elastic-enterprise-search 8.9.0 → 8.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.buildkite/pipeline.yml +3 -2
- data/.ci/make.sh +1 -23
- data/.github/workflows/license.yml +2 -2
- data/.github/workflows/rubocop.yml +2 -2
- data/.github/workflows/testing.yml +5 -4
- data/README.md +10 -0
- data/catalog-info.yaml +19 -0
- data/docs/guide/app-search-api.asciidoc +4 -2
- data/elastic-enterprise-search.gemspec +15 -2
- data/lib/elastic/enterprise-search/version.rb +1 -1
- metadata +21 -13
- data/.ci/Dockerfile +0 -25
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e1edee1a341d229766cc56217bdc48daba826c38285fac78da19f98c4499f007
|
|
4
|
+
data.tar.gz: e59f9320edc8874b05b7a42888bc6c8817c4192a9f266bdf5584674c686cb518
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d1a70bed65232c5281f1439cfa460cdbd8c10414c73e522e0570d5a900916b4c3685b578256cbb0929b1f2aae574a14e23815b994918f37eba72ede0030c1639
|
|
7
|
+
data.tar.gz: e82c1ce74df9f238b3a978291bdf8736d73fc71fa20c028bba039d33b75b01e4c36db676e8d2a5c9177e3e2c0e2f8fe3e73c6b4a72533e0d9c21d49ff4e2f101
|
data/.buildkite/pipeline.yml
CHANGED
|
@@ -4,13 +4,14 @@ steps:
|
|
|
4
4
|
provider: "gcp"
|
|
5
5
|
env:
|
|
6
6
|
RUBY_VERSION: "{{ matrix.ruby }}"
|
|
7
|
-
STACK_VERSION: 8.
|
|
7
|
+
STACK_VERSION: 8.18.0-SNAPSHOT
|
|
8
8
|
matrix:
|
|
9
9
|
setup:
|
|
10
10
|
ruby:
|
|
11
|
+
- "3.4"
|
|
12
|
+
- "3.3"
|
|
11
13
|
- "3.2"
|
|
12
14
|
- "3.1"
|
|
13
|
-
- "3.0"
|
|
14
15
|
command: ./.buildkite/run-tests.sh
|
|
15
16
|
artifact_paths: "tmp/*"
|
|
16
17
|
- wait: ~
|
data/.ci/make.sh
CHANGED
|
@@ -55,15 +55,6 @@ case $CMD in
|
|
|
55
55
|
echo -e "\033[32;1mdone.\033[0m"
|
|
56
56
|
exit 0
|
|
57
57
|
;;
|
|
58
|
-
assemble)
|
|
59
|
-
if [ -v $VERSION ]; then
|
|
60
|
-
echo -e "\033[31;1mTARGET: assemble -> missing version parameter\033[0m"
|
|
61
|
-
exit 1
|
|
62
|
-
fi
|
|
63
|
-
echo -e "\033[36;1mTARGET: assemble artefact $VERSION\033[0m"
|
|
64
|
-
TASK=assemble
|
|
65
|
-
TASK_ARGS=("$VERSION" "$output_folder")
|
|
66
|
-
;;
|
|
67
58
|
codegen)
|
|
68
59
|
if [ -v $VERSION ]; then
|
|
69
60
|
echo -e "\033[31;1mTARGET: codegen -> missing version parameter\033[0m"
|
|
@@ -112,11 +103,7 @@ esac
|
|
|
112
103
|
|
|
113
104
|
echo -e "\033[34;1mINFO: building $product container\033[0m"
|
|
114
105
|
|
|
115
|
-
docker build --file .
|
|
116
|
-
--build-arg BUILDER_UID="$(id -u)" \
|
|
117
|
-
--build-arg USER_ID="$(id -u)" \
|
|
118
|
-
--build-arg GROUP_ID="$(id -g)" .
|
|
119
|
-
|
|
106
|
+
docker build --file .buildkite/Dockerfile --tag ${product}
|
|
120
107
|
|
|
121
108
|
# ------------------------------------------------------- #
|
|
122
109
|
# Run the Container
|
|
@@ -142,15 +129,6 @@ docker run \
|
|
|
142
129
|
# Post Command tasks & checks
|
|
143
130
|
# ------------------------------------------------------- #
|
|
144
131
|
|
|
145
|
-
if [[ "$CMD" == "assemble" ]]; then
|
|
146
|
-
if compgen -G ".ci/output/*" > /dev/null; then
|
|
147
|
-
echo -e "\033[32;1mTARGET: successfully assembled client v$VERSION\033[0m"
|
|
148
|
-
else
|
|
149
|
-
echo -e "\033[31;1mTARGET: assemble failed, empty workspace!\033[0m"
|
|
150
|
-
exit 1
|
|
151
|
-
fi
|
|
152
|
-
fi
|
|
153
|
-
|
|
154
132
|
if [[ "$CMD" == "codegen" ]]; then
|
|
155
133
|
echo "TODO"
|
|
156
134
|
fi
|
|
@@ -4,10 +4,10 @@ jobs:
|
|
|
4
4
|
build:
|
|
5
5
|
runs-on: ubuntu-latest
|
|
6
6
|
steps:
|
|
7
|
-
- uses: actions/checkout@
|
|
7
|
+
- uses: actions/checkout@v4
|
|
8
8
|
- uses: ruby/setup-ruby@v1
|
|
9
9
|
with:
|
|
10
|
-
ruby-version: 3
|
|
10
|
+
ruby-version: '3.4'
|
|
11
11
|
- name: Check license headers
|
|
12
12
|
run: |
|
|
13
13
|
ruby ./.github/check_license_headers.rb
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
---
|
|
1
2
|
name: main
|
|
2
3
|
on: [push, pull_request]
|
|
3
4
|
|
|
@@ -7,10 +8,10 @@ jobs:
|
|
|
7
8
|
ENDPOINT: http://localhost:8080
|
|
8
9
|
strategy:
|
|
9
10
|
matrix:
|
|
10
|
-
ruby: [ '3.
|
|
11
|
+
ruby: ['3.1', '3.2', '3.3', '3.4']
|
|
11
12
|
runs-on: ubuntu-latest
|
|
12
13
|
steps:
|
|
13
|
-
- uses: actions/checkout@
|
|
14
|
+
- uses: actions/checkout@v4
|
|
14
15
|
- uses: ruby/setup-ruby@v1
|
|
15
16
|
with:
|
|
16
17
|
ruby-version: ${{ matrix.ruby }}
|
|
@@ -27,10 +28,10 @@ jobs:
|
|
|
27
28
|
strategy:
|
|
28
29
|
fail-fast: false
|
|
29
30
|
matrix:
|
|
30
|
-
ruby: [
|
|
31
|
+
ruby: ['jruby-9.3', 'jruby-9.4']
|
|
31
32
|
runs-on: ubuntu-latest
|
|
32
33
|
steps:
|
|
33
|
-
- uses: actions/checkout@
|
|
34
|
+
- uses: actions/checkout@v4
|
|
34
35
|
- uses: ruby/setup-ruby@v1
|
|
35
36
|
with:
|
|
36
37
|
ruby-version: ${{ matrix.ruby }}
|
data/README.md
CHANGED
|
@@ -5,6 +5,16 @@
|
|
|
5
5
|
|
|
6
6
|
[](https://buildkite.com/elastic/enterprise-search-ruby)
|
|
7
7
|
|
|
8
|
+
> [!WARNING] **Enterprise Search will be discontinued in 9.0.**
|
|
9
|
+
|
|
10
|
+
> Starting with Elastic version 9.0, the standalone Enterprise Search products, will no longer be included in our offering. They remain supported in their current form in version 8.x and will only receive security upgrades and fixes. Enterprise Search clients will continue to be supported in their current form throughout 8.x versions, according to our EOL policy: https://www.elastic.co/support/eol
|
|
11
|
+
> We recommend transitioning to our actively developed Elastic Stack (https://www.elastic.co/elastic-stack) tools for your search use cases. However, if you're still using any Enterprise Search products, we recommend using the latest stable release of the clients.
|
|
12
|
+
|
|
13
|
+
> Here are some useful links with more information:
|
|
14
|
+
> * Enterprise Search FAQ: https://www.elastic.co/resources/enterprise-search/enterprise-search-faq
|
|
15
|
+
> * Migrating to 9.x from Enterprise Search 8.x versions: https://www.elastic.co/guide/en/enterprise-search/current/upgrading-to-9-x.html
|
|
16
|
+
|
|
17
|
+
|
|
8
18
|
Official Ruby API client for [Elastic Enterprise Search](https://www.elastic.co/enterprise-search). Use this gem to integrate App Search and Workplace Search into your Ruby code.
|
|
9
19
|
|
|
10
20
|
## Installation
|
data/catalog-info.yaml
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
apiVersion: backstage.io/v1alpha1
|
|
2
|
+
kind: Resource
|
|
3
|
+
metadata:
|
|
4
|
+
name: buildkite-pipeline-enterprise-search-ruby
|
|
5
|
+
spec:
|
|
6
|
+
implementation:
|
|
7
|
+
apiVersion: buildkite.elastic.dev/v1
|
|
8
|
+
kind: Pipeline
|
|
9
|
+
metadata:
|
|
10
|
+
description: Enterprise Search Ruby Client
|
|
11
|
+
name: enterprise-search-ruby
|
|
12
|
+
spec:
|
|
13
|
+
repository: elastic/enterprise-search-ruby
|
|
14
|
+
teams:
|
|
15
|
+
devtools-team: {}
|
|
16
|
+
everyone:
|
|
17
|
+
access_level: READ_ONLY
|
|
18
|
+
owner: group:devtools-team
|
|
19
|
+
type: buildkite-pipeline
|
|
@@ -35,7 +35,7 @@ client.create_engine(body: body)
|
|
|
35
35
|
# Add a source engine to a meta engine:
|
|
36
36
|
client.add_meta_engine_source(meta_engine_name, source_engines: ['engine1', 'engine2'])
|
|
37
37
|
|
|
38
|
-
# Remove a source
|
|
38
|
+
# Remove a source engine from a meta engine:
|
|
39
39
|
client.delete_meta_engine_source(meta_engine_name, source_engines: ['engine1', 'engine2'])
|
|
40
40
|
----------------------------
|
|
41
41
|
|
|
@@ -72,7 +72,9 @@ client.put_documents(engine_name, documents: [{id: document_id, key: value}])
|
|
|
72
72
|
----------------------------
|
|
73
73
|
# Single Search
|
|
74
74
|
query = {
|
|
75
|
-
|
|
75
|
+
body: {
|
|
76
|
+
query: 'luigi'
|
|
77
|
+
}
|
|
76
78
|
}
|
|
77
79
|
|
|
78
80
|
client.search(engine_name, query)
|
|
@@ -53,13 +53,26 @@ Gem::Specification.new do |s|
|
|
|
53
53
|
s.add_development_dependency 'byebug' unless defined?(JRUBY_VERSION)
|
|
54
54
|
s.add_development_dependency 'rspec', '~> 3.9.0'
|
|
55
55
|
s.add_development_dependency 'rspec_junit_formatter'
|
|
56
|
-
s.add_development_dependency 'rubocop', '
|
|
56
|
+
s.add_development_dependency 'rubocop', '>= 1.51' unless defined?(JRUBY_VERSION) &&
|
|
57
|
+
Gem::Version.new(JRUBY_VERSION) < Gem::Version.new('9.4')
|
|
57
58
|
s.add_development_dependency 'vcr'
|
|
58
|
-
s.add_development_dependency 'webmock'
|
|
59
|
+
s.add_development_dependency 'webmock', '>= 3.23.1'
|
|
59
60
|
# Adapters
|
|
60
61
|
s.add_development_dependency 'faraday-httpclient'
|
|
61
62
|
s.add_development_dependency 'faraday-net_http_persistent'
|
|
62
63
|
s.add_development_dependency 'faraday-patron' unless defined? JRUBY_VERSION
|
|
63
64
|
s.add_development_dependency 'faraday-typhoeus'
|
|
65
|
+
|
|
66
|
+
s.post_install_message = <<~MESSAGE
|
|
67
|
+
|
|
68
|
+
Warning: Starting with Elastic version 9.0, the standalone Enterprise Search products, will no longer be included in our offering. They remain supported in their current form in version 8.x and will only receive security upgrades and fixes.
|
|
69
|
+
Enterprise Search clients will continue to be supported in their current form throughout 8.x versions, according to our EOL policy: https://www.elastic.co/support/eol
|
|
70
|
+
We recommend transitioning to our actively developed Elastic Stack (https://www.elastic.co/elastic-stack) tools for your search use cases. However, if you're still using any Enterprise Search products, we recommend using the latest stable release of the clients.
|
|
71
|
+
|
|
72
|
+
Here are some useful links with more information:
|
|
73
|
+
* Enterprise Search FAQ: https://www.elastic.co/resources/enterprise-search/enterprise-search-faq
|
|
74
|
+
* Migrating to 9.x from Enterprise Search 8.x versions: https://www.elastic.co/guide/en/enterprise-search/current/upgrading-to-9-x.html
|
|
75
|
+
|
|
76
|
+
MESSAGE
|
|
64
77
|
end
|
|
65
78
|
# rubocop:enable Metrics/BlockLength
|
metadata
CHANGED
|
@@ -1,14 +1,13 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: elastic-enterprise-search
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 8.
|
|
4
|
+
version: 8.18.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Fernando Briano
|
|
8
|
-
autorequire:
|
|
9
8
|
bindir: bin
|
|
10
9
|
cert_chain: []
|
|
11
|
-
date:
|
|
10
|
+
date: 2025-04-15 00:00:00.000000000 Z
|
|
12
11
|
dependencies:
|
|
13
12
|
- !ruby/object:Gem::Dependency
|
|
14
13
|
name: elastic-transport
|
|
@@ -104,16 +103,16 @@ dependencies:
|
|
|
104
103
|
name: rubocop
|
|
105
104
|
requirement: !ruby/object:Gem::Requirement
|
|
106
105
|
requirements:
|
|
107
|
-
- - "
|
|
106
|
+
- - ">="
|
|
108
107
|
- !ruby/object:Gem::Version
|
|
109
|
-
version: '1'
|
|
108
|
+
version: '1.51'
|
|
110
109
|
type: :development
|
|
111
110
|
prerelease: false
|
|
112
111
|
version_requirements: !ruby/object:Gem::Requirement
|
|
113
112
|
requirements:
|
|
114
|
-
- - "
|
|
113
|
+
- - ">="
|
|
115
114
|
- !ruby/object:Gem::Version
|
|
116
|
-
version: '1'
|
|
115
|
+
version: '1.51'
|
|
117
116
|
- !ruby/object:Gem::Dependency
|
|
118
117
|
name: vcr
|
|
119
118
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -134,14 +133,14 @@ dependencies:
|
|
|
134
133
|
requirements:
|
|
135
134
|
- - ">="
|
|
136
135
|
- !ruby/object:Gem::Version
|
|
137
|
-
version:
|
|
136
|
+
version: 3.23.1
|
|
138
137
|
type: :development
|
|
139
138
|
prerelease: false
|
|
140
139
|
version_requirements: !ruby/object:Gem::Requirement
|
|
141
140
|
requirements:
|
|
142
141
|
- - ">="
|
|
143
142
|
- !ruby/object:Gem::Version
|
|
144
|
-
version:
|
|
143
|
+
version: 3.23.1
|
|
145
144
|
- !ruby/object:Gem::Dependency
|
|
146
145
|
name: faraday-httpclient
|
|
147
146
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -226,7 +225,6 @@ files:
|
|
|
226
225
|
- ".buildkite/run-local.sh"
|
|
227
226
|
- ".buildkite/run-tests.sh"
|
|
228
227
|
- ".ci/.gitignore"
|
|
229
|
-
- ".ci/Dockerfile"
|
|
230
228
|
- ".ci/make.sh"
|
|
231
229
|
- ".github/check_license_headers.rb"
|
|
232
230
|
- ".github/license-header.txt"
|
|
@@ -243,6 +241,7 @@ files:
|
|
|
243
241
|
- NOTICE
|
|
244
242
|
- README.md
|
|
245
243
|
- Rakefile
|
|
244
|
+
- catalog-info.yaml
|
|
246
245
|
- docs/guide/app-search-api.asciidoc
|
|
247
246
|
- docs/guide/connecting.asciidoc
|
|
248
247
|
- docs/guide/development.asciidoc
|
|
@@ -465,7 +464,16 @@ metadata:
|
|
|
465
464
|
homepage_uri: https://www.elastic.co/enterprise-search
|
|
466
465
|
source_code_uri: https://github.com/elastic/enterprise-search-ruby
|
|
467
466
|
changelog_uri: https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/release_notes.html
|
|
468
|
-
post_install_message:
|
|
467
|
+
post_install_message: |2+
|
|
468
|
+
|
|
469
|
+
Warning: Starting with Elastic version 9.0, the standalone Enterprise Search products, will no longer be included in our offering. They remain supported in their current form in version 8.x and will only receive security upgrades and fixes.
|
|
470
|
+
Enterprise Search clients will continue to be supported in their current form throughout 8.x versions, according to our EOL policy: https://www.elastic.co/support/eol
|
|
471
|
+
We recommend transitioning to our actively developed Elastic Stack (https://www.elastic.co/elastic-stack) tools for your search use cases. However, if you're still using any Enterprise Search products, we recommend using the latest stable release of the clients.
|
|
472
|
+
|
|
473
|
+
Here are some useful links with more information:
|
|
474
|
+
* Enterprise Search FAQ: https://www.elastic.co/resources/enterprise-search/enterprise-search-faq
|
|
475
|
+
* Migrating to 9.x from Enterprise Search 8.x versions: https://www.elastic.co/guide/en/enterprise-search/current/upgrading-to-9-x.html
|
|
476
|
+
|
|
469
477
|
rdoc_options: []
|
|
470
478
|
require_paths:
|
|
471
479
|
- lib
|
|
@@ -480,8 +488,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
480
488
|
- !ruby/object:Gem::Version
|
|
481
489
|
version: '0'
|
|
482
490
|
requirements: []
|
|
483
|
-
rubygems_version: 3.
|
|
484
|
-
signing_key:
|
|
491
|
+
rubygems_version: 3.6.2
|
|
485
492
|
specification_version: 4
|
|
486
493
|
summary: Official API client for Elastic Enterprise Search
|
|
487
494
|
test_files: []
|
|
495
|
+
...
|
data/.ci/Dockerfile
DELETED
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
ARG RUBY_VERSION=2.7
|
|
2
|
-
FROM ruby:${RUBY_VERSION}
|
|
3
|
-
|
|
4
|
-
# Default UID/GID to 1000
|
|
5
|
-
# it can be overridden at build time
|
|
6
|
-
ARG BUILDER_UID=1000
|
|
7
|
-
ARG BUILDER_GID=1000
|
|
8
|
-
ENV BUILDER_USER elastic
|
|
9
|
-
ENV BUILDER_GROUP elastic
|
|
10
|
-
|
|
11
|
-
ENV GEM_HOME="/usr/local/bundle"
|
|
12
|
-
ENV PATH $GEM_HOME/bin:$GEM_HOME/gems/bin:$PATH
|
|
13
|
-
ENV QUIET=true
|
|
14
|
-
ENV CI=true
|
|
15
|
-
|
|
16
|
-
# Create user
|
|
17
|
-
RUN groupadd --system -g ${BUILDER_GID} ${BUILDER_GROUP} \
|
|
18
|
-
&& useradd --system --shell /bin/bash -u ${BUILDER_UID} -g ${BUILDER_GROUP} -d /var/lib/elastic -m elastic 1>/dev/null 2>/dev/null \
|
|
19
|
-
&& mkdir -p /code/enterprise-search-ruby && touch /Gemfile.lock \
|
|
20
|
-
&& chown -R ${BUILDER_USER}:${BUILDER_GROUP} /code/enterprise-search-ruby /Gemfile.lock
|
|
21
|
-
|
|
22
|
-
WORKDIR /code/enterprise-search-ruby
|
|
23
|
-
|
|
24
|
-
COPY --chown=$BUILDER_USER:$BUILDER_GROUP . .
|
|
25
|
-
RUN bundle install
|