algoliasearch 1.26.1 → 1.27.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b688a2dbf301d12d5334b0ae73dbb287bd5054f1a19499d59c68c3b69713569
-  data.tar.gz: d8d8dc2d476cc6f4e9b8ad81437f390401e1c720a61184b020ec15638026b6c3
+  metadata.gz: d05a0e17139977680099b2b1e1ee1e0901834ad0aeb20f8061a54d9f74def4d9
+  data.tar.gz: ad1178bb101f66b3dafb95d2e17f40abd6efa1593482b9d7ddd8965d73afbcf9
 SHA512:
-  metadata.gz: 40e6001e2b9b43490d9dc6ee901054d53b822f04c87d62c0979eaa6bd8671da4f7f94d9a781a7ffb5fb8e834cbcef63231a2469e42364177ee598fa1428f3f4e
-  data.tar.gz: de731f8dff00f9084da3fd9e230dfc2ef286cccbea2958a5512690ac229044180e5af2118c37fd3048bc54e238669e60b77b38bacc03675855a2edb510bb0541
+  metadata.gz: bfc4fce2c92ca1aa22a814ca43051070600be031227dda2667348eea5ae6e0392c73534b35daf6b1966e6fdb6b380a1bc60d21a4669b3da6d6e6493901ebe330
+  data.tar.gz: acb939243bb56bb478ee96fd842b201631d39847296a51cf39e610420b2f5abd7d523bd1141b90eef0fa2dc0f2196f7936eca5417389b0a435299b1b98043cb4

data/.travis.yml

@@ -5,7 +5,6 @@ branches:
     - master
 
 rvm:
-- 1.8.7
 - 1.9.3
 - 2.0
 - 2.1
@@ -20,6 +19,10 @@ matrix:
   allow_failures:
     - rvm: rbx-3
     - rvm: jruby
+  include:
+    - rvm: 1.8.7
+      dist: precise
+
 
 cache: bundler
 

data/CHANGELOG.md

@@ -1,5 +1,52 @@
 # ChangeLog
 
+## Unreleased
+
+## [1.27.4](https://github.com/algolia/algoliasearch-client-ruby/compare/1.27.3...1.27.4) (2020-09-16)
+
+**Fixed**
+
+* Retrieve all objects when using `copy_index` from `AccountClient` class ([399](https://github.com/algolia/algoliasearch-client-ruby/pull/399))
+
+## [1.27.3](https://github.com/algolia/algoliasearch-client-ruby/compare/1.27.2...1.27.3) (2020-06-03)
+
+**Fixed**
+
+* Replace expired certificate within embedded certificate chain ([9087dd1](https://github.com/algolia/algoliasearch-client-ruby/commit/9087dd14a97bf77c9391a3360c4803edf686086d))
+
+## [1.27.2](https://github.com/algolia/algoliasearch-client-ruby/compare/1.27.1...1.27.2) (2020-04-28)
+
+**Fixed**
+
+* In `search_user_id`, retrieve param `cluster` instead of `clusterName`. [368](https://github.com/algolia/algoliasearch-client-ruby/issues/368)
+
+## [1.27.1](https://github.com/algolia/algoliasearch-client-ruby/compare/1.27.0...1.27.1) (2019-09-26)
+
+**Fixed**
+
+* Update `Algolia::Index.exists` method to `Algolia::Index.exists?`. [364](https://github.com/algolia/algoliasearch-client-ruby/issues/364)
+
+## [1.27.0](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/1.27.0) (2019-09-16)
+
+**Added**
+
+* Introduce `Algolia::Index.exists` method. [358](https://github.com/algolia/algoliasearch-client-ruby/issues/358)
+
+    Check whether an index exists or not.
+
+* Introduce `Algolia::Index.find_object` method. [359](https://github.com/algolia/algoliasearch-client-ruby/issues/359)
+
+    Find object by the given condition.
+
+* Introduce `Algolia::Index.get_object_position` method. [359](https://github.com/algolia/algoliasearch-client-ruby/issues/359)
+
+    Retrieve the given object position in a set of results.
+
+* Introduce `Algolia.get_secured_api_key_remaining_validity` method. [361](https://github.com/algolia/algoliasearch-client-ruby/issues/361)
+
+    Returns the remaining validity time for the given API key in seconds.
+
+
 ## [1.26.1](https://github.com/algolia/algoliasearch-client-ruby/compare/1.26.0...1.26.1) (2019-07-31)
 
 ### Chore

data/Gemfile.lock

@@ -1,73 +1,66 @@
 PATH
   remote: .
   specs:
-    algoliasearch (1.26.0)
+    algoliasearch (1.27.3)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.4.0)
-    backports (3.15.0)
-    coveralls (0.7.2)
-      multi_json (~> 1.3)
-      rest-client (= 1.6.7)
-      simplecov (>= 0.7)
-      term-ansicolor (= 1.2.2)
-      thor (= 0.18.1)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    backports (3.18.2)
+    connection_pool (2.2.3)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     docile (1.3.2)
     ethon (0.12.0)
       ffi (>= 1.3.0)
-    faraday (0.15.4)
+    faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.13.1)
+    faraday_middleware (0.14.0)
       faraday (>= 0.7.4, < 1.0)
-    ffi (1.11.1)
+    ffi (1.13.1)
     ffi2-generators (0.1.1)
-    gh (0.15.1)
-      addressable (~> 2.4.0)
+    gh (0.14.0)
+      addressable
       backports
       faraday (~> 0.8)
       multi_json (~> 1.0)
-      net-http-persistent (~> 2.9)
+      net-http-persistent (>= 2.7)
       net-http-pipeline
-    hashdiff (1.0.0)
+    hashdiff (1.0.1)
     highline (1.7.10)
     httpclient (2.8.3)
-    json (2.2.0)
-    launchy (2.4.3)
-      addressable (~> 2.3)
-    mime-types (3.2.2)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0331)
-    multi_json (1.13.1)
+    json (2.3.1)
+    launchy (2.5.0)
+      addressable (~> 2.7)
+    multi_json (1.15.0)
     multipart-post (2.1.1)
-    net-http-persistent (2.9.4)
+    net-http-persistent (4.0.0)
+      connection_pool (~> 2.2)
     net-http-pipeline (1.0.1)
+    public_suffix (4.0.6)
     pusher-client (0.6.2)
       json
       websocket (~> 1.0)
-    rake (12.3.2)
-    rdoc (6.1.1)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rake (13.0.1)
+    rdoc (6.2.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
     rubysl (2.2.0)
       rubysl-abbrev (~> 2.0)
       rubysl-base64 (~> 2.0)
@@ -175,7 +168,7 @@ GEM
     rubysl-curses (2.0.1)
     rubysl-date (2.0.9)
     rubysl-delegate (2.0.1)
-    rubysl-digest (2.0.8)
+    rubysl-digest (2.1)
     rubysl-drb (2.0.1)
     rubysl-e2mmap (2.0.0)
     rubysl-english (2.0.0)
@@ -225,7 +218,7 @@ GEM
     rubysl-observer (2.0.0)
     rubysl-open-uri (2.0.0)
     rubysl-open3 (2.0.0)
-    rubysl-openssl (2.10)
+    rubysl-openssl (2.13)
     rubysl-optparse (2.0.1)
       rubysl-shellwords (~> 2.0)
     rubysl-ostruct (2.1.0)
@@ -271,16 +264,11 @@ GEM
     rubysl-yaml (2.1.0)
     rubysl-zlib (2.0.1)
     safe_yaml (1.0.5)
-    simplecov (0.17.0)
+    simplecov (0.19.0)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    term-ansicolor (1.2.2)
-      tins (~> 0.8)
-    thor (0.18.1)
-    tins (0.13.2)
-    travis (1.8.10)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    travis (1.8.13)
       backports
       faraday (~> 0.9)
       faraday_middleware (~> 0.9, >= 0.9.1)
@@ -291,7 +279,7 @@ GEM
       typhoeus (~> 0.6, >= 0.6.8)
     typhoeus (0.8.0)
       ethon (>= 0.8.0)
-    webmock (3.6.0)
+    webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -302,7 +290,7 @@ PLATFORMS
 
 DEPENDENCIES
   algoliasearch!
-  coveralls
+  gh (<= 0.14.0)
   rake
   rdoc
   rspec (>= 2.5.0)
@@ -312,4 +300,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.0.2
+   1.17.2

data/README.md

@@ -7,8 +7,8 @@
 
   <p align="center">
     <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>
-    <a href="https://rubygems.org/gems/algoliasearch/versions/1.26.0"><img src="https://badge.fury.io/rb/algoliasearch.svg" alt="Gem Version"></a>
-    <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>
+    <a href="https://rubygems.org/gems/algoliasearch"><img src="https://badge.fury.io/rb/algoliasearch.svg" alt="Gem Version"></a>
+    <a href="https://rubygems.org/gems/algoliasearch"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="License"></a>
   </p>
 </p>
 
@@ -18,6 +18,7 @@
   <a href="https://discourse.algolia.com" target="_blank">Community Forum</a>  •
   <a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a>  •
   <a href="https://github.com/algolia/algoliasearch-client-ruby/issues" target="_blank">Report a bug</a>  •
+  <a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/ruby/" target="_blank">FAQ</a>  •
   <a href="https://www.algolia.com/support" target="_blank">Support</a>
 </p>
 
@@ -51,6 +52,10 @@ objects = index.search('Fo')
 
 For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/api-client/getting-started/install/ruby/)**.
 
+## ❓ Troubleshooting
+
+Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/ruby/) where you will find answers for the most common issues and gotchas with the client.
+
 ## 📄 License
 
 Algolia Ruby API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).

data/algoliasearch.gemspec

@@ -64,17 +64,21 @@ Gem::Specification.new do |s|
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      if defined?(RUBY_VERSION) && RUBY_VERSION < '2.0'
+        s.add_runtime_dependency     'json',       '>= 1.5.1', '< 2.3'
+      else
+        s.add_runtime_dependency     'json',       '>= 1.5.1'
+      end
       s.add_runtime_dependency     'httpclient', '~> 2.8', '>= 2.8.3'
-      s.add_runtime_dependency     'json',       '>= 1.5.1'
       s.add_development_dependency 'travis',     '~> 0'
       s.add_development_dependency 'rake',       '~> 0'
       s.add_development_dependency 'rdoc',       '~> 0'
     else
       s.add_dependency             'httpclient', '~> 2.8', '>= 2.8.3'
-      s.add_dependency             'json',       '>= 1.5.1'
+      s.add_dependency             'json',       '>= 1.5.1', '< 2.3'
     end
   else
     s.add_dependency               'httpclient', '~> 2.8', '>= 2.8.3'
-    s.add_dependency               'json',       '>= 1.5.1'
+    s.add_dependency               'json',       '>= 1.5.1', '< 2.3'
   end
 end

data/lib/algolia/account_client.rb

@@ -55,7 +55,7 @@ module Algolia
         batch_size = 1000
         count = 0
 
-        source_index.browse()['hits'].each do |obj|
+        source_index.browse do |obj|
           batch << obj
           count += 1
 

data/lib/algolia/client.rb

@@ -552,7 +552,7 @@ module Algolia
 
     def search_user_id(query, cluster_name = nil, page = nil, hits_per_page = nil, request_options = {})
       body = { :query => query }
-      body[:clusterName] = cluster_name unless cluster_name.nil?
+      body[:cluster] = cluster_name unless cluster_name.nil?
       body[:page] = page unless page.nil?
       body[:hitsPerPage] = hits_per_page unless hits_per_page.nil?
       post(Protocol.search_user_id_uri, body.to_json, :read, request_options)
@@ -774,6 +774,28 @@ module Algolia
     end
   end
 
+  #
+  # Returns the remaining validity time for the given API key in seconds
+  #
+  # @param [String] secured_api_key the secured API key to check
+  #
+  # @return [Integer] remaining validity in seconds
+  #
+  def Algolia.get_secured_api_key_remaining_validity(secured_api_key)
+    now = Time.now.to_i
+    decoded_key = Base64.decode64(secured_api_key)
+    regex = 'validUntil=(\d+)'
+    matches = decoded_key.match(regex)
+
+    if matches === nil
+      raise ValidUntilNotFoundError.new('The SecuredAPIKey doesn\'t have a validUntil parameter.')
+    end
+
+    valid_until = matches[1].to_i
+
+    valid_until - now
+  end
+
   #
   # This method allows to query multiple indexes with one API call
   #

data/lib/algolia/error.rb

@@ -20,4 +20,12 @@ module Algolia
     end
   end
 
-end
+  # An exception class raised when the given object was not found.
+  class AlgoliaObjectNotFoundError < AlgoliaError
+  end
+
+  # An exception class raised when the validUntil parameter is not found
+  class ValidUntilNotFoundError < AlgoliaError
+  end
+
+end

data/lib/algolia/index.rb

@@ -264,6 +264,75 @@ module Algolia
       client.post(Protocol.objects_uri, { :requests => requests }.to_json, :read, request_options)['results']
     end
 
+    #
+    # Find object by the given condition.
+    #
+    # Options can be passed in request_options body:
+    #  - query (string): pass a query
+    #  - paginate (bool): choose if you want to iterate through all the
+    # documents (true) or only the first page (false). Default is true.
+    # The function takes a block to filter the results from search query
+    # Usage example:
+    #  index.find_object({'query' => '', 'paginate' => true}) {|obj| obj.key?('company') and obj['company'] == 'Apple'}
+    #
+    # @param request_options contains extra parameters to send with your query
+    #
+    # @return [Hash] the matching object and its position in the result set
+    #
+    def find_object(request_options = {})
+      paginate = true
+      page = 0
+
+      query = request_options[:query] || request_options['query'] || ''
+      request_options.delete(:query)
+      request_options.delete('query')
+
+      if request_options.has_key? :paginate
+        paginate = request_options[:paginate]
+      end
+
+      if request_options.has_key? 'paginate'
+        paginate = request_options['paginate']
+      end
+
+      request_options.delete(:paginate)
+      request_options.delete('paginate')
+
+      while true
+        request_options['page'] = page
+        res = search(query, request_options)
+
+        res['hits'].each_with_index do |hit, i|
+          if yield(hit)
+            return {
+                'object' => hit,
+                'position' => i,
+                'page' => page,
+            }
+          end
+        end if block_given?
+
+        has_next_page = page + 1 < res['nbPages']
+        if !paginate || !has_next_page
+          raise AlgoliaObjectNotFoundError.new('Object not found')
+        end
+
+        page += 1
+      end
+    end
+
+    #
+    # Retrieve the given object position in a set of results.
+    #
+    # @param [Array] objects the result set to browse
+    # @param [String] object_id the object to look for
+    #
+    # @return [Integer] position of the object, or -1 if it's not in the array
+    #
+    def self.get_object_position(objects, object_id)
+      objects['hits'].find_index { |hit| hit['objectID'] == object_id } || -1
+    end
+
     #
     # Check the status of a task on the server.
     # All server task are asynchronous and you can check the status of a task with this method.
@@ -1208,6 +1277,29 @@ module Algolia
       res
     end
 
+    #
+    # Check whether an index exists or not
+    #
+    # @return [Boolean]
+    #
+    def exists
+      begin
+        get_settings
+      rescue AlgoliaProtocolError => e
+        if e.code === 404
+          return false
+        end
+
+        raise e
+      end
+      return true
+    end
+
+    #
+    # Aliases the exists method
+    #
+    alias :exists? :exists
+
     # Deprecated
     alias_method :get_user_key, :get_api_key
     alias_method :list_user_keys, :list_api_keys

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.26.1"
+  VERSION = "1.27.4"
 end

data/resources/ca-bundle.crt

@@ -16,6 +16,43 @@
 
 # @(#) $RCSfile: certdata.txt,v $ $Revision: 1.87 $ $Date: 2012/12/29 16:32:45 $
 
+USERTrust RSA root CA
+=====================
+-----BEGIN CERTIFICATE-----
+MIIF3jCCA8agAwIBAgIQAf1tMPyjylGoG7xkDjUDLTANBgkqhkiG9w0BAQwFADCB
+iDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCk5ldyBKZXJzZXkxFDASBgNVBAcTC0pl
+cnNleSBDaXR5MR4wHAYDVQQKExVUaGUgVVNFUlRSVVNUIE5ldHdvcmsxLjAsBgNV
+BAMTJVVTRVJUcnVzdCBSU0EgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkwHhcNMTAw
+MjAxMDAwMDAwWhcNMzgwMTE4MjM1OTU5WjCBiDELMAkGA1UEBhMCVVMxEzARBgNV
+BAgTCk5ldyBKZXJzZXkxFDASBgNVBAcTC0plcnNleSBDaXR5MR4wHAYDVQQKExVU
+aGUgVVNFUlRSVVNUIE5ldHdvcmsxLjAsBgNVBAMTJVVTRVJUcnVzdCBSU0EgQ2Vy
+dGlmaWNhdGlvbiBBdXRob3JpdHkwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIK
+AoICAQCAEmUXNg7D2wiz0KxXDXbtzSfTTK1Qg2HiqiBNCS1kCdzOiZ/MPans9s/B
+3PHTsdZ7NygRK0faOca8Ohm0X6a9fZ2jY0K2dvKpOyuR+OJv0OwWIJAJPuLodMkY
+tJHUYmTbf6MG8YgYapAiPLz+E/CHFHv25B+O1ORRxhFnRghRy4YUVD+8M/5+bJz/
+Fp0YvVGONaanZshyZ9shZrHUm3gDwFA66Mzw3LyeTP6vBZY1H1dat//O+T23LLb2
+VN3I5xI6Ta5MirdcmrS3ID3KfyI0rn47aGYBROcBTkZTmzNg95S+UzeQc0PzMsNT
+79uq/nROacdrjGCT3sTHDN/hMq7MkztReJVni+49Vv4M0GkPGw/zJSZrM233bkf6
+c0Plfg6lZrEpfDKEY1WJxA3Bk1QwGROs0303p+tdOmw1XNtB1xLaqUkL39iAigmT
+Yo61Zs8liM2EuLE/pDkP2QKe6xJMlXzzawWpXhaDzLhn4ugTncxbgtNMs+1b/97l
+c6wjOy0AvzVVdAlJ2ElYGn+SNuZRkg7zJn0cTRe8yexDJtC/QV9AqURE9JnnV4ee
+UB9XVKg+/XRjL7FQZQnmWEIuQxpMtPAlR1n6BB6T1CZGSlCBst6+eLf8ZxXhyVeE
+Hg9j1uliutZfVS7qXMYoCAQlObgOK6nyTJccBz8NUvXt7y+CDwIDAQABo0IwQDAd
+BgNVHQ4EFgQUU3m/WqorSs9UgOHYm8Cd8rIDZsswDgYDVR0PAQH/BAQDAgEGMA8G
+A1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQEMBQADggIBAFzUfA3P9wF9QZllDHPF
+Up/L+M+ZBn8b2kMVn54CVVeWFPFSPCeHlCjtHzoBN6J2/FNQwISbxmtOuowhT6KO
+VWKR82kV2LyI48SqC/3vqOlLVSoGIG1VeCkZ7l8wXEskEVX/JJpuXior7gtNn3/3
+ATiUFJVDBwn7YKnuHKsSjKCaXqeYalltiz8I+8jRRa8YFWSQEg9zKC7F4iRO/Fjs
+8PRF/iKz6y+O0tlFYQXBl2+odnKPi4w2r78NBc5xjeambx9spnFixdjQg3IM8WcR
+iQycE0xyNN+81XHfqnHd4blsjDwSXWXavVcStkNr/+XeTWYRUc+ZruwXtuhxkYze
+Sf7dNXGiFSeUHM9h4ya7b6NnJSFd5t0dCy5oGzuCr+yDZ4XUmFF0sbmZgIn/f3gZ
+XHlKYC6SQK5MNyosycdiyA5d9zZbyuAlJQG03RoHnHcAP9Dc1ew91Pq7P8yF1m9/
+qS3fuQL39ZeatTXaw2ewh0qpKJ4jjv9cJ2vhsE/zB+4ALtRZh8tSQZXq9EfX7mRB
+VXyNWQKV3WKdwrnuWih0hKWbt5DHDAff9Yk2dDLWKMGwsAvgnEzDHNb842m1R0aB
+L6KCq9NjRHDEjf8tM7qtj3u1cIiuPhnPQCjY/MiQu12ZIvVS5ljFH4gxQ+6IHdfG
+jjxDah2nGN59PRbxYvnKkKj9
+-----END CERTIFICATE-----
+
 GTE CyberTrust Global Root
 ==========================
 -----BEGIN CERTIFICATE-----
@@ -551,30 +588,6 @@ mYbvP33zGDLKe8bjq2RGlfgmadlVg3sslgf/WSxEo8bl6ancoWOAWiFeIc9TVPC6b4nbqKqVz4vj
 ccweGyBECMB6tkD9xOQ14R0WHNC8K47Wcdk=
 -----END CERTIFICATE-----
 
-AddTrust External Root
-======================
------BEGIN CERTIFICATE-----
-MIIENjCCAx6gAwIBAgIBATANBgkqhkiG9w0BAQUFADBvMQswCQYDVQQGEwJTRTEUMBIGA1UEChML
-QWRkVHJ1c3QgQUIxJjAkBgNVBAsTHUFkZFRydXN0IEV4dGVybmFsIFRUUCBOZXR3b3JrMSIwIAYD
-VQQDExlBZGRUcnVzdCBFeHRlcm5hbCBDQSBSb290MB4XDTAwMDUzMDEwNDgzOFoXDTIwMDUzMDEw
-NDgzOFowbzELMAkGA1UEBhMCU0UxFDASBgNVBAoTC0FkZFRydXN0IEFCMSYwJAYDVQQLEx1BZGRU
-cnVzdCBFeHRlcm5hbCBUVFAgTmV0d29yazEiMCAGA1UEAxMZQWRkVHJ1c3QgRXh0ZXJuYWwgQ0Eg
-Um9vdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALf3GjPm8gAELTngTlvtH7xsD821
-+iO2zt6bETOXpClMfZOfvUq8k+0DGuOPz+VtUFrWlymUWoCwSXrbLpX9uMq/NzgtHj6RQa1wVsfw
-Tz/oMp50ysiQVOnGXw94nZpAPA6sYapeFI+eh6FqUNzXmk6vBbOmcZSccbNQYArHE504B4YCqOmo
-aSYYkKtMsE8jqzpPhNjfzp/haW+710LXa0Tkx63ubUFfclpxCDezeWWkWaCUN/cALw3CknLa0Dhy
-2xSoRcRdKn23tNbE7qzNE0S3ySvdQwAl+mG5aWpYIxG3pzOPVnVZ9c0p10a3CitlttNCbxWyuHv7
-7+ldU9U0WicCAwEAAaOB3DCB2TAdBgNVHQ4EFgQUrb2YejS0Jvf6xCZU7wO94CTLVBowCwYDVR0P
-BAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wgZkGA1UdIwSBkTCBjoAUrb2YejS0Jvf6xCZU7wO94CTL
-VBqhc6RxMG8xCzAJBgNVBAYTAlNFMRQwEgYDVQQKEwtBZGRUcnVzdCBBQjEmMCQGA1UECxMdQWRk
-VHJ1c3QgRXh0ZXJuYWwgVFRQIE5ldHdvcmsxIjAgBgNVBAMTGUFkZFRydXN0IEV4dGVybmFsIENB
-IFJvb3SCAQEwDQYJKoZIhvcNAQEFBQADggEBALCb4IUlwtYj4g+WBpKdQZic2YR5gdkeWxQHIzZl
-j7DYd7usQWxHYINRsPkyPef89iYTx4AWpb9a/IfPeHmJIZriTAcKhjW88t5RxNKWt9x+Tu5w/Rw5
-6wwCURQtjr0W4MHfRnXnJK3s9EK0hZNwEGe6nQY1ShjTK3rMUUKhemPR5ruhxSvCNr4TDea9Y355
-e6cJDUCrat2PisP29owaQgVR1EX1n6diIWgVIEM8med8vSTYqZEXc4g/VhsxOBi0cQ+azcgOno4u
-G+GMmIPLHzHxREzGBHNJdmAPx/i9F4BrLunMTA5amnkPIAou1Z5jJh5VkpTYghdae9C8x49OhgQ=
------END CERTIFICATE-----
-
 AddTrust Public Services Root
 =============================
 -----BEGIN CERTIFICATE-----

data/spec/account_client_spec.rb

@@ -47,9 +47,7 @@ describe 'Account client' do
 
   it 'should perform a cross app copy index and assert that destination must not exist' do
 
-    @index_1.save_objects! ([
-        {:objectID => 'one'},
-    ])
+    @index_1.save_objects!(1.upto(1500).map { |i| { :objectID => i, :i => i } })
 
     @index_1.batch_rules! ([
         {
@@ -67,9 +65,8 @@ describe 'Account client' do
 
     Algolia::AccountClient.copy_index!(@index_1, @index_3)
 
-    res = @index_3.search('');
-    res['nbHits'].should eq(1)
-    res['hits'][0]['objectID'].should eq('one')
+    res = @index_3.search('')
+    res['nbHits'].should eq(1500)
 
     res = @index_3.search_rules('')['hits']
     res.size.should eq(1)

data/spec/client_spec.rb

@@ -175,6 +175,16 @@ describe 'Client' do
     @index.delete_index rescue "not fatal"
   end
 
+  it "should tell if index exists" do
+    @index.add_object!({ :name => "John Doe", :email => "john@doe.org" }, "1")
+    expect(@index.exists?).to be true
+  end
+
+  it "should tell if index does not exist" do
+    index = Algolia::Index.new('nonexistent_index')
+    expect(index.exists?).to be false
+  end
+
   it "should add a simple object" do
     @index.add_object!({ :name => "John Doe", :email => "john@doe.org" }, "1")
     res = @index.search("john")
@@ -436,6 +446,73 @@ describe 'Client' do
     end
   end
 
+  it 'should find objects when needed' do
+    index = Algolia::Index.new(safe_index_name("àlgol?à"))
+
+    index.save_objects!([
+      {:company => 'Algolia', :name => 'Julien Lemoine', :objectID => 'julien-lemoine'},
+      {:company => 'Algolia', :name => 'Nicolas Dessaigne', :objectID => 'nicolas-dessaigne'},
+      {:company => 'Amazon', :name =>' "Jeff Bezos', :objectID => '162590850'},
+      {:company => 'Apple', :name => 'Steve Jobs', :objectID => '162590860'},
+      {:company => 'Apple', :name => 'Steve Wozniak', :objectID => '162590870'},
+      {:company => 'Arista Networks', :name => 'Jayshree Ullal', :objectID => '162590880'},
+      {:company => 'Google', :name => 'Larry Page', :objectID => '162590890'},
+      {:company => 'Google', :name => 'Rob Pike', :objectID => '162590900'},
+      {:company => 'Google', :name => 'Sergueï Brin', :objectID => '162590910'},
+      {:company => 'Microsoft', :name => 'Bill Gates', :objectID => '162590920'},
+      {:company => 'SpaceX', :name => 'Elon Musk', :objectID => '162590930'},
+      {:company => 'Tesla', :name => 'Elon Musk', :objectID => '162590940'},
+      {:company => 'Yahoo', :name => 'Marissa Mayer', :objectID => '162590950'},
+    ])
+
+    res = index.search('algolia')
+    Algolia::Index.get_object_position(res, 'nicolas-dessaigne').should eq(0)
+    Algolia::Index.get_object_position(res, 'julien-lemoine').should eq(1)
+    Algolia::Index.get_object_position(res, '').should eq(-1)
+
+    expect {
+      index.find_object({'query' => '', 'paginate' => true})
+    }.to raise_exception(
+      Algolia::AlgoliaObjectNotFoundError,
+      'Object not found'
+    )
+
+    expect {
+      index.find_object({'query' => '', 'paginate' => true}) { false }
+    }.to raise_exception(
+      Algolia::AlgoliaObjectNotFoundError,
+      'Object not found'
+    )
+
+    obj = index.find_object({'query' => '', 'paginate' => true}) { true }
+    obj['position'].should eq(0)
+    obj['page'].should eq(0)
+
+    # we use a lambda and convert it to a block with `&`
+    # so as not to repeat the condition
+    condition = lambda do |obj|
+      obj.key?('company') and obj['company'] == 'Apple'
+    end
+
+    expect {
+      index.find_object({'query' => 'algolia', 'paginate' => true}, &condition)
+    }.to raise_exception(
+      Algolia::AlgoliaObjectNotFoundError,
+      'Object not found'
+    )
+
+    expect {
+      index.find_object({'query' => '', 'paginate' => false, 'hitsPerPage' => 5}, &condition)
+    }.to raise_exception(
+      Algolia::AlgoliaObjectNotFoundError,
+      'Object not found'
+    )
+
+    obj = index.find_object({'query' => '', 'paginate' => true, 'hitsPerPage' => 5}, &condition)
+    obj['position'].should eq(0)
+    obj['page'].should eq(2)
+  end
+
   it "should copy the index" do
     index = Algolia::Index.new(safe_index_name("àlgol?à"))
     begin
@@ -615,7 +692,7 @@ describe 'Client' do
     expect { Algolia.multiple_queries([{"query" => ""}]) }.to raise_error(ArgumentError)
   end
 
-  it "shoud accept custom batch" do
+  it "should accept custom batch" do
     @index.clear_index! rescue "Not fatal"
     request = { "requests" => [
       {
@@ -1277,6 +1354,19 @@ describe 'Client' do
     expect{Algolia.list_indexes('headers' => { 'X-Algolia-API-Key' => 'NotExistentAPIKey' })}.to raise_error(Algolia::AlgoliaProtocolError)
   end
 
+  it 'should retrieve the remaining validity time in seconds' do
+    now = Time.now.to_i
+
+    key = Algolia.generate_secured_api_key('foo', :validUntil => now - (10 * 60))
+    expect(Algolia.get_secured_api_key_remaining_validity(key)).to be < 0
+
+    key = Algolia.generate_secured_api_key('foo', :validUntil => now + (10 * 60))
+    expect(Algolia.get_secured_api_key_remaining_validity(key)).to be > 0
+
+    key = Algolia.generate_secured_api_key('foo', [])
+    expect { Algolia.get_secured_api_key_remaining_validity(key) }.to raise_error(Algolia::ValidUntilNotFoundError)
+  end
+
   context 'DNS timeout' do
     before(:each) do
       @client = Algolia::Client.new :application_id => ENV['ALGOLIA_APPLICATION_ID'], :api_key => ENV['ALGOLIA_API_KEY'],

metadata

@@ -1,49 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.26.1
+  version: 1.27.4
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-01 00:00:00.000000000 Z
+date: 2020-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httpclient
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.3
+        version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.3
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
-  name: json
+  name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 2.8.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 2.8.3
 - !ruby/object:Gem::Dependency
   name: travis
   requirement: !ruby/object:Gem::Requirement
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API