algoliasearch 1.26.1 → 1.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b688a2dbf301d12d5334b0ae73dbb287bd5054f1a19499d59c68c3b69713569
-  data.tar.gz: d8d8dc2d476cc6f4e9b8ad81437f390401e1c720a61184b020ec15638026b6c3
+  metadata.gz: 9036ce666897c7cfb05a637b80ffcebc26a08560ac655bca29f0bbaa631aa2e6
+  data.tar.gz: 39a1e847147a3d9f08fa529045abaec8725d95c7cb4f8a496646c0b2dd25f9d4
 SHA512:
-  metadata.gz: 40e6001e2b9b43490d9dc6ee901054d53b822f04c87d62c0979eaa6bd8671da4f7f94d9a781a7ffb5fb8e834cbcef63231a2469e42364177ee598fa1428f3f4e
-  data.tar.gz: de731f8dff00f9084da3fd9e230dfc2ef286cccbea2958a5512690ac229044180e5af2118c37fd3048bc54e238669e60b77b38bacc03675855a2edb510bb0541
+  metadata.gz: db1d480cc1aa22bf2c2ea547740ab905440928dab50680afb21998bffa9b6ffd29aef6dda35a0263bf5c4a61c398a7d6e260c045efe636fc1a0dbc781dd15b44
+  data.tar.gz: 22e70e7d376ca9ef5fca68e13b381eedd854afef4d315a2d2e18c6c2b64562e2d1952d8a17dad309171bc33dc489728004cbf9bc668fd39fc6d4e81a18bc2aa8

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,26 @@
 # ChangeLog
 
+## [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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algoliasearch (1.26.0)
+    algoliasearch (1.26.1)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
 
@@ -10,12 +10,6 @@ GEM
   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)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
@@ -41,9 +35,6 @@ GEM
     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)
     multipart-post (2.1.1)
     net-http-persistent (2.9.4)
@@ -51,10 +42,8 @@ GEM
     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)
+    rake (12.3.3)
+    rdoc (6.2.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -276,10 +265,6 @@ GEM
       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)
       backports
       faraday (~> 0.9)
@@ -291,7 +276,7 @@ GEM
       typhoeus (~> 0.6, >= 0.6.8)
     typhoeus (0.8.0)
       ethon (>= 0.8.0)
-    webmock (3.6.0)
+    webmock (3.7.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -302,7 +287,6 @@ PLATFORMS
 
 DEPENDENCIES
   algoliasearch!
-  coveralls
   rake
   rdoc
   rspec (>= 2.5.0)

data/lib/algolia/client.rb

@@ -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,24 @@ 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
+
     # 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.0"
 end

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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.26.1
+  version: 1.27.0
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-01 00:00:00.000000000 Z
+date: 2019-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -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