send* methods to return values

Author: DavertMik

src/Codeception/Module/REST.php

@@ -431,7 +431,7 @@ public function amAWSAuthenticated($additionalAWSConfig = [])
      * ```php
      * <?php
      * //simple POST call
-     * $I->sendPost('/message', ['subject' => 'Read this!', 'to' => '[email protected]']);
+     * $response = $I->sendPost('/message', ['subject' => 'Read this!', 'to' => '[email protected]']);
      * //simple upload method
      * $I->sendPost('/message/24', ['inline' => 0], ['attachmentFile' => codecept_data_dir('sample_file.pdf')]);
      * //uploading a file with a custom name and mime-type. This is also useful to simulate upload errors.
@@ -465,7 +465,7 @@ public function amAWSAuthenticated($additionalAWSConfig = [])
      */
     public function sendPost($url, $params = [], $files = [])
     {
-        $this->execute('POST', $url, $params, $files);
+        return $this->execute('POST', $url, $params, $files);
     }
 
     /**
@@ -478,7 +478,7 @@ public function sendPost($url, $params = [], $files = [])
      */
     public function sendHead($url, $params = [])
     {
-        $this->execute('HEAD', $url, $params);
+        return $this->execute('HEAD', $url, $params);
     }
 
     /**
@@ -497,19 +497,32 @@ public function sendOptions($url, $params = [])
     /**
      * Sends a GET request to given uri.
      *
+     * ```php
+     * <?php
+     * $response = $I->sendGet('/users');
+     *
+     * // send get with query params
+     * $I->sendGet('/orders', ['id' => 1])
+     * ```
+     *
      * @param $url
      * @param array $params
      * @part json
      * @part xml
      */
     public function sendGet($url, $params = [])
     {
-        $this->execute('GET', $url, $params);
+        return $this->execute('GET', $url, $params);
     }
 
     /**
      * Sends PUT request to given uri.
      *
+     * ```php
+     * <?php
+     * $response = $I->sendPut('/message/1', ['subject' => 'Read this!']);
+     * ```
+     *
      * @param $url
      * @param array|string|\JsonSerializable $params
      * @param array $files
@@ -518,12 +531,17 @@ public function sendGet($url, $params = [])
      */
     public function sendPut($url, $params = [], $files = [])
     {
-        $this->execute('PUT', $url, $params, $files);
+        return $this->execute('PUT', $url, $params, $files);
     }
 
     /**
      * Sends PATCH request to given uri.
      *
+     * ```php
+     * <?php
+     * $response = $I->sendPatch('/message/1', ['subject' => 'Read this!']);
+     * ```
+     *
      * @param       $url
      * @param array|string|\JsonSerializable $params
      * @param array $files
@@ -532,11 +550,17 @@ public function sendPut($url, $params = [], $files = [])
      */
     public function sendPatch($url, $params = [], $files = [])
     {
-        $this->execute('PATCH', $url, $params, $files);
+        return $this->execute('PATCH', $url, $params, $files);
     }
 
     /**
      * Sends DELETE request to given uri.
+     *
+     * ```php
+     * <?php
+     * $I->sendDelete('/message/1');
+     * ```
+
      *
      * @param $url
      * @param array $params
@@ -546,7 +570,7 @@ public function sendPatch($url, $params = [], $files = [])
      */
     public function sendDelete($url, $params = [], $files = [])
     {
-        $this->execute('DELETE', $url, $params, $files);
+        return $this->execute('DELETE', $url, $params, $files);
     }
 
     /**
@@ -561,7 +585,7 @@ public function sendDelete($url, $params = [], $files = [])
      */
     public function send($method, $url, $params = [], $files = [])
     {
-        $this->execute(strtoupper($method), $url, $params, $files);
+        return $this->execute(strtoupper($method), $url, $params, $files);
     }
 
     /**
@@ -688,6 +712,8 @@ protected function execute($method, $url, $parameters = [], $files = [])
         } else {
             $this->debugSection("Response", $printedResponse);
         }
+
+        return $this->response;
     }
 
     /**

tests/unit/Codeception/Module/RestTest.php

@@ -64,34 +64,43 @@ public function testBeforeHookResetsVariables()
 
     public function testGet()
     {
-        $this->module->sendGET('/rest/user/');
+        $response = $this->module->sendGET('/rest/user/');
         $this->module->seeResponseIsJson();
         $this->module->seeResponseContains('davert');
         $this->module->seeResponseContainsJson(['name' => 'davert']);
         $this->module->seeResponseCodeIs(200);
         $this->module->dontSeeResponseCodeIs(404);
+        $this->assertNotEmpty($response);
+        $this->assertStringContainsString('"name":"davert"', $response);
     }
 
     public function testPost()
     {
-        $this->module->sendPOST('/rest/user/', ['name' => 'john']);
+        $response = $this->module->sendPOST('/rest/user/', ['name' => 'john']);
         $this->module->seeResponseContains('john');
         $this->module->seeResponseContainsJson(['name' => 'john']);
+        $this->assertNotEmpty($response);
+        $this->assertStringContainsString('"name":"john"', $response);
     }
 
     public function testPut()
     {
-        $this->module->sendPUT('/rest/user/', ['name' => 'laura']);
+        $response = $this->module->sendPUT('/rest/user/', ['name' => 'laura']);
         $this->module->seeResponseContains('[email protected]');
         $this->module->seeResponseContainsJson(['name' => 'laura']);
         $this->module->dontSeeResponseContainsJson(['name' => 'john']);
+        $this->assertNotEmpty($response);
+        $this->assertStringContainsString('"name":"laura"', $response);
+
     }
 
     public function testSend()
     {
-        $this->module->send('POST','/rest/user/', ['name' => 'john']);
+        $response = $this->module->send('POST','/rest/user/', ['name' => 'john']);
         $this->module->seeResponseContains('john');
         $this->module->seeResponseContainsJson(['name' => 'john']);
+        $this->assertNotEmpty($response);
+        $this->assertStringContainsString('"name":"john"', $response);
     }
 
     public function testGrabDataFromResponseByJsonPath()