elasticsearch-api 6.1.0 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 339eaef9d53c9b3bb9e480e923ee644d48b9a325
-  data.tar.gz: 15fff528c094a4f2ffc28587c93ebe56ffaec377
+SHA256:
+  metadata.gz: 95f0862a557b65c4baf38743f4e6866d77d7d56cd21180ddc1f1fda65a5d992a
+  data.tar.gz: e18b8bc805755ddcbc2a10d4657b55ee24fb75abc84ea706e07bf5aed304f397
 SHA512:
-  metadata.gz: 8e79cf96d718462e360f38131ab8c4ba5dce473e1a55309b467ceaeaa1acd2540d99b0d019ad23c8ebc70f22a8112e8c48ef840d47f3ca4222d4b0728367b682
-  data.tar.gz: d76d8390aeaf299272073d3fd7bd820b31930dee75ac75282bedfd96bdbc6d37d05e3fc05ab5638e9ddd8df39089a883241e2436ecb131061f1dfc4f7b404acb
+  metadata.gz: 724cfe9f1665465585f0b877e059463cff6cb390302d7350d5432cad3dbd49f2527192dcb3eef70be1e1270b021caa2a3189fc832c4facb68bcb5325eacde5cb
+  data.tar.gz: 337bc9605d85fd89f1be2bee5674b1e2cac4a8b9c085fd5099c39661b5e4b8fef35402d072a99aa550cb2d97391ce7c8968376b0da47954aa2efd444bef6811c

data/Gemfile

@@ -14,3 +14,9 @@ end
 if File.exist? File.expand_path("../../elasticsearch-extensions", __FILE__)
   gem 'elasticsearch-extensions', :path => File.expand_path("../../elasticsearch-extensions", __FILE__), :require => false
 end
+
+
+group :development do
+  gem 'rspec'
+  gem 'pry-nav'
+end

data/Rakefile

@@ -14,22 +14,32 @@ task  :test    => 'test:unit'
 # ----- Test tasks ------------------------------------------------------------
 
 require 'rake/testtask'
+require 'rspec/core/rake_task'
+
 namespace :test do
 
+  RSpec::Core::RakeTask.new(:spec)
+
   desc "Update the repository with YAML tests"
   task :update do
     git_specs "fetch origin --verbose", :verbose => true
   end
 
+  desc "Wait for Elasticsearch to be in a green state"
+  task :wait_for_green do
+    sh '../scripts/wait-cluster.sh'
+  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
   end
 
   desc "Run integration tests"
-  task :integration do
+  task :integration => :wait_for_green do
     require 'elasticsearch'
 
     branches = `git --git-dir=#{__current__.join('../tmp/elasticsearch/.git')} --work-tree=#{__current__.join('../tmp/elasticsearch')} branch --no-color`
@@ -48,6 +58,7 @@ namespace :test do
 
     # Define the task
     t = Rake::TestTask.new(:integration) do |test|
+      test.deps = [ :wait_for_green ]
       test.libs << 'lib' << 'test'
       test.test_files = FileList["test/integration/yaml_test_runner.rb", "test/integration/**/*_test.rb"]
       test.verbose = false
@@ -56,7 +67,8 @@ namespace :test do
 
     # Check if a test cluster is running
     begin
-      url = ENV.fetch('TEST_CLUSTER_URL', "http://localhost:#{ENV['TEST_CLUSTER_PORT'] || 9250}")
+      url = ENV['TEST_CLUSTER_URL'] || ENV['TEST_ES_SERVER']
+      url = "http://localhost:#{ENV['TEST_CLUSTER_PORT'] || 9250}" unless url
       client = Elasticsearch::Client.new :url => url
       es_version_info = client.info['version']
       build_hash      = es_version_info['build_hash']

data/elasticsearch-api.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   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"
+  s.license       = "Apache-2.0"
 
   s.files         = `git ls-files`.split($/)
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "multi_json"
 
-  s.add_development_dependency "bundler", "> 1"
+  s.add_development_dependency "bundler"
 
   if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
     s.add_development_dependency "rake", "~> 11.1"

data/lib/elasticsearch/api.rb

@@ -4,7 +4,9 @@ require "multi_json"
 require "elasticsearch/api/version"
 require "elasticsearch/api/namespace/common"
 require "elasticsearch/api/utils"
+require "elasticsearch/api/actions/params_registry"
 
+Dir[ File.expand_path('../api/actions/**/params_registry.rb', __FILE__) ].each   { |f| require f }
 Dir[ File.expand_path('../api/actions/**/*.rb', __FILE__) ].each   { |f| require f }
 Dir[ File.expand_path('../api/namespace/**/*.rb', __FILE__) ].each { |f| require f }
 

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

@@ -48,15 +48,18 @@ module Elasticsearch
       # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html
       #
       def benchmark(arguments={})
-        valid_params = [
-          :verbose ]
         method = HTTP_PUT
         path   = "_bench"
-        params = Utils.__validate_and_extract_params arguments, valid_params
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
         body   = arguments[:body]
 
         perform_request(method, path, params, body).body
       end
+
+      # Register this action with its valid params when the module is loaded.
+      #
+      # @since 6.2.0
+      ParamsRegistry.register(:benchmark, [ :verbose ].freeze)
     end
   end
 end

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

@@ -8,6 +8,8 @@ module Elasticsearch
       # 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: [
@@ -47,7 +49,7 @@ module Elasticsearch
       #
       # @option arguments [String] :index Default index for items which don't provide one
       # @option arguments [String] :type Default document type for items which don't provide one
-      # @option arguments [Hash] :body The operation definition and data (action-data pairs), separated by newlines (*Required*)
+      # @option arguments [Hash] :body The operation definition and data (action-data pairs), separated by newlines (*Required*). Note that this cannot be empty.
       # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
       # @option arguments [String] :refresh If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)
       # @option arguments [String] :routing Specific routing value
@@ -68,22 +70,10 @@ module Elasticsearch
 
         type      = arguments.delete(:type)
 
-        valid_params = [
-          :wait_for_active_shards,
-          :refresh,
-          :routing,
-          :timeout,
-          :type,
-          :fields,
-          :_source,
-          :_source_exclude,
-          :_source_include,
-          :pipeline ]
-
         method = HTTP_POST
         path   = Utils.__pathify Utils.__escape(arguments[:index]), Utils.__escape(type), '_bulk'
 
-        params = Utils.__validate_and_extract_params arguments, valid_params
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
         body   = arguments[:body]
 
         if body.is_a? Array
@@ -94,6 +84,23 @@ module Elasticsearch
 
         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.2.0
+      ParamsRegistry.register(:bulk, [
+          :wait_for_active_shards,
+          :refresh,
+          :routing,
+          :timeout,
+          :type,
+          :fields,
+          :_source,
+          :_source_exclude,
+          :_source_excludes,
+          :_source_include,
+          :_source_includes,
+          :pipeline ].freeze)
     end
   end
 end

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

@@ -46,27 +46,25 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-aliases.html
         #
         def aliases(arguments={})
-          valid_params = [
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :v,
-            :s ]
-
           name = arguments.delete(:name)
-
           method = HTTP_GET
-
           path   = Utils.__pathify '_cat/aliases', Utils.__listify(name)
-
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
-
           body   = nil
-
           perform_request(method, path, params, body).body
         end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:aliases, [
+            :local,
+            :master_timeout,
+            :h,
+            :help,
+            :v,
+            :s ].freeze)
       end
     end
   end

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

@@ -43,28 +43,26 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-allocation.html
         #
         def allocation(arguments={})
-          valid_params = [
-            :bytes,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :v,
-            :s ]
-
           node_id = arguments.delete(:node_id)
-
           method = HTTP_GET
-
           path   = Utils.__pathify '_cat/allocation', Utils.__listify(node_id)
-
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
-
           body   = nil
-
           perform_request(method, path, params, body).body
         end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:allocation, [
+            :bytes,
+            :local,
+            :master_timeout,
+            :h,
+            :help,
+            :v,
+            :s ].freeze)
       end
     end
   end

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

@@ -38,27 +38,30 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-count.html
         #
         def count(arguments={})
-          valid_params = [
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :v,
-            :s ]
-
           index = arguments.delete(:index)
 
           method = HTTP_GET
 
           path   = Utils.__pathify '_cat/count', Utils.__listify(index)
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
 
           body   = nil
 
           perform_request(method, path, params, body).body
         end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:count, [
+            :local,
+            :master_timeout,
+            :h,
+            :help,
+            :v,
+            :s ].freeze)
       end
     end
   end

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

@@ -26,25 +26,28 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-fielddata.html
         #
         def fielddata(arguments={})
-          valid_params = [
-            :bytes,
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :v,
-            :s,
-            :fields ]
-
           fields = arguments.delete(:fields)
 
           method = HTTP_GET
           path   = Utils.__pathify "_cat/fielddata", Utils.__listify(fields)
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           body   = nil
 
           perform_request(method, path, params, body).body
         end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:fielddata, [
+            :bytes,
+            :local,
+            :master_timeout,
+            :h,
+            :help,
+            :v,
+            :s,
+            :fields ].freeze)
       end
     end
   end

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

@@ -30,23 +30,26 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-health.html
         #
         def health(arguments={})
-          valid_params = [
-            :local,
-            :master_timeout,
-            :h,
-            :help,
-            :ts,
-            :v,
-            :s ]
-
           method = HTTP_GET
           path   = "_cat/health"
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
           body   = nil
 
           perform_request(method, path, params, body).body
         end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:health, [
+            :local,
+            :master_timeout,
+            :h,
+            :help,
+            :ts,
+            :v,
+            :s ].freeze)
       end
     end
   end

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

@@ -10,15 +10,19 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html
         #
         def help(arguments={})
-          valid_params = [
-            :help ]
           method = HTTP_GET
           path   = "_cat"
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           body   = nil
 
           perform_request(method, path, params, body).body
         end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:help, [
+            :help ].freeze)
       end
     end
   end

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

@@ -52,30 +52,32 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-indices.html
         #
         def indices(arguments={})
-          valid_params = [
-            :bytes,
-            :h,
-            :health,
-            :help,
-            :local,
-            :master_timeout,
-            :pri,
-            :v,
-            :s ]
-
           index = arguments.delete(:index)
-
           method = HTTP_GET
 
           path   = Utils.__pathify '_cat/indices', Utils.__listify(index)
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
           params[:h] = Utils.__listify(params[:h]) if params[:h]
 
           body   = nil
 
           perform_request(method, path, params, body).body
         end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:indices, [
+            :bytes,
+            :h,
+            :health,
+            :help,
+            :local,
+            :master_timeout,
+            :pri,
+            :v,
+            :s ].freeze)
       end
     end
   end