fortnox-api 0.8.0 → 0.9.0

data/fortnox-api.gemspec

@@ -1,44 +1,50 @@
-
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'fortnox/api/version'
+require_relative 'lib/fortnox/api/version'
 
-Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
   spec.name          = 'fortnox-api'
   spec.version       = Fortnox::API::VERSION
-  spec.authors       = ['Jonas Schubert Erlandsson', 'Hannes Elvemyr', 'Felix Holmgren']
+  spec.authors       = ['Jonas Schubert Erlandsson', 'Hannes Elvemyr', 'Felix Holmgren', 'Mike Eirih']
   spec.email         = ['info@accodeing.com']
   spec.summary       = 'Gem to use Fortnox REST API in Ruby.'
-  spec.description   = 'This gem uses the HTTParty library to abstract away the REST calls. It gives you access to a '\
-                       'number of objects that behave a lot like ActiveRecord instances, giving you access to methods '\
-                       'like `all`, `find`, `find_by_...` and so on. And each individual instance can be easily'\
-                       'persistable to Fortnox again using the `save` method.'
+  spec.description   = 'This gem uses the HTTParty library to abstract away the REST calls. It gives you access to a ' \
+                       'number of objects that behave a lot like ActiveRecord instances, giving you access to ' \
+                       'methods like `all`, `find`, `find_by_...` and so on. And each individual instance can be' \
+                       'easily persistable to Fortnox again using the `save` method.'
   spec.homepage      = 'http://github.com/accodeing/fortnox-api'
   spec.license       = 'LGPL-3.0'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.5'
-  spec.add_dependency 'countries', '~> 3.0'
-  spec.add_dependency 'dry-struct', '~> 0.1'
-  spec.add_dependency 'dry-types', '~> 0.8', '< 0.13.0'
-  spec.add_dependency 'httparty', '~> 0.17'
+  spec.required_ruby_version = '>= 2.7'
+  spec.add_dependency 'countries', '~> 5.0'
+  spec.add_dependency 'dry-configurable', '~> 1.0'
+  spec.add_dependency 'dry-container', '~> 0.10'
+  spec.add_dependency 'dry-struct', '~> 1.6'
+  spec.add_dependency 'dry-types', '~> 1.7'
+  spec.add_dependency 'httparty', '~> 0.21'
+  spec.add_dependency 'jwt', '~> 2.3'
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'guard', '~> 2.12'
-  spec.add_development_dependency 'guard-rspec', '~> 4.5'
+  spec.add_development_dependency 'bundler', '~> 2.4'
+  spec.add_development_dependency 'dotenv', '~> 2.8'
+  spec.add_development_dependency 'guard', '~> 2.18'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.5'
   spec.add_development_dependency 'pry', '~> 0'
-  spec.add_development_dependency 'rake', '>= 12.3.3'
-  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.12'
   spec.add_development_dependency 'rspec-collection_matchers', '~> 0'
-  spec.add_development_dependency 'rubocop', '~> 0.52.0'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.22.2'
-  spec.add_development_dependency 'simplecov', '~> 0.15'
-  spec.add_development_dependency 'vcr', '~> 4.0'
-  spec.add_development_dependency 'webmock', '~> 3.5'
+  spec.add_development_dependency 'rubocop', '~> 1.39.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.16.0'
+  spec.add_development_dependency 'simplecov', '~> 0.22'
+  spec.add_development_dependency 'vcr', '~> 6.1'
+  spec.add_development_dependency 'webmock', '~> 3.18'
 end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/mappers/base'
+require_relative 'base'
 
 module Fortnox
   module API

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

@@ -4,7 +4,7 @@ module Fortnox
   module API
     module Mapper
       module FromJSON
-        class MissingModelOrMapperException < StandardError
+        class MissingModelOrMapperException < Fortnox::API::Exception
         end
 
         def wrapped_json_collection_to_entities_hash(json_collection_hash)
@@ -45,12 +45,13 @@ module Fortnox
             # 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}"
+            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, {})
+            convert_hash_keys_from_json_format(collection, {})
           end
         end
 

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

@@ -25,8 +25,8 @@ module Fortnox
           # 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
+            hash.transform_keys do |key|
+              convert_key_to_json(key)
             end
           end
 
@@ -35,13 +35,12 @@ module Fortnox
           end
 
           def default_key_to_json_transform(key)
-            key.to_s.split('_').map(&:capitalize).join('')
+            key.to_s.split('_').map(&:capitalize).join
           end
 
           def sanitise(hash, keys_to_filter)
             hash.reject do |key, value|
-              next false if keys_to_filter.include?(key)
-              value.nil?
+              keys_to_filter.include?(key) || value.nil?
             end
           end
         end

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/mappers/base/canonical_name_sym'
-require 'fortnox/api/mappers/base/from_json'
-require 'fortnox/api/mappers/base/to_json'
+require_relative 'base/canonical_name_sym'
+require_relative 'base/from_json'
+require_relative 'base/to_json'
 
 module Fortnox
   module API

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/mappers/base'
+require_relative 'base'
 
 module Fortnox
   module API

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/mappers/base'
+require_relative 'base'
 
 module Fortnox
   module API

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/mappers/base'
+require_relative 'base'
 
 module Fortnox
   module API

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/mappers/base'
+require_relative 'base'
 
 module Fortnox
   module API

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/mappers/base'
+require_relative 'base'
 
 module Fortnox
   module API

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

@@ -1,9 +1,9 @@
 # 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'
+require_relative 'base'
+require_relative 'edi_information'
+require_relative 'email_information'
+require_relative 'invoice_row'
 
 module Fortnox
   module API

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/mappers/base'
+require_relative 'base'
 
 module Fortnox
   module API

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

@@ -1,9 +1,9 @@
 # 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'
+require_relative 'base'
+require_relative 'edi_information'
+require_relative 'email_information'
+require_relative 'order_row'
 
 module Fortnox
   module API

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/mappers/base'
+require_relative 'base'
 
 module Fortnox
   module API

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/mappers/base'
+require_relative 'base'
 
 module Fortnox
   module API

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/mappers/base'
+require_relative 'base'
 
 module Fortnox
   module API

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/mappers/base'
+require_relative 'base'
 
 module Fortnox
   module API

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/mappers/base/canonical_name_sym'
+require_relative '../base/canonical_name_sym'
 
 module Fortnox
   module API

data/lib/fortnox/api/mappers.rb

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types'
+require_relative 'types'
 
-require 'fortnox/api/mappers/value/array'
-require 'fortnox/api/mappers/value/country_string'
-require 'fortnox/api/mappers/value/date'
-require 'fortnox/api/mappers/value/hash'
-require 'fortnox/api/mappers/value/identity'
-require 'fortnox/api/mappers/customer'
-require 'fortnox/api/mappers/default_delivery_types'
-require 'fortnox/api/mappers/default_templates'
-require 'fortnox/api/mappers/edi_information'
-require 'fortnox/api/mappers/email_information'
-require 'fortnox/api/mappers/invoice_row'
-require 'fortnox/api/mappers/invoice'
-require 'fortnox/api/mappers/order_row'
-require 'fortnox/api/mappers/order'
-require 'fortnox/api/mappers/project'
-require 'fortnox/api/mappers/unit'
-require 'fortnox/api/mappers/terms_of_payment'
+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'

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types'
-require 'fortnox/api/models/base'
+require_relative 'base'
+require_relative '../types'
 
 module Fortnox
   module API

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

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types'
 require 'ice_nine'
 
+require_relative '../types'
+
 module Fortnox
   module API
     module Model
@@ -25,8 +26,8 @@ module Fortnox
             obj = preserve_meta_properties(hash) do
               super(hash)
             end
-          rescue Dry::Struct::Error => e
-            raise Fortnox::API::AttributeError, e
+          rescue Dry::Struct::Error => exception
+            raise Fortnox::API::AttributeError, exception
           end
 
           IceNine.deep_freeze(obj)
@@ -36,6 +37,10 @@ module Fortnox
           new(self::STUB.dup)
         end
 
+        def unique_id
+          send(self.class::UNIQUE_ID)
+        end
+
         # This filtering logic could be improved since it is currently O(N*M).
         def attributes(*options)
           return self.class.schema if options.nil?
@@ -47,25 +52,30 @@ module Fortnox
           end
         end
 
-        def unique_id
-          send(self.class::UNIQUE_ID)
+        def to_hash(recursive = false) # rubocop:disable Style/OptionalBooleanParameter
+          return super() if recursive
+
+          self.class.schema.each_with_object({}) do |key, result|
+            # Only output attributes that have a value set
+            result[key.name] = self[key.name] if send("#{key.name}?")
+          end
         end
 
         def update(hash)
           old_attributes = to_hash
-          new_attributes = old_attributes.merge(hash)
+          new_attributes = old_attributes.merge(hash).compact
 
           return self if new_attributes == old_attributes
 
-          new_hash = new_attributes.delete_if { |_, value| value.nil? }
-          new_hash[:new] = @new
-          new_hash[:parent] = self
-          self.class.new(new_hash)
+          new_attributes[:new] = @new
+          new_attributes[:parent] = self
+          self.class.new(new_attributes)
         end
 
         # Generic comparison, by value, use .eql? or .equal? for object identity.
         def ==(other)
           return false unless other.is_a? self.class
+
           to_hash == other.to_hash
         end
 
@@ -85,19 +95,9 @@ module Fortnox
           @parent || self.class.new(self.class::STUB.dup)
         end
 
-        def to_hash(recursive = false)
-          return super() if recursive
-
-          self.class.schema.keys.each_with_object({}) do |key, result|
-            result[key] = self[key]
-          end
-        end
-
-        private_class_method
-
         # dry-types filter anything that isn't specified as an attribute on the
         # class that is being instantiated. This wrapper preserves the meta
-        # properties we need to track object state during that initilisation and
+        # properties we need to track object state during that initialisation and
         # sets them on the object after dry-types is done with it.
         def self.preserve_meta_properties(hash)
           is_unsaved = hash.delete(:unsaved) { true }
@@ -115,6 +115,8 @@ module Fortnox
           obj
         end
 
+        private_class_method :preserve_meta_properties
+
         private
 
         def private_attributes