sepa_king_codeur 0.12.1

data/lib/sepa_king/message/direct_debit.rb

@@ -0,0 +1,207 @@
+# encoding: utf-8
+
+module SEPA
+  class DirectDebit < Message
+    self.account_class = CreditorAccount
+    self.transaction_class = DirectDebitTransaction
+    self.xml_main_tag = 'CstmrDrctDbtInitn'
+    self.known_schemas = [ PAIN_008_003_02, PAIN_008_002_02, PAIN_008_001_02 ]
+
+    validate do |record|
+      if record.transactions.map(&:local_instrument).uniq.size > 1
+        errors.add(:base, 'CORE, COR1 AND B2B must not be mixed in one message!')
+      end
+    end
+
+  private
+    # Find groups of transactions which share the same values of some attributes
+    def transaction_group(transaction)
+      { requested_date:   transaction.requested_date,
+        local_instrument: transaction.local_instrument,
+        sequence_type:    transaction.sequence_type,
+        batch_booking:    transaction.batch_booking,
+        account:          transaction.creditor_account || account
+      }
+    end
+
+    def build_payment_informations(builder)
+      # Build a PmtInf block for every group of transactions
+      grouped_transactions.each do |group, transactions|
+        builder.PmtInf do
+          builder.PmtInfId(payment_information_identification(group))
+          builder.PmtMtd('DD')
+          builder.BtchBookg(group[:batch_booking])
+          builder.NbOfTxs(transactions.length)
+          builder.CtrlSum('%.2f' % amount_total(transactions))
+          builder.PmtTpInf do
+            builder.SvcLvl do
+              builder.Cd('SEPA')
+            end
+            builder.LclInstrm do
+              builder.Cd(group[:local_instrument])
+            end
+            builder.SeqTp(group[:sequence_type])
+          end
+          builder.ReqdColltnDt(group[:requested_date].iso8601)
+          builder.Cdtr do
+            builder.Nm(group[:account].name)
+          end
+          builder.CdtrAcct do
+            builder.Id do
+              builder.IBAN(group[:account].iban)
+            end
+          end
+          builder.CdtrAgt do
+            builder.FinInstnId do
+              if group[:account].bic
+                builder.BIC(group[:account].bic)
+              else
+                builder.Othr do
+                  builder.Id('NOTPROVIDED')
+                end
+              end
+            end
+          end
+          builder.ChrgBr('SLEV')
+          builder.CdtrSchmeId do
+            builder.Id do
+              builder.PrvtId do
+                builder.Othr do
+                  builder.Id(group[:account].creditor_identifier)
+                  builder.SchmeNm do
+                    builder.Prtry('SEPA')
+                  end
+                end
+              end
+            end
+          end
+
+          transactions.each do |transaction|
+            build_transaction(builder, transaction)
+          end
+        end
+      end
+    end
+
+    def build_amendment_informations(builder, transaction)
+      builder.AmdmntInd(true)
+      builder.AmdmntInfDtls do
+        if transaction.original_debtor_account
+          builder.OrgnlDbtrAcct do
+            builder.Id do
+              builder.IBAN(transaction.original_debtor_account)
+            end
+          end
+        elsif transaction.same_mandate_new_debtor_agent
+          builder.OrgnlDbtrAgt do
+            builder.FinInstnId do
+              builder.Othr do
+                builder.Id('SMNDA')
+              end
+            end
+          end
+        end
+        if transaction.original_creditor_account
+          builder.OrgnlCdtrSchmeId do
+            if transaction.original_creditor_account.name
+              builder.Nm(transaction.original_creditor_account.name)
+            end
+            if transaction.original_creditor_account.creditor_identifier
+              builder.Id do
+                builder.PrvtId do
+                  builder.Othr do
+                    builder.Id(transaction.original_creditor_account.creditor_identifier)
+                    builder.SchmeNm do
+                      builder.Prtry('SEPA')
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def build_transaction(builder, transaction)
+      builder.DrctDbtTxInf do
+        builder.PmtId do
+          if transaction.instruction.present?
+            builder.InstrId(transaction.instruction)
+          end
+          builder.EndToEndId(transaction.reference)
+        end
+        builder.InstdAmt('%.2f' % transaction.amount, Ccy: transaction.currency)
+        builder.DrctDbtTx do
+          builder.MndtRltdInf do
+            builder.MndtId(transaction.mandate_id)
+            builder.DtOfSgntr(transaction.mandate_date_of_signature.iso8601)
+            build_amendment_informations(builder, transaction) if transaction.amendment_informations?
+          end
+        end
+        builder.DbtrAgt do
+          builder.FinInstnId do
+            if transaction.bic
+              builder.BIC(transaction.bic)
+            else
+              builder.Othr do
+                builder.Id('NOTPROVIDED')
+              end
+            end
+          end
+        end
+        builder.Dbtr do
+          builder.Nm(transaction.name)
+          if transaction.debtor_address
+            builder.PstlAdr do
+              # Only set the fields that are actually provided.
+              # StrtNm, BldgNb, PstCd, TwnNm provide a structured address
+              # separated into its individual fields.
+              # AdrLine provides the address in free format text.
+              # Both are currently allowed and the actual preference depends on the bank.
+              # Also the fields that are required legally may vary depending on the country
+              # or change over time.
+              if transaction.debtor_address.street_name
+                builder.StrtNm transaction.debtor_address.street_name
+              end
+
+              if transaction.debtor_address.building_number
+                builder.BldgNb transaction.debtor_address.building_number
+              end
+
+              if transaction.debtor_address.post_code
+                builder.PstCd transaction.debtor_address.post_code
+              end
+
+              if transaction.debtor_address.town_name
+                builder.TwnNm transaction.debtor_address.town_name
+              end
+
+              if transaction.debtor_address.country_code
+                builder.Ctry transaction.debtor_address.country_code
+              end
+
+              if transaction.debtor_address.address_line1
+                builder.AdrLine transaction.debtor_address.address_line1
+              end
+
+              if transaction.debtor_address.address_line2
+                builder.AdrLine transaction.debtor_address.address_line2
+              end
+            end
+          end
+        end
+        builder.DbtrAcct do
+          builder.Id do
+            builder.IBAN(transaction.iban)
+          end
+        end
+        if transaction.remittance_information
+          builder.RmtInf do
+            builder.Ustrd(transaction.remittance_information)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sepa_king/transaction.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+module SEPA
+  class Transaction
+    include ActiveModel::Validations
+    extend Converter
+
+    DEFAULT_REQUESTED_DATE = Date.new(1999, 1, 1).freeze
+
+    attr_accessor :name,
+                  :iban,
+                  :bic,
+                  :amount,
+                  :instruction,
+                  :reference,
+                  :remittance_information,
+                  :requested_date,
+                  :batch_booking,
+                  :currency,
+                  :debtor_address,
+                  :creditor_address
+
+    convert :name, :instruction, :reference, :remittance_information, to: :text
+    convert :amount, to: :decimal
+
+    validates_length_of :name, within: 1..70
+    validates_length_of :currency, is: 3
+    validates_length_of :instruction, within: 1..35, allow_nil: true
+    validates_length_of :reference, within: 1..35, allow_nil: true
+    validates_length_of :remittance_information, within: 1..140, allow_nil: true
+    validates_numericality_of :amount, greater_than: 0
+    validates_presence_of :requested_date
+    validates_inclusion_of :batch_booking, :in => [true, false]
+    validates_with BICValidator, IBANValidator, message: "%{value} is invalid"
+
+    def initialize(attributes = {})
+      attributes.each do |name, value|
+        send("#{name}=", value)
+      end
+
+      self.requested_date ||= DEFAULT_REQUESTED_DATE
+      self.reference ||= 'NOTPROVIDED'
+      self.batch_booking = true if self.batch_booking.nil?
+      self.currency ||= 'EUR'
+    end
+
+    protected
+
+    def validate_requested_date_after(min_requested_date)
+      return unless requested_date.is_a?(Date)
+
+      if requested_date != DEFAULT_REQUESTED_DATE && requested_date < min_requested_date
+        errors.add(:requested_date, "must be greater or equal to #{min_requested_date}, or nil")
+      end
+    end
+  end
+end

