elasticsearch-api 7.5.0 → 7.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b881e7cb1f40511b850a1ef10fe4f39047ca62fadb6de31f7d47bb9b9975d5d
-  data.tar.gz: 7c285a20100e694ad7b5d3806d3b62cbc58341a6b9eaf2f4c88294fc0367692e
+  metadata.gz: e9d7a11634cede8ee637851db254cc180fbfa74c2fad7cd01c0009feedbed49a
+  data.tar.gz: bb195a57bf443788022d77c8beebfd2ffbb7a6f5380237472b81a04ad8834279
 SHA512:
-  metadata.gz: 4e6ada0c6484d228af0ea67e66e5ae209ae90b7a4c6e4342c4f6616f206417add4dd03c435854df5d3e3b7d0b14c1af14dfc43cfa8026b6779e1c62933467064
-  data.tar.gz: 95b8072f025a5b9963bad07951190d9b4123d87f523dcd9e62b7fbb0553740ada93bd02aac89784c672dd62a8584717f3eec1b4f5c54026766193255b403de4c
+  metadata.gz: 1b99941bac80ec2f7e7821df7aa14b3d2a30cbdc25dea1734bdad7e79cec4eb22d22061410e07ba0f4d3f15c5145018d785cb0f508441eed1c348b7071f467c3
+  data.tar.gz: 89fc951d9ec43702537ad7714b7539c68374df84f97625291cf84ce8f65a0760cf421c7c16a60c29f3c782598dd0c443d75baf11d697e8b4c72b4b0e7c40b52c

data/Gemfile

@@ -8,19 +8,22 @@ source 'https://rubygems.org'
 gemspec
 
 if File.exist? File.expand_path("../../elasticsearch/elasticsearch.gemspec", __FILE__)
-  gem 'elasticsearch', :path => File.expand_path("../../elasticsearch", __FILE__), :require => false
+  gem 'elasticsearch', path: File.expand_path("../../elasticsearch", __FILE__), require: false
 end
 
 if File.exist? File.expand_path("../../elasticsearch-transport", __FILE__)
-  gem 'elasticsearch-transport', :path => File.expand_path("../../elasticsearch-transport", __FILE__), :require => true
+  gem 'elasticsearch-transport', path: File.expand_path("../../elasticsearch-transport", __FILE__), require: true
 end
 
 if File.exist? File.expand_path("../../elasticsearch-extensions", __FILE__)
-  gem 'elasticsearch-extensions', :path => File.expand_path("../../elasticsearch-extensions", __FILE__), :require => false
+  gem 'elasticsearch-extensions', path: File.expand_path("../../elasticsearch-extensions", __FILE__), require: false
 end
 
-
 group :development do
   gem 'rspec'
-  gem 'pry-nav'
+  if defined?(JRUBY_VERSION)
+    gem 'pry-nav'
+  else
+    gem 'pry-byebug'
+  end
 end

data/Rakefile

@@ -69,7 +69,7 @@ namespace :test do
       es_version_info = client.info['version']
       build_hash      = es_version_info['build_hash']
       cluster_running = true
-    rescue Faraday::Error::ConnectionFailed
+    rescue Faraday::ConnectionFailed
       STDERR.puts "[!] Test cluster not running?"
       cluster_running = false
     end

data/elasticsearch-api.gemspec

@@ -8,72 +8,51 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'elasticsearch/api/version'
 
 Gem::Specification.new do |s|
-  s.name          = "elasticsearch-api"
+  s.name          = 'elasticsearch-api'
   s.version       = Elasticsearch::API::VERSION
-  s.authors       = ["Karel Minarik"]
-  s.email         = ["karel.minarik@elasticsearch.org"]
-  s.summary       = "Ruby API for Elasticsearch."
-  s.homepage      = "https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-api"
-  s.license       = "Apache-2.0"
+  s.authors       = ['Karel Minarik']
+  s.email         = ['karel.minarik@elasticsearch.org']
+  s.summary       = 'Ruby API for Elasticsearch.'
+  s.homepage      = 'https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-api'
+  s.license       = 'Apache-2.0'
 
   s.files         = `git ls-files`.split($/)
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 
-  s.extra_rdoc_files  = [ "README.md", "LICENSE" ]
-  s.rdoc_options      = [ "--charset=UTF-8" ]
+  s.extra_rdoc_files  = [ 'README.md', 'LICENSE' ]
+  s.rdoc_options      = [ '--charset=UTF-8' ]
 
