sepa_king 0.0.7 → 0.1.0

data/lib/sepa_king/message/credit_transfer.rb

@@ -5,20 +5,15 @@ module SEPA
     self.account_class = DebtorAccount
     self.transaction_class = CreditTransferTransaction
     self.xml_main_tag = 'CstmrCdtTrfInitn'
+    self.known_schemas = [ PAIN_001_003_03, PAIN_001_002_03 ]
 
   private
-    # @return {Hash<Symbol=>String>} xml schema information used in output xml
-    def xml_schema
-      { :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' }
-    end
-
     # Find groups of transactions which share the same values of some attributes
     def grouped_transactions
       transactions.group_by do |transaction|
         { requested_date: transaction.requested_date,
-          batch_booking:  transaction.batch_booking
+          batch_booking:  transaction.batch_booking,
+          service_level:  transaction.service_level
         }
       end
     end
@@ -35,7 +30,7 @@ module SEPA
           builder.CtrlSum('%.2f' % amount_total(transactions))
           builder.PmtTpInf do
             builder.SvcLvl do
-              builder.Cd('SEPA')
+              builder.Cd(group[:service_level])
             end
           end
           builder.ReqdExctnDt(group[:requested_date].iso8601)
@@ -49,7 +44,13 @@ module SEPA
           end
           builder.DbtrAgt do
             builder.FinInstnId do
-              builder.BIC(account.bic)
+              if account.bic
+                builder.BIC(account.bic)
+              else
+                builder.Othr do
+                  builder.Id('NOTPROVIDED')
+                end
+              end
             end
           end
           builder.ChrgBr('SLEV')
@@ -69,9 +70,11 @@ module SEPA
         builder.Amt do
           builder.InstdAmt('%.2f' % transaction.amount, Ccy: 'EUR')
         end
-        builder.CdtrAgt do
-          builder.FinInstnId do
-            builder.BIC(transaction.bic)
+        if transaction.bic
+          builder.CdtrAgt do
+            builder.FinInstnId do
+              builder.BIC(transaction.bic)
+            end
           end
         end
         builder.Cdtr do

data/lib/sepa_king/message/direct_debit.rb

@@ -5,21 +5,15 @@ module SEPA
     self.account_class = CreditorAccount
     self.transaction_class = DirectDebitTransaction
     self.xml_main_tag = 'CstmrDrctDbtInitn'
+    self.known_schemas = [ PAIN_008_003_02, PAIN_008_002_02 ]
 
     validate do |record|
       if record.transactions.map(&:local_instrument).uniq.size > 1
-        errors.add(:base, 'CORE and B2B must not be mixed in one message!')
+        errors.add(:base, 'CORE, COR1 AND B2B must not be mixed in one message!')
       end
     end
 
   private
-    # @return {Hash<Symbol=>String>} xml schema information used in output xml
-    def xml_schema
-      { :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' }
-    end
-
     # Find groups of transactions which share the same values of some attributes
     def grouped_transactions
       transactions.group_by do |transaction|
@@ -61,7 +55,13 @@ module SEPA
           end
           builder.CdtrAgt do
             builder.FinInstnId do
-              builder.BIC(group[:account].bic)
+              if group[:account].bic
+                builder.BIC(group[:account].bic)
+              else
+                builder.Othr do
+                  builder.Id('NOTPROVIDED')
+                end
+              end
             end
           end
           builder.ChrgBr('SLEV')
@@ -99,7 +99,13 @@ module SEPA
         end
         builder.DbtrAgt do
           builder.FinInstnId do
-            builder.BIC(transaction.bic)
+            if transaction.bic
+              builder.BIC(transaction.bic)
+            else
+              builder.Othr do
+                builder.Id('NOTPROVIDED')
+              end
+            end
           end
         end
         builder.Dbtr do

data/lib/sepa_king/message.rb

@@ -1,6 +1,11 @@
 # encoding: utf-8
 
 module SEPA
+  PAIN_008_002_02 = 'pain.008.002.02'
+  PAIN_008_003_02 = 'pain.008.003.02'
+  PAIN_001_002_03 = 'pain.001.002.03'
+  PAIN_001_003_03 = 'pain.001.003.03'
+
   class Message
     include ActiveModel::Validations
 
@@ -11,7 +16,7 @@ module SEPA
       record.errors.add(:account, 'is invalid') unless record.account.valid?
     end
 
-    class_attribute :account_class, :transaction_class, :xml_main_tag
+    class_attribute :account_class, :transaction_class, :xml_main_tag, :known_schemas
 
     def initialize(account_options={})
       @transactions = []
@@ -25,12 +30,13 @@ module SEPA
     end
 
     # @return [String] xml
-    def to_xml
+    def to_xml(schema_name=self.known_schemas.first)
       raise RuntimeError.new(errors.full_messages.join("\n")) unless valid?
+      raise RuntimeError.new("Incompatible with schema #{schema_name}!") unless schema_compatible?(schema_name)
 
       builder = Builder::XmlMarkup.new indent: 2
       builder.instruct!
-      builder.Document(xml_schema) do
+      builder.Document(xml_schema(schema_name)) do
         builder.__send__(xml_main_tag) do
           build_group_header(builder)
           build_payment_informations(builder)
@@ -42,7 +48,25 @@ module SEPA
       selected_transactions.inject(0) { |sum, t| sum + t.amount }
     end
 
+    def schema_compatible?(schema_name)
+      raise ArgumentError.new("Schema #{schema_name} is unknown!") unless self.known_schemas.include?(schema_name)
+
+      case schema_name
+        when PAIN_001_002_03, PAIN_008_002_02
+          account.bic.present? && transactions.all? { |t| t.schema_compatible?(schema_name) }
+        when PAIN_001_003_03, PAIN_008_003_02
+          transactions.all? { |t| t.schema_compatible?(schema_name) }
+      end
+    end
+
   private
+    # @return {Hash<Symbol=>String>} xml schema information used in output xml
+    def xml_schema(schema_name)
+      { :xmlns                => "urn:iso:std:iso:20022:tech:xsd:#{schema_name}",
+        :'xmlns:xsi'          => 'http://www.w3.org/2001/XMLSchema-instance',
+        :'xsi:schemaLocation' => "urn:iso:std:iso:20022:tech:xsd:#{schema_name} #{schema_name}.xsd" }
+    end
+
     def build_group_header(builder)
       builder.GrpHdr do
         builder.MsgId(message_identification)

data/lib/sepa_king/transaction/credit_transfer_transaction.rb

@@ -1,5 +1,22 @@
 # encoding: utf-8
 module SEPA
   class CreditTransferTransaction < Transaction
+    attr_accessor :service_level
+
+    validates_inclusion_of :service_level, :in => %w(SEPA URGP)
+
+    def initialize(attributes = {})
+      super
+      self.service_level ||= 'SEPA'
+    end
+
+    def schema_compatible?(schema_name)
+      case schema_name
+      when PAIN_001_002_03
+        self.bic.present? && self.service_level == 'SEPA'
+      when PAIN_001_003_03
+        true
+      end
+    end
   end
 end

data/lib/sepa_king/transaction/direct_debit_transaction.rb

@@ -5,7 +5,7 @@ module SEPA
 
     validates_length_of :mandate_id, within: 1..35
     validates_presence_of :mandate_date_of_signature
-    validates_inclusion_of :local_instrument, :in => %w(CORE B2B)
+    validates_inclusion_of :local_instrument, :in => %w(CORE COR1 B2B)
     validates_inclusion_of :sequence_type, :in => %w(FRST OOFF RCUR FNAL)
 
     validate do |t|
@@ -25,5 +25,14 @@ module SEPA
       self.local_instrument ||= 'CORE'
       self.sequence_type ||= 'OOFF'
     end
+
+    def schema_compatible?(schema_name)
+      case schema_name
+      when PAIN_008_002_02
+        self.bic.present? && %w(CORE B2B).include?(self.local_instrument)
+      when PAIN_008_003_02
+        true
+      end
+    end
   end
 end

data/lib/sepa_king/validator.rb

@@ -3,15 +3,17 @@ module SEPA
   class IBANValidator < ActiveModel::Validator
     def validate(record)
       unless IBANTools::IBAN.valid?(record.iban.to_s)
-        record.errors.add(:iban, 'is invalid')
+        record.errors.add(:iban, :invalid)
       end
     end
   end
 
   class BICValidator < ActiveModel::Validator
     def validate(record)
-      unless record.bic.to_s.match /[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}/
-        record.errors.add(:bic, 'is invalid')
+      if record.bic
+        unless record.bic.to_s.match /[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}/
+          record.errors.add(:bic, :invalid)
+        end
       end
     end
   end
@@ -19,7 +21,7 @@ module SEPA
   class CreditorIdentifierValidator < ActiveModel::Validator
     def validate(record)
       unless valid?(record.creditor_identifier)
-        record.errors.add(:creditor_identifier, 'is invalid')
+        record.errors.add(:creditor_identifier, :invalid)
       end
     end
 

data/lib/sepa_king/version.rb

@@ -1,3 +1,3 @@
 module SEPA
-  VERSION = '0.0.7'
+  VERSION = '0.1.0'
 end

data/spec/account_spec.rb

@@ -36,7 +36,7 @@ describe SEPA::Account do
     end
 
     it 'should not accept invalid value' do
-      SEPA::Account.should_not accept(nil, '', 'invalid', for: :bic)
+      SEPA::Account.should_not accept('', 'invalid', for: :bic)
     end
   end
 end

data/spec/converter_spec.rb

@@ -17,6 +17,13 @@ describe SEPA::Converter do
       convert_text('üöäÜÖÄß').should == 'ueoeaeUEOEAEss'
     end
 
+    it 'should convert line breaks' do
+      convert_text("one\ntwo")    .should == 'one two'
+      convert_text("one\ntwo\n")  .should == 'one two'
+      convert_text("\none\ntwo\n").should == 'one two'
+      convert_text("one\n\ntwo")  .should == 'one two'
+    end
+
     it 'should convert number' do
       convert_text(1234).should == '1234'
     end

data/spec/credit_transfer_spec.rb

@@ -42,6 +42,55 @@ describe SEPA::CreditTransfer do
     end
 
     context 'for valid debtor' do
+      context 'without BIC (IBAN-only)' do
+        subject do
+          sct = SEPA::CreditTransfer.new name:       'Schuldner GmbH',
+                                         iban:       'DE87200500001234567890'
+
+          sct.add_transaction name:                   'Telekomiker AG',
+                              bic:                    'PBNKDEFF370',
+                              iban:                   'DE37112589611964645802',
+                              amount:                 102.50,
+                              reference:              'XYZ-1234/123',
+                              remittance_information: 'Rechnung vom 22.08.2013'
+
+          sct
+        end
+
+        it 'should create valid XML file' do
+          expect(subject.to_xml).to validate_against('pain.001.003.03.xsd')
+        end
+
+        it 'should fail for pain.001.002.03' do
+          expect {
+            subject.to_xml(SEPA::PAIN_001_002_03)
+          }.to raise_error(RuntimeError)
+        end
+      end
+
+      context 'with BIC' do
+        subject do
+          sct = credit_transfer
+
+          sct.add_transaction name:                   'Telekomiker AG',
+                              bic:                    'PBNKDEFF370',
+                              iban:                   'DE37112589611964645802',
+                              amount:                 102.50,
+                              reference:              'XYZ-1234/123',
+                              remittance_information: 'Rechnung vom 22.08.2013'
+
+          sct
+        end
+
+        it 'should validate against pain.001.002.03' do
+          expect(subject.to_xml('pain.001.002.03')).to validate_against('pain.001.002.03.xsd')
+        end
+
+        it 'should validate against pain.001.003.03' do
+          expect(subject.to_xml('pain.001.003.03')).to validate_against('pain.001.003.03.xsd')
+        end
+      end
+
       context 'without requested_date given' do
         subject do
           sct = credit_transfer
@@ -54,7 +103,6 @@ describe SEPA::CreditTransfer do
                               remittance_information: 'Rechnung vom 22.08.2013'
 
           sct.add_transaction name:                   'Amazonas GmbH',
-                              bic:                    'TUBDDEDDXXX',
                               iban:                   'DE27793589132923472195',
                               amount:                 59.00,
                               reference:              'XYZ-5678/456',
@@ -64,7 +112,7 @@ describe SEPA::CreditTransfer do
         end
 
         it 'should create valid XML file' do
-          expect(subject).to validate_against('pain.001.002.03.xsd')
+          expect(subject).to validate_against('pain.001.003.03.xsd')
         end
 
         it 'should have message_identification' do
@@ -117,9 +165,9 @@ describe SEPA::CreditTransfer do
           subject.should have_xml('//Document/CstmrCdtTrfInitn/PmtInf/CdtTrfTxInf[2]/Amt/InstdAmt', '59.00')
         end
 
-        it 'should contain <CdtrAgt>' do
+        it 'should contain <CdtrAgt> for every BIC given' do
           subject.should have_xml('//Document/CstmrCdtTrfInitn/PmtInf/CdtTrfTxInf[1]/CdtrAgt/FinInstnId/BIC', 'PBNKDEFF370')
-          subject.should have_xml('//Document/CstmrCdtTrfInitn/PmtInf/CdtTrfTxInf[2]/CdtrAgt/FinInstnId/BIC', 'TUBDDEDDXXX')
+          subject.should_not have_xml('//Document/CstmrCdtTrfInitn/PmtInf/CdtTrfTxInf[2]/CdtrAgt')
         end
 
         it 'should contain <Cdtr>' do

data/spec/credit_transfer_transaction_spec.rb

@@ -2,14 +2,35 @@
 require 'spec_helper'
 
 describe SEPA::CreditTransferTransaction do
-  it 'should initialize a new transaction' do
-    expect(
-      SEPA::CreditTransferTransaction.new name:                   'Telekomiker AG',
-                                          iban:                   'DE37112589611964645802',
-                                          bic:                    'PBNKDEFF370',
-                                          amount:                 102.50,
-                                          reference:              'XYZ-1234/123',
-                                          remittance_information: 'Rechnung 123 vom 22.08.2013'
-    ).to be_valid
+  describe :initialize do
+    it 'should initialize a valid transaction' do
+      expect(
+        SEPA::CreditTransferTransaction.new name:                   'Telekomiker AG',
+                                            iban:                   'DE37112589611964645802',
+                                            bic:                    'PBNKDEFF370',
+                                            amount:                 102.50,
+                                            reference:              'XYZ-1234/123',
+                                            remittance_information: 'Rechnung 123 vom 22.08.2013'
+      ).to be_valid
+    end
+  end
+
+  describe :schema_compatible? do
+    context 'for pain.001.003.03' do
+      it 'should success' do
+        SEPA::CreditTransferTransaction.new({}).should be_schema_compatible('pain.001.003.03')
+      end
+    end
+
+    context 'pain.001.002.03' do
+      it 'should success for valid attributes' do
+        SEPA::CreditTransferTransaction.new(:bic => 'SPUEDE2UXXX', :service_level => 'SEPA').should be_schema_compatible('pain.001.002.03')
+      end
+
+      it 'should fail for invalid attributes' do
+        SEPA::CreditTransferTransaction.new(:bic => nil).should_not be_schema_compatible('pain.001.002.03')
+        SEPA::CreditTransferTransaction.new(:bic => 'SPUEDE2UXXX', :service_level => 'URGP').should_not be_schema_compatible('pain.001.002.03')
+      end
+    end
   end
 end

data/spec/direct_debit_spec.rb

@@ -43,6 +43,60 @@ describe SEPA::DirectDebit do
     end
 
     context 'for valid creditor' do
+      context 'without BIC (IBAN-only)' do
+        subject do
+          sdd = SEPA::DirectDebit.new name:                'Gläubiger GmbH',
+                                      iban:                'DE87200500001234567890',
+                                      creditor_identifier: 'DE98ZZZ09999999999'
+
+          sdd.add_transaction name:                      'Zahlemann & Söhne GbR',
+                              bic:                       'SPUEDE2UXXX',
+                              iban:                      'DE21500500009876543210',
+                              amount:                    39.99,
+                              reference:                 'XYZ/2013-08-ABO/12345',
+                              remittance_information:    'Unsere Rechnung vom 10.08.2013',
+                              mandate_id:                'K-02-2011-12345',
+                              mandate_date_of_signature: Date.new(2011,1,25)
+
+          sdd
+        end
+
+        it 'should create valid XML file' do
+          expect(subject.to_xml).to validate_against('pain.008.003.02.xsd')
+        end
+
+        it 'should fail for pain.008.002.02' do
+          expect {
+            subject.to_xml(SEPA::PAIN_008_002_02)
+          }.to raise_error(RuntimeError)
+        end
+      end
+
+      context 'with BIC' do
+        subject do
+          sdd = direct_debit
+
+          sdd.add_transaction name:                      'Zahlemann & Söhne GbR',
+                              bic:                       'SPUEDE2UXXX',
+                              iban:                      'DE21500500009876543210',
+                              amount:                    39.99,
+                              reference:                 'XYZ/2013-08-ABO/12345',
+                              remittance_information:    'Unsere Rechnung vom 10.08.2013',
+                              mandate_id:                'K-02-2011-12345',
+                              mandate_date_of_signature: Date.new(2011,1,25)
+
+          sdd
+        end
+
+        it 'should validate against pain.008.002.02' do
+          expect(subject.to_xml('pain.008.002.02')).to validate_against('pain.008.002.02.xsd')
+        end
+
+        it 'should validate against pain.008.003.02' do
+          expect(subject.to_xml('pain.008.003.02')).to validate_against('pain.008.003.02.xsd')
+        end
+      end
+
       context 'without requested_date given' do
         subject do
           sdd = direct_debit
@@ -57,7 +111,6 @@ describe SEPA::DirectDebit do
                               mandate_date_of_signature: Date.new(2011,1,25)
 
           sdd.add_transaction name:                      'Meier & Schulze oHG',
-                              bic:                       'GENODEF1JEV',
                               iban:                      'DE68210501700012345678',
                               amount:                    750.00,
                               reference:                 'XYZ/2013-08-ABO/6789',
@@ -69,7 +122,7 @@ describe SEPA::DirectDebit do
         end
 
         it 'should create valid XML file' do
-          expect(subject).to validate_against('pain.008.002.02.xsd')
+          expect(subject).to validate_against('pain.008.003.02.xsd')
         end
 
         it 'should have message_identification' do
@@ -138,7 +191,7 @@ describe SEPA::DirectDebit do
 
         it 'should contain <DbtrAgt>' do
           subject.should have_xml('//Document/CstmrDrctDbtInitn/PmtInf/DrctDbtTxInf[1]/DbtrAgt/FinInstnId/BIC', 'SPUEDE2UXXX')
-          subject.should have_xml('//Document/CstmrDrctDbtInitn/PmtInf/DrctDbtTxInf[2]/DbtrAgt/FinInstnId/BIC', 'GENODEF1JEV')
+          subject.should have_xml('//Document/CstmrDrctDbtInitn/PmtInf/DrctDbtTxInf[2]/DbtrAgt/FinInstnId/Othr/Id', 'NOTPROVIDED')
         end
 
         it 'should contain <Dbtr>' do

data/spec/direct_debit_transaction_spec.rb

@@ -2,17 +2,38 @@
 require 'spec_helper'
 
 describe SEPA::DirectDebitTransaction do
-  it 'should initialize a new transaction' do
-    expect(
-      SEPA::DirectDebitTransaction.new name:                      'Zahlemann & Söhne Gbr',
-                                       bic:                       'SPUEDE2UXXX',
-                                       iban:                      'DE21500500009876543210',
-                                       amount:                    39.99,
-                                       reference:                 'XYZ-1234/123',
-                                       remittance_information:    'Vielen Dank für Ihren Einkauf!',
-                                       mandate_id:                'K-02-2011-12345',
-                                       mandate_date_of_signature: Date.new(2011,1,25)
-    ).to be_valid
+  describe :initialize do
+    it 'should create a valid transaction' do
+      expect(
+        SEPA::DirectDebitTransaction.new name:                      'Zahlemann & Söhne Gbr',
+                                         bic:                       'SPUEDE2UXXX',
+                                         iban:                      'DE21500500009876543210',
+                                         amount:                    39.99,
+                                         reference:                 'XYZ-1234/123',
+                                         remittance_information:    'Vielen Dank für Ihren Einkauf!',
+                                         mandate_id:                'K-02-2011-12345',
+                                         mandate_date_of_signature: Date.new(2011,1,25)
+      ).to be_valid
+    end
+  end
+
+  describe :schema_compatible? do
+    context 'for pain.008.003.02' do
+      it 'should success' do
+        SEPA::DirectDebitTransaction.new({}).should be_schema_compatible('pain.008.003.02')
+      end
+    end
+
+    context 'for pain.008.002.02' do
+      it 'should success for valid attributes' do
+        SEPA::DirectDebitTransaction.new(:bic => 'SPUEDE2UXXX', :local_instrument => 'CORE').should be_schema_compatible('pain.008.002.02')
+      end
+
+      it 'should fail for invalid attributes' do
+        SEPA::DirectDebitTransaction.new(:bic => nil).should_not be_schema_compatible('pain.008.002.02')
+        SEPA::DirectDebitTransaction.new(:bic => 'SPUEDE2UXXX', :local_instrument => 'COR1').should_not be_schema_compatible('pain.008.002.02')
+      end
+    end
   end
 
   context 'Mandate Date of Signature' do