algoliasearch 1.4.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1726fd4406b2f28c30c00ada864700697de5478c
-  data.tar.gz: fe9a42f9f9ed7c137006564f03999051a8e6f78e
+  metadata.gz: 8320f64639625f110a727ff9020826427ebbc373
+  data.tar.gz: 56183ac910b91ecd25588d396b552a4e8d41aa43
 SHA512:
-  metadata.gz: e41301b7d77c62eb8afa6e1c2126b0a45a9741a767644fff639203ea2a531805b2a9e68b9d572a2f4c24e194b7f1aed06626eb2fa916c6c0ac3c598525db7eb5
-  data.tar.gz: 608fc4e94933e30a98b95ec0c5d1ec6f05d49a1ec4feef00acf833d7915a2bb550164cb106a959dcd69798251bc41f08a189e621f7f08506d7e3640cc0e2c018
+  metadata.gz: 06b994ce753c37cb70caa6c5ed61a3fa07f4e7fcf4e37427113873d03c444b6e21fa68c8e2f186937ce92256fc18c8ce7e9e856b56933046313e296f08515966
+  data.tar.gz: eb9d2669d3c719bb04e70ca8b0ec053d769c1bb66072386ce1dec0c1dcc27b86df99af957f7359cb16782cd6251a200edbae72dbf1aab17f026770f623e0d5db

data/ChangeLog

@@ -1,5 +1,8 @@
 CHANGELOG
 
+2015-06-05 1.5.0
+      * New cursor-based browse() implementation taking query parameters
+
 2015-05-27 1.4.3
       * Do not call `WebMock.disable!` in the helper
 

data/lib/algolia/index.rb

@@ -139,6 +139,25 @@ module Algolia
       Algolia.client.get(Protocol.search_uri(name, query, encoded_params), :search)
     end
 
+    class IndexBrowser
+      def initialize(name, params)
+        @name = name
+        @params = params
+        @cursor = params[:cursor] || params['cursor'] || nil
+      end
+
+      def browse(&block)
+        loop do
+          answer = Algolia.client.get(Protocol.browse_uri(@name, @params.merge({ :cursor => @cursor })), :read)
+          answer['hits'].each do |hit|
+            yield hit
+          end
+          @cursor = answer['cursor']
+          break if @cursor.nil?
+        end
+      end
+    end
+
     #
     # Browse all index content
     #
@@ -146,8 +165,25 @@ module Algolia
     #             Page is zero-based and defaults to 0. Thus, to retrieve the 10th page you need to set page=9
     # @param hitsPerPage: Pagination parameter used to select the number of hits per page. Defaults to 1000.
     #
-    def browse(page = 0, hitsPerPage = 1000)
-     Algolia.client.get(Protocol.browse_uri(name, {:page => page, :hitsPerPage => hitsPerPage}), :read)
+    def browse(page = nil, hitsPerPage = nil, &block)
+      if block_given?
+        params = {}
+        if page.is_a?(Hash)
+          params.merge!(page)
+        else
+          params[:page] = page unless page.nil?
+        end
+        if hitsPerPage.is_a?(Hash)
+          params.merge!(hitsPerPage)
+        else
+          params[:hitsPerPage] = hitsPerPage unless hitsPerPage.nil?
+        end
+        IndexBrowser.new(name, params).browse(&block)
+      else
+        page ||= 0
+        hitsPerPage ||= 1000
+        Algolia.client.get(Protocol.browse_uri(name, {:page => page, :hitsPerPage => hitsPerPage}), :read)
+      end
     end
 
     #

data/lib/algolia/version.rb

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

data/spec/client_spec.rb

@@ -738,8 +738,6 @@ describe 'Client' do
     end
   end
 
-  
-
   it "should send a custom batch" do
     batch = [
       {:action => "addObject", :indexName => @index.name, :body => { :objectID => "11", :email => "john@be.org" }},
@@ -749,5 +747,42 @@ describe 'Client' do
     res = @index.search("@be.org")
     res["hits"].length.should eq(2)
   end
-end
 
+  def test_browse(expected, *args)
+    @index.clear
+    @index.add_objects!(1.upto(1500).map { |i| { :objectID => i, :i => i } })
+    hits = {}
+    @index.browse(*args) do |hit|
+      hits[hit['objectID']] = true
+    end
+    hits.size.should eq(expected)
+  end
+
+  it "should browse the index using cursors" do
+    test_browse(1500)
+    test_browse(500, 1, 1000)
+    test_browse(0, 2, 1000)
+  end
+
+  it "should browse the index using cursors specifying hitsPerPage" do
+    test_browse(1500, { :hitsPerPage => 500 })
+  end
+
+  it "should browse the index using cursors specifying params" do
+    test_browse(1, { :hitsPerPage => 500, :numericFilters => 'i=42' })
+    test_browse(42, { :numericFilters => 'i<=42' })
+  end
+
+  it "should browse the index using cursors from a cursor" do
+    @index.clear
+    @index.add_objects!(1.upto(1500).map { |i| { :objectID => i, :i => i } })
+    answer = @index.browse(0, 1000)
+
+    hits = {}
+    @index.browse(:cursor => answer['cursor']) do |hit|
+      hits[hit['objectID']] = true
+    end
+    hits.size.should eq(500)
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.0
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-27 00:00:00.000000000 Z
+date: 2015-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient