elasticsearch-api 0.4.11 → 1.0.0.rc1

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

@@ -0,0 +1,38 @@
+module Elasticsearch
+  module API
+    module Cat
+      module Actions
+
+        # TODO: Description
+        #
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [List] :h Comma-separated list of column names to display
+        # @option arguments [Boolean] :help Return help information
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-nodes.html
+        #
+        def nodes(arguments={})
+          valid_params = [
+            :local,
+            :master_timeout,
+            :h,
+            :help,
+            :v ]
+
+          method = 'GET'
+          path   = "_cat/nodes"
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
+
+          params[:h] = Utils.__listify(params[:h]) if params[:h]
+
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/cat/pending_tasks.rb

@@ -0,0 +1,40 @@
+module Elasticsearch
+  module API
+    module Cat
+      module Actions
+
+        # Display the information from the {Cluster::Actions#pending_tasks} API in a tabular format
+        #
+        # @example
+        #
+        #     puts client.cat.pending_tasks
+        #
+        # @option arguments [List] :h Comma-separated list of column names to display -- see the `help` argument
+        # @option arguments [Boolean] :v Display column headers as part of the output
+        # @option arguments [String] :format The output format. Options: 'text', 'json'; default: 'text'
+        # @option arguments [Boolean] :help Return information about headers
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
+        #                                    (default: false)
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-pending-tasks.html
+        #
+        def pending_tasks(arguments={})
+          valid_params = [
+            :local,
+            :master_timeout,
+            :h,
+            :help,
+            :v ]
+
+          method = 'GET'
+          path   = "_cat/pending_tasks"
+          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/actions/cat/recovery.rb

@@ -0,0 +1,73 @@
+module Elasticsearch
+  module API
+    module Cat
+      module Actions
+
+        # Display information about the recovery process (allocating shards)
+        #
+        # @example Display information for all indices
+        #
+        #     puts client.cat.recovery
+        #
+        # @example Display information for a specific index
+        #
+        #     puts client.cat.recovery index: 'index-a'
+        #
+        # @example Display information for indices matching a pattern
+        #
+        #     puts client.cat.recovery index: 'index-*'
+        #
+        # @example Display header names in the output
+        #
+        #     puts client.cat.recovery v: true
+        #
+        # @example Display only specific columns in the output (see the `help` parameter)
+        #
+        #     puts client.cat.recovery h: ['node', 'index', 'shard', 'percent']
+        #
+        # @example Display only specific columns in the output, using the short names
+        #
+        #     puts client.cat.recovery h: 'n,i,s,per'
+        #
+        # @example Return the information as Ruby objects
+        #
+        #     client.cat.recovery format: 'json'
+        #
+        # @option arguments [List] :index A comma-separated list of index names to limit the returned information
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, m, g)
+        # @option arguments [List] :h Comma-separated list of column names to display -- see the `help` argument
+        # @option arguments [Boolean] :v Display column headers as part of the output
+        # @option arguments [String] :format The output format. Options: 'text', 'json'; default: 'text'
+        # @option arguments [Boolean] :help Return information about headers
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
+        #                                    (default: false)
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-recovery.html
+        #
+        def recovery(arguments={})
+          valid_params = [
+            :bytes,
+            :local,
+            :master_timeout,
+            :h,
+            :help,
+            :v ]
+
+          index = arguments.delete(:index)
+
+          method = 'GET'
+
+          path   = Utils.__pathify '_cat/recovery', Utils.__listify(index)
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          params[:h] = Utils.__listify(params[:h]) if params[:h]
+
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/cat/shards.rb

