fortnox-api 0.6.2 → 0.8.0

data/lib/fortnox/api/mappers/value/identity.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Fortnox
+  module API
+    module Mapper
+      Identity = ->(value) { value }
+
+      Registry.register(:integer, Fortnox::API::Mapper::Identity)
+      Registry.register(:int, Fortnox::API::Mapper::Identity)
+      Registry.register(:float, Fortnox::API::Mapper::Identity)
+      Registry.register(:string, Fortnox::API::Mapper::Identity)
+      Registry.register(:boolean, Fortnox::API::Mapper::Identity)
+      Registry.register(:falseclass, Fortnox::API::Mapper::Identity)
+      Registry.register(:trueclass, Fortnox::API::Mapper::Identity)
+      Registry.register(:nilclass, Fortnox::API::Mapper::Identity)
+    end
+  end
+end

data/lib/fortnox/api/models/document.rb

@@ -44,7 +44,7 @@ module Fortnox
         attribute :contribution_value, Types::Nullable::Float.is(:read_only)
 
         # Country Country for the document address.
-        attribute :country, Types::CountryCode
+        attribute :country, Types::Country
 
         # CostCenter Code of the cost center.
         attribute :cost_center, Types::Nullable::String
@@ -74,7 +74,7 @@ module Fortnox
         attribute :delivery_city, Types::Sized::String[1024]
 
         # DeliveryCountry Country for the document delivery address.
-        attribute :delivery_country, Types::CountryCode
+        attribute :delivery_country, Types::Country
 
         # DeliveryDate Date of delivery.
         attribute :delivery_date, Types::Nullable::Date
@@ -109,7 +109,7 @@ module Fortnox
         # HouseWork If there is any row of the document marked "housework".
         attribute :housework, Types::Nullable::Boolean.is(:read_only)
 
-        attribute :labels, Types::Strict::Array.member(Label)
+        attribute :labels, Types::Strict::Array.of(Label)
 
         # Net Net amount
         attribute :net, Types::Nullable::Float.is(:read_only)
@@ -154,6 +154,9 @@ module Fortnox
         # TaxReduction The amount of tax reduction.
         attribute :tax_reduction, Types::Nullable::Integer.is(:read_only)
 
+        # TaxReductionType Tax Reduction Type
+        attribute :tax_reduction_type, Types::TaxReductionType
+
         # TermsOfDelivery Code of the terms of delivery.
         attribute :terms_of_delivery, Types::Nullable::String
 

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

@@ -50,7 +50,7 @@ module Fortnox
         attribute :invoice_period_end, Types::Nullable::Date.is(:read_only)
 
         # InvoiceRows Separate object
-        attribute :invoice_rows, Types::Strict::Array.member(Types::InvoiceRow)
+        attribute :invoice_rows, Types::Strict::Array.of(Types::InvoiceRow)
 
         # InvoiceType The type of invoice.
         attribute :invoice_type, Types::Nullable::String

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

@@ -20,7 +20,7 @@ module Fortnox
         attribute :order_date, Types::Nullable::Date
 
         # OrderRows Separate object
-        attribute :order_rows, Types::Strict::Array.member(Types::OrderRow)
+        attribute :order_rows, Types::Strict::Array.of(Types::OrderRow)
       end
     end
   end

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

@@ -16,10 +16,10 @@ module Fortnox
 
         HTTParty::Parser::SupportedFormats['text/html'] = :json
 
-        DEFAULT_HEADERS = {
+        headers(
           'Content-Type' => 'application/json',
           'Accept' => 'application/json'
-        }.freeze
+        )
 
         HTTP_METHODS = %i[get put post delete].freeze
 
@@ -31,21 +31,19 @@ module Fortnox
         end
 
         HTTP_METHODS.each do |method|
-          define_method method do |*args|
-            headers['Access-Token'] = next_access_token
+          define_method method do |path, options = {}, &block|
+            provided_headers = options[:headers] || {}
+            provided_headers['Client-Secret'] = client_secret
+            provided_headers['Access-Token'] = next_access_token
+            options[:headers] = provided_headers
+            options[:base_uri] ||= base_url
             execute do |remote|
