fortnox-api 0.7.2 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 707b9b050edd8499029c1f2120d11edc923e868847657eb0c108789014a5e3c8
-  data.tar.gz: 7da764b991529e720f3afbbb01433da52ca4f34800951b05c4f0f1e11f646c6a
+  metadata.gz: 7d28f8cb3667dac63023e514d6c5203ba795a8c1c2598bbf538e49f58528cbc1
+  data.tar.gz: 127841e8b5d6a64d2b37408960e9659da918fcc9135d821098d281d508e337ca
 SHA512:
-  metadata.gz: 075e852a210ad2313fcf1c4469cb54a857016d46963e353679f16ea9e5daf09b28857491d9ccdc9b20c2a6843d7bc79093122db5419cf4219f1d830665af27b4
-  data.tar.gz: 35f8989ec19be2bf69c4f703daf54feb8b7d09e4c6bec95455c3483b23e4f8aa74547f781f2874c39d8903761feb769474bba0795ac2b3a21142a27b4ca706dc
+  metadata.gz: 4a9557fb4ecacf5d545c26d8894953793268b37a3c8a603a8095e239536d97871712140a6c3bc1f0596708913f369584633fee7e903a3f8ae4be99c47297418d
+  data.tar.gz: 244727089a11d031ec9e8afafa93d80c4b3ee87d1eb9c7f6ff57a8d26751d78304bc34073c095328f61edc580abeff44dba3f275e28346dea024b292e114126a

data/.codeclimate.yml

@@ -12,6 +12,7 @@ engines:
     enabled: false
   rubocop:
     enabled: true
+    channel: rubocop-1-39-0
 ratings:
   paths:
   - "**.rb"

data/.rubocop.yml

@@ -1,7 +1,7 @@
 require: rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.7
   DisplayCopNames: true
 
 RSpec/FilePath:

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.0

data/.travis.yml

@@ -3,16 +3,11 @@ env:
   - CC_TEST_REPORTER_ID=43ea0acb059b164537ce31bf67e03e1cb552d63df1ad3e9bd95dc3d844697bb4
 language: ruby
 rvm:
-- 2.4.0
-- 2.4.1
-- 2.4.2
-- 2.4.3
-- 2.4.6
-- 2.5.0
-- 2.5.5
-- 2.6.0
-- 2.6.3
-- 2.7.0-preview1
+  - 2.7.7
+  - 3.0.5
+  - 3.1.3
+  - 3.2.0
+
 notifications:
   slack:
     secure: UEYDtwLaQgAoMRY7ct1y0Uu5HbInMwrLo+TiYRc3rjDrzqDfDyInEr3bpckyPJ79lnzccrFezMdY4jWzRjmsvQzvYMu+DWJ1mAWOa/9Ws4YZ8nHd5KqXxVQ0EqPWuWwMOyOdyy3DK/MjUOobGSc0//Pv5DeaAAEBKLJzN+e1BQM=

data/CHANGELOG.md

@@ -1,37 +1,81 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+and this project adheres to
+[Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [0.8.1]
+
+### Fixed
+
+- Missing runtime dependencies dry-configurable and dry-container is added.
+  Those were indirect dependencies before via other dry libs, but we use them
+  explicitly in the gem, so they should be included as real dependencies. Also,
+  newer versions of these gems did actually break the gem.
+
+### Removed
+
+- **Breaking** Drops support for Ruby 2.6 since it's reached end of life
+- Token rotation is removed since Fortnox counts rate limit on tenant and client
+  id. Before, you could get around this by using multiple access tokens. That's
+  not possible anymore, so token rotation is simply removed.
+
+## [0.8.0]
+
+### Changed
+
+- `Fortnox::API::CURRENT_HOUSEWORK_TYPES` is now renamed to `HOUSEWORK_TYPES`
+  and is instead a Hash with keys for the different categories of types. It also
+  includes legacy types, which means `Fortnox::API::LEGACY_HOUSEWORK_TYPES` is
+  removed.
+
+### Removed
+
+- Drops support for Ruby < `2.5.0` since they are deprecated
 
 ## [0.7.2]
+
 ### Fixed
+
 - Invalid validation for Customer's account number attribute
 
 ## [0.7.1]
+
 ### Fixed
+
 - Invalid validation for Customer's country attributes
 
 ## [0.7.0]
+
 ### Added
+
 - Adds build test for Ruby `2.6.0`, `2.6.3` and `2.7.0-preview`.
 
 ### Removed
+
 - Drops support for Ruby < `2.4.0` since they are deprecated
 
 ### Fixed
+
 - Country attribute for `Invoice` and `Order` is now validated correctly.
 - Fixes deprecation warnings
 - Unlocks pinned `HTTParty` version
 - Invalid email validation
 
 ## [0.6.3]
+
 ### Changed
+
 - Pins `dry-types` to `< 0.13.0` due to breaking changes
 
 ### Fixed
+
 - Model attribute `url` is no longer null
 
+[0.8.1]: https://github.com/accodeing/fortnox-api/compare/v0.8.0...v0.8.1
+[0.8.0]: https://github.com/accodeing/fortnox-api/compare/v0.7.2...v0.8.0
 [0.7.2]: https://github.com/accodeing/fortnox-api/compare/v0.7.1...v0.7.2
 [0.7.1]: https://github.com/accodeing/fortnox-api/compare/v0.7.0...v0.7.1
 [0.7.0]: https://github.com/accodeing/fortnox-api/compare/v0.6.3...v0.7.0

data/README.md

@@ -10,14 +10,13 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/89d30a43fedf210d470b/maintainability)](https://codeclimate.com/github/accodeing/fortnox-api/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/89d30a43fedf210d470b/test_coverage)](https://codeclimate.com/github/accodeing/fortnox-api/test_coverage)
 
-The rough status of this project is as follows (as of October 2018):
+The rough status of this project is as follows (as of December 2020):
 * Development is not as active as it used to be, but the project is not forgotten. We have an app running this gem in production and it works like a charm for what we do.
-* We are planning on generalize REST API's in general with our [rest_easy gem](https://github.com/accodeing/rest_easy).
+* We hope to be able to continue with our work with [rest_easy gem](https://github.com/accodeing/rest_easy), which generalize REST API's in general.
 * Basic structure complete. Things like getting customers and invoices, updating and saving etc.
 * Some advanced features implemented, for instance support for multiple Access Tokens and filtering entities.
 * We have ideas for more advanced features, like sorting entities, pagination of results but nothing in the pipeline right now.
 * A few models implemented. Right now we pretty good support for `Customer`, `Invoice`, `Order`, `Article`, `Label` and `Project`. Adding more models in general is quick and easy (that's the whole point with this gem), see the developer guide further down.
-* Massive refactorings no longer occurs weekly :)
 
 # Architecture overview
 The gem is structured with distinct models for the tasks of data, JSON mapping and saving state. These are called: model, type, mapper and repository.
@@ -81,7 +80,7 @@ These are responsible for the mapping between our plain old Ruby object models a
 
 # Requirements
 
-This gem is build for Ruby 2.4 or higher (see Travis configuration file for what versions we are testing against).
+This gem is built for Ruby 2.5 or higher (see Travis configuration file for what versions we are testing against).
 
 ## Installation
 
@@ -191,5 +190,9 @@ updated_customer.name #=> "Ned Stark"
 
 The update method takes an implicit hash of attributes to update, so you can update as many as you like in one go.
 
+# Development
+## Testing
+This gem has integration tests to verify the code against the real API. It uses [vcr](https://github.com/vcr/vcr) to record API endpoint responses. These responses are stored locally and are called vcr cassettes. If no cassettes are available, vcr will record new ones for you. Once in a while, it's good to throw away all cassettes and rerecord them. Fortnox updates their endpoints and we need to keep our code up to date with the reality. There's a handy rake task for removing all cassettes, see `rake -T`. Note that when rerecording all cassettes, do it one repository at a time, otherwise you'll definitely get `429 Too Many Requests` from Fortnox. Run them manually with something like `bundle exec rspec spec/fortnox/api/repositories/article_spec.rb`. Also, you will need to update some test data in specs, see notes in specs.
+
 # Contributing
 See the [CONTRIBUTE](CONTRIBUTE.md) readme.

data/Rakefile

@@ -5,3 +5,8 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+desc 'Remove all VCR cassettes so we can rerecord them'
+task :throw_vcr_cassettes do
+  FileUtils.rm_rf(Dir.glob('spec/vcr_cassettes/**'))
+end

data/fortnox-api.gemspec

@@ -3,12 +3,12 @@
 
 lib = File.expand_path('../lib', __FILE__)
 $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 '\
@@ -23,22 +23,27 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.4'
-  spec.add_dependency 'countries', '~> 3.0'
-  spec.add_dependency 'dry-struct', '~> 0.1'
-  spec.add_dependency 'dry-types', '~> 0.8', '< 0.13.0'
+  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.17'
+  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 'pry', '~> 0'
-  spec.add_development_dependency 'rake', '~> 10.4'
-  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 'timecop', '~> 0.9.6'
+  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

@@ -50,7 +50,7 @@ module Fortnox
 
             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
 
@@ -72,8 +72,8 @@ module Fortnox
 
         def default_key_from_json_transform(key)
           key = key.to_s
-          key = camelcase_to_underscore(key) unless key =~ /\A[A-Z]+\z/
-          key = strip_at_symbol(key) if key =~ /\A@.*\z/
+          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
 

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
 

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
@@ -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,8 +52,13 @@ module Fortnox
           end
         end
 
-        def unique_id
-          send(self.class::UNIQUE_ID)
+        def to_hash(recursive = false)
+          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 self.send("#{key.name}?")
+          end
         end
 
         def update(hash)
@@ -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 }

data/lib/fortnox/api/models/customer.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/document.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'fortnox/api/types'
-require 'fortnox/api/models/label'
+require_relative '../types'
+require_relative 'label'
 
 module Fortnox
   module API
@@ -154,6 +154,9 @@ module Fortnox
         # TaxReduction The amount of tax reduction.
         attribute :tax_reduction, Types::Nullable::Integer.is(:read_only)
 
+        # TaxReductionType Tax Reduction Type
+        attribute :tax_reduction_type, Types::TaxReductionType
+
         # TermsOfDelivery Code of the terms of delivery.
         attribute :terms_of_delivery, Types::Nullable::String
 

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

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

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

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

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

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

data/lib/fortnox/api/models/project.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/terms_of_payment.rb

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

data/lib/fortnox/api/models/unit.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