sepa_king 0.11.1 → 0.13.0

data/lib/sepa_king/message/credit_transfer.rb

@@ -5,7 +5,7 @@ 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, PAIN_001_001_03 ]
+    self.known_schemas = [ PAIN_001_001_03, PAIN_001_001_03_CH_02, PAIN_001_003_03, PAIN_001_002_03 ]
 
   private
     # Find groups of transactions which share the same values of some attributes
@@ -59,7 +59,9 @@ module SEPA
               end
             end
           end
-          builder.ChrgBr('SLEV')
+          if group[:service_level]
+            builder.ChrgBr('SLEV')
+          end
 
           transactions.each do |transaction|
             build_transaction(builder, transaction)

data/lib/sepa_king/message/direct_debit.rb

@@ -5,7 +5,7 @@ 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, PAIN_008_001_02 ]
+    self.known_schemas = [ PAIN_008_001_02, PAIN_008_003_02, PAIN_008_002_02 ]
 
     validate do |record|
       if record.transactions.map(&:local_instrument).uniq.size > 1

data/lib/sepa_king/message.rb

@@ -7,6 +7,7 @@ module SEPA
   PAIN_001_001_03 = 'pain.001.001.03'
   PAIN_001_002_03 = 'pain.001.002.03'
   PAIN_001_003_03 = 'pain.001.003.03'
+  PAIN_001_001_03_CH_02 = 'pain.001.001.03.ch.02'
 
   class Message
     include ActiveModel::Validations
@@ -41,7 +42,7 @@ module SEPA
       raise SEPA::Error.new(errors.full_messages.join("\n")) unless valid?
       raise SEPA::Error.new("Incompatible with schema #{schema_name}!") unless schema_compatible?(schema_name)
 
-      builder = Nokogiri::XML::Builder.new do |builder|
+      builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |builder|
         builder.Document(xml_schema(schema_name)) do
           builder.__send__(xml_main_tag) do
             build_group_header(builder)
@@ -62,7 +63,7 @@ module SEPA
       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, PAIN_001_001_03
+        when PAIN_001_002_03, PAIN_008_002_02, PAIN_001_001_03, PAIN_001_001_03_CH_02
           account.bic.present? && transactions.all? { |t| t.schema_compatible?(schema_name) }
         when PAIN_001_003_03, PAIN_008_003_02, PAIN_008_001_02
           transactions.all? { |t| t.schema_compatible?(schema_name) }
@@ -74,7 +75,7 @@ module SEPA
       raise ArgumentError.new('message_identification must be a string!') unless value.is_a?(String)
 
       regex = /\A([A-Za-z0-9]|[\+|\?|\/|\-|\:|\(|\)|\.|\,|\'|\ ]){1,35}\z/
-      raise ArgumentError.new("message_identification does not match #{regex}!") unless value.match(regex)
+      raise ArgumentError.new("message_identification does not match #{regex}!") unless value.match?(regex)
 
       @message_identification = value
     end
@@ -90,7 +91,7 @@ module SEPA
       raise ArgumentError.new('creation_date_time must be a string!') unless value.is_a?(String)
 
       regex = /[0-9]{4}[-][0-9]{2,2}[-][0-9]{2,2}(?:\s|T)[0-9]{2,2}[:][0-9]{2,2}[:][0-9]{2,2}/
-      raise ArgumentError.new("creation_date_time does not match #{regex}!") unless value.match(regex)
+      raise ArgumentError.new("creation_date_time does not match #{regex}!") unless value.match?(regex)
 
       @creation_date_time = value
     end
@@ -117,9 +118,17 @@ module SEPA
   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}",
+      return {
+        :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" }
+        :'xsi:schemaLocation' => "urn:iso:std:iso:20022:tech:xsd:#{schema_name} #{schema_name}.xsd"
+      } unless schema_name == PAIN_001_001_03_CH_02
+
+      {
+        xmlns:                'http://www.six-interbank-clearing.com/de/pain.001.001.03.ch.02.xsd',
+        'xmlns:xsi':          'http://www.w3.org/2001/XMLSchema-instance',
+        'xsi:schemaLocation': 'http://www.six-interbank-clearing.com/de/pain.001.001.03.ch.02.xsd  pain.001.001.03.ch.02.xsd'
+      }
     end
 
     def build_group_header(builder)

data/lib/sepa_king/transaction/credit_transfer_transaction.rb

@@ -23,6 +23,8 @@ module SEPA
         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

data/lib/sepa_king/validator.rb

@@ -8,7 +8,7 @@ module SEPA
       field_name = options[:field_name] || :iban
       value = record.send(field_name).to_s
 
-      unless IBANTools::IBAN.valid?(value) && value.match(REGEX)
+      unless IBANTools::IBAN.valid?(value) && value.match?(REGEX)
         record.errors.add(field_name, :invalid, message: options[:message])
       end
     end
@@ -31,7 +31,12 @@ module SEPA
   end
 
   class CreditorIdentifierValidator < ActiveModel::Validator
-    REGEX = /\A[a-zA-Z]{2,2}[0-9]{2,2}([A-Za-z0-9]|[\+|\?|\/|\-|\:|\(|\)|\.|,|']){3,3}([A-Za-z0-9]|[\+|\?|\/|\-|:|\(|\)|\.|,|']){1,28}\z/
+    REGEX = %r{\A
+      [a-zA-Z]{2}                 # ISO country code
+      [0-9]{2}                    # Check digits
+      [A-Za-z0-9]{3}              # Creditor business code
+      [A-Za-z0-9+?/:().,'-]{1,28} # National identifier
+    \z}x
 
     def validate(record)
       field_name = options[:field_name] || :creditor_identifier
@@ -43,9 +48,9 @@ module SEPA
     end
 
     def valid?(creditor_identifier)
-      if ok = creditor_identifier.to_s.match(REGEX)
+      if ok = creditor_identifier.to_s.match?(REGEX)
         # In Germany, the identifier has to be exactly 18 chars long
-        if creditor_identifier[0..1].match(/DE/i)
+        if creditor_identifier[0..1].match?(/DE/i)
           ok = creditor_identifier.length == 18
         end
       end
@@ -54,13 +59,13 @@ module SEPA
   end
 
   class MandateIdentifierValidator < ActiveModel::Validator
-    REGEX = /\A([A-Za-z0-9]|[\+|\?|\/|\-|\:|\(|\)|\.|\,|\']){1,35}\z/
+    REGEX = %r{\A[A-Za-z0-9 +?/:().,'-]{1,35}\z}
 
     def validate(record)
       field_name = options[:field_name] || :mandate_id
       value = record.send(field_name)
 
-      unless value.to_s.match(REGEX)
+      unless value.to_s.match?(REGEX)
         record.errors.add(field_name, :invalid, message: options[:message])
       end
     end

data/lib/sepa_king/version.rb

@@ -1,3 +1,3 @@
 module SEPA
-  VERSION = '0.11.1'
+  VERSION = '0.13.0'
 end

data/sepa_king.gemspec

@@ -7,26 +7,24 @@ Gem::Specification.new do |s|
   s.name          = 'sepa_king'
   s.version       = SEPA::VERSION
   s.authors       = ['Georg Leciejewski', 'Georg Ledermann']
-  s.email         = ['gl@salesking.eu', 'mail@georg-ledermann.de']
-  s.description   = 'Implemention of pain.001.002.03 and pain.008.002.02 (ISO 20022)'
+  s.email         = ['gl@salesking.eu', 'georg@ledermann.dev']
+  s.description   = 'Implemention of Payments Initiation (ISO 20022)'
   s.summary       = 'Ruby gem for creating SEPA XML files'
-  s.homepage      = 'http://github.com/salesking/sepa_king'
+  s.homepage      = 'https://github.com/salesking/sepa_king'
   s.license       = 'MIT'
 
   s.files         = `git ls-files`.split($/)
-  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 2.2'
+  s.required_ruby_version = '>= 2.7'
 
-  s.add_runtime_dependency 'activemodel', '>= 3.1'
+  s.add_runtime_dependency 'activemodel', '>= 4.2'
   s.add_runtime_dependency 'nokogiri'
   s.add_runtime_dependency 'iban-tools'
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'coveralls_reborn'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'rake'
 end

data/spec/credit_transfer_spec.rb

@@ -38,7 +38,7 @@ describe SEPA::CreditTransfer do
       it 'should fail' do
         expect {
           SEPA::CreditTransfer.new.to_xml
-        }.to raise_error(SEPA::Error)
+        }.to raise_error(SEPA::Error, /Name is too short/)
       end
     end
 
@@ -62,7 +62,7 @@ describe SEPA::CreditTransfer do
         sct
       end
 
-      it 'should validate against pain.001.003.01' do
+      it 'should validate against pain.001.003.03' do
         expect(subject.to_xml(SEPA::PAIN_001_003_03)).to validate_against('pain.001.003.03.xsd')
       end
     end
@@ -90,7 +90,7 @@ describe SEPA::CreditTransfer do
         sct
       end
 
-      it 'should validate against pain.001.001.01' do
+      it 'should validate against pain.001.001.03' do
         expect(subject.to_xml(SEPA::PAIN_001_001_03)).to validate_against('pain.001.001.03.xsd')
       end
     end
@@ -112,19 +112,19 @@ describe SEPA::CreditTransfer do
         end
 
         it 'should create valid XML file' do
-          expect(subject.to_xml).to validate_against('pain.001.003.03.xsd')
+          expect(subject.to_xml(SEPA::PAIN_001_003_03)).to validate_against('pain.001.003.03.xsd')
         end
 
         it 'should fail for pain.001.001.03' do
           expect {
             subject.to_xml(SEPA::PAIN_001_001_03)
-          }.to raise_error(SEPA::Error)
+          }.to raise_error(SEPA::Error, /Incompatible with schema/)
         end
 
         it 'should fail for pain.001.002.03' do
           expect {
             subject.to_xml(SEPA::PAIN_001_002_03)
-          }.to raise_error(SEPA::Error)
+          }.to raise_error(SEPA::Error, /Incompatible with schema/)
         end
       end
 
@@ -143,7 +143,7 @@ describe SEPA::CreditTransfer do
         end
 
         it 'should validate against pain.001.001.03' do
-          expect(subject.to_xml('pain.001.001.03')).to validate_against('pain.001.001.03.xsd')
+          expect(subject.to_xml).to validate_against('pain.001.001.03.xsd')
         end
 
         it 'should validate against pain.001.002.03' do
@@ -176,7 +176,7 @@ describe SEPA::CreditTransfer do
         end
 
         it 'should create valid XML file' do
-          expect(subject).to validate_against('pain.001.003.03.xsd')
+          expect(subject).to validate_against('pain.001.001.03.xsd')
         end
 
         it 'should have message_identification' do
@@ -344,7 +344,7 @@ describe SEPA::CreditTransfer do
         end
 
         it 'should create valid XML file' do
-          expect(subject).to validate_against('pain.001.003.03.xsd')
+          expect(subject).to validate_against('pain.001.001.03.xsd')
         end
 
         it 'should contain <InstrId>' do
@@ -381,13 +381,13 @@ describe SEPA::CreditTransfer do
         it 'should fail for pain.001.002.03' do
           expect {
             subject.to_xml(SEPA::PAIN_001_002_03)
-          }.to raise_error(SEPA::Error)
+          }.to raise_error(SEPA::Error, /Incompatible with schema/)
         end
 
         it 'should fail for pain.001.003.03' do
           expect {
             subject.to_xml(SEPA::PAIN_001_003_03)
-          }.to raise_error(SEPA::Error)
+          }.to raise_error(SEPA::Error, /Incompatible with schema/)
         end
       end
 
@@ -409,7 +409,7 @@ describe SEPA::CreditTransfer do
         it 'should fail for pain.001.002.03' do
           expect {
             subject.to_xml(SEPA::PAIN_001_002_03)
-          }.to raise_error(SEPA::Error)
+          }.to raise_error(SEPA::Error, /Incompatible with schema/)
         end
 
         it 'should validate against pain.001.003.03' do
