fortnox-api 0.8.0 → 0.9.0

data/spec/fortnox/api/repositories/examples/save.rb

@@ -7,21 +7,14 @@
 # Assumes that attribute is a string attribute without restrictions.
 shared_examples_for '.save' do |attribute, additional_attrs: {}|
   describe '.save' do
-    let(:new_hash) { additional_attrs.merge(attribute => value) }
-    let(:new_model) { described_class::MODEL.new(new_hash) }
-    let(:save_new) { VCR.use_cassette("#{vcr_dir}/save_new") { repository.save(new_model) } }
-    let(:entity_wrapper) { repository.mapper.class::JSON_ENTITY_WRAPPER }
-    let(:value) { 'A value' }
-
-    shared_examples_for 'save' do
-      before do
-        if model.saved?
-          message = 'Test trying to save model, but already marked as saved!'
-          message << " Model: #{model.inspect}"
-          raise(message)
-        end
+    let(:new_hash) { additional_attrs.merge(attribute => 'A value') }
+    let(:save_new) do
+      VCR.use_cassette("#{vcr_dir}/save_new") do
+        repository.save(described_class::MODEL.new(new_hash))
       end
+    end
 
+    shared_examples_for 'save' do
       specify "includes correct #{attribute.inspect}" do
         saved_entity = send_request
         expect(saved_entity.send(attribute)).to eql(value)
@@ -31,8 +24,9 @@ shared_examples_for '.save' do |attribute, additional_attrs: {}|
     describe 'new' do
       context 'when not saved' do
         include_examples 'save' do
-          let(:model) { new_model }
+          let(:model) { described_class::MODEL.new(new_hash) }
           let(:send_request) { save_new }
+          let(:value) { 'A value' }
         end
       end
 
@@ -45,13 +39,34 @@ shared_examples_for '.save' do |attribute, additional_attrs: {}|
     end
 
     describe 'old (update existing)' do
+      let(:find_new_cassette) { "#{vcr_dir}/find_new" }
+
       include_examples 'save' do
         let(:value) { "Updated #{attribute}" }
+
         let(:model) do
-          new_id = save_new.unique_id
-          new_record = VCR.use_cassette("#{vcr_dir}/find_new") { repository.find(new_id) }
-          new_record.update(attribute => value)
+          existing_model = VCR.use_cassette(find_new_cassette) do
+            repository.find(save_new.unique_id)
+          end
+
+          updated_model = existing_model.update(attribute => value)
+
+          if updated_model.saved?
+            raise(
+              "We are trying to update the :#{attribute} attribute with " \
+              "#{value} on an existing record, but that record " \
+              'loaded from Fortnox ' \
+              "already has this attribute set to that value:\n" \
+              "#{existing_model.inspect}\nHave a look at the VCR cassette " \
+              "\"#{find_new_cassette}\" which should load the record with the " \
+              "attribute :#{attribute} set to something else than " \
+              'the value we want to set. ' \
+            )
+          end
+
+          updated_model
         end
+
         let(:send_request) do
           VCR.use_cassette("#{vcr_dir}/save_old") { repository.save(model) }
         end
@@ -59,4 +74,3 @@ shared_examples_for '.save' do |attribute, additional_attrs: {}|
     end
   end
 end
-# rubocop:enable RSpec/DescribeClass

data/spec/fortnox/api/repositories/examples/save_with_nested_model.rb

@@ -15,10 +15,6 @@ shared_examples_for '.save with nested model' do |required_hash, nested_model_ke
       end
     end
 
-    it 'does not raise any errors' do
-      expect { response }.not_to raise_error
-    end
-
     describe 'returned entity\'s nested model' do
       subject(:returned_nested_model) { response.send(nested_model_key).first }
 
@@ -30,4 +26,3 @@ shared_examples_for '.save with nested model' do |required_hash, nested_model_ke
     end
   end
 end
-# rubocop:enable RSpec/DescribeClass

data/spec/fortnox/api/repositories/examples/save_with_specially_named_attribute.rb

@@ -7,8 +7,6 @@
 shared_examples_for '.save with specially named attribute' do |required_hash, attribute, value|
   describe '.save' do
     context 'with specially named attribute' do
-      subject { -> { save_model } }
-
       let(:new_model) { described_class::MODEL.new(required_hash.merge(attribute => value)) }
       let(:save_model) do
         VCR.use_cassette("#{vcr_dir}/save_with_specially_named_attribute") do
@@ -16,7 +14,7 @@ shared_examples_for '.save with specially named attribute' do |required_hash, at
         end
       end
 
-      it { is_expected.not_to raise_error }
+      it { expect { save_model }.not_to raise_error }
 
       describe 'response' do
         subject { save_model.send(attribute) }
@@ -26,4 +24,3 @@ shared_examples_for '.save with specially named attribute' do |required_hash, at
     end
   end
 end
-# rubocop:enable RSpec/DescribeClass

data/spec/fortnox/api/repositories/examples/search.rb

@@ -26,17 +26,14 @@ shared_examples_for '.search' do |attribute_hash_key_name, value, matches|
       end
 
       context 'with special characters' do
-        subject do
-          when_performing do
-            VCR.use_cassette("#{vcr_dir}/search_with_special_char") do
-              repository.search(attribute_hash_key_name => 'special char å')
-            end
+        let(:search_with_special_char) do
+          VCR.use_cassette("#{vcr_dir}/search_with_special_char") do
+            repository.search(attribute_hash_key_name => 'special char å')
           end
         end
 
-        it { is_expected.not_to raise_error }
+        specify { expect { search_with_special_char }.not_to raise_error }
       end
     end
   end
 end
-# rubocop:enable RSpec/DescribeClass

data/spec/fortnox/api/repositories/invoice_spec.rb

@@ -12,18 +12,36 @@ require 'fortnox/api/repositories/examples/save_with_nested_model'
 require 'fortnox/api/repositories/examples/save_with_specially_named_attribute'
 require 'fortnox/api/repositories/examples/only'
 
-describe Fortnox::API::Repository::Invoice, order: :defined, integration: true do
+describe Fortnox::API::Repository::Invoice, integration: true, order: :defined do
   include Helpers::Configuration
-
-  before { set_api_test_configuration }
+  include Helpers::Repositories
 
   subject(:repository) { described_class.new }
 
+  before { set_api_test_configuration }
+
   required_hash = { customer_number: '1' }
 
   include_examples '.save', :comments, additional_attrs: required_hash
 
-  nested_model_hash = { price: 10, article_number: '0000' }
+  describe '#save' do
+    context 'with unsaved parent' do
+      subject(:saved_child) do
+        parent_invoice = Fortnox::API::Model::Invoice.new(customer_number: '1')
+        child_invoice = parent_invoice.update(due_date: '2023-01-01')
+
+        VCR.use_cassette("#{vcr_dir}/save_new_with_unsaved_parent") do
+          described_class.new.save(child_invoice)
+        end
+      end
+
+      it 'sets attribute from parent when saved' do
+        expect(saved_child.customer_number).to eq '1'
+      end
+    end
+  end
+
+  nested_model_hash = { price: 10, article_number: '101' }
   include_examples '.save with nested model',
                    required_hash,
                    :invoice_rows,
@@ -37,8 +55,9 @@ describe Fortnox::API::Repository::Invoice, order: :defined, integration: true d
 
   # 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', 100
+  include_examples '.all', 34
 
+  # VCR: Models needs to be created manually in Fortnox
   include_examples '.find', 1 do
     let(:find_by_hash_failure) { { yourreference: 'Not found' } }
 
@@ -51,9 +70,10 @@ describe Fortnox::API::Repository::Invoice, order: :defined, integration: true d
     end
   end
 
-  include_examples '.search', :customername, 'Test', 7
+  include_examples '.search', :customername, 'Test', 1
 
-  include_examples '.only', :fullypaid, 4
+  # VCR: Need to be set manually in Fortnox
+  include_examples '.only', :fullypaid, 2
 
   describe 'country attribute' do
     def new_invoice(country:)
@@ -89,12 +109,6 @@ describe Fortnox::API::Repository::Invoice, order: :defined, integration: true d
         it { is_expected.to eq('GB') }
       end
 
-      describe 'KR' do
-        subject { save_invoice(country: 'KR').country }
-
-        it { is_expected.to eq('KR') }
-      end
-
       describe 'VA' do
         subject { save_invoice(country: 'VA').country }
 
@@ -130,7 +144,7 @@ describe Fortnox::API::Repository::Invoice, order: :defined, integration: true d
       before { persisted_invoice }
 
       context 'when setting value to nil' do
-        subject { updated_persisted_invoice.comments }
+        subject(:comments) { updated_persisted_invoice.comments }
 
         let(:updated_persisted_invoice) do
           VCR.use_cassette("#{vcr_dir}/save_old_with_nil_comments") do
@@ -138,11 +152,14 @@ describe Fortnox::API::Repository::Invoice, order: :defined, integration: true d
           end
         end
 
-        pending { is_expected.to eq(nil) }
+        it do
+          pending "test to rerecord VCR cassette, maybe it's working now"
+          expect(comments).to be_nil
+        end
       end
 
       context 'when setting value to empty string' do
-        subject { updated_persisted_invoice.comments }
+        subject(:comments) { updated_persisted_invoice.comments }
 
         let(:updated_persisted_invoice) do
           VCR.use_cassette("#{vcr_dir}/save_old_with_empty_comments") do
@@ -151,7 +168,7 @@ describe Fortnox::API::Repository::Invoice, order: :defined, integration: true d
         end
 
         it 'does not reset the value' do
-          is_expected.to eq('A comment to be reset')
+          expect(comments).to eq('A comment to be reset')
         end
       end
     end
@@ -170,7 +187,7 @@ describe Fortnox::API::Repository::Invoice, order: :defined, integration: true d
       before { persisted_invoice }
 
       context 'when setting value to nil' do
-        subject { updated_persisted_invoice.country }
+        subject(:country) { updated_persisted_invoice.country }
 
         let(:updated_persisted_invoice) do
           # TODO: This VCR cassette needs to be re-recorded again
@@ -180,11 +197,14 @@ describe Fortnox::API::Repository::Invoice, order: :defined, integration: true d
           end
         end
 
-        pending { is_expected.to eq(nil) }
+        it 'is nil' do
+          pending 'see comment above'
+          expect(country).to be_nil
+        end
       end
 
       context 'when setting value to empty string' do
-        subject { updated_persisted_invoice.country }
+        subject(:country) { updated_persisted_invoice.country }
 
         let(:updated_persisted_invoice) do
           VCR.use_cassette("#{vcr_dir}/save_old_with_empty_country") do
@@ -193,9 +213,32 @@ describe Fortnox::API::Repository::Invoice, order: :defined, integration: true d
         end
 
         it 'does not reset the country' do
-          is_expected.to eq('SE')
+          expect(country).to eq('SE')
         end
       end
     end
   end
+
+  describe 'limits for invoice_row' do
+    describe 'description' do
+      let(:model) do
+        described_class::MODEL.new(
+          customer_number: '1',
+          invoice_rows: [
+            {
+              article_number: '101',
+              description: 'a' * 255
+            }
+          ]
+        )
+      end
+      let(:saving_with_max_row_description) do
+        VCR.use_cassette("#{vcr_dir}/row_description_limit") { repository.save(model) }
+      end
+
+      it 'allows 255 characters' do
+        expect { saving_with_max_row_description }.not_to raise_error
+      end
+    end
+  end
 end

data/spec/fortnox/api/repositories/order_spec.rb

@@ -11,28 +11,29 @@ require 'fortnox/api/repositories/examples/save'
 require 'fortnox/api/repositories/examples/save_with_nested_model'
 require 'fortnox/api/repositories/examples/search'
 
-describe Fortnox::API::Repository::Order, order: :defined, integration: true do
+describe Fortnox::API::Repository::Order, integration: true, order: :defined do
   include Helpers::Configuration
-
-  before { set_api_test_configuration }
+  include Helpers::Repositories
 
   subject(:repository) { described_class.new }
 
+  before { set_api_test_configuration }
+
   required_hash = { customer_number: '1' }
 
   include_examples '.save', :comments, additional_attrs: required_hash
 
-  nested_model_hash = { price: 10, article_number: '0000', ordered_quantity: 1 }
+  nested_model_hash = { price: -9_999_999_999, article_number: '101', ordered_quantity: 1 }
   include_examples '.save with nested model',
                    required_hash,
                    :order_rows,
                    nested_model_hash,
                    [Fortnox::API::Types::OrderRow.new(nested_model_hash)]
 
-  # 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
+  # VCR: Update expected result
+  include_examples '.all', 7
 
+  # VCR: Searched Orders needs to be created manually in Fortnox
   include_examples '.find', 1 do
     let(:find_by_hash_failure) { { ourreference: 'Not found' } }
 
@@ -45,7 +46,8 @@ describe Fortnox::API::Repository::Order, order: :defined, integration: true do
     end
   end
 
-  include_examples '.search', :customername, 'A customer', 3
+  # VCR: Searched Order needs to be created manually
+  include_examples '.search', :customername, 'A customer', 1
 
-  include_examples '.only', :cancelled, 6
+  include_examples '.only', :cancelled, 2
 end

data/spec/fortnox/api/repositories/project_spec.rb

@@ -8,28 +8,29 @@ require 'fortnox/api/repositories/examples/all'
 require 'fortnox/api/repositories/examples/find'
 require 'fortnox/api/repositories/examples/save'
 
-describe Fortnox::API::Repository::Project, order: :defined, integration: true do
+describe Fortnox::API::Repository::Project, integration: true, order: :defined do
   include Helpers::Configuration
-
-  before { set_api_test_configuration }
+  include Helpers::Repositories
 
   subject(:repository) { described_class.new }
 
+  before { set_api_test_configuration }
+
   include_examples '.save',
                    :comments,
                    additional_attrs: { description: 'Some important project' }
 
-  # It is not yet possible to delete Projects. Therefore, expected nr of
+  # VCR: 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', 33
+  include_examples '.all', 2
 
   include_examples '.find', '1' do
     let(:find_by_hash_failure) { { offset: 10_000 } }
     let(:single_param_find_by_hash) { { find_hash: { limit: 1 }, matches: 1 } }
 
     let(:multi_param_find_by_hash) do
-      { find_hash: { limit: 2, offset: 2 }, matches: 2 }
+      { find_hash: { limit: 2, offset: 0 }, matches: 2 }
     end
   end
 end

data/spec/fortnox/api/repositories/terms_of_payment_spec.rb

@@ -10,23 +10,25 @@ require 'fortnox/api/repositories/examples/save'
 require 'fortnox/api/repositories/examples/save_with_specially_named_attribute'
 require 'fortnox/api/repositories/examples/search'
 
-describe Fortnox::API::Repository::TermsOfPayment, order: :defined, integration: true do
+describe Fortnox::API::Repository::TermsOfPayment, integration: true, order: :defined do
   include Helpers::Configuration
+  include Helpers::Repositories
 
   subject(:repository) { described_class.new }
 
   before { set_api_test_configuration }
 
-  # When recording new VCR cassettes, code must be changed to a new unique one
-  required_hash = { code: '19DAYS' }
+  # VCR: code must be changed to a new unique one
+  required_hash = { code: '21DAYS' }
 
   include_examples '.save', :description, additional_attrs: required_hash
 
-  # When recording new VCR cassettes, expected matches needs to be increased
-  include_examples '.all', 13
+  # VCR: expected matches needs to be increased
+  include_examples '.all', 10
 
-  include_examples '.find', '15DAYS', find_by_hash: false do
-    let(:find_by_hash_failure) { { code: '15days' } }
+  # VCR: The terms of payment searched here needs to be created manually in Fortnox
+  include_examples '.find', '19DAYS', find_by_hash: false do
+    let(:find_by_hash_failure) { { code: '19days' } }
     let(:single_param_find_by_hash) { { find_hash: { code: '30days' }, matches: 1 } }
   end
 end

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

@@ -9,29 +9,31 @@ require 'fortnox/api/repositories/examples/find'
 require 'fortnox/api/repositories/examples/save'
 require 'fortnox/api/repositories/examples/save_with_specially_named_attribute'
 
-describe Fortnox::API::Repository::Unit, order: :defined, integration: true do
+describe Fortnox::API::Repository::Unit, integration: true, order: :defined do
   include Helpers::Configuration
-
-  before { set_api_test_configuration }
+  include Helpers::Repositories
 
   subject(:repository) { described_class.new }
 
-  # When recording new VCR cassettes, code needs to be changed to a unique value
+  before { set_api_test_configuration }
+
+  # VCR: code needs to be changed to a unique value
   include_examples '.save',
                    :description,
-                   additional_attrs: { code: 'blarg5' }
+                   additional_attrs: { code: 'blarg9' }
 
-  # When recording new VCR cassettes, code needs to be changed to a unique value
+  # VCR: code needs to be changed to a unique value
   include_examples '.save with specially named attribute',
                    { description: 'Happy clouds' },
                    :code,
-                   'woooh5'
+                   'woooh7'
 
-  # When recording new VCR cassettes, expected number must be updated
-  include_examples '.all', 14
+  # VCR: expected number must be updated
+  include_examples '.all', 7
 
-  include_examples '.find', 'blarg', find_by_hash: false do
+  # VCR: code must be updated
+  include_examples '.find', 'blarg7', find_by_hash: false do
     let(:find_by_hash_failure) { { code: 'notfound' } }
-    let(:single_param_find_by_hash) { { find_hash: { code: 'blarg' }, matches: 1 } }
+    let(:single_param_find_by_hash) { { find_hash: { code: 'blarg7' }, matches: 1 } }
   end
 end

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

@@ -45,7 +45,7 @@ describe Fortnox::API::Types::Country do
         expect(described_class['SV']).to eq 'SV'
       end
 
-      it 'translated Switzerland to ' do
+      it 'translated Switzerland to' do
         expect(described_class['Switzerland']).to eq 'CH'
       end
     end

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

@@ -36,8 +36,8 @@ describe Fortnox::API::Types::Email do
   end
 
   context 'when created with more than 1024 characters' do
-    legal_characters = 'abcdefghijklmnopqrstuvwxyz0123456789.-_+'.split('')
-    too_long_email = (legal_characters * 35).shuffle.join + '@example.com'
+    legal_characters = 'abcdefghijklmnopqrstuvwxyz0123456789.-_+'.chars
+    too_long_email = "#{(legal_characters * 35).shuffle.join}@example.com"
     include_examples 'raises ConstraintError', too_long_email
   end
 end

data/spec/fortnox/api/types/examples/document_row.rb

@@ -4,7 +4,7 @@ shared_examples_for 'DocumentRow' do |valid_hash|
   it { is_expected.to have_account_number(:account_number, valid_hash) }
 
   it { is_expected.to have_sized_string(:article_number, 50, valid_hash) }
-  it { is_expected.to have_sized_string(:description, 50, valid_hash) }
+  it { is_expected.to have_sized_string(:description, 255, valid_hash) }
 
   it { is_expected.to have_discount_type(:discount_type, valid_hash) }
 
@@ -12,10 +12,10 @@ shared_examples_for 'DocumentRow' do |valid_hash|
 
   it { is_expected.to have_housework_type(:housework_type, valid_hash) }
 
-  it { is_expected.to have_sized_float(:price, 0.0, 99_999_999_999.9, valid_hash) }
+  it { is_expected.to have_sized_float(:price, -9_999_999_999, 99_999_999_999.9, valid_hash) }
 
   it do # rubocop:disable RSpec/ExampleLength
-    is_expected.to have_sized_float(
+    expect(subject).to have_sized_float(
       :delivered_quantity,
       -9_999_999_999_999.9,
       9_999_999_999_999.9,

data/spec/fortnox/api/types/examples/enum.rb

@@ -36,14 +36,14 @@ shared_examples_for 'enum' do |name, values, auto_crop: false|
       end
 
       context 'with a string that starts like a random member from the enum' do
-        let(:input) { enum_value.downcase + 'more string' }
+        let(:input) { "#{enum_value.downcase}more string" }
 
         if auto_crop
           it { is_expected.to eq enum_value }
         else
-          subject { -> { klass[input] } }
-
-          it { is_expected.to raise_error(Dry::Types::ConstraintError) }
+          it do
+            expect { klass[input] }.to raise_error(Dry::Types::ConstraintError)
+          end
         end
       end
     end

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

@@ -7,7 +7,5 @@ shared_examples_for 'equals input' do |input|
 end
 
 shared_examples_for 'raises ConstraintError' do |input|
-  subject { -> { klass[input] } }
-
-  it { is_expected.to raise_error(Dry::Types::ConstraintError) }
+  specify { expect { klass[input] }.to raise_error(Dry::Types::ConstraintError) }
 end