elasticsearch 5.0.3 → 8.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.gitignore +4 -0
- data/Gemfile +21 -10
- data/LICENSE.txt +190 -1
- data/README.md +73 -46
- data/Rakefile +35 -29
- data/bin/elastic_ruby_console +28 -0
- data/elasticsearch.gemspec +50 -53
- data/lib/elasticsearch/version.rb +18 -1
- data/lib/elasticsearch-ruby.rb +17 -0
- data/lib/elasticsearch.rb +179 -5
- data/spec/integration/characters_escaping_spec.rb +94 -0
- data/spec/integration/client_integration_spec.rb +63 -0
- data/spec/spec_helper.rb +31 -0
- data/spec/unit/api_key_spec.rb +101 -0
- data/spec/unit/cloud_credentials_spec.rb +167 -0
- data/spec/unit/custom_transport_implementation_spec.rb +43 -0
- data/spec/unit/elasticsearch_product_validation_spec.rb +302 -0
- data/spec/unit/headers_spec.rb +55 -0
- data/spec/unit/opaque_id_spec.rb +48 -0
- data/spec/unit/wrapper_gem_spec.rb +33 -0
- metadata +51 -115
- data/test/integration/client_integration_test.rb +0 -60
- data/test/test_helper.rb +0 -61
- data/test/unit/wrapper_gem_test.rb +0 -26
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 4031c796f4dd1e18270a45c5b1f6c173d8cbcfcd800ba107d55755416cffd374
|
4
|
+
data.tar.gz: 3f500fc8cdf04a779a5a8e01ba0f9baf1024b63a86b4e360305d99285dd01ce9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c607e2c8a1bba5143ce888e3da179feb2137a3871d06e196b3b4786c903e01e19bdd84e7d5b1c5f675ab1e1d6d870065732020a733cf67db4b8c1b0c75082390
|
7
|
+
data.tar.gz: 2f08fe6140a6156028ee77246177498fc00ae2e08cd3cf0ab625054c30738fffdc9d0f6fc36445495536543ae9c1e235c41885af93e1a107226aa7e87ef38f22
|
data/.gitignore
CHANGED
data/Gemfile
CHANGED
@@ -1,16 +1,27 @@
|
|
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
|
+
|
1
20
|
source 'https://rubygems.org'
|
2
21
|
|
3
22
|
# Specify your gem's dependencies in elasticsearch.gemspec
|
4
23
|
gemspec
|
5
24
|
|
6
|
-
if File.exist? File.expand_path(
|
7
|
-
gem 'elasticsearch-api', :
|
8
|
-
end
|
9
|
-
|
10
|
-
if File.exist? File.expand_path("../../elasticsearch-transport/elasticsearch-transport.gemspec", __FILE__)
|
11
|
-
gem 'elasticsearch-transport', :path => File.expand_path("../../elasticsearch-transport", __FILE__), :require => false
|
12
|
-
end
|
13
|
-
|
14
|
-
if File.exist? File.expand_path("../../elasticsearch-extensions", __FILE__)
|
15
|
-
gem 'elasticsearch-extensions', :path => File.expand_path("../../elasticsearch-extensions", __FILE__), :require => true
|
25
|
+
if File.exist? File.expand_path('../elasticsearch-api/elasticsearch-api.gemspec', __dir__)
|
26
|
+
gem 'elasticsearch-api', path: File.expand_path('../elasticsearch-api', __dir__), require: false
|
16
27
|
end
|
data/LICENSE.txt
CHANGED
@@ -1,4 +1,193 @@
|
|
1
|
-
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
2
191
|
|
3
192
|
Licensed under the Apache License, Version 2.0 (the "License");
|
4
193
|
you may not use this file except in compliance with the License.
|
data/README.md
CHANGED
@@ -1,11 +1,34 @@
|
|
1
1
|
# Elasticsearch
|
2
2
|
|
3
|
-
The `elasticsearch` library provides a Ruby client and API for [Elasticsearch](http://elasticsearch.
|
3
|
+
The `elasticsearch` library provides a Ruby client and API for [Elasticsearch](http://elasticsearch.com).
|
4
|
+
|
5
|
+
## Usage
|
6
|
+
|
7
|
+
This gem is a wrapper for two separate libraries:
|
8
|
+
|
9
|
+
* [`elastic-transport`](https://github.com/elastic/elastic-transport-ruby/), which provides a low-level Ruby client for connecting to [Elastic](http://elasticsearch.com) services.
|
10
|
+
* [`elasticsearch-api`](https://github.com/elasticsearch/elasticsearch-ruby/tree/main/elasticsearch-api), which provides a Ruby API for the Elasticsearch RESTful API.
|
11
|
+
|
12
|
+
Install the `elasticsearch` package and use the API directly:
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'elasticsearch'
|
16
|
+
|
17
|
+
client = Elasticsearch::Client.new(log: true)
|
18
|
+
|
19
|
+
client.cluster.health
|
20
|
+
|
21
|
+
client.transport.reload_connections!
|
22
|
+
|
23
|
+
client.search(q: 'test')
|
24
|
+
|
25
|
+
# etc.
|
26
|
+
```
|
4
27
|
|
5
28
|
Features overview:
|
6
29
|
|
7
30
|
* Pluggable logging and tracing
|
8
|
-
*
|
31
|
+
* Pluggable connection selection strategies (round-robin, random, custom)
|
9
32
|
* Pluggable transport implementation, customizable and extendable
|
10
33
|
* Pluggable serializer implementation
|
11
34
|
* Request retries and dead connections handling
|
@@ -14,22 +37,13 @@ Features overview:
|
|
14
37
|
* Extensive documentation and examples
|
15
38
|
* Emphasis on modularity and extendability of both the client and API libraries
|
16
39
|
|
17
|
-
(For integration with Ruby models and Rails applications,
|
18
|
-
see the <https://github.com/elasticsearch/elasticsearch-rails> project.)
|
40
|
+
(For integration with Ruby models and Rails applications, see the <https://github.com/elasticsearch/elasticsearch-rails> project.)
|
19
41
|
|
20
42
|
## Compatibility
|
21
43
|
|
22
|
-
|
44
|
+
We follow Ruby’s own maintenance policy and officially support all currently maintained versions per [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/).
|
23
45
|
|
24
|
-
|
25
|
-
just use a release matching major version of Elasticsearch.
|
26
|
-
|
27
|
-
| Ruby | | Elasticsearch |
|
28
|
-
|:-------------:|:-:| :-----------: |
|
29
|
-
| 0.90 | → | 0.90 |
|
30
|
-
| 1.x | → | 1.x |
|
31
|
-
| 2.x | → | 2.x |
|
32
|
-
| master | → | master |
|
46
|
+
Language clients are forward compatible; meaning that clients support communicating with greater minor versions of Elasticsearch. Elastic language clients are also backwards compatible with lesser supported minor Elasticsearch versions.
|
33
47
|
|
34
48
|
## Installation
|
35
49
|
|
@@ -48,55 +62,68 @@ or install it from a source code checkout:
|
|
48
62
|
bundle install
|
49
63
|
rake install
|
50
64
|
|
51
|
-
##
|
65
|
+
## Configuration
|
52
66
|
|
53
|
-
|
67
|
+
* [Identifying running tasks with X-Opaque-Id](#identifying-running-tasks-with-x-opaque-id)
|
68
|
+
* [Api Key Authentication](#api-key-authentication)
|
54
69
|
|
55
|
-
|
56
|
-
which provides a low-level Ruby client for connecting to an [Elasticsearch](http://elasticsearch.org) cluster
|
57
|
-
* [`elasticsearch-api`](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-api),
|
58
|
-
which provides a Ruby API for the Elasticsearch RESTful API
|
70
|
+
### Identifying running tasks with X-Opaque-Id
|
59
71
|
|
60
|
-
|
72
|
+
The X-Opaque-Id header allows to track certain calls, or associate certain tasks with the client that started them ([more on the Elasticsearch docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/tasks.html#_identifying_running_tasks)). To use this feature, you need to set an id for `opaque_id` on the client on each request. Example:
|
61
73
|
|
62
74
|
```ruby
|
63
|
-
|
75
|
+
client = Elasticsearch::Client.new
|
76
|
+
client.search(index: 'myindex', q: 'title:test', opaque_id: '123456')
|
77
|
+
```
|
78
|
+
The search request will include the following HTTP Header:
|
79
|
+
```
|
80
|
+
X-Opaque-Id: 123456
|
81
|
+
```
|
64
82
|
|
65
|
-
client
|
83
|
+
You can also set a prefix for X-Opaque-Id when initializing the client. This will be prepended to the id you set before each request if you're using X-Opaque-Id. Example:
|
84
|
+
```ruby
|
85
|
+
client = Elastic::Transport::Client.new(opaque_id_prefix: 'eu-west1_')
|
86
|
+
client.search(index: 'myindex', q: 'title:test', opaque_id: '123456')
|
87
|
+
```
|
88
|
+
The request will include the following HTTP Header:
|
89
|
+
```
|
90
|
+
X-Opaque-Id: eu-west1_123456
|
91
|
+
```
|
66
92
|
|
67
|
-
|
93
|
+
### Api Key Authentication
|
68
94
|
|
69
|
-
|
95
|
+
You can use [**API Key authentication**](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html):
|
70
96
|
|
71
|
-
|
97
|
+
``` ruby
|
98
|
+
Elasticsearch::Client.new(
|
99
|
+
host: host,
|
100
|
+
transport_options: transport_options,
|
101
|
+
api_key: credentials
|
102
|
+
)
|
103
|
+
```
|
72
104
|
|
73
|
-
|
105
|
+
Where credentials is either the base64 encoding of `id` and `api_key` joined by a colon or a hash with the `id` and `api_key`:
|
106
|
+
|
107
|
+
``` ruby
|
108
|
+
Elasticsearch::Client.new(
|
109
|
+
host: host,
|
110
|
+
transport_options: transport_options,
|
111
|
+
api_key: {id: 'my_id', api_key: 'my_api_key'}
|
112
|
+
)
|
74
113
|
```
|
75
114
|
|
115
|
+
## API and Transport
|
116
|
+
|
76
117
|
Please refer to the specific library documentation for details:
|
77
118
|
|
78
119
|
* **Transport**:
|
79
|
-
[[README]](https://github.com/
|
80
|
-
[[Documentation]](
|
120
|
+
[[README]](https://github.com/elastic/elastic-transport-ruby#elastic-transport)
|
121
|
+
[[Documentation]](https://rubydoc.info/github/elastic/elastic-transport-ruby/)
|
81
122
|
|
82
123
|
* **API**:
|
83
|
-
[[README]](https://github.com/
|
84
|
-
[[Documentation]](
|
124
|
+
[[README]](https://github.com/elastic/elasticsearch-ruby/tree/main/elasticsearch-api#elasticsearchapi)
|
125
|
+
[[Documentation]](https://rubydoc.info/gems/elasticsearch-api)
|
85
126
|
|
86
127
|
## License
|
87
128
|
|
88
|
-
This software is licensed under the Apache 2 license
|
89
|
-
|
90
|
-
Copyright (c) 2013 Elasticsearch <http://www.elasticsearch.org>
|
91
|
-
|
92
|
-
Licensed under the Apache License, Version 2.0 (the "License");
|
93
|
-
you may not use this file except in compliance with the License.
|
94
|
-
You may obtain a copy of the License at
|
95
|
-
|
96
|
-
http://www.apache.org/licenses/LICENSE-2.0
|
97
|
-
|
98
|
-
Unless required by applicable law or agreed to in writing, software
|
99
|
-
distributed under the License is distributed on an "AS IS" BASIS,
|
100
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
101
|
-
See the License for the specific language governing permissions and
|
102
|
-
limitations under the License.
|
129
|
+
This software is licensed under the [Apache 2 license](./LICENSE).
|
data/Rakefile
CHANGED
@@ -1,43 +1,49 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
4
|
-
|
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
|
+
require 'bundler/gem_tasks'
|
19
|
+
|
20
|
+
task(:default) { system 'rake --tasks' }
|
21
|
+
|
22
|
+
desc 'Run unit tests'
|
23
|
+
task test: 'test:spec'
|
5
24
|
|
6
25
|
# ----- Test tasks ------------------------------------------------------------
|
26
|
+
require 'rspec/core/rake_task'
|
7
27
|
|
8
|
-
require 'rake/testtask'
|
9
28
|
namespace :test do
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
require 'ci/reporter/rake/test_unit'
|
14
|
-
Rake::Task['ci:setup:testunit'].invoke
|
15
|
-
else
|
16
|
-
require 'ci/reporter/rake/minitest'
|
17
|
-
Rake::Task['ci:setup:minitest'].invoke
|
18
|
-
end
|
29
|
+
desc 'Wait for Elasticsearch to be in a green state'
|
30
|
+
task :wait_for_green do
|
31
|
+
sh '../scripts/wait-cluster.sh'
|
19
32
|
end
|
20
33
|
|
21
|
-
|
22
|
-
|
23
|
-
test.libs << 'lib' << 'test'
|
24
|
-
test.test_files = FileList["test/unit/**/*_test.rb"]
|
25
|
-
# test.verbose = true
|
26
|
-
# test.warning = true
|
34
|
+
RSpec::Core::RakeTask.new(:integration) do |t|
|
35
|
+
t.pattern = 'spec/integration/**{,/*/**}/*_spec.rb'
|
27
36
|
end
|
28
37
|
|
29
|
-
|
30
|
-
|
31
|
-
test.libs << 'lib' << 'test'
|
32
|
-
test.test_files = FileList["test/integration/**/*_test.rb"]
|
38
|
+
RSpec::Core::RakeTask.new(:unit) do |t|
|
39
|
+
t.pattern = 'spec/unit/**{,/*/**}/*_spec.rb'
|
33
40
|
end
|
34
41
|
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
42
|
+
desc 'Run unit and integration tests'
|
43
|
+
task :all do
|
44
|
+
Rake::Task['test:unit'].invoke
|
45
|
+
Rake::Task['test:integration'].invoke
|
39
46
|
end
|
40
|
-
|
41
47
|
end
|
42
48
|
|
43
49
|
# ----- Documentation tasks ---------------------------------------------------
|
@@ -0,0 +1,28 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
$LOAD_PATH.unshift(File.expand_path('../../elasticsearch/lib', __dir__))
|
4
|
+
$LOAD_PATH.unshift(File.expand_path('../../elasticsearch-api/lib', __dir__))
|
5
|
+
|
6
|
+
require 'elasticsearch'
|
7
|
+
require 'elasticsearch-api'
|
8
|
+
|
9
|
+
include Elasticsearch
|
10
|
+
|
11
|
+
begin
|
12
|
+
require 'pry'
|
13
|
+
rescue LoadError
|
14
|
+
end
|
15
|
+
|
16
|
+
begin
|
17
|
+
require 'irb'
|
18
|
+
rescue LoadError
|
19
|
+
end
|
20
|
+
|
21
|
+
if defined?(Pry)
|
22
|
+
Pry.config.prompt_name = 'elastic_ruby'
|
23
|
+
Pry.start
|
24
|
+
elsif defined?(IRB)
|
25
|
+
IRB.start
|
26
|
+
else
|
27
|
+
abort 'LoadError: elastic_ruby_console requires Pry or IRB'
|
28
|
+
end
|
data/elasticsearch.gemspec
CHANGED
@@ -1,66 +1,63 @@
|
|
1
|
-
#
|
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
|
+
|
2
18
|
lib = File.expand_path('../lib', __FILE__)
|
3
19
|
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
20
|
require 'elasticsearch/version'
|
5
21
|
|
6
22
|
Gem::Specification.new do |s|
|
7
|
-
s.name =
|
23
|
+
s.name = 'elasticsearch'
|
8
24
|
s.version = Elasticsearch::VERSION
|
9
|
-
s.authors = [
|
10
|
-
s.email = [
|
11
|
-
s.summary =
|
12
|
-
s.homepage =
|
13
|
-
s.license =
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
s.
|
21
|
-
s.
|
22
|
-
|
23
|
-
s.
|
24
|
-
s.
|
25
|
-
|
26
|
-
s.add_development_dependency "bundler", "> 1"
|
27
|
-
|
28
|
-
if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
|
29
|
-
s.add_development_dependency "rake", "~> 11.1"
|
30
|
-
else
|
31
|
-
s.add_development_dependency "rake", "< 11.0"
|
32
|
-
end
|
33
|
-
|
34
|
-
if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
|
35
|
-
s.add_development_dependency "elasticsearch-extensions"
|
36
|
-
end
|
25
|
+
s.authors = ['Karel Minarik']
|
26
|
+
s.email = ['karel.minarik@elasticsearch.org']
|
27
|
+
s.summary = 'Ruby integrations for Elasticsearch'
|
28
|
+
s.homepage = 'https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html'
|
29
|
+
s.license = 'Apache-2.0'
|
30
|
+
s.metadata = {
|
31
|
+
'homepage_uri' => 'https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html',
|
32
|
+
'changelog_uri' => 'https://github.com/elastic/elasticsearch-ruby/blob/main/CHANGELOG.md',
|
33
|
+
'source_code_uri' => 'https://github.com/elastic/elasticsearch-ruby/tree/main',
|
34
|
+
'bug_tracker_uri' => 'https://github.com/elastic/elasticsearch-ruby/issues'
|
35
|
+
}
|
36
|
+
s.files = `git ls-files`.split($/)
|
37
|
+
s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
38
|
+
s.executables << 'elastic_ruby_console'
|
39
|
+
s.test_files = s.files.grep(%r{^(test|spec|features)/})
|
40
|
+
s.require_paths = ['lib']
|
41
|
+
s.bindir = 'bin'
|
37
42
|
|
38
|
-
s.
|
39
|
-
s.
|
40
|
-
s.add_development_dependency "mocha"
|
41
|
-
s.add_development_dependency "turn"
|
42
|
-
s.add_development_dependency "yard"
|
43
|
-
s.add_development_dependency "pry"
|
44
|
-
s.add_development_dependency "ci_reporter", "~> 1.9"
|
43
|
+
s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
|
44
|
+
s.rdoc_options = ['--charset=UTF-8']
|
45
45
|
|
46
|
-
|
47
|
-
if defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'
|
48
|
-
s.add_development_dependency "test-unit", '~> 2'
|
49
|
-
s.add_development_dependency "json", '~> 1.8'
|
50
|
-
end
|
46
|
+
s.required_ruby_version = '>= 2.5'
|
51
47
|
|
52
|
-
|
53
|
-
|
54
|
-
s.add_development_dependency "ruby-prof" unless defined?(JRUBY_VERSION) || defined?(Rubinius)
|
55
|
-
s.add_development_dependency "require-prof" unless defined?(JRUBY_VERSION) || defined?(Rubinius)
|
56
|
-
s.add_development_dependency "simplecov"
|
57
|
-
s.add_development_dependency "simplecov-rcov"
|
58
|
-
s.add_development_dependency "cane"
|
59
|
-
end
|
48
|
+
s.add_dependency 'elastic-transport', '~> 8'
|
49
|
+
s.add_dependency 'elasticsearch-api', '8.3.0'
|
60
50
|
|
61
|
-
|
62
|
-
|
63
|
-
|
51
|
+
s.add_development_dependency 'bundler'
|
52
|
+
s.add_development_dependency 'byebug' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
|
53
|
+
s.add_development_dependency 'pry'
|
54
|
+
s.add_development_dependency 'rake'
|
55
|
+
s.add_development_dependency 'require-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
|
56
|
+
s.add_development_dependency 'rspec'
|
57
|
+
s.add_development_dependency 'ruby-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
|
58
|
+
s.add_development_dependency 'simplecov'
|
59
|
+
s.add_development_dependency 'webmock'
|
60
|
+
s.add_development_dependency 'yard'
|
64
61
|
|
65
62
|
s.description = <<-DESC.gsub(/^ /, '')
|
66
63
|
Ruby integrations for Elasticsearch (client, API, etc.)
|