fortnox-api 0.4.0 → 0.5.0

data/lib/fortnox/api/models/document_base.rb

@@ -44,13 +44,13 @@ module Fortnox
             base.attribute :contribution_value, Types::Nullable::Float.with( read_only: true )
 
             # Country Country for the document address.
-            base.attribute :country, Fortnox::API::Types::CountryCode
+            base.attribute :country, Types::CountryCode
 
             # CostCenter Code of the cost center.
             base.attribute :cost_center, Types::Nullable::String
 
             # Currency Code of the currency.
-            base.attribute :currency, Fortnox::API::Types::Currency
+            base.attribute :currency, Types::Currency
 
             # CurrencyRate Currency rate used for the document
             base.attribute :currency_rate, Types::Nullable::Float
@@ -74,7 +74,7 @@ module Fortnox
             base.attribute :delivery_city, Types::Sized::String[ 1024 ]
 
             # DeliveryCountry Country for the document delivery address.
-            base.attribute :delivery_country, Fortnox::API::Types::CountryCode
+            base.attribute :delivery_country, Types::CountryCode
 
             # DeliveryDate Date of delivery.
             base.attribute :delivery_date, Types::Nullable::Date
@@ -98,7 +98,7 @@ module Fortnox
             base.attribute :external_invoice_reference2, Types::Sized::String[ 80 ]
 
             # Freight Freight cost of the document. 12 digits (incl. decimals)
-            base.attribute :freight, Types::Sized::Float[ 0.0, 99_999_999_999.0 ]
+            base.attribute :freight, Types::Sized::Float[ 0.0, 99_999_999_999.9 ]
 
             # FreightVAT VAT of the freight cost.
             base.attribute :freight_vat, Types::Nullable::Float.with( read_only: true )

data/lib/fortnox/api/repositories/article.rb

@@ -5,10 +5,9 @@ require "fortnox/api/mappers/article"
 module Fortnox
   module API
     module Repository
-      class Article < Fortnox::API::Repository::Base
-
-        MODEL = Fortnox::API::Model::Article
-        MAPPER = Fortnox::API::Mapper::Article
+      class Article < Base
+        MODEL = Model::Article
+        MAPPER = Mapper::Article
         URI = '/articles/'.freeze
       end
     end

data/lib/fortnox/api/repositories/base.rb

@@ -1,24 +1,76 @@
-require "fortnox/api/base"
+require 'httparty'
+require 'fortnox/api/request_handling'
 require "fortnox/api/repositories/base/loaders"
 require "fortnox/api/repositories/base/savers"
 
 module Fortnox
   module API
     module Repository
-      class Base < Fortnox::API::Base
-
+      class Base
+        include HTTParty
+        include Fortnox::API::RequestHandling
         include Loaders
         include Savers
 
+        HTTParty::Parser::SupportedFormats[ "text/html" ] = :json
+
+        DEFAULT_HEADERS = {
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json',
+        }.freeze
+
+        HTTP_METHODS = [ :get, :put, :post, :delete ].freeze
+
+        attr_accessor :headers
         attr_reader :mapper, :keys_filtered_on_save
 
-        def initialize( keys_filtered_on_save: [ :url ] )
-          super()
+        def self.set_headers( headers = {} )
+          self.headers.merge!( headers )
+        end
+
+        HTTP_METHODS.each do |method|
+          define_method method do |*args|
+            self.headers['Access-Token'] = next_access_token
+            execute do |remote|
+              remote.send( method, *args )
+            end
+          end
+        end
+
+        def initialize( keys_filtered_on_save: [ :url ], token_store: :default )
+          self.class.base_uri( get_base_url )
+
+          self.headers = DEFAULT_HEADERS.merge({
+            'Client-Secret' => get_client_secret,
+          })
 
           @keys_filtered_on_save = keys_filtered_on_save
+          @token_store = token_store
           @mapper = Registry[ Mapper::Base.canonical_name_sym( self.class::MODEL )].new
         end
 
+        def next_access_token
+          @access_tokens ||= CircularQueue.new( *get_access_tokens )
+          @access_tokens.next
+        end
+
+        def check_access_tokens!( tokens )
+          if tokens == nil or tokens.empty?
+            fail MissingConfiguration, "You have not provided any access tokens in token store #{ @token_store.inspect }."
+          end
+        end
+
+        def get_access_tokens
+          begin
+            tokens = config.token_store.fetch( @token_store )
+          rescue KeyError
+            token_store_not_found!( @token_store.inspect )
+          end
+
+          check_access_tokens!( tokens )
+          tokens
+        end
+
         private
 
           def instantiate( hash )
