elastic-enterprise-search 7.17.0 → 8.0.1

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

@@ -21,21 +21,21 @@ module Elastic
   module EnterpriseSearch
     module WorkplaceSearch
       module Actions
+        # getTriggersBlocklist - Get current triggers blocklist
         # Get current triggers blocklist
         #
-        # @param arguments [Hash] endpoint arguments
+        # @param [Hash] arguments endpoint arguments
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/automatic-query-refinement-blocklist.html
         #
         def triggers_blocklist(arguments = {})
           headers = arguments.delete(:headers) || {}
-
           request(
             :get,
             'api/ws/v1/automatic_query_refinement/',
             arguments,
-            {},
+            nil,
             headers
           )
         end

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

@@ -27,12 +27,17 @@ module Elastic
         include Elastic::EnterpriseSearch::WorkplaceSearch::Actions
         include Elastic::EnterpriseSearch::Utils
 
+        attr_accessor :kibana_url
+
         # 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
+        # @option options [String] :kibana_url The base URL of your Kibana instance
+        #
         def initialize(options = {})
+          @kibana_url = options[:kibana_url]
           super(options)
         end
 
@@ -45,9 +50,11 @@ module Elastic
         end
 
         def authorization_url(client_id, redirect_uri)
+          raise ArgumentError, 'kibana_url The base URL of your Kibana instance must be set in the client' unless kibana_url
+
           [
-            host,
-            '/ws/oauth/authorize?',
+            kibana_url,
+            '/app/enterprise_search/workplace_search/p/oauth/authorize?',
             'response_type=code&',
             "client_id=#{client_id}&",
             "redirect_uri=#{CGI.escape(redirect_uri)}"

data/spec/app-search/client_spec.rb

@@ -85,4 +85,33 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
       expect(decoded_token[0]['query']).to(eq('cat'))
     end
   end
+
+  context 'adapters' do
+    let(:client) { described_class.new }
+    let(:adapter) { client.transport.transport.connections.all.first.connection.builder.adapter }
+
+    context 'when no adapter is specified' do
+      it 'uses Faraday NetHttp' do
+        expect(adapter).to eq Faraday::Adapter::NetHttp
+      end
+    end
+
+    context 'when the adapter is patron' do
+      let(:client) { described_class.new(adapter: :patron) }
+
+      it 'uses Faraday with the adapter' do
+        expect(adapter).to eq Faraday::Adapter::Patron
+      end
+    end
+
+    unless defined?(JRUBY_VERSION)
+      context 'when the adapter is typhoeus' do
+        let(:client) { described_class.new(adapter: :patron) }
+
+        it 'uses Faraday with the adapter' do
+          expect(adapter).to eq Faraday::Adapter::Patron
+        end
+      end
+    end
+  end
 end

data/spec/enterprise-search/client_spec.rb

@@ -103,4 +103,33 @@ describe Elastic::EnterpriseSearch::Client do
       expect(subject['x-elastic-client-meta']).to match(/^ent=[0-9]+\.[0-9]+\.[0-9]+(p)?,/)
     end
   end
+
+  context 'adapters' do
+    let(:client) { described_class.new }
+    let(:adapter) { client.transport.transport.connections.all.first.connection.builder.adapter }
+
+    context 'when no adapter is specified' do
+      it 'uses Faraday NetHttp' do
+        expect(adapter).to eq Faraday::Adapter::NetHttp
+      end
+    end
+
+    context 'when the adapter is patron' do
+      let(:client) { described_class.new(adapter: :patron) }
+
+      it 'uses Faraday with the adapter' do
+        expect(adapter).to eq Faraday::Adapter::Patron
+      end
+    end
+
+    unless defined?(JRUBY_VERSION)
+      context 'when the adapter is typhoeus' do
+        let(:client) { described_class.new(adapter: :patron) }
+
+        it 'uses Faraday with the adapter' do
+          expect(adapter).to eq Faraday::Adapter::Patron
+        end
+      end
+    end
+  end
 end

data/spec/enterprise-search/request_spec.rb

@@ -32,7 +32,7 @@ describe Elastic::EnterpriseSearch::Client do
       "(RUBY_VERSION: #{RUBY_VERSION}; ",
       "#{RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase} ",
       "#{RbConfig::CONFIG['target_cpu']}; ",
-      "elasticsearch-transport: #{Elasticsearch::Transport::VERSION})"
+      "elastic-transport: #{Elastic::Transport::VERSION})"
     ].join
   end
 

