fortnox-api 0.5.2 → 0.6.0

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

@@ -1,16 +1,23 @@
-require "fortnox/api/mappers/base"
+# frozen_string_literal: true
+
+require 'fortnox/api/mappers/base'
 
 module Fortnox
   module API
     module Mapper
       class OrderRow < Fortnox::API::Mapper::Base
-        KEY_MAP = { vat: 'VAT' }.freeze
-        JSON_ENTITY_WRAPPER = 'OrderRow'.freeze
-        JSON_COLLECTION_WRAPPER = 'OrderRows'.freeze
+        KEY_MAP = {
+          housework: 'HouseWork',
+          housework_hours_to_report: 'HouseWorkHoursToReport',
+          housework_type: 'HouseWorkType',
+          vat: 'VAT'
+        }.freeze
+        JSON_ENTITY_WRAPPER = 'OrderRow'
+        JSON_COLLECTION_WRAPPER = 'OrderRows'
       end
 
-      Registry.register( OrderRow.canonical_name_sym, OrderRow )
-      Registry.register( :orderrows, OrderRow )
+      Registry.register(OrderRow.canonical_name_sym, OrderRow)
+      Registry.register(:orderrows, OrderRow)
     end
   end
 end

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

@@ -1,15 +1,17 @@
-require "fortnox/api/mappers/base"
+# frozen_string_literal: true
+
+require 'fortnox/api/mappers/base'
 
 module Fortnox
   module API
     module Mapper
       class Project < Fortnox::API::Mapper::Base
         KEY_MAP = {}.freeze
-        JSON_ENTITY_WRAPPER = 'Project'.freeze
-        JSON_COLLECTION_WRAPPER = 'Projects'.freeze
+        JSON_ENTITY_WRAPPER = 'Project'
+        JSON_COLLECTION_WRAPPER = 'Projects'
       end
 
-      Registry.register( Project.canonical_name_sym, Project )
+      Registry.register(Project.canonical_name_sym, Project)
     end
   end
 end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'fortnox/api/mappers/base'
+
+module Fortnox
+  module API
+    module Mapper
+      class TermsOfPayments < Fortnox::API::Mapper::Base
+        KEY_MAP = {}.freeze
+        JSON_ENTITY_WRAPPER = 'TermsOfPayment'
+        JSON_COLLECTION_WRAPPER = 'TermsOfPayments'
+      end
+
+      Registry.register(TermsOfPayments.canonical_name_sym, TermsOfPayments)
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'fortnox/api/mappers/base'
+
+module Fortnox
+  module API
+    module Mapper
+      class Unit < Fortnox::API::Mapper::Base
+        KEY_MAP = {}.freeze
+        JSON_ENTITY_WRAPPER = 'Unit'
+        JSON_COLLECTION_WRAPPER = 'Units'
+      end
+
+      Registry.register(Unit.canonical_name_sym, Unit)
+    end
+  end
+end

data/lib/fortnox/api/models.rb

@@ -1,5 +1,9 @@
-require "fortnox/api/models/article"
-require "fortnox/api/models/customer"
-require "fortnox/api/models/invoice"
-require "fortnox/api/models/order"
-require "fortnox/api/models/project"
+# frozen_string_literal: true
+
+require 'fortnox/api/models/article'
+require 'fortnox/api/models/customer'
+require 'fortnox/api/models/invoice'
+require 'fortnox/api/models/order'
+require 'fortnox/api/models/project'
+require 'fortnox/api/models/unit'
+require 'fortnox/api/models/terms_of_payments'

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

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

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

@@ -1,55 +1,72 @@
-require "fortnox/api/types"
-require "ice_nine"
+# frozen_string_literal: true
+
+require 'fortnox/api/types'
+require 'ice_nine'
 
 module Fortnox
   module API
     module Model
       class Base < Fortnox::API::Types::Model
-
         # TODO(jonas): Restructure this class a bit, it is not very readable.
 
-        attr_accessor :unsaved, :parent
+        attr_accessor :unsaved
+        attr_writer :parent
 
-        def self.attribute( name, *args )
-          define_method( "#{ name }?" ) do
-            !send( name ).nil?
+        def self.attribute(name, *args)
+          define_method("#{name}?") do
+            !send(name).nil?
           end
 
           super
         end
 
-        def self.new( hash )
+        def self.new(hash = {})
           begin
-            obj = preserve_meta_properties( hash ) do
-              super( hash )
+            obj = preserve_meta_properties(hash) do
+              super(hash)
             end
           rescue Dry::Struct::Error => e
-            raise Fortnox::API::AttributeError.new e
+            raise Fortnox::API::AttributeError, e
           end
 
-          IceNine.deep_freeze( obj )
+          IceNine.deep_freeze(obj)
+        end
+
+        def self.stub
+          new(self::STUB.dup)
+        end
+
+        # This filtering logic could be improved since it is currently O(N*M).
+        def attributes(*options)
+          return self.class.schema if options.nil?
+
+          options = Array(options)
+
+          self.class.schema.find_all do |_name, attribute|
+            options.all? { |option| attribute.is?(option) }
+          end
         end
 
         def unique_id
-          send( self.class::UNIQUE_ID )
+          send(self.class::UNIQUE_ID)
         end
 
-        def update( hash )
-          old_attributes = self.to_hash
-          new_attributes = old_attributes.merge( hash )
+        def update(hash)
+          old_attributes = to_hash
+          new_attributes = old_attributes.merge(hash)
 
           return self if new_attributes == old_attributes
 
-          new_hash = new_attributes.delete_if{ |_, value| value.nil? }
+          new_hash = new_attributes.delete_if { |_, value| value.nil? }
           new_hash[:new] = @new
           new_hash[:parent] = self
-          self.class.new( new_hash )
+          self.class.new(new_hash)
         end
 
         # Generic comparison, by value, use .eql? or .equal? for object identity.
-        def ==( other )
+        def ==(other)
           return false unless other.is_a? self.class
-          self.to_hash == other.to_hash
+          to_hash == other.to_hash
         end
 
         def new?
@@ -61,14 +78,14 @@ module Fortnox
         end
 
         def parent?
-          not @parent.nil?
+          !@parent.nil?
         end
 
         def parent
-          @parent || self.class.new( self.class::STUB.dup )
+          @parent || self.class.new(self.class::STUB.dup)
         end
 
-        def to_hash( recursive = false )
+        def to_hash(recursive = false)
           return super() if recursive
 
           self.class.schema.keys.each_with_object({}) do |key, result|
@@ -76,34 +93,33 @@ module Fortnox
           end
         end
 
-      private_class_method
+        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
         # sets them on the object after dry-types is done with it.
-        def self.preserve_meta_properties( hash )
-          is_unsaved = hash.delete( :unsaved ){ true }
-          is_new = hash.delete( :new ){ true }
-          parent = hash.delete( :parent ){ nil }
+        def self.preserve_meta_properties(hash)
+          is_unsaved = hash.delete(:unsaved) { true }
+          is_new = hash.delete(:new) { true }
+          parent = hash.delete(:parent) { nil }
 
           obj = yield
 
           # TODO: remove new, unsaved, saved
-          obj.instance_variable_set( :@unsaved, is_unsaved )
-          obj.instance_variable_set( :@saved, !is_unsaved )
-          obj.instance_variable_set( :@new, is_new )
-          obj.instance_variable_set( :@parent, parent )
+          obj.instance_variable_set(:@unsaved, is_unsaved)
+          obj.instance_variable_set(:@saved, !is_unsaved)
+          obj.instance_variable_set(:@new, is_new)
+          obj.instance_variable_set(:@parent, parent)
 
-          return obj
+          obj
         end
 
-      private
+        private
 
         def private_attributes
-          @@private_attributes ||= attribute_set.select{ |a| !a.public_writer? }
+          @private_attributes ||= attribute_set.reject(&:public_writer?)
         end
-
       end
     end
   end