elastic-enterprise-search 7.14.0 → 7.16.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (207) hide show
  1. checksums.yaml +4 -4
  2. data/.ci/functions/imports.sh +1 -0
  3. data/.ci/jobs/defaults.yml +4 -0
  4. data/.ci/jobs/{elastic+enterprise-search-ruby+master.yml → elastic+enterprise-search-ruby+main.yml} +4 -4
  5. data/.ci/run-repository.sh +2 -1
  6. data/.ci/test-matrix.yml +5 -3
  7. data/{spec/app-search/api_spec_helper.rb → .github/compatibility/Gemfile} +4 -11
  8. data/.github/workflows/compatibility.yml +20 -0
  9. data/.github/workflows/testing.yml +1 -1
  10. data/CONTRIBUTING.md +1 -1
  11. data/README.md +1 -1
  12. data/Rakefile +19 -0
  13. data/docs/guide/app-search-api.asciidoc +155 -1
  14. data/docs/guide/overview.asciidoc +3 -3
  15. data/docs/guide/release_notes/714.asciidoc +12 -0
  16. data/docs/guide/release_notes/715.asciidoc +48 -0
  17. data/docs/guide/release_notes/716.asciidoc +16 -0
  18. data/docs/guide/release_notes/index.asciidoc +4 -0
  19. data/docs/guide/workplace-search-api.asciidoc +17 -0
  20. data/elastic-enterprise-search.gemspec +1 -1
  21. data/lib/elastic/app-search/api/adaptive_relevance_settings.rb +51 -0
  22. data/lib/elastic/app-search/api/adaptive_relevance_suggestions.rb +56 -0
  23. data/lib/elastic/app-search/api/add_meta_engine_source.rb +3 -2
  24. data/lib/elastic/app-search/api/api_key.rb +2 -1
  25. data/lib/elastic/app-search/api/api_logs.rb +14 -13
  26. data/lib/elastic/app-search/api/count_analytics.rb +7 -6
  27. data/lib/elastic/app-search/api/crawler_active_crawl_request.rb +51 -0
  28. data/lib/elastic/app-search/api/crawler_crawl_request.rb +54 -0
  29. data/lib/elastic/app-search/api/crawler_crawl_schedule.rb +51 -0
  30. data/lib/elastic/app-search/api/crawler_domain.rb +54 -0
  31. data/lib/elastic/app-search/api/crawler_domain_validation_result.rb +48 -0
  32. data/lib/elastic/app-search/api/crawler_metrics.rb +48 -0
  33. data/lib/elastic/app-search/api/crawler_overview.rb +51 -0
  34. data/lib/elastic/app-search/api/crawler_process_crawl.rb +54 -0
  35. data/lib/elastic/app-search/api/crawler_process_crawl_denied_urls.rb +54 -0
  36. data/lib/elastic/app-search/api/crawler_url_extraction_result.rb +52 -0
  37. data/lib/elastic/app-search/api/crawler_url_tracing_result.rb +51 -0
  38. data/lib/elastic/app-search/api/crawler_url_validation_result.rb +51 -0
  39. data/lib/elastic/app-search/api/crawler_user_agent.rb +48 -0
  40. data/lib/elastic/app-search/api/create_api_key.rb +9 -1
  41. data/lib/elastic/app-search/api/create_crawler_crawl_request.rb +51 -0
  42. data/lib/elastic/app-search/api/create_crawler_crawl_rule.rb +60 -0
  43. data/lib/elastic/app-search/api/create_crawler_domain.rb +55 -0
  44. data/lib/elastic/app-search/api/create_crawler_entry_point.rb +57 -0
  45. data/lib/elastic/app-search/api/create_crawler_process_crawl.rb +53 -0
  46. data/lib/elastic/app-search/api/create_crawler_sitemap.rb +57 -0
  47. data/lib/elastic/app-search/api/create_curation.rb +8 -6
  48. data/lib/elastic/app-search/api/create_engine.rb +9 -7
  49. data/lib/elastic/app-search/api/create_synonym_set.rb +7 -4
  50. data/lib/elastic/app-search/api/curation.rb +4 -3
  51. data/lib/elastic/app-search/api/delete_active_crawl_request.rb +51 -0
  52. data/lib/elastic/app-search/api/delete_api_key.rb +1 -0
  53. data/lib/elastic/app-search/api/delete_crawler_active_crawl_request.rb +51 -0
  54. data/lib/elastic/app-search/api/delete_crawler_crawl_rule.rb +57 -0
  55. data/lib/elastic/app-search/api/delete_crawler_crawl_schedule.rb +51 -0
  56. data/lib/elastic/app-search/api/delete_crawler_domain.rb +54 -0
  57. data/lib/elastic/app-search/api/delete_crawler_entry_point.rb +57 -0
  58. data/lib/elastic/app-search/api/delete_crawler_sitemap.rb +57 -0
  59. data/lib/elastic/app-search/api/delete_curation.rb +4 -3
  60. data/lib/elastic/app-search/api/delete_documents.rb +2 -1
  61. data/lib/elastic/app-search/api/delete_engine.rb +3 -2
  62. data/lib/elastic/app-search/api/delete_meta_engine_source.rb +3 -3
  63. data/lib/elastic/app-search/api/delete_synonym_set.rb +4 -3
  64. data/lib/elastic/app-search/api/denied_urls.rb +54 -0
  65. data/lib/elastic/app-search/api/documents.rb +3 -2
  66. data/lib/elastic/app-search/api/engine.rb +3 -2
  67. data/lib/elastic/app-search/api/index_documents.rb +3 -2
  68. data/lib/elastic/app-search/api/list_adaptive_relevance_suggestions.rb +53 -0
  69. data/lib/elastic/app-search/api/list_api_keys.rb +2 -1
  70. data/lib/elastic/app-search/api/list_crawler_crawl_requests.rb +52 -0
  71. data/lib/elastic/app-search/api/list_crawler_domains.rb +51 -0
  72. data/lib/elastic/app-search/api/list_crawler_process_crawls.rb +51 -0
  73. data/lib/elastic/app-search/api/list_curations.rb +3 -2
  74. data/lib/elastic/app-search/api/list_documents.rb +3 -2
  75. data/lib/elastic/app-search/api/list_engines.rb +2 -1
  76. data/lib/elastic/app-search/api/list_synonym_sets.rb +3 -2
  77. data/lib/elastic/app-search/api/log_clickthrough.rb +8 -10
  78. data/lib/elastic/app-search/api/put_adaptive_relevance_settings.rb +52 -0
  79. data/lib/elastic/app-search/api/put_adaptive_relevance_suggestions.rb +51 -0
  80. data/lib/elastic/app-search/api/put_api_key.rb +9 -2
  81. data/lib/elastic/app-search/api/put_crawler_crawl_rule.rb +63 -0
  82. data/lib/elastic/app-search/api/put_crawler_crawl_schedule.rb +53 -0
  83. data/lib/elastic/app-search/api/put_crawler_domain.rb +58 -0
  84. data/lib/elastic/app-search/api/put_crawler_entry_point.rb +60 -0
  85. data/lib/elastic/app-search/api/put_crawler_sitemap.rb +60 -0
  86. data/lib/elastic/app-search/api/put_curation.rb +10 -8
  87. data/lib/elastic/app-search/api/put_documents.rb +3 -3
  88. data/lib/elastic/app-search/api/put_schema.rb +4 -4
  89. data/lib/elastic/app-search/api/put_search_settings.rb +6 -2
  90. data/lib/elastic/app-search/api/put_synonym_set.rb +8 -5
  91. data/lib/elastic/app-search/api/query_suggestion.rb +7 -7
  92. data/lib/elastic/app-search/api/reset_search_settings.rb +3 -2
  93. data/lib/elastic/app-search/api/schema.rb +3 -2
  94. data/lib/elastic/app-search/api/search.rb +14 -3
  95. data/lib/elastic/app-search/api/search_settings.rb +3 -2
  96. data/lib/elastic/app-search/api/synonym_set.rb +4 -3
  97. data/lib/elastic/app-search/api/top_clicks_analytics.rb +8 -8
  98. data/lib/elastic/app-search/api/top_queries_analytics.rb +7 -7
  99. data/lib/elastic/app-search/app_search.rb +0 -10
  100. data/lib/elastic/enterprise-search/api/health.rb +1 -0
  101. data/lib/elastic/enterprise-search/api/put_read_only.rb +3 -2
  102. data/lib/elastic/enterprise-search/api/read_only.rb +1 -0
  103. data/lib/elastic/enterprise-search/api/version.rb +1 -0
  104. data/lib/elastic/enterprise-search/client.rb +12 -1
  105. data/lib/elastic/enterprise-search/request.rb +10 -1
  106. data/lib/elastic/enterprise-search/version.rb +1 -1
  107. data/lib/elastic/workplace-search/api/auto_query_refinement_details.rb +49 -0
  108. data/lib/elastic/workplace-search/api/create_content_source.rb +1 -0
  109. data/lib/elastic/workplace-search/api/delete_synonym_set.rb +1 -1
  110. data/lib/elastic/workplace-search/api/list_documents.rb +55 -0
  111. data/lib/elastic/workplace-search/api/put_content_source.rb +1 -0
  112. data/lib/elastic/workplace-search/api/put_synonym_set.rb +1 -1
  113. data/lib/elastic/workplace-search/api/put_triggers_blocklist.rb +47 -0
  114. data/lib/elastic/workplace-search/api/search.rb +3 -0
  115. data/lib/elastic/workplace-search/api/synonym_set.rb +1 -1
  116. data/{spec/app-search/api_logs_spec.rb → lib/elastic/workplace-search/api/triggers_blocklist.rb} +23 -14
  117. data/lib/elastic/workplace-search/workplace_search.rb +0 -15
  118. data/spec/integration/app-search/adaptive_relevance_spec.rb +80 -0
  119. data/spec/integration/app-search/api_key_spec.rb +110 -0
  120. data/spec/integration/app-search/api_logs_spec.rb +59 -0
  121. data/spec/integration/app-search/app_search_helper.rb +51 -0
  122. data/spec/integration/app-search/count_analytics_spec.rb +47 -0
  123. data/spec/integration/app-search/crawl_requests_spec.rb +86 -0
  124. data/spec/integration/app-search/crawler_crawl_rule_spec.rb +73 -0
  125. data/spec/integration/app-search/crawler_domain_spec.rb +87 -0
  126. data/spec/integration/app-search/crawler_entry_point_spec.rb +77 -0
  127. data/spec/integration/app-search/crawler_metrics_spec.rb +46 -0
  128. data/spec/integration/app-search/crawler_overview_spec.rb +45 -0
  129. data/spec/integration/app-search/crawler_process_crawl_denied_urls_spec.rb +50 -0
  130. data/spec/integration/app-search/crawler_process_crawl_spec.rb +66 -0
  131. data/spec/integration/app-search/crawler_scheduling_spec.rb +69 -0
  132. data/spec/integration/app-search/crawler_sitemap_spec.rb +72 -0
  133. data/spec/integration/app-search/crawler_urls_spec.rb +60 -0
  134. data/spec/{app-search/api_count_analytics_spec.rb → integration/app-search/crawler_user_agent_spec.rb} +6 -9
  135. data/spec/integration/app-search/curations_spec.rb +118 -0
  136. data/spec/integration/app-search/documents_spec.rb +123 -0
  137. data/spec/integration/app-search/engines_spec.rb +78 -0
  138. data/spec/{app-search/api_log_clickthrough_spec.rb → integration/app-search/log_clickthrough_spec.rb} +14 -7
  139. data/spec/integration/app-search/meta_engines_spec.rb +75 -0
  140. data/spec/integration/app-search/query_suggestion_spec.rb +50 -0
  141. data/spec/{app-search/api_schema_spec.rb → integration/app-search/schema_spec.rb} +21 -16
  142. data/spec/integration/app-search/search_and_multiple_search_spec.rb +67 -0
  143. data/spec/integration/app-search/search_settings_spec.rb +87 -0
  144. data/spec/integration/app-search/synonyms_spec.rb +79 -0
  145. data/spec/{app-search/api_top_clicks_analytics_spec.rb → integration/app-search/top_clicks_analytics_spec.rb} +20 -14
  146. data/spec/{app-search/api_top_queries_analytics_spec.rb → integration/app-search/top_queries_analytics_spec.rb} +16 -8
  147. data/spec/integration/workplace-search/content_sources_spec.rb +106 -0
  148. data/spec/integration/workplace-search/documents_spec.rb +102 -0
  149. data/spec/integration/workplace-search/external_identities_spec.rb +97 -0
  150. data/spec/integration/{icon.png → workplace-search/icon.png} +0 -0
  151. data/spec/integration/workplace-search/permissions_spec.rb +77 -0
  152. data/spec/integration/workplace-search/synonym_sets_spec.rb +92 -0
  153. data/spec/integration/workplace-search/triggers_spec.rb +43 -0
  154. data/spec/{app-search/api_query_suggestion_spec.rb → integration/workplace-search/users_spec.rb} +12 -15
  155. data/spec/integration/workplace-search/workplace_search_helper.rb +39 -0
  156. metadata +94 -68
  157. data/spec/app-search/api_apikey_spec.rb +0 -92
  158. data/spec/app-search/api_curations_spec.rb +0 -97
  159. data/spec/app-search/api_documents_spec.rb +0 -102
  160. data/spec/app-search/api_engines_spec.rb +0 -67
  161. data/spec/app-search/api_meta_engines_spec.rb +0 -72
  162. data/spec/app-search/api_search_and_multi_search_spec.rb +0 -48
  163. data/spec/app-search/api_search_settings_spec.rb +0 -76
  164. data/spec/app-search/api_synonyms_spec.rb +0 -79
  165. data/spec/fixtures/vcr/app_search/add_meta_engine_source.yml +0 -109
  166. data/spec/fixtures/vcr/app_search/api_documents.yml +0 -56
  167. data/spec/fixtures/vcr/app_search/api_index_documents.yml +0 -57
  168. data/spec/fixtures/vcr/app_search/api_log_clickthrough.yml +0 -54
  169. data/spec/fixtures/vcr/app_search/api_logs.yml +0 -70
  170. data/spec/fixtures/vcr/app_search/api_put_schema.yml +0 -109
  171. data/spec/fixtures/vcr/app_search/api_put_search_settings.yml +0 -56
  172. data/spec/fixtures/vcr/app_search/api_query_suggestion.yml +0 -59
  173. data/spec/fixtures/vcr/app_search/api_reset_search_settings.yml +0 -56
  174. data/spec/fixtures/vcr/app_search/api_schema.yml +0 -56
  175. data/spec/fixtures/vcr/app_search/api_search_settings.yml +0 -56
  176. data/spec/fixtures/vcr/app_search/api_top_clicks_analytics.yml +0 -55
  177. data/spec/fixtures/vcr/app_search/api_top_clicks_analytics_query.yml +0 -55
  178. data/spec/fixtures/vcr/app_search/api_top_queries_analytics.yml +0 -55
  179. data/spec/fixtures/vcr/app_search/count_analytics.yml +0 -55
  180. data/spec/fixtures/vcr/app_search/create_and_update_document.yml +0 -107
  181. data/spec/fixtures/vcr/app_search/create_api_key.yml +0 -52
  182. data/spec/fixtures/vcr/app_search/create_curation.yml +0 -113
  183. data/spec/fixtures/vcr/app_search/create_engine.yml +0 -55
  184. data/spec/fixtures/vcr/app_search/create_meta_engine.yml +0 -56
  185. data/spec/fixtures/vcr/app_search/create_synonym_set.yml +0 -56
  186. data/spec/fixtures/vcr/app_search/delete_api_key.yml +0 -52
  187. data/spec/fixtures/vcr/app_search/delete_curation.yml +0 -56
  188. data/spec/fixtures/vcr/app_search/delete_engine.yml +0 -55
  189. data/spec/fixtures/vcr/app_search/delete_meta_engine_source.yml +0 -56
  190. data/spec/fixtures/vcr/app_search/delete_synonym_set.yml +0 -56
  191. data/spec/fixtures/vcr/app_search/get_api_key.yml +0 -52
  192. data/spec/fixtures/vcr/app_search/get_curation.yml +0 -56
  193. data/spec/fixtures/vcr/app_search/get_engine.yml +0 -55
  194. data/spec/fixtures/vcr/app_search/index_and_delete_document.yml +0 -107
  195. data/spec/fixtures/vcr/app_search/list_api_keys.yml +0 -52
  196. data/spec/fixtures/vcr/app_search/list_curations.yml +0 -56
  197. data/spec/fixtures/vcr/app_search/list_documents.yml +0 -57
  198. data/spec/fixtures/vcr/app_search/list_engines.yml +0 -55
  199. data/spec/fixtures/vcr/app_search/list_synonym_sets.yml +0 -56
  200. data/spec/fixtures/vcr/app_search/multi_query_search.yml +0 -63
  201. data/spec/fixtures/vcr/app_search/put_api_key.yml +0 -52
  202. data/spec/fixtures/vcr/app_search/put_curation.yml +0 -113
  203. data/spec/fixtures/vcr/app_search/put_synonym_set.yml +0 -56
  204. data/spec/fixtures/vcr/app_search/search.yml +0 -57
  205. data/spec/fixtures/vcr/app_search/single_query_search.yml +0 -60
  206. data/spec/fixtures/vcr/app_search/synonym_set.yml +0 -56
  207. data/spec/integration/workplace_search_spec.rb +0 -375
