fortnox-api 0.8.0 → 0.9.0

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types'
-require 'fortnox/api/models/base'
+require_relative 'base'
+require_relative '../types'
 
 module Fortnox
   module API
@@ -30,31 +30,31 @@ module Fortnox
         # Url Direct URL to the record
         attribute :url, Types::Nullable::String.is(:read_only)
 
-        # Address1	First address of the customer. 1024 characters
+        # Address1  First address of the customer. 1024 characters
         attribute :address1, Types::Sized::String[1024]
 
-        # Address2	Second address of the customer. 1024 characters
+        # Address2  Second address of the customer. 1024 characters
         attribute :address2, Types::Sized::String[1024]
 
-        # City	City of the customer. 1024 characters
+        # City  City of the customer. 1024 characters
         attribute :city, Types::Sized::String[1024]
 
-        # Country	Country of the customer. Read-only.
+        # Country  Country of the customer. Read-only.
         attribute :country, Types::Nullable::String.is(:read_only)
 
-        # Comments	Comments. 1024 characters.
+        # Comments  Comments. 1024 characters.
         attribute :comments, Types::Sized::String[1024]
 
-        # Currency	Currency of the customer, 3 letters
+        # Currency  Currency of the customer, 3 letters
         attribute :currency, Types::Currency
 
-        # CostCenter	Cost center of the customer, Cost center in Fortnox
+        # CostCenter  Cost center of the customer, Cost center in Fortnox
         attribute :cost_center, Types::Nullable::String
 
-        # CountryCode	Country code of the customer, 2 letters
+        # CountryCode  Country code of the customer, 2 letters
         attribute :country_code, Types::CountryCode
 
-        # CustomerNumber	Customer number. 1024 characters
+        # CustomerNumber  Customer number. 1024 characters
         attribute :customer_number, Types::Sized::String[1024]
 
         # DefaultDeliveryTypes The properties for this object is listed in the table for "Default Delivery Types".
@@ -63,146 +63,146 @@ module Fortnox
         # The properties for this object is listed in the table for "Default Templates".
         attribute :default_templates, Types::DefaultTemplates
 
-        # DeliveryAddress1	First delivery address of the customer. 1024 characters
+        # DeliveryAddress1  First delivery address of the customer. 1024 characters
         attribute :delivery_address1, Types::Sized::String[1024]
 
-        # DeliveryAddress2	Second delivery address of the customer. 1024 characters
+        # DeliveryAddress2  Second delivery address of the customer. 1024 characters
         attribute :delivery_address2, Types::Sized::String[1024]
 
-        # DeliveryCity	Delivery city of the customer. 1024 characters
+        # DeliveryCity  Delivery city of the customer. 1024 characters
         attribute :delivery_city, Types::Sized::String[1024]
 
-        # DeliveryCountry	Delivery country of the customer. Read-only.
+        # DeliveryCountry  Delivery country of the customer. Read-only.
         attribute :delivery_country, Types::Nullable::String.is(:read_only)
 
-        # DeliveryCountryCode	Delivery country code of the customer, 2 letters
+        # DeliveryCountryCode  Delivery country code of the customer, 2 letters
         attribute :delivery_country_code, Types::CountryCode
 
-        # DeliveryFax	Delivery fax number of the customer. 1024 characters
+        # DeliveryFax  Delivery fax number of the customer. 1024 characters
         attribute :delivery_fax, Types::Sized::String[1024]
 
-        # DeliveryName	Delivery name of the customer. 1024 characters
+        # DeliveryName  Delivery name of the customer. 1024 characters
         attribute :delivery_name, Types::Sized::String[1024]
 
-        # DeliveryPhone1	First delivery phone number of the customer. 1024 characters
+        # DeliveryPhone1  First delivery phone number of the customer. 1024 characters
         attribute :delivery_phone1, Types::Sized::String[1024]
 
-        # DeliveryPhone2	Second delivery phone number of the customer. 1024 characters
+        # DeliveryPhone2  Second delivery phone number of the customer. 1024 characters
         attribute :delivery_phone2, Types::Sized::String[1024]
 
-        # DeliveryZipCode	Delivery zip code of the customer. 1024 characters.
+        # DeliveryZipCode  Delivery zip code of the customer. 1024 characters.
         attribute :delivery_zip_code, Types::Sized::String[1024]
 
-        # Email	Email address of the customer. 1024 characters
+        # Email  Email address of the customer. 1024 characters
         attribute :email, Types::Email
 
-        # EmailInvoice	Invoice email address of the customer. 1024 characters
+        # EmailInvoice  Invoice email address of the customer. 1024 characters
         attribute :email_invoice, Types::Email
 
-        # EmailInvoiceBCC	Invoice BCC email address of the customer. 1024 characters
+        # EmailInvoiceBCC  Invoice BCC email address of the customer. 1024 characters
         attribute :email_invoice_bcc, Types::Email
 
-        # EmailInvoiceCC	Invoice CC email address of the customer. 1024 characters
+        # EmailInvoiceCC  Invoice CC email address of the customer. 1024 characters
         attribute :email_invoice_cc, Types::Email
 
-        # EmailOffer	Offer email address of the customer. 1024 characters
+        # EmailOffer  Offer email address of the customer. 1024 characters
         attribute :email_offer, Types::Email
 
-        # EmailOfferBCC	Offer BCC email address of the customer. 1024 characters
+        # EmailOfferBCC  Offer BCC email address of the customer. 1024 characters
         attribute :email_offer_bcc, Types::Email
 
-        # EmailOfferCC	Offer CC email address of the customer. 1024 characters
+        # EmailOfferCC  Offer CC email address of the customer. 1024 characters
         attribute :email_offer_cc, Types::Email
 
-        # EmailOrder	Order email address of the customer. 1024 characters
+        # EmailOrder  Order email address of the customer. 1024 characters
         attribute :email_order, Types::Email
 
-        # EmailOrderBCC	Order BCC email address of the customer. 1024 characters
+        # EmailOrderBCC  Order BCC email address of the customer. 1024 characters
         attribute :email_order_bcc, Types::Email
 
-        # EmailOrderCC	Order CC email address of the customer. 1024 characters
+        # EmailOrderCC  Order CC email address of the customer. 1024 characters
         attribute :email_order_cc, Types::Email
 
-        # Fax	Fax number of the customer. 1024 characters
+        # Fax  Fax number of the customer. 1024 characters
         attribute :fax, Types::Sized::String[1024]
 
         # InvoiceAdministrationFee  Invoice administration fee of the customer, 12 digits (incl. decimals).
         attribute :invoice_administration_fee,
                   Types::Sized::Float[0.0, 99_999_999_999.9]
 
-        # InvoiceDiscount	Invoice discount of the customer, 12 digits (incl. decimals)
+        # InvoiceDiscount  Invoice discount of the customer, 12 digits (incl. decimals)
         attribute :invoice_discount, Types::Sized::Float[0.0, 99_999_999_999.9]
 
-        # InvoiceFreight	Invoice freight fee of the customer, 12 digits (incl. decimals)
+        # InvoiceFreight  Invoice freight fee of the customer, 12 digits (incl. decimals)
         attribute :invoice_freight, Types::Sized::Float[0.0, 99_999_999_999.9]
 
-        # InvoiceRemark	Invoice remark of the customer. 1024 characters
+        # InvoiceRemark  Invoice remark of the customer. 1024 characters
         attribute :invoice_remark, Types::Sized::String[1024]
 
-        # Name	Name of the customer, 1024 characters
+        # Name  Name of the customer, 1024 characters
         attribute :name, Types::Sized::String[1024].is(:required)
 
-        # OrganisationNumber	Organisation number of the customer. 30 characters
+        # OrganisationNumber  Organisation number of the customer. 30 characters
         attribute :organisation_number, Types::Sized::String[30]
 
-        # OurReference	Our reference of the customer. 50 characters
+        # OurReference  Our reference of the customer. 50 characters
         attribute :our_reference, Types::Sized::String[50]
 
-        # Phone1	First phone number of the customer. 1024 characters
+        # Phone1  First phone number of the customer. 1024 characters
         attribute :phone1, Types::Sized::String[1024]
 
-        # Phone2	Second phone number of the customer. 1024 characters
+        # Phone2  Second phone number of the customer. 1024 characters
         attribute :phone2, Types::Sized::String[1024]
 
-        # PriceList	Price list of the customer, Price list in Fortnox
+        # PriceList  Price list of the customer, Price list in Fortnox
         attribute :price_list, Types::Nullable::String
 
-        # Project	Project of the customer, Project in Fortnox
+        # Project  Project of the customer, Project in Fortnox
         attribute :project, Types::Nullable::String
 
-        # SalesAccount	Sales account of the customer, 4 digits
-        attribute :sales_account, Types::AccountNumber
+        # SalesAccount  Sales account of the customer, 4 characters
+        attribute :sales_account, Types::SalesAccount
 
-        # ShowPriceVATIncluded	Show prices with VAT included or not
+        # ShowPriceVATIncluded  Show prices with VAT included or not
         attribute :show_price_vat_included, Types::Nullable::Boolean
 
-        # TermsOfDeliveryCode	Terms of delivery code of the customer
+        # TermsOfDeliveryCode  Terms of delivery code of the customer
         attribute :terms_of_delivery, Types::Nullable::String
 
-        # TermsOfPaymentCode	Terms of payment code of the customer
+        # TermsOfPaymentCode  Terms of payment code of the customer
         attribute :terms_of_payment, Types::Nullable::String
 
-        # Type	Customer type, PRIVATE / COMPANY
+        # Type  Customer type, PRIVATE / COMPANY
         attribute :type, Types::CustomerType
 
-        # VATNumber	VAT number of the customer
+        # VATNumber  VAT number of the customer
         attribute :vat_number, Types::Nullable::String
 
-        # VATType	VAT type of the customer, SEVAT / SEREVERSEDVAT / EUREVERSEDVAT / EUVAT / EXPORT
+        # VATType  VAT type of the customer, SEVAT / SEREVERSEDVAT / EUREVERSEDVAT / EUVAT / EXPORT
         attribute :vat_type, Types::VATType
 
-        # VisitAddress	Visit address of the customer. 128 characters
+        # VisitAddress  Visit address of the customer. 128 characters
         attribute :visiting_address, Types::Sized::String[128]
 
-        # VisitCity	Visit city of the customer. 128 characters
+        # VisitCity  Visit city of the customer. 128 characters
         attribute :visiting_city, Types::Sized::String[128]
 
-        # VisitCountry	Visit country of the customer, read-only
+        # VisitCountry  Visit country of the customer, read-only
         attribute :visiting_country, Types::Nullable::String.is(:read_only)
 
         # VisitingCountryCode Code of the visiting country for the customer, 2 letters
         attribute :visiting_country_code, Types::CountryCode
 
-        # VisitZipCode	Visit zip code of the customer. 10 characters
+        # VisitZipCode  Visit zip code of the customer. 10 characters
         attribute :visiting_zip_code, Types::Sized::String[10]
 
-        # WayOfDeliveryCode	Way of delivery code of the customer
+        # WayOfDeliveryCode  Way of delivery code of the customer
         attribute :way_of_delivery, Types::Nullable::String
 
-        # YourReference	Your reference of the customer. 50 characters
+        # YourReference  Your reference of the customer. 50 characters
         attribute :your_reference, Types::Sized::String[50]
 
-        # ZipCode	Zip code of the customer. 10 characters
+        # ZipCode  Zip code of the customer. 10 characters
         attribute :zip_code, Types::Sized::String[10]
       end
     end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types'
-require 'fortnox/api/models/label'
+require_relative '../types'
+require_relative 'label'
 
 module Fortnox
   module API

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/models/base'
-require 'fortnox/api/models/document'
+require_relative 'base'
+require_relative 'document'
 
 module Fortnox
   module API

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types'
+require_relative '../types'
 
 module Fortnox
   module API
@@ -8,10 +8,10 @@ module Fortnox
       class Label < Model::Base
         STUB = {}.freeze
 
-        # Id	integer, read-only. The ID of the label.
+        # Id  integer, read-only. The ID of the label.
         attribute :id, Types::Required::Integer.is(:read_only)
 
-        # Description	string, 25 characters, required. Description of the label
+        # Description  string, 25 characters, required. Description of the label
         attribute :description, Types::Sized::String[25].is(:read_only)
       end
     end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/models/base'
-require 'fortnox/api/models/document'
+require_relative 'base'
+require_relative 'document'
 
 module Fortnox
   module API

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types'
-require 'fortnox/api/models/base'
+require_relative 'base'
+require_relative '../types'
 
 module Fortnox
   module API

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types'
-require 'fortnox/api/models/base'
+require_relative '../types'
+require_relative '../models/base'
 
 module Fortnox
   module API

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types'
-require 'fortnox/api/models/base'
+require_relative 'base'
+require_relative '../types'
 
 module Fortnox
   module API

data/lib/fortnox/api/models.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/models/article'
-require 'fortnox/api/models/customer'
-require 'fortnox/api/models/invoice'
-require 'fortnox/api/models/order'
-require 'fortnox/api/models/project'
-require 'fortnox/api/models/unit'
-require 'fortnox/api/models/terms_of_payment'
+require_relative 'models/article'
+require_relative 'models/customer'
+require_relative 'models/invoice'
+require_relative 'models/order'
+require_relative 'models/project'
+require_relative 'models/unit'
+require_relative 'models/terms_of_payment'

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/repositories/base'
-require 'fortnox/api/models/article'
-require 'fortnox/api/mappers/article'
+require_relative 'base'
+require_relative '../models/article'
+require_relative '../mappers/article'
 
 module Fortnox
   module API

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module Fortnox
+  module API
+    module Repository
+      class Authentication
+        def renew_tokens(refresh_token:, client_id:, client_secret:)
+          body = {
+            grant_type: 'refresh_token',
+            refresh_token: refresh_token
+          }
+
+          response = HTTParty.post(Fortnox::API.config.token_url,
+                                   headers: headers(client_id, client_secret),
+                                   body: body)
+
+          validate_response(response)
+
+          parsed_response_to_hash(response.parsed_response)
+        end
+
+        private
+
+        def parsed_response_to_hash(parsed_response)
+          {
+            access_token: parsed_response['access_token'],
+            refresh_token: parsed_response['refresh_token'],
+            expires_in: parsed_response['expires_in'],
+            token_type: parsed_response['token_type'],
+            scope: parsed_response['scope']
+          }
+        end
+
+        def headers(client_id, client_secret)
+          credentials = Base64.encode64("#{client_id}:#{client_secret}")
+
+          {
+            'Content-type' => 'application/x-www-form-urlencoded',
+            Authorization: "Basic #{credentials}"
+          }
+        end
+
+        def validate_response(response)
+          return if response.code == 200
+
+          case response.code
+          when 400
+            raise Fortnox::API::RemoteServerError, "Bad request. Error: \"#{response.body}\""
+          when 401
+            raise Fortnox::API::RemoteServerError, "Unauthorized request. Error: \"#{response.body}\""
+          else
+            raise Exception, "Unable to renew access token. Response code: #{response.code}. " \
+                             "Response message: #{response.message}. Response body: #{response.body}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -8,6 +8,7 @@ module Fortnox
           return true if entity.saved?
 
           return save_new(entity) if entity.new?
+
           update_existing(entity)
         end
 
@@ -33,8 +34,9 @@ module Fortnox
 
         def get_changes_on(entity)
           hash = @mapper.entity_to_hash(entity, @keys_filtered_on_save)
-          parent_hash = @mapper.entity_to_hash(entity.parent, @keys_filtered_on_save)
+          return hash unless entity.parent.saved?
 
+          parent_hash = @mapper.entity_to_hash(entity.parent, @keys_filtered_on_save)
           @mapper.wrap_entity_json_hash(@mapper.diff(hash, parent_hash))
         end
 

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

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 require 'httparty'
-require 'fortnox/api/request_handling'
-require 'fortnox/api/repositories/base/loaders'
-require 'fortnox/api/repositories/base/savers'
+require 'jwt'
+require 'base64'
+
+require_relative 'base/loaders'
+require_relative 'base/savers'
+require_relative '../request_handling'
 
 module Fortnox
   module API
@@ -26,53 +29,47 @@ module Fortnox
         attr_accessor :headers
         attr_reader :mapper, :keys_filtered_on_save
 
-        def self.set_headers(headers = {}) # rubocop:disable Naming/AccessorMethodName
+        def self.set_headers(headers = {})
           self.headers.merge!(headers)
         end
 
         HTTP_METHODS.each do |method|
           define_method method do |path, options = {}, &block|
             provided_headers = options[:headers] || {}
-            provided_headers['Client-Secret'] = client_secret
-            provided_headers['Access-Token'] = next_access_token
+            provided_headers['Authorization'] = "Bearer #{access_token}"
             options[:headers] = provided_headers
             options[:base_uri] ||= base_url
+
+            debug_log_request(path, options)
+
             execute do |remote|
               remote.send(method, path, options, &block)
             end
           end
         end
 
-        def initialize(keys_filtered_on_save: [:url], token_store: :default)
+        def initialize(keys_filtered_on_save: [:url])
           @keys_filtered_on_save = keys_filtered_on_save
-          @token_store = token_store
           @mapper = Registry[Mapper::Base.canonical_name_sym(self.class::MODEL)].new
-        end
+          return unless access_token.nil?
 
-        def next_access_token
-          @access_tokens ||= CircularQueue.new(*access_tokens)
-          @access_tokens.next
+          raise MissingAccessToken,
+                'No Access Token provided! You need to provide an Access Token: ' \
+                'Fortnox::API.access_token = token'
         end
 
-        def check_access_tokens!(tokens)
-          tokens_present = !(tokens.nil? || tokens.empty?)
-          return if tokens_present
-          error_message = "You have not provided any access tokens in token store #{@token_store.inspect}."
-          raise MissingConfiguration, error_message
-        end
+        private
 
-        def access_tokens
-          begin
-            tokens = config.token_store.fetch(@token_store)
-          rescue KeyError
-            token_store_not_found!(@token_store.inspect)
-          end
+        def debug_log_request(path, options)
+          return unless Fortnox::API.debugging
 
-          check_access_tokens!(tokens)
-          tokens
+          Fortnox::API.logger.debug("path: #{path.inspect}")
+          Fortnox::API.logger.debug("options: #{options.inspect}")
         end
 
-        private
+        def access_token
+          Fortnox::API.access_token
+        end
 
         def instantiate(hash)
           hash[:new] = false
@@ -83,23 +80,13 @@ module Fortnox
         def base_url
           base_url = config.base_url
           raise MissingConfiguration, 'You have to provide a base url.' unless base_url
-          base_url
-        end
 
-        def client_secret
-          client_secret = config.client_secret
-          raise MissingConfiguration, 'You have to provide your client secret.' unless client_secret
-          client_secret
+          base_url
         end
 
         def config
           Fortnox::API.config
         end
-
-        def token_store_not_found!(store_name)
-          raise MissingConfiguration,
-                "There is no token store named #{store_name}. Available stores are #{config.token_store.keys}."
-        end
       end
     end
   end

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/repositories/base'
-require 'fortnox/api/models/customer'
-require 'fortnox/api/mappers/customer'
+require_relative 'base'
+require_relative '../models/customer'
+require_relative '../mappers/customer'
 
 module Fortnox
   module API

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/repositories/base'
-require 'fortnox/api/models/invoice'
-require 'fortnox/api/mappers/invoice'
+require_relative 'base'
+require_relative '../models/invoice'
+require_relative '../mappers/invoice'
 
 module Fortnox
   module API

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/repositories/base'
-require 'fortnox/api/models/order'
-require 'fortnox/api/mappers/order'
+require_relative 'base'
+require_relative '../models/order'
+require_relative '../mappers/order'
 
 module Fortnox
   module API

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/repositories/base'
-require 'fortnox/api/models/project'
-require 'fortnox/api/mappers/project'
+require_relative 'base'
+require_relative '../models/project'
+require_relative '../mappers/project'
 
 module Fortnox
   module API

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/repositories/base'
-require 'fortnox/api/models/terms_of_payment'
-require 'fortnox/api/mappers/terms_of_payment'
+require_relative 'base'
+require_relative '../models/terms_of_payment'
+require_relative '../mappers/terms_of_payment'
 
 module Fortnox
   module API

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/repositories/base'
-require 'fortnox/api/models/unit'
-require 'fortnox/api/mappers/unit'
+require_relative 'base'
+require_relative '../models/unit'
+require_relative '../mappers/unit'
 
 module Fortnox
   module API

data/lib/fortnox/api/repositories.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/repositories/article'
-require 'fortnox/api/repositories/customer'
-require 'fortnox/api/repositories/invoice'
-require 'fortnox/api/repositories/order'
-require 'fortnox/api/repositories/project'
-require 'fortnox/api/repositories/unit'
-require 'fortnox/api/repositories/terms_of_payment'
+require_relative 'repositories/article'
+require_relative 'repositories/customer'
+require_relative 'repositories/invoice'
+require_relative 'repositories/order'
+require_relative 'repositories/project'
+require_relative 'repositories/unit'
+require_relative 'repositories/terms_of_payment'
+require_relative 'repositories/authentication'