Merge pull request #10 from viafintech/feature/qrr-support

Add support for QRR type in structured remittance information

README.md

@@ -184,6 +184,19 @@ sct.add_transaction(
   # String, max. 140 char
   remittance_information: 'Rechnung vom 22.08.2013',
 
+  # OPTIONAL: Structured remittance information, in German "Strukturierter Verwendungszweck". Required for e.g. Swiss QR transfers
+  # StructuredRemittanceInformation
+  structured_remittance_information: SPS::StructuredRemittanceInformation.new(
+    # Defines how the reference field should be interpreted for Swiss Direct Debits
+    # One of these strings:
+    #   'IPI' ("IPI-Verwendungszweck")
+    #   'QRR' ("QR-Referenz")
+    proprietary: 'QRR',
+    # if proprietary is 'IPI': 20 character IPI remittance
+    # if proprietary is 'QRR': 27 character QR reference
+    reference:   '000008207791225857421286694'
+  ),
+
   # OPTIONAL: Requested execution date, in German "Ausführungstermin"
   # Date
   requested_date: Date.new(2013,9,5),

lib/sps_king/message/credit_transfer.rb

@@ -132,9 +132,24 @@ def build_transaction(builder, transaction)
             builder.IBAN(transaction.iban)
           end
         end
-        if transaction.remittance_information
+        if transaction.remittance_information || transaction.structured_remittance_information
           builder.RmtInf do
-            builder.Ustrd(transaction.remittance_information)
+            if transaction.remittance_information
+              builder.Ustrd(transaction.remittance_information)
+            end
+
+            if transaction.structured_remittance_information
+              builder.Strd do
+                builder.CdtrRefInf do
+                  builder.Tp do
+                    builder.CdOrPrtry do
+                      builder.Prtry(transaction.structured_remittance_information.proprietary)
+                    end
+                  end
+                  builder.Ref(transaction.structured_remittance_information.reference)
+                end
+              end
+            end
           end
         end
       end

lib/sps_king/structured_remittance_information.rb

@@ -6,7 +6,7 @@ class StructuredRemittanceInformation
     attr_accessor :proprietary,
                   :reference
 
-    validates_inclusion_of :proprietary, in: %w(ESR IPI)
+    validates_inclusion_of :proprietary, in: %w(ESR IPI QRR)
     validates_length_of :reference, within: 1..35
 
     convert :proprietary, :reference, to: :text

lib/sps_king/version.rb

@@ -1,3 +1,3 @@
 module SPS
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

spec/lib/sps_king/message/credit_transfer_spec.rb

@@ -273,8 +273,6 @@
             end
 
             it 'should contain payment_information with <ChrgBr>' do
-              puts subject
-
               expect(subject)
                 .to have_xml('//Document/CstmrCdtTrfInitn/PmtInf[1]/ChrgBr', charge_bearer)
             end
@@ -366,6 +364,37 @@
             )
         end
       end
+
+      context 'with structured remittance information given' do
+        subject do
+          sct = credit_transfer
+
+          sct.add_transaction(
+            name:        'Contoso AG',
+            iban:        'CH5481230000001998736',
+            bic:         'RAIFCH22',
+            amount:      102.50,
+            structured_remittance_information: SPS::StructuredRemittanceInformation.new(
+              proprietary: 'QRR',
+              reference:   '185744810000000000200800628'
+            )
+          )
+
+          sct.to_xml
+        end
+
+        it 'should create valid XML file' do
+          expect(subject).to validate_against('pain.001.001.03.ch.02.xsd')
+        end
+
+        it 'should contain <Prtry>' do
+          expect(subject)
+            .to have_xml(
+              '//Document/CstmrCdtTrfInitn/PmtInf/CdtTrfTxInf[1]/RmtInf/Strd/CdtrRefInf/Tp/CdOrPrtry/Prtry',
+              'QRR'
+            )
+        end
+      end
     end
   end
 end

spec/lib/sps_king/structured_remittance_information_spec.rb

@@ -12,7 +12,7 @@
 
   describe :proprietary do
     it 'should accept valid value' do
-      expect(SPS::StructuredRemittanceInformation).to accept('ESR', 'IPI', for: :proprietary)
+      expect(SPS::StructuredRemittanceInformation).to accept('ESR', 'IPI', 'QRR', for: :proprietary)
     end
 
     it 'should not accept invalid value' do