fortnox-api 0.1.0 → 0.2.0

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

@@ -0,0 +1,29 @@
+require "fortnox/api/types"
+
+module Fortnox
+  module API
+    module Types
+      class EDIInformation < Types::Model
+        STUB = {}.freeze
+        
+        #EDIGlobalLocationNumber Invoice address GLN for EDI
+        attribute :edi_global_location_number, Types::Nullable::String
+
+        #EDIGlobalLocationNumberDelivery Delivery address GLN for EDI
+        attribute :edi_global_location_number_delivery, Types::Nullable::String
+
+        #EDIInvoiceExtra1 Extra EDI Information
+        attribute :edi_invoice_extra1, Types::Nullable::String
+
+        #EDIInvoiceExtra2 Extra EDI Information
+        attribute :edi_invoice_extra2, Types::Nullable::String
+
+        #EDIOurElectronicReference Our electronic reference for EDI
+        attribute :edi_our_electronic_reference, Types::Nullable::String
+
+        #EDIYourElectronicReference Your electronic reference for EDI
+        attribute :edi_your_electronic_reference, Types::Nullable::String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require "fortnox/api/types"
+
+module Fortnox
+  module API
+    module Types
+      class EmailInformation < Types::Model
+        STUB = {}.freeze
+
+        #EmailAddressTo Customer e-mail address. Must be a valid e-mail address. 1024 characters
+        attribute :email_address_to, Types::Email
+
+        #EmailAddressCC Customer e-mail address – Carbon copy. Must be a valid e-mail address. 1024 characters
+        attribute :email_address_cc, Types::Email
+
+        #EmailAddressBCC Customer e-mail address – Blind carbon copy. Must be a valid e-mail address. 1024 characters
+        attribute :email_address_bcc, Types::Email
+
+        #EmailSubject Subject of the e-mail, 100 characters.
+        attribute :email_subject, Types::Sized::String[ 100 ]
+
+        #EmailBody Body of the e-mail, 20000 characters.
+        attribute :email_body, Types::Sized::String[ 20000 ]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+module Fortnox
+  module API
+    module Types
+
+      module EnumConstructors
+        def self.sized( size )
+          -> (value){ return nil if value == ''; value.to_s.upcase[0...size] unless value.nil? }
+        end
+
+        def self.default
+          -> (value){ return nil if value == ''; value.to_s.upcase unless value.nil? }
+        end
+      end
+
+      DiscountTypes = Types::Strict::String.enum(
+        'AMOUNT','PERCENT'
+      )
+      CURRENT_HOUSE_WORK_TYPES = [
+        'CONSTRUCTION','ELECTRICITY','GLASSMETALWORK','GROUNDDRAINAGEWORK',
+        'MASONRY','PAINTINGWALLPAPERING','HVAC','CLEANING','TEXTILECLOTHING',
+        'SNOWPLOWING','GARDENING','BABYSITTING','OTHERCARE', 'OTHERCOSTS'
+      ].freeze
+      LEGACY_HOUSE_WORK_TYPES = [ 'COOKING', 'TUTORING' ].freeze
+      HouseWorkTypes = Types::Strict::String.enum(
+        *(CURRENT_HOUSE_WORK_TYPES + LEGACY_HOUSE_WORK_TYPES)
+      )
+      CountryCodes = Types::Strict::String.enum(
+        'AF','AX','AL','DZ','AS','AD','AO','AI','AQ','AG','AR','AM','AW','AU',
+        'AT','AZ','BS','BH','BD','BB','BY','BE','BZ','BJ','BM','BT','BO','BQ',
+        'BA','BW','BV','BR','IO','BN','BG','BF','BI','CV','KH','CM','CA','KY',
+        'CF','TD','CL','CN','CX','CC','CO','KM','CG','CD','CK','CR','CI','HR',
+        'CU','CW','CY','CZ','DK','DJ','DM','DO','EC','EG','SV','GQ','ER','EE',
+        'ET','FK','FO','FJ','FI','FR','GF','PF','TF','GA','GM','GE','DE','GH',
+        'GI','GR','GL','GD','GP','GU','GT','GG','GN','GW','GY','HT','HM','VA',
+        'HN','HK','HU','IS','IN','ID','IR','IQ','IE','IM','IL','IT','JM','JP',
+        'JE','JO','KZ','KE','KI','KP','KR','KW','KG','LA','LV','LB','LS','LR',
+        'LY','LI','LT','LU','MO','MK','MG','MW','MY','MV','ML','MT','MH','MQ',
+        'MR','MU','YT','MX','FM','MD','MC','MN','ME','MS','MA','MZ','MM','NA',
+        'NR','NP','NL','NC','NZ','NI','NE','NG','NU','NF','MP','NO','OM','PK',
+        'PW','PS','PA','PG','PY','PE','PH','PN','PL','PT','PR','QA','RE','RO',
+        'RU','RW','BL','SH','KN','LC','MF','PM','VC','WS','SM','ST','SA','SN',
+        'RS','SC','SL','SG','SX','SK','SI','SB','SO','ZA','GS','SS','ES','LK',
+        'SD','SR','SJ','SZ','SE','CH','SY','TW','TJ','TZ','TH','TL','TG','TK',
+        'TO','TT','TN','TR','TM','TC','TV','UG','UA','AE','GB','US','UM','UY',
+        'UZ','VU','VE','VN','VG','VI','WF','EH','YE','ZM','ZW'
+      )
+      Currencies = Types::Strict::String.enum(
+        'AED','AFN','ALL','AMD','ANG','AOA','ARS','AUD','AWG','AZN','BAM','BBD',
+        'BDT','BGN','BHD','BIF','BMD','BND','BOB','BOV','BRL','BSD','BTN','BWP',
+        'BYR','BZD','CAD','CDF','CHE','CHF','CHW','CLF','CLP','CNY','COP','COU',
+        'CRC','CUP','CVE','CZK','DJF','DKK','DOP','DZD','EGP','ERN','ETB','EUR',
+        'FJD','FKP','GBP','GEL','GHS','GIP','GMD','GNF','GTQ','GYD','HKD','HNL',
+        'HRK','HTG','HUF','IDR','ILS','INR','IQD','IRR','ISK','JMD','JOD','JPY',
+        'KES','KGS','KHR','KUR','KMF','KPW','KRW','KWD','KYD','KZT','LAK','LBP',
+        'LKR','LRD','LSL','LYD','MAD','MDL','MGA','MKD','MMK','MNT','MOP','MRO',
+        'MUR','MVR','MWK','MXN','MXV','MYR','MZN','NAD','NGN','NIO','NOK','NPR',
+        'NZD','OMR','PAB','PEN','PGK','PHP','PKR','PLN','PYG','QAR','RON','RSD',
+        'RUB','RWF','SAR','SBD','SCR','SDG','SEK','SGD','SHP','SLL','SOS','SRD',
+        'SSP','STD','SYP','SZL','THB','TJS','TMM','TND','TOP','TRY','TTD','TWD',
+        'TZS','UAH','UGX','USD','USN','USS','UYU','UZS','VEF','VND','VUV','WST',
+        'XAF','XAG','XAU','XBA','XBB','XBC','XBD','XCD','XDR','XFU','XOF','XPD',
+        'XPF','XPT','XTS','XXX','YER','ZAR','ZMK','ZWD'
+      )
+      CustomerTypes = Types::Strict::String.enum(
+        'PRIVATE', 'COMPANY'
+      )
+      VATTypes = Types::Strict::String.enum(
+        'SEVAT', 'SEREVERSEDVAT', 'EUREVERSEDVAT', 'EUVAT', 'EXPORT'
+      )
+      DefaultDeliveryTypeValues = Types::Strict::String.enum(
+        'PRINT', 'EMAIL', 'PRINTSERVICE'
+      )
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+require "fortnox/api/types/document_row"
+
+module Fortnox
+  module API
+    module Types
+      class InvoiceRow < Fortnox::API::Types::Model
+        STUB = {}.freeze
+        
+        DocumentRow.ify self
+
+        #PriceExcludingVAT Price per unit excluding VAT.
+        attribute :price_excluding_vat, Types::Nullable::Float.with( private: true )
+
+        #TotalExcludingVAT  Total amount for the row excluding VAT.
+        attribute :total_excluding_vat, Types::Nullable::Float.with( private: true )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Fortnox
+  module API
+    module Types
+      class Model < Dry::Struct
+        constructor_type(:schema)
+
+        def initialize( input_attributes )
+          if (missing_key = first_missing_required_key( input_attributes ))
+            raise Fortnox::API::MissingAttributeError.new( "Missing attribute #{ missing_key.inspect } in attributes: #{ input_attributes }" )
+          end
+
+          super
+        end
+
+      private
+
+        def missing_keys( attributes )
+          non_nil_attributes = attributes.select{ |_,value| !value.nil? }
+
+          attribute_keys = non_nil_attributes.keys
+          schema_keys =  self.class.schema.keys
+
+          schema_keys - attribute_keys
+        end
+
+        def first_missing_required_key( attributes )
+          all_missing_keys = missing_keys( attributes )
+          missing_required = all_missing_keys.select do |name|
+            attribute = self.class.schema[ name ]
+            next unless attribute.respond_to? :options
+            attribute.options[:required]
+          end
+
+          missing_required.first
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require 'date'
+
+module Fortnox
+  module API
+    module Types
+
+      module Nullable
+        String = Types::Strict::String.optional.constructor{ |value| value.to_s unless value.nil? }
+        Float = Types::Strict::Float.optional.constructor{ |value| value.to_f unless value.nil? }
+        Integer = Types::Strict::Int.optional.constructor{ |value| value.to_i unless value.nil? }
+        Boolean = Types::Bool.optional.constructor{ |value| THE_TRUTH.fetch( value ){ false } }
+        # TODO: Improve parsing!
+        # In case date parsing fails, ArgumentError is thrown. Currently, it is rescued in Repository::Loaders.find.
+        # That method assumes that the exception is due to invalid argument to the find method, which is not the case
+        # if it is raised from here!
+        Date = Types::Date.optional.constructor{ |value| ::Date.parse( value.to_s ) unless value.nil? || value == '' }
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+require "fortnox/api/types/document_row"
+
+module Fortnox
+  module API
+    module Types
+      class OrderRow < Fortnox::API::Types::Model
+        STUB = { ordered_quantity: 0 }.freeze
+
+        DocumentRow.ify self
+
+        #OrderedQuantity Ordered quantity
+        attribute :ordered_quantity, Types::Required::Float
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Fortnox
+  module API
+    module Types
+
+      module Required
+        String = Types::Strict::String.constructor{ |value| value.to_s unless value.nil? }.with( required: true )
+        Integer = Types::Strict::Int.constructor{ |value| value.to_i unless value.nil? }.with( required: true )
+        Float = Types::Strict::Float.constructor{ |value| value.to_f unless value.nil? }.with( required: true )
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Fortnox
+  module API
+    module Types
+      module Sized
+        module String
+          def self.[]( size )
+            Types::Strict::String.constrained( max_size: size ).optional.constructor{ |value| value.to_s unless value.nil? }
+          end
+        end
+
+        module Integer
+          def self.[]( low, high )
+            Types::Strict::Int.constrained( gteq: low, lteq: high ).optional.constructor{ |value| value.to_i unless value.nil? }
+          end
+        end
+
+        module Float
+          def self.[]( low, high )
+            Types::Strict::Float.constrained( gteq: low, lteq: high ).optional.constructor{ |value| value.to_f unless value.nil? }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fortnox/api/version.rb