@@ -27,6 +79,26 @@ module Fortnox
             self.class::MODEL.new( hash )
           end
 
+          def get_base_url
+            base_url = config.base_url
+            fail MissingConfiguration, 'You have to provide a base url.' unless base_url
+            base_url
+          end
+
+          def get_client_secret
+            client_secret = config.client_secret
+            fail MissingConfiguration, 'You have to provide your client secret.' unless client_secret
+            client_secret
+          end
+
+          def config
+            Fortnox::API.config
+          end
+
+          def token_store_not_found!( store_name )
+            fail MissingConfiguration,
+                 "There is no token store named #{ store_name }."
+          end
       end
     end
   end

data/lib/fortnox/api/repositories/base/savers.rb

@@ -19,13 +19,13 @@ module Fortnox
 
         def save_new( entity )
           execute_save( entity ) do |body|
-            post( self.class::URI, { body: body })
+            post( self.class::URI, { body: body } )
           end
         end
 
         def update_existing( entity )
           execute_save( entity ) do |body|
-            put( get_update_url_for( entity ), { body: body })
+            put( get_update_url_for( entity ), { body: body } )
           end
         end
 

data/lib/fortnox/api/repositories/customer.rb

@@ -5,10 +5,9 @@ require "fortnox/api/mappers/customer"
 module Fortnox
   module API
     module Repository
-      class Customer < Fortnox::API::Repository::Base
-
-        MODEL = Fortnox::API::Model::Customer
-        MAPPER = Fortnox::API::Mapper::Customer
+      class Customer < Base
+        MODEL = Model::Customer
+        MAPPER = Mapper::Customer
         URI = '/customers/'.freeze
       end
     end

data/lib/fortnox/api/repositories/invoice.rb

@@ -5,10 +5,9 @@ require "fortnox/api/mappers/invoice"
 module Fortnox
   module API
     module Repository
-      class Invoice < Fortnox::API::Repository::Base
-
-        MODEL = Fortnox::API::Model::Invoice
-        MAPPER = Fortnox::API::Mapper::Invoice
+      class Invoice < Base
+        MODEL = Model::Invoice
+        MAPPER = Mapper::Invoice
         URI = '/invoices/'.freeze
       end
     end

data/lib/fortnox/api/repositories/order.rb

@@ -5,10 +5,9 @@ require "fortnox/api/mappers/order"
 module Fortnox
   module API
     module Repository
-      class Order < Fortnox::API::Repository::Base
-
-        MODEL = Fortnox::API::Model::Order
-        MAPPER = Fortnox::API::Mapper::Order
+      class Order < Base
+        MODEL = Model::Order
+        MAPPER = Mapper::Order
         URI = '/orders/'.freeze
       end
     end

data/lib/fortnox/api/repositories/project.rb

@@ -5,9 +5,9 @@ require "fortnox/api/mappers/project"
 module Fortnox
   module API
     module Repository
-      class Project < Fortnox::API::Repository::Base
-        MODEL = Fortnox::API::Model::Project
-        MAPPER = Fortnox::API::Mapper::Project
+      class Project < Base
+        MODEL = Model::Project
+        MAPPER = Mapper::Project
         URI = '/projects/'.freeze
       end
     end

data/lib/fortnox/api/types/document_row.rb

@@ -20,7 +20,7 @@ module Fortnox
             attribute :cost_center, Types::Nullable::String
 
             #DeliveredQuantity Delivered quantity. 14 digits
-            attribute :delivered_quantity, Types::Sized::Float[ 0.0, 9_999_999_999_999.0 ]
+            attribute :delivered_quantity, Types::Sized::Float[ 0.0, 9_999_999_999_999.9 ]
 
             #Description Description Row description. 50 characters
             attribute :description, Types::Sized::String[ 50 ]
@@ -29,7 +29,7 @@ module Fortnox
             # TODO(hannes): Verify that we can send in more than 5 digits through
             # the actual API for DiscountType PERCENT. This cannot be done until
             # we fix issue #62...
