dhs 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c77465b9e45a9f59c90566da5a2b706d7b2b1c83ea4a02da1133ae69008b113
-  data.tar.gz: 80d5e98d765171120c67167c214ca4b9a7a02a2f017d33d1e1d3d98da16edd6d
+  metadata.gz: f42a1fdc00478fe3e24e797f52396c953442e4e0d2da738b28fb7cc55b908ea3
+  data.tar.gz: 1465403fb48c2dca7f2b955550309a7983a4d264ef10cbb35d620df88f01f1fe
 SHA512:
-  metadata.gz: 6ff3c40cdf4da8c18be8420afb4dae547f3d3c3dc6211bdce27706ea48dc1e4099dedf9dc35975cfa7e8291d6a8e0ca485cf58b0a790900883ac547ba14b10a3
-  data.tar.gz: a366a714e0fb4235f75475079973824a2e620fa8ceca02866fc223f43a69897cb664b6d46120dedb1d6d0aa3dfbeef1ab68de620187bbc74085a01a712ea25bd
+  metadata.gz: bd6412647a124e42350e185d60a6a0040aa9ef30db503fddf529db0979f4c6b7151bc3e9cdad8378a111512b4f481868a39839c89e42f7ea420c3a27e2539050
+  data.tar.gz: a6936544068aa3b6591163f768a6e3c96ce38317abc183ca3bec8e62c50da10d25518f215b939945acd990f449615865d19dec5886a8cd2e88e59965c1fcb5d8

data/.github/workflows/rubocop.yml

@@ -8,20 +8,9 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
+      - uses: ruby/setup-ruby@master
         with:
-          ruby-version: 3.0.0
-      - name: Cache Ruby Gems
-        uses: actions/cache@v2
-        with:
-          path: /.tmp/vendor/bundle
-          key: ${{ runner.os }}-gems-latest-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-gems-latest-
-      - name: Bundle Install
-        run: |
-          bundle config path /.tmp/vendor/bundle
-          bundle install --jobs 4 --retry 3
+          bundler-cache: true
       - name: Run Rubocop
         run: |
           bundle exec rubocop

data/.github/workflows/test.yml

@@ -8,20 +8,9 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
+      - uses: ruby/setup-ruby@master
         with:
-          ruby-version: 3.0.0
-      - name: Cache Ruby Gems
-        uses: actions/cache@v2
-        with:
-          path: /.tmp/vendor/bundle
-          key: ${{ runner.os }}-gems-latest-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-gems-latest-
-      - name: Bundle Install
-        run: |
-          bundle config path /.tmp/vendor/bundle
-          bundle install --jobs 4 --retry 3
+          bundler-cache: true
       - name: Run Tests
         run: |
           bundle exec rspec

data/lib/dhs/concerns/record/batch.rb

@@ -22,17 +22,18 @@ class DHS::Record
       def find_in_batches(options = {})
         raise 'No block given' unless block_given?
         options = options.dup
-        start = options.delete(:start) || 1
-        batch_size = options.delete(:batch_size) || DHS::Pagination::Base::DEFAULT_LIMIT
+        start = options[:start] || self.pagination_class::DEFAULT_OFFSET
+        batch_size = options.delete(:batch_size) || self.pagination_class::DEFAULT_LIMIT
         loop do # as suggested by Matz
           options = options.dup
           options[:params] = (options[:params] || {}).merge(limit_key(:parameter) => batch_size, pagination_key(:parameter) => start)
           data = request(options)
-          batch_size = data._raw.dig(*limit_key(:body))
-          left = data._raw.dig(*total_key).to_i - data._raw.dig(*pagination_key(:body)).to_i - data._raw.dig(*limit_key(:body)).to_i
+          pagination = self.pagination(data)
+          batch_size = pagination.limit
+          left = pagination.pages_left
           yield new(data)
           break if left <= 0
-          start += batch_size
+          start = pagination.next_offset
         end
       end
     end

data/lib/dhs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DHS
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/spec/record/find_each_spec.rb

@@ -29,11 +29,11 @@ describe DHS::Collection do
 
   context 'find_each' do
     it 'processes each record by fetching records in batches' do
-      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=1").to_return(status: 200, body: api_response((1..100).to_a, 1))
-      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=101").to_return(status: 200, body: api_response((101..200).to_a, 101))
-      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=201").to_return(status: 200, body: api_response((201..300).to_a, 201))
-      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=301").to_return(status: 200, body: api_response((301..400).to_a, 301))
-      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=401").to_return(status: 200, body: api_response((401..total).to_a, 401))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=0").to_return(status: 200, body: api_response((1..100).to_a, 0))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=100").to_return(status: 200, body: api_response((101..200).to_a, 100))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=200").to_return(status: 200, body: api_response((201..300).to_a, 200))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=300").to_return(status: 200, body: api_response((301..400).to_a, 300))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=400").to_return(status: 200, body: api_response((401..total).to_a, 400))
       count = 0
       Record.find_each do |record|
         count += 1
