fortnox-api 0.1.0 → 0.2.0

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

@@ -0,0 +1,32 @@
+# TODO: This will not work until we solve issue #62.
+# Until then, these tests are pending.
+# rubocop:disable RSpec/DescribeClass
+shared_examples_for '.save with nested model' do |required_hash, nested_model_key, nested_model_hash, nested_entity|
+  describe '.save with nested model' do
+    let( :repository ){ described_class.new }
+    let( :new_hash ) do
+      required_hash.merge( nested_model_key => nested_entity )
+    end
+    let( :response ) do
+      VCR.use_cassette( "#{ vcr_dir }/save_with_nested_model" ) do
+        model = described_class::MODEL.new( new_hash )
+        repository.save( model )
+      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 }
+
+      it 'has the wanted attributes' do
+        nested_model_hash.each do |attribute, value|
+          expect(returned_nested_model.send(attribute)).to eq(value)
+        end
+      end
+    end
+  end
+end
+# rubocop:enable RSpec/DescribeClass

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

@@ -0,0 +1,27 @@
+# rubocop:disable RSpec/DescribeClass
+# Test saving model with attributes that has specially names that needs to be mapped.
+#
+# NOTE: VCR cassette must be discarded when repositories are updated to reflect
+# the changes!
+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
+            repository.save( new_model )
+        end
+      end
+
+      it{ is_expected.not_to raise_error }
+
+      describe 'response' do
+        subject{ save_model.send(attribute) }
+        it{ is_expected.to eq(value) }
+      end
+    end
+  end
+end
+# rubocop:enable RSpec/DescribeClass

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

@@ -0,0 +1,31 @@
+# rubocop:disable RSpec/DescribeClass
+shared_examples_for '.search' do |attribute_hash_key_name, value, matches|
+  describe '.search' do
+
+    describe 'search' do
+      context "with no matches" do
+        subject do
+          VCR.use_cassette( "#{ vcr_dir }/search_miss" ) do
+            repository.search( attribute_hash_key_name => 'nothing' )
+          end
+        end
+
+        it{ is_expected.to be_instance_of( Array ) }
+        it{ is_expected.to have(0).entries }
+      end
+
+      context "with #{ matches } match(es)" do
+        subject do
+          VCR.use_cassette( "#{ vcr_dir }/search_by_name" ) do
+            repository.search( attribute_hash_key_name => value )
+          end
+        end
+
+        it{ is_expected.to be_instance_of( Array) }
+        it{ is_expected.to have(matches).entries }
+      end
+
+    end
+  end
+end
+# rubocop:enable RSpec/DescribeClass

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

@@ -1,10 +1,41 @@
 require 'spec_helper'
-require 'fortnox/api/repositories/context'
+require 'fortnox/api'
+require 'fortnox/api/mappers'
 require 'fortnox/api/repositories/invoice'
-require 'fortnox/api/models/invoice'
+require 'fortnox/api/repositories/examples/all'
+require 'fortnox/api/repositories/examples/find'
+require 'fortnox/api/repositories/examples/search'
+require 'fortnox/api/repositories/examples/save'
+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 do
-  include_context 'repository context'
+describe Fortnox::API::Repository::Invoice, order: :defined, integration: true do
+  subject(:repository){ described_class.new }
 
-  it_behaves_like 'repositories', Fortnox::API::Model::Invoice
+  required_hash = { customer_number: '1' }
+
+  include_examples '.save', :comments, required_hash
+
+  nested_model_hash = { price: 10, article_number: '0000' }
+  include_examples '.save with nested model',
+                   required_hash,
+                   :invoice_rows,
+                   nested_model_hash,
+                   [ Fortnox::API::Types::InvoiceRow.new( nested_model_hash ) ]
+
+  include_examples '.save with specially named attribute',
+                   required_hash,
+                   :ocr,
+                   '426523791'
+
+  # 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', 60
+
+  include_examples '.find', 1
+
+  include_examples '.search', :customername, 'Test', 3
+
+  include_examples '.only', :fullypaid, 1
 end

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

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'fortnox/api'
+require 'fortnox/api/mappers'
+require 'fortnox/api/repositories/order'
+require 'fortnox/api/repositories/examples/all'
+require 'fortnox/api/repositories/examples/find'
+require 'fortnox/api/repositories/examples/only'
+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
+  subject(:repository){ described_class.new }
+
+  required_hash = { customer_number: '1' }
+
+  include_examples '.save', :comments, required_hash
+
+  nested_model_hash = { price: 10, article_number: '0000', 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
+
+  include_examples '.find', 1
+
+  include_examples '.search', :customername, 'A customer', 2
+
+  include_examples '.only', :cancelled, 3
+end

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

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'fortnox/api/types'
+require 'fortnox/api/types/examples/types'
+
+describe Fortnox::API::Types do
+  let( :klass ){ Fortnox::API::Types::AccountNumber }
+
+  context 'AccountNumber created with nil' do
+    subject{ klass[ nil ] }
+    it{ is_expected.to be_nil }
+  end
+
+  context 'AccountNumber created with empty string' do
+    include_examples 'raises ConstraintError', ''
+  end
+
+  context 'AccountNumber created with valid number' do
+    include_examples 'equals input', 1234
+  end
+
+  context 'AccountNumber created with a too large number' do
+    include_examples 'raises ConstraintError', 10000
+  end
+
+  context 'AccountNumber created with a negative number' do
+    include_examples 'raises ConstraintError', -1
+  end
+end

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

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'fortnox/api/types/default_delivery_types'
+
+RSpec.describe Fortnox::API::Types::DefaultDeliveryTypes, type: :type do
+  subject{ described_class }
+
+  it{ is_expected.to have_default_delivery_type( :invoice ) }
+  it{ is_expected.to have_default_delivery_type( :order ) }
+  it{ is_expected.to have_default_delivery_type( :offer ) }
+end

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

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'fortnox/api/types/edi_information'
+
+RSpec.describe Fortnox::API::Types::EDIInformation, type: :type do
+  subject{ described_class }
+
+  it{ is_expected.to have_nullable_string( :edi_global_location_number ) }
+  it{ is_expected.to have_nullable_string( :edi_global_location_number_delivery ) }
+  it{ is_expected.to have_nullable_string( :edi_invoice_extra1 ) }
+  it{ is_expected.to have_nullable_string( :edi_invoice_extra2 ) }
+  it{ is_expected.to have_nullable_string( :edi_our_electronic_reference ) }
+  it{ is_expected.to have_nullable_string( :edi_your_electronic_reference ) }
+end

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

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'fortnox/api/types/email_information'
+
+RSpec.describe Fortnox::API::Types::EmailInformation, type: :type do
+  subject{ described_class }
+
+  it{ is_expected.to have_email( :email_address_to ) }
+  it{ is_expected.to have_email( :email_address_cc ) }
+  it{ is_expected.to have_email( :email_address_bcc ) }
+
+  it{ is_expected.to have_sized_string( :email_subject, 100 ) }
+  it{ is_expected.to have_sized_string( :email_body, 20000 ) }
+end

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

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'fortnox/api/types'
+require 'fortnox/api/types/examples/types'
+
+describe Fortnox::API::Types do
+  let( :klass ){ Fortnox::API::Types::Email }
+
+  context 'Email created with nil' do
+    subject{ klass[ nil ] }
+    it{ is_expected.to be_nil }
+  end
+
+  context 'Email created with empty string' do
+    subject{ klass[ '' ] }
+    it{ is_expected.to eq('') }
+  end
+
+  context 'Email created with valid email' do
+    subject{ klass[ input ] }
+    let( :input ){ 'test@example.com' }
+    it{ is_expected.to eq input }
+  end
+
+  context 'Email created with more than 1024 characters' do
+    legal_characters = 'abcdefghijklmnopqrstuvwxyz-_+'.split('')
+    too_long_email = (legal_characters * 35).shuffle.join + '@example.com'
+    include_examples 'raises ConstraintError', too_long_email
+  end
+end

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

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'fortnox/api/types'
+require 'fortnox/api/types/examples/enum'
+
+describe Fortnox::API::Types do
+  it_behaves_like 'enum', 'CountryCode', 'CountryCodes', auto_crop: true
+  it_behaves_like 'enum', 'Currency', 'Currencies', auto_crop: true
+  it_behaves_like 'enum', 'CustomerType', 'CustomerTypes'
+  it_behaves_like 'enum', 'DiscountType', 'DiscountTypes'
+  it_behaves_like 'enum', 'HouseWorkType', 'HouseWorkTypes'
+  it_behaves_like 'enum', 'VATType', 'VATTypes'
+  it_behaves_like 'enum', 'DefaultDeliveryType', 'DefaultDeliveryTypeValues'
+end

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

@@ -0,0 +1,15 @@
+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_float( :delivered_quantity, 0.0, 9_999_999_999_999.0, valid_hash ) }
+  it{ is_expected.to have_sized_float( :price, 0.0, 99_999_999_999.0, valid_hash ) }
+
+  it{ is_expected.to have_discount_type( :discount_type, valid_hash ) }
+
+  it{ is_expected.to have_sized_integer( :house_work_hours_to_report, 0, 99_999, valid_hash ) }
+
+  it{ is_expected.to have_house_work_type( :house_work_type, valid_hash ) }
+end

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

