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

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

@@ -24,16 +24,34 @@ module Elastic
         # 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
+            body,
+            headers
           )
         end
       end

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

@@ -24,23 +24,27 @@ module Elastic
         # Permissions - Lists all permissions for one user
         # List permissions for a user
         #
-        # @param content_source_key [String] Unique key for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @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 user [String] The username in context (*Required*)
+        # @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_key, arguments = {})
-          raise ArgumentError, "Required parameter 'content_source_key' missing" unless content_source_key
+        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_key}/permissions/#{user}/",
+            "api/ws/v1/sources/#{content_source_id}/permissions/#{user}/",
             arguments,
-            {}
+            {},
+            headers
           )
         end
       end

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

@@ -37,7 +37,7 @@ module Elastic
         include Elastic::EnterpriseSearch::WorkplaceSearch::Request
         include Elastic::EnterpriseSearch::Utils
 
-        # Crete a new Elastic::EnterpriseSearch::WorkplaceSearch::Client client
+        # 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
@@ -53,6 +53,31 @@ module Elastic
         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

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

@@ -26,14 +26,14 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
 
   context 'documents' do
     it 'indexes and lists documents' do
-      VCR.use_cassette('app_search/index_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, body: documents)
+        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']]
@@ -47,6 +47,20 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
       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' })
@@ -60,12 +74,12 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
     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, body: document)
+        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, body: [id])
+        response = @client.delete_documents(engine_name, document_ids: [id])
         expect(response.status).to eq 200
         expect(response.body.first['deleted'])
       end
@@ -74,12 +88,12 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
     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, body: document)
+        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, body: [{ id: id, year: 1987 }])
+        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

data/spec/app-search/api_engines_spec.rb

@@ -26,7 +26,7 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
 
   context 'engines' do
     it 'creates an engine' do
-      VCR.use_cassette(:create_engine) do
+      VCR.use_cassette('app_search/create_engine') do
         response = @client.create_engine(name: 'videogames')
 
         expect(response.status).to eq 200
@@ -35,7 +35,7 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
     end
 
     it 'lists engines' do
-      VCR.use_cassette(:list_engines) do
+      VCR.use_cassette('app_search/list_engines') do
         response = @client.list_engines
 
         expect(response.status).to eq 200
@@ -47,7 +47,7 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
     end
 
     it 'retrieves an engine by name' do
-      VCR.use_cassette(:get_engine) do
+      VCR.use_cassette('app_search/get_engine') do
         response = @client.engine('videogames')
 
         expect(response.status).to eq 200
@@ -56,7 +56,7 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
     end
 
     it 'deletes an engine' do
-      VCR.use_cassette(:delete_engine) do
+      VCR.use_cassette('app_search/delete_engine') do
         response = @client.delete_engine('videogames')
 
         expect(response.status).to eq 200

data/{lib/generator/templates/_license.erb → spec/app-search/api_log_clickthrough_spec.rb}

@@ -14,3 +14,21 @@
 # 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_meta_engines_spec.rb

@@ -0,0 +1,72 @@
+# 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) { 'new-meta-engine' }
+
+  # TODO: Once we stop using VCR, we need to do create / list / destroy engines
+
+  context 'meta engines' do
+    it 'creates a meta engine' do
+      VCR.use_cassette('app_search/create_meta_engine') do
+        body = {
+          name: engine_name,
+          type: 'meta',
+          source_engines: ['books', 'videogames']
+        }
+        response = @client.create_engine(name: engine_name, body: body)
+
+        expect(response.status).to eq 200
+        expect(response.body['name']).to eq('new-meta-engine')
+        expect(response.body['type']).to eq('meta')
+        expect(response.body['source_engines'].sort).to eq(['books', 'videogames'])
+        expect(response.body['document_count']).to be > 1
+      end
+    end
+
+    it 'adds a new source engine to a meta engine' do
+      VCR.use_cassette('app_search/add_meta_engine_source') do
+        # Create new source engine to add:
+        @client.create_engine(name: 'comicbooks')
+
+        response = @client.add_meta_engine_source(engine_name, source_engines: ['comicbooks'])
+
+        expect(response.status).to eq 200
+        expect(response.body['name']).to eq('new-meta-engine')
+        expect(response.body['type']).to eq('meta')
+        expect(response.body['source_engines'].sort).to eq(['books', 'comicbooks', 'videogames'])
+        expect(response.body['document_count']).to be > 1
+      end
+    end
+
+    it 'removes a source engine from a meta engine' do
+      VCR.use_cassette('app_search/delete_meta_engine_source') do
+        response = @client.delete_meta_engine_source(engine_name, source_engines: ['videogames'])
+
+        expect(response.status).to eq 200
+        expect(response.body['name']).to eq('new-meta-engine')
+        expect(response.body['type']).to eq('meta')
+        expect(response.body['source_engines'].sort).to eq(['books', 'comicbooks'])
+        expect(response.body['document_count']).to be > 1
+      end
+    end
+  end
+end

data/spec/app-search/api_query_suggestion_spec.rb

@@ -0,0 +1,39 @@
+# 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_query_suggestion' do
+    let(:engine_name) { 'films' }
+
+    it 'provides query suggestions' do
+      VCR.use_cassette('app_search/api_query_suggestion') do
+        response = @client.query_suggestion(engine_name, query: 'moo')
+
+        expect(response.status).to eq 200
+
+        expect(response.body['results']['documents']).to include(
+          { 'suggestion' => 'moon' },
+          { 'suggestion' => 'moon men' }
+        )
+      end
+    end
+  end
+end