fortnox-api 0.5.2 → 0.6.0

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

@@ -1,77 +1,84 @@
+# frozen_string_literal: true
+
 module Fortnox
   module API
     module Mapper
       module FromJSON
-
         class MissingModelOrMapperException < StandardError
         end
 
-        def wrapped_json_collection_to_entities_hash( json_collection_hash )
+        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 )
+          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 )
+        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 )
+        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 )
+                convert_collection(key, value)
               else
                 value
               end
           end
         end
 
-        def convert_collection( key, collection )
+        def convert_collection(key, collection)
           mapper_name = key.downcase
           if Registry.key?(mapper_name)
-            convert_nested_data( mapper_name, key, collection )
+            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.
 
-            raise MissingModelOrMapperException, "for #{ key } (#{ mapper_name }, #{ Fortnox::API::Mapper::DefaultTemplates.canonical_name_sym }) with #{ collection }" if ENV['RUBY_ENV']
-            Fortnox::API.logger.warn( "Missing Model or Mapper implementation for #{ key } with attributes: #{ collection }" )
-            return convert_hash_keys_from_json_format( collection, {} )
+            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}")
+            return convert_hash_keys_from_json_format(collection, {})
           end
         end
 
-        def convert_nested_data( _mapper_name, key, nested_data )
-          nested_mapper = Registry[ key.downcase ]
-          if nested_data.is_a?(::Array) # Array of nested models
-            return nested_data.each_with_object( [] ) do |value, nested_models|
-              nested_models << json_hash_to_entity_hash( value, nested_mapper::KEY_MAP )
-            end
-          else # Assume Hash of nested model
-            return json_hash_to_entity_hash( nested_data, nested_mapper::KEY_MAP )
+        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 )
+        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 )
+        def default_key_from_json_transform(key)
           key = key.to_s
-          unless key =~ /\A[A-Z]+\z/
-            key = key.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').gsub(/([a-z])([A-Z])/, '\1_\2')
-          end
+          key = camelcase_to_underscore(key) unless key =~ /\A[A-Z]+\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
       end
     end
   end

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

@@ -1,64 +1,66 @@
+# frozen_string_literal: true
+
 module Fortnox
   module API
     module Mapper
       module ToJSON
         def self.included(base)
-          base.instance_eval do
+          base.send :extend, ClassMethods
 
-            # PUBLIC
+          base.send :private_class_method,
+                    :convert_hash_keys_to_json_format,
+                    :convert_key_to_json,
+                    :default_key_to_json_transform,
+                    :sanitise
+        end
 
-            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
+        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
+          # PRIVATE
 
-            def convert_hash_keys_to_json_format( hash )
-              hash.each_with_object( {} ) do |(key, value), json_hash|
-                json_hash[ convert_key_to_json( key ) ] = value
-              end
+          def convert_hash_keys_to_json_format(hash)
+            hash.each_with_object({}) do |(key, value), json_hash|
+              json_hash[convert_key_to_json(key)] = value
             end
+          end
 
-            def convert_key_to_json( key )
-              self::KEY_MAP.fetch( key ){ default_key_to_json_transform( key ) }
-            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 default_key_to_json_transform(key)
+            key.to_s.split('_').map(&:capitalize).join('')
+          end
 
-            def sanitise( hash, keys_to_filter )
-              hash.select do |key, value|
-                next false if keys_to_filter.include?( key )
-                value != nil
-              end
+          def sanitise(hash, keys_to_filter)
+            hash.reject do |key, value|
+              next false if keys_to_filter.include?(key)
+              value.nil?
             end
-
-            private_class_method :convert_hash_keys_to_json_format,
-                                 :convert_key_to_json,
-                                 :default_key_to_json_transform,
-                                 :sanitise
           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 )
+        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 )
+        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
+        def mapper_name_for(value)
+          value.class.name.split('::').last.downcase.to_sym
+        end
       end
     end
   end

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

@@ -1,10 +1,11 @@
-require "fortnox/api/mappers/base"
+# frozen_string_literal: true
+
+require 'fortnox/api/mappers/base'
 
 module Fortnox
   module API
     module Mapper
       class Customer < Fortnox::API::Mapper::Base
-
         KEY_MAP = {
           vat_type: 'VATType',
           vat_number: 'VATNumber',
@@ -14,14 +15,13 @@ module Fortnox
           email_offer_cc: 'EmailOfferCC',
           email_order_bcc: 'EmailOrderBCC',
           email_order_cc: 'EmailOrderCC',
-          show_price_vat_included: 'ShowPriceVATIncluded',
+          show_price_vat_included: 'ShowPriceVATIncluded'
         }.freeze
-        JSON_ENTITY_WRAPPER = 'Customer'.freeze
-        JSON_COLLECTION_WRAPPER = 'Customers'.freeze
-
+        JSON_ENTITY_WRAPPER = 'Customer'
+        JSON_COLLECTION_WRAPPER = 'Customers'
       end
 
-      Registry.register( Customer.canonical_name_sym, Customer )
+      Registry.register(Customer.canonical_name_sym, Customer)
     end
   end
 end

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

@@ -1,4 +1,6 @@
-require "fortnox/api/mappers/base"
+# frozen_string_literal: true
+
+require 'fortnox/api/mappers/base'
 
 module Fortnox
   module API
@@ -7,7 +9,7 @@ module Fortnox
         KEY_MAP = {}.freeze
       end
 
-      Registry.register( DefaultDeliveryTypes.canonical_name_sym, DefaultDeliveryTypes )
+      Registry.register(DefaultDeliveryTypes.canonical_name_sym, DefaultDeliveryTypes)
     end
   end
 end

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

@@ -1,15 +1,16 @@
-require "fortnox/api/mappers/base"
+# frozen_string_literal: true
+
+require 'fortnox/api/mappers/base'
 
 module Fortnox
   module API
     module Mapper
       class DefaultTemplates < Fortnox::API::Mapper::Base
-
         KEY_MAP = {}.freeze
-        JSON_ENTITY_WRAPPER = JSON_COLLECTION_WRAPPER = 'DefaultTemplates'.freeze
+        JSON_ENTITY_WRAPPER = JSON_COLLECTION_WRAPPER = 'DefaultTemplates'
       end
 
-      Registry.register( DefaultTemplates.canonical_name_sym, DefaultTemplates )
+      Registry.register(DefaultTemplates.canonical_name_sym, DefaultTemplates)
     end
   end
 end

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

@@ -1,10 +1,11 @@
-require "fortnox/api/mappers/base"
+# frozen_string_literal: true
+
+require 'fortnox/api/mappers/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',
@@ -13,10 +14,10 @@ module Fortnox
           edi_our_electronic_reference: 'EDIOurElectronicReference',
           edi_your_electronic_reference: 'EDIYourElectronicReference'
         }.freeze
-        JSON_ENTITY_WRAPPER = JSON_COLLECTION_WRAPPER = 'EDIInformation'.freeze
+        JSON_ENTITY_WRAPPER = JSON_COLLECTION_WRAPPER = 'EDIInformation'
       end
 
-      Registry.register( EDIInformation.canonical_name_sym, EDIInformation )
+      Registry.register(EDIInformation.canonical_name_sym, EDIInformation)
     end
   end
 end

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

@@ -1,18 +1,19 @@
-require "fortnox/api/mappers/base"
+# frozen_string_literal: true
+
+require 'fortnox/api/mappers/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'.freeze
+        JSON_ENTITY_WRAPPER = JSON_COLLECTION_WRAPPER = 'EmailInformation'
       end
 
-      Registry.register( EmailInformation.canonical_name_sym, EmailInformation )
+      Registry.register(EmailInformation.canonical_name_sym, EmailInformation)
     end
   end
 end

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

@@ -1,27 +1,29 @@
-require "fortnox/api/mappers/base"
-require "fortnox/api/mappers/edi_information"
-require "fortnox/api/mappers/email_information"
-require "fortnox/api/mappers/invoice_row"
+# frozen_string_literal: true
+
+require 'fortnox/api/mappers/base'
+require 'fortnox/api/mappers/edi_information'
+require 'fortnox/api/mappers/email_information'
+require 'fortnox/api/mappers/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'.freeze
-        JSON_COLLECTION_WRAPPER = 'Invoices'.freeze
+        JSON_ENTITY_WRAPPER = 'Invoice'
+        JSON_COLLECTION_WRAPPER = 'Invoices'
       end
 
-      Registry.register( Invoice.canonical_name_sym, Invoice )
+      Registry.register(Invoice.canonical_name_sym, Invoice)
     end
   end
 end

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

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

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

@@ -1,7 +1,9 @@
-require "fortnox/api/mappers/base"
-require "fortnox/api/mappers/edi_information"
-require "fortnox/api/mappers/email_information"
-require "fortnox/api/mappers/order_row"
+# frozen_string_literal: true
+
+require 'fortnox/api/mappers/base'
+require 'fortnox/api/mappers/edi_information'
+require 'fortnox/api/mappers/email_information'
+require 'fortnox/api/mappers/order_row'
 
 module Fortnox
   module API
@@ -10,14 +12,15 @@ module Fortnox
         KEY_MAP = {
           administration_fee_vat: 'AdministrationFeeVAT',
           freight_vat: 'FreightVAT',
+          housework: 'HouseWork',
           total_vat: 'TotalVAT',
           vat_included: 'VATIncluded'
         }.freeze
-        JSON_ENTITY_WRAPPER = 'Order'.freeze
-        JSON_COLLECTION_WRAPPER = 'Orders'.freeze
+        JSON_ENTITY_WRAPPER = 'Order'
+        JSON_COLLECTION_WRAPPER = 'Orders'
       end
 
-      Registry.register( Order.canonical_name_sym, Order )
+      Registry.register(Order.canonical_name_sym, Order)
     end
   end
 end