algoliasearch 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8320f64639625f110a727ff9020826427ebbc373
-  data.tar.gz: 56183ac910b91ecd25588d396b552a4e8d41aa43
+  metadata.gz: 7f8a8ea00f71415bf0e2840c750d9122d14a0b14
+  data.tar.gz: 20f3cdce74f9bf324414263d8fb50e90f0ca933a
 SHA512:
-  metadata.gz: 06b994ce753c37cb70caa6c5ed61a3fa07f4e7fcf4e37427113873d03c444b6e21fa68c8e2f186937ce92256fc18c8ce7e9e856b56933046313e296f08515966
-  data.tar.gz: eb9d2669d3c719bb04e70ca8b0ec053d769c1bb66072386ce1dec0c1dcc27b86df99af957f7359cb16782cd6251a200edbae72dbf1aab17f026770f623e0d5db
+  metadata.gz: bdf0fb25764237fc16479a5d2f1faebf5f469cb979eaf9e3571b9fe70c3151ca8b40f24b7eee4a94b1bffe5f196d006becdc0ca8654e438567ec12e973623dd3
+  data.tar.gz: c94357b18b72c01a06ef07af02f45e5f4a01d16cb780af9c555a83321504719689563460691fc738dcafb5b0aa462c73b23cf408c7d2bb056c3368c241615cb9

data/ChangeLog

@@ -1,5 +1,8 @@
 CHANGELOG
 
+2015-07-14 1.5.1
+      * Ability to retrieve a single page from a cursor with `browse_from`
+
 2015-06-05 1.5.0
       * New cursor-based browse() implementation taking query parameters
 

data/README.md

@@ -423,6 +423,8 @@ res = Algolia.multiple_queries([{:index_name => "categories", "query" => my_quer
 puts res["results"]
 ```
 
+The resulting JSON answer contains a ```results``` array storing the underlying queries answers. The answers order is the same than the requests order.
+
 You can specify a strategy to optimize your multiple queries:
 - **none**: Execute the sequence of queries until the end.
 - **stopIfEnoughMatches**: Execute the sequence of queries until the number of hits is reached by the sum of hits.
@@ -569,7 +571,15 @@ index.clear_index
 Wait indexing
 -------------
 
-All write operations return a `taskID` when the job is securely stored on our infrastructure but not when the job is published in your index. Even if it's extremely fast, you can easily ensure indexing is complete using  the same method with a `!`.
+All write operations in Algolia are asynchronous by design.
+
+It means that when you add or update an object to your index, our servers will
+reply to your request with a `taskID` as soon as they understood the write
+operation.
+
+The actual insert and indexing will be done after replying to your code.
+
+You can wait for a task to complete using  the same method with a `!`.
 
 For example, to wait for indexing of a new object:
 ```ruby
@@ -577,8 +587,8 @@ res = index.add_object!({"firstname" => "Jimmie",
                          "lastname" => "Barninger"})
 ```
 
-
-If you want to ensure multiple objects have been indexed, you only need check the biggest taskID with `wait_task`.
+If you want to ensure multiple objects have been indexed, you only need to check
+the biggest `taskID` with `wait_task`.
 
 Batch writes
 -------------

data/lib/algolia/index.rb

@@ -150,7 +150,11 @@ module Algolia
         loop do
           answer = Algolia.client.get(Protocol.browse_uri(@name, @params.merge({ :cursor => @cursor })), :read)
           answer['hits'].each do |hit|
-            yield hit
+            if block.arity == 2
+              yield hit, @cursor
+            else
+              yield hit
+            end
           end
           @cursor = answer['cursor']
           break if @cursor.nil?
@@ -161,17 +165,20 @@ module Algolia
     #
     # Browse all index content
     #
-    # @param page Pagination parameter used to select the page to retrieve.
-    #             Page is zero-based and defaults to 0. Thus, to retrieve the 10th page you need to set page=9
+    # @param pageOrQueryParameters The hash of query parameters to use to browse
+    #                              To browse from a specific cursor, just add a ":cursor" parameters
+    #
+    # @DEPRECATED:
+    # @param pageOrQueryParameters Pagination parameter used to select the page to retrieve.
     # @param hitsPerPage: Pagination parameter used to select the number of hits per page. Defaults to 1000.
     #
-    def browse(page = nil, hitsPerPage = nil, &block)
+    def browse(pageOrQueryParameters = nil, hitsPerPage = nil, &block)
       if block_given?
         params = {}
-        if page.is_a?(Hash)
-          params.merge!(page)
+        if pageOrQueryParameters.is_a?(Hash)
+          params.merge!(pageOrQueryParameters)
         else
-          params[:page] = page unless page.nil?
+          params[:page] = pageOrQueryParameters unless pageOrQueryParameters.nil?
         end
         if hitsPerPage.is_a?(Hash)
           params.merge!(hitsPerPage)
@@ -186,6 +193,13 @@ module Algolia
       end
     end
 
+    #
+    # Browse a single page from a specific cursor
+    #
+    def browse_from(cursor, hitsPerPage = 1000)
+      Algolia.client.get(Protocol.browse_uri(name, { :cursor => cursor, :hitsPerPage => hitsPerPage }), :read)
+    end
+
     #
     # Get an object from this index
     # 

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.5.0"
+  VERSION = "1.5.1"
 end

data/spec/client_spec.rb

@@ -4,7 +4,7 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
 # avoid concurrent access to the same index
 def safe_index_name(name)
   return name if ENV['TRAVIS'].to_s != "true"
-  id = ENV['TRAVIS_JOB_NUMBER'].split('.').last
+  id = ENV['TRAVIS_JOB_NUMBER']
   "#{name}_travis-#{id}"
 end
 
@@ -225,10 +225,10 @@ describe 'Client' do
 
     @index.add_object!({:firstname => "Robert"})
     @index.search('')['nbHits'].should eq(1)
-    
+
     Algolia.copy_index!(safe_index_name("àlgol?a"), safe_index_name("àlgol?à"))
     @index.delete_index!
-    
+
     index.search('')['nbHits'].should eq(1)
     index.delete_index!
   end
@@ -244,9 +244,9 @@ describe 'Client' do
 
     @index.add_object!({:firstname => "Robert"})
     @index.search('')['nbHits'].should eq(1)
-    
+
     Algolia.move_index!(safe_index_name("àlgol?a"), safe_index_name("àlgol?à"))
-    
+
     index.search('')['nbHits'].should eq(1)
     index.delete_index
   end
@@ -259,7 +259,7 @@ describe 'Client' do
 
     res['hits'].size.should eq(1)
     res['hits'][0]['firstname'].should eq("Robert")
-  end 
+  end
 
   it "should get logs" do
     res = Algolia.get_logs(0, 20, true)
@@ -282,23 +282,23 @@ describe 'Client' do
     request = { "requests" => [
       {
         "action" => "addObject",
-        "body" => {"firstname" => "Jimmie", 
+        "body" => {"firstname" => "Jimmie",
         "lastname" => "Barninger"}
       },
       {
         "action" => "addObject",
-        "body" => {"firstname" => "Warren", 
+        "body" => {"firstname" => "Warren",
         "lastname" => "Speach"}
       },
       {
         "action" => "updateObject",
-        "body" => {"firstname" => "Jimmie", 
+        "body" => {"firstname" => "Jimmie",
         "lastname" => "Barninger",
         "objectID" => "43"}
       },
       {
         "action" => "updateObject",
-        "body" => {"firstname" => "Warren", 
+        "body" => {"firstname" => "Warren",
         "lastname" => "Speach"},
         "objectID" => "42"
       }
@@ -396,7 +396,7 @@ describe 'Client' do
     resEnd = Algolia.list_user_keys
     is_include(resEnd['keys'], 'value', newKey['key']).should eq(false)
 
-    
+
   end
 
   it "should check functions" do
@@ -414,7 +414,7 @@ describe 'Client' do
     object = @index.get_object(res['hits'][0]['objectID'])
     object['firstname'].should eq('Robert')
     object = @index.get_object(res['hits'][0]['objectID'], 'firstname')
-    object['firstname'].should eq('Robert') 
+    object['firstname'].should eq('Robert')
 
     @index.save_object!({:firstname => "George", :objectID => "A/go/?a"})
     res = @index.search('')
@@ -432,37 +432,37 @@ describe 'Client' do
 
   it "Check attributes list_indexes:" do
     res = Algolia::Index.all
-    res.should have_key('items')     
-    res['items'][0].should have_key('name')    
-    res['items'][0]['name'].should be_a(String)    
-    res['items'][0].should have_key('createdAt')    
-    res['items'][0]['createdAt'].should be_a(String)    
-    res['items'][0].should have_key('updatedAt')    
-    res['items'][0]['updatedAt'].should be_a(String)    
-    res['items'][0].should have_key('entries')    
-    res['items'][0]['entries'].should be_a(Integer)    
-    res['items'][0].should have_key('pendingTask')    
-    [true, false].should include(res['items'][0]['pendingTask']) 
+    res.should have_key('items')
+    res['items'][0].should have_key('name')
+    res['items'][0]['name'].should be_a(String)
+    res['items'][0].should have_key('createdAt')
+    res['items'][0]['createdAt'].should be_a(String)
+    res['items'][0].should have_key('updatedAt')
+    res['items'][0]['updatedAt'].should be_a(String)
+    res['items'][0].should have_key('entries')
+    res['items'][0]['entries'].should be_a(Integer)
+    res['items'][0].should have_key('pendingTask')
+    [true, false].should include(res['items'][0]['pendingTask'])
   end
 
   it 'Check attributes search : ' do
     res = @index.search('')
-    res.should have_key('hits')     
+    res.should have_key('hits')
     res['hits'].should be_a(Array)
-    res.should have_key('page')     
-    res['page'].should be_a(Integer)     
-    res.should have_key('nbHits')     
-    res['nbHits'].should be_a(Integer)     
-    res.should have_key('nbPages')     
-    res['nbPages'].should be_a(Integer)     
-    res.should have_key('hitsPerPage')     
-    res['hitsPerPage'].should be_a(Integer)     
-    res.should have_key('processingTimeMS')     
-    res['processingTimeMS'].should be_a(Integer)     
-    res.should have_key('query')     
-    res['query'].should be_a(String)     
-    res.should have_key('params')     
-    res['params'].should be_a(String)     
+    res.should have_key('page')
+    res['page'].should be_a(Integer)
+    res.should have_key('nbHits')
+    res['nbHits'].should be_a(Integer)
+    res.should have_key('nbPages')
+    res['nbPages'].should be_a(Integer)
+    res.should have_key('hitsPerPage')
+    res['hitsPerPage'].should be_a(Integer)
+    res.should have_key('processingTimeMS')
+    res['processingTimeMS'].should be_a(Integer)
+    res.should have_key('query')
+    res['query'].should be_a(String)
+    res.should have_key('params')
+    res['params'].should be_a(String)
   end
 
   it 'Check attributes delete_index : ' do
@@ -482,7 +482,7 @@ describe 'Client' do
     task.should have_key('taskID')
     task['taskID'].should be_a(Integer)
   end
-  
+
   it 'Check attributes add object : ' do
     task = @index.add_object({ :name => "John Doe", :email => "john@doe.org" })
     task.should have_key('createdAt')
@@ -502,7 +502,7 @@ describe 'Client' do
     #task.to_s.should eq("")
     task.should have_key('objectID')
     task['objectID'].should be_a(String)
-    task['objectID'].should eq("1") 
+    task['objectID'].should eq("1")
   end
 
   it 'Check attributes partial update: ' do
@@ -592,7 +592,7 @@ describe 'Client' do
     task.should have_key('status')
     task['status'].should be_a(String)
     task.should have_key('pendingTask')
-    [true, false].should include(task['pendingTask']) 
+    [true, false].should include(task['pendingTask'])
   end
 
   it "Check add keys" do
@@ -656,28 +656,28 @@ describe 'Client' do
     key.should eq(OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), 'my_api_key', 'public'))
     key = Algolia.generate_secured_api_key('my_api_key', ['public', ['premium','vip']])
     key.should eq(OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), 'my_api_key', 'public,(premium,vip)'))
-  end 
+  end
 
   it 'Check attributes multipleQueries' do
     res = Algolia.multiple_queries([{:index_name => safe_index_name("àlgol?a"), "query" => ""}])
     res.should have_key('results')
     res['results'].should be_a(Array)
-    res['results'][0].should have_key('hits')     
+    res['results'][0].should have_key('hits')
     res['results'][0]['hits'].should be_a(Array)
-    res['results'][0].should have_key('page')     
-    res['results'][0]['page'].should be_a(Integer)     
-    res['results'][0].should have_key('nbHits')     
-    res['results'][0]['nbHits'].should be_a(Integer)     
-    res['results'][0].should have_key('nbPages')     
-    res['results'][0]['nbPages'].should be_a(Integer)     
-    res['results'][0].should have_key('hitsPerPage')     
-    res['results'][0]['hitsPerPage'].should be_a(Integer)     
-    res['results'][0].should have_key('processingTimeMS')     
-    res['results'][0]['processingTimeMS'].should be_a(Integer)     
-    res['results'][0].should have_key('query')     
-    res['results'][0]['query'].should be_a(String)     
-    res['results'][0].should have_key('params')     
-    res['results'][0]['params'].should be_a(String)  
+    res['results'][0].should have_key('page')
+    res['results'][0]['page'].should be_a(Integer)
+    res['results'][0].should have_key('nbHits')
+    res['results'][0]['nbHits'].should be_a(Integer)
+    res['results'][0].should have_key('nbPages')
+    res['results'][0]['nbPages'].should be_a(Integer)
+    res['results'][0].should have_key('hitsPerPage')
+    res['results'][0]['hitsPerPage'].should be_a(Integer)
+    res['results'][0].should have_key('processingTimeMS')
+    res['results'][0]['processingTimeMS'].should be_a(Integer)
+    res['results'][0].should have_key('query')
+    res['results'][0]['query'].should be_a(String)
+    res['results'][0].should have_key('params')
+    res['results'][0]['params'].should be_a(String)
   end
 
   it 'should handle disjunctive faceting' do
@@ -779,10 +779,13 @@ describe 'Client' do
     answer = @index.browse(0, 1000)
 
     hits = {}
-    @index.browse(:cursor => answer['cursor']) do |hit|
+    @index.browse(:cursor => answer['cursor']) do |hit, cursor|
       hits[hit['objectID']] = true
+      cursor.should eq(answer['cursor'])
     end
     hits.size.should eq(500)
+
+    @index.browse_from(answer['cursor'])['hits'].size.should eq(500)
   end
 
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2015-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.4'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: travis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A simple Ruby client for the algolia.com REST API
@@ -89,8 +89,8 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- ".rspec"
-- ".travis.yml"
+- .rspec
+- .travis.yml
 - ChangeLog
 - Gemfile
 - Gemfile.lock
@@ -121,17 +121,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API