bank_payments 0.5.1

data/lib/bank_payments/swedbank_export/address_record.rb

@@ -0,0 +1,40 @@
+module BankPayments
+  module SwedbankExport
+
+    # Used to describe the destination of the transaction being
+    # done as well as some basic transactional information such as
+    #
+    # * Which party/parties should be responsible for the transactional costs
+    # * What kind of Swedbank account that should be used for the transaction
+    #
+    # @author Michael Litton
+    class AddressRecord < SpisuRecord
+
+      define_field :serial_number, '2:8:N'
+      define_field :address,       '9:73:AN'
+      define_field :country_code,  '75:76:AN'
+
+      # Account type to use
+      # '0': Inlåningskonto (SEK-konto)
+      # '1': Valutakonto
+      define_field :account_type,  '74:74:N'
+
+      # Transaction cost responsibility
+      # '2': The beneficiary is responsible for their transaction costs
+      # '0': The payer stands for all transaction costs
+      define_field :cost_carrier, '78:78:N'
+
+      # Priority code
+      # '0': Normal
+      # '1': Express
+      # '2': Check
+      define_field :priority, '80:80:N'
+
+      def initialize
+        super
+        self.type = '3'
+      end
+
+    end
+end
+end

data/lib/bank_payments/swedbank_export/bank_record.rb

@@ -0,0 +1,28 @@
+module BankPayments
+  module SwedbankExport
+
+    # Describes the beneficiaries / payees bank. All fields are required except
+    # for the name which is only required is the payment is made outside of EU.
+    # This is something that any implementors needs to validate on their own.
+    #
+    # @author Michael Litton
+    class BankRecord < SpisuRecord
+
+      define_field :serial_number, '2:8:N'
+
+      # Usually BIC (Bank Identification Code)
+      define_field :bank_id,       '9:20:AN'
+
+      # IBAN (Internactional Bank Account Number)
+      define_field :account,       '21:50:AN'
+
+      # Leave this blank if the payment is made within EU
+      define_field :name,          '51:80:AN'
+
+      def initialize
+        super
+        self.type = '4'
+      end
+    end
+  end
+end

data/lib/bank_payments/swedbank_export/credit_memo_record.rb

@@ -0,0 +1,49 @@
+module BankPayments::SwedbankExport
+
+  # Describes a credit to be made. See the parent class for additional information.
+  # The only special thing about this class is how to interpret the date.
+  #
+  # When you set the date it is to interpreted as a soft "expiry date" for the
+  # credit itself. When the date passes the bank will still use it, if possible,
+  # but it will appear of a special list at the bank: 'Utestående kreditfakturor'
+  #
+  # @author Michael Litton
+  class CreditMemoRecord < MoneyRecord
+
+    DIGIT_MAP = {
+      '0' => '-',
+      '1' => 'J',
+      '2' => 'K',
+      '3' => 'L',
+      '4' => 'M',
+      '5' => 'N',
+      '6' => 'O',
+      '7' => 'P',
+      '8' => 'Q',
+      '9' => 'R'
+    }.freeze
+
+    def initialize
+      super
+      self.type = '5'
+    end
+
+    def amount_sek=(amount)
+      super change_last_digit(amount.abs.spisu_format)
+    end
+
+    def amount_foreign=(amount)
+      super change_last_digit(amount.abs.spisu_format)
+    end
+
+    private
+
+    # Set a special value in positions 44 and 78 (the last digit). This is
+    # how the bank determines that this is a credit memo
+    def change_last_digit(digits)
+      digits[0..-2] + DIGIT_MAP[digits[-1]]
+    end
+  end
+end
+
+

data/lib/bank_payments/swedbank_export/enums.rb

@@ -0,0 +1,22 @@
+module BankPayments::SwedbankExport
+
+  # Lookup module for account types as described in the specification from
+  # the bank making calling code a little bit easier to understand.
+  module AccountType
+    DEPOSIT_ACCOUNT  = 0
+    CURRENCY_ACCOUNT = 1
+  end
+
+  # @see AccountType
+  module Priority
+    NORMAL    = 0
+    EXPRESS   = 1
+    CHECK     = 2
+  end
+
+  # @see AccountType
+  module CostResponsibility
+    PAYER        = 0
+    OWN_EXPENSES = 2
+  end
+end

data/lib/bank_payments/swedbank_export/field_definition.rb

@@ -0,0 +1,21 @@
+module BankPayments::SwedbankExport
+
+  # Defines a field in the the Swedbank SPISU format
+  #
+  # @author Michael Litton
+  class FieldDefinition
+    attr_reader :name, :start, :stop, :type
+
+    def initialize(name, definition)
+      @name                = name
+      unformatted_def     = definition.split(':')
+      @start, @stop, @type = unformatted_def.each_with_index.map do |value,idx|
+        idx < 2 ? value.to_i : value
+      end
+    end
+
+    def length
+      @stop - @start + 1
+    end
+  end
+end

data/lib/bank_payments/swedbank_export/file.rb

@@ -0,0 +1,26 @@
+module BankPayments::SwedbankExport
+
+  # Contains international payments to be made to foreign beneficiaries. The file
+  # contains one or more sequnces containing payments.
+  #
+  # @author Michael Litton
+  class File
+    attr_accessor :file_name
+
+    def initialize(file_name)
+      @file_name = file_name
+      @sequences = []
+    end
+
+    # Adds a sequence to the file
+    def <<(sequence)
+      @sequences << sequence
+    end
+
+    def to_file_data
+      sequence_data = @sequences.map { |sequence| sequence.to_file_data }
+
+      sequence_data.join("\n").encode('iso-8859-1')
+    end
+  end
+end

data/lib/bank_payments/swedbank_export/money_record.rb

@@ -0,0 +1,21 @@
+module BankPayments
+  module SwedbankExport
+
+    # There can be two types of monetary records in a transaction. Payments and
+    # credits sent over to the bank. This is the parent class that describes both.
+    # There is a date present which means different things depending on which
+    # implementation that is being used.
+    #
+    # @author Michael Litton
+    class MoneyRecord < SpisuRecord
+
+      define_field :serial_number,  '2:8:N'
+      define_field :reference_msg,  '9:33:AN'
+      define_field :amount_sek,     '34:44:N'
+      define_field :amount_foreign, '66:78:N'
+      define_field :currency_code,  '55:57:AN'
+      define_field :date,           '58:63:N'
+
+    end
+  end
+end

data/lib/bank_payments/swedbank_export/name_record.rb

@@ -0,0 +1,15 @@
+module BankPayments
+  module SwedbankExport
+    class NameRecord < SpisuRecord
+
+      define_field :serial_number, '2:8:N'
+      define_field :name,          '9:73:AN'
+
+      def initialize
+        super
+        self.type = '2'
+      end
+
+    end
+  end
+end

data/lib/bank_payments/swedbank_export/opening_record.rb

@@ -0,0 +1,30 @@
+module BankPayments
+  module SwedbankExport
+
+
+    # The first record in a sequence which contains information about payer.
+    #
+    # @author Michael Litton
+    class OpeningRecord < SpisuRecord
+
+      define_field :account,       '2:9:N'
+      define_field :creation_date, '10:15:N'
+      define_field :name,          '16:37:AN'
+      define_field :address,       '38:72:AN'
+      define_field :pay_date,      '73:78:N'
+      define_field :layout,        '79:79:N'
+
+      def initialize
+        super
+        self.type = '0'
+        set_spisu_layout
+      end
+
+      private
+
+      def set_spisu_layout
+        self.layout  = '2'
+      end
+    end
+  end
+end

data/lib/bank_payments/swedbank_export/payment_record.rb

@@ -0,0 +1,20 @@
+module BankPayments::SwedbankExport
+  class PaymentRecord < MoneyRecord
+
+    def initialize
+      super
+      self.type = '6'
+    end
+
+    def amount_sek=(amount)
+      super amount.spisu_format
+    end
+
+    def amount_foreign=(amount)
+      super amount.spisu_format
+    end
+
+  end
+end
+
+

data/lib/bank_payments/swedbank_export/reason_record.rb

@@ -0,0 +1,16 @@
+module BankPayments
+  module SwedbankExport
+    class ReasonRecord < SpisuRecord
+
+      define_field :serial_number,  '2:8:N'
+      define_field :code,           '9:11:N'
+
+      def initialize
+        super
+        self.type = '7'
+      end
+    end
+  end
+end
+
+

data/lib/bank_payments/swedbank_export/reconciliation_record.rb

@@ -0,0 +1,54 @@
+module BankPayments
+  module SwedbankExport
+    class ReconciliationRecord < SpisuRecord
+
+      define_field :account,             '2:9:N'
+      define_field :sum_amount_sek,      '10:21:N'
+      define_field :sum_amount_foreign,  '64:78:N'
+      define_field :total_beneficiaries, '32:43:N'
+      define_field :total_records,       '44:55:N'
+
+      DIGIT_MAP = {
+        '0' => '-',
+        '1' => 'J',
+        '2' => 'K',
+        '3' => 'L',
+        '4' => 'M',
+        '5' => 'N',
+        '6' => 'O',
+        '7' => 'P',
+        '8' => 'Q',
+        '9' => 'R'
+      }.freeze
+
+      def initialize
+        super
+        self.type = '9'
+      end
+
+      def sum_amount_sek=(amount)
+        super reformat_sums(amount)
+      end
+
+      def sum_amount_foreign=(amount)
+        super reformat_sums(amount)
+      end
+
+      private
+
+      def reformat_sums(amount)
+        if amount >= 0
+          amount.spisu_format
+        else
+          change_last_digit(amount.abs.spisu_format)
+        end
+      end
+
+      # Set a special value in positions 44 and 78 (the last digit). This is
+      # how the bank determines that this is a credit memo
+      def change_last_digit(digits)
+        digits[0..-2] + DIGIT_MAP[digits[-1]]
+      end
+    end
+  end
+end

data/lib/bank_payments/swedbank_export/sequence.rb

@@ -0,0 +1,148 @@
+module BankPayments::SwedbankExport
+
+  # An export file may contain multiple sequences. A sequence starts with an
+  # {BankPayments::SwedbankExport::OpeningRecord} and ends with an
+  # {BankPayments::SwedbankExport::ReconciliationRecord}. Each sequence will
+  # consist of at least the following:
+  #
+  # * {BankPayments::SwedbankExport::OpeningRecord}
+  # * {BankPayments::SwedbankExport::NameRecord}
+  # * {BankPayments::SwedbankExport::AddressRecord}
+  # * {BankPayments::SwedbankExport::BankRecord}
+  # * {BankPayments::SwedbankExport::MoneyRecord} (Payment or Credit Memo)
+  # * {BankPayments::SwedbankExport::ReasonRecord}
+  # * {BankPayments::SwedbankExport::ReconciliationRecord}
+  #
+  # In particular you need to supply the following per beneficiary/payee:
+  #
+  # * {BankPayments::SwedbankExport::NameRecord}
+  # * {BankPayments::SwedbankExport::AddressRecord}
+  # * {BankPayments::SwedbankExport::BankRecord}
+  #
+  # which describes where the payment should be made. Then you will supply
+  # a money record (payment or credit memo) together with it reason to to
+  # describe a payment. All of these records will have a unique serial number
+  # for the beneficiary.
+  #
+  # According to the documentation you can group money records together with the
+  # beneficiary given that the have the correct serial number.
+  #
+  # * {BankPayments::SwedbankExport::MoneyRecord} (Payment or Credit Memo)
+  # * {BankPayments::SwedbankExport::ReasonRecord}
+  #
+  # @author Michael Litton
+  class Sequence
+
+    # Intializes the required records for a sequence given the
+    # sends account, name and adress
+    def initialize(account, name, address, payment_date = nil)
+      @initial_records = []
+
+      @initial_records << OpeningRecord.new do |o_record|
+        o_record.account = account
+        o_record.name    = name
+        o_record.address = address
+      end
+
+      @initial_records << ReconciliationRecord.new do |r_record|
+        r_record.account              = account
+        r_record.sum_amount_sek       = 0
+        r_record.sum_amount_foreign   = 0
+        r_record.total_beneficiaries  = 0
+        r_record.total_records        = 2
+      end
+
+      @payment_date = payment_date
+
+      # TODO Make this thread safe using a mutex?
+      @beneficiaries = []
+    end
+
+    def records
+      all_records = []
+      all_records << @initial_records.first
+
+      @beneficiaries.each_with_index do |entry,index|
+        destination_records = entry[:beneficiary].to_spisu_records
+        moneytary_records   = entry[:transactions].map(&:to_spisu_records)
+
+        [destination_records + moneytary_records].flatten.each do|record|
+          record.serial_number = index + 1
+        end
+
+        all_records << destination_records << moneytary_records
+      end
+
+      reconciliation                      = @initial_records.last
+      reconciliation.sum_amount_sek       = sum_sek_transactions
+      reconciliation.sum_amount_foreign   = sum_foreign_transactions
+      reconciliation.total_beneficiaries  = @beneficiaries.size
+      reconciliation.total_records        = all_records.flatten.size + 1
+
+      all_records << reconciliation
+
+      all_records.flatten
+    end
+
+    # Adds a transaction to an existing beneficiary or creates a
+    # new one.
+    def add_transaction(beneficiary, transaction)
+      find_or_create_beneficiary(beneficiary) do |entry|
+        entry[:transactions] << transaction
+        entry[:transactions].sort_by!(&:amount_sek)
+      end
+    end
+
+    # Goes through the sequence and validates that in corresponds to the
+    # rules in the specification
+    def valid?
+      all_requried_types_present?
+    end
+
+    def to_file_data
+      records.join("\n")
+    end
+
+    private
+
+    def sum_sek_transactions
+      sum_field(:amount_sek)
+    end
+
+    def sum_foreign_transactions
+      sum_field(:amount_foreign)
+    end
+
+    def sum_field(field)
+      tnxs = @beneficiaries.map { |e| e[:transactions] }.flatten
+      tnxs.inject(0.0) { |sum,e| sum += e.send(field) }
+    end
+
+    def find_or_create_beneficiary(beneficiary, &block)
+      entry = @beneficiaries.find { |entry| entry[:beneficiary] == beneficiary }
+
+      if entry.nil?
+        entry = { beneficiary:  beneficiary, transactions: [] }
+        @beneficiaries << entry
+      end
+
+      yield entry
+    end
+
+    def all_requried_types_present?
+      all_types = records.map do |record|
+        if record.is_a?(MoneyRecord)
+          'MoneyRecord'
+        else
+          record.class.name.split('::').last
+        end
+      end
+
+      required_types = %w(OpeningRecord NameRecord AddressRecord BankRecord
+        MoneyRecord ReasonRecord ReconciliationRecord)
+
+      (required_types - all_types.uniq).size == 0
+    end
+
+  end
+end