fortnox-api 0.7.2 → 0.8.1

data/lib/fortnox/api/models.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/models/article'
-require 'fortnox/api/models/customer'
-require 'fortnox/api/models/invoice'
-require 'fortnox/api/models/order'
-require 'fortnox/api/models/project'
-require 'fortnox/api/models/unit'
-require 'fortnox/api/models/terms_of_payment'
+require_relative 'models/article'
+require_relative 'models/customer'
+require_relative 'models/invoice'
+require_relative 'models/order'
+require_relative 'models/project'
+require_relative 'models/unit'
+require_relative 'models/terms_of_payment'

data/lib/fortnox/api/repositories/article.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/repositories/base'
-require 'fortnox/api/models/article'
-require 'fortnox/api/mappers/article'
+require_relative 'base'
+require_relative '../models/article'
+require_relative '../mappers/article'
 
 module Fortnox
   module API

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

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 require 'httparty'
-require 'fortnox/api/request_handling'
-require 'fortnox/api/repositories/base/loaders'
-require 'fortnox/api/repositories/base/savers'
+
+require_relative 'base/loaders'
+require_relative 'base/savers'
+require_relative '../request_handling'
 
 module Fortnox
   module API

data/lib/fortnox/api/repositories/customer.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/repositories/base'
-require 'fortnox/api/models/customer'
-require 'fortnox/api/mappers/customer'
+require_relative 'base'
+require_relative '../models/customer'
+require_relative '../mappers/customer'
 
 module Fortnox
   module API

data/lib/fortnox/api/repositories/invoice.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/repositories/base'
-require 'fortnox/api/models/invoice'
-require 'fortnox/api/mappers/invoice'
+require_relative 'base'
+require_relative '../models/invoice'
+require_relative '../mappers/invoice'
 
 module Fortnox
   module API

data/lib/fortnox/api/repositories/order.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/repositories/base'
-require 'fortnox/api/models/order'
-require 'fortnox/api/mappers/order'
+require_relative 'base'
+require_relative '../models/order'
+require_relative '../mappers/order'
 
 module Fortnox
   module API

data/lib/fortnox/api/repositories/project.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/repositories/base'
-require 'fortnox/api/models/project'
-require 'fortnox/api/mappers/project'
+require_relative 'base'
+require_relative '../models/project'
+require_relative '../mappers/project'
 
 module Fortnox
   module API

data/lib/fortnox/api/repositories/terms_of_payment.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/repositories/base'
-require 'fortnox/api/models/terms_of_payment'
-require 'fortnox/api/mappers/terms_of_payment'
+require_relative 'base'
+require_relative '../models/terms_of_payment'
+require_relative '../mappers/terms_of_payment'
 
 module Fortnox
   module API

data/lib/fortnox/api/repositories/unit.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/repositories/base'
-require 'fortnox/api/models/unit'
-require 'fortnox/api/mappers/unit'
+require_relative 'base'
+require_relative '../models/unit'
+require_relative '../mappers/unit'
 
 module Fortnox
   module API

data/lib/fortnox/api/repositories.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/repositories/article'
-require 'fortnox/api/repositories/customer'
-require 'fortnox/api/repositories/invoice'
-require 'fortnox/api/repositories/order'
-require 'fortnox/api/repositories/project'
-require 'fortnox/api/repositories/unit'
-require 'fortnox/api/repositories/terms_of_payment'
+require_relative 'repositories/article'
+require_relative 'repositories/customer'
+require_relative 'repositories/invoice'
+require_relative 'repositories/order'
+require_relative 'repositories/project'
+require_relative 'repositories/unit'
+require_relative 'repositories/terms_of_payment'

data/lib/fortnox/api/types/default_delivery_types.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types'
-
 module Fortnox
   module API
     module Types

data/lib/fortnox/api/types/default_templates.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types'
-
 module Fortnox
   module API
     module Types

data/lib/fortnox/api/types/edi_information.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types'
-
 module Fortnox
   module API
     module Types

data/lib/fortnox/api/types/email_information.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types'
-
 module Fortnox
   module API
     module Types

data/lib/fortnox/api/types/enums.rb

@@ -17,6 +17,13 @@ module Fortnox
             value.to_s.upcase unless value.nil?
           end
         end
+
+        def self.lower_case
+          lambda do |value|
+            return nil if value == ''
+            value.to_s.downcase unless value.nil?
+          end
+        end
       end
 
       ArticleTypes = Types::Strict::String.enum(
@@ -25,15 +32,31 @@ module Fortnox
       DiscountTypes = Types::Strict::String.enum(
         'AMOUNT', 'PERCENT'
       )
-      CURRENT_HOUSEWORK_TYPES = %w[
-        CONSTRUCTION ELECTRICITY GLASSMETALWORK GROUNDDRAINAGEWORK
-        MASONRY PAINTINGWALLPAPERING HVAC MAJORAPPLIANCEREPAIR
-        MOVINGSERVICES ITSERVICES CLEANING TEXTILECLOTHING
-        SNOWPLOWING GARDENING BABYSITTING OTHERCARE OTHERCOSTS
-      ].freeze
-      LEGACY_HOUSEWORK_TYPES = %w[COOKING TUTORING].freeze
+      HOUSEWORK_TYPES = {
+        rot: %w[
+          CONSTRUCTION ELECTRICITY GLASSMETALWORK GROUNDDRAINAGEWORK
+          MASONRY PAINTINGWALLPAPERING HVAC OTHERCOSTS
+        ],
+        rut: %w[
+          MAJORAPPLIANCEREPAIR MOVINGSERVICES ITSERVICES CLEANING
+          TEXTILECLOTHING SNOWPLOWING GARDENING BABYSITTING OTHERCARE
+          OTHERCOSTS
+        ],
+        legacy_rut: %w[COOKING TUTORING]
+      }.freeze
+
+      # TODO: RUT to be added:
+      # HOMEMAINTENANCE FURNISHING TRANSPORTATIONSERVICES
+      # WASHINGANDCAREOFCLOTHING
+      #
+      # TODO: GREEN to be added:
+      # SOLARCELLS STORAGESELFPRODUCEDELECTRICTY
+      # CHARGINGSTATIONELECTRICVEHICLE OTHERCOSTS
+
       HouseworkTypes = Types::Strict::String.enum(
-        *(CURRENT_HOUSEWORK_TYPES + LEGACY_HOUSEWORK_TYPES)
+        *(HOUSEWORK_TYPES[:rot] +
+          HOUSEWORK_TYPES[:rut] +
+          HOUSEWORK_TYPES[:legacy_rut]).uniq
       )
       Currencies = Types::Strict::String.enum(
         'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN',
@@ -67,6 +90,11 @@ module Fortnox
       ProjectStatusTypes = Types::Strict::String.enum(
         'NOTSTARTED', 'ONGOING', 'COMPLETED'
       )
+      # NOTE: Yes, these needs to be in lower case...
+      # I know, this is stupid... Fortnox: why?!
+      TaxReductionTypes = Types::Strict::String.enum(
+        'rot', 'rut', 'green', 'none'
+      )
     end
   end
 end

data/lib/fortnox/api/types/invoice_row.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types/document_row'
+require_relative 'document_row'
 
 module Fortnox
   module API

data/lib/fortnox/api/types/model.rb

@@ -4,7 +4,7 @@ module Fortnox
   module API
     module Types
       class Model < Dry::Struct
-        constructor_type(:schema)
+        transform_types(&:omittable)
 
         def initialize(input_attributes)
           if (missing_key = first_missing_required_key(input_attributes))
@@ -15,23 +15,21 @@ module Fortnox
           super
         end
 
-        def self.is?(*_args) end
-
         private
 
         def missing_keys(attributes)
           non_nil_attributes = attributes.reject { |_, value| value.nil? }
 
           attribute_keys = non_nil_attributes.keys
-          schema_keys =  self.class.schema.keys
+          schema_keys = self.class.schema.keys.map(&:name)
 
           schema_keys - attribute_keys
         end
 
         def first_missing_required_key(attributes)
           missing_keys(attributes).find do |name|
-            attribute = self.class.schema[name]
-            attribute.respond_to?(:options) && attribute.options[:required]
+            attribute = self.class.schema.keys.find { |key| key.name == name }
+            attribute.type.respond_to?(:options) && attribute.type.options[:required]
           end
         end
       end

data/lib/fortnox/api/types/nullable.rb

@@ -6,15 +6,19 @@ module Fortnox
   module API
     module Types
       module Nullable
-        String = Types::Strict::String.optional.constructor { |value| value.to_s unless value.nil? }
-        Float = Types::Strict::Float.optional.constructor { |value| value.to_f unless value.nil? }
-        Integer = Types::Strict::Int.optional.constructor { |value| value.to_i unless value.nil? }
-        Boolean = Types::Bool.optional.constructor { |value| THE_TRUTH.fetch(value) { false } }
-        # TODO: Improve parsing!
-        # In case date parsing fails, ArgumentError is thrown. Currently, it is rescued in Repository::Loaders.find.
-        # That method assumes that the exception is due to invalid argument to the find method, which is not the case
-        # if it is raised from here!
-        Date = Types::Date.optional.constructor { |value| ::Date.parse(value.to_s) unless value.nil? || value == '' }
+        String = Types::Strict::String.optional.constructor { |value| value&.to_s }
+        Float = Types::Strict::Float.optional.constructor { |value| value&.to_f }
+        Integer = Types::Strict::Integer.optional.constructor { |value| value&.to_i }
+        Boolean = Types::Bool.optional.constructor { |value| THE_TRUTH.fetch(value, false) }
+        Date = Types::Date.optional.constructor do |value|
+          next if value.nil? || value == ''
+
+          begin
+            ::Date.parse(value.to_s)
+          rescue ::Date::Error
+            raise Fortnox::API::AttributeError, 'invalid date'
+          end
+        end
       end
     end
   end

data/lib/fortnox/api/types/order_row.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types/document_row'
+require_relative 'document_row'
 
 module Fortnox
   module API

data/lib/fortnox/api/types/required.rb

@@ -4,9 +4,9 @@ module Fortnox
   module API
     module Types
       module Required
-        String = Types::Strict::String.constructor { |value| value.to_s unless value.nil? }.is(:required)
-        Integer = Types::Strict::Int.constructor { |value| value.to_i unless value.nil? }.is(:required)
-        Float = Types::Strict::Float.constructor { |value| value.to_f unless value.nil? }.is(:required)
+        String = Types::Strict::String.constructor { |value| value&.to_s }.is(:required)
+        Integer = Types::Strict::Integer.constructor { |value| value&.to_i }.is(:required)
+        Float = Types::Strict::Float.constructor { |value| value&.to_f }.is(:required)
       end
     end
   end

data/lib/fortnox/api/types/sized.rb

@@ -14,8 +14,8 @@ module Fortnox
 
         module Integer
           def self.[](low, high)
-            Types::Strict::Int.constrained(gteq: low, lteq: high).optional.constructor do |value|
-              value.to_i unless value.nil?
+            Types::Strict::Integer.constrained(gteq: low, lteq: high).optional.constructor do |value|
+              value&.to_i
             end
           end
         end

data/lib/fortnox/api/types.rb

@@ -3,7 +3,7 @@
 require 'dry-struct'
 require 'dry-types'
 require 'countries'
-require 'fortnox/api/types/shim/country_string'
+require_relative 'types/shim/country_string'
 
 module Dry
   module Types
@@ -12,11 +12,7 @@ module Dry
         new_options = option_names.each_with_object({}) do |name, hash|
           hash[name] = true
         end
-        with(new_options)
-      end
-
-      def is?(option_name)
-        @options[option_name]
+        with(**new_options)
       end
     end
   end
@@ -25,20 +21,19 @@ end
 module Fortnox
   module API
     module Types
-      include Dry::Types.module
+      include Dry.Types(default: :nominal)
       ISO3166.configure { |config| config.locales = %i[en sv] }
 
       THE_TRUTH = { true => true, 'true' => true, false => false, 'false' => false }.freeze
 
-      require 'fortnox/api/types/required'
-      require 'fortnox/api/types/defaulted'
-      require 'fortnox/api/types/nullable'
-
-      require 'fortnox/api/types/enums'
+      require_relative 'types/required'
+      require_relative 'types/defaulted'
+      require_relative 'types/nullable'
 
-      require 'fortnox/api/types/sized'
+      require_relative 'types/enums'
+      require_relative 'types/sized'
 
-      AccountNumber = Strict::Int
+      AccountNumber = Strict::Integer
                       .constrained(gteq: 0, lteq: 9999)
                       .optional
                       .constructor do |value|
@@ -57,10 +52,10 @@ module Fortnox
                   next value if value.nil? || value == ''
 
                   # Fortnox only supports Swedish translation of Sweden
-                  next CountryString.new('SE') if value =~ /^s(e$|we|ve)/i
+                  next CountryString.new('SE') if value.match?(/^s(e$|we|ve)/i)
 
                   country = ::ISO3166::Country[value] ||
-                            ::ISO3166::Country.find_country_by_name(value) ||
+                            ::ISO3166::Country.find_country_by_any_name(value) ||
                             ::ISO3166::Country.find_country_by_translated_names(value)
 
                   raise Dry::Types::ConstraintError.new('value violates constraints', value) if country.nil?
@@ -119,13 +114,18 @@ module Fortnox
                           .optional
                           .constructor(EnumConstructors.default)
 
-      require 'fortnox/api/types/model'
-      require 'fortnox/api/types/default_delivery_types'
-      require 'fortnox/api/types/default_templates'
-      require 'fortnox/api/types/email_information'
-      require 'fortnox/api/types/edi_information'
-      require 'fortnox/api/types/invoice_row'
-      require 'fortnox/api/types/order_row'
+      TaxReductionType = Strict::String
+                         .constrained(included_in: TaxReductionTypes.values)
+                         .optional
+                         .constructor(EnumConstructors.lower_case)
+
+      require_relative 'types/model'
+      require_relative 'types/default_delivery_types'
+      require_relative 'types/default_templates'
+      require_relative 'types/email_information'
+      require_relative 'types/edi_information'
+      require_relative 'types/invoice_row'
+      require_relative 'types/order_row'
     end
   end
 end

data/lib/fortnox/api/version.rb

@@ -2,6 +2,6 @@
 
 module Fortnox
   module API
-    VERSION = '0.7.2'
+    VERSION = '0.8.1'
   end
 end

data/lib/fortnox/api.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 require 'set'
-require 'dry-struct'
-require 'fortnox/api/circular_queue'
-require 'fortnox/api/version'
+require 'dry-configurable'
+require 'dry-container'
 require 'logger'
 
+require_relative 'api/circular_queue'
+require_relative 'api/version'
+
 module Fortnox
   module API
     extend Dry::Configurable
@@ -18,29 +20,29 @@ module Fortnox
       access_tokens: nil,
       debugging: false,
       logger: lambda {
-        logger = Logger.new(STDOUT)
+        logger = Logger.new($stdout)
         logger.level = Logger::WARN
         return logger
       }.call
     }.freeze
 
-    setting :base_url, DEFAULT_CONFIGURATION[:base_url]
-    setting :client_secret, DEFAULT_CONFIGURATION[:client_secret]
-    setting :token_store, DEFAULT_CONFIGURATION[:token_store]
-    setting :access_token, DEFAULT_CONFIGURATION[:access_token] do |value|
+    setting :base_url, default: DEFAULT_CONFIGURATION[:base_url]
+    setting :client_secret, default: DEFAULT_CONFIGURATION[:client_secret]
+    setting :token_store, default: DEFAULT_CONFIGURATION[:token_store]
+    setting :access_token, default: DEFAULT_CONFIGURATION[:access_token], constructor: (proc do |value|
       next if value.nil? # nil is a valid unassigned value
       invalid_access_token_format!(value) unless value.is_a?(String)
       config.token_store = { default: value }
       value
-    end
-    setting :access_tokens, DEFAULT_CONFIGURATION[:access_tokens] do |value|
+    end)
+    setting :access_tokens, default: DEFAULT_CONFIGURATION[:access_tokens], constructor: (proc do |value|
       next if value.nil? # nil is a valid unassigned value
       invalid_access_tokens_format!(value) unless value.is_a?(Hash) || value.is_a?(Array)
       config.token_store = value.is_a?(Hash) ? value : { default: value }
       value
-    end
-    setting :debugging, DEFAULT_CONFIGURATION[:debugging], reader: true
-    setting :logger, DEFAULT_CONFIGURATION[:logger], reader: true
+    end)
+    setting :debugging, default: DEFAULT_CONFIGURATION[:debugging], reader: true
+    setting :logger, default: DEFAULT_CONFIGURATION[:logger], reader: true
 
     class Exception < StandardError
     end
@@ -75,6 +77,6 @@ module Fortnox
   end
 end
 
-require 'fortnox/api/models'
-require 'fortnox/api/repositories'
-require 'fortnox/api/mappers'
+require_relative 'api/models'
+require_relative 'api/repositories'
+require_relative 'api/mappers'

data/spec/fortnox/api/circular_queue_spec.rb

@@ -6,11 +6,11 @@ require 'fortnox/api/circular_queue'
 describe Fortnox::API::CircularQueue do
   describe 'start index' do
     context 'when running several times' do
+      subject { Set.new(samples).size }
+
       let(:test_array) { (0..99).to_a }
       let(:samples) { Array.new(100) { described_class.new(*test_array).next } }
 
-      subject { Set.new(samples).size }
-
       # NOTE: This test is not perfect. We are testing that a random generator
       # with 100 items to choose from does not choose the same item 100 times in a row.
       # Yes, the possibility is low, but I thought I should just mention it :)
@@ -22,7 +22,7 @@ describe Fortnox::API::CircularQueue do
 
   describe '#next' do
     context 'when several items in queue' do
-      let(:queue) { described_class.new(1,2,3) }
+      let(:queue) { described_class.new(1, 2, 3) }
       let(:first_round) { Array.new(3) { queue.next } }
       let(:second_round) { Array.new(3) { queue.next } }
 

data/spec/fortnox/api/mappers/base/canonical_name_sym_spec.rb

@@ -6,10 +6,12 @@ require 'fortnox/api/mappers/base/canonical_name_sym'
 describe Fortnox::API::Mapper::CanonicalNameSym do
   describe '.canonical_name_sym' do
     context 'with simple class' do
-      using_test_class do
-        class TestClass
+      before do
+        test_class = Class.new do
           extend Fortnox::API::Mapper::CanonicalNameSym
         end
+
+        stub_const('TestClass', test_class)
       end
 
       subject { TestClass.canonical_name_sym }
@@ -18,12 +20,12 @@ describe Fortnox::API::Mapper::CanonicalNameSym do
     end
 
     context 'when class included in module' do
-      using_test_class do
-        module Something
-          class Test
-            extend Fortnox::API::Mapper::CanonicalNameSym
-          end
+      before do
+        test_class = Class.new do
+          extend Fortnox::API::Mapper::CanonicalNameSym
         end
+
+        stub_const('Something::Test', test_class)
       end
 
       subject { Something::Test.canonical_name_sym }

data/spec/fortnox/api/mappers/default_delivery_types_spec.rb

@@ -8,7 +8,7 @@ require 'fortnox/api/mappers/examples/mapper'
 describe Fortnox::API::Mapper::DefaultDeliveryTypes do
   key_map = {}
 
-  it_behaves_like 'mapper', key_map do
+  it_behaves_like 'mapper', key_map, nil, nil do
     let(:mapper) { described_class.new }
   end
 end

data/spec/fortnox/api/mappers/examples/mapper.rb

@@ -12,7 +12,7 @@ shared_examples_for 'mapper' do |key_map, json_entity_wrapper = nil, json_collec
     describe 'key_map' do
       subject { described_class::KEY_MAP }
 
-      it { is_expected.to eq(key_map) }
+      it { expect(subject).to eq(key_map) }
     end
 
     unless json_entity_wrapper.nil?

data/spec/fortnox/api/models/base_spec.rb

@@ -5,8 +5,8 @@ require 'fortnox/api/models/base'
 require 'fortnox/api/types'
 
 describe Fortnox::API::Model::Base do
-  using_test_classes do
-    class Entity < Fortnox::API::Model::Base
+  let(:entity_class) do
+    Class.new(Fortnox::API::Model::Base) do
       attribute :private, Fortnox::API::Types::String.is(:read_only)
       attribute :string, Fortnox::API::Types::Required::String
       attribute :number, Fortnox::API::Types::Nullable::Integer
@@ -16,15 +16,15 @@ describe Fortnox::API::Model::Base do
 
   describe '.new' do
     context 'with basic attribute' do
-      subject { Entity.new(string: 'Test') }
+      subject { entity_class.new(string: 'Test') }
 
-      it { is_expected.to be_a Entity }
+      it { is_expected.to be_a entity_class }
       it { is_expected.to be_new }
       it { is_expected.not_to be_saved }
     end
 
     context 'without required attribute' do
-      subject { -> { Entity.new({}) } }
+      subject { -> { entity_class.new({}) } }
 
       it { is_expected.to raise_error Fortnox::API::Exception }
       it { is_expected.to raise_error Fortnox::API::MissingAttributeError }
@@ -32,7 +32,7 @@ describe Fortnox::API::Model::Base do
     end
 
     context 'with invalid attribute value' do
-      subject { -> { Entity.new(string: 'Test', account: 13_337) } }
+      subject { -> { entity_class.new(string: 'Test', account: 13_337) } }
 
       it { is_expected.to raise_error Fortnox::API::Exception }
       it { is_expected.to raise_error Fortnox::API::AttributeError }
@@ -41,7 +41,7 @@ describe Fortnox::API::Model::Base do
   end
 
   describe '.update' do
-    let(:original) { Entity.new(string: 'Test') }
+    let(:original) { entity_class.new(string: 'Test') }
 
     context 'with new, simple value' do
       subject { updated_model }
@@ -85,7 +85,7 @@ describe Fortnox::API::Model::Base do
 
     context 'when updating' do
       let(:updated_entity) do
-        saved_entity = Entity.new(string: 'Saved', new: false, unsaved: false)
+        saved_entity = entity_class.new(string: 'Saved', new: false, unsaved: false)
         saved_entity.update(string: 'Updated')
       end