elastic-enterprise-search 7.14.0 → 7.15.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (193) 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/.github/workflows/testing.yml +1 -1
  8. data/CONTRIBUTING.md +1 -1
  9. data/README.md +1 -1
  10. data/Rakefile +19 -0
  11. data/docs/guide/app-search-api.asciidoc +129 -1
  12. data/docs/guide/overview.asciidoc +3 -3
  13. data/docs/guide/release_notes/715.asciidoc +36 -0
  14. data/docs/guide/release_notes/index.asciidoc +2 -0
  15. data/docs/guide/workplace-search-api.asciidoc +14 -0
  16. data/lib/elastic/app-search/api/add_meta_engine_source.rb +3 -2
  17. data/lib/elastic/app-search/api/api_key.rb +2 -1
  18. data/lib/elastic/app-search/api/api_logs.rb +14 -13
  19. data/lib/elastic/app-search/api/count_analytics.rb +7 -6
  20. data/lib/elastic/app-search/api/crawler_active_crawl_request.rb +51 -0
  21. data/lib/elastic/app-search/api/crawler_crawl_request.rb +54 -0
  22. data/lib/elastic/app-search/api/crawler_crawl_schedule.rb +51 -0
  23. data/lib/elastic/app-search/api/crawler_domain.rb +54 -0
  24. data/lib/elastic/app-search/api/crawler_domain_validation_result.rb +48 -0
  25. data/lib/elastic/app-search/api/crawler_metrics.rb +48 -0
  26. data/lib/elastic/app-search/api/crawler_overview.rb +51 -0
  27. data/lib/elastic/app-search/api/crawler_process_crawl.rb +54 -0
  28. data/lib/elastic/app-search/api/crawler_process_crawl_denied_urls.rb +54 -0
  29. data/lib/elastic/app-search/api/crawler_url_extraction_result.rb +52 -0
  30. data/lib/elastic/app-search/api/crawler_url_tracing_result.rb +52 -0
  31. data/lib/elastic/app-search/api/crawler_url_validation_result.rb +52 -0
  32. data/lib/elastic/app-search/api/crawler_user_agent.rb +48 -0
  33. data/lib/elastic/app-search/api/create_api_key.rb +9 -1
  34. data/lib/elastic/app-search/api/create_crawler_crawl_request.rb +51 -0
  35. data/lib/elastic/app-search/api/create_crawler_crawl_rule.rb +59 -0
  36. data/lib/elastic/app-search/api/create_crawler_domain.rb +55 -0
  37. data/lib/elastic/app-search/api/create_crawler_entry_point.rb +56 -0
  38. data/lib/elastic/app-search/api/create_crawler_process_crawl.rb +53 -0
  39. data/lib/elastic/app-search/api/create_crawler_sitemap.rb +56 -0
  40. data/lib/elastic/app-search/api/create_curation.rb +7 -6
  41. data/lib/elastic/app-search/api/create_engine.rb +9 -7
  42. data/lib/elastic/app-search/api/create_synonym_set.rb +7 -4
  43. data/lib/elastic/app-search/api/curation.rb +4 -3
  44. data/lib/elastic/app-search/api/delete_active_crawl_request.rb +51 -0
  45. data/lib/elastic/app-search/api/delete_api_key.rb +1 -0
  46. data/lib/elastic/app-search/api/delete_crawler_active_crawl_request.rb +51 -0
  47. data/lib/elastic/app-search/api/delete_crawler_crawl_rule.rb +57 -0
  48. data/lib/elastic/app-search/api/delete_crawler_crawl_schedule.rb +51 -0
  49. data/lib/elastic/app-search/api/delete_crawler_domain.rb +54 -0
  50. data/lib/elastic/app-search/api/delete_crawler_entry_point.rb +57 -0
  51. data/lib/elastic/app-search/api/delete_crawler_sitemap.rb +57 -0
  52. data/lib/elastic/app-search/api/delete_curation.rb +4 -3
  53. data/lib/elastic/app-search/api/delete_documents.rb +2 -1
  54. data/lib/elastic/app-search/api/delete_engine.rb +3 -2
  55. data/lib/elastic/app-search/api/delete_meta_engine_source.rb +3 -3
  56. data/lib/elastic/app-search/api/delete_synonym_set.rb +4 -3
  57. data/lib/elastic/app-search/api/denied_urls.rb +54 -0
  58. data/lib/elastic/app-search/api/documents.rb +3 -2
  59. data/lib/elastic/app-search/api/engine.rb +3 -2
  60. data/lib/elastic/app-search/api/index_documents.rb +3 -2
  61. data/lib/elastic/app-search/api/list_api_keys.rb +2 -1
  62. data/lib/elastic/app-search/api/list_crawler_crawl_requests.rb +52 -0
  63. data/lib/elastic/app-search/api/list_crawler_process_crawls.rb +51 -0
  64. data/lib/elastic/app-search/api/list_curations.rb +3 -2
  65. data/lib/elastic/app-search/api/list_documents.rb +3 -2
  66. data/lib/elastic/app-search/api/list_engines.rb +2 -1
  67. data/lib/elastic/app-search/api/list_synonym_sets.rb +3 -2
  68. data/lib/elastic/app-search/api/log_clickthrough.rb +8 -10
  69. data/lib/elastic/app-search/api/put_api_key.rb +9 -2
  70. data/lib/elastic/app-search/api/put_crawler_crawl_rule.rb +62 -0
  71. data/lib/elastic/app-search/api/put_crawler_crawl_schedule.rb +53 -0
  72. data/lib/elastic/app-search/api/put_crawler_domain.rb +58 -0
  73. data/lib/elastic/app-search/api/put_crawler_entry_point.rb +59 -0
  74. data/lib/elastic/app-search/api/put_crawler_sitemap.rb +59 -0
  75. data/lib/elastic/app-search/api/put_curation.rb +9 -8
  76. data/lib/elastic/app-search/api/put_documents.rb +3 -3
  77. data/lib/elastic/app-search/api/put_schema.rb +4 -4
  78. data/lib/elastic/app-search/api/put_search_settings.rb +6 -2
  79. data/lib/elastic/app-search/api/put_synonym_set.rb +8 -5
  80. data/lib/elastic/app-search/api/query_suggestion.rb +7 -7
  81. data/lib/elastic/app-search/api/reset_search_settings.rb +3 -2
  82. data/lib/elastic/app-search/api/schema.rb +3 -2
  83. data/lib/elastic/app-search/api/search.rb +14 -3
  84. data/lib/elastic/app-search/api/search_settings.rb +3 -2
  85. data/lib/elastic/app-search/api/synonym_set.rb +4 -3
  86. data/lib/elastic/app-search/api/top_clicks_analytics.rb +8 -8
  87. data/lib/elastic/app-search/api/top_queries_analytics.rb +7 -7
  88. data/lib/elastic/app-search/app_search.rb +0 -10
  89. data/lib/elastic/enterprise-search/api/health.rb +1 -0
  90. data/lib/elastic/enterprise-search/api/put_read_only.rb +3 -2
  91. data/lib/elastic/enterprise-search/api/read_only.rb +1 -0
  92. data/lib/elastic/enterprise-search/api/version.rb +1 -0
  93. data/lib/elastic/enterprise-search/request.rb +10 -1
  94. data/lib/elastic/enterprise-search/version.rb +1 -1
  95. data/lib/elastic/workplace-search/api/auto_query_refinement_details.rb +49 -0
  96. data/lib/elastic/workplace-search/api/create_content_source.rb +1 -0
  97. data/lib/elastic/workplace-search/api/delete_synonym_set.rb +1 -1
  98. data/lib/elastic/workplace-search/api/put_content_source.rb +1 -0
  99. data/lib/elastic/workplace-search/api/put_synonym_set.rb +1 -1
  100. data/lib/elastic/workplace-search/api/put_triggers_blocklist.rb +47 -0
  101. data/lib/elastic/workplace-search/api/search.rb +3 -0
  102. data/lib/elastic/workplace-search/api/synonym_set.rb +1 -1
  103. data/{spec/app-search/api_logs_spec.rb → lib/elastic/workplace-search/api/triggers_blocklist.rb} +23 -14
  104. data/lib/elastic/workplace-search/workplace_search.rb +0 -15
  105. data/spec/integration/app-search/api_key_spec.rb +110 -0
  106. data/spec/integration/app-search/api_logs_spec.rb +59 -0
  107. data/spec/{app-search/api_spec_helper.rb → integration/app-search/app_search_helper.rb} +17 -8
  108. data/spec/integration/app-search/count_analytics_spec.rb +47 -0
  109. data/spec/integration/app-search/crawl_requests_spec.rb +86 -0
  110. data/spec/integration/app-search/crawler_crawl_rule_spec.rb +73 -0
  111. data/spec/integration/app-search/crawler_domain_spec.rb +82 -0
  112. data/spec/integration/app-search/crawler_entry_point_spec.rb +89 -0
  113. data/spec/integration/app-search/crawler_metrics_spec.rb +46 -0
  114. data/spec/integration/app-search/crawler_overview_spec.rb +45 -0
  115. data/spec/integration/app-search/crawler_process_crawl_denied_urls_spec.rb +50 -0
  116. data/spec/integration/app-search/crawler_process_crawl_spec.rb +66 -0
  117. data/spec/integration/app-search/crawler_scheduling_spec.rb +81 -0
  118. data/spec/integration/app-search/crawler_sitemap_spec.rb +72 -0
  119. data/spec/integration/app-search/crawler_urls_spec.rb +60 -0
  120. data/spec/{app-search/api_count_analytics_spec.rb → integration/app-search/crawler_user_agent_spec.rb} +6 -9
  121. data/spec/integration/app-search/curations_spec.rb +118 -0
  122. data/spec/integration/app-search/documents_spec.rb +123 -0
  123. data/spec/integration/app-search/engines_spec.rb +77 -0
  124. data/spec/{app-search/api_log_clickthrough_spec.rb → integration/app-search/log_clickthrough_spec.rb} +14 -7
  125. data/spec/integration/app-search/meta_engines_spec.rb +75 -0
  126. data/spec/integration/app-search/query_suggestion_spec.rb +50 -0
  127. data/spec/{app-search/api_schema_spec.rb → integration/app-search/schema_spec.rb} +21 -16
  128. data/spec/integration/app-search/search_and_multiple_search_spec.rb +67 -0
  129. data/spec/integration/app-search/search_settings_spec.rb +87 -0
  130. data/spec/integration/app-search/synonyms_spec.rb +79 -0
  131. data/spec/{app-search/api_top_clicks_analytics_spec.rb → integration/app-search/top_clicks_analytics_spec.rb} +20 -14
  132. data/spec/{app-search/api_top_queries_analytics_spec.rb → integration/app-search/top_queries_analytics_spec.rb} +16 -8
  133. data/spec/integration/workplace-search/content_sources_spec.rb +106 -0
  134. data/spec/integration/workplace-search/documents_spec.rb +95 -0
  135. data/spec/integration/workplace-search/external_identities_spec.rb +97 -0
  136. data/spec/integration/{icon.png → workplace-search/icon.png} +0 -0
  137. data/spec/integration/workplace-search/permissions_spec.rb +77 -0
  138. data/spec/integration/workplace-search/synonym_sets_spec.rb +92 -0
  139. data/spec/integration/workplace-search/triggers_spec.rb +43 -0
  140. data/spec/{app-search/api_query_suggestion_spec.rb → integration/workplace-search/users_spec.rb} +12 -15
  141. data/spec/integration/workplace-search/workplace_search_helper.rb +39 -0
  142. metadata +79 -64
  143. data/spec/app-search/api_apikey_spec.rb +0 -92
  144. data/spec/app-search/api_curations_spec.rb +0 -97
  145. data/spec/app-search/api_documents_spec.rb +0 -102
  146. data/spec/app-search/api_engines_spec.rb +0 -67
  147. data/spec/app-search/api_meta_engines_spec.rb +0 -72
  148. data/spec/app-search/api_search_and_multi_search_spec.rb +0 -48
  149. data/spec/app-search/api_search_settings_spec.rb +0 -76
  150. data/spec/app-search/api_synonyms_spec.rb +0 -79
  151. data/spec/fixtures/vcr/app_search/add_meta_engine_source.yml +0 -109
  152. data/spec/fixtures/vcr/app_search/api_documents.yml +0 -56
  153. data/spec/fixtures/vcr/app_search/api_index_documents.yml +0 -57
  154. data/spec/fixtures/vcr/app_search/api_log_clickthrough.yml +0 -54
  155. data/spec/fixtures/vcr/app_search/api_logs.yml +0 -70
  156. data/spec/fixtures/vcr/app_search/api_put_schema.yml +0 -109
  157. data/spec/fixtures/vcr/app_search/api_put_search_settings.yml +0 -56
  158. data/spec/fixtures/vcr/app_search/api_query_suggestion.yml +0 -59
  159. data/spec/fixtures/vcr/app_search/api_reset_search_settings.yml +0 -56
  160. data/spec/fixtures/vcr/app_search/api_schema.yml +0 -56
  161. data/spec/fixtures/vcr/app_search/api_search_settings.yml +0 -56
  162. data/spec/fixtures/vcr/app_search/api_top_clicks_analytics.yml +0 -55
  163. data/spec/fixtures/vcr/app_search/api_top_clicks_analytics_query.yml +0 -55
  164. data/spec/fixtures/vcr/app_search/api_top_queries_analytics.yml +0 -55
  165. data/spec/fixtures/vcr/app_search/count_analytics.yml +0 -55
  166. data/spec/fixtures/vcr/app_search/create_and_update_document.yml +0 -107
  167. data/spec/fixtures/vcr/app_search/create_api_key.yml +0 -52
  168. data/spec/fixtures/vcr/app_search/create_curation.yml +0 -113
  169. data/spec/fixtures/vcr/app_search/create_engine.yml +0 -55
  170. data/spec/fixtures/vcr/app_search/create_meta_engine.yml +0 -56
  171. data/spec/fixtures/vcr/app_search/create_synonym_set.yml +0 -56
  172. data/spec/fixtures/vcr/app_search/delete_api_key.yml +0 -52
  173. data/spec/fixtures/vcr/app_search/delete_curation.yml +0 -56
  174. data/spec/fixtures/vcr/app_search/delete_engine.yml +0 -55
  175. data/spec/fixtures/vcr/app_search/delete_meta_engine_source.yml +0 -56
  176. data/spec/fixtures/vcr/app_search/delete_synonym_set.yml +0 -56
  177. data/spec/fixtures/vcr/app_search/get_api_key.yml +0 -52
  178. data/spec/fixtures/vcr/app_search/get_curation.yml +0 -56
  179. data/spec/fixtures/vcr/app_search/get_engine.yml +0 -55
  180. data/spec/fixtures/vcr/app_search/index_and_delete_document.yml +0 -107
  181. data/spec/fixtures/vcr/app_search/list_api_keys.yml +0 -52
  182. data/spec/fixtures/vcr/app_search/list_curations.yml +0 -56
  183. data/spec/fixtures/vcr/app_search/list_documents.yml +0 -57
  184. data/spec/fixtures/vcr/app_search/list_engines.yml +0 -55
  185. data/spec/fixtures/vcr/app_search/list_synonym_sets.yml +0 -56
  186. data/spec/fixtures/vcr/app_search/multi_query_search.yml +0 -63
  187. data/spec/fixtures/vcr/app_search/put_api_key.yml +0 -52
  188. data/spec/fixtures/vcr/app_search/put_curation.yml +0 -113
  189. data/spec/fixtures/vcr/app_search/put_synonym_set.yml +0 -56
  190. data/spec/fixtures/vcr/app_search/search.yml +0 -57
  191. data/spec/fixtures/vcr/app_search/single_query_search.yml +0 -60
  192. data/spec/fixtures/vcr/app_search/synonym_set.yml +0 -56
  193. data/spec/integration/workplace_search_spec.rb +0 -375
