elasticsearch-api 1.0.1 → 1.0.2

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

@@ -0,0 +1,29 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Return a list of running benchmarks
+      #
+      # @example
+      #
+      #     client.list_benchmarks
+      #
+      # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string
+      #                                 to perform the operation on all indices
+      # @option arguments [String] :type The name of the document type
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html
+      #
+      def list_benchmarks(arguments={})
+        valid_params = [
+           ]
+        method = 'GET'
+        path   = "_bench"
+        params = {}
+        body   = nil
+
+        perform_request(method, path, params, body).body
+      end
+    end
+  end
+end

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

@@ -8,7 +8,45 @@ module Elasticsearch
       #
       # @example Search for similar documents using the `title` property of document `myindex/mytype/1`
       #
-      #     client.mlt index: 'myindex', type: 'mytype', id: '1', mlt_fields: 'title'
+      #     # First, let's setup a synonym-aware analyzer ("quick" <=> "fast")
+      #     client.indices.create index: 'myindex', body: {
+      #       settings: {
+      #         analysis: {
+      #           filter: {
+      #             synonyms: {
+      #               type: 'synonym',
+      #               synonyms: [ "quick,fast" ]
+      #             }
+      #           },
+      #           analyzer: {
+      #             title_synonym: {
+      #               type: 'custom',
+      #               tokenizer: 'whitespace',
+      #               filter: ['lowercase', 'stop', 'snowball', 'synonyms']
+      #             }
+      #           }
+      #         }
+      #       },
+      #       mappings: {
+      #         mytype: {
+      #           properties: {
+      #             title: {
+      #               type: 'string',
+      #               analyzer: 'title_synonym'
+      #             }
+      #           }
+      #         }
+      #       }
+      #     }
+      #
+      #     # Index three documents
+      #     client.index index: 'myindex', type: 'mytype', id: 1, body: { title: 'Quick Brown Fox'   }
+      #     client.index index: 'myindex', type: 'mytype', id: 2, body: { title: 'Slow Black Dog'    }
+      #     client.index index: 'myindex', type: 'mytype', id: 3, body: { title: 'Fast White Rabbit' }
+      #     client.indices.refresh index: 'myindex'
+      #
+      #     client.mlt index: 'myindex', type: 'mytype', id: 1, mlt_fields: 'title', min_doc_freq: 1, min_term_freq: 1
+      #     # => { ... {"title"=>"Fast White Rabbit"}}]}}
       #
       # @option arguments [String] :id The document ID (*Required*)
       # @option arguments [String] :index The name of the index (*Required*)

data/lib/elasticsearch/api/actions/nodes/info.rb

@@ -17,13 +17,12 @@ module Elasticsearch
         # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information;
         #                                   use `_local` to return information from the node you're connecting to, leave
         #                                   empty to get information from all nodes
-        # @option arguments [Boolean] :all Return all available information
-        # @option arguments [Boolean] :clear Reset the default settings
+        # @option arguments [Boolean] :_all Return all available information
         # @option arguments [Boolean] :http Return information about HTTP
         # @option arguments [Boolean] :jvm Return information about the JVM
         # @option arguments [Boolean] :network Return information about network
         # @option arguments [Boolean] :os Return information about the operating system
-        # @option arguments [Boolean] :plugin Return information about plugins
+        # @option arguments [Boolean] :plugins Return information about plugins
         # @option arguments [Boolean] :process Return information about the Elasticsearch process
         # @option arguments [Boolean] :settings Return information about node settings
         # @option arguments [Boolean] :thread_pool Return information about the thread pool
@@ -32,24 +31,27 @@ module Elasticsearch
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-info/
         #
         def info(arguments={})
