algoliasearch 1.26.0 → 1.26.1
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/CHANGELOG.md +9 -0
- data/Gemfile +0 -1
- data/Gemfile.lock +33 -28
- data/README.md +31 -338
- data/lib/algolia/version.rb +1 -1
- data/spec/spec_helper.rb +0 -5
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4b688a2dbf301d12d5334b0ae73dbb287bd5054f1a19499d59c68c3b69713569
|
|
4
|
+
data.tar.gz: d8d8dc2d476cc6f4e9b8ad81437f390401e1c720a61184b020ec15638026b6c3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 40e6001e2b9b43490d9dc6ee901054d53b822f04c87d62c0979eaa6bd8671da4f7f94d9a781a7ffb5fb8e834cbcef63231a2469e42364177ee598fa1428f3f4e
|
|
7
|
+
data.tar.gz: de731f8dff00f9084da3fd9e230dfc2ef286cccbea2958a5512690ac229044180e5af2118c37fd3048bc54e238669e60b77b38bacc03675855a2edb510bb0541
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,12 @@
|
|
|
1
|
+
# ChangeLog
|
|
2
|
+
|
|
3
|
+
## [1.26.1](https://github.com/algolia/algoliasearch-client-ruby/compare/1.26.0...1.26.1) (2019-07-31)
|
|
4
|
+
|
|
5
|
+
### Chore
|
|
6
|
+
|
|
7
|
+
- stop using coveralls because of a GPL-licensed transitive dep ([d2fbe8c](https://github.com/algolia/algoliasearch-client-ruby/commit/d2fbe8c))
|
|
8
|
+
|
|
9
|
+
|
|
1
10
|
[1.26.0](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/1.26.0) (2019-02-12)
|
|
2
11
|
|
|
3
12
|
**Added**
|
data/Gemfile
CHANGED
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
algoliasearch (1.
|
|
4
|
+
algoliasearch (1.26.0)
|
|
5
5
|
httpclient (~> 2.8, >= 2.8.3)
|
|
6
6
|
json (>= 1.5.1)
|
|
7
7
|
|
|
@@ -9,24 +9,24 @@ GEM
|
|
|
9
9
|
remote: https://rubygems.org/
|
|
10
10
|
specs:
|
|
11
11
|
addressable (2.4.0)
|
|
12
|
-
backports (3.
|
|
13
|
-
coveralls (0.
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
12
|
+
backports (3.15.0)
|
|
13
|
+
coveralls (0.7.2)
|
|
14
|
+
multi_json (~> 1.3)
|
|
15
|
+
rest-client (= 1.6.7)
|
|
16
|
+
simplecov (>= 0.7)
|
|
17
|
+
term-ansicolor (= 1.2.2)
|
|
18
|
+
thor (= 0.18.1)
|
|
19
19
|
crack (0.4.3)
|
|
20
20
|
safe_yaml (~> 1.0.0)
|
|
21
21
|
diff-lcs (1.3)
|
|
22
|
-
docile (1.3.
|
|
22
|
+
docile (1.3.2)
|
|
23
23
|
ethon (0.12.0)
|
|
24
24
|
ffi (>= 1.3.0)
|
|
25
25
|
faraday (0.15.4)
|
|
26
26
|
multipart-post (>= 1.2, < 3)
|
|
27
|
-
faraday_middleware (0.
|
|
27
|
+
faraday_middleware (0.13.1)
|
|
28
28
|
faraday (>= 0.7.4, < 1.0)
|
|
29
|
-
ffi (1.
|
|
29
|
+
ffi (1.11.1)
|
|
30
30
|
ffi2-generators (0.1.1)
|
|
31
31
|
gh (0.15.1)
|
|
32
32
|
addressable (~> 2.4.0)
|
|
@@ -35,14 +35,17 @@ GEM
|
|
|
35
35
|
multi_json (~> 1.0)
|
|
36
36
|
net-http-persistent (~> 2.9)
|
|
37
37
|
net-http-pipeline
|
|
38
|
-
hashdiff (0.
|
|
38
|
+
hashdiff (1.0.0)
|
|
39
39
|
highline (1.7.10)
|
|
40
40
|
httpclient (2.8.3)
|
|
41
|
-
json (2.
|
|
41
|
+
json (2.2.0)
|
|
42
42
|
launchy (2.4.3)
|
|
43
43
|
addressable (~> 2.3)
|
|
44
|
+
mime-types (3.2.2)
|
|
45
|
+
mime-types-data (~> 3.2015)
|
|
46
|
+
mime-types-data (3.2019.0331)
|
|
44
47
|
multi_json (1.13.1)
|
|
45
|
-
multipart-post (2.
|
|
48
|
+
multipart-post (2.1.1)
|
|
46
49
|
net-http-persistent (2.9.4)
|
|
47
50
|
net-http-pipeline (1.0.1)
|
|
48
51
|
pusher-client (0.6.2)
|
|
@@ -50,19 +53,21 @@ GEM
|
|
|
50
53
|
websocket (~> 1.0)
|
|
51
54
|
rake (12.3.2)
|
|
52
55
|
rdoc (6.1.1)
|
|
56
|
+
rest-client (1.6.7)
|
|
57
|
+
mime-types (>= 1.16)
|
|
53
58
|
rspec (3.8.0)
|
|
54
59
|
rspec-core (~> 3.8.0)
|
|
55
60
|
rspec-expectations (~> 3.8.0)
|
|
56
61
|
rspec-mocks (~> 3.8.0)
|
|
57
|
-
rspec-core (3.8.
|
|
62
|
+
rspec-core (3.8.2)
|
|
58
63
|
rspec-support (~> 3.8.0)
|
|
59
|
-
rspec-expectations (3.8.
|
|
64
|
+
rspec-expectations (3.8.4)
|
|
60
65
|
diff-lcs (>= 1.2.0, < 2.0)
|
|
61
66
|
rspec-support (~> 3.8.0)
|
|
62
|
-
rspec-mocks (3.8.
|
|
67
|
+
rspec-mocks (3.8.1)
|
|
63
68
|
diff-lcs (>= 1.2.0, < 2.0)
|
|
64
69
|
rspec-support (~> 3.8.0)
|
|
65
|
-
rspec-support (3.8.
|
|
70
|
+
rspec-support (3.8.2)
|
|
66
71
|
rubysl (2.2.0)
|
|
67
72
|
rubysl-abbrev (~> 2.0)
|
|
68
73
|
rubysl-base64 (~> 2.0)
|
|
@@ -265,17 +270,17 @@ GEM
|
|
|
265
270
|
rubysl-xmlrpc (2.0.0)
|
|
266
271
|
rubysl-yaml (2.1.0)
|
|
267
272
|
rubysl-zlib (2.0.1)
|
|
268
|
-
safe_yaml (1.0.
|
|
269
|
-
simplecov (0.
|
|
273
|
+
safe_yaml (1.0.5)
|
|
274
|
+
simplecov (0.17.0)
|
|
270
275
|
docile (~> 1.1)
|
|
271
276
|
json (>= 1.8, < 3)
|
|
272
277
|
simplecov-html (~> 0.10.0)
|
|
273
278
|
simplecov-html (0.10.2)
|
|
274
|
-
term-ansicolor (1.
|
|
275
|
-
tins (~>
|
|
276
|
-
thor (0.
|
|
277
|
-
tins (
|
|
278
|
-
travis (1.8.
|
|
279
|
+
term-ansicolor (1.2.2)
|
|
280
|
+
tins (~> 0.8)
|
|
281
|
+
thor (0.18.1)
|
|
282
|
+
tins (0.13.2)
|
|
283
|
+
travis (1.8.10)
|
|
279
284
|
backports
|
|
280
285
|
faraday (~> 0.9)
|
|
281
286
|
faraday_middleware (~> 0.9, >= 0.9.1)
|
|
@@ -286,10 +291,10 @@ GEM
|
|
|
286
291
|
typhoeus (~> 0.6, >= 0.6.8)
|
|
287
292
|
typhoeus (0.8.0)
|
|
288
293
|
ethon (>= 0.8.0)
|
|
289
|
-
webmock (3.
|
|
294
|
+
webmock (3.6.0)
|
|
290
295
|
addressable (>= 2.3.6)
|
|
291
296
|
crack (>= 0.3.2)
|
|
292
|
-
hashdiff
|
|
297
|
+
hashdiff (>= 0.4.0, < 2.0.0)
|
|
293
298
|
websocket (1.2.8)
|
|
294
299
|
|
|
295
300
|
PLATFORMS
|
|
@@ -307,4 +312,4 @@ DEPENDENCIES
|
|
|
307
312
|
webmock
|
|
308
313
|
|
|
309
314
|
BUNDLED WITH
|
|
310
|
-
|
|
315
|
+
2.0.2
|
data/README.md
CHANGED
|
@@ -1,363 +1,56 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://www.algolia.com">
|
|
3
|
+
<img alt="Algolia for Ruby" src="https://raw.githubusercontent.com/algolia/algoliasearch-client-common/master/banners/ruby.png" >
|
|
4
|
+
</a>
|
|
2
5
|
|
|
3
|
-
|
|
6
|
+
<h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your Ruby project</h4>
|
|
4
7
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
+
<p align="center">
|
|
9
|
+
<a href="https://travis-ci.org/algolia/algoliasearch-client-ruby"><img src="https://img.shields.io/travis/algolia/algoliasearch-client-ruby/master.svg" alt="Build Status"></a>
|
|
10
|
+
<a href="https://rubygems.org/gems/algoliasearch/versions/1.26.0"><img src="https://badge.fury.io/rb/algoliasearch.svg" alt="Gem Version"></a>
|
|
11
|
+
<a href="https://rubygems.org/gems/algoliasearch/versions/1.26.0"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="License"></a>
|
|
12
|
+
</p>
|
|
13
|
+
</p>
|
|
8
14
|
|
|
9
|
-
|
|
15
|
+
<p align="center">
|
|
16
|
+
<a href="https://www.algolia.com/doc/api-client/getting-started/install/ruby/" target="_blank">Documentation</a> •
|
|
17
|
+
<a href="https://github.com/algolia/algoliasearch-rails" target="_blank">Rails</a> •
|
|
18
|
+
<a href="https://discourse.algolia.com" target="_blank">Community Forum</a> •
|
|
19
|
+
<a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a> •
|
|
20
|
+
<a href="https://github.com/algolia/algoliasearch-client-ruby/issues" target="_blank">Report a bug</a> •
|
|
21
|
+
<a href="https://www.algolia.com/support" target="_blank">Support</a>
|
|
22
|
+
</p>
|
|
10
23
|
|
|
24
|
+
## ✨ Features
|
|
11
25
|
|
|
12
|
-
|
|
26
|
+
- Thin & minimal low-level HTTP client to interact with Algolia's API
|
|
27
|
+
- Supports Ruby `^1.8.7`.
|
|
13
28
|
|
|
29
|
+
## 💡 Getting Started
|
|
14
30
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
## API Documentation
|
|
18
|
-
|
|
19
|
-
You can find the full reference on [Algolia's website](https://www.algolia.com/doc/api-client/ruby/).
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
1. **[Install](#install)**
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
1. **[Quick Start](#quick-start)**
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
1. **[Push data](#push-data)**
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
1. **[Configure](#configure)**
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
1. **[Search](#search)**
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
1. **[Search UI](#search-ui)**
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
1. **[List of available methods](#list-of-available-methods)**
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
# Getting Started
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
## Install
|
|
49
|
-
|
|
50
|
-
Install the Ruby client using [RubyGems](https://rubygems.org/):
|
|
51
|
-
|
|
31
|
+
First, install Algolia Ruby API Client via the [RubyGems](https://rubygems.org/) package manager:
|
|
52
32
|
```bash
|
|
53
33
|
gem install algoliasearch
|
|
54
34
|
```
|
|
55
35
|
|
|
56
|
-
|
|
36
|
+
Then, create objects on your index:
|
|
57
37
|
|
|
58
|
-
If you're a Ruby on Rails user, you're probably looking for the [algoliasearch-rails](https://github.com/algolia/algoliasearch-rails) gem.
|
|
59
|
-
|
|
60
|
-
## Quick Start
|
|
61
|
-
|
|
62
|
-
In 30 seconds, this quick start tutorial will show you how to index and search objects.
|
|
63
|
-
|
|
64
|
-
### Initialize the client
|
|
65
|
-
|
|
66
|
-
To start, you need to initialize the client. To do this, you need your **Application ID** and **API Key**.
|
|
67
|
-
You can find both on [your Algolia account](https://www.algolia.com/api-keys).
|
|
68
38
|
|
|
69
39
|
```ruby
|
|
70
|
-
require 'rubygems'
|
|
71
|
-
require 'algoliasearch'
|
|
72
|
-
|
|
73
40
|
Algolia.init(application_id: 'YourApplicationID',
|
|
74
41
|
api_key: 'YourAPIKey')
|
|
75
42
|
index = Algolia::Index.new('your_index_name')
|
|
76
|
-
```
|
|
77
43
|
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
Without any prior configuration, you can start indexing [500 contacts](https://github.com/algolia/datasets/blob/master/contacts/contacts.json) in the ```contacts``` index using the following code:
|
|
81
|
-
```ruby
|
|
82
|
-
index = Algolia::Index.new('contacts')
|
|
83
|
-
batch = JSON.parse(File.read('contacts.json'))
|
|
84
|
-
index.add_objects(batch)
|
|
44
|
+
index.save_objects([objectID: 1, name: 'Foo'])
|
|
85
45
|
```
|
|
86
46
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
You can customize settings to fine tune the search behavior. For example, you can add a custom ranking by number of followers to further enhance the built-in relevance:
|
|
90
|
-
|
|
91
|
-
```ruby
|
|
92
|
-
index.set_settings(customRanking: ['desc(followers)'])
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
You can also configure the list of attributes you want to index by order of importance (most important first).
|
|
96
|
-
|
|
97
|
-
**Note:** Algolia is designed to suggest results as you type, which means you'll generally search by prefix.
|
|
98
|
-
In this case, the order of attributes is crucial to decide which hit is the best.
|
|
99
|
-
|
|
100
|
-
```ruby
|
|
101
|
-
index.set_settings({
|
|
102
|
-
searchableAttributes: [
|
|
103
|
-
'lastname',
|
|
104
|
-
'firstname',
|
|
105
|
-
'company',
|
|
106
|
-
'email',
|
|
107
|
-
'city',
|
|
108
|
-
'address'
|
|
109
|
-
]}
|
|
110
|
-
)
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
## Search
|
|
114
|
-
|
|
115
|
-
You can now search for contacts by `firstname`, `lastname`, `company`, etc. (even with typos):
|
|
116
|
-
|
|
47
|
+
Finally, you may begin searching a object using the `search` method:
|
|
117
48
|
```ruby
|
|
118
|
-
|
|
119
|
-
puts index.search('jimmie').to_json
|
|
120
|
-
# Search for a first name with typo
|
|
121
|
-
puts index.search('jimie').to_json
|
|
122
|
-
# Search for a company
|
|
123
|
-
puts index.search('california paint').to_json
|
|
124
|
-
# Search for a first name and a company
|
|
125
|
-
puts index.search('jimmie paint').to_json
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
## Search UI
|
|
129
|
-
|
|
130
|
-
**Warning:** If you're building a web application, you may be interested in using one of our
|
|
131
|
-
[front-end search UI libraries](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/).
|
|
132
|
-
|
|
133
|
-
The following example shows how to quickly build a front-end search using
|
|
134
|
-
[InstantSearch.js](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/)
|
|
135
|
-
|
|
136
|
-
### index.html
|
|
137
|
-
|
|
138
|
-
```html
|
|
139
|
-
<!doctype html>
|
|
140
|
-
<head>
|
|
141
|
-
<meta charset="UTF-8">
|
|
142
|
-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/instantsearch.css@7.1.0/themes/algolia.css" />
|
|
143
|
-
</head>
|
|
144
|
-
<body>
|
|
145
|
-
<header>
|
|
146
|
-
<div>
|
|
147
|
-
<input id="search-input" placeholder="Search for products">
|
|
148
|
-
<!-- We use a specific placeholder in the input to guide users in their search. -->
|
|
149
|
-
|
|
150
|
-
</header>
|
|
151
|
-
<main>
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
</main>
|
|
155
|
-
|
|
156
|
-
<script type="text/html" id="hit-template">
|
|
157
|
-
|
|
158
|
-
<p class="hit-name">
|
|
159
|
-
{}{ "attribute": "firstname" }{{/helpers.highlight}}
|
|
160
|
-
{}{ "attribute": "lastname" }{{/helpers.highlight}}
|
|
161
|
-
</p>
|
|
162
|
-
|
|
163
|
-
</script>
|
|
164
|
-
|
|
165
|
-
<script src="https://cdn.jsdelivr.net/npm/instantsearch.js@3.0.0"></script>
|
|
166
|
-
<script src="app.js"></script>
|
|
167
|
-
</body>
|
|
168
|
-
```
|
|
169
|
-
|
|
170
|
-
### app.js
|
|
171
|
-
|
|
172
|
-
```js
|
|
173
|
-
// Replace with your own values
|
|
174
|
-
var searchClient = algoliasearch(
|
|
175
|
-
'YourApplicationID',
|
|
176
|
-
'YourAPIKey' // search only API key, no ADMIN key
|
|
177
|
-
);
|
|
178
|
-
|
|
179
|
-
var search = instantsearch({
|
|
180
|
-
indexName: 'instant_search',
|
|
181
|
-
searchClient: searchClient,
|
|
182
|
-
routing: true,
|
|
183
|
-
searchParameters: {
|
|
184
|
-
hitsPerPage: 10
|
|
185
|
-
}
|
|
186
|
-
});
|
|
187
|
-
|
|
188
|
-
search.addWidget(
|
|
189
|
-
instantsearch.widgets.searchBox({
|
|
190
|
-
container: '#search-input'
|
|
191
|
-
})
|
|
192
|
-
);
|
|
193
|
-
|
|
194
|
-
search.addWidget(
|
|
195
|
-
instantsearch.widgets.hits({
|
|
196
|
-
container: '#hits',
|
|
197
|
-
templates: {
|
|
198
|
-
item: document.getElementById('hit-template').innerHTML,
|
|
199
|
-
empty: "We didn't find any results for the search <em>\"{{query}}\"</em>"
|
|
200
|
-
}
|
|
201
|
-
})
|
|
202
|
-
);
|
|
203
|
-
|
|
204
|
-
search.start();
|
|
49
|
+
objects = index.search('Fo')
|
|
205
50
|
```
|
|
206
51
|
|
|
52
|
+
For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/api-client/getting-started/install/ruby/)**.
|
|
207
53
|
|
|
54
|
+
## 📄 License
|
|
208
55
|
|
|
209
|
-
|
|
210
|
-
## List of available methods
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
### Personalization
|
|
217
|
-
|
|
218
|
-
- [Add strategy](https://algolia.com/doc/api-reference/api-methods/add-strategy/?language=ruby)
|
|
219
|
-
- [Get strategy](https://algolia.com/doc/api-reference/api-methods/get-strategy/?language=ruby)
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
### Search
|
|
225
|
-
|
|
226
|
-
- [Search index](https://algolia.com/doc/api-reference/api-methods/search/?language=ruby)
|
|
227
|
-
- [Search for facet values](https://algolia.com/doc/api-reference/api-methods/search-for-facet-values/?language=ruby)
|
|
228
|
-
- [Search multiple indices](https://algolia.com/doc/api-reference/api-methods/multiple-queries/?language=ruby)
|
|
229
|
-
- [Browse index](https://algolia.com/doc/api-reference/api-methods/browse/?language=ruby)
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
### Indexing
|
|
235
|
-
|
|
236
|
-
- [Add objects](https://algolia.com/doc/api-reference/api-methods/add-objects/?language=ruby)
|
|
237
|
-
- [Save objects](https://algolia.com/doc/api-reference/api-methods/save-objects/?language=ruby)
|
|
238
|
-
- [Partial update objects](https://algolia.com/doc/api-reference/api-methods/partial-update-objects/?language=ruby)
|
|
239
|
-
- [Delete objects](https://algolia.com/doc/api-reference/api-methods/delete-objects/?language=ruby)
|
|
240
|
-
- [Replace all objects](https://algolia.com/doc/api-reference/api-methods/replace-all-objects/?language=ruby)
|
|
241
|
-
- [Delete by](https://algolia.com/doc/api-reference/api-methods/delete-by/?language=ruby)
|
|
242
|
-
- [Clear objects](https://algolia.com/doc/api-reference/api-methods/clear-objects/?language=ruby)
|
|
243
|
-
- [Get objects](https://algolia.com/doc/api-reference/api-methods/get-objects/?language=ruby)
|
|
244
|
-
- [Custom batch](https://algolia.com/doc/api-reference/api-methods/batch/?language=ruby)
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
### Settings
|
|
250
|
-
|
|
251
|
-
- [Get settings](https://algolia.com/doc/api-reference/api-methods/get-settings/?language=ruby)
|
|
252
|
-
- [Set settings](https://algolia.com/doc/api-reference/api-methods/set-settings/?language=ruby)
|
|
253
|
-
- [Copy settings](https://algolia.com/doc/api-reference/api-methods/copy-settings/?language=ruby)
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
### Manage indices
|
|
259
|
-
|
|
260
|
-
- [List indices](https://algolia.com/doc/api-reference/api-methods/list-indices/?language=ruby)
|
|
261
|
-
- [Delete index](https://algolia.com/doc/api-reference/api-methods/delete-index/?language=ruby)
|
|
262
|
-
- [Copy index](https://algolia.com/doc/api-reference/api-methods/copy-index/?language=ruby)
|
|
263
|
-
- [Move index](https://algolia.com/doc/api-reference/api-methods/move-index/?language=ruby)
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
### API Keys
|
|
269
|
-
|
|
270
|
-
- [Create secured API Key](https://algolia.com/doc/api-reference/api-methods/generate-secured-api-key/?language=ruby)
|
|
271
|
-
- [Add API Key](https://algolia.com/doc/api-reference/api-methods/add-api-key/?language=ruby)
|
|
272
|
-
- [Update API Key](https://algolia.com/doc/api-reference/api-methods/update-api-key/?language=ruby)
|
|
273
|
-
- [Delete API Key](https://algolia.com/doc/api-reference/api-methods/delete-api-key/?language=ruby)
|
|
274
|
-
- [Get API Key permissions](https://algolia.com/doc/api-reference/api-methods/get-api-key/?language=ruby)
|
|
275
|
-
- [List API Keys](https://algolia.com/doc/api-reference/api-methods/list-api-keys/?language=ruby)
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
### Synonyms
|
|
281
|
-
|
|
282
|
-
- [Save synonym](https://algolia.com/doc/api-reference/api-methods/save-synonym/?language=ruby)
|
|
283
|
-
- [Batch synonyms](https://algolia.com/doc/api-reference/api-methods/batch-synonyms/?language=ruby)
|
|
284
|
-
- [Delete synonym](https://algolia.com/doc/api-reference/api-methods/delete-synonym/?language=ruby)
|
|
285
|
-
- [Clear all synonyms](https://algolia.com/doc/api-reference/api-methods/clear-synonyms/?language=ruby)
|
|
286
|
-
- [Get synonym](https://algolia.com/doc/api-reference/api-methods/get-synonym/?language=ruby)
|
|
287
|
-
- [Search synonyms](https://algolia.com/doc/api-reference/api-methods/search-synonyms/?language=ruby)
|
|
288
|
-
- [Replace all synonyms](https://algolia.com/doc/api-reference/api-methods/replace-all-synonyms/?language=ruby)
|
|
289
|
-
- [Copy synonyms](https://algolia.com/doc/api-reference/api-methods/copy-synonyms/?language=ruby)
|
|
290
|
-
- [Export Synonyms](https://algolia.com/doc/api-reference/api-methods/export-synonyms/?language=ruby)
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
### Query rules
|
|
296
|
-
|
|
297
|
-
- [Save rule](https://algolia.com/doc/api-reference/api-methods/save-rule/?language=ruby)
|
|
298
|
-
- [Batch rules](https://algolia.com/doc/api-reference/api-methods/batch-rules/?language=ruby)
|
|
299
|
-
- [Get rule](https://algolia.com/doc/api-reference/api-methods/get-rule/?language=ruby)
|
|
300
|
-
- [Delete rule](https://algolia.com/doc/api-reference/api-methods/delete-rule/?language=ruby)
|
|
301
|
-
- [Clear rules](https://algolia.com/doc/api-reference/api-methods/clear-rules/?language=ruby)
|
|
302
|
-
- [Search rules](https://algolia.com/doc/api-reference/api-methods/search-rules/?language=ruby)
|
|
303
|
-
- [Replace all rules](https://algolia.com/doc/api-reference/api-methods/replace-all-rules/?language=ruby)
|
|
304
|
-
- [Copy rules](https://algolia.com/doc/api-reference/api-methods/copy-rules/?language=ruby)
|
|
305
|
-
- [Export rules](https://algolia.com/doc/api-reference/api-methods/export-rules/?language=ruby)
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
### A/B Test
|
|
311
|
-
|
|
312
|
-
- [Add A/B test](https://algolia.com/doc/api-reference/api-methods/add-ab-test/?language=ruby)
|
|
313
|
-
- [Get A/B test](https://algolia.com/doc/api-reference/api-methods/get-ab-test/?language=ruby)
|
|
314
|
-
- [List A/B tests](https://algolia.com/doc/api-reference/api-methods/list-ab-tests/?language=ruby)
|
|
315
|
-
- [Stop A/B test](https://algolia.com/doc/api-reference/api-methods/stop-ab-test/?language=ruby)
|
|
316
|
-
- [Delete A/B test](https://algolia.com/doc/api-reference/api-methods/delete-ab-test/?language=ruby)
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
### Insights
|
|
322
|
-
|
|
323
|
-
- [Clicked Object IDs After Search](https://algolia.com/doc/api-reference/api-methods/clicked-object-ids-after-search/?language=ruby)
|
|
324
|
-
- [Clicked Object IDs](https://algolia.com/doc/api-reference/api-methods/clicked-object-ids/?language=ruby)
|
|
325
|
-
- [Clicked Filters](https://algolia.com/doc/api-reference/api-methods/clicked-filters/?language=ruby)
|
|
326
|
-
- [Converted Objects IDs After Search](https://algolia.com/doc/api-reference/api-methods/converted-object-ids-after-search/?language=ruby)
|
|
327
|
-
- [Converted Object IDs](https://algolia.com/doc/api-reference/api-methods/converted-object-ids/?language=ruby)
|
|
328
|
-
- [Converted Filters](https://algolia.com/doc/api-reference/api-methods/converted-filters/?language=ruby)
|
|
329
|
-
- [Viewed Object IDs](https://algolia.com/doc/api-reference/api-methods/viewed-object-ids/?language=ruby)
|
|
330
|
-
- [Viewed Filters](https://algolia.com/doc/api-reference/api-methods/viewed-filters/?language=ruby)
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
### MultiClusters
|
|
336
|
-
|
|
337
|
-
- [Assign or Move userID](https://algolia.com/doc/api-reference/api-methods/assign-user-id/?language=ruby)
|
|
338
|
-
- [Get top userID](https://algolia.com/doc/api-reference/api-methods/get-top-user-id/?language=ruby)
|
|
339
|
-
- [Get userID](https://algolia.com/doc/api-reference/api-methods/get-user-id/?language=ruby)
|
|
340
|
-
- [List clusters](https://algolia.com/doc/api-reference/api-methods/list-clusters/?language=ruby)
|
|
341
|
-
- [List userIDs](https://algolia.com/doc/api-reference/api-methods/list-user-id/?language=ruby)
|
|
342
|
-
- [Remove userID](https://algolia.com/doc/api-reference/api-methods/remove-user-id/?language=ruby)
|
|
343
|
-
- [Search userID](https://algolia.com/doc/api-reference/api-methods/search-user-id/?language=ruby)
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
### Advanced
|
|
349
|
-
|
|
350
|
-
- [Get logs](https://algolia.com/doc/api-reference/api-methods/get-logs/?language=ruby)
|
|
351
|
-
- [Configuring timeouts](https://algolia.com/doc/api-reference/api-methods/configuring-timeouts/?language=ruby)
|
|
352
|
-
- [Set extra header](https://algolia.com/doc/api-reference/api-methods/set-extra-header/?language=ruby)
|
|
353
|
-
- [Wait for operations](https://algolia.com/doc/api-reference/api-methods/wait-task/?language=ruby)
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
## Getting Help
|
|
360
|
-
|
|
361
|
-
- **Need help**? Ask a question to the [Algolia Community](https://discourse.algolia.com/) or on [Stack Overflow](http://stackoverflow.com/questions/tagged/algolia).
|
|
362
|
-
- **Found a bug?** You can open a [GitHub issue](https://github.com/algolia/algoliasearch-client-ruby/issues).
|
|
363
|
-
|
|
56
|
+
Algolia Ruby API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).
|
data/lib/algolia/version.rb
CHANGED
data/spec/spec_helper.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: algoliasearch
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.26.
|
|
4
|
+
version: 1.26.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Algolia
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2019-
|
|
11
|
+
date: 2019-08-01 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: httpclient
|
|
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
145
145
|
- !ruby/object:Gem::Version
|
|
146
146
|
version: '0'
|
|
147
147
|
requirements: []
|
|
148
|
-
rubygems_version: 3.0.
|
|
148
|
+
rubygems_version: 3.0.3
|
|
149
149
|
signing_key:
|
|
150
150
|
specification_version: 4
|
|
151
151
|
summary: A simple Ruby client for the algolia.com REST API
|