fortnox-api 0.9.2 → 1.0.0.rc2

data/lib/fortnox/api/mappers/base/from_json.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-module Fortnox
-  module API
-    module Mapper
-      module FromJSON
-        class MissingModelOrMapperException < Fortnox::API::Exception
-        end
-
-        def wrapped_json_collection_to_entities_hash(json_collection_hash)
-          entities_hash = []
-          json_collection_hash[self.class::JSON_COLLECTION_WRAPPER].each do |json_hash|
-            entities_hash << json_hash_to_entity_hash(json_hash, self.class::KEY_MAP)
-          end
-
-          entities_hash
-        end
-
-        def wrapped_json_hash_to_entity_hash(json_entity_hash)
-          json_hash_to_entity_hash(json_entity_hash[self.class::JSON_ENTITY_WRAPPER],
-                                   self.class::KEY_MAP)
-        end
-
-        private
-
-        def json_hash_to_entity_hash(hash, key_map)
-          hash.each_with_object({}) do |(key, value), json_hash|
-            converted_key = convert_key_from_json(key, key_map)
-            json_hash[converted_key] =
-              if value.respond_to?(:each)
-                convert_collection(key, value)
-              else
-                value
-              end
-          end
-        end
-
-        def convert_collection(key, collection)
-          mapper_name = key.downcase
-          if Registry.key?(mapper_name)
-            convert_nested_data(mapper_name, key, collection)
-          else
-            # NOTE: This probably means this is a nested model that we have
-            # not implemented yet, or that is missing a mapper.
-            # Raise exception during test run if this happens so that we can
-            # add it before a new release.
-
-            message = "for #{key} (#{mapper_name}, #{Fortnox::API::Mapper::DefaultTemplates.canonical_name_sym}) " \
-                      "with #{collection}"
-
-            raise MissingModelOrMapperException, message if ENV['RUBY_ENV']
-
-            Fortnox::API.logger.warn("Missing Model or Mapper implementation for #{key} with attributes: #{collection}")
-            convert_hash_keys_from_json_format(collection, {})
-          end
-        end
-
-        def convert_nested_data(_mapper_name, key, nested_data)
-          nested_mapper = Registry[key.downcase]
-
-          # Assume Hash of nested model
-          return json_hash_to_entity_hash(nested_data, nested_mapper::KEY_MAP) unless nested_data.is_a?(::Array)
-
-          # Array of nested models
-          nested_data.each_with_object([]) do |value, nested_models|
-            nested_models << json_hash_to_entity_hash(value, nested_mapper::KEY_MAP)
-          end
-        end
-
-        def convert_key_from_json(key, key_map)
-          key_map.key(key) || default_key_from_json_transform(key)
-        end
-
-        def default_key_from_json_transform(key)
-          key = key.to_s
-          key = camelcase_to_underscore(key) unless key.match?(/\A[A-Z]+\z/)
-          key = strip_at_symbol(key) if key.match?(/\A@.*\z/)
-          key.downcase.to_sym
-        end
-
-        def camelcase_to_underscore(key)
-          key.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').gsub(/([a-z])([A-Z])/, '\1_\2')
-        end
-
-        def strip_at_symbol(key)
-          key.gsub(/\A@/, '')
-        end
-      end
-    end
-  end
-end

data/lib/fortnox/api/mappers/base/to_json.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-module Fortnox
-  module API
-    module Mapper
-      module ToJSON
-        def self.included(base)
-          base.send :extend, ClassMethods
-
-          base.send :private_class_method,
-                    :convert_hash_keys_to_json_format,
-                    :convert_key_to_json,
-                    :default_key_to_json_transform,
-                    :sanitise
-        end
-
-        module ClassMethods
-          def call(entity, keys_to_filter = {})
-            entity_hash = entity.to_hash
-            clean_entity_hash = sanitise(entity_hash, keys_to_filter)
-            clean_entity_hash = convert_hash_keys_to_json_format(clean_entity_hash)
-            Registry[:hash].call(clean_entity_hash)
-          end
-
-          # PRIVATE
-
-          def convert_hash_keys_to_json_format(hash)
-            hash.transform_keys do |key|
-              convert_key_to_json(key)
-            end
-          end
-
-          def convert_key_to_json(key)
-            self::KEY_MAP.fetch(key) { default_key_to_json_transform(key) }
-          end
-
-          def default_key_to_json_transform(key)
-            key.to_s.split('_').map(&:capitalize).join
-          end
-
-          def sanitise(hash, keys_to_filter)
-            hash.reject do |key, value|
-              keys_to_filter.include?(key) || value.nil?
-            end
-          end
-        end
-
-        def entity_to_hash(entity, keys_to_filter)
-          entity_json_hash = Registry[mapper_name_for(entity)]
-                             .call(entity, keys_to_filter)
-          wrap_entity_json_hash(entity_json_hash)
-        end
-
-        def wrap_entity_json_hash(entity_json_hash)
-          { self.class::JSON_ENTITY_WRAPPER => entity_json_hash }
-        end
-
-        private
-
-        def mapper_name_for(value)
-          value.class.name.split('::').last.downcase.to_sym
-        end
-      end
-    end
-  end
-end

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

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base/canonical_name_sym'
-require_relative 'base/from_json'
-require_relative 'base/to_json'
-
-module Fortnox
-  module API
-    module Mapper
-      class Base
-        include FromJSON
-        include ToJSON
-        extend CanonicalNameSym
-
-        def diff(entity_hash, parent_hash)
-          hash_diff(entity_hash[self.class::JSON_ENTITY_WRAPPER],
-                    parent_hash[self.class::JSON_ENTITY_WRAPPER])
-        end
-
-        private
-
-        def hash_diff(hash1, hash2)
-          hash1.dup
-               .delete_if { |k, v| hash2[k] == v }
-               .merge!(hash2.dup.delete_if { |k, _| hash1.key?(k) })
-        end
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module Fortnox
-  module API
-    module Mapper
-      class Customer < Fortnox::API::Mapper::Base
-        KEY_MAP = {
-          vat_type: 'VATType',
-          vat_number: 'VATNumber',
-          email_invoice_bcc: 'EmailInvoiceBCC',
-          email_invoice_cc: 'EmailInvoiceCC',
-          email_offer_bcc: 'EmailOfferBCC',
-          email_offer_cc: 'EmailOfferCC',
-          email_order_bcc: 'EmailOrderBCC',
-          email_order_cc: 'EmailOrderCC',
-          show_price_vat_included: 'ShowPriceVATIncluded'
-        }.freeze
-        JSON_ENTITY_WRAPPER = 'Customer'
-        JSON_COLLECTION_WRAPPER = 'Customers'
-      end
-
-      Registry.register(Customer.canonical_name_sym, Customer)
-    end
-  end
-end

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

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module Fortnox
-  module API
-    module Mapper
-      class DefaultDeliveryTypes < Fortnox::API::Mapper::Base
-        KEY_MAP = {}.freeze
-      end
-
-      Registry.register(DefaultDeliveryTypes.canonical_name_sym, DefaultDeliveryTypes)
-    end
-  end
-end

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

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module Fortnox
-  module API
-    module Mapper
-      class DefaultTemplates < Fortnox::API::Mapper::Base
-        KEY_MAP = {}.freeze
-        JSON_ENTITY_WRAPPER = JSON_COLLECTION_WRAPPER = 'DefaultTemplates'
-      end
-
-      Registry.register(DefaultTemplates.canonical_name_sym, DefaultTemplates)
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module Fortnox
-  module API
-    module Mapper
-      class EDIInformation < Fortnox::API::Mapper::Base
-        KEY_MAP = {
-          edi_global_location_number: 'EDIGlobalLocationNumber',
-          edi_global_location_number_delivery: 'EDIGlobalLocationNumberDelivery',
-          edi_invoice_extra1: 'EDIInvoiceExtra1',
-          edi_invoice_extra2: 'EDIInvoiceExtra2',
-          edi_our_electronic_reference: 'EDIOurElectronicReference',
-          edi_your_electronic_reference: 'EDIYourElectronicReference'
-        }.freeze
-        JSON_ENTITY_WRAPPER = JSON_COLLECTION_WRAPPER = 'EDIInformation'
-      end
-
-      Registry.register(EDIInformation.canonical_name_sym, EDIInformation)
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module Fortnox
-  module API
-    module Mapper
-      class EmailInformation < Fortnox::API::Mapper::Base
-        KEY_MAP = {
-          email_address_bcc: 'EmailAddressBCC',
-          email_address_cc: 'EmailAddressCC'
-        }.freeze
-        JSON_ENTITY_WRAPPER = JSON_COLLECTION_WRAPPER = 'EmailInformation'
-      end
-
-      Registry.register(EmailInformation.canonical_name_sym, EmailInformation)
-    end
-  end
-end

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

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-require_relative 'edi_information'
-require_relative 'email_information'
-require_relative 'invoice_row'
-
-module Fortnox
-  module API
-    module Mapper
-      class Invoice < Fortnox::API::Mapper::Base
-        KEY_MAP = {
-          administration_fee_vat: 'AdministrationFeeVAT',
-          edi_information: 'EDIInformation',
-          eu_quarterly_report: 'EUQuarterlyReport',
-          freight_vat: 'FreightVAT',
-          housework: 'HouseWork',
-          ocr: 'OCR',
-          total_vat: 'TotalVAT',
-          vat_included: 'VATIncluded'
-        }.freeze
-        JSON_ENTITY_WRAPPER = 'Invoice'
-        JSON_COLLECTION_WRAPPER = 'Invoices'
-      end
-
-      Registry.register(Invoice.canonical_name_sym, Invoice)
-    end
-  end
-end

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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module Fortnox
-  module API
-    module Mapper
-      class InvoiceRow < Fortnox::API::Mapper::Base
-        KEY_MAP = {
-          housework: 'HouseWork',
-          housework_hours_to_report: 'HouseWorkHoursToReport',
-          housework_type: 'HouseWorkType',
-          price_excluding_vat: 'PriceExcludingVAT',
-          total_excluding_vat: 'TotalExcludingVAT',
-          vat: 'VAT'
-        }.freeze
-        JSON_ENTITY_WRAPPER = 'InvoiceRow'
-        JSON_COLLECTION_WRAPPER = 'InvoiceRows'
-      end
-
-      Registry.register(InvoiceRow.canonical_name_sym, InvoiceRow)
-      Registry.register(:invoicerows, InvoiceRow)
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-require_relative 'edi_information'
-require_relative 'email_information'
-require_relative 'order_row'
-
-module Fortnox
-  module API
-    module Mapper
-      class Order < Fortnox::API::Mapper::Base
-        KEY_MAP = {
-          administration_fee_vat: 'AdministrationFeeVAT',
-          freight_vat: 'FreightVAT',
-          housework: 'HouseWork',
-          total_vat: 'TotalVAT',
-          vat_included: 'VATIncluded'
-        }.freeze
-        JSON_ENTITY_WRAPPER = 'Order'
-        JSON_COLLECTION_WRAPPER = 'Orders'
-      end
-
-      Registry.register(Order.canonical_name_sym, Order)
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module Fortnox
-  module API
-    module Mapper
-      class OrderRow < Fortnox::API::Mapper::Base
-        KEY_MAP = {
-          housework: 'HouseWork',
-          housework_hours_to_report: 'HouseWorkHoursToReport',
-          housework_type: 'HouseWorkType',
-          vat: 'VAT'
-        }.freeze
-        JSON_ENTITY_WRAPPER = 'OrderRow'
-        JSON_COLLECTION_WRAPPER = 'OrderRows'
-      end
-
-      Registry.register(OrderRow.canonical_name_sym, OrderRow)
-      Registry.register(:orderrows, OrderRow)
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module Fortnox
-  module API
-    module Mapper
-      class Project < Fortnox::API::Mapper::Base
-        KEY_MAP = {}.freeze
-        JSON_ENTITY_WRAPPER = 'Project'
-        JSON_COLLECTION_WRAPPER = 'Projects'
-      end
-
-      Registry.register(Project.canonical_name_sym, Project)
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module Fortnox
-  module API
-    module Mapper
-      class TermsOfPayment < Fortnox::API::Mapper::Base
-        KEY_MAP = {}.freeze
-        JSON_ENTITY_WRAPPER = 'TermsOfPayment'
-        JSON_COLLECTION_WRAPPER = 'TermsOfPayments'
-      end
-
-      Registry.register(TermsOfPayment.canonical_name_sym, TermsOfPayment)
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module Fortnox
-  module API
-    module Mapper
-      class Unit < Fortnox::API::Mapper::Base
-        KEY_MAP = {}.freeze
-        JSON_ENTITY_WRAPPER = 'Unit'
-        JSON_COLLECTION_WRAPPER = 'Units'
-      end
-
-      Registry.register(Unit.canonical_name_sym, Unit)
-    end
-  end
-end

data/lib/fortnox/api/mappers/value/array.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Fortnox
-  module API
-    module Mapper
-      Array = lambda do |array|
-        array.each_with_object([]) do |item, converted_array|
-          name = Fortnox::API::Mapper::Base.canonical_name_sym(item)
-          converted_array << Fortnox::API::Registry[name].call(item)
-        end
-      end
-
-      Registry.register(:array, Fortnox::API::Mapper::Array)
-
-      Registry.register(:labels, Fortnox::API::Mapper::Array)
-    end
-  end
-end

data/lib/fortnox/api/mappers/value/country_string.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../base/canonical_name_sym'
-
-module Fortnox
-  module API
-    module Mapper
-      class CountryString
-        extend CanonicalNameSym
-
-        CountryMapper = lambda do |code|
-          next code if code.nil? || code == ''
-
-          # Fortnox only supports Swedish country name for Sweden
-          next 'Sverige' if code == 'SE'
-
-          ::ISO3166::Country[code].translations['en']
-        end
-
-        Registry.register(canonical_name_sym, CountryMapper)
-      end
-    end
-  end
-end

data/lib/fortnox/api/mappers/value/date.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Fortnox
-  module API
-    module Mapper
-      Date = ->(value) { value.to_s }
-
-      Registry.register(:date, Fortnox::API::Mapper::Date)
-    end
-  end
-end

