fortnox-api 0.1.0 → 0.2.0

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

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'fortnox/api'
+require 'fortnox/api/mappers/order'
+require 'fortnox/api/mappers/examples/mapper'
+
+describe Fortnox::API::Mapper::Order do
+  key_map =
+    {
+      administration_fee_vat: 'AdministrationFeeVAT',
+      freight_vat: 'FreightVAT',
+      total_vat: 'TotalVAT',
+      vat_included: 'VATIncluded'
+    }
+  json_entity_type = 'Order'
+  json_entity_collection = 'Orders'
+
+  it_behaves_like 'mapper', key_map, json_entity_type, json_entity_collection do
+    let(:mapper){ described_class.new }
+  end
+end

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

@@ -1,12 +1,14 @@
 require 'spec_helper'
 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
-      attribute :private, String, writer: :private
-      attribute :string, String
-      attribute :number, Integer, default: 42
+      attribute :private, Fortnox::API::Types::String.with( read_only: true )
+      attribute :string, Fortnox::API::Types::Required::String
+      attribute :number, Fortnox::API::Types::Nullable::Integer
+      attribute :account, Fortnox::API::Types::AccountNumber
     end
   end
 
@@ -16,7 +18,23 @@ describe Fortnox::API::Model::Base do
 
       it{ is_expected.to be_a Entity }
       it{ is_expected.to be_new }
-      it{ is_expected.to_not be_saved }
+      it{ is_expected.not_to be_saved }
+    end
+
+    context 'without required attribute' do
+      subject{ ->{ Entity.new({}) } }
+
+      it{ is_expected.to raise_error Fortnox::API::Exception }
+      it{ is_expected.to raise_error Fortnox::API::MissingAttributeError }
+      it{ is_expected.to raise_error Fortnox::API::MissingAttributeError, /Missing attribute :string/ }
+    end
+
+    context 'with invalid attribute value' do
+      subject{ ->{ Entity.new({ string: 'Test', account: 13337 }) } }
+
+      it{ is_expected.to raise_error Fortnox::API::Exception }
+      it{ is_expected.to raise_error Fortnox::API::AttributeError }
+      it{ is_expected.to raise_error Fortnox::API::AttributeError, /invalid type for :account/ }
     end
   end
 
@@ -24,52 +42,56 @@ describe Fortnox::API::Model::Base do
     let(:original){ Entity.new( string: 'Test' ) }
 
     context 'with new, simple value' do
-      subject{ original.update( string: 'Variant' ) }
+      subject{ updated_model }
+
+      let(:updated_model){ original.update( string: 'Variant' ) }
+
+      it{ is_expected.to be_new }
+      it{ is_expected.not_to be_saved }
 
       it 'returns a new object' do
-        is_expected.to_not eql( original )
+        is_expected.not_to eql( original )
       end
 
-      it 'returns a object of the same class' do
-        expect( subject.class ).to eql( original.class )
+      describe 'updated attribute' do
+        subject{ updated_model.string }
+        it{ is_expected.to eql( 'Variant' ) }
       end
 
-      it 'returns a object with the new value' do
-        expect( subject.string ).to eql( 'Variant' )
+      describe 'returned class' do
+        subject{ updated_model.class }
+        it{ is_expected.to eql( original.class ) }
       end
-
-      it{ is_expected.to be_new }
-      it{ is_expected.to_not be_saved }
     end
 
     context 'with the same, simple value' do
-      subject{ original.update( string: 'Test' ) }
+      subject( :updated_model ){ original.update( string: 'Test' ) }
 
       it 'returns the same object' do
         is_expected.to eql( original )
       end
 
       it 'returns a object with the same value' do
-        expect( subject.string ).to eql( 'Test' )
+        expect( updated_model.string ).to eql( 'Test' )
       end
 
       it{ is_expected.to be_new }
-      it{ is_expected.to_not be_saved }
+      it{ is_expected.not_to be_saved }
     end
 
     context 'a saved entity' do
-      let( :saved_entry ){ Entity.new( string: 'Saved', new: false, unsaved: false) }
+      subject( :updated_entry ){ saved_entry.update( string: 'Updated' ) }
 
-      subject{ saved_entry.update( string: 'Updated' ) }
+      let( :saved_entry ){ Entity.new( string: 'Saved', new: false, unsaved: false) }
 
       before do
-        expect(saved_entry).to_not be_new
+        expect(saved_entry).not_to be_new
         expect(saved_entry).to be_saved
       end
 
-      specify{ expect(subject.string).to eq( 'Updated' ) }
-      it{ is_expected.to_not be_new }
-      it{ is_expected.to_not be_saved }
+      specify{ expect(updated_entry.string).to eq( 'Updated' ) }
+      it{ is_expected.not_to be_new }
+      it{ is_expected.not_to be_saved }
     end
   end
 

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

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'fortnox/api/models/customer'
+require 'fortnox/api/models/examples/model'
+
+describe Fortnox::API::Model::Customer, type: :model do
+  valid_hash = { name: 'Arthur Dent' }
+
+  it_behaves_like 'a model', valid_hash, :customer_number, '5'
+end

data/spec/fortnox/api/models/examples/document_base.rb

@@ -0,0 +1,13 @@
+require 'fortnox/api/models/examples/model'
+
+shared_examples_for 'DocumentBase Model' do |row_class, row_attribute, valid_hash, valid_row_hash: {}|
+  it_behaves_like 'a model', valid_hash, :document_number, 1
+
+  context "when having a(n) #{ row_class }" do
+    it 'returns the correct object' do
+      row = row_class.new(valid_row_hash)
+      document_base = described_class.new( customer_number: '123', row_attribute => [row] )
+      expect(document_base.send(row_attribute)).to eq([row])
+    end
+  end
+end

data/spec/fortnox/api/models/examples/model.rb

@@ -0,0 +1,13 @@
+shared_examples_for 'a model' do |valid_hash, unique_id_attribute, value|
+  it 'can be initialized' do
+    expect{ described_class.new(valid_hash) }.not_to raise_error
+  end
+
+  describe '.unique_id' do
+    let( :model ){ described_class.new( valid_hash.merge({ unique_id_attribute => value })) }
+
+    before{ expect(model.send(unique_id_attribute)).to eq value }
+
+    it{ expect(model.unique_id).to eq value }
+  end
+end

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

@@ -1,36 +1,12 @@
 require 'spec_helper'
 require 'fortnox/api/models/invoice'
+require 'fortnox/api/models/examples/document_base'
 
-describe Fortnox::API::Model::Invoice do
-  shared_examples 'having value objects' do |value_object_class|
-    context "when having an #{value_object_class}" do
-      it "returns the correct object" do
-        value_object = value_object_class.new
-        invoice = described_class.new( attribute => value_object )
-        expect(invoice.send(attribute)).to eq(value_object)
-      end
-    end
-  end
+describe Fortnox::API::Model::Invoice, type: :model do
+  valid_hash = { customer_number: '12345' }
 
-  describe 'association with Fortnox::API::Model::Row' do
-    context 'when having an Invoice Row' do
-      it 'returns the correct Row' do
-        row = Fortnox::API::Model::Row.new
-        invoice = described_class.new( invoice_rows: [row] )
-        expect(invoice.invoice_rows).to eq([row])
-      end
-    end
-  end
-
-  describe 'association with Fortnox::API::Model::EmailInformation' do
-    include_examples 'having value objects', Fortnox::API::Model::EmailInformation do
-      let( :attribute ){ :email_information }
-    end
-  end
-
-  describe 'association with Fortnox::API::Model::EDIInformation' do
-    include_examples 'having value objects', Fortnox::API::Model::EDIInformation do
-      let( :attribute ){ :edi_information }
-    end
-  end
+  it_behaves_like 'DocumentBase Model',
+                  Fortnox::API::Types::InvoiceRow,
+                  :invoice_rows,
+                  valid_hash
 end

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

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'fortnox/api/models/order'
+require 'fortnox/api/models/examples/document_base'
+
+describe Fortnox::API::Model::Order, type: :model do
+  valid_hash = { customer_number: '12345' }
+
+  it_behaves_like 'DocumentBase Model',
+                  Fortnox::API::Types::OrderRow,
+                  :order_rows,
+                  valid_hash,
+                  valid_row_hash: { ordered_quantity: 1.1 }
+end

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

@@ -1,85 +1,29 @@
 require 'spec_helper'
-require 'fortnox/api/repositories/context'
+require 'fortnox/api'
+require 'fortnox/api/mappers'
 require 'fortnox/api/repositories/customer'
-require 'fortnox/api/models/customer'
+require 'fortnox/api/repositories/examples/all'
+require 'fortnox/api/repositories/examples/find'
+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::Customer do
-  include_context 'repository context'
+describe Fortnox::API::Repository::Customer, order: :defined, integration: true do
+  subject(:repository){ described_class.new }
 
-  subject{ described_class.new }
+  include_examples '.save', :name
 
-  it_behaves_like 'repositories', Fortnox::API::Model::Customer
+  include_examples '.save with specially named attribute',
+                   { name: 'Test customer' },
+                   :email_invoice_cc,
+                   'test@example.com'
 
-  let( :find_id ){ 1 }
-  let( :find_customer_1 ) do
-    VCR.use_cassette( 'customers/find_id_1' ){ subject.find( find_id ) }
-  end
+  # It is not yet possible to delete Customers. Therefore, expected nr of
+  # Customers when running .all will continue to increase
+  # (until 100, which is max by default).
+  include_examples '.all', 100
 
-  describe '.all' do
-    let(:response) do
-      VCR.use_cassette( 'customers/all' ){ subject.all }
-    end
+  include_examples '.find', '1'
 
-    specify 'returns correct number of records' do
-      expect( response.size ).to be 1
-    end
-
-    specify 'returns correct class' do
-      expect( response.first.class ).to be Fortnox::API::Model::Customer
-    end
-  end
-
-  describe '.find' do
-    specify 'returns correct class' do
-      expect( find_customer_1.class ).to be Fortnox::API::Model::Customer
-    end
-
-    specify 'returns correct Customer' do
-      expect( find_customer_1.customer_number.to_i ).to eq( find_id )
-    end
-
-    specify 'returned Customer is marked as saved' do
-      expect( find_customer_1 ).to be_saved
-    end
-
-    specify 'returned Customer is not markes as new' do
-      expect( find_customer_1 ).to_not be_new
-    end
-  end
-
-  describe '.save' do
-    shared_examples_for 'save' do |attribute|
-      specify "include updated #{attribute.inspect}" do
-        send_request
-        expect( response['Customer'][attribute] ).to eql( updated_attribute )
-      end
-    end
-
-    describe 'new' do
-      include_examples 'save', 'Name' do
-        let( :updated_attribute ){ 'A customer' }
-        let( :model ) do
-          Fortnox::API::Model::Customer.new( name: updated_attribute )
-        end
-
-        let( :send_request ) do
-          VCR.use_cassette( 'customers/save_new' ){ subject.save( model ) }
-        end
-
-        let( :response ){ send_request }
-      end
-    end
-
-    describe 'old (update existing)' do
-      include_examples 'save', 'Name' do
-        let( :updated_attribute ){ 'Updated customer' }
-        let( :model ){ find_customer_1.update( name: updated_attribute ) }
-
-        let( :send_request ) do
-          VCR.use_cassette( 'customers/save_old' ){ subject.save( model ) }
-        end
-        let( :response ){ send_request }
-      end
-    end
-  end
+  include_examples '.search', :name, 'Test', 23
 end

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

@@ -0,0 +1,17 @@
+# rubocop:disable RSpec/DescribeClass
+RSpec.shared_examples_for '.all' do |count|
+  describe '.all' do
+    let(:response) do
+      VCR.use_cassette( "#{ vcr_dir }/all" ){ subject.all }
+    end
+
+    specify 'returns correct number of records' do
+      expect( response.size ).to be count
+    end
+
+    specify 'returns correct class' do
+      expect( response.first.class ).to be described_class::MODEL
+    end
+  end
+end
+# rubocop:enable RSpec/DescribeClass

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

@@ -0,0 +1,25 @@
+# rubocop:disable RSpec/DescribeClass
+shared_examples_for '.find' do |searched_entity_id|
+  describe '.find' do
+    let( :find_id_1 ) do
+      VCR.use_cassette( "#{ vcr_dir }/find_id_1" ){ repository.find( searched_entity_id ) }
+    end
+
+    specify 'returns correct class' do
+      expect( find_id_1.class ).to be described_class::MODEL
+    end
+
+    specify 'returns correct Customer' do
+      expect( find_id_1.unique_id ).to eq( searched_entity_id )
+    end
+
+    specify 'returned Customer is marked as saved' do
+      expect( find_id_1 ).to be_saved
+    end
+
+    specify 'returned Customer is not markes as new' do
+      expect( find_id_1 ).not_to be_new
+    end
+  end
+end
+# rubocop:enable RSpec/DescribeClass

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

@@ -0,0 +1,42 @@
+# rubocop:disable RSpec/DescribeClass
+shared_examples_for '.only' do |matching_filter, expected_matches, missing_filter: nil|
+  describe '.only' do
+    def repository_only(repository, vcr_cassette, filter)
+      VCR.use_cassette( "#{ vcr_dir }/#{ vcr_cassette }" ) do
+        repository.only( filter )
+      end
+    end
+
+    shared_examples '.only response' do |vcr_cassette, expected_entries|
+      subject{ repository_only( repository, vcr_cassette, filter ) }
+
+      it{ is_expected.to be_instance_of( Array ) }
+      it{ is_expected.to have(expected_entries).entries }
+    end
+
+    unless missing_filter.nil?
+      context "with no matches" do
+        include_examples '.only response', 'filter_miss', 0 do
+          let(:filter){ missing_filter }
+        end
+      end
+    end
+
+    context "with matches" do
+      include_examples '.only response', 'filter_hit', expected_matches do
+        let(:filter){ matching_filter }
+      end
+    end
+
+    context "with invalid filter" do
+      subject do
+        when_performing do
+          repository_only( repository, 'filter_invalid', 'doesntexist' )
+        end
+      end
+
+      it{ is_expected.to raise_error( Fortnox::API::RemoteServerError, /ogiltigt filter/ ) }
+    end
+  end
+end
+# rubocop:enable RSpec/DescribeClass

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

@@ -0,0 +1,69 @@
+# rubocop:disable RSpec/DescribeClass
+#######################################
+# SPEC IS DEPENDENT ON DEFINED ORDER!
+#######################################
+#
+# Assumes that attribute is a string attribute without restrictions.
+shared_examples_for '.save' do |attribute, required_attributes = {}|
+  describe '.save' do
+    let( :new_hash ) do
+      required_attributes.merge( attribute => value )
+    end
+    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 }"
+          fail(message)
+        end
+      end
+
+      specify "includes correct #{ attribute.inspect }" do
+        saved_entity = send_request
+        expect( saved_entity.send(attribute) ).to eql( value )
+      end
+    end
+
+    describe 'new' do
+      context 'when not saved' do
+        include_examples 'save' do
+          let( :model ){ new_model }
+          let( :send_request ){ save_new }
+        end
+      end
+
+      context "saved #{ described_class::MODEL }" do
+        let( :hash ){ { unsaved: false }.merge(new_hash) }
+        let( :model ){ described_class::MODEL.new( hash ) }
+
+        before do
+          # Should not make an API request in test!
+          expect( repository ).not_to receive( :save_new )
+          expect( repository ).not_to receive( :update_existing )
+        end
+
+        specify{ expect( repository.save( model )).to be( true ) }
+      end
+    end
+
+    describe 'old (update existing)' do
+      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 )
+        end
+        let( :send_request ) do
+          VCR.use_cassette( "#{ vcr_dir }/save_old" ){ repository.save( model ) }
+        end
+      end
+    end
+  end
+end
+# rubocop:enable RSpec/DescribeClass