-            attribute :discount, Types::Sized::Float[ 0.0, 99_999_999_999.0 ]
+            attribute :discount, Types::Sized::Float[ 0.0, 99_999_999_999.9 ]
 
             #DiscountType The type of discount used for the row.
             attribute :discount_type, Types::DiscountType
@@ -44,7 +44,7 @@ module Fortnox
             attribute :house_work_type, Types::HouseWorkType
 
             #Price Price per unit. 12 digits
-            attribute :price, Types::Sized::Float[ 0.0, 99_999_999_999.0 ]
+            attribute :price, Types::Sized::Float[ 0.0, 99_999_999_999.9 ]
 
             #Project Code of the project for the row.
             attribute :project, Types::Nullable::String

data/lib/fortnox/api/types/model.rb

@@ -24,14 +24,10 @@ module Fortnox
         end
 
         def first_missing_required_key( attributes )
-          all_missing_keys = missing_keys( attributes )
-          missing_required = all_missing_keys.select do |name|
+          missing_keys( attributes ).find do |name|
             attribute = self.class.schema[ name ]
-            next unless attribute.respond_to? :options
-            attribute.options[:required]
+            attribute.respond_to?(:options) && attribute.options[:required]
           end
-
-          missing_required.first
         end
       end
 

data/lib/fortnox/api/version.rb

@@ -1,5 +1,5 @@
 module Fortnox
   module API
-    VERSION = "0.4.0".freeze
+    VERSION = "0.5.0".freeze
   end
 end

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

@@ -49,6 +49,12 @@ describe Fortnox::API::Mapper::Base do
     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) ] }

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

@@ -9,6 +9,10 @@ require 'fortnox/api/repositories/examples/save_with_specially_named_attribute'
 require 'fortnox/api/repositories/examples/search'
 
 describe Fortnox::API::Repository::Article, order: :defined, integration: true do
+  include Helpers::Configuration
+
+  before{ set_api_test_configuration }
+
   subject(:repository){ described_class.new }
 
   include_examples '.save',

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