-          valid_params = [
-            :all,
-            :clear,
+          valid_parts = [
+            :_all,
             :http,
             :jvm,
             :network,
             :os,
-            :plugin,
+            :plugins,
             :process,
             :settings,
             :thread_pool,
             :transport ]
 
+          valid_params = []
+
           method = 'GET'
-          path   = Utils.__pathify '_nodes', Utils.__listify(arguments[:node_id])
+
+          parts  = Utils.__extract_parts arguments, valid_parts
+          path   = Utils.__pathify '_nodes', Utils.__listify(arguments[:node_id]), Utils.__listify(parts)
 
           params = Utils.__validate_and_extract_params arguments, valid_params
-          body = nil
+          body   = nil
 
           perform_request(method, path, params, body).body
         end

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

@@ -69,7 +69,7 @@ module Elasticsearch
       # @option arguments [String] :percolate_index The index to percolate the document into. Defaults to passed `index`.
       # @option arguments [String] :percolate_type The type to percolate document into. Defaults to passed `type`.
       # @option arguments [Number] :version Explicit version number for concurrency control
-      # @option arguments [String] :version_type Specific version type (options: internal, external)
+      # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
       #
       # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-percolate.html
       #

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

@@ -9,13 +9,30 @@ module Elasticsearch
       #
       # "Scrolling" the results is frequently used with the `scan` search type.
       #
-      # @example Scroll results
+      # @example A basic example
       #
       #     result = client.search index: 'scrollindex',
       #                            scroll: '5m',
       #                            body: { query: { match: { title: 'test' } }, sort: '_id' }
       #
-      #     client.scroll scroll: '5m', scroll_id: result['_scroll_id']
+      #     result = client.scroll scroll: '5m', scroll_id: result['_scroll_id']
+      #
+      # @example Call the `scroll` API until all the documents are returned
+      #
+      #     # Index 1,000 documents
+      #     client.indices.delete index: 'test'
+      #     1_000.times do |i| client.index index: 'test', type: 'test', id: i+1, body: {title: "Test #{i}"} end
+      #     client.indices.refresh index: 'test'
+      #
+      #     # Open the "view" of the index with the `scan` search_type
+      #     r = client.search index: 'test', search_type: 'scan', scroll: '5m', size: 10
+      #
+      #     # Call the `scroll` API until empty results are returned
+      #     while r = client.scroll(scroll_id: r['_scroll_id'], scroll: '5m') and not r['hits']['hits'].empty? do
+      #       puts "--- BATCH #{defined?($i) ? $i += 1 : $i = 1} -------------------------------------------------"
+      #       puts r['hits']['hits'].map { |d| d['_source']['title'] }.inspect
+      #       puts
+      #     end
       #
       # @option arguments [String] :scroll_id The scroll ID
       # @option arguments [Hash] :body The scroll ID if not passed by URL or query parameter.
@@ -23,6 +40,7 @@ module Elasticsearch
       #                                      should be maintained for scrolled search
       # @option arguments [String] :scroll_id The scroll ID for scrolled search
       #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/guide/current/scan-scroll.html#scan-scroll
       # @see http://www.elasticsearch.org/guide/reference/api/search/scroll/
       # @see http://www.elasticsearch.org/guide/reference/api/search/search-type/
       #

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

@@ -70,7 +70,6 @@ module Elasticsearch
       # @option arguments [Number] :from Starting offset (default: 0)
       # @option arguments [String] :ignore_indices When performed on multiple indices, allows to ignore `missing` ones
       #                                            (options: none, missing)
-      # @option arguments [List] :indices_boost Comma-separated list of index boosts
       # @option arguments [Boolean] :lenient Specify whether format-based query failures
       #                                      (such as providing text to a numeric field) should be ignored
       # @option arguments [Boolean] :lowercase_expanded_terms Specify whether query terms should be lowercased
@@ -115,7 +114,9 @@ module Elasticsearch
           :fields,
           :from,
           :ignore_indices,
-          :indices_boost,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
           :lenient,
           :lowercase_expanded_terms,
           :preference,

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

@@ -0,0 +1,41 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Returns the names of indices and shards on which a search request would be executed
+      #
+      # @option arguments [String] :index The name of the index
+      # @option arguments [String] :type The type of the document
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on
+      #                                        (default: random)
+      # @option arguments [String] :routing Specific routing value
+      # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
+      #                                    (default: false)
+      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
+      #                                                 unavailable (missing or closed)
+      # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves
+      #                                               into no concrete indices.
+      #                                               (This includes `_all` or when no indices have been specified)
+      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices
+      #                                              that are open, closed or both. (options: open, closed)
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-shards.html
+      #
+      def search_shards(arguments={})
+        valid_params = [
+          :preference,
+          :routing,
+          :local,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards ]
+        method = 'GET'
+        path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_search_shards' )
+        params = Utils.__validate_and_extract_params arguments, valid_params
+        body   = nil
+
+        perform_request(method, path, params, body).body
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Configure the search definition witha template in Mustache and parameters
+      #
+      # @example Insert the start and end values for the `range` query
+      #
+      #     client.search_template index: 'myindex',
+      #                            body: {
+      #                              template: {
+      #                                query: {
+      #                                  range: {
+      #                                    date: { gte: "{{start}}", lte: "{{end}}" }
+      #                                  }
+      #                                }
+      #                              },
+      #                              params: { start: "2014-02-01", end: "2014-03-01" }
+      #                            }
+      #
+      # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty
+      #                                 string to perform the operation on all indices
+      # @option arguments [List] :type A comma-separated list of document types to search;
+      #                                leave empty to perform the operation on all types
+      # @option arguments [Hash] :body The search definition template and its params
+      # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored
+      #                                                 when unavailable (missing or closed)
+      # @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into
+      #                                               no concrete indices. (This includes `_all` string or when no
+      #                                               indices have been specified)
+      # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices
+      #                                              that are open, closed or both. (options: open, closed)
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on
+      #                                        (default: random)
+      # @option arguments [List] :routing A comma-separated list of specific routing values
+      # @option arguments [Duration] :scroll Specify how long a consistent view of the index should be maintained
+      #                                      for scrolled search
+      # @option arguments [String] :search_type Search operation type (options: query_then_fetch, query_and_fetch,
+      #                                         dfs_query_then_fetch, dfs_query_and_fetch, count, scan)
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html
+      #
+      def search_template(arguments={})
+        valid_params = [
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :preference,
+          :routing,
+          :scroll,
+          :search_type ]
+        method = 'GET'
+        path   = Utils.__pathify( Utils.__listify(arguments[:index]), Utils.__listify(arguments[:type]), '_search/template' )
+        params = Utils.__validate_and_extract_params arguments, valid_params
+        body   = arguments[:body]
+
+        perform_request(method, path, params, body).body
+      end
+    end
+  end
+end

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

@@ -22,7 +22,7 @@ module Elasticsearch
         # @option arguments [Boolean] :wait_for_completion Whether the request should block and wait until
         #                                                  the operation has completed
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html#_snapshot
         #
         def create(arguments={})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]

data/lib/elasticsearch/api/actions/snapshot/create_repository.rb

@@ -18,7 +18,7 @@ module Elasticsearch
         # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
         # @option arguments [Time] :timeout Explicit operation timeout
         #
-        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html#_repositories
         #
         def create_repository(arguments={})
           raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]

data/lib/elasticsearch/api/actions/snapshot/restore.rb

@@ -12,7 +12,7 @@ module Elasticsearch
         # @example Restore a specific index under a different name
         #
         #     client.snapshot.restore repository: 'my-backups',
-        #                             snapshot: 'snapshot-5',
+        #                             snapshot: 'snapshot-1',
         #                             body: {
         #                               rename_pattern: "^(.*)$",
         #                               rename_replacement: "restored_$1"

data/lib/elasticsearch/api/actions/snapshot/status.rb

@@ -0,0 +1,40 @@
+module Elasticsearch
+  module API
+    module Snapshot
+      module Actions
+
+        # Return information about a running snapshot
+        #
+        # @example Return information about all currently running snapshots
+        #
+        #     client.snapshot.status repository: 'my-backups', human: true
+        #
+        # @example Return information about a specific snapshot
+        #
+        #     client.snapshot.status repository: 'my-backups', human: true
+        #
+        # @option arguments [String] :repository A repository name
+        # @option arguments [List] :snapshot A comma-separated list of snapshot names
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html#_snapshot_status
+        #
+        def status(arguments={})
+          valid_params = [
+            :master_timeout ]
+
+          repository = arguments.delete(:repository)
+          snapshot   = arguments.delete(:snapshot)
+
+          method = 'GET'
+
+          path   = Utils.__pathify( '_snapshot', Utils.__escape(repository), Utils.__escape(snapshot), '_status')
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/utils.rb

@@ -103,7 +103,7 @@ module Elasticsearch
 
       # Validates the argument Hash against common and valid API parameters
       #
-      # @param arguments [Hash]             Hash of arguments to verify and extract, **with symbolized keys**
+      # @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
@@ -130,6 +130,28 @@ module Elasticsearch
         params
       end
 
+      # Extracts the valid parts of the URL from the arguments
+      #
+      # @note Mutates the `arguments` argument, to prevent failures in `__validate_and_extract_params`.
+      #
+      # @param arguments   [Hash]          Hash of arguments to verify and extract, **with symbolized keys**
+      # @param valid_parts [Array<Symbol>] An array of symbol with valid keys
+      #
+      # @return [Array<String>]            Valid parts of the URL as an array of strings
+      #
+      # @example Extract parts
+      #   __extract_parts { :foo => true }, [:foo, :bar]
+      #   # => [:foo]
+      #
+      #
+      # @api private
+      #
+      def __extract_parts(arguments, valid_parts=[])
+        parts  = arguments.keys.select { |a| valid_parts.include?(a) }.map { |a| a.to_s }.sort
+        arguments.delete_if { |k,v| valid_parts.include? k }
+        return parts
+      end
+
       extend self
     end
   end

data/lib/elasticsearch/api/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module API
-    VERSION = "1.0.1"
+    VERSION = "1.0.2"
   end
 end

data/test/integration/yaml_test_runner.rb

@@ -395,6 +395,7 @@ suites.each do |suite|
                     $stderr.puts "CHECK: Expected '#{property}' to match #{pattern}, is: #{result.inspect}" if ENV['DEBUG']
                     assert_match(pattern, result)
                   else
+                    value = value.reduce({}) { |memo, (k,v)| memo[k] =  Runner.fetch_or_return(v); memo  } if value.is_a? Hash
                     $stderr.puts "CHECK: Expected '#{property}' to be '#{value}', is: #{result.inspect}" if ENV['DEBUG']
                     assert_equal(value, result)
                   end

data/test/unit/abort_benchmark_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+module Elasticsearch
+  module Test
+    class AbortBenchmarkTest < ::Test::Unit::TestCase
+
+      context "Abort benchmark" do
+        subject { FakeClient.new }
+
+        should "perform correct request" do
+          subject.expects(:perform_request).with do |method, url, params, body|
+            assert_equal 'POST', method
+            assert_equal '_bench/abort/foo', url
+            assert_equal nil, params[:name]
+            assert_nil   body
+            true
+          end.returns(FakeResponse.new)
+
+          subject.abort_benchmark :name => 'foo'
+        end
+
+      end
+
+    end
+  end
+end