@@ -0,0 +1,72 @@
+module Elasticsearch
+  module API
+    module Cat
+      module Actions
+
+        # Display shard allocation across nodes
+        #
+        # @example Display information for all indices
+        #
+        #     puts client.cat.shards
+        #
+        # @example Display information for a specific index
+        #
+        #     puts client.cat.shards index: 'index-a'
+        #
+        # @example Display information for a list of indices
+        #
+        #     puts client.cat.shards index: ['index-a', 'index-b']
+        #
+        # @example Display header names in the output
+        #
+        #     puts client.cat.shards v: true
+        #
+        # @example Display only specific columns in the output (see the `help` parameter)
+        #
+        #     puts client.cat.shards h: ['node', 'index', 'shard', 'prirep', 'docs', 'store', 'merges.total']
+        #
+        # @example Display only specific columns in the output, using the short names
+        #
+        #     puts client.cat.shards h: 'n,i,s,p,d,sto,mt'
+        #
+        # @example Return the information as Ruby objects
+        #
+        #     client.cat.shards format: 'json'
+        #
+        # @option arguments [List] :index A comma-separated list of index names to limit the returned information
+        # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, m, g)
+        # @option arguments [List] :h Comma-separated list of column names to display -- see the `help` argument
+        # @option arguments [Boolean] :v Display column headers as part of the output
+        # @option arguments [String] :format The output format. Options: 'text', 'json'; default: 'text'
+        # @option arguments [Boolean] :help Return information about headers
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
+        #                                    (default: false)
+        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-shards.html
+        #
+        def shards(arguments={})
+          valid_params = [
+            :local,
+            :master_timeout,
+            :h,
+            :help,
+            :v ]
+
+          index = arguments.delete(:index)
+
+          method = 'GET'
+
+          path   = Utils.__pathify '_cat/shards', Utils.__listify(index)
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          params[:h] = Utils.__listify(params[:h]) if params[:h]
+
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/actions/cluster/put_settings.rb

@@ -15,9 +15,11 @@ module Elasticsearch
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-update-settings/
         #
         def put_settings(arguments={})
+          valid_params = [ :flat_settings ]
+
           method = 'PUT'
           path   = "_cluster/settings"
-          params = {}
+          params = Utils.__validate_and_extract_params arguments, valid_params
           body   = arguments[:body] || {}
 
           perform_request(method, path, params, body).body

data/lib/elasticsearch/api/actions/cluster/state.rb

@@ -9,13 +9,12 @@ module Elasticsearch
         #
         #     client.cluster.state
         #
-        # @option arguments [Boolean] :filter_blocks Do not return information about blocks
-        # @option arguments [Boolean] :filter_index_templates Do not return information about index templates
-        # @option arguments [List] :filter_indices Limit returned metadata information to specific indices
-        # @option arguments [Boolean] :filter_metadata Do not return information about indices metadata
-        # @option arguments [Boolean] :filter_nodes Do not return information about nodes
-        # @option arguments [Boolean] :filter_routing_table Do not return information about shard allocation
-        #                                                   (`routing_table` and `routing_nodes`)
+        # @option arguments [List] :index A comma-separated list of index names; use `_all` or omit to
+        #                                 perform the operation on all indices
+        # @option arguments [List] :metric Limit the information returned to the specified metrics
+        #                                 (options: _all, blocks, index_templates, metadata, nodes, routing_table)
+        # @option arguments [List] :index_templates A comma separated list to return specific index templates when
+        #                                           returning metadata
         # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
         #                                    (default: false)
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
@@ -23,20 +22,30 @@ module Elasticsearch
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-state/
         #
         def state(arguments={})
+          arguments = arguments.clone
+          index     = arguments.delete(:index)
+          metric    = arguments.delete(:metric)
+
           valid_params = [
-            :filter_blocks,
-            :filter_index_templates,
-            :filter_indices,
-            :filter_metadata,
-            :filter_nodes,
-            :filter_routing_table,
+            :metric,
+            :index_templates,
             :local,
-            :master_timeout ]
+            :master_timeout,
+            :flat_settings ]
 
           method = 'GET'
           path   = "_cluster/state"
 
+          path   = Utils.__pathify '_cluster/state',
+                                   Utils.__listify(metric),
+                                   Utils.__listify(index)
+
           params = Utils.__validate_and_extract_params arguments, valid_params
+
+          [:index_templates].each do |key|
+            params[key] = Utils.__listify(params[key]) if params[key]
+          end
+
           body = nil
 
           perform_request(method, path, params, body).body

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

