elastic-enterprise-search 0.3.0 → 7.13.0.pre

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

@@ -0,0 +1,89 @@
+# 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
+          case http_auth
+          when Hash
+            basic_auth_header
+          when String
+            "Bearer #{http_auth}"
+          end
+        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

data/spec/app-search/api_count_analytics_spec.rb

@@ -0,0 +1,34 @@
+# 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'
+require_relative './api_spec_helper'
+
+describe Elastic::EnterpriseSearch::AppSearch::Client do
+  context 'api_logs' do
+    it 'returns api logs' do
+      VCR.use_cassette('app_search/count_analytics') do
+        response = @client.count_analytics('videogames')
+
+        expect(response.status).to eq 200
+        expect(response.body['results'].count).to be > 1
+      end
+    end
+  end
+end

data/spec/app-search/api_curations_spec.rb

@@ -0,0 +1,97 @@
+# 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_relative './api_spec_helper'
+
+describe Elastic::EnterpriseSearch::AppSearch::Client do
+  context 'curations' do
+    let(:engine_name) { 'books' }
+
+    it 'creates a new curation' do
+      VCR.use_cassette('app_search/create_curation') do
+        response = @client.create_curation(
+          engine_name,
+          queries: ['jungle'],
+          promoted: ['doc-600070f60e9e05e6b7037721'],
+          hidden: ['doc-600070f60e9e05e6b7037729']
+        )
+        expect(response.status).to eq 200
+        expect(response.body['id']).to match(/cur-[0-9a-f]+/)
+
+        response = @client.search(engine_name, query: 'jungle')
+        expect(response.status).to eq 200
+        expect(response.body['results'].count).to eq 1
+        expect(response.body['results'].first['title']['raw']).to eq 'Jungle Tales'
+      end
+    end
+
+    it 'retrieves a curation by id' do
+      VCR.use_cassette('app_search/get_curation') do
+        response = @client.curation(engine_name, curation_id: 'cur-600202fa0e9e05e6b7037753')
+
+        expect(response.status).to eq 200
+        expect(response.body['id']).to match(/cur-[0-9a-f]+/)
+        expect(response.body['queries']).to eq ['jungle']
+        expect(response.body['promoted']).to eq ['doc-600070f60e9e05e6b7037721']
+        expect(response.body['hidden']).to eq ['doc-600070f60e9e05e6b7037729']
+      end
+    end
+
+    it 'updates an existing curation' do
+      VCR.use_cassette('app_search/put_curation') do
+        response = @client.put_curation(
+          engine_name,
+          curation_id: 'cur-600202fa0e9e05e6b7037753',
+          queries: ['jungle'],
+          promoted: ['doc-600070f60e9e05e6b7037729'],
+          hidden: ['doc-600070f60e9e05e6b7037721']
+        )
+
+        expect(response.status).to eq 200
+        expect(response.body['id']).to match(/cur-[0-9a-f]+/)
+
+        response = @client.search(engine_name, query: 'jungle')
+        expect(response.status).to eq 200
+        expect(response.body['results'].count).to eq 1
+        expect(response.body['results'].first['title']['raw']).to eq 'The Jungle Book'
+      end
+    end
+
+    it 'lists curations' do
+      VCR.use_cassette('app_search/list_curations') do
+        response = @client.list_curations(engine_name)
+
+        expect(response.status).to eq 200
+        expect(response.body['results'].count).to eq 1
+        curation = response.body['results'].first
+        expect(curation['id']).to match(/cur-[0-9a-f]+/)
+        expect(curation['queries']).to eq ['jungle']
+      end
+    end
+
+    it 'deletes a curation' do
+      VCR.use_cassette('app_search/delete_curation') do
+        response = @client.delete_curation(engine_name, curation_id: 'cur-6002097c0e9e053992037769')
+
+        expect(response.status).to eq 200
+        expect(response.body).to eq({ 'deleted' => true })
+      end
+    end
+  end
+end

data/spec/app-search/api_documents_spec.rb

@@ -0,0 +1,102 @@
+# 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_relative './api_spec_helper'
+
+describe Elastic::EnterpriseSearch::AppSearch::Client do
+  let(:engine_name) { 'videogames' }
+
+  # TODO: Once we stop using VCR, we need to do create / list / destroy engines
+
+  context 'documents' do
+    it 'indexes and lists documents' do
+      VCR.use_cassette('app_search/api_index_documents') do
+        documents = [
+          { name: 'Super Lorenzo Bros', year: 1985 },
+          { name: 'Pack-Man', year: 1980 },
+          { name: 'Galaxxian', year: 1979 },
+          { name: 'Audiovisual, the hedgehog', year: '1991' }
+        ]
+        response = @client.index_documents(engine_name, documents: documents)
+        expect(response.status).to eq 200
+        expect(response.body.count).to eq 4
+        expect(response.body.map(&:keys)).to eq [['id', 'errors'], ['id', 'errors'], ['id', 'errors'], ['id', 'errors']]
+      end
+
+      VCR.use_cassette('app_search/list_documents') do
+        response = @client.list_documents(engine_name)
+
+        expect(response.status).to eq 200
+        expect(response.body['results'].count).to eq 4
+      end
+    end
+
+    it 'retrieves documents by ID' do
+      VCR.use_cassette('app_search/api_documents') do
+        ids = ['doc-6005c044ad7f0c8b464b8cc4', 'doc-6005c044ad7f0c8b464b8cc3']
+        response = @client.documents(engine_name, document_ids: ids)
+
+        expect(response.status).to eq 200
+        expect(response.body.count).to eq 2
+        expect(response.body).to include(
+          { 'name' => 'Galaxxian', 'year' => '1979', 'id' => 'doc-6005c044ad7f0c8b464b8cc4' },
+          { 'name' => 'Pack-Man', 'year' => '1980', 'id' => 'doc-6005c044ad7f0c8b464b8cc3' }
+        )
+      end
+    end
+
+    it 'searches for a document' do
+      VCR.use_cassette('app_search/search') do
+        response = @client.search(engine_name, body: { query: 'Pack-Man' })
+        expect(response.status).to eq 200
+        expect(response.body['meta']['engine']).to eq({ 'name' => 'videogames', 'type' => 'default' })
+        expect(response.body['results'].first['name']).to eq({ 'raw' => 'Pack-Man' })
+        expect(response.body['results'].first['year']).to eq({ 'raw' => '1980' })
+      end
+    end
+
+    it 'deletes a document' do
+      VCR.use_cassette('app_search/index_and_delete_document') do
+        document = { name: 'Princess Zelda', year: 1986 }
+        response = @client.index_documents(engine_name, documents: document)
+        expect(response.status).to eq 200
+
+        id = response.body.first['id']
+
+        response = @client.delete_documents(engine_name, document_ids: [id])
+        expect(response.status).to eq 200
+        expect(response.body.first['deleted'])
+      end
+    end
+
+    it 'updates a document' do
+      VCR.use_cassette('app_search/create_and_update_document') do
+        document = { name: '', year: 1986 }
+        response = @client.index_documents(engine_name, documents: document)
+        expect(response.status).to eq 200
+
+        id = response.body.first['id']
+
+        response = @client.put_documents(engine_name, documents: [{ id: id, year: 1987 }])
+        expect(response.status).to eq 200
+        expect(response.body).to eq [{ 'id' => 'doc-5fa2d4e1389ab975965be3e3', 'errors' => [] }]
+      end
+    end
+  end
+end

data/spec/app-search/api_engines_spec.rb

@@ -0,0 +1,67 @@
+# 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_relative './api_spec_helper'
+
+describe Elastic::EnterpriseSearch::AppSearch::Client do
+  let(:engine_name) { 'videogames' }
+
+  # TODO: Once we stop using VCR, we need to do create / list / destroy engines
+
+  context 'engines' do
+    it 'creates an engine' do
+      VCR.use_cassette('app_search/create_engine') do
+        response = @client.create_engine(name: 'videogames')
+
+        expect(response.status).to eq 200
+        expect(response.body).to eq({ 'name' => 'videogames', 'type' => 'default', 'language' => nil })
+      end
+    end
+
+    it 'lists engines' do
+      VCR.use_cassette('app_search/list_engines') do
+        response = @client.list_engines
+
+        expect(response.status).to eq 200
+        expect(response.body).to eq(
+          { 'meta' => { 'page' => { 'current' => 1, 'total_pages' => 1, 'total_results' => 1, 'size' => 25 } },
+            'results' => [{ 'name' => 'videogames', 'type' => 'default', 'language' => nil }] }
+        )
+      end
+    end
+
+    it 'retrieves an engine by name' do
+      VCR.use_cassette('app_search/get_engine') do
+        response = @client.engine('videogames')
+
+        expect(response.status).to eq 200
+        expect(response.body).to eq({ 'name' => 'videogames', 'type' => 'default', 'language' => nil })
+      end
+    end
+
+    it 'deletes an engine' do
+      VCR.use_cassette('app_search/delete_engine') do
+        response = @client.delete_engine('videogames')
+
+        expect(response.status).to eq 200
+        expect(response.body).to eq({ 'deleted' => true })
+      end
+    end
+  end
+end

data/spec/app-search/api_log_clickthrough_spec.rb

@@ -0,0 +1,34 @@
+# 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_relative './api_spec_helper'
+
+describe Elastic::EnterpriseSearch::AppSearch::Client do
+  context 'api_log_clickthrough' do
+    let(:engine_name) { 'films' }
+
+    it 'logs clicked results' do
+      VCR.use_cassette('app_search/api_log_clickthrough') do
+        response = @client.log_clickthrough(engine_name, query_text: 'moon', document_id: 'doc-id')
+
+        expect(response.status).to eq 200
+      end
+    end
+  end
+end

data/spec/app-search/api_logs_spec.rb

@@ -0,0 +1,36 @@
+# 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_relative './api_spec_helper'
+
+describe Elastic::EnterpriseSearch::AppSearch::Client do
+  context 'api_logs' do
+    it 'returns api logs' do
+      VCR.use_cassette('app_search/api_logs') do
+        response = @client.api_logs(
+          'videogames',
+          from_date: Date.new(2020, 10, 0o1),
+          to_date: Date.new(2020, 11, 0o5)
+        )
+        expect(response.status).to eq 200
+        expect(response.body['results'].count).to be > 1
+      end
+    end
+  end
+end