Serialize request parameters for GET requests properly, using ActiveSupport and to_query.

Author: denyago

lib/rspec_api_documentation.rb

@@ -2,6 +2,7 @@
 require 'active_support/inflector'
 require 'cgi'
 require 'json'
+require 'active_support/core_ext/object/to_query'
 
 module RspecApiDocumentation
   extend ActiveSupport::Autoload

lib/rspec_api_documentation/dsl/endpoint.rb

@@ -45,11 +45,7 @@ def do_request(extra_params = {})
     end
 
     def query_string
-      query = params.to_a.map do |param|
-        param.map! { |a| CGI.escape(a.to_s) }
-        param.join("=")
-      end
-      query.join("&")
+      (params || {}).to_query
     end
 
     def params

spec/dsl_spec.rb

@@ -380,6 +380,41 @@
     end
   end
 
+  context "proper query_string serialization" do
+    get "/orders" do
+      context "with an array parameter" do
+        parameter :id_eq, "List of IDs"
+
+        let(:id_eq) { [1, 2] }
+
+        example "parsed properly" do
+          client.should_receive(:get).with do |path, data, headers|
+            Addressable::URI.parse(path).query_values.should eq({"id_eq"=>['1', '2']})
+          end
+          do_request
+        end
+      end
+
+      context "with a deep nested parameter, including Hashes and Arrays" do
+        parameter :within_id, "Fancy search condition"
+
+        let(:within_id) { {"first" => 1, "last" => 10, "exclude" => [3,5,7]} }
+        scope_parameters :search, :all
+
+        example "parsed properly" do
+          client.should_receive(:get).with do |path, data, headers|
+            Addressable::URI.parse(path).query_values.should eq({
+              "search" => { "within_id" => {"first" => '1', "last" => '10', "exclude" => ['3','5','7']}}
+            })
+          end
+          do_request
+        end
+      end
+    end
+  end
+
+
+
   context "auto request" do
     post "/orders" do
       parameter :order_type, "Type of order"