fortnox-api 0.1.0 → 0.2.0

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

@@ -0,0 +1,76 @@
+require 'spec_helper'
+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!'
+
+  describe 'wrapp_entity_json_hash' do
+    it 'should be tested'
+  end
+
+  # include_context 'JSON conversion'
+
+  # before do
+  #   module Test
+  #     class BaseMapper
+  #       include Fortnox::API::Mapper::ToJSON
+  #     end
+  #   end
+  # end
+
+  # let( :mapper ){ Test::ProductMapper.new }
+
+  # 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
+
+  #   context 'with keys without mapping' do
+  #     specify 'converts correctly' do
+  #       expect( inner_hash['Name'] ).to eq( 'Ford Mustang' )
+  #     end
+  #   end
+
+  #   context 'with keys to filter' do
+  #     specify 'filteres out those keys' do
+  #       expect( inner_hash ).not_to have_key( '@url' )
+  #     end
+  #   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
+
+  #   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
+end

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

@@ -0,0 +1,156 @@
+require 'spec_helper'
+require 'fortnox/api'
+require 'fortnox/api/mappers'
+require 'fortnox/api/mappers/base'
+require 'fortnox/api/mappers/examples/mapper'
+
+describe Fortnox::API::Mapper::Base do
+  it_behaves_like 'mapper', nil, nil, nil, check_constants: false
+
+  shared_examples_for 'simple mapper' do |registry_key, exp_value|
+    subject{ mapper.call( value ) }
+    let( :mapper ){ Fortnox::API::Registry[ registry_key ] }
+    it{ is_expected.to eq( exp_value ) }
+  end
+
+  shared_examples_for 'identity mapper' do |registry_key|
+    subject{ mapper.call( value ) }
+    let( :mapper ){ Fortnox::API::Registry[ registry_key ] }
+    it{ is_expected.to eq( value ) }
+  end
+
+  describe 'string' do
+    include_examples 'identity mapper', :string do
+      let( :value ){ Fortnox::API::Types::Nullable::String[ 'test' ] }
+    end
+  end
+
+  describe 'int' do
+    include_examples 'identity mapper', :int do
+      let( :value ){ Fortnox::API::Types::Nullable::Integer[ 1337 ] }
+    end
+  end
+
+  describe 'float' do
+    include_examples 'identity mapper', :float do
+      let( :value ){ Fortnox::API::Types::Nullable::Float[ 13.37 ] }
+    end
+  end
+
+  describe 'boolean' do
+    include_examples 'identity mapper', :boolean do
+      let( :value ){ Fortnox::API::Types::Nullable::Boolean[ false ] }
+    end
+  end
+
+  describe 'array' do
+    include_examples 'identity mapper', :array do
+      let( :value ){ [1,3,3,7] }
+    end
+  end
+
+  describe 'advanced array' do
+    include_examples 'simple mapper', :array, [ "2016-01-01", "2016-01-02" ] do
+      let( :value ){ [ Date.new(2016, 1, 1), Date.new(2016, 1, 2) ] }
+    end
+  end
+
+  describe 'hash' do
+    include_examples 'identity mapper', :hash do
+      let( :value ){ { string: 'test', int: 1337, float: 13.37 } }
+    end
+  end
+
+  describe 'advanced hash' do
+    expected_hash = {
+      string: 'test',
+      date_array: [ "2016-01-01", "2016-01-02"],
+      nested_hash: { date: "2016-01-03", string: 'test' }
+    }
+    include_examples 'identity mapper', :hash, expected_hash do
+      let( :value ) do
+        {
+          string: 'test',
+          date_array: [Date.new(2016, 1, 1), Date.new(2016, 1, 2)],
+          nested_hash: { date: Date.new(2016, 1, 3), string: 'test' }
+        }
+      end
+    end
+  end
+
+  describe 'trueclass' do
+    include_examples 'identity mapper', :trueclass do
+      let( :value ){ true }
+    end
+  end
+  describe 'falseclass' do
+    include_examples 'identity mapper', :falseclass do
+      let( :value ){ false }
+    end
+  end
+
+  describe 'date' do
+    include_examples 'simple mapper', :date, "2016-01-01" do
+      let( :value ){ Date.new(2016, 1, 1) }
+    end
+  end
+
+  describe 'nilclass' do
+    include_examples 'identity mapper', :nilclass do
+      let( :value ){ Fortnox::API::Types::Nullable::String[ nil ] }
+    end
+  end
+
+  describe 'AccountNumber' do
+    include_examples 'identity mapper', :account_number do
+      let( :value ){ Fortnox::API::Types::AccountNumber[ 1234 ] }
+    end
+  end
+
+  describe 'CountryCode' do
+    include_examples 'identity mapper', :country_code do
+      let( :value ){ Fortnox::API::Types::CountryCode[ 'SE' ] }
+    end
+  end
+
+  describe 'Currency' do
+    include_examples 'identity mapper', :currency do
+      let( :value ){ Fortnox::API::Types::Currency[ 'SEK' ] }
+    end
+  end
+
+  describe 'CustomerType' do
+    include_examples 'identity mapper', :customer_type do
+      let( :value ){ Fortnox::API::Types::CustomerType[ 'PRIVATE' ] }
+    end
+  end
+
+  describe 'DiscountType' do
+    include_examples 'identity mapper', :discount_type do
+      let( :value ){ Fortnox::API::Types::DiscountType[ 'PERCENT' ] }
+    end
+  end
+
+  describe 'Email' do
+    include_examples 'identity mapper', :email do
+      let( :value ){ Fortnox::API::Types::Email[ 'email@example.com' ] }
+    end
+  end
+
+  describe 'HouseWorkType' do
+    include_examples 'identity mapper', :house_work_type do
+      let( :value ){ Fortnox::API::Types::HouseWorkType[ 'CONSTRUCTION' ] }
+    end
+  end
+
+  describe 'VATType' do
+    include_examples 'identity mapper', :vat_type do
+      let( :value ){ Fortnox::API::Types::VATType[ 'SEVAT' ] }
+    end
+  end
+
+  describe '#canonical_name_sym' do
+    subject{ described_class.canonical_name_sym }
+    it{ is_expected.to eq( described_class.name.split( '::' ).last.downcase.to_sym ) }
+  end
+end

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

