elasticsearch-api 7.3.0 → 7.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 554bf3603ac9c6be5fa3555e017babe35f101f15e2417013ed56f953afc865e3
-  data.tar.gz: c478ddfc93e1229bffb91bbe0cb9997e74becde2c5105ed497780e7e4f7a2f59
+  metadata.gz: 6b881e7cb1f40511b850a1ef10fe4f39047ca62fadb6de31f7d47bb9b9975d5d
+  data.tar.gz: 7c285a20100e694ad7b5d3806d3b62cbc58341a6b9eaf2f4c88294fc0367692e
 SHA512:
-  metadata.gz: 55e7282d4325fb747e51aec041f4e7aa86d20f5760ade1a060825db225500810f8ede807b94329ec1980bf5f7e938c233134f56361fc683378cde0bfdf8fe09d
-  data.tar.gz: 773db2bfcf05d36b4e8a042f70a0e269c41a13bef8d785e90d38c8db3a3e96e8d8cf6aa40094d15ac97486fc0a24a74353e38c54fa6da6705935de5b153c694c
+  metadata.gz: 4e6ada0c6484d228af0ea67e66e5ae209ae90b7a4c6e4342c4f6616f206417add4dd03c435854df5d3e3b7d0b14c1af14dfc43cfa8026b6779e1c62933467064
+  data.tar.gz: 95b8072f025a5b9963bad07951190d9b4123d87f523dcd9e62b7fbb0553740ada93bd02aac89784c672dd62a8584717f3eec1b4f5c54026766193255b403de4c

data/Rakefile

@@ -2,7 +2,7 @@
 # Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
 # See the LICENSE file in the project root for more information
 
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 def __current__
   Pathname( File.expand_path('..', __FILE__) )
@@ -12,8 +12,8 @@ def git_specs(command, options={})
   sh "git --git-dir=#{__current__.join('../tmp/elasticsearch/.git')} --work-tree=#{__current__.join('../tmp/elasticsearch')} #{command}", options
 end
 
-task(:default) { system "rake --tasks" }
-task  :test    => 'test:unit'
+task(:default) { system 'rake --tasks' }
+task test: 'test:unit'
 
 # ----- Test tasks ------------------------------------------------------------
 
@@ -21,35 +21,30 @@ require 'rake/testtask'
 require 'rspec/core/rake_task'
 
 namespace :test do
-
-  desc "Wait for Elasticsearch to be in a green state"
+  desc 'Wait for Elasticsearch to be in a green state'
   task :wait_for_green do
     sh '../scripts/wait-cluster.sh'
   end
 
+  # Unit tests - rake test:unit
+  #
+  task unit: :spec
   RSpec::Core::RakeTask.new(:spec) do |t|
     t.exclude_pattern = 'spec/**{,/*/**}/rest_api_yaml_spec.rb'
   end
 
+  # Rest API Spec tests - rake test:rest_api
   RSpec::Core::RakeTask.new(:rest_api) do |t|
     t.pattern = 'spec/**{,/*/**}/rest_api_yaml_spec.rb'
   end
 
-  desc "Update the repository with YAML tests"
+  desc 'Update the repository with YAML tests'
   task :update do
-    git_specs "fetch origin", :verbose => true
-  end
-
-  Rake::TestTask.new(:unit) do |test|
-    test.libs << 'lib' << 'test'
-    test.test_files = FileList["test/unit/**/*_test.rb"]
-    test.deps = [ :spec ]
-    # test.verbose = true
-    # test.warning = true
+    git_specs 'fetch origin', verbose: true
   end
 
   desc "Run integration tests"
-  task :integration => :update do
+  task integration: :update do
     require 'elasticsearch'
 
     branches = `git --git-dir=#{__current__.join('../tmp/elasticsearch/.git')} --work-tree=#{__current__.join('../tmp/elasticsearch')} branch --no-color`
@@ -107,7 +102,7 @@ namespace :test do
     end
   end
 
-  desc "Run unit and integration tests"
+  desc 'Run unit and integration tests'
   task :all do
     Rake::Task['test:unit'].invoke
     Rake::Task['test:integration'].invoke
