fortnox-api 0.8.0 → 0.9.0

data/lib/fortnox/api/request_handling.rb

@@ -5,30 +5,42 @@ module Fortnox
     module RequestHandling
       private
 
-        def raise_api_error(error, response)
-          message = (error['message'] || error['Message'] || 'Okänt fel')
+      def raise_api_error(error, response)
+        message = (error['message'] || error['Message'] || 'Okänt fel')
 
-          message += "\n\n#{response.request.inspect}" if Fortnox::API.debugging
+        message += "\n\n#{response.request.inspect}" if Fortnox::API.debugging
 
-          raise Fortnox::API::RemoteServerError, message
-        end
+        raise Fortnox::API::RemoteServerError, message
+      end
 
-        def validate_response(response)
-          return if response.code == 200
+      def validate_response(response)
+        return if response.code == 200
 
-          api_error = response.parsed_response['ErrorInformation']
-          raise_api_error(api_error, response) if api_error
-        end
+        raise_content_type_error(response) if response.headers['content-type'].start_with?('text/html')
 
-        def validate_and_parse(response)
-          validate_response(response)
-          response.parsed_response
-        end
+        raise Fortnox::API::RemoteServerError, "Unauthorized request. Error: #{response.body}" if response.code == 401
+        raise Fortnox::API::RemoteServerError, "Forbidden request. Error: #{response.body}" if response.code == 403
 
-        def execute
-          response = yield(self.class)
-          validate_and_parse response
-        end
+        api_error = response.parsed_response['ErrorInformation']
+        raise_api_error(api_error, response) if api_error
+      end
+
+      def raise_content_type_error(response)
+        raise Fortnox::API::RemoteServerError,
+              "Fortnox API's response has content type \"text/html\" instead of requested \"application/json\"." \
+              'This could be due to invalid endpoint or when the API is down. ' \
+              "Body: #{response.body}"
+      end
+
+      def validate_and_parse(response)
+        validate_response(response)
+        response.parsed_response
+      end
+
+      def execute
+        response = yield(self.class)
+        validate_and_parse response
+      end
     end
   end
 end

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types'
-
 module Fortnox
   module API
     module Types

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types'
-
 module Fortnox
   module API
     module Types

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

@@ -22,8 +22,8 @@ module Fortnox
         # DeliveredQuantity Delivered quantity. 14 digits
         attribute :delivered_quantity, Types::Sized::Float[-9_999_999_999_999.9, 9_999_999_999_999.9]
 
-        # Description Description Row description. 50 characters
-        attribute :description, Types::Sized::String[50]
+        # Description Description Row description.
+        attribute :description, Types::Sized::String[255]
 
         # Discount amount. 12 digits (for amount) / 5 digits (for percent)
         # TODO(hannes): Verify that we can send in more than 5 digits through
@@ -45,7 +45,7 @@ module Fortnox
         attribute :housework_type, Types::HouseworkType
 
         # Price Price per unit. 12 digits
-        attribute :price, Types::Sized::Float[0.0, 99_999_999_999.9]
+        attribute :price, Types::Sized::Float[-9_999_999_999, 99_999_999_999.9]
 
         # Project Code of the project for the row.
         attribute :project, Types::Nullable::String

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types'
-
 module Fortnox
   module API
     module Types

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types'
-
 module Fortnox
   module API
     module Types

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

@@ -7,6 +7,7 @@ module Fortnox
         def self.sized(size)
           lambda do |value|
             return nil if value == ''
+
             value.to_s.upcase[0...size] unless value.nil?
           end
         end
@@ -14,14 +15,16 @@ module Fortnox
         def self.default
           lambda do |value|
             return nil if value == ''
-            value.to_s.upcase unless value.nil?
+
+            value&.to_s&.upcase
           end
         end
 
         def self.lower_case
           lambda do |value|
             return nil if value == ''
-            value.to_s.downcase unless value.nil?
+
+            value&.to_s&.downcase
           end
         end
       end
@@ -33,16 +36,29 @@ module Fortnox
         'AMOUNT', 'PERCENT'
       )
       HOUSEWORK_TYPES = {
-        rot: %w[
-          CONSTRUCTION ELECTRICITY GLASSMETALWORK GROUNDDRAINAGEWORK
-          MASONRY PAINTINGWALLPAPERING HVAC OTHERCOSTS
+        rot: [
+          'CONSTRUCTION',
+          'ELECTRICITY',
+          'GLASSMETALWORK',
+          'GROUNDDRAINAGEWORK',
+          'HVAC',
+          'MASONRY',
+          'OTHERCOSTS',
+          'PAINTINGWALLPAPERING'
         ],
-        rut: %w[
-          MAJORAPPLIANCEREPAIR MOVINGSERVICES ITSERVICES CLEANING
-          TEXTILECLOTHING SNOWPLOWING GARDENING BABYSITTING OTHERCARE
-          OTHERCOSTS
+        rut: [
+          'BABYSITTING',
+          'CLEANING',
+          'GARDENING',
+          'ITSERVICES',
+          'MAJORAPPLIANCEREPAIR',
+          'MOVINGSERVICES',
+          'OTHERCARE',
+          'OTHERCOSTS',
+          'SNOWPLOWING',
+          'TEXTILECLOTHING'
         ],
-        legacy_rut: %w[COOKING TUTORING]
+        legacy_rut: ['COOKING', 'TUTORING']
       }.freeze
 
       # TODO: RUT to be added:
@@ -85,7 +101,7 @@ module Fortnox
         'SEVAT', 'SEREVERSEDVAT', 'EUREVERSEDVAT', 'EUVAT', 'EXPORT'
       )
       DefaultDeliveryTypeValues = Types::Strict::String.enum(
-        'PRINT', 'EMAIL', 'PRINTSERVICE'
+        'PRINT', 'EMAIL', 'PRINTSERVICE', 'ELECTRONICINVOICE'
       )
       ProjectStatusTypes = Types::Strict::String.enum(
         'NOTSTARTED', 'ONGOING', 'COMPLETED'

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types/document_row'
+require_relative 'document_row'
 
 module Fortnox
   module API

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

@@ -4,7 +4,7 @@ module Fortnox
   module API
     module Types
       class Model < Dry::Struct
-        constructor_type(:schema)
+        transform_types(&:omittable)
 
         def initialize(input_attributes)
           if (missing_key = first_missing_required_key(input_attributes))
@@ -15,23 +15,19 @@ module Fortnox
           super
         end
 
-        def self.is?(*_args) end
-
         private
 
         def missing_keys(attributes)
-          non_nil_attributes = attributes.reject { |_, value| value.nil? }
-
-          attribute_keys = non_nil_attributes.keys
-          schema_keys =  self.class.schema.keys
+          attribute_keys = attributes.compact.keys
+          schema_keys = self.class.schema.keys.map(&:name)
 
           schema_keys - attribute_keys
         end
 
         def first_missing_required_key(attributes)
           missing_keys(attributes).find do |name|
-            attribute = self.class.schema[name]
-            attribute.respond_to?(:options) && attribute.options[:required]
+            attribute = self.class.schema.keys.find { |key| key.name == name }
+            attribute.type.respond_to?(:options) && attribute.type.options[:required]
           end
         end
       end

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

@@ -6,15 +6,19 @@ 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 == '' }
+        String = Types::Strict::String.optional.constructor { |value| value&.to_s }
+        Float = Types::Strict::Float.optional.constructor { |value| value&.to_f }
+        Integer = Types::Strict::Integer.optional.constructor { |value| value&.to_i }
+        Boolean = Types::Bool.optional.constructor { |value| THE_TRUTH.fetch(value, false) }
+        Date = Types::Date.optional.constructor do |value|
+          next if value.nil? || value == ''
+
+          begin
+            ::Date.parse(value.to_s)
+          rescue ::Date::Error
+            raise Fortnox::API::AttributeError, 'invalid date'
+          end
+        end
       end
     end
   end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types/document_row'
+require_relative 'document_row'
 
 module Fortnox
   module API

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

@@ -4,9 +4,9 @@ module Fortnox
   module API
     module Types
       module Required
-        String = Types::Strict::String.constructor { |value| value.to_s unless value.nil? }.is(:required)
-        Integer = Types::Strict::Int.constructor { |value| value.to_i unless value.nil? }.is(:required)
-        Float = Types::Strict::Float.constructor { |value| value.to_f unless value.nil? }.is(:required)
+        String = Types::Strict::String.constructor { |value| value&.to_s }.is(:required)
+        Integer = Types::Strict::Integer.constructor { |value| value&.to_i }.is(:required)
+        Float = Types::Strict::Float.constructor { |value| value&.to_f }.is(:required)
       end
     end
   end

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

@@ -7,15 +7,15 @@ module Fortnox
         module String
           def self.[](size)
             Types::Strict::String.constrained(max_size: size).optional.constructor do |value|
-              value.to_s unless value.nil?
+              value&.to_s
             end
           end
         end
 
         module Integer
           def self.[](low, high)
-            Types::Strict::Int.constrained(gteq: low, lteq: high).optional.constructor do |value|
-              value.to_i unless value.nil?
+            Types::Strict::Integer.constrained(gteq: low, lteq: high).optional.constructor do |value|
+              value&.to_i
             end
           end
         end
@@ -23,7 +23,7 @@ module Fortnox
         module Float
           def self.[](low, high)
             Types::Strict::Float.constrained(gteq: low, lteq: high).optional.constructor do |value|
-              value.to_f unless value.nil?
+              value&.to_f
             end
           end
         end

data/lib/fortnox/api/types.rb

@@ -3,7 +3,7 @@
 require 'dry-struct'
 require 'dry-types'
 require 'countries'
-require 'fortnox/api/types/shim/country_string'
+require_relative 'types/shim/country_string'
 
 module Dry
   module Types
@@ -12,11 +12,7 @@ module Dry
         new_options = option_names.each_with_object({}) do |name, hash|
           hash[name] = true
         end
-        with(new_options)
-      end
-
-      def is?(option_name)
-        @options[option_name]
+        with(**new_options)
       end
     end
   end
@@ -25,24 +21,24 @@ end
 module Fortnox
   module API
     module Types
-      include Dry::Types.module
+      include Dry.Types(default: :nominal)
       ISO3166.configure { |config| config.locales = %i[en sv] }
 
       THE_TRUTH = { true => true, 'true' => true, false => false, 'false' => false }.freeze
 
-      require 'fortnox/api/types/required'
-      require 'fortnox/api/types/defaulted'
-      require 'fortnox/api/types/nullable'
-
-      require 'fortnox/api/types/enums'
+      require_relative 'types/required'
+      require_relative 'types/defaulted'
+      require_relative 'types/nullable'
 
-      require 'fortnox/api/types/sized'
+      require_relative 'types/enums'
+      require_relative 'types/sized'
 
-      AccountNumber = Strict::Int
+      AccountNumber = Strict::Integer
                       .constrained(gteq: 0, lteq: 9999)
                       .optional
                       .constructor do |value|
                         next nil if value.nil? || value == ''
+
                         value
                       end
 
@@ -60,7 +56,7 @@ module Fortnox
                   next CountryString.new('SE') if value.match?(/^s(e$|we|ve)/i)
 
                   country = ::ISO3166::Country[value] ||
-                            ::ISO3166::Country.find_country_by_name(value) ||
+                            ::ISO3166::Country.find_country_by_any_name(value) ||
                             ::ISO3166::Country.find_country_by_translated_names(value)
 
                   raise Dry::Types::ConstraintError.new('value violates constraints', value) if country.nil?
@@ -97,7 +93,7 @@ module Fortnox
       Email = Strict::String
               .constrained(max_size: 1024, format: /^$|\A[[[:alnum:]]+-_.]+@[\w+-_.]+\.[a-z]+\z/i)
               .optional
-              .constructor { |v| v.to_s.downcase unless v.nil? }
+              .constructor { |v| v&.to_s&.downcase }
 
       HouseworkType = Strict::String
                       .constrained(included_in: HouseworkTypes.values)
@@ -124,13 +120,25 @@ module Fortnox
                          .optional
                          .constructor(EnumConstructors.lower_case)
 
-      require 'fortnox/api/types/model'
-      require 'fortnox/api/types/default_delivery_types'
-      require 'fortnox/api/types/default_templates'
-      require 'fortnox/api/types/email_information'
-      require 'fortnox/api/types/edi_information'
-      require 'fortnox/api/types/invoice_row'
-      require 'fortnox/api/types/order_row'
+      # Some Fortnox endpoints returns a String and some returns an Integer...
+      # The documentation says it should be a string, so let's keep it as a string.
+      SalesAccount = Strict::String
+                     .constrained(format: /^[0-9]{4}$/)
+                     .optional
+                     .constructor do |value|
+                       next nil if value == '' || value.nil?
+                       next value.to_s if value.is_a?(::Integer)
+
+                       value
+                     end
+
+      require_relative 'types/model'
+      require_relative 'types/default_delivery_types'
+      require_relative 'types/default_templates'
+      require_relative 'types/email_information'
+      require_relative 'types/edi_information'
+      require_relative 'types/invoice_row'
+      require_relative 'types/order_row'
     end
   end
 end

data/lib/fortnox/api/version.rb

@@ -2,6 +2,6 @@
 
 module Fortnox
   module API
-    VERSION = '0.8.0'
+    VERSION = '0.9.0'
   end
 end

data/lib/fortnox/api.rb

@@ -1,46 +1,39 @@
 # frozen_string_literal: true
 
 require 'set'
-require 'dry-struct'
-require 'fortnox/api/circular_queue'
-require 'fortnox/api/version'
+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/',
-      client_secret: nil,
-      token_store: {},
-      access_token: nil,
-      access_tokens: nil,
+      token_url: 'https://apps.fortnox.se/oauth-v1/token',
       debugging: false,
       logger: lambda {
-        logger = Logger.new(STDOUT)
+        logger = Logger.new($stdout)
         logger.level = Logger::WARN
         return logger
       }.call
     }.freeze
 