@@ -0,0 +1,348 @@
+require 'spec_helper'
+require 'fortnox/api'
+
+describe Fortnox::API::Repository::Base do
+  using_test_class do
+    module Model
+      class Test
+      end
+    end
+    module Repository
+      class Test < Fortnox::API::Repository::Base
+        MODEL = Model::Test
+      end
+    end
+
+    require 'dry/container/stub'
+    Fortnox::API::Registry.enable_stubs!
+    Fortnox::API::Registry.stub( :test, Model::Test )
+  end
+
+  let(:access_token){ '3f08d038-f380-4893-94a0-a08f6e60e67a' }
+  let(:access_token2){ '89feajou-sif8-8f8u-29ja-xdfniokeniod' }
+  let(:client_secret){ 'P5K5vE3Kun' }
+  let(:repository){ Repository::Test.new }
+  let(:application_json){}
+  let(:headers) do
+    {
+      'Access-Token' => access_token,
+      'Client-Secret' => client_secret,
+      'Content-Type' => 'application/json',
+      'Accept' => 'application/json',
+    }
+  end
+
+  describe 'creation' do
+    shared_examples_for 'missing configuration' do
+      subject{ ->{ repository } }
+
+      let(:error){ Fortnox::API::MissingConfiguration }
+
+      it{ is_expected.to raise_error( error, /#{message}/ ) }
+    end
+
+    context 'without base url' do
+      include_examples 'missing configuration' do
+        before{ Fortnox::API.configure{ |conf| conf.base_url = nil } }
+        let(:message){ 'have to provide a base url' }
+      end
+    end
+
+    context 'without client secret' do
+      include_examples 'missing configuration' do
+        before{ Fortnox::API.configure{ |conf| conf.client_secret = nil } }
+        let(:message){ 'have to provide your client secret' }
+      end
+    end
+  end
+
+  describe '#next_access_token' do
+    before{ Fortnox::API.configure{ |conf| conf.client_secret = client_secret } }
+
+    context 'with default token store' do
+      context 'with one access token' do
+        subject{ repository.next_access_token }
+
+        before{ Fortnox::API.configure{ |conf| conf.access_token = access_token } }
+        it{ is_expected.to eql( access_token ) }
+
+        describe 'next request' do
+          before{ repository.next_access_token }
+
+          it 'still uses the same token' do
+            is_expected.to eql( access_token )
+          end
+        end
+      end
+
+      context 'with multiple access tokens' do
+        subject{ access_tokens }
+
+        before{ Fortnox::API.configure{ |conf| conf.access_tokens = access_tokens } }
+        let( :access_tokens ){ [access_token, access_token2] }
+
+        it{ is_expected.to include( repository.next_access_token ) }
+
+        it 'changes token on next request' do
+          token1 = repository.next_access_token
+          token2 = repository.next_access_token
+
+          expect( token1 ).not_to eql( token2 )
+        end
+
+        it 'circulates tokens' do
+          token1 = repository.next_access_token
+          repository.next_access_token
+          token3 = repository.next_access_token
+
+          expect( token1 ).to eql( token3 )
+        end
+      end
+    end
+
+    context 'with multiple stores' do
+      subject{ repository.next_access_token }
+
+      before do 
+        Fortnox::API.configure do |config|
+          config.access_tokens = { store1: access_token, store2: access_token2 }
+        end
+      end
+
+      describe 'first token store' do
+        let( :repository ){ Repository::Test.new( token_store: :store1) }
+
+        it{ is_expected.to eql access_token }
+      end
+
+      describe 'second token store' do
+        let( :repository ){ Repository::Test.new( token_store: :store2 ) }
+
+        it{ is_expected.to eql access_token2 }
+      end
+    end
+  end
+
+  describe '#get_access_tokens' do
+    subject( :get_access_tokens ){ repository.get_access_tokens }
+
+    before{ Fortnox::API.configure{ |conf| conf.client_secret = client_secret } }
+
+    let( :token_store_not_present ){ "no token store named #{ token_store.inspect }." }
+    let( :error ){ Fortnox::API::MissingConfiguration }
+
+    context 'with non existing token store' do
+      subject{ ->{ get_access_tokens } }
+
+      before do
+        Fortnox::API.configure{ |conf| conf.access_tokens = { some_store: [access_token] } }
+      end
+
+      let( :repository ){ Repository::Test.new( token_store: token_store ) }
+      let( :token_store ){ :non_existing_store }
+
+      it{ is_expected.to raise_error( error, /#{token_store_not_present}/ ) }
+    end
+
+    context 'with no tokens set' do
+      subject{ ->{ get_access_tokens } }
+
+      before{ Fortnox::API.configure{ |conf| conf.access_tokens = {} } }
+      let( :token_store ){ :default }
+
+      it{ is_expected.to raise_error( error, /#{token_store_not_present}/) }
+    end
+
+    context 'with one access token in token store' do
+      before{ Fortnox::API.configure{ |conf| conf.access_token = access_token } }
+      let( :token_store ){ :default }
+
+      it{ is_expected.to eql( access_token ) }
+    end
+
+    context 'with multiple access tokens' do
+      before do
+        Fortnox::API.configure{ |conf| conf.access_tokens = [access_token, access_token2] }
+      end
+      let( :token_store ){ :default }
+
+      it{ is_expected.to eql( [access_token, access_token2] ) }
+    end
+
+    context 'with multiple token stores' do
+      before do
+        Fortnox::API.configure do |conf|
+          conf.access_tokens = { store_a: store_a_tokens, store_b: store_b_token }
+        end
+      end
+      let( :store_a_tokens ){ ['token_a1', 'token_a2'] }
+      let( :store_b_token ){ 'token_b1' }
+
+      context 'with valid store name' do
+        let( :repository ){ Repository::Test.new( token_store: :store_a ) }
+
+        it{ is_expected.to eql( store_a_tokens ) }
+      end
+
+      context 'with non collection' do
+        let( :repository ){ Repository::Test.new( token_store: :store_b ) }
+
+        it{ is_expected.to eql( store_b_token ) }
+      end
+
+      context 'with invalid store name' do
+        subject{ ->{ get_access_tokens } }
+
+        let( :repository ){ Repository::Test.new( token_store: :nonsence_store ) }
+
+        it{ is_expected.to raise_error( error ) }
+      end
+    end
+  end
+
+  describe '#check_access_tokens!' do
+    subject{ ->{ repository.check_access_tokens!(tokens) } }
+
+    before{ Fortnox::API.configure{ |conf| conf.client_secret = client_secret } }
+    let( :error ){ Fortnox::API::MissingConfiguration }
+    let( :message ){ "not provided any access tokens in token store #{ token_store.inspect }" }
+    let( :token_store ){ :default }
+
+    context 'with nil' do
+      let( :tokens ){ nil }
+
+      it{ is_expected.to raise_error( error, /#{message}/ ) }
+    end
+
+    context 'with empty array' do
+      let( :tokens ){ [] }
+
+      it{ is_expected.to raise_error( error, /#{message}/ ) }
+    end
+
+    context 'with an empty, non default, token store' do
+      before{ Fortnox::API.configure{ |conf| conf.access_tokens = { token_store => tokens } } }
+      let( :repository ){ Repository::Test.new( token_store: token_store ) }
+      let( :tokens ){ [] }
+      let( :token_store ){ :store1 }
+
+      it{ is_expected.to raise_error( error, /#{message}/ ) }
+    end
+
+    context 'with valid tokens' do
+      let( :tokens ){ ['12345', 'abcde'] }
+
+      it{ is_expected.not_to raise_error }
+    end
+  end
+
+  context 'when making a request including the proper headers' do
+    before do
+      Fortnox::API.configure do |conf|
+        conf.client_secret = client_secret
+        conf.access_token = access_token
+      end
+
+      stub_request(
+        :get,
+        'https://api.fortnox.se/3/test',
+      ).with(
+        headers: headers
+      ).to_return(
+        status: 200
+      )
+    end
+
+    subject{ repository.get( '/test', { body: '' } ) }
+
+    it{ is_expected.to be_nil }
+  end
+
+  describe 'making requests with multiple access tokens' do
+    before do
+      Fortnox::API.configure do |conf|
+        conf.client_secret = client_secret
+        conf.access_tokens = [access_token, access_token2]
+      end
+
+      stub_request(
+        :get,
+        'https://api.fortnox.se/3/test',
+      ).with(
+        headers: {
+          'Access-Token' => access_token,
+          'Client-Secret' => client_secret,
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json',
+        }
+      ).to_return(
+        status: 200,
+        body: '1'
+      )
+
+      stub_request(
+        :get,
+        'https://api.fortnox.se/3/test',
+      ).with(
+        headers: {
+          'Access-Token' => access_token2,
+          'Client-Secret' => client_secret,
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json',
+        }
+      ).to_return(
+        status: 200,
+        body: '2'
+      )
+    end
+
+    context 'with subsequent requests on same object' do
+      let!(:response1){ repository.get( '/test', { body: '' } ) }
+      let!(:response2){ repository.get( '/test', { body: '' } ) }
+      let!(:response3){ repository.get( '/test', { body: '' } ) }
+
+      # rubocop:disable RSpec/MultipleExpectations
+      # All these checks must be run in same it-statement because
+      # of the random starting index.
+      it 'works' do
+        expect(response1).not_to eq( response2 )
+        expect(response1).to eq( response3 )
+        expect(response3).not_to eq( response2 )
+      end
+      # rubocop:enable RSpec/MultipleExpectations
+    end
+  end
+
+  context 'when raising error from remote server' do
+    before do
+      Fortnox::API.configure do |conf|
+        conf.client_secret = client_secret
+        conf.access_tokens = [access_token, access_token2]
+      end
+
+      stub_request(
+        :post,
+        'https://api.fortnox.se/3/test',
+      ).to_return(
+        status: 500,
+        body: { 'ErrorInformation' => { 'error' => 1, 'message' => 'Räkenskapsår finns inte upplagt. För att kunna skapa en faktura krävs det att det finns ett räkenskapsår' } }.to_json,
+        headers: { 'Content-Type' => 'application/json' },
+      )
+    end
+
+    subject{ ->{ repository.post( '/test', { body: '' } ) } }
+
+    it{ is_expected.to raise_error( Fortnox::API::RemoteServerError ) }
+    it{ is_expected.to raise_error( 'Räkenskapsår finns inte upplagt. För att kunna skapa en faktura krävs det att det finns ett räkenskapsår' ) }
+
+    context 'with debugging enabled' do
+      around do |example|
+        Fortnox::API.config.debugging = true
+        example.run
+        Fortnox::API.config.debugging = false
+      end
+
+      it{ is_expected.to raise_error( /\<HTTParty\:\:Request\:0x/ ) }
+    end
+  end
+end