fortnox-api 0.9.2 → 1.0.0.rc2

data/lib/fortnox/api.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require 'set'
-require 'dry-configurable'
-require 'dry-container'
-require 'logger'
-
-require_relative 'api/version'
-
-module Fortnox
-  module API
-    extend Dry::Configurable
-
-    DEFAULT_CONFIGURATION = {
-      base_url: 'https://api.fortnox.se/3/',
-      token_url: 'https://apps.fortnox.se/oauth-v1/token',
-      debugging: false,
-      logger: lambda {
-        logger = Logger.new($stdout)
-        logger.level = Logger::WARN
-        return logger
-      }.call
-    }.freeze
-
-    setting :base_url, default: DEFAULT_CONFIGURATION[:base_url]
-    setting :token_url, default: DEFAULT_CONFIGURATION[:token_url]
-    setting :debugging, default: DEFAULT_CONFIGURATION[:debugging], reader: true
-    setting :logger, default: DEFAULT_CONFIGURATION[:logger], reader: true
-
-    def self.access_token=(token)
-      Thread.current[:access_token] = token
-    end
-
-    def self.access_token
-      Thread.current[:access_token]
-    end
-
-    class Exception < StandardError
-    end
-
-    class AttributeError < Fortnox::API::Exception
-    end
-
-    class RemoteServerError < Fortnox::API::Exception
-    end
-
-    class MissingAttributeError < Fortnox::API::Exception
-    end
-
-    class MissingConfiguration < Fortnox::API::Exception
-    end
-
-    class MissingAccessToken < Fortnox::API::Exception
-    end
-
-    Registry = Dry::Container.new
-  end
-end
-
-require_relative 'api/models'
-require_relative 'api/repositories'
-require_relative 'api/mappers'

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'fortnox/api'
-require 'fortnox/api/mappers/customer'
-require 'fortnox/api/mappers/examples/mapper'
-
-describe Fortnox::API::Mapper::Article do
-  key_map = Fortnox::API::Mapper::Article::KEY_MAP
-
-  json_entity_type = 'Article'
-  json_entity_collection = 'Articles'
-
-  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/base/canonical_name_sym_spec.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'fortnox/api/mappers/base/canonical_name_sym'
-
-describe Fortnox::API::Mapper::CanonicalNameSym do
-  describe '.canonical_name_sym' do
-    context 'with simple class' do
-      subject { TestClass.canonical_name_sym }
-
-      before do
-        test_class = Class.new do
-          extend Fortnox::API::Mapper::CanonicalNameSym
-        end
-
-        stub_const('TestClass', test_class)
-      end
-
-      it { is_expected.to eq(:testclass) }
-    end
-
-    context 'when class included in module' do
-      subject { Something::Test.canonical_name_sym }
-
-      before do
-        test_class = Class.new do
-          extend Fortnox::API::Mapper::CanonicalNameSym
-        end
-
-        stub_const('Something::Test', test_class)
-      end
-
-      it { is_expected.to eq(:test) }
-    end
-  end
-end

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

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'fortnox/api/mappers/base/from_json'
-require 'fortnox/api/mappers/contexts/json_conversion'
-
-describe Fortnox::API::Mapper::FromJSON do
-  include_context 'with JSON conversion'
-
-  before do
-    Test::BaseMapper.class_eval do
-      include Fortnox::API::Mapper::FromJSON # rubocop:disable RSpec/DescribedClass
-    end
-
-    add_to_registry(:categories, Test::CategoryMapper)
-    add_to_registry(:designer, Test::ProductDesignerMapper)
-  end
-
-  let(:mapper) { Test::ProductMapper.new }
-
-  describe 'wrapped_json_hash_to_entity_hash' do
-    let(:entity_hash) { mapper.wrapped_json_hash_to_entity_hash(wrapped_json_hash) }
-    let(:wrapped_json_hash) do
-      {
-        'Product' => {
-          '@url': 'someurl@example.com',
-          Name: 'Ford Mustang',
-          VAT: 30_000,
-          Categories: [{ Name: 'Cars', ID: '1' }, { Name: 'Fast cars', ID: '2' }],
-          Designer: { Name: 'John Najjar', ID: '23' }
-        }
-      }
-    end
-
-    specify 'converts keys without mapping correctly' do
-      expect(entity_hash[:name]).to eq 'Ford Mustang'
-    end
-
-    specify 'converts keys with mapping correctly' do
-      expect(entity_hash[:vat]).to eq 30_000
-    end
-
-    specify 'converts keys starting with "@" correctly'
-    # do
-    # expect( entity_hash[:url] ).to eq 'someurl@example.com'
-    # end
-
-    describe '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(entity_hash[:categories]).to eq(expected_nested_model_hash)
-      end
-    end
-
-    describe 'nested model' do
-      let(:expected_nested_model_hash) { { name: 'John Najjar', id: '23' } }
-
-      specify 'is converted correctly' do
-        expect(entity_hash[:designer]).to eq(expected_nested_model_hash)
-      end
-    end
-  end
-
-  describe 'wrapped_json_collection_to_entities_hash' do
-    it 'is tested'
-  end
-end

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

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'fortnox/api/mappers/base/to_json'
-require 'fortnox/api/mappers/contexts/json_conversion'
-
-describe Fortnox::API::Mapper::ToJSON do
-  include_context 'with JSON conversion'
-
-  before do
-    Test::BaseMapper.class_eval do
-      include Fortnox::API::Mapper::ToJSON # rubocop:disable RSpec/DescribedClass
-    end
-  end
-
-  let(:mapper) { Test::ProductMapper.new }
-
-  describe '#entity_to_hash' do
-    let(:product) do
-      category1 = Test::Category.new(name: 'Cars', id: '1')
-      category2 = Test::Category.new(name: 'Fast Cars', id: '2')
-      product_designer = Test::ProductDesigner.new(name: 'John Najjar', id: '23')
-
-      Test::Product.new(url: 'someurl@example.com',
-                        name: 'Ford Mustang',
-                        vat: 30_000.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
-
-    describe 'keys without mapping' do
-      specify 'converts correctly' do
-        expect(inner_hash['Name']).to eq('Ford Mustang')
-      end
-    end
-
-    describe 'keys to filter' do
-      specify 'filteres out those keys' do
-        expect(inner_hash).not_to have_key('@url')
-      end
-    end
-
-    describe '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
-
-    describe '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

@@ -1,154 +0,0 @@
-# frozen_string_literal: true
-
-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 'integer' do
-    include_examples 'identity mapper', :integer 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 'array with very large int (Bigint if Ruby <2.4)' do
-    include_examples 'identity mapper', :array do
-      let(:value) { [(100**10)] }
-    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 'Country' do
-    subject { mapper.call('GB') }
-
-    let(:mapper) { Fortnox::API::Registry[:countrystring] }
-
-    it { is_expected.to eq('United Kingdom') }
-
-    describe 'special cases' do
-      context 'with SE' do
-        it 'translates code to country name in Swedish' do
-          expect(mapper.call('SE')).to eq('Sverige')
-        end
-      end
-
-      context 'with nil value' do
-        subject { mapper.call(nil) }
-
-        it { is_expected.to be_nil }
-      end
-
-      context 'with empty string' do
-        subject { mapper.call('') }
-
-        it { is_expected.to eq('') }
-      end
-
-      context 'with nonsense' do
-        it 'is not supported (since input is sanitised) and therefore blows up' do
-          expect { mapper.call('nonsense') }.to raise_error(NoMethodError)
-        end
-      end
-    end
-  end
-end

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

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require 'fortnox/api'
-require 'fortnox/api/mappers'
-require 'dry/container/stub'
-
-shared_context 'with JSON conversion' do
-  include Helpers::Configuration
-
-  before do
-    stub_const('Test::BaseMapper', Class.new)
-
-    stub_const('Test::CategoryMapper', Class.new(Test::BaseMapper))
-    stub_const('Test::CategoryMapper::KEY_MAP', { id: 'ID' }.freeze)
-
-    stub_const('Test::ProductDesignerMapper', Class.new(Test::BaseMapper))
-    stub_const('Test::ProductDesignerMapper::KEY_MAP', { id: 'ID' }.freeze)
-
-    stub_const('Test::ProductMapper', Class.new(Test::BaseMapper))
-    stub_const(
-      'Test::ProductMapper::KEY_MAP',
-      {
-        vat: 'VAT',
-        url: '@url' # TODO: How to handle url attribute?
-      }.freeze
-    )
-    stub_const('Test::ProductMapper::JSON_ENTITY_WRAPPER', 'Product')
-    stub_const('Test::ProductMapper::JSON_COLLECTION_WRAPPER', 'Products')
-
-    stub_const(
-      'Test::Category',
-      Class.new(Fortnox::API::Model::Base) do
-        attribute :name, 'strict.string'
-        attribute :id, 'strict.string'
-      end
-    )
-
-    stub_const(
-      'Test::ProductDesigner',
-      Class.new(Fortnox::API::Model::Base) do
-        attribute :name, 'strict.string'
-        attribute :id, 'strict.string'
-      end
-    )
-
-    stub_const(
-      'Test::Product',
-      Class.new(Fortnox::API::Model::Base) do
-        attribute :url, 'strict.string'
-        attribute :name, 'strict.string'
-        attribute :vat, 'strict.float'
-        attribute :categories, Dry::Types['coercible.array'].of(Test::Category)
-        attribute :designer, Test::ProductDesigner
-      end
-    )
-
-    Fortnox::API::Registry.enable_stubs!
-    add_to_registry(:category, Test::CategoryMapper)
-    add_to_registry(:productdesigner, Test::ProductDesignerMapper)
-    add_to_registry(:product, Test::ProductMapper)
-  end
-end

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-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

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-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, nil, nil do
-    let(:mapper) { described_class.new }
-  end
-end

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

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-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

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-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

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-# rubocop:disable Metrics/LineLength
-shared_examples_for 'mapper' do |key_map, json_entity_wrapper = nil, json_collection_wrapper = nil, check_constants: true|
-  # rubocop:enable Metrics/LineLength
-
-  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 { expect(subject).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

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-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 = {
-    housework: 'HouseWork',
-    housework_hours_to_report: 'HouseWorkHoursToReport',
-    housework_type: 'HouseWorkType',
-    price_excluding_vat: 'PriceExcludingVAT',
-    total_excluding_vat: 'TotalExcludingVAT',
-    vat: 'VAT'
-  }
-
-  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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-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',
-      housework: 'HouseWork',
-      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

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-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 = {
-    housework: 'HouseWork',
-    housework_hours_to_report: 'HouseWorkHoursToReport',
-    housework_type: 'HouseWorkType',
-    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