@@ -0,0 +1,48 @@
+require 'fortnox/api/types/examples/types'
+
+shared_examples_for 'enum' do |name, values, auto_crop: false|
+  describe name do
+    let( :klass ){ Fortnox::API::Types.const_get(name) }
+
+    context 'created with nil' do
+      subject{ klass[ nil ] }
+      it{ is_expected.to be_nil }
+    end
+
+    context 'created with' do
+      subject{ klass[ input ] }
+
+      let( :enum_value ){ Fortnox::API::Types.const_get(values).values.sample }
+
+      context 'a random member from then enum' do
+        let(:input){ enum_value }
+        it{ is_expected.to eq enum_value }
+      end
+
+      context 'a symoblised, random member from the enum' do
+        let( :input ){ enum_value.to_sym }
+        it{ is_expected.to eq enum_value }
+      end
+
+      context 'a lower case, random member from the enum' do
+        let( :input ){ enum_value.downcase }
+        it{ is_expected.to eq enum_value }
+      end
+
+      context 'a string that starts like a random member from the enum' do
+        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) }
+        end
+      end
+    end
+
+    context 'created with invalid input' do
+      include_examples 'raises ConstraintError', 'r4nd0m'
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+shared_examples_for 'equals input' do |input|
+  subject{ klass[ input ] }
+  it{ is_expected.to eq input }
+end
+
+shared_examples_for 'raises ConstraintError' do |input|
+  subject{ ->{ klass[ input ] } }
+  it{ is_expected.to raise_error(Dry::Types::ConstraintError) }
+end

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

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'fortnox/api'
+require 'fortnox/api/types'
+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
+  let(:repository){ Fortnox::API::Repository::Order.new }
+  let(:valid_model) do
+    Fortnox::API::Model::Order.new(customer_number: '1', order_rows: [order_row])
+  end
+  let(:order_row){ Fortnox::API::Types::OrderRow.new(ordered_quantity: 1,
+                                                     article_number: '0000',
+                                                     house_work_type: house_work_type)}
+
+  shared_examples_for 'house work type' do |type, legacy: false|
+    subject do
+      -> do
+        VCR.use_cassette( "orders/house_work_type_#{ type.downcase }" ) do
+          repository.save(valid_model)
+        end
+      end
+    end
+
+    let(:error_message){ 'Skattereduktion för en av de valda husarbetestyperna har upphört.' }
+    let(:house_work_type){ Fortnox::API::Types::HouseWorkTypes[type] }
+
+    context "when creating an OrderRow with house_work_type set to #{ type }" do
+      if legacy
+        it 'raises an error' do
+          is_expected.to raise_error(Fortnox::API::RemoteServerError, error_message)
+        end
+      else
+        it{ is_expected.not_to raise_error }
+      end
+    end
+  end
+
+  it_behaves_like 'house work type', 'CONSTRUCTION'
+  it_behaves_like 'house work type', 'ELECTRICITY'
+  it_behaves_like 'house work type', 'GLASSMETALWORK'
+  it_behaves_like 'house work type', 'GROUNDDRAINAGEWORK'
+  it_behaves_like 'house work type', 'MASONRY'
+  it_behaves_like 'house work type', 'PAINTINGWALLPAPERING'
+  it_behaves_like 'house work type', 'HVAC'
+  it_behaves_like 'house work type', 'CLEANING'
+  it_behaves_like 'house work type', 'TEXTILECLOTHING'
+  it_behaves_like 'house work type', 'CLEANING'
+  it_behaves_like 'house work type', 'SNOWPLOWING'
+  it_behaves_like 'house work type', 'GARDENING'
+  it_behaves_like 'house work type', 'BABYSITTING'
+  it_behaves_like 'house work type', 'OTHERCARE'
+  it_behaves_like 'house work type', 'OTHERCOSTS'
+
+  it_behaves_like 'house work type', 'COOKING', legacy: true
+  it_behaves_like 'house work type', 'TUTORING', legacy: true
+end
+# rubocop:enable RSpec/DescribeClass

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

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'fortnox/api/types/invoice_row'
+require 'fortnox/api/types/examples/document_row'
+
+RSpec.describe Fortnox::API::Types::InvoiceRow, type: :type do
+  subject{ described_class }
+
+  it_behaves_like 'DocumentRow', {}
+end

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

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'dry-struct'
+require 'fortnox/api/types/model'
+
+RSpec.describe Fortnox::API::Types::Model do
+  shared_examples_for 'raises error' do |error|
+    using_test_classes do
+      module Types
+        include Dry::Types.module
+
+        Age = Int.constrained(gt: 18).with(required: true)
+      end
+
+      class TypesModelUser < Fortnox::API::Types::Model
+        attribute :age, Types::Age
+      end
+    end
+
+    describe "User inheriting from #{ described_class }" do
+      subject{ ->{ TypesModelUser.new(args) } }
+
+      it{ is_expected.to raise_error(error) }
+    end
+  end
+
+  context 'without required keys' do
+    include_examples 'raises error', Fortnox::API::MissingAttributeError do
+      let(:args){ {} }
+    end
+  end
+
+  context 'when omitting optional keys' do
+    using_test_class do
+      module Types
+        include Dry::Types.module
+
+        module Nullable
+          String = Types::Strict::String.optional
+        end
+      end
+
+      class User < Fortnox::API::Types::Model
+        attribute :optional_string, Types::Nullable::String
+      end
+    end
+
+    subject{ ->{ User.new() } }
+
+    it{ is_expected.not_to raise_error }
+
+    describe 'optional attribute' do
+      subject{ User.new().optional_string }
+      it{ is_expected.to be nil }
+    end
+  end
+end