fortnox-api 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 124c4cde46325d41cffa7a3bf092375697cb6b1d
-  data.tar.gz: cb91dde384a1c59e4304f29dc9dbdd9ea0c64d4f
+  metadata.gz: 0e05948f9903dea9dc9b90deab6e51a9e610e0bb
+  data.tar.gz: b7205e9aef5625b36623652e1626c042d2ffedda
 SHA512:
-  metadata.gz: 8f7bc215cb29128bb0c8385c3769f9aa3576006d69ac84d275b8df4a8799583148e73b77a788538ed4d0fee45e700b7144b803b0a3dca4a2cfe430da1206b0de
-  data.tar.gz: d962b0e1dbb2e05900846866f69a585100b59ac993002dfb1bcef7d89dc8887ecb0e6eaa993be1355971d6d7e09cc4ae67b6881b2609b0a3abe260839aae5436
+  metadata.gz: 9d6b44d780e5eec9961b9c398f0ce7b289e8381eebb5bf5965e59c3d46cae5667b3a9b96dc9411b87bce6063d3354491c61fa0da7164acf8daa417cc1281cfec
+  data.tar.gz: a14a4ab461cdda2e0d50dc4851b69494c58744508aab9d065d237349f62dfaa63b0e3e16c413a6e0738cafcae1a4f59d2e516c5333fb3e4fec2766abff0b245e

data/README.md

@@ -11,14 +11,14 @@
 [![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)
 
-The rough status of this project is as follows (as of November 2016):
+The rough status of this project is as follows (as of October 2017):
 * In active development (just check out the commit log)
-* Two developers. At least twice as good as one.
+* Three developers. At least thrice as good as one.
 * 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` and `Order`. Adding more models in general is quick and easy, see the developer guide further down.
-* Massive refactorings no longer occurs weakly :) We are running this gem in production for live test.
+* 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.
 
@@ -65,12 +65,20 @@ customer.name == "New Name" # => false
 ```
 This is how all the models work, they are all immutable.
 
+### Exceptions
+
+Models can throw `Fortnox::API::AttributeError` if an attribute is invalid in some way (for instance if you try to assign a too long string to a limited string attribute) and `Fortnox::API::MissingAttributeError` if a required attribute is missing.
+
 ## Type
 The types automatically enforce the constraints on values, lengths and, in some cases, content of the model attributes. Types forces your models to be correct before sending data to the API, which saves you a lot of API calls and rescuing the exception we throw when we get a 4xx/5xx response from the server (you can still get errors from the server; our implementation is not perfect. Also, Fortnox sometimes requires a specific combination of attributes).
 
 ## Repositories
 Used to load, update, create and delete model instances. These are what is actually wrapping the HTTP REST API requests against Fortnox's server.
 
+### Exceptions
+
+Repositories can throw `Fortnox::API::RemoteServerError` if something went wrong at Fortnox.
+
 ## Mappers
 These are responsible for the mapping between our plain old Ruby object models and Fortnox JSON requests. The repositories use the mappers to map models to JSON requests and JSON to model instances when working with the Fortnox API, you will not need to use them directly.
 

data/fortnox-api.gemspec

@@ -3,10 +3,10 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fortnox/api/version'
 
-Gem::Specification.new do |spec|
+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"]
+  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."
@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   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.41"
-  spec.add_development_dependency "rubocop-rspec", "~> 1.7"
+  spec.add_development_dependency "rubocop", "~> 0.46.0"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.8.0"
 
 end

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

@@ -0,0 +1,22 @@
+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',
+          vat: 'VAT'
+        }.freeze
+        JSON_ENTITY_WRAPPER = 'Article'.freeze
+        JSON_COLLECTION_WRAPPER = 'Articles'.freeze
+
+      end
+
+      Registry.register( Article.canonical_name_sym, Article )
+    end
+  end
+end

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

@@ -47,10 +47,10 @@ module Fortnox
         def entity_to_hash( entity, keys_to_filter )
           entity_json_hash = Registry[ mapper_name_for( entity ) ]
                              .call( entity, keys_to_filter )
-          wrapp_entity_json_hash( entity_json_hash )
+          wrap_entity_json_hash( entity_json_hash )
         end
 
-        def wrapp_entity_json_hash( entity_json_hash )
+        def wrap_entity_json_hash( entity_json_hash )
           { self.class::JSON_ENTITY_WRAPPER => entity_json_hash }
         end
 

data/lib/fortnox/api/models.rb

@@ -1,3 +1,4 @@
+require "fortnox/api/models/article"
 require "fortnox/api/models/customer"
 require "fortnox/api/models/invoice"
 require "fortnox/api/models/order"

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

@@ -0,0 +1,133 @@
+require "fortnox/api/types"
+require "fortnox/api/models/base"
+
+module Fortnox
+  module API
+    module Model
+      class Article < Fortnox::API::Model::Base
+
+        UNIQUE_ID = :article_number
+        STUB = { description: '' }.freeze
+
+        #Url Direct URL to the record
+        attribute :url, Fortnox::API::Types::Nullable::String.with( read_only: true )
+
+        #Active If the article is active
+        attribute :active, Fortnox::API::Types::Nullable::Boolean
+
+        #ArticleNumber Article number. 50 characters
+        attribute :article_number, Fortnox::API::Types::Sized::String[ 50 ]
+
+        #Bulky If the article is bulky.
+        attribute :bulky, Fortnox::API::Types::Nullable::Boolean
+
+        #ConstructionAccount Account number for construction work (special VAT rules in Sweden).
+        # The number must be of an existing account.
+        attribute :construction_account, Types::Sized::Integer[ 0, 9_999 ]
+
+        #Depth The depth of the article in millimeters
+        attribute :depth, Types::Sized::Integer[ 0, 99_999_999 ]
+
+        #Description The description of the article
+        attribute :description, Fortnox::API::Types::Sized::String[ 200 ].with( required: true )
+
+        #DisposableQuantity Disposable quantity of the article.
+        attribute :disposable_quantity, Fortnox::API::Types::Nullable::Float.with( read_only: true )
+
+        #EAN EAN bar code
+        attribute :ean, Fortnox::API::Types::Sized::String[ 30 ]
+
+        #EUAccount Account number for the sales account to EU.
+        # The number must be of an existing account.
+        attribute :eu_account, Types::Sized::Integer[ 0, 9_999 ]
+
+        #EUVATAccount Account number for the sales account to EU with VAT.
+        # The number must be of an existing account.
+        attribute :eu_vat_account, Types::Sized::Integer[ 0, 9_999 ]
+
+        #ExportAccount Account number for the sales account outside EU
+        # The number must be of an existing account.
+        attribute :export_account, Types::Sized::Integer[ 0, 9_999 ]
+
+        #Height The height of the article in millimeters
+        attribute :height, Types::Sized::Integer[ 0, 99_999_999 ]
+
+        #Housework If the article is housework
+        attribute :housework, Fortnox::API::Types::Nullable::Boolean
+
+        #HouseWorkType The type of house work.
+        attribute :house_work_type, Types::HouseWorkType
+
+        #Manufacturer The manufacturer of the article
+        attribute :manufacturer, Fortnox::API::Types::Sized::String[ 50 ]
+
+        #ManufacturerArticleNumber The manufacturer's article number
+        attribute :manufacturer_article_number, Fortnox::API::Types::Sized::String[ 50 ]
+
+        #Note Text note
+        attribute :note, Fortnox::API::Types::Sized::String[ 10_000 ]
+
+        #PurchaseAccount Account number for purchase.
+        # The number must be of an existing account.
+        attribute :purchase_account, Types::Sized::Integer[ 0, 9_999 ]
+
+        #PurchasePrice Purchase price of the article
+        attribute :purchase_price, Fortnox::API::Types::Sized::Float[ 0.0, 99_999_999_999_999.9 ]
+
+        #QuantityInStock Quantity in stock of the article
+        attribute :quantity_in_stock, Fortnox::API::Types::Sized::Float[ 0.0, 99_999_999_999_999.9 ]
+
+        #ReservedQuantity Reserved quantity of the article
+        attribute :reserved_quantity, Fortnox::API::Types::Nullable::Float.with( read_only: true )
+
+        #SalesAccount Account number for the sales account in Sweden.
+        # The number must be of an existing account.
+        attribute :sales_account, Types::Sized::Integer[ 0, 9_999 ]
+
+        #SalesPrice Price of article for its default price list
+        attribute :sales_price, Fortnox::API::Types::Nullable::Float.with( read_only: true )
+
+        #StockGoods If the article is stock goods
+        attribute :stock_goods, Fortnox::API::Types::Nullable::Boolean
+
+        #StockPlace Storage place for the article
+        attribute :stock_place, Fortnox::API::Types::Sized::String[ 100 ]
+
+        #StockValue Value in stock of the article
+        attribute :stock_value, Fortnox::API::Types::Nullable::Float.with( read_only: true )
+
+        #StockWarning When to start warning for low quantity in stock
+        attribute :stock_warning, Fortnox::API::Types::Sized::Float[ 0.0, 99_999_999_999_999.9 ]
+
+        #SupplierName Name of the supplier
+        attribute :supplier_name, Fortnox::API::Types::Nullable::String.with( read_only: true )
+
+        #SupplierNumber Supplier number for the article.
+        # The number must be of an existing supplier.
+        attribute :supplier_number, Fortnox::API::Types::Nullable::String
+
+        #Type The type of the article
+        attribute :type, Types::ArticleType
+
+        #Unit Unit code for the article.
+        # The code must be of an existing unit.
+        attribute :unit, Fortnox::API::Types::Nullable::String
+
+        #VAT VAT percent, this is predefined by the VAT for the sales account
+        attribute :vat, Fortnox::API::Types::Nullable::Float
+
+        #WebshopArticle If the article is a webshop article
+        attribute :webshop_article, Fortnox::API::Types::Nullable::Boolean
+
+        #Weight Weight of the article in grams
+        attribute :weight, Types::Sized::Integer[ 0, 99_999_999 ]
+
+        #Width Width of the article in millimeters.
+        attribute :width, Types::Sized::Integer[ 0, 99_999_999 ]
+
+        #Expired If the article has expired
+        attribute :expired, Fortnox::API::Types::Nullable::Boolean
+      end
+    end
+  end
+end

