elastomer-client 0.7.0 → 0.8.1

data/lib/elastomer/client/delete_by_query.rb

@@ -60,7 +60,7 @@ module Elastomer
         @client = client
         @query = query
         @params = params
-        @response_stats = { 'took' => 0, '_indices' => { '_all' => {} }, 'failures' => [] }
+        @response_stats = { "took" => 0, "_indices" => { "_all" => {} }, "failures" => [] }
       end
 
       attr_reader :client, :query, :params, :response_stats
@@ -95,9 +95,9 @@ module Elastomer
       # item - A bulk response item
       def accumulate(item)
         item = item["delete"]
-        (@response_stats['_indices'][item['_index']] ||= {}).merge!(categorize(item)) { |_, n, m| n + m }
-        @response_stats['_indices']['_all'].merge!(categorize(item)) { |_, n, m| n + m }
-        @response_stats['failures'] << item unless is_ok? item['status']
+        (@response_stats["_indices"][item["_index"]] ||= {}).merge!(categorize(item)) { |_, n, m| n + m }
+        @response_stats["_indices"]["_all"].merge!(categorize(item)) { |_, n, m| n + m }
+        @response_stats["failures"] << item unless is_ok? item["status"]
       end
 
       # Perform the Delete by Query action
@@ -105,13 +105,13 @@ module Elastomer
       # Returns a Hash of statistics about the bulk operation
       def execute
         ops = Enumerator.new do |yielder|
-          @client.scan(@query, @params).each_document do |hit|
-            yielder.yield([:delete, { _id: hit["_id"], _type: hit["_type"], _index: hit["_index"] }])
+          @client.scan(@query, @params.merge(:_source => false)).each_document do |hit|
+            yielder.yield([:delete, { :_id => hit["_id"], :_type => hit["_type"], :_index => hit["_index"] }])
           end
         end
 
         stats = @client.bulk_stream_items(ops, @params) { |item| accumulate(item) }
-        @response_stats['took'] = stats['took']
+        @response_stats["took"] = stats["took"]
         @response_stats
       end
 

data/lib/elastomer/client/docs.rb

@@ -26,8 +26,8 @@ module Elastomer
       #
       def initialize( client, name, type = nil )
         @client = client
-        @name   = @client.assert_param_presence(name, 'index name') unless name.nil?
-        @type   = @client.assert_param_presence(type, 'document type') unless type.nil?
+        @name   = @client.assert_param_presence(name, "index name") unless name.nil?
+        @type   = @client.assert_param_presence(type, "document type") unless type.nil?
       end
 
       attr_reader :client, :name, :type
@@ -68,15 +68,15 @@ module Elastomer
       def index( document, params = {} )
         overrides = from_document document
         params = update_params(params, overrides)
-        params[:action] = 'docs.index'
+        params[:action] = "docs.index"
 
         params.delete(:id) if params[:id].nil? || params[:id].to_s =~ /\A\s*\z/
 
         response =
             if params[:id]
-              client.put '/{index}/{type}/{id}', params
+              client.put "/{index}/{type}/{id}", params
             else
-              client.post '/{index}/{type}', params
+              client.post "/{index}/{type}", params
             end
 
         response.body
@@ -92,7 +92,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")
         response.body
       end
 
@@ -106,7 +106,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")
         response.body
       end
 
@@ -120,7 +120,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")
         response.success?
       end
       alias_method :exist?, :exists?
@@ -135,7 +135,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")
         response.body
       end
 
@@ -149,9 +149,9 @@ module Elastomer
       # Returns the response body as a Hash
       def multi_get( body, params = {} )
         overrides = from_document body
-        overrides[:action] = 'docs.multi_get'
+        overrides[:action] = "docs.multi_get"
 
-        response = client.get '{/index}{/type}/_mget', update_params(params, overrides)
+        response = client.get "{/index}{/type}/_mget", update_params(params, overrides)
         response.body
       end
       alias_method :mget, :multi_get
@@ -166,9 +166,9 @@ module Elastomer
       # Returns the response body as a Hash
       def update( script, params = {} )
         overrides = from_document script
-        overrides[:action] = 'docs.update'
+        overrides[:action] = "docs.update"
 
-        response = client.post '/{index}/{type}/{id}/_update', update_params(params, overrides)
+        response = client.post "/{index}/{type}/{id}/_update", update_params(params, overrides)
         response.body
       end
 
@@ -197,7 +197,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")
         response.body
       end
 
@@ -215,7 +215,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")
         response.body
       end
 
