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,77 @@
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 'Crawler entry point' do
24
+ let(:engine_name) { 'crawler-entry-point' }
25
+ let(:name) { 'https://www.elastic.co' }
26
+
27
+ before do
28
+ create_engine(engine_name)
29
+ body = { name: name }
30
+ response = client.create_crawler_domain(engine_name, body: body)
31
+ @domain = response.body
32
+ end
33
+
34
+ after do
35
+ delete_engines
36
+ end
37
+
38
+ it 'creates an entry point' do
39
+ value = '/enterprise-search'
40
+ body = { value: value }
41
+ response = client.create_crawler_entry_point(engine_name, domain_id: @domain['id'], body: body)
42
+ expect(response.status).to eq 200
43
+ expect(response.body.keys).to eq(['id', 'value', 'created_at'])
44
+ expect(response.body['value']).to eq value
45
+ end
46
+
47
+ it 'updates an entry point' do
48
+ value = '/elastic-stack'
49
+ body = { value: value }
50
+ @entry_point = client.create_crawler_entry_point(engine_name, domain_id: @domain['id'], body: body).body
51
+
52
+ response = client.put_crawler_entry_point(
53
+ engine_name,
54
+ domain_id: @domain['id'],
55
+ entry_point_id: @entry_point['id'],
56
+ body: body
57
+ )
58
+ expect(response.status).to eq 200
59
+ expect(response.body.keys).to eq(['id', 'value', 'created_at'])
60
+ expect(response.body['value']).to eq value
61
+ end
62
+
63
+ it 'deletes an entry point' do
64
+ value = '/security'
65
+ body = { value: value }
66
+ @entry_point = client.create_crawler_entry_point(engine_name, domain_id: @domain['id'], body: body).body
67
+
68
+ response = client.delete_crawler_entry_point(
69
+ engine_name,
70
+ domain_id: @domain['id'],
71
+ entry_point_id: @entry_point['id']
72
+ )
73
+ expect(response.status).to eq 200
74
+ expect(response.body).to eq({ 'deleted' => true })
75
+ end
76
+ end
77
+ end
@@ -0,0 +1,46 @@
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 'Crawler metrics' do
24
+ let(:engine_name) { 'crawler-metrics' }
25
+ let(:name) { 'https://www.elastic.co' }
26
+
27
+ before do
28
+ create_engine(engine_name)
29
+ body = { name: name }
30
+ response = client.create_crawler_domain(engine_name, body: body)
31
+ @domain = response.body
32
+ end
33
+
34
+ after do
35
+ client.delete_engine(engine_name)
36
+ end
37
+
38
+ it 'retrieves crawler metrics' do
39
+ response = client.crawler_metrics
40
+ expect(response.status).to eq 200
41
+ expect(response.body.keys).to eq(['global', 'node'])
42
+ expect(response.body.dig('global', 'crawl_requests'))
43
+ expect(response.body.dig('node', 'workers'))
44
+ end
45
+ end
46
+ end
@@ -0,0 +1,45 @@
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 'Crawler overview' do
24
+ let(:engine_name) { 'crawler-overview' }
25
+ let(:name) { 'https://www.elastic.co' }
26
+
27
+ before do
28
+ create_engine(engine_name)
29
+ body = { name: name }
30
+ response = client.create_crawler_domain(engine_name, body: body)
31
+ @domain = response.body
32
+ end
33
+
34
+ after do
35
+ client.delete_engine(engine_name)
36
+ end
37
+
38
+ it 'retrieves crawler configuration overview' do
39
+ response = client.crawler_overview(engine_name)
40
+ expect(response.status).to eq 200
41
+ expect(response.body['domains'].count).to eq 1
42
+ expect(response.body['domains'].first['name']).to eq name
43
+ end
44
+ end
45
+ 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 'Crawler process crawl denied URLs' do
24
+ let(:engine_name) { 'crawler-process-crawl-denied-urls' }
25
+ let(:name) { 'https://www.elastic.co' }
26
+
27
+ before do
28
+ create_engine(engine_name)
29
+ body = { name: name }
30
+ response = client.create_crawler_domain(engine_name, body: body)
31
+ @domain = response.body
32
+ end
33
+
34
+ after do
35
+ client.delete_engine(engine_name)
36
+ end
37
+
38
+ it 'retrieves denied urls for process crawl' do
39
+ response = client.create_crawler_process_crawl(engine_name, body: { dry_run: true })
40
+ id = response.body['id']
41
+
42
+ response = client.crawler_process_crawl_denied_urls(engine_name, process_crawl_id: id)
43
+ expect(response.status).to eq 200
44
+ expect(
45
+ response.body.keys &
46
+ ['total_url_count', 'denied_url_count', 'sample_size', 'denied_urls_sample']
47
+ ).to eq response.body.keys
48
+ end
49
+ end
50
+ end
@@ -0,0 +1,66 @@
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 'Crawler Process Crawl' do
24
+ let(:engine_name) { 'crawler-urls' }
25
+ let(:name) { 'https://www.elastic.co' }
26
+
27
+ before do
28
+ create_engine(engine_name)
29
+ body = { name: name }
30
+ response = client.create_crawler_domain(engine_name, body: body)
31
+ @domain = response.body
32
+ end
33
+
34
+ after do
35
+ client.delete_engine(engine_name)
36
+ sleep 1
37
+ end
38
+
39
+ it 'creates, retrieves and shows denied for a process crawl' do
40
+ response = client.create_crawler_process_crawl(engine_name, body: { dry_run: true })
41
+ expect(response.status).to eq 200
42
+
43
+ id = response.body['id']
44
+ expect(response.body['dry_run']).to eq true
45
+ expect(response.body['domains']).to eq(['https://www.elastic.co'])
46
+
47
+ response = client.crawler_process_crawl(engine_name, process_crawl_id: id)
48
+ expect(response.status).to eq 200
49
+ expect(response.body['dry_run']).to eq true
50
+ expect(response.body['domains']).to eq(['https://www.elastic.co'])
51
+
52
+ response = client.denied_urls(engine_name, process_crawl_id: id)
53
+ expect(response.status).to eq 200
54
+ expect(response.body.keys).to eq(['total_url_count', 'denied_url_count', 'sample_size', 'denied_urls_sample'])
55
+ end
56
+
57
+ it 'lists process crawls' do
58
+ client.create_crawler_process_crawl(engine_name, body: { dry_run: true })
59
+ client.create_crawler_process_crawl(engine_name, body: { dry_run: true })
60
+
61
+ response = client.list_crawler_process_crawls(engine_name)
62
+ expect(response.status).to eq 200
63
+ expect(response.body.count).to be 2
64
+ end
65
+ end
66
+ end
@@ -0,0 +1,69 @@
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 'Crawler scheduling' do
24
+ let(:engine_name) { 'crawler-scheduling' }
25
+ let(:body) { { frequency: 1, unit: 'day' } }
26
+ let(:name) { 'https://www.elastic.co' }
27
+
28
+ before do
29
+ create_engine(engine_name)
30
+ body = { name: name }
31
+ response = client.create_crawler_domain(engine_name, body: body)
32
+ @domain = response.body
33
+ end
34
+
35
+ after do
36
+ delete_engines
37
+ end
38
+
39
+ it 'sets a crawl schedule' do
40
+ response = client.put_crawler_crawl_schedule(engine_name, body: body)
41
+ expect(response.status).to eq 200
42
+ expect(response.body).to eq({
43
+ 'engine' => engine_name,
44
+ 'frequency' => 1,
45
+ 'unit' => 'day'
46
+ })
47
+ end
48
+
49
+ it 'gets the crawl schedule' do
50
+ client.put_crawler_crawl_schedule(engine_name, body: body)
51
+
52
+ response = client.crawler_crawl_schedule(engine_name)
53
+ expect(response.status).to eq 200
54
+ expect(response.body).to eq({
55
+ 'engine' => engine_name,
56
+ 'frequency' => 1,
57
+ 'unit' => 'day'
58
+ })
59
+ end
60
+
61
+ it 'deletes a crawler crawl schedule' do
62
+ client.put_crawler_crawl_schedule(engine_name, body: body)
63
+
64
+ response = client.delete_crawler_crawl_schedule(engine_name)
65
+ expect(response.status).to eq 200
66
+ expect(response.body).to eq({ 'deleted' => true })
67
+ end
68
+ end
69
+ end
@@ -0,0 +1,72 @@
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 'Crawler Sitemap' do
24
+ let(:engine_name) { 'crawler-sitemap' }
25
+ let(:name) { 'https://www.elastic.co' }
26
+
27
+ before do
28
+ create_engine(engine_name)
29
+ body = { name: name }
30
+ response = client.create_crawler_domain(engine_name, body: body)
31
+ @domain = response.body
32
+ end
33
+
34
+ after do
35
+ client.delete_engine(engine_name)
36
+ end
37
+
38
+ it 'creates, updates and deletes a crawler sitemap configuration' do
39
+ # Create a sitemap
40
+ sitemap_url = 'https://www.elastic.co/sitemap.xml'
41
+ body = { url: sitemap_url }
42
+ response = client.create_crawler_sitemap(engine_name, domain_id: @domain['id'], body: body)
43
+ expect(response.status).to eq 200
44
+ expect(response.body.keys).to eq(['id', 'url', 'created_at'])
45
+ expect(response.body['url']).to eq(sitemap_url)
46
+
47
+ # Update a sitemap
48
+ sitemap_id = response.body['id']
49
+ sitemap_url = 'https://www.elastic.co/sitemap2.xml'
50
+ body = { url: sitemap_url }
51
+ response = client.put_crawler_sitemap(
52
+ engine_name,
53
+ domain_id: @domain['id'],
54
+ sitemap_id: sitemap_id,
55
+ body: body
56
+ )
57
+ expect(response.status).to eq 200
58
+ expect(response.body.keys).to eq(['id', 'url', 'created_at'])
59
+ expect(response.body['url']).to eq(sitemap_url)
60
+
61
+ # Delete sitemap
62
+ response = client.delete_crawler_sitemap(
63
+ engine_name,
64
+ domain_id: @domain['id'],
65
+ sitemap_id: sitemap_id
66
+ )
67
+
68
+ expect(response.status).to eq 200
69
+ expect(response.body).to eq({ 'deleted' => true })
70
+ end
71
+ end
72
+ end
@@ -0,0 +1,60 @@
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 'Crawler URLs' do
24
+ let(:engine_name) { 'crawler-urls' }
25
+ let(:name) { 'https://www.elastic.co' }
26
+
27
+ before do
28
+ create_engine(engine_name)
29
+ body = { name: name }
30
+ response = client.create_crawler_domain(engine_name, body: body)
31
+ @domain = response.body
32
+ end
33
+
34
+ after do
35
+ client.delete_engine(engine_name)
36
+ sleep 1
37
+ end
38
+
39
+ it 'validates a URL' do
40
+ response = client.crawler_url_validation_result(engine_name, url: name)
41
+ expect(response.status).to eq 200
42
+ expect(response.body['url']).to eq name
43
+ expect(response.body['valid']).to eq true
44
+ end
45
+
46
+ it 'extracts content from a URL' do
47
+ response = client.crawler_url_extraction_result(engine_name, url: name)
48
+ expect(response.status).to eq 200
49
+ expect(response.body.keys).to eq(['url', 'normalized_url', 'results'])
50
+ end
51
+
52
+ it 'traces history for a crawler URL' do
53
+ response = client.crawler_url_tracing_result(engine_name, url: name)
54
+ expect(response.status).to eq 200
55
+ expect(response.body['url']).to eq name
56
+ expect(response.body['normalized_url']).to eq "#{name}/"
57
+ expect(response.body['crawl_requests'])
58
+ end
59
+ end
60
+ end
@@ -17,18 +17,15 @@
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 'api_logs' do
25
- it 'returns api logs' do
26
- VCR.use_cassette('app_search/count_analytics') do
27
- response = @client.count_analytics('videogames')
23
+ context 'Crawler User Agent' do
24
+ it 'retrieves the user-agent header value for the crawler' do
25
+ response = client.crawler_user_agent
28
26
 
29
- expect(response.status).to eq 200
30
- expect(response.body['results'].count).to be > 1
31
- end
27
+ expect(response.status).to eq 200
28
+ expect(response.body['user_agent']).to match(/Elastic-Crawler\ \([0-9.]+\)/)
32
29
  end
33
30
  end
34
31
  end
@@ -0,0 +1,118 @@
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 'Curations' do
24
+ let(:engine_name) { 'books' }
25
+
26
+ before do
27
+ create_engine(engine_name)
28
+ documents = [
29
+ { title: 'Jungle Tales', author: 'Horacio Quiroga' },
30
+ { title: 'The Jungle Book', author: 'Rudyard Kipling' }
31
+ ]
32
+ response = client.index_documents(engine_name, documents: documents)
33
+
34
+ @promoted = response.body.first
35
+ @hidden = response.body.last
36
+ end
37
+ after do
38
+ client.delete_engine(engine_name)
39
+ sleep 1
40
+ end
41
+
42
+ it 'creates a new curation' do
43
+ response = create_curation(engine_name, 'jungle', @promoted['id'], @hidden['id'])
44
+ expect(response.status).to eq 200
45
+ expect(response.body['id']).to match(/cur-[0-9a-f]+/)
46
+
47
+ response = client.search(engine_name, query: 'jungle')
48
+ expect(response.status).to eq 200
49
+ expect(response.body['results'].count).to eq 1
50
+ expect(response.body['results'].first['title']['raw']).to eq 'Jungle Tales'
51
+ end
52
+
53
+ it 'retrieves a curation by id' do
54
+ id = create_curation(engine_name, 'book', @promoted['id'], @hidden['id']).body['id']
55
+
56
+ response = client.curation(engine_name, curation_id: id)
57
+
58
+ expect(response.status).to eq 200
59
+ expect(response.body['id']).to match(/cur-[0-9a-f]+/)
60
+ expect(response.body['queries']).to eq ['book']
61
+ expect(response.body['promoted']).to eq [@promoted['id']]
62
+ expect(response.body['hidden']).to eq [@hidden['id']]
63
+ end
64
+
65
+ def create_curation(name, query, promoted_id, hidden_id)
66
+ response = client.create_curation(
67
+ name,
68
+ queries: [query],
69
+ promoted: [promoted_id],
70
+ hidden: [hidden_id]
71
+ )
72
+ # Give the server a second
73
+ sleep 1
74
+ response
75
+ end
76
+
77
+ it 'updates an existing curation' do
78
+ id = create_curation(engine_name, 'jungle', @promoted['id'], @hidden['id']).body['id']
79
+
80
+ response = client.put_curation(
81
+ engine_name,
82
+ curation_id: id,
83
+ queries: ['jungle'],
84
+ promoted: [@hidden['id']],
85
+ hidden: [@promoted['id']]
86
+ )
87
+
88
+ expect(response.status).to eq 200
89
+ expect(response.body['id']).to match(/cur-[0-9a-f]+/)
90
+
91
+ response = @client.search(engine_name, query: 'jungle')
92
+ expect(response.status).to eq 200
93
+ expect(response.body['results'].count).to eq 1
94
+ expect(response.body['results'].first['title']['raw']).to eq 'The Jungle Book'
95
+ end
96
+
97
+ it 'lists curations' do
98
+ create_curation(engine_name, 'jungle', @promoted['id'], @hidden['id']).body['id']
99
+ create_curation(engine_name, 'book', @promoted['id'], @hidden['id']).body['id']
100
+ create_curation(engine_name, 'tales', @promoted['id'], @hidden['id']).body['id']
101
+
102
+ response = client.list_curations(engine_name)
103
+
104
+ expect(response.status).to eq 200
105
+ expect(response.body['results'].count).to eq 3
106
+ curation = response.body['results'].first
107
+ expect(curation['id']).to match(/cur-[0-9a-f]+/)
108
+ end
109
+
110
+ it 'deletes a curation' do
111
+ id = create_curation(engine_name, 'jungle', @promoted['id'], @hidden['id']).body['id']
112
+ response = client.delete_curation(engine_name, curation_id: id)
113
+
114
+ expect(response.status).to eq 200
115
+ expect(response.body).to eq({ 'deleted' => true })
116
+ end
117
+ end
118
+ end