sps_king 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7110f83251be28b1fcd5bc66d2071ac1587c7ddd9ab19a3fed3c8e0c593bc87b
-  data.tar.gz: 02b6280f380d1648bd8d1d905d96676e4ac7f299eb07d968780cad25967164d4
+  metadata.gz: 0bbc6291838df10ef7290cb3e04e1c97d573c92f67e13073e0734743a7d93fa7
+  data.tar.gz: 9611dd93cbfa199e0d32e50f39f6a9d77c4cc952a64a1d20d191d4644ecb0beb
 SHA512:
-  metadata.gz: 8533d776ca0a69f4f675f5717ebe4cb6a4060d85c90dfdba2d6d360e5f04017be111e78a4668d38834138406f6af7d064f20e8863dd96633bde73d693f462d31
-  data.tar.gz: f318b2e263415392387480e4d15d97e9da8a66ecbf69dd5f40c8df32e630ea717bfdcf89af824903a2b3bbed7dd0fbc2d3138f6f28af9289fe76ca65f8551bbe
+  metadata.gz: 7e50e84dac80865f798fe6bbbbfb4582d2500346d87f9e28420a1381c5cc7843db5d8999892fc4d41c34c83fff0cbfd24cf10dafbb13cee6966bac854aa7d59e
+  data.tar.gz: d6ccf85250954c8e84df1146bf4c59d07d0f0eb99f313fef315bd7e0b4a5a31e8cf204fa4bec4c320d33e289661532346533147b08a9bc60e4ad35828f78ef87

data/CHANGELOG.md

@@ -1,9 +1,20 @@
-## What's Changed
+## What's Changed in v0.5.0
+* Add support for QRR type in structured remittance information by @tobischo in [#10](https://github.com/viafintech/sps_king/pull/10)
+* Allow structured remittance information optionally for credits
+* Bump version to 0.5.0
+* Add support for QRR as value for proprietary
+* Fix changelog links
+
+## What's Changed in v0.4.0
+* Bump version to 0.4.0
+* Make charge bearer optional instead of constant set to `SLEV` by @tobischo in [#7](https://github.com/viafintech/sps_king/pull/7)
 * Make charge bearer optional instead of constant set to `SLEV`
 
+**Full Changelog**: https://github.com/viafintech/sps_king/compare/v0.3.1...v0.4.0
+
 ## What's Changed in v0.3.1
 * Bump version to 0.3.1
-* Merge pull request #5 from viafintech/bug/use-correct-default-currency
+* Fix default currency on transactions by @tobischo in [#5](https://github.com/viafintech/sps_king/pull/5)
 * Revert to old gemfile definition
 * Re-add bundle install step
 * Fix indentation
@@ -11,36 +22,39 @@
 * Add newer ruby versions to test matrix
 * Fix default currency on transactions
 
-**Full Changelog**: https://github.com///compare/v0.3.0...v0.3.1
+**Full Changelog**: https://github.com/viafintech/sps_king/compare/v0.3.0...v0.3.1
 
 ## What's Changed in v0.3.0
 * Bump gem version
 * Update tested activemodel versions
 * Update test ruby version to 3.0
 
-**Full Changelog**: https://github.com///compare/v0.2.0...v0.3.0
+**Full Changelog**: https://github.com/viafintech/sps_king/compare/v0.2.0...v0.3.0
 
 ## What's Changed in v0.2.0
-* Merge pull request #3 from viafintech/feature/update-dependencies-and-run-tests-on-github
-* Stick to ruby 2.7 support for now
-* Fix CI setup
-* Bump required ruby version to 2.7
-* Merge pull request #2 from viafintech/remove-coveralls-dependency
-* Update version to 0.1.1
-* Add missing gemfiles for testing
-* Remove coveralls dependency
-* Merge pull request #1 from Barzahlen/update-copyright-notice
-* Update copyright notice and author mail address
-* Add comment pointing to sepa_king for sepa files
-* Fix gem description for next release
-
-**Full Changelog**: https://github.com///compare/v0.1.0...v0.2.0
+* Bump required ruby version to 2.7 by @martinseener in [#3](https://github.com/viafintech/sps_king/pull/3)
+* Stick to ruby 2.7 support for now by @tobischo
+* Fix CI setup by @tobischo
+* Bump required ruby version to 2.7 by @tobischo
+* Remove coveralls dependency by @martinseener in [#2](https://github.com/viafintech/sps_king/pull/2)
+* Update version to 0.1.1 by @tobischo
+* Add missing gemfiles for testing by @tobischo
+* Remove coveralls dependency by @tobischo
+* Update copyright notice and author mail address by @martinseener in [#1](https://github.com/viafintech/sps_king/pull/1)
+* Update copyright notice and author mail address by @tobischo
+* Add comment pointing to sepa_king for sepa files by @tobischo
+* Fix gem description for next release by @tobischo
+
+## New Contributors
+* @martinseener made their first contribution in [#3](https://github.com/viafintech/sps_king/pull/3)
+
+**Full Changelog**: https://github.com/viafintech/sps_king/compare/v0.1.0...v0.2.0
 
 ## What's Changed in v0.1.0
-* Add .gem to gitignore
-* Adapt example account holder
-* Fix status badges
-* Fix copyright notice
-* Initial implementation after fork from sepa_king gem
+* Add .gem to gitignore by @tobischo
+* Adapt example account holder by @tobischo
+* Fix status badges by @tobischo
+* Fix copyright notice by @tobischo
+* Initial implementation after fork from sepa_king gem by @tobischo
 
 <!-- generated by git-cliff -->

data/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),

data/cliff.toml

@@ -1,9 +1,9 @@
 # git-cliff ~ configuration file
 # https://git-cliff.org/docs/configuration
 
-# [remote.github]
-# owner = "orhun"
-# repo = "git-cliff"
+[remote.github]
+owner = "viafintech"
+repo = "sps_king"
 # token = ""
 
 [changelog]

data/lib/sps_king/message/credit_transfer.rb

@@ -132,9 +132,24 @@ module SPS
             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

data/lib/sps_king/structured_remittance_information.rb

@@ -6,7 +6,7 @@ module SPS
     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

data/lib/sps_king/version.rb

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

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

@@ -273,8 +273,6 @@ describe SPS::CreditTransfer do
             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 @@ describe SPS::CreditTransfer do
             )
         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

data/spec/lib/sps_king/structured_remittance_information_spec.rb

@@ -12,7 +12,7 @@ describe SPS::StructuredRemittanceInformation do
 
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sps_king
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Tobias Schoknecht
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-03 00:00:00.000000000 Z
+date: 2024-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel