elastic-enterprise-search 7.10.0.beta.1 → 7.11.0

data/lib/elastic/app-search/api/search.rb

@@ -25,8 +25,8 @@ module Elastic
         #
         # @param engine_name [String]  (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option body - The request body
-        #
+        # @option arguments [Object] :body Search request parameters
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/search.html#search-single
         #
@@ -34,12 +34,14 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :post,
             "api/as/v1/engines/#{engine_name}/search/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

data/lib/elastic/app-search/api/search_settings.rb

@@ -21,12 +21,12 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Searchsettings - Retrive current search settings for the engine
+        # Searchsettings - Retrieve current search settings for the engine
         #
         # @param engine_name [String]  (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option body - The request body
-        #
+        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/search-settings.html#search-settings-show
         #
@@ -34,12 +34,14 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :get,
             "api/as/v1/engines/#{engine_name}/search_settings/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

data/lib/elastic/app-search/api/synonym_set.rb

@@ -25,9 +25,9 @@ module Elastic
         #
         # @param engine_name [String]  (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option synonym_set_id [String]  (*Required*)
-        # @option body - The request body
-        #
+        # @option arguments [String] :synonym_set_id  (*Required*)
+        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/synonyms.html#synonyms-list-one
         #
@@ -36,14 +36,15 @@ module Elastic
           raise ArgumentError, "Required parameter 'synonym_set_id' missing" unless arguments[:synonym_set_id]
 
           synonym_set_id = arguments[:synonym_set_id]
-
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :get,
             "api/as/v1/engines/#{engine_name}/synonyms/#{synonym_set_id}/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

data/lib/elastic/app-search/api/top_clicks_analytics.rb

@@ -25,12 +25,12 @@ module Elastic
         #
         # @param engine_name [String]  (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option query [String] Filter clicks over a search query
-        # @option current_page [String] The page to fetch. Defaults to 1
-        # @option page_size [String] The number of results per page
-        # @option filters [Array] Analytics filters
-        # @option body - The request body
-        #
+        # @option arguments [String] :query Filter clicks over a search query
+        # @option arguments [String] :current_page The page to fetch. Defaults to 1
+        # @option arguments [String] :page_size The number of results per page
+        # @option arguments [Array] :filters Analytics filters
+        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/clicks.html
         #
@@ -38,12 +38,14 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :get,
             "api/as/v1/engines/#{engine_name}/analytics/clicks/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

data/lib/elastic/app-search/api/top_queries_analytics.rb

@@ -25,11 +25,11 @@ module Elastic
         #
         # @param engine_name [String]  (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option current_page [String] The page to fetch. Defaults to 1
-        # @option page_size [String] The number of results per page
-        # @option filters [Array] Analytics filters
-        # @option body - The request body
-        #
+        # @option arguments [String] :current_page The page to fetch. Defaults to 1
+        # @option arguments [String] :page_size The number of results per page
+        # @option arguments [Array] :filters Analytics filters
+        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/queries.html#queries-top-queries
         #
@@ -37,12 +37,14 @@ module Elastic
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :get,
             "api/as/v1/engines/#{engine_name}/analytics/queries/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

data/lib/elastic/app-search/app_search.rb

@@ -17,6 +17,8 @@
 
 # frozen_string_literal: true
 
+require 'jwt'
+
 module Elastic
   module EnterpriseSearch
     # App Search client for Enterprise Search.
@@ -37,9 +39,8 @@ module Elastic
       class Client < Elastic::EnterpriseSearch::Client
         include Elastic::EnterpriseSearch::AppSearch::Actions
         include Elastic::EnterpriseSearch::AppSearch::Request
-        include Elastic::EnterpriseSearch::Utils
 
-        # Crete a new Elastic::EnterpriseSearch::AppSearch::Client client
+        # Create a new Elastic::EnterpriseSearch::AppSearch::Client client
         #
         # @param options [Hash] a hash of configuration options
         # @option options [String] :host_identifier A unique string that represents your account.
@@ -48,6 +49,22 @@ module Elastic
           super(options)
         end
 
+        SIGNED_KEY_ALGORITHM = 'HS256'
+
+        class << self
+          # Build a JWT for authentication
+          #
+          # @param [String] api_key the API Key to sign the request with
+          # @param [String] api_key_name the unique name for the API Key
+          # @option options see the {App Search API}[https://www.elastic.co/guide/en/app-search/current/authentication.html#authentication-signed] for supported search options.
+          #
+          # @return [String] the JWT to use for authentication
+          def create_signed_search_key(api_key, api_key_name, options = {})
+            payload = Elastic::EnterpriseSearch::Utils.symbolize_keys(options).merge(api_key_name: api_key_name)
+            JWT.encode(payload, api_key, SIGNED_KEY_ALGORITHM)
+          end
+        end
+
         def http_auth
           @options[:http_auth]
         end

data/lib/elastic/enterprise-search/api/health.rb

@@ -23,14 +23,19 @@ module Elastic
       # Health - Get information on the health of a deployment and basic statistics around resource usage
       # Get information on the health of a deployment and basic statistics around resource usage
       #
+      # @option arguments [Hash] :headers optional HTTP headers to send with the request
+      #
       # @see https://www.elastic.co/guide/en/enterprise-search/current/monitoring-apis.html#health-api-example
       #
       def health(arguments = {})
+        headers = arguments.delete(:headers) || {}
+
         request(
           :get,
           'api/ent/v1/internal/health/',
           arguments,
-          {}
+          {},
+          headers
         )
       end
     end

data/lib/elastic/enterprise-search/api/put_read_only.rb

@@ -23,16 +23,20 @@ module Elastic
       # Read-Only - Update the read-only flag's state
       # Update the read-only flag's state
       #
+      # @option arguments [Hash] :headers optional HTTP headers to send with the request
+      #
       # @see https://www.elastic.co/guide/en/enterprise-search/current/read-only-api.html#setting-read-only-state
       #
       def put_read_only(arguments = {})
         body = arguments.delete(:body) || {}
+        headers = arguments.delete(:headers) || {}
 
         request(
           :put,
           'api/ent/v1/internal/read_only_mode/',
           arguments,
-          body
+          body,
+          headers
         )
       end
     end

data/lib/elastic/enterprise-search/api/read_only.rb

@@ -23,14 +23,19 @@ module Elastic
       # Read-Only - Get the read-only flag's state
       # Get the read-only flag's state
       #
+      # @option arguments [Hash] :headers optional HTTP headers to send with the request
+      #
       # @see https://www.elastic.co/guide/en/enterprise-search/current/read-only-api.html#getting-read-only-state
       #
       def read_only(arguments = {})
+        headers = arguments.delete(:headers) || {}
+
         request(
           :get,
           'api/ent/v1/internal/read_only_mode/',
           arguments,
-          {}
+          {},
+          headers
         )
       end
     end

data/lib/elastic/enterprise-search/api/stats.rb

@@ -24,16 +24,20 @@ module Elastic
       # Get information about the resource usage of the application, the state of different internal queues, etc.
       #
       # @param arguments [Hash] endpoint arguments
-      # @option include [Array] Comma-separated list of stats to return
+      # @option arguments [Array] :include Comma-separated list of stats to return
+      # @option arguments [Hash] :headers optional HTTP headers to send with the request
       #
       # @see https://www.elastic.co/guide/en/enterprise-search/current/monitoring-apis.html#stats-api-example
       #
       def stats(arguments = {})
+        headers = arguments.delete(:headers) || {}
+
         request(
           :get,
           'api/ent/v1/internal/stats/',
           arguments,
-          {}
+          {},
+          headers
         )
       end
     end

data/lib/elastic/enterprise-search/api/version.rb

@@ -23,14 +23,19 @@ module Elastic
       # Version - Get version information for this server
       # Get version information for this server
       #
+      # @option arguments [Hash] :headers optional HTTP headers to send with the request
+      #
       # @see https://www.elastic.co/guide/en/enterprise-search/current/management-apis.html
       #
       def version(arguments = {})
+        headers = arguments.delete(:headers) || {}
+
         request(
           :get,
           'api/ent/v1/internal/version/',
           arguments,
-          {}
+          {},
+          headers
         )
       end
     end

data/lib/elastic/enterprise-search/client.rb

@@ -17,12 +17,22 @@
 
 # frozen_string_literal: true
 
-# TODO: CONFIG require 'elastic/enterprise-search/configuration'
 require 'elastic/enterprise-search/request'
 require 'elastic/enterprise-search/utils'
 require 'elasticsearch-transport'
 
 module Elastic
+  # If the version is X.X.X.pre/alpha/beta, use X.X.Xp for the meta-header:
+  def self.client_meta_version
+    regexp = /^([0-9]+\.[0-9]+\.[0-9]+)\.?([a-z0-9.-]+)?$/
+    match = Elastic::EnterpriseSearch::VERSION.match(regexp)
+    return "#{match[1]}p" if match[2]
+
+    Elastic::EnterpriseSearch::VERSION
+  end
+
+  META_HEADER_SERVICE_VERSION = [:ent, client_meta_version].freeze
+
   module EnterpriseSearch
     # API client for the {Elastic Enterprise Search API}[https://www.elastic.co/enterprise-search].
     # This is the main client from which the Workplace Search and App Search clients inherit.
@@ -59,6 +69,8 @@ module Elastic
       # @option options [String] :proxy url of proxy to use, ex: "http://localhost:8888"
       # @option options [Boolean] :log Use the default logger (disabled by default)
       # @option arguments [Object] :logger An instance of a Logger-compatible object
+      # @option enable_meta_header [Boolean] :enable_meta_header Enable sending the meta data header to Cloud.
+      #                                                          (Default: true)
       def initialize(options = {})
         @options = options
         @transport = transport
@@ -73,7 +85,8 @@ module Elastic
             request_timeout: overall_timeout,
             transport_options: {
               request: { open_timeout: open_timeout }
-            }
+            },
+            enable_meta_header: @options[:enable_meta_header] || true
           )
       end
 

data/lib/elastic/enterprise-search/request.rb

@@ -29,30 +29,32 @@ module Elastic
 
     # Module included in Elastic::Enterprise::Client for http requests.
     module Request
-      def get(path, params = {})
-        request(:get, path, params)
+      def get(path, params = {}, headers = {})
+        request(:get, path, params, headers)
       end
 
-      def post(path, params = {}, body = {})
-        request(:post, path, params, body)
+      def post(path, params = {}, body = {}, headers = {})
+        request(:post, path, params, body, headers)
       end
 
-      def put(path, params = {}, body = {})
-        request(:put, path, params, body)
+      def put(path, params = {}, body = {}, headers = {})
+        request(:put, path, params, body, headers)
       end
 
-      def delete(path, params = {})
-        request(:delete, path, params)
+      def delete(path, params = {}, headers = {})
+        request(:delete, path, params, headers)
       end
 
       # Construct and send a request to the API.
       #
       # @raise [Timeout::Error] when the timeout expires
-      def request(method, path, params = {}, body = {})
-        headers = {
-          authorization: setup_authentication_header,
-          user_agent: request_user_agent
-        }
+      def request(method, path, params = {}, body = {}, headers = {})
+        meta_headers = { authorization: decide_authorization(params), user_agent: request_user_agent }
+        headers = if headers.nil? || !headers.is_a?(Hash)
+                    meta_headers
+                  else
+                    headers.merge(meta_headers)
+                  end
 
         @transport.perform_request(method.to_s.upcase, path, params, body, headers)
       end
@@ -74,6 +76,16 @@ module Elastic
         meta << "elasticsearch-transport: #{Elasticsearch::Transport::VERSION}"
         "#{ua} (#{meta.join('; ')})"
       end
+
+      def decide_authorization(params)
+        if params[:grant_type] == 'authorization_code'
+          "Bearer #{params[:code]}"
+        elsif params[:access_token]
+          "Bearer #{params.delete(:access_token)}"
+        else
+          setup_authentication_header
+        end
+      end
     end
   end
 end

data/lib/elastic/enterprise-search/utils.rb

@@ -31,12 +31,11 @@ module Elastic
         output
       end
 
-      def host=(host)
-        @options[:host] = if host.end_with?('/')
-                            host
-                          else
-                            "#{host}/"
-                          end
+      def self.symbolize_keys(hash)
+        hash.each_with_object({}) do |(key, value), out|
+          new_key = key.respond_to?(:to_sym) ? key.to_sym : key
+          out[new_key] = value
+        end
       end
     end
   end

data/lib/elastic/enterprise-search/version.rb

@@ -19,6 +19,6 @@
 
 module Elastic
   module EnterpriseSearch
-    VERSION = '7.10.0.beta.1'
+    VERSION = '7.11.0'
   end
 end