- Refactored common validation into new method in RestMultiClient.

- Removed uneeded comments.
- Added exception to code climate config

Author: mikecbrant

.codeclimate.yml

@@ -8,9 +8,11 @@ engines:
     enabled: true
   phpmd:
     enabled: true
+      exclude_fingerprints:
+      - 22c29059ae6bb876ee678dfad3c26ec4
 ratings:
   paths:
-  - "**.php"
+    - "**.php"
 exclude_paths:
   - .settings/
   - build/

src/RestClientLib/RestClient.php

@@ -118,7 +118,6 @@ public function get($action) {
         $this->curlSetup();
         $this->setRequestUrl($action);
         curl_setopt($this->curl, CURLOPT_HTTPGET, true);
-        // execute call. Can throw \Exception.
         return $this->curlExec();
     }
 
@@ -138,7 +137,6 @@ public function post($action, $data) {
         $this->setRequestUrl($action);
         $this->setRequestData($data);
         curl_setopt($this->curl, CURLOPT_POST, true);
-        // execute call. Can throw \Exception.
         return $this->curlExec();
     }
 
@@ -158,7 +156,6 @@ public function put($action, $data) {
         $this->setRequestUrl($action);
         $this->setRequestData($data);
         curl_setopt($this->curl, CURLOPT_CUSTOMREQUEST, 'PUT');
-        // execute call. Can throw \Exception.
         return $this->curlExec();
     }
 
@@ -175,7 +172,6 @@ public function delete($action) {
         $this->curlSetup();
         $this->setRequestUrl($action);
         curl_setopt($this->curl, CURLOPT_CUSTOMREQUEST, 'DELETE');
-        // execute call. Can throw \Exception.
         return $this->curlExec();
     }
 
@@ -193,7 +189,6 @@ public function head($action) {
         $this->setRequestUrl($action);
         curl_setopt($this->curl, CURLOPT_CUSTOMREQUEST, 'HEAD');
         curl_setopt($this->curl, CURLOPT_NOBODY, true);
-        // execute call. Can throw \Exception.
         return $this->curlExec();
     }
 

src/RestClientLib/RestMultiClient.php

@@ -46,12 +46,10 @@ public function __construct() {}
      */
     public function get($actions) {
         $this->validateActionArray($actions);
-        
-        // set up curl handles
         $this->curlMultiSetup(count($actions));
         $this->setRequestUrls($actions);
         foreach($this->curlHandles as $curl) {
-            curl_setopt($curl, CURLOPT_HTTPGET, true); // explicitly set the method to GET    
+            curl_setopt($curl, CURLOPT_HTTPGET, true);
         }
         return $this->curlMultiExec();
     }
@@ -67,19 +65,12 @@ public function get($actions) {
      * @throws \LengthException
      */
     public function post($actions, $data) {
-        $this->validateActionArray($actions);
-        $this->validateDataArray($data);
-        // verify that the number of data elements matches the number of action elements
-        if (count($actions) !== count($data)) {
-            throw new \LengthException('The number of actions requested does not match the number of data elements provided.'); 
-        }
-        
-        // set up curl handles
+        $this->validateInputArrays($actions, $data);
         $this->curlMultiSetup(count($actions));
         $this->setRequestUrls($actions);
         $this->setRequestDataArray($data);
         foreach($this->curlHandles as $curl) {
-            curl_setopt($curl, CURLOPT_POST, true); // explicitly set the method to POST 
+            curl_setopt($curl, CURLOPT_POST, true);
         }
         return $this->curlMultiExec();
     }
@@ -95,19 +86,12 @@ public function post($actions, $data) {
      * @throws \LengthException
      */
     public function put($actions, $data) {
-        $this->validateActionArray($actions);
-        $this->validateDataArray($data);
-        // verify that the number of data elements matches the number of action elements
-        if (count($actions) !== count($data)) {
-            throw new \LengthException('The number of actions requested does not match the number of data elements provided.'); 
-        }
-        
-        // set up curl handles
+        $this->validateInputArrays($actions, $data);
         $this->curlMultiSetup(count($actions));
         $this->setRequestUrls($actions);
         $this->setRequestDataArray($data);
         foreach($this->curlHandles as $curl) {
-            curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT'); // explicitly set the method to PUT 
+            curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
         }
         return $this->curlMultiExec();
     }
@@ -124,12 +108,10 @@ public function put($actions, $data) {
      */
     public function delete($actions) {
         $this->validateActionArray($actions);
-        
-        // set up curl handles
         $this->curlMultiSetup(count($actions));
         $this->setRequestUrls($actions);
         foreach($this->curlHandles as $curl) {
-            curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE'); // explicitly set the method to DELETE
+            curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE');
         }
         return $this->curlMultiExec();
     }
@@ -145,8 +127,6 @@ public function delete($actions) {
      */
     public function head($actions) {
         $this->validateActionArray($actions);
-        
-        // set up curl handles
         $this->curlMultiSetup(count($actions));
         $this->setRequestUrls($actions);
         foreach($this->curlHandles as $curl) {
@@ -235,7 +215,7 @@ private function curlMultiExec() {
         }
 
         // process the results. Note there could be individual errors on specific calls
-        $curlMultiHttpResponse = new CurlMultiHttpResponse();
+        $curlMultiResponse = new CurlMultiHttpResponse();
         foreach($this->curlHandles as $curl) {
             try {
                 $response = new CurlHttpResponse(
@@ -250,10 +230,10 @@ private function curlMultiExec() {
                    $e
                 );
             }
-            $curlMultiHttpResponse->addResponse($response);
+            $curlMultiResponse->addResponse($response);
         }
         $this->curlMultiTeardown();
-        return $curlMultiHttpResponse;
+        return $curlMultiResponse;
     }
 
     /**
@@ -282,6 +262,23 @@ private function setRequestDataArray(array $data) {
         }
     }
 
+    /**
+     * Method to provide validation to action and data arrays for POST/PUT methods
+     * 
+     * @param string[] $actions
+     * @param mixed[] $data
+     * @return void
+     * @throws \InvalidArgumentException
+     * @throws \LengthException
+     */
+    private function validateInputArrays(array $actions, array $data) {
+        $this->validateActionArray($actions);
+        $this->validateDataArray($data);
+        if (count($actions) !== count($data)) {
+            throw new \LengthException('The number of actions requested does not match the number of data elements provided.'); 
+        }
+    }
+    
     /**
      * Method to provide common validation for action array parameters
      * 

tests/RestMultiClientTest.php

@@ -175,6 +175,18 @@ public function testValidateDataArrayThrowsExceptionOnOversizedArray() {
         );
     }
 
+    /**
+     * @expectedException \LengthException
+     * @covers MikeBrant\RestClientLib\RestMultiClient::validateInputArrays
+     */
+    public function testValidateInputArraysThrowsExceptionOnArraySizeMismatch() {
+        $maxHandles = $this->client->getMaxHandles();
+        $this->client->post(
+            array_fill(0, $maxHandles, 'action'),
+            array_fill(0, $maxHandles - 1, 'data')
+        );
+    }
+    
     /**
      * @expectedException \Exception
      * @covers MikeBrant\RestClientLib\RestMultiClient::curlMultiSetup
@@ -227,18 +239,6 @@ public function testGet() {
         $this->assertAttributeEquals(null, 'curlMultiHandle', $this->client);
     }
 
-    /**
-     * @expectedException \LengthException
-     * @covers MikeBrant\RestClientLib\RestMultiClient::post
-     */
-    public function testPostThrowsExceptionOnArraySizeMismatch() {
-        $maxHandles = $this->client->getMaxHandles();
-        $this->client->post(
-            array_fill(0, $maxHandles, 'action'),
-            array_fill(0, $maxHandles - 1, 'data')
-        );
-    }
-    
     /**
      * @covers MikeBrant\RestClientLib\RestMultiClient::post
      * @covers MikeBrant\RestClientLib\RestMultiClient::validateDataArray