@@ -1,5 +1,5 @@
 module Fortnox
   module API
-    VERSION = "0.1.0"
+    VERSION = "0.2.0".freeze
   end
 end

data/spec/fortnox/api/base_spec.rb

@@ -2,20 +2,28 @@ require 'spec_helper'
 require 'fortnox/api'
 
 describe Fortnox::API::Base do
+  include Helpers::Environment
 
   describe 'creation' do
+    before do
+      stub_environment('FORTNOX_API_BASE_URL' => nil,
+                       'FORTNOX_API_CLIENT_SECRET' => nil,
+                       'FORTNOX_API_ACCESS_TOKEN' => nil)
+    end
 
-    subject{ ->{ Fortnox::API::Base.new() } }
+    subject{ ->{ described_class.new() } }
 
     context 'without FORTNOX_API_BASE_URL' do
-      before{ ENV['FORTNOX_API_BASE_URL'] = nil }
+      before do
+        stub_environment('FORTNOX_API_BASE_URL' => nil)
+      end
 
       it{ is_expected.to raise_error( ArgumentError, /base url/ ) }
     end
 
     context 'without FORTNOX_API_CLIENT_SECRET' do
       before do
-        stub_const('ENV', ENV.to_hash.merge('FORTNOX_API_BASE_URL' => 'xxx'))
+        stub_environment('FORTNOX_API_BASE_URL' => 'xxx')
       end
 
       it{ is_expected.to raise_error( ArgumentError, /client secret/ ) }
@@ -23,8 +31,8 @@ describe Fortnox::API::Base do
 
     context 'without FORTNOX_API_ACCESS_TOKEN' do
       before do
-        stub_const('ENV', ENV.to_hash.merge('FORTNOX_API_BASE_URL' => 'xxx',
-                                            'FORTNOX_API_CLIENT_SECRET' => 'xxx'))
+        stub_environment('FORTNOX_API_BASE_URL' => 'xxx',
+                         'FORTNOX_API_CLIENT_SECRET' => 'xxx')
       end
 
       it{ is_expected.to raise_error( ArgumentError, /access token/ ) }
@@ -34,9 +42,11 @@ describe Fortnox::API::Base do
 
   context 'making a request including the proper headers' do
     before do
-      ENV['FORTNOX_API_BASE_URL'] = 'http://api.fortnox.se/3'
-      ENV['FORTNOX_API_CLIENT_SECRET'] = 'P5K5vE3Kun'
-      ENV['FORTNOX_API_ACCESS_TOKEN'] = '3f08d038-f380-4893-94a0-a08f6e60e67a'
+      stub_environment(
+        'FORTNOX_API_BASE_URL' => 'http://api.fortnox.se/3',
+        'FORTNOX_API_CLIENT_SECRET' => 'P5K5vE3Kun',
+        'FORTNOX_API_ACCESS_TOKEN' => '3f08d038-f380-4893-94a0-a08f6e60e67a'
+      )
 
       stub_request(
         :get,
@@ -53,17 +63,78 @@ describe Fortnox::API::Base do
       )
     end
 