@@ -0,0 +1,56 @@
+require 'fortnox/api'
+require 'fortnox/api/mappers'
+
+shared_context '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'.freeze
+        JSON_COLLECTION_WRAPPER = 'Products'.freeze
+      end
+
+      class Category < Fortnox::API::Model::Base
+        attribute :name, 'strict.string'
+        attribute :id, 'strict.string'
+      end
+
+      class ProductDesigner < Fortnox::API::Model::Base
+        attribute :name, 'strict.string'
+        attribute :id, 'strict.string'
+      end
+
+      class Product < Fortnox::API::Model::Base
+        attribute :url, 'strict.string'
+        attribute :name, 'strict.string'
+        attribute :vat, 'strict.float'
+        attribute :categories, Dry::Types['coercible.array'].member( Test::Category )
+        attribute :designer, Test::ProductDesigner
+      end
+    end
+
+    def register_mapper( mapper_sym, mapper )
+      unless Fortnox::API::Registry.key? mapper_sym
+        Fortnox::API::Registry.register( mapper_sym, mapper )
+      end
+    end
+
+    register_mapper( :category, Test::CategoryMapper)
+    register_mapper( :productdesigner, Test::ProductDesignerMapper )
+    register_mapper( :product, Test::ProductMapper )
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'fortnox/api'
+require 'fortnox/api/mappers/customer'
+require 'fortnox/api/mappers/examples/mapper'
+
+describe Fortnox::API::Mapper::Customer do
+  key_map =
+    {
+      vat_type: 'VATType',
+      vat_number: 'VATNumber',
+      email_invoice_bcc: 'EmailInvoiceBCC',
+      email_invoice_cc: 'EmailInvoiceCC',
+      email_offer_bcc: 'EmailOfferBCC',
+      email_offer_cc: 'EmailOfferCC',
+      email_order_bcc: 'EmailOrderBCC',
+      email_order_cc: 'EmailOrderCC',
+      show_price_vat_included: 'ShowPriceVATIncluded'
+    }
+  json_entity_type = 'Customer'
+  json_entity_collection = 'Customers'
+
+  it_behaves_like 'mapper', key_map, json_entity_type, json_entity_collection do
+    let(:mapper){ described_class.new }
+  end
+end

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

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'fortnox/api'
+require 'fortnox/api/mappers/default_delivery_types'
+require 'fortnox/api/mappers/examples/mapper'
+
+describe Fortnox::API::Mapper::DefaultDeliveryTypes do
+  key_map = {}
+
+  it_behaves_like 'mapper', key_map do
+    let(:mapper){ described_class.new }
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'fortnox/api'
+require 'fortnox/api/mappers/edi_information'
+require 'fortnox/api/mappers/examples/mapper'
+
+describe Fortnox::API::Mapper::EDIInformation do
+  key_map = { 
+    edi_global_location_number: 'EDIGlobalLocationNumber',
+    edi_global_location_number_delivery: 'EDIGlobalLocationNumberDelivery',
+    edi_invoice_extra1: 'EDIInvoiceExtra1',
+    edi_invoice_extra2: 'EDIInvoiceExtra2',
+    edi_our_electronic_reference: 'EDIOurElectronicReference',
+    edi_your_electronic_reference: 'EDIYourElectronicReference'
+  }
+  json_entity_type = 'EDIInformation'
+  json_entity_collection = 'EDIInformation'
+
+  it_behaves_like 'mapper', key_map, json_entity_type, json_entity_collection do
+    let(:mapper){ described_class.new }
+  end
+end

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

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'fortnox/api'
+require 'fortnox/api/mappers/email_information'
+require 'fortnox/api/mappers/examples/mapper'
+
+describe Fortnox::API::Mapper::EmailInformation do
+  key_map = { 
+    email_address_bcc: 'EmailAddressBCC',
+    email_address_cc: 'EmailAddressCC'
+  }
+  json_entity_type = 'EmailInformation'
+  json_entity_collection = 'EmailInformation'
+
+  it_behaves_like 'mapper', key_map, json_entity_type, json_entity_collection do
+    let(:mapper){ described_class.new }
+  end
+end

data/spec/fortnox/api/mappers/examples/mapper.rb

@@ -0,0 +1,26 @@
+shared_examples_for 'mapper' do |key_map, json_entity_wrapper = nil, json_collection_wrapper = nil, check_constants: true|
+  it{ is_expected.to respond_to(:wrapped_json_collection_to_entities_hash) }
+  it{ is_expected.to respond_to(:wrapped_json_hash_to_entity_hash) }
+  it{ is_expected.to respond_to(:entity_to_hash) }
+
+  if check_constants
+    describe 'key_map' do
+      subject{ described_class::KEY_MAP }
+      it{ is_expected.to eq(key_map) }
+    end
+
+    unless json_entity_wrapper.nil?
+      describe 'json_entity_wrapper' do
+        subject{ described_class::JSON_ENTITY_WRAPPER }
+        it{ is_expected.to eq(json_entity_wrapper) }
+      end
+    end
+
+    unless json_collection_wrapper.nil?
+      describe 'json_collection_wrapper' do
+        subject{ described_class::JSON_COLLECTION_WRAPPER }
+        it{ is_expected.to eq(json_collection_wrapper) }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'fortnox/api'
+require 'fortnox/api/mappers/invoice_row'
+require 'fortnox/api/mappers/examples/mapper'
+
+describe Fortnox::API::Mapper::InvoiceRow do
+  key_map = {
+    vat: 'VAT',
+    price_excluding_vat: 'PriceExcludingVAT',
+    total_excluding_vat: 'TotalExcludingVAT'
+  }
+
+  json_entity_type = 'InvoiceRow'
+  json_entity_collection = 'InvoiceRows'
+
+  it_behaves_like 'mapper', key_map, json_entity_type, json_entity_collection do
+    let(:mapper){ described_class.new }
+  end
+end

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

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'fortnox/api'
+require 'fortnox/api/mappers/invoice'
+require 'fortnox/api/mappers/examples/mapper'
+
+describe Fortnox::API::Mapper::Invoice do
+  key_map =
+    {
+      administration_fee_vat: 'AdministrationFeeVAT',
+      edi_information: 'EDIInformation',
+      eu_quarterly_report: 'EUQuarterlyReport',
+      freight_vat: 'FreightVAT',
+      ocr: 'OCR',
+      total_vat: 'TotalVAT',
+      vat_included: 'VATIncluded'
+    }
+
+  json_entity_type = 'Invoice'
+  json_entity_collection = 'Invoices'
+
+  it_behaves_like 'mapper', key_map, json_entity_type, json_entity_collection do
+    let(:mapper){ described_class.new }
+  end
+end

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

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'fortnox/api'
+require 'fortnox/api/mappers/order_row'
+require 'fortnox/api/mappers/examples/mapper'
+
+describe Fortnox::API::Mapper::OrderRow do
+  key_map = { vat: 'VAT' }
+  json_entity_type = 'OrderRow'
+  json_entity_collection = 'OrderRows'
+
+  it_behaves_like 'mapper', key_map, json_entity_type, json_entity_collection do
+    let(:mapper){ described_class.new }
+  end
+end