fortnox-api 0.0.1 → 0.0.2

data/lib/fortnox/api/class_methods.rb

@@ -0,0 +1,62 @@
+module Fortnox
+  module API
+    module ClassMethods
+
+      def get_access_token( base_url: nil, client_secret: nil, authorization_code: nil )
+        base_url = validate_base_url( base_url )
+        client_secret = validate_client_secret( client_secret )
+        authorization_code = validate_authorization_code( authorization_code )
+
+        base_uri( base_url )
+
+        set_headers(
+          'Accept' => 'application/json',
+          'Client-Secret' => client_secret,
+          'Authorisation-Code' => authorization_code,
+        )
+
+        response = get('/')
+        response[ 'Authorisation' ][ 'AccessToken' ]
+      end
+
+      def set_header( name: nil, value: nil )
+        headers[ name ] = value
+      end
+
+      def set_headers( headers = {} )
+        headers.each do |name, value|
+          set_header( name: name, value: value )
+        end
+      end
+
+      def remove_header( name: nil )
+        headers.delete( name )
+      end
+
+      def validate_base_url( base_url )
+        base_url ||= ENV['FORTNOX_API_BASE_URL']
+        fail ArgumentError, 'You have to provide a base url.' unless base_url
+        base_url
+      end
+
+      def validate_client_secret( client_secret )
+        client_secret ||= ENV['FORTNOX_API_CLIENT_SECRET']
+        fail ArgumentError, 'You have to provide your client secret.' unless client_secret
+        client_secret
+      end
+
+      def validate_access_token( access_token )
+        access_token ||= ENV['FORTNOX_API_ACCESS_TOKEN']
+        fail ArgumentError, 'You have to provide your access token.' unless access_token
+        access_token
+      end
+
+      def validate_authorization_code( authorization_code )
+        authorization_code ||= ENV['FORTNOX_API_AUTHORIZATION_CODE']
+        fail ArgumentError, 'You have to provide your access token.' unless authorization_code
+        authorization_code
+      end
+
+    end
+  end
+end

data/lib/fortnox/api/customer.rb

@@ -0,0 +1,15 @@
+require "fortnox/api/customer/repository"
+require "fortnox/api/customer/validator"
+require "fortnox/api/customer/entity"
+
+module Fortnox
+  module API
+    module Customer
+
+      def self.new( hash = {} )
+        Entity.new( hash )
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,179 @@
+require "fortnox/api/entity"
+
+module Fortnox
+  module API
+    module Customer
+      class Entity < Fortnox::API::Entity
+
+        #Url	Direct URL to the record
+        attribute :url, String, writer: :private
+
+        #Address1	First address of the customer
+        attribute :address1, String
+
+        #Address2	Second address of the customer
+        attribute :address2, String
+
+        #City	City of the customer
+        attribute :city, String
+
+        #Country	Country of the customer
+        attribute :country, String
+
+        #Comments	Comments
+        attribute :comments, String
+
+        #Currency	Currency of the customer, 3 letters
+        attribute :currency, String
+
+        #CostCenter	Cost center of the customer, Cost center in Fortnox
+        attribute :cost_center, String
+
+        #CountryCode	Country code of the customer, 2 letters
+        attribute :country_code, String
+
+        #CustomerNumber	Customer number
+        attribute :customer_number, String
+
+        #DeliveryAddress1	First delivery address of the customer
+        attribute :delivery_address1, String
+
+        #DeliveryAddress2	Second delivery address of the customer
+        attribute :delivery_address2, String
+
+        #DeliveryCity	Delivery city of the customer
+        attribute :delivery_city, String
+
+        #DeliveryCountry	Delivery country of the customer
+        attribute :delivery_country, String
+
+        #DeliveryCountryCode	Delivery country code of the customer
+        attribute :delivery_country_code, String
+
+        #DeliveryFax	Delivery fax number of the customer
+        attribute :delivery_fax, String
+
+        #DeliveryName	Delivery name of the customer
+        attribute :delivery_name, String
+
+        #DeliveryPhone1	First delivery phone number of the customer
+        attribute :delivery_phone1, String
+
+        #DeliveryPhone2	Second delivery phone number of the customer
+        attribute :delivery_phone2, String
+
+        #DeliveryZipCode	Delivery zip code of the customer
+        attribute :delivery_zip_code, String
+
+        #Email	Email address of the customer
+        attribute :email, String
+
+        #EmailInvoice	Invoice email address of the customer
+        attribute :email_invoice, String
+
+        #EmailInvoiceBCC	Invoice BCC email address of the customer
+        attribute :email_invoice_bcc, String
+
+        #EmailInvoiceCC	Invoice CC email address of the customer
+        attribute :email_invoice_cc, String
+
+        #EmailOffer	Offer email address of the customer
+        attribute :email_offer, String
+
+        #EmailOfferBCC	Offer BCC email address of the customer
+        attribute :email_offer_bcc, String
+
+        #EmailOfferCC	Offer CC email address of the customer
+        attribute :email_offer_cc, String
+
+        #EmailOrder	Order email address of the customer
+        attribute :email_order, String
+
+        #EmailOrderBCC	Order BCC email address of the customer
+        attribute :email_order_bcc, String
+
+        #EmailOrderCC	Order CC email address of the customer
+        attribute :email_order_cc, String
+
+        #Fax	Fax number of the customer
+        attribute :fax, String
+
+        #InvoiceAdministrationFee  Invoice administration fee of the customer
+        attribute :invoice_administration_fee, Float
+
+        #InvoiceDiscount	Invoice discount of the customer
+        attribute :invoice_discount, Float
+
+        #InvoiceFreight	Invoice freight fee of the customer
+        attribute :invoice_freight, Float
+
+        #InvoiceRemark	Invoice remark of the customer
+        attribute :invoice_remark, String
+
+        #Name	Name of the customer
+        attribute :name, String
+
+        #OrganisationNumber	Organisation number of the customer
+        attribute :organisation_number, String
+
+        #OurReference	Our reference of the customer
+        attribute :our_reference, String
+
+        #Phone1	First phone number of the customer
+        attribute :phone1, String
+
+        #Phone2	Second phone number of the customer
+        attribute :phone2, String
+
+        #PriceList	Price list of the customer, Price list in Fortnox
+        attribute :price_list, String
+
+        #Project	Project of the customer, Project in Fortnox
+        attribute :project, Integer
+
+        #SalesAccount	Sales account of the customer, 4 digits
+        attribute :sales_account, Integer
+
+        #ShowPriceVATIncluded	Show prices with VAT included or not
+        attribute :show_price_vat_included, Boolean
+
+        #TermsOfDeliveryCode	Terms of delivery code of the customer
+        attribute :terms_of_delivery_code, String
+
+        #TermsOfPaymentCode	Terms of payment code of the customer
+        attribute :terms_of_payment_code, String
+
+        #Type	Customer type, PRIVATE / COMPANY
+        attribute :type, String
+
+        #VATNumber	VAT number of the customer
+        attribute :vat_number, String
+
+        #VATType	VAT type of the customer, SEVAT / SEREVERSEDVAT / EUREVERSEDVAT / EUVAT / EXPORT
+        attribute :vat_type, String
+
+        #VisitAddress	Visit address of the customer
+        attribute :visit_address, String
+
+        #VisitCity	Visit city of the customer
+        attribute :visit_city, String
+
+        #VisitCountry	Visit country of the customer
+        attribute :visit_country, String
+
+        #VisitZipCode	Visit zip code of the customer
+        attribute :visit_zip_code, String
+
+        #WayOfDeliveryCode	Way of delivery code of the customer
+        attribute :way_of_delivery_code, String
+
+        #YourReference	Your reference of the customer
+        attribute :your_reference, String
+
+        #ZipCode	Zip code of the customer
+        attribute :zip_code, String
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require "fortnox/api/repository/base"
+
+module Fortnox
+  module API
+    module Customer
+      class Repository < Fortnox::API::Repository::Base
+
+        def initialize
+          super(
+            base_uri: '/customers/',
+            json_list_wrapper: 'Customers',
+            json_unit_wrapper: 'Customer',
+            key_map: {
+              vat_type: "VATType",
+            }
+          )
+        end
+
+      private
+
+        def instansiate( hash )
+          Fortnox::API::Customer::Entity.new( hash )
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require "fortnox/api/validator"
+
+module Fortnox
+  module API
+    module Customer
+      class Validator
+
+        extend Fortnox::API::Validator
+
+        using_validations do
+
+          validates_presence_of :name
+
+          validates_length_of :currency, length: 3, if: :currency
+          validates_length_of :country_code, length: 2, if: :country_code
+
+          validates_inclusion_of :sales_account, within: (0..9999), if: :sales_account
+          validates_inclusion_of :type, within: ['PRIVATE', 'COMPANY'], if: :type
+          validates_inclusion_of :vat_type, within: ['SEVAT', 'SEREVERSEDVAT', 'EUREVERSEDVAT', 'EUVAT', 'EXPORT'], if: :vat_type
+
+        end
+
+      end
+    end
+  end
+end

data/lib/fortnox/api/entity.rb

@@ -0,0 +1,45 @@
+require "virtus"
+require "ice_nine"
+
+module Fortnox
+  module API
+    class Entity
+
+      extend Forwardable
+      include Virtus.model
+
+      attr_accessor :unsaved
+
+      def initialize( hash = {} )
+        @unsaved = hash.delete( :unsaved ){ true }
+        super
+        IceNine.deep_freeze( self )
+      end
+
+      def update( hash )
+        attributes = self.to_hash.merge( hash )
+
+        return self if attributes == self.to_hash
+
+        self.class.new( attributes )
+      end
+
+      # Generic comparison, by value, use .eql? or .equal? for object identity.
+      def ==( other )
+        return false unless other.is_a? self.class
+        self.to_hash == other.to_hash
+      end
+
+      def to_json
+        hash = attribute_set.each_with_object({}) do |attribute, hash|
+          name = attribute.options[ :name ]
+          key = attribute.options[ :json_name ] || attribute_name_to_json( name )
+          value = attributes[name]
+          hash[ key ] = value
+        end
+        hash.to_json
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require "fortnox/api/base"
+require "fortnox/api/repository/json_convertion"
+require "fortnox/api/repository/loaders"
+require "fortnox/api/repository/savers"
+
+module Fortnox
+  module API
+    module Repository
+      class Base < Fortnox::API::Base
+
+        include JSONConvertion
+        include Loaders
+        include Savers
+
+        def initialize( options = {} )
+          super()
+          @base_uri = options.fetch( :base_uri ){ '/' }
+          @json_list_wrapper = options.fetch( :json_list_wrapper ){ '' }
+          @json_unit_wrapper = options.fetch( :json_unit_wrapper ){ '' }
+          @attr_to_json_map = options.fetch( :key_map ){ {} }
+          @json_to_attr_map = @attr_to_json_map.invert
+        end
+
+      end
+    end
+  end
+end

data/lib/fortnox/api/repository/json_convertion.rb

@@ -0,0 +1,55 @@
+module Fortnox
+  module API
+    module Repository
+      module JSONConvertion
+
+      private
+
+        def hash_to_entity( entity_json_hash )
+          entity_hash = convert_hash_keys_from_json_format( entity_json_hash )
+          instansiate( entity_hash )
+        end
+
+        def entity_to_hash( entity )
+          entity_hash = entity.to_hash
+          entity_json_hash = convert_hash_keys_to_json_format( entity_hash )
+          { @json_unit_wrapper => entity_json_hash }
+        end
+
+        def convert_hash_keys_from_json_format( hash )
+          hash.each_with_object( {} ) do |(key, value), json_hash|
+            json_hash[ convert_key_from_json( key ) ] = value
+          end
+        end
+
+        def convert_key_from_json( key )
+          @json_to_attr_map.fetch( key ){ default_key_from_json_transform( key ) }
+        end
+
+        def default_key_from_json_transform( key )
+          key = key.to_s
+          return key.downcase if key.match(/\A[A-Z]+\z/)
+          key.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+          gsub(/([a-z])([A-Z])/, '\1_\2').
+          downcase.
+          to_sym
+        end
+
+        def convert_hash_keys_to_json_format( hash )
+          hash.each_with_object( {} ) do |key, value, json_hash|
+            json_hash[ convert_key_to_json( key ) ] = value
+          end
+        end
+
+        def convert_key_to_json( key )
+          @attr_to_json_map.fetch( key ){ default_key_to_json_transform( key ) }
+        end
+
+        def default_key_to_json_transform( key )
+          key.to_s.split('_').map(&:capitalize).join('')
+        end
+
+      end
+    end
+  end
+end