Merge pull request #352 from rafaelsales/reserved-params

oestrich · web-flow · commit 16f6fea7562e · 2017-09-27T09:42:38.000-04:00
Don't evaluate original parameter name when custom method is provided
diff --git a/lib/rspec_api_documentation/dsl/endpoint/set_param.rb b/lib/rspec_api_documentation/dsl/endpoint/set_param.rb
@@ -45,10 +45,12 @@ def path_params
         end
 
         def method_name
-          @method_name ||= begin
-            [custom_method_name, scoped_key, key].find do |name|
-              name && example_group.respond_to?(name)
-            end
+          if custom_method_name
+            custom_method_name if example_group.respond_to?(custom_method_name)
+          elsif scoped_key && example_group.respond_to?(scoped_key)
+            scoped_key
+          elsif key && example_group.respond_to?(key)
+            key
           end
         end
 
diff --git a/spec/dsl_spec.rb b/spec/dsl_spec.rb
@@ -1,6 +1,7 @@
 require 'spec_helper'
 require 'rspec_api_documentation/dsl'
 require 'net/http'
+require "rack/test"
 
 describe "Non-api documentation specs" do
   it "should not be polluted by the rspec api dsl" do |example|
@@ -396,6 +397,36 @@
           do_request
         end
       end
+
+      context "with reserved name parameter" do
+        context "without custom method name" do
+          parameter :status, "Filter order by status"
+
+          example "does not work as expected" do
+            expect { do_request }.to raise_error Rack::Test::Error, /No response yet/
+          end
+        end
+
+        context "with custom method name" do
+          parameter :status, "Filter order by status", method: :status_param
+
+          context "when parameter value is not specified" do
+            example "does not serialize param" do
+              expect(client).to receive(method).with("/orders", anything, anything)
+              do_request
+            end
+          end
+
+          context "when parameter value is specified" do
+            let(:status_param) { "pending" }
+
+            example "serializes param" do
+              expect(client).to receive(method).with("/orders?status=pending", anything, anything)
+              do_request
+            end
+          end
+        end
+      end
     end
   end
 
