dhs 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7d6af021c9cf582a27709769c0355f5b9c978df218606456887641f7fcf83fc
-  data.tar.gz: 8cc46642942b9804799c74c2568b0dc8d9b131a87f8b2f9fe5615f2b510759e1
+  metadata.gz: 1880fd170b224c3968acc2c3d77f2aa2b31bf6205f0427a30d8041081feafda9
+  data.tar.gz: 85e87c2fd8b9f0931286d7b4343839c9951f6a22f201d2dcd1135fad0dccf4f7
 SHA512:
-  metadata.gz: d8a4620d4f6861dde1bc5cf577fe73f37fca800c4c5758cc0664ef5bd0f2d52b870839275446d5a29cd8b00f5d0fbf518310fdf55f1e40e2bb9c3f169550f766
-  data.tar.gz: 9c6a6ff69bc89e7ee2b84518c7c60ff673bdace69def5ee778ea54f4dd513705eb06d599a218353be7182f9487ac000ed0acad711cc56c8eb34e948817451638
+  metadata.gz: 15623d271f53db3a97af63412ee8a325ffa3ed8039bfbe3716a5fb337341f978cfde0893f811111eaee487d4f01d8c6e32cd70d5f6de5389d0a6d7a66a65d4bc
+  data.tar.gz: 507dd7ccbcd98f21060dfb1c90fa1e849aa63319e842bc1f70d8aa06398aeb4edbc9f7763890090b9252df93606851f598e901451e750ad4fd4ae0c772a04ead

data/README.md

@@ -1131,6 +1131,40 @@ In parallel:
   GET https://service.example.com/records?limit=100&page=3
 ```
 
+##### Pagination strategy: offset_page
+
+The `offest_page` strategy is based on the `page` strategy with the only difference
+that the pages are counted from 0 onwards (not from 1).
+
+```ruby
+# app/models/transaction.rb
+
+class Transaction < DHS::Record
+  configuration pagination_strategy: 'offset_page', pagination_key: 'page'
+
+  endpoint '{+service}/transactions'
+end
+```
+
+```ruby
+# app/controllers/some_controller.rb
+
+Record.all
+
+```
+```
+GET https://service.example.com/records?limit=100
+{
+  items: [{...}, ...],
+  total: 300,
+  limit: 100,
+  page: 0
+}
+In parallel:
+  GET https://service.example.com/records?limit=100&page=1
+  GET https://service.example.com/records?limit=100&page=2
+```
+
 ##### Pagination strategy: total_pages
 
 The `total_pages` strategy is based on the `page` strategy with the only difference
@@ -1165,7 +1199,6 @@ In parallel:
   GET https://service.example.com/records?limit=100&page=3
 ```
 
-
 ##### Pagination strategy: start
 
 In comparison to the `offset` strategy, the `start` strategy indicates with which item the current page starts. 

data/lib/dhs.rb

@@ -38,6 +38,7 @@ module DHS
     autoload :Offset, 'dhs/pagination/offset'
     autoload :Page, 'dhs/pagination/page'
     autoload :TotalPages, 'dhs/pagination/total_pages'
+    autoload :OffsetPage, 'dhs/pagination/offset_page'
     autoload :Start, 'dhs/pagination/start'
     autoload :Link, 'dhs/pagination/link'
   end

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

@@ -24,6 +24,8 @@ class DHS::Record
           DHS::Pagination::Page
         when :total_pages
           DHS::Pagination::TotalPages
+        when :offset_page
+          DHS::Pagination::OffsetPage
         when :start
           DHS::Pagination::Start
         when :link

data/lib/dhs/pagination/offset_page.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class DHS::Pagination::OffsetPage < DHS::Pagination::Page
+
+  DEFAULT_OFFSET = 0
+
+end

data/lib/dhs/version.rb

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

data/spec/pagination/offset_page_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  context 'pagination' do
+    def stub_api_request(items: [], page: nil)
+      stub_request(:get, ['http://depay.fi/v2/transactions?limit=100', page].compact.join('&page='))
+        .to_return(body: { items: items }.to_json)
+    end
+
+    let!(:requests) do
+      stub_api_request(items: (0...100).to_a)
+      stub_api_request(items: (100...200).to_a, page: 1)
+      stub_api_request(items: (200...300).to_a, page: 2)
+      stub_api_request(items: [], page: 3)
+    end
+
+    before do
+      class Transaction < DHS::Record
+        configuration pagination_strategy: :offset_page, pagination_key: :page
+
+        endpoint 'http://depay.fi/v2/transactions'
+      end
+    end
+
+    it 'fetches all the pages' do
+      transactions = Transaction.all.fetch
+      expect(transactions.to_a).to eq (0...300).to_a
+    end
+
+    context 'incomplete pages' do
+      let!(:requests) do
+        stub_api_request(items: (0...100).to_a)
+        stub_api_request(items: (100...200).to_a, page: 1)
+        stub_api_request(items: (200...300).to_a, page: 2)
+        stub_api_request(items: [300], page: 3)
+        stub_api_request(items: [], page: 4)
+      end
+
+      it 'fetches all the pages' do
+        transactions = Transaction.all.fetch
+        expect(transactions.to_a).to eq (0..300).to_a
+      end
+    end
+
+    context 'incomplete pages' do
+      let!(:requests) do
+        stub_api_request(items: (0...100).to_a)
+        stub_api_request(items: (100...200).to_a, page: 1)
+        stub_api_request(items: (200...299).to_a, page: 2)
+        stub_api_request(items: [], page: 3)
+      end
+
+      it 'fetches all the pages' do
+        transactions = Transaction.all.fetch
+        expect(transactions.to_a).to eq (0...299).to_a
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dhs
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - https://github.com/DePayFi/dhs/graphs/contributors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-08 00:00:00.000000000 Z
+date: 2021-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -322,6 +322,7 @@ files:
 - lib/dhs/pagination/base.rb
 - lib/dhs/pagination/link.rb
 - lib/dhs/pagination/offset.rb
+- lib/dhs/pagination/offset_page.rb
 - lib/dhs/pagination/page.rb
 - lib/dhs/pagination/start.rb
 - lib/dhs/pagination/total_pages.rb
@@ -459,6 +460,7 @@ files:
 - spec/pagination/link/parallel_spec.rb
 - spec/pagination/link/total_spec.rb
 - spec/pagination/offset/pages_left_spec.rb
+- spec/pagination/offset_page_spec.rb
 - spec/pagination/parameters_spec.rb
 - spec/pagination/total_pages_spec.rb
 - spec/proxy/create_sub_resource_spec.rb
@@ -693,6 +695,7 @@ test_files:
 - spec/pagination/link/parallel_spec.rb
 - spec/pagination/link/total_spec.rb
 - spec/pagination/offset/pages_left_spec.rb
+- spec/pagination/offset_page_spec.rb
 - spec/pagination/parameters_spec.rb
 - spec/pagination/total_pages_spec.rb
 - spec/proxy/create_sub_resource_spec.rb