elastomer-client 0.7.0 → 0.8.1

data/lib/elastomer/client/multi_percolate.rb

@@ -0,0 +1,127 @@
+module Elastomer
+  class Client
+
+    # Execute an array of percolate actions in bulk. Results are returned in an
+    # array in the order the actions were sent.
+    #
+    # The `multi_percolate` method can be used in two ways. Without a block
+    # the method will perform an API call, and it requires a bulk request
+    # body and optional request parameters.
+    #
+    # See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-percolate.html#_multi_percolate_api
+    #
+    # body   - Request body as a String (required if a block is not given)
+    # params - Optional request parameters as a Hash
+    # block  - Passed to a MultiPercolate instance which assembles the
+    #          percolate actions into a single request.
+    #
+    # Examples
+    #
+    #   # index and type in request body
+    #   multi_percolate(request_body)
+    #
+    #   # index in URI
+    #   multi_percolate(request_body, :index => 'default-index')
+    #
+    #   # block form
+    #   multi_percolate(:index => 'default-index') 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(body = nil, params = nil)
+      if block_given?
+        params, body = (body || {}), nil
+        yield mpercolate_obj = MultiPercolate.new(self, params)
+        mpercolate_obj.call
+      else
+        raise "multi_percolate request body cannot be nil" if body.nil?
+        params ||= {}
+
+        response = self.post "{/index}{/type}/_mpercolate", params.merge(:body => body)
+        response.body
+      end
+    end
+    alias_method :mpercolate, :multi_percolate
+
+    # The MultiPercolate class is a helper for accumulating and submitting
+    # multi_percolate API requests. Instances of the MultiPercolate class
+    # accumulate percolate actions and then issue a single API request to
+    # Elasticsearch, which runs all accumulated percolate actions in parallel
+    # and returns each result hash aggregated into an array of result
+    # hashes.
+    #
+    # Instead of instantiating this class directly, use
+    # the block form of Client#multi_percolate.
+    #
+    class MultiPercolate
+
+      # Create a new MultiPercolate instance for accumulating percolate actions
+      # and submitting them all as a single request.
+      #
+      # client - Elastomer::Client used for HTTP requests to the server
+      # params - Parameters Hash to pass to the Client#multi_percolate method
+      def initialize(client, params = {})
+        @client  = client
+        @params  = params
+
+        @actions = []
+      end
+
+      attr_reader :client
+
+      # Add a percolate action to the multi percolate request. This percolate
+      # action will not be executed until the multi_percolate API call is made.
+      #
+      # header - A Hash of the index and type, if not provided in the params
+      # doc    - A Hash of the document
+      #
+      # Returns this MultiPercolate instance.
+      def percolate(doc, header = {})
+        add_to_actions(:percolate => header)
+        add_to_actions(:doc => doc)
+      end
+
+      # Add a percolate acount action to the multi percolate request. This
+      # percolate count action will not be executed until the multi_percolate
+      # API call is made.
+      #
+      # header - A Hash of the index and type, if not provided in the params
+      # doc    - A Hash of the document
+      #
+      # Returns this MultiPercolate instance.
+      def count(doc, header = {})
+        add_to_actions(:count => header)
+        add_to_actions(:doc => doc)
+      end
+
+      # Execute the multi_percolate call with the accumulated percolate actions.
+      # If the accumulated actions list is empty then no action is taken.
+      #
+      # Returns the response body Hash.
+      def call
+        return if @actions.empty?
+
+        body = @actions.join("\n") + "\n"
+        client.multi_percolate(body, @params)
+      ensure
+        @actions.clear
+      end
+
+      # Internal: Add an action to the pending request. Actions can be
+      # either headers or bodies. The first action must be a percolate header,
+      # followed by a body, then alternating headers and bodies.
+      #
+      # action - the Hash (header or body) to add to the pending request
+      #
+      # Returns this MultiPercolate instance.
+      def add_to_actions(action)
+        action = MultiJson.dump action
+        @actions << action
+        self
+      end
+    end
+  end
+end

data/lib/elastomer/client/multi_search.rb

@@ -37,10 +37,10 @@ module Elastomer
         yield msearch_obj = MultiSearch.new(self, params)
         msearch_obj.call
       else
-        raise 'multi_search request body cannot be nil' if body.nil?
+        raise "multi_search request body cannot be nil" if body.nil?
         params ||= {}
 
-        response = self.post '{/index}{/type}/_msearch', params.merge(:body => body)
+        response = self.post "{/index}{/type}/_msearch", params.merge(:body => body)
         response.body
       end
     end

data/lib/elastomer/client/nodes.rb

@@ -49,7 +49,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def info( params = {} )
-        response = client.get '/_nodes{/node_id}{/info}', update_params(params, :action => 'nodes.info')
+        response = client.get "/_nodes{/node_id}{/info}", update_params(params, :action => "nodes.info")
         response.body
       end
 
@@ -69,7 +69,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def stats( params = {} )
-        response = client.get '/_nodes{/node_id}/stats{/stats}', update_params(params, :action => 'nodes.stats')
+        response = client.get "/_nodes{/node_id}/stats{/stats}", update_params(params, :action => "nodes.stats")
         response.body
       end
 
@@ -87,7 +87,7 @@ module Elastomer
       #
       # Returns the response as a String
       def hot_threads( params = {} )
-        response = client.get '/_nodes{/node_id}/hot_threads', update_params(params, :action => 'nodes.hot_threads')
+        response = client.get "/_nodes{/node_id}/hot_threads", update_params(params, :action => "nodes.hot_threads")
         response.body
       end
 
@@ -101,7 +101,7 @@ module Elastomer
       #
       # Returns the response as a Hash
       def shutdown( params = {} )
-        response = client.post '/_cluster/nodes{/node_id}/_shutdown', update_params(params, :action => 'nodes.shutdown')
+        response = client.post "/_cluster/nodes{/node_id}/_shutdown", update_params(params, :action => "nodes.shutdown")
         response.body
       end
 

data/lib/elastomer/client/percolator.rb

@@ -0,0 +1,77 @@
+module Elastomer
+  class Client
+
+    class Percolator
+
+      # Create a new Percolator for managing a query.
+      #
+      # client     - Elastomer::Client used for HTTP requests to the server
+      # index_name - The index name
+      # id         - The _id for the query
+      def initialize(client, index_name, id)
+        @client = client
+        @index_name = client.assert_param_presence(index_name, "index name")
+        @id = client.assert_param_presence(id, "id")
+      end
+
+      attr_reader :client, :index_name, :id
+
+      # Create a percolator query.
+      #
+      # Examples
+      #
+      #   percolator = $client.index("default-index").percolator "1"
+      #   percolator.create :query => { :match_all => { } }
+      #
+      # Returns the response body as a Hash
+      def create(body, params = {})
+        response = client.put("/{index}/.percolator/{id}", defaults.merge(params.merge(:body => body, :action => "percolator.create")))
+        response.body
+      end
+
+      # Gets a percolator query.
+      #
+      # Examples
+      #
+      #   percolator = $client.index("default-index").percolator "1"
+      #   percolator.get
+      #
+      # Returns the response body as a Hash
+      def get(params = {})
+        response = client.get("/{index}/.percolator/{id}", defaults.merge(params.merge(:action => "percolator.get")))
+        response.body
+      end
+
+      # Delete a percolator query.
+      #
+      # Examples
+      #
+      #   percolator = $client.index("default-index").percolator "1"
+      #   percolator.delete
+      #
+      # Returns the response body as a Hash
+      def delete(params = {})
+        response = client.delete("/{index}/.percolator/{id}", defaults.merge(params.merge(:action => "percolator.delete")))
+        response.body
+      end
+
+      # Checks for the existence of a percolator query.
+      #
+      # Examples
+      #
+      #   percolator = $client.index("default-index").percolator "1"
+      #   percolator.exists?
+      #
+      # Returns a boolean
+      def exists?(params = {})
+        get(params)["found"]
+      end
+
+      # Internal: Returns a Hash containing default parameters.
+      def defaults
+        {:index => index_name, :id => id}
+      end
+
+    end  # Percolator
+  end  # Client
+end  # Elastomer

data/lib/elastomer/client/repository.rb

@@ -14,7 +14,7 @@ module Elastomer
       # name   - The name of the index as a String or an Array of names
       def initialize(client, name = nil)
         @client = client
-        @name   = @client.assert_param_presence(name, 'repository name') unless name.nil?
+        @name   = @client.assert_param_presence(name, "repository name") unless name.nil?
       end
 
       attr_reader :client, :name
@@ -26,7 +26,7 @@ module Elastomer
       #
       # Returns true if the repository exists
       def exists?(params = {})
-        response = client.get '/_snapshot{/repository}', update_params(params, :action => 'repository.exists')
+        response = client.get "/_snapshot{/repository}", update_params(params, :action => "repository.exists")
         response.success?
       rescue Elastomer::Client::Error => exception
         if exception.message =~ /RepositoryMissingException/
@@ -45,7 +45,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def create(body, params = {})
-        response = client.put '/_snapshot/{repository}', update_params(params, :body => body, :action => 'repository.create')
+        response = client.put "/_snapshot/{repository}", update_params(params, :body => body, :action => "repository.create")
         response.body
       end
 
@@ -56,7 +56,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def get(params = {})
-        response = client.get '/_snapshot{/repository}', update_params(params, :action => 'repository.get')
+        response = client.get "/_snapshot{/repository}", update_params(params, :action => "repository.get")
         response.body
       end
 
@@ -67,7 +67,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def status(params = {})
-        response = client.get '/_snapshot{/repository}/_status', update_params(params, :action => 'repository.status')
+        response = client.get "/_snapshot{/repository}/_status", update_params(params, :action => "repository.status")
         response.body
       end
 
@@ -79,7 +79,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def update(body, params = {})
-        response = client.put '/_snapshot/{repository}', update_params(params, :body => body, :action => 'repository.update')
+        response = client.put "/_snapshot/{repository}", update_params(params, :body => body, :action => "repository.update")
         response.body
       end
 
@@ -90,7 +90,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def delete(params = {})
-        response = client.delete '/_snapshot/{repository}', update_params(params, :action => 'repository.delete')
+        response = client.delete "/_snapshot/{repository}", update_params(params, :action => "repository.delete")
         response.body
       end
 

data/lib/elastomer/client/scroller.rb

@@ -43,7 +43,7 @@ module Elastomer
     #
     # Returns a new Scroller instance
     def scan( query, opts = {} )
-      opts = opts.merge(:search_type => 'scan')
+      opts = opts.merge(:search_type => "scan")
       Scroller.new(self, query, opts)
     end
 
@@ -72,8 +72,8 @@ module Elastomer
     #
     # Returns the response body as a Hash.
     def start_scroll( opts = {} )
-      opts = opts.merge :action => 'search.start_scroll'
-      response = get '{/index}{/type}/_search', opts
+      opts = opts.merge :action => "search.start_scroll"
+      response = get "{/index}{/type}/_search", opts
       response.body
     end
 
@@ -96,15 +96,15 @@ module Elastomer
     #   # repeat until the results are empty
     #
     # Returns the response body as a Hash.
-    def continue_scroll( scroll_id, scroll = '5m' )
-      response = get '/_search/scroll', :body => scroll_id, :scroll => scroll, :action => 'search.scroll'
+    def continue_scroll( scroll_id, scroll = "5m" )
+      response = get "/_search/scroll", :body => scroll_id, :scroll => scroll, :action => "search.scroll"
       response.body
     end
 
     DEFAULT_OPTS = {
       :index => nil,
       :type => nil,
-      :scroll => '5m',
+      :scroll => "5m",
       :size => 50,
     }.freeze
 
@@ -165,11 +165,11 @@ module Elastomer
         loop do
           body = do_scroll
 
-          hits = body['hits']
-          break if hits['hits'].empty?
+          hits = body["hits"]
+          break if hits["hits"].empty?
 
