fortnox-api 0.1.0 → 0.2.0

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

@@ -0,0 +1,13 @@
+require "fortnox/api/mappers/base"
+
+module Fortnox
+  module API
+    module Mapper
+      class DefaultDeliveryTypes < Fortnox::API::Mapper::Base
+        KEY_MAP = {}.freeze
+      end
+
+      Registry.register( DefaultDeliveryTypes.canonical_name_sym, DefaultDeliveryTypes )
+    end
+  end
+end

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

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

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

@@ -0,0 +1,22 @@
+require "fortnox/api/mappers/base"
+
+module Fortnox
+  module API
+    module Mapper
+      class EDIInformation < Fortnox::API::Mapper::Base
+
+        KEY_MAP = {
+          edi_global_location_number: 'EDIGlobalLocationNumber',
+          edi_global_location_number_delivery: 'EDIGlobalLocationNumberDelivery',
+          edi_invoice_extra1: 'EDIInvoiceExtra1',
+          edi_invoice_extra2: 'EDIInvoiceExtra2',
+          edi_our_electronic_reference: 'EDIOurElectronicReference',
+          edi_your_electronic_reference: 'EDIYourElectronicReference'
+        }.freeze
+        JSON_ENTITY_WRAPPER = JSON_COLLECTION_WRAPPER = 'EDIInformation'.freeze
+      end
+
+      Registry.register( EDIInformation.canonical_name_sym, EDIInformation )
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require "fortnox/api/mappers/base"
+
+module Fortnox
+  module API
+    module Mapper
+      class EmailInformation < Fortnox::API::Mapper::Base
+
+        KEY_MAP = {
+          email_address_bcc: 'EmailAddressBCC',
+          email_address_cc: 'EmailAddressCC'
+        }.freeze
+        JSON_ENTITY_WRAPPER = JSON_COLLECTION_WRAPPER = 'EmailInformation'.freeze
+      end
+
+      Registry.register( EmailInformation.canonical_name_sym, EmailInformation )
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require "fortnox/api/mappers/base"
+require "fortnox/api/mappers/edi_information"
+require "fortnox/api/mappers/email_information"
+require "fortnox/api/mappers/invoice_row"
+
+module Fortnox
+  module API
+    module Mapper
+      class Invoice < Fortnox::API::Mapper::Base
+
+        KEY_MAP = {
+          administration_fee_vat: 'AdministrationFeeVAT',
+          edi_information: 'EDIInformation',
+          eu_quarterly_report: 'EUQuarterlyReport',
+          freight_vat: 'FreightVAT',
+          ocr: 'OCR',
+          total_vat: 'TotalVAT',
+          vat_included: 'VATIncluded'
+        }.freeze
+        JSON_ENTITY_WRAPPER = 'Invoice'.freeze
+        JSON_COLLECTION_WRAPPER = 'Invoices'.freeze
+      end
+
+      Registry.register( Invoice.canonical_name_sym, Invoice )
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require "fortnox/api/mappers/base"
+
+module Fortnox
+  module API
+    module Mapper
+      class InvoiceRow < Fortnox::API::Mapper::Base
+        KEY_MAP = {
+          vat: 'VAT',
+          price_excluding_vat: 'PriceExcludingVAT',
+          total_excluding_vat: 'TotalExcludingVAT'
+        }.freeze
+        JSON_ENTITY_WRAPPER = 'InvoiceRow'.freeze
+        JSON_COLLECTION_WRAPPER = 'InvoiceRows'.freeze
+      end
+
+      Registry.register( InvoiceRow.canonical_name_sym, InvoiceRow )
+      Registry.register( :invoicerows, InvoiceRow )
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require "fortnox/api/mappers/base"
+require "fortnox/api/mappers/edi_information"
+require "fortnox/api/mappers/email_information"
+require "fortnox/api/mappers/order_row"
+
+module Fortnox
+  module API
+    module Mapper
+      class Order < Fortnox::API::Mapper::Base
+        KEY_MAP = {
+          administration_fee_vat: 'AdministrationFeeVAT',
+          freight_vat: 'FreightVAT',
+          total_vat: 'TotalVAT',
+          vat_included: 'VATIncluded'
+        }.freeze
+        JSON_ENTITY_WRAPPER = 'Order'.freeze
+        JSON_COLLECTION_WRAPPER = 'Orders'.freeze
+      end
+
+      Registry.register( Order.canonical_name_sym, Order )
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+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
+      end
+
+      Registry.register( OrderRow.canonical_name_sym, OrderRow )
+      Registry.register( :orderrows, OrderRow )
+    end
+  end
+end

data/lib/fortnox/api/models.rb

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

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

@@ -1,33 +1,37 @@
-require "virtus"
+require "fortnox/api/types"
 require "ice_nine"
 
 module Fortnox
   module API
     module Model
-      class Base
+      class Base < Fortnox::API::Types::Model
 
-        # extend Forwardable
-        include Virtus.model
+        # TODO(jonas): Restructure this class a bit, it is not very readable.
 
-        attr_accessor :unsaved
+        attr_accessor :unsaved, :parent
 
         def self.attribute( name, *args )
-          define_method( "#{name}?" ) do
+          define_method( "#{ name }?" ) do
             !send( name ).nil?
           end
 
           super
         end
 
-        def initialize( hash = {} )
-          unsaved = hash.delete( :unsaved ){ true }
-          @saved = !unsaved
-          @new = hash.delete( :new ){ true }
+        def self.new( hash )
+          begin
+            obj = preserve_meta_properties( hash ) do
+              super( hash )
+            end
+          rescue Dry::Struct::Error => e
+            raise Fortnox::API::AttributeError.new e
+          end
 
-          # .each{|a| p a.name}
+          IceNine.deep_freeze( obj )
+        end
 
-          super hash
-          IceNine.deep_freeze( self )
+        def unique_id
+          send( self.class::UNIQUE_ID )
         end
 
         def update( hash )
@@ -38,6 +42,7 @@ module Fortnox
 
           new_hash = new_attributes.delete_if{ |_, value| value.nil? }
           new_hash[:new] = @new
+          new_hash[:parent] = self
           self.class.new( new_hash )
         end
 
@@ -55,6 +60,44 @@ module Fortnox
           @saved
         end
 
+        def parent?
+          not @parent.nil?
+        end
+
+        def parent
+          @parent || self.class.new( self.class::STUB.dup )
+        end
+
+        def to_hash( recursive = false )
+          return super() if recursive
+
+          self.class.schema.keys.each_with_object({}) do |key, result|
+            result[key] = self[key]
+          end
+        end
+
+      private_class_method
+
+        # dry-types filter anything that isn't specified as an attribute on the
+        # class that is being instansiated. 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 }
+
+          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 )
+
+          return obj
+        end
+
       private
 
         def private_attributes

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

@@ -1,12 +1,14 @@
+require "fortnox/api/types"
 require "fortnox/api/models/base"
-require "fortnox/api/models/attributes/country_code"
-require "fortnox/api/models/attributes/currency"
 
 module Fortnox
   module API
     module Model
       class Customer < Fortnox::API::Model::Base
 
+        UNIQUE_ID = :customer_number
+        STUB = { name: '' }.freeze
+
         # searchable_attributes(
         #     :city, :customer_number, :email, :name, :organisation_number,
         #     :phone1, :zip_code
@@ -25,173 +27,182 @@ module Fortnox
         # )
 
         #Url	Direct URL to the record
-        attribute :url, String, writer: :private
+        attribute :url, Fortnox::API::Types::Nullable::String.with( read_only: true )
 
-        #Address1	First address of the customer
-        attribute :address1, String
+        #Address1	First address of the customer. 1024 characters
+        attribute :address1, Fortnox::API::Types::Sized::String[ 1024 ]
 
-        #Address2	Second address of the customer
-        attribute :address2, String
+        #Address2	Second address of the customer. 1024 characters
+        attribute :address2, Fortnox::API::Types::Sized::String[ 1024 ]
 
-        #City	City of the customer
-        attribute :city, String
+        #City	City of the customer. 1024 characters
+        attribute :city, Fortnox::API::Types::Sized::String[ 1024 ]
 