@@ -0,0 +1,123 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
18
+ # frozen_string_literal: true
19
+
20
+ require_relative "#{__dir__}/app_search_helper.rb"
21
+
22
+ describe Elastic::EnterpriseSearch::AppSearch::Client do
23
+ context 'documents' do
24
+ let(:engine_name) { 'documents' }
25
+ let(:documents) do
26
+ [
27
+ { name: 'Super Lorenzo Bros', year: '1985' },
28
+ { name: 'Pack-Man', year: '1980' },
29
+ { name: 'Galaxxian', year: '1979' },
30
+ { name: 'Audiovisual, the hedgehog', year: '1991' }
31
+ ]
32
+ end
33
+
34
+ before do
35
+ create_engine(engine_name)
36
+ end
37
+
38
+ after do
39
+ delete_engines
40
+ end
41
+
42
+ def extract_from_key(key)
43
+ ->(h) { h[key] }
44
+ end
45
+
46
+ it 'indexes and lists documents' do
47
+ response = client.index_documents(engine_name, documents: documents)
48
+ expect(response.status).to eq 200
49
+ expect(response.body.count).to eq 4
50
+ expect(response.body.map(&:keys)).to eq [['id', 'errors'], ['id', 'errors'], ['id', 'errors'], ['id', 'errors']]
51
+
52
+ response = client.list_documents(engine_name)
53
+ attempts = 0
54
+ while response.body['results'].count < 1 && attempts < 20
55
+ sleep 1
56
+ attempts += 1
57
+ response = client.list_documents(engine_name)
58
+ end
59
+
60
+ expect(response.status).to eq 200
61
+ expect(response.body['results'].count).to eq 4
62
+ end
63
+
64
+ it 'retrieves documents by ID' do
65
+ response = client.index_documents(engine_name, documents: documents)
66
+ ids = response.body.map(&->(h) { h['id'] })
67
+
68
+ attempts = 0
69
+ while client.list_documents(engine_name).body['results'].count < 4 && attempts < 20
70
+ sleep 1
71
+ attempts += 1
72
+ end
73
+
74
+ response = client.documents(engine_name, document_ids: ids)
75
+
76
+ expect(response.status).to eq 200
77
+ expect(response.body.count).to eq 4
78
+ expect(
79
+ response.body.map(&extract_from_key('name')) - documents.map(&extract_from_key(:name))
80
+ ).to be_empty
81
+ end
82
+
83
+ it 'searches for a document' do
84
+ client.index_documents(engine_name, documents: documents)
85
+
86
+ response = client.search(engine_name, body: { query: 'Pack-Man' })
87
+ attempts = 0
88
+ while response.body['results'].count < 1 && attempts < 20
89
+ sleep 1
90
+ attempts += 1
91
+ response = client.search(engine_name, body: { query: 'Pack-Man' })
92
+ end
93
+ expect(response.status).to eq 200
94
+ expect(response.body['meta']['engine']).to eq({ 'name' => engine_name, 'type' => 'default' })
95
+ expect(response.body['results'].first['name']).to eq({ 'raw' => 'Pack-Man' })
96
+ expect(response.body['results'].first['year']).to eq({ 'raw' => '1980' })
97
+ end
98
+
99
+ it 'deletes a document' do
100
+ document = { name: 'Celda', year: 1986 }
101
+ response = client.index_documents(engine_name, documents: document)
102
+ expect(response.status).to eq 200
103
+
104
+ id = response.body.first['id']
105
+
106
+ response = client.delete_documents(engine_name, document_ids: [id])
107
+ expect(response.status).to eq 200
108
+ expect(response.body.first['deleted'])
109
+ end
110
+
111
+ it 'updates a document' do
112
+ document = { name: 'Al*bert', year: 1983 }
113
+ response = client.index_documents(engine_name, documents: document)
114
+ expect(response.status).to eq 200
115
+
116
+ id = response.body.first['id']
117
+
118
+ response = client.put_documents(engine_name, documents: [{ id: id, year: 1982 }])
119
+ expect(response.status).to eq 200
120
+ expect(response.body).to eq [{ 'id' => id, 'errors' => [] }]
121
+ end
122
+ end
123
+ end
@@ -0,0 +1,78 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
18
+ # frozen_string_literal: true
19
+
20
+ require_relative "#{__dir__}/app_search_helper.rb"
21
+
22
+ describe Elastic::EnterpriseSearch::AppSearch::Client do
23
+ context 'Engines' do
24
+ let(:engine_name) { 'test-create-engines' }
25
+
26
+ after do
27
+ delete_engines
28
+ end
29
+
30
+ it 'creates a new engine' do
31
+ response = client.create_engine(name: engine_name)
32
+
33
+ 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
+ end
43
+
44
+ it 'lists engines' do
45
+ client.create_engine(name: 'engine1')
46
+ client.create_engine(name: 'engine2')
47
+
48
+ response = client.list_engines
49
+ expect(response.status).to eq 200
50
+
51
+ expect(response.body.dig('meta', 'page', 'total_results')).to eq 2
52
+ expect(response.body['results']).to include(
53
+ { 'name' => 'engine1', 'type' => 'default', 'language' => nil, 'document_count' => 0 }
54
+ )
55
+ expect(response.body['results']).to include(
56
+ { 'name' => 'engine2', 'type' => 'default', 'language' => nil, 'document_count' => 0 }
57
+ )
58
+ end
59
+
60
+ it 'retrieves an engine by name' do
61
+ engine_name = 'retrieve-engine'
62
+ client.create_engine(name: engine_name)
63
+ response = client.engine(engine_name)
64
+ expect(response.status).to eq 200
65
+ expect(response.body).to eq(
66
+ { 'name' => engine_name, 'type' => 'default', 'language' => nil, 'document_count' => 0 }
67
+ )
68
+ end
69
+
70
+ it 'deletes an engine' do
71
+ engine_name = 'delete-engine'
72
+ client.create_engine(name: engine_name)
73
+ response = client.delete_engine(engine_name)
74
+ expect(response.status).to eq 200
75
+ expect(response.body).to eq({ 'deleted' => true })
76
+ end
77
+ end
78
+ end
@@ -17,18 +17,25 @@
17
17
 
