elasticsearch-api 7.9.0 → 7.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b4c908b611c1f11f33677f31e23ab069a27a53e7b7c8765e05371c0a3b45f4e
-  data.tar.gz: 4ce4bb9d09c4a5010390a768a1c3c1d493c69891f4ede0e45ebebae5dc087e1d
+  metadata.gz: f73d95469f7d334ef8293085aee0d220b42666ca60d0cc26a5d47fea6eb7ad4c
+  data.tar.gz: 39ffe6b84ef28a675f92332840d56fda4a568eab8d65b450ac14c0eb7a34b2c2
 SHA512:
-  metadata.gz: 1b55dff1575e13a0d591276fc46ba2b5a1ab2d280cd234f67d4c6751d943043594de70831cd264beb9072b3c6a0fde26646bd7175d77486ef0906450463b474c
-  data.tar.gz: 8a69c31d352a5de8186394cf79b1fc608f80d915bdddffeffac039eaf2aaefe6ab36e4ad315723cfb19a31f4a7201c3ac30ae13a66feaa0ebb7ef1d6b39f6ed5
+  metadata.gz: 81452e679f37809e048ec484144bc9665e63a66593637c718e1c0eaebd855710710254df91e47cf9adc4e4f2ee0200fa7bf50d682546c87c80b0f76e92222f05
+  data.tar.gz: 044f100c6178945025e5579f4ac7c65c31533bd55bb8b2dd55caf86e183ce388de39f0136665ccaffcb66d7506eccbce87e596a790e3beabe96c870f76712715

data/Gemfile

@@ -20,14 +20,14 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in elasticsearch-api.gemspec
 gemspec
 
-if File.exist? File.expand_path("../../elasticsearch/elasticsearch.gemspec", __FILE__)
-  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
 end
 
+if File.exist? File.expand_path("../../elasticsearch/elasticsearch.gemspec", __FILE__)
+  gem 'elasticsearch', path: File.expand_path("../../elasticsearch", __FILE__), require: false
+end
+
 if File.exist? File.expand_path("../../elasticsearch-extensions", __FILE__)
   gem 'elasticsearch-extensions', path: File.expand_path("../../elasticsearch-extensions", __FILE__), require: false
 end

data/README.md

@@ -13,8 +13,7 @@ It does not provide an Elasticsearch client; see the
 
 The library is compatible with Ruby 1.9 and higher.
 
-It is compatible with Elasticsearch's API versions from 0.90 till current,
-just use a release matching major version of Elasticsearch.
+It is compatible with Elasticsearch's API versions from 0.90 till current, just use a release matching major version of Elasticsearch.
 
 | Ruby          |   | Elasticsearch |
 |:-------------:|:-:| :-----------: |
@@ -56,12 +55,12 @@ the library modules have been already included**, so you just call the API metho
 ```ruby
 require 'elasticsearch'
 
-client = Elasticsearch::Client.new log: true
+client = Elasticsearch::Client.new(log: true)
 
-client.index  index: 'myindex', type: 'mytype', id: 1, body: { title: 'Test' }
+client.index(index: 'myindex', type: 'mytype', id: 1, body: { title: 'Test' })
 # => {"_index"=>"myindex", ... "created"=>true}
 
-client.search index: 'myindex', body: { query: { match: { title: 'test' } } }
+client.search(index: 'myindex', body: { query: { match: { title: 'test' } } })
 # => {"took"=>2, ..., "hits"=>{"total":5, ...}}
 ```
 
@@ -75,12 +74,13 @@ When you want to mix the library into your own client, it must conform to a foll
 * It responds to a `perform_request(method, path, params, body, headers)` method,
 * the method returns an object with `status`, `body` and `headers` methods.
 
-A simple client could look like this:
+A simple client could look like this (_with a dependency on `active_support` to parse the query params_):
 
 ```ruby
 require 'multi_json'
 require 'faraday'
 require 'elasticsearch/api'
+require 'active_support'
 
 class MySimpleClient
   include Elasticsearch::API
@@ -92,10 +92,25 @@ class MySimpleClient
 
     CONNECTION.run_request \
       method.downcase.to_sym,
-      path,
+      path_with_params(path, params),
       ( body ? MultiJson.dump(body): nil ),
       {'Content-Type' => 'application/json'}
   end
+  
+  private
+  
+  def path_with_params(path, params)
+    return path if params.blank?
+  
+    case params
+    when String
+      "#{path}?#{params}"
+    when Hash
+      "#{path}?#{params.to_query}"
+    else
+      raise ArgumentError, "Cannot parse params: '#{params}'"
+    end
+  end
 end
 
 client = MySimpleClient.new
@@ -174,19 +189,18 @@ Elasticsearch::API.serializer.dump({foo: 'bar'})
 
 ## Development
 
-To work on the code, clone and bootstrap the main repository first --
-please see instructions in the main [README](../README.md#development).
+To work on the code, clone and bootstrap the main repository first -- please see instructions in the main [README](../README.md#development).
 
-To run tests, launch a testing cluster -- again, see instructions
-in the main [README](../README.md#development) -- and use the Rake tasks:
+To run tests, launch a testing cluster -- again, see instructions in the main [README](../README.md#development) -- and use the Rake tasks:
 
 ```
 time rake test:unit
 time rake test:integration
 ```
 
-Unit tests have to use Ruby 1.8 compatible syntax, integration tests
-can use Ruby 2.x syntax and features.
+We run the test suite for Elasticsearch's Rest API tests. You can read more about this in [the test runner README](https://github.com/elastic/elasticsearch-ruby/tree/master/api-spec-testing#rest-api-yaml-test-runner).
+
+The `rest_api` needs the test files from Elasticsearch. You can run the rake task to download the test artifacts in the root folder of the project. This task needs a running cluster to determine which version and build hash of Elasticsearch to use and test against. `TEST_ES_SERVER=http://localhost:9200 rake elasticsearch:download_artifacts`. This will download the necessary files used for the integration tests to `./tmp`.
 
 ## License
 

data/Rakefile

@@ -16,14 +16,7 @@
 # under the License.
 
 require 'bundler/gem_tasks'
-
-def __current__
-  Pathname( File.expand_path('..', __FILE__) )
-end
-
-def git_specs(command, options={})
-  sh "git --git-dir=#{__current__.join('../tmp/elasticsearch/.git')} --work-tree=#{__current__.join('../tmp/elasticsearch')} #{command}", options
-end
+require 'json'
 
 task(:default) { system 'rake --tasks' }
 task test: 'test:unit'
@@ -46,73 +39,28 @@ namespace :test do
     t.exclude_pattern = 'spec/**{,/*/**}/rest_api_yaml_spec.rb'
   end
 
-  # Rest API Spec tests - rake test:rest_api
+  desc "Run Rest API Spec tests"
   RSpec::Core::RakeTask.new(:rest_api) do |t|
-    t.pattern = 'spec/**{,/*/**}/rest_api_yaml_spec.rb'
-  end
-
-  desc 'Update the repository with YAML tests'
-  task :update do
-    git_specs 'fetch origin', verbose: true
-  end
-
-  desc "Run integration tests"
-  task integration: :update do
     require 'elasticsearch'
-
-    branches = `git --git-dir=#{__current__.join('../tmp/elasticsearch/.git')} --work-tree=#{__current__.join('../tmp/elasticsearch')} branch --no-color`
-
-    current_branch = branches.
-      split("\n").
-      select { |b| b =~ /^\*/ }.
-      reject { |b| b =~ /no branch|detached/ }.
-      map    { |b| b.gsub(/^\*\s*/, '') }.
-      first
-
-    unless current_branch
-      STDERR.puts "[!] Unable to determine current branch, defaulting to 'master'"
-      current_branch = 'master'
-    end
-
     # Check if a test cluster is running
     begin
       url = ENV['TEST_CLUSTER_URL'] || ENV['TEST_ES_SERVER']
-      url = "http://localhost:#{ENV['TEST_CLUSTER_PORT'] || 9250}" unless url
+      url = "http://localhost:#{ENV['TEST_CLUSTER_PORT'] || 9200}" unless url
       client = Elasticsearch::Client.new :url => url
       es_version_info = client.info['version']
+      version_number = es_version_info['number']
       build_hash      = es_version_info['build_hash']
-      cluster_running = true
     rescue Faraday::ConnectionFailed
       STDERR.puts "[!] Test cluster not running?"
-      cluster_running = false
+      exit 1
     end
 
-    checkout_specs_version = ENV['TEST_NO_CHECKOUT'].nil? ? true : false
-    checkout_build_hash    = ENV['TEST_BUILD_REF'] || build_hash
-    ENV['TEST_BUILD_REF']  = checkout_build_hash
+    t.pattern = 'spec/**{,/*/**}/rest_api_yaml_spec.rb'
+  end
 
-    begin
-      unless checkout_specs_version
-        STDERR.puts '-'*80, "YAML tests: Not switching, TEST_NO_CHECKOUT=y", '-'*80
-      end
-
-      if checkout_specs_version && !checkout_build_hash
-        STDERR.puts "[!] Cannot determine checkout build hash -- server not running or TEST_BUILD_REF not specified"
-        exit(1)
-      end
-
-      if checkout_specs_version && checkout_build_hash
-        # Checkout the commit corresponding to the running server build, or passed TEST_BUILD_REF
-        name = ENV['CI'] ? checkout_build_hash : "[\e[1m#{checkout_build_hash}\e[0m]"
-        STDERR.puts '-'*80, "YAML tests: Switching to #{name} from #{current_branch}", '-'*80
-        git_specs "checkout #{checkout_build_hash} --force --quiet"
-      end
-
-      Rake::Task['test:rest_api'].invoke
-
-    ensure
-      git_specs "checkout #{current_branch} --force --quiet" if checkout_specs_version && current_branch
-    end
+  desc "Run integration tests"
+  task :integration do
+    Rake::Task['test:rest_api'].invoke
   end
 
   desc 'Run unit and integration tests'
@@ -121,6 +69,42 @@ namespace :test do
     Rake::Task['test:integration'].invoke
   end
 
+  def refresh_artifacts(build_hash, version_number)
+    unless build_hash
+      STDERR.puts "[!] Cannot determine checkout build hash -- server not running"
+      exit(1)
+    end
+
+    puts 'Downloading artifacts file...'
+    filename = 'tmp/artifacts.json'
+    `curl -s https://artifacts-api.elastic.co/v1/versions/#{version_number} -o #{filename}`
+
+    unless File.exists?("./#{filename}")
+      STDERR.puts '[!] Couldn\'t download artifacts file'
+      exit 1
+    end
+
+    artifacts = JSON.parse(File.read('./tmp/artifacts.json'))
+
+    build_hash_artifact = artifacts['version']['builds'].select do |a|
+      a.dig('projects', 'elasticsearch', 'commit_hash') == build_hash
+    end.first
+    # Dig into the elasticsearch packages, search for the rest-resources-zip package and catch the URL:
+    zip_url = build_hash_artifact.dig('projects', 'elasticsearch', 'packages').select { |k,v| k =~ /rest-resources-zip/ }.map { | _, v| v['url'] }.first
+
+    filename = zip_url.split('/').last
+    puts 'Downloading zip file:'
+    `curl -s #{zip_url} -o tmp/#{filename}`
+
+    unless File.exists?("./tmp/#{filename}")
+      STDERR.puts '[!] Couldn\'t download artifact'
+      exit 1
+    end
+
+    puts "Unzipping file #{filename}"
+    `unzip -o tmp/#{filename} -d tmp/`
+  end
+
   namespace :cluster do
     desc "Start Elasticsearch nodes for tests"
     task :start do

data/elasticsearch-api.gemspec

@@ -49,13 +49,12 @@ Gem::Specification.new do |s|
   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 'rake', '~> 13'
   s.add_development_dependency 'shoulda-context'
   s.add_development_dependency 'yard'
 
@@ -67,8 +66,7 @@ Gem::Specification.new do |s|
   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 'simplecov'
   s.add_development_dependency 'test-unit', '~> 2'
   s.add_development_dependency 'ruby-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
 

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

@@ -26,16 +26,16 @@ module Elasticsearch
       # @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
       # @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_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 [Boolean] :require_alias Sets require_alias for all incoming documents. Defaults to unset (false)
       # @option arguments [Hash] :headers Custom HTTP headers
       # @option arguments [String|Array] :body The operation definition and data (action-data pairs), separated by newlines. Array of Strings, Header/Data pairs,
       # or the conveniency "combined" format can be passed, refer to Elasticsearch::API::Utils.__bulkify documentation.
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/docs-bulk.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/docs-bulk.html
       #
       def bulk(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -81,7 +81,8 @@ module Elasticsearch
         :_source,
         :_source_excludes,
         :_source_includes,
-        :pipeline
+        :pipeline,
+        :require_alias
       ].freeze)
     end
   end

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

@@ -31,7 +31,7 @@ module Elasticsearch
         # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-alias.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/cat-alias.html
         #
         def aliases(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -32,7 +32,7 @@ module Elasticsearch
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-allocation.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/cat-allocation.html
         #
         def allocation(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -29,7 +29,7 @@ module Elasticsearch
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-count.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/cat-count.html
         #
         def count(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -28,10 +28,9 @@ module Elasticsearch
         # @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
-        # @option arguments [List] :fields A comma-separated list of fields to return in the output
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-fielddata.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/cat-fielddata.html
         #
         def fielddata(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -30,7 +30,7 @@ module Elasticsearch
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-health.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/cat-health.html
         #
         def health(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -25,7 +25,7 @@ module Elasticsearch
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/cat.html
         #
         def help(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -24,7 +24,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, 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 [Boolean] :local Return local information, do not retrieve 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 [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status (options: green, yellow, red)
@@ -37,7 +37,7 @@ module Elasticsearch
         # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-indices.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/cat-indices.html
         #
         def indices(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -30,7 +30,7 @@ module Elasticsearch
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-master.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/cat-master.html
         #
         def master(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -30,7 +30,7 @@ module Elasticsearch
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-nodeattrs.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/cat-nodeattrs.html
         #
         def nodeattrs(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -31,9 +31,10 @@ module Elasticsearch
         # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
         # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos)
         # @option arguments [Boolean] :v Verbose mode. Display column headers
+        # @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-nodes.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/cat-nodes.html
         #
         def nodes(arguments = {})
           headers = arguments.delete(:headers) || {}
@@ -62,7 +63,8 @@ module Elasticsearch
           :help,
           :s,
           :time,
-          :v
+          :v,
+          :include_unloaded_segments
         ].freeze)
       end
     end

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

@@ -31,7 +31,7 @@ module Elasticsearch
         # @option arguments [Boolean] :v Verbose mode. Display column headers
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-pending-tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/cat-pending-tasks.html
         #
         def pending_tasks(arguments = {})
           headers = arguments.delete(:headers) || {}