fortnox-api 0.6.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 790f4fbabb42b6455b84fac371b7d0273432c65c
-  data.tar.gz: 81802b99dcd1d93af3ca69c774967271db96f318
+SHA256:
+  metadata.gz: 02c5fbd6c659d3c6cc4e9ed8dfef6e739ded62fc33107623f4dddc13d33f6672
+  data.tar.gz: 14f0815a2fd32e98055d71ef231da2b6fac4b95ecfd9dfcda59b88d1c1445c63
 SHA512:
-  metadata.gz: cd2300b9cabe6ddc2e9ec16d767dc6e2c8e078078e7deacca457c003b6049f9f9d46a259b537aaafadbcd08b80d8712a8ecb7ab2ac7fa7e328b54c0318ec5a9f
-  data.tar.gz: bb686131fa2559c04b0e3b4a6036ab1ff912ff261aaa4eeb891dae57eb04f87a653b3e598e6d4bb48a2b8b1ddd9a63912fd303aca13b2f09cd94ba338f8fff39
+  metadata.gz: 293665ff9e0b860e88c7c6c78fbcfdd0b8a8047444f23cd0560d504442e1a0ac3439c52349413cac63e0c5973d1db74dabcf7ebdd9c10bc3f1b7de922db58cbc
+  data.tar.gz: 011b4785ce46af9c4cd57939431f6b09dc6ab44d650023616fe7b0784dcde890727999eb918ac3c3db311afaaff8785d240c54e5c30f198a630b9a1bf41483b7

data/.rubocop.yml

@@ -1,7 +1,7 @@
 require: rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
   DisplayCopNames: true
 
 RSpec/FilePath:
@@ -19,3 +19,7 @@ Metrics/LineLength:
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
+
+Naming/PredicateName:
+  Exclude:
+    - 'spec/support/matchers/**/*'

data/.travis.yml

@@ -1,31 +1,29 @@
 env:
   global:
-    - CC_TEST_REPORTER_ID=787a2f89b15c637323c7340d65ec17e898ac44480706b4b4122ea040c2a88f1d
+  - CC_TEST_REPORTER_ID=43ea0acb059b164537ce31bf67e03e1cb552d63df1ad3e9bd95dc3d844697bb4
 language: ruby
 rvm:
-  - "2.3.0"
-  - "2.3.1"
-  - "2.3.2"
-  - "2.3.3"
-  - "2.3.4"
-  - "2.3.5"
-  - "2.3.6"
-  - "2.4.0"
-  - "2.4.1"
-  - "2.4.2"
-  - "2.4.3"
-  - "2.5.0"
-addons:
-  code_climate:
-    repo_token: 397c19af63ca3467cff6fd640b0460b691f687118332b5989f530d28f82adcb8
+- 2.5.8
+- 2.6.6
+- 2.7.1
 notifications:
-  slack: my-codeworks:fwKO4YfipnmNKJQL3cRSEoKB
+  slack:
+    secure: UEYDtwLaQgAoMRY7ct1y0Uu5HbInMwrLo+TiYRc3rjDrzqDfDyInEr3bpckyPJ79lnzccrFezMdY4jWzRjmsvQzvYMu+DWJ1mAWOa/9Ws4YZ8nHd5KqXxVQ0EqPWuWwMOyOdyy3DK/MjUOobGSc0//Pv5DeaAAEBKLJzN+e1BQM=
   email: false
+before_install:
+- gem update --system
+- gem install bundler
+cache: bundler
 before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
+- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64
+  > ./cc-test-reporter
+- chmod +x ./cc-test-reporter
+- "./cc-test-reporter before-build"
 script:
-  - bundle exec rspec
+- bundle exec rspec
 after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
+branches:
+  only:
+  - master
+  - development

data/CHANGELOG.md

@@ -0,0 +1,48 @@
+# 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).
+
+## [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.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
+[0.6.3]: https://github.com/accodeing/fortnox-api/compare/v0.6.2...v0.6.3

data/README.md