-        #Country	Country of the customer
-        attribute :country, String
+        #Country	Country of the customer. Read-only.
+        attribute :country, Fortnox::API::Types::Nullable::String.with( read_only: true )
 
-        #Comments	Comments
-        attribute :comments, String
+        #Comments	Comments. 1024 characters.
+        attribute :comments, Fortnox::API::Types::Sized::String[ 1024 ]
 
         #Currency	Currency of the customer, 3 letters
-        include Attribute::Currency
+        attribute :currency, Fortnox::API::Types::Currency
 
         #CostCenter	Cost center of the customer, Cost center in Fortnox
-        attribute :cost_center, String
+        attribute :cost_center, Fortnox::API::Types::Nullable::String
 
         #CountryCode	Country code of the customer, 2 letters
-        include Attribute::CountryCode
+        attribute :country_code, Fortnox::API::Types::CountryCode
+
+        #CustomerNumber	Customer number. 1024 characters
+        attribute :customer_number, Fortnox::API::Types::Sized::String[ 1024 ]
+
+        #DefaultDeliveryTypes The properties for this object is listed in the table for “Default Delivery Types”.
+        attribute :default_delivery_types, Types::DefaultDeliveryTypes
 
-        #CustomerNumber	Customer number
-        attribute :customer_number, String
+        #The properties for this object is listed in the table for “Default Templates”.
+        attribute :default_templates, Types::DefaultTemplates
 
-        #DeliveryAddress1	First delivery address of the customer
-        attribute :delivery_address1, String
+        #DeliveryAddress1	First delivery address of the customer. 1024 characters
+        attribute :delivery_address1, Fortnox::API::Types::Sized::String[ 1024 ]
 
-        #DeliveryAddress2	Second delivery address of the customer
-        attribute :delivery_address2, String
+        #DeliveryAddress2	Second delivery address of the customer. 1024 characters
+        attribute :delivery_address2, Fortnox::API::Types::Sized::String[ 1024 ]
 
-        #DeliveryCity	Delivery city of the customer
-        attribute :delivery_city, String
+        #DeliveryCity	Delivery city of the customer. 1024 characters
+        attribute :delivery_city, Fortnox::API::Types::Sized::String[ 1024 ]
 
-        #DeliveryCountry	Delivery country of the customer
-        attribute :delivery_country, String
+        #DeliveryCountry	Delivery country of the customer. Read-only.
+        attribute :delivery_country, Fortnox::API::Types::Nullable::String.with( read_only: true )
 
-        #DeliveryCountryCode	Delivery country code of the customer
-        attribute :delivery_country_code, String
+        #DeliveryCountryCode	Delivery country code of the customer, 2 letters
+        attribute :delivery_country_code, Fortnox::API::Types::CountryCode
 
-        #DeliveryFax	Delivery fax number of the customer
-        attribute :delivery_fax, String
+        #DeliveryFax	Delivery fax number of the customer. 1024 characters
+        attribute :delivery_fax, Fortnox::API::Types::Sized::String[ 1024 ]
 
-        #DeliveryName	Delivery name of the customer
-        attribute :delivery_name, String
+        #DeliveryName	Delivery name of the customer. 1024 characters
+        attribute :delivery_name, Fortnox::API::Types::Sized::String[ 1024 ]
 
-        #DeliveryPhone1	First delivery phone number of the customer
-        attribute :delivery_phone1, String
+        #DeliveryPhone1	First delivery phone number of the customer. 1024 characters
+        attribute :delivery_phone1, Fortnox::API::Types::Sized::String[ 1024 ]
 
-        #DeliveryPhone2	Second delivery phone number of the customer
-        attribute :delivery_phone2, String
+        #DeliveryPhone2	Second delivery phone number of the customer. 1024 characters
+        attribute :delivery_phone2, Fortnox::API::Types::Sized::String[ 1024 ]
 
-        #DeliveryZipCode	Delivery zip code of the customer
-        attribute :delivery_zip_code, String
+        #DeliveryZipCode	Delivery zip code of the customer. 1024 characters.
+        attribute :delivery_zip_code, Fortnox::API::Types::Sized::String[ 1024 ]
 
-        #Email	Email address of the customer
-        attribute :email, String
+        #Email	Email address of the customer. 1024 characters
+        attribute :email, Types::Email
 
-        #EmailInvoice	Invoice email address of the customer
-        attribute :email_invoice, String
+        #EmailInvoice	Invoice email address of the customer. 1024 characters
+        attribute :email_invoice, Types::Email
 
-        #EmailInvoiceBCC	Invoice BCC email address of the customer
-        attribute :email_invoice_bcc, String
+        #EmailInvoiceBCC	Invoice BCC email address of the customer. 1024 characters
+        attribute :email_invoice_bcc, Types::Email
 
-        #EmailInvoiceCC	Invoice CC email address of the customer
-        attribute :email_invoice_cc, String
+        #EmailInvoiceCC	Invoice CC email address of the customer. 1024 characters
+        attribute :email_invoice_cc, Types::Email
 
-        #EmailOffer	Offer email address of the customer
-        attribute :email_offer, String
+        #EmailOffer	Offer email address of the customer. 1024 characters
+        attribute :email_offer, Types::Email
 
-        #EmailOfferBCC	Offer BCC email address of the customer
-        attribute :email_offer_bcc, String
+        #EmailOfferBCC	Offer BCC email address of the customer. 1024 characters
+        attribute :email_offer_bcc, Types::Email
 
-        #EmailOfferCC	Offer CC email address of the customer
-        attribute :email_offer_cc, String
+        #EmailOfferCC	Offer CC email address of the customer. 1024 characters
+        attribute :email_offer_cc, Types::Email
 
-        #EmailOrder	Order email address of the customer
-        attribute :email_order, String
+        #EmailOrder	Order email address of the customer. 1024 characters
+        attribute :email_order, Types::Email
 
-        #EmailOrderBCC	Order BCC email address of the customer
-        attribute :email_order_bcc, String
+        #EmailOrderBCC	Order BCC email address of the customer. 1024 characters
+        attribute :email_order_bcc, Types::Email
 
-        #EmailOrderCC	Order CC email address of the customer
-        attribute :email_order_cc, String
+        #EmailOrderCC	Order CC email address of the customer. 1024 characters
+        attribute :email_order_cc, Types::Email
 
-        #Fax	Fax number of the customer
-        attribute :fax, String
+        #Fax	Fax number of the customer. 1024 characters
+        attribute :fax, Fortnox::API::Types::Sized::String[ 1024 ]
 
-        #InvoiceAdministrationFee  Invoice administration fee of the customer
-        attribute :invoice_administration_fee, Float
+        #InvoiceAdministrationFee  Invoice administration fee of the customer, 12 digits (incl. decimals).
+        attribute :invoice_administration_fee,
+                  Fortnox::API::Types::Sized::Float[ 0.0, 99_999_999_999.9 ]
 
-        #InvoiceDiscount	Invoice discount of the customer
-        attribute :invoice_discount, Float
+        #InvoiceDiscount	Invoice discount of the customer, 12 digits (incl. decimals)
+        attribute :invoice_discount, Fortnox::API::Types::Sized::Float[ 0.0, 99_999_999_999.9 ]
 
-        #InvoiceFreight	Invoice freight fee of the customer
-        attribute :invoice_freight, Float
+        #InvoiceFreight	Invoice freight fee of the customer, 12 digits (incl. decimals)
+        attribute :invoice_freight, Fortnox::API::Types::Sized::Float[ 0.0, 99_999_999_999.9 ]
 
-        #InvoiceRemark	Invoice remark of the customer
-        attribute :invoice_remark, String
+        #InvoiceRemark	Invoice remark of the customer. 1024 characters
+        attribute :invoice_remark, Fortnox::API::Types::Sized::String[ 1024 ]
 
-        #Name	Name of the customer
-        attribute :name, String
+        #Name	Name of the customer, 1024 characters
+        attribute :name, Fortnox::API::Types::Sized::String[ 1024 ].with( required: true )
 
-        #OrganisationNumber	Organisation number of the customer
-        attribute :organisation_number, String
+        #OrganisationNumber	Organisation number of the customer. 30 characters
+        attribute :organisation_number, Fortnox::API::Types::Sized::String[ 30 ]
 
-        #OurReference	Our reference of the customer
-        attribute :our_reference, String
+        #OurReference	Our reference of the customer. 50 characters
+        attribute :our_reference, Fortnox::API::Types::Sized::String[ 50 ]
 
-        #Phone1	First phone number of the customer
-        attribute :phone1, String
+        #Phone1	First phone number of the customer. 1024 characters
+        attribute :phone1, Fortnox::API::Types::Sized::String[ 1024 ]
 
-        #Phone2	Second phone number of the customer
-        attribute :phone2, String
+        #Phone2	Second phone number of the customer. 1024 characters
+        attribute :phone2, Fortnox::API::Types::Sized::String[ 1024 ]
 
         #PriceList	Price list of the customer, Price list in Fortnox
-        attribute :price_list, String
+        attribute :price_list, Fortnox::API::Types::Nullable::String
 
         #Project	Project of the customer, Project in Fortnox
-        attribute :project, Integer
+        attribute :project, Fortnox::API::Types::Nullable::String
 
         #SalesAccount	Sales account of the customer, 4 digits
-        attribute :sales_account, Integer
+        attribute :sales_account, Fortnox::API::Types::AccountNumber
 
         #ShowPriceVATIncluded	Show prices with VAT included or not
-        attribute :show_price_vat_included, Boolean
+        attribute :show_price_vat_included, Fortnox::API::Types::Nullable::Boolean
 
         #TermsOfDeliveryCode	Terms of delivery code of the customer
-        attribute :terms_of_delivery, String
+        attribute :terms_of_delivery, Fortnox::API::Types::Nullable::String
 
         #TermsOfPaymentCode	Terms of payment code of the customer
-        attribute :terms_of_payment, String
+        attribute :terms_of_payment, Fortnox::API::Types::Nullable::String
 
         #Type	Customer type, PRIVATE / COMPANY
-        attribute :type, String
+        attribute :type, Fortnox::API::Types::CustomerType
 
         #VATNumber	VAT number of the customer
-        attribute :vat_number, String
+        attribute :vat_number, Fortnox::API::Types::Nullable::String
 
         #VATType	VAT type of the customer, SEVAT / SEREVERSEDVAT / EUREVERSEDVAT / EUVAT / EXPORT
-        attribute :vat_type, String
+        attribute :vat_type, Fortnox::API::Types::VATType
 
-        #VisitAddress	Visit address of the customer
-        attribute :visiting_address, String
+        #VisitAddress	Visit address of the customer. 128 characters
+        attribute :visiting_address, Fortnox::API::Types::Sized::String[ 128 ]
 
-        #VisitCity	Visit city of the customer
-        attribute :visiting_city, String
+        #VisitCity	Visit city of the customer. 128 characters
+        attribute :visiting_city, Fortnox::API::Types::Sized::String[ 128 ]
 
-        #VisitCountry	Visit country of the customer
-        attribute :visiting_country, String
+        #VisitCountry	Visit country of the customer, read-only
+        attribute :visiting_country, Fortnox::API::Types::Nullable::String.with( read_only: true )
 
-        #VisitZipCode	Visit zip code of the customer
-        attribute :visiting_zip_code, String
+        #VisitingCountryCode Code of the visiting country for the customer, 2 letters
+        attribute :visiting_country_code, Fortnox::API::Types::CountryCode
 
-        #WayOfDeliveryCode	Way of delivery code of the customer
-        attribute :way_of_delivery, String
+        #VisitZipCode	Visit zip code of the customer. 10 characters
+        attribute :visiting_zip_code, Fortnox::API::Types::Sized::String[ 10 ]
 
-        #YourReference	Your reference of the customer
-        attribute :your_reference, String
+        #WayOfDeliveryCode	Way of delivery code of the customer
+        attribute :way_of_delivery, Fortnox::API::Types::Nullable::String
 
-        #ZipCode	Zip code of the customer
-        attribute :zip_code, String
+        #YourReference	Your reference of the customer. 50 characters
+        attribute :your_reference, Fortnox::API::Types::Sized::String[ 50 ]
 
+        #ZipCode	Zip code of the customer. 10 characters
+        attribute :zip_code, Fortnox::API::Types::Sized::String[ 10 ]
       end
     end
   end