elastic-enterprise-search 0.3.0 → 7.13.0.pre
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.ci/.gitignore +1 -0
- data/.ci/Dockerfile +12 -0
- data/.ci/certs/README.md +50 -0
- data/.ci/certs/ca.crt +20 -0
- data/.ci/certs/ca.key +27 -0
- data/.ci/certs/testnode.crt +21 -0
- data/.ci/certs/testnode.key +27 -0
- data/.ci/certs/testnode_no_san.crt +19 -0
- data/.ci/certs/testnode_no_san.key +27 -0
- data/.ci/functions/cleanup.sh +67 -0
- data/.ci/functions/imports.sh +59 -0
- data/.ci/functions/wait-for-container.sh +36 -0
- data/.ci/jobs/defaults.yml +69 -0
- data/.ci/jobs/elastic+enterprise-search-ruby+7.10.0.beta.1.yml +12 -0
- data/.ci/jobs/elastic+enterprise-search-ruby+master.yml +12 -0
- data/.ci/jobs/elastic+enterprise-search-ruby+pull-request.yml +19 -0
- data/.ci/run-elasticsearch.sh +127 -0
- data/.ci/run-enterprise-search.sh +71 -0
- data/.ci/run-local.sh +14 -0
- data/.ci/run-repository.sh +49 -0
- data/.ci/run-tests +27 -0
- data/.ci/test-matrix.yml +14 -0
- data/.github/workflows/rubocop.yml +15 -0
- data/.github/workflows/testing.yml +40 -0
- data/.gitignore +4 -0
- data/.rubocop.yml +52 -0
- data/CONTRIBUTING.md +43 -0
- data/Gemfile +23 -1
- data/{LICENSE.txt → LICENSE} +33 -32
- data/README.md +27 -147
- data/Rakefile +48 -1
- data/docs/guide/app-search-api.asciidoc +186 -0
- data/docs/guide/connecting.asciidoc +171 -0
- data/docs/guide/development.asciidoc +42 -0
- data/docs/guide/enterprise-search-api.asciidoc +46 -0
- data/docs/guide/index.asciidoc +19 -0
- data/docs/guide/installation.asciidoc +18 -0
- data/docs/guide/overview.asciidoc +59 -0
- data/docs/guide/release_notes/710.asciidoc +4 -0
- data/docs/guide/release_notes/711.asciidoc +27 -0
- data/docs/guide/release_notes/712.asciidoc +16 -0
- data/docs/guide/release_notes/index.asciidoc +14 -0
- data/docs/guide/workplace-search-api.asciidoc +138 -0
- data/elastic-enterprise-search.gemspec +49 -12
- data/lib/elastic-enterprise-search.rb +20 -1
- data/lib/elastic/.rubocop.yml +6 -0
- data/lib/elastic/app-search/api/add_meta_engine_source.rb +51 -0
- data/lib/elastic/app-search/api/api_logs.rb +62 -0
- data/lib/elastic/app-search/api/count_analytics.rb +52 -0
- data/lib/elastic/app-search/api/create_curation.rb +54 -0
- data/lib/elastic/app-search/api/create_engine.rb +53 -0
- data/lib/elastic/app-search/api/create_synonym_set.rb +51 -0
- data/lib/elastic/app-search/api/curation.rb +53 -0
- data/lib/elastic/app-search/api/delete_curation.rb +53 -0
- data/lib/elastic/app-search/api/delete_documents.rb +51 -0
- data/lib/elastic/app-search/api/delete_engine.rb +50 -0
- data/lib/elastic/app-search/api/delete_meta_engine_source.rb +51 -0
- data/lib/elastic/app-search/api/delete_synonym_set.rb +53 -0
- data/lib/elastic/app-search/api/documents.rb +51 -0
- data/lib/elastic/app-search/api/engine.rb +50 -0
- data/lib/elastic/app-search/api/index_documents.rb +51 -0
- data/lib/elastic/app-search/api/list_curations.rb +52 -0
- data/lib/elastic/app-search/api/list_documents.rb +52 -0
- data/lib/elastic/app-search/api/list_engines.rb +49 -0
- data/lib/elastic/app-search/api/list_synonym_sets.rb +52 -0
- data/lib/elastic/app-search/api/log_clickthrough.rb +57 -0
- data/lib/elastic/app-search/api/multi_search.rb +51 -0
- data/lib/elastic/app-search/api/put_curation.rb +57 -0
- data/lib/elastic/app-search/api/put_documents.rb +51 -0
- data/lib/elastic/app-search/api/put_schema.rb +51 -0
- data/lib/elastic/app-search/api/put_search_settings.rb +51 -0
- data/lib/elastic/app-search/api/put_synonym_set.rb +54 -0
- data/lib/elastic/app-search/api/query_suggestion.rb +54 -0
- data/lib/elastic/app-search/api/reset_search_settings.rb +50 -0
- data/lib/elastic/app-search/api/schema.rb +50 -0
- data/lib/elastic/app-search/api/search.rb +50 -0
- data/lib/elastic/app-search/api/search_settings.rb +50 -0
- data/lib/elastic/app-search/api/synonym_set.rb +53 -0
- data/lib/elastic/app-search/api/top_clicks_analytics.rb +54 -0
- data/lib/elastic/app-search/api/top_queries_analytics.rb +53 -0
- data/lib/elastic/app-search/app_search.rb +82 -0
- data/lib/elastic/enterprise-search/api/health.rb +43 -0
- data/lib/elastic/enterprise-search/api/put_read_only.rb +46 -0
- data/lib/elastic/enterprise-search/api/read_only.rb +43 -0
- data/lib/elastic/enterprise-search/api/stats.rb +45 -0
- data/lib/elastic/enterprise-search/api/version.rb +43 -0
- data/lib/elastic/enterprise-search/client.rb +81 -15
- data/lib/elastic/enterprise-search/configuration.rb +32 -16
- data/lib/elastic/enterprise-search/exceptions.rb +19 -0
- data/lib/elastic/enterprise-search/request.rb +62 -80
- data/lib/elastic/enterprise-search/utils.rb +28 -1
- data/lib/elastic/enterprise-search/version.rb +20 -1
- data/lib/elastic/enterprise_search.rb +49 -0
- data/lib/elastic/workplace-search/api/add_user_permissions.rb +54 -0
- data/lib/elastic/workplace-search/api/content_source.rb +49 -0
- data/lib/elastic/workplace-search/api/create_analytics_event.rb +59 -0
- data/lib/elastic/workplace-search/api/create_content_source.rb +52 -0
- data/lib/elastic/workplace-search/api/create_external_identity.rb +53 -0
- data/lib/elastic/workplace-search/api/delete_all_documents.rb +49 -0
- data/lib/elastic/workplace-search/api/delete_content_source.rb +49 -0
- data/lib/elastic/workplace-search/api/delete_documents.rb +51 -0
- data/lib/elastic/workplace-search/api/delete_external_identity.rb +53 -0
- data/lib/elastic/workplace-search/api/document.rb +53 -0
- data/lib/elastic/workplace-search/api/external_identity.rb +53 -0
- data/lib/elastic/workplace-search/api/index_documents.rb +52 -0
- data/lib/elastic/workplace-search/api/list_content_sources.rb +48 -0
- data/lib/elastic/workplace-search/api/list_external_identities.rb +51 -0
- data/lib/elastic/workplace-search/api/list_permissions.rb +51 -0
- data/lib/elastic/workplace-search/api/put_content_source.rb +55 -0
- data/lib/elastic/workplace-search/api/put_external_identity.rb +56 -0
- data/lib/elastic/workplace-search/api/put_user_permissions.rb +54 -0
- data/lib/elastic/workplace-search/api/remove_user_permissions.rb +54 -0
- data/lib/elastic/workplace-search/api/search.rb +60 -0
- data/lib/elastic/workplace-search/api/user_permissions.rb +53 -0
- data/lib/elastic/workplace-search/workplace_search.rb +89 -0
- data/spec/app-search/api_count_analytics_spec.rb +34 -0
- data/spec/app-search/api_curations_spec.rb +97 -0
- data/spec/app-search/api_documents_spec.rb +102 -0
- data/spec/app-search/api_engines_spec.rb +67 -0
- data/spec/app-search/api_log_clickthrough_spec.rb +34 -0
- data/spec/app-search/api_logs_spec.rb +36 -0
- data/spec/app-search/api_meta_engines_spec.rb +72 -0
- data/spec/app-search/api_query_suggestion_spec.rb +39 -0
- data/spec/app-search/api_schema_spec.rb +48 -0
- data/spec/app-search/api_search_and_multi_search_spec.rb +48 -0
- data/spec/app-search/api_search_settings_spec.rb +76 -0
- data/spec/app-search/api_spec_helper.rb +14 -0
- data/spec/app-search/api_synonyms_spec.rb +79 -0
- data/spec/app-search/api_top_clicks_analytics_spec.rb +44 -0
- data/spec/app-search/api_top_queries_analytics_spec.rb +34 -0
- data/spec/app-search/client_spec.rb +88 -0
- data/spec/app-search/date_spec.rb +69 -0
- data/spec/enterprise-search/client_spec.rb +107 -0
- data/spec/enterprise-search/request_spec.rb +136 -0
- data/spec/enterprise-search/utils_spec.rb +46 -0
- data/spec/fixtures/vcr/app_search/add_meta_engine_source.yml +109 -0
- data/spec/fixtures/vcr/app_search/api_documents.yml +56 -0
- data/spec/fixtures/vcr/app_search/api_index_documents.yml +57 -0
- data/spec/fixtures/vcr/app_search/api_log_clickthrough.yml +54 -0
- data/spec/fixtures/vcr/app_search/api_logs.yml +70 -0
- data/spec/fixtures/vcr/app_search/api_put_schema.yml +109 -0
- data/spec/fixtures/vcr/app_search/api_put_search_settings.yml +56 -0
- data/spec/fixtures/vcr/app_search/api_query_suggestion.yml +59 -0
- data/spec/fixtures/vcr/app_search/api_reset_search_settings.yml +56 -0
- data/spec/fixtures/vcr/app_search/api_schema.yml +56 -0
- data/spec/fixtures/vcr/app_search/api_search_settings.yml +56 -0
- data/spec/fixtures/vcr/app_search/api_top_clicks_analytics.yml +55 -0
- data/spec/fixtures/vcr/app_search/api_top_clicks_analytics_query.yml +55 -0
- data/spec/fixtures/vcr/app_search/api_top_queries_analytics.yml +55 -0
- data/spec/fixtures/vcr/app_search/count_analytics.yml +55 -0
- data/spec/fixtures/vcr/app_search/create_and_update_document.yml +107 -0
- data/spec/fixtures/vcr/app_search/create_curation.yml +113 -0
- data/spec/fixtures/vcr/app_search/create_engine.yml +55 -0
- data/spec/fixtures/vcr/app_search/create_meta_engine.yml +56 -0
- data/spec/fixtures/vcr/app_search/create_synonym_set.yml +56 -0
- data/spec/fixtures/vcr/app_search/delete_curation.yml +56 -0
- data/spec/fixtures/vcr/app_search/delete_engine.yml +55 -0
- data/spec/fixtures/vcr/app_search/delete_meta_engine_source.yml +56 -0
- data/spec/fixtures/vcr/app_search/delete_synonym_set.yml +56 -0
- data/spec/fixtures/vcr/app_search/get_curation.yml +56 -0
- data/spec/fixtures/vcr/app_search/get_engine.yml +55 -0
- data/spec/fixtures/vcr/app_search/index_and_delete_document.yml +107 -0
- data/spec/fixtures/vcr/app_search/list_curations.yml +56 -0
- data/spec/fixtures/vcr/app_search/list_documents.yml +57 -0
- data/spec/fixtures/vcr/app_search/list_engines.yml +55 -0
- data/spec/fixtures/vcr/app_search/list_synonym_sets.yml +56 -0
- data/spec/fixtures/vcr/app_search/multi_query_search.yml +63 -0
- data/spec/fixtures/vcr/app_search/put_curation.yml +113 -0
- data/spec/fixtures/vcr/app_search/put_synonym_set.yml +56 -0
- data/spec/fixtures/vcr/app_search/search.yml +57 -0
- data/spec/fixtures/vcr/app_search/single_query_search.yml +60 -0
- data/spec/fixtures/vcr/app_search/synonym_set.yml +56 -0
- data/spec/fixtures/vcr/workplace_search/create_analytics_event.yml +55 -0
- data/spec/fixtures/vcr/workplace_search/oauth_request_token.yml +57 -0
- data/spec/fixtures/vcr/workplace_search/search_request.yml +60 -0
- data/spec/integration/enterprise_search_api_spec.rb +100 -0
- data/spec/integration/workplace_search_spec.rb +253 -0
- data/spec/spec_helper.rb +27 -14
- data/spec/webmock_requires.rb +4 -0
- data/spec/workplace-search/client_spec.rb +77 -0
- data/spec/workplace-search/create_analytics_event_spec.rb +59 -0
- data/spec/workplace-search/search_spec.rb +53 -0
- metadata +266 -45
- data/.circleci/config.yml +0 -68
- data/.travis.yml +0 -15
- data/NOTICE.txt +0 -3
- data/lib/elastic/enterprise-search.rb +0 -7
- data/lib/elastic/enterprise-search/client/content_source_documents.rb +0 -46
- data/lib/elastic/enterprise-search/client/permissions.rb +0 -30
- data/logo-enterprise-search.png +0 -0
- data/spec/client/content_source_documents_spec.rb +0 -55
- data/spec/client/permissions_spec.rb +0 -75
- data/spec/configuration_spec.rb +0 -19
- data/spec/fixtures/vcr/add_user_permissions.yml +0 -55
- data/spec/fixtures/vcr/async_create_or_update_document_success.yml +0 -51
- data/spec/fixtures/vcr/destroy_documents_success.yml +0 -51
- data/spec/fixtures/vcr/get_user_permissions.yml +0 -55
- data/spec/fixtures/vcr/list_all_permissions.yml +0 -55
- data/spec/fixtures/vcr/list_all_permissions_with_paging.yml +0 -55
- data/spec/fixtures/vcr/remove_user_permissions.yml +0 -55
- data/spec/fixtures/vcr/update_user_permissions.yml +0 -55
@@ -0,0 +1,43 @@
|
|
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 Actions
|
23
|
+
# Health - Get information on the health of a deployment and basic statistics around resource usage
|
24
|
+
# Get information on the health of a deployment and basic statistics around resource usage
|
25
|
+
#
|
26
|
+
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
27
|
+
#
|
28
|
+
# @see https://www.elastic.co/guide/en/enterprise-search/current/monitoring-apis.html#health-api-example
|
29
|
+
#
|
30
|
+
def health(arguments = {})
|
31
|
+
headers = arguments.delete(:headers) || {}
|
32
|
+
|
33
|
+
request(
|
34
|
+
:get,
|
35
|
+
'api/ent/v1/internal/health/',
|
36
|
+
arguments,
|
37
|
+
{},
|
38
|
+
headers
|
39
|
+
)
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
@@ -0,0 +1,46 @@
|
|
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 Actions
|
23
|
+
# Read-Only - Update the read-only flag's state
|
24
|
+
# Update the read-only flag's state
|
25
|
+
#
|
26
|
+
# @option arguments [Object] :body
|
27
|
+
# @option body [Boolean] :enabled
|
28
|
+
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
29
|
+
#
|
30
|
+
# @see https://www.elastic.co/guide/en/enterprise-search/current/read-only-api.html#setting-read-only-state
|
31
|
+
#
|
32
|
+
def put_read_only(arguments = {})
|
33
|
+
body = arguments.delete(:body) || {}
|
34
|
+
headers = arguments.delete(:headers) || {}
|
35
|
+
|
36
|
+
request(
|
37
|
+
:put,
|
38
|
+
'api/ent/v1/internal/read_only_mode/',
|
39
|
+
arguments,
|
40
|
+
body,
|
41
|
+
headers
|
42
|
+
)
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
@@ -0,0 +1,43 @@
|
|
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 Actions
|
23
|
+
# Read-Only - Get the read-only flag's state
|
24
|
+
# Get the read-only flag's state
|
25
|
+
#
|
26
|
+
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
27
|
+
#
|
28
|
+
# @see https://www.elastic.co/guide/en/enterprise-search/current/read-only-api.html#getting-read-only-state
|
29
|
+
#
|
30
|
+
def read_only(arguments = {})
|
31
|
+
headers = arguments.delete(:headers) || {}
|
32
|
+
|
33
|
+
request(
|
34
|
+
:get,
|
35
|
+
'api/ent/v1/internal/read_only_mode/',
|
36
|
+
arguments,
|
37
|
+
{},
|
38
|
+
headers
|
39
|
+
)
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
@@ -0,0 +1,45 @@
|
|
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 Actions
|
23
|
+
# Stats - Get information about the resource usage of the application, the state of different internal queues, etc.
|
24
|
+
# Get information about the resource usage of the application, the state of different internal queues, etc.
|
25
|
+
#
|
26
|
+
# @param arguments [Hash] endpoint arguments
|
27
|
+
# @option arguments [Array] :include Comma-separated list of stats to return
|
28
|
+
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
29
|
+
#
|
30
|
+
# @see https://www.elastic.co/guide/en/enterprise-search/current/monitoring-apis.html#stats-api-example
|
31
|
+
#
|
32
|
+
def stats(arguments = {})
|
33
|
+
headers = arguments.delete(:headers) || {}
|
34
|
+
|
35
|
+
request(
|
36
|
+
:get,
|
37
|
+
'api/ent/v1/internal/stats/',
|
38
|
+
arguments,
|
39
|
+
{},
|
40
|
+
headers
|
41
|
+
)
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
@@ -0,0 +1,43 @@
|
|
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 Actions
|
23
|
+
# Version - Get version information for this server
|
24
|
+
# Get version information for this server
|
25
|
+
#
|
26
|
+
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
27
|
+
#
|
28
|
+
# @see https://www.elastic.co/guide/en/enterprise-search/current/management-apis.html
|
29
|
+
#
|
30
|
+
def version(arguments = {})
|
31
|
+
headers = arguments.delete(:headers) || {}
|
32
|
+
|
33
|
+
request(
|
34
|
+
:get,
|
35
|
+
'api/ent/v1/internal/version/',
|
36
|
+
arguments,
|
37
|
+
{},
|
38
|
+
headers
|
39
|
+
)
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
@@ -1,37 +1,82 @@
|
|
1
|
-
|
2
|
-
|
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
|
+
|
3
20
|
require 'elastic/enterprise-search/request'
|
4
21
|
require 'elastic/enterprise-search/utils'
|
22
|
+
require 'elasticsearch-transport'
|
5
23
|
|
6
24
|
module Elastic
|
7
25
|
module EnterpriseSearch
|
8
|
-
# API client for the {Elastic Enterprise Search API}[https://
|
26
|
+
# API client for the {Elastic Enterprise Search API}[https://www.elastic.co/enterprise-search].
|
27
|
+
# This is the main client from which the Workplace Search and App Search clients inherit.
|
9
28
|
class Client
|
10
|
-
autoload :ContentSourceDocuments, 'elastic/enterprise-search/client/content_source_documents.rb'
|
11
|
-
autoload :Permissions, 'elastic/enterprise-search/client/permissions.rb'
|
12
|
-
|
13
29
|
DEFAULT_TIMEOUT = 15
|
14
30
|
|
15
31
|
include Elastic::EnterpriseSearch::Request
|
32
|
+
include Elastic::EnterpriseSearch::Actions
|
33
|
+
include Elastic::EnterpriseSearch::Utils
|
34
|
+
|
35
|
+
def workplace_search(options = {})
|
36
|
+
@workplace_search ||= Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(
|
37
|
+
host: host,
|
38
|
+
http_auth: options[:http_auth],
|
39
|
+
transport: @transport
|
40
|
+
)
|
41
|
+
end
|
16
42
|
|
17
|
-
def
|
18
|
-
Elastic::EnterpriseSearch.
|
43
|
+
def app_search(options = {})
|
44
|
+
@app_search ||= Elastic::EnterpriseSearch::AppSearch::Client.new(
|
45
|
+
host: host,
|
46
|
+
http_auth: options[:http_auth],
|
47
|
+
transport: @transport
|
48
|
+
)
|
19
49
|
end
|
20
50
|
|
21
51
|
# Create a new Elastic::EnterpriseSearch::Client client
|
22
52
|
#
|
23
53
|
# @param options [Hash] a hash of configuration options that will override what is set on the Elastic::EnterpriseSearch class.
|
24
|
-
# @option options [String] :
|
54
|
+
# @option options [String] :host Enterprise Search host
|
55
|
+
# @option options [Hash] :basic_auth a username and password for Basic Authentication
|
25
56
|
# @option options [Numeric] :overall_timeout overall timeout for requests in seconds (default: 15s)
|
26
|
-
# @option options [Numeric] :open_timeout the number of seconds Net::HTTP (default: 15s)
|
27
|
-
# will wait while opening a connection before raising a Timeout::Error
|
57
|
+
# @option options [Numeric] :open_timeout the number of seconds Net::HTTP (default: 15s) will wait while opening a connection before raising a Timeout::Error
|
28
58
|
# @option options [String] :proxy url of proxy to use, ex: "http://localhost:8888"
|
59
|
+
# @option options [Boolean] :log Use the default logger (disabled by default)
|
60
|
+
# @option arguments [Object] :logger An instance of a Logger-compatible object
|
61
|
+
# @option enable_meta_header [Boolean] :enable_meta_header Enable sending the meta data header to Cloud.
|
62
|
+
# (Default: true)
|
29
63
|
def initialize(options = {})
|
30
64
|
@options = options
|
65
|
+
@transport = transport
|
31
66
|
end
|
32
67
|
|
33
|
-
def
|
34
|
-
@options[:
|
68
|
+
def transport
|
69
|
+
@options[:transport] ||
|
70
|
+
Elasticsearch::Client.new(
|
71
|
+
host: host,
|
72
|
+
log: log,
|
73
|
+
logger: logger,
|
74
|
+
request_timeout: overall_timeout,
|
75
|
+
transport_options: {
|
76
|
+
request: { open_timeout: open_timeout }
|
77
|
+
},
|
78
|
+
enable_meta_header: @options[:enable_meta_header] || true
|
79
|
+
)
|
35
80
|
end
|
36
81
|
|
37
82
|
def open_timeout
|
@@ -46,8 +91,29 @@ module Elastic
|
|
46
91
|
(@options[:overall_timeout] || DEFAULT_TIMEOUT).to_f
|
47
92
|
end
|
48
93
|
|
49
|
-
|
50
|
-
|
94
|
+
def http_auth
|
95
|
+
@options[:http_auth] || { user: 'elastic', password: 'changeme' }
|
96
|
+
end
|
97
|
+
|
98
|
+
def http_auth=(http_auth)
|
99
|
+
@options[:http_auth] = http_auth
|
100
|
+
end
|
101
|
+
|
102
|
+
def log
|
103
|
+
@options[:log] || false
|
104
|
+
end
|
105
|
+
|
106
|
+
def logger
|
107
|
+
@options[:logger]
|
108
|
+
end
|
109
|
+
|
110
|
+
def host
|
111
|
+
return DEFAULT_HOST unless @options[:host]
|
112
|
+
|
113
|
+
raise URI::InvalidURIError unless @options[:host] =~ /\A#{URI::DEFAULT_PARSER.make_regexp}\z/
|
114
|
+
|
115
|
+
@options[:host]
|
116
|
+
end
|
51
117
|
end
|
52
118
|
end
|
53
119
|
end
|
@@ -1,18 +1,35 @@
|
|
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
|
+
|
1
20
|
require 'uri'
|
2
|
-
require 'elastic/
|
21
|
+
require 'elastic/workplace-search/version'
|
3
22
|
|
4
23
|
module Elastic
|
5
24
|
module EnterpriseSearch
|
25
|
+
# Configuratin module
|
6
26
|
module Configuration
|
7
|
-
|
27
|
+
# TODO: Endpoint for EE
|
28
|
+
# DEFAULT_ENDPOINT = 'http://localhost:3002/api/ws/v1/'
|
8
29
|
|
9
|
-
VALID_OPTIONS_KEYS = [
|
10
|
-
:access_token,
|
11
|
-
:user_agent,
|
12
|
-
:endpoint
|
13
|
-
].freeze
|
30
|
+
VALID_OPTIONS_KEYS = [:access_token, :endpoint].freeze
|
14
31
|
|
15
|
-
attr_accessor
|
32
|
+
attr_accessor(*VALID_OPTIONS_KEYS)
|
16
33
|
|
17
34
|
def self.extended(base)
|
18
35
|
base.reset
|
@@ -22,11 +39,10 @@ module Elastic
|
|
22
39
|
def reset
|
23
40
|
self.access_token = nil
|
24
41
|
self.endpoint = DEFAULT_ENDPOINT
|
25
|
-
self.user_agent = nil
|
26
42
|
self
|
27
43
|
end
|
28
44
|
|
29
|
-
# Yields the Elastic::
|
45
|
+
# Yields the Elastic::WorkplaceSearch::Configuration module which can be used to set configuration options.
|
30
46
|
#
|
31
47
|
# @return self
|
32
48
|
def configure
|
@@ -37,17 +53,17 @@ module Elastic
|
|
37
53
|
# Return a hash of the configured options.
|
38
54
|
def options
|
39
55
|
options = {}
|
40
|
-
VALID_OPTIONS_KEYS.each{ |k| options[k] = send(k) }
|
56
|
+
VALID_OPTIONS_KEYS.each { |k| options[k] = send(k) }
|
41
57
|
options
|
42
58
|
end
|
43
59
|
|
44
60
|
# setter for endpoint that ensures it always ends in '/'
|
45
61
|
def endpoint=(endpoint)
|
46
|
-
if endpoint.end_with?('/')
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
62
|
+
@endpoint = if endpoint.end_with?('/')
|
63
|
+
endpoint
|
64
|
+
else
|
65
|
+
"#{endpoint}/"
|
66
|
+
end
|
51
67
|
end
|
52
68
|
end
|
53
69
|
end
|
@@ -1,3 +1,22 @@
|
|
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
|
+
|
1
20
|
module Elastic
|
2
21
|
module EnterpriseSearch
|
3
22
|
class ClientException < StandardError; end
|