data/lib/fortnox/api/repositories.rb

@@ -1,3 +1,4 @@
+require "fortnox/api/repositories/article"
 require "fortnox/api/repositories/customer"
 require "fortnox/api/repositories/invoice"
 require "fortnox/api/repositories/order"

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

@@ -0,0 +1,16 @@
+require "fortnox/api/repositories/base"
+require "fortnox/api/models/article"
+require "fortnox/api/mappers/article"
+
+module Fortnox
+  module API
+    module Repository
+      class Article < Fortnox::API::Repository::Base
+
+        MODEL = Fortnox::API::Model::Article
+        MAPPER = Fortnox::API::Mapper::Article
+        URI = '/articles/'.freeze
+      end
+    end
+  end
+end

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

@@ -33,7 +33,7 @@ module Fortnox
           hash = @mapper.entity_to_hash( entity, @keys_filtered_on_save )
           parent_hash = @mapper.entity_to_hash( entity.parent, @keys_filtered_on_save )
 
-          @mapper.wrapp_entity_json_hash( @mapper.diff( hash, parent_hash ) )
+          @mapper.wrap_entity_json_hash( @mapper.diff( hash, parent_hash ) )
         end
 
         def get_update_url_for( entity )

data/lib/fortnox/api/types.rb

@@ -18,6 +18,8 @@ module Fortnox
 
       AccountNumber = Strict::Int.constrained( gt: 0, lteq: 9999 ).optional
 
+      ArticleType = Strict::String.constrained( included_in: ArticleTypes.values ).optional.constructor( EnumConstructors.default )
+
       CountryCode = Strict::String.constrained( included_in: CountryCodes.values ).optional.constructor( EnumConstructors.sized(2) )
       Currency = Strict::String.constrained( included_in: Currencies.values ).optional.constructor( EnumConstructors.sized(3) )
       CustomerType = Strict::String.constrained( included_in: CustomerTypes.values ).optional.constructor( EnumConstructors.default )

data/lib/fortnox/api/types/enums.rb

@@ -4,14 +4,17 @@ module Fortnox
 
       module EnumConstructors
         def self.sized( size )
-          -> (value){ return nil if value == ''; value.to_s.upcase[0...size] unless value.nil? }
+          ->(value){ return nil if value == ''; value.to_s.upcase[0...size] unless value.nil? }
         end
 
         def self.default
-          -> (value){ return nil if value == ''; value.to_s.upcase unless value.nil? }
+          ->(value){ return nil if value == ''; value.to_s.upcase unless value.nil? }
         end
       end
 
+      ArticleTypes = Types::Strict::String.enum(
+        'SERVICE','STOCK'
+      )
       DiscountTypes = Types::Strict::String.enum(
         'AMOUNT','PERCENT'
       )

data/lib/fortnox/api/version.rb

@@ -1,5 +1,5 @@
 module Fortnox
   module API
-    VERSION = "0.3.0".freeze
+    VERSION = "0.4.0".freeze
   end
 end

data/spec/fortnox/api/mappers/article_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'fortnox/api'
+require 'fortnox/api/mappers/customer'
+require 'fortnox/api/mappers/examples/mapper'
+
+describe Fortnox::API::Mapper::Article do
+  key_map = Fortnox::API::Mapper::Article::KEY_MAP
+
+  json_entity_type = 'Article'
+  json_entity_collection = 'Articles'
+
+  it_behaves_like 'mapper', key_map, json_entity_type, json_entity_collection do
+    let(:mapper){ described_class.new }
+  end
+end

data/spec/fortnox/api/mappers/base/to_json_spec.rb

@@ -8,7 +8,7 @@ describe Fortnox::API::Mapper::ToJSON do
   # "NoMethodError: undefined method `call\' for Test::ProductMapper:Class`"
   it 'should be tested when random error is fixed!'
 
-  describe 'wrapp_entity_json_hash' do
+  describe 'wrap_entity_json_hash' do
     it 'should be tested'
   end
 

data/spec/fortnox/api/models/article_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+require 'fortnox/api/models/article'
+require 'fortnox/api/models/examples/model'
+
+describe Fortnox::API::Model::Article, type: :model do
+  it_behaves_like 'a model', '1'
+end

data/spec/fortnox/api/repositories/article_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'fortnox/api'
+require 'fortnox/api/mappers'
+require 'fortnox/api/repositories/customer'
+require 'fortnox/api/repositories/examples/all'
+require 'fortnox/api/repositories/examples/find'
+require 'fortnox/api/repositories/examples/save'
+require 'fortnox/api/repositories/examples/save_with_specially_named_attribute'
+require 'fortnox/api/repositories/examples/search'
+
+describe Fortnox::API::Repository::Article, order: :defined, integration: true do
+  subject(:repository){ described_class.new }
+
+  include_examples '.save',
+                   :description,
+                   additional_attrs: { sales_account: 1250 }
+
+  include_examples '.save with specially named attribute',
+                   { description: 'Test article' },
+                   :ean,
+                   '5901234123457'
+
+  include_examples '.all', 12
+
+  include_examples '.find', '1' do
+    let( :find_by_hash_failure ){ { description: 'Not Found' } }
+    let( :single_param_find_by_hash ){ { find_hash: { articlenumber: 1 }, matches: 3 } }
+
+    let( :multi_param_find_by_hash ) do
+      { find_hash: { articlenumber: 1, description: 'Cykelpump' }, matches: 1 }
+    end
+  end
+
+  include_examples '.search', :description, 'Testartikel', 2
+end

data/spec/fortnox/api/repositories/examples/find.rb

@@ -1,4 +1,3 @@
-# rubocop:disable RSpec/DescribeClass
 shared_examples_for '.find' do |searched_entity_id|
   describe '.find by id' do
     let( :returned_object ) do
@@ -77,4 +76,3 @@ shared_examples_for '.find' do |searched_entity_id|
     end
   end
 end
-# rubocop:enable RSpec/DescribeClass

data/spec/fortnox/api/repositories/examples/save.rb

@@ -1,14 +1,13 @@
-# rubocop:disable RSpec/DescribeClass
 #######################################
 # SPEC IS DEPENDENT ON DEFINED ORDER!
 #######################################
 #
 # Assumes that attribute is a string attribute without restrictions.
-shared_examples_for '.save' do |attribute, required_attributes = {}|
+
+# rubocop:disable RSpec/DescribeClass
+shared_examples_for '.save' do |attribute, additional_attrs: {}|
   describe '.save' do
-    let( :new_hash ) do
-      required_attributes.merge( attribute => value )
-    end
+    let( :new_hash ){ additional_attrs.merge( attribute => value ) }
     let( :new_model ){ described_class::MODEL.new( new_hash ) }
     let( :save_new ){ VCR.use_cassette( "#{ vcr_dir }/save_new" ){ repository.save( new_model ) } }
     let( :entity_wrapper ){ repository.mapper.class::JSON_ENTITY_WRAPPER }

data/spec/fortnox/api/repositories/examples/save_with_nested_model.rb

@@ -1,5 +1,6 @@
 # TODO: This will not work until we solve issue #62.
 # Until then, these tests are pending.
+
 # rubocop:disable RSpec/DescribeClass
 shared_examples_for '.save with nested model' do |required_hash, nested_model_key, nested_model_hash, nested_entity|
   describe '.save with nested model' do

data/spec/fortnox/api/repositories/examples/save_with_specially_named_attribute.rb

@@ -1,8 +1,9 @@
-# rubocop:disable RSpec/DescribeClass
 # Test saving model with attributes that has specially names that needs to be mapped.
 #
 # NOTE: VCR cassette must be discarded when repositories are updated to reflect
 # the changes!
+
+# rubocop:disable RSpec/DescribeClass
 shared_examples_for '.save with specially named attribute' do |required_hash, attribute, value|
   describe '.save' do
     context 'with specially named attribute' do