-    setting :base_url, DEFAULT_CONFIGURATION[:base_url]
-    setting :client_secret, DEFAULT_CONFIGURATION[:client_secret]
-    setting :token_store, DEFAULT_CONFIGURATION[:token_store]
-    setting :access_token, DEFAULT_CONFIGURATION[:access_token] do |value|
-      next if value.nil? # nil is a valid unassigned value
-      invalid_access_token_format!(value) unless value.is_a?(String)
-      config.token_store = { default: value }
-      value
+    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
-    setting :access_tokens, DEFAULT_CONFIGURATION[:access_tokens] do |value|
-      next if value.nil? # nil is a valid unassigned value
-      invalid_access_tokens_format!(value) unless value.is_a?(Hash) || value.is_a?(Array)
-      config.token_store = value.is_a?(Hash) ? value : { default: value }
-      value
+
+    def self.access_token
+      Thread.current[:access_token]
     end
-    setting :debugging, DEFAULT_CONFIGURATION[:debugging], reader: true
-    setting :logger, DEFAULT_CONFIGURATION[:logger], reader: true
 
     class Exception < StandardError
     end
@@ -57,24 +50,13 @@ module Fortnox
     class MissingConfiguration < Fortnox::API::Exception
     end
 
-    Registry = Dry::Container.new
-
-    def self.invalid_access_token_format!(value)
-      raise ArgumentError,
-            'expected a String, but '\
-            "#{value.inspect} is a(n) #{value.class}"
+    class MissingAccessToken < Fortnox::API::Exception
     end