data/lib/fortnox/api/mappers/value/hash.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Fortnox
-  module API
-    module Mapper
-      Hash = lambda do |hash|
-        hash.each do |key, value|
-          name = Fortnox::API::Mapper::Base.canonical_name_sym(value)
-          hash[key] = Fortnox::API::Registry[name].call(value)
-        end
-      end
-
-      Registry.register(:hash, Hash)
-    end
-  end
-end

data/lib/fortnox/api/mappers/value/identity.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Fortnox
-  module API
-    module Mapper
-      Identity = ->(value) { value }
-
-      Registry.register(:integer, Fortnox::API::Mapper::Identity)
-      Registry.register(:int, Fortnox::API::Mapper::Identity)
-      Registry.register(:float, Fortnox::API::Mapper::Identity)
-      Registry.register(:string, Fortnox::API::Mapper::Identity)
-      Registry.register(:boolean, Fortnox::API::Mapper::Identity)
-      Registry.register(:falseclass, Fortnox::API::Mapper::Identity)
-      Registry.register(:trueclass, Fortnox::API::Mapper::Identity)
-      Registry.register(:nilclass, Fortnox::API::Mapper::Identity)
-    end
-  end
-end

data/lib/fortnox/api/mappers.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'types'
-
-require_relative 'mappers/value/array'
-require_relative 'mappers/value/country_string'
-require_relative 'mappers/value/date'
-require_relative 'mappers/value/hash'
-require_relative 'mappers/value/identity'
-require_relative 'mappers/customer'
-require_relative 'mappers/default_delivery_types'
-require_relative 'mappers/default_templates'
-require_relative 'mappers/edi_information'
-require_relative 'mappers/email_information'
-require_relative 'mappers/invoice_row'
-require_relative 'mappers/invoice'
-require_relative 'mappers/order_row'
-require_relative 'mappers/order'
-require_relative 'mappers/project'
-require_relative 'mappers/unit'
-require_relative 'mappers/terms_of_payment'