@@ -3,24 +3,20 @@
 
 # Status for master
 [![Gem version](https://img.shields.io/gem/v/fortnox-api.svg?style=flat-square)](https://rubygems.org/gems/fortnox-api)
-[![Build status](https://img.shields.io/travis/my-codeworks/fortnox-api/master.svg?style=flat-square)](https://travis-ci.org/my-codeworks/fortnox-api)
-[![Dependency status](https://img.shields.io/gemnasium/my-codeworks/fortnox-api.svg?style=flat-square)](https://gemnasium.com/my-codeworks/fortnox-api)
+[![Build Status](https://travis-ci.com/accodeing/fortnox-api.svg?branch=master)](https://travis-ci.com/accodeing/fortnox-api)
 
 # Status for development
-[![Build status](https://img.shields.io/travis/my-codeworks/fortnox-api/development.svg?style=flat-square)](https://travis-ci.org/my-codeworks/fortnox-api)
-[![Maintainability](https://api.codeclimate.com/v1/badges/50d44a1d00620b4a6bde/maintainability)](https://codeclimate.com/github/my-codeworks/fortnox-api/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/50d44a1d00620b4a6bde/test_coverage)](https://codeclimate.com/github/my-codeworks/fortnox-api/test_coverage)
+[![Build Status](https://travis-ci.com/accodeing/fortnox-api.svg?branch=development)](https://travis-ci.com/accodeing/fortnox-api)
+[![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 2017):
-* In active development (just check out the commit log)
-* Three developers. At least thrice as good as one.
+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 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.
-* Advanced features around the corner. Things like sorting entities, pagination of results etc.
-* A few models implemented. Right now we have nearly full support for `Customer`, `Invoice`, `Order`, `Article`, `Label` and `Project`. Adding more models in general is quick and easy, see the developer guide further down.
-* Massive refactorings no longer occurs weekly :) We are running this gem in production for live test.
-
-The goal is to have a production ready version that covers at least the `Invoice`, `Order`,  `Customer` and `Project` models by January.
+* 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.
 
 # 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.
@@ -84,12 +80,7 @@ These are responsible for the mapping between our plain old Ruby object models a
 
 # Requirements
 
-This gem is build for Ruby 2.2 or higher, it's tested agains Ruby 2.2.5, 2.3.0 and 2.3.1. Since it uses the keywords argument feature and since Ruby 2.1
-is [officially outdated and unsupported](https://www.ruby-lang.org/en/news/2016/03/30/ruby-2-1-9-released/)
-it won't work on older versions.
-
-If you want or need Ruby 1.9 compatibility please submit a pull request.
-Instructions can be found below :)
+This gem is built for Ruby 2.5 or higher (see Travis configuration file for what versions we are testing against).
 
 ## Installation
 
@@ -199,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

@@ -9,13 +9,13 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.name          = 'fortnox-api'
   spec.version       = Fortnox::API::VERSION
   spec.authors       = ['Jonas Schubert Erlandsson', 'Hannes Elvemyr', 'Felix Holmgren']
-  spec.email         = ['info@my-codeworks.com']
+  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.homepage      = 'http://github.com/my-codeworks/fortnox-api'
+  spec.homepage      = 'http://github.com/accodeing/fortnox-api'
   spec.license       = 'LGPL-3.0'
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -23,22 +23,22 @@ 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.3'
+  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'
-  # TODO: Temporary lockdown. See issue #103 for more info.
-  spec.add_dependency 'httparty', '~> 0.14.0'
+  spec.add_dependency 'dry-types', '~> 0.8', '< 0.13.0'
+  spec.add_dependency 'httparty', '~> 0.17'
 
-  spec.add_development_dependency 'bundler', '~> 1.9'
+  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 'pry', '~> 0'
-  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.2'
   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', '~> 3.0'
-  spec.add_development_dependency 'webmock', '~> 1.21'
+  spec.add_development_dependency 'vcr', '~> 4.0'
+  spec.add_development_dependency 'webmock', '~> 3.5'
 end

data/lib/fortnox/api/mappers.rb

@@ -2,44 +2,11 @@
 
 require 'fortnox/api/types'
 
-module Fortnox
-  module API
-    module Mapper
-      Identity = ->(value) { value }
-
-      Date = ->(value) { value.to_s }
-
-      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(: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)
-      Registry.register(:array, Fortnox::API::Mapper::Array)
-      Registry.register(:date, Fortnox::API::Mapper::Date)
-
-      Registry.register(:account_number, Fortnox::API::Mapper::Identity)
-      Registry.register(:country_code, Fortnox::API::Mapper::Identity)
-      Registry.register(:currency, Fortnox::API::Mapper::Identity)
-      Registry.register(:customer_type, Fortnox::API::Mapper::Identity)
-      Registry.register(:discount_type, Fortnox::API::Mapper::Identity)
-      Registry.register(:email, Fortnox::API::Mapper::Identity)
-      Registry.register(:housework_type, Fortnox::API::Mapper::Identity)
-      Registry.register(:vat_type, Fortnox::API::Mapper::Identity)
-      Registry.register(:labels, Fortnox::API::Mapper::Array)
-    end
-  end
-end
-
+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'

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

@@ -1,5 +1,6 @@
 # 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'
 
@@ -9,30 +10,7 @@ module Fortnox
       class Base
         include FromJSON
         include ToJSON
-
-        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, Fortnox::API::Mapper::Base::Hash)
-
-        def self.canonical_name_sym(*values)
-          klass = if values.empty?
-                    self
-                  elsif values.first.is_a? Class
-                    values.first
-                  else
-                    values.first.class
-                  end
-
-          # For Ruby < 2.4, make sure we don't pass Bignum and Fixnum around
-          klass = Integer if %w[Bignum Fixnum].include?(klass.to_s) # Stringify to avoid warnings on 2.4
-
-          klass.name.split('::').last.downcase.to_sym
-        end
+        extend CanonicalNameSym
 
         def diff(entity_hash, parent_hash)
           hash_diff(entity_hash[self.class::JSON_ENTITY_WRAPPER],

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Fortnox
+  module API
+    module Mapper
+      module CanonicalNameSym
+        def canonical_name_sym(*values)
+          klass = if values.empty?
+                    self
+                  elsif values.first.is_a? Class
+                    values.first
+                  else
+                    values.first.class
+                  end
+
+          klass.name.split('::').last.downcase.to_sym
+        end
+      end
+    end
+  end
+end

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

@@ -72,13 +72,18 @@ 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 = 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

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

@@ -0,0 +1,18 @@
+# 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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'fortnox/api/mappers/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

@@ -0,0 +1,11 @@
+# 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

@@ -0,0 +1,16 @@
+# 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