data/lib/sepa_king/transaction/credit_transfer_transaction.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+module SEPA
+  class CreditTransferTransaction < Transaction
+    attr_accessor :service_level,
+                  :creditor_address,
+                  :category_purpose
+
+    validates_inclusion_of :service_level, :in => %w(SEPA URGP), :allow_nil => true
+    validates_length_of :category_purpose, within: 1..4, allow_nil: true
+
+    validate { |t| t.validate_requested_date_after(Date.today) }
+
+    def initialize(attributes = {})
+      super
+      self.service_level ||= 'SEPA' if self.currency == 'EUR'
+    end
+
+    def schema_compatible?(schema_name)
+      case schema_name
+      when PAIN_001_001_03
+        !self.service_level || (self.service_level == 'SEPA' && self.currency == 'EUR')
+      when PAIN_001_002_03
+        self.bic.present? && self.service_level == 'SEPA' && self.currency == 'EUR'
+      when PAIN_001_003_03
+        self.currency == 'EUR'
+      when PAIN_001_001_03_CH_02
+        self.currency == 'CHF'
+      end
+    end
+  end
+end

data/lib/sepa_king/transaction/direct_debit_transaction.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+module SEPA
+  class DirectDebitTransaction < Transaction
+    SEQUENCE_TYPES = %w(FRST OOFF RCUR FNAL)
+    LOCAL_INSTRUMENTS = %w(CORE COR1 B2B)
+
+    attr_accessor :mandate_id,
+                  :mandate_date_of_signature,
+                  :local_instrument,
+                  :sequence_type,
+                  :creditor_account,
+                  :original_debtor_account,
+                  :same_mandate_new_debtor_agent,
+                  :original_creditor_account,
+                  :debtor_address
+
+    validates_with MandateIdentifierValidator, field_name: :mandate_id, message: "%{value} is invalid"
+    validates_presence_of :mandate_date_of_signature
+    validates_inclusion_of :local_instrument, in: LOCAL_INSTRUMENTS
+    validates_inclusion_of :sequence_type, in: SEQUENCE_TYPES
+    validate { |t| t.validate_requested_date_after(Date.today.next) }
+
+    validate do |t|
+      if creditor_account
+        errors.add(:creditor_account, 'is not correct') unless creditor_account.valid?
+      end
+
+      if t.mandate_date_of_signature.is_a?(Date)
+        errors.add(:mandate_date_of_signature, 'is in the future') if t.mandate_date_of_signature > Date.today
+      else
+        errors.add(:mandate_date_of_signature, 'is not a Date')
+      end
+    end
+
+    def initialize(attributes = {})
+      super
+      self.local_instrument ||= 'CORE'
+      self.sequence_type ||= 'OOFF'
+    end
+
+    def amendment_informations?
+      original_debtor_account || same_mandate_new_debtor_agent || original_creditor_account
+    end
+
+    def schema_compatible?(schema_name)
+      case schema_name
+      when PAIN_008_002_02
+        self.bic.present? && %w(CORE B2B).include?(self.local_instrument) && self.currency == 'EUR'
+      when PAIN_008_003_02
+        self.currency == 'EUR'
+      when PAIN_008_001_02
+        true
+      end
+    end
+  end
+end

