elastic-enterprise-search 7.12.1 → 7.13.0.pre

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

@@ -29,7 +29,7 @@ module Elastic
         # @option arguments [Array] :document_ids
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
-        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-custom-sources-api.html#destroy
+        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-custom-sources-api.html#delete-by-id
         #
         def delete_documents(content_source_id, arguments = {})
           raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id

data/lib/elastic/workplace-search/api/document.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
+        # Documents - Retrieves a document by ID from the specified content source
+        # Retrieves a document by ID from the specified content source
+        #
+        # @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] :document_id  (*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-content-sources-api.html#get-document-by-id-api
+        #
+        def document(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
+          raise ArgumentError, "Required parameter 'document_id' missing" unless arguments[:document_id]
+
+          document_id = arguments[:document_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            "api/ws/v1/sources/#{content_source_id}/documents/#{document_id}/",
+            arguments,
+            {},
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# 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
+        # ContentSources - Retrieves all content sources
+        # Retrieves all content sources
+        #
+        # @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-content-sources-api.html#list-content-sources-api
+        #
+        def list_content_sources(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            'api/ws/v1/sources/',
+            arguments,
+            {},
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# 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
+        # ContentSources - Update a content source
+        # Update a custom content source
+        #
+        # @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 [Object] :body Definition to update a Workplace Search Content Source (Required: name, schema, display, is_searchable)
+        # @option body [String] :name The human readable display name for this Content Source.
+        # @option body :schema The schema that each document in this Content Source will adhere to.
+        # @option body :display The display details which governs which fields will be displayed, and in what order, in the search results.
+        # @option body [Boolean] :is_searchable Whether or not this Content Source will be searchable on the search 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-content-sources-api.html#update-content-source-api
+        #
+        def put_content_source(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :put,
+            "api/ws/v1/sources/#{content_source_id}/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -28,6 +28,8 @@ module Elastic
         # @param arguments [Hash] endpoint arguments
         # @option arguments [String] :user The username in context (*Required*)
         # @option arguments [Object] :body  (Required: source_user_id, user)
+        # @option body [String] :source_user_id
+        # @option body [String] :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

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

@@ -26,7 +26,12 @@ module Elastic
       # authentication.
       module Request
         def setup_authentication_header
-          "Bearer #{http_auth}"
+          case http_auth
+          when Hash
+            basic_auth_header
+          when String
+            "Bearer #{http_auth}"
+          end
         end
       end
 

data/spec/integration/enterprise_search_api_spec.rb

@@ -31,6 +31,10 @@ describe Elastic::EnterpriseSearch::Client do
     Elastic::EnterpriseSearch::Client.new(host: host, http_auth: http_auth)
   end
 
+  after do
+    client.put_read_only(body: { enabled: false })
+  end
+
   context 'API' do
     context 'health' do
       it 'makes GET request' do

data/spec/integration/workplace_search_spec.rb

@@ -0,0 +1,253 @@
+# 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 'spec_helper'
+
+describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
+  let(:host) { ENV['ELASTIC_ENTERPRISE_HOST'] || 'http://localhost:3002' }
+  let(:http_auth) do
+    {
+      user: ENV['ELASTIC_ENTERPRISE_USER'] || 'enterprise_search',
+      password: ENV['ELASTIC_ENTERPRISE_PASSWORD'] || 'changeme'
+    }
+  end
+  let(:client) do
+    Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(host: host, http_auth: http_auth)
+  end
+  let(:documents) do
+    [
+      {
+        'id' => '4e696e74656e646f203634',
+        'url' => 'https://www.elastic.co/blog/introducing-quick-start-guides-getting-started-with-elastic-enterprise-search-for-free',
+        'title' => 'Getting started with Elastic Enterprise Search for free',
+        'body' => 'this is a test'
+      },
+      {
+        'id' => '47616d6520426f7920436f6c6f72',
+        'url' => 'https://www.elastic.co/workplace-search',
+        'title' => 'One-stop answer shop for the virtual workplace',
+        'body' => 'this is also a test'
+      }
+    ]
+  end
+
+  context 'Content Sources' do
+    it 'creates, retrieves and deletes authenticated with basic auth' do
+      # Create a content source and get its id
+      response = client.create_content_source(name: 'test')
+      expect(response.status).to eq 200
+      expect(response.body['id'])
+      id = response.body['id']
+
+      # Test we get the content source information with get_content_source
+      response = client.content_source(id)
+      expect(response.status).to eq 200
+
+      # List all content sources
+      response = client.list_content_sources
+      expect(response.status).to eq 200
+      expect(response.body['results'].count).to be >= 1
+
+      # Delete content source
+      response = client.delete_content_source(id)
+      expect(response.status).to eq 200
+    end
+
+    it 'creates and updates' do
+      response = client.create_content_source(name: 'ruby_client_app')
+      expect(response.status).to eq 200
+      id = response.body['id']
+
+      documents = [{ title: 'My first Document', body: 'Content', url: 'elastic.co' }]
+      response = client.index_documents(id, documents: documents)
+      expect(response.status).to eq 200
+
+      new_name = 'ruby_client'
+      body = {
+        name: new_name,
+        schema: { title: 'text', body: 'text', url: 'text' },
+        display: { title_field: 'title', url_field: 'url', color: '#f00f00' },
+        is_searchable: true
+      }
+      response = client.put_content_source(id, body: body)
+      expect(response.status).to eq 200
+
+      response = client.content_source(id)
+      expect(response.status).to eq 200
+      expect(response.body['name']) == new_name
+    end
+  end
+
+  context 'Documents' do
+    let(:content_source_id) do
+      client.create_content_source(name: 'test').body['id']
+    end
+
+    it 'indexes' do
+      response = client.index_documents(content_source_id, documents: documents)
+      expect(response.status).to eq 200
+    end
+
+    it 'deletes' do
+      response = client.delete_documents(content_source_id, document_ids: documents.map { |doc| doc['id'] })
+      expect(response.status).to eq 200
+    end
+  end
+
+  context 'Documents in Content Sources' do
+    let(:content_source_id) { client.create_content_source(name: 'books').body['id'] }
+    let(:document_id) { client.index_documents(content_source_id, documents: documents).body['results'].first['id'] }
+
+    it 'Gets a document in a content source' do
+      response = client.document(content_source_id, document_id: document_id)
+      expect(response.status).to eq 200
+      expect(response.body['id']).to eq document_id
+    end
+
+    it 'Deletes all documents in a content source' do
+      response = client.delete_all_documents(content_source_id)
+      expect(response.status).to eq 200
+    end
+  end
+
+  context 'External Identities' do
+    let(:content_source_id) { client.create_content_source(name: 'my_content').body['id'] }
+    let(:user) { 'elastic_user' }
+    let(:source_user_id) { 'example@elastic.co' }
+    let(:body) do
+      { user: user, source_user_id: source_user_id }
+    end
+
+    context 'Creates' do
+      let(:source_user_id) { 'test@elastic.co' }
+      let(:user) { 'test' }
+
+      it 'creates an external identity' do
+        response = client.create_external_identity(content_source_id, body: body)
+
+        expect(response.status).to eq 200
+        expect(response.body).to eq({ 'source_user_id' => source_user_id, 'user' => user })
+
+        client.delete_external_identity(content_source_id, user: user)
+      end
+
+      it 'creates and retrieves' do
+        client.create_external_identity(content_source_id, body: body)
+        response = client.external_identity(content_source_id, user: user)
+
+        expect(response.status).to eq 200
+        expect(response.body).to eq({ 'source_user_id' => source_user_id, 'user' => user })
+        client.delete_external_identity(content_source_id, user: user)
+      end
+    end
+
+    context 'Lists' do
+      let(:user) { 'lists_test' }
+
+      it 'lists external identities' do
+        client.create_external_identity(content_source_id, body: body)
+        response = client.list_external_identities(content_source_id)
+
+        expect(response.status).to eq 200
+        expect(response.body['results']).to eq([{ 'source_user_id' => source_user_id, 'user' => user }])
+        client.delete_external_identity(content_source_id, user: user)
+      end
+    end
+
+    context 'Updates' do
+      before do
+        client.create_external_identity(content_source_id, body: body)
+      end
+
+      it 'updates an external identity' do
+        body = { source_user_id: 'example2@elastic.co' }
+        response = client.put_external_identity(content_source_id, user: user, body: body)
+
+        expect(response.status).to eq 200
+        expect(response.body).to eq({ 'source_user_id' => 'example2@elastic.co', 'user' => user })
+      end
+    end
+
+    context 'Deletes' do
+      before do
+        client.create_external_identity(content_source_id, body: body)
+      end
+
+      it 'deletes an external identity' do
+        response = client.delete_external_identity(content_source_id, user: user)
+        expect(response.status).to eq 200
+        expect(response.body).to eq 'ok'
+      end
+    end
+  end
+
+  context 'Permissions' do
+    let(:content_source_id) { client.create_content_source(name: 'my_content').body['id'] }
+    let(:user) { 'enterprise_search' }
+    let(:permissions) { ['permission1', 'permission2'] }
+
+    after do
+      client.put_user_permissions(content_source_id, { permissions: [], user: user })
+    end
+
+    it 'adds permissions to a user' do
+      response = client.add_user_permissions(
+        content_source_id,
+        { permissions: permissions, user: user }
+      )
+      expect(response.status).to eq 200
+      expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => ['permission1', 'permission2'] })
+    end
+
+    it 'removes permissions from a user' do
+      client.add_user_permissions(content_source_id, { permissions: permissions, user: user })
+
+      # Removes Permissions
+      response = client.remove_user_permissions(
+        content_source_id,
+        { permissions: permissions, user: user }
+      )
+      expect(response.status).to eq 200
+      expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => [] })
+    end
+
+    it 'lists permissions' do
+      response = client.list_permissions(content_source_id)
+      expect(response.status).to eq 200
+    end
+
+    it 'gets a user\'s permissions' do
+      client.add_user_permissions(content_source_id, { permissions: permissions, user: user })
+      response = client.user_permissions(content_source_id, { user: user })
+      expect(response.status).to eq 200
+      expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => permissions })
+    end
+
+    it 'updates a user\'s permissions' do
+      permissions = ['testing', 'more', 'permissions']
+      response = client.add_user_permissions(content_source_id, { permissions: permissions, user: user })
+      expect(response.status).to eq 200
+      expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => permissions })
+
+      response = client.put_user_permissions(content_source_id, { permissions: [], user: user })
+      expect(response.status).to eq 200
+      expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => [] })
+    end
+  end
+end