fortnox-api 0.5.2 → 0.6.0

data/.travis.yml

@@ -1,11 +1,31 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=787a2f89b15c637323c7340d65ec17e898ac44480706b4b4122ea040c2a88f1d
+language: ruby
 rvm:
-  - "2.2.5"
   - "2.3.0"
   - "2.3.1"
-  # - "2.4.0" TODO: Ruby 2.4 not supported yet. See issue #93.
+  - "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
 notifications:
   slack: my-codeworks:fwKO4YfipnmNKJQL3cRSEoKB
   email: false
+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
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in fortnox-api.gemspec
-gemspec
+gemspec

data/Guardfile

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 guard :rspec, cmd: 'bundle exec rspec --color', all_after_pass: true do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$}){ |m| "spec/#{ m[1] }_spec.rb" }
-  watch('spec/spec_helper.rb'){ "spec" }
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { 'spec' }
 end

data/README.md

@@ -8,8 +8,8 @@
 
 # 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)
-[![Code Climate](https://img.shields.io/codeclimate/github/my-codeworks/fortnox-api.svg?style=flat-square)](https://codeclimate.com/github/my-codeworks/fortnox-api)
-[![Test coverage](https://img.shields.io/codeclimate/coverage/github/my-codeworks/fortnox-api.svg?style=flat-square)](https://codeclimate.com/github/my-codeworks/fortnox-api/coverage)
+[![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)
 
 The rough status of this project is as follows (as of October 2017):
 * In active development (just check out the commit log)

data/Rakefile

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task default: :spec

data/bin/console

@@ -1,8 +1,22 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
+require 'bundler/setup'
 
-require "pry"
-require "fortnox/api"
+require 'pry'
+require 'fortnox/api'
+
+##
+# Starts a new copy of this script, replacing the current session.
+#
+# When run the current process, this script, will be replaced by the result from
+# exec, a new copy of this script.
+#
+# Together with Pry's history this makes it look like you basically just
+# reloaded the gem and all of it's dependancies with their latest versions.
+
+def reload!
+  exec([File.absolute_path(__FILE__), __FILE__], *ARGV)
+end
 
 Pry.start

data/fortnox-api.gemspec

@@ -1,39 +1,44 @@
-# coding: utf-8
+
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fortnox/api/version'
 
 Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
-  spec.name          = "fortnox-api"
+  spec.name          = 'fortnox-api'
   spec.version       = Fortnox::API::VERSION
-  spec.authors       = ["Jonas Schubert Erlandsson", "Hannes Elvemyr", "Felix Holmgren"]
-  spec.email         = ["jonas.schubert.erlandsson@my-codeworks.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 easaly persistable to Fortnox again using the `save` method."
-  spec.homepage      = "http://github.com/my-codeworks/fortnox-api"
-  spec.license       = "LGPL-3.0"
+  spec.authors       = ['Jonas Schubert Erlandsson', 'Hannes Elvemyr', 'Felix Holmgren']
+  spec.email         = ['info@my-codeworks.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.license       = 'LGPL-3.0'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}){ |f| File.basename(f) }
+  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.2'
-  spec.add_dependency "httparty", "~> 0.14.0" # TODO: Temporary lockdown. See issue #103 for more info.
-  spec.add_dependency "dry-struct", "~> 0.1"
-  spec.add_dependency "dry-types", "~> 0.8"
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.4"
-  spec.add_development_dependency "rspec", "~> 3.2"
-  spec.add_development_dependency "rspec-collection_matchers", "~> 0"
-  spec.add_development_dependency "guard", "~> 2.12"
-  spec.add_development_dependency "guard-rspec", "~> 4.5"
-  spec.add_development_dependency "webmock", "~> 1.21"
-  spec.add_development_dependency "vcr", "~> 3.0"
-  spec.add_development_dependency "pry", "~> 0"
-  spec.add_development_dependency "codeclimate-test-reporter", "~> 0"
-  spec.add_development_dependency "rubocop", "~> 0.46.0"
-  spec.add_development_dependency "rubocop-rspec", "~> 1.8.0"
+  spec.required_ruby_version = '>= 2.3'
+  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_development_dependency 'bundler', '~> 1.9'
+  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 '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'
 end

data/lib/fortnox/api.rb

@@ -1,12 +1,13 @@
-require "set"
-require "dry-struct"
-require "fortnox/api/circular_queue"
-require "fortnox/api/version"
+# frozen_string_literal: true
+
+require 'set'
+require 'dry-struct'
+require 'fortnox/api/circular_queue'
+require 'fortnox/api/version'
 require 'logger'
 
 module Fortnox
   module API
-
     extend Dry::Configurable
 
     DEFAULT_CONFIGURATION = {
@@ -16,24 +17,24 @@ module Fortnox
       access_token: nil,
       access_tokens: nil,
       debugging: false,
-      logger: ->{
+      logger: lambda {
         logger = Logger.new(STDOUT)
         logger.level = Logger::WARN
         return logger
-      }.call,
+      }.call
     }.freeze
 
     setting :base_url, DEFAULT_CONFIGURATION[:base_url]
     setting :client_secret, DEFAULT_CONFIGURATION[:client_secret]
     setting :token_store, DEFAULT_CONFIGURATION[:token_store]
     setting :access_token, DEFAULT_CONFIGURATION[:access_token] do |value|
-      next if value == nil # nil is a valid unassigned value
+      next if value.nil? # nil is a valid unassigned value
       invalid_access_token_format!(value) unless value.is_a?(String)
       config.token_store = { default: value }
       value
     end
     setting :access_tokens, DEFAULT_CONFIGURATION[:access_tokens] do |value|
-      next if value == nil # nil is a valid unassigned value
+      next if value.nil? # nil is a valid unassigned value
       invalid_access_tokens_format!(value) unless value.is_a?(Hash) || value.is_a?(Array)
       config.token_store = value.is_a?(Hash) ? value : { default: value }
       value
@@ -60,20 +61,20 @@ module Fortnox
 
     def self.invalid_access_token_format!(value)
       raise ArgumentError,
-            "expected a String, but "\
-            "#{ value.inspect } is a(n) #{ value.class }"
+            'expected a String, but '\
+            "#{value.inspect} is a(n) #{value.class}"
     end
     private_class_method :invalid_access_token_format!
 
     def self.invalid_access_tokens_format!(value)
       raise ArgumentError,
-            "expected a Hash or an Array, but "\
-            "#{ value.inspect } is a(n) #{ value.class }"
+            'expected a Hash or an Array, but '\
+            "#{value.inspect} is a(n) #{value.class}"
     end
     private_class_method :invalid_access_tokens_format!
   end
 end
 
-require "fortnox/api/models"
-require "fortnox/api/repositories"
-require "fortnox/api/mappers"
+require 'fortnox/api/models'
+require 'fortnox/api/repositories'
+require 'fortnox/api/mappers'

data/lib/fortnox/api/circular_queue.rb

@@ -1,12 +1,16 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
+# rubocop:disable Style/ClassVars
+
 module Fortnox
   module API
     class CircularQueue
       extend Forwardable
 
-      def initialize *items
-        @queue = [ *items ]
+      def initialize(*items)
+        @queue = [*items]
         @@next_index = random_start_index
       end
 
@@ -14,20 +18,22 @@ module Fortnox
       def_delegators :@queue, :new, :[], :size
 
       def next
-        value = @queue[ @@next_index ]
+        value = @queue[@@next_index]
         if @@next_index == size - 1
           @@next_index = 0
         else
           @@next_index += 1
         end
-        return value
+        value
       end
 
       private
 
-        def random_start_index
-          Random.rand(@queue.size)
-        end
+      def random_start_index
+        Random.rand(@queue.size)
+      end
     end
   end
 end
+
+# rubocop:enable Style/ClassVars

data/lib/fortnox/api/mappers.rb

@@ -1,39 +1,41 @@
+# frozen_string_literal: true
+
 require 'fortnox/api/types'
 
 module Fortnox
   module API
     module Mapper
-      Identity = ->(value){ value }
+      Identity = ->(value) { value }
 
-      Date = ->(value){ value.to_s }
+      Date = ->(value) { value.to_s }
 
-      Array = ->(array) do
-        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 )
+      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(: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( :house_work_type, Fortnox::API::Mapper::Identity )
-      Registry.register( :vat_type, Fortnox::API::Mapper::Identity )
-      Registry.register( :labels, Fortnox::API::Mapper::Array )
+      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
@@ -48,3 +50,5 @@ 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_payments'

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

@@ -1,22 +1,23 @@
-require "fortnox/api/mappers/base"
+# frozen_string_literal: true
+
+require 'fortnox/api/mappers/base'
 
 module Fortnox
   module API
     module Mapper
       class Article < Fortnox::API::Mapper::Base
-
         KEY_MAP = {
           ean: 'EAN',
           eu_account: 'EUAccount',
           eu_vat_account: 'EUVATAccount',
+          housework_type: 'HouseWorkType',
           vat: 'VAT'
         }.freeze
-        JSON_ENTITY_WRAPPER = 'Article'.freeze
-        JSON_COLLECTION_WRAPPER = 'Articles'.freeze
-
+        JSON_ENTITY_WRAPPER = 'Article'
+        JSON_COLLECTION_WRAPPER = 'Articles'
       end
 
-      Registry.register( Article.canonical_name_sym, Article )
+      Registry.register(Article.canonical_name_sym, Article)
     end
   end
 end

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

@@ -1,5 +1,7 @@
-require "fortnox/api/mappers/base/from_json"
-require "fortnox/api/mappers/base/to_json"
+# frozen_string_literal: true
+
+require 'fortnox/api/mappers/base/from_json'
+require 'fortnox/api/mappers/base/to_json'
 
 module Fortnox
   module API
@@ -8,16 +10,16 @@ module Fortnox
         include FromJSON
         include ToJSON
 
-        Hash = ->(hash) do
+        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 )
+            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 )
+        Registry.register(:hash, Fortnox::API::Mapper::Base::Hash)
 
-        def self.canonical_name_sym( *values )
+        def self.canonical_name_sym(*values)
           klass = if values.empty?
                     self
                   elsif values.first.is_a? Class
@@ -27,23 +29,23 @@ module Fortnox
                   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 = Integer if %w[Bignum Fixnum].include?(klass.to_s) # Stringify to avoid warnings on 2.4
 
           klass.name.split('::').last.downcase.to_sym
         end
 
-        def diff( entity_hash, parent_hash )
-          hash_diff( entity_hash[self.class::JSON_ENTITY_WRAPPER],
-                     parent_hash[self.class::JSON_ENTITY_WRAPPER] )
+        def diff(entity_hash, parent_hash)
+          hash_diff(entity_hash[self.class::JSON_ENTITY_WRAPPER],
+                    parent_hash[self.class::JSON_ENTITY_WRAPPER])
         end
 
         private
 
-          def hash_diff( hash1, hash2 )
-            hash1.dup.
-              delete_if{ |k, v| hash2[k] == v }.
-              merge!(hash2.dup.delete_if{ |k, _| hash1.has_key?(k) })
-          end
+        def hash_diff(hash1, hash2)
+          hash1.dup
+               .delete_if { |k, v| hash2[k] == v }
+               .merge!(hash2.dup.delete_if { |k, _| hash1.key?(k) })
+        end
       end
     end
   end