elasticsearch-api 0.4.0 → 0.4.1

data/lib/elasticsearch/api/actions/indices/validate_query.rb

@@ -48,16 +48,18 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/reference/api/validate/
         #
         def validate_query(arguments={})
+          valid_params = [
+            :q,
+            :explain,
+            :ignore_indices,
+            :source ]
+
           method = 'GET'
-          path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_validate/query' )
-          params = arguments.select do |k,v|
-            [ :q,
-              :explain,
-              :ignore_indices,
-              :source ].include?(k)
-          end
-          # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-          params = Hash[params] unless params.is_a?(Hash)
+          path   = Utils.__pathify Utils.__listify(arguments[:index]),
+                                   Utils.__listify(arguments[:type]),
+                                   '_validate/query'
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
           body   = arguments[:body]
 
           perform_request(method, path, params, body).body

data/lib/elasticsearch/api/actions/mget.rb

@@ -36,23 +36,33 @@ module Elasticsearch
       # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
       # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
       # @option arguments [String] :routing Specific routing value
+      # @option arguments [String] :_source Specify whether the _source field should be returned,
+      #                                     or a list of fields to return
+      # @option arguments [String] :_source_exclude A list of fields to exclude from the returned _source field
+      # @option arguments [String] :_source_include A list of fields to extract and return from the _source field
       #
       # @see http://elasticsearch.org/guide/reference/api/multi-get/
       #
       def mget(arguments={})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
+        valid_params = [
+          :fields,
+          :parent,
+          :preference,
+          :realtime,
+          :refresh,
+          :routing,
+          :_source,
+          :_source_include,
+          :_source_exclude ]
+
         method = 'GET'
-        path   = Utils.__pathify( arguments[:index], arguments[:type], '_mget' )
-        params = arguments.select do |k,v|
-          [ :fields,
-            :parent,
-            :preference,
-            :realtime,
-            :refresh,
-            :routing ].include?(k)
-        end
-        # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-        params = Hash[params] unless params.is_a?(Hash)
+        path   = Utils.__pathify Utils.__escape(arguments[:index]),
+                                 Utils.__escape(arguments[:type]),
+                                 '_mget'
+
+        params = Utils.__validate_and_extract_params arguments, valid_params
         body   = arguments[:body]
 
         params[:fields] = Utils.__listify(params[:fields]) if params[:fields]

data/lib/elasticsearch/api/actions/mlt.rb

@@ -47,31 +47,35 @@ module Elasticsearch
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
         raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
+
+        valid_params = [
+          :boost_terms,
+          :max_doc_freq,
+          :max_query_terms,
+          :max_word_len,
+          :min_doc_freq,
+          :min_term_freq,
+          :min_word_len,
+          :mlt_fields,
+          :percent_terms_to_match,
+          :routing,
+          :search_from,
+          :search_indices,
+          :search_query_hint,
+          :search_scroll,
+          :search_size,
+          :search_source,
+          :search_type,
+          :search_types,
+          :stop_words ]
+
         method = 'GET'
-        path   = Utils.__pathify( arguments[:index], arguments[:type], arguments[:id], '_mlt' )
-        params = arguments.select do |k,v|
-          [ :boost_terms,
-            :max_doc_freq,
-            :max_query_terms,
-            :max_word_len,
-            :min_doc_freq,
-            :min_term_freq,
-            :min_word_len,
-            :mlt_fields,
-            :percent_terms_to_match,
-            :routing,
-            :search_from,
-            :search_indices,
-            :search_query_hint,
-            :search_scroll,
-            :search_size,
-            :search_source,
-            :search_type,
-            :search_types,
-            :stop_words ].include?(k)
-        end
-        # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-        params = Hash[params] unless params.is_a?(Hash)
+        path   = Utils.__pathify Utils.__escape(arguments[:index]),
+                                 Utils.__escape(arguments[:type]),
+                                 Utils.__escape(arguments[:id]),
+                                 '_mlt'
+
+        params = Utils.__validate_and_extract_params arguments, valid_params
 
         [:mlt_fields, :search_indices, :search_types, :stop_words].each do |name|
           params[name] = Utils.__listify(params[name]) if params[name]

data/lib/elasticsearch/api/actions/msearch.rb

@@ -37,13 +37,12 @@ module Elasticsearch
       #
       def msearch(arguments={})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+        valid_params = [ :search_type ]
+
         method = 'GET'
         path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_msearch' )
-        params = arguments.select do |k,v|
-          [ :search_type ].include?(k)
-        end
-        # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-        params = Hash[params] unless params.is_a?(Hash)
+
+        params = Utils.__validate_and_extract_params arguments, valid_params
         body   = arguments[:body]
 
         case

data/lib/elasticsearch/api/actions/percolate.rb

