fortnox-api 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a0367007a797c6a5e054927933fb9e4cb9e897b1
-  data.tar.gz: 280be6192fd9f9d9678b02c18f84d1da45dcb969
+SHA256:
+  metadata.gz: a174ee3cf9c8f2a5ee1a43ce636806e017e1462263eddfdd5e91968025144fb4
+  data.tar.gz: d5f3c46c81e25009be272bee9bdfafe64e657f4ff5b7a131c272a49b8f9382f5
 SHA512:
-  metadata.gz: 55041f7e183aa01f3757feaf79135bd415665983f5475186a41cf2199dbf8be2933f4fe1a705b6d839eb60883a9f1a4aa2777c19324bcc7b41a654a64a5d3599
-  data.tar.gz: a1e060065d65878d653dcd34f7b78dfff30ef341617e05653853a7af5f524a4e3261be7c03708e7c8ebad182bffcdcf17ecb48214e6ded8033d8fd2acdc5eb69
+  metadata.gz: 942b59f8380781117425fbcdb713bbf05c3e4651779e517c89b1c1cd339bc521a19a79ca2df9c02098a472eabc31a5b9ae9f1b69945bd21c54e727075d4c66f9
+  data.tar.gz: 598dd75a8a6d7f8af1b84e70a331192df243ebddad2174b09f43161767ab84b0e4c08dc8c020e55b9fa8928d8d3419f6ba7a99e2b5c6d21d541691d0eaacda17

data/.rubocop.yml

@@ -19,3 +19,7 @@ Metrics/LineLength:
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
+
+Naming/PredicateName:
+  Exclude:
+    - 'spec/support/matchers/**/*'

data/.travis.yml

@@ -1,31 +1,36 @@
 env:
   global:
-  - CC_TEST_REPORTER_ID=397c19af63ca3467cff6fd640b0460b691f687118332b5989f530d28f82adcb8
+  - 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.4.6
 - 2.5.0
-addons:
-  code_climate:
-    repo_token: 397c19af63ca3467cff6fd640b0460b691f687118332b5989f530d28f82adcb8
+- 2.5.5
+- 2.6.0
+- 2.6.3
+- 2.7.0-preview1
 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
+- 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
+- "./cc-test-reporter before-build"
 script:
 - 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,18 @@
+# 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.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
+
+[0.7.0]: https://github.com/accodeing/fortnox-api/compare/v0.7.0...v0.6.3

data/README.md

@@ -3,24 +3,21 @@
 
 # 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 October 2018):
+* 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).
 * 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.
+* 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.
@@ -84,12 +81,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 build for Ruby 2.4 or higher (see Travis configuration file for what versions we are testing against).
 
 ## Installation
 

data/fortnox-api.gemspec

@@ -23,13 +23,13 @@ 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.4'
+  spec.add_dependency 'countries', '~> 3.0'
   spec.add_dependency 'dry-struct', '~> 0.1'
   spec.add_dependency 'dry-types', '~> 0.8', '< 0.13.0'
-  # TODO: Temporary lockdown. See issue #103 for more info.
-  spec.add_dependency 'httparty', '~> 0.14.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'
@@ -39,6 +39,6 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   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_code_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/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_code_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 CountryCodeString
+        extend CanonicalNameSym
+
+        CountryCodeMapper = 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, CountryCodeMapper)
+      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

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

@@ -0,0 +1,18 @@
+# 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/models/document.rb

@@ -109,7 +109,7 @@ module Fortnox
         # HouseWork If there is any row of the document marked "housework".
         attribute :housework, Types::Nullable::Boolean.is(:read_only)
 
-        attribute :labels, Types::Strict::Array.member(Label)
+        attribute :labels, Types::Strict::Array.of(Label)
 
         # Net Net amount
         attribute :net, Types::Nullable::Float.is(:read_only)

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

@@ -50,7 +50,7 @@ module Fortnox
         attribute :invoice_period_end, Types::Nullable::Date.is(:read_only)
 
         # InvoiceRows Separate object
-        attribute :invoice_rows, Types::Strict::Array.member(Types::InvoiceRow)
+        attribute :invoice_rows, Types::Strict::Array.of(Types::InvoiceRow)
 
         # InvoiceType The type of invoice.
         attribute :invoice_type, Types::Nullable::String

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

@@ -20,7 +20,7 @@ module Fortnox
         attribute :order_date, Types::Nullable::Date
 
         # OrderRows Separate object
-        attribute :order_rows, Types::Strict::Array.member(Types::OrderRow)
+        attribute :order_rows, Types::Strict::Array.of(Types::OrderRow)
       end
     end
   end

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

@@ -16,10 +16,10 @@ module Fortnox
 
         HTTParty::Parser::SupportedFormats['text/html'] = :json
 
-        DEFAULT_HEADERS = {
+        headers(
           'Content-Type' => 'application/json',
           'Accept' => 'application/json'
-        }.freeze
+        )
 
         HTTP_METHODS = %i[get put post delete].freeze
 
@@ -31,21 +31,19 @@ module Fortnox
         end
 
         HTTP_METHODS.each do |method|
-          define_method method do |*args|
-            headers['Access-Token'] = next_access_token
+          define_method method do |path, options = {}, &block|
+            provided_headers = options[:headers] || {}
+            provided_headers['Client-Secret'] = client_secret
+            provided_headers['Access-Token'] = next_access_token
+            options[:headers] = provided_headers
+            options[:base_uri] ||= base_url
             execute do |remote|
-              remote.send(method, *args)
+              remote.send(method, path, options, &block)
             end
           end
         end
 
         def initialize(keys_filtered_on_save: [:url], token_store: :default)
-          self.class.base_uri(base_url)
-
-          self.headers = DEFAULT_HEADERS.merge(
-            'Client-Secret' => client_secret
-          )
-
           @keys_filtered_on_save = keys_filtered_on_save
           @token_store = token_store
           @mapper = Registry[Mapper::Base.canonical_name_sym(self.class::MODEL)].new