@@ -417,5 +417,104 @@ describe SEPA::CreditTransfer do
         end
       end
     end
+
+    context 'xml_schema_header' do
+      subject { credit_transfer.to_xml(format) }
+
+      let(:xml_header) do
+        '<?xml version="1.0" encoding="UTF-8"?>' +
+          "\n<Document xmlns=\"urn:iso:std:iso:20022:tech:xsd:#{format}\"" +
+          ' xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"' +
+          " xsi:schemaLocation=\"urn:iso:std:iso:20022:tech:xsd:#{format} #{format}.xsd\">\n"
+      end
+
+      let(:transaction) do
+        {
+          name: 'Telekomiker AG',
+          iban: 'DE37112589611964645802',
+          bic: 'PBNKDEFF370',
+          amount: 102.50,
+          currency: 'CHF'
+        }
+      end
+
+      before do
+        credit_transfer.add_transaction transaction
+      end
+
+      context "when format is #{SEPA::PAIN_001_001_03}" do
+        let(:format) { SEPA::PAIN_001_001_03 }
+
+        it 'should return correct header' do
+          is_expected.to start_with(xml_header)
+        end
+      end
+
+      context "when format is #{SEPA::PAIN_001_002_03}" do
+        let(:format) { SEPA::PAIN_001_002_03 }
+        let(:transaction) do
+          {
+            name: 'Telekomiker AG',
+            bic: 'PBNKDEFF370',
+            iban: 'DE37112589611964645802',
+            amount: 102.50,
+            reference: 'XYZ-1234/123',
+            remittance_information: 'Rechnung vom 22.08.2013'
+          }
+        end
+
+        it 'should return correct header' do
+          is_expected.to start_with(xml_header)
+        end
+      end
+
+      context "when format is #{SEPA::PAIN_001_003_03}" do
+        let(:format) { SEPA::PAIN_001_003_03 }
+        let(:transaction) do
+          {
+            name: 'Telekomiker AG',
+            bic: 'PBNKDEFF370',
+            iban: 'DE37112589611964645802',
+            amount: 102.50,
+            reference: 'XYZ-1234/123',
+            remittance_information: 'Rechnung vom 22.08.2013'
+          }
+        end
+
+        it 'should return correct header' do
+          is_expected.to start_with(xml_header)
+        end
+      end
+
+      context "when format is #{SEPA::PAIN_001_001_03_CH_02}" do
+        let(:format) { SEPA::PAIN_001_001_03_CH_02 }
+        let(:credit_transfer) do
+          SEPA::CreditTransfer.new name: 'Schuldner GmbH',
+                                   iban: 'CH5481230000001998736',
+                                   bic:  'RAIFCH22'
+        end
+        let(:transaction) do
+          {
+            name: 'Telekomiker AG',
+            iban: 'DE62007620110623852957',
+            amount: 102.50,
+            currency: 'CHF',
+            reference: 'XYZ-1234/123',
+            remittance_information: 'Rechnung vom 22.08.2013'
+          }
+        end
+
+        let(:xml_header) do
+          '<?xml version="1.0" encoding="UTF-8"?>' +
+            "\n<Document xmlns=\"http://www.six-interbank-clearing.com/de/#{format}.xsd\"" +
+            ' xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"' +
+            " xsi:schemaLocation=\"http://www.six-interbank-clearing.com/de/#{format}.xsd  #{format}.xsd\">\n"
+        end
+
+        it 'should return correct header' do
+          is_expected.to start_with(xml_header)
+        end
+      end
+    end
   end
 end

data/spec/credit_transfer_transaction_spec.rb

@@ -44,6 +44,12 @@ describe SEPA::CreditTransferTransaction do
         expect(SEPA::CreditTransferTransaction.new(:bic => nil)).to be_schema_compatible('pain.001.003.03')
       end
     end
+
+    context 'for pain.001.001.03.ch.02' do
+      it 'should succeed for valid attributes' do
+        expect(SEPA::CreditTransferTransaction.new(:bic => 'SPUEDE2UXXX', :currency => 'CHF')).to be_schema_compatible('pain.001.001.03.ch.02')
+      end
+    end
   end
 
   context 'Requested date' do

data/spec/direct_debit_spec.rb

@@ -70,7 +70,7 @@ describe SEPA::DirectDebit do
       it 'should fail' do
         expect {
           SEPA::DirectDebit.new.to_xml
-        }.to raise_error(SEPA::Error)
+        }.to raise_error(SEPA::Error, /Name is too short/)
       end
     end
 
@@ -158,7 +158,7 @@ describe SEPA::DirectDebit do
         it 'should fail for pain.008.002.02' do
           expect {
             subject.to_xml(SEPA::PAIN_008_002_02)
-          }.to raise_error(SEPA::Error)
+          }.to raise_error(SEPA::Error, /Incompatible with schema/)
         end
 
         it 'should validate against pain.008.001.02' do
@@ -256,7 +256,7 @@ describe SEPA::DirectDebit do
         end
 
         it 'should create valid XML file' do
-          expect(subject).to validate_against('pain.008.003.02.xsd')
+          expect(subject).to validate_against('pain.008.001.02.xsd')
         end
 
         it 'should have creditor identifier' do
