elasticsearch-api 2.0.2 → 5.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7930e5a92a8e6e184698d3c37b7198aed10fd227
-  data.tar.gz: 6db8b0dab0894bd46f3f24e6ce6aa29b9e93dddb
+  metadata.gz: ecee9a5f6ee610f547eedea1f62be23d87b15828
+  data.tar.gz: 9652aab1592a6983d8fd7ba00e12bce42524c50b
 SHA512:
-  metadata.gz: 6a34d854f41738b90b36e27470bfe198bc9c26b46457d553e7d75edad2047ddccc3ee68148e8ea7d2857148e27c18953b2d4953208c9e7baa10f3cdb09d13103
-  data.tar.gz: 8e58ee3cf1f0676168ca4fb13fddd6256b31e6ac29525ac8300ac0d59d77d97c765c51f332ff6f4a6634f3d42e7a367e20e8dd0cddfdc50c79341e3a9ec0e124
+  metadata.gz: 23d1e1b4db1935d4023e5c1faa0d5c61fc9dc8a585832dc38c7643f4d3b2a67c944859cd2edf16b9fcd51cfd6840d7ebca161ae3674728810ae2ab797eabf96c
+  data.tar.gz: e44b133d5d70ed6d678b42cc76ec9cbc1e96613aeaead67f7374b9a14b67e3d0f2b61495e02ebdddd40c2b9c715c440d375bb7998b479f79e59f9e5baa9c2d08

data/README.md

@@ -9,17 +9,20 @@ The `elasticsearch-api` library provides a Ruby implementation of
 the [Elasticsearch](http://elasticsearch.org) REST API.
 
 It does not provide an Elasticsearch client; see the
-[`elasticsearch-transport`](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-transport)
-library.
+[`elasticsearch-transport`](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-transport) library.
 
-The library is compatible with Ruby 1.8.7 or higher.
+The library is compatible with Ruby 1.8.7 and higher.
 
-The library is compatible with Elasticsearch 0.90, 1.x and 2.x -- you have to install and use a matching version, though.
+It is compatible with Elasticsearch's API versions from 0.90 till current,
+just use a release matching major version of Elasticsearch.
 
-The 1.x versions and the master branch are compatible with Elasticsearch 1.x and 2.x APIs.
-
-To use the **Elasticsearch 0.90** API, install the **0.4.x** gem version or use the corresponding
-[`0.4`](https://github.com/elasticsearch/elasticsearch-ruby/tree/0.4) branch.
+| Ruby          |   | Elasticsearch |
+|:-------------:|:-:| :-----------: |
+| 0.90          | → | 0.90          |
+| 1.x           | → | 1.x           |
+| 2.x           | → | 2.x           |
+| 5.x           | → | 5.x           |
+| master        | → | master        |
 
 ## Installation
 

data/elasticsearch-api.gemspec

@@ -53,7 +53,7 @@ Gem::Specification.new do |s|
   # Prevent unit test failures on Ruby 1.8
   if defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'
     s.add_development_dependency "test-unit", '~> 2'
-    s.add_development_dependency "json"
+    s.add_development_dependency "json", '~> 1.8'
   end
 
   if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'

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

@@ -45,21 +45,23 @@ module Elasticsearch
       #
       #     ]
       #
-      # @option arguments [String]      :index Default index for items which don't provide one
-      # @option arguments [String]      :type Default document type for items which don't provide one
-      # @option arguments [Array<Hash>] :body An array of operations to perform, each operation is a Hash
-      # @option arguments [String]  :consistency Explicit write consistency setting for the operation
-      #                             (options: one, quorum, all)
-      # @option arguments [Boolean] :refresh Refresh the index after performing the operation
-      # @option arguments [String]  :replication Explicitly set the replication type (options: sync, async)
-      # @option arguments [Time]    :timeout Explicit operation timeout
-      # @option arguments [String]  :fields Default comma-separated list of fields to return
-      #                             in the response for updates
-      # @options arguments [String] :pipeline The pipeline ID to use for preprocessing incoming documents
+      # @option arguments [String] :index Default index for items which don't provide one
+      # @option arguments [String] :type Default document type for items which don't provide one
+      # @option arguments [Hash] :body The operation definition and data (action-data pairs), separated by newlines (*Required*)
+      # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
+      # @option arguments [String] :refresh If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
+      # @option arguments [String] :routing Specific routing value
+      # @option arguments [Time] :timeout Explicit operation timeout
+      # @option arguments [String] :type Default document type for items which don't provide one
+      # @option arguments [List] :fields Default comma-separated list of fields to return in the response for updates, can be overridden on each sub-request
+      # @option arguments [List] :_source True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
+      # @option arguments [List] :_source_exclude Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
+      # @option arguments [List] :_source_include Default list of fields to extract and return from the _source field, can be overridden on each sub-request
+      # @option arguments [String] :pipeline The pipeline ID to preprocess incoming documents with
       #
       # @return [Hash] Deserialized Elasticsearch response
       #
-      # @see http://elasticsearch.org/guide/reference/api/bulk/
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
       #
       def bulk(arguments={})
         arguments = arguments.clone
@@ -67,17 +69,17 @@ module Elasticsearch
         type      = arguments.delete(:type)
 
         valid_params = [
-          :consistency,
+          :wait_for_active_shards,
           :refresh,
-          :replication,
-          :type,
+          :routing,
           :timeout,
+          :type,
           :fields,
+          :_source,
+          :_source_exclude,
+          :_source_include,
           :pipeline ]
 
-        unsupported_params = [ :fields, :pipeline ]
-        Utils.__report_unsupported_parameters(arguments, unsupported_params)
-
         method = HTTP_POST
         path   = Utils.__pathify Utils.__escape(arguments[:index]), Utils.__escape(type), '_bulk'
 

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

@@ -25,6 +25,10 @@ module Elasticsearch
         #
         #     puts client.cat.aliases h: 'a,i'
         #
+        # @example Return the output sorted by the alias name
+        #
+        #     puts client.cat.aliases s: 'alias'
+        #
         # @example Return the information as Ruby objects
         #
         #     client.cat.aliases format: 'json'
@@ -32,6 +36,7 @@ module Elasticsearch
         # @option arguments [List] :name A comma-separated list of alias names to return
         # @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 [List] :s Comma-separated list of column names or column aliases to sort by
         # @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
@@ -46,7 +51,8 @@ module Elasticsearch
             :master_timeout,
             :h,
             :help,
-            :v ]
+            :v,
+            :s ]
 
           name = arguments.delete(:name)
 

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

@@ -33,6 +33,7 @@ module Elasticsearch
         # @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 [List] :s Comma-separated list of column names or column aliases to sort by
         # @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
@@ -48,7 +49,8 @@ module Elasticsearch
             :master_timeout,
             :h,
             :help,
-            :v ]
+            :v,
+            :s ]
 
           node_id = arguments.delete(:node_id)
 

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

@@ -28,6 +28,7 @@ module Elasticsearch
         # @option arguments [List] :index A comma-separated list of index names to limit the returned information
         # @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 [List] :s Comma-separated list of column names or column aliases to sort by
         # @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
@@ -42,7 +43,8 @@ module Elasticsearch
             :master_timeout,
             :h,
             :help,
-            :v ]
+            :v,
+            :s ]
 
           index = arguments.delete(:index)
 

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

@@ -21,6 +21,7 @@ module Elasticsearch
         # @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
+        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         #
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-fielddata.html
         #
@@ -32,6 +33,7 @@ module Elasticsearch
             :h,
             :help,
             :v,
+            :s,
             :fields ]
 
           fields = arguments.delete(:fields)

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

@@ -20,6 +20,7 @@ module Elasticsearch
         # @option arguments [Boolean] :ts Whether to display timestamp information
         # @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 [List] :s Comma-separated list of column names or column aliases to sort by
         # @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
@@ -35,7 +36,8 @@ module Elasticsearch
             :h,
             :help,
             :ts,
-            :v ]
+            :v,
+            :s ]
 
           method = HTTP_GET
           path   = "_cat/health"

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

@@ -40,6 +40,9 @@ module Elasticsearch
         # @option arguments [Boolean] :pri Limit the returned information on primary shards only (default: false)
         # @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 [List] :s Comma-separated list of column names or column aliases to sort by
+        # @option arguments [String] :health A health status ("green", "yellow", or "red" to filter only indices
+        #                                    matching the specified health status (options: green, yellow, red)
         # @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
@@ -51,12 +54,14 @@ module Elasticsearch
         def indices(arguments={})
           valid_params = [
             :bytes,
-            :local,
-            :master_timeout,
             :h,
+            :health,
             :help,
+            :local,
+            :master_timeout,
             :pri,
-            :v ]
+            :v,
+            :s ]
 
           index = arguments.delete(:index)
 

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

@@ -19,6 +19,7 @@ module Elasticsearch
         #
         # @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 [List] :s Comma-separated list of column names or column aliases to sort by
         # @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
@@ -33,7 +34,8 @@ module Elasticsearch
             :master_timeout,
             :h,
             :help,
-            :v ]
+            :v,
+            :s ]
 
           method = HTTP_GET
           path   = "_cat/master"

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

@@ -10,6 +10,7 @@ module Elasticsearch
         # @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
+        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         #
         # @see http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodeattrs.html
         #
@@ -19,12 +20,9 @@ module Elasticsearch
             :master_timeout,
             :h,
             :help,
-            :v ]
-
-          unsupported_params = [ :format ]
-          Utils.__report_unsupported_parameters(arguments.keys, unsupported_params)
-
-          method = HTTP_GET
+            :v,
+            :s ]
+          method = 'GET'
           path   = "_cat/nodeattrs"
           params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil

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

@@ -27,6 +27,7 @@ module Elasticsearch
         #
         # @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 [List] :s Comma-separated list of column names or column aliases to sort by
         # @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
@@ -41,7 +42,8 @@ module Elasticsearch
             :master_timeout,
             :h,
             :help,
-            :v ]
+            :v,
+            :s ]
 
           method = HTTP_GET
           path   = "_cat/nodes"

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

@@ -19,6 +19,7 @@ module Elasticsearch
         #
         # @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 [List] :s Comma-separated list of column names or column aliases to sort by
         # @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
@@ -33,7 +34,8 @@ module Elasticsearch
             :master_timeout,
             :h,
             :help,
-            :v ]
+            :v,
+            :s ]
 
           method = HTTP_GET
           path   = "_cat/pending_tasks"

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

@@ -9,6 +9,7 @@ module Elasticsearch
         #                                    (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 [List] :s Comma-separated list of column names or column aliases to sort by
         # @option arguments [Boolean] :help Return help information
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         #
@@ -20,9 +21,9 @@ module Elasticsearch
             :master_timeout,
             :h,
             :help,
-            :v ]
-
-          method = HTTP_GET
+            :v,
+            :s ]
+          method = 'GET'
           path   = "_cat/plugins"
           params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil

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

@@ -37,6 +37,7 @@ module Elasticsearch
         # @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 [List] :s Comma-separated list of column names or column aliases to sort by
         # @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
@@ -52,7 +53,8 @@ module Elasticsearch
             :master_timeout,
             :h,
             :help,
-            :v ]
+            :v,
+            :s ]
 
           index = arguments.delete(:index)
 

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

@@ -17,6 +17,7 @@ module Elasticsearch
         # @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
+        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-repositories.html
         #
@@ -25,10 +26,8 @@ module Elasticsearch
             :master_timeout,
             :h,
             :help,
-            :v ]
-
-          unsupported_params = [ :format ]
-          Utils.__report_unsupported_parameters(arguments.keys, unsupported_params)
+            :v,
+            :s ]
 
           method = HTTP_GET
           path   = "_cat/repositories"

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

@@ -14,17 +14,19 @@ module Elasticsearch
         # @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
+        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         #
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-segments.html
         #
         def segments(arguments={})
           valid_params = [
             :bytes,
+            :index,
             :h,
             :help,
-            :v ]
-
-          method = HTTP_GET
+            :v,
+            :s ]
+          method = 'GET'
           path   = "_cat/segments"
           params = Utils.__validate_and_extract_params arguments, valid_params
           body   = nil

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

@@ -41,6 +41,7 @@ module Elasticsearch
         # @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 [List] :s Comma-separated list of column names or column aliases to sort by
         # @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
@@ -56,7 +57,8 @@ module Elasticsearch
             :bytes,
             :h,
             :help,
-            :v ]
+            :v,
+            :s ]
 
           index = arguments.delete(:index)
 

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

@@ -17,20 +17,19 @@ module Elasticsearch
         # @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
+        # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-snapshots.html
         #
         def snapshots(arguments={})
-          raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
+          raise ArgumentError, "Required argument 'repository' missing" if !arguments[:repository] && !arguments[:help]
 
           valid_params = [
             :master_timeout,
             :h,
             :help,
-            :v ]
-
-          unsupported_params = [ :format ]
-          Utils.__report_unsupported_parameters(arguments.keys, unsupported_params)
+            :v,
+            :s ]
 
           repository = arguments.delete(:repository)