elasticsearch-api 0.4.0 → 0.4.1

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

@@ -37,22 +37,23 @@ module Elasticsearch
       #
       def delete_by_query(arguments={})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+
+        valid_params = [
+          :analyzer,
+          :consistency,
+          :default_operator,
+          :df,
+          :ignore_indices,
+          :replication,
+          :q,
+          :routing,
+          :source,
+          :timeout ]
+
         method = 'DELETE'
         path   = Utils.__pathify( Utils.__listify(arguments[:index]), '/_query' )
-        params = arguments.select do |k,v|
-          [ :analyzer,
-            :consistency,
-            :default_operator,
-            :df,
-            :ignore_indices,
-            :replication,
-            :q,
-            :routing,
-            :source,
-            :timeout ].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/exists.rb

@@ -21,21 +21,23 @@ module Elasticsearch
       # @see http://elasticsearch.org/guide/reference/api/get/
       #
       def exists(arguments={})
-        raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+        raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         arguments[:type] ||= '_all'
 
+        valid_params = [
+          :parent,
+          :preference,
+          :realtime,
+          :refresh,
+          :routing ]
+
         method = 'HEAD'
-        path   = Utils.__pathify( arguments[:index], arguments[:type], arguments[:id] )
-        params = arguments.select do |k,v|
-          [ :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]),
+                                 Utils.__escape(arguments[:id])
+
+        params = Utils.__validate_and_extract_params arguments, valid_params
         body   = nil
 
         perform_request(method, path, params, body).status == 200 ? true : false

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

@@ -35,6 +35,10 @@ module Elasticsearch
       # @option arguments [String] :q Query in the Lucene query string syntax
       # @option arguments [String] :routing Specific routing value
       # @option arguments [String] :source The URL-encoded query definition (instead of using the 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
       #
       # @see http://elasticsearch.org/guide/reference/api/explain/
       #
@@ -42,24 +46,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 = [
+          :analyze_wildcard,
+          :analyzer,
+          :default_operator,
+          :df,
+          :fields,
+          :lenient,
+          :lowercase_expanded_terms,
+          :parent,
+          :preference,
+          :q,
+          :routing,
+          :source,
+          :_source,
+          :_source_include,
+          :_source_exclude ]
+
         method = 'GET'
-        path   = Utils.__pathify( arguments[:index], arguments[:type], arguments[:id], '_explain' )
-        params = arguments.select do |k,v|
-          [ :analyze_wildcard,
-            :analyzer,
-            :default_operator,
-            :df,
-            :fields,
-            :lenient,
-            :lowercase_expanded_terms,
-            :parent,
-            :preference,
-            :q,
-            :routing,
-            :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.__escape(arguments[:index]),
+                                 Utils.__escape(arguments[:type]),
+                                 Utils.__escape(arguments[:id]),
+                                 '_explain'
+
+        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/get.rb

@@ -22,6 +22,10 @@ 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/get/
       #
@@ -30,18 +34,23 @@ module Elasticsearch
         raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
         arguments[:type] ||= '_all'
 
+        valid_params = [
+          :fields,
+          :parent,
+          :preference,
+          :realtime,
+          :refresh,
+          :routing,
+          :_source,
+          :_source_include,
+          :_source_exclude ]
+
         method = 'GET'
-        path   = Utils.__pathify( arguments[:index], arguments[:type], arguments[:id] )
-        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]),
+                                 Utils.__escape(arguments[:id])
+
+        params = Utils.__validate_and_extract_params arguments, valid_params
         body   = nil
 
         params[:fields] = Utils.__listify(params[:fields]) if params[:fields]

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

@@ -22,6 +22,12 @@ 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/get/
       #
       # @since 0.90.1
       #
@@ -30,18 +36,24 @@ module Elasticsearch
         raise ArgumentError, "Required argument 'id' missing"    unless arguments[:id]
         arguments[:type] ||= '_all'
 
+        valid_params = [
+          :fields,
+          :parent,
+          :preference,
+          :realtime,
+          :refresh,
+          :routing,
+          :_source,
+          :_source_include,
+          :_source_exclude ]
+
         method = 'GET'
-        path   = Utils.__pathify( arguments[:index], arguments[:type], arguments[:id], '_source' )
-        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]),
+                                 Utils.__escape(arguments[:id]),
+                                 '_source'
+
+        params = Utils.__validate_and_extract_params arguments, valid_params
         body   = nil
 
         params[:fields] = Utils.__listify(params[:fields]) if params[:fields]

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

