elastomer-client 3.0.1 → 3.1.0

data/lib/elastomer/client/rest_api_spec/rest_api.rb

@@ -0,0 +1,59 @@
+require "forwardable"
+
+module Elastomer::Client::RestApiSpec
+  class RestApi
+    extend Forwardable
+
+    attr_reader :documentation
+    attr_reader :methods
+    attr_reader :url
+    attr_reader :body
+
+    def_delegators :@url,
+        :select_parts, :select_params, :valid_part?, :valid_param?
+
+    def initialize(documentation:, methods:, url:, body: nil)
+      @documentation = documentation
+      @methods = Array(methods)
+      @url = Url.new(url)
+      @body = body
+    end
+
+    def body?
+      !body.nil?
+    end
+
+    class Url
+      attr_reader :path
+      attr_reader :paths
+      attr_reader :parts
+      attr_reader :params
+
+      def initialize(path:, paths: [], parts: {}, params: {})
+        @path = path
+        @paths = Array(paths)
+        @parts = parts
+        @params = params
+
+        @parts_set  = Set.new(@parts.keys)
+        @params_set = Set.new(@params.keys)
+      end
+
+      def select_parts(from:)
+        from.select {|k,v| valid_part?(k)}
+      end
+
+      def valid_part?(part)
+        @parts_set.include?(part.to_s)
+      end
+
+      def select_params(from:)
+        from.select {|k,v| valid_param?(k)}
+      end
+
+      def valid_param?(param)
+        @params_set.include?(param.to_s)
+      end
+    end
+  end
+end

data/lib/elastomer/client/rest_api_spec.rb

@@ -0,0 +1,44 @@
+
+module Elastomer
+  class Client
+
+    # Provides access to the versioned REST API specs for Elasticsearch.
+    module RestApiSpec
+
+      # Returns an ApiSpec instance for the given Elasticsearcion version. This
+      # method will load the ApiSpec version class if it has not already been
+      # defined. This prevents bloat by only loading the version specs that are
+      # needed.
+      #
+      # Because of this lazy loading, this method is _not_ thread safe.
+      #
+      # version - the Elasticsearch version String
+      #
+      # Returns the requested ApiSpec version if available
+      def self.api_spec(version)
+        classname = "ApiSpecV#{to_class_version(version)}"
+        load_api_spec(version) if !self.const_defined? classname
+        self.const_get(classname).new
+      end
+
+      # Internal: Load the specific ApiSpec version class for the given version.
+      def self.load_api_spec(version)
+        path = File.expand_path("../rest_api_spec/api_spec_v#{to_class_version(version)}.rb", __FILE__)
+        if File.exist? path
+          load path
+        else
+          raise RuntimeError, "Unsupported REST API spec version: #{version}"
+        end
+      end
+
+      # Internal: Convert a dotted version String into an underscore format
+      # suitable for use in Ruby class names.
+      def self.to_class_version(version)
+        version.to_s.split(".").slice(0,2).join("_")
+      end
+    end
+  end
+end
+
+require_relative "rest_api_spec/api_spec"
+require_relative "rest_api_spec/rest_api"

data/lib/elastomer/client/scroller.rb

@@ -12,7 +12,7 @@ module Elastomer
     #
     # Examples
     #
-    #   scroll = client.scroll('{"query":{"match_all":{}}}', :index => 'test')
+    #   scroll = client.scroll('{"query":{"match_all":{}}}', index: 'test')
     #   scroll.each_document do |document|
     #     document['_id']
     #     document['_source']
@@ -35,7 +35,7 @@ module Elastomer
     #
     # Examples
     #
-    #   scan = client.scan('{"query":{"match_all":{}}}', :index => 'test')
+    #   scan = client.scan('{"query":{"match_all":{}}}', index: 'test')
     #   scan.each_document do |document|
     #     document['_id']
     #     document['_source']
@@ -59,7 +59,7 @@ module Elastomer
     #
     # Examples
     #
-    #   h = client.start_scroll(:body => '{"query":{"match_all":{}},"sort":{"created":"desc"}}', :index => 'test')
+    #   h = client.start_scroll(body: '{"query":{"match_all":{}},"sort":{"created":"desc"}}', index: 'test')
     #   scroll_id = h['_scroll_id']
     #   h['hits']['hits'].each { |doc| ... }
     #
@@ -71,7 +71,7 @@ module Elastomer
     #
     # Returns the response body as a Hash.
     def start_scroll( opts = {} )
-      opts = opts.merge :action => "search.start_scroll"
+      opts = opts.merge action: "search.start_scroll", rest_api: "search"
       response = get "{/index}{/type}/_search", opts
       response.body
     end
@@ -84,7 +84,7 @@ module Elastomer
     #
     # Examples
     #
-    #   scroll_id = client.start_scroll(:body => '{"query":{"match_all":{}}}', :index => 'test')['_scroll_id']
+    #   scroll_id = client.start_scroll(body: '{"query":{"match_all":{}}}', index: 'test')['_scroll_id']
     #
     #   h = client.continue_scroll scroll_id   # scroll to get the next set of results
     #   scroll_id = h['_scroll_id']            # and store the scroll_id to use later
@@ -96,7 +96,7 @@ module Elastomer
     #
     # Returns the response body as a Hash.
     def continue_scroll( scroll_id, scroll = "5m" )
-      response = get "/_search/scroll", :body => {:scroll_id => scroll_id}, :scroll => scroll, :action => "search.scroll"
+      response = get "/_search/scroll", body: {scroll_id: scroll_id}, scroll: scroll, action: "search.scroll", rest_api: "scroll"
       response.body
     rescue RequestError => err
       if err.error && err.error["caused_by"]["type"] == "search_context_missing_exception"
@@ -113,7 +113,7 @@ module Elastomer
     #
     # Returns the response body as a Hash.
     def clear_scroll( scroll_ids )
-      response = delete "/_search/scroll", :body => {scroll_id: Array(scroll_ids)}, :action => "search.clear_scroll"
+      response = delete "/_search/scroll", body: {scroll_id: Array(scroll_ids)}, action: "search.clear_scroll", rest_api: "clear_scroll"
       response.body
     end
 
@@ -132,7 +132,7 @@ module Elastomer
          raise ArgumentError, "Query cannot contain a sort (found sort '#{query[:sort]}' in query: #{query})"
       end
 
-      query.merge(:sort => [:_doc])
+      query.merge(sort: [:_doc])
     end
 
     DEFAULT_OPTS = {
@@ -161,7 +161,7 @@ module Elastomer
       #
       # Examples
       #
-      #   scan = Scroller.new(client, {:query => {:match_all => {}}}, :index => 'test-1')
+      #   scan = Scroller.new(client, {query: {match_all: {}}}, index: 'test-1')
       #   scan.each_document { |doc|
       #     doc['_id']
       #     doc['_source']
@@ -170,7 +170,7 @@ module Elastomer
       def initialize( client, query, opts = {} )
         @client = client
 
-        @opts = DEFAULT_OPTS.merge({ :body => query }).merge(opts)
+        @opts = DEFAULT_OPTS.merge({ body: query }).merge(opts)
 
         @scroll_id = nil
         @offset = 0

data/lib/elastomer/client/snapshot.rb

@@ -35,7 +35,7 @@ module Elastomer
       #
       # Returns true if the snapshot exists
       def exists?(params = {})
-        response = client.get "/_snapshot/{repository}/{snapshot}", update_params(params, :action => "snapshot.exists")
+        response = client.get "/_snapshot/{repository}/{snapshot}", update_params(params, action: "snapshot.exists", rest_api: "snapshot.get")
         response.success?
       rescue Elastomer::Client::Error => err
         if err.error && err.error.dig("root_cause", 0, "type") == "snapshot_missing_exception"
@@ -54,7 +54,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def create(body = {}, params = {})
-        response = client.put "/_snapshot/{repository}/{snapshot}", update_params(params, :body => body, :action => "snapshot.create")
+        response = client.put "/_snapshot/{repository}/{snapshot}", update_params(params, body: body, action: "snapshot.create", rest_api: "snapshot.create")
         response.body
       end
 
@@ -67,7 +67,7 @@ module Elastomer
       def get(params = {})
         # Set snapshot name or we'll get the repository instead
         snapshot = name || "_all"
-        response = client.get "/_snapshot/{repository}/{snapshot}", update_params(params, :snapshot => snapshot, :action => "snapshot.get")
+        response = client.get "/_snapshot/{repository}/{snapshot}", update_params(params, snapshot: snapshot, action: "snapshot.get", rest_api: "snapshot.get")
         response.body
       end
 
@@ -78,7 +78,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def status(params = {})
-        response = client.get "/_snapshot{/repository}{/snapshot}/_status", update_params(params, :action => "snapshot.status")
+        response = client.get "/_snapshot{/repository}{/snapshot}/_status", update_params(params, action: "snapshot.status", rest_api: "snapshot.status")
         response.body
       end
 
@@ -90,7 +90,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def restore(body = {}, params = {})
-        response = client.post "/_snapshot/{repository}/{snapshot}/_restore", update_params(params, :body => body, :action => "snapshot.restore")
+        response = client.post "/_snapshot/{repository}/{snapshot}/_restore", update_params(params, body: body, action: "snapshot.restore", rest_api: "snapshot.restore")
         response.body
       end
 
@@ -101,7 +101,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def delete(params = {})
-        response = client.delete "/_snapshot/{repository}/{snapshot}", update_params(params, :action => "snapshot.delete")
+        response = client.delete "/_snapshot/{repository}/{snapshot}", update_params(params, action: "snapshot.delete", rest_api: "snapshot.delete")
         response.body
       end
 
@@ -120,7 +120,7 @@ module Elastomer
 
       # Internal: Returns a Hash containing default parameters.
       def defaults
-        { :repository => repository, :snapshot => name }
+        { repository: repository, snapshot: name }
       end
     end
   end

data/lib/elastomer/client/tasks.rb

@@ -12,18 +12,6 @@ module Elastomer
 
     class Tasks
 
-      # TODO - validate params from this whitelist
-      PARAMETERS = %i[
-        nodes
-        actions
-        parent_task_id
-        wait_for_completion
-        pretty
-        detailed
-        timeout
-        group_by
-      ].to_set.freeze
-
       # Create a new Tasks for introspecting on internal cluster activity.
       # More context: https://www.elastic.co/guide/en/elasticsearch/reference/5.6/tasks.html
       #
@@ -38,21 +26,21 @@ module Elastomer
 
       # Fetch results from the generic _tasks endpoint.
       #
-      # params       - Hash of request parameters, including:
+      # params - Hash of request parameters, including:
       #
       # Examples
       #
       #   tasks.get
-      #   tasks.get :nodes => "DmteLdw1QmSgW3GZmjmoKA,DmteLdw1QmSgW3GZmjmoKB", :actions => "cluster:*", :detailed => true
+      #   tasks.get nodes: "DmteLdw1QmSgW3GZmjmoKA,DmteLdw1QmSgW3GZmjmoKB", actions: "cluster:*", detailed: true
       #
       # Examples (ES 5+ only)
       #
-      #   tasks.get :group_by => "parents"
-      #   tasks.get :group_by => "parents", :actions => "*reindex", ...
+      #   tasks.get group_by: "parents"
+      #   tasks.get group_by: "parents", actions: "*reindex", ...
       #
       # Returns the response body as a Hash
       def get(params = {})
-        response = client.get "/_tasks", params
+        response = client.get "/_tasks", params.merge(action: "tasks.list", rest_api: "tasks.list")
         response.body
       end
 
@@ -61,22 +49,24 @@ module Elastomer
       # where "node_id" is a value from the "nodes" hash returned from the /_tasks endpoint, and "task_id" is
       # from the "tasks" child hash of any of the "nodes" entries of the /_tasks endpoint
       #
-      # node_id         - the name of the ES cluster node hosting the target task
-      # task_id         - the numerical ID of the task to return data about in the response
-      # params          - Hash of request parameters to include
+      # node_id - the name of the ES cluster node hosting the target task
+      # task_id - the numerical ID of the task to return data about in the response
+      # params  - Hash of request parameters to include
       #
       # Examples
       #
       #  tasks.get_by_id "DmteLdw1QmSgW3GZmjmoKA", 123
-      #  tasks.get_by_id "DmteLdw1QmSgW3GZmjmoKA", 456, :pretty => true
+      #  tasks.get_by_id "DmteLdw1QmSgW3GZmjmoKA", 456, pretty: true
       #
       # Returns the response body as a Hash
       def get_by_id(node_id, task_id, params = {})
         raise ArgumentError, "invalid node ID provided: #{node_id.inspect}" if node_id.to_s.empty?
         raise ArgumentError, "invalid task ID provided: #{task_id.inspect}" unless task_id.is_a?(Integer)
 
+        rest_api = client.version_support.supports_tasks_get? ? "tasks.get" : "tasks.list"
+
         # in this API, the task ID is included in the path, not as a request parameter.
-        response = client.get "/_tasks/#{node_id}:#{task_id}", params
+        response = client.get "/_tasks/{task_id}", params.merge(task_id: "#{node_id}:#{task_id}", action: "tasks.get", rest_api: rest_api)
         response.body
       end
 
@@ -85,9 +75,9 @@ module Elastomer
       # is not the correct syntax for the parent_task_id param value. The correct
       # value syntax is "<parent_node_id>:<parent_task_id>"
       #
-      # parent_node_id  - ID of the node the parent task is hosted by
-      # parent_task_id  - ID of a parent task who's child tasks' data will be returned in the response
-      # params          - Hash of request parameters to include
+      # parent_node_id - ID of the node the parent task is hosted by
+      # parent_task_id - ID of a parent task who's child tasks' data will be returned in the response
+      # params         - Hash of request parameters to include
       #
       # Examples
       #
@@ -99,50 +89,55 @@ module Elastomer
         raise ArgumentError, "invalid parent node ID provided: #{parent_node_id.inspect}" if node_id.to_s.empty?
         raise ArgumentError, "invalid parent task ID provided: #{parent_task_id.inspect}" unless parent_task_id.is_a?(Integer)
 
-        # in this API, we pass the parent task ID as a formatted parameter in a request to the _tasks endpoint
-        formatted_parent = { :parent_task_id => "#{parent_node_id}:#{parent_task_id}" }
-        response = client.get "/_tasks", params.merge(formatted_parent)
+        parent_task_id = "#{parent_node_id}:#{parent_task_id}"
+        params = params.merge(action: "tasks.parent", rest_api: "tasks.list")
+
+        if client.version_support.supports_parent_task_id?
+          params[:parent_task_id] = parent_task_id
+        else
+          params[:parent_task] = parent_task_id
+        end
+
+        response = client.get "/_tasks", params
         response.body
       end
 
       # Wait for the specified amount of time (10 seconds by default) for some task(s) to complete.
       # Filters for task(s) to wait upon using same filter params as Tasks#get(params)
       #
-      # timeout         - maximum time to wait for target task to complete before returning, example: "5s"
-      # params          - Hash of request params to include (mostly task filters in this context)
+      # timeout - maximum time to wait for target task to complete before returning, example: "5s"
+      # params  - Hash of request params to include (mostly task filters in this context)
       #
       # Examples
       #
-      # tasks.wait_for "5s", :actions => "*health"
-      # tasks.wait_for("30s", :actions => "*reindex", :nodes => "DmteLdw1QmSgW3GZmjmoKA,DmteLdw1QmSgW3GZmjmoKB")
+      # tasks.wait_for "5s", actions: "*health"
+      # tasks.wait_for("30s", actions: "*reindex", nodes: "DmteLdw1QmSgW3GZmjmoKA,DmteLdw1QmSgW3GZmjmoKB")
       #
       # Returns the response body as a Hash when timeout expires or target tasks complete
       # COMPATIBILITY WARNING: the response body differs between ES versions for this API
       def wait_for(timeout = "10s", params = {}) 
-        params_with_wait = params.merge({ :wait_for_completion => true, :timeout => timeout })
-        self.get(params_with_wait)
+        self.get params.merge(wait_for_completion: true, timeout: timeout)
       end
 
       # Wait for the specified amount of time (10 seconds by default) for some task(s) to complete.
       # Filters for task(s) to wait upon using same IDs and filter params as Tasks#get_by_id(params)
       #
-      # node_id                 - the ID of the node on which the target task is hosted
-      # task_id                 - the ID of the task to wait on
-      # timeout                 - time for call to await target tasks completion before returning
-      # params                  - Hash of request params to include (mostly task filters in this context)
+      # node_id - the ID of the node on which the target task is hosted
+      # task_id - the ID of the task to wait on
+      # timeout - time for call to await target tasks completion before returning
+      # params  - Hash of request params to include (mostly task filters in this context)
       #
       # Examples
       #
       # tasks.wait_by_id "DmteLdw1QmSgW3GZmjmoKA", 123, "15s"
-      # tasks.wait_by_id "DmteLdw1QmSgW3GZmjmoKA", 456, "30s", :actions => "*search"
+      # tasks.wait_by_id "DmteLdw1QmSgW3GZmjmoKA", 456, "30s", actions: "*search"
       #
       # Returns the response body as a Hash when timeout expires or target tasks complete
       def wait_by_id(node_id, task_id, timeout = "10s", params = {})
         raise ArgumentError, "invalid node ID provided: #{node_id.inspect}" if node_id.to_s.empty?
         raise ArgumentError, "invalid task ID provided: #{task_id.inspect}" unless task_id.is_a?(Integer)
 
-        params_with_wait = params.merge({ :wait_for_completion => true, :timeout => timeout })
-        self.get_by_id(node_id, task_id, params_with_wait)
+        self.get_by_id(node_id, task_id, params.merge(wait_for_completion: true, timeout: timeout))
       end
 
       # Cancels a task running on a particular node.
@@ -157,32 +152,31 @@ module Elastomer
       # Examples
       #
       #   tasks.cancel_by_id "DmteLdw1QmSgW3GZmjmoKA", 123
-      #   tasks.cancel_by_id "DmteLdw1QmSgW3GZmjmoKA", 456, :pretty => true
+      #   tasks.cancel_by_id "DmteLdw1QmSgW3GZmjmoKA", 456, pretty: true
       #
       # Returns the response body as a Hash
       def cancel_by_id(node_id, task_id, params = {})
         raise ArgumentError, "invalid node ID provided: #{node_id.inspect}" if node_id.to_s.empty?
         raise ArgumentError, "invalid task ID provided: #{task_id.inspect}" unless task_id.is_a?(Integer)
 
-        response = client.post "/_tasks/#{node_id}:#{task_id}/_cancel", params
-        response.body
+        self.cancel(params.merge(task_id: "#{node_id}:#{task_id}"))
       end
 
       # Cancels a task or group of tasks using various filtering parameters.
       #
-      # params          - Hash of request parameters to include
+      # params - Hash of request parameters to include
       #
       # Examples
       #
-      #   tasks.cancel :actions => "*reindex"
-      #   tasks.cancel :actions => "*search", :nodes => "DmteLdw1QmSgW3GZmjmoKA,DmteLdw1QmSgW3GZmjmoKB,DmteLdw1QmSgW3GZmjmoKC"
+      #   tasks.cancel actions: "*reindex"
+      #   tasks.cancel actions: "*search", nodes: "DmteLdw1QmSgW3GZmjmoKA,DmteLdw1QmSgW3GZmjmoKB,DmteLdw1QmSgW3GZmjmoKC"
       #
       # Returns the response body as a Hash
       def cancel(params = {})
-        response = client.post "/_tasks/_cancel", params
+        response = client.post "/_tasks{/task_id}/_cancel", params.merge(action: "tasks.cancel", rest_api: "tasks.cancel")
         response.body
       end
 
-    end # end class Tasks
-  end # end class Client
-end # end module Elastomer
+    end
+  end
+end

data/lib/elastomer/client/template.rb

@@ -25,7 +25,7 @@ module Elastomer
 
       # Returns true if the template already exists on the cluster.
       def exists?( params = {} )
-        response = client.head "/_template/{template}", update_params(params, action: "template.exists")
+        response = client.head "/_template/{template}", update_params(params, action: "template.exists", rest_api: "indices.exists_template")
         response.success?
       end
       alias_method :exist?, :exists?
@@ -37,7 +37,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def get( params = {} )
-        response = client.get "/_template/{template}", update_params(params, :action => "template.get")
+        response = client.get "/_template/{template}", update_params(params, action: "template.get", rest_api: "indices.get_template")
         response.body
       end
 
@@ -49,7 +49,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def create( template, params = {} )
-        response = client.put "/_template/{template}", update_params(params, :body => template, :action => "template.create")
+        response = client.put "/_template/{template}", update_params(params, body: template, action: "template.create", rest_api: "indices.put_template")
         response.body
       end
 
@@ -60,7 +60,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def delete( params = {} )
-        response = client.delete "/_template/{template}", update_params(params, :action => "template.delete")
+        response = client.delete "/_template/{template}", update_params(params, action: "template.delete", rest_api: "indices.delete_template")
         response.body
       end
 
@@ -79,8 +79,8 @@ module Elastomer
 
       # Internal: Returns a Hash containing default parameters.
       def defaults
-        { :template => name }
+        { template: name }
       end
-    end  # Template
-  end  # Client
-end  # Elastomer
+    end
+  end
+end

data/lib/elastomer/client/warmer.rb

@@ -34,7 +34,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def create(query, params = {})
-        response = client.put "/{index}{/type}/_warmer/{warmer}", defaults.update(params.update(:body => query))
+        response = client.put "/{index}{/type}/_warmer/{warmer}", update_params(params, body: query, action: "warmer.create", rest_api: "indices.put_warmer")
         response.body
       end
 
@@ -45,7 +45,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def delete(params = {})
-        response = client.delete "/{index}{/type}/_warmer/{warmer}", defaults.update(params)
+        response = client.delete "/{index}{/type}/_warmer/{warmer}", update_params(params, action: "warmer.delete", rest_api: "indices.delete_warmer")
         response.body
       end
 
@@ -56,7 +56,7 @@ module Elastomer
       #
       # Returns the response body as a Hash
       def get(params = {})
-        response = client.get "/{index}{/type}/_warmer/{warmer}", defaults.update(params)
+        response = client.get "/{index}{/type}/_warmer/{warmer}", update_params(params, action: "warmer.get", rest_api: "indices.get_warmer")
         response.body
       end
 
@@ -82,9 +82,16 @@ module Elastomer
       end
       alias_method :exist?, :exists?
 
+      # Internal:
+      def update_params(params, overrides = nil)
+        h = defaults.update params
+        h.update overrides unless overrides.nil?
+        h
+      end
+
       # Internal: Returns a Hash containing default parameters.
       def defaults
-        {:index => index_name, :warmer => name}
+        {index: index_name, warmer: name}
       end
     end
   end

data/lib/elastomer/client.rb

@@ -31,10 +31,12 @@ module Elastomer
     #   :max_request_size - the maximum allowed request size in bytes (defaults to 250 MB)
     #   :max_retries      - the maximum number of request retires (defaults to 0)
     #   :retry_delay      - delay in seconds between retries (defaults to 0.075)
+    #   :strict_params    - set to `true` to raise exceptions when invalid request params are used
     #
     def initialize(host: "localhost", port: 9200, url: nil,
                    read_timeout: 5, open_timeout: 2, max_retries: 0, retry_delay: 0.075,
-                   opaque_id: false, adapter: Faraday.default_adapter, max_request_size: MAX_REQUEST_SIZE)
+                   opaque_id: false, adapter: Faraday.default_adapter, max_request_size: MAX_REQUEST_SIZE,
+                   strict_params: false)
 
       @url = url || "http://#{host}:#{port}"
 
@@ -49,11 +51,14 @@ module Elastomer
       @adapter          = adapter
       @opaque_id        = opaque_id
       @max_request_size = max_request_size
+      @strict_params    = strict_params
     end
 
     attr_reader :host, :port, :url
     attr_reader :read_timeout, :open_timeout
     attr_reader :max_retries, :retry_delay, :max_request_size
+    attr_reader :strict_params
+    alias :strict_params? :strict_params
 
     # Returns a duplicate of this Client connection configured in the exact same
     # fashion.
@@ -69,7 +74,7 @@ module Elastomer
 
     # Returns true if the server is available; returns false otherwise.
     def ping
-      response = head "/", :action => "cluster.ping"
+      response = head "/", action: "cluster.ping"
       response.success?
     rescue StandardError
       false
@@ -78,7 +83,10 @@ module Elastomer
 
     # Returns the version String of the attached Elasticsearch instance.
     def version
-      @version ||= info["version"]["number"]
+      @version ||= begin
+        response = get "/"
+        response.body.dig("version", "number")
+      end
     end
 
     # Returns a Semantic::Version for the attached Elasticsearch instance.
@@ -89,10 +97,16 @@ module Elastomer
 
     # Returns the information Hash from the attached Elasticsearch instance.
     def info
-      response = get "/", :action => "cluster.info"
+      response = get "/", action: "cluster.info"
       response.body
     end
 
+    # Returns the ApiSpec for the specific version of Elasticsearch that this
+    # Client is connected to.
+    def api_spec
+      @api_spec ||= RestApiSpec.api_spec(version)
+    end
+
     # Internal: Provides access to the Faraday::Connection used by this client
     # for all requests to the server.
     #
@@ -102,7 +116,7 @@ module Elastomer
         conn.request(:encode_json)
         conn.response(:parse_json)
         conn.request(:opaque_id) if @opaque_id
-        conn.request(:limit_size, :max_request_size => max_request_size) if max_request_size
+        conn.request(:limit_size, max_request_size: max_request_size) if max_request_size
 
         if @adapter.is_a?(Array)
           conn.adapter(*@adapter)
@@ -307,10 +321,10 @@ module Elastomer
     #
     # Examples
     #
-    #   expand_path('/foo{/bar}', {:bar => 'hello', :q => 'what', :p => 2})
+    #   expand_path('/foo{/bar}', {bar: 'hello', q: 'what', p: 2})
     #   #=> '/foo/hello?q=what&p=2'
     #
-    #   expand_path('/foo{/bar}{/baz}', {:baz => 'no bar'}
+    #   expand_path('/foo{/bar}{/baz}', {baz: 'no bar'}
     #   #=> '/foo/no%20bar'
     #
     # Returns an Addressable::Uri
@@ -323,12 +337,22 @@ module Elastomer
       query_values.delete :context
       query_values.delete :retries
 
+      rest_api = query_values.delete :rest_api
+
       template.keys.map(&:to_sym).each do |key|
         value = query_values.delete key
         value = assert_param_presence(value, key) unless path =~ /{\/#{key}}/ && value.nil?
         expansions[key] = value
       end
 
+      if rest_api
+        query_values = if strict_params?
+          api_spec.validate_params!(api: rest_api, params: query_values)
+        else
+          api_spec.select_params(api: rest_api, from: query_values)
+        end
+      end
+
       uri = template.expand(expansions)
       uri.query_values = query_values unless query_values.empty?
       uri.to_s

data/lib/elastomer/version.rb

@@ -1,5 +1,5 @@
 module Elastomer
-  VERSION = "3.0.1"
+  VERSION = "3.1.0"
 
   def self.version
     VERSION