fortnox-api 0.8.2 → 0.9.0

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

@@ -22,8 +22,8 @@ module Fortnox
         # DeliveredQuantity Delivered quantity. 14 digits
         attribute :delivered_quantity, Types::Sized::Float[-9_999_999_999_999.9, 9_999_999_999_999.9]
 
-        # Description Description Row description. 50 characters
-        attribute :description, Types::Sized::String[50]
+        # Description Description Row description.
+        attribute :description, Types::Sized::String[255]
 
         # Discount amount. 12 digits (for amount) / 5 digits (for percent)
         # TODO(hannes): Verify that we can send in more than 5 digits through
@@ -45,7 +45,7 @@ module Fortnox
         attribute :housework_type, Types::HouseworkType
 
         # Price Price per unit. 12 digits
-        attribute :price, Types::Sized::Float[0.0, 99_999_999_999.9]
+        attribute :price, Types::Sized::Float[-9_999_999_999, 99_999_999_999.9]
 
         # Project Code of the project for the row.
         attribute :project, Types::Nullable::String

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

@@ -7,6 +7,7 @@ module Fortnox
         def self.sized(size)
           lambda do |value|
             return nil if value == ''
+
             value.to_s.upcase[0...size] unless value.nil?
           end
         end
@@ -14,14 +15,16 @@ module Fortnox
         def self.default
           lambda do |value|
             return nil if value == ''
-            value.to_s.upcase unless value.nil?
+
+            value&.to_s&.upcase
           end
         end
 
         def self.lower_case
           lambda do |value|
             return nil if value == ''
-            value.to_s.downcase unless value.nil?
+
+            value&.to_s&.downcase
           end
         end
       end
@@ -33,16 +36,29 @@ module Fortnox
         'AMOUNT', 'PERCENT'
       )
       HOUSEWORK_TYPES = {
-        rot: %w[
-          CONSTRUCTION ELECTRICITY GLASSMETALWORK GROUNDDRAINAGEWORK
-          MASONRY PAINTINGWALLPAPERING HVAC OTHERCOSTS
+        rot: [
+          'CONSTRUCTION',
+          'ELECTRICITY',
+          'GLASSMETALWORK',
+          'GROUNDDRAINAGEWORK',
+          'HVAC',
+          'MASONRY',
+          'OTHERCOSTS',
+          'PAINTINGWALLPAPERING'
         ],
-        rut: %w[
-          MAJORAPPLIANCEREPAIR MOVINGSERVICES ITSERVICES CLEANING
-          TEXTILECLOTHING SNOWPLOWING GARDENING BABYSITTING OTHERCARE
-          OTHERCOSTS
+        rut: [
+          'BABYSITTING',
+          'CLEANING',
+          'GARDENING',
+          'ITSERVICES',
+          'MAJORAPPLIANCEREPAIR',
+          'MOVINGSERVICES',
+          'OTHERCARE',
+          'OTHERCOSTS',
+          'SNOWPLOWING',
+          'TEXTILECLOTHING'
         ],
-        legacy_rut: %w[COOKING TUTORING]
+        legacy_rut: ['COOKING', 'TUTORING']
       }.freeze
 
       # TODO: RUT to be added:
@@ -85,7 +101,7 @@ module Fortnox
         'SEVAT', 'SEREVERSEDVAT', 'EUREVERSEDVAT', 'EUVAT', 'EXPORT'
       )
       DefaultDeliveryTypeValues = Types::Strict::String.enum(
-        'PRINT', 'EMAIL', 'PRINTSERVICE'
+        'PRINT', 'EMAIL', 'PRINTSERVICE', 'ELECTRONICINVOICE'
       )
       ProjectStatusTypes = Types::Strict::String.enum(
         'NOTSTARTED', 'ONGOING', 'COMPLETED'

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

@@ -5,7 +5,6 @@ module Fortnox
     module Types
       class Model < Dry::Struct
         transform_types(&:omittable)
-        transform_keys(&:to_sym)
 
         def initialize(input_attributes)
           if (missing_key = first_missing_required_key(input_attributes))
@@ -19,9 +18,7 @@ module Fortnox
         private
 
         def missing_keys(attributes)
-          non_nil_attributes = attributes.reject { |_, value| value.nil? }
-
-          attribute_keys = non_nil_attributes.keys
+          attribute_keys = attributes.compact.keys
           schema_keys = self.class.schema.keys.map(&:name)
 
           schema_keys - attribute_keys

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

@@ -7,7 +7,7 @@ module Fortnox
         module String
           def self.[](size)
             Types::Strict::String.constrained(max_size: size).optional.constructor do |value|
-              value.to_s unless value.nil?
+              value&.to_s
             end
           end
         end
@@ -23,7 +23,7 @@ module Fortnox
         module Float
           def self.[](low, high)
             Types::Strict::Float.constrained(gteq: low, lteq: high).optional.constructor do |value|
-              value.to_f unless value.nil?
+              value&.to_f
             end
           end
         end

data/lib/fortnox/api/types.rb

@@ -38,6 +38,7 @@ module Fortnox
                       .optional
                       .constructor do |value|
                         next nil if value.nil? || value == ''
+
                         value
                       end
 
@@ -92,7 +93,7 @@ module Fortnox
       Email = Strict::String
               .constrained(max_size: 1024, format: /^$|\A[[[:alnum:]]+-_.]+@[\w+-_.]+\.[a-z]+\z/i)
               .optional
-              .constructor { |v| v.to_s.downcase unless v.nil? }
+              .constructor { |v| v&.to_s&.downcase }
 
       HouseworkType = Strict::String
                       .constrained(included_in: HouseworkTypes.values)
@@ -119,6 +120,18 @@ module Fortnox
                          .optional
                          .constructor(EnumConstructors.lower_case)
 
+      # Some Fortnox endpoints returns a String and some returns an Integer...
+      # The documentation says it should be a string, so let's keep it as a string.
+      SalesAccount = Strict::String
+                     .constrained(format: /^[0-9]{4}$/)
+                     .optional
+                     .constructor do |value|
+                       next nil if value == '' || value.nil?
+                       next value.to_s if value.is_a?(::Integer)
+
+                       value
+                     end
+
       require_relative 'types/model'
       require_relative 'types/default_delivery_types'
       require_relative 'types/default_templates'

data/lib/fortnox/api/version.rb

@@ -2,6 +2,6 @@
 
 module Fortnox
   module API
-    VERSION = '0.8.2'
+    VERSION = '0.9.0'
   end
 end

data/lib/fortnox/api.rb

@@ -5,7 +5,6 @@ require 'dry-configurable'
 require 'dry-container'
 require 'logger'
 
-require_relative 'api/circular_queue'
 require_relative 'api/version'
 
 module Fortnox
@@ -14,10 +13,7 @@ module Fortnox
 
     DEFAULT_CONFIGURATION = {
       base_url: 'https://api.fortnox.se/3/',
-      client_secret: nil,
-      token_store: {},
-      access_token: nil,
-      access_tokens: nil,
+      token_url: 'https://apps.fortnox.se/oauth-v1/token',
       debugging: false,
       logger: lambda {
         logger = Logger.new($stdout)
@@ -27,23 +23,18 @@ module Fortnox
     }.freeze
 
     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: 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 :token_url, default: DEFAULT_CONFIGURATION[:token_url]
     setting :debugging, default: DEFAULT_CONFIGURATION[:debugging], reader: true
     setting :logger, default: DEFAULT_CONFIGURATION[:logger], reader: true
 
+    def self.access_token=(token)
+      Thread.current[:access_token] = token
+    end
+
+    def self.access_token
+      Thread.current[:access_token]
+    end
+
     class Exception < StandardError
     end
 
@@ -59,21 +50,10 @@ module Fortnox
     class MissingConfiguration < Fortnox::API::Exception
     end
 
-    Registry = Dry::Container.new
-
-    def self.invalid_access_token_format!(value)
-      raise ArgumentError,
-            'expected a String, but '\
-            "#{value.inspect} is a(n) #{value.class}"
+    class MissingAccessToken < Fortnox::API::Exception
     end
-    private_class_method :invalid_access_token_format!
 
-    def self.invalid_access_tokens_format!(value)
-      raise ArgumentError,
-            'expected a Hash or an Array, but '\
-            "#{value.inspect} is a(n) #{value.class}"
-    end
-    private_class_method :invalid_access_tokens_format!
+    Registry = Dry::Container.new
   end
 end
 

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

@@ -6,6 +6,8 @@ require 'fortnox/api/mappers/base/canonical_name_sym'
 describe Fortnox::API::Mapper::CanonicalNameSym do
   describe '.canonical_name_sym' do
     context 'with simple class' do
+      subject { TestClass.canonical_name_sym }
+
       before do
         test_class = Class.new do
           extend Fortnox::API::Mapper::CanonicalNameSym
@@ -14,12 +16,12 @@ describe Fortnox::API::Mapper::CanonicalNameSym do
         stub_const('TestClass', test_class)
       end
 
-      subject { TestClass.canonical_name_sym }
-
       it { is_expected.to eq(:testclass) }
     end
 
     context 'when class included in module' do
+      subject { Something::Test.canonical_name_sym }
+
       before do
         test_class = Class.new do
           extend Fortnox::API::Mapper::CanonicalNameSym
@@ -28,8 +30,6 @@ describe Fortnox::API::Mapper::CanonicalNameSym do
         stub_const('Something::Test', test_class)
       end
 
-      subject { Something::Test.canonical_name_sym }
-
       it { is_expected.to eq(:test) }
     end
   end

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

@@ -8,14 +8,12 @@ describe Fortnox::API::Mapper::FromJSON do
   include_context 'with JSON conversion'
 
   before do
-    module Test
-      class BaseMapper
-        include Fortnox::API::Mapper::FromJSON
-      end
+    Test::BaseMapper.class_eval do
+      include Fortnox::API::Mapper::FromJSON # rubocop:disable RSpec/DescribedClass
     end
 
-    register_mapper(:categories, Test::CategoryMapper)
-    register_mapper(:designer, Test::ProductDesignerMapper)
+    add_to_registry(:categories, Test::CategoryMapper)
+    add_to_registry(:designer, Test::ProductDesignerMapper)
   end
 
   let(:mapper) { Test::ProductMapper.new }
@@ -26,10 +24,10 @@ describe Fortnox::API::Mapper::FromJSON do
       {
         'Product' => {
           '@url': 'someurl@example.com',
-          'Name': 'Ford Mustang',
-          'VAT': 30_000,
-          'Categories': [{ 'Name' => 'Cars', 'ID' => '1' }, { 'Name' => 'Fast cars', 'ID' => '2' }],
-          'Designer': { 'Name' => 'John Najjar', 'ID' => '23' }
+          Name: 'Ford Mustang',
+          VAT: 30_000,
+          Categories: [{ Name: 'Cars', ID: '1' }, { Name: 'Fast cars', ID: '2' }],
+          Designer: { Name: 'John Najjar', ID: '23' }
         }
       }
     end
@@ -47,7 +45,7 @@ describe Fortnox::API::Mapper::FromJSON do
     # expect( entity_hash[:url] ).to eq 'someurl@example.com'
     # end
 
-    context 'with nested models' do
+    describe 'nested models' do
       let(:expected_nested_model_hash) do
         [{ name: 'Cars', id: '1' }, { name: 'Fast cars', id: '2' }]
       end
@@ -57,7 +55,7 @@ describe Fortnox::API::Mapper::FromJSON do
       end
     end
 
-    context 'with nested model' do
+    describe 'nested model' do
       let(:expected_nested_model_hash) { { name: 'John Najjar', id: '23' } }
 
       specify 'is converted correctly' do

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

@@ -5,73 +5,64 @@ require 'fortnox/api/mappers/base/to_json'
 require 'fortnox/api/mappers/contexts/json_conversion'
 
 describe Fortnox::API::Mapper::ToJSON do
-  # TODO: Following error is risen sometimes when all specs are run:
-  # "NoMethodError: undefined method `call\' for Test::ProductMapper:Class`"
-  it 'should be tested when random error is fixed!'
+  include_context 'with JSON conversion'
 
-  describe 'wrap_entity_json_hash' do
-    it 'should be tested'
+  before do
+    Test::BaseMapper.class_eval do
+      include Fortnox::API::Mapper::ToJSON # rubocop:disable RSpec/DescribedClass
+    end
   end
 
-  # include_context 'with JSON conversion'
+  let(:mapper) { Test::ProductMapper.new }
 
-  # before do
-  #   module Test
-  #     class BaseMapper
-  #       include Fortnox::API::Mapper::ToJSON
-  #     end
-  #   end
-  # end
+  describe '#entity_to_hash' do
+    let(:product) do
+      category1 = Test::Category.new(name: 'Cars', id: '1')
+      category2 = Test::Category.new(name: 'Fast Cars', id: '2')
+      product_designer = Test::ProductDesigner.new(name: 'John Najjar', id: '23')
 
-  # let( :mapper ){ Test::ProductMapper.new }
+      Test::Product.new(url: 'someurl@example.com',
+                        name: 'Ford Mustang',
+                        vat: 30_000.0,
+                        categories: [category1, category2],
+                        designer: product_designer)
+    end
+    let(:keys_to_filter) { [:url] }
+    let(:returned_hash) { mapper.entity_to_hash(product, keys_to_filter) }
+    let(:inner_hash) { returned_hash['Product'] }
 
-  # describe 'entity_to_hash' do
-  #   let( :category1 ){ Test::Category.new( name: 'Cars', id: '1' ) }
-  #   let( :category2 ){ Test::Category.new( name: 'Fast Cars', id: '2' ) }
-  #   let( :product_designer ){ Test::ProductDesigner.new( name: 'John Najjar', id: '23' ) }
-  #   let( :product ) do
-  #     Test::Product.new( url: 'someurl@example.com',
-  #                        name: 'Ford Mustang',
-  #                        vat: 30000.0 ,
-  #                        categories: [category1, category2],
-  #                        designer: product_designer )
-  #   end
-  #   let( :keys_to_filter ){ [:url] }
-  #   let( :returned_hash ){ mapper.entity_to_hash( product, keys_to_filter ) }
-  #   let( :inner_hash ){ returned_hash['Product'] }
+    it 'includes JSON entity wrapper' do
+      expect(returned_hash).to have_key('Product')
+    end
 
-  #   it 'includes JSON entity wrapper' do
-  #     expect( returned_hash ).to have_key( 'Product' )
-  #   end
+    describe 'keys without mapping' do
+      specify 'converts correctly' do
+        expect(inner_hash['Name']).to eq('Ford Mustang')
+      end
+    end
 
-  #   context 'with keys without mapping' do
-  #     specify 'converts correctly' do
-  #       expect( inner_hash['Name'] ).to eq( 'Ford Mustang' )
-  #     end
-  #   end
+    describe 'keys to filter' do
+      specify 'filteres out those keys' do
+        expect(inner_hash).not_to have_key('@url')
+      end
+    end
 
-  #   context 'with keys to filter' do
-  #     specify 'filteres out those keys' do
-  #       expect( inner_hash ).not_to have_key( '@url' )
-  #     end
-  #   end
+    describe 'nested models' do
+      let(:expected_nested_model_hash) do
+        [{ 'Name' => 'Cars', 'ID' => '1' }, { 'Name' => 'Fast Cars', 'ID' => '2' }]
+      end
 
-  #   context 'with nested models' do
-  #     let( :expected_nested_model_hash ) do
-  #       [{"Name" => "Cars", "ID" => "1"}, {"Name" => "Fast Cars", "ID" => "2"}]
-  #     end
+      specify 'are converted correctly' do
+        expect(inner_hash['Categories']).to eq(expected_nested_model_hash)
+      end
+    end
 
-  #     specify 'are converted correctly' do
-  #       expect( inner_hash['Categories'] ).to eq( expected_nested_model_hash )
-  #     end
-  #   end
+    describe 'nested model' do
+      let(:expected_nested_model_hash) { { 'Name' => 'John Najjar', 'ID' => '23' } }
 
-  #   context 'with nested model' do
-  #     let( :expected_nested_model_hash ){ { 'Name' => 'John Najjar', 'ID' => '23' } }
-
-  #     specify 'is converted correctly' do
-  #       expect( inner_hash['Designer'] ).to eq( expected_nested_model_hash )
-  #     end
-  #   end
-  # end
+      specify 'is converted correctly' do
+        expect(inner_hash['Designer']).to eq(expected_nested_model_hash)
+      end
+    end
+  end
 end

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

@@ -99,6 +99,7 @@ describe Fortnox::API::Mapper::Base do
       let(:value) { true }
     end
   end
+
   describe 'falseclass' do
     include_examples 'identity mapper', :falseclass do
       let(:value) { false }
@@ -126,17 +127,15 @@ describe Fortnox::API::Mapper::Base do
 
     describe 'special cases' do
       context 'with SE' do
-        subject { mapper.call('SE') }
-
         it 'translates code to country name in Swedish' do
-          is_expected.to eq('Sverige')
+          expect(mapper.call('SE')).to eq('Sverige')
         end
       end
 
       context 'with nil value' do
         subject { mapper.call(nil) }
 
-        it { is_expected.to eq(nil) }
+        it { is_expected.to be_nil }
       end
 
       context 'with empty string' do
@@ -146,10 +145,8 @@ describe Fortnox::API::Mapper::Base do
       end
 
       context 'with nonsense' do
-        subject { -> { mapper.call('nonsense') } }
-
         it 'is not supported (since input is sanitised) and therefore blows up' do
-          raise_error(NoMethodError)
+          expect { mapper.call('nonsense') }.to raise_error(NoMethodError)
         end
       end
     end

data/spec/fortnox/api/mappers/contexts/json_conversion.rb

@@ -2,56 +2,61 @@
 
 require 'fortnox/api'
 require 'fortnox/api/mappers'
+require 'dry/container/stub'
 
 shared_context 'with JSON conversion' do
-  before do
-    module Test
-      class BaseMapper
-      end
-
-      class CategoryMapper < BaseMapper
-        KEY_MAP = { id: 'ID' }.freeze
-      end
-
-      class ProductDesignerMapper < BaseMapper
-        KEY_MAP = { id: 'ID' }.freeze
-      end
-
-      class ProductMapper < BaseMapper
-        KEY_MAP = {
-          vat: 'VAT',
-          url: '@url' # TODO: How to handle url attribute?
-        }.freeze
-        JSON_ENTITY_WRAPPER = 'Product'
-        JSON_COLLECTION_WRAPPER = 'Products'
-      end
+  include Helpers::Configuration
 
-      class Category < Fortnox::API::Model::Base
+  before do
+    stub_const('Test::BaseMapper', Class.new)
+
+    stub_const('Test::CategoryMapper', Class.new(Test::BaseMapper))
+    stub_const('Test::CategoryMapper::KEY_MAP', { id: 'ID' }.freeze)
+
+    stub_const('Test::ProductDesignerMapper', Class.new(Test::BaseMapper))
+    stub_const('Test::ProductDesignerMapper::KEY_MAP', { id: 'ID' }.freeze)
+
+    stub_const('Test::ProductMapper', Class.new(Test::BaseMapper))
+    stub_const(
+      'Test::ProductMapper::KEY_MAP',
+      {
+        vat: 'VAT',
+        url: '@url' # TODO: How to handle url attribute?
+      }.freeze
+    )
+    stub_const('Test::ProductMapper::JSON_ENTITY_WRAPPER', 'Product')
+    stub_const('Test::ProductMapper::JSON_COLLECTION_WRAPPER', 'Products')
+
+    stub_const(
+      'Test::Category',
+      Class.new(Fortnox::API::Model::Base) do
         attribute :name, 'strict.string'
         attribute :id, 'strict.string'
       end
+    )
 
-      class ProductDesigner < Fortnox::API::Model::Base
+    stub_const(
+      'Test::ProductDesigner',
+      Class.new(Fortnox::API::Model::Base) do
         attribute :name, 'strict.string'
         attribute :id, 'strict.string'
       end
+    )
 
-      class Product < Fortnox::API::Model::Base
+    stub_const(
+      'Test::Product',
+      Class.new(Fortnox::API::Model::Base) do
         attribute :url, 'strict.string'
         attribute :name, 'strict.string'
         attribute :vat, 'strict.float'
         attribute :categories, Dry::Types['coercible.array'].of(Test::Category)
         attribute :designer, Test::ProductDesigner
       end
-    end
-
-    def register_mapper(mapper_sym, mapper)
-      return if Fortnox::API::Registry.key? mapper_sym
-      Fortnox::API::Registry.register(mapper_sym, mapper)
-    end
+    )
 
-    register_mapper(:category, Test::CategoryMapper)
-    register_mapper(:productdesigner, Test::ProductDesignerMapper)
-    register_mapper(:product, Test::ProductMapper)
+    Fortnox::API::Registry.enable_stubs!
+    add_to_registry(:category, Test::CategoryMapper)
+    add_to_registry(:productdesigner, Test::ProductDesignerMapper)
+    add_to_registry(:product, Test::ProductMapper)
   end
 end

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

@@ -8,7 +8,6 @@ require 'fortnox/api/mappers/examples/mapper'
 
 module Fortnox
   module API
-    # Shhh Rubocop, we don't need a comment here ... Really
     module Mapper
       describe Unit do
         context 'when mapping model' do
@@ -17,13 +16,13 @@ module Fortnox
           let(:model_hash) { { code: 'lbs', description: 'Pounds' } }
 
           describe '#entity_to_hash' do
-            subject { Unit.new.entity_to_hash(model, {}) }
+            subject { described_class.new.entity_to_hash(model, {}) }
 
             it { is_expected.to eq(serialised_model_hash) }
           end
 
           describe '#wrapped_json_hash_to_entity_hash' do
-            subject { Unit.new.wrapped_json_hash_to_entity_hash(serialised_model_hash) }
+            subject { described_class.new.wrapped_json_hash_to_entity_hash(serialised_model_hash) }
 
             it { is_expected.to eq(model_hash) }
           end
@@ -46,7 +45,7 @@ module Fortnox
           end
 
           describe '#wrapped_json_collection_to_entities_hash' do
-            subject { Unit.new.wrapped_json_collection_to_entities_hash(serialised_collection_hash) }
+            subject { described_class.new.wrapped_json_collection_to_entities_hash(serialised_collection_hash) }
 
             it { is_expected.to eq(collection_hash) }
           end