-  s.required_ruby_version = '>= 1.9'
+  s.required_ruby_version = '>= 2.4'
 
-  s.add_dependency "multi_json"
+  s.add_dependency 'multi_json'
 
-  s.add_development_dependency "bundler"
-
-  if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
-    s.add_development_dependency "rake", "~> 11.1"
-  else
-    s.add_development_dependency "rake", "< 11.0"
-  end
-
-  s.add_development_dependency "elasticsearch"
-  s.add_development_dependency "elasticsearch-transport"
-
-  if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
-    s.add_development_dependency "minitest"
-    s.add_development_dependency "minitest-reporters"
-    s.add_development_dependency "elasticsearch-extensions"
-  end
-
-  s.add_development_dependency "ansi"
-  s.add_development_dependency "shoulda-context"
-  s.add_development_dependency "mocha"
-  s.add_development_dependency "yard"
-  s.add_development_dependency "pry"
+  s.add_development_dependency 'ansi'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'elasticsearch'
+  s.add_development_dependency 'elasticsearch-extensions'
+  s.add_development_dependency 'elasticsearch-transport'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'minitest-reporters'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rake', '~> 11.1'
+  s.add_development_dependency 'shoulda-context'
+  s.add_development_dependency 'yard'
 
   # Gems for testing integrations
-  s.add_development_dependency "jsonify"
-  s.add_development_dependency "hashie"
-
-  # 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", '~> 1.8'
-  end
-
-  if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
-    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", '~> 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)
-  end
-
-  if defined?(RUBY_VERSION) && RUBY_VERSION > '2.2'
-    s.add_development_dependency "test-unit", '~> 2'
-  end
+  s.add_development_dependency 'jsonify'
+  s.add_development_dependency 'hashie'
+
+  s.add_development_dependency 'cane'
+  s.add_development_dependency 'escape_utils' unless defined? JRUBY_VERSION
+  s.add_development_dependency 'jbuilder'
+  s.add_development_dependency 'require-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
+  s.add_development_dependency 'simplecov', '~> 0.17', '< 0.18'
+  s.add_development_dependency 'simplecov-rcov'
+  s.add_development_dependency 'test-unit', '~> 2'
+  s.add_development_dependency 'ruby-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
 
   s.description = <<-DESC.gsub(/^    /, '')
     Ruby API for Elasticsearch. See the `elasticsearch` gem for full integration.

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

@@ -46,7 +46,7 @@ module Elasticsearch
 
         body = arguments[:body]
         if body.is_a? Array
-          payload = Utils.__bulkify(body)
+          payload = Elasticsearch::API::Utils.__bulkify(body)
         else
           payload = body
       end

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

@@ -26,7 +26,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = "_cat/health"
-          params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
 
           body = nil

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

@@ -11,7 +11,7 @@ module Elasticsearch
         # @option arguments [List] :index A comma-separated list of index names to limit the returned information
         # @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,m,g)
+        #   (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

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

@@ -13,7 +13,7 @@ module Elasticsearch
 
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [Boolean] :full_id Return the full node ID instead of the shortened version (default: false)
-        # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
+        # @option arguments [Boolean] :local Calculate the selected nodes using the local cluster state rather than the state from master node (default: false)   *Deprecated*
         # @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

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

@@ -27,7 +27,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = "_cat/pending_tasks"
-          params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
 
           body = nil

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

@@ -9,6 +9,7 @@ module Elasticsearch
       #
       # @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  (*Required*)
       # @option arguments [List] :type A comma-separated list of document types to search; leave empty to perform the operation on all types
