fortnox-api 0.1.0 → 0.2.0

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

@@ -0,0 +1,17 @@
+require "fortnox/api/types"
+
+module Fortnox
+  module API
+    module Model
+      class Label < Model::Base
+        STUB = {}.freeze
+
+        # Id	integer, read-only. The ID of the label.
+        attribute :id, Types::Required::Integer.with( read_only: true )
+
+        # Description	string, 25 characters, required. Description of the label
+        attribute :description, Types::Sized::String[ 25 ].with( read_only: true )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require "fortnox/api/models/base"
+require "fortnox/api/models/document_base"
+
+module Fortnox
+  module API
+    module Model
+      class Order < Fortnox::API::Model::Base
+        UNIQUE_ID = :document_number
+        STUB = { customer_number: '', order_rows: [] }.freeze
+
+        DocumentBase.ify( self )
+
+        #CopyRemarks I remarks shall copies from order to invoice
+        attribute :copy_remarks, Types::Nullable::Boolean
+
+        # InvoiceReference Reference if an invoice is created from order
+        attribute :invoice_reference, Types::Nullable::Integer.with( read_only: true )
+
+        # OrderDate Date of order
+        attribute :order_date, Types::Nullable::Date
+
+        # OrderRows Separate object
+        attribute :order_rows, Types::Strict::Array.member( Types::OrderRow )
+      end
+    end
+  end
+end

data/lib/fortnox/api/repositories.rb

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

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

@@ -1,5 +1,4 @@
 require "fortnox/api/base"
-require "fortnox/api/repositories/base/json_convertion"
 require "fortnox/api/repositories/base/loaders"
 require "fortnox/api/repositories/base/savers"
 
@@ -8,16 +7,16 @@ module Fortnox
     module Repository
       class Base < Fortnox::API::Base
 
-        include JSONConvertion
         include Loaders
         include Savers
 
-        require "fortnox/api/repositories/base/options"
+        attr_reader :mapper, :keys_filtered_on_save
 
-        def initialize( options )
+        def initialize( keys_filtered_on_save: [ :url ] )
           super()
 
-          @options = options
+          @keys_filtered_on_save = keys_filtered_on_save
+          @mapper = Registry[ Mapper::Base.canonical_name_sym( self.class::MODEL )].new
         end
 
         private

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

@@ -6,19 +6,19 @@ module Fortnox
       module Loaders
 
         def all()
-          response_hash = get( @options.uri )
-          entities_hash = response_hash[ @options.json_collection_wrapper ]
-          entities_hash.map do |entity_hash|
-            hash_to_entity( entity_hash )
-          end
+          response_hash = get( self.class::URI )
+          instansiate_collection_response( response_hash )
         end
 
         def only( filter )
-          response_hash = get( @options.uri + "?filter=#{ filter }" )
-          entities_hash = response_hash[ @options.json_collection_wrapper ]
-          entities_hash.map do |entity_hash|
-            hash_to_entity( entity_hash )
-          end
+          response_hash = get( "#{ self.class::URI }?filter=#{ filter }" )
+          instansiate_collection_response( response_hash )
+        end
+
+        def search( hash )
+          attribute, value = hash.first
+          response_hash = get( "#{ self.class::URI }?#{ attribute }=#{ value }" )
+          instansiate_collection_response( response_hash )
         end
 
         def find( id_or_hash )
@@ -32,9 +32,8 @@ module Fortnox
         end
 
         def find_one_by( id )
-          response_hash = get( "#{@options.uri}#{id}" )
-          entity_hash = response_hash[ @options.json_entity_wrapper ]
-          hash_to_entity( entity_hash )
+          response_hash = get( "#{ self.class::URI }#{ id }" )
+          instansiate( @mapper.wrapped_json_hash_to_entity_hash( response_hash ) )
         end
 
         # def find_all_by( hash )
@@ -48,9 +47,18 @@ module Fortnox
         end
 
         def escape( key, value )
-          "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
+          "#{ CGI.escape(key.to_s) }=#{ CGI.escape(value.to_s) }"
         end
 
+        private
+
+          def instansiate_collection_response( response_hash )
+            entities_hash = @mapper.wrapped_json_collection_to_entities_hash( response_hash )
+            entities_hash.map do |entity_hash|
+              instansiate( entity_hash )
+            end
+          end
+
       end
     end
   end

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

@@ -6,32 +6,46 @@ module Fortnox
         def save( entity )
           return true if entity.saved?
 
-          hash = entity_to_hash( entity )
-
-          return save_new( hash ) if entity.new?
-          update_existing( hash )
+          return save_new( entity ) if entity.new?
+          update_existing( entity )
         end
 
       private
+        def execute_save( entity )
+          body = get_changes_on( entity ).to_json
+          result = yield body
+          instansiate_saved( result )
+        end
 
-        def save_new( hash )
-          post( @options.uri, { body: hash.to_json } )
+        def save_new( entity )
+          execute_save( entity ) do |body|
+            post( self.class::URI, { body: body })
+          end
         end
 
-        def update_existing( hash )
-          put(
-              entity_url( hash ),
-              { body: hash.to_json }
-            )
+        def update_existing( entity )
+          execute_save( entity ) do |body|
+            put( get_update_url_for( entity ), { body: body })
+          end
         end
 
-        def entity_url( hash )
-          id = cut_id_from_hash( hash )
-          "#{ @options.uri }#{ id }"
+        def get_changes_on( entity )
+          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 ) )
         end
 
-        def cut_id_from_hash( hash )
-          hash[ @options.json_entity_wrapper ].delete( @options.unique_id )
+        def get_update_url_for( entity )
+          "#{ self.class::URI }#{ entity.unique_id }"
+        end
+
+        def instansiate_saved( wrapped_json_hash )
+          instansiate(
+            @mapper.wrapped_json_hash_to_entity_hash(
+              wrapped_json_hash
+            )
+          )
         end
       end
     end

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

@@ -1,37 +1,15 @@
 require "fortnox/api/repositories/base"
 require "fortnox/api/models/customer"
+require "fortnox/api/mappers/customer"
 
 module Fortnox
   module API
     module Repository
       class Customer < Fortnox::API::Repository::Base
 
-        CONFIGURATION = Fortnox::API::Repository::Base::Options.new(
-          uri: '/customers/',
-          json_collection_wrapper: 'Customers',
-          json_entity_wrapper: 'Customer',
-          unique_id: 'CustomerNumber',
-          attribute_name_to_json_key_map: {
-            vat_type: 'VATType',
-            vat_number: 'VATNumber',
-            email_invoice_bcc: 'EmailInvoiceBCC',
-            email_invoice_cc: 'EmailInvoiceCC',
-            email_offer_bcc: 'EmailOfferBCC',
-            email_offer_cc: 'EmailOfferCC',
-            email_order_bcc: 'EmailOrderBCC',
-            email_order_cc: 'EmailOrderCC',
-            show_price_vat_included: 'ShowPriceVATIncluded',
-          },
-          keys_filtered_on_save: [
-            :url,
-          ]
-        )
         MODEL = Fortnox::API::Model::Customer
-
-        def initialize
-          super( CONFIGURATION )
-        end
-
+        MAPPER = Fortnox::API::Mapper::Customer
+        URI = '/customers/'.freeze
       end
     end
   end

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

@@ -1,34 +1,15 @@
 require "fortnox/api/repositories/base"
 require "fortnox/api/models/invoice"
+require "fortnox/api/mappers/invoice"
 
 module Fortnox
   module API
     module Repository
       class Invoice < Fortnox::API::Repository::Base
 
-        CONFIGURATION = Fortnox::API::Repository::Base::Options.new(
-          uri: '/invoices/',
-          json_collection_wrapper: 'Invoices',
-          json_entity_wrapper: 'Invoice',
-          unique_id: 'DocumentNumber',
-          attribute_name_to_json_key_map: {
-            administration_fee_vat: 'AdministrationFeeVAT',
-            edi_information: 'EDIInformation',
-            eu_quarterly_report: 'EUQuarterlyReport',
-            freight_vat: 'FreightVAT',
-            ocr: 'OCR',
-            total_vat: 'TotalVAT',
-            vat_included: 'VATIncluded'
-          },
-          keys_filtered_on_save: [
-            :url,
-          ]
-        )
         MODEL = Fortnox::API::Model::Invoice
-
-        def initialize
-          super( CONFIGURATION )
-        end
+        MAPPER = Fortnox::API::Mapper::Invoice
+        URI = '/invoices/'.freeze
       end
     end
   end

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

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

data/lib/fortnox/api/request_handling.rb

@@ -7,7 +7,7 @@ module Fortnox
         def raise_api_error( error, response )
           message = ( error[ 'message' ] || error[ 'Message' ] || 'Okänt fel' )
 
-          message += "\n\n#{response.request.inspect}" if Fortnox::API.debugging
+          message += "\n\n#{ response.request.inspect }" if Fortnox::API.debugging
 
           raise Fortnox::API::RemoteServerError, message
         end
@@ -24,9 +24,9 @@ module Fortnox
           response.parsed_response
         end
 
-        def execute &request
+        def execute
           self.class.set_headers( @headers )
-          response = request.call( self.class )
+          response = yield( self.class )
           validate_and_parse response
         end
 

data/lib/fortnox/api/types.rb

@@ -0,0 +1,44 @@
+require 'dry-struct'
+require 'dry-types'
+
+module Fortnox
+  module API
+    module Types
+      include Dry::Types.module
+
+      THE_TRUTH = { true => true, 'true' => true, false => false, 'false' => false }.freeze
+
+      require 'fortnox/api/types/required'
+      require 'fortnox/api/types/defaulted'
+      require 'fortnox/api/types/nullable'
+
+      require 'fortnox/api/types/enums'
+
+      require 'fortnox/api/types/sized'
+
+      AccountNumber = Strict::Int.constrained( gt: 0, lteq: 9999 ).optional
+
+      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 )
+
+      DiscountType = Strict::String.constrained( included_in: DiscountTypes.values ).optional.constructor( EnumConstructors.default )
+
+      Email = Strict::String.constrained( max_size: 1024, format: /\A^$|[\w+\-.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z/i ).optional.constructor{ |v| v.to_s.downcase unless v.nil? }
+
+      HouseWorkType = Strict::String.constrained( included_in: HouseWorkTypes.values ).optional.constructor( EnumConstructors.default )
+
+      VATType = Strict::String.constrained( included_in: VATTypes.values ).optional.constructor( EnumConstructors.default )
+
+      DefaultDeliveryType = Strict::String.constrained( included_in: DefaultDeliveryTypeValues.values ).optional.constructor( EnumConstructors.default )
+
+      require 'fortnox/api/types/model'
+      require 'fortnox/api/types/default_delivery_types'
+      require 'fortnox/api/types/default_templates'
+      require 'fortnox/api/types/email_information'
+      require 'fortnox/api/types/edi_information'
+      require 'fortnox/api/types/invoice_row'
+      require 'fortnox/api/types/order_row'
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require 'fortnox/api/types'
+
+module Fortnox
+  module API
+    module Types
+      class DefaultDeliveryTypes < Types::Model
+        STUB = {}.freeze
+
+        #Default delivery type for invoices. Can be PRINT EMAIL or PRINTSERVICE.
+        attribute :invoice, Types::DefaultDeliveryType
+
+        #Default delivery type for orders. Can be PRINT EMAIL or PRINTSERVICE.
+        attribute :order, Types::DefaultDeliveryType
+
+        #Default delivery type for offers. Can be PRINT EMAIL or PRINTSERVICE.
+        attribute :offer, Types::DefaultDeliveryType
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require "fortnox/api/types"
+
+module Fortnox
+  module API
+    module Types
+      class DefaultTemplates < Types::Model
+        STUB = {}.freeze
+
+        # Default template for orders. Must be a name of an existing print template.
+        attribute :order, Types::Required::String
+
+        # Default template for offers. Must be a name of an existing print template.
+        attribute :offer, Types::Required::String
+
+        # Default template for invoices. Must be a name of an existing print template.
+        attribute :invoice, Types::Required::String
+
+        # Default template for cash invoices. Must be a name of an existing print template.
+        attribute :cash_invoice, Types::Required::String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Fortnox
+  module API
+    module Types
+
+      module Defaulted
+        String = Types::Strict::String.default('')
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+module Fortnox
+  module API
+    module Types
+      module DocumentRow
+        def self.ify( base )
+          base.class_eval do
+            #AccountNumber Account number. 4 digits
+            attribute :account_number, Types::AccountNumber
+
+            #ArticleNumber Article number. 50 characters
+            attribute :article_number, Types::Sized::String[ 50 ]
+
+            #ContributionPercent Contribution Percent.
+            attribute :contribution_percent, Types::Nullable::Float.with( private: true )
+
+            #ContributionValue Contribution Value.
+            attribute :contribution_value, Types::Nullable::Float.with( private: true )
+
+            #CostCenter Code of the cost center for the row.
+            attribute :cost_center, Types::Nullable::String
+
+            #DeliveredQuantity Delivered quantity. 14 digits
+            attribute :delivered_quantity, Types::Sized::Float[ 0.0, 9_999_999_999_999.0 ]
+
+            #Description Description Row description. 50 characters
+            attribute :description, Types::Sized::String[ 50 ]
+
+            # Discount amount. 12 digits (for amount) / 5 digits (for percent)
+            # TODO(hannes): Verify that we can send in more than 5 digits through
+            # the actual API for DiscountType PERCENT. This cannot be done until
+            # we fix issue #62...
+            attribute :discount, Types::Sized::Float[ 0.0, 99_999_999_999.0 ]
+
+            #DiscountType The type of discount used for the row.
+            attribute :discount_type, Types::DiscountType
+
+            #HouseWork If the row is housework
+            attribute :house_work, Types::Nullable::Boolean
+
+            #HouseWorkHoursToReport Hours to be reported if the quantity of the row should not be used as hours. 5 digits
+            attribute :house_work_hours_to_report, Types::Sized::Integer[ 0, 99_999 ]
+
+            #HouseWorkType The type of house work.
+            attribute :house_work_type, Types::HouseWorkType
+
+            #Price Price per unit. 12 digits
+            attribute :price, Types::Sized::Float[ 0.0, 99_999_999_999.0 ]
+
+            #Project Code of the project for the row.
+            attribute :project, Types::Nullable::String
+
+            #Total Total amount for the row.
+            attribute :total, Types::Nullable::Float.with( private: true )
+
+            #Unit Code of the unit for the row.
+            attribute :unit, Types::Nullable::String
+
+            #VAT VAT percentage of the row.
+            attribute :vat, Types::Nullable::Integer
+          end
+        end
+      end
+    end
+  end
+end