@@ -139,10 +134,8 @@ end
 
 # ----- Code analysis tasks ---------------------------------------------------
 
-if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
-  require 'cane/rake_task'
-  Cane::RakeTask.new(:quality) do |cane|
-    cane.abc_max = 15
-    cane.no_style = true
-  end
+require 'cane/rake_task'
+Cane::RakeTask.new(:quality) do |cane|
+  cane.abc_max = 15
+  cane.no_style = true
 end

data/elasticsearch-api.gemspec

@@ -65,7 +65,7 @@ Gem::Specification.new do |s|
     s.add_development_dependency "ruby-prof" unless defined?(JRUBY_VERSION) || defined?(Rubinius)
     s.add_development_dependency "jbuilder"
     s.add_development_dependency "escape_utils" unless defined? JRUBY_VERSION
-    s.add_development_dependency "simplecov"
+    s.add_development_dependency "simplecov", '~> 0.17', '< 0.18'
     s.add_development_dependency "simplecov-rcov"
     s.add_development_dependency "cane"
     s.add_development_dependency "require-prof" unless defined?(JRUBY_VERSION) || defined?(Rubinius)

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

@@ -5,7 +5,6 @@
 module Elasticsearch
   module API
     module Actions
-
       # Abort a running benchmark
       #
       # @example
@@ -16,7 +15,7 @@ module Elasticsearch
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-benchmark.html
       #
-      def abort_benchmark(arguments={})
+      def abort_benchmark(arguments = {})
         method = HTTP_POST
         path   = "_bench/abort/#{arguments[:name]}"
         params = {}

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

@@ -5,7 +5,6 @@
 module Elasticsearch
   module API
     module Actions
-
       # Run a single query, or a set of queries, and return statistics on their performance
       #
       # @example Return statistics for a single query
@@ -51,7 +50,7 @@ module Elasticsearch
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-benchmark.html
       #
-      def benchmark(arguments={})
+      def benchmark(arguments = {})
         method = HTTP_PUT
         path   = "_bench"
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
@@ -63,7 +62,7 @@ module Elasticsearch
       # Register this action with its valid params when the module is loaded.
       #
       # @since 6.1.1
-      ParamsRegistry.register(:benchmark, [ :verbose ].freeze)
+      ParamsRegistry.register(:benchmark, [:verbose].freeze)
     end
   end
 end

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

@@ -5,57 +5,14 @@
 module Elasticsearch
   module API
     module Actions
-
-      # Perform multiple index, delete or update operations in a single request.
-      #
-      # Supports various different formats of the payload: Array of Strings, Header/Data pairs,
-      # or the conveniency "combined" format where data is passed along with the header
-      # in a single item in a custom `:data` key.
-      #
-      # @note The body argument is required and cannot be empty.
-      #
-      # @example Perform three operations in a single request, passing actions and data as an array of hashes
-      #
-      #     client.bulk body: [
-      #       { index: { _index: 'myindex', _type: 'mytype', _id: 1 } },
-      #       { title: 'foo' },
-      #
-      #       { index: { _index: 'myindex', _type: 'mytype', _id: 2 } },
-      #       { title: 'foo' },
-      #
-      #       { delete: { _index: 'myindex', _type: 'mytype', _id: 3  } }
-      #     ]
-      # @example Perform three operations in a single request, passing data in the `:data` option
-      #
-      #     client.bulk body: [
-      #       { index:  { _index: 'myindex', _type: 'mytype', _id: 1, data: { title: 'foo' } } },
-      #       { update: { _index: 'myindex', _type: 'mytype', _id: 2, data: { doc: { title: 'foo' } } } },
-      #       { delete: { _index: 'myindex', _type: 'mytype', _id: 3  } }
-      #     ]
-      #
-      # @example Perform a script-based bulk update, passing scripts in the `:data` option
-      #
-      #     client.bulk body: [
-      #       { update: { _index: 'myindex', _type: 'mytype', _id: 1,
-      #                  data: {
-      #                   script: "ctx._source.counter += value",
-      #                   lang: 'js',
-      #                   params: { value: 1 }, upsert: { counter: 0 } }
-      #                 }},
-      #       { update: { _index: 'myindex', _type: 'mytype', _id: 2,
-      #                  data: {
-      #                   script: "ctx._source.counter += value",
-      #                   lang: 'js',
-      #                   params: { value: 42 }, upsert: { counter: 0 } }
-      #                  }}
-      #
-      #     ]
+      # Allows to perform multiple index/update/delete operations in a single request.
       #
       # @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] :refresh If `true` then refresh the affected 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
@@ -63,44 +20,54 @@ module Elasticsearch
       # @option arguments [List] :_source_excludes Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
       # @option arguments [List] :_source_includes 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
+
+      # @option arguments [Hash] :body The operation definition and data (action-data pairs), separated by newlines (*Required*)
       #
-      # @return [Hash] Deserialized Elasticsearch response
-      #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/docs-bulk.html
       #
-      def bulk(arguments={})
+      def bulk(arguments = {})
+        raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
+
         arguments = arguments.clone
 
-        type      = arguments.delete(:type)
+        _index = arguments.delete(:index)
 
-        method = HTTP_POST
-        path   = Utils.__pathify Utils.__escape(arguments[:index]), Utils.__escape(type), '_bulk'
+        _type = arguments.delete(:type)
 
+        method = Elasticsearch::API::HTTP_POST
+        path   = if _index && _type
+                   "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_bulk"
+                 elsif _index
+                   "#{Utils.__listify(_index)}/_bulk"
+                 else
+                   "_bulk"
+  end
         params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-        body   = arguments[:body]
 
+        body = arguments[:body]
         if body.is_a? Array
           payload = Utils.__bulkify(body)
         else
           payload = body
-        end
+      end
 
-        perform_request(method, path, params, payload, {"Content-Type" => "application/x-ndjson"}).body
+        perform_request(method, path, params, payload, { "Content-Type" => "application/x-ndjson" }).body
       end
 
       # Register this action with its valid params when the module is loaded.
       #
-      # @since 6.1.1
+      # @since 6.2.0
       ParamsRegistry.register(:bulk, [
-          :wait_for_active_shards,
-          :refresh,
-          :routing,
-          :timeout,
-          :type,
-          :_source,
-          :_source_excludes,
-          :_source_includes,
-          :pipeline ].freeze)
+        :wait_for_active_shards,
+        :refresh,
+        :routing,
+        :timeout,
+        :type,
+        :_source,
+        :_source_excludes,
+        :_source_includes,
+        :pipeline
+      ].freeze)
+    end
     end
-  end
 end

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

@@ -6,71 +6,49 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Returns information about aliases, including associated routing values and filters.
-        #
-        # @example Display all aliases in the cluster
-        #
-        #     puts client.cat.aliases
-        #
-        # @example Display indices for the 'year-2013' alias
-        #
-        #     puts client.cat.aliases name: 'year-2013'
-        #
-        # @example Display header names in the output
-        #
-        #     puts client.cat.aliases v: true
-        #
-        # @example Return only the 'alias' and 'index' columns
-        #
-        #     puts client.cat.aliases h: ['alias', 'index']
-        #
-        # @example Return only the 'alias' and 'index' columns, using short names
-        #
-        #     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'
+        # Shows information about currently configured aliases to indices including filter and routing infos.
         #
         # @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 [String] :format a short version of the Accept header, e.g. json, yaml
+        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+        # @option arguments [List] :h Comma-separated list of column names to display
+        # @option arguments [Boolean] :help Return help information
         # @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
-        #                                    (default: false)
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-aliases.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cat-alias.html
         #
-        def aliases(arguments={})
-          name = arguments.delete(:name)
-          method = HTTP_GET
-          path   = Utils.__pathify '_cat/aliases', Utils.__listify(name)
+        def aliases(arguments = {})
+          arguments = arguments.clone
+
+          _name = arguments.delete(:name)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _name
+                     "_cat/aliases/#{Utils.__listify(_name)}"
+                   else
+                     "_cat/aliases"
+end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
-          body   = nil
+
+          body = nil
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:aliases, [
-            :format,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          :format,
+          :local,
+          :h,
+          :help,
+          :s,
+          :v
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,69 +6,55 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Return shard allocation information
-        #
-        # @example Display allocation for all nodes in the cluster
-        #
-        #     puts client.cat.allocation
-        #
-        # @example Display allocation for node with name 'node-1'
-        #
-        #     puts client.cat.allocation node_id: 'node-1'
-        #
-        # @example Display header names in the output
-        #
-        #     puts client.cat.allocation v: true
-        #
-        # @example Display only specific columns in the output (see the `help` parameter)
-        #
-        #     puts client.cat.allocation h: ['node', 'shards', 'disk.percent']
-        #
-        # @example Display only specific columns in the output, using the short names
-        #
-        #     puts client.cat.allocation h: 'n,s,dp'
-        #
-        # @example Return the information as Ruby objects
-        #
-        #     client.cat.allocation format: 'json'
+        # Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
         #
         # @option arguments [List] :node_id A comma-separated list of node IDs or 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 [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
-        #                                    (default: false)
+        # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
+        # @option arguments [String] :bytes The unit in which to display byte values
+        #   (options: b,k,kb,m,mb,g,gb,t,tb,p,pb)
+
+        # @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 [List] :s Comma-separated list of column names or column aliases to sort by
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cat-allocation.html
         #
-        def allocation(arguments={})
-          node_id = arguments.delete(:node_id)
-          method = HTTP_GET
-          path   = Utils.__pathify '_cat/allocation', Utils.__listify(node_id)
+        def allocation(arguments = {})
+          arguments = arguments.clone
+
+          _node_id = arguments.delete(:node_id)
+
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _node_id
+                     "_cat/allocation/#{Utils.__listify(_node_id)}"
+                   else
+                     "_cat/allocation"
+end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
-          body   = nil
+
+          body = nil
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:allocation, [
-            :format,
-            :bytes,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          :format,
+          :bytes,
+          :local,
+          :master_timeout,
+          :h,
+          :help,
+          :s,
+          :v
+        ].freeze)
+end
       end
-    end
   end
 end

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

@@ -6,68 +6,47 @@ module Elasticsearch
   module API
     module Cat
       module Actions
-
-        # Return document counts for the entire cluster or specific indices
-        #
-        # @example Display number of documents in the cluster
-        #
-        #     puts client.cat.count
-        #
-        # @example Display number of documents in an index
-        #
-        #     puts client.cat.count index: 'index-a'
-        #
-        # @example Display number of documents in a list of indices
-        #
-        #     puts client.cat.count index: ['index-a', 'index-b']
-        #
-        # @example Display header names in the output
-        #
-        #     puts client.cat.count v: true
-        #
-        # @example Return the information as Ruby objects
-        #
-        #     client.cat.count format: 'json'
+        # Provides quick access to the document count of the entire cluster, or individual indices.
         #
         # @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 [String] :format a short version of the Accept header, e.g. json, yaml
+        # @option arguments [List] :h Comma-separated list of column names to display
+        # @option arguments [Boolean] :help Return help information
         # @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
-        #                                    (default: false)
-        # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node
+        # @option arguments [Boolean] :v Verbose mode. Display column headers
+
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/cat-count.html
         #
-        def count(arguments={})
-          index = arguments.delete(:index)
+        def count(arguments = {})
+          arguments = arguments.clone
 
-          method = HTTP_GET
-
-          path   = Utils.__pathify '_cat/count', Utils.__listify(index)
+          _index = arguments.delete(:index)
 
+          method = Elasticsearch::API::HTTP_GET
+          path   = if _index
+                     "_cat/count/#{Utils.__listify(_index)}"
+                   else
+                     "_cat/count"
+end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
 
-          body   = nil
-
+          body = nil
           perform_request(method, path, params, body).body
         end
 
         # Register this action with its valid params when the module is loaded.
         #
-        # @since 6.1.1
+        # @since 6.2.0
         ParamsRegistry.register(:count, [
-            :format,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :s,
-            :v ].freeze)
+          :format,
+          :h,
+          :help,
+          :s,
+          :v
+        ].freeze)
+end
       end
-    end
   end
 end