elastic-enterprise-search 7.12.1 → 7.15.0

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

@@ -0,0 +1,81 @@
+# 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 'Crawler scheduling' do
+    let(:engine_name) { 'crawler-scheduling' }
+    let(:body) { { frequency: 1, unit: 'day' } }
+    let(:name) { 'https://www.elastic.co' }
+
+    before do
+      attempts = 0
+      loop do
+        attempts += 1
+        client.create_engine(name: engine_name)
+        break if attempts > 9
+      rescue Elasticsearch::Transport::Transport::Errors::BadRequest => e
+        if e.message.match?(/Name is already taken/)
+          sleep 1
+          next
+        end
+      else
+        break
+      end
+      body = { name: name }
+      response = client.create_crawler_domain(engine_name, body: body)
+      @domain = response.body
+    end
+
+    after do
+      client.delete_engine(engine_name)
+    end
+
+    it 'sets a crawl schedule' do
+      response = client.put_crawler_crawl_schedule(engine_name, body: body)
+      expect(response.status).to eq 200
+      expect(response.body).to eq({
+                                    'engine' => engine_name,
+                                    'frequency' => 1,
+                                    'unit' => 'day'
+                                  })
+    end
+
+    it 'gets the crawl schedule' do
+      client.put_crawler_crawl_schedule(engine_name, body: body)
+
+      response = client.crawler_crawl_schedule(engine_name)
+      expect(response.status).to eq 200
+      expect(response.body).to eq({
+                                    'engine' => engine_name,
+                                    'frequency' => 1,
+                                    'unit' => 'day'
+                                  })
+    end
+
+    it 'deletes a crawler crawl schedule' do
+      client.put_crawler_crawl_schedule(engine_name, body: body)
+
+      response = client.delete_crawler_crawl_schedule(engine_name)
+      expect(response.status).to eq 200
+      expect(response.body).to eq({ 'deleted' => true })
+    end
+  end
+end

data/spec/integration/app-search/crawler_sitemap_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 "#{__dir__}/app_search_helper.rb"
+
+describe Elastic::EnterpriseSearch::AppSearch::Client do
+  context 'Crawler Sitemap' do
+    let(:engine_name) { 'crawler-sitemap' }
+    let(:name) { 'https://www.elastic.co' }
+
+    before do
+      client.create_engine(name: engine_name)
+      body = { name: name }
+      response = client.create_crawler_domain(engine_name, body: body)
+      @domain = response.body
+    end
+
+    after do
+      client.delete_engine(engine_name)
+    end
+
+    it 'creates, updates and deletes a crawler sitemap configuration' do
+      # Create a sitemap
+      sitemap_url = 'https://www.elastic.co/sitemap.xml'
+      body = { url: sitemap_url }
+      response = client.create_crawler_sitemap(engine_name, domain_id: @domain['id'], body: body)
+      expect(response.status).to eq 200
+      expect(response.body.keys).to eq(['id', 'url', 'created_at'])
+      expect(response.body['url']).to eq(sitemap_url)
+
+      # Update a sitemap
+      sitemap_id = response.body['id']
+      sitemap_url = 'https://www.elastic.co/sitemap2.xml'
+      body = { url: sitemap_url }
+      response = client.put_crawler_sitemap(
+        engine_name,
+        domain_id: @domain['id'],
+        sitemap_id: sitemap_id,
+        body: body
+      )
+      expect(response.status).to eq 200
+      expect(response.body.keys).to eq(['id', 'url', 'created_at'])
+      expect(response.body['url']).to eq(sitemap_url)
+
+      # Delete sitemap
+      response = client.delete_crawler_sitemap(
+        engine_name,
+        domain_id: @domain['id'],
+        sitemap_id: sitemap_id
+      )
+
+      expect(response.status).to eq 200
+      expect(response.body).to eq({ 'deleted' => true })
+    end
+  end
+end

data/spec/integration/app-search/crawler_urls_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 'Crawler URLs' do
+    let(:engine_name) { 'crawler-urls' }
+    let(:name) { 'https://www.elastic.co' }
+
+    before do
+      client.create_engine(name: engine_name)
+      body = { name: name }
+      response = client.create_crawler_domain(engine_name, body: body)
+      @domain = response.body
+    end
+
+    after do
+      client.delete_engine(engine_name)
+      sleep 1
+    end
+
+    it 'validates a URL' do
+      response = client.crawler_url_validation_result(engine_name, url: name)
+      expect(response.status).to eq 200
+      expect(response.body['url']).to eq name
+      expect(response.body['valid']).to eq true
+    end
+
+    it 'extracts content from a URL' do
+      response = client.crawler_url_extraction_result(engine_name, url: name)
+      expect(response.status).to eq 200
+      expect(response.body.keys).to eq(['url', 'normalized_url', 'results'])
+    end
+
+    it 'traces history for a crawler URL' do
+      response = client.crawler_url_tracing_result(engine_name, url: name)
+      expect(response.status).to eq 200
+      expect(response.body['url']).to eq name
+      expect(response.body['normalized_url']).to eq "#{name}/"
+      expect(response.body['crawl_requests'])
+    end
+  end
+end

data/spec/{app-search/api_count_analytics_spec.rb → integration/app-search/crawler_user_agent_spec.rb}

@@ -17,18 +17,15 @@
 
 # frozen_string_literal: true
 
-require 'spec_helper'
-require_relative './api_spec_helper'
+require_relative "#{__dir__}/app_search_helper.rb"
 
 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')
+  context 'Crawler User Agent' do
+    it 'retrieves the user-agent header value for the crawler' do
+      response = client.crawler_user_agent
 
-        expect(response.status).to eq 200
-        expect(response.body['results'].count).to be > 1
-      end
+      expect(response.status).to eq 200
+      expect(response.body['user_agent']).to match(/Elastic-Crawler\ \([0-9.]+\)/)
     end
   end
 end

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

@@ -0,0 +1,118 @@
+# 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 'Curations' do
+    let(:engine_name) { 'books' }
+
+    before do
+      client.create_engine(name: engine_name)
+      documents = [
+        { title: 'Jungle Tales', author: 'Horacio Quiroga' },
+        { title: 'The Jungle Book', author: 'Rudyard Kipling' }
+      ]
+      response = client.index_documents(engine_name, documents: documents)
+
+      @promoted = response.body.first
+      @hidden = response.body.last
+    end
+    after do
+      client.delete_engine(engine_name)
+      sleep 1
+    end
+
+    it 'creates a new curation' do
+      response = create_curation(engine_name, 'jungle', @promoted['id'], @hidden['id'])
+      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
+
+    it 'retrieves a curation by id' do
+      id = create_curation(engine_name, 'book', @promoted['id'], @hidden['id']).body['id']
+
+      response = client.curation(engine_name, curation_id: id)
+
+      expect(response.status).to eq 200
+      expect(response.body['id']).to match(/cur-[0-9a-f]+/)
+      expect(response.body['queries']).to eq ['book']
+      expect(response.body['promoted']).to eq [@promoted['id']]
+      expect(response.body['hidden']).to eq [@hidden['id']]
+    end
+
+    def create_curation(name, query, promoted_id, hidden_id)
+      response = client.create_curation(
+        name,
+        queries: [query],
+        promoted: [promoted_id],
+        hidden: [hidden_id]
+      )
+      # Give the server a second
+      sleep 1
+      response
+    end
+
+    it 'updates an existing curation' do
+      id = create_curation(engine_name, 'jungle', @promoted['id'], @hidden['id']).body['id']
+
+      response = client.put_curation(
+        engine_name,
+        curation_id: id,
+        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')
+      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
+
+    it 'lists curations' do
+      create_curation(engine_name, 'jungle', @promoted['id'], @hidden['id']).body['id']
+      create_curation(engine_name, 'book', @promoted['id'], @hidden['id']).body['id']
+      create_curation(engine_name, 'tales', @promoted['id'], @hidden['id']).body['id']
+
+      response = client.list_curations(engine_name)
+
+      expect(response.status).to eq 200
+      expect(response.body['results'].count).to eq 3
+      curation = response.body['results'].first
+      expect(curation['id']).to match(/cur-[0-9a-f]+/)
+    end
+
+    it 'deletes a  curation' do
+      id = create_curation(engine_name, 'jungle', @promoted['id'], @hidden['id']).body['id']
+      response = client.delete_curation(engine_name, curation_id: id)
+
+      expect(response.status).to eq 200
+      expect(response.body).to eq({ 'deleted' => true })
+    end
+  end
+end

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

@@ -0,0 +1,123 @@
+# 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 'documents' do
+    let(:engine_name) { 'documents' }
+    let(:documents) do
+      [
+        { name: 'Super Lorenzo Bros', year: '1985' },
+        { name: 'Pack-Man', year: '1980' },
+        { name: 'Galaxxian', year: '1979' },
+        { name: 'Audiovisual, the hedgehog', year: '1991' }
+      ]
+    end
+
+    before do
+      client.create_engine(name: engine_name)
+    end
+
+    after do
+      delete_engines
+    end
+
+    def extract_from_key(key)
+      ->(h) { h[key] }
+    end
+
+    it 'indexes and lists documents' do
+      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']]
+
+      response = client.list_documents(engine_name)
+      attempts = 0
+      while response.body['results'].count < 1 && attempts < 20
+        sleep 1
+        attempts += 1
+        response = client.list_documents(engine_name)
+      end
+
+      expect(response.status).to eq 200
+      expect(response.body['results'].count).to eq 4
+    end
+
+    it 'retrieves documents by ID' do
+      response = client.index_documents(engine_name, documents: documents)
+      ids = response.body.map(&->(h) { h['id'] })
+
+      attempts = 0
+      while client.list_documents(engine_name).body['results'].count < 4 && attempts < 20
+        sleep 1
+        attempts += 1
+      end
+
+      response = client.documents(engine_name, document_ids: ids)
+
+      expect(response.status).to eq 200
+      expect(response.body.count).to eq 4
+      expect(
+        response.body.map(&extract_from_key('name')) - documents.map(&extract_from_key(:name))
+      ).to be_empty
+    end
+
+    it 'searches for a document' do
+      client.index_documents(engine_name, documents: documents)
+
+      response = client.search(engine_name, body: { query: 'Pack-Man' })
+      attempts = 0
+      while response.body['results'].count < 1 && attempts < 20
+        sleep 1
+        attempts += 1
+        response = client.search(engine_name, body: { query: 'Pack-Man' })
+      end
+      expect(response.status).to eq 200
+      expect(response.body['meta']['engine']).to eq({ 'name' => engine_name, 'type' => 'default' })
+      expect(response.body['results'].first['name']).to eq({ 'raw' => 'Pack-Man' })
+      expect(response.body['results'].first['year']).to eq({ 'raw' => '1980' })
+    end
+
+    it 'deletes a document' do
+      document = { name: 'Celda', 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
+
+    it 'updates a document' do
+      document = { name: 'Al*bert', year: 1983 }
+      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: 1982 }])
+      expect(response.status).to eq 200
+      expect(response.body).to eq [{ 'id' => id, 'errors' => [] }]
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# 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 'Engines' do
+    let(:engine_name) { 'test-create-engines' }
+
+    after do
+      delete_engines
+    end
+
+    it 'creates a new engine' do
+      response = client.create_engine(name: engine_name)
+
+      expect(response.status).to eq 200
+      expect(response.body).to eq(
+        {
+          'name' => engine_name,
+          'type' => 'default',
+          'language' => nil,
+          'document_count' => 0
+        }
+      )
+    end
+
+    it 'lists engines' do
+      client.create_engine(name: 'engine1')
+      client.create_engine(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 }
+      )
+    end
+
+    it 'retrieves an engine by name' do
+      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 }
+      )
+    end
+
+    it 'deletes an engine' do
+      client.create_engine(name: engine_name)
+      response = client.delete_engine(engine_name)
+      expect(response.status).to eq 200
+      expect(response.body).to eq({ 'deleted' => true })
+    end
+  end
+end

data/spec/{app-search/api_log_clickthrough_spec.rb → integration/app-search/log_clickthrough_spec.rb}

@@ -17,18 +17,25 @@
 
 # frozen_string_literal: true
 
-require_relative './api_spec_helper'
+require_relative "#{__dir__}/app_search_helper.rb"
 
 describe Elastic::EnterpriseSearch::AppSearch::Client do
-  context 'api_log_clickthrough' do
-    let(:engine_name) { 'films' }
+  context 'Log Click through' do
+    let(:engine_name) { 'videogames' }
+
+    before do
+      client.create_engine(name: engine_name)
+    end
+
+    after do
+      client.delete_engine(engine_name)
+    end
 
     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')
+      body = { query: 'moon', document_id: 'doc_id' }
+      response = client.log_clickthrough(engine_name, body: body)
 
-        expect(response.status).to eq 200
-      end
+      expect(response.status).to eq 200
     end
   end
 end

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

@@ -0,0 +1,75 @@
+# 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 'Meta Engines' do
+    let(:engine_name) { 'new-meta-engine' }
+    let(:create_meta_engine) do
+      body = {
+        name: engine_name,
+        type: 'meta',
+        source_engines: ['books', 'videogames']
+      }
+      client.create_engine(name: engine_name, body: body)
+    end
+
+    before do
+      client.create_engine(name: 'books')
+      client.create_engine(name: 'videogames')
+    end
+
+    after do
+      delete_engines
+    end
+
+    it 'creates a meta engine' do
+      response = create_meta_engine
+      expect(response.status).to eq 200
+      expect(response.body['name']).to eq(engine_name)
+      expect(response.body['type']).to eq('meta')
+      expect(response.body['source_engines'].sort).to eq(['books', 'videogames'])
+    end
+
+    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')
+      response = client.add_meta_engine_source(engine_name, source_engines: ['add-source'])
+
+      expect(response.status).to eq 200
+      expect(response.body['name']).to eq(engine_name)
+      expect(response.body['type']).to eq('meta')
+      expect(response.body['source_engines'].sort).to eq(['add-source', 'books', 'videogames'])
+    end
+
+    it 'removes a source engine from a meta engine' do
+      create_meta_engine
+      client.create_engine(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'])
+
+      expect(response.status).to eq 200
+      expect(response.body['name']).to eq(engine_name)
+      expect(response.body['type']).to eq('meta')
+      expect(response.body['source_engines'].sort).to eq(['books', 'videogames'])
+    end
+  end
+end