elastic-enterprise-search 0.3.1 → 7.12.1

data/lib/elastic/workplace-search/api/list_external_identities.rb

@@ -0,0 +1,51 @@
+# 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 WorkplaceSearch
+      module Actions
+        # ExternalIdentities - Retrieves all external identities
+        # Retrieves all external identities
+        #
+        # @param content_source_id [String] Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Integer] :current_page Which page of results to request
+        # @option arguments [Integer] :page_size The number of results to return in a page
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-external-identities-api.html#list-external-identities
+        #
+        def list_external_identities(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
+
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            "api/ws/v1/sources/#{content_source_id}/external_identities/",
+            arguments,
+            {},
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/workplace-search/api/list_permissions.rb

@@ -0,0 +1,51 @@
+# 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 WorkplaceSearch
+      module Actions
+        # Permissions - Lists all permissions for all users
+        # List all permissions for all users
+        #
+        # @param content_source_id [String] Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Integer] :current_page Which page of results to request
+        # @option arguments [Integer] :page_size The number of results to return in a page
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-document-permissions-api.html#list
+        #
+        def list_permissions(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
+
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            "api/ws/v1/sources/#{content_source_id}/permissions/",
+            arguments,
+            {},
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/workplace-search/api/put_external_identity.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 WorkplaceSearch
+      module Actions
+        # ExternalIdentities - Updates an external identity
+        # Updates an external identity
+        #
+        # @param content_source_id [String] Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :user The username in context (*Required*)
+        # @option arguments [Object] :body  (Required: source_user_id, user)
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-external-identities-api.html#update-external-identity
+        #
+        def put_external_identity(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
+          raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
+
+          user = arguments[:user]
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :put,
+            "api/ws/v1/sources/#{content_source_id}/external_identities/#{user}/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/workplace-search/api/put_user_permissions.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 WorkplaceSearch
+      module Actions
+        # Permissions - Creates a new set of permissions or over-writes all existing permissions
+        # Create a set of permissions or overwrite existing permissions
+        #
+        # @param content_source_id [String] Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :user The username in context (*Required*)
+        # @option arguments [Array] :body List of permissions
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-document-permissions-api.html#add-all
+        #
+        def put_user_permissions(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
+          raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
+
+          user = arguments[:user]
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :put,
+            "api/ws/v1/sources/#{content_source_id}/permissions/#{user}/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/workplace-search/api/remove_user_permissions.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 WorkplaceSearch
+      module Actions
+        # Permissions - Removes one or more permissions from an existing set of permissions
+        # Remove one or more permission for a given user
+        #
+        # @param content_source_id [String] Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :user The username in context (*Required*)
+        # @option arguments [Array] :body List of permissions
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-document-permissions-api.html#remove-one
+        #
+        def remove_user_permissions(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
+          raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
+
+          user = arguments[:user]
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            "api/ws/v1/sources/#{content_source_id}/permissions/#{user}/remove/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# 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 WorkplaceSearch
+      module Actions
+        # Search - Search across available sources with various query tuning options
+        # Issue a Search Query
+        #
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :access_token OAuth Access Token (*Required*)
+        # @option arguments [Object] :body
+        # @option body [String] :query A string or number used to find related documents
+        # @option body [Boolean] :automatic_query_refinement Set to false to not automatically refine the query by keywords
+        # @option body [Object] :page Paging controls for the result set
+        # @option body [Object] :search_fields Restrict the fulltext search to only specific fields
+        # @option body [Object] :result_fields Restrict the result fields for each item to the specified fields
+        # @option body :filters
+        # @option body :sort
+        # @option body [Object] :facets
+        # @option body [Object] :boosts
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-search-api.html
+        #
+        def search(arguments = {})
+          raise ArgumentError, "Required parameter 'access_token' missing" unless arguments[:access_token]
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            'api/ws/v1/search/',
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/workplace-search/api/user_permissions.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 WorkplaceSearch
+      module Actions
+        # Permissions - Lists all permissions for one user
+        # List permissions for a user
+        #
+        # @param content_source_id [String] Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :user The username in context (*Required*)
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-document-permissions-api.html#list-one
+        #
+        def user_permissions(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
+          raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
+
+          user = arguments[:user]
+
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            "api/ws/v1/sources/#{content_source_id}/permissions/#{user}/",
+            arguments,
+            {},
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/workplace-search/workplace_search.rb

@@ -0,0 +1,84 @@
+# 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
+
+module Elastic
+  module EnterpriseSearch
+    # Workplace Search client for Enterprise Search.
+    module WorkplaceSearch
+      # The Request module is included in the WorkplaceSearch Client to override
+      # EnterpriseSearch client's authentication method with Workplace's
+      # authentication.
+      module Request
+        def setup_authentication_header
+          "Bearer #{http_auth}"
+        end
+      end
+
+      # The Workplace Search Client
+      # Extends EnterpriseSearch client but overrides authentication to use access token.
+      class Client < Elastic::EnterpriseSearch::Client
+        include Elastic::EnterpriseSearch::WorkplaceSearch::Actions
+        include Elastic::EnterpriseSearch::WorkplaceSearch::Request
+        include Elastic::EnterpriseSearch::Utils
+
+        # Create a new Elastic::EnterpriseSearch::WorkplaceSearch::Client client
+        #
+        # @param options [Hash] a hash of configuration options
+        # @option options [String] :access_token the access token for workplace search
+        # @option options [String] :endpoint the endpoint Workplace Search
+        def initialize(options = {})
+          super(options)
+        end
+
+        def http_auth
+          @options[:http_auth]
+        end
+
+        def http_auth=(access_token)
+          @options[:http_auth] = access_token
+        end
+
+        def authorization_url(client_id, redirect_uri)
+          [
+            host,
+            '/ws/oauth/authorize?',
+            'response_type=code&',
+            "client_id=#{client_id}&",
+            "redirect_uri=#{CGI.escape(redirect_uri)}"
+          ].join
+        end
+
+        def request_access_token(client_id, client_secret, authorization_code, redirect_uri)
+          response = request(
+            :post,
+            '/ws/oauth/token',
+            {
+              grant_type: 'authorization_code',
+              client_id: client_id,
+              client_secret: client_secret,
+              redirect_uri: redirect_uri,
+              code: authorization_code
+            }
+          )
+          response.body['access_token']
+        end
+      end
+    end
+  end
+end