fortnox-api 0.9.2 → 1.0.0.rc2

data/lib/fortnox/api/request_handling.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Fortnox
-  module API
-    module RequestHandling
-      private
-
-      def raise_api_error(error, response)
-        message = (error['message'] || error['Message'] || 'Okänt fel')
-
-        message += "\n\n#{response.request.inspect}" if Fortnox::API.debugging
-
-        raise Fortnox::API::RemoteServerError, message
-      end
-
-      def validate_response(response)
-        return if response.code == 200
-
-        raise_content_type_error(response) if response.headers['content-type'].start_with?('text/html')
-
-        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
-
-        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,20 +0,0 @@
-# frozen_string_literal: true
-
-module Fortnox
-  module API
-    module Types
-      class DefaultDeliveryTypes < Types::Model
-        STUB = {}.freeze
-
-        # Default delivery type for invoices. Can be PRINT EMAIL or PRINTSERVICE.
-        attribute :invoice, Types::DefaultDeliveryType
-
-        # Default delivery type for orders. Can be PRINT EMAIL or PRINTSERVICE.
-        attribute :order, Types::DefaultDeliveryType
-
-        # Default delivery type for offers. Can be PRINT EMAIL or PRINTSERVICE.
-        attribute :offer, Types::DefaultDeliveryType
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Fortnox
-  module API
-    module Types
-      class DefaultTemplates < Types::Model
-        STUB = {}.freeze
-
-        # Default template for orders. Must be a name of an existing print template.
-        attribute :order, Types::Required::String
-
-        # Default template for offers. Must be a name of an existing print template.
-        attribute :offer, Types::Required::String
-
-        # Default template for invoices. Must be a name of an existing print template.
-        attribute :invoice, Types::Required::String
-
-        # Default template for cash invoices. Must be a name of an existing print template.
-        attribute :cash_invoice, Types::Required::String
-      end
-    end
-  end
-end

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

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Fortnox
-  module API
-    module Types
-      module Defaulted
-        String = Types::Strict::String.default('')
-      end
-    end
-  end
-end

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

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-module Fortnox
-  module API
-    module Types
-      class DocumentRow < Fortnox::API::Types::Model
-        # AccountNumber Account number. 4 digits
-        attribute :account_number, Types::AccountNumber
-
-        # ArticleNumber Article number. 50 characters
-        attribute :article_number, Types::Sized::String[50]
-
-        # ContributionPercent Contribution Percent.
-        attribute :contribution_percent, Types::Nullable::Float.with(private: true)
-
-        # ContributionValue Contribution Value.
-        attribute :contribution_value, Types::Nullable::Float.with(private: true)
-
-        # CostCenter Code of the cost center for the row.
-        attribute :cost_center, Types::Nullable::String
-
-        # 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.
-        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
-        # the actual API for DiscountType PERCENT. This cannot be done until
-        # we fix issue #62...
-        attribute :discount, Types::Sized::Float[0.0, 99_999_999_999.9]
-
-        # DiscountType The type of discount used for the row.
-        attribute :discount_type, Types::DiscountType
-
-        # HouseWork If the row is housework
-        attribute :housework, Types::Nullable::Boolean
-
-        # HouseWorkHoursToReport Hours to be reported if the quantity of the row should not be used as hours.
-        # 5 digits
-        attribute :housework_hours_to_report, Types::Sized::Integer[0, 99_999]
-
-        # HouseWorkType The type of housework.
-        attribute :housework_type, Types::HouseworkType
-
-        # Price Price per unit. 12 digits
-        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
-
-        # Total Total amount for the row.
-        attribute :total, Types::Nullable::Float.with(private: true)
-
-        # Unit Code of the unit for the row.
-        attribute :unit, Types::Nullable::String
-
-        # VAT VAT percentage of the row.
-        attribute :vat, Types::Nullable::Integer
-      end
-    end
-  end
-end

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

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-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[20_000]
-      end
-    end
-  end
-end

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

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-
-module Fortnox
-  module API
-    module Types
-      module EnumConstructors
-        def self.sized(size)
-          lambda do |value|
-            return nil if value == ''
-
-            value.to_s.upcase[0...size] unless value.nil?
-          end
-        end
-
-        def self.default
-          lambda do |value|
-            return nil if value == ''
-
-            value&.to_s&.upcase
-          end
-        end
-
-        def self.lower_case
-          lambda do |value|
-            return nil if value == ''
-
-            value&.to_s&.downcase
-          end
-        end
-      end
-
-      ArticleTypes = Types::Strict::String.enum(
-        'SERVICE', 'STOCK'
-      )
-      DiscountTypes = Types::Strict::String.enum(
-        'AMOUNT', 'PERCENT'
-      )
-      HOUSEWORK_TYPES = {
-        rot: [
-          'CONSTRUCTION',
-          'ELECTRICITY',
-          'GLASSMETALWORK',
-          'GROUNDDRAINAGEWORK',
-          'HVAC',
-          'MASONRY',
-          'OTHERCOSTS',
-          'PAINTINGWALLPAPERING'
-        ],
-        rut: [
-          'BABYSITTING',
-          'CLEANING',
-          'GARDENING',
-          'ITSERVICES',
-          'MAJORAPPLIANCEREPAIR',
-          'MOVINGSERVICES',
-          'OTHERCARE',
-          'OTHERCOSTS',
-          'SNOWPLOWING',
-          'TEXTILECLOTHING'
-        ],
-        legacy_rut: ['COOKING', 'TUTORING']
-      }.freeze
-
-      # TODO: RUT to be added:
-      # HOMEMAINTENANCE FURNISHING TRANSPORTATIONSERVICES
-      # WASHINGANDCAREOFCLOTHING
-      #
-      # TODO: GREEN to be added:
-      # SOLARCELLS STORAGESELFPRODUCEDELECTRICTY
-      # CHARGINGSTATIONELECTRICVEHICLE OTHERCOSTS
-
-      HouseworkTypes = Types::Strict::String.enum(
-        *(HOUSEWORK_TYPES[:rot] +
-          HOUSEWORK_TYPES[:rut] +
-          HOUSEWORK_TYPES[:legacy_rut]).uniq
-      )
-      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', 'ELECTRONICINVOICE'
-      )
-      ProjectStatusTypes = Types::Strict::String.enum(
-        'NOTSTARTED', 'ONGOING', 'COMPLETED'
-      )
-      # NOTE: Yes, these needs to be in lower case...
-      # I know, this is stupid... Fortnox: why?!
-      TaxReductionTypes = Types::Strict::String.enum(
-        'rot', 'rut', 'green', 'none'
-      )
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'document_row'
-
-module Fortnox
-  module API
-    module Types
-      class InvoiceRow < DocumentRow
-        STUB = {}.freeze
-
-        # 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

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Fortnox
-  module API
-    module Types
-      class Model < Dry::Struct
-        transform_types(&:omittable)
-        transform_keys(&:to_sym)
-
-        def initialize(input_attributes)
-          if (missing_key = first_missing_required_key(input_attributes))
-            error_message = "Missing attribute #{missing_key.inspect} in attributes: #{input_attributes}"
-            raise Fortnox::API::MissingAttributeError, error_message
-          end
-
-          super
-        end
-
-        private
-
-        def missing_keys(attributes)
-          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.keys.find { |key| key.name == name }
-            attribute.type.respond_to?(:options) && attribute.type.options[:required]
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require 'date'
-
-module Fortnox
-  module API
-    module Types
-      module Nullable
-        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
-end

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

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'document_row'
-
-module Fortnox
-  module API
-    module Types
-      class OrderRow < DocumentRow
-        STUB = { ordered_quantity: 0 }.freeze
-
-        # OrderedQuantity Ordered quantity
-        attribute :ordered_quantity, Types::Required::Float
-      end
-    end
-  end
-end

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

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Fortnox
-  module API
-    module Types
-      module 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
-end

data/lib/fortnox/api/types/shim/country_string.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Fortnox
-  module API
-    module Types
-      class CountryString < String
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Fortnox
-  module API
-    module Types
-      module Sized
-        module String
-          def self.[](size)
-            Types::Strict::String.constrained(max_size: size).optional.constructor do |value|
-              value&.to_s
-            end
-          end
-        end
-
-        module Integer
-          def self.[](low, high)
-            Types::Strict::Integer.constrained(gteq: low, lteq: high).optional.constructor do |value|
-              value&.to_i
-            end
-          end
-        end
-
-        module Float
-          def self.[](low, high)
-            Types::Strict::Float.constrained(gteq: low, lteq: high).optional.constructor do |value|
-              value&.to_f
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/fortnox/api/types.rb

@@ -1,144 +0,0 @@
-# frozen_string_literal: true
-
-require 'dry-struct'
-require 'dry-types'
-require 'countries'
-require_relative 'types/shim/country_string'
-
-module Dry
-  module Types
-    module Options
-      def is(*option_names)
-        new_options = option_names.each_with_object({}) do |name, hash|
-          hash[name] = true
-        end
-        with(**new_options)
-      end
-    end
-  end
-end
-
-module Fortnox
-  module API
-    module Types
-      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_relative 'types/required'
-      require_relative 'types/defaulted'
-      require_relative 'types/nullable'
-
-      require_relative 'types/enums'
-      require_relative 'types/sized'
-
-      AccountNumber = Strict::Integer
-                      .constrained(gteq: 0, lteq: 9999)
-                      .optional
-                      .constructor do |value|
-                        next nil if value.nil? || value == ''
-
-                        value
-                      end
-
-      ArticleType = Strict::String
-                    .constrained(included_in: ArticleTypes.values)
-                    .optional
-                    .constructor(EnumConstructors.default)
-
-      Country = Strict::String
-                .optional
-                .constructor do |value|
-                  next value if value.nil? || value == ''
-
-                  # Fortnox only supports Swedish translation of Sweden
-                  next CountryString.new('SE') if value.match?(/^s(e$|we|ve)/i)
-
-                  country = ::ISO3166::Country[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?
-
-                  CountryString.new(country.alpha2)
-                end
-
-      CountryCode = Strict::String
-                    .optional
-                    .constructor do |value|
-                      next value if value.nil? || value == ''
-
-                      country = ::ISO3166::Country[value]
-
-                      raise Dry::Types::ConstraintError.new('value violates constraints', value) if country.nil?
-
-                      country.alpha2
-                    end
-
-      Currency = Strict::String
-                 .constrained(included_in: Currencies.values)
-                 .optional
-                 .constructor(EnumConstructors.sized(3))
-      CustomerType = Strict::String
-                     .constrained(included_in: CustomerTypes.values)
-                     .optional
-                     .constructor(EnumConstructors.default)
-
-      DiscountType = Strict::String
-                     .constrained(included_in: DiscountTypes.values)
-                     .optional
-                     .constructor(EnumConstructors.default)
-
-      Email = Strict::String
-              .constrained(max_size: 1024, format: /^$|\A[[[:alnum:]]._+-]+@[[[:alnum:]]._-]+\.[a-z]+\z/i)
-              .optional
-              .constructor { |v| v&.to_s&.downcase }
-
-      HouseworkType = Strict::String
-                      .constrained(included_in: HouseworkTypes.values)
-                      .optional
-                      .constructor(EnumConstructors.default)
-
-      VATType = Strict::String
-                .constrained(included_in: VATTypes.values)
-                .optional
-                .constructor(EnumConstructors.default)
-
-      DefaultDeliveryType = Strict::String
-                            .constrained(included_in: DefaultDeliveryTypeValues.values)
-                            .optional
-                            .constructor(EnumConstructors.default)
-
-      ProjectStatusType = Strict::String
-                          .constrained(included_in: ProjectStatusTypes.values)
-                          .optional
-                          .constructor(EnumConstructors.default)
-
-      TaxReductionType = Strict::String
-                         .constrained(included_in: TaxReductionTypes.values)
-                         .optional
-                         .constructor(EnumConstructors.lower_case)
-
-      # 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