@@ -0,0 +1,78 @@
+module Elasticsearch
+  module API
+    module Actions
+
+      # Return the number of queries matching a document.
+      #
+      # Percolator allows you to register queries and then evaluate a document against them:
+      # the number of matching queries is returned in the response.
+      #
+      # @example Register query named "alert-1" for the "my-index" index
+      #
+      #     client.index index: 'my-index',
+      #                  type: '.percolator',
+      #                  id: 'alert-1',
+      #                  body: { query: { query_string: { query: 'foo' } } }
+      #
+      # @example Return the number of matching queries for a custom document
+      #
+      #     client.count_percolate index: 'my-index', type: 'my-type', body: { doc: { title: "Foo Bar" } }
+      #     # => { ..., total: 1}
+      #
+      # @example Return the number of matching queries for an existing document
+      #
+      #     client.index index: 'my-index', type: 'my-type', id: '123', body: { title: "Foo Bar" }
+      #
+      #     client.count_percolate index: 'my-index', type: 'my-type', id: '123'
+      #     # => { ..., total: 1}
+      #
+      # @option arguments [String] :index The index of the document being percolated. (*Required*)
+      # @option arguments [String] :type The type of the document being percolated. (*Required*)
+      # @option arguments [String] :id Fetch the document specified by index/type/id and
+      #                                use it instead of the passed `doc`
+      # @option arguments [Hash] :body The percolator request definition using the percolate DSL
+      # @option arguments [List] :routing A comma-separated list of specific routing values
+      # @option arguments [String] :preference Specify the node or shard the operation should be performed on
+      #                                        (default: random)
+      # @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] :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)
+      #
+      # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-percolate.html
+      #
+      def count_percolate(arguments={})
+        raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
+        raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
+        valid_params = [
+          :routing,
+          :preference,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :percolate_index,
+          :percolate_type,
+          :version,
+          :version_type ]
+
+        method = 'GET'
+        path   = Utils.__pathify Utils.__escape(arguments[:index]),
+                                 Utils.__escape(arguments[:type]),
+                                 arguments[:id],
+                                 '_percolate/count'
+
+        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/indices/exists.rb

@@ -19,6 +19,8 @@ module Elasticsearch
         #                                            `missing` ones (options: none, missing) @until 1.0
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
         #                                                 unavailable (missing, closed, etc)
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
+        #                                    (default: false)
         #
         # @return [true,false]
         #
@@ -31,7 +33,8 @@ module Elasticsearch
             :ignore_indices,
             :ignore_unavailable,
             :allow_no_indices,
-            :expand_wildcards
+            :expand_wildcards,
+            :local
           ]
 
           method = 'HEAD'

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

@@ -10,7 +10,7 @@ module Elasticsearch
         #     client.indices.exists_alias name: 'myalias'
         #
         # @option arguments [List] :index A comma-separated list of index names to filter aliases
-        # @option arguments [List] :name A comma-separated list of alias names to return (*Required*)
+        # @option arguments [List] :name A comma-separated list of alias names to return
         # @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)
@@ -20,16 +20,18 @@ module Elasticsearch
         #                                            `missing` ones (options: none, missing) @until 1.0
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when
         #                                                 unavailable (missing, closed, etc)
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node
+        #                                    (default: false)
         #
         # @see http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
         #
         def exists_alias(arguments={})
-          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
           valid_params = [
             :ignore_indices,
             :ignore_unavailable,
             :allow_no_indices,
-            :expand_wildcards
+            :expand_wildcards,
+            :local
           ]
 
           method = 'HEAD'

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

@@ -0,0 +1,34 @@
+module Elasticsearch
+  module API
+    module Indices
+      module Actions
+
+        # TODO: Description
+        #
+        # @option arguments [String] :name The name of the template (*Required*)
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+        #
+        # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-templates.html
+        #
+        def exists_template(arguments={})
+          raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
+          valid_params = [ :local ]
+
+          method = 'HEAD'
+          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).status == 200 ? true : false
+        rescue Exception => e
+          if e.class.to_s =~ /NotFound/ || e.message =~ /Not\s*Found|404/i
+            false
+          else
+            raise e
+          end
+        end
+      end
+    end
+  end
+end