data/spec/integration/app-search/adaptive_relevance_settings_spec.rb

@@ -0,0 +1,60 @@
+# 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 "#{__dir__}/app_search_helper.rb"
+
+describe Elastic::EnterpriseSearch::AppSearch::Client do
+  context 'Adaptive Relevance Settings' do
+    let(:engine_name) { 'relevance-settings' }
+
+    before do
+      create_engine(engine_name)
+      client.put_adaptive_relevance_settings(engine_name, body: { curation: { enabled: true } })
+    end
+
+    after do
+      delete_engines
+    end
+
+    it 'Shows the settings for an engine' do
+      response = client.adaptive_relevance_settings(engine_name)
+
+      expect(response.status).to eq 200
+      expect(response.body['curation'])
+    end
+
+    it 'Updates relevance settings' do
+      body = {
+        curation: { enabled: true }
+      }
+      response = client.put_adaptive_relevance_settings(engine_name, body: body)
+      expect(response.status).to eq 200
+      expect(response.body['curation']['enabled'])
+    end
+
+    it 'Refreshes adaptive relevance update process' do
+      response = client.refresh_adaptive_relevance_update_process(
+        engine_name,
+        adaptive_relevance_suggestion_type: 'curation'
+      )
+      expect(response.status).to eq 200
+      expect(response.body['process']['type']).to eq 'curation'
+    end
+  end
+end

data/spec/integration/app-search/adaptive_relevance_suggestions_spec.rb

@@ -0,0 +1,54 @@
+# 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 "#{__dir__}/app_search_helper.rb"
+
+describe Elastic::EnterpriseSearch::AppSearch::Client do
+  context 'Adaptive Relevance Suggestions' do
+    let(:engine_name) { 'relevance-suggestions' }
+
+    before do
+      create_engine(engine_name)
+      client.put_adaptive_relevance_settings(engine_name, body: { curation: { enabled: true } })
+    end
+
+    after do
+      delete_engines
+    end
+
+    it 'Updates an adaptive relevance suggestion' do
+      body = [{ query: 'forest', type: 'curation', status: 'applied' }]
+      response = client.put_adaptive_relevance_suggestions(engine_name, body: body)
+      expect(response.status).to eq 200
+      expect(response.body['results'].first.keys).to include('query', 'type', 'status')
+    end
+
+    it 'Retrieves an adaptive relevance suggestion' do
+      expect do
+        client.adaptive_relevance_suggestions(engine_name, search_suggestion_query: 'test')
+      end.to raise_error(Elastic::Transport::Transport::Errors::NotFound)
+    end
+
+    it 'Lists adaptive relevance suggestions' do
+      response = client.list_adaptive_relevance_suggestions(engine_name)
+      expect(response.status).to eq 200
+      expect(response.body)
+    end
+  end
+end

data/spec/integration/app-search/api_logs_spec.rb

@@ -21,7 +21,7 @@ require_relative "#{__dir__}/app_search_helper.rb"
 
 describe Elastic::EnterpriseSearch::AppSearch::Client do
   context 'API logs' do
-    let(:engine_name) { 'videogames' }
+    let(:engine_name) { 'api-logs' }
     let(:api_key_name) { 'logs-api-key' }
 
     before do
@@ -44,14 +44,22 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
     end
 
     it 'returns api logs' do
-      response = client.api_logs(engine_name, from_date: Date.today - 1, to_date: Date.today + 1)
+      body = {
+        filters: {
+          date: {
+            from: client.date_to_rfc3339(Date.today - 1),
+            to: client.date_to_rfc3339(Date.today + 1)
+          }
+        }
+      }
+      response = client.api_logs(engine_name, body: body)
       expect(response.status).to eq 200
 
       attempts = 0
       while response.body['results'].count < 1 && attempts < 20
         sleep 1
         attempts += 1