-          hits['offset'] = @offset
-          @offset += hits['hits'].length
+          hits["offset"] = @offset
+          @offset += hits["hits"].length
 
           yield hits
         end
@@ -195,7 +195,7 @@ module Elastomer
       #
       # Returns this Scan instance.
       def each_document( &block )
-        each { |hits| hits['hits'].each(&block) }
+        each { |hits| hits["hits"].each(&block) }
       end
 
       # Internal: Perform the actual scroll requests. This method wil call out
@@ -206,15 +206,15 @@ module Elastomer
       def do_scroll
         if scroll_id.nil?
           body = client.start_scroll(@opts)
-          if body['hits']['hits'].empty?
-            @scroll_id = body['_scroll_id']
+          if body["hits"]["hits"].empty?
+            @scroll_id = body["_scroll_id"]
             return do_scroll
           end
         else
           body = client.continue_scroll(scroll_id, @opts[:scroll])
         end
 
-        @scroll_id = body['_scroll_id']
+        @scroll_id = body["_scroll_id"]
         body
       end
 

data/lib/elastomer/client/snapshot.rb

@@ -22,8 +22,8 @@ module Elastomer
       def initialize(client, repository = nil, name = nil)
         @client     = client
         # don't allow nil repository if snapshot name is not nil
-        @repository = @client.assert_param_presence(repository, 'repository name') unless repository.nil? && name.nil?
-        @name       = @client.assert_param_presence(name, 'snapshot name') unless name.nil?
+        @repository = @client.assert_param_presence(repository, "repository name") unless repository.nil? && name.nil?
+        @name       = @client.assert_param_presence(name, "snapshot name") unless name.nil?
       end
 
       attr_reader :client, :repository, :name
@@ -35,7 +35,7 @@ module Elastomer
       #
       # Returns true if the snapshot exists
       def exists?(params = {})
-        response = client.get '/_snapshot/{repository}/{snapshot}', update_params(params, :action => 'snapshot.exists')
+        response = client.get "/_snapshot/{repository}/{snapshot}", update_params(params, :action => "snapshot.exists")
         response.success?
       rescue Elastomer::Client::Error => exception
         if exception.message =~ /SnapshotMissingException/
@@ -54,7 +54,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def create(body = {}, params = {})
-        response = client.put '/_snapshot/{repository}/{snapshot}', update_params(params, :body => body, :action => 'snapshot.create')
+        response = client.put "/_snapshot/{repository}/{snapshot}", update_params(params, :body => body, :action => "snapshot.create")
         response.body
       end
 
@@ -66,8 +66,8 @@ module Elastomer
       # Returns the response body as a Hash
       def get(params = {})
         # Set snapshot name or we'll get the repository instead
-        snapshot = name || '_all'
-        response = client.get '/_snapshot/{repository}/{snapshot}', update_params(params, :snapshot => snapshot, :action => 'snapshot.get')
+        snapshot = name || "_all"
+        response = client.get "/_snapshot/{repository}/{snapshot}", update_params(params, :snapshot => snapshot, :action => "snapshot.get")
         response.body
       end
 
@@ -78,7 +78,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def status(params = {})
-        response = client.get '/_snapshot{/repository}{/snapshot}/_status', update_params(params, :action => 'snapshot.status')
+        response = client.get "/_snapshot{/repository}{/snapshot}/_status", update_params(params, :action => "snapshot.status")
         response.body
       end
 
@@ -90,7 +90,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def restore(body = {}, params = {})
-        response = client.post '/_snapshot/{repository}/{snapshot}/_restore', update_params(params, :body => body, :action => 'snapshot.restore')
+        response = client.post "/_snapshot/{repository}/{snapshot}/_restore", update_params(params, :body => body, :action => "snapshot.restore")
         response.body
       end
 
@@ -101,7 +101,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def delete(params = {})
-        response = client.delete '/_snapshot/{repository}/{snapshot}', update_params(params, :action => 'snapshot.delete')
+        response = client.delete "/_snapshot/{repository}/{snapshot}", update_params(params, :action => "snapshot.delete")
         response.body
       end