sps_king 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19d0865ad6d2b22dd641a185a944fbd202ccac2cc0c35978aa17c96461f284a5
-  data.tar.gz: 5fc3c5d5ab1bf1e0d0064f14b91dec22f586d68f87128615ff90ea7b42dfc6e1
+  metadata.gz: 7110f83251be28b1fcd5bc66d2071ac1587c7ddd9ab19a3fed3c8e0c593bc87b
+  data.tar.gz: 02b6280f380d1648bd8d1d905d96676e4ac7f299eb07d968780cad25967164d4
 SHA512:
-  metadata.gz: 6d8858f99dee20619395d99ec7c272cae8a361a90592993e57ae0b737bd21f7729d6233e970d517abf9d2178624e2be51a358770a9f211fca58ba513701232e2
-  data.tar.gz: bb74468d090c2bf36f57dc8d527e8ae3abacb0e501e68182458ddd02bd30a3e2940af8c4eab2df51b9496b044b6f8bb9d7429bb6b27216386218830de3f21ab9
+  metadata.gz: 8533d776ca0a69f4f675f5717ebe4cb6a4060d85c90dfdba2d6d360e5f04017be111e78a4668d38834138406f6af7d064f20e8863dd96633bde73d693f462d31
+  data.tar.gz: f318b2e263415392387480e4d15d97e9da8a66ecbf69dd5f40c8df32e630ea717bfdcf89af824903a2b3bbed7dd0fbc2d3138f6f28af9289fe76ca65f8551bbe

data/.github/workflows/test.yml

@@ -11,21 +11,26 @@ jobs:
     runs-on: ubuntu-latest
 
     strategy:
+      fail-fast: false
       matrix:
-        ruby-version: ['3.0']
+        ruby: ['3.0', '3.1', '3.2', '3.3']
         gemfile:
-          - gemfiles/Gemfile-activemodel-6.0.x
           - gemfiles/Gemfile-activemodel-6.1.x
           - gemfiles/Gemfile-activemodel-7.0.x
           - gemfiles/Gemfile-activemodel-7.1.x
 
+    name: Ruby ${{ matrix.ruby }} / Gemfile {{ matrix.gemfile }}
+
     steps:
       - uses: actions/checkout@v3
-      - name: Set up Ruby ${{ matrix.ruby-version }}
-        uses: ruby/setup-ruby@359bebbc29cbe6c87da6bc9ea3bc930432750108
+
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: ${{ matrix.ruby-version }}
-      - name: Install dependencies for ${{ matrix.gemfile}}
-        run: bundle install --gemfile=${{ matrix.gemfile  }}
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install dependencies for ${{ matrix.gemfile }}
+        run: bundle install --gemfile=${{ matrix.gemfile }}
+
       - name: Run tests
         run: bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,46 @@
+## What's Changed
+* Make charge bearer optional instead of constant set to `SLEV`
+
+## What's Changed in v0.3.1
+* Bump version to 0.3.1
+* Merge pull request #5 from viafintech/bug/use-correct-default-currency
+* 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///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
+
+## 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
+
+## 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
+
+<!-- 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:
@@ -198,6 +198,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 = "orhun"
+# repo = "git-cliff"
+# 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)

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/transaction.rb

@@ -43,7 +43,7 @@ module SPS
       self.requested_date ||= DEFAULT_REQUESTED_DATE
       self.reference ||= 'NOTPROVIDED'
       self.batch_booking = true if self.batch_booking.nil?
-      self.currency ||= 'EUR'
+      self.currency ||= 'CHF'
     end
 
     protected

data/lib/sps_king/version.rb

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

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

@@ -261,6 +261,27 @@ 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
+              puts subject
+
+              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

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.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tobias Schoknecht
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-06 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -119,12 +119,13 @@ files:
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/Gemfile-activemodel-6.0.x
+- cliff.toml
 - gemfiles/Gemfile-activemodel-6.1.x
 - gemfiles/Gemfile-activemodel-7.0.x
 - gemfiles/Gemfile-activemodel-7.1.x
@@ -189,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Ruby gem for creating SPS XML files

data/gemfiles/Gemfile-activemodel-6.0.x

@@ -1,5 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec path: '..'
-
-gem 'activemodel', '~> 6.0.0'