@@ -385,7 +385,7 @@ describe SEPA::DirectDebit do
         it 'should raise error on XML generation' do
           expect {
             subject.to_xml
-          }.to raise_error(SEPA::Error)
+          }.to raise_error(SEPA::Error, /CORE, COR1 AND B2B must not be mixed in one message/)
         end
       end
 
@@ -516,7 +516,7 @@ describe SEPA::DirectDebit do
         end
 
         it 'should create valid XML file' do
-          expect(subject).to validate_against('pain.008.003.02.xsd')
+          expect(subject).to validate_against('pain.008.001.02.xsd')
         end
 
         it 'should contain <InstrId>' do
@@ -533,7 +533,7 @@ describe SEPA::DirectDebit do
         end
 
         it 'should fail as the payment identification becomes too large' do
-          expect { subject.to_xml }.to raise_error(SEPA::Error)
+          expect { subject.to_xml }.to raise_error(SEPA::Error, /The value has a length of '37'; this exceeds the allowed maximum length of '35'/)
         end
       end
 
@@ -546,7 +546,7 @@ describe SEPA::DirectDebit do
           sct
         end
 
-        it 'should validate against pain.001.001.03' do
+        it 'should validate against pain.008.001.02' do
           expect(subject.to_xml(SEPA::PAIN_008_001_02)).to validate_against('pain.008.001.02.xsd')
         end
 
@@ -562,13 +562,94 @@ describe SEPA::DirectDebit do
         it 'should fail for pain.008.002.02' do
           expect {
             subject.to_xml(SEPA::PAIN_008_002_02)
-          }.to raise_error(SEPA::Error)
+          }.to raise_error(SEPA::Error, /Incompatible with schema/)
         end
 
         it 'should fail for pain.008.003.02' do
           expect {
             subject.to_xml(SEPA::PAIN_008_003_02)
-          }.to raise_error(SEPA::Error)
+          }.to raise_error(SEPA::Error, /Incompatible with schema/)
+        end
+      end
+    end
+
+    context 'xml_schema_header' do
+      subject { sepa_direct_debit.to_xml(format) }
+
+      let(:sepa_direct_debit) do
+        SEPA::DirectDebit.new name: 'Gläubiger GmbH',
+                              iban: 'DE87200500001234567890',
+                              creditor_identifier: 'DE98ZZZ09999999999'
+      end
+
+      let(:xml_header) do
+        '<?xml version="1.0" encoding="UTF-8"?>' +
+          "\n<Document xmlns=\"urn:iso:std:iso:20022:tech:xsd:#{format}\"" +
+          ' xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"' +
+          " xsi:schemaLocation=\"urn:iso:std:iso:20022:tech:xsd:#{format} #{format}.xsd\">\n"
+      end
+
+      let(:transaction) do
+        {
+          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)
+        }
+      end
+
+      before do
+        sepa_direct_debit.add_transaction transaction
+      end
+
+      context "when format is #{SEPA::PAIN_008_001_02}" do
+        let(:format) { SEPA::PAIN_008_001_02 }
+
+        it 'should return correct header' do
+          is_expected.to start_with(xml_header)
+        end
+      end
+
+      context "when format is #{SEPA::PAIN_008_002_02}" do
+        let(:format) { SEPA::PAIN_008_002_02 }
+        let(:sepa_direct_debit) do
+          SEPA::DirectDebit.new name: 'Gläubiger GmbH',
+                                bic: 'SPUEDE2UXXX',
+                                iban: 'DE87200500001234567890',
+                                creditor_identifier: 'DE98ZZZ09999999999'
+        end
+        let(:transaction) do
+          {
+            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',
+            debtor_address: SEPA::DebtorAddress.new(
+              country_code: 'CH',
+              address_line1: 'Mustergasse 123',
+              address_line2: '1234 Musterstadt'
+            ),
+            mandate_date_of_signature: Date.new(2011, 1, 25)
+          }
+        end
+
+        it 'should return correct header' do
+          is_expected.to start_with(xml_header)
+        end
+      end
+
+      context "when format is #{SEPA::PAIN_008_003_02}" do
+        let(:format) { SEPA::PAIN_008_003_02 }
+
+        it 'should return correct header' do
+          is_expected.to start_with(xml_header)
         end
       end
     end