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
@@ -1,56 +0,0 @@
1
- ---
2
- http_interactions:
3
- - request:
4
- method: put
5
- uri: http://localhost:3002/api/as/v1/engines/videogames/synonyms/id/?synonym_set_id=id
6
- body:
7
- encoding: UTF-8
8
- string: '{"synonyms":["gamepad","controller"]}'
9
- headers:
10
- User-Agent:
11
- - 'elastic-enteprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
12
- elasticsearch-transport: 7.10.0)'
13
- Content-Type:
14
- - application/json
15
- Authorization:
16
- - Bearer api_key
17
- Accept-Encoding:
18
- - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
19
- Accept:
20
- - "*/*"
21
- response:
22
- status:
23
- code: 200
24
- message: OK
25
- headers:
26
- X-Frame-Options:
27
- - SAMEORIGIN
28
- X-Xss-Protection:
29
- - 1; mode=block
30
- X-Content-Type-Options:
31
- - nosniff
32
- X-App-Search-Version:
33
- - 7.12.0
34
- Content-Type:
35
- - application/json;charset=utf-8
36
- Vary:
37
- - Accept-Encoding, User-Agent
38
- - Origin
39
- Etag:
40
- - W/"9ca5aeb3eb725b1f89da70ecaa22732a--gzip"
41
- Cache-Control:
42
- - max-age=0, private, must-revalidate
43
- X-Request-Id:
44
- - 135930bd-6383-4f57-af0f-c8ad6e8091fd
45
- X-Runtime:
46
- - '0.066131'
47
- Transfer-Encoding:
48
- - chunked
49
- Server:
50
- - Jetty(9.4.33.v20201020)
51
- body:
52
- encoding: ASCII-8BIT
53
- string: '{"id":"id","synonyms":["gamepad","controller"]}'
54
- http_version:
55
- recorded_at: Thu, 14 Jan 2021 11:10:25 GMT
56
- recorded_with: VCR 3.0.3
@@ -1,57 +0,0 @@
1
- ---
2
- http_interactions:
3
- - request:
4
- method: post
5
- uri: http://localhost:3002/api/as/v1/engines/videogames/search/
6
- body:
7
- encoding: UTF-8
8
- string: '{"query":"Pack-Man"}'
9
- headers:
10
- User-Agent:
11
- - 'elastic-enteprise-search-ruby/0.0.1 (RUBY_VERSION: 2.7.1; linux x86_64; elasticsearch-transport:
12
- 8.0.0.pre)'
13
- Content-Type:
14
- - application/json
15
- Authorization:
16
- - Bearer api_key
17
- Accept-Encoding:
18
- - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
19
- Accept:
20
- - "*/*"
21
- response:
22
- status:
23
- code: 200
24
- message: OK
25
- headers:
26
- X-Frame-Options:
27
- - SAMEORIGIN
28
- X-Xss-Protection:
29
- - 1; mode=block
30
- X-Content-Type-Options:
31
- - nosniff
32
- X-App-Search-Version:
33
- - 7.10.0
34
- X-St-Internal-Rails-Version:
35
- - 4.2.11.3
36
- Content-Type:
37
- - application/json;charset=utf-8
38
- Vary:
39
- - Origin
40
- Etag:
41
- - W/"6944875da062e5f8180006ee7a911911"
42
- Cache-Control:
43
- - max-age=0, private, must-revalidate
44
- X-Request-Id:
45
- - 435a5809-d036-4d78-9199-58d99209f3fb
46
- X-Runtime:
47
- - '0.112800'
48
- Transfer-Encoding:
49
- - chunked
50
- Server:
51
- - Jetty(9.4.30.v20200611)
52
- body:
53
- encoding: UTF-8
54
- string: '{"meta":{"alerts":[],"warnings":[],"page":{"current":1,"total_pages":1,"total_results":1,"size":10},"engine":{"name":"videogames","type":"default"},"request_id":"435a5809-d036-4d78-9199-58d99209f3fb"},"results":[{"name":{"raw":"Pack-Man"},"year":{"raw":"1980"},"_meta":{"id":"doc-5fa1e04d389ab9c9bb5be385","engine":"videogames","score":1.9132978},"id":{"raw":"doc-5fa1e04d389ab9c9bb5be385"}}]}'
55
- http_version:
56
- recorded_at: Tue, 03 Nov 2020 22:58:58 GMT
57
- recorded_with: VCR 3.0.3
@@ -1,60 +0,0 @@
1
- ---
2
- http_interactions:
3
- - request:
4
- method: post
5
- uri: http://localhost:3002/api/as/v1/engines/books/search/?query=Herman
6
- body:
7
- encoding: UTF-8
8
- string: "{}"
9
- headers:
10
- User-Agent:
11
- - 'elastic-enteprise-search-ruby/0.0.1 (RUBY_VERSION: 2.7.1; linux x86_64; elasticsearch-transport:
12
- 7.9.0)'
13
- Content-Type:
14
- - application/json
15
- Authorization:
16
- - Bearer api_key
17
- Accept-Encoding:
18
- - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
19
- Accept:
20
- - "*/*"
21
- response:
22
- status:
23
- code: 200
24
- message: OK
25
- headers:
26
- X-Frame-Options:
27
- - SAMEORIGIN
28
- X-Xss-Protection:
29
- - 1; mode=block
30
- X-Content-Type-Options:
31
- - nosniff
32
- X-App-Search-Version:
33
- - 7.10.0
34
- X-St-Internal-Rails-Version:
35
- - 4.2.11.3
36
- Content-Type:
37
- - application/json;charset=utf-8
38
- Vary:
39
- - Origin
40
- Etag:
41
- - W/"1a01d8266da629691e392eb8e94f1b17"
42
- Cache-Control:
43
- - max-age=0, private, must-revalidate
44
- X-Request-Id:
45
- - ee597b23-112f-4656-b7b7-11107557145b
46
- X-Runtime:
47
- - '0.040581'
48
- Transfer-Encoding:
49
- - chunked
50
- Server:
51
- - Jetty(9.4.30.v20200611)
52
- body:
53
- encoding: UTF-8
54
- string: '{"meta":{"alerts":[],"warnings":[],"page":{"current":1,"total_pages":1,"total_results":2,"size":10},"engine":{"name":"books","type":"default"},"request_id":"ee597b23-112f-4656-b7b7-11107557145b"},"results":[{"title":{"raw":"Moby
55
- Dick; Or, The Whale"},"_meta":{"id":"doc-5fa5b01a2a88e93a83aa1c59","engine":"books","score":2.2699733},"id":{"raw":"doc-5fa5b01a2a88e93a83aa1c59"},"author":{"raw":"Herman
56
- Melville"}},{"title":{"raw":"Siddhartha"},"_meta":{"id":"doc-5fa5b6e52a88e93a83aa1c69","engine":"books","score":0.26182064},"id":{"raw":"doc-5fa5b6e52a88e93a83aa1c69"},"author":{"raw":"Hermann
57
- Hesse"}}]}'
58
- http_version:
59
- recorded_at: Fri, 06 Nov 2020 22:13:10 GMT
60
- recorded_with: VCR 3.0.3
@@ -1,56 +0,0 @@
1
- ---
2
- http_interactions:
3
- - request:
4
- method: get
5
- uri: http://localhost:3002/api/as/v1/engines/videogames/synonyms/id/?synonym_set_id=id
6
- body:
7
- encoding: UTF-8
8
- string: "{}"
9
- headers:
10
- User-Agent:
11
- - 'elastic-enteprise-search-ruby/7.11.0.pre (RUBY_VERSION: 2.7.2; linux x86_64;
12
- elasticsearch-transport: 7.10.0)'
13
- Content-Type:
14
- - application/json
15
- Authorization:
16
- - Bearer api_key
17
- Accept-Encoding:
18
- - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
19
- Accept:
20
- - "*/*"
21
- response:
22
- status:
23
- code: 200
24
- message: OK
25
- headers:
26
- X-Frame-Options:
27
- - SAMEORIGIN
28
- X-Xss-Protection:
29
- - 1; mode=block
30
- X-Content-Type-Options:
31
- - nosniff
32
- X-App-Search-Version:
33
- - 7.12.0
34
- Content-Type:
35
- - application/json;charset=utf-8
36
- Vary:
37
- - Accept-Encoding, User-Agent
38
- - Origin
39
- Etag:
40
- - W/"73484e0e55190b38a77a06f0c93dcd27--gzip"
41
- Cache-Control:
42
- - max-age=0, private, must-revalidate
43
- X-Request-Id:
44
- - '04997dca-6669-40d8-804b-6dad2d222a94'
45
- X-Runtime:
46
- - '0.028868'
47
- Transfer-Encoding:
48
- - chunked
49
- Server:
50
- - Jetty(9.4.33.v20201020)
51
- body:
52
- encoding: ASCII-8BIT
53
- string: '{"id":"id","synonyms":["joypad","gamepad"]}'
54
- http_version:
55
- recorded_at: Thu, 14 Jan 2021 11:06:02 GMT
56
- recorded_with: VCR 3.0.3
@@ -1,375 +0,0 @@
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 'spec_helper'
21
- require 'base64'
22
-
23
- describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
24
- let(:host) { ENV['ELASTIC_ENTERPRISE_HOST'] || 'http://localhost:3002' }
25
- let(:http_auth) do
26
- {
27
- user: ENV['ELASTIC_ENTERPRISE_USER'] || 'enterprise_search',
28
- password: ENV['ELASTIC_ENTERPRISE_PASSWORD'] || 'changeme'
29
- }
30
- end
31
- let(:client) do
32
- Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(host: host, http_auth: http_auth)
33
- end
34
- let(:documents) do
35
- [
36
- {
37
- 'id' => '4e696e74656e646f203634',
38
- 'url' => 'https://www.elastic.co/blog/introducing-quick-start-guides-getting-started-with-elastic-enterprise-search-for-free',
39
- 'title' => 'Getting started with Elastic Enterprise Search for free',
40
- 'body' => 'this is a test'
41
- },
42
- {
43
- 'id' => '47616d6520426f7920436f6c6f72',
44
- 'url' => 'https://www.elastic.co/workplace-search',
45
- 'title' => 'One-stop answer shop for the virtual workplace',
46
- 'body' => 'this is also a test'
47
- }
48
- ]
49
- end
50
-
51
- context 'Content Sources' do
52
- it 'creates, retrieves and deletes authenticated with basic auth' do
53
- # Create a content source and get its id
54
- response = client.create_content_source(name: 'test')
55
- expect(response.status).to eq 200
56
- expect(response.body['id'])
57
- id = response.body['id']
58
-
59
- # Test we get the content source information with get_content_source
60
- response = client.content_source(id)
61
- expect(response.status).to eq 200
62
-
63
- # List all content sources
64
- response = client.list_content_sources
65
- expect(response.status).to eq 200
66
- expect(response.body['results'].count).to be >= 1
67
-
68
- # Delete content source
69
- response = client.delete_content_source(id)
70
- expect(response.status).to eq 200
71
- end
72
-
73
- it 'creates and updates' do
74
- response = client.create_content_source(name: 'ruby_client_app')
75
- expect(response.status).to eq 200
76
- id = response.body['id']
77
-
78
- documents = [{ title: 'My first Document', body: 'Content', url: 'elastic.co' }]
79
- response = client.index_documents(id, documents: documents)
80
- expect(response.status).to eq 200
81
-
82
- new_name = 'ruby_client'
83
- body = {
84
- name: new_name,
85
- schema: { title: 'text', body: 'text', url: 'text' },
86
- display: { title_field: 'title', url_field: 'url', color: '#f00f00' },
87
- is_searchable: true
88
- }
89
- response = client.put_content_source(id, body: body)
90
- expect(response.status).to eq 200
91
-
92
- response = client.content_source(id)
93
- expect(response.status).to eq 200
94
- expect(response.body['name']) == new_name
95
- end
96
-
97
- it 'syncs jobs' do
98
- response = client.create_content_source(name: 'sync_jobs_test')
99
- expect(response.status).to eq 200
100
- id = response.body['id']
101
-
102
- response = client.command_sync_jobs(id, body: { command: 'interrupt' })
103
- expect(response.status).to eq 200
104
- expect(response.body['results'].keys).to eq ['interrupted']
105
- end
106
-
107
- context 'Icons' do
108
- let(:content_source_id) { client.create_content_source(name: 'with-icon').body['id'] }
109
-
110
- it 'puts an icon' do
111
- path = File.expand_path("#{File.dirname(__FILE__)}/icon.png")
112
- icon = Base64.strict_encode64(File.read(path))
113
- response = client.put_content_source_icons(content_source_id, main_icon: icon, alt_icon: icon)
114
- expect(response.status).to eq 200
115
- expect(response.body['results']).to eq({ 'main_icon' => 'success', 'alt_icon' => 'success' })
116
- end
117
- end
118
- end
119
-
120
- context 'Documents' do
121
- let(:content_source_id) do
122
- client.create_content_source(name: 'test').body['id']
123
- end
124
-
125
- it 'indexes' do
126
- response = client.index_documents(content_source_id, documents: documents)
127
- expect(response.status).to eq 200
128
- end
129
-
130
- it 'deletes' do
131
- response = client.delete_documents(content_source_id, document_ids: documents.map { |doc| doc['id'] })
132
- expect(response.status).to eq 200
133
- end
134
- end
135
-
136
- context 'Documents in Content Sources' do
137
- let(:content_source_id) { client.create_content_source(name: 'books').body['id'] }
138
- let(:document_id) { client.index_documents(content_source_id, documents: documents).body['results'].first['id'] }
139
-
140
- it 'Gets a document in a content source' do
141
- response = client.document(content_source_id, document_id: document_id)
142
- expect(response.status).to eq 200
143
- expect(response.body['id']).to eq document_id
144
- end
145
-
146
- it 'Deletes all documents in a content source' do
147
- response = client.delete_all_documents(content_source_id)
148
- expect(response.status).to eq 200
149
- end
150
-
151
- it 'Deletes documents by query' do
152
- content_source_id = client.create_content_source(name: 'asimov').body['id']
153
- documents = [
154
- { title: 'Foundation', year: 1951 },
155
- { title: 'Foundation and Empire', year: 1952 },
156
- { title: 'Second Foundation', year: 1953 }
157
- ]
158
- response = client.index_documents(content_source_id, documents: documents)
159
-
160
- expect(response.status).to eq 200
161
- expect(response.body['results'].count).to eq 3
162
-
163
- # Give time to index the documents so we can delete them:
164
- sleep 2
165
-
166
- response = client.delete_documents_by_query(content_source_id, query: 'Foundation')
167
- expect(response.status).to eq 200
168
- expect(response.body).to eq({ 'total' => 3, 'deleted' => 3, 'failures' => [] })
169
- end
170
- end
171
-
172
- context 'External Identities' do
173
- let(:content_source_id) { client.create_content_source(name: 'my_content').body['id'] }
174
- let(:user) { 'elastic_user' }
175
- let(:source_user_id) { 'example@elastic.co' }
176
- let(:body) do
177
- { user: user, source_user_id: source_user_id }
178
- end
179
-
180
- context 'Creates' do
181
- let(:source_user_id) { 'test@elastic.co' }
182
- let(:user) { 'test' }
183
-
184
- it 'creates an external identity' do
185
- response = client.create_external_identity(content_source_id, body: body)
186
-
187
- expect(response.status).to eq 200
188
- expect(response.body).to eq({ 'source_user_id' => source_user_id, 'user' => user })
189
-
190
- client.delete_external_identity(content_source_id, user: user)
191
- end
192
-
193
- it 'creates and retrieves' do
194
- client.create_external_identity(content_source_id, body: body)
195
- response = client.external_identity(content_source_id, user: user)
196
-
197
- expect(response.status).to eq 200
198
- expect(response.body).to eq({ 'source_user_id' => source_user_id, 'user' => user })
199
- client.delete_external_identity(content_source_id, user: user)
200
- end
201
- end
202
-
203
- context 'Lists' do
204
- let(:user) { 'lists_test' }
205
-
206
- it 'lists external identities' do
207
- client.create_external_identity(content_source_id, body: body)
208
- response = client.list_external_identities(content_source_id)
209
-
210
- expect(response.status).to eq 200
211
- expect(response.body['results']).to eq([{ 'source_user_id' => source_user_id, 'user' => user }])
212
- client.delete_external_identity(content_source_id, user: user)
213
- end
214
- end
215
-
216
- context 'Updates' do
217
- before do
218
- client.create_external_identity(content_source_id, body: body)
219
- end
220
-
221
- it 'updates an external identity' do
222
- body = { source_user_id: 'example2@elastic.co' }
223
- response = client.put_external_identity(content_source_id, user: user, body: body)
224
-
225
- expect(response.status).to eq 200
226
- expect(response.body).to eq({ 'source_user_id' => 'example2@elastic.co', 'user' => user })
227
- end
228
- end
229
-
230
- context 'Deletes' do
231
- before do
232
- client.create_external_identity(content_source_id, body: body)
233
- end
234
-
235
- it 'deletes an external identity' do
236
- response = client.delete_external_identity(content_source_id, user: user)
237
- expect(response.status).to eq 200
238
- expect(response.body).to eq 'ok'
239
- end
240
- end
241
- end
242
-
243
- context 'Permissions' do
244
- let(:content_source_id) { client.create_content_source(name: 'my_content').body['id'] }
245
- let(:user) { 'enterprise_search' }
246
- let(:permissions) { ['permission1', 'permission2'] }
247
-
248
- after do
249
- client.put_user_permissions(content_source_id, { permissions: [], user: user })
250
- end
251
-
252
- it 'adds permissions to a user' do
253
- response = client.add_user_permissions(
254
- content_source_id,
255
- { permissions: permissions, user: user }
256
- )
257
- expect(response.status).to eq 200
258
- expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => ['permission1', 'permission2'] })
259
- end
260
-
261
- it 'removes permissions from a user' do
262
- client.add_user_permissions(content_source_id, { permissions: permissions, user: user })
263
-
264
- # Removes Permissions
265
- response = client.remove_user_permissions(
266
- content_source_id,
267
- { permissions: permissions, user: user }
268
- )
269
- expect(response.status).to eq 200
270
- expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => [] })
271
- end
272
-
273
- it 'lists permissions' do
274
- response = client.list_permissions(content_source_id)
275
- expect(response.status).to eq 200
276
- end
277
-
278
- it 'gets a user\'s permissions' do
279
- client.add_user_permissions(content_source_id, { permissions: permissions, user: user })
280
- response = client.user_permissions(content_source_id, { user: user })
281
- expect(response.status).to eq 200
282
- expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => permissions })
283
- end
284
-
285
- it 'updates a user\'s permissions' do
286
- permissions = ['testing', 'more', 'permissions']
287
- response = client.add_user_permissions(content_source_id, { permissions: permissions, user: user })
288
- expect(response.status).to eq 200
289
- expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => permissions })
290
-
291
- response = client.put_user_permissions(content_source_id, { permissions: [], user: user })
292
- expect(response.status).to eq 200
293
- expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => [] })
294
- end
295
- end
296
-
297
- context 'Synonym sets' do
298
- let(:body) do
299
- {
300
- synonym_sets: [
301
- { 'synonyms' => ['house', 'home', 'abode'] },
302
- { 'synonyms' => ['cat', 'feline', 'kitty'] },
303
- { 'synonyms' => ['mouses', 'mice'] }
304
- ]
305
- }
306
- end
307
-
308
- it 'creates and deletes a batch synonym set' do
309
- response = client.create_batch_synonym_sets(body: body)
310
-
311
- expect(response.status).to eq 200
312
- expect(response.body['has_errors']).to eq false
313
- expect(response.body['synonym_sets'].count).to eq 3
314
-
315
- response.body['synonym_sets'].map { |s| client.delete_synonym_set(synonym_set_id: s['id']) }
316
- end
317
-
318
- it 'lists synonym sets' do
319
- client.create_batch_synonym_sets(body: body)
320
- response = client.list_synonym_sets
321
-
322
- expect(response.status).to eq 200
323
- expect(response.body['results'].count).to eq 3
324
-
325
- response.body['results'].map { |syn| client.delete_synonym_set(synonym_set_id: syn['id']) }
326
- end
327
-
328
- it 'gets a single synonym set' do
329
- id = client.create_batch_synonym_sets(
330
- body: {
331
- synonym_sets: [
332
- { 'synonyms' => ['house', 'home', 'abode'] }
333
- ]
334
- }
335
- ).body['synonym_sets'].first['id']
336
-
337
- response = client.synonym_set(synonym_set_id: id)
338
- expect(response.status).to eq 200
339
- expect(response.body['id']).to eq id
340
- expect(response.body['synonyms']).to eq ['house', 'home', 'abode']
341
- client.delete_synonym_set(synonym_set_id: id)
342
- end
343
-
344
- it 'updates a synonym set' do
345
- id = client.create_batch_synonym_sets(
346
- body: {
347
- synonym_sets: [
348
- { 'synonyms' => ['mouses', 'mice'] }
349
- ]
350
- }
351
- ).body['synonym_sets'].first['id']
352
- body = { synonyms: ['mouses', 'mice', 'luch'] }
353
-
354
- response = client.put_synonym_set(synonym_set_id: id, body: body)
355
-
356
- expect(response.status).to eq 200
357
- expect(response.body).to eq({ 'id' => id, 'synonyms' => ['mouses', 'mice', 'luch'] })
358
- client.delete_synonym_set(synonym_set_id: id)
359
- end
360
- end
361
-
362
- context 'Users' do
363
- it 'gets the current user' do
364
- response = client.current_user
365
- expect(response.status).to eq 200
366
- expect(response.body.keys).to eq ['email', 'username']
367
- end
368
-
369
- it 'gets the current user with an access token' do
370
- response = client.current_user(get_token: true)
371
- expect(response.status).to eq 200
372
- expect(response.body.keys).to eq ['email', 'username', 'access_token']
373
- end
374
- end
375
- end