fortnox-api 0.9.2 → 1.0.0.rc2

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

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-require_relative 'document'
-
-module Fortnox
-  module API
-    module Model
-      class Invoice < Document
-        UNIQUE_ID = :document_number
-        STUB = { customer_number: '' }.freeze
-
-        # UrlTaxReductionList Direct url to the tax reduction for the invoice.
-        attribute :url_tax_reduction_list, Types::Nullable::String.is(:read_only)
-
-        # AccountingMethod Accounting Method.
-        attribute :accounting_method, Types::Nullable::String
-
-        # Balance Balance of the invoice.
-        attribute :balance, Types::Nullable::Float.is(:read_only)
-
-        # 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.is(:read_only)
-
-        # 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.is(:read_only)
-
-        # DueDate Due date of the invoice.
-        attribute :due_date, Types::Nullable::Date
-
-        # EDIInformation Separate EDIInformation object
-        attribute :edi_information, Types::EDIInformation
-
-        # EUQuarterlyReport EU Quarterly Report On / Off
-        attribute :eu_quarterly_report, Types::Nullable::Boolean
-
-        # InvoiceDate Invoice date.
-        attribute :invoice_date, Types::Nullable::Date
-
-        # 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.is(:read_only)
-
-        # InvoiceRows Separate object
-        attribute :invoice_rows, Types::Strict::Array.of(Types::InvoiceRow)
-
-        # InvoiceType The type of invoice.
-        attribute :invoice_type, Types::Nullable::String
-
-        # Language Language code.
-        attribute :language, Types::Nullable::String
-
-        # 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.is(:read_only)
-
-        # 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.is(:read_only)
-
-        # 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.is(:read_only)
-
-        # 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.is(:read_only)
-      end
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../types'
-
-module Fortnox
-  module API
-    module Model
-      class Label < Model::Base
-        STUB = {}.freeze
-
-        # 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
-        attribute :description, Types::Sized::String[25].is(:read_only)
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-require_relative 'document'
-
-module Fortnox
-  module API
-    module Model
-      class Order < Document
-        UNIQUE_ID = :document_number
-        STUB = { customer_number: '', order_rows: [] }.freeze
-
-        # 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.is(:read_only)
-
-        # OrderDate Date of order
-        attribute :order_date, Types::Nullable::Date
-
-        # OrderRows Separate object
-        attribute :order_rows, Types::Strict::Array.of(Types::OrderRow)
-      end
-    end
-  end
-end

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

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-require_relative '../types'
-
-module Fortnox
-  module API
-    module Model
-      class Project < Fortnox::API::Model::Base
-        UNIQUE_ID = :project_number
-        STUB = { description: '' }.freeze
-
-        # Url Direct URL to the record
-        attribute :url, Types::Nullable::String.is(:read_only)
-
-        # Comments Comments on project. 512 characters
-        attribute :comments, Types::Sized::String[512]
-
-        # ContactPerson ContactPerson for project. 50 characters
-        attribute :contact_person, Types::Sized::String[50]
-
-        # Description Description of the project. 50 characters
-        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]
-
-        # ProjectNumber Projectnumber. 20 characters
-        attribute :project_number, Types::Sized::String[20]
-
-        # Status Status of the project
-        attribute :status, Types::ProjectStatusType
-
-        # StartDate Start date of the project
-        attribute :start_date, Types::Nullable::Date
-      end
-    end
-  end
-end

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

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../types'
-require_relative '../models/base'
-
-module Fortnox
-  module API
-    module Model
-      class TermsOfPayment < 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

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-require_relative '../types'
-
-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/models.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-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,17 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-require_relative '../models/article'
-require_relative '../mappers/article'
-
-module Fortnox
-  module API
-    module Repository
-      class Article < Base
-        MODEL = Model::Article
-        MAPPER = Mapper::Article
-        URI = '/articles/'
-      end
-    end
-  end
-end

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

@@ -1,61 +0,0 @@
-# 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/loaders.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-require 'cgi'
-
-module Fortnox
-  module API
-    module Repository
-      module Loaders
-        def all
-          response_hash = get(self.class::URI)
-          instantiate_collection_response(response_hash)
-        end
-
-        def only(filter)
-          response_hash = get("#{self.class::URI}?filter=#{filter}")
-          instantiate_collection_response(response_hash)
-        end
-
-        def search(hash)
-          attribute, value = hash.first
-          uri_encoded_value = CGI.escape(value)
-          uri = "#{self.class::URI}?#{attribute}=#{uri_encoded_value}"
-          response_hash = get(uri)
-          instantiate_collection_response(response_hash)
-        end
-
-        def find(id_or_hash)
-          return find_all_by(id_or_hash) if id_or_hash.is_a? Hash
-
-          find_one_by(id_or_hash)
-        end
-
-        def find_one_by(id)
-          response_hash = get("#{self.class::URI}#{id}")
-          instantiate(@mapper.wrapped_json_hash_to_entity_hash(response_hash))
-        end
-
-        def find_all_by(hash)
-          response_hash = get("#{self.class::URI}?#{to_query(hash)}")
-          instantiate_collection_response(response_hash)
-        end
-
-        def to_query(hash)
-          hash.collect do |key, value|
-            escape(key, value)
-          end.sort * '&'
-        end
-
-        def escape(key, value)
-          "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
-        end
-
-        private
-
-        def instantiate_collection_response(response_hash)
-          entities_hash = @mapper.wrapped_json_collection_to_entities_hash(response_hash)
-          entities_hash.map do |entity_hash|
-            instantiate(entity_hash)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-module Fortnox
-  module API
-    module Repository
-      module Savers
-        def save(entity)
-          return true if entity.saved?
-
-          return save_new(entity) if entity.new?
-
-          update_existing(entity)
-        end
-
-        private
-
-        def execute_save(entity)
-          body = get_changes_on(entity).to_json
-          result = yield body
-          instantiate_saved(result)
-        end
-
-        def save_new(entity)
-          execute_save(entity) do |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)
-          end
-        end
-
-        def get_changes_on(entity)
-          hash = @mapper.entity_to_hash(entity, @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
-
-        def get_update_url_for(entity)
-          "#{self.class::URI}#{entity.unique_id}"
-        end
-
-        def instantiate_saved(wrapped_json_hash)
-          instantiate(
-            @mapper.wrapped_json_hash_to_entity_hash(
-              wrapped_json_hash
-            )
-          )
-        end
-      end
-    end
-  end
-end

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

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-require 'httparty'
-require 'jwt'
-require 'base64'
-
-require_relative 'base/loaders'
-require_relative 'base/savers'
-require_relative '../request_handling'
-
-module Fortnox
-  module API
-    module Repository
-      class Base
-        include HTTParty
-        include Fortnox::API::RequestHandling
-        include Loaders
-        include Savers
-
-        HTTParty::Parser::SupportedFormats['text/html'] = :json
-
-        headers(
-          'Content-Type' => 'application/json',
-          'Accept' => 'application/json'
-        )
-
-        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)
-        end
-
-        HTTP_METHODS.each do |method|
-          define_method method do |path, options = {}, &block|
-            provided_headers = options[:headers] || {}
-            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])
-          @keys_filtered_on_save = keys_filtered_on_save
-          @mapper = Registry[Mapper::Base.canonical_name_sym(self.class::MODEL)].new
-          return unless access_token.nil?
-
-          raise MissingAccessToken,
-                'No Access Token provided! You need to provide an Access Token: ' \
-                'Fortnox::API.access_token = token'
-        end
-
-        private
-
-        def debug_log_request(path, options)
-          return unless Fortnox::API.debugging
-
-          Fortnox::API.logger.debug("path: #{path.inspect}")
-          Fortnox::API.logger.debug("options: #{options.inspect}")
-        end
-
-        def access_token
-          Fortnox::API.access_token
-        end
-
-        def instantiate(hash)
-          hash[:new] = false
-          hash[:unsaved] = false
-          self.class::MODEL.new(hash)
-        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 config
-          Fortnox::API.config
-        end
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-require_relative '../models/customer'
-require_relative '../mappers/customer'
-
-module Fortnox
-  module API
-    module Repository
-      class Customer < Base
-        MODEL = Model::Customer
-        MAPPER = Mapper::Customer
-        URI = '/customers/'
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-require_relative '../models/invoice'
-require_relative '../mappers/invoice'
-
-module Fortnox
-  module API
-    module Repository
-      class Invoice < Base
-        MODEL = Model::Invoice
-        MAPPER = Mapper::Invoice
-        URI = '/invoices/'
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-require_relative '../models/order'
-require_relative '../mappers/order'
-
-module Fortnox
-  module API
-    module Repository
-      class Order < Base
-        MODEL = Model::Order
-        MAPPER = Mapper::Order
-        URI = '/orders/'
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-require_relative '../models/project'
-require_relative '../mappers/project'
-
-module Fortnox
-  module API
-    module Repository
-      class Project < Base
-        MODEL = Model::Project
-        MAPPER = Mapper::Project
-        URI = '/projects/'
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-require_relative '../models/terms_of_payment'
-require_relative '../mappers/terms_of_payment'
-
-module Fortnox
-  module API
-    module Repository
-      class TermsOfPayment < Base
-        MODEL = Model::TermsOfPayment
-        MAPPER = Mapper::TermsOfPayment
-        URI = '/termsofpayments/'
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-require_relative '../models/unit'
-require_relative '../mappers/unit'
-
-module Fortnox
-  module API
-    module Repository
-      class Unit < Fortnox::API::Repository::Base
-        MODEL = Fortnox::API::Model::Unit
-        MAPPER = Fortnox::API::Mapper::Unit
-        URI = '/units/'
-      end
-    end
-  end
-end

data/lib/fortnox/api/repositories.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-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'