sps_king 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd70e12d3810143618272131a6c71f938e0f3a38d12a3922b1096798bd56906d
-  data.tar.gz: d3f2d858ed88af261d8fa635a04a1625e30d0b8b572477c91b672665999a0b1b
+  metadata.gz: 0bbc6291838df10ef7290cb3e04e1c97d573c92f67e13073e0734743a7d93fa7
+  data.tar.gz: 9611dd93cbfa199e0d32e50f39f6a9d77c4cc952a64a1d20d191d4644ecb0beb
 SHA512:
-  metadata.gz: 202f18b83b35c8ba940eb8bb0827b65933893bf5ca307399940f8990146bdd69970e24c3ab9938067ea7f0343884f3c8523c891a394700d3ba83af0611305829
-  data.tar.gz: 2bae9c411fcb2a036219ca61ca2c701a2f69a57431ec8a89375e6c5764e11e6390db65e2ecb60819bc44744050f55d108fb4a654151341cfe389f8e6514fbec0
+  metadata.gz: 7e50e84dac80865f798fe6bbbbfb4582d2500346d87f9e28420a1381c5cc7843db5d8999892fc4d41c34c83fff0cbfd24cf10dafbb13cee6966bac854aa7d59e
+  data.tar.gz: d6ccf85250954c8e84df1146bf4c59d07d0f0eb99f313fef315bd7e0b4a5a31e8cf204fa4bec4c320d33e289661532346533147b08a9bc60e4ad35828f78ef87

data/CHANGELOG.md

@@ -0,0 +1,60 @@
+## 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
+* 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
+* Improve test setup
+* Add newer ruby versions to test matrix
+* Fix default currency on transactions
+
+**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/viafintech/sps_king/compare/v0.2.0...v0.3.0
+
+## What's Changed in 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 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/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2018-2023 viafintech GmbH
+Copyright (c) 2018-2024 viafintech GmbH
 
 Copyright (c) 2013-2017 Georg Leciejewski (Sales King GmbH) & Georg Ledermann for portions of this project copied from sepa_king
 

data/README.md

@@ -91,7 +91,7 @@ sdd.add_transaction(
   # One of these strings:
   #   'CHTA' ("Banklastschrift") - Only for Swiss Direct Debits
   #   'CHDD' ("PostFinance-Lastschrift") - Only for Swiss Direct Debits
-  service_level: 'CHTA'
+  service_level: 'CHTA',
 
   # Local instrument, in German "Lastschriftart"
   # One of these strings:
@@ -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),
@@ -198,6 +211,14 @@ sct.add_transaction(
   #   'URGP' ("Taggleiche Eilüberweisung")
   service_level: 'URGP'
 
+  # OPTIONAL: Charge Bearer
+  # One of these strings:
+  #   'DEBT' (Borne by Debitor)
+  #   'CRED' (Borne by Creditor)
+  #   'SHAR' (Shared)
+  #   'SLEV' (Service Level) - Must be SLEV for SEPA transfers
+  charge_bearer: 'SHAR',
+
   # OPTIONAL: Unstructured information to indicate the purpose of the payment
   # String, max. 4 char
   category_purpose:         'SALA',

data/cliff.toml

@@ -0,0 +1,88 @@
+# git-cliff ~ configuration file
+# https://git-cliff.org/docs/configuration
+
+[remote.github]
+owner = "viafintech"
+repo = "sps_king"
+# token = ""
+
+[changelog]
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+## What's Changed
+
+{%- if version %} in {{ version }}{%- endif -%}
+{% for commit in commits %}
+  {% if commit.github.pr_title -%}
+    {%- set commit_message = commit.github.pr_title -%}
+  {%- else -%}
+    {%- set commit_message = commit.message -%}
+  {%- endif -%}
+  * {{ commit_message | split(pat="\n") | first | trim }}\
+    {% if commit.github.username %} by @{{ commit.github.username }}{%- endif -%}
+    {% if commit.github.pr_number %} in \
+      [#{{ commit.github.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.github.pr_number }}) \
+    {%- endif %}
+{%- endfor -%}
+
+{%- if github -%}
+{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}
+  {% raw %}\n{% endraw -%}
+  ## New Contributors
+{%- endif %}\
+{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %}
+  * @{{ contributor.username }} made their first contribution
+    {%- if contributor.pr_number %} in \
+      [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \
+    {%- endif %}
+{%- endfor -%}
+{%- endif -%}
+
+{% if version %}
+    {% if previous.version %}
+      **Full Changelog**: {{ self::remote_url() }}/compare/{{ previous.version }}...{{ version }}
+    {% endif %}
+{% else -%}
+  {% raw %}\n{% endraw %}
+{% endif %}
+
+{%- macro remote_url() -%}
+  https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
+{%- endmacro -%}
+"""
+# remove the leading and trailing whitespace from the template
+trim = true
+# changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+# postprocessors
+postprocessors = []
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = false
+# filter out the commits that are not conventional
+filter_unconventional = true
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+  # remove issue numbers from commits
+  { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" },
+]
+# protect breaking changes from being skipped due to matching a skipping commit_parser
+protect_breaking_commits = false
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# regex for matching git tags
+tag_pattern = "v[0-9].*"
+# regex for skipping tags
+skip_tags = "beta|alpha"
+# regex for ignoring tags
+ignore_tags = "rc"
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "newest"

data/lib/sps_king/message/credit_transfer.rb

@@ -16,7 +16,8 @@ module SPS
         requested_date:   transaction.requested_date,
         batch_booking:    transaction.batch_booking,
         service_level:    transaction.service_level,
-        category_purpose: transaction.category_purpose
+        category_purpose: transaction.category_purpose,
+        charge_bearer:    transaction.charge_bearer,
       }
     end
 
@@ -56,7 +57,9 @@ module SPS
               builder.BIC(account.bic)
             end
           end
-          builder.ChrgBr('SLEV')
+          if group[:charge_bearer]
+            builder.ChrgBr(group[:charge_bearer])
+          end
 
           transactions.each do |transaction|
             build_transaction(builder, transaction)
@@ -129,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/transaction/credit_transfer_transaction.rb

@@ -3,10 +3,15 @@ module SPS
   class CreditTransferTransaction < Transaction
     attr_accessor :service_level,
                   :creditor_address,
-                  :category_purpose
+                  :category_purpose,
+                  :charge_bearer
+
+    CHARGE_BEARERS = ['DEBT', 'CRED', 'SHAR', 'SLEV'].freeze
 
     validates_length_of :category_purpose, within: 1..4, allow_nil: true
 
+    validates :charge_bearer, inclusion: CHARGE_BEARERS, allow_nil: true
+
     validate { |t| t.validate_requested_date_after(Date.today) }
 
     def schema_compatible?(schema_name)

data/lib/sps_king/version.rb

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

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

@@ -261,6 +261,25 @@ describe SPS::CreditTransfer do
         end
       end
 
+      context 'with charge bearer' do
+        SPS::CreditTransferTransaction::CHARGE_BEARERS.each do |charge_bearer|
+          context "with value #{charge_bearer}" do
+            subject do
+              sct = credit_transfer
+
+              sct.add_transaction(credit_transfer_transaction.merge(charge_bearer: charge_bearer))
+
+              sct.to_xml
+            end
+
+            it 'should contain payment_information with <ChrgBr>' do
+              expect(subject)
+                .to have_xml('//Document/CstmrCdtTrfInitn/PmtInf[1]/ChrgBr', charge_bearer)
+            end
+          end
+        end
+      end
+
       context 'with different batch_booking given' do
         subject do
           sct = credit_transfer
@@ -345,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

data/spec/lib/sps_king/transaction/credit_transfer_transaction_spec.rb

@@ -11,7 +11,7 @@ describe SPS::CreditTransferTransaction do
           bic:                    'RAIFCH22',
           amount:                 102.50,
           reference:              'XYZ-1234/123',
-          remittance_information: 'Rechnung 123 vom 22.08.2013'
+          remittance_information: 'Rechnung 123 vom 22.08.2013',
         )
       ).to be_valid
     end
@@ -50,4 +50,16 @@ describe SPS::CreditTransferTransaction do
       expect(SPS::CreditTransferTransaction).not_to accept('', 'X' * 5, for: :category_purpose)
     end
   end
+
+  context 'Charge Bearer' do
+    it 'should allow valid value' do
+      expect(SPS::CreditTransferTransaction)
+        .to accept(nil, 'DEBT', 'CRED', 'SHAR', 'SLEV', for: :charge_bearer)
+    end
+
+    it 'should not allow invalid value' do
+      expect(SPS::CreditTransferTransaction)
+        .not_to accept('', 'X' * 5, 'X' * 4, for: :charge_bearer)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sps_king
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Tobias Schoknecht
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-20 00:00:00.000000000 Z
+date: 2024-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -119,11 +119,13 @@ files:
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- cliff.toml
 - gemfiles/Gemfile-activemodel-6.1.x
 - gemfiles/Gemfile-activemodel-7.0.x
 - gemfiles/Gemfile-activemodel-7.1.x