Merge pull request #397 from meilisearch/bump-meilisearch-v0.30.0-add-limited-pagination

Add support to finite pagination

Author: brunoocasali

lib/meilisearch/index.rb

@@ -191,7 +191,10 @@ def search(query, options = {})
       parsed_options = Utils.transform_attributes({ q: query.to_s }.merge(options.compact))
 
       response = http_post "/indexes/#{@uid}/search", parsed_options
-      response['nbHits'] ||= response['estimatedTotalHits']
+
+      if !response.key?('totalPages')
+        response['nbHits'] ||= response['estimatedTotalHits']
+      end
 
       response
     end

spec/meilisearch/index/search/q_spec.rb

@@ -69,4 +69,18 @@
     expect(response['hits'].first['objectId']).to eq(4)
     expect(response['hits'].first).not_to have_key('_formatted')
   end
+
+  context 'with finite pagination params' do
+    it 'responds with specialized fields' do
+      response = index.search('coco', { page: 2, hits_per_page: 2 })
+
+      expect(response.keys).to contain_exactly(*FINITE_PAGINATED_SEARCH_RESPONSE_KEYS)
+    end
+
+    it 'responds with specialized fields' do
+      response = index.search('coco', { page: 2, hitsPerPage: 2 })
+
+      expect(response.keys).to contain_exactly(*FINITE_PAGINATED_SEARCH_RESPONSE_KEYS)
+    end
+  end
 end

spec/spec_helper.rb

@@ -41,6 +41,16 @@
   'nbHits'
 ].freeze
 
+FINITE_PAGINATED_SEARCH_RESPONSE_KEYS = [
+  'hits',
+  'query',
+  'processingTimeMs',
+  'hitsPerPage',
+  'page',
+  'totalPages',
+  'totalHits',
+].freeze
+
 Dir["#{Dir.pwd}/spec/support/**/*.rb"].sort.each { |file| require file }
 
 RSpec.configure do |config|