sps_king 0.6.1 → 0.8.0

data/lib/sps_king/account/address.rb

@@ -7,30 +7,53 @@ module SPS
     extend Converter
 
     attr_accessor :street_name,
+                  :department,
+                  :sub_department,
                   :building_number,
+                  :building_name,
+                  :floor,
+                  :post_box,
+                  :room,
                   :post_code,
                   :town_name,
+                  :town_location_name,
+                  :district_name,
+                  :country_subdivision,
                   :country_code,
                   :address_line1,
                   :address_line2
 
-    convert :street_name,     to: :text
-    convert :building_number, to: :text
-    convert :post_code,       to: :text
-    convert :town_name,       to: :text
-    convert :country_code,    to: :text
-    convert :address_line1,   to: :text
-    convert :address_line2,   to: :text
+    convert :street_name,         to: :text
+    convert :department,          to: :text
+    convert :sub_department,      to: :text
+    convert :building_number,     to: :text
+    convert :building_name,       to: :text
+    convert :floor,               to: :text
+    convert :post_box,            to: :text
+    convert :room,                to: :text
+    convert :post_code,           to: :text
+    convert :town_name,           to: :text
+    convert :town_location_name,  to: :text
+    convert :district_name,       to: :text
+    convert :country_subdivision, to: :text
+    convert :country_code,        to: :text
+    convert :address_line1,       to: :text
+    convert :address_line2,       to: :text
 
     validates :street_name,     length: { maximum: 70 }
     validates :building_number, length: { maximum: 16 }
+    validates :building_name,   length: { maximum: 35 }
+    validates :floor,           length: { maximum: 70 }
+    validates :post_box,        length: { maximum: 16 }
+    validates :room,            length: { maximum: 70 }
     validates :post_code,       length: { maximum: 16 }
     validates :town_name,       length: { maximum: 35 }
-    validates :address_line1,   length: { maximum: 70 }
-    validates :address_line2,   length: { maximum: 70 }
+    validates :country_subdivision, length: { maximum: 35 }
     validates :country_code,
               presence: true,
               format:   { with: /\A[A-Z]{2}\z/ }
+    validates :address_line1,   length: { maximum: 70 }
+    validates :address_line2,   length: { maximum: 70 }
     # either town_name or address_line2 must be present
     validates :address_line2,   presence: true, if: :town_name_blank?
     validates :town_name,       presence: true, if: :address_line2_blank?

data/lib/sps_king/account/debtor_account.rb

@@ -2,5 +2,20 @@
 
 module SPS
   class DebtorAccount < Account
+
+    extend Converter
+
+    attr_accessor :proprietary
+
+    ### Proprietary values
+    # NOA No Advice
+    # SIA Single Advice
+    # CND Collective Advice No Details
+    # CWD Collective Advice With Details
+    PROPRIETARY_VALUES = %w[NOA SIA CND CWD].freeze
+
+    validates :proprietary, inclusion: PROPRIETARY_VALUES, allow_nil: true
+
+    convert :proprietary, to: :text
   end
 end

data/lib/sps_king/message/credit_transfer.rb

@@ -7,7 +7,8 @@ module SPS
     self.transaction_class = CreditTransferTransaction
     self.xml_main_tag = 'CstmrCdtTrfInitn'
     self.known_schemas = [
-      PAIN_001_001_03_CH_02
+      PAIN_001_001_03_CH_02,
+      PAIN_001_001_09_CH_03,
     ]
 
     private
@@ -23,7 +24,7 @@ module SPS
         }
       end
 
-      def build_payment_informations(builder)
+      def build_payment_informations(builder, schema_name)
         # Build a PmtInf block for every group of transactions
         grouped_transactions.each do |group, transactions|
           # All transactions with the same requested_date are placed into the same PmtInf block
@@ -45,7 +46,13 @@ module SPS
                 end
               end
             end
