elastic-enterprise-search 0.2.1 → 7.12.0

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# 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 Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Searchsettings - Retrieve current search settings for the engine
+        #
+        # @param engine_name [String]  (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @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
+        #
+        def search_settings(engine_name, arguments = {})
+          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,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# 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 Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Synonyms - Retrieve a synonym set by ID
+        #
+        # @param engine_name [String]  (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @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
+        #
+        def synonym_set(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          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,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# 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 Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Analytics - Returns the number of clicks received by a document in descending order
+        #
+        # @param engine_name [String]  (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :query Filter clicks over a search query
+        # @option arguments [Integer] :current_page The page to fetch. Defaults to 1
+        # @option arguments [Integer] :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
+        #
+        def top_clicks_analytics(engine_name, arguments = {})
+          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,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# 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 Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Analytics - Returns queries analytics by usage count
+        #
+        # @param engine_name [String]  (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Integer] :current_page The page to fetch. Defaults to 1
+        # @option arguments [Integer] :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
+        #
+        def top_queries_analytics(engine_name, arguments = {})
+          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,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+# 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.
+
+# frozen_string_literal: true
+
+require 'jwt'
+
+module Elastic
+  module EnterpriseSearch
+    # App Search client for Enterprise Search.
+    #
+    # @see https://www.elastic.co/guide/en/app-search/current/index.html
+    module AppSearch
+      # The Request module is included in the AppSearch Client to override
+      # EnterpriseSearch client's authentication method with App's
+      # authentication.
+      module Request
+        def setup_authentication_header
+          "Bearer #{http_auth}"
+        end
+      end
+
+      # The App Search Client
+      # Extends EnterpriseSearch client but overrides authentication to use access token.
+      class Client < Elastic::EnterpriseSearch::Client
+        include Elastic::EnterpriseSearch::AppSearch::Actions
+        include Elastic::EnterpriseSearch::AppSearch::Request
+
+        # 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.
+        # @option options [String] :api_key Part of the credentials
+        def initialize(options = {})
+          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
+
+        def http_auth=(api_key)
+          @options[:http_auth] = api_key
+        end
+
+        def date_to_rfc3339(date)
+          DateTime.parse(date.to_s).rfc3339
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# 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 Elastic
+  module EnterpriseSearch
+    module Actions
+      # 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
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# 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 Elastic
+  module EnterpriseSearch
+    module Actions
+      # 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,
+          headers
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# 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 Elastic
+  module EnterpriseSearch
+    module Actions
+      # 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
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# 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 Elastic
+  module EnterpriseSearch
+    module Actions
+      # Stats - Get information about the resource usage of the application, the state of different internal queues, etc.
+      # Get information about the resource usage of the application, the state of different internal queues, etc.
+      #
+      # @param arguments [Hash] endpoint arguments
+      # @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
+  end
+end