fortnox-api 0.8.2 → 0.9.0

data/spec/fortnox/api/types/housework_types_spec.rb

@@ -7,98 +7,94 @@ require 'fortnox/api/repositories/order'
 require 'fortnox/api/models/order'
 require 'fortnox/api/types/order_row'
 
-# rubocop:disable RSpec/DescribeClass
 describe 'HouseworkTypes', integration: true do
   include Helpers::Configuration
+  include Helpers::Repositories
 
-  before { set_api_test_configuration }
+  before do
+    set_api_test_configuration
+    stub_const('TYPE_ROT', Fortnox::API::Types::TaxReductionTypes['rot'])
+    stub_const('TYPE_RUT', Fortnox::API::Types::TaxReductionTypes['rut'])
+  end
 
   let(:repository) { Fortnox::API::Repository::Order.new }
 
   shared_examples_for 'housework type' do |type, tax_reduction_type, legacy: false, housework: true|
-    subject do
-      cassette = "orders/housework_type_#{type.downcase}"
-      -> { VCR.use_cassette(cassette) { repository.save(document) } }
-    end
-
     let(:document) do
       Fortnox::API::Model::Order.new(
         customer_number: '1',
-        tax_reduction_type: tax_reduction_type,
+        tax_reduction_type: Object.const_get(tax_reduction_type),
         order_rows: [
           Fortnox::API::Types::OrderRow.new(
             ordered_quantity: 1,
-            article_number: '0000',
+            article_number: '101',
             housework_type: Fortnox::API::Types::HouseworkTypes[type],
             housework: housework
           )
         ]
       )
     end
+    let(:save) do
+      -> { VCR.use_cassette("orders/housework_type_#{type.downcase}") { repository.save(document) } }
+    end
 
     context "when creating an OrderRow with housework_type set to #{type}" do
       if legacy
-        let(:error_message) { 'Skattereduktion för den valda typen av husarbete har upphört.' }
+        let(:error_message) { /Skattereduktion för den valda typen av husarbete har upphört/ }
 
-        it 'raises an error' do
-          is_expected.to raise_error(Fortnox::API::RemoteServerError, error_message)
-        end
+        specify { expect { save.call }.to raise_error(Fortnox::API::RemoteServerError, error_message) }
       else
-        it { is_expected.not_to raise_error }
+        specify { expect { save.call }.not_to raise_error }
       end
     end
   end
 
-  TYPE_ROT = Fortnox::API::Types::TaxReductionTypes['rot']
-  TYPE_RUT = Fortnox::API::Types::TaxReductionTypes['rut']
-
-  it_behaves_like 'housework type', 'CONSTRUCTION', TYPE_ROT
-  it_behaves_like 'housework type', 'ELECTRICITY', TYPE_ROT
-  it_behaves_like 'housework type', 'GLASSMETALWORK', TYPE_ROT
-  it_behaves_like 'housework type', 'GROUNDDRAINAGEWORK', TYPE_ROT
-  it_behaves_like 'housework type', 'MASONRY', TYPE_ROT
-  it_behaves_like 'housework type', 'PAINTINGWALLPAPERING', TYPE_ROT
-  it_behaves_like 'housework type', 'HVAC', TYPE_ROT
-  it_behaves_like 'housework type', 'OTHERCOSTS', TYPE_ROT, housework: false
-
-  it_behaves_like 'housework type', 'MAJORAPPLIANCEREPAIR', TYPE_RUT
-  it_behaves_like 'housework type', 'MOVINGSERVICES', TYPE_RUT
-  it_behaves_like 'housework type', 'ITSERVICES', TYPE_RUT
-  it_behaves_like 'housework type', 'CLEANING', TYPE_RUT
-  it_behaves_like 'housework type', 'TEXTILECLOTHING', TYPE_RUT
-  it_behaves_like 'housework type', 'SNOWPLOWING', TYPE_RUT
-  it_behaves_like 'housework type', 'GARDENING', TYPE_RUT
-  it_behaves_like 'housework type', 'BABYSITTING', TYPE_RUT
-  it_behaves_like 'housework type', 'OTHERCARE', TYPE_RUT
-  it_behaves_like 'housework type', 'OTHERCOSTS', TYPE_RUT, housework: false
-
+  it_behaves_like 'housework type', 'CONSTRUCTION', 'TYPE_ROT'
+  it_behaves_like 'housework type', 'ELECTRICITY', 'TYPE_ROT'
+  it_behaves_like 'housework type', 'GLASSMETALWORK', 'TYPE_ROT'
+  it_behaves_like 'housework type', 'GROUNDDRAINAGEWORK', 'TYPE_ROT'
+  it_behaves_like 'housework type', 'MASONRY', 'TYPE_ROT'
+  it_behaves_like 'housework type', 'PAINTINGWALLPAPERING', 'TYPE_ROT'
+  it_behaves_like 'housework type', 'HVAC', 'TYPE_ROT'
+  it_behaves_like 'housework type', 'OTHERCOSTS', 'TYPE_ROT', housework: false
+
+  it_behaves_like 'housework type', 'MAJORAPPLIANCEREPAIR', 'TYPE_RUT'
+  it_behaves_like 'housework type', 'MOVINGSERVICES', 'TYPE_RUT'
+  it_behaves_like 'housework type', 'ITSERVICES', 'TYPE_RUT'
+  it_behaves_like 'housework type', 'CLEANING', 'TYPE_RUT'
+  it_behaves_like 'housework type', 'TEXTILECLOTHING', 'TYPE_RUT'
+  it_behaves_like 'housework type', 'SNOWPLOWING', 'TYPE_RUT'
+  it_behaves_like 'housework type', 'GARDENING', 'TYPE_RUT'
+  it_behaves_like 'housework type', 'BABYSITTING', 'TYPE_RUT'
+  it_behaves_like 'housework type', 'OTHERCARE', 'TYPE_RUT'
+  it_behaves_like 'housework type', 'OTHERCOSTS', 'TYPE_RUT', housework: false
+
+  # rubocop:disable RSpec/RepeatedExample
   # rubocop:disable RSpec/RepeatedDescription
-  pending 'to be added' do
-    raise Exception, 'Will be supported 2021-01-01'
+  it 'will soon be added' do
+    pending 'todo'
+    raise StandardError, 'Will be supported 2021-01-01'
     # it_behaves_like 'housework type', 'HOMEMAINTENANCE', TYPE_RUT
     # it_behaves_like 'housework type', 'FURNISHING', TYPE_RUT
     # it_behaves_like 'housework type', 'TRANSPORTATIONSERVICES', TYPE_RUT
     # it_behaves_like 'housework type', 'WASHINGANDCAREOFCLOTHING', TYPE_RUT
   end
 
-  pending 'to be added' do
-    raise Exception, 'Will be supported 2021-01-01'
+  it 'will soon be added' do
+    pending 'todo'
+    raise StandardError, 'Will be supported 2021-01-01'
     # it_behaves_like 'housework type', 'SOLARCELLS', TYPE_GREEN
     # it_behaves_like 'housework type', 'STORAGESELFPRODUCEDELECTRICTY', TYPE_GREEN
     # it_behaves_like 'housework type', 'CHARGINGSTATIONELECTRICVEHICLE', TYPE_GREEN
     # it_behaves_like 'housework type', 'OTHERCOSTS', TYPE_GREEN
   end
+  # rubocop:enable RSpec/RepeatedExample
   # rubocop:enable RSpec/RepeatedDescription
 
-  it_behaves_like 'housework type', 'COOKING', TYPE_RUT, legacy: true
-  it_behaves_like 'housework type', 'TUTORING', TYPE_RUT, legacy: true
+  it_behaves_like 'housework type', 'COOKING', 'TYPE_RUT', legacy: true
+  it_behaves_like 'housework type', 'TUTORING', 'TYPE_RUT', legacy: true
 
   describe 'with OTHERCOSTS' do
-    subject do
-      cassette = 'orders/housework_othercoses_invalid'
-      -> { VCR.use_cassette(cassette) { repository.save(document) } }
-    end
-
     let(:document) do
       Fortnox::API::Model::Order.new(
         customer_number: '1',
@@ -106,7 +102,7 @@ describe 'HouseworkTypes', integration: true do
         order_rows: [
           Fortnox::API::Types::OrderRow.new(
             ordered_quantity: 1,
-            article_number: '0000',
+            article_number: '101',
             housework_type: Fortnox::API::Types::HouseworkTypes['OTHERCOSTS'],
             housework: true
           )
@@ -114,19 +110,16 @@ describe 'HouseworkTypes', integration: true do
       )
     end
 
-    let(:error_message) { 'Kan inte sätta typen övrig kostnad på en rad markerad som husarbete.' }
+    let(:error_message) { /Kan inte sätta typen övrig kostnad på en rad markerad som husarbete/ }
 
     it "can't have housework set to true" do
-      is_expected.to raise_error(Fortnox::API::RemoteServerError, error_message)
+      expect do
+        VCR.use_cassette('orders/housework_othercoses_invalid') { repository.save(document) }
+      end.to raise_error(Fortnox::API::RemoteServerError, error_message)
     end
   end
 
   describe 'with wrong tax reduction type' do
-    subject do
-      cassette = 'orders/housework_invalid_tax_reduction_type'
-      -> { VCR.use_cassette(cassette) { repository.save(document) } }
-    end
-
     let(:type) { 'CONSTRUCTION' }
     let(:document) do
       Fortnox::API::Model::Order.new(
@@ -135,7 +128,7 @@ describe 'HouseworkTypes', integration: true do
         order_rows: [
           Fortnox::API::Types::OrderRow.new(
             ordered_quantity: 1,
-            article_number: '0000',
+            article_number: '101',
             housework_type: Fortnox::API::Types::HouseworkTypes[type],
             housework: true
           )
@@ -144,13 +137,13 @@ describe 'HouseworkTypes', integration: true do
     end
 
     let(:error_message) do
-      "Dokument med skattereduktionstypen '#{TYPE_RUT}' " \
-      "får inte innehålla rader med husarbetestypen '#{type}'."
+      /Dokument med skattereduktionstypen '#{TYPE_RUT}' får inte innehålla rader med husarbetestypen '#{type}'/
     end
 
     it 'raises an error' do
-      is_expected.to raise_error(Fortnox::API::RemoteServerError, error_message)
+      expect do
+        VCR.use_cassette('orders/housework_invalid_tax_reduction_type') { repository.save(document) }
+      end.to raise_error(Fortnox::API::RemoteServerError, error_message)
     end
   end
 end
-# rubocop:enable RSpec/DescribeClass

data/spec/fortnox/api/types/model_spec.rb

@@ -17,9 +17,7 @@ RSpec.describe Fortnox::API::Types::Model do
     end
 
     describe "User inheriting from #{described_class}" do
-      subject { -> { TypesModelUser.new(args) } }
-
-      it { is_expected.to raise_error(error) }
+      specify { expect { TypesModelUser.new(args) }.to raise_error(error) }
     end
   end
 
@@ -30,8 +28,6 @@ RSpec.describe Fortnox::API::Types::Model do
   end
 
   context 'when omitting optional keys' do
-    subject { -> { User.new } }
-
     before do
       stub_const('Types::Nullable::String', Dry::Types['strict.string'].optional)
 
@@ -42,32 +38,12 @@ RSpec.describe Fortnox::API::Types::Model do
       stub_const('User', user_class)
     end
 
-    it { is_expected.not_to raise_error }
+    specify { expect { User.new }.not_to raise_error }
 
     describe 'optional attribute' do
       subject { User.new.optional_string }
 
-      it { is_expected.to be nil }
-    end
-  end
-
-  context 'with required keys' do
-    before do
-      stub_const('Types::Age', Dry::Types['strict.integer'].constrained(gt: 18).is(:required))
-
-      test_class = Class.new(Fortnox::API::Types::Model) do
-        attribute :age, Types::Age
-      end
-
-      stub_const('Model', test_class)
-    end
-
-    it 'does not raise error' do
-      expect { Model.new(age: 20) }.not_to raise_error
-    end
-
-    it 'supports string keys' do
-      expect { Model.new('age' => 20) }.not_to raise_error
+      it { is_expected.to be_nil }
     end
   end
 end

data/spec/fortnox/api/types/order_row_spec.rb

@@ -5,10 +5,10 @@ require 'fortnox/api/types/order_row'
 require 'fortnox/api/types/examples/document_row'
 
 RSpec.describe Fortnox::API::Types::OrderRow, type: :type do
-  valid_hash = { ordered_quantity: 10.5 }
-
   subject { described_class }
 
+  valid_hash = { ordered_quantity: 10.5 }
+
   it { is_expected.to require_attribute(:ordered_quantity, valid_hash) }
 
   it_behaves_like 'DocumentRow', valid_hash

data/spec/fortnox/api/types/required_spec.rb

@@ -8,22 +8,16 @@ describe Fortnox::API::Types::Required, type: :type do
   before { stub_const('TestClass', Class.new(Dry::Struct)) }
 
   shared_examples_for 'required attribute' do |_type|
-    subject { -> { TestClass.new({}) } }
-
-    let(:error_message) do
-      "[#{TestClass}.new] #{:required_attribute.inspect} is missing in Hash input"
-    end
-
-    it 'raises an error' do
-      is_expected.to raise_error(Dry::Struct::Error, error_message)
-    end
+    let(:error_message) { "[#{TestClass}.new] #{:required_attribute.inspect} is missing in Hash input" }
+    specify { expect { TestClass.new({}) }.to raise_error(Dry::Struct::Error, error_message) }
   end
 
   describe 'String' do
     before do
-      class TestClass
+      test_class = Class.new(TestClass) do
         attribute :required_attribute, Fortnox::API::Types::Required::String
       end
+      stub_const('TestClass', test_class)
     end
 
     include_examples 'required attribute', String
@@ -31,9 +25,10 @@ describe Fortnox::API::Types::Required, type: :type do
 
   describe 'Float' do
     before do
-      class TestClass
+      test_class = Class.new(TestClass) do
         attribute :required_attribute, Fortnox::API::Types::Required::Float
       end
+      stub_const('TestClass', test_class)
     end
 
     include_examples 'required attribute', Float

data/spec/fortnox/api/types/sales_account_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'fortnox/api/types'
+require 'fortnox/api/types/examples/types'
+
+describe Fortnox::API::Types do
+  let(:klass) { Fortnox::API::Types::SalesAccount }
+
+  describe 'SalesAccount' do
+    context 'when created with nil' do
+      subject { klass[nil] }
+
+      it { is_expected.to be_nil }
+    end
+
+    context 'when created with empty string' do
+      subject { klass[''] }
+
+      it { is_expected.to be_nil }
+    end
+
+    [-12_345, -1_234, -123, -1, 0, 1, 12, 123, 1_234.0, 12_345].each do |invalid_number|
+      context "with #{invalid_number}" do
+        it 'raises ConstraintError' do
+          expect { klass[invalid_number] }.to raise_error(Dry::Types::ConstraintError)
+        end
+      end
+    end
+
+    context 'with 4 digits' do
+      subject { klass[1_234] }
+
+      it { is_expected.to eq('1234') }
+    end
+
+    context 'when created with valid string' do
+      include_examples 'equals input', '1234'
+    end
+
+    context 'when created with a too many digits' do
+      include_examples 'raises ConstraintError', '12345'
+    end
+
+    context 'when created with too few digits' do
+      include_examples 'raises ConstraintError', '123'
+    end
+
+    context 'when created with a negative number' do
+      include_examples 'raises ConstraintError', '-1234'
+    end
+
+    context 'when created with characters' do
+      include_examples 'raises ConstraintError', 'abcd'
+    end
+  end
+end

data/spec/fortnox/api_spec.rb

@@ -4,14 +4,7 @@ require 'spec_helper'
 require 'fortnox/api'
 
 describe Fortnox::API do
-  before do
-    module Fortnox
-      module API
-        class TestBase
-        end
-      end
-    end
-  end
+  before { stub_const('Fortnox::API::TestBase', Class.new) }
 
   describe 'configuration defaults' do
     subject(:config_value) { described_class.config[config_key] }
@@ -21,37 +14,13 @@ describe Fortnox::API do
     describe 'base_url' do
       let(:config_key) { :base_url }
 
-      it { is_expected.to eql 'https://api.fortnox.se/3/' }
-    end
-
-    describe 'client_secret' do
-      let(:config_key) { :client_secret }
-
-      it { is_expected.to be_nil }
-    end
-
-    describe 'access_token' do
-      let(:config_key) { :access_token }
-
-      it { is_expected.to be_nil }
-    end
-
-    describe 'access_tokens' do
-      let(:config_key) { :access_tokens }
-
-      it { is_expected.to be_nil }
+      it { is_expected.to eq 'https://api.fortnox.se/3/' }
     end
 
-    describe 'token_store' do
-      let(:config_key) { :token_store }
-
-      it { is_expected.to eql({}) }
-    end
-
-    describe 'debugging' do
-      let(:config_key) { :debugging }
+    describe 'token_url' do
+      let(:config_key) { :token_url }
 
-      it { is_expected.to be false }
+      it { is_expected.to eq 'https://apps.fortnox.se/oauth-v1/token' }
     end
 
     describe 'logger' do
@@ -67,104 +36,30 @@ describe Fortnox::API do
     end
   end
 
-  describe 'access_token' do
-    context 'when set to a String' do
-      subject { described_class.config.access_token }
-
-      before { described_class.configure { |config| config.access_token = value } }
-      let(:value) { '12345' }
-
-      it { is_expected.to eql value }
-    end
-
-    shared_examples_for 'invalid argument' do
-      subject { -> { described_class.configure { |config| config.access_token = value } } }
-
-      it { is_expected.to raise_error(ArgumentError, /expected a String/) }
-    end
-
-    context 'when set to a Hash' do
-      include_examples 'invalid argument' do
-        let(:value) { { a: '123' } }
-      end
-    end
-
-    context 'when set to an Array' do
-      include_examples 'invalid argument' do
-        let(:value) { %w[123 456] }
-      end
-    end
-  end
-
-  describe 'access_tokens' do
-    context 'when set to a String' do
-      subject { -> { described_class.configure { |config| config.access_tokens = '12345' } } }
-
-      it { is_expected.to raise_error(ArgumentError, /expected a Hash or an Array/) }
-    end
-
-    shared_examples_for 'valid argument' do
-      subject { described_class.config.access_tokens }
-
-      before { described_class.configure { |config| config.access_tokens = value } }
-
-      it { is_expected.to eql(value) }
-    end
-
-    context 'when set to a Hash' do
-      include_examples 'valid argument' do
-        let(:value) { { a: '123', b: '456' } }
-      end
-    end
-
-    context 'when set to an Array' do
-      include_examples 'valid argument' do
-        let(:value) { %w[123 456] }
-      end
-    end
-  end
-
-  describe 'token_store' do
-    subject { described_class.config[:token_store] }
-
-    context 'when access_token set' do
-      before { described_class.configure { |config| config.access_token = access_token } }
-      let(:access_token) { '12345' }
-
-      it { is_expected.to eql(default: access_token) }
-    end
-
-    context 'when access_tokens is' do
-      before { described_class.configure { |config| config.access_tokens = access_tokens } }
-
-      describe 'a Hash' do
-        let(:access_tokens) { { a: '123', b: '456' } }
-
-        it { is_expected.to eql(access_tokens) }
-      end
-
-      describe 'an Array' do
-        let(:access_tokens) { %w[123 456] }
-
-        it { is_expected.to eql(default: access_tokens) }
-      end
-    end
-  end
-
   describe 'readers for' do
     describe 'debugging' do
-      subject { described_class.debugging }
+      subject(:debugging) { described_class.debugging }
 
       it 'is available' do
-        is_expected.to be false
+        expect(debugging).to be false
       end
     end
 
     describe 'logger' do
-      subject { described_class.logger }
+      subject(:logger) { described_class.logger }
 
       it 'is available' do
-        is_expected.to be_a Logger
+        expect(logger).to be_a Logger
+      end
+    end
+  end
+
+  describe '#access_token' do
+    context 'when token is set' do
+      before { described_class.access_token = 'an_access_token' }
+
+      it 'returns the token' do
+        expect(described_class.access_token).to eq('an_access_token')
       end
     end
   end

data/spec/spec_helper.rb

@@ -20,26 +20,12 @@ RSpec.configure do |config|
   config.extend Helpers # Allow access to helpers in describe and context blocks
   config.include Helpers # Allow access to helpers in it and let blocks
 
-  config.include Helpers::Repositories, integration: true
   config.include Matchers::Type, type: :type
 
   config.order = 'random'
 
   WebMock.disable_net_connect!(allow: 'codeclimate.com')
 
-  config.before do
-    module Test
-      def self.remove_constants
-        constants.each { |const| remove_const(const) }
-        self
-      end
-    end
-  end
-
-  config.after do
-    Object.send(:remove_const, Test.remove_constants.name)
-  end
-
   # Reset configuration after each test run
   config.after do
     Fortnox::API::DEFAULT_CONFIGURATION.each do |key, value|

data/spec/support/helpers/configuration_helper.rb

@@ -1,12 +1,39 @@
 # frozen_string_literal: true
 
+require 'dotenv'
+require 'jwt'
+
+DOTENV_FILE_NAME = '.env.test'
+Dotenv.load(DOTENV_FILE_NAME)
+
+DEBUG = ENV.fetch('DEBUG', false) == true
+
 module Helpers
   module Configuration
-    def set_api_test_configuration
+    def set_api_test_configuration # rubocop:disable Metrics/MethodLength
       Fortnox::API.configure do |config|
-        config.client_secret = '9aBA8ZgsvR'
-        config.access_tokens = ['ccaef817-d5d8-4b1c-a316-54f3e55c5c54']
+        config.debugging = DEBUG
+
+        if DEBUG
+          config.logger = lambda {
+            logger = Logger.new($stdout)
+            logger.level = Logger::DEBUG
+            return logger
+          }.call
+        end
       end
+
+      Fortnox::API.access_token = ENV.fetch('FORTNOX_API_ACCESS_TOKEN')
+    end
+
+    def add_to_registry(symbol, klass)
+      unless Fortnox::API::Registry.key? symbol
+        # Only register the key once...
+        Fortnox::API::Registry.register(symbol) { klass }
+      end
+
+      # ... but stub the value each test run
+      Fortnox::API::Registry.stub(symbol, klass)
     end
   end
 end

data/spec/support/helpers.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-Dir[File.expand_path('spec/support/helpers/*.rb')].each { |file| require file }
+Dir[File.expand_path('spec/support/helpers/*.rb')].sort.each { |file| require file }

data/spec/support/matchers/type/attribute_matcher.rb

@@ -19,7 +19,7 @@ module Matchers
       end
 
       def failure_message
-        "Expected class to have attribute #{@attribute.inspect} defined as #{@attribute_type}, "\
+        "Expected class to have attribute #{@attribute.inspect} defined as #{@attribute_type}, " \
         "but got following errors:
         #{@errors}"
       end
@@ -29,7 +29,7 @@ module Matchers
       def expect_error(msg)
         yield
 
-        @errors << msg
+        @errors = @errors += msg
         false # Fail test since expected error not thrown
       rescue Dry::Struct::Error
         # TODO: check if error message is correct

data/spec/support/matchers/type/have_nullable_date_matcher.rb

@@ -14,6 +14,8 @@ module Matchers
         @expected_error = Fortnox::API::AttributeError
         @expected_error_message = 'invalid date'
         @failure_description = ''
+
+        super(attribute, valid_value, invalid_value, nil)
       end
 
       def matches?(klass)
@@ -46,11 +48,11 @@ module Matchers
 
         @failure_description << " (Expected #{@expected_error}, but got none)"
         false
-      rescue @expected_error => e
-        return true if e.message == @expected_error_message
+      rescue @expected_error => exception
+        return true if exception.message == @expected_error_message
 
-        fail_message = "Expected error message to include #{@expected_error_message.inspect}, "\
-                       "but was #{e.message.inspect}"
+        fail_message = "Expected error message to include #{@expected_error_message.inspect}, " \
+                       "but was #{exception.message.inspect}"
         raise(fail_message)
       end
     end

data/spec/support/matchers/type/have_nullable_matcher.rb

@@ -45,7 +45,7 @@ module Matchers
         value = model.send(@attribute)
         return true if value == @default_value
 
-        @failure_description << " (Expected #{@invalid_value.inspect} to default to "\
+        @failure_description << " (Expected #{@invalid_value.inspect} to default to " \
                                 "#{@default_value.inspect}), but got #{value.inspect}"
         false
       end