-        response = client.api_logs(engine_name, from_date: Date.today - 1, to_date: Date.today + 1)
+        response = client.api_logs(engine_name, body: body)
       end
       expect(response.body['results'].count).to be >= 1
     end

data/spec/integration/app-search/app_search_helper.rb

@@ -41,8 +41,8 @@ def delete_engines
 end
 
 def create_engine(name)
-  client.create_engine(name: name)
-rescue Elasticsearch::Transport::Transport::Errors::BadRequest => e
+  client.create_engine({ body: { name: name } })
+rescue Elastic::Transport::Transport::Errors::BadRequest => e
   raise e unless e.message.match(/Name is already taken/)
 
   Logger.new($stdout).info("Engine '#{name}' had already been created, giving time for the server to sync.")

data/spec/integration/app-search/count_analytics_spec.rb

@@ -35,13 +35,14 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
       response = client.count_analytics(engine_name)
 
       expect(response.status).to eq 200
-      expect(response.body['results'].count).to be > 1
+
+      expect(response.body['results'])
     end
 
     it 'returns count analytics with filters' do
       response = client.count_analytics(engine_name, body: { filters: { tag: 'web' } })
       expect(response.status).to eq 200
-      expect(response.body['results'].count).to be > 1
+      expect(response.body['results'])
     end
   end
 end

data/spec/integration/app-search/crawler_domain_spec.rb

@@ -68,6 +68,22 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
       expect(response.body).to include('name' => new_name)
     end
 
+    it 'creates and lists crawler domains' do
+      body = { name: name }
+      response = client.create_crawler_domain(engine_name, body: body)
+      @domain = response.body
+
+      expect(response.status).to eq 200
+      expect(response.body['id']).to eq @domain['id']
+      expect(response.body).to include('name' => name)
+
+      response = client.list_crawler_domains(engine_name)
+      expect(response.status).to eq 200
+
+      expect(response.body['results'].count).to eq 1
+      expect(response.body['results'].first['name']).to eq name
+    end
+
     it 'validates a domain' do
       body = { name: name }
       @domain = client.create_crawler_domain(engine_name, body: body).body

data/spec/integration/app-search/curations_spec.rb

@@ -44,7 +44,7 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
       expect(response.status).to eq 200
       expect(response.body['id']).to match(/cur-[0-9a-f]+/)
 
-      response = client.search(engine_name, query: 'jungle')
+      response = client.search(engine_name, body: { 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'
@@ -65,9 +65,11 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
     def create_curation(name, query, promoted_id, hidden_id)
       response = client.create_curation(
         name,
-        queries: [query],
-        promoted: [promoted_id],
-        hidden: [hidden_id]
+        body: {
+          queries: [query],
+          promoted: [promoted_id],
+          hidden: [hidden_id]
+        }
       )
       # Give the server a second
       sleep 1
@@ -79,16 +81,20 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
 
       response = client.put_curation(
         engine_name,
-        curation_id: id,
-        queries: ['jungle'],
-        promoted: [@hidden['id']],
-        hidden: [@promoted['id']]
+        {
+          curation_id: id,
+          body: {
+            queries: ['jungle'],
+            promoted: [@hidden['id']],
+            hidden: [@promoted['id']]
+          }
+        }
       )
 
       expect(response.status).to eq 200
       expect(response.body['id']).to match(/cur-[0-9a-f]+/)
 
-      response = @client.search(engine_name, query: 'jungle')
+      response = @client.search(engine_name, body: { 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'

data/spec/integration/app-search/engines_spec.rb

@@ -22,54 +22,52 @@ require_relative "#{__dir__}/app_search_helper.rb"
 describe Elastic::EnterpriseSearch::AppSearch::Client do
   context 'Engines' do
     let(:engine_name) { 'test-create-engines' }
+    let(:engine_response) do
+      {
+        'type' => 'default',
+        'language' => nil,
+        'document_count' => 0,
+        'index_create_settings_override' => {}
+      }
+    end
 
     after do
       delete_engines
     end
 
     it 'creates a new engine' do
-      response = client.create_engine(name: engine_name)
+      response = client.create_engine({ body: { name: engine_name } })
 
       expect(response.status).to eq 200
-      expect(response.body).to eq(
-        {
-          'name' => engine_name,
-          'type' => 'default',
-          'language' => nil,
-          'document_count' => 0
-        }
-      )
+      expect(response.body).to eq(engine_response.merge({ 'name' => engine_name }))
     end
 
     it 'lists engines' do
-      client.create_engine(name: 'engine1')
-      client.create_engine(name: 'engine2')
+      client.create_engine({ body: { name: 'engine1' } })
+      client.create_engine({ body: { name: 'engine2' } })
 
       response = client.list_engines
       expect(response.status).to eq 200
 
       expect(response.body.dig('meta', 'page', 'total_results')).to eq 2
-      expect(response.body['results']).to include(
-        { 'name' => 'engine1', 'type' => 'default', 'language' => nil, 'document_count' => 0 }
-      )
-      expect(response.body['results']).to include(
-        { 'name' => 'engine2', 'type' => 'default', 'language' => nil, 'document_count' => 0 }
-      )
+      expect(response.body['results']).to include(engine_response.merge({ 'name' => 'engine1' }))
+      expect(response.body['results']).to include(engine_response.merge({ 'name' => 'engine2' }))
     end
 
-    it 'retrieves an engine by name' do
-      engine_name = 'retrieve-engine'
-      client.create_engine(name: engine_name)
-      response = client.engine(engine_name)
-      expect(response.status).to eq 200
-      expect(response.body).to eq(
-        { 'name' => engine_name, 'type' => 'default', 'language' => nil, 'document_count' => 0 }
-      )
+    context 'get engines' do
+      let(:engine_name) { 'retrieve-engine' }
+      it 'retrieves an engine by name' do
+        engine_name = 'retrieve-engine'
+        client.create_engine({ body: { name: engine_name } })
+        response = client.engine(engine_name)
+        expect(response.status).to eq 200
+        expect(response.body).to eq(engine_response.merge({ 'name' => engine_name }))
+      end
     end
 
     it 'deletes an engine' do
       engine_name = 'delete-engine'
-      client.create_engine(name: engine_name)
+      client.create_engine({ body: { name: engine_name } })
       response = client.delete_engine(engine_name)
       expect(response.status).to eq 200
       expect(response.body).to eq({ 'deleted' => true })

data/spec/integration/app-search/log_clickthrough_spec.rb

@@ -21,7 +21,7 @@ require_relative "#{__dir__}/app_search_helper.rb"
 
 describe Elastic::EnterpriseSearch::AppSearch::Client do
   context 'Log Click through' do
-    let(:engine_name) { 'videogames' }
+    let(:engine_name) { 'log-click-through' }
 
     before do
       create_engine(engine_name)

data/spec/integration/app-search/meta_engines_spec.rb

@@ -28,12 +28,12 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
         type: 'meta',
         source_engines: ['books', 'videogames']
       }
-      client.create_engine(name: engine_name, body: body)
+      client.create_engine(body: body)
     end
 
     before do
-      client.create_engine(name: 'books')
-      client.create_engine(name: 'videogames')
+      client.create_engine({ body: { name: 'books' } })
+      client.create_engine({ body: { name: 'videogames' } })
     end
 
     after do
@@ -51,7 +51,7 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
     it 'adds a new source engine to a meta engine' do
       create_meta_engine
       # Create new source engine to add:
-      client.create_engine(name: 'add-source')
+      client.create_engine({ body: { name: 'add-source' } })
       response = client.add_meta_engine_source(engine_name, source_engines: ['add-source'])
 
       expect(response.status).to eq 200
@@ -62,7 +62,7 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
 
     it 'removes a source engine from a meta engine' do
       create_meta_engine
-      client.create_engine(name: 'remove-source')
+      client.create_engine({ body: { name: 'remove-source' } })
       client.add_meta_engine_source(engine_name, source_engines: ['remove-source'])
       response = client.delete_meta_engine_source(engine_name, source_engines: ['remove-source'])
 

data/spec/integration/app-search/search_and_multiple_search_spec.rb

@@ -44,7 +44,7 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
 
   context 'search' do
     it 'performs a single query search' do
-      response = client.search(engine_name, query: 'Ibarbourou')
+      response = client.search(engine_name, body: { query: 'Ibarbourou' })
       expect(response.status).to eq 200
       expect(response.body).not_to be nil
       expect(response.body['results'].count).to be 1

data/spec/integration/workplace-search/content_sources_spec.rb

@@ -27,7 +27,7 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client 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')
+      response = client.create_content_source(body: { name: 'test' })
       expect(response.status).to eq 200
       expect(response.body['id'])
       id = response.body['id']
@@ -47,7 +47,7 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
     end
 
     it 'creates and updates' do
-      response = client.create_content_source(name: 'ruby_client_app')
+      response = client.create_content_source(body: { name: 'ruby_client_app' })
       expect(response.status).to eq 200
       id = response.body['id']
 
@@ -71,7 +71,7 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
     end
 
     it 'syncs jobs' do
-      response = client.create_content_source(name: 'sync_jobs_test')
+      response = client.create_content_source(body: { name: 'sync_jobs_test' })
       expect(response.status).to eq 200
       id = response.body['id']
 
@@ -81,19 +81,19 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
     end
 
     context 'icons' do
-      let(:content_source_id) { client.create_content_source(name: 'with-icon').body['id'] }
+      let(:content_source_id) { client.create_content_source(body: { name: 'with-icon' }).body['id'] }
 
       it 'puts an icon' do
         path = File.expand_path("#{File.dirname(__FILE__)}/icon.png")
         icon = Base64.strict_encode64(File.read(path))
-        response = client.put_content_source_icons(content_source_id, main_icon: icon, alt_icon: icon)
+        response = client.put_content_source_icons(content_source_id, body: { main_icon: icon, alt_icon: icon })
         expect(response.status).to eq 200
         expect(response.body['results']).to eq({ 'main_icon' => 'success', 'alt_icon' => 'success' })
       end
     end
 
     context 'auto query refinements details' do
-      let(:content_source_id) { client.create_content_source(name: 'refinements').body['id'] }
+      let(:content_source_id) { client.create_content_source(body: { name: 'refinements' }).body['id'] }
 
       it 'retrieves details' do
         response = client.auto_query_refinement_details(content_source_id)

data/spec/integration/workplace-search/documents_spec.rb

@@ -43,7 +43,7 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
 
   context 'Documents' do
     let(:content_source_id) do
-      client.create_content_source(name: 'test').body['id']
+      client.create_content_source(body: { name: 'test' }).body['id']
     end
 
     it 'indexes' do
@@ -58,7 +58,7 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
   end
 
   context 'Documents in Content Sources' do
-    let(:content_source_id) { client.create_content_source(name: 'books').body['id'] }
+    let(:content_source_id) { client.create_content_source(body: { 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
@@ -67,20 +67,13 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
       expect(response.body['id']).to eq document_id
     end
 
-    it 'Lists documents in a content source' do
-      response = client.list_documents(content_source_id)
-      expect(response.status).to eq 200
-      expect(response.body['results'])
-      expect(response.body['meta'])
-    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
 
     it 'Deletes documents by query' do
-      content_source_id = client.create_content_source(name: 'asimov').body['id']
+      content_source_id = client.create_content_source(body: { name: 'asimov' }).body['id']
       documents = [
         { title: 'Foundation', year: 1951 },
         { title: 'Foundation and Empire', year: 1952 },
@@ -98,5 +91,22 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
       expect(response.status).to eq 200
       expect(response.body).to eq({ 'total' => 3, 'deleted' => 3, 'failures' => [] })
     end
+
+    it 'Lists documents' do
+      content_source_id = client.create_content_source(body: { name: 'quiroga' }).body['id']
+      documents = [
+        { title: 'Stories of Love, Madness and Death', year: 1917 },
+        { title: 'Drifting', year: 1937 },
+        { title: 'The Beheaded Hen', year: 1925 }
+      ]
+      client.index_documents(content_source_id, documents: documents)
+      # Give time to index the documents
+      sleep 2
+
+      response = client.list_documents(content_source_id)
+      expect(response.status).to eq 200
+      expect(response.body['results'].count).to eq 3
+      expect(response.body['results'].map { |a| a['year'] }).to eq ['1917', '1937', '1925']
+    end
   end
 end