@@ -33,6 +33,7 @@ module Elastic
33
33
  # @option body [Boolean] :is_searchable Whether or not this Content Source will be searchable on the search page. (*Required)
34
34
  # @option body :indexing
35
35
  # @option body :facets
36
+ # @option body :automatic_query_refinement
36
37
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
37
38
  #
38
39
  # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-content-sources-api.html#update-content-source-api
@@ -25,7 +25,7 @@ module Elastic
25
25
  # Update a synonym set
26
26
  #
27
27
  # @param arguments [Hash] endpoint arguments
28
- # @option arguments [String] :synonym_set_id Unique ID for a content source document. Provided upon or returned at creation. (*Required*)
28
+ # @option arguments [String] :synonym_set_id Synonym Set ID (*Required*)
29
29
  # @option arguments [Hash] :body (Required: synonyms)
30
30
  # @option body [Array] :synonyms A list of terms for this synonym set (*Required)
31
31
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
@@ -0,0 +1,47 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Licensed to Elasticsearch B.V. under one or more contributor
4
+ # license agreements. See the NOTICE file distributed with
5
+ # this work for additional information regarding copyright
6
+ # ownership. Elasticsearch B.V. licenses this file to you under
7
+ # the Apache License, Version 2.0 (the "License"); you may
8
+ # not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing,
14
+ # software distributed under the License is distributed on an
15
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16
+ # KIND, either express or implied. See the License for the
17
+ # specific language governing permissions and limitations
18
+ # under the License.
19
+
20
+ module Elastic
21
+ module EnterpriseSearch
22
+ module WorkplaceSearch
23
+ module Actions
24
+ # Update current triggers blocklist
25
+ #
26
+ # @param arguments [Hash] endpoint arguments
27
+ # @option arguments [Hash] :body The request body
28
+ # @option arguments [Hash] :headers optional HTTP headers to send with the request
29
+ #
30
+ # @see https://www.elastic.co/guide/en/workplace-search/current/automatic-query-refinement-blocklist.html
31
+ #
32
+ def put_triggers_blocklist(arguments = {})
33
+ body = arguments.delete(:body) || {}
34
+ headers = arguments.delete(:headers) || {}
35
+
36
+ request(
37
+ :put,
38
+ 'api/ws/v1/automatic_query_refinement/',
39
+ arguments,
40
+ body,
41
+ headers
42
+ )
43
+ end
44
+ end
45
+ end
46
+ end
47
+ end
@@ -36,6 +36,9 @@ module Elastic
36
36
  # @option body :sort
37
37
  # @option body [Object] :facets
38
38
  # @option body [Object] :boosts
39
+ # @option body :source_type Optional parameter to search standard, remote only, or all available sources
40
+ # @option body [Integer] :timeout Optional timeout in ms for searching remote sources
41
+ # @option body [Array] :content_sources Optional list of content source ids to only return results from
39
42
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
40
43
  #
41
44
  # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-search-api.html
@@ -25,7 +25,7 @@ module Elastic
25
25
  # Retrieve a synonym set by ID
26
26
  #
27
27
  # @param arguments [Hash] endpoint arguments
28
- # @option arguments [String] :synonym_set_id Unique ID for a content source document. Provided upon or returned at creation. (*Required*)
28
+ # @option arguments [String] :synonym_set_id Synonym Set ID (*Required*)
29
29
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
30
30
  #
31
31
  # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-synonyms-api.html#show-synonym
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # Licensed to Elasticsearch B.V. under one or more contributor
2
4
  # license agreements. See the NOTICE file distributed with
3
5
  # this work for additional information regarding copyright
@@ -15,21 +17,28 @@
15
17
  # specific language governing permissions and limitations
16
18
  # under the License.
17
19
 
18
- # frozen_string_literal: true
19
-
20
- require_relative './api_spec_helper'
20
+ module Elastic
21
+ module EnterpriseSearch
22
+ module WorkplaceSearch
23
+ module Actions
24
+ # Get current triggers blocklist
25
+ #
26
+ # @param arguments [Hash] endpoint arguments
27
+ # @option arguments [Hash] :headers optional HTTP headers to send with the request
28
+ #
29
+ # @see https://www.elastic.co/guide/en/workplace-search/current/automatic-query-refinement-blocklist.html
30
+ #
31
+ def triggers_blocklist(arguments = {})
32
+ headers = arguments.delete(:headers) || {}
21
33
 