@@ -41,13 +41,14 @@ module Elasticsearch
         raise ArgumentError, "Required argument 'body' missing"  unless arguments[:body]
         arguments[:type] ||= 'document'
 
+        valid_params = [ :prefer_local ]
+
         method = 'GET'
-        path   = "#{arguments[:index]}/#{arguments[:type]}/_percolate"
-        params = arguments.select do |k,v|
-          [ :prefer_local ].include?(k)
-        end
-        # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-        params = Hash[params] unless params.is_a?(Hash)
+        path   = Utils.__pathify Utils.__escape(arguments[:index]),
+                                 Utils.__escape(arguments[:type]),
+                                 '_percolate'
+
+        params = Utils.__validate_and_extract_params arguments, valid_params
         body   = arguments[:body]
 
         perform_request(method, path, params, body).body

data/lib/elasticsearch/api/actions/scroll.rb

@@ -29,12 +29,11 @@ module Elasticsearch
       def scroll(arguments={})
         method = 'GET'
         path   = "_search/scroll"
-        params = arguments.select do |k,v|
-          [ :scroll,
-            :scroll_id ].include?(k)
-        end
-        # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-        params = Hash[params] unless params.is_a?(Hash)
+        valid_params = [
+          :scroll,
+          :scroll_id ]
+
+        params = Utils.__validate_and_extract_params arguments, valid_params
         body   = arguments[:body]
 
         perform_request(method, path, params, body).body

data/lib/elasticsearch/api/actions/search.rb

@@ -86,6 +86,10 @@ module Elasticsearch
       # @option arguments [List] :sort A comma-separated list of <field>:<direction> pairs
       # @option arguments [String] :source The URL-encoded request definition using the Query DSL
       #                                    (instead of using request body)
+      # @option arguments [String] :_source Specify whether the _source field should be returned,
+      #                                     or a list of fields to return
+      # @option arguments [String] :_source_exclude A list of fields to exclude from the returned _source field
+      # @option arguments [String] :_source_include A list of fields to extract and return from the _source field
       # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes
       # @option arguments [String] :suggest_field Specify which field to use for suggestions
       # @option arguments [String] :suggest_mode Specify suggest mode (options: missing, popular, always)
@@ -102,38 +106,41 @@ module Elasticsearch
       def search(arguments={})
         arguments[:index] = '_all' if ! arguments[:index] && arguments[:type]
 
+        valid_params = [
+          :analyzer,
+          :analyze_wildcard,
+          :default_operator,
+          :df,
+          :explain,
+          :fields,
+          :from,
+          :ignore_indices,
+          :indices_boost,
+          :lenient,
+          :lowercase_expanded_terms,
+          :preference,
+          :q,
+          :routing,
+          :scroll,
+          :search_type,
+          :size,
+          :sort,
+          :source,
+          :_source,
+          :_source_include,
+          :_source_exclude,
+          :stats,
+          :suggest_field,
+          :suggest_mode,
+          :suggest_size,
+          :suggest_text,
+          :timeout,
+          :version ]
+
         method = 'GET'
         path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_search' )
-        params = arguments.select do |k,v|
-          [ :analyzer,
-            :analyze_wildcard,
-            :default_operator,
-            :df,
-            :explain,
-            :fields,
-            :from,
-            :ignore_indices,
-            :indices_boost,
-            :lenient,
-            :lowercase_expanded_terms,
-            :preference,
-            :q,
-            :routing,
-            :scroll,
-            :search_type,
-            :size,
-            :sort,
-            :source,
-            :stats,
-            :suggest_field,
-            :suggest_mode,
-            :suggest_size,
-            :suggest_text,
-            :timeout,
-            :version ].include?(k)
-        end
-        # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-        params = Hash[params] unless params.is_a?(Hash)
+
+        params = Utils.__validate_and_extract_params arguments, valid_params
         body   = arguments[:body]
 
         params[:fields] = Utils.__listify(params[:fields]) if params[:fields]

data/lib/elasticsearch/api/actions/suggest.rb

@@ -27,16 +27,16 @@ module Elasticsearch
       # @see http://elasticsearch.org/guide/reference/api/search/suggest/
       #
       def suggest(arguments={})
+        valid_params = [
+          :ignore_indices,
+          :preference,
+          :routing,
+          :source ]
+
         method = 'POST'
         path   = Utils.__pathify( Utils.__listify(arguments[:index]), '_suggest' )
-        params = arguments.select do |k,v|
-          [ :ignore_indices,
-            :preference,
-            :routing,
-            :source ].include?(k)
-        end
-        # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-        params = Hash[params] unless params.is_a?(Hash)
+
+        params = Utils.__validate_and_extract_params arguments, valid_params
         body   = arguments[:body]
 
         perform_request(method, path, params, body).body

