elasticsearch-api 6.1.0 → 6.2.0

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

@@ -20,13 +20,11 @@ module Elasticsearch
       #
       def msearch_template(arguments={})
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-
-        valid_params = [ :search_type ]
         method = HTTP_GET
         path   = Utils.__pathify Utils.__listify(arguments[:index]),
                                  Utils.__listify(arguments[:type]),
                                  '_msearch/template'
-        params = Utils.__validate_and_extract_params arguments, valid_params
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
         body   = arguments[:body]
 
         case
@@ -40,6 +38,11 @@ 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(:msearch_template, [ :search_type ].freeze)
     end
   end
 end

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

@@ -35,19 +35,6 @@ module Elasticsearch
       # @see #termvector
       #
       def mtermvectors(arguments={})
-        valid_params = [
-          :ids,
-          :term_statistics,
-          :field_statistics,
-          :fields,
-          :offsets,
-          :positions,
-          :payloads,
-          :preference,
-          :realtime,
-          :routing,
-          :parent ]
-
         ids = arguments.delete(:ids)
 
         method = HTTP_GET
@@ -55,7 +42,7 @@ module Elasticsearch
                                  Utils.__escape(arguments[:type]),
                                  '_mtermvectors'
 
-        params = Utils.__validate_and_extract_params arguments, valid_params
+        params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
         if ids
           body = { :ids => ids }
@@ -65,6 +52,22 @@ module Elasticsearch
 
         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(:mtermvectors, [
+          :ids,
+          :term_statistics,
+          :field_statistics,
+          :fields,
+          :offsets,
+          :positions,
+          :payloads,
+          :preference,
+          :realtime,
+          :routing,
+          :parent ].freeze)
     end
   end
 end

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

@@ -27,21 +27,24 @@ module Elasticsearch
         # @see http://www.elasticsearch.org/guide/reference/api/admin-cluster-nodes-hot-threads/
         #
         def hot_threads(arguments={})
-          valid_params = [
-            :interval,
-            :snapshots,
-            :threads,
-            :type,
-            :timeout ]
-
           method = HTTP_GET
           path   = Utils.__pathify '_nodes', Utils.__listify(arguments[:node_id]), 'hot_threads'
 
-          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(:hot_threads, [
+            :interval,
+            :snapshots,
+            :threads,
+            :type,
+            :timeout ].freeze)
       end
     end
   end

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

@@ -43,37 +43,41 @@ module Elasticsearch
         def info(arguments={})
           arguments = arguments.clone
           metric    = arguments.delete(:metric)
-
-          valid_parts = [
-            :_all,
-            :http,
-            :jvm,
-            :network,
-            :os,
-            :plugins,
-            :process,
-            :settings,
-            :thread_pool,
-            :transport,
-            :timeout ]
-
-          valid_params = [ :flat_settings, :timeout ]
-
           method = HTTP_GET
-
           if metric
             parts = metric
           else
-            parts = Utils.__extract_parts arguments, valid_parts
+            parts = Utils.__extract_parts arguments, ParamsRegistry.get(:info_parts)
           end
 
           path   = Utils.__pathify '_nodes', Utils.__listify(arguments[:node_id]), Utils.__listify(parts)
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(:info_params)
           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(:info_params, [ :flat_settings, :timeout ].freeze)
+
+        # Register this action with its valid parts when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:info_parts, [
+            :_all,
+            :http,
+            :jvm,
+            :network,
+            :os,
+            :plugins,
+            :process,
+            :settings,
+            :thread_pool,
+            :transport,
+            :timeout ].freeze)
       end
     end
   end

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

@@ -0,0 +1,44 @@
+module Elasticsearch
+  module API
+    module Nodes
+      module Actions
+        module ParamsRegistry
+
+          extend self
+
+          # A Mapping of all the actions to their list of valid params.
+          #
+          # @since 6.2.0
+          PARAMS = {}
+
+          # Register an action with its list of valid params.
+          #
+          # @example Register the action.
+          #   ParamsRegistry.register(:benchmark, [ :verbose ])
+          #
+          # @param [ Symbol ] action The action to register.
+          # @param [ Array[Symbol] ] valid_params The list of valid params.
+          #
+          # @since 6.2.0
+          def register(action, valid_params)
+            PARAMS[action.to_sym] = valid_params
+          end
+
+          # Get the list of valid params for a given action.
+          #
+          # @example Get the list of valid params.
+          #   ParamsRegistry.get(:benchmark)
+          #
+          # @param [ Symbol ] action The action.
+          #
+          # @return [ Array<Symbol> ] The list of valid params for the action.
+          #
+          # @since 6.2.0
+          def get(action)
+            PARAMS.fetch(action, [])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module Elasticsearch
+  module API
+    module Nodes
+      module Actions
+
+        # Re-read the local node's encrypted keystore. Specifically, it will prompt the keystore
+        # decryption and reading across the cluster.
+        #
+        # @example Reload secure settings for all nodes
+        #
+        #     client.nodes.reload_secure_settings
+        #
+        # @example Reload secure settings for a list of nodes
+        #
+        #     client.nodes.reload_secure_settings(node_id: 'foo,bar')
+        #
+        # @option arguments [ Array ] :node_id A comma-separated list of node IDs or names to perform the operation on
+        # @option arguments [ String ] :timeout Explicit operation timeout
+        #
+        # @see http://elasticsearch.org/guide/reference/api/cluster-nodes-reload-secure-settings
+        #
+        def reload_secure_settings(arguments={})
+          valid_params = [
+              :timeout ]
+
+          method = HTTP_POST
+          path   = Utils.__pathify '_nodes', Utils.__listify(arguments[:node_id]), 'reload_secure_settings'
+
+          params = Utils.__validate_and_extract_params arguments, valid_params
+          body   = nil
+
+          perform_request(method, path, params, body).body
+        end
+      end
+    end
+  end
+end

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

@@ -18,18 +18,21 @@ module Elasticsearch
         # @see http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-shutdown/
         #
         def shutdown(arguments={})
-          valid_params = [
-            :delay,
-            :exit ]
-
           method = HTTP_POST
           path   = Utils.__pathify '_cluster/nodes', Utils.__listify(arguments[:node_id]), '_shutdown'
 
-          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(:shutdown, [
+            :delay,
+            :exit ].freeze)
       end
     end
   end

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

@@ -44,21 +44,6 @@ module Elasticsearch
         #
         def stats(arguments={})
           arguments = arguments.clone
-
-          valid_params = [
-            :metric,
-            :index_metric,
-            :node_id,
-            :completion_fields,
-            :fielddata_fields,
-            :fields,
-            :include_segment_file_sizes,
-            :groups,
-            :human,
-            :level,
-            :types,
-            :timeout ]
-
           node_id = arguments.delete(:node_id)
 
           path   = Utils.__pathify '_nodes',
@@ -67,7 +52,7 @@ module Elasticsearch
                                    Utils.__listify(arguments.delete(:metric)),
                                    Utils.__listify(arguments.delete(:index_metric))
 
-          params = Utils.__validate_and_extract_params arguments, valid_params
+          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
           [:completion_fields, :fielddata_fields, :fields, :groups, :types].each do |key|
             params[key] = Utils.__listify(params[key]) if params[key]
@@ -77,6 +62,23 @@ module Elasticsearch
 
           perform_request(HTTP_GET, path, params, body).body
         end
+
+        # Register this action with its valid params when the module is loaded.
+        #
+        # @since 6.2.0
+        ParamsRegistry.register(:stats, [
+            :metric,
+            :index_metric,
+            :node_id,
+            :completion_fields,
+            :fielddata_fields,
+            :fields,
+            :include_segment_file_sizes,
+            :groups,
+            :human,
+            :level,
+            :types,
+            :timeout ].freeze)
       end
     end
   end

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

@@ -0,0 +1,42 @@
+module Elasticsearch
+  module API
+    module Actions
+      module ParamsRegistry
+
+        extend self
+
+        # A Mapping of all the actions to their list of valid params.
+        #
+        # @since 6.2.0
+        PARAMS = {}
+
+        # Register an action with its list of valid params.
+        #
+        # @example Register the action.
+        #   ParamsRegistry.register(:benchmark, [ :verbose ])
+        #
+        # @param [ Symbol ] action The action to register.
+        # @param [ Array[Symbol] ] valid_params The list of valid params.
+        #
+        # @since 6.2.0
+        def register(action, valid_params)
+          PARAMS[action.to_sym] = valid_params
+        end
+
+        # Get the list of valid params for a given action.
+        #
+        # @example Get the list of valid params.
+        #   ParamsRegistry.get(:benchmark)
+        #
+        # @param [ Symbol ] action The action.
+        #
+        # @return [ Array<Symbol> ] The list of valid params for the action.
+        #
+        # @since 6.2.0
+        def get(action)
+          PARAMS.fetch(action, [])
+        end
+      end
+    end
+  end
+end

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

@@ -42,30 +42,32 @@ module Elasticsearch
 
         raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
         raise ArgumentError, "Required argument 'type' missing"  unless arguments[:type]
-
-        valid_params = [
-          :routing,
-          :preference,
-          :ignore_unavailable,
-          :allow_no_indices,
-          :expand_wildcards,
-          :percolate_index,
-          :percolate_type,
-          :percolate_format,
-          :version,
-          :version_type ]
-
         method = HTTP_GET
         path   = Utils.__pathify Utils.__escape(arguments[:index]),
                                  Utils.__escape(arguments[:type]),
                                  Utils.__escape(arguments[:id]),
                                  '_percolate'
 
-        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(:percolate, [
+          :routing,
+          :preference,
+          :ignore_unavailable,
+          :allow_no_indices,
+          :expand_wildcards,
+          :percolate_index,
+          :percolate_type,
+          :percolate_format,
+          :version,
+          :version_type ].freeze)
     end
   end
 end

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

@@ -19,7 +19,7 @@ module Elasticsearch
       #     }
       #
       # @option arguments [String] :id Script ID (*Required*)
-      # @option arguments [String] :lang Script language (*Required*)
+      # @option arguments [String] :lang Script language
       # @option arguments [Hash]   :body A JSON document containing the script (*Required*)
       # @option arguments [Number] :version Explicit version number for concurrency control
       # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
@@ -29,23 +29,24 @@ module Elasticsearch
       #
       def put_script(arguments={})
         raise ArgumentError, "Required argument 'id' missing"   unless arguments[:id]
-        raise ArgumentError, "Required argument 'lang' missing" unless arguments[:lang]
         raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
-
-        valid_params = [
-          :op_type,
-          :version,
-          :version_type ]
-
         method = HTTP_PUT
-        path   = "_scripts/#{arguments.delete(:lang)}/#{arguments[:id]}"
+        path   = "_scripts/#{arguments.has_key?(:lang) ? "#{arguments.delete(:lang)}/" : ''}#{arguments[:id]}"
 
-        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(:put_script, [
+          :op_type,
+          :version,
+          :version_type ].freeze)
     end
   end
 end