sps_king 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7110f83251be28b1fcd5bc66d2071ac1587c7ddd9ab19a3fed3c8e0c593bc87b
-  data.tar.gz: 02b6280f380d1648bd8d1d905d96676e4ac7f299eb07d968780cad25967164d4
+  metadata.gz: cd8f010271911b78bed9955509277ed10a1a9da20c11ac9cc6c52847cffaf810
+  data.tar.gz: 44a38096598ff27e120797c59b43d0505c184db77eb08556982f39ce0823fff4
 SHA512:
-  metadata.gz: 8533d776ca0a69f4f675f5717ebe4cb6a4060d85c90dfdba2d6d360e5f04017be111e78a4668d38834138406f6af7d064f20e8863dd96633bde73d693f462d31
-  data.tar.gz: f318b2e263415392387480e4d15d97e9da8a66ecbf69dd5f40c8df32e630ea717bfdcf89af824903a2b3bbed7dd0fbc2d3138f6f28af9289fe76ca65f8551bbe
+  metadata.gz: 2b88d4094b57f6b40db6ebc5e83b90238bafb99521d38b0c59b5d7b13b317917bf54184fb5b654c810c0cd19394a5915fd6940bc7752fb1a9b9519e9ff0034f3
+  data.tar.gz: 99cbcd8f475d7310ecf302a5d6786594d883d8a9464a670baabbaf0207a17227c80dcf46bb277a501649c84c9c957ba126128a58d0cc2047ec4465fc82885e4f

data/.github/workflows/test.yml

@@ -13,11 +13,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['3.0', '3.1', '3.2', '3.3']
+        ruby: ['3.2', '3.3', '3.4']
         gemfile:
-          - gemfiles/Gemfile-activemodel-6.1.x
-          - gemfiles/Gemfile-activemodel-7.0.x
           - gemfiles/Gemfile-activemodel-7.1.x
+          - gemfiles/Gemfile-activemodel-7.2.x
+          - gemfiles/Gemfile-activemodel-8.0.x
 
     name: Ruby ${{ matrix.ruby }} / Gemfile {{ matrix.gemfile }}
 

data/CHANGELOG.md

@@ -1,9 +1,29 @@
-## What's Changed
+## What's Changed in v0.5.0
+* Update covered ruby and activemodel versions for testing
+* Improvement of the convert_decimal function by @casaper in [#14](https://github.com/viafintech/sps_king/pull/14)
+* Standardized creditor and debitor addresses and added stricter validation by @casapar in [#16](https://github.com/viafintech/sps_king/pull/16)
+
+**Full Changelog**: https://github.com/viafintech/sps_king/compare/v0.5.0...v0.6.0
+
+## 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
+
+**Full Changelog**: https://github.com/viafintech/sps_king/compare/v0.4.0...v0.5.0
+
+## 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 +31,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

@@ -22,6 +22,8 @@ This gem is forked of `sepa_king` and therefore heavily inspired by the structur
 
 ## Usage
 
+## Direct Debit Initiation
+
 How to create the XML for **Direct Debit Initiation** (in German: "Lastschriften")
 
 ```ruby
@@ -41,7 +43,7 @@ sdd = SPS::DirectDebit.new(
 
   # Creditor Identifier, in German: Gläubiger-Identifikationsnummer
   # String, max. 35 chars
-  creditor_identifier: 'ABC1W'
+  creditor_identifier: 'ABC1W',
 )
 
 # Second: Add transactions
@@ -84,7 +86,7 @@ sdd.add_transaction(
     proprietary: 'ESR',
     # if proprietary is 'ESR': 27 character ISR reference number
     # if proprietary is 'IPI': 20 character IPI remittance
-    reference:   '609323234234234353453423423'
+    reference:   '609323234234234353453423423',
   ),
 
   # Service Level
@@ -103,14 +105,14 @@ sdd.add_transaction(
 
   # OPTIONAL: Requested collection date, in German "Fälligkeitsdatum der Lastschrift"
   # Date
-  requested_date: Date.new(2013,9,5),
+  requested_date: Date.new(2013, 9, 5),
 
   # OPTIONAL: Use a different creditor account
   # CreditorAccount
   creditor_account: SPS::CreditorAccount.new(
     name:                'Creditor Inc.',
     iban:                'CH7081232000001998736',
-    creditor_identifier: '12312'
+    creditor_identifier: '12312',
   )
 
   # Specify the country & address of the debtor (The individually required fields depend on the local legal requirements)
@@ -118,11 +120,11 @@ sdd.add_transaction(
     country_code:        'CH',
     # Not required if individual fields are used
     address_line1:       'Mustergasse 123a',
-    address_line2:       '1234 Musterstadt'
+    address_line2:       '1234 Musterstadt',
     # Not required if address_line1 and address_line2 are used
     street_name:         'Mustergasse',
     post_code:           '1234',
-    town_name:           'Musterstadt'
+    town_name:           'Musterstadt',
   )
 )
 sdd.add_transaction ...
@@ -131,6 +133,7 @@ sdd.add_transaction ...
 xml_string = sdd.to_xml # Use latest schema pain.008.001.02.ch.03
 ```
 
+### Credit Transfer Initiation
 
 How to create the XML for **Credit Transfer Initiation** (in German: "Überweisungen")
 
@@ -147,7 +150,7 @@ sct = SPS::CreditTransfer.new(
 
   # International Bank Account Number of the debtor
   # String, max. 34 chars
-  iban: 'CH5481230000001998736'
+  iban: 'CH5481230000001998736',
 )
 
 # Second: Add transactions
@@ -184,6 +187,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),
@@ -196,7 +212,7 @@ sct.add_transaction(
   # One of these strings:
   #   'SEPA' ("SEPA-Zahlung")
   #   'URGP' ("Taggleiche Eilüberweisung")
-  service_level: 'URGP'
+  service_level: 'URGP',
 
   # OPTIONAL: Charge Bearer
   # One of these strings:
@@ -215,12 +231,12 @@ sct.add_transaction(
     country_code:        'CH',
     # Not required if individual fields are used
     address_line1:       'Mustergasse 123a',
-    address_line2:       '1234 Musterstadt'
+    address_line2:       '1234 Musterstadt',
     # Not required if address_line1 and address_line2 are used
     street_name:         'Mustergasse',
     building_number:     '123a',
     post_code:           '1234',
-    town_name:           'Musterstadt'
+    town_name:           'Musterstadt',
   )
 )
 sct.add_transaction ...
@@ -231,12 +247,12 @@ xml_string = sct.to_xml # Use latest schema pain.001.001.03.ch.02
 
 ## Changelog
 
-https://github.com/Barzahlen/sps_king/releases
+https://github.com/viafintech/sps_king/releases
 
 
 ## Contributors
 
-https://github.com/Barzahlen/sps_king/graphs/contributors
+https://github.com/viafintech/sps_king/graphs/contributors
 
 
 ## Resources
@@ -249,6 +265,6 @@ https://github.com/Barzahlen/sps_king/graphs/contributors
 
 Released under the MIT license
 
-Copyright (c) 2018-2023 Tobias Schoknecht
+Copyright (c) 2018-2025 Tobias Schoknecht
 
 Copyright (c) 2013-2017 Georg Leciejewski (Sales King GmbH) & Georg Ledermann for portions of this project copied from sepa_king

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/gemfiles/{Gemfile-activemodel-6.1.x → Gemfile-activemodel-7.2.x}

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 gemspec path: '..'
 
-gem 'activemodel', '~> 6.1.0'
+gem 'activemodel', '~> 7.2.0'

data/gemfiles/{Gemfile-activemodel-7.0.x → Gemfile-activemodel-8.0.x}

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 gemspec path: '..'
 
-gem 'activemodel', '~> 7.0.0'
+gem 'activemodel', '~> 8.0.0'

data/lib/sps_king/account/address.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+module SPS
+  class Address
+
+    include ActiveModel::Validations
+    extend Converter
+
+    attr_accessor :street_name,
+                  :building_number,
+                  :post_code,
+                  :town_name,
+                  :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
+
+    validates :street_name,     length: { maximum: 70 }
+    validates :building_number, length: { maximum: 16 }
+    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_code,
+              presence: true,
+              format:   { with: /\A[A-Z]{2}\z/ }
+    # 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?
+
+    def initialize(attributes = {})
+      attributes.each do |name, value|
+        public_send("#{name}=", value)
+      end
+    end
+
+    private
+
+      def town_name_blank?
+        town_name.blank?
+      end
+
+      def address_line2_blank?
+        address_line2.blank?
+      end
+
+  end
+end

data/lib/sps_king/account/creditor_account.rb

@@ -1,11 +1,14 @@
 # encoding: utf-8
+
 module SPS
   class CreditorAccount < Account
+
     attr_accessor :creditor_identifier,
                   :isr_participant_number
 
     validates_with CreditorIdentifierValidator,
                    message: "%{value} is invalid"
     validates_format_of :isr_participant_number, with: /\A\d{9}\z/, allow_nil: true
+
   end
 end

data/lib/sps_king/account/creditor_address.rb

@@ -1,37 +1,5 @@
 # encoding: utf-8
-module SPS
-  class CreditorAddress
-    include ActiveModel::Validations
-    extend Converter
-
-    attr_accessor :street_name,
-                  :building_number,
-                  :post_code,
-                  :town_name,
-                  :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
 
-    validates_length_of :street_name,     maximum: 70
-    validates_length_of :building_number, maximum: 16
-    validates_length_of :post_code,       maximum: 16
-    validates_length_of :town_name,       maximum: 35
-    validates_length_of :country_code,    is: 2
-    validates_length_of :address_line1,   maximum: 70
-    validates_length_of :address_line2,   maximum: 70
-
-    def initialize(attributes = {})
-      attributes.each do |name, value|
-        public_send("#{name}=", value)
-      end
-    end
-  end
+module SPS
+  class CreditorAddress < Address; end
 end

data/lib/sps_king/account/debtor_account.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+
 module SPS
   class DebtorAccount < Account
   end

data/lib/sps_king/account/debtor_address.rb

@@ -1,34 +1,5 @@
 # encoding: utf-8
-module SPS
-  class DebtorAddress
-    include ActiveModel::Validations
-    extend Converter
-
-    attr_accessor :street_name,
-                  :post_code,
-                  :town_name,
-                  :country_code,
-                  :address_line1,
-                  :address_line2
-
-    convert :street_name,     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
 
-    validates_length_of :street_name,     maximum: 70
-    validates_length_of :post_code,       maximum: 16
-    validates_length_of :town_name,       maximum: 35
-    validates_length_of :country_code,    is: 2
-    validates_length_of :address_line1,   maximum: 70
-    validates_length_of :address_line2,   maximum: 70
-
-    def initialize(attributes = {})
-      attributes.each do |name, value|
-        public_send("#{name}=", value)
-      end
-    end
-  end
+module SPS
+  class DebtorAddress < Address; end
 end

data/lib/sps_king/account.rb

@@ -1,6 +1,8 @@
 # encoding: utf-8
+
 module SPS
   class Account
+
     include ActiveModel::Validations
     extend Converter
 
@@ -20,5 +22,6 @@ module SPS
         public_send("#{name}=", value)
       end
     end
+
   end
 end

data/lib/sps_king/converter.rb

@@ -1,6 +1,8 @@
 # encoding: utf-8
+
 module SPS
   module Converter
+
     def convert(*attributes, options)
       include InstanceMethods
 
@@ -17,18 +19,19 @@ module SPS
     end
 
     module InstanceMethods
+
       def convert_text(value)
         return unless value
 
         value.to_s.
           # Replace some special characters described as "Best practices" in Chapter 6.2 of this document:
           # http://www.europeanpaymentscouncil.eu/index.cfm/knowledge-bank/epc-documents/sepa-requirements-for-an-extended-character-set-unicode-subset-best-practices/
-          gsub('€','E').
-          gsub('@','(at)').
-          gsub('_','-').
+          gsub('€', 'E')
+          .gsub('@', '(at)')
+          .gsub('_', '-').
 
           # Replace linebreaks by spaces
-          gsub(/\n+/,' ').
+          gsub(/\n+/, ' ').
 
           # Remove all invalid characters
           gsub(/[^a-zA-Z0-9ÄÖÜäöüß&*$%\ \'\:\?\,\-\(\+\.\)\/]/, '').
@@ -37,17 +40,18 @@ module SPS
           strip
       end
 
+      # @param [BigDecimal|Integer|Float|String|nil] value the value to convert
+      # @return [BigDecimal|nil] the converted value or nil if the conversion failed
       def convert_decimal(value)
-        return unless value
-        value = begin
+        val = begin
           BigDecimal(value.to_s)
         rescue ArgumentError
+          nil
         end
-
-        if value && value.finite? && value > 0
-          value.round(2)
-        end
+        val.round(2) if val&.finite? && val > 0
       end
+
     end
+
   end
 end