elasticsearch-api 7.12.0 → 7.13.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42a694e5db47d40c5bd1a2d5e1cc8fc6c6c4edf16fd6010917b5eacddee8584a
-  data.tar.gz: 58a7c5786ff99ad0713e3a463bab0ebdb897fc9a71da02a34a3842b5dd3a9cff
+  metadata.gz: ac1b298f88f95a176b9723eb7fb66ed7e232a9617fd2c8eada50dd685741e3b9
+  data.tar.gz: 548d3145ede52487c8d07dd5b8f0be76d3c404efd562b58237d28adac1ab942e
 SHA512:
-  metadata.gz: e0582f444374b3f8b97a2aab4b4b1ea7bc96e557c62bedc89e41e0f1ae082367aa832b2dfd7e452e677402e12e068e1d63170edf2d2d6c92ed2e152f5c8d5100
-  data.tar.gz: ede2dda8d950cddfc6a4d403d2d57b8bf8ad53d0a280e7f696f9aa56efe24ce1430721b8b85944db10db84b60ab1a130cdb4a8d22f30eb9e8a61a78e5a8709ae
+  metadata.gz: 79f0f36a869774d61257c2ae2e7d4fe6da8e0f625c63634037cdf34b2ade1197daf80225e49f3e7aa73201f4829a9c52ebbbd6eb02c8e29135c124b35f899f2f
+  data.tar.gz: 6ea4bd25abff9691a478f4437e12f541de1ec4f09abd5421b75b2c4d19f784c5364337f34b01d0a67f8279a0dd87dcff1428008ae5b77110e3a6caf3797aadcb

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 |
 |:-------------:|:-:| :-----------: |
@@ -190,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 test: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/lib/elasticsearch/api.rb

@@ -73,7 +73,8 @@ module Elasticsearch
                 Elasticsearch::API::Cat,
                 Elasticsearch::API::Remote,
                 Elasticsearch::API::DanglingIndices,
-                Elasticsearch::API::Features
+                Elasticsearch::API::Features,
+                Elasticsearch::API::Shutdown
     end
 
     # The serializer class

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

@@ -35,7 +35,7 @@ module Elasticsearch
       # @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.12/docs-bulk.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/docs-bulk.html
       #
       def bulk(arguments = {})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]

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.12/cat-alias.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/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.12/cat-allocation.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/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.12/cat-count.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-count.html
         #
         def count(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/cat/fielddata.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.12/cat-fielddata.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/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.12/cat-health.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/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.12/cat.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat.html
         #
         def help(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -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.12/cat-indices.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/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.12/cat-master.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/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.12/cat-nodeattrs.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/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.12/cat-nodes.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/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.12/cat-pending-tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-pending-tasks.html
         #
         def pending_tasks(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/cat/plugins.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.12/cat-plugins.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-plugins.html
         #
         def plugins(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -33,7 +33,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.12/cat-recovery.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-recovery.html
         #
         def recovery(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/cat/repositories.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.12/cat-repositories.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-repositories.html
         #
         def repositories(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/cat/segments.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.12/cat-segments.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-segments.html
         #
         def segments(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -33,7 +33,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.12/cat-shards.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-shards.html
         #
         def shards(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/cat/snapshots.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.12/cat-snapshots.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-snapshots.html
         #
         def snapshots(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -33,7 +33,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.12/tasks.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/tasks.html
         #
         def tasks(arguments = {})
           headers = arguments.delete(:headers) || {}

data/lib/elasticsearch/api/actions/cat/templates.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.12/cat-templates.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-templates.html
         #
         def templates(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -33,7 +33,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.12/cat-thread-pool.html
+        # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-thread-pool.html
         #
         def thread_pool(arguments = {})
           headers = arguments.delete(:headers) || {}

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

@@ -29,7 +29,7 @@ module Elasticsearch
       # Deprecated since version 7.0.0
       #
       #
-      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.12/clear-scroll-api.html
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/clear-scroll-api.html
       #
       def clear_scroll(arguments = {})
         headers = arguments.delete(:headers) || {}

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

@@ -0,0 +1,42 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module API
+    module Actions
+      # Close a point in time
+      #
+      # @option arguments [Hash] :headers Custom HTTP headers
+      # @option arguments [Hash] :body a point-in-time id to close
+      #
+      # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/point-in-time-api.html
+      #
+      def close_point_in_time(arguments = {})
+        headers = arguments.delete(:headers) || {}
+
+        arguments = arguments.clone
+
+        method = Elasticsearch::API::HTTP_DELETE
+        path   = "_pit"
+        params = {}
+
+        body = arguments[:body]
+        perform_request(method, path, params, body, headers).body
+      end
+    end
+  end
+end