+      # @option arguments [String] :analyzer The analyzer to use for the query string
       # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false)
       # @option arguments [String] :default_operator The default operator for query string query (AND or OR)
       #   (options: AND,OR)
@@ -85,6 +86,7 @@ module Elasticsearch
       #
       # @since 6.2.0
       ParamsRegistry.register(:delete_by_query, [
+        :analyzer,
         :analyze_wildcard,
         :default_operator,
         :df,

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

@@ -0,0 +1,26 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# 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
+
+module Elasticsearch
+  module API
+    module Actions
+      # Returns all script contexts.
+      #
+
+      #
+      # @see [TODO]
+      #
+      def get_script_context(arguments = {})
+        arguments = arguments.clone
+
+        method = Elasticsearch::API::HTTP_GET
+        path   = "_script_context"
+        params = {}
+
+        body = nil
+        perform_request(method, path, params, body).body
+      end
+    end
+    end
+end

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

@@ -0,0 +1,26 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# 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
+
+module Elasticsearch
+  module API
+    module Actions
+      # Returns available script types, languages and contexts
+      #
+
+      #
+      # @see [TODO]
+      #
+      def get_script_languages(arguments = {})
+        arguments = arguments.clone
+
+        method = Elasticsearch::API::HTTP_GET
+        path   = "_script_language"
+        params = {}
+
+        body = nil
+        perform_request(method, path, params, body).body
+      end
+    end
+    end
+end

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

@@ -6,7 +6,7 @@ module Elasticsearch
   module API
     module Indices
       module Actions
-        # Performs a synced flush operation on one or more indices.
+        # Performs a synced flush operation on one or more indices. Synced flush is deprecated and will be removed in 8.0. Use flush instead
         #
         # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string for all indices
         # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)

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

@@ -39,12 +39,10 @@ module Elasticsearch
           method = Elasticsearch::API::HTTP_PUT
           path   = if _index && _type
                      "#{Utils.__listify(_index)}/#{Utils.__listify(_type)}/_mappings"
+                   elsif _index
+                     "#{Utils.__listify(_index)}/_mapping"
                    elsif _type
                      "_mappings/#{Utils.__listify(_type)}"
-                   elsif _index
-                     "#{Utils.__listify(_index)}/_mappings"
-                   else
-                     "_mapping/#{Utils.__listify(_type)}"
   end
           params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 

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

@@ -12,9 +12,7 @@ module Elasticsearch
         # @option arguments [Boolean] :include_type_name Whether a type should be returned in the body of the mappings.
         # @option arguments [Number] :order The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
         # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one
-        # @option arguments [Time] :timeout Explicit operation timeout
         # @option arguments [Time] :master_timeout Specify timeout for connection to master
-        # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
 
         # @option arguments [Hash] :body The template definition (*Required*)
         #
@@ -43,9 +41,7 @@ module Elasticsearch
           :include_type_name,
           :order,
           :create,
-          :timeout,
-          :master_timeout,
-          :flat_settings
+          :master_timeout
         ].freeze)
 end
       end

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

@@ -15,6 +15,7 @@ module Elasticsearch
       # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
       # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute
       # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
+      # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
 
       # @option arguments [Hash] :body The request definitions (metadata-search request definition pairs), separated by newlines (*Required*)
       #
@@ -65,7 +66,8 @@ module Elasticsearch
         :search_type,
         :typed_keys,
         :max_concurrent_searches,
-        :rest_total_hits_as_int
+        :rest_total_hits_as_int,
+        :ccs_minimize_roundtrips
       ].freeze)
     end
     end

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

@@ -13,6 +13,9 @@ module Elasticsearch
       # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
       #   (options: open,closed,none,all)
 
+      # @option arguments [String] :search_type Search operation type
+      #   (options: query_then_fetch,dfs_query_then_fetch)
+
       # @option arguments [Hash] :body The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. (*Required*)
       #
       # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.5/search-rank-eval.html
@@ -42,7 +45,8 @@ module Elasticsearch
       ParamsRegistry.register(:rank_eval, [
         :ignore_unavailable,
         :allow_no_indices,
-        :expand_wildcards
+        :expand_wildcards,
+        :search_type
       ].freeze)
     end
     end

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

@@ -25,6 +25,7 @@ module Elasticsearch
       # @option arguments [Boolean] :profile Specify whether to profile the query execution
       # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
       # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response
+      # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution
 
       # @option arguments [Hash] :body The search definition template and its params (*Required*)
       #
@@ -73,7 +74,8 @@ module Elasticsearch
         :explain,
         :profile,
         :typed_keys,
-        :rest_total_hits_as_int
+        :rest_total_hits_as_int,
+        :ccs_minimize_roundtrips
       ].freeze)
     end
     end

data/lib/elasticsearch/api/version.rb

@@ -4,6 +4,6 @@
 
 module Elasticsearch
   module API
-    VERSION = "7.5.0"
+    VERSION = "7.6.0"
   end
 end

data/lib/elasticsearch/api.rb

@@ -32,7 +32,8 @@ module Elasticsearch
       :format,                        # Search, Cat, ...
       :pretty,                        # Pretty-print the response
       :human,                         # Return numeric values in human readable format
-      :filter_path                    # Filter the JSON response
+      :filter_path,                   # Filter the JSON response
+      :opaque_id                      # Use X-Opaque-Id
     ]
 
     HTTP_GET          = 'GET'.freeze

data/spec/README.md

@@ -0,0 +1,61 @@
+# Rest API YAML Spec Runner
+
+The file that traverses the yaml files and loads a **TestFile** object per each of them:
+`elasticsearch-api/spec/elasticsearch/api/rest_api_yaml_spec.rb`
+
+You can use the SINGLE_TEST env variable to run just one test, or add code like this on the first line of the tests.each block:  
+```ruby
+next unless file =~ /indices.put_mapping\/all_path_options_with_types.yml/
+```
+
+#### TestFile object
+Class representing a single test file. Contains setup, teardown and tests.   
+`../api-spec-testing/test_file.rb`
+
+#### Test object
+Every single test in the test file is represented in the Test object.   
+`../api-spec-testing/test_file/test.rb`
+
+#### TaskGroup objects
+
+Tests are ordered in task groups, an array of TaskGroup objects.  
+`../api-spec-testing/test_file/task_group.rb`  
+
+Task Groups are a representation of a block of actions consisting of 'do' actions and their verifications. e.g.: 
+```yaml
+ - do:
+      index:
+          index:  test-index
+          id:     1
+          body:   { foo: bar }
+
+ - match:   { _index:   test-index }
+ - match:   { _id:      "1"}
+ - match:   { _version: 1}
+```
+
+**Before** each test, the spec runner runs `clear_data` on the test_file. This clears indices, index templates, snapshots and repositories. For xpack it also clears roles, users, privileges, datafeeds, ml_jobs and more.
+
+**After** each test, it runs the test file teardown and `clear_data` again.
+
+For each TaskGroup, it sees what's in the task group definition and runs an expectation test.
+
+# Rest YAML tests Helper
+
+`elasticsearch-api/spec/rest_yaml_tests_helper.rb`
+
+- `ADMIN_CLIENT` is defined here.
+- `SINGLE_TEST` is defined here.
+- Skipped tests are listed here
+
+# Spec Helper
+
+- `DEFAULT_CLIENT` is defined here
+
+# RSpec Matchers
+
+The tests use custom [RSpec Matchers](https://www.rubydoc.info/gems/rspec-expectations/RSpec/Matchers) defined in `api-spec-testing/rspec_matchers.rb`.
+
+# Enable Logging
+
+To enable logging, set the environment `QUIET` to false before running the tests. In CI, this is located in the [Dockerfile](https://github.com/elastic/elasticsearch-ruby/blob/master/.ci/Dockerfile). The environment variable is evaluated in the Rest YAML tests Helper file.

data/spec/elasticsearch/api/rest_api_yaml_spec.rb

@@ -6,29 +6,23 @@ require 'spec_helper'
 require 'rest_yaml_tests_helper'
 
 describe 'Rest API YAML tests' do
-
+  # Traverse YAML files and create TestFile object:
   REST_API_YAML_FILES.each do |file|
-
     test_file = Elasticsearch::RestAPIYAMLTests::TestFile.new(file, REST_API_YAML_SKIP_FEATURES)
 
     context "#{file.gsub("#{YAML_FILES_DIRECTORY}/", '')}" do
-
       test_file.tests.each do |test|
 
         context "#{test.description}" do
-
           if test.skip_test?(ADMIN_CLIENT)
             skip 'Test contains feature(s) not yet supported or version is not satisfied'
-
           else
-
             let(:client) do
               DEFAULT_CLIENT
             end
 
             # Runs once before each test in a test file
             before(:all) do
-              # Runs once before each test in a test file
               Elasticsearch::RestAPIYAMLTests::TestFile.clear_data(ADMIN_CLIENT)
               test_file.setup(ADMIN_CLIENT)
             end
@@ -39,21 +33,18 @@ describe 'Rest API YAML tests' do
             end
 
             test.task_groups.each do |task_group|
-
               before do
                 task_group.run(client)
               end
 
               # 'catch' is in the task group definition
               if task_group.catch_exception?
-
                 it 'sends the request and throws the expected error' do
                   expect(task_group.exception).to match_error(task_group.expected_exception_message)
                 end
 
                 # 'match' on error description is in the task group definition
                 if task_group.has_match_clauses?
-
                   task_group.match_clauses.each do |match|
                     it 'contains the expected error in the request response' do
                       expect(task_group.exception.message).to match(Regexp.new(Regexp.escape(match['match'].values.first.to_s)))
@@ -64,7 +55,6 @@ describe 'Rest API YAML tests' do
 
                 # 'match' is in the task group definition
                 if task_group.has_match_clauses?
-
                   task_group.match_clauses.each do |match|
                     it "has the expected value (#{match['match'].values.join(',')}) in the response field (#{match['match'].keys.join(',')})" do
                       expect(task_group.response).to match_response(match['match'], test)
@@ -74,7 +64,6 @@ describe 'Rest API YAML tests' do
 
                 # 'length' is in the task group definition
                 if task_group.has_length_match_clauses?
-
                   task_group.length_match_clauses.each do |match|
                     it "the '#{match['length'].keys.join(',')}' field have the expected length" do
                       expect(task_group.response).to match_response_field_length(match['length'], test)
@@ -84,7 +73,6 @@ describe 'Rest API YAML tests' do
 
                 # 'is_true' is in the task group definition
                 if task_group.has_true_clauses?
-
                   task_group.true_clauses.each do |match|
                     it "sends the request and the '#{match['is_true']}' field is set to true" do
                       expect(task_group.response).to match_true_field(match['is_true'], test)
@@ -94,7 +82,6 @@ describe 'Rest API YAML tests' do
 
                 # 'is_false' is in the task group definition
                 if task_group.has_false_clauses?
-
                   task_group.false_clauses.each do |match|
                     it "sends the request and the '#{match['is_false']}' field is set to true" do
                       expect(task_group.response).to match_false_field(match['is_false'], test)
@@ -104,7 +91,6 @@ describe 'Rest API YAML tests' do
 
                 # 'gte' is in the task group definition
                 if task_group.has_gte_clauses?
-
                   task_group.gte_clauses.each do |match|
                     it "sends the request and the '#{match['gte']}' field is greater than or equal to the expected value" do
                       expect(task_group.response).to match_gte_field(match['gte'], test)
@@ -114,7 +100,6 @@ describe 'Rest API YAML tests' do
 
                 # 'gt' is in the task group definition
                 if task_group.has_gt_clauses?
-
                   task_group.gt_clauses.each do |match|
                     it "sends the request and the '#{match['gt']}' field is greater than the expected value" do
                       expect(task_group.response).to match_gt_field(match['gt'], test)
@@ -124,7 +109,6 @@ describe 'Rest API YAML tests' do
 
                 # 'lte' is in the task group definition
                 if task_group.has_lte_clauses?
-
                   task_group.lte_clauses.each do |match|
                     it "sends the request and the '#{match['lte']}' field is less than or equal to the expected value" do
                       expect(task_group.response).to match_lte_field(match['lte'], test)
@@ -134,7 +118,6 @@ describe 'Rest API YAML tests' do
 
                 # 'lt' is in the task group definition
                 if task_group.has_lt_clauses?
-
                   task_group.lt_clauses.each do |match|
                     it "sends the request and the '#{match['lt']}' field is less than the expected value" do
                       expect(task_group.response).to match_lt_field(match['lt'], test)

data/spec/rest_yaml_tests_helper.rb

@@ -11,10 +11,11 @@ PROJECT_PATH = File.join(File.dirname(__FILE__), '..', '..')
 
 if hosts = ELASTICSEARCH_URL
   split_hosts = hosts.split(',').map do |host|
-    /(http\:\/\/)?(\S+)/.match(host)[2]
+    /(http\:\/\/)?\S+/.match(host)
   end
-
-  TEST_HOST, TEST_PORT = split_hosts.first.split(':')
+  uri = URI.parse(split_hosts.first[0])
+  TEST_HOST = uri.host
+  TEST_PORT = uri.port
 else
   TEST_HOST, TEST_PORT = 'localhost', '9200'
 end

data/spec/spec_helper.rb

@@ -2,7 +2,11 @@
 # 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 'pry-nav'
+if defined?(JRUBY_VERSION)
+  require 'pry-nav'
+else
+  require 'pry-byebug'
+end
 require 'yaml'
 require 'jbuilder'
 require 'jsonify'

data/utils/README.md

@@ -0,0 +1,41 @@
+# Utils
+
+## The Generator
+
+This directory hosts The Generator, a tool that generates the classes for each API endpoint from the [Elasticsearch REST API JSON Specification](https://github.com/elastic/elasticsearch/tree/master/rest-api-spec).
+
+### Generate
+
+To generate the code, you need to run (from this folder):
+```bash
+$ thor api:code:generate
+```
+
+- The oss Ruby code will be generated in `elasticsearch-api/lib/elasticsearch/api/actions`.  
+- The xpack Ruby code will be generated in `elasticsearch-xpack/lib/elasticsearch/xpack/api/actions`.
+- The generator runs Rubocop to autolint and clean up the generated files.
+
+Alternatively, you can pass in `oss` or `xpack` as parameters to generate only one of the 2 sets of endpoints:
+
+```bash
+$ thor api:code:generate --api=xpack
+$ thor api:code:generate --api=oss
+```
+
+### Development
+
+The main entry point is `generate_source.rb`, which contains a class that implements a Thor task: `generate`:
+
+```
+$ thor api:code:generate
+```
+
+It uses [Thor::Actions](https://github.com/erikhuda/thor/wiki/Actions)' `template` method and `templates/method.erb` to generate the final code. The `generator` directory contains some helpers used to generate the code. The ERB template is split into partials and you can find all ERB files in the `templates` directory.
+
+There's also a lister task:
+
+```
+$ thor api:list
+```
+
+It's implemented in `lister.rb` and it lists all the REST API endpoints from the JSON specification.

data/utils/thor/generate_source.rb

@@ -34,18 +34,28 @@ module Elasticsearch
       __root = Pathname(File.expand_path('../../..', __FILE__))
 
       desc 'generate', 'Generate source code and tests from the REST API JSON specification'
-      method_option :verbose, type: :boolean, default: false, desc: 'Output more information'
-      method_option :tests,   type: :boolean, default: false, desc: 'Generate test files'
-      method_option :xpack,   type: :boolean, default: false, desc: 'Generate X-Pack'
-
+      method_option :verbose, type: :boolean, default: false,  desc: 'Output more information'
+      method_option :tests,   type: :boolean, default: false,  desc: 'Generate test files'
+      method_option :api,     type: :array,   default: %w[oss xpack], desc: 'APIs to generate (oss, x-pack)'
       def generate
         self.class.source_root File.expand_path(__dir__)
-        @xpack = options[:xpack]
+        @xpack = options[:api].include? 'xpack'
+        @oss   = options[:api].include? 'oss'
+
+        __generate_source(:xpack) if @xpack
+        __generate_source(:oss) if @oss
+        # -- Tree output
+        print_tree if options[:verbose]
+      end
+
+      private
 
-        @input = FilesHelper.input_dir(@xpack)
-        @output = FilesHelper.output_dir(@xpack)
+      def __generate_source(api)
+        @current_api = api
+        @input = FilesHelper.input_dir(api)
+        @output = FilesHelper.output_dir(api)
 
-        FilesHelper.files(@xpack).each do |filepath|
+        FilesHelper.files(api).each do |filepath|
           @path = Pathname(@input.join(filepath))
           @json = MultiJson.load(File.read(@path))
           @spec = @json.values.first
@@ -83,17 +93,12 @@ module Elasticsearch
           puts
         end
 
-        run_rubocop
-
-        # -- Tree output
-        print_tree if options[:verbose]
+        run_rubocop(api)
       end
 
-      private
-
       def __full_namespace
         names = @endpoint_name.split('.')
-        if @xpack
+        if @current_api == :xpack
           names = (names.first == 'xpack' ? names : ['xpack', names].flatten)
           # Return an array with 'ml' renamed to 'machine_learning' and 'ilm' to
           # 'index_lifecycle_management'
@@ -149,12 +154,12 @@ module Elasticsearch
         return termvectors_path if @method_name == 'termvectors'
 
         result = ''
-        anchor_string = ''
+        anchor_string = []
         @paths.sort { |a, b| b.length <=> a.length }.each_with_index do |path, i|
           var_string = __extract_path_variables(path).map { |var| "_#{var}" }.join(' && ')
-          next if anchor_string == var_string
+          next if anchor_string.include? var_string
 
-          anchor_string = var_string
+          anchor_string << var_string
           result += if i.zero?
                       "if #{var_string}\n"
                     elsif (i == @paths.size - 1) || var_string.empty?
@@ -238,11 +243,11 @@ module Elasticsearch
       end
 
       def __utils
-        @xpack ? 'Elasticsearch::API::Utils' : 'Utils'
+        (@current_api == :xpack) ? 'Elasticsearch::API::Utils' : 'Utils'
       end
 
-      def run_rubocop
-        system("rubocop --format autogenconf -x #{FilesHelper::output_dir(@xpack)}")
+      def run_rubocop(api)
+        system("rubocop --format autogenconf -x #{FilesHelper::output_dir(api)}")
       end
     end
   end

data/utils/thor/generator/endpoint_specifics.rb

@@ -64,6 +64,12 @@ module Elasticsearch
         COMPLEX_IGNORE_404.include? endpoint
       end
 
+      def module_name_helper(name)
+        return name.upcase if %w[sql ssl].include? name
+
+        name.split("_").map(&:capitalize).join
+      end
+
       def termvectors_path
         <<~SRC
           if _index && _type && _id
@@ -146,7 +152,7 @@ module Elasticsearch
       def bulk_body_helper
         <<~SRC
           if body.is_a? Array
-            payload = Utils.__bulkify(body)
+            payload = Elasticsearch::API::Utils.__bulkify(body)
           else
             payload = body
           end

data/utils/thor/generator/files_helper.rb

@@ -10,8 +10,8 @@ module Elasticsearch
       XPACK_OUTPUT_DIR = '../../elasticsearch-xpack/lib/elasticsearch/xpack/api/actions'.freeze
 
       # Path to directory with JSON API specs
-      def self.input_dir(xpack = false)
-        input_dir = if xpack
+      def self.input_dir(api)
+        input_dir = if api == :xpack
                       File.expand_path(XPACK_SRC_PATH, __FILE__)
                     else
                       File.expand_path(OSS_SRC_PATH, __FILE__)
@@ -20,13 +20,13 @@ module Elasticsearch
       end
 
       # Path to directory to copy generated files
-      def self.output_dir(xpack = false)
-        xpack ? Pathname(XPACK_OUTPUT_DIR) : Pathname(OSS_OUTPUT_DIR)
+      def self.output_dir(api)
+        api == :xpack ? Pathname(XPACK_OUTPUT_DIR) : Pathname(OSS_OUTPUT_DIR)
       end
 
       # Only get JSON files and remove hidden files
-      def self.files(xpack = false)
-        Dir.entries(input_dir(xpack).to_s).reject do |f|
+      def self.files(api)
+        Dir.entries(input_dir(api).to_s).reject do |f|
           f.start_with?('.') ||
             f.start_with?('_') ||
             File.extname(f) != '.json'

data/utils/thor/templates/method.erb

@@ -3,12 +3,12 @@
 # See the LICENSE file in the project root for more information
 
 module Elasticsearch
-<%- if @xpack -%>
+<%- if @current_api == :xpack -%>
   <%= '  '*(@namespace_depth) %>module XPack
 <%- end %>
 <%= '  '*(@namespace_depth) %>module API
 <%- @module_namespace.each_with_index do |name, i| -%>
-  <%= '  '*i %>module <%= name.split("_").map(&:capitalize).join %>
+  <%= '  '*i %>module <%= module_name_helper(name) %>
 <%- end -%>
 <%= '  '*(@namespace_depth+2) %>module Actions
 <%= ERB.new(File.new("./thor/templates/_documentation_top.erb").read, trim_mode: '-').result(binding) -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-api
 version: !ruby/object:Gem::Version
-  version: 7.5.0
+  version: 7.6.0
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2020-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: ansi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: elasticsearch
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: elasticsearch-transport
+  name: elasticsearch-extensions
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: elasticsearch-transport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: elasticsearch-extensions
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ansi
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: shoulda-context
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +151,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,7 +193,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: jsonify
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -193,7 +207,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jsonify
+  name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -207,7 +221,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: cane
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -221,7 +235,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby-prof
+  name: escape_utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -249,7 +263,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: escape_utils
+  name: require-prof
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -297,21 +311,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cane
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: require-prof
+  name: ruby-prof
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -324,20 +338,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
 description: 'Ruby API for Elasticsearch. See the `elasticsearch` gem for full integration.
 
 '
@@ -405,6 +405,8 @@ files:
 - lib/elasticsearch/api/actions/field_caps.rb
 - lib/elasticsearch/api/actions/get.rb
 - lib/elasticsearch/api/actions/get_script.rb
+- lib/elasticsearch/api/actions/get_script_context.rb
+- lib/elasticsearch/api/actions/get_script_languages.rb
 - lib/elasticsearch/api/actions/get_source.rb
 - lib/elasticsearch/api/actions/index.rb
 - lib/elasticsearch/api/actions/indices/analyze.rb
@@ -509,6 +511,7 @@ files:
 - lib/elasticsearch/api/namespace/tasks.rb
 - lib/elasticsearch/api/utils.rb
 - lib/elasticsearch/api/version.rb
+- spec/README.md
 - spec/elasticsearch/api/actions/abort_benchmark_spec.rb
 - spec/elasticsearch/api/actions/benchmark_spec.rb
 - spec/elasticsearch/api/actions/bulk_spec.rb
@@ -641,6 +644,7 @@ files:
 - test/integration/yaml_test_runner.rb
 - test/test_helper.rb
 - utils/Gemfile
+- utils/README.md
 - utils/Thorfile
 - utils/thor/generate_source.rb
 - utils/thor/generator/endpoint_specifics.rb
@@ -666,18 +670,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby API for Elasticsearch.
 test_files:
+- spec/README.md
 - spec/elasticsearch/api/actions/abort_benchmark_spec.rb
 - spec/elasticsearch/api/actions/benchmark_spec.rb
 - spec/elasticsearch/api/actions/bulk_spec.rb