@@ -242,7 +242,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")
         response.body
       end
 
@@ -261,6 +261,38 @@ module Elastomer
         @client.delete_by_query(query, update_params(params))
       end
 
+      # Matches a provided or existing document to the stored percolator
+      # queries. To match an existing document, pass `nil` as the body and
+      # include `:id` in the params.
+      #
+      # Examples
+      #
+      #   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.body
+      end
+
+      # Counts the queries that match a provided or existing document. To count
+      # matches for an existing document, pass `nil` as the body and include
+      # `:id` in the params.
+      #
+      # Examples
+      #
+      #   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.body["total"]
+      end
+
       # Returns information and statistics on terms in the fields of a
       # particular document as stored in the index. The :id is provided as part
       # of the params hash.
@@ -272,7 +304,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}/_termvector", update_params(params, :action => "docs.termvector")
         response.body
       end
       alias_method :termvectors, :termvector
@@ -290,7 +322,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")
         response.body
       end
       alias_method :multi_term_vectors, :multi_termvectors
@@ -322,7 +354,7 @@ Percolate
       def more_like_this( query, params = nil )
         query, params = extract_params(query) if params.nil?
 
-        response = client.get '/{index}/{type}/{id}/_mlt', update_params(params, :body => query, :action => 'docs.more_like_this')
+        response = client.get "/{index}/{type}/{id}/_mlt", update_params(params, :body => query, :action => "docs.more_like_this")
         response.body
       end
 
@@ -346,7 +378,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")
         response.body
       end
 
@@ -371,7 +403,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")
         response.body
       end
 
@@ -397,7 +429,7 @@ Percolate
       #
       # Returns the response body as a Hash
       def bulk( params = {}, &block )
-        raise 'a block is required' if block.nil?
+        raise "a block is required" if block.nil?
 
         params = {:index => self.name, :type => self.type}.merge params
         client.bulk params, &block
@@ -481,12 +513,37 @@ Percolate
       #
       # Returns the response body as a Hash
       def multi_search( params = {}, &block )
-        raise 'a block is required' if block.nil?
+        raise "a block is required" if block.nil?
 
         params = {:index => self.name, :type => self.type}.merge params
         client.multi_search params, &block
       end
 
+      # Execute an array of percolate actions in bulk. Results are returned in
+      # an array in the order the actions were sent. The current index name and
+      # type will be passed to the API call as part of the request parameters.
+      #
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-percolate.html#_multi_percolate_api
+      #
+      # params - Optional request parameters as a Hash
+      # block  - Passed to a MultiPercolate instance which assembles the
+      #          percolate actions into a single request.
+      #
+      # Examples
+      #
+      #   # block form
+      #   multi_percolate do |m|
+      #     m.percolate(:author => "pea53")
+      #     m.count(:author => "grantr")
+      #     ...
+      #   end
+      #
+      # Returns the response body as a Hash
+      def multi_percolate(params = {}, &block)
+        params = defaults.merge params
+        client.multi_percolate(params, &block)
+      end
+
       SPECIAL_KEYS = %w[index type id version version_type op_type routing parent timestamp ttl consistency replication refresh].freeze
       SPECIAL_KEYS_HASH = SPECIAL_KEYS.inject({}) { |h, k| h[k.to_sym] = "_#{k}"; h }.freeze
 
@@ -523,7 +580,7 @@ Percolate
       def update_params( params, overrides = nil )
         h = defaults.update params
         h.update overrides unless overrides.nil?
-        h[:routing] = h[:routing].join(',') if Array === h[:routing]
+        h[:routing] = h[:routing].join(",") if Array === h[:routing]
         h
       end
 

data/lib/elastomer/client/errors.rb

@@ -29,11 +29,11 @@ module Elastomer
           @status = response.status
           body = response.body
 
-          message = body.is_a?(Hash) && body['error'] || body.to_s
+          message = body.is_a?(Hash) && body["error"] || body.to_s
           super message
 
         else
-          super args.join(' ')
+          super args.join(" ")
         end
       end
 

data/lib/elastomer/client/index.rb

@@ -24,7 +24,7 @@ module Elastomer
       #
       def initialize( client, name )
         @client = client
-        @name   = @client.assert_param_presence(name, 'index name') unless name.nil?
+        @name   = @client.assert_param_presence(name, "index name") unless name.nil?
       end
 
       attr_reader :client, :name
@@ -40,7 +40,7 @@ module Elastomer
       #
       # Returns true if the index (or type) exists
       def exists?( params = {} )
-        response = client.head '/{index}{/type}', update_params(params, :action => 'index.exists')
+        response = client.head "/{index}{/type}", update_params(params, :action => "index.exists")
         response.success?
       end
       alias_method :exist?, :exists?
@@ -54,7 +54,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def create( body, params = {} )
-        response = client.post '/{index}', update_params(params, :body => body, :action => 'index.create')
+        response = client.post "/{index}", update_params(params, :body => body, :action => "index.create")
         response.body
       end
 
@@ -66,7 +66,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def delete( params = {} )
-        response = client.delete '/{index}', update_params(params, :action => 'index.delete')
+        response = client.delete "/{index}", update_params(params, :action => "index.delete")
         response.body
       end
 
@@ -78,7 +78,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def open( params = {} )
-        response = client.post '/{index}/_open', update_params(params, :action => 'index.open')
+        response = client.post "/{index}/_open", update_params(params, :action => "index.open")
         response.body
       end
 
@@ -90,7 +90,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def close( params = {} )
-        response = client.post '/{index}/_close', update_params(params, :action => 'index.close')
+        response = client.post "/{index}/_close", update_params(params, :action => "index.close")
         response.body
       end
 
@@ -102,7 +102,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def get_settings( params = {} )
-        response = client.get '{/index}/_settings', update_params(params, :action => 'index.get_settings')
+        response = client.get "{/index}/_settings", update_params(params, :action => "index.get_settings")
         response.body
       end
       alias_method :settings, :get_settings
@@ -116,7 +116,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def update_settings( body, params = {} )
-        response = client.put '{/index}/_settings', update_params(params, :body => body, :action => 'index.update_settings')
+        response = client.put "{/index}/_settings", update_params(params, :body => body, :action => "index.update_settings")
         response.body
       end
 
@@ -130,7 +130,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def get_mapping( params = {} )
-        response = client.get '/{index}{/type}/_mapping', update_params(params, :action => 'index.get_mapping')
+        response = client.get "/{index}{/type}/_mapping", update_params(params, :action => "index.get_mapping")
         response.body
       end
       alias_method :mapping, :get_mapping
@@ -145,7 +145,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def update_mapping( type, body, params = {} )
-        response = client.put '/{index}/{type}/_mapping', update_params(params, :body => body, :type => type, :action => 'index.update_mapping')
+        response = client.put "/{index}/{type}/_mapping", update_params(params, :body => body, :type => type, :action => "index.update_mapping")
         response.body
       end
       alias_method :put_mapping, :update_mapping
@@ -160,7 +160,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def delete_mapping( type, params = {} )
-        response = client.delete '/{index}/{type}', update_params(params, :type => type, :action => 'index.delete_mapping')
+        response = client.delete "/{index}/{type}", update_params(params, :type => type, :action => "index.delete_mapping")
         response.body
       end
 
@@ -172,7 +172,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def get_aliases( params = {} )
-        response = client.get '/{index}/_aliases', update_params(:action => 'index.get_aliases')
+        response = client.get "/{index}/_aliases", update_params(:action => "index.get_aliases")
         response.body
       end
       alias_method :aliases, :get_aliases
@@ -193,7 +193,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def get_alias( name, params = {} )
-        response = client.get '/{index}/_alias/{name}', update_params(params, :name => name, :action => 'index.get_alias')
+        response = client.get "/{index}/_alias/{name}", update_params(params, :name => name, :action => "index.get_alias")
         response.body
       end
 
@@ -212,7 +212,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def add_alias( name, params = {} )
-        response = client.put '/{index}/_alias/{name}', update_params(params, :name => name, :action => 'index.add_alias')
+        response = client.put "/{index}/_alias/{name}", update_params(params, :name => name, :action => "index.add_alias")
         response.body
       end
 
@@ -230,7 +230,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def delete_alias( name, params = {} )
-        response = client.delete '/{index}/_alias/{name}', update_params(params, :name => name, :action => 'index.delete_alias')
+        response = client.delete "/{index}/_alias/{name}", update_params(params, :name => name, :action => "index.delete_alias")
         response.body
       end
 
@@ -243,7 +243,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def analyze( text, params = {} )
-        response = client.get '{/index}/_analyze', update_params(params, :body => text.to_s, :action => 'index.analyze')
+        response = client.get "{/index}/_analyze", update_params(params, :body => text.to_s, :action => "index.analyze")
         response.body
       end
 
@@ -257,7 +257,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def refresh( params = {} )
-        response = client.post '{/index}/_refresh', update_params(params, :action => 'index.refresh')
+        response = client.post "{/index}/_refresh", update_params(params, :action => "index.refresh")
         response.body
       end
 
@@ -270,7 +270,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def flush( params = {} )
-        response = client.post '{/index}/_flush', update_params(params, :action => 'index.flush')
+        response = client.post "{/index}/_flush", update_params(params, :action => "index.flush")
         response.body
       end
 
@@ -284,7 +284,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def optimize( params = {} )
-        response = client.post '{/index}/_optimize', update_params(params, :action => 'index.optimize')
+        response = client.post "{/index}/_optimize", update_params(params, :action => "index.optimize")
         response.body
       end
 
@@ -300,7 +300,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def snapshot( params = {} )
-        response = client.post '{/index}/_gateway/snapshot', update_params(params, :action => 'index.snapshot')
+        response = client.post "{/index}/_gateway/snapshot", update_params(params, :action => "index.snapshot")
         response.body
       end
 
@@ -313,7 +313,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def recovery( params = {} )
-        response = client.get '{/index}/_recovery', update_params(params, :action => 'index.recovery')
+        response = client.get "{/index}/_recovery", update_params(params, :action => "index.recovery")
         response.body
       end
 
@@ -327,7 +327,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def clear_cache( params = {} )
-        response = client.post '{/index}/_cache/clear', update_params(params, :action => 'index.clear_cache')
+        response = client.post "{/index}/_cache/clear", update_params(params, :action => "index.clear_cache")
         response.body
       end
 
@@ -340,7 +340,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def stats( params = {} )
-        response = client.get '{/index}/_stats', update_params(params, :action => 'index.stats')
+        response = client.get "{/index}/_stats", update_params(params, :action => "index.stats")
         response.body
       end
 
@@ -355,7 +355,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def status( params = {} )
-        response = client.get '{/index}/_status', update_params(params, :action => 'index.status')
+        response = client.get "{/index}/_status", update_params(params, :action => "index.status")
         response.body
       end
 
@@ -368,7 +368,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def segments( params = {} )
-        response = client.get '{/index}/_segments', update_params(params, :action => 'index.segments')
+        response = client.get "{/index}/_segments", update_params(params, :action => "index.segments")
         response.body
       end
 
@@ -407,7 +407,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def bulk( params = {}, &block )
-        raise 'a block is required' if block.nil?
+        raise "a block is required" if block.nil?
 
         params = {:index => self.name}.merge params
         client.bulk params, &block
@@ -495,12 +495,37 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def multi_search( params = {}, &block )
-        raise 'a block is required' if block.nil?
+        raise "a block is required" if block.nil?
 
         params = {:index => self.name}.merge params
         client.multi_search params, &block
       end
 
+      # Execute an array of percolate actions in bulk. Results are returned in
+      # an array in the order the actions were sent. The current index name will
+      # be passed to the API call as part of the request parameters.
+      #
+      # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-percolate.html#_multi_percolate_api
+      #
+      # params - Optional request parameters as a Hash
+      # block  - Passed to a MultiPercolate instance which assembles the
+      #          percolate actions into a single request.
+      #
+      # Examples
+      #
+      #   # block form
+      #   multi_percolate do |m|
+      #     m.percolate({ :author => "pea53" }, { :type => 'default-type' })
+      #     m.count({ :author => "pea53" }, { :type => 'type2' })
+      #     ...
+      #   end
+      #
+      # Returns the response body as a Hash
+      def multi_percolate(params = {}, &block)
+        params = defaults.merge params
+        client.multi_percolate(params, &block)
+      end
+
       # Provides access to warmer API commands. Index warmers run search
       # requests to warm up the index before it is available for
       # searching. Warmers are useful for searches that require heavy
@@ -519,8 +544,8 @@ module Elastomer
       # See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-warmers.html
       #
       # Returns a new Warmer instance
-      def warmer( warmer_name )
-        client.warmer(name, warmer_name)
+      def warmer(warmer_name)
+        Warmer.new(client, name, warmer_name)
       end
 
       # Delete documents from one or more indices and one or more types based
@@ -533,6 +558,17 @@ module Elastomer
         docs.delete_by_query(query, params)
       end
 
+      # Constructs a Percolator with the given id on this index.
+      #
+      # Examples
+      #
+      #   index.percolator "1"
+      #
+      # Returns a Percolator
+      def percolator(id)
+        Percolator.new(client, name, id)
+      end
+
       # Internal: Add default parameters to the `params` Hash and then apply
       # `overrides` to the params if any are given.
       #