elastomer-client 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 149f340281bffddc3fac2a8a783890725da2ee30
-  data.tar.gz: e25c7f445e3002c6c751fca4119e7abc6311885b
+  metadata.gz: 2d22300f2c0a799c8b2253f60928f24d7da61e39
+  data.tar.gz: 19e135b931dece3946b68469ad52f56dcb9b8271
 SHA512:
-  metadata.gz: b738a0e0c1ee712fcdd2143996415b419203fc55c692e38d0ccc8c44caa0795f843e8da880a6ea4b4d346f65bdfbfcd6cd45c57db7d7fa00387c467cb0d3c36f
-  data.tar.gz: 3622c6b76c88e224f38587acd480f3bb2875abfe15e2a29ba7c00c1ea12c1166c1ef8522d93425e1a44b078f9a0d8515446a4682a4923787cb165a03c2f75228
+  metadata.gz: cebdfe02683dee2502e7beb39040dc876884d44656b2f0f5a0aa071621cd6c89be23a39c88b2b0185bc1035c76f01dd42748e1b5cdd14a13ecf5fa1c93696b7f
+  data.tar.gz: 06bbcedac35ee8a1a947b3fcb87c6e451d05d03f390971f5de678c3298b1924414e22cc062459ef378d872134a8d36b5f92cbb903d9c35b7aa923f8055b1d977

data/.gitignore

@@ -1,4 +1,5 @@
 /bin
+/vendor/elasticsearch
 /vendor/gems
 /.bundle
 /.rbenv-version

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.1.0 (2018-01-19)
+- Added the `strict_params` flag for enforcing params passed to the REST API
+- Added the `RestApiSpec` module and classes for enforcing strict params
+
 ## 3.0.1 (2017-12-20)
 - Fixed argument passing to `app_delete_by_query`
 - Explicitly close scroll search contexts when scroll is complete

data/lib/elastomer/client/bulk.rb

@@ -38,7 +38,7 @@ module Elastomer
         raise "bulk request body cannot be nil" if body.nil?
         params ||= {}
 
-        response = self.post "{/index}{/type}/_bulk", params.merge(:body => body, :action => "bulk")
+        response = self.post "{/index}{/type}/_bulk", params.merge(body: body, action: "bulk", rest_api: "bulk")
         response.body
       end
     end

data/lib/elastomer/client/cluster.rb

@@ -34,7 +34,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def health( params = {} )
-        response = client.get "/_cluster/health{/index}", params.merge(action: "cluster.health")
+        response = client.get "/_cluster/health{/index}", params.merge(action: "cluster.health", rest_api: "cluster.health")
         response.body
       end
 
@@ -52,7 +52,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def state( params = {} )
-        response = client.get "/_cluster/state{/metrics}{/indices}", params.merge(action: "cluster.state")
+        response = client.get "/_cluster/state{/metrics}{/indices}", params.merge(action: "cluster.state", rest_api: "cluster.state")
         response.body
       end
 
@@ -67,7 +67,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def stats( params = {} )
-        response = client.get "/_cluster/stats", params.merge(action: "cluster.stats")
+        response = client.get "/_cluster/stats", params.merge(action: "cluster.stats", rest_api: "cluster.stats")
         response.body
       end
 
@@ -80,7 +80,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def pending_tasks( params = {} )
-        response = client.get "/_cluster/pending_tasks", params.merge(action: "cluster.pending_tasks")
+        response = client.get "/_cluster/pending_tasks", params.merge(action: "cluster.pending_tasks", rest_api: "cluster.pending_tasks")
         response.body
       end
 
@@ -101,7 +101,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def get_settings( params = {} )
-        response = client.get "/_cluster/settings", params.merge(action: "cluster.get_settings")
+        response = client.get "/_cluster/settings", params.merge(action: "cluster.get_settings", rest_api: "cluster.get_settings")
         response.body
       end
       alias_method :settings, :get_settings
@@ -117,7 +117,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def update_settings( body, params = {} )
-        response = client.put "/_cluster/settings", params.merge(body: body, action: "cluster.update_settings")
+        response = client.put "/_cluster/settings", params.merge(body: body, action: "cluster.update_settings", rest_api: "cluster.put_settings")
         response.body
       end
 
@@ -157,20 +157,7 @@ module Elastomer
           body = {commands: Array(commands)}
         end
 
-        response = client.post "/_cluster/reroute", params.merge(body: body, action: "cluster.reroute")
-        response.body
-      end
-
-      # Shutdown the entire cluster. There is also a Nodes#shutdown method for
-      # shutting down individual nodes.
-      #
-      # params - Parameters Hash
-      #
-      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-shutdown.html
-      #
-      # Returns the response as a Hash
-      def shutdown( params = {} )
-        response = client.post "/_shutdown", params.merge(action: "cluster.shutdown")
+        response = client.post "/_cluster/reroute", params.merge(body: body, action: "cluster.reroute", rest_api: "cluster.reroute")
         response.body
       end
 
@@ -181,6 +168,7 @@ module Elastomer
       #
       # params - Parameters Hash
       #   :index - an index name or Array of index names
+      #   :name  - an alias name or Array of alias names
       #
       # Examples
       #
@@ -191,7 +179,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def get_aliases( params = {} )
-        response = client.get "{/index}/_aliases", params.merge(action: "cluster.get_aliases")
+        response = client.get "{/index}/_alias{/name}", params.merge(action: "cluster.get_aliases", rest_api: "indices.get_alias")
         response.body
       end
       alias_method :aliases, :get_aliases
@@ -227,7 +215,7 @@ module Elastomer
           body = {actions: Array(actions)}
         end
 
-        response = client.post "/_aliases", params.merge(body: body, action: "cluster.update_aliases")
+        response = client.post "/_aliases", params.merge(body: body, action: "cluster.update_aliases", rest_api: "indices.update_aliases")
         response.body
       end
 

data/lib/elastomer/client/docs.rb

@@ -15,7 +15,6 @@ module Elastomer
       Docs.new self, name, type
     end
 
-
     class Docs
       # Create a new document client for making API requests that pertain to
       # the indexing and searching of documents in a search index.
@@ -79,7 +78,7 @@ module Elastomer
       def index( document, params = {} )
         overrides = from_document document
         params = update_params(params, overrides)
-        params[:action] = "docs.index"
+        params.merge!(action: "docs.index", rest_api: "index")
 
         params.delete(:id) if params[:id].nil? || params[:id].to_s =~ /\A\s*\z/
 
@@ -103,7 +102,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def delete( params = {} )
-        response = client.delete "/{index}/{type}/{id}", update_params(params, :action => "docs.delete")
+        response = client.delete "/{index}/{type}/{id}", update_params(params, action: "docs.delete", rest_api: "delete")
         response.body
       end
 
@@ -117,7 +116,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def get( params = {} )
-        response = client.get "/{index}/{type}/{id}", update_params(params, :action => "docs.get")
+        response = client.get "/{index}/{type}/{id}", update_params(params, action: "docs.get", rest_api: "get")
         response.body
       end
 
@@ -131,7 +130,7 @@ module Elastomer
       #
       # Returns true if the document exists
       def exists?( params = {} )
-        response = client.head "/{index}/{type}/{id}", update_params(params, :action => "docs.exists")
+        response = client.head "/{index}/{type}/{id}", update_params(params, action: "docs.exists", rest_api: "exists")
         response.success?
       end
       alias_method :exist?, :exists?
@@ -146,7 +145,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def source( params = {} )
-        response = client.get "/{index}/{type}/{id}/_source", update_params(params, :action => "docs.source")
+        response = client.get "/{index}/{type}/{id}/_source", update_params(params, action: "docs.source", rest_api: "get_source")
         response.body
       end
 
@@ -160,7 +159,7 @@ module Elastomer
       # Returns the response body as a Hash
       def multi_get( body, params = {} )
         overrides = from_document body
-        overrides[:action] = "docs.multi_get"
+        overrides.merge!(action: "docs.multi_get", rest_api: "mget")
 
         response = client.get "{/index}{/type}/_mget", update_params(params, overrides)
         response.body
@@ -177,7 +176,7 @@ module Elastomer
       # Returns the response body as a Hash
       def update( script, params = {} )
         overrides = from_document script
-        overrides[:action] = "docs.update"
+        overrides.merge!(action: "docs.update", rest_api: "update")
 
         response = client.post "/{index}/{type}/{id}/_update", update_params(params, overrides)
         response.body
@@ -195,10 +194,10 @@ module Elastomer
       # Examples
       #
       #   # request body query
-      #   search({:query => {:match_all => {}}}, :type => 'tweet')
+      #   search({query: {match_all: {}}}, type: 'tweet')
       #
       #   # same thing but using the URI request method
-      #   search(:q => '*:*', :type => 'tweet')
+      #   search(q: '*:*', type: 'tweet')
       #
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html
@@ -208,7 +207,7 @@ module Elastomer
       def search( query, params = nil )
         query, params = extract_params(query) if params.nil?
 
-        response = client.get "/{index}{/type}/_search", update_params(params, :body => query, :action => "docs.search")
+        response = client.get "/{index}{/type}/_search", update_params(params, body: query, action: "docs.search", rest_api: "search")
         response.body
       end
 
@@ -226,7 +225,7 @@ module Elastomer
       #
       # Returns the response body as a hash
       def search_shards( params = {} )
-        response = client.get "/{index}{/type}/_search_shards", update_params(params, :action => "docs.search_shards")
+        response = client.get "/{index}{/type}/_search_shards", update_params(params, action: "docs.search_shards", rest_api: "search_shards")
         response.body
       end
 
@@ -242,10 +241,10 @@ module Elastomer
       # Examples
       #
       #   # request body query
-      #   count({:match_all => {}}, :type => 'tweet')
+      #   count({match_all: {}}, type: 'tweet')
       #
       #   # same thing but using the URI request method
-      #   count(:q => '*:*', :type => 'tweet')
+      #   count(q: '*:*', type: 'tweet')
       #
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html
       #
@@ -253,7 +252,7 @@ module Elastomer
       def count( query, params = nil )
         query, params = extract_params(query) if params.nil?
 
-        response = client.get "/{index}{/type}/_count", update_params(params, :body => query, :action => "docs.count")
+        response = client.get "/{index}{/type}/_count", update_params(params, body: query, action: "docs.count", rest_api: "count")
         response.body
       end
 
@@ -304,13 +303,13 @@ module Elastomer
       #
       # Examples
       #
-      #   index.percolator(1).create :query => { :match => { :author => "pea53" } }
-      #   docs.percolate :doc => { :author => "pea53" }
-      #   docs.percolate nil, :id => 3
+      #   index.percolator(1).create query: { match: { author: "pea53" } }
+      #   docs.percolate doc: { author: "pea53" }
+      #   docs.percolate nil, id: 3
       #
       # Returns the response body as a Hash
       def percolate(body, params = {})
-        response = client.get "/{index}/{type}{/id}/_percolate", update_params(params, :body => body, :action => "percolator.percolate")
+        response = client.get "/{index}/{type}{/id}/_percolate", update_params(params, body: body, action: "percolator.percolate", rest_api: "percolate")
         response.body
       end
 
@@ -320,13 +319,13 @@ module Elastomer
       #
       # Examples
       #
-      #   index.register_percolator_query 1, :query => { :match => { :author => "pea53" } }
-      #   docs.percolate_count :doc => { :author => "pea53" }
-      #   docs.percolate_count nil, :id => 3
+      #   index.register_percolator_query 1, query: { match: { author: "pea53" } }
+      #   docs.percolate_count doc: { author: "pea53" }
+      #   docs.percolate_count nil, id: 3
       #
       # Returns the count
       def percolate_count(body, params = {})
-        response = client.get "/{index}/{type}{/id}/_percolate/count", update_params(params, :body => body, :action => "percolator.percolate_count")
+        response = client.get "/{index}/{type}{/id}/_percolate/count", update_params(params, body: body, action: "percolator.percolate_count", rest_api: "count_percolate")
         response.body["total"]
       end
 
@@ -341,7 +340,7 @@ module Elastomer
       #
       # Returns the response body as a hash
       def termvector( params = {} )
-        response = client.get "/{index}/{type}/{id}/_termvector", update_params(params, :action => "docs.termvector")
+        response = client.get "/{index}/{type}/{id}/_termvectors", update_params(params, action: "docs.termvector", rest_api: "termvectors")
         response.body
       end
       alias_method :termvectors, :termvector
@@ -359,7 +358,7 @@ module Elastomer
       #
       # Returns the response body as a hash
       def multi_termvectors( body, params = {} )
-        response = client.get "{/index}{/type}/_mtermvectors", update_params(params, :body => body, :action => "docs.multi_termvectors")
+        response = client.get "{/index}{/type}/_mtermvectors", update_params(params, body: body, action: "docs.multi_termvectors", rest_api: "mtermvectors")
         response.body
       end
       alias_method :multi_term_vectors, :multi_termvectors
@@ -378,9 +377,9 @@ Percolate
       #
       # Examples
       #
-      #   explain({:query => {:term => {"message" => "search"}}}, :id => 1)
+      #   explain({query: {term: {"message" => "search"}}}, id: 1)
       #
-      #   explain(:q => "message:search", :id => 1)
+      #   explain(q: "message:search", id: 1)
       #
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-explain.html
       #
@@ -388,7 +387,7 @@ Percolate
       def explain( query, params = nil )
         query, params = extract_params(query) if params.nil?
 
-        response = client.get "/{index}/{type}/{id}/_explain", update_params(params, :body => query, :action => "docs.explain")
+        response = client.get "/{index}/{type}/{id}/_explain", update_params(params, body: query, action: "docs.explain", rest_api: "explain")
         response.body
       end
 
@@ -402,10 +401,10 @@ Percolate
       # Examples
       #
       #   # request body query