18
18
  # frozen_string_literal: true
19
19
 
20
- require_relative './api_spec_helper'
20
+ require_relative "#{__dir__}/app_search_helper.rb"
21
21
 
22
22
  describe Elastic::EnterpriseSearch::AppSearch::Client do
23
- context 'api_log_clickthrough' do
24
- let(:engine_name) { 'films' }
23
+ context 'Log Click through' do
24
+ let(:engine_name) { 'videogames' }
25
+
26
+ before do
27
+ create_engine(engine_name)
28
+ end
29
+
30
+ after do
31
+ client.delete_engine(engine_name)
32
+ end
25
33
 
26
34
  it 'logs clicked results' do
27
- VCR.use_cassette('app_search/api_log_clickthrough') do
28
- response = @client.log_clickthrough(engine_name, query_text: 'moon', document_id: 'doc-id')
35
+ body = { query: 'moon', document_id: 'doc_id' }
36
+ response = client.log_clickthrough(engine_name, body: body)
29
37
 
30
- expect(response.status).to eq 200
31
- end
38
+ expect(response.status).to eq 200
32
39
  end
33
40
  end
34
41
  end
@@ -0,0 +1,75 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
18
+ # frozen_string_literal: true
19
+
20
+ require_relative "#{__dir__}/app_search_helper.rb"
21
+
22
+ describe Elastic::EnterpriseSearch::AppSearch::Client do
23
+ context 'Meta Engines' do
24
+ let(:engine_name) { 'new-meta-engine' }
25
+ let(:create_meta_engine) do
26
+ body = {
27
+ name: engine_name,
28
+ type: 'meta',
29
+ source_engines: ['books', 'videogames']
30
+ }
31
+ client.create_engine(name: engine_name, body: body)
32
+ end
33
+
34
+ before do
35
+ client.create_engine(name: 'books')
36
+ client.create_engine(name: 'videogames')
37
+ end
38
+
39
+ after do
40
+ delete_engines
41
+ end
42
+
43
+ it 'creates a meta engine' do
44
+ response = create_meta_engine
45
+ expect(response.status).to eq 200
46
+ expect(response.body['name']).to eq(engine_name)
47
+ expect(response.body['type']).to eq('meta')
48
+ expect(response.body['source_engines'].sort).to eq(['books', 'videogames'])
49
+ end
50
+
51
+ it 'adds a new source engine to a meta engine' do
52
+ create_meta_engine
53
+ # Create new source engine to add:
54
+ client.create_engine(name: 'add-source')
55
+ response = client.add_meta_engine_source(engine_name, source_engines: ['add-source'])
56
+
57
+ expect(response.status).to eq 200
58
+ expect(response.body['name']).to eq(engine_name)
59
+ expect(response.body['type']).to eq('meta')
60
+ expect(response.body['source_engines'].sort).to eq(['add-source', 'books', 'videogames'])
61
+ end
62
+
63
+ it 'removes a source engine from a meta engine' do
64
+ create_meta_engine
65
+ client.create_engine(name: 'remove-source')
66
+ client.add_meta_engine_source(engine_name, source_engines: ['remove-source'])
67
+ response = client.delete_meta_engine_source(engine_name, source_engines: ['remove-source'])
68
+
69
+ expect(response.status).to eq 200
70
+ expect(response.body['name']).to eq(engine_name)
71
+ expect(response.body['type']).to eq('meta')
72
+ expect(response.body['source_engines'].sort).to eq(['books', 'videogames'])
73
+ end
74
+ end
75
+ end
@@ -0,0 +1,50 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
18
+ # frozen_string_literal: true
19
+
20
+ require_relative "#{__dir__}/app_search_helper.rb"
21
+
22
+ describe Elastic::EnterpriseSearch::AppSearch::Client do
23
+ context 'Query Suggestion' do
24
+ let(:engine_name) { 'query-suggestions' }
25
+
26
+ before do
27
+ create_engine(engine_name)
28
+ end
29
+
30
+ after do
31
+ delete_engines
32
+ end
33
+
34
+ it 'provides query suggestions' do
35
+ client.index_documents(engine_name, documents: [{ title: 'A trip to the moon' }])
36
+ attempts = 0
37
+ response = client.query_suggestion(engine_name, query: 'moo')
38
+
39
+ while response.body['results']['documents'].count < 1 && attempts < 20
40
+ sleep 1
41
+ attempts += 1
42
+ response = client.query_suggestion(engine_name, query: 'moo')
43
+ end
44
+ expect(response.status).to eq 200
45
+ expect(response.body['results']['documents']).to include(
46
+ { 'suggestion' => 'moon' }
47
+ )
48
+ end
49
+ end
50
+ end
@@ -17,32 +17,37 @@
17
17
 
18
18
  # frozen_string_literal: true
19
19
 
20
- require 'spec_helper'
21
- require_relative './api_spec_helper'
20
+ require_relative "#{__dir__}/app_search_helper.rb"
22
21
 
23
22
  describe Elastic::EnterpriseSearch::AppSearch::Client do
24
- context 'schema' do
25
- let(:engine_name) { 'films' }
23
+ let(:engine_name) { 'schema' }
24
+
25
+ before do
26
+ create_engine(engine_name)
27
+ client.index_documents(engine_name, documents: [{ title: 'test', director: 'someone' }])
28
+ end
26
29
 
30
+ after do
31
+ client.delete_engine(engine_name)
32
+ sleep 1
33
+ end
34
+
35
+ context 'schema' do
27
36
  it 'returns an engine schema' do
28
- VCR.use_cassette('app_search/api_schema') do
29
- response = @client.schema(engine_name)
37
+ response = client.schema(engine_name)
30
38
 
31
- expect(response.status).to eq 200
32
- expect(response.body).to eq({ 'title' => 'text', 'year' => 'number', 'director' => 'text' })
33
- end
39
+ expect(response.status).to eq 200
40
+ expect(response.body).to eq({ 'title' => 'text', 'director' => 'text' })
34
41
  end
35
42
 
36
43
  it 'updates a schema for an engine' do
37
- VCR.use_cassette('app_search/api_put_schema') do
38
- response = @client.put_schema(engine_name, schema: { year: 'text' })
44
+ response = client.put_schema(engine_name, schema: { year: 'number' })
39
45
 
40
- expect(response.status).to eq 200
41
- expect(response.body).to eq({ 'title' => 'text', 'year' => 'text', 'director' => 'text' })
46
+ expect(response.status).to eq 200
47
+ expect(response.body).to eq({ 'title' => 'text', 'year' => 'number', 'director' => 'text' })
42
48
 
43
- response = @client.schema(engine_name)
44
- expect(response.body).to eq({ 'title' => 'text', 'year' => 'text', 'director' => 'text' })
45
- end
49
+ response = client.schema(engine_name)
50
+ expect(response.body).to eq({ 'title' => 'text', 'year' => 'number', 'director' => 'text' })
46
51
  end
47
52
  end
48
53
  end
@@ -0,0 +1,67 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
18
+ # frozen_string_literal: true
19
+
20
+ require_relative "#{__dir__}/app_search_helper.rb"
21
+
22
+ describe Elastic::EnterpriseSearch::AppSearch::Client do
23
+ let(:engine_name) { 'search' }
24
+ let(:documents) do
25
+ [
26
+ { title: 'Animal Farm', author: 'George Orwell' },
27
+ { title: '1984', author: 'George Orwell' },
28
+ { title: 'Jungle Tales', author: 'Horacio Quiroga' },
29
+ { title: 'Lenguas de diamante', author: 'Juana de Ibarbourou' },
30
+ { title: 'Metamorphosis', author: 'Franz Kafka' },
31
+ { title: 'The Handmaid\'s Tale', author: 'Margaret Atwood' }
32
+ ]
33
+ end
34
+
35
+ before do
36
+ create_engine(engine_name)
37
+ client.index_documents(engine_name, documents: documents)
38
+ sleep 1
39
+ end
40
+
41
+ after do
42
+ delete_engines
43
+ end
44
+
45
+ context 'search' do
46
+ it 'performs a single query search' do
47
+ response = client.search(engine_name, query: 'Ibarbourou')
48
+ expect(response.status).to eq 200
49
+ expect(response.body).not_to be nil
50
+ expect(response.body['results'].count).to be 1
51
+
52
+ expect(response.body['results'].first['author']['raw']).to eq documents[3][:author]
53
+ expect(response.body['results'].first['title']['raw']).to eq documents[3][:title]
54
+ end
55
+ end
56
+
57
+ context 'multi query search' do
58
+ it 'performs a multi query search' do
59
+ response = client.multi_search(engine_name, body: { queries: [{ query: 'George' }, { query: 'Margaret' }] })
60
+ expect(response.status).to eq 200
61
+ expect(response.body.class).to be Array
62
+ expect(response.body.count).to be 2
63
+ expect(response.body[0]['results']).to_not be nil
64
+ expect(response.body[1]['results']).to_not be nil
65
+ end
66
+ end
67
+ end
@@ -0,0 +1,87 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
18
+ # frozen_string_literal: true
19
+
20
+ require_relative "#{__dir__}/app_search_helper.rb"
21
+
22
+ describe Elastic::EnterpriseSearch::AppSearch::Client do
23
+ let(:engine_name) { 'search-settings' }
24
+
25
+ before do
26
+ create_engine(engine_name)
27
+ end
28
+
29
+ after do
30
+ delete_engines
31
+ end
32
+
33
+ context 'search settings' do
34
+ it 'returns engine search settings' do
35
+ response = client.search_settings(engine_name)
36
+
37
+ expect(response.status).to eq 200
38
+ expect(response.body['search_fields'])
39
+ expect(response.body['result_fields'])
40
+ expect(response.body['boosts'])
41
+ end
42
+
43
+ it 'updates search settings' do
44
+ client.put_schema(engine_name, schema: { year: 'number' })
45
+ documents = [
46
+ { title: 'Attack of the Giant Leeches', year: 1959, director: 'Bernard L. Kowalski' },
47
+ { title: '20,000 Leagues Under the Sea', year: 1916, director: 'Stuart Paton' },
48
+ { title: 'Indestructible Man', year: 1956, director: 'Jack Pollexfen' },
49
+ { title: 'Metropolis', year: 1927, director: 'Fritz Lang' }
50
+ ]
51
+ client.index_documents(engine_name, documents: documents)
52
+
53
+ body = {
54
+ boosts: {
55
+ year: [
56
+ {
57
+ type: 'proximity',
58
+ function: 'linear',
59
+ center: 1950,
60
+ factor: 9
61
+ }
62
+ ]
63
+ }
64
+ }
65
+ response = client.put_search_settings(engine_name, body: body)
66
+
67
+ expect(response.status).to eq 200
68
+ expect(response.body['boosts']).to eq(
69
+ {
70
+ 'year' => [
71
+ { 'type' => 'proximity',
72
+ 'function' => 'linear',
73
+ 'center' => 1950,
74
+ 'factor' => 9 }
75
+ ]
76
+ }
77
+ )
78
+ end
79
+
80
+ it 'resets search settings' do
81
+ response = client.reset_search_settings(engine_name)
82
+
83
+ expect(response.body['boosts']).to eq({})
84
+ expect(response.status).to eq 200
85
+ end
86
+ end
87
+ end
@@ -0,0 +1,79 @@
1
+ # Licensed to Elasticsearch B.V. under one or more contributor
2
+ # license agreements. See the NOTICE file distributed with
3
+ # this work for additional information regarding copyright
4
+ # ownership. Elasticsearch B.V. licenses this file to you under
5
+ # the Apache License, Version 2.0 (the "License"); you may
6
+ # not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing,
12
+ # software distributed under the License is distributed on an
13
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
+ # KIND, either express or implied. See the License for the
15
+ # specific language governing permissions and limitations
16
+ # under the License.
17
+
18
+ # frozen_string_literal: true
19
+
20
+ require_relative "#{__dir__}/app_search_helper.rb"
21
+
22
+ describe Elastic::EnterpriseSearch::AppSearch::Client do
23
+ let(:engine_name) { 'synonyms' }
24
+
25
+ before do
26
+ create_engine(engine_name)
27
+ end
28
+
29
+ after do
30
+ delete_engines
31
+ end
32
+
33
+ context 'Synonyms' do
34
+ it 'creates a synonym set' do
35
+ response = client.create_synonym_set(engine_name, body: { synonyms: ['joypad', 'gamepad'] })
36
+
37
+ expect(response.status).to eq 200
38
+ expect(response.body['synonyms'].sort).to eq ['gamepad', 'joypad']
39
+ expect(response.body['id'])
40
+ end
41
+
42
+ it 'lists synonym sets' do
43
+ client.create_synonym_set(engine_name, body: { synonyms: ['joypad', 'gamepad'] })
44
+ response = client.list_synonym_sets(engine_name)
45
+
46
+ expect(response.status).to eq 200
47
+ expect(response.body['results'].count).to be > 0
48
+ expect(response.body['results'].first['synonyms'].sort).to eq ['gamepad', 'joypad']
49
+ end
50
+
51
+ it 'retrieves a synonym set by ID' do
52
+ id = client.create_synonym_set(engine_name, body: { synonyms: ['joypad', 'gamepad'] }).body['id']
53
+ response = client.synonym_set(engine_name, synonym_set_id: id)
54
+
55
+ expect(response.status).to eq 200
56
+ expect(response.body).to eq({ 'id' => id, 'synonyms' => ['joypad', 'gamepad'] })
57
+ end
58
+
59
+ it 'updates a synonym set' do
60
+ id = client.create_synonym_set(engine_name, body: { synonyms: ['joypad', 'gamepad'] }).body['id']
61
+ response = client.put_synonym_set(
62
+ engine_name,
63
+ synonym_set_id: id,
64
+ body: { synonyms: ['gamepad', 'controller'] }
65
+ )
66
+
67
+ expect(response.status).to eq 200
68
+ expect(response.body).to eq({ 'id' => id, 'synonyms' => ['gamepad', 'controller'] })
69
+ end
70
+
71
+ it 'deletes a synonym set' do
72
+ id = client.create_synonym_set(engine_name, body: { synonyms: ['joypad', 'gamepad'] }).body['id']
73
+ response = @client.delete_synonym_set(engine_name, synonym_set_id: id)
74
+
75
+ expect(response.status).to eq 200
76
+ expect(response.body).to eq({ 'deleted' => true })
77
+ end
78
+ end
79
+ end