Fixed a bug which was introduced when switching to http_build_query for

query string encoding where repeated parameters would adopt named indexes.
Library now defaults to omitting numeric indexes, which can be re-enabled with
the `build_indexed_queries` boolean option. Original tests now pass, additional
tests added to verify integrity of regex hack.

Author: tcdent

README.markdown

@@ -31,6 +31,7 @@ Configurable Options
 `headers` - An associative array of HTTP headers and values to be included in every request.  
 `parameters` - An associative array of URL or body parameters to be included in every request.  
 `curl_options` - cURL options to apply to every request; anything defined here: https://secure.php.net/manual/en/function.curl-setopt.php. These will override any automatically generated values.  
+`build_indexed_queries` `(bool)` - `http_build_query` automatically adds an array index to repeated parameters which is not desirable on most systems. Use this option to enable the default behavior. Defaults to `FALSE`.
 `user_agent` - User agent string to use in requests.  
 `base_url` - URL to use for the base of each request.  
 `format` - Format string is appended to resource on request (extension), and used to determine which decoder to use on response; a request URL like "api.twitter.com/1.1/statuses/user_timeline.json" would be expected to return well-formed JSON.  

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "tcdent/php-restclient", 
-    "version": "0.1.6", 
+    "version": "0.1.7", 
     "description": "A generic REST API client for PHP", 
     "type": "library", 
     "keywords": ["REST", "api", "client", "curl", "JSON", "XML"], 

restclient.php

@@ -10,7 +10,6 @@ class RestClientException extends Exception {}
 
 class RestClient implements Iterator, ArrayAccess {
 
-    public $url;
     public $options;
     public $handle; // cURL resource handle.
 
@@ -29,7 +28,8 @@ public function __construct($options=[]){
             'headers' => [], 
             'parameters' => [], 
             'curl_options' => [], 
-            'user_agent' => "PHP RestClient/0.1.6", 
+            'build_indexed_queries' => FALSE, 
+            'user_agent' => "PHP RestClient/0.1.7", 
             'base_url' => NULL, 
             'format' => NULL, 
             'format_regex' => "/(\w+)\/(\w+)(;[.+])?/",
@@ -162,6 +162,13 @@ public function execute($url, $method='GET', $parameters=[], $headers=[]){
         if(is_array($parameters)){
             $parameters = array_merge($client->options['parameters'], $parameters);
             $parameters_string = http_build_query($parameters);
+            
+            // http_build_query automatically adds an array index to repeated
+            // parameters which is not desirable on most systems. This hack
+            // reverts "key[0]=foo&key[1]=bar" to "key[]=foo&key[]=bar"
+            if(!$client->options['build_indexed_queries'])
+                $parameters_string = preg_replace(
+                    "/%5B[0-9]+%5D=/simU", "%5B%5D=", $parameters_string);
         }
         else
             $parameters_string = (string) $parameters;

test.php

@@ -35,7 +35,7 @@ public function test_get(){
 
         $api = new RestClient;
         $result = $api->get($TEST_SERVER_URL, [
-            'foo' => ' bar', 'baz' => 1, 'bat[]' => ['foo', 'bar']
+            'foo' => ' bar', 'baz' => 1, 'bat' => ['foo', 'bar']
         ]);
 
         $response_json = $result->decode_response();
@@ -52,7 +52,7 @@ public function test_post(){
 
         $api = new RestClient;
         $result = $api->post($TEST_SERVER_URL, [
-            'foo' => ' bar', 'baz' => 1, 'bat[]' => ['foo', 'bar']
+            'foo' => ' bar', 'baz' => 1, 'bat' => ['foo', 'bar']
         ]);
 
         $response_json = $result->decode_response();
@@ -183,6 +183,32 @@ public function test_status_only_response(){
         $this->assertEquals((object) [], $api->headers);
         $this->assertEquals("", $api->response);
     }
+    
+    public function test_build_indexed_queries(){
+        global $TEST_SERVER_URL;
+        
+        $api = new RestClient(['build_indexed_queries' => TRUE]);
+        $result = $api->get($TEST_SERVER_URL, [
+            'foo' => ' bar', 'baz' => 1, 'bat' => ['foo', 'bar', 'baz[12]']
+        ]);
+        
+        $response_json = $result->decode_response();
+        $this->assertEquals("foo=+bar&baz=1&bat%5B0%5D=foo&bat%5B1%5D=bar&bat%5B2%5D=baz%5B12%5D", 
+            $response_json->SERVER->QUERY_STRING);
+    }
+    
+    public function test_build_non_indexed_queries(){
+        global $TEST_SERVER_URL;
+        
+        $api = new RestClient;
+        $result = $api->get($TEST_SERVER_URL, [
+            'foo' => ' bar', 'baz' => 1, 'bat' => ['foo', 'bar', 'baz[12]']
+        ]);
+        
+        $response_json = $result->decode_response();
+        $this->assertEquals("foo=+bar&baz=1&bat%5B%5D=foo&bat%5B%5D=bar&bat%5B%5D=baz%5B12%5D", 
+            $response_json->SERVER->QUERY_STRING);
+    }
 }