-    private_class_method :invalid_access_token_format!
 
-    def self.invalid_access_tokens_format!(value)
-      raise ArgumentError,
-            'expected a Hash or an Array, but '\
-            "#{value.inspect} is a(n) #{value.class}"
-    end
-    private_class_method :invalid_access_tokens_format!
+    Registry = Dry::Container.new
   end
 end
 
-require 'fortnox/api/models'
-require 'fortnox/api/repositories'
-require 'fortnox/api/mappers'
+require_relative 'api/models'
+require_relative 'api/repositories'
+require_relative 'api/mappers'

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

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

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

@@ -8,14 +8,12 @@ describe Fortnox::API::Mapper::FromJSON do
   include_context 'with JSON conversion'
 
   before do
-    module Test
-      class BaseMapper
-        include Fortnox::API::Mapper::FromJSON
-      end
+    Test::BaseMapper.class_eval do
+      include Fortnox::API::Mapper::FromJSON # rubocop:disable RSpec/DescribedClass
     end
 
-    register_mapper(:categories, Test::CategoryMapper)
-    register_mapper(:designer, Test::ProductDesignerMapper)
+    add_to_registry(:categories, Test::CategoryMapper)
+    add_to_registry(:designer, Test::ProductDesignerMapper)
   end
 
   let(:mapper) { Test::ProductMapper.new }
@@ -26,10 +24,10 @@ describe Fortnox::API::Mapper::FromJSON 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' }
+          Name: 'Ford Mustang',
+          VAT: 30_000,
+          Categories: [{ Name: 'Cars', ID: '1' }, { Name: 'Fast cars', ID: '2' }],
+          Designer: { Name: 'John Najjar', ID: '23' }
         }
       }
     end
@@ -47,7 +45,7 @@ describe Fortnox::API::Mapper::FromJSON do
     # expect( entity_hash[:url] ).to eq 'someurl@example.com'
     # end
 
-    context 'with nested models' do
+    describe 'nested models' do
       let(:expected_nested_model_hash) do
         [{ name: 'Cars', id: '1' }, { name: 'Fast cars', id: '2' }]
       end
@@ -57,7 +55,7 @@ describe Fortnox::API::Mapper::FromJSON do
       end
     end
 
-    context 'with nested model' do
+    describe 'nested model' do
       let(:expected_nested_model_hash) { { name: 'John Najjar', id: '23' } }
 
       specify 'is converted correctly' do