-    subject{ Fortnox::API::Base.new.get( '/test', { body: '' }) }
+    subject{ described_class.new.get( '/test', { body: '' }) }
 
     it{ is_expected.to be_nil }
   end
 
+  describe 'making requests with multiple access tokens' do
+
+    before do
+      stub_environment(
+        'FORTNOX_API_BASE_URL' => 'http://api.fortnox.se/3',
+        'FORTNOX_API_CLIENT_SECRET' => 'P5K5vE3Kun',
+        'FORTNOX_API_ACCESS_TOKEN' => '3f08d038-f380-4893-94a0-a08f6e60e67a,aaee8217-0bbd-2e16-441f-668931d582cd'
+      )
+
+      stub_request(
+        :get,
+        'http://api.fortnox.se/3/test',
+      ).with(
+        headers: {
+          'Access-Token' => '3f08d038-f380-4893-94a0-a08f6e60e67a',
+          'Client-Secret' => 'P5K5vE3Kun',
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json',
+        }
+      ).to_return(
+        status: 200,
+        body: '1'
+      )
+
+      stub_request(
+        :get,
+        'http://api.fortnox.se/3/test',
+      ).with(
+        headers: {
+          'Access-Token' => 'aaee8217-0bbd-2e16-441f-668931d582cd',
+          'Client-Secret' => 'P5K5vE3Kun',
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json',
+        }
+      ).to_return(
+        status: 200,
+        body: '2'
+      )
+    end
+
+    context 'with subsequent requests on same object' do
+      let!(:response1){ api.get( '/test', body: '' ) }
+      let!(:response2){ api.get( '/test', body: '' ) }
+      let!(:response3){ api.get( '/test', body: '' ) }
+
+      let(:api){ described_class.new }
+
+      # 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 'raising error from remote server' do
 
     before do
-      ENV['FORTNOX_API_BASE_URL'] = 'http://api.fortnox.se/3'
-      ENV['FORTNOX_API_CLIENT_SECRET'] = 'P5K5vE3Kun'
-      ENV['FORTNOX_API_ACCESS_TOKEN'] = '3f08d038-f380-4893-94a0-a08f6e60e67a'
+      stub_environment(
+        'FORTNOX_API_BASE_URL' => 'http://api.fortnox.se/3',
+        'FORTNOX_API_CLIENT_SECRET' => 'P5K5vE3Kun',
+        'FORTNOX_API_ACCESS_TOKEN' => '3f08d038-f380-4893-94a0-a08f6e60e67a'
+      )
 
       stub_request(
         :post,
@@ -75,14 +146,14 @@ describe Fortnox::API::Base do
       )
     end
 
-    subject{ ->{ Fortnox::API::Base.new.post( '/test', { body: '' }) } }
+    subject{ ->{ described_class.new.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(:each) do |example|
+      around do |example|
         Fortnox::API.debugging = true
         example.run
         Fortnox::API.debugging = false

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

@@ -0,0 +1,70 @@
+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 'JSON conversion'
+
+  before do
+    module Test
+      class BaseMapper
+        include Fortnox::API::Mapper::FromJSON
+      end
+    end
+
+    register_mapper( :categories, Test::CategoryMapper )
+    register_mapper( :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': 30000,
+          '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 30000
+    end
+
+    specify 'converts keys starting with "@" correctly'
+    # do
+    # expect( entity_hash[:url] ).to eq 'someurl@example.com'
+    # 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( entity_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( 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