@@ -45,7 +45,7 @@ describe DHS::Collection do
     end
 
     it 'passes options to the requests made' do
-      request = stub_request(:get, 'http://depay.fi/v2/feedbacks?limit=100&offset=1')
+      request = stub_request(:get, 'http://depay.fi/v2/feedbacks?limit=100&offset=0')
         .with(headers: { 'Authorization' => 'Bearer 123' })
         .to_return(body: {
           items: []

data/spec/record/find_in_batches_spec.rb

@@ -29,11 +29,11 @@ describe DHS::Collection do
 
   context 'find_batches' do
     it 'processes records in batches' do
-      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=1").to_return(status: 200, body: api_response((1..100).to_a, 1))
-      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=101").to_return(status: 200, body: api_response((101..200).to_a, 101))
-      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=201").to_return(status: 200, body: api_response((201..300).to_a, 201))
-      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=301").to_return(status: 200, body: api_response((301..400).to_a, 301))
-      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=401").to_return(status: 200, body: api_response((401..total).to_a, 401))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=0").to_return(status: 200, body: api_response((1..100).to_a, 0))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=100").to_return(status: 200, body: api_response((101..200).to_a, 100))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=200").to_return(status: 200, body: api_response((201..300).to_a, 200))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=300").to_return(status: 200, body: api_response((301..400).to_a, 300))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=400").to_return(status: 200, body: api_response((401..total).to_a, 400))
       length = 0
       Record.find_in_batches do |records|
         length += records.length
@@ -44,11 +44,11 @@ describe DHS::Collection do
     end
 
     it 'adapts to backend max limit' do
-      stub_request(:get, "#{datastore}/feedbacks?limit=230&offset=1").to_return(status: 200, body: api_response((1..100).to_a, 1))
-      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=101").to_return(status: 200, body: api_response((101..200).to_a, 101))
-      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=201").to_return(status: 200, body: api_response((201..300).to_a, 201))
-      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=301").to_return(status: 200, body: api_response((301..400).to_a, 301))
-      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=401").to_return(status: 200, body: api_response((401..total).to_a, 401))
+      stub_request(:get, "#{datastore}/feedbacks?limit=230&offset=0").to_return(status: 200, body: api_response((1..100).to_a, 0))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=100").to_return(status: 200, body: api_response((101..200).to_a, 100))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=200").to_return(status: 200, body: api_response((201..300).to_a, 200))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=300").to_return(status: 200, body: api_response((301..400).to_a, 300))
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=400").to_return(status: 200, body: api_response((401..total).to_a, 400))
       length = 0
       Record.find_in_batches(batch_size: 230) do |records|
         length += records.length
@@ -59,8 +59,8 @@ describe DHS::Collection do
     end
 
     it 'forwards offset' do
-      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=401").to_return(status: 200, body: api_response((401..total).to_a, 401))
-      Record.find_in_batches(start: 401) do |records|
+      stub_request(:get, "#{datastore}/feedbacks?limit=100&offset=400").to_return(status: 200, body: api_response((401..total).to_a, 400))
+      Record.find_in_batches(start: 400) do |records|
         expect(records.length).to eq(total - 400)
       end
     end
@@ -119,4 +119,42 @@ describe DHS::Collection do
       expect(length).to eq total
     end
   end
+
+  context 'different pagination strategy' do
+    before do
+      class Transaction < DHS::Record
+        endpoint 'https://api/transactions'
+        configuration limit_key: :items_on_page, pagination_strategy: :total_pages, pagination_key: :page, items_key: :transactions, total_key: :total_pages
+      end
+
+      stub_request(:get, 'https://api/transactions?items_on_page=50&page=1')
+        .to_return(body: {
+          page: 1,
+          total_pages: 2,
+          items_on_page: 50,
+          transactions: 50.times.map { |index| { id: index } }
+        }.to_json)
+
+      stub_request(:get, 'https://api/transactions?items_on_page=50&page=2')
+        .to_return(body: {
+          page: 2,
+          total_pages: 2,
+          items_on_page: 50,
+          transactions: 22.times.map { |index| { id: 50 + index } }
+        }.to_json)
+    end
+
+    it 'find in batches and paginates automatically even for different pagination strategies' do
+      total = 0
+      transactions = []
+
+      Transaction.find_in_batches(batch_size: 50) do |batch|
+        total += batch.length
+        transactions << batch
+      end
+
+      expect(total).to eq(72)
+      expect(transactions.flatten.as_json).to eq(72.times.map { |index| { id: index }.as_json })
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dhs
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - https://github.com/DePayFi/dhs/graphs/contributors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2021-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel