fortnox-api 0.5.2 → 0.6.0

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

@@ -1,86 +1,86 @@
-require "fortnox/api/models/base"
-require "fortnox/api/models/document_base"
+# frozen_string_literal: true
+
+require 'fortnox/api/models/base'
+require 'fortnox/api/models/document'
 
 module Fortnox
   module API
     module Model
-      class Invoice < Fortnox::API::Model::Base
+      class Invoice < Document
         UNIQUE_ID = :document_number
         STUB = { customer_number: '' }.freeze
 
-        DocumentBase.ify( self )
-
-        #UrlTaxReductionList Direct url to the tax reduction for the invoice.
-        attribute :url_tax_reduction_list, Types::Nullable::String.with( read_only: true )
+        # UrlTaxReductionList Direct url to the tax reduction for the invoice.
+        attribute :url_tax_reduction_list, Types::Nullable::String.is(:read_only)
 
-        #AccountingMethod Accounting Method.
+        # AccountingMethod Accounting Method.
         attribute :accounting_method, Types::Nullable::String
 
-        #Balance Balance of the invoice.
-        attribute :balance, Types::Nullable::Float.with( read_only: true )
+        # Balance Balance of the invoice.
+        attribute :balance, Types::Nullable::Float.is(:read_only)
 
-        #Booked If the invoice is bookkept.
-        attribute :booked, Types::Nullable::Boolean.with( read_only: true )
+        # Booked If the invoice is bookkept.
+        attribute :booked, Types::Nullable::Boolean.is(:read_only)
 
-        #Credit If the invoice is a credit invoice.
-        attribute :credit, Types::Nullable::Boolean.with( read_only: true )
+        # Credit If the invoice is a credit invoice.
+        attribute :credit, Types::Nullable::Boolean.is(:read_only)
 
-        #CreditInvoiceReference Reference to the credit invoice, if one exits.
+        # CreditInvoiceReference Reference to the credit invoice, if one exits.
         attribute :credit_invoice_reference, Types::Nullable::Integer
 
-        #ContractReference Reference to the contract, if one exists.
-        attribute :contract_reference, Types::Nullable::Integer.with( read_only: true )
+        # ContractReference Reference to the contract, if one exists.
+        attribute :contract_reference, Types::Nullable::Integer.is(:read_only)
 
-        #DueDate Due date of the invoice.
+        # DueDate Due date of the invoice.
         attribute :due_date, Types::Nullable::Date
 
-        #EDIInformation Separate EDIInformation object
+        # EDIInformation Separate EDIInformation object
         attribute :edi_information, Types::EDIInformation
 
-        #EUQuarterlyReport EU Quarterly Report On / Off
+        # EUQuarterlyReport EU Quarterly Report On / Off
         attribute :eu_quarterly_report, Types::Nullable::Boolean
 
-        #InvoiceDate Invoice date.
+        # InvoiceDate Invoice date.
         attribute :invoice_date, Types::Nullable::Date
 
-        #InvoicePeriodStart Start date of the invoice period.
-        attribute :invoice_period_start, Types::Nullable::Date.with( read_only: true )
+        # InvoicePeriodStart Start date of the invoice period.
+        attribute :invoice_period_start, Types::Nullable::Date.is(:read_only)
 
-        #InvoicePeriodEnd End date of the invoice period.
-        attribute :invoice_period_end, Types::Nullable::Date.with( read_only: true )
+        # InvoicePeriodEnd End date of the invoice period.
+        attribute :invoice_period_end, Types::Nullable::Date.is(:read_only)
 
-        #InvoiceRows Separate object
-        attribute :invoice_rows, Types::Strict::Array.member( Types::InvoiceRow )
+        # InvoiceRows Separate object
+        attribute :invoice_rows, Types::Strict::Array.member(Types::InvoiceRow)
 
-        #InvoiceType The type of invoice.
+        # InvoiceType The type of invoice.
         attribute :invoice_type, Types::Nullable::String
 
-        #Language Language code.
+        # Language Language code.
         attribute :language, Types::Nullable::String
 
-        #LastRemindDate Date of last reminder.
-        attribute :last_remind_date, Types::Nullable::Date.with( read_only: true )
+        # LastRemindDate Date of last reminder.
+        attribute :last_remind_date, Types::Nullable::Date.is(:read_only)
 
-        #NoxFinans If the invoice is managed by NoxFinans
-        attribute :nox_finans, Types::Nullable::Boolean.with( read_only: true )
+        # NoxFinans If the invoice is managed by NoxFinans
+        attribute :nox_finans, Types::Nullable::Boolean.is(:read_only)
 
-        #OCR OCR number of the invoice.
+        # OCR OCR number of the invoice.
         attribute :ocr, Types::Nullable::String
 
-        #OrderReference Reference to the order, if one exists.
-        attribute :order_reference, Types::Nullable::Integer.with( read_only: true )
+        # OrderReference Reference to the order, if one exists.
+        attribute :order_reference, Types::Nullable::Integer.is(:read_only)
 
-        #Reminders Number of reminders sent to the customer.
-        attribute :reminders, Types::Nullable::Integer.with( read_only: true )
+        # Reminders Number of reminders sent to the customer.
+        attribute :reminders, Types::Nullable::Integer.is(:read_only)
 
-        #VoucherNumber Voucher number for the invoice.
-        attribute :voucher_number, Types::Nullable::Integer.with( read_only: true )
+        # VoucherNumber Voucher number for the invoice.
+        attribute :voucher_number, Types::Nullable::Integer.is(:read_only)
 
-        #VoucherSeries Voucher series for the invoice.
-        attribute :voucher_series, Types::Nullable::String.with( read_only: true )
+        # VoucherSeries Voucher series for the invoice.
+        attribute :voucher_series, Types::Nullable::String.is(:read_only)
 
-        #VoucherYear Voucher year for the invoice.
-        attribute :voucher_year, Types::Nullable::Integer.with( read_only: true )
+        # VoucherYear Voucher year for the invoice.
+        attribute :voucher_year, Types::Nullable::Integer.is(:read_only)
       end
     end
   end

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

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

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

@@ -1,26 +1,26 @@
-require "fortnox/api/models/base"
-require "fortnox/api/models/document_base"
+# frozen_string_literal: true
+
+require 'fortnox/api/models/base'
+require 'fortnox/api/models/document'
 
 module Fortnox
   module API
     module Model
-      class Order < Fortnox::API::Model::Base
+      class Order < Document
         UNIQUE_ID = :document_number
         STUB = { customer_number: '', order_rows: [] }.freeze
 
-        DocumentBase.ify( self )
-
-        #CopyRemarks I remarks shall copies from order to invoice
+        # CopyRemarks I remarks shall copies from order to invoice
         attribute :copy_remarks, Types::Nullable::Boolean
 
         # InvoiceReference Reference if an invoice is created from order
-        attribute :invoice_reference, Types::Nullable::Integer.with( read_only: true )
+        attribute :invoice_reference, Types::Nullable::Integer.is(:read_only)
 
         # OrderDate Date of order
         attribute :order_date, Types::Nullable::Date
 
         # OrderRows Separate object
-        attribute :order_rows, Types::Strict::Array.member( Types::OrderRow )
+        attribute :order_rows, Types::Strict::Array.member(Types::OrderRow)
       end
     end
   end

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

@@ -1,5 +1,7 @@
-require "fortnox/api/types"
-require "fortnox/api/models/base"
+# frozen_string_literal: true
+
+require 'fortnox/api/types'
+require 'fortnox/api/models/base'
 
 module Fortnox
   module API
@@ -9,25 +11,25 @@ module Fortnox
         STUB = { description: '' }.freeze
 
         # Url Direct URL to the record
-        attribute :url, Types::Nullable::String.with( read_only: true )
+        attribute :url, Types::Nullable::String.is(:read_only)
 
         # Comments Comments on project. 512 characters
-        attribute :comments, Types::Sized::String[ 512 ]
+        attribute :comments, Types::Sized::String[512]
 
         # ContactPerson ContactPerson for project. 50 characters
-        attribute :contact_person, Types::Sized::String[ 50 ]
+        attribute :contact_person, Types::Sized::String[50]
 
         # Description Description of the project. 50 characters
-        attribute :description, Types::Sized::String[ 50 ]
+        attribute :description, Types::Sized::String[50]
 
         # EndDate End date of the project.
         attribute :end_date, Types::Nullable::Date
 
         # ProjectLeader Projectleader. 50 characters
-        attribute :project_leader, Types::Sized::String[ 50 ]
+        attribute :project_leader, Types::Sized::String[50]
 
         # ProjectNumber Projectnumber. 20 characters
-        attribute :project_number, Types::Sized::String[ 20 ]
+        attribute :project_number, Types::Sized::String[20]
 
         # Status Status of the project
         attribute :status, Types::ProjectStatusType

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'fortnox/api/types'
+require 'fortnox/api/models/base'
+
+module Fortnox
+  module API
+    module Model
+      class TermsOfPayments < Fortnox::API::Model::Base
+        UNIQUE_ID = :code
+        STUB = { code: '', description: '' }.freeze
+
+        # Direct URL to the record
+        attribute :url, Types::Nullable::String.with(read_only: true)
+
+        # The code of the term of payment. Sortable
+        # TODO: Only writable during POST.
+        # TODO: Must be alphanumeric
+        # TODO: 30days is a valid value, but the API rewrites it as 30DAYS
+        #       and you will not find the resource with a GET with value '30days'
+        attribute :code, Types::Required::String
+
+        # The description of the term of payment
+        attribute :description, Types::Required::String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'fortnox/api/types'
+require 'fortnox/api/models/base'
+
+module Fortnox
+  module API
+    module Model
+      class Unit < Fortnox::API::Model::Base
+        UNIQUE_ID = :code
+        STUB = { code: '' }.freeze
+
+        # Url Direct URL to the record
+        attribute :url, Types::Nullable::String.is(:read_only)
+
+        # Comments Comments on project. 512 characters
+        attribute :code, Types::Required::String.is(:read_only)
+
+        # ContactPerson ContactPerson for project. 50 characters
+        attribute :description, Types::Nullable::String
+      end
+    end
+  end
+end

data/lib/fortnox/api/repositories.rb

@@ -1,5 +1,9 @@
-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"
+# 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_payments'

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

@@ -1,6 +1,8 @@
-require "fortnox/api/repositories/base"
-require "fortnox/api/models/article"
-require "fortnox/api/mappers/article"
+# frozen_string_literal: true
+
+require 'fortnox/api/repositories/base'
+require 'fortnox/api/models/article'
+require 'fortnox/api/mappers/article'
 
 module Fortnox
   module API
@@ -8,7 +10,7 @@ module Fortnox
       class Article < Base
         MODEL = Model::Article
         MAPPER = Mapper::Article
-        URI = '/articles/'.freeze
+        URI = '/articles/'
       end
     end
   end

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'httparty'
 require 'fortnox/api/request_handling'
-require "fortnox/api/repositories/base/loaders"
-require "fortnox/api/repositories/base/savers"
+require 'fortnox/api/repositories/base/loaders'
+require 'fortnox/api/repositories/base/savers'
 
 module Fortnox
   module API
@@ -12,93 +14,94 @@ module Fortnox
         include Loaders
         include Savers
 
-        HTTParty::Parser::SupportedFormats[ "text/html" ] = :json
+        HTTParty::Parser::SupportedFormats['text/html'] = :json
 
         DEFAULT_HEADERS = {
           'Content-Type' => 'application/json',
-          'Accept' => 'application/json',
+          'Accept' => 'application/json'
         }.freeze
 
-        HTTP_METHODS = [ :get, :put, :post, :delete ].freeze
+        HTTP_METHODS = %i[get put post delete].freeze
 
         attr_accessor :headers
         attr_reader :mapper, :keys_filtered_on_save
 
-        def self.set_headers( headers = {} )
-          self.headers.merge!( headers )
+        def self.set_headers(headers = {}) # rubocop:disable Naming/AccessorMethodName
+          self.headers.merge!(headers)
         end
 
         HTTP_METHODS.each do |method|
           define_method method do |*args|
-            self.headers['Access-Token'] = next_access_token
+            headers['Access-Token'] = next_access_token
             execute do |remote|
-              remote.send( method, *args )
+              remote.send(method, *args)
             end
           end
         end
 
-        def initialize( keys_filtered_on_save: [ :url ], token_store: :default )
-          self.class.base_uri( get_base_url )
+        def initialize(keys_filtered_on_save: [:url], token_store: :default)
+          self.class.base_uri(base_url)
 
-          self.headers = DEFAULT_HEADERS.merge({
-            'Client-Secret' => get_client_secret,
-          })
+          self.headers = DEFAULT_HEADERS.merge(
+            'Client-Secret' => 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
+          @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 ||= CircularQueue.new(*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
+        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
 
-        def get_access_tokens
+        def access_tokens
           begin
-            tokens = config.token_store.fetch( @token_store )
+            tokens = config.token_store.fetch(@token_store)
           rescue KeyError
-            token_store_not_found!( @token_store.inspect )
+            token_store_not_found!(@token_store.inspect)
           end
 
-          check_access_tokens!( tokens )
+          check_access_tokens!(tokens)
           tokens
         end
 
         private
 
-          def instantiate( hash )
-            hash[ :new ] = false
-            hash[ :unsaved ] = false
-            self.class::MODEL.new( hash )
-          end
+        def instantiate(hash)
+          hash[:new] = false
+          hash[:unsaved] = false
+          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 base_url
+          base_url = config.base_url
+          raise 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 client_secret
+          client_secret = config.client_secret
+          raise MissingConfiguration, 'You have to provide your client secret.' unless client_secret
+          client_secret
+        end
 
-          def config
-            Fortnox::API.config
-          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
+        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