@@ -52,26 +52,28 @@ module Elasticsearch
       #
       def index(arguments={})
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
-        raise ArgumentError, "Required argument 'type' missing" unless arguments[:type]
+        raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
+
+        valid_params = [
+          :consistency,
+          :op_type,
+          :parent,
+          :percolate,
+          :refresh,
+          :replication,
+          :routing,
+          :timeout,
+          :timestamp,
+          :ttl,
+          :version,
+          :version_type ]
+
         method = arguments[:id] ? 'PUT' : 'POST'
-        path   = Utils.__pathify( arguments[:index], arguments[:type], arguments[:id] )
-        params = arguments.select do |k,v|
-          [ :consistency,
-            :op_type,
-            :parent,
-            :percolate,
-            :refresh,
-            :replication,
-            :routing,
-            :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])
 
+        params = Utils.__validate_and_extract_params arguments, valid_params
         body   = arguments[:body]
 
         perform_request(method, path, params, body).body

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

@@ -36,21 +36,20 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-analyze/
         #
         def analyze(arguments={})
+          valid_params = [
+            :analyzer,
+            :field,
+            :filters,
+            :index,
+            :prefer_local,
+            :text,
+            :tokenizer,
+            :format ]
+
           method = 'GET'
-          path   = Utils.__pathify( arguments[:index], '_analyze' )
-          params = arguments.select do |k,v|
-            [ :analyzer,
-              :field,
-              :filters,
-              :index,
-              :prefer_local,
-              :text,
-              :tokenizer,
-              :format ].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]), '_analyze'
 
+          params = Utils.__validate_and_extract_params arguments, valid_params
           params[:filters] = Utils.__listify(params[:filters]) if params[:filters]
 
           body   = arguments[:body]

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

@@ -41,22 +41,22 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-clearcache/
         #
         def clear_cache(arguments={})
+          valid_params = [
+            :field_data,
+            :fielddata,
+            :fields,
+            :filter,
+            :filter_cache,
+            :filter_keys,
+            :id,
+            :id_cache,
+            :ignore_indices,
+            :recycler ]
+
           method = 'POST'
-          path   = Utils.__pathify( Utils.__listify(arguments[:index]), '_cache/clear' )
-          params = arguments.select do |k,v|
-            [ :field_data,
-              :fielddata,
-              :fields,
-              :filter,
-              :filter_cache,
-              :filter_keys,
-              :id,
-              :id_cache,
-              :ignore_indices,
-              :recycler ].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]), '_cache/clear'
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil
 
           params[:fields] = Utils.__listify(params[:fields]) if params[:fields]

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

@@ -18,13 +18,12 @@ module Elasticsearch
         #
         def close(arguments={})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          valid_params = [ :timeout ]
+
           method = 'POST'
-          path   = "#{arguments[:index]}/_close"
-          params = arguments.select do |k,v|
-            [ :timeout ].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]), '_close'
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil
 
           perform_request(method, path, params, body).body

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

@@ -66,13 +66,12 @@ module Elasticsearch
         #
         def create(arguments={})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+          valid_params = [ :timeout ]
+
           method = 'PUT'
-          path   = "#{arguments[:index]}"
-          params = arguments.select do |k,v|
-            [ :timeout ].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])
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
           body   = arguments[:body]
 
           perform_request(method, path, params, body).body

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

@@ -31,13 +31,12 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-delete-index/
         #
         def delete(arguments={})
+          valid_params = [ :timeout ]
+
           method = 'DELETE'
-          path   = Utils.__pathify( Utils.__listify(arguments[:index]) )
-          params = arguments.select do |k,v|
-            [ :timeout ].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])
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil
 
           perform_request(method, path, params, body).body

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

@@ -20,13 +20,12 @@ module Elasticsearch
         def delete_alias(arguments={})
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
           raise ArgumentError, "Required argument 'name' missing"  unless arguments[:name]
+          valid_params = [ :timeout ]
+
           method = 'DELETE'
-          path   = "#{arguments[:index]}/_alias/#{arguments[:name]}"
-          params = arguments.select do |k,v|
-            [ :timeout ].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]), '_alias', Utils.__escape(arguments[:name])
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil
 
           perform_request(method, path, params, body).body

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

@@ -14,7 +14,7 @@ module Elasticsearch
           raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
           raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
           method = 'DELETE'
-          path   = Utils.__pathify( Utils.__listify(arguments[:index]), arguments[:type] )
+          path   = Utils.__pathify Utils.__listify(arguments[:index]), Utils.__escape(arguments[:type])
           params = {}
           body   = nil
 

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

@@ -16,13 +16,12 @@ module Elasticsearch
         #
         def delete_template(arguments={})
           raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+          valid_params = [ :timeout ]
+
           method = 'DELETE'
-          path   = "_template/#{arguments[:name]}"
-          params = arguments.select do |k,v|
-            [ :timeout ].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 '_template', Utils.__escape(arguments[:name])
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
           body = nil
 
           perform_request(method, path, params, body).body