data/lib/sepa_king/validator.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module SEPA
+  class IBANValidator < ActiveModel::Validator
+    # IBAN2007Identifier (taken from schema)
+    REGEX = /\A[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}\z/.freeze
+
+    def validate(record)
+      field_name = options[:field_name] || :iban
+      value = record.send(field_name).to_s
+
+      record.errors.add(field_name, :invalid, message: options[:message]) unless value.match(REGEX)
+    end
+  end
+
+  class BICValidator < ActiveModel::Validator
+    # AnyBICIdentifier (taken from schema)
+    REGEX = /\A[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}\z/.freeze
+
+    def validate(record)
+      field_name = options[:field_name] || :bic
+      value = record.send(field_name)
+
+      record.errors.add(field_name, :invalid, message: options[:message]) if value && !value.to_s.match(REGEX)
+    end
+  end
+
+  class CreditorIdentifierValidator < ActiveModel::Validator
+    REGEX = %r{\A[a-zA-Z]{2,2}[0-9]{2,2}([A-Za-z0-9]|[+|?|/|\-|:|(|)|.|,|']){3,3}([A-Za-z0-9]|[+|?|/|\-|:|(|)|.|,|']){1,28}\z}.freeze
+
+    def validate(record)
+      field_name = options[:field_name] || :creditor_identifier
+      value = record.send(field_name)
+
+      record.errors.add(field_name, :invalid, message: options[:message]) unless valid?(value)
+    end
+
+    def valid?(creditor_identifier)
+      if ok = creditor_identifier.to_s.match(REGEX) && creditor_identifier[0..1].match(/DE/i)
+        # In Germany, the identifier has to be exactly 18 chars long
+        ok = creditor_identifier.length == 18
+      end
+      ok
+    end
+  end
+
+  class MandateIdentifierValidator < ActiveModel::Validator
+    REGEX = %r{\A([A-Za-z0-9]|[+|?|/|\-|:|(|)|.|,|']){1,35}\z}.freeze
+
+    def validate(record)
+      field_name = options[:field_name] || :mandate_id
+      value = record.send(field_name)
+
+      record.errors.add(field_name, :invalid, message: options[:message]) unless value.to_s.match(REGEX)
+    end
+  end
+end

data/lib/sepa_king/version.rb

@@ -0,0 +1,3 @@
+module SEPA
+  VERSION = '0.12.1'
+end

data/sepa_king.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sepa_king/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'sepa_king_codeur'
+  s.version       = SEPA::VERSION
+  s.authors       = ['Georg Leciejewski', 'Georg Ledermann', 'Codeur']
+  s.email         = ['gl@salesking.eu', 'mail@georg-ledermann.de', 'dev@codeur.com']
+  s.description   = 'Implemention of pain.001.002.03 and pain.008.002.02 (ISO 20022)'
+  s.summary       = 'Ruby gem for creating SEPA XML files'
+  s.homepage      = 'http://github.com/codeur/sepa_king'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split($/)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.metadata['homepage_uri'] = s.homepage
+  s.metadata['source_code_uri'] = 'https://github.com/codeur/sepa_king'
+
+  s.required_ruby_version = '>= 2.2'
+
+  s.add_runtime_dependency 'activemodel', '>= 3.1'
+  s.add_runtime_dependency 'iban-tools'
+  s.add_runtime_dependency 'nokogiri'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'simplecov'
+end