algoliasearch 1.25.2 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8ca787d62b4f0df0b2147df5b2163076c29a3a99a450dd79e1bed442a1c11af
-  data.tar.gz: 914dae2a9d0af62c354a16224867298f5c29a751062d555d23fdfb2cd86f5672
+  metadata.gz: 7419f8c2f96d1a08461a1d069948004752c155d45b02be413b064558a61f7f37
+  data.tar.gz: a3d5a45956d86bcc984f512f9e39d2efeda5a1f938120092cd77ccc919926580
 SHA512:
-  metadata.gz: a45d614a97620019f79d9fc17740da96a0819dae4bf09366f5c3f36023220e48a3c05057cd38c2141219097ab9f878f6b33cf39ddb9f4e68d6cce6d11a579a72
-  data.tar.gz: 914f928b122ae1540568ce80878a229d6a45b3a88bac84d31114b6858567c10b96b7353307d55a1db310386706cf3e9990afc37bbab3978f7499fc3ff226c3b8
+  metadata.gz: bfdca3abc62f36662e90a3a06157beeb9de33516b91c70a3541c59e4fc132b966b55725f45f21852cd673ac6a826a9a7c83cfe4a25188d29f4f850eff9a8b53b
+  data.tar.gz: 4d7ece80fecb91f403345d14a7534d36621c109407dd65f5fa5b1b4e4746506faad0b5fe7a3ed301ab86218063a1cb660b61b8fd30d1d758f5f3ded9270668de

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+[1.26.0](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/1.26.0) (2019-02-12)
+
+**Added**
+
+* Introduce `Algolia.restore_api_key` method.
+    
+    If you delete your API key by mistake, you can now restore it via
+    this new method. This especially useful if this key is used in a
+    mobile app or somewhere you can't update easily.
+    
+
 ## [1.25.2](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/1.25.2) (2018-12-19)
 
 ## [1.25.1](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/1.25.1) (2018-12-19)

data/Gemfile.lock

@@ -20,13 +20,14 @@ GEM
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     docile (1.3.1)
-    ethon (0.11.0)
+    ethon (0.12.0)
       ffi (>= 1.3.0)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.12.2)
       faraday (>= 0.7.4, < 1.0)
-    ffi (1.9.25)
+    ffi (1.10.0)
+    ffi2-generators (0.1.1)
     gh (0.15.1)
       addressable (~> 2.4.0)
       backports
@@ -34,7 +35,7 @@ GEM
       multi_json (~> 1.0)
       net-http-persistent (~> 2.9)
       net-http-pipeline
-    hashdiff (0.3.7)
+    hashdiff (0.3.8)
     highline (1.7.10)
     httpclient (2.8.3)
     json (2.1.0)
@@ -47,8 +48,8 @@ GEM
     pusher-client (0.6.2)
       json
       websocket (~> 1.0)
-    rake (12.3.1)
-    rdoc (6.0.4)
+    rake (12.3.2)
+    rdoc (6.1.1)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -62,13 +63,215 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rubysl (2.2.0)
+      rubysl-abbrev (~> 2.0)
+      rubysl-base64 (~> 2.0)
+      rubysl-benchmark (~> 2.0)
+      rubysl-bigdecimal (~> 2.0)
+      rubysl-cgi (~> 2.0)
+      rubysl-cgi-session (~> 2.0)
+      rubysl-cmath (~> 2.0)
+      rubysl-complex (~> 2.0)
+      rubysl-continuation (~> 2.0)
+      rubysl-coverage (~> 2.0)
+      rubysl-csv (~> 2.0)
+      rubysl-curses (~> 2.0)
+      rubysl-date (~> 2.0)
+      rubysl-delegate (~> 2.0)
+      rubysl-digest (~> 2.0)
+      rubysl-drb (~> 2.0)
+      rubysl-e2mmap (~> 2.0)
+      rubysl-english (~> 2.0)
+      rubysl-enumerator (~> 2.0)
+      rubysl-erb (~> 2.0)
+      rubysl-etc (~> 2.0)
+      rubysl-expect (~> 2.0)
+      rubysl-fcntl (~> 2.0)
+      rubysl-fiber (~> 2.0)
+      rubysl-fileutils (~> 2.0)
+      rubysl-find (~> 2.0)
+      rubysl-forwardable (~> 2.0)
+      rubysl-getoptlong (~> 2.0)
+      rubysl-gserver (~> 2.0)
+      rubysl-io-console (~> 2.0)
+      rubysl-io-nonblock (~> 2.0)
+      rubysl-io-wait (~> 2.0)
+      rubysl-ipaddr (~> 2.0)
+      rubysl-irb (~> 2.1)
+      rubysl-logger (~> 2.0)
+      rubysl-mathn (~> 2.0)
+      rubysl-matrix (~> 2.0)
+      rubysl-mkmf (~> 2.0)
+      rubysl-monitor (~> 2.0)
+      rubysl-mutex_m (~> 2.0)
+      rubysl-net-ftp (~> 2.0)
+      rubysl-net-http (~> 2.0)
+      rubysl-net-imap (~> 2.0)
+      rubysl-net-pop (~> 2.0)
+      rubysl-net-protocol (~> 2.0)
+      rubysl-net-smtp (~> 2.0)
+      rubysl-net-telnet (~> 2.0)
+      rubysl-nkf (~> 2.0)
+      rubysl-observer (~> 2.0)
+      rubysl-open-uri (~> 2.0)
+      rubysl-open3 (~> 2.0)
+      rubysl-openssl (~> 2.0)
+      rubysl-optparse (~> 2.0)
+      rubysl-ostruct (~> 2.0)
+      rubysl-pathname (~> 2.0)
+      rubysl-prettyprint (~> 2.0)
+      rubysl-prime (~> 2.0)
+      rubysl-profile (~> 2.0)
+      rubysl-profiler (~> 2.0)
+      rubysl-pstore (~> 2.0)
+      rubysl-pty (~> 2.0)
+      rubysl-rational (~> 2.0)
+      rubysl-resolv (~> 2.0)
+      rubysl-rexml (~> 2.0)
+      rubysl-rinda (~> 2.0)
+      rubysl-rss (~> 2.0)
+      rubysl-scanf (~> 2.0)
+      rubysl-securerandom (~> 2.0)
+      rubysl-set (~> 2.0)
+      rubysl-shellwords (~> 2.0)
+      rubysl-singleton (~> 2.0)
+      rubysl-socket (~> 2.0)
+      rubysl-stringio (~> 2.0)
+      rubysl-strscan (~> 2.0)
+      rubysl-sync (~> 2.0)
+      rubysl-syslog (~> 2.0)
+      rubysl-tempfile (~> 2.0)
+      rubysl-thread (~> 2.0)
+      rubysl-thwait (~> 2.0)
+      rubysl-time (~> 2.0)
+      rubysl-timeout (~> 2.0)
+      rubysl-tmpdir (~> 2.0)
+      rubysl-tsort (~> 2.0)
+      rubysl-un (~> 2.0)
+      rubysl-unicode_normalize (~> 2.0)
+      rubysl-uri (~> 2.0)
+      rubysl-weakref (~> 2.0)
+      rubysl-webrick (~> 2.0)
+      rubysl-xmlrpc (~> 2.0)
+      rubysl-yaml (~> 2.0)
+      rubysl-zlib (~> 2.0)
+    rubysl-abbrev (2.0.4)
+    rubysl-base64 (2.0.0)
+    rubysl-benchmark (2.0.1)
+    rubysl-bigdecimal (2.0.2)
+    rubysl-cgi (2.0.1)
+    rubysl-cgi-session (2.1.0)
+    rubysl-cmath (2.0.0)
+    rubysl-complex (2.0.0)
+    rubysl-continuation (2.0.0)
+    rubysl-coverage (2.1)
+    rubysl-csv (2.0.2)
+      rubysl-english (~> 2.0)
+    rubysl-curses (2.0.1)
+    rubysl-date (2.0.9)
+    rubysl-delegate (2.0.1)
+    rubysl-digest (2.0.8)
+    rubysl-drb (2.0.1)
+    rubysl-e2mmap (2.0.0)
+    rubysl-english (2.0.0)
+    rubysl-enumerator (2.0.0)
+    rubysl-erb (2.0.2)
+    rubysl-etc (2.0.3)
+      ffi2-generators (~> 0.1)
+    rubysl-expect (2.0.0)
+    rubysl-fcntl (2.0.4)
+      ffi2-generators (~> 0.1)
+    rubysl-fiber (2.0.0)
+    rubysl-fileutils (2.0.3)
+    rubysl-find (2.0.1)
+    rubysl-forwardable (2.0.1)
+    rubysl-getoptlong (2.0.0)
+    rubysl-gserver (2.0.0)
+      rubysl-socket (~> 2.0)
+      rubysl-thread (~> 2.0)
+    rubysl-io-console (2.0.0)
+    rubysl-io-nonblock (2.0.0)
+    rubysl-io-wait (2.0.0)
+    rubysl-ipaddr (2.0.0)
+    rubysl-irb (2.1.1)
+      rubysl-e2mmap (~> 2.0)
+      rubysl-mathn (~> 2.0)
+      rubysl-thread (~> 2.0)
+    rubysl-logger (2.1.0)
+    rubysl-mathn (2.0.0)
+    rubysl-matrix (2.1.0)
+      rubysl-e2mmap (~> 2.0)
+    rubysl-mkmf (2.1)
+      rubysl-fileutils (~> 2.0)
+      rubysl-shellwords (~> 2.0)
+    rubysl-monitor (2.1)
+    rubysl-mutex_m (2.0.0)
+    rubysl-net-ftp (2.0.1)
+    rubysl-net-http (2.0.4)
+      rubysl-cgi (~> 2.0)
+      rubysl-erb (~> 2.0)
+      rubysl-singleton (~> 2.0)
+    rubysl-net-imap (2.0.1)
+    rubysl-net-pop (2.0.1)
+    rubysl-net-protocol (2.0.1)
+    rubysl-net-smtp (2.0.1)
+    rubysl-net-telnet (2.0.0)
+    rubysl-nkf (2.0.1)
+    rubysl-observer (2.0.0)
+    rubysl-open-uri (2.0.0)
+    rubysl-open3 (2.0.0)
+    rubysl-openssl (2.10)
+    rubysl-optparse (2.0.1)
+      rubysl-shellwords (~> 2.0)
+    rubysl-ostruct (2.1.0)
+    rubysl-pathname (2.3)
+    rubysl-prettyprint (2.0.3)
+    rubysl-prime (2.0.1)
+    rubysl-profile (2.0.0)
+    rubysl-profiler (2.1)
+    rubysl-pstore (2.0.0)
+    rubysl-pty (2.0.3)
+    rubysl-rational (2.0.1)
+    rubysl-resolv (2.1.2)
+    rubysl-rexml (2.0.4)
+    rubysl-rinda (2.0.1)
+    rubysl-rss (2.0.0)
+    rubysl-scanf (2.0.0)
+    rubysl-securerandom (2.0.0)
+    rubysl-set (2.0.1)
+    rubysl-shellwords (2.0.0)
+    rubysl-singleton (2.0.0)
+    rubysl-socket (2.2.1)
+      rubysl-fcntl (~> 2.0)
+    rubysl-stringio (2.3)
+    rubysl-strscan (2.0.0)
+    rubysl-sync (2.0.0)
+    rubysl-syslog (2.1.0)
+      ffi2-generators (~> 0.1)
+    rubysl-tempfile (2.0.1)
+    rubysl-thread (2.1)
+    rubysl-thwait (2.0.0)
+    rubysl-time (2.0.3)
+    rubysl-timeout (2.0.0)
+    rubysl-tmpdir (2.0.1)
+    rubysl-tsort (2.0.1)
+    rubysl-un (2.0.0)
+      rubysl-fileutils (~> 2.0)
+      rubysl-optparse (~> 2.0)
+    rubysl-unicode_normalize (2.0)
+    rubysl-uri (2.0.0)
+    rubysl-weakref (2.0.0)
+    rubysl-webrick (2.0.0)
+    rubysl-xmlrpc (2.0.0)
+    rubysl-yaml (2.1.0)
+    rubysl-zlib (2.0.1)
     safe_yaml (1.0.4)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    term-ansicolor (1.7.0)
+    term-ansicolor (1.7.1)
       tins (~> 1.0)
     thor (0.19.4)
     tins (1.20.2)
@@ -83,7 +286,7 @@ GEM
       typhoeus (~> 0.6, >= 0.6.8)
     typhoeus (0.8.0)
       ethon (>= 0.8.0)
-    webmock (3.4.2)
+    webmock (3.5.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
@@ -104,4 +307,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.17.2
+   1.17.3

data/README.md

@@ -1,7 +1,6 @@
 # Algolia Search API Client for Ruby
 
-[Algolia Search](https://www.algolia.com) is a hosted full-text, numerical,
-and faceted search engine capable of delivering realtime results from the first keystroke.
+[Algolia Search](https://www.algolia.com) is a hosted search engine capable of delivering realtime results from the first keystroke.
 
 The **Algolia Search API Client for Ruby** lets
 you easily use the [Algolia Search REST API](https://www.algolia.com/doc/rest-api/search) from
@@ -56,7 +55,7 @@ gem install algoliasearch
 
 ### Ruby on Rails
 
-If you're a Ruby on Rails user; you're probably looking for the [algoliasearch-rails](https://github.com/algolia/algoliasearch-rails) gem.
+If you're a Ruby on Rails user, you're probably looking for the [algoliasearch-rails](https://github.com/algolia/algoliasearch-rails) gem.
 
 ## Quick Start
 
@@ -64,7 +63,7 @@ In 30 seconds, this quick start tutorial will show you how to index and search o
 
 ### Initialize the client
 
-To begin, you will need to initialize the client. In order to do this you will need your **Application ID** and **API Key**.
+To start, you need to initialize the client. To do this, you need your **Application ID** and **API Key**.
 You can find both on [your Algolia account](https://www.algolia.com/api-keys).
 
 ```ruby
@@ -87,7 +86,7 @@ index.add_objects(batch)
 
 ## Configure
 
-Settings can be customized to fine tune the search behavior. For example, you can add a custom sort by number of followers to further enhance the built-in relevance:
+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:
 
 ```ruby
 index.set_settings(customRanking: ['desc(followers)'])
@@ -95,8 +94,8 @@ index.set_settings(customRanking: ['desc(followers)'])
 
 You can also configure the list of attributes you want to index by order of importance (most important first).
 
-**Note:** The Algolia engine is designed to suggest results as you type, which means you'll generally search by prefix.
-In this case, the order of attributes is very important to decide which hit is the best:
+**Note:** Algolia is designed to suggest results as you type, which means you'll generally search by prefix.
+In this case, the order of attributes is crucial to decide which hit is the best.
 
 ```ruby
 index.set_settings({
@@ -113,7 +112,7 @@ index.set_settings({
 
 ## Search
 
-You can now search for contacts using `firstname`, `lastname`, `company`, etc. (even with typos):
+You can now search for contacts by `firstname`, `lastname`, `company`, etc. (even with typos):
 
 ```ruby
 # Search for a first name
@@ -128,11 +127,11 @@ puts index.search('jimmie paint').to_json
 
 ## Search UI
 
-**Warning:** If you are building a web application, you may be more interested in using one of our
-[frontend search UI libraries](https://www.algolia.com/doc/guides/search-ui/search-libraries/)
+**Warning:** If you're building a web application, you may be interested in using one of our
+[front-end search UI libraries](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/).
 
-The following example shows how to build a front-end search quickly using
-[InstantSearch.js](https://community.algolia.com/instantsearch.js/)
+The following example shows how to quickly build a front-end search using
+[InstantSearch.js](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/)
 
 ### index.html
 
@@ -140,15 +139,13 @@ The following example shows how to build a front-end search quickly using
 <!doctype html>
 <head>
   <meta charset="UTF-8">
-  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/instantsearch.js@2.3/dist/instantsearch.min.css">
-  <!-- Always use `2.x` versions in production rather than `2` to mitigate any side effects on your website,
-  Find the latest version on InstantSearch.js website: https://community.algolia.com/instantsearch.js/v2/guides/usage.html -->
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/instantsearch.css@7.1.0/themes/algolia.css" />
 </head>
 <body>
   <header>
     <div>
        <input id="search-input" placeholder="Search for products">
-       <!-- We use a specific placeholder in the input to guides users in their search. -->
+       <!-- We use a specific placeholder in the input to guide users in their search. -->
     
   </header>
   <main>
@@ -158,11 +155,14 @@ The following example shows how to build a front-end search quickly using
 
   <script type="text/html" id="hit-template">
     
-      <p class="hit-name">{{{_highlightResult.firstname.value}}} {{{_highlightResult.lastname.value}}}</p>
+      <p class="hit-name">
+        {}{ "attribute": "firstname" }{{/helpers.highlight}}
+        {}{ "attribute": "lastname" }{{/helpers.highlight}}
+      </p>
     
   </script>
 
-  <script src="https://cdn.jsdelivr.net/npm/instantsearch.js@2.3/dist/instantsearch.min.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/instantsearch.js@3.0.0"></script>
   <script src="app.js"></script>
 </body>
 ```
@@ -170,11 +170,15 @@ The following example shows how to build a front-end search quickly using
 ### app.js
 
 ```js
+// Replace with your own values
+var searchClient = algoliasearch(
+  'YourApplicationID',
+  'YourAPIKey' // search only API key, no ADMIN key
+);
+
 var search = instantsearch({
-  // Replace with your own values
-  appId: 'YourApplicationID',
-  apiKey: 'YourSearchOnlyAPIKey', // search only API key, no ADMIN key
-  indexName: 'contacts',
+  indexName: 'instant_search',
+  searchClient: searchClient,
   routing: true,
   searchParameters: {
     hitsPerPage: 10

data/lib/algolia/client.rb

@@ -455,6 +455,13 @@ module Algolia
       delete(Protocol.key_uri(key), :write, request_options)
     end
 
+    #
+    # Restore a deleted api key
+    #
+    def restore_api_key(key, request_options = {})
+      post(Protocol.restore_key_uri(key), :write, request_options)
+    end
+
     #
     # Send a batch request targeting multiple indices
     #
@@ -1045,6 +1052,13 @@ module Algolia
     Algolia.client.delete_api_key(key, request_options)
   end
 
+  #
+  # Restore an existing api key
+  #
+  def Algolia.restore_api_key(key, request_options = {})
+    Algolia.client.restore_api_key(key, request_options)
+  end
+
   #
   # Deprecated
   #

data/lib/algolia/protocol.rb

@@ -109,6 +109,10 @@ module Algolia
       "/#{VERSION}/keys/#{key}"
     end
 
+    def Protocol.restore_key_uri(key)
+      "/#{VERSION}/keys/#{key}/restore"
+    end
+
     def Protocol.index_key_uri(index, key)
       "#{index_uri(index)}/keys/#{key}"
     end

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.25.2"
+  VERSION = "1.26.0"
 end

data/spec/client_spec.rb

@@ -83,6 +83,7 @@ describe 'API keys', :maintainers_only => true do
 
   it "should test index keys" do
     @index.set_settings!({}) # ensure the index exists
+
     resIndex = @index.list_api_keys
     newIndexKey = @index.add_api_key(['search'])
     newIndexKey['key'].should_not eq("")
@@ -124,6 +125,15 @@ describe 'API keys', :maintainers_only => true do
     wait_global_key_missing(newKey['key'])
     resEnd = Algolia.list_api_keys
     is_include(resEnd['keys'], 'value', newKey['key']).should eq(false)
+
+    # Restore the deleted key
+    Algolia.restore_api_key(newKey['key'])
+    wait_global_key(newKey['key'])
+    key_end = Algolia.list_api_keys
+    is_include(key_end['keys'], 'value', newKey['key']).should eq(true)
+
+    # Re-delete the key
+    Algolia.delete_api_key(newKey['key'])
   end
 
   it "Check add keys" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.25.2
+  version: 1.26.0
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-19 00:00:00.000000000 Z
+date: 2019-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -145,8 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API