elastic-enterprise-search 7.16.0 → 8.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.ci/jobs/elastic+enterprise-search-ruby+7.13.yml +12 -0
- data/.ci/jobs/elastic+enterprise-search-ruby+7.14.yml +12 -0
- data/.ci/jobs/elastic+enterprise-search-ruby+7.15.yml +12 -0
- data/.ci/jobs/elastic+enterprise-search-ruby+7.16.yml +12 -0
- data/.ci/test-matrix.yml +2 -3
- data/.github/workflows/testing.yml +3 -3
- data/.rubocop.yml +1 -1
- data/CHANGELOG +1 -0
- data/CODE_OF_CONDUCT +1 -0
- data/CONTRIBUTING.md +37 -0
- data/NOTICE +2 -0
- data/README.md +25 -29
- data/docs/guide/app-search-api.asciidoc +39 -31
- data/docs/guide/overview.asciidoc +11 -3
- data/docs/guide/release_notes/712.asciidoc +10 -0
- data/docs/guide/release_notes/714.asciidoc +0 -12
- data/docs/guide/release_notes/715.asciidoc +0 -12
- data/docs/guide/release_notes/717.asciidoc +9 -0
- data/docs/guide/release_notes/80.asciidoc +117 -0
- data/docs/guide/release_notes/index.asciidoc +6 -0
- data/docs/guide/workplace-search-api.asciidoc +14 -7
- data/elastic-enterprise-search.gemspec +3 -3
- data/lib/elastic/api/response.rb +52 -0
- data/lib/elastic/app-search/api/adaptive_relevance_settings.rb +3 -6
- data/lib/elastic/app-search/api/adaptive_relevance_suggestions.rb +10 -6
- data/lib/elastic/app-search/api/add_meta_engine_source.rb +4 -5
- data/lib/elastic/app-search/api/api_key.rb +4 -6
- data/lib/elastic/app-search/api/api_logs.rb +8 -15
- data/lib/elastic/app-search/api/count_analytics.rb +5 -5
- data/lib/elastic/app-search/api/crawler_active_crawl_request.rb +4 -7
- data/lib/elastic/app-search/api/crawler_crawl_request.rb +6 -8
- data/lib/elastic/app-search/api/crawler_crawl_schedule.rb +4 -7
- data/lib/elastic/app-search/api/crawler_domain.rb +6 -8
- data/lib/elastic/app-search/api/crawler_domain_validation_result.rb +5 -4
- data/lib/elastic/app-search/api/crawler_metrics.rb +3 -6
- data/lib/elastic/app-search/api/crawler_overview.rb +4 -7
- data/lib/elastic/app-search/api/crawler_process_crawl.rb +6 -8
- data/lib/elastic/app-search/api/crawler_process_crawl_denied_urls.rb +6 -8
- data/lib/elastic/app-search/api/crawler_url_extraction_result.rb +6 -6
- data/lib/elastic/app-search/api/crawler_url_tracing_result.rb +6 -5
- data/lib/elastic/app-search/api/crawler_url_validation_result.rb +6 -5
- data/lib/elastic/app-search/api/crawler_user_agent.rb +3 -6
- data/lib/elastic/app-search/api/create_api_key.rb +10 -10
- data/lib/elastic/app-search/api/create_crawler_crawl_request.rb +9 -5
- data/lib/elastic/app-search/api/create_crawler_crawl_rule.rb +13 -12
- data/lib/elastic/app-search/api/create_crawler_domain.rb +8 -8
- data/lib/elastic/app-search/api/create_crawler_entry_point.rb +10 -9
- data/lib/elastic/app-search/api/create_crawler_process_crawl.rb +6 -6
- data/lib/elastic/app-search/api/create_crawler_sitemap.rb +10 -9
- data/lib/elastic/app-search/api/create_curation.rb +10 -9
- data/lib/elastic/app-search/api/create_engine.rb +8 -7
- data/lib/elastic/app-search/api/create_synonym_set.rb +6 -6
- data/lib/elastic/app-search/api/curation.rb +5 -7
- data/lib/elastic/app-search/api/delete_api_key.rb +4 -6
- data/lib/elastic/app-search/api/delete_crawler_active_crawl_request.rb +4 -7
- data/lib/elastic/app-search/api/delete_crawler_crawl_rule.rb +7 -9
- data/lib/elastic/app-search/api/delete_crawler_crawl_schedule.rb +4 -7
- data/lib/elastic/app-search/api/delete_crawler_domain.rb +6 -8
- data/lib/elastic/app-search/api/delete_crawler_entry_point.rb +7 -9
- data/lib/elastic/app-search/api/delete_crawler_sitemap.rb +7 -9
- data/lib/elastic/app-search/api/delete_curation.rb +5 -7
- data/lib/elastic/app-search/api/delete_documents.rb +4 -5
- data/lib/elastic/app-search/api/delete_engine.rb +3 -6
- data/lib/elastic/app-search/api/delete_meta_engine_source.rb +4 -4
- data/lib/elastic/app-search/api/delete_synonym_set.rb +5 -7
- data/lib/elastic/app-search/api/documents.rb +5 -5
- data/lib/elastic/app-search/api/engine.rb +3 -6
- data/lib/elastic/app-search/api/index_documents.rb +4 -5
- data/lib/elastic/app-search/api/list_adaptive_relevance_suggestions.rb +4 -4
- data/lib/elastic/app-search/api/list_api_keys.rb +2 -5
- data/lib/elastic/app-search/api/list_crawler_crawl_requests.rb +6 -8
- data/lib/elastic/app-search/api/list_crawler_domains.rb +6 -7
- data/lib/elastic/app-search/api/list_crawler_process_crawls.rb +6 -7
- data/lib/elastic/app-search/api/list_curations.rb +3 -6
- data/lib/elastic/app-search/api/list_documents.rb +3 -6
- data/lib/elastic/app-search/api/list_engines.rb +2 -5
- data/lib/elastic/app-search/api/list_synonym_sets.rb +3 -6
- data/lib/elastic/app-search/api/log_clickthrough.rb +9 -8
- data/lib/elastic/app-search/api/put_adaptive_relevance_settings.rb +6 -5
- data/lib/elastic/app-search/api/put_adaptive_relevance_suggestions.rb +4 -4
- data/lib/elastic/app-search/api/put_api_key.rb +11 -10
- data/lib/elastic/app-search/api/put_crawler_crawl_rule.rb +14 -13
- data/lib/elastic/app-search/api/put_crawler_crawl_schedule.rb +8 -7
- data/lib/elastic/app-search/api/put_crawler_domain.rb +9 -9
- data/lib/elastic/app-search/api/put_crawler_entry_point.rb +11 -10
- data/lib/elastic/app-search/api/put_crawler_sitemap.rb +11 -10
- data/lib/elastic/app-search/api/put_curation.rb +11 -10
- data/lib/elastic/app-search/api/put_documents.rb +4 -4
- data/lib/elastic/app-search/api/put_schema.rb +4 -4
- data/lib/elastic/app-search/api/put_search_settings.rb +6 -6
- data/lib/elastic/app-search/api/put_synonym_set.rb +8 -8
- data/lib/elastic/app-search/api/query_suggestion.rb +5 -5
- data/lib/elastic/app-search/api/refresh_adaptive_relevance_update_process.rb +56 -0
- data/lib/elastic/app-search/api/reset_search_settings.rb +3 -6
- data/lib/elastic/app-search/api/schema.rb +3 -6
- data/lib/elastic/app-search/api/search.rb +6 -5
- data/lib/elastic/app-search/api/search_settings.rb +3 -6
- data/lib/elastic/app-search/api/synonym_set.rb +5 -7
- data/lib/elastic/app-search/api/top_clicks_analytics.rb +5 -5
- data/lib/elastic/app-search/api/top_queries_analytics.rb +4 -4
- data/lib/elastic/enterprise-search/api/health.rb +2 -3
- data/lib/elastic/enterprise-search/api/put_read_only.rb +6 -4
- data/lib/elastic/enterprise-search/api/read_only.rb +2 -3
- data/lib/elastic/enterprise-search/api/stats.rb +2 -3
- data/lib/elastic/enterprise-search/api/version.rb +2 -3
- data/lib/elastic/enterprise-search/client.rb +8 -13
- data/lib/elastic/enterprise-search/request.rb +5 -3
- data/lib/elastic/enterprise-search/version.rb +1 -1
- data/lib/elastic/workplace-search/api/auto_query_refinement_details.rb +3 -4
- data/lib/elastic/workplace-search/api/command_sync_jobs.rb +4 -5
- data/lib/elastic/workplace-search/api/content_source.rb +3 -4
- data/lib/elastic/workplace-search/api/create_analytics_event.rb +16 -12
- data/lib/elastic/workplace-search/api/create_batch_synonym_sets.rb +4 -3
- data/lib/elastic/workplace-search/api/create_content_source.rb +6 -5
- data/lib/elastic/workplace-search/api/create_external_identity.rb +11 -6
- data/lib/elastic/workplace-search/api/current_user.rb +3 -5
- data/lib/elastic/workplace-search/api/delete_content_source.rb +3 -4
- data/lib/elastic/workplace-search/api/delete_documents.rb +4 -4
- data/lib/elastic/workplace-search/api/delete_documents_by_query.rb +4 -3
- data/lib/elastic/workplace-search/api/delete_external_identity.rb +7 -9
- data/lib/elastic/workplace-search/api/delete_synonym_set.rb +3 -5
- data/lib/elastic/workplace-search/api/document.rb +4 -6
- data/lib/elastic/workplace-search/api/external_identity.rb +7 -9
- data/lib/elastic/workplace-search/api/index_documents.rb +3 -4
- data/lib/elastic/workplace-search/api/list_content_sources.rb +2 -3
- data/lib/elastic/workplace-search/api/list_documents.rb +4 -5
- data/lib/elastic/workplace-search/api/list_external_identities.rb +3 -4
- data/lib/elastic/workplace-search/api/list_synonym_sets.rb +1 -2
- data/lib/elastic/workplace-search/api/put_content_source.rb +6 -6
- data/lib/elastic/workplace-search/api/put_content_source_icons.rb +6 -6
- data/lib/elastic/workplace-search/api/put_external_identity.rb +11 -10
- data/lib/elastic/workplace-search/api/put_synonym_set.rb +4 -4
- data/lib/elastic/workplace-search/api/put_triggers_blocklist.rb +3 -5
- data/lib/elastic/workplace-search/api/search.rb +13 -13
- data/lib/elastic/workplace-search/api/synonym_set.rb +3 -5
- data/lib/elastic/workplace-search/api/triggers_blocklist.rb +3 -3
- data/spec/app-search/client_spec.rb +29 -0
- data/spec/enterprise-search/client_spec.rb +29 -0
- data/spec/enterprise-search/request_spec.rb +1 -1
- data/spec/integration/app-search/adaptive_relevance_settings_spec.rb +60 -0
- data/spec/integration/app-search/adaptive_relevance_suggestions_spec.rb +54 -0
- data/spec/integration/app-search/api_logs_spec.rb +11 -3
- data/spec/integration/app-search/app_search_helper.rb +2 -2
- data/spec/integration/app-search/count_analytics_spec.rb +3 -2
- data/spec/integration/app-search/crawler_domain_spec.rb +17 -6
- data/spec/integration/app-search/curations_spec.rb +15 -9
- data/spec/integration/app-search/engines_spec.rb +24 -26
- data/spec/integration/app-search/log_clickthrough_spec.rb +1 -1
- data/spec/integration/app-search/meta_engines_spec.rb +5 -5
- data/spec/integration/app-search/search_and_multiple_search_spec.rb +1 -1
- data/spec/integration/workplace-search/content_sources_spec.rb +6 -6
- data/spec/integration/workplace-search/documents_spec.rb +20 -10
- data/spec/integration/workplace-search/external_identities_spec.rb +26 -16
- data/spec/integration/workplace-search/triggers_spec.rb +2 -2
- data/spec/integration/workplace-search/users_spec.rb +0 -6
- data/spec/workplace-search/client_spec.rb +29 -0
- metadata +24 -21
- data/.ci/jobs/elastic+enterprise-search-ruby+7.10.0.beta.1.yml +0 -12
- data/.github/compatibility/Gemfile +0 -23
- data/.github/workflows/compatibility.yml +0 -20
- data/lib/elastic/workplace-search/api/add_user_permissions.rb +0 -54
- data/lib/elastic/workplace-search/api/list_permissions.rb +0 -51
- data/lib/elastic/workplace-search/api/put_user_permissions.rb +0 -54
- data/lib/elastic/workplace-search/api/remove_user_permissions.rb +0 -54
- data/lib/elastic/workplace-search/api/user_permissions.rb +0 -53
- data/spec/integration/app-search/adaptive_relevance_spec.rb +0 -80
- data/spec/integration/workplace-search/permissions_spec.rb +0 -77
@@ -21,7 +21,7 @@ require_relative "#{__dir__}/app_search_helper.rb"
|
|
21
21
|
|
22
22
|
describe Elastic::EnterpriseSearch::AppSearch::Client do
|
23
23
|
context 'API logs' do
|
24
|
-
let(:engine_name) { '
|
24
|
+
let(:engine_name) { 'api-logs' }
|
25
25
|
let(:api_key_name) { 'logs-api-key' }
|
26
26
|
|
27
27
|
before do
|
@@ -44,14 +44,22 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
|
|
44
44
|
end
|
45
45
|
|
46
46
|
it 'returns api logs' do
|
47
|
-
|
47
|
+
body = {
|
48
|
+
filters: {
|
49
|
+
date: {
|
50
|
+
from: client.date_to_rfc3339(Date.today - 1),
|
51
|
+
to: client.date_to_rfc3339(Date.today + 1)
|
52
|
+
}
|
53
|
+
}
|
54
|
+
}
|
55
|
+
response = client.api_logs(engine_name, body: body)
|
48
56
|
expect(response.status).to eq 200
|
49
57
|
|
50
58
|
attempts = 0
|
51
59
|
while response.body['results'].count < 1 && attempts < 20
|
52
60
|
sleep 1
|
53
61
|
attempts += 1
|
54
|
-
response = client.api_logs(engine_name,
|
62
|
+
response = client.api_logs(engine_name, body: body)
|
55
63
|
end
|
56
64
|
expect(response.body['results'].count).to be >= 1
|
57
65
|
end
|
@@ -41,8 +41,8 @@ def delete_engines
|
|
41
41
|
end
|
42
42
|
|
43
43
|
def create_engine(name)
|
44
|
-
client.create_engine(name: name)
|
45
|
-
rescue
|
44
|
+
client.create_engine({ body: { name: name } })
|
45
|
+
rescue Elastic::Transport::Transport::Errors::BadRequest => e
|
46
46
|
raise e unless e.message.match(/Name is already taken/)
|
47
47
|
|
48
48
|
Logger.new($stdout).info("Engine '#{name}' had already been created, giving time for the server to sync.")
|
@@ -35,13 +35,14 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
|
|
35
35
|
response = client.count_analytics(engine_name)
|
36
36
|
|
37
37
|
expect(response.status).to eq 200
|
38
|
-
|
38
|
+
|
39
|
+
expect(response.body['results'])
|
39
40
|
end
|
40
41
|
|
41
42
|
it 'returns count analytics with filters' do
|
42
43
|
response = client.count_analytics(engine_name, body: { filters: { tag: 'web' } })
|
43
44
|
expect(response.status).to eq 200
|
44
|
-
expect(response.body['results']
|
45
|
+
expect(response.body['results'])
|
45
46
|
end
|
46
47
|
end
|
47
48
|
end
|
@@ -34,7 +34,7 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
|
|
34
34
|
sleep 1
|
35
35
|
end
|
36
36
|
|
37
|
-
it 'creates
|
37
|
+
it 'creates and gets a crawler domain' do
|
38
38
|
body = { name: name }
|
39
39
|
response = client.create_crawler_domain(engine_name, body: body)
|
40
40
|
@domain = response.body
|
@@ -48,11 +48,6 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
|
|
48
48
|
expect(response.status).to eq 200
|
49
49
|
expect(response.body['id']).to eq @domain['id']
|
50
50
|
expect(response.body).to include('name' => name)
|
51
|
-
|
52
|
-
# client.list_crawler_domains
|
53
|
-
response = client.list_crawler_domains(engine_name)
|
54
|
-
expect(response.status).to eq 200
|
55
|
-
expect(response.body['results'].first['id']).to eq(@domain['id'])
|
56
51
|
end
|
57
52
|
|
58
53
|
it 'creates and updates a crawler domain' do
|
@@ -73,6 +68,22 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
|
|
73
68
|
expect(response.body).to include('name' => new_name)
|
74
69
|
end
|
75
70
|
|
71
|
+
it 'creates and lists crawler domains' do
|
72
|
+
body = { name: name }
|
73
|
+
response = client.create_crawler_domain(engine_name, body: body)
|
74
|
+
@domain = response.body
|
75
|
+
|
76
|
+
expect(response.status).to eq 200
|
77
|
+
expect(response.body['id']).to eq @domain['id']
|
78
|
+
expect(response.body).to include('name' => name)
|
79
|
+
|
80
|
+
response = client.list_crawler_domains(engine_name)
|
81
|
+
expect(response.status).to eq 200
|
82
|
+
|
83
|
+
expect(response.body['results'].count).to eq 1
|
84
|
+
expect(response.body['results'].first['name']).to eq name
|
85
|
+
end
|
86
|
+
|
76
87
|
it 'validates a domain' do
|
77
88
|
body = { name: name }
|
78
89
|
@domain = client.create_crawler_domain(engine_name, body: body).body
|
@@ -44,7 +44,7 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
|
|
44
44
|
expect(response.status).to eq 200
|
45
45
|
expect(response.body['id']).to match(/cur-[0-9a-f]+/)
|
46
46
|
|
47
|
-
response = client.search(engine_name, query: 'jungle')
|
47
|
+
response = client.search(engine_name, body: { query: 'jungle' })
|
48
48
|
expect(response.status).to eq 200
|
49
49
|
expect(response.body['results'].count).to eq 1
|
50
50
|
expect(response.body['results'].first['title']['raw']).to eq 'Jungle Tales'
|
@@ -65,9 +65,11 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
|
|
65
65
|
def create_curation(name, query, promoted_id, hidden_id)
|
66
66
|
response = client.create_curation(
|
67
67
|
name,
|
68
|
-
|
69
|
-
|
70
|
-
|
68
|
+
body: {
|
69
|
+
queries: [query],
|
70
|
+
promoted: [promoted_id],
|
71
|
+
hidden: [hidden_id]
|
72
|
+
}
|
71
73
|
)
|
72
74
|
# Give the server a second
|
73
75
|
sleep 1
|
@@ -79,16 +81,20 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
|
|
79
81
|
|
80
82
|
response = client.put_curation(
|
81
83
|
engine_name,
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
84
|
+
{
|
85
|
+
curation_id: id,
|
86
|
+
body: {
|
87
|
+
queries: ['jungle'],
|
88
|
+
promoted: [@hidden['id']],
|
89
|
+
hidden: [@promoted['id']]
|
90
|
+
}
|
91
|
+
}
|
86
92
|
)
|
87
93
|
|
88
94
|
expect(response.status).to eq 200
|
89
95
|
expect(response.body['id']).to match(/cur-[0-9a-f]+/)
|
90
96
|
|
91
|
-
response = @client.search(engine_name, query: 'jungle')
|
97
|
+
response = @client.search(engine_name, body: { query: 'jungle' })
|
92
98
|
expect(response.status).to eq 200
|
93
99
|
expect(response.body['results'].count).to eq 1
|
94
100
|
expect(response.body['results'].first['title']['raw']).to eq 'The Jungle Book'
|
@@ -22,54 +22,52 @@ require_relative "#{__dir__}/app_search_helper.rb"
|
|
22
22
|
describe Elastic::EnterpriseSearch::AppSearch::Client do
|
23
23
|
context 'Engines' do
|
24
24
|
let(:engine_name) { 'test-create-engines' }
|
25
|
+
let(:engine_response) do
|
26
|
+
{
|
27
|
+
'type' => 'default',
|
28
|
+
'language' => nil,
|
29
|
+
'document_count' => 0,
|
30
|
+
'index_create_settings_override' => {}
|
31
|
+
}
|
32
|
+
end
|
25
33
|
|
26
34
|
after do
|
27
35
|
delete_engines
|
28
36
|
end
|
29
37
|
|
30
38
|
it 'creates a new engine' do
|
31
|
-
response = client.create_engine(name: engine_name)
|
39
|
+
response = client.create_engine({ body: { name: engine_name } })
|
32
40
|
|
33
41
|
expect(response.status).to eq 200
|
34
|
-
expect(response.body).to eq(
|
35
|
-
{
|
36
|
-
'name' => engine_name,
|
37
|
-
'type' => 'default',
|
38
|
-
'language' => nil,
|
39
|
-
'document_count' => 0
|
40
|
-
}
|
41
|
-
)
|
42
|
+
expect(response.body).to eq(engine_response.merge({ 'name' => engine_name }))
|
42
43
|
end
|
43
44
|
|
44
45
|
it 'lists engines' do
|
45
|
-
client.create_engine(name: 'engine1')
|
46
|
-
client.create_engine(name: 'engine2')
|
46
|
+
client.create_engine({ body: { name: 'engine1' } })
|
47
|
+
client.create_engine({ body: { name: 'engine2' } })
|
47
48
|
|
48
49
|
response = client.list_engines
|
49
50
|
expect(response.status).to eq 200
|
50
51
|
|
51
52
|
expect(response.body.dig('meta', 'page', 'total_results')).to eq 2
|
52
|
-
expect(response.body['results']).to include(
|
53
|
-
|
54
|
-
)
|
55
|
-
expect(response.body['results']).to include(
|
56
|
-
{ 'name' => 'engine2', 'type' => 'default', 'language' => nil, 'document_count' => 0 }
|
57
|
-
)
|
53
|
+
expect(response.body['results']).to include(engine_response.merge({ 'name' => 'engine1' }))
|
54
|
+
expect(response.body['results']).to include(engine_response.merge({ 'name' => 'engine2' }))
|
58
55
|
end
|
59
56
|
|
60
|
-
|
61
|
-
engine_name
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
57
|
+
context 'get engines' do
|
58
|
+
let(:engine_name) { 'retrieve-engine' }
|
59
|
+
it 'retrieves an engine by name' do
|
60
|
+
engine_name = 'retrieve-engine'
|
61
|
+
client.create_engine({ body: { name: engine_name } })
|
62
|
+
response = client.engine(engine_name)
|
63
|
+
expect(response.status).to eq 200
|
64
|
+
expect(response.body).to eq(engine_response.merge({ 'name' => engine_name }))
|
65
|
+
end
|
68
66
|
end
|
69
67
|
|
70
68
|
it 'deletes an engine' do
|
71
69
|
engine_name = 'delete-engine'
|
72
|
-
client.create_engine(name: engine_name)
|
70
|
+
client.create_engine({ body: { name: engine_name } })
|
73
71
|
response = client.delete_engine(engine_name)
|
74
72
|
expect(response.status).to eq 200
|
75
73
|
expect(response.body).to eq({ 'deleted' => true })
|
@@ -21,7 +21,7 @@ require_relative "#{__dir__}/app_search_helper.rb"
|
|
21
21
|
|
22
22
|
describe Elastic::EnterpriseSearch::AppSearch::Client do
|
23
23
|
context 'Log Click through' do
|
24
|
-
let(:engine_name) { '
|
24
|
+
let(:engine_name) { 'log-click-through' }
|
25
25
|
|
26
26
|
before do
|
27
27
|
create_engine(engine_name)
|
@@ -28,12 +28,12 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
|
|
28
28
|
type: 'meta',
|
29
29
|
source_engines: ['books', 'videogames']
|
30
30
|
}
|
31
|
-
client.create_engine(
|
31
|
+
client.create_engine(body: body)
|
32
32
|
end
|
33
33
|
|
34
34
|
before do
|
35
|
-
client.create_engine(name: 'books')
|
36
|
-
client.create_engine(name: 'videogames')
|
35
|
+
client.create_engine({ body: { name: 'books' } })
|
36
|
+
client.create_engine({ body: { name: 'videogames' } })
|
37
37
|
end
|
38
38
|
|
39
39
|
after do
|
@@ -51,7 +51,7 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
|
|
51
51
|
it 'adds a new source engine to a meta engine' do
|
52
52
|
create_meta_engine
|
53
53
|
# Create new source engine to add:
|
54
|
-
client.create_engine(name: 'add-source')
|
54
|
+
client.create_engine({ body: { name: 'add-source' } })
|
55
55
|
response = client.add_meta_engine_source(engine_name, source_engines: ['add-source'])
|
56
56
|
|
57
57
|
expect(response.status).to eq 200
|
@@ -62,7 +62,7 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
|
|
62
62
|
|
63
63
|
it 'removes a source engine from a meta engine' do
|
64
64
|
create_meta_engine
|
65
|
-
client.create_engine(name: 'remove-source')
|
65
|
+
client.create_engine({ body: { name: 'remove-source' } })
|
66
66
|
client.add_meta_engine_source(engine_name, source_engines: ['remove-source'])
|
67
67
|
response = client.delete_meta_engine_source(engine_name, source_engines: ['remove-source'])
|
68
68
|
|
@@ -44,7 +44,7 @@ describe Elastic::EnterpriseSearch::AppSearch::Client do
|
|
44
44
|
|
45
45
|
context 'search' do
|
46
46
|
it 'performs a single query search' do
|
47
|
-
response = client.search(engine_name, query: 'Ibarbourou')
|
47
|
+
response = client.search(engine_name, body: { query: 'Ibarbourou' })
|
48
48
|
expect(response.status).to eq 200
|
49
49
|
expect(response.body).not_to be nil
|
50
50
|
expect(response.body['results'].count).to be 1
|
@@ -27,7 +27,7 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
|
|
27
27
|
|
28
28
|
it 'creates, retrieves and deletes authenticated with basic auth' do
|
29
29
|
# Create a content source and get its id
|
30
|
-
response = client.create_content_source(name: 'test')
|
30
|
+
response = client.create_content_source(body: { name: 'test' })
|
31
31
|
expect(response.status).to eq 200
|
32
32
|
expect(response.body['id'])
|
33
33
|
id = response.body['id']
|
@@ -47,7 +47,7 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
|
|
47
47
|
end
|
48
48
|
|
49
49
|
it 'creates and updates' do
|
50
|
-
response = client.create_content_source(name: 'ruby_client_app')
|
50
|
+
response = client.create_content_source(body: { name: 'ruby_client_app' })
|
51
51
|
expect(response.status).to eq 200
|
52
52
|
id = response.body['id']
|
53
53
|
|
@@ -71,7 +71,7 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
|
|
71
71
|
end
|
72
72
|
|
73
73
|
it 'syncs jobs' do
|
74
|
-
response = client.create_content_source(name: 'sync_jobs_test')
|
74
|
+
response = client.create_content_source(body: { name: 'sync_jobs_test' })
|
75
75
|
expect(response.status).to eq 200
|
76
76
|
id = response.body['id']
|
77
77
|
|
@@ -81,19 +81,19 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
|
|
81
81
|
end
|
82
82
|
|
83
83
|
context 'icons' do
|
84
|
-
let(:content_source_id) { client.create_content_source(name: 'with-icon').body['id'] }
|
84
|
+
let(:content_source_id) { client.create_content_source(body: { name: 'with-icon' }).body['id'] }
|
85
85
|
|
86
86
|
it 'puts an icon' do
|
87
87
|
path = File.expand_path("#{File.dirname(__FILE__)}/icon.png")
|
88
88
|
icon = Base64.strict_encode64(File.read(path))
|
89
|
-
response = client.put_content_source_icons(content_source_id, main_icon: icon, alt_icon: icon)
|
89
|
+
response = client.put_content_source_icons(content_source_id, body: { main_icon: icon, alt_icon: icon })
|
90
90
|
expect(response.status).to eq 200
|
91
91
|
expect(response.body['results']).to eq({ 'main_icon' => 'success', 'alt_icon' => 'success' })
|
92
92
|
end
|
93
93
|
end
|
94
94
|
|
95
95
|
context 'auto query refinements details' do
|
96
|
-
let(:content_source_id) { client.create_content_source(name: 'refinements').body['id'] }
|
96
|
+
let(:content_source_id) { client.create_content_source(body: { name: 'refinements' }).body['id'] }
|
97
97
|
|
98
98
|
it 'retrieves details' do
|
99
99
|
response = client.auto_query_refinement_details(content_source_id)
|
@@ -43,7 +43,7 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
|
|
43
43
|
|
44
44
|
context 'Documents' do
|
45
45
|
let(:content_source_id) do
|
46
|
-
client.create_content_source(name: 'test').body['id']
|
46
|
+
client.create_content_source(body: { name: 'test' }).body['id']
|
47
47
|
end
|
48
48
|
|
49
49
|
it 'indexes' do
|
@@ -58,7 +58,7 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
|
|
58
58
|
end
|
59
59
|
|
60
60
|
context 'Documents in Content Sources' do
|
61
|
-
let(:content_source_id) { client.create_content_source(name: 'books').body['id'] }
|
61
|
+
let(:content_source_id) { client.create_content_source(body: { name: 'books' }).body['id'] }
|
62
62
|
let(:document_id) { client.index_documents(content_source_id, documents: documents).body['results'].first['id'] }
|
63
63
|
|
64
64
|
it 'Gets a document in a content source' do
|
@@ -67,20 +67,13 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
|
|
67
67
|
expect(response.body['id']).to eq document_id
|
68
68
|
end
|
69
69
|
|
70
|
-
it 'Lists documents in a content source' do
|
71
|
-
response = client.list_documents(content_source_id)
|
72
|
-
expect(response.status).to eq 200
|
73
|
-
expect(response.body['results'])
|
74
|
-
expect(response.body['meta'])
|
75
|
-
end
|
76
|
-
|
77
70
|
it 'Deletes all documents in a content source' do
|
78
71
|
response = client.delete_all_documents(content_source_id)
|
79
72
|
expect(response.status).to eq 200
|
80
73
|
end
|
81
74
|
|
82
75
|
it 'Deletes documents by query' do
|
83
|
-
content_source_id = client.create_content_source(name: 'asimov').body['id']
|
76
|
+
content_source_id = client.create_content_source(body: { name: 'asimov' }).body['id']
|
84
77
|
documents = [
|
85
78
|
{ title: 'Foundation', year: 1951 },
|
86
79
|
{ title: 'Foundation and Empire', year: 1952 },
|
@@ -98,5 +91,22 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
|
|
98
91
|
expect(response.status).to eq 200
|
99
92
|
expect(response.body).to eq({ 'total' => 3, 'deleted' => 3, 'failures' => [] })
|
100
93
|
end
|
94
|
+
|
95
|
+
it 'Lists documents' do
|
96
|
+
content_source_id = client.create_content_source(body: { name: 'quiroga' }).body['id']
|
97
|
+
documents = [
|
98
|
+
{ title: 'Stories of Love, Madness and Death', year: 1917 },
|
99
|
+
{ title: 'Drifting', year: 1937 },
|
100
|
+
{ title: 'The Beheaded Hen', year: 1925 }
|
101
|
+
]
|
102
|
+
client.index_documents(content_source_id, documents: documents)
|
103
|
+
# Give time to index the documents
|
104
|
+
sleep 2
|
105
|
+
|
106
|
+
response = client.list_documents(content_source_id)
|
107
|
+
expect(response.status).to eq 200
|
108
|
+
expect(response.body['results'].count).to eq 3
|
109
|
+
expect(response.body['results'].map { |a| a['year'] }).to eq ['1917', '1937', '1925']
|
110
|
+
end
|
101
111
|
end
|
102
112
|
end
|
@@ -25,33 +25,42 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
|
|
25
25
|
delete_content_sources
|
26
26
|
end
|
27
27
|
|
28
|
-
let(:content_source_id) { client.create_content_source(name: 'my_content').body['id'] }
|
29
|
-
let(:
|
30
|
-
let(:
|
28
|
+
let(:content_source_id) { client.create_content_source(body: { name: 'my_content' }).body['id'] }
|
29
|
+
let(:external_user_id) { 'elastic_user' }
|
30
|
+
let(:user_properties) { ['attribute_name' => '_elasticsearch_username', 'attribute_value' => 'fernando'] }
|
31
31
|
let(:body) do
|
32
|
-
{
|
32
|
+
{ external_user_id: external_user_id, permissions: [], external_user_properties: user_properties }
|
33
|
+
end
|
34
|
+
let(:expected_response) do
|
35
|
+
{
|
36
|
+
'content_source_id' => content_source_id,
|
37
|
+
'external_user_id' => external_user_id,
|
38
|
+
'external_user_properties' => user_properties,
|
39
|
+
'permissions' => []
|
40
|
+
}
|
33
41
|
end
|
34
42
|
|
35
43
|
context 'Creates' do
|
36
|
-
let(:source_user_id) { 'test@elastic.co' }
|
44
|
+
# let(:source_user_id) { 'test@elastic.co' }
|
37
45
|
let(:user) { 'test' }
|
38
46
|
|
39
47
|
it 'creates an external identity' do
|
40
48
|
response = client.create_external_identity(content_source_id, body: body)
|
41
49
|
|
42
50
|
expect(response.status).to eq 200
|
43
|
-
expect(response.body).to eq(
|
51
|
+
expect(response.body).to eq(expected_response)
|
44
52
|
|
45
|
-
client.delete_external_identity(content_source_id,
|
53
|
+
client.delete_external_identity(content_source_id, external_user_id: external_user_id)
|
46
54
|
end
|
47
55
|
|
48
56
|
it 'creates and retrieves' do
|
49
57
|
client.create_external_identity(content_source_id, body: body)
|
50
|
-
response = client.external_identity(content_source_id,
|
58
|
+
response = client.external_identity(content_source_id, external_user_id: external_user_id)
|
51
59
|
|
52
60
|
expect(response.status).to eq 200
|
53
|
-
|
54
|
-
|
61
|
+
|
62
|
+
expect(response.body).to eq(expected_response)
|
63
|
+
client.delete_external_identity(content_source_id, external_user_id: external_user_id)
|
55
64
|
end
|
56
65
|
end
|
57
66
|
|
@@ -63,8 +72,9 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
|
|
63
72
|
response = client.list_external_identities(content_source_id)
|
64
73
|
|
65
74
|
expect(response.status).to eq 200
|
66
|
-
|
67
|
-
|
75
|
+
|
76
|
+
expect(response.body['results']).to eq([expected_response])
|
77
|
+
client.delete_external_identity(content_source_id, external_user_id: external_user_id)
|
68
78
|
end
|
69
79
|
end
|
70
80
|
|
@@ -74,11 +84,11 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
|
|
74
84
|
end
|
75
85
|
|
76
86
|
it 'updates an external identity' do
|
77
|
-
body = {
|
78
|
-
response = client.put_external_identity(content_source_id,
|
87
|
+
body = { external_user_id: external_user_id, permissions: ['permission1'] }
|
88
|
+
response = client.put_external_identity(content_source_id, external_user_id: external_user_id, body: body)
|
79
89
|
|
80
90
|
expect(response.status).to eq 200
|
81
|
-
expect(response.body).to eq({ '
|
91
|
+
expect(response.body).to eq expected_response.merge({ 'permissions' => ['permission1'] })
|
82
92
|
end
|
83
93
|
end
|
84
94
|
|
@@ -88,7 +98,7 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
|
|
88
98
|
end
|
89
99
|
|
90
100
|
it 'deletes an external identity' do
|
91
|
-
response = client.delete_external_identity(content_source_id,
|
101
|
+
response = client.delete_external_identity(content_source_id, external_user_id: external_user_id)
|
92
102
|
expect(response.status).to eq 200
|
93
103
|
expect(response.body).to eq 'ok'
|
94
104
|
end
|
@@ -28,14 +28,14 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
|
|
28
28
|
original_list = response.body['blocklist']
|
29
29
|
|
30
30
|
# Add a term to the block list and check it's been changed
|
31
|
-
response = client.put_triggers_blocklist(
|
31
|
+
response = client.put_triggers_blocklist(blocklist: original_list + ['tests'])
|
32
32
|
expect(response.status).to eq 200
|
33
33
|
expect(response.body['blocklist']).to eq(original_list + ['tests'])
|
34
34
|
response = client.triggers_blocklist
|
35
35
|
expect(response.body['blocklist']).to eq(original_list + ['tests'])
|
36
36
|
|
37
37
|
# Restored original list
|
38
|
-
response = client.put_triggers_blocklist(
|
38
|
+
response = client.put_triggers_blocklist(blocklist: original_list)
|
39
39
|
expect(response.status).to eq 200
|
40
40
|
expect(response.body['blocklist']).to eq(original_list)
|
41
41
|
end
|
@@ -26,11 +26,5 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
|
|
26
26
|
expect(response.status).to eq 200
|
27
27
|
expect(response.body.keys).to eq ['email', 'username']
|
28
28
|
end
|
29
|
-
|
30
|
-
it 'gets the current user with an access token' do
|
31
|
-
response = client.current_user(get_token: true)
|
32
|
-
expect(response.status).to eq 200
|
33
|
-
expect(response.body.keys).to eq ['email', 'username', 'access_token']
|
34
|
-
end
|
35
29
|
end
|
36
30
|
end
|
@@ -96,4 +96,33 @@ describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
|
|
96
96
|
expect(client.authorization_url('client_id', 'https://localhost:3002')).to eq authorization_url
|
97
97
|
end
|
98
98
|
end
|
99
|
+
|
100
|
+
context 'adapters' do
|
101
|
+
let(:client) { described_class.new }
|
102
|
+
let(:adapter) { client.transport.transport.connections.all.first.connection.builder.adapter }
|
103
|
+
|
104
|
+
context 'when no adapter is specified' do
|
105
|
+
it 'uses Faraday NetHttp' do
|
106
|
+
expect(adapter).to eq Faraday::Adapter::NetHttp
|
107
|
+
end
|
108
|
+
end
|
109
|
+
|
110
|
+
context 'when the adapter is patron' do
|
111
|
+
let(:client) { described_class.new(adapter: :patron) }
|
112
|
+
|
113
|
+
it 'uses Faraday with the adapter' do
|
114
|
+
expect(adapter).to eq Faraday::Adapter::Patron
|
115
|
+
end
|
116
|
+
end
|
117
|
+
|
118
|
+
unless defined?(JRUBY_VERSION)
|
119
|
+
context 'when the adapter is typhoeus' do
|
120
|
+
let(:client) { described_class.new(adapter: :patron) }
|
121
|
+
|
122
|
+
it 'uses Faraday with the adapter' do
|
123
|
+
expect(adapter).to eq Faraday::Adapter::Patron
|
124
|
+
end
|
125
|
+
end
|
126
|
+
end
|
127
|
+
end
|
99
128
|
end
|