data/lib/elasticsearch/api/actions/update.rb

@@ -65,27 +65,31 @@ module Elasticsearch
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
         raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
+
+        valid_params = [
+          :consistency,
+          :fields,
+          :lang,
+          :parent,
+          :percolate,
+          :refresh,
+          :replication,
+          :retry_on_conflict,
+          :routing,
+          :script,
+          :timeout,
+          :timestamp,
+          :ttl,
+          :version,
+          :version_type ]
+
         method = 'POST'
-        path   = Utils.__pathify( arguments[:index], arguments[:type], arguments[:id], '_update' )
-        params = arguments.select do |k,v|
-          [ :consistency,
-            :fields,
-            :lang,
-            :parent,
-            :percolate,
-            :refresh,
-            :replication,
-            :retry_on_conflict,
-            :routing,
-            :script,
-            :timeout,
-            :timestamp,
-            :ttl,
-            :version,
-            :version_type ].include?(k)
-        end
-        # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
-        params = Hash[params] unless params.is_a?(Hash)
+        path   = Utils.__pathify Utils.__escape(arguments[:index]),
+                                 Utils.__escape(arguments[:type]),
+                                 Utils.__escape(arguments[:id]),
+                                 '_update'
+
+        params = Utils.__validate_and_extract_params arguments, valid_params
         body   = arguments[:body]
 
         params[:fields] = Utils.__listify(params[:fields]) if params[:fields]

data/lib/elasticsearch/api/utils.rb

@@ -8,14 +8,15 @@ module Elasticsearch
       # URL-escape a string
       #
       # @example
+      #     __escape('foo/bar') # => 'foo%2Fbar'
       #     __escape('bar^bam') # => 'bar%5Ebam'
       #
       # @api private
       def __escape(string)
-        URI.encode(string.to_s)
+        defined?(EscapeUtils) ? EscapeUtils.escape_url(string.to_s) : CGI.escape(string.to_s)
       end
 
-      # Create a "list" of values from arguments, ignoring nil values
+      # Create a "list" of values from arguments, ignoring nil values and encoding special characters.
       #
       # @example Create a list from array
       #     __listify(['A','B']) # => 'A,B'
@@ -23,13 +24,22 @@ module Elasticsearch
       # @example Create a list from arguments
       #     __listify('A','B') # => 'A,B'
       #
+      # @example Escape values
+      #     __listify('foo','bar^bam') # => 'foo,bar%5Ebam'
+      #
       # @api private
       def __listify(*list)
-        Array(list).flatten.compact.join(',')
+        # require 'pry'
+        # binding.pry
+        Array(list).flatten.
+          map { |e| e.respond_to?(:split) ? e.split(',') : e }.
+          flatten.
+          compact.
+          map { |e| __escape(e) }.
+          join(',')
       end
 
-      # Create a path (URL part) from arguments, ignoring nil values and empty strings,
-      # and encoding special characters
+      # Create a path (URL part) from arguments, ignoring nil values and empty strings.
       #
       # @example Create a path from array
       #     __pathify(['foo', '', nil, 'bar']) # => 'foo/bar'
@@ -45,7 +55,6 @@ module Elasticsearch
         Array(segments).flatten.
           compact.
           reject { |s| s.to_s =~ /^\s*$/ }.
-          map    { |s| __escape(s) }.
           join('/').
           squeeze('/')
       end
@@ -91,6 +100,35 @@ module Elasticsearch
         payload = payload.join("\n")
       end
 
+      # Validates the argument Hash against common and valid API parameters
+      #
+      # @param arguments [Hash]             Hash of arguments to verify and extract, **with symbolized keys**
+      # @param valid_params [Array<Symbol>] An array of symbols with valid keys
+      #
+      # @return [Hash]         Return whitelisted Hash
+      # @raise [ArgumentError] If the arguments Hash contains invalid keys
+      #
+      # @example Extract parameters
+      #   __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]
+      #   # ArgumentError: "URL parameter 'bam' is not supported"
+      #
+      # @api private
+      #
+      def __validate_and_extract_params(arguments, valid_params=[])
+        arguments.each do |k,v|
+          raise ArgumentError, "URL parameter '#{k}' is not supported" \
+            unless valid_params.include?(k) || COMMON_PARAMS.include?(k)
+        end
+
+        params = arguments.select { |k,v| valid_params.include?(k) }
+        params = Hash[params] unless params.is_a?(Hash) # Normalize Ruby 1.8 and Ruby 1.9 Hash#select behaviour
+        params
+      end
+
       extend self
     end
   end

data/lib/elasticsearch/api/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module API
-    VERSION = "0.4.0"
+    VERSION = "0.4.1"
   end
 end