-              remote.send(method, *args)
+              remote.send(method, path, options, &block)
             end
           end
         end
 
         def initialize(keys_filtered_on_save: [:url], token_store: :default)
-          self.class.base_uri(base_url)
-
-          self.headers = DEFAULT_HEADERS.merge(
-            'Client-Secret' => client_secret
-          )
-
           @keys_filtered_on_save = keys_filtered_on_save
           @token_store = token_store
           @mapper = Registry[Mapper::Base.canonical_name_sym(self.class::MODEL)].new

data/lib/fortnox/api/request_handling.rb

@@ -26,7 +26,6 @@ module Fortnox
         end
 
         def execute
-          self.class.set_headers(@headers)
           response = yield(self.class)
           validate_and_parse response
         end

data/lib/fortnox/api/types.rb

@@ -2,6 +2,8 @@
 
 require 'dry-struct'
 require 'dry-types'
+require 'countries'
+require 'fortnox/api/types/shim/country_string'
 
 module Dry
   module Types
@@ -24,6 +26,7 @@ module Fortnox
   module API
     module Types
       include Dry::Types.module
+      ISO3166.configure { |config| config.locales = %i[en sv] }
 
       THE_TRUTH = { true => true, 'true' => true, false => false, 'false' => false }.freeze
 
@@ -38,16 +41,45 @@ module Fortnox
       AccountNumber = Strict::Int
                       .constrained(gteq: 0, lteq: 9999)
                       .optional
+                      .constructor do |value|
+                        next nil if value.nil? || value == ''
+                        value
+                      end
 
       ArticleType = Strict::String
                     .constrained(included_in: ArticleTypes.values)
                     .optional
                     .constructor(EnumConstructors.default)
 
+      Country = Strict::String
+                .optional
+                .constructor do |value|
+                  next value if value.nil? || value == ''
+
+                  # Fortnox only supports Swedish translation of Sweden
+                  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_translated_names(value)
+
+                  raise Dry::Types::ConstraintError.new('value violates constraints', value) if country.nil?
+
+                  CountryString.new(country.alpha2)
+                end
+
       CountryCode = Strict::String
-                    .constrained(included_in: CountryCodes.values)
                     .optional
-                    .constructor(EnumConstructors.sized(2))
+                    .constructor do |value|
+                      next value if value.nil? || value == ''
+
+                      country = ::ISO3166::Country[value]
+
+                      raise Dry::Types::ConstraintError.new('value violates constraints', value) if country.nil?
+
+                      country.alpha2
+                    end
+
       Currency = Strict::String
                  .constrained(included_in: Currencies.values)
                  .optional
@@ -63,7 +95,7 @@ module Fortnox
                      .constructor(EnumConstructors.default)
 
       Email = Strict::String
-              .constrained(max_size: 1024, format: /^$|\A[\w+-_.]+@[\w+-_.]+\.[a-z]+\z/i)
+              .constrained(max_size: 1024, format: /^$|\A[[[:alnum:]]+-_.]+@[\w+-_.]+\.[a-z]+\z/i)
               .optional
               .constructor { |v| v.to_s.downcase unless v.nil? }
 
@@ -87,6 +119,11 @@ module Fortnox
                           .optional
                           .constructor(EnumConstructors.default)
 
+      TaxReductionType = Strict::String
+                         .constrained(included_in: TaxReductionTypes.values)
+                         .optional
+                         .constructor(EnumConstructors.lower_case)
+
       require 'fortnox/api/types/model'
       require 'fortnox/api/types/default_delivery_types'
       require 'fortnox/api/types/default_templates'

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,38 +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)
-      )
-      CountryCodes = Types::Strict::String.enum(
-        'AF', 'AX', 'AL', 'DZ', 'AS', 'AD', 'AO', 'AI', 'AQ', 'AG', 'AR', 'AM',
-        'AW', 'AU', 'AT', 'AZ', 'BS', 'BH', 'BD', 'BB', 'BY', 'BE', 'BZ', 'BJ',
-        'BM', 'BT', 'BO', 'BQ', 'BA', 'BW', 'BV', 'BR', 'IO', 'BN', 'BG', 'BF',
-        'BI', 'CV', 'KH', 'CM', 'CA', 'KY', 'CF', 'TD', 'CL', 'CN', 'CX', 'CC',
-        'CO', 'KM', 'CG', 'CD', 'CK', 'CR', 'CI', 'HR', 'CU', 'CW', 'CY', 'CZ',
-        'DK', 'DJ', 'DM', 'DO', 'EC', 'EG', 'SV', 'GQ', 'ER', 'EE', 'ET', 'FK',
-        'FO', 'FJ', 'FI', 'FR', 'GF', 'PF', 'TF', 'GA', 'GM', 'GE', 'DE', 'GH',
-        'GI', 'GR', 'GL', 'GD', 'GP', 'GU', 'GT', 'GG', 'GN', 'GW', 'GY', 'HT',
-        'HM', 'VA', 'HN', 'HK', 'HU', 'IS', 'IN', 'ID', 'IR', 'IQ', 'IE', 'IM',
-        'IL', 'IT', 'JM', 'JP', 'JE', 'JO', 'KZ', 'KE', 'KI', 'KP', 'KR', 'KW',
-        'KG', 'LA', 'LV', 'LB', 'LS', 'LR', 'LY', 'LI', 'LT', 'LU', 'MO', 'MK',
-        'MG', 'MW', 'MY', 'MV', 'ML', 'MT', 'MH', 'MQ', 'MR', 'MU', 'YT', 'MX',
-        'FM', 'MD', 'MC', 'MN', 'ME', 'MS', 'MA', 'MZ', 'MM', 'NA', 'NR', 'NP',
-        'NL', 'NC', 'NZ', 'NI', 'NE', 'NG', 'NU', 'NF', 'MP', 'NO', 'OM', 'PK',
-        'PW', 'PS', 'PA', 'PG', 'PY', 'PE', 'PH', 'PN', 'PL', 'PT', 'PR', 'QA',
-        'RE', 'RO', 'RU', 'RW', 'BL', 'SH', 'KN', 'LC', 'MF', 'PM', 'VC', 'WS',
-        'SM', 'ST', 'SA', 'SN', 'RS', 'SC', 'SL', 'SG', 'SX', 'SK', 'SI', 'SB',
-        'SO', 'ZA', 'GS', 'SS', 'ES', 'LK', 'SD', 'SR', 'SJ', 'SZ', 'SE', 'CH',
-        'SY', 'TW', 'TJ', 'TZ', 'TH', 'TL', 'TG', 'TK', 'TO', 'TT', 'TN', 'TR',
-        'TM', 'TC', 'TV', 'UG', 'UA', 'AE', 'GB', 'US', 'UM', 'UY', 'UZ', 'VU',
-        'VE', 'VN', 'VG', 'VI', 'WF', 'EH', 'YE', 'ZM', 'ZW'
+        *(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',
@@ -90,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/shim/country_string.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Fortnox
+  module API
+    module Types
+      class CountryString < String
+      end
+    end
+  end
+end

data/lib/fortnox/api/version.rb

@@ -2,6 +2,6 @@
 
 module Fortnox
   module API
-    VERSION = '0.6.2'
+    VERSION = '0.8.0'
   end
 end

data/spec/fortnox/api/circular_queue_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+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 } }
+
+      # 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 :)
+      it 'does not start with the same item each time' do
+        is_expected.to be > 1
+      end
+    end
+  end
+
+  describe '#next' do
+    context 'when several items in queue' do
+      let(:queue) { described_class.new(1, 2, 3) }
+      let(:first_round) { Array.new(3) { queue.next } }
+      let(:second_round) { Array.new(3) { queue.next } }
+
+      it 'circulates the items' do
+        first_round
+        expect(first_round[0]).to eq(queue.next)
+      end
+
+      it 'circulates the items in the same order each time' do
+        expect(first_round).to eq(second_round)
+      end
+
+      it 'circulates through given input' do
+        expect(first_round.sort).to eq([1, 2, 3])
+      end
+    end
+
+    context 'when only one item in queue' do
+      let(:queue) { described_class.new(1) }
+
+      it 'circulates the item' do
+        first_item = queue.next
+        expect(first_item).to eq(queue.next)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+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
+          extend Fortnox::API::Mapper::CanonicalNameSym
+        end
+      end
+
+      subject { TestClass.canonical_name_sym }
+
+      it { is_expected.to eq(:testclass) }
+    end
+
+    context 'when class included in module' do
+      using_test_class do
+        module Something
+          class Test
+            extend Fortnox::API::Mapper::CanonicalNameSym
+          end
+        end
+      end
+
+      subject { Something::Test.canonical_name_sym }
+
+      it { is_expected.to eq(:test) }
+    end
+  end
+end

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

@@ -35,6 +35,12 @@ describe Fortnox::API::Mapper::Base do
     end
   end
 
+  describe 'integer' do
+    include_examples 'identity mapper', :integer do
+      let(:value) { Fortnox::API::Types::Nullable::Integer[1337] }
+    end
+  end
+
   describe 'float' do
     include_examples 'identity mapper', :float do
       let(:value) { Fortnox::API::Types::Nullable::Float[13.37] }
@@ -111,57 +117,41 @@ describe Fortnox::API::Mapper::Base do
     end
   end
 
-  describe 'AccountNumber' do
-    include_examples 'identity mapper', :account_number do
-      let(:value) { Fortnox::API::Types::AccountNumber[1234] }
-    end
-  end
+  describe 'Country' do
+    subject { mapper.call('GB') }
 
-  describe 'CountryCode' do
-    include_examples 'identity mapper', :country_code do
-      let(:value) { Fortnox::API::Types::CountryCode['SE'] }
-    end
-  end
+    let(:mapper) { Fortnox::API::Registry[:countrystring] }
 
-  describe 'Currency' do
-    include_examples 'identity mapper', :currency do
-      let(:value) { Fortnox::API::Types::Currency['SEK'] }
-    end
-  end
+    it { is_expected.to eq('United Kingdom') }
 
-  describe 'CustomerType' do
-    include_examples 'identity mapper', :customer_type do
-      let(:value) { Fortnox::API::Types::CustomerType['PRIVATE'] }
-    end
-  end
+    describe 'special cases' do
+      context 'with SE' do
+        subject { mapper.call('SE') }
 
-  describe 'DiscountType' do
-    include_examples 'identity mapper', :discount_type do
-      let(:value) { Fortnox::API::Types::DiscountType['PERCENT'] }
-    end
-  end
+        it 'translates code to country name in Swedish' do
+          is_expected.to eq('Sverige')
+        end
+      end
 
-  describe 'Email' do
-    include_examples 'identity mapper', :email do
-      let(:value) { Fortnox::API::Types::Email['email@example.com'] }
-    end
-  end
+      context 'with nil value' do
+        subject { mapper.call(nil) }
 
-  describe 'HouseworkType' do
-    include_examples 'identity mapper', :housework_type do
-      let(:value) { Fortnox::API::Types::HouseworkType['CONSTRUCTION'] }
-    end
-  end
+        it { is_expected.to eq(nil) }
+      end
 
-  describe 'VATType' do
-    include_examples 'identity mapper', :vat_type do
-      let(:value) { Fortnox::API::Types::VATType['SEVAT'] }
-    end
-  end
+      context 'with empty string' do
+        subject { mapper.call('') }
+
+        it { is_expected.to eq('') }
+      end
 
-  describe '#canonical_name_sym' do
-    subject { described_class.canonical_name_sym }
+      context 'with nonsense' do
+        subject { -> { mapper.call('nonsense') } }
 
-    it { is_expected.to eq(described_class.name.split('::').last.downcase.to_sym) }
+        it 'is not supported (since input is sanitised) and therefore blows up' do
+          raise_error(NoMethodError)
+        end
+      end
+    end
   end
 end