[API] Added a Elasticsearch::API.settings[:skip_parameter_validation] setting support into __validate_and_extract_params

Example:

    Elasticsearch::API.settings[:skip_parameter_validation] = true
    __validate_and_extract_params( { :foo => 'q', :bam => 'm' }, [:foo, :bar] )
    # => { :foo => "q", :bam => "m" }

Author: karmi

elasticsearch-api/lib/elasticsearch/api/utils.rb

@@ -110,24 +110,44 @@ def __bulkify(payload)
       # @raise [ArgumentError] If the arguments Hash contains invalid keys
       #
       # @example Extract parameters
-      #   __validate_and_extract_params { :foo => 'qux' }, [:foo, :bar]
+      #   __validate_and_extract_params( { :foo => 'qux' }, [:foo, :bar] )
       #   # => { :foo => 'qux' }
       #
       # @example Raise an exception for invalid parameters
-      #   __validate_and_extract_params { :foo => 'qux', :bam => 'mux' }, [:foo, :bar]
+      #   __validate_and_extract_params( { :foo => 'qux', :bam => 'mux' }, [:foo, :bar] )
       #   # ArgumentError: "URL parameter 'bam' is not supported"
       #
+      # @example Skip validating parameters
+      #   __validate_and_extract_params( { :foo => 'q', :bam => 'm' }, [:foo, :bar], { skip_parameter_validation: true } )
+      #   # => { :foo => "q", :bam => "m" }
+      #
+      # @example Skip validating parameters when the module setting is set
+      #   Elasticsearch::API.settings[:skip_parameter_validation] = true
+      #   __validate_and_extract_params( { :foo => 'q', :bam => 'm' }, [:foo, :bar] )
+      #   # => { :foo => "q", :bam => "m" }
+      #
       # @api private
       #
-      def __validate_and_extract_params(arguments, valid_params=[])
+      def __validate_and_extract_params(arguments, params=[], options={})
+        if options[:skip_parameter_validation] || Elasticsearch::API.settings[:skip_parameter_validation]
+          arguments
+        else
+          __validate_params(arguments, params)
+          __extract_params(arguments, params)
+        end
+      end
+
+      def __validate_params(arguments, valid_params=[])
         arguments.each do |k,v|
           raise ArgumentError, "URL parameter '#{k}' is not supported" \
             unless COMMON_PARAMS.include?(k) || COMMON_QUERY_PARAMS.include?(k) || valid_params.include?(k)
         end
+      end
 
-        params = arguments.select { |k,v| COMMON_QUERY_PARAMS.include?(k) || valid_params.include?(k) }
-        params = Hash[params] unless params.is_a?(Hash) # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-        params
+      def __extract_params(arguments, params=[])
+        result = arguments.select { |k,v| COMMON_QUERY_PARAMS.include?(k) || params.include?(k) }
+        result = Hash[result] unless result.is_a?(Hash) # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
+        result
       end
 
       # Extracts the valid parts of the URL from the arguments

elasticsearch-api/test/unit/utils_test.rb

@@ -141,6 +141,9 @@ class UtilsTest < ::Test::Unit::TestCase
         end
 
         context "__validate_and_extract_params" do
+          teardown do
+            Elasticsearch::API.settings.clear
+          end
 
           should "extract valid params from a Hash" do
             assert_equal( {:foo => 'qux'},
@@ -164,6 +167,21 @@ class UtilsTest < ::Test::Unit::TestCase
                           __validate_and_extract_params( { :format => 'yaml' } ) )
           end
 
+          should "not validate parameters when the option is set" do
+            assert_nothing_raised do
+              result = __validate_and_extract_params( { :foo => 'q', :bam => 'm' }, [:foo, :bar], { skip_parameter_validation: true } )
+              assert_equal( { :foo => 'q', :bam => 'm' }, result )
+            end
+          end
+
+          should "not validate parameters when the module setting is set" do
+            assert_nothing_raised do
+              Elasticsearch::API.settings[:skip_parameter_validation] = true
+              result = __validate_and_extract_params( { :foo => 'q', :bam => 'm' }, [:foo, :bar] )
+              assert_equal( { :foo => 'q', :bam => 'm' }, result )
+            end
+          end
+
         end
 
         context "__extract_parts" do