sepa_king 0.0.2

data/lib/sepa_king/credit_transaction.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+module SEPA
+  class CreditTransaction
+    include TextConverter
+    attr_reader :name, :iban, :bic, :amount, :reference, :remittance_information
+
+    def initialize(options)
+      options.each_pair do |k,v|
+        send("#{k}=", v)
+      end
+    end
+
+    def name=(value)
+      raise ArgumentError.new('Name is missing') unless value
+      @name = convert_text(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
+
+    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
+      @amount = value
+    end
+
+    def reference=(value)
+      raise ArgumentError.new('Reference is missing') unless value
+      raise ArgumentError.new("Reference has wrong length: #{value.length}, must be 35 maximum") if value.length > 35
+      @reference = convert_text(value)
+    end
+
+    def remittance_information=(value)
+      raise ArgumentError.new('Remittance information is missing') unless value
+      @remittance_information = convert_text(value)
+    end
+  end
+end

data/lib/sepa_king/credit_transfer_initiation.rb

@@ -0,0 +1,102 @@
+# encoding: utf-8
+
+module SEPA
+  class CreditTransferInitiation
+    attr_reader :debitor, :transactions
+
+    def initialize(debitor_options)
+      @debitor = Account.new(debitor_options)
+      @transactions = []
+    end
+
+    def add_transaction(options)
+      @transactions << CreditTransaction.new(options)
+    end
+
+    def to_xml
+      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
+          builder.GrpHdr do
+            builder.MsgId(message_identification)
+            builder.CreDtTm(Time.now.iso8601)
+            builder.NbOfTxs(transactions.length)
+            builder.InitgPty do
+              builder.Nm(debitor.name)
+            end
+          end
+
+          builder.PmtInf do
+            builder.PmtInfId(payment_information_identification)
+            builder.PmtMtd('TRF')
+            builder.BtchBookg(true)
+            builder.NbOfTxs(transactions.length)
+            builder.CtrlSum(amount_total)
+            builder.PmtTpInf do
+              builder.SvcLvl do
+                builder.Cd('SEPA')
+              end
+            end
+            builder.ReqdExctnDt(Date.today.next.iso8601)
+            builder.Dbtr do
+              builder.Nm(debitor.name)
+            end
+            builder.DbtrAcct do
+              builder.Id do
+                builder.IBAN(debitor.iban)
+              end
+            end
+            builder.DbtrAgt do
+              builder.FinInstnId do
+                builder.BIC(debitor.bic)
+              end
+            end
+            builder.ChrgBr('SLEV')
+            transactions.each do |transaction|
+              builder.CdtTrfTxInf do
+                builder.PmtId do
+                  builder.EndToEndId(transaction.reference || 'NOTPROVIDED')
+                end
+                builder.Amt do
+                  builder.InstdAmt(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
+                builder.RmtInf do
+                  builder.Ustrd(transaction.remittance_information)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+  private
+    def amount_total
+      transactions.inject(0) { |sum, t| sum + t.amount }
+    end
+
+    def message_identification
+      "SEPA-KING/#{Time.now.iso8601}"
+    end
+
+    def payment_information_identification
+      message_identification
+    end
+  end
+end

data/lib/sepa_king/debt_transaction.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+module SEPA
+  class DebtTransaction
+    include TextConverter
+    attr_reader :name, :iban, :bic, :amount, :reference, :mandate_id, :mandate_date_of_signature
+
+    def initialize(options)
+      options.each_pair do |k,v|
+        send("#{k}=", v)
+      end
+    end
+
+    def name=(value)
+      raise ArgumentError.new('Name is missing') unless value
+      @name = convert_text(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
+
+    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
+      @amount = value
+    end
+
+    def reference=(value)
+      raise ArgumentError.new('Reference is missing') unless value
+      raise ArgumentError.new("Reference has wrong length: #{value.length}, must be 35 maximum") if value.length > 35
+      @reference = convert_text(value)
+    end
+
+    def mandate_id=(value)
+      raise ArgumentError.new('Mandate ID is missing') unless value
+      @mandate_id = convert_text(value)
+    end
+
+    def mandate_date_of_signature=(value)
+      raise ArgumentError.new('Mandate Date of Signature is missing') unless value.is_a?(Date)
+      @mandate_date_of_signature = value
+    end
+  end
+end

data/lib/sepa_king/direct_debit_initiation.rb

@@ -0,0 +1,117 @@
+# encoding: utf-8
+
+module SEPA
+  class DirectDebitInitiation
+    attr_reader :creditor, :transactions
+
+    def initialize(creditor_options)
+      @creditor = Account.new(creditor_options)
+      @transactions = []
+    end
+
+    def add_transaction(options)
+      @transactions << DebtTransaction.new(options)
+    end
+
+    def to_xml
+      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
+          builder.GrpHdr do
+            builder.MsgId(message_identification)
+            builder.CreDtTm(Time.now.iso8601)
+            builder.NbOfTxs(transactions.length)
+            builder.CtrlSum(amount_total)
+            builder.InitgPty do
+              builder.Nm(creditor.name)
+            end
+          end
+
+          builder.PmtInf do
+            builder.PmtInfId(payment_information_identification)
+            builder.PmtMtd('DD')
+            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(creditor.name)
+            end
+            builder.CdtrAcct do
+              builder.Id do
+                builder.IBAN(creditor.iban)
+              end
+            end
+            builder.CdtrAgt do
+              builder.FinInstnId do
+                builder.BIC(creditor.bic)
+              end
+            end
+            builder.ChrgBr('SLEV')
+            builder.CdtrSchmeId do
+              builder.Id do
+                builder.PrvtId do
+                  builder.Othr do
+                    builder.Id(creditor.identifier)
+                    builder.SchmeNm do
+                      builder.Prtry('SEPA')
+                    end
+                  end
+                end
+              end
+            end
+            transactions.each do |transaction|
+              builder.DrctDbtTxInf do
+                builder.PmtId do
+                  builder.EndToEndId(transaction.reference || 'NOTPROVIDED')
+                end
+                builder.InstdAmt(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
+              end
+            end
+          end
+        end
+      end
+    end
+
+  private
+    def amount_total
+      transactions.inject(0) { |sum, t| sum + t.amount }
+    end
+
+    def message_identification
+      "SEPA-KING/#{Time.now.iso8601}"
+    end
+
+    def payment_information_identification
+      message_identification
+    end
+  end
+end

data/lib/sepa_king/exception.rb

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

data/lib/sepa_king/text_converter.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module SEPA
+  module TextConverter
+    def convert_text(text)
+      text = text.to_s
+      return text if text.empty?
+
+      text = text.
+        # 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
+  end
+end

data/lib/sepa_king/version.rb

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

data/lib/sepa_king.rb

@@ -0,0 +1,11 @@
+require 'i18n'
+require 'bigdecimal'
+require 'builder'
+
+require 'sepa_king/text_converter'
+require 'sepa_king/account'
+require 'sepa_king/debt_transaction'
+require 'sepa_king/credit_transaction'
+require 'sepa_king/exception'
+require 'sepa_king/direct_debit_initiation'
+require 'sepa_king/credit_transfer_initiation'

data/sepa_king.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'sepa_king/version'
+
+Gem::Specification.new do |s|
+  s.name = %q{sepa_king}
+  s.version = SEPA::VERSION
+
+  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
+  s.authors = ['Georg Leciejewski', 'Georg Ledermann']
+  s.date = %q{2013-08-10}
+  s.summary = %q{Generate SEPA XML files with Ruby .. the easy way}
+  s.description = %q{}
+  s.email = %q{gl@salesking.eu}
+  s.extra_rdoc_files = ['README.markdown']
+  s.executables   = nil
+  s.files         = `git ls-files`.split("\n").reject{|i| i[/^docs\//] }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.homepage = %q{http://github.com/salesking/sepa_king}
+  s.require_paths = ['lib']
+  s.rubygems_version = %q{1.6.2}
+
+  s.add_runtime_dependency 'i18n'
+  s.add_runtime_dependency 'builder'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'rake', '>= 0.9.2'
+  s.add_development_dependency 'libxml-ruby'
+end

data/spec/fixtures/pain.001.002.03.xml

@@ -0,0 +1,89 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Mit XMLSpy v2008 rel. 2 sp2 (http://www.altova.com) von benutzerservice benutzerservice (SIZ GmbH) bearbeitet -->
+<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">
+  <CstmrCdtTrfInitn>
+    <GrpHdr>
+      <MsgId>Message-ID-4711</MsgId>
+      <CreDtTm>2010-11-11T09:30:47.000Z</CreDtTm>
+      <NbOfTxs>2</NbOfTxs>
+      <InitgPty>
+        <Nm>Initiator Name</Nm>
+      </InitgPty>
+    </GrpHdr>
+    <PmtInf>
+      <PmtInfId>Payment-Information-ID-4711</PmtInfId>
+      <PmtMtd>TRF</PmtMtd>
+      <BtchBookg>true</BtchBookg>
+      <NbOfTxs>2</NbOfTxs>
+      <CtrlSum>6655.86</CtrlSum>
+      <PmtTpInf>
+        <SvcLvl>
+          <Cd>SEPA</Cd>
+        </SvcLvl>
+      </PmtTpInf>
+      <ReqdExctnDt>2010-11-25</ReqdExctnDt>
+      <Dbtr>
+        <Nm>Debtor Name</Nm>
+      </Dbtr>
+      <DbtrAcct>
+        <Id>
+          <IBAN>DE87200500001234567890</IBAN>
+        </Id>
+      </DbtrAcct>
+      <DbtrAgt>
+        <FinInstnId>
+          <BIC>BANKDEFFXXX</BIC>
+        </FinInstnId>
+      </DbtrAgt>
+      <ChrgBr>SLEV</ChrgBr>
+      <CdtTrfTxInf>
+        <PmtId>
+          <EndToEndId>OriginatorID1234</EndToEndId>
+        </PmtId>
+        <Amt>
+          <InstdAmt Ccy="EUR">6543.14</InstdAmt>
+        </Amt>
+        <CdtrAgt>
+          <FinInstnId>
+            <BIC>SPUEDE2UXXX</BIC>
+          </FinInstnId>
+        </CdtrAgt>
+        <Cdtr>
+          <Nm>Creditor Name</Nm>
+        </Cdtr>
+        <CdtrAcct>
+          <Id>
+            <IBAN>DE21500500009876543210</IBAN>
+          </Id>
+        </CdtrAcct>
+        <RmtInf>
+          <Ustrd>Unstructured Remittance Information</Ustrd>
+        </RmtInf>
+      </CdtTrfTxInf>
+      <CdtTrfTxInf>
+        <PmtId>
+          <EndToEndId>OriginatorID1235</EndToEndId>
+        </PmtId>
+        <Amt>
+          <InstdAmt Ccy="EUR">112.72</InstdAmt>
+        </Amt>
+        <CdtrAgt>
+          <FinInstnId>
+            <BIC>SPUEDE2UXXX</BIC>
+          </FinInstnId>
+        </CdtrAgt>
+        <Cdtr>
+          <Nm>Other Creditor Name</Nm>
+        </Cdtr>
+        <CdtrAcct>
+          <Id>
+            <IBAN>DE21500500001234567897</IBAN>
+          </Id>
+        </CdtrAcct>
+        <RmtInf>
+          <Ustrd>Unstructured Remittance Information</Ustrd>
+        </RmtInf>
+      </CdtTrfTxInf>
+    </PmtInf>
+  </CstmrCdtTrfInitn>
+</Document>

data/spec/fixtures/pain.008.002.02.xml

@@ -0,0 +1,134 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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">
+  <CstmrDrctDbtInitn>
+    <GrpHdr>
+      <MsgId>Message-ID</MsgId>
+      <CreDtTm>2010-11-21T09:30:47.000Z</CreDtTm>
+      <NbOfTxs>2</NbOfTxs>
+      <InitgPty>
+        <Nm>Initiator Name</Nm>
+      </InitgPty>
+    </GrpHdr>
+    <PmtInf>
+      <PmtInfId>Payment-ID</PmtInfId>
+      <PmtMtd>DD</PmtMtd>
+      <NbOfTxs>2</NbOfTxs>
+      <CtrlSum>6655.86</CtrlSum>
+      <PmtTpInf>
+        <SvcLvl>
+          <Cd>SEPA</Cd>
+        </SvcLvl>
+        <LclInstrm>
+          <Cd>CORE</Cd>
+        </LclInstrm>
+        <SeqTp>FRST</SeqTp>
+      </PmtTpInf>
+      <ReqdColltnDt>2010-12-03</ReqdColltnDt>
+      <Cdtr>
+        <Nm>Creditor Name</Nm>
+      </Cdtr>
+      <CdtrAcct>
+        <Id>
+          <IBAN>DE87200500001234567890</IBAN>
+        </Id>
+      </CdtrAcct>
+      <CdtrAgt>
+        <FinInstnId>
+          <BIC>BANKDEFFXXX</BIC>
+        </FinInstnId>
+      </CdtrAgt>
+      <ChrgBr>SLEV</ChrgBr>
+      <CdtrSchmeId>
+        <Id>
+          <PrvtId>
+            <Othr>
+              <Id>DE00ZZZ00099999999</Id>
+              <SchmeNm>
+                <Prtry>SEPA</Prtry>
+              </SchmeNm>
+            </Othr>
+          </PrvtId>
+        </Id>
+      </CdtrSchmeId>
+      <DrctDbtTxInf>
+        <PmtId>
+          <EndToEndId>OriginatorID1234</EndToEndId>
+        </PmtId>
+        <InstdAmt Ccy="EUR">6543.14</InstdAmt>
+        <DrctDbtTx>
+          <MndtRltdInf>
+            <MndtId>Mandate-Id</MndtId>
+            <DtOfSgntr>2010-11-20</DtOfSgntr>
+            <AmdmntInd>true</AmdmntInd>
+            <AmdmntInfDtls>
+              <OrgnlCdtrSchmeId>
+                <Nm>Original Creditor Name</Nm>
+                <Id>
+                  <PrvtId>
+                    <Othr>
+                      <Id>AA00ZZZOriginalCreditorID</Id>
+                      <SchmeNm>
+                        <Prtry>SEPA</Prtry>
+                      </SchmeNm>
+                    </Othr>
+                  </PrvtId>
+                </Id>
+              </OrgnlCdtrSchmeId>
+            </AmdmntInfDtls>
+          </MndtRltdInf>
+        </DrctDbtTx>
+        <DbtrAgt>
+          <FinInstnId>
+            <BIC>SPUEDE2UXXX</BIC>
+          </FinInstnId>
+        </DbtrAgt>
+        <Dbtr>
+          <Nm>Debtor Name</Nm>
+        </Dbtr>
+        <DbtrAcct>
+          <Id>
+            <IBAN>DE21500500009876543210</IBAN>
+          </Id>
+        </DbtrAcct>
+        <UltmtDbtr>
+          <Nm>Ultimate Debtor Name</Nm>
+        </UltmtDbtr>
+        <RmtInf>
+          <Ustrd>Unstructured Remittance Information</Ustrd>
+        </RmtInf>
+      </DrctDbtTxInf>
+      <DrctDbtTxInf>
+        <PmtId>
+          <EndToEndId>OriginatorID1235</EndToEndId>
+        </PmtId>
+        <InstdAmt Ccy="EUR">112.72</InstdAmt>
+        <DrctDbtTx>
+          <MndtRltdInf>
+            <MndtId>Other-Mandate-Id</MndtId>
+            <DtOfSgntr>2010-11-20</DtOfSgntr>
+            <AmdmntInd>false</AmdmntInd>
+          </MndtRltdInf>
+        </DrctDbtTx>
+        <DbtrAgt>
+          <FinInstnId>
+            <BIC>SPUEDE2UXXX</BIC>
+          </FinInstnId>
+        </DbtrAgt>
+        <Dbtr>
+          <Nm>Other Debtor Name</Nm>
+        </Dbtr>
+        <DbtrAcct>
+          <Id>
+            <IBAN>DE21500500001234567897</IBAN>
+          </Id>
+        </DbtrAcct>
+        <UltmtDbtr>
+          <Nm>Ultimate Debtor Name</Nm>
+        </UltmtDbtr>
+        <RmtInf>
+          <Ustrd>Unstructured Remittance Information</Ustrd>
+        </RmtInf>
+      </DrctDbtTxInf>
+    </PmtInf>
+  </CstmrDrctDbtInitn>
+</Document>

data/spec/sepa_king/account_spec.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe SEPA::Account do
+  it 'should initialize a new account' do
+    lambda{
+      SEPA::Account.new :name       => 'Gläubiger GmbH',
+                        :bic        => 'BANKDEFFXXX',
+                        :iban       => 'DE87200500001234567890',
+                        :identifier => 'DE98ZZZ09999999999'
+    }.should_not raise_error
+  end
+end

data/spec/sepa_king/credit_transaction_spec.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe SEPA::CreditTransaction do
+  it 'should initialize a new transaction' do
+    lambda{
+      SEPA::CreditTransaction.new :name                   => 'Telekomiker AG',
+                                  :iban                   => 'DE37112589611964645802',
+                                  :bic                    => 'PBNKDEFF370',
+                                  :amount                 => 102.50,
+                                  :reference              => 'XYZ-1234/123',
+                                  :remittance_information => 'Rechnung 123 vom 22.08.2013'
+    }.should_not raise_error
+  end
+end

data/spec/sepa_king/credit_transfer_initiation_spec.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe SEPA::CreditTransferInitiation do
+  it 'should create valid XML file' do
+    cti = SEPA::CreditTransferInitiation.new :name       => 'Schuldner GmbH',
+                                             :bic        => 'BANKDEFFXXX',
+                                             :iban       => 'DE87200500001234567890',
+                                             :identifier => 'DE98ZZZ09999999999'
+
+    cti.add_transaction :name                   => 'Telekomiker AG',
+                        :iban                   => 'DE37112589611964645802',
+                        :bic                    => 'PBNKDEFF370',
+                        :amount                 => 102.50,
+                        :reference              => 'XYZ-1234/123',
+                        :remittance_information => 'Rechnung vom 22.08.2013'
+
+    cti.add_transaction :name                   => 'Amazonas GmbH',
+                        :iban                   => 'DE27793589132923472195',
+                        :bic                    => 'TUBDDEDDXXX',
+                        :amount                 => 59.00,
+                        :reference              => 'XYZ-5678/456',
+                        :remittance_information => 'Rechnung om 21.08.2013'
+
+    XML::Document.string(cti.to_xml).should validate_against('pain.001.002.03.xsd')
+  end
+end