sepa_king 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 975c5018834a59ef2185c0b36f0f9ae64a49f600
-  data.tar.gz: 0af3c482071e0b707162776b948d4cc55fa2bacf
+  metadata.gz: d39443f2a8e1403804bfc6dd0eeb03f9e5e9d845
+  data.tar.gz: 7fa5f5072912dee37819412cc0e05229c371b33a
 SHA512:
-  metadata.gz: 75b1b3c8cd76dfe4142b549c5b7c3512a9e3077ff278f9d7c0a879ecf278824b0da5d629043b72dce7762ba5bb61c5005bfd0a307b1c84899446bf9177345720
-  data.tar.gz: 7c6b844e79e783258601b637596c30c7bc07a3f557e475a9ea667ffd67cacafe3780bf4992ba2448965547575d5ca4261b5e4a9dbda89af56a01b91cc5c5b2b7
+  metadata.gz: a6aa54767870360c955f350ae74bd3777fc6f7928b9cf9b75806689e76f4b70db70f5f722e426c7b4df075b6dcba939e560e84af479d56417c2b8caac9b173a1
+  data.tar.gz: 9a06003c4a9d9c9fdbf58d1d6430651888339317c1f1a8f98d2f5c1a5f320b7b60457e3fae7e7ce8d8c74e6fdc9e3d4b2052aeae96e742079c3dbc4650a5cf1b

data/lib/sepa_king/account/creditor_account.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+module SEPA
+  class CreditorAccount < Account
+    attr_accessor :identifier
+
+    validates_length_of :identifier, :is => 18
+  end
+end

data/lib/sepa_king/{exception.rb → account/debtor_account.rb}

@@ -1,5 +1,5 @@
 # encoding: utf-8
 module SEPA
-  class Exception < ::Exception
+  class DebtorAccount < Account
   end
 end

data/lib/sepa_king/account.rb

@@ -1,37 +1,18 @@
 # encoding: utf-8
 module SEPA
   class Account
-    include TextConverter
+    include ActiveModel::Model
+    extend Converter
 
-    attr_reader :name, :iban, :bic, :identifier
+    attr_accessor :name, :iban, :bic
+    convert :name, :to => :text
 
-    def initialize(options)
-      options.each_pair do |k,v|
-        send("#{k}=", convert_text(v))
-      end
-    end
-
-    def name=(value)
-      raise ArgumentError.new('Name is missing') unless value
-      @name = value
-    end
-
-    def iban=(value)
-      raise ArgumentError.new('IBAN is missing') unless value
-      raise ArgumentError.new("IBAN has wrong length: #{value.length}, must be between 15-34") unless value.length.between?(15,34)
-      @iban = value
-    end
-
-    def bic=(value)
-      raise ArgumentError.new('BIC is missing') unless value
-      raise ArgumentError.new("BIC has wrong length: #{value.length} must be between 8-11") unless value.length.between?(8,11)
-      @bic = value
-    end
+    validates_presence_of :name, :iban, :bic
+    validates_length_of :name, :maximum => 70
+    validates_length_of :bic, :within => 8..11
 
-    def identifier=(value)
-      raise ArgumentError.new('Identifier is missing') unless value
-      raise ArgumentError.new("Identifier has wrong length: #{value.length} must be exactly 18") unless value.length == 18
-      @identifier = value
+    validate do |t|
+      errors.add(:iban, 'is invalid') unless IBANTools::IBAN.valid?(t.iban.to_s)
     end
   end
 end

data/lib/sepa_king/converter.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+module SEPA
+  module Converter
+    def convert(*attributes, options)
+      include InstanceMethods
+
+      method_name = "convert_#{options[:to]}"
+      raise ArgumentError.new("Converter '#{options[:to]}' does not exist!") unless InstanceMethods.method_defined?(method_name)
+
+      attributes.each do |attribute|
+        define_method "#{attribute}=" do |value|
+          instance_variable_set("@#{attribute}", send(method_name, value))
+        end
+      end
+    end
+
+    module InstanceMethods
+      def convert_text(value)
+        return unless value
+
+        text = value.to_s.
+          # Convert german umlauts
+          gsub('Ä', 'AE').
+          gsub('Ü', 'UE').
+          gsub('Ö', 'OE').
+          gsub('ä', 'ae').
+          gsub('ü', 'ue').
+          gsub('ö', 'oe').
+          gsub('ß', 'ss')
+
+        I18n.transliterate(text).
+          # Remove all invalid characters
+          gsub(/[^a-zA-Z0-9\ \'\:\?\,\-\(\+\.\)\/]/, '').
+          # Remove leading and trailing spaces
+          strip
+      end
+
+      def convert_decimal(value)
+        return unless value
+        BigDecimal(value.to_s).round(2)
+      end
+    end
+  end
+end

data/lib/sepa_king/message/credit_transfer.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+
+module SEPA
+  class CreditTransfer < Message
+    self.account_class = DebtorAccount
+    self.transaction_class = CreditTransferTransaction
+
+    def to_xml
+      super
+
+      builder = Builder::XmlMarkup.new :indent => 2
+      builder.instruct!
+      builder.Document :xmlns                => 'urn:iso:std:iso:20022:tech:xsd:pain.001.002.03',
+                       :'xmlns:xsi'          => 'http://www.w3.org/2001/XMLSchema-instance',
+                       :'xsi:schemaLocation' => 'urn:iso:std:iso:20022:tech:xsd:pain.001.002.03 pain.001.002.03.xsd' do
+        builder.CstmrCdtTrfInitn do
+          build_group_header(builder)
+          build_payment_information(builder)
+        end
+      end
+    end
+
+  private
+    def build_payment_information(builder)
+      builder.PmtInf do
+        builder.PmtInfId(payment_information_identification)
+        builder.PmtMtd('TRF')
+        builder.BtchBookg(true)
+        builder.NbOfTxs(transactions.length)
+        builder.CtrlSum('%.2f' % amount_total)
+        builder.PmtTpInf do
+          builder.SvcLvl do
+            builder.Cd('SEPA')
+          end
+        end
+        builder.ReqdExctnDt(Date.today.next.iso8601)
+        builder.Dbtr do
+          builder.Nm(account.name)
+        end
+        builder.DbtrAcct do
+          builder.Id do
+            builder.IBAN(account.iban)
+          end
+        end
+        builder.DbtrAgt do
+          builder.FinInstnId do
+            builder.BIC(account.bic)
+          end
+        end
+        builder.ChrgBr('SLEV')
+        build_transactions(builder)
+      end
+    end
+
+    def build_transactions(builder)
+      transactions.each do |transaction|
+        builder.CdtTrfTxInf do
+          builder.PmtId do
+            builder.EndToEndId(transaction.reference || 'NOTPROVIDED')
+          end
+          builder.Amt do
+            builder.InstdAmt('%.2f' % transaction.amount, :Ccy => 'EUR')
+          end
+          builder.CdtrAgt do
+            builder.FinInstnId do
+              builder.BIC(transaction.bic)
+            end
+          end
+          builder.Cdtr do
+            builder.Nm(transaction.name)
+          end
+          builder.CdtrAcct 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
+end

data/lib/sepa_king/message/direct_debit.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+
+module SEPA
+  class DirectDebit < Message
+    self.account_class = CreditorAccount
+    self.transaction_class = DirectDebitTransaction
+
+    def to_xml
+      super
+      builder = Builder::XmlMarkup.new :indent => 2
+      builder.instruct!
+      builder.Document :xmlns                => 'urn:iso:std:iso:20022:tech:xsd:pain.008.002.02',
+                       :'xmlns:xsi'          => 'http://www.w3.org/2001/XMLSchema-instance',
+                       :'xsi:schemaLocation' => 'urn:iso:std:iso:20022:tech:xsd:pain.008.002.02 pain.008.002.02.xsd' do
+        builder.CstmrDrctDbtInitn do
+          build_group_header(builder)
+          build_payment_information(builder)
+        end
+      end
+    end
+
+  private
+    def build_payment_information(builder)
+      builder.PmtInf do
+        builder.PmtInfId(payment_information_identification)
+        builder.PmtMtd('DD')
+        builder.NbOfTxs(transactions.length)
+        builder.CtrlSum('%.2f' % amount_total)
+        builder.PmtTpInf do
+          builder.SvcLvl do
+            builder.Cd('SEPA')
+          end
+          builder.LclInstrm do
+            builder.Cd('CORE')
+          end
+          builder.SeqTp('OOFF')
+        end
+        builder.ReqdColltnDt(Date.today.next.iso8601)
+        builder.Cdtr do
+          builder.Nm(account.name)
+        end
+        builder.CdtrAcct do
+          builder.Id do
+            builder.IBAN(account.iban)
+          end
+        end
+        builder.CdtrAgt do
+          builder.FinInstnId do
+            builder.BIC(account.bic)
+          end
+        end
+        builder.ChrgBr('SLEV')
+        builder.CdtrSchmeId do
+          builder.Id do
+            builder.PrvtId do
+              builder.Othr do
+                builder.Id(account.identifier)
+                builder.SchmeNm do
+                  builder.Prtry('SEPA')
+                end
+              end
+            end
+          end
+        end
+        build_transactions(builder)
+      end
+    end
+
+    def build_transactions(builder)
+      transactions.each do |transaction|
+        builder.DrctDbtTxInf do
+          builder.PmtId do
+            builder.EndToEndId(transaction.reference || 'NOTPROVIDED')
+          end
+          builder.InstdAmt('%.2f' % transaction.amount, :Ccy => 'EUR')
+          builder.DrctDbtTx do
+            builder.MndtRltdInf do
+              builder.MndtId(transaction.mandate_id)
+              builder.DtOfSgntr(transaction.mandate_date_of_signature.iso8601)
+            end
+          end
+          builder.DbtrAgt do
+            builder.FinInstnId do
+              builder.BIC(transaction.bic)
+            end
+          end
+          builder.Dbtr do
+            builder.Nm(transaction.name)
+          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
+end

data/lib/sepa_king/message.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+module SEPA
+  class Message
+    attr_reader :account, :transactions
+    class_attribute :account_class, :transaction_class
+
+    def initialize(account_options={})
+      @transactions = []
+      @account = self.account_class.new(account_options)
+    end
+
+    def add_transaction(options)
+      transaction = transaction_class.new(options)
+      raise ArgumentError.new(transaction.errors.full_messages.join("\n")) unless transaction.valid?
+      @transactions << transaction
+    end
+
+    def to_xml
+      raise RuntimeError.new(account.errors.full_messages.join("\n")) unless account.valid?
+    end
+
+    def amount_total
+      transactions.inject(0) { |sum, t| sum + t.amount }
+    end
+
+  private
+    def build_group_header(builder)
+      builder.GrpHdr do
+        builder.MsgId(message_identification)
+        builder.CreDtTm(Time.now.iso8601)
+        builder.NbOfTxs(transactions.length)
+        builder.CtrlSum('%.2f' % amount_total)
+        builder.InitgPty do
+          builder.Nm(account.name)
+        end
+      end
+    end
+
+    def message_identification
+      "SEPA-KING/#{Time.now.iso8601}"
+    end
+
+    def payment_information_identification
+      message_identification
+    end
+  end
+end

data/lib/sepa_king/transaction/credit_transfer_transaction.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+module SEPA
+  class CreditTransferTransaction < Transaction
+  end
+end

data/lib/sepa_king/transaction/direct_debit_transaction.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+module SEPA
+  class DirectDebitTransaction < Transaction
+    attr_accessor :mandate_id, :mandate_date_of_signature
+
+    validates_length_of :mandate_id, :within => 1..35
+    validates_presence_of :mandate_date_of_signature
+
+    validate do |t|
+      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
+  end
+end

data/lib/sepa_king/transaction.rb

@@ -1,54 +1,22 @@
 # encoding: utf-8
 module SEPA
   class Transaction
-    include TextConverter
-    attr_reader :name, :iban, :bic, :amount, :reference, :remittance_information
+    include ActiveModel::Model
+    extend Converter
 
-    def initialize(options)
-      options.each_pair do |k,v|
-        send("#{k}=", v)
-      end
-    end
-
-    def name=(value)
-      raise ArgumentError.new('Name is missing') if value.nil? || value.empty?
-      raise ArgumentError.new("Name is too long: #{value.length}, must be 70 maximum") if value.length > 70
-      @name = convert_text(value)
-    end
-
-    def iban=(value)
-      raise ArgumentError.new('IBAN is missing') if value.nil? || value.empty?
-      raise ArgumentError.new('IBAN is invalid') unless IBANTools::IBAN.valid?(value)
-      @iban = value
-    end
+    attr_accessor :name, :iban, :bic, :amount, :reference, :remittance_information
+    convert :name, :reference, :remittance_information, :to => :text
+    convert :amount, :to => :decimal
 
-    def bic=(value)
-      raise ArgumentError.new('BIC is missing') if value.nil? || value.empty?
-      raise ArgumentError.new("BIC has wrong length: #{value.length} must be between 8-11") unless value.length.between?(8,11)
-      @bic = value
-    end
-
-    def amount=(value)
-      raise ArgumentError.new('Amount is not a number') unless value.is_a?(Numeric)
-      raise ArgumentError.new('Amount cannot be zero') if value.zero?
-      raise ArgumentError.new('Amount cannot be negative') if value < 0
-      raise ArgumentError.new('Amount has more than 2 digits') if value.round(2) != value
-      @amount = value
-    end
-
-    def reference=(value)
-      raise ArgumentError.new('Reference is missing') if value.nil? || value.empty?
-      raise ArgumentError.new("Reference is too long: #{value.length}, must be 35 maximum") if value.length > 35
-      @reference = convert_text(value)
-    end
+    validates_presence_of :name, :iban, :bic, :amount
+    validates_length_of :name, :maximum => 70
+    validates_length_of :bic, :within => 8..11
+    validates_length_of :reference, :maximum => 35, :minimum => 1, :allow_nil => true
+    validates_length_of :remittance_information, :minimum => 1, :maximum => 140, :allow_nil => true
+    validates_numericality_of :amount, :greater_than => 0
 
-    def remittance_information=(value)
-      if value
-        raise ArgumentError.new('Remittance information has to be a string') unless value.is_a?(String)
-        raise ArgumentError.new('Remittance information cannot be blank') if value.empty?
-        raise ArgumentError.new("Remittance information is too long: #{value.length}, must be 140 maximum") if value.length > 140
-      end
-      @remittance_information = convert_text(value)
+    validate do |t|
+      errors.add(:iban, 'is invalid') unless IBANTools::IBAN.valid?(t.iban.to_s)
     end
   end
 end

data/lib/sepa_king/version.rb

@@ -1,3 +1,3 @@
 module SEPA
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/sepa_king.rb

@@ -1,13 +1,16 @@
 require 'i18n'
+require 'active_model'
 require 'bigdecimal'
 require 'builder'
 require 'iban-tools'
 
-require 'sepa_king/text_converter'
+require 'sepa_king/converter'
 require 'sepa_king/account'
+require 'sepa_king/account/debtor_account'
+require 'sepa_king/account/creditor_account'
 require 'sepa_king/transaction'
-require 'sepa_king/debt_transaction'
-require 'sepa_king/credit_transaction'
-require 'sepa_king/exception'
-require 'sepa_king/direct_debit'
-require 'sepa_king/credit_transfer'
+require 'sepa_king/transaction/direct_debit_transaction'
+require 'sepa_king/transaction/credit_transfer_transaction'
+require 'sepa_king/message'
+require 'sepa_king/message/direct_debit'
+require 'sepa_king/message/credit_transfer'

data/sepa_king.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
+  s.add_runtime_dependency 'activemodel'
   s.add_runtime_dependency 'i18n'
   s.add_runtime_dependency 'builder'
   s.add_runtime_dependency 'iban-tools'

data/spec/account_spec.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe SEPA::Account do
+  describe 'Initialization' do
+    it 'should not accept unknown keys' do
+      expect {
+        SEPA::Account.new :foo => 'bar'
+      }.to raise_error(NoMethodError)
+    end
+  end
+
+  describe :name do
+    it 'should accept valid value' do
+      [ 'Gläubiger GmbH', 'Zahlemann & Söhne GbR', 'X' * 70 ].each do |value_value|
+        expect(
+          SEPA::Account.new :name => value_value
+        ).to have(:no).errors_on(:name)
+      end
+    end
+
+    it 'should not accept invalid value' do
+      [ nil, '', 'X' * 71 ].each do |invalue_value|
+        expect(
+          SEPA::Account.new :name => invalue_value
+        ).to have_at_least(1).errors_on(:name)
+      end
+    end
+  end
+
+  describe :iban do
+    it 'should accept valid value' do
+      [ 'DE21500500009876543210', 'PL61109010140000071219812874' ].each do |value_value|
+        expect(
+          SEPA::Account.new :iban => value_value
+        ).to have(:no).errors_on(:iban)
+      end
+    end
+
+    it 'should not accept invalid value' do
+      [ nil, '', 'invalid' ].each do |invalue_value|
+        expect(
+          SEPA::Account.new :iban => invalue_value
+        ).to have_at_least(1).errors_on(:iban)
+      end
+    end
+  end
+
+  describe :bic do
+    it 'should accept valid value' do
+      [ 'DEUTDEFF', 'DEUTDEFF500', 'SPUEDE2UXXX' ].each do |value_value|
+        expect(
+          SEPA::Account.new :bic => value_value
+        ).to have(:no).errors_on(:bic)
+      end
+    end
+
+    it 'should not accept invalid value' do
+      [ nil, '', 'invalid' ].each do |invalue_value|
+        expect(
+          SEPA::Account.new :bic => invalue_value
+        ).to have_at_least(1).errors_on(:bic)
+      end
+    end
+  end
+end

data/spec/converter_spec.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe SEPA::Converter do
+  include SEPA::Converter::InstanceMethods
+
+  describe :convert_text do
+    it 'should remove invalid chars' do
+      convert_text('&@"=<>!').should == ''
+    end
+
+    it 'should not touch valid chars' do
+      convert_text("abc-ABC-0123- ':?,-(+.)/").should == "abc-ABC-0123- ':?,-(+.)/"
+    end
+
+    it 'should convert umlaute' do
+      convert_text('üöäÜÖÄß').should == 'ueoeaeUEOEAEss'
+    end
+
+    it 'should convert number' do
+      convert_text(1234).should == '1234'
+    end
+
+    it 'should not touch nil' do
+      convert_text(nil).should == nil
+    end
+  end
+
+  describe :convert_decimal do
+    it "should convert Integer to BigDecimal" do
+      convert_decimal(42).should == BigDecimal('42.00')
+    end
+
+    it "should convert Float to BigDecimal" do
+      convert_decimal(42.12).should == BigDecimal('42.12')
+    end
+
+    it 'should round' do
+      convert_decimal(1.345).should == BigDecimal('1.35')
+    end
+
+    it 'should not touch nil' do
+      convert_decimal(nil).should == nil
+    end
+  end
+end

data/spec/credit_transfer_spec.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe SEPA::CreditTransfer do
+  let(:credit_transfer) {
+    SEPA::CreditTransfer.new :name       => 'Schuldner GmbH',
+                             :bic        => 'BANKDEFFXXX',
+                             :iban       => 'DE87200500001234567890'
+  }
+
+  describe :new do
+    it 'should accept mission options' do
+      expect {
+        SEPA::CreditTransfer.new
+      }.to_not raise_error
+    end
+  end
+
+  describe :add_transaction do
+    it 'should add valid transactions' do
+      3.times {
+        credit_transfer.add_transaction :name                   => 'Telekomiker AG',
+                                        :bic                    => 'PBNKDEFF370',
+                                        :iban                   => 'DE37112589611964645802',
+                                        :amount                 => 102.50,
+                                        :reference              => 'XYZ-1234/123',
+                                        :remittance_information => 'Rechnung vom 22.08.2013'
+      }
+
+      expect(credit_transfer).to have(3).transactions
+    end
+
+    it 'should fail for invalid transaction' do
+      expect {
+        credit_transfer.add_transaction :name => ''
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe :to_xml do
+    it 'should fail for invalid debtor' do
+      expect {
+        SEPA::CreditTransfer.new.to_xml
+      }.to raise_error(RuntimeError)
+    end
+
+    it 'should create valid XML file' do
+      ct = credit_transfer
+
+      ct.add_transaction :name                   => 'Telekomiker AG',
+                         :bic                    => 'PBNKDEFF370',
+                         :iban                   => 'DE37112589611964645802',
+                         :amount                 => 102.50,
+                         :reference              => 'XYZ-1234/123',
+                         :remittance_information => 'Rechnung vom 22.08.2013'
+
+      ct.add_transaction :name                   => 'Amazonas GmbH',
+                         :bic                    => 'TUBDDEDDXXX',
+                         :iban                   => 'DE27793589132923472195',
+                         :amount                 => 59.00,
+                         :reference              => 'XYZ-5678/456',
+                         :remittance_information => 'Rechnung vom 21.08.2013'
+
+      expect(
+        XML::Document.string(ct.to_xml)
+      ).to validate_against('pain.001.002.03.xsd')
+    end
+  end
+end