Add returnType to Management class

src/API/Helpers/ApiClient.php

@@ -58,10 +58,13 @@ public static function disableInfoHeaders()
 
     protected $guzzleOptions;
 
+    protected $returnType;
+
     public function __construct($config)
     {
         $this->basePath      = $config['basePath'];
         $this->domain        = $config['domain'];
+        $this->returnType    = isset( $config['returnType'] ) ? $config['returnType'] : null;
         $this->headers       = isset($config['headers']) ? $config['headers'] : [];
         $this->guzzleOptions = isset($config['guzzleOptions']) ? $config['guzzleOptions'] : [];
 
@@ -76,7 +79,8 @@ public function __call($name, $arguments)
             'domain' => $this->domain,
             'basePath' => $this->basePath,
             'method' => $name,
-            'guzzleOptions' => $this->guzzleOptions
+            'guzzleOptions' => $this->guzzleOptions,
+            'returnType' => $this->returnType,
         ]);
 
         return $builder->withHeaders($this->headers);
@@ -97,7 +101,8 @@ public function method($method)
             'domain' => $this->domain,
             'basePath' => $this->basePath,
             'method' => $method,
-            'guzzleOptions' => $this->guzzleOptions
+            'guzzleOptions' => $this->guzzleOptions,
+            'returnType' => $this->returnType,
         ]);
         $builder->withHeaders($this->headers);
 

src/API/Helpers/RequestBuilder.php

@@ -125,12 +125,14 @@ public function __construct(array $config)
     }
 
     /**
+     * Magic method to overload method calls to paths.
+     *
+     * @param string $name      Method invoked.
+     * @param array  $arguments Arguments to add to the path.
      *
-     * @param  string $name
-     * @param  array  $arguments
      * @return RequestBuilder
      */
-    public function __call($name, $arguments)
+    public function __call($name, array $arguments)
     {
         $argument = null;
 
@@ -144,9 +146,11 @@ public function __call($name, $arguments)
     }
 
     /**
+     * Add a path and an optional argument to this request.
+     *
+     * @param string      $name     Path to add.
+     * @param string|null $argument Optional argument to add.
      *
-     * @param  string      $name
-     * @param  string|null $argument
      * @return RequestBuilder
      */
     public function addPath($name, $argument = null)
@@ -160,8 +164,10 @@ public function addPath($name, $argument = null)
     }
 
     /**
+     * Add a path variable.
+     *
+     * @param string $variable Path variable to add.
      *
-     * @param  string $variable
      * @return RequestBuilder
      */
     public function addPathVariable($variable)
@@ -171,6 +177,7 @@ public function addPathVariable($variable)
     }
 
     /**
+     * Get the path and URL parameters of this request.
      *
      * @return string
      */
@@ -180,6 +187,7 @@ public function getUrl()
     }
 
     /**
+     * Output a URL
      *
      * @return string
      */

src/API/Management.php

@@ -49,6 +49,12 @@ class Management
      */
     private $guzzleOptions;
 
+    /**
+     *
+     * @var string
+     */
+    private $returnType;
+
     /**
      *
      * @var Blacklists
@@ -157,12 +163,14 @@ class Management
      * @param string $token
      * @param string $domain
      * @param array  $guzzleOptions
+     * @param string $returnType
      */
-    public function __construct($token, $domain, $guzzleOptions = [])
+    public function __construct($token, $domain, $guzzleOptions = [], $returnType = 'body')
     {
         $this->token         = $token;
         $this->domain        = $domain;
         $this->guzzleOptions = $guzzleOptions;
+        $this->returnType    = $returnType;
 
         $this->setApiClient();
 
@@ -193,6 +201,7 @@ protected function setApiClient()
             'domain' => $apiDomain,
             'basePath' => '/api/v2/',
             'guzzleOptions' => $this->guzzleOptions,
+            'returnType' => $this->returnType,
             'headers' => [
                 new AuthorizationBearer($this->token)
             ]

tests/API/Management/RulesTest.php

@@ -170,6 +170,7 @@ public function testExceptions()
         } catch (CoreException $e) {
             $caught_get_no_id_exception = $this->errorHasString($e, 'Invalid "id" parameter');
         }
+
         $this->assertTrue($caught_get_no_id_exception);
 
         // Test that the delete method throws an exception if the $id parameter is empty.
@@ -179,6 +180,7 @@ public function testExceptions()
         } catch (CoreException $e) {
             $caught_delete_no_id_exception = $this->errorHasString($e, 'Invalid "id" parameter');
         }
+
         $this->assertTrue($caught_delete_no_id_exception);
 
         // Test that the create method throws an exception if no "name" field is passed.
@@ -188,6 +190,7 @@ public function testExceptions()
         } catch (CoreException $e) {
             $caught_create_no_name_exception = $this->errorHasString($e, 'Missing required "name" field');
         }
+
         $this->assertTrue($caught_create_no_name_exception);
 
         // Test that the create method throws an exception if no "script" field is passed.
@@ -197,6 +200,7 @@ public function testExceptions()
         } catch (CoreException $e) {
             $caught_create_no_script_exception = $this->errorHasString($e, 'Missing required "script" field');
         }
+
         $this->assertTrue($caught_create_no_script_exception);
 
         // Test that the update method throws an exception if the $id parameter is empty.
@@ -206,6 +210,7 @@ public function testExceptions()
         } catch (CoreException $e) {
             $caught_update_no_id_exception = $this->errorHasString($e, 'Invalid "id" parameter');
         }
+
         $this->assertTrue($caught_update_no_id_exception);
     }
 }