22
- describe Elastic::EnterpriseSearch::AppSearch::Client do
23
- context 'api_logs' do
24
- it 'returns api logs' do
25
- VCR.use_cassette('app_search/api_logs') do
26
- response = @client.api_logs(
27
- 'videogames',
28
- from_date: Date.new(2020, 10, 0o1),
29
- to_date: Date.new(2020, 11, 0o5)
30
- )
31
- expect(response.status).to eq 200
32
- expect(response.body['results'].count).to be > 1
34
+ request(
35
+ :get,
36
+ 'api/ws/v1/automatic_query_refinement/',
37
+ arguments,
38
+ {},
39
+ headers
40
+ )
41
+ end
33
42
  end
34
43
  end
35
44
  end
@@ -21,25 +21,10 @@ module Elastic
21
21
  module EnterpriseSearch
22
22
  # Workplace Search client for Enterprise Search.
23
23
  module WorkplaceSearch
24
- # The Request module is included in the WorkplaceSearch Client to override
25
- # EnterpriseSearch client's authentication method with Workplace's
26
- # authentication.
27
- module Request
28
- def setup_authentication_header
29
- case http_auth
30
- when Hash
31
- basic_auth_header
32
- when String
33
- "Bearer #{http_auth}"
34
- end
35
- end
36
- end
37
-
38
24
  # The Workplace Search Client
39
25
  # Extends EnterpriseSearch client but overrides authentication to use access token.
40
26
  class Client < Elastic::EnterpriseSearch::Client
41
27
  include Elastic::EnterpriseSearch::WorkplaceSearch::Actions
42
- include Elastic::EnterpriseSearch::WorkplaceSearch::Request
43
28
  include Elastic::EnterpriseSearch::Utils
44
29
 
45
30
  # Create a new Elastic::EnterpriseSearch::WorkplaceSearch::Client client
@@ -0,0 +1,110 @@
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 'API Key' do
24
+ it 'creates and deletes an API key' do
25
+ name = 'created-key'
26
+ body = { name: name, type: 'private', read: true, write: true, access_all_engines: true }
27
+ response = client.create_api_key(body: body)
28
+
29
+ expect(response.status).to eq 200
30
+ expect(response.body.keys).to include('id')
31
+ expect(response.body.keys).to include('key')
32
+ expect(response.body).to include('name' => name)
33
+ expect(response.body).to include('type' => 'private')
34
+ expect(response.body).to include('read' => true)
35
+ expect(response.body).to include('write' => true)
36
+ expect(response.body).to include('access_all_engines' => true)
37
+
38
+ response = client.delete_api_key(api_key_name: name)
39
+
40
+ expect(response.status).to eq 200
41
+ expect(response.body).to eq({ 'deleted' => true })
42
+ end
43
+
44
+ it 'gets the details of an API key' do
45
+ name = 'details-key'
46
+ body = { name: name, type: 'private', read: true, write: true, access_all_engines: true }
47
+ client.create_api_key(body: body)
48
+
49
+ response = client.api_key(api_key_name: name)
50
+
51
+ expect(response.status).to eq 200
52
+ expect(response.body.keys).to include('id')
53
+ expect(response.body.keys).to include('key')
54
+ expect(response.body).to include('name' => name)
55
+ expect(response.body).to include('type' => 'private')
56
+ expect(response.body).to include('read' => true)
57
+ expect(response.body).to include('write' => true)
58
+ expect(response.body).to include('access_all_engines' => true)
59
+ expect(response.body)
60
+
61
+ client.delete_api_key(api_key_name: name)
62
+ end
63
+
64
+ it 'updates an API key' do
65
+ key_name = 'updates-key'
66
+ engine_name = 'update-engine'
67
+ body = { name: key_name, type: 'private', read: true, write: true, access_all_engines: true }
68
+ client.create_api_key(body: body)
69
+ client.create_engine(name: engine_name)
70
+
71
+ body = { name: key_name, type: 'private', read: true, write: true, engines: [engine_name] }
72
+ attempts = 0
73
+ begin
74
+ response = put_api_key(key_name, body)
75
+ # Since we're creating the API key and trying to update it right away, we sometimes get a 404
76
+ # if the transaction hasn't been confirmed. We give it a second and try again for a few times:
77
+ rescue Elasticsearch::Transport::Transport::Errors::NotFound
78
+ attempts += 1
79
+ if attempts > 5
80
+ Logger.new($stdout).log('Attempted 6 times')
81
+ raise e
82
+ end
83
+
84
+ sleep 1
85
+ response = put_api_key(key_name, body)
86
+ end
87
+ expect(response.status).to eq 200
88
+ expect(response.body['engines']).to eq [engine_name]
89
+ client.delete_engine(engine_name)
90
+ end
91
+
92
+ def put_api_key(key_name, body)
93
+ client.put_api_key(api_key_name: key_name, body: body)
94
+ end
95
+
96
+ it 'lists API keys' do
97
+ body = { name: 'api-key-1', type: 'private', read: true, write: true, access_all_engines: true }
98
+ client.create_api_key(body: body)
99
+ body = { name: 'api-key-2', type: 'private', read: true, write: true, access_all_engines: true }
100
+ client.create_api_key(body: body)
101
+
102
+ response = client.list_api_keys
103
+ expect(response.status).to eq 200
104
+ expect(response.body['results'].select { |r| ['api-key-1', 'api-key-2'].include? r['name'] }.count).to be 2
105
+ expect(response.body['results'].count).to be >= 2
106
+ client.delete_api_key(api_key_name: 'api-key-1')
107
+ client.delete_api_key(api_key_name: 'api-key-2')
108
+ end
109
+ end
110
+ end
@@ -0,0 +1,59 @@
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 'API logs' do
24
+ let(:engine_name) { 'videogames' }
25
+ let(:api_key_name) { 'logs-api-key' }
26
+
27
+ before do
28
+ client.create_engine(name: engine_name)
29
+ # Create API Key Client to log events:
30
+ body = { name: api_key_name, type: 'private', read: true, write: true, access_all_engines: true }
31
+ api_key = client.create_api_key(body: body).body['key']
32
+ private_key_client = Elastic::EnterpriseSearch::AppSearch::Client.new(
33
+ host: ENV['ELASTIC_ENTERPRISE_HOST'] || 'http://localhost:3002',
34
+ http_auth: api_key
35
+ )
36
+ id = private_key_client.index_documents(engine_name, documents: [{ title: 'Test Document' }]).body.first['id']
37
+ private_key_client.documents(engine_name, document_ids: [id])
38
+ private_key_client.delete_documents(engine_name, document_ids: [id])
39
+ end
40
+
41
+ after do
42
+ client.delete_engine(engine_name)
43
+ client.delete_api_key(api_key_name: api_key_name)
44
+ end
45
+
46
+ it 'returns api logs' do
47
+ response = client.api_logs(engine_name, from_date: Date.today - 1, to_date: Date.today + 1)
48
+ expect(response.status).to eq 200
49
+
50
+ attempts = 0
51
+ while response.body['results'].count < 1 && attempts < 20
52
+ sleep 1
53
+ attempts += 1
54
+ response = client.api_logs(engine_name, from_date: Date.today - 1, to_date: Date.today + 1)
55
+ end
56
+ expect(response.body['results'].count).to be >= 1
57
+ end
58
+ end
59
+ end
@@ -14,17 +14,26 @@
14
14
  # KIND, either express or implied. See the License for the
15
15
  # specific language governing permissions and limitations
16
16
  # under the License.
17
+
17
18
  # frozen_string_literal: true
18
19
 
19
20
  require 'spec_helper'
20
21
 
21
- RSpec.configure do |config|
22
- config.before(:example) do
23
- @host = ENV['ELASTIC_ENTERPRISE_HOST'] || 'http://localhost:3002'
24
- @api_key = ENV['ELASTIC_APPSEARCH_API_KEY'] || 'api_key'
25
- @client = Elastic::EnterpriseSearch::AppSearch::Client.new(
26
- host: @host,
27
- http_auth: @api_key
28
- )
22
+ # App Search Integration tests Client Configuration
23
+ def client
24
+ @client ||= Elastic::EnterpriseSearch::AppSearch::Client.new(
25
+ host: ENV['ELASTIC_ENTERPRISE_HOST'] || 'http://localhost:3002',
26
+ http_auth: {
27
+ user: ENV['ELASTIC_ENTERPRISE_USER'] || 'enterprise_search',
28
+ password: ENV['ELASTIC_ENTERPRISE_PASSWORD'] || 'changeme'
29
+ }
30
+ )
31
+ end
32
+
33
+ def delete_engines
34
+ engines = client.list_engines.body['results']
35
+ engines.each do |engine|
36
+ client.delete_engine(engine['name'])
29
37
  end
38
+ sleep 1
30
39
  end
@@ -0,0 +1,47 @@
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
+ describe Elastic::EnterpriseSearch::AppSearch::Client do
22
+ context 'Count Analytics' do
23
+ let(:engine_name) { 'count-analytics' }
24
+
25
+ before do
26
+ client.create_engine(name: engine_name)
27
+ sleep 1
28
+ end
29
+
30
+ after do
31
+ delete_engines
32
+ end
33
+
34
+ it 'returns count analytics' do
35
+ response = client.count_analytics(engine_name)
36
+
37
+ expect(response.status).to eq 200
38
+ expect(response.body['results'].count).to be > 1
39
+ end
40
+
41
+ it 'returns count analytics with filters' do
42
+ response = client.count_analytics(engine_name, body: { filters: { tag: 'web' } })
43
+ expect(response.status).to eq 200
44
+ expect(response.body['results'].count).to be > 1
45
+ end
46
+ end
47
+ end
@@ -0,0 +1,86 @@
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 crawl requests' do
24
+ let(:engine_name) { 'crawler-requests' }
25
+ let(:name) { 'https://www.elastic.co' }
26
+
27
+ before do
28
+ client.create_engine(name: 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_crawler_active_crawl_request(engine_name)
36
+ delete_engines
37
+ end
38
+
39
+ it 'creates, gets, lists and deletes a crawl request' do
40
+ response = client.create_crawler_crawl_request(engine_name)
41
+
42
+ expect(response.status).to eq 200
43
+ expect(response.body.keys).to include('status')
44
+ expect(response.body.keys).to include('id')
45
+ request_id = response.body['id']
46
+
47
+ # get crawl request
48
+ response = client.crawler_crawl_request(engine_name, crawl_request_id: request_id)
49
+ expect(response.status).to eq 200
50
+ expect(response.body.keys).to include('status')
51
+ expect(response.body.keys).to include('id')
52
+
53
+ # get active crawl request details
54
+ response = client.crawler_active_crawl_request(engine_name)
55
+ expect(response.status).to eq 200
56
+ expect(response.body.keys).to include('status')
57
+ expect(response.body.keys).to include('id')
58
+
59
+ attempts = 0
60
+ while response.body['status'] != 'running' && attempts < 20
61
+ sleep 1
62
+ attempts += 1
63
+ response = client.crawler_active_crawl_request(engine_name)
64
+ end
65
+ expect(response.body['status']).to eq 'running'
66
+
67
+ # list crawl requests
68
+ response = client.list_crawler_crawl_requests(engine_name)
69
+ expect(response.status).to eq 200
70
+
71
+ # delete active crawl request
72
+ response = client.delete_active_crawl_request(engine_name)
73
+ expect(response.status).to eq 200
74
+ end
75
+
76
+ it 'creates, starts and stops a crawl request' do
77
+ response = client.create_crawler_crawl_request(engine_name)
78
+ request_id = response.body['id']
79
+
80
+ response = client.delete_crawler_active_crawl_request(engine_name)
81
+ expect(response.status).to eq 200
82
+ expect(response.body['id']).to eq request_id
83
+ expect(response.body['status']).to eq('canceling')
84
+ end
85
+ end
86
+ end
@@ -0,0 +1,73 @@
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 crawl rules' do
24
+ let(:engine_name) { 'crawler-crawl-rule' }
25
+ let(:name) { 'https://www.elastic.co' }
26
+
27
+ before do
28
+ client.create_engine(name: 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 rule' do
39
+ # Create a crawler crawl rule
40
+ body = { order: 1, policy: 'allow', rule: 'contains', pattern: '/stack' }
41
+ response = client.create_crawler_crawl_rule(engine_name, domain_id: @domain['id'], body: body)
42
+ expect(response.status).to eq 200
43
+ rule_id = response.body['id']
44
+ expect(response.body['order']).to eq 1
45
+ expect(response.body['policy']).to eq 'allow'
46
+ expect(response.body['rule']).to eq 'contains'
47
+ expect(response.body['pattern']).to eq '/stack'
48
+
49
+ # Update a crawler crawl rule
50
+ body = { order: 2, policy: 'allow', rule: 'begins', pattern: '/stack' }
51
+ response = client.put_crawler_crawl_rule(
52
+ engine_name,
53
+ domain_id: @domain['id'],
54
+ crawl_rule_id: rule_id,
55
+ body: body
56
+ )
57
+ expect(response.status).to eq 200
58
+ expect(response.body['order']).to eq 2
59
+ expect(response.body['policy']).to eq 'allow'
60
+ expect(response.body['rule']).to eq 'begins'
61
+ expect(response.body['pattern']).to eq '/stack'
62
+
63
+ # Delete a crawler crawl rule
64
+ response = client.delete_crawler_crawl_rule(
65
+ engine_name,
66
+ domain_id: @domain['id'],
67
+ crawl_rule_id: rule_id
68
+ )
69
+ expect(response.status).to eq 200
70
+ expect(response.body).to eq({ 'deleted' => true })
71
+ end
72
+ end
73
+ end
@@ -0,0 +1,82 @@
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 Domain' do
24
+ let(:engine_name) { 'crawler' }
25
+ let(:name) { 'https://www.elastic.co' }
26
+
27
+ before do
28
+ client.create_engine(name: engine_name)
29
+ end
30
+
31
+ after do
32
+ client.delete_crawler_domain(engine_name, domain_id: @domain['id'])
33
+ client.delete_engine(engine_name)
34
+ sleep 1
35
+ end
36
+
37
+ it 'creates and gets a crawler domain' do
38
+ body = { name: name }
39
+ response = client.create_crawler_domain(engine_name, body: body)
40
+ @domain = response.body
41
+
42
+ expect(response.status).to eq 200
43
+ expect(response.body['id']).to eq @domain['id']
44
+ expect(response.body).to include('name' => name)
45
+
46
+ # client.crawler_domain
47
+ response = client.crawler_domain(engine_name, domain_id: @domain['id'])
48
+ expect(response.status).to eq 200
49
+ expect(response.body['id']).to eq @domain['id']
50
+ expect(response.body).to include('name' => name)
51
+ end
52
+
53
+ it 'creates and updates a crawler domain' do
54
+ body = { name: name }
55
+ response = client.create_crawler_domain(engine_name, body: body)
56
+ @domain = response.body
57
+
58
+ expect(response.status).to eq 200
59
+ expect(response.body['id']).to eq @domain['id']
60
+ expect(response.body).to include('name' => name)
61
+
62
+ new_name = 'https://www.wikipedia.org'
63
+ body = { name: new_name }
64
+ response = client.put_crawler_domain(engine_name, domain_id: @domain['id'], domain: body)
65
+
66
+ expect(response.status).to eq 200
67
+ expect(response.body['id']).to eq @domain['id']
68
+ expect(response.body).to include('name' => new_name)
69
+ end
70
+
71
+ it 'validates a domain' do
72
+ body = { name: name }
73
+ @domain = client.create_crawler_domain(engine_name, body: body).body
74
+ body = { url: name }
75
+ response = client.crawler_domain_validation_result(body: body)
76
+
77
+ expect(response.status).to eq 200
78
+ expect(response.body['url']).to eq name
79
+ expect(response.body['valid']).to eq true
80
+ end
81
+ end
82
+ end