Add proper #all implementation

fortnox-api.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
 
   spec.required_ruby_version = '>= 2.3'
   spec.add_dependency 'dry-struct', '~> 0.1'
-  spec.add_dependency 'dry-types', '~> 0.8'
+  spec.add_dependency 'dry-types', '~> 0.8', '< 0.13.0'
   # TODO: Temporary lockdown. See issue #103 for more info.
   spec.add_dependency 'httparty', '~> 0.14.0'
 

lib/fortnox/api/mappers/metadata.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'fortnox/api/mappers/base'
+
+module Fortnox
+  module API
+    module Mapper
+      class Metadata < Fortnox::API::Mapper::Base
+        KEY_MAP = {
+          total_resources: '@TotalResources',
+          total_pages: '@TotalPages',
+          current_page: '@CurrentPage'
+        }.freeze
+        JSON_ENTITY_WRAPPER = 'MetaInformation'
+      end
+
+      Registry.register(Metadata.canonical_name_sym, Metadata)
+    end
+  end
+end

lib/fortnox/api/models.rb

@@ -7,3 +7,4 @@
 require 'fortnox/api/models/project'
 require 'fortnox/api/models/unit'
 require 'fortnox/api/models/terms_of_payment'
+require 'fortnox/api/models/metadata'

lib/fortnox/api/models/metadata.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'fortnox/api/types'
+
+module Fortnox
+  module API
+    module Model
+      class Metadata < Model::Base
+        STUB = {
+          current_page: '',
+          total_resources: '',
+          total_pages: ''
+        }.freeze
+
+        attribute :current_page, Types::Required::Integer.is(:read_only)
+        attribute :total_resources, Types::Required::Integer.is(:read_only)
+        attribute :total_pages, Types::Required::Integer.is(:read_only)
+      end
+    end
+  end
+end

lib/fortnox/api/repositories/base.rb

@@ -4,6 +4,8 @@
 require 'fortnox/api/request_handling'
 require 'fortnox/api/repositories/base/loaders'
 require 'fortnox/api/repositories/base/savers'
+require 'fortnox/api/repositories/base/pagination'
+require 'fortnox/api/mappers/metadata'
 
 module Fortnox
   module API
@@ -13,6 +15,7 @@ class Base
         include Fortnox::API::RequestHandling
         include Loaders
         include Savers
+        include Pagination
 
         HTTParty::Parser::SupportedFormats['text/html'] = :json
 
@@ -24,7 +27,7 @@ class Base
         HTTP_METHODS = %i[get put post delete].freeze
 
         attr_accessor :headers
-        attr_reader :mapper, :keys_filtered_on_save
+        attr_reader :mapper, :keys_filtered_on_save, :metadata
 
         def self.set_headers(headers = {}) # rubocop:disable Naming/AccessorMethodName
           self.headers.merge!(headers)
@@ -49,6 +52,7 @@ def initialize(keys_filtered_on_save: [:url], token_store: :default)
           @keys_filtered_on_save = keys_filtered_on_save
           @token_store = token_store
           @mapper = Registry[Mapper::Base.canonical_name_sym(self.class::MODEL)].new
+          @metadata_mapper = Mapper::Metadata.new
         end
 
         def next_access_token

lib/fortnox/api/repositories/base/loaders.rb

@@ -7,8 +7,15 @@ module API
     module Repository
       module Loaders
         def all
-          response_hash = get(self.class::URI)
-          instantiate_collection_response(response_hash)
+          results = []
+
+          loop do
+            response_hash = get(self.class::URI, query: { page: next_page })
+            results += instantiate_collection_response(response_hash)
+            break if last_page?
+          end
+
+          results
         end
 
         def only(filter)
@@ -53,6 +60,9 @@ def escape(key, value)
         private
 
         def instantiate_collection_response(response_hash)
+          metadata_hash = @metadata_mapper.wrapped_json_hash_to_entity_hash(response_hash)
+          @metadata = Model::Metadata.new(metadata_hash)
+
           entities_hash = @mapper.wrapped_json_collection_to_entities_hash(response_hash)
           entities_hash.map do |entity_hash|
             instantiate(entity_hash)

lib/fortnox/api/repositories/base/pagination.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Fortnox
+  module API
+    module Repository
+      module Pagination
+        def last_page?
+          current_page == total_pages
+        end
+
+        def next_page
+          current_page + 1
+        end
+
+        def current_page
+          metadata&.current_page || 0
+        end
+
+        def total_pages
+          metadata&.total_pages || 0
+        end
+      end
+    end
+  end
+end

spec/fortnox/api/mappers/metadata_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'fortnox/api'
+require 'fortnox/api/mappers/metadata'
+require 'fortnox/api/mappers/examples/mapper'
+
+describe Fortnox::API::Mapper::Metadata do
+  key_map = Fortnox::API::Mapper::Metadata::KEY_MAP
+  json_entity_type = 'MetaInformation'
+
+  it_behaves_like 'mapper', key_map, json_entity_type, nil do
+    let(:mapper) { described_class.new }
+  end
+end

spec/fortnox/api/models/metadata_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'fortnox/api/models/metadata'
+require 'fortnox/api/models/examples/model'
+
+describe Fortnox::API::Model::Metadata, type: :model do
+  let(:required_attributes) do
+    {
+      current_page: 1,
+      total_resources: 2,
+      total_pages: 1
+    }
+  end
+
+  it 'can be initialized' do
+    expect { described_class.new(required_attributes) }.not_to raise_error
+  end
+end

spec/fortnox/api/repositories/article_spec.rb

@@ -26,7 +26,7 @@
                    :ean,
                    '5901234123457'
 
-  include_examples '.all', 12
+  include_examples '.all', 20
 
   include_examples '.find', '1' do
     let(:find_by_hash_failure) { { description: 'Not Found' } }

spec/fortnox/api/repositories/base_spec.rb

@@ -328,7 +328,7 @@ class Test < Fortnox::API::Repository::Base
 
   context 'when raising error from remote server' do
     error_message = 'Räkenskapsår finns inte upplagt. '\
-                    'För att kunna skapa en faktura krävs det att det finns ett räkenskapsår'
+      'För att kunna skapa en faktura krävs det att det finns ett räkenskapsår'
 
     before do
       Fortnox::API.configure do |conf|

spec/fortnox/api/repositories/customer_spec.rb

@@ -27,7 +27,7 @@
   # It is not yet possible to delete Customers. Therefore, expected nr of
   # Customers when running .all will continue to increase
   # (until 100, which is max by default).
-  include_examples '.all', 100
+  include_examples '.all', 209
 
   include_examples '.find', '1' do
     let(:find_by_hash_failure) { { city: 'Not Found' } }

spec/fortnox/api/repositories/invoice_spec.rb

@@ -37,7 +37,7 @@
 
   # It is not possible to delete Invoces. Therefore, expected nr of Orders
   # when running .all will continue to increase (until 100, which is max by default).
-  include_examples '.all', 60
+  include_examples '.all', 84
 
   include_examples '.find', 1 do
     let(:find_by_hash_failure) { { yourreference: 'Not found' } }

spec/fortnox/api/repositories/order_spec.rb

@@ -31,7 +31,7 @@
 
   # It is not possible to delete Orders. Therefore, expected nr of Orders
   # when running .all will continue to increase (until 100, which is max by default).
-  include_examples '.all', 100
+  include_examples '.all', 325
 
   include_examples '.find', 1 do
     let(:find_by_hash_failure) { { ourreference: 'Not found' } }

spec/fortnox/api/repositories/project_spec.rb

@@ -22,7 +22,7 @@
   # It is not yet possible to delete Projects. Therefore, expected nr of
   # Projects when running .all will continue to increase
   # (until 100, which is max by default).
-  include_examples '.all', 8
+  include_examples '.all', 26
 
   include_examples '.find', '1' do
     let(:find_by_hash_failure) { { offset: 10_000 } }

spec/fortnox/api/repositories/terms_of_payment_spec.rb

@@ -21,7 +21,7 @@
 
   include_examples '.save', :description, additional_attrs: required_hash
 
-  include_examples '.all', 9
+  include_examples '.all', 10
 
   include_examples '.find', '15DAYS', find_by_hash: false do
     let(:find_by_hash_failure) { { code: '15days' } }

spec/fortnox/api/repositories/unit_spec.rb

@@ -25,7 +25,7 @@
                    :code,
                    'woooh'
 
-  include_examples '.all', 6
+  include_examples '.all', 8
 
   include_examples '.find', 'blarg', find_by_hash: false do
     let(:find_by_hash_failure) { { code: 'notfound' } }