-      #   validate({:query => {:query_string => {:query => "*:*"}}}, :explain => true)
+      #   validate({query: {query_string: {query: "*:*"}}}, explain: true)
       #
       #   # same thing but using the URI query parameter
-      #   validate(:q => "post_date:foo", :explain => true)
+      #   validate(q: "post_date:foo", explain: true)
       #
       # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-validate.html
       #
@@ -413,7 +412,7 @@ Percolate
       def validate( query, params = nil )
         query, params = extract_params(query) if params.nil?
 
-        response = client.get "/{index}{/type}/_validate/query", update_params(params, :body => query, :action => "docs.validate")
+        response = client.get "/{index}{/type}/_validate/query", update_params(params, body: query, action: "docs.validate", rest_api: "indices.validate_query")
         response.body
       end
 
@@ -441,7 +440,7 @@ Percolate
       def bulk( params = {}, &block )
         raise "a block is required" if block.nil?
 
-        params = {:index => self.name, :type => self.type}.merge params
+        params = {index: self.name, type: self.type}.merge params
         client.bulk params, &block
       end
 
@@ -467,7 +466,7 @@ Percolate
       #
       # Returns a new Scroller instance
       def scroll( query, opts = {} )
-        opts = {:index => name, :type => type}.merge opts
+        opts = {index: name, type: type}.merge opts
         client.scroll query, opts
       end
 
@@ -494,7 +493,7 @@ Percolate
       #
       # Returns a new Scroller instance
       def scan( query, opts = {} )
-        opts = {:index => name, :type => type}.merge opts
+        opts = {index: name, type: type}.merge opts
         client.scan query, opts
       end
 
@@ -514,8 +513,8 @@ Percolate
       # Examples
       #
       #   docs.multi_search do |m|
-      #     m.search({:query => {:match_all => {}}, :size => 0)
-      #     m.search({:query => {:field => {"foo" => "bar"}}})
+      #     m.search({query: {match_all: {}}, size: 0)
+      #     m.search({query: {field: {"foo" => "bar"}}})
       #     ...
       #   end
       #
@@ -525,7 +524,7 @@ Percolate
       def multi_search( params = {}, &block )
         raise "a block is required" if block.nil?
 
-        params = {:index => self.name, :type => self.type}.merge params
+        params = {index: self.name, type: self.type}.merge params
         client.multi_search params, &block
       end
 
@@ -543,8 +542,8 @@ Percolate
       #
       #   # block form
       #   multi_percolate do |m|
-      #     m.percolate(:author => "pea53")
-      #     m.count(:author => "grantr")
+      #     m.percolate(author: "pea53")
+      #     m.count(author: "grantr")
       #     ...
       #   end
       #
@@ -554,6 +553,11 @@ Percolate
         client.multi_percolate(params, &block)
       end
 
+      SPECIAL_KEYS= %i[
+        index type id version version_type op_type routing parent timestamp ttl
+        consistency replication refresh wait_for_active_shards
+      ].inject({}) { |h,k| h[k] = "_#{k}"; h }.freeze
+
       # Internal: Given a `document` generate an options hash that will
       # override parameters based on the content of the document. The document
       # will be returned as the value of the :body key.
@@ -568,26 +572,13 @@ Percolate
       # Raises Elastomer::Client::IllegalArgument if an unsupported indexing
       # directive is used.
       def from_document( document )
-        opts = {:body => document}
+        opts = {body: document}
 
         if document.is_a? Hash
-          client.version_support.indexing_directives.each do |key, field|
+          SPECIAL_KEYS.each do |key, field|
             opts[key] = document.delete field if document.key? field
             opts[key] = document.delete field.to_sym if document.key? field.to_sym
           end
-
-          # COMPATIBILITY
-          # Fail fast if a consumer is attempting to use an indexing parameter
-          # for a different version of Elasticsearch. Elasticsearch 5+ is strict
-          # about parameter names so we need to either ignore these (in which
-          # case they would be indexed with the document) or fail-fast.
-          # Elasticsearch 2.X will happily ignore unknown parameters, but we
-          # felt it was best to consistently fail fast.
-          client.version_support.unsupported_indexing_directives.each do |key, field|
-            if document.key?(field) || document.key?(field.to_sym)
-              raise IllegalArgument, "Elasticsearch #{client.version} does not support the '#{key}' indexing parameter"
-            end
-          end
         end
 
         opts
@@ -609,7 +600,7 @@ Percolate
 
       # Internal: Returns a Hash containing default parameters.
       def defaults
-        { :index => name, :type => type }
+        { index: name, type: type }
       end
 
       # Internal: Allow params to be passed as the first argument to