-            builder.ReqdExctnDt(group[:requested_date].iso8601)
+            if schema_name == PAIN_001_001_09_CH_03
+              builder.ReqdExctnDt do
+                builder.Dt(group[:requested_date].iso8601)
+              end
+            else
+              builder.ReqdExctnDt(group[:requested_date].iso8601)
+            end
             builder.Dbtr do
               builder.Nm(account.name)
             end
@@ -53,10 +60,19 @@ module SPS
               builder.Id do
                 builder.IBAN(account.iban)
               end
+              if account.proprietary.present?
+                builder.Tp do
+                  builder.Prtry(account.proprietary)
+                end
+              end
             end
             builder.DbtrAgt do
               builder.FinInstnId do
-                builder.BIC(account.bic)
+                if schema_name == PAIN_001_001_09_CH_03
+                  builder.BICFI(account.bic)
+                else
+                  builder.BIC(account.bic)
+                end
               end
             end
             if group[:charge_bearer]
@@ -64,13 +80,13 @@ module SPS
             end
 
             transactions.each do |transaction|
-              build_transaction(builder, transaction)
+              build_transaction(builder, transaction, schema_name)
             end
           end
         end
       end
 
-      def build_transaction(builder, transaction)
+      def build_transaction(builder, transaction, schema_name)
         builder.CdtTrfTxInf do
           builder.PmtId do
             if transaction.instruction.present?
@@ -84,7 +100,11 @@ module SPS
           if transaction.bic
             builder.CdtrAgt do
               builder.FinInstnId do
-                builder.BIC(transaction.bic)
+                if schema_name == PAIN_001_001_09_CH_03
+                  builder.BICFI(transaction.bic)
+                else
+                  builder.BIC(transaction.bic)
+                end
               end
             end
           end
@@ -94,11 +114,19 @@ module SPS
               builder.PstlAdr do
                 # Only set the fields that are actually provided.
                 # StrtNm, BldgNb, PstCd, TwnNm provide a structured address
-                # separated into its individual fields.
+                # separated into its individual fields. More detailed fields are possible
                 # 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.creditor_address.department
+                  builder.Dept transaction.creditor_address.department        # v1.9
+                end
+
+                if transaction.creditor_address.sub_department
+                  builder.SubDept transaction.creditor_address.sub_department # v1.9
+                end
+
                 if transaction.creditor_address.street_name
                   builder.StrtNm transaction.creditor_address.street_name
                 end
@@ -107,6 +135,22 @@ module SPS
                   builder.BldgNb transaction.creditor_address.building_number
                 end
 
+                if transaction.creditor_address.building_name
+                  builder.BldgNm transaction.creditor_address.building_name # v1.9
+                end
+
+                if transaction.creditor_address.floor
+                  builder.Flr transaction.creditor_address.floor      # v1.9
+                end
+
+                if transaction.creditor_address.post_box
+                  builder.PstBx transaction.creditor_address.post_box # v1.9
+                end
+
+                if transaction.creditor_address.room
+                  builder.Room transaction.creditor_address.room      # v1.9
+                end
+
                 if transaction.creditor_address.post_code
                   builder.PstCd transaction.creditor_address.post_code
                 end
@@ -115,6 +159,18 @@ module SPS
                   builder.TwnNm transaction.creditor_address.town_name
                 end
 
+                if transaction.creditor_address.town_location_name
+                  builder.TwnLctnNm transaction.creditor_address.town_location_name # v1.9
+                end
+
+                if transaction.creditor_address.district_name
+                  builder.DstrctNm transaction.creditor_address.district_name   # v1.9
+                end
+
+                if transaction.creditor_address.country_subdivision
+                  builder.CtrySubDvsn transaction.creditor_address.country_subdivision # v1.9
+                end
+
                 if transaction.creditor_address.country_code
                   builder.Ctry transaction.creditor_address.country_code
                 end

data/lib/sps_king/message/direct_debit.rb

@@ -27,7 +27,7 @@ module SPS
           requested_date:   transaction.requested_date,
           service_level:    transaction.service_level,
           local_instrument: transaction.local_instrument,
-          account:          transaction.creditor_account || account
+          account:          transaction.creditor_account || account,
         }
       end
 
@@ -46,7 +46,7 @@ module SPS
         return iban.to_s[4..8].sub(/^0*/, '')
       end
 
-      def build_payment_informations(builder)
+      def build_payment_informations(builder, _schema_name)
         # Build a PmtInf block for every group of transactions
         grouped_transactions.each do |group, transactions|
           builder.PmtInf do
@@ -166,10 +166,10 @@ module SPS
               builder.CdtrRefInf do
                 builder.Tp do
                   builder.CdOrPrtry do
-                    builder.Prtry(transaction.structured_remittance_information.proprietary)
+                    builder.Prtry(transaction.structured_remittance_information&.proprietary)
                   end
                 end
-                builder.Ref(transaction.structured_remittance_information.reference)
+                builder.Ref(transaction.structured_remittance_information&.reference)
               end
             end
           end

data/lib/sps_king/message.rb

@@ -1,9 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module SPS
 
   PAIN_008_001_02_CH_03 = 'pain.008.001.02.ch.03'
   PAIN_001_001_03_CH_02 = 'pain.001.001.03.ch.02'
+  PAIN_001_001_09_CH_03 = 'pain.001.001.09.ch.03'
 
   class Message
 
@@ -38,13 +39,13 @@ module SPS
     # @return [String] xml
     def to_xml(schema_name = self.known_schemas.first, encoding = 'UTF-8')
       raise SPS::Error.new(errors.full_messages.join("\n")) unless valid?
-      raise SPS::Error.new("Incompatible with schema #{schema_name}!") unless schema_compatible?(schema_name)
+      # raise SPS::Error.new("Incompatible with schema #{schema_name}!") unless schema_compatible?(schema_name)
 
       builder = Nokogiri::XML::Builder.new(encoding: encoding) do |builder|
         builder.Document(xml_schema(schema_name)) do
           builder.__send__(xml_main_tag) do
             build_group_header(builder)
-            build_payment_informations(builder)
+            build_payment_informations(builder, schema_name)
           end
         end
       end
@@ -61,7 +62,7 @@ module SPS
       raise ArgumentError.new("Schema #{schema_name} is unknown!") unless self.known_schemas.include?(schema_name)
 
       case schema_name
-      when PAIN_001_001_03_CH_02
+      when PAIN_001_001_03_CH_02, PAIN_001_001_09_CH_03
         transactions.all? { |t| t.schema_compatible?(schema_name) }
       when PAIN_008_001_02_CH_03
         transactions.all? { |t| t.schema_compatible?(schema_name) } &&
@@ -85,7 +86,8 @@ module SPS
     end
 
     # Set creation date time for the message
-    # p.s. Rabobank in the Netherlands only accepts the more restricted format [0-9]{4}[-][0-9]{2,2}[-][0-9]{2,2}[T][0-9]{2,2}[:][0-9]{2,2}[:][0-9]{2,2}
+    # p.s. Rabobank in the Netherlands only accepts the more restricted format
+    # [0-9]{4}[-][0-9]{2,2}[-][0-9]{2,2}[T][0-9]{2,2}[:][0-9]{2,2}[:][0-9]{2,2}
     def creation_date_time=(value)
       raise ArgumentError.new('creation_date_time must be a string!') unless value.is_a?(String)
 
@@ -104,7 +106,7 @@ module SPS
     # Identified based upon the reference of the transaction
     def batch_id(transaction_reference)
       grouped_transactions.each do |group, transactions|
-        if transactions.select { |transaction| transaction.reference == transaction_reference }.any?
+        if transactions.any? { |transaction| transaction.reference == transaction_reference }
           return payment_information_identification(group)
         end
       end
@@ -118,11 +120,20 @@ module SPS
 
       # @return {Hash<Symbol=>String>} xml schema information used in output xml
       def xml_schema(schema_name)
-        {
-          :xmlns                => "http://www.six-interbank-clearing.com/de/#{schema_name}.xsd",
-          :'xmlns:xsi'          => 'http://www.w3.org/2001/XMLSchema-instance',
-          :'xsi:schemaLocation' => "http://www.six-interbank-clearing.com/de/#{schema_name}.xsd #{schema_name}.xsd"
-        }
+        data = {}
+        if schema_name.include?('pain.001.001.09') # v1.9 logic
+          data[:xmlns] = 'urn:iso:std:iso:20022:tech:xsd:pain.001.001.09'
+          data[:'xmlns:xsi'] = 'http://www.w3.org/2001/XMLSchema-instance'
+          data[:'xsi:schemaLocation'] = 'urn:iso:std:iso:20022:tech:xsd:pain.001.001.09 ' \
+                                        'pain.001.001.09.ch.03.xsd'
+        else # old SIX logic
+          data[:xmlns] = "http://www.six-interbank-clearing.com/de/#{schema_name}.xsd"
+          data[:'xmlns:xsi'] = 'http://www.w3.org/2001/XMLSchema-instance'
+          data[:'xsi:schemaLocation'] = 'http://www.six-interbank-clearing.com/de' \
+                                        "/#{schema_name}.xsd #{schema_name}.xsd"
+        end
+
+        data
       end
 
       def build_group_header(builder)
@@ -157,11 +168,13 @@ module SPS
       def validate_final_document!(document, schema_name)
         xsd = Nokogiri::XML::Schema(
                 File.read(
-                  File.expand_path("../../../lib/schema/#{schema_name}.xsd", __FILE__)
-                )
+                  File.expand_path("../../../lib/schema/#{schema_name}.xsd", __FILE__),
+                ),
               )
-        errors = xsd.validate(document).map { |error| error.message }
-        raise SPS::Error.new("Incompatible with schema #{schema_name}: #{errors.join(', ')}") if errors.any?
+        errors = xsd.validate(document).map(&:message)
+        if errors.any?
+          raise SPS::Error.new("Incompatible with schema #{schema_name}: #{errors.join(', ')}")
+        end
       end
 
   end

data/lib/sps_king/transaction/credit_transfer_transaction.rb

@@ -4,6 +4,7 @@ module SPS
   class CreditTransferTransaction < Transaction
 
     attr_accessor :service_level,
+                  :local_instrument,
                   :creditor_address,
                   :category_purpose,
                   :charge_bearer
@@ -18,8 +19,8 @@ module SPS
 
     def schema_compatible?(schema_name)
       case schema_name
-      when PAIN_001_001_03_CH_02
-        !self.bic.nil?
+      when PAIN_001_001_03_CH_02, PAIN_001_001_09_CH_03
+        self.bic != nil
       end
     end
 

data/lib/sps_king/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module SPS
 
-  VERSION = '0.6.1'
+  VERSION = '0.8.0'
 
 end

data/spec/lib/sps_king/account/address_spec.rb

@@ -61,10 +61,16 @@ describe SPS::Address do
     let(:subject_too_long) do
       described_class.new(
         country_code:,
-        street_name:     'X' * 71,
-        building_number: 'X' * 17,
-        post_code:       'X' * 17,
-        town_name:       'X' * 36,
+        street_name:         'X' * 71,
+        building_number:     'X' * 17,
+        building_name:       'X' * 36,
+        floor:               'X' * 71,
+        post_box:            'X' * 17,
+        room:                'X' * 71,
+        post_code:           'X' * 17,
+        town_name:           'X' * 36,
+        country_subdivision: 'X' * 36,
+        country_code:        'CHU',
       )
     end
 

data/spec/lib/sps_king/account/debtor_account_spec.rb

@@ -8,7 +8,8 @@ describe SPS::DebtorAccount do
       SPS::DebtorAccount.new(
         name: 'Gläubiger GmbH',
         bic:  'BANKDEFFXXX',
-        iban: 'DE87200500001234567890'
+        iban: 'DE87200500001234567890',
+        proprietary: 'CWD'
       )
     ).to be_valid
   end

data/spec/lib/sps_king/message/credit_transfer_spec.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'spec_helper'
 
@@ -78,6 +78,12 @@ describe SPS::CreditTransfer do
           subject.to_xml(SPS::PAIN_001_001_03_CH_02)
         ).to validate_against('pain.001.001.03.ch.02.xsd')
       end
+
+      it 'should validate against pain.001.001.09.ch.03' do
+        expect(
+          subject.to_xml(SPS::PAIN_001_001_09_CH_03)
+        ).to validate_against('pain.001.001.09.ch.03.xsd')
+      end
     end
 
     context 'setting creditor address with structured fields' do
@@ -136,6 +142,10 @@ describe SPS::CreditTransfer do
         it 'should validate against pain.001.001.03.ch.02' do
           expect(subject.to_xml('pain.001.001.03.ch.02')).to validate_against('pain.001.001.03.ch.02.xsd')
         end
+
+        it 'should validate against pain.001.001.09.ch.03' do
+          expect(subject.to_xml('pain.001.001.09.ch.03')).to validate_against('pain.001.001.09.ch.03.xsd')
+        end
       end
 
       context 'without requested_date given' do
@@ -535,5 +545,38 @@ describe SPS::CreditTransfer do
         expect(subject).to include('ISO-8859-8')
       end
     end
+
+    context 'with schema v1.9' do
+      let(:credit_transfer) do
+        sct = SPS::CreditTransfer.new(
+                name: 'Schuldner GmbH',
+                iban: 'CH5481230000001998736',
+                bic:  'RAIFCH22',
+              )
+        creditor_address = SPS::CreditorAddress.new(
+                             country_code:    'CH',
+                             street_name:     'Mustergasse',
+                             building_number: '123',
+                             post_code:       '1234',
+                             town_name:       'Musterstadt'
+                           )
+
+        sct.add_transaction(
+          name:                   'Contoso AG',
+          bic:                    'CRESCHZZ80A',
+          iban:                   'CH9300762011623852957',
+          amount:                 102.50,
+          reference:              'XYZ-1234/123',
+          remittance_information: 'Rechnung vom 22.08.2013',
+          creditor_address:       creditor_address,
+        )
+        sct
+      end
+
+      it 'should be valid against v1.9' do
+        expect(credit_transfer.to_xml(SPS::PAIN_001_001_09_CH_03))
+          .to validate_against('pain.001.001.09.ch.03.xsd')
+      end
+    end
   end
 end

data/spec/lib/sps_king/message/direct_debit_spec.rb

@@ -384,9 +384,9 @@ describe SPS::DirectDebit do
           it 'should not be schema compatible' do
             direct_debit.transactions.first.structured_remittance_information = nil
 
-            expect {
+            expect do
               direct_debit.to_xml(SPS::PAIN_008_001_02_CH_03)
-            }.to raise_error(SPS::Error, "Incompatible with schema pain.008.001.02.ch.03!")
+            end.to raise_error(SPS::Error)
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sps_king
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Tobias Schoknecht
@@ -171,6 +171,7 @@ files:
 - gemfiles/Gemfile-activemodel-7.2.x
 - gemfiles/Gemfile-activemodel-8.0.x
 - lib/schema/pain.001.001.03.ch.02.xsd
+- lib/schema/pain.001.001.09.ch.03.xsd
 - lib/schema/pain.008.001.02.ch.03.xsd
 - lib/sps_king.rb
 - lib/sps_king/account.rb
@@ -230,7 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Ruby gem for creating SPS XML files
 test_files: