sepa_rator 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a58a4b048d1554e4d422e8a7f0d3a054e01c9f280c026bbcba373d826b72b23
-  data.tar.gz: db691fda7be2fb62d6d42b172708956ac12b17c46614a09c24ac4fd035dbfd20
+  metadata.gz: 83ba8734459eaf10832606aa2c4c894cad0fde36f221a88e4664d55ec929d1d6
+  data.tar.gz: 54c0ad9c0f54bcfa88b2912cd1f93b5fd2574d15581574dd5bd2760941adef10
 SHA512:
-  metadata.gz: 9c3f27235b35022711b6115b025eb5b50694f6832d486238610144b676adf672917f1a354e2cf6a11dff98c5570a764cd27e1713cbc53e208a56c08b665bf702
-  data.tar.gz: 2f29c643d85508b1159d630a169f3248450b36556ca4bfd84032d1efc6325d68ab9956a7d36dbbbb063a83515aaa8fd16064ed2f9b2c461fd4c3966aa5a341df
+  metadata.gz: 2570e0b6dc02a36accc1d6caeeeb19b064f6da7395f43a1d13af1629de401f67b94d07fcbd45dd82b5e6bc473860ede0c8a6e41f811eca5e66f1fda15398444c
+  data.tar.gz: eb2e7d4a6b6809f4a4eeec006de9816773407845c3a74a002fe082d7fb4190052389ea007b7357bf65651638d83c9cbafbc15135faba6decf145de16d0f48558

data/lib/sepa_rator/account/address.rb

@@ -2,8 +2,7 @@
 
 module SEPA
   class Address
-    include ActiveModel::Validations
-    include AttributeInitializer
+    include ActiveModel::Model
     extend Converter
 
     # PostalAddress6 fields (all schemas)

data/lib/sepa_rator/account/contact_details.rb

@@ -2,8 +2,7 @@
 
 module SEPA
   class ContactDetails
-    include ActiveModel::Validations
-    include AttributeInitializer
+    include ActiveModel::Model
     extend Converter
 
     NAME_PREFIXES = %w[DOCT MADM MISS MIST MIKS].freeze

data/lib/sepa_rator/account.rb

@@ -2,8 +2,7 @@
 
 module SEPA
   class Account
-    include ActiveModel::Validations
-    include AttributeInitializer
+    include ActiveModel::Model
     extend Converter
 
     attr_accessor :name, :iban, :bic, :address, :agent_lei, :contact_details
@@ -11,28 +10,10 @@ module SEPA
     convert :name, to: :text
 
     validates_length_of :name, within: 1..70
-    validates_with BICValidator, IBANValidator, message: 'is invalid'
+    validates_with BICValidator, message: 'is invalid'
+    validates_with IBANValidator
     validates_with LEIValidator, field_name: :agent_lei, message: 'is invalid'
-
-    validate do |record|
-      next unless record.address
-
-      unless record.address.valid?
-        record.address.errors.each do |error|
-          record.errors.add(:address, error.full_message)
-        end
-      end
-    end
-
-    validate do |record|
-      next unless record.contact_details
-
-      unless record.contact_details.valid?
-        record.contact_details.errors.each do |error|
-          record.errors.add(:contact_details, error.full_message)
-        end
-      end
-    end
+    validates :address, :contact_details, nested_model: true, allow_nil: true
 
     def initiating_party_id(builder, schema_name); end
 

data/lib/sepa_rator/concerns/schema_validation.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
+require 'active_support/concern'
+
 module SEPA
   module SchemaValidation
+    extend ActiveSupport::Concern
+
     SCHEMA_DIR = File.expand_path('../../schema', __dir__).freeze
     SCHEMA_CACHE_MUTEX = Mutex.new
 
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
+    class_methods do
       def schema_cache
         @schema_cache ||= {}
       end

data/lib/sepa_rator/nested_model_validator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Validates nested ActiveModel objects and propagates their errors.
+# Defined at root level so ActiveModel's const_get lookup finds it from any namespace.
+# Usage: validates :address, :contact_details, nested_model: true
+class NestedModelValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    return unless value
+    return if value.valid?
+
+    value.errors.each { |error| record.errors.add(attribute, error.full_message) }
+  end
+end

data/lib/sepa_rator/transaction/credit_transfer_transaction.rb

@@ -21,7 +21,8 @@ module SEPA
                   :credit_transfer_mandate_id,
                   :credit_transfer_mandate_date_of_signature,
                   :credit_transfer_mandate_frequency,
-                  :creditor_contact_details
+                  :creditor_contact_details,
+                  :creditor_address
 
     CHARGE_BEARERS = %w[DEBT CRED SHAR SLEV].freeze
     EPC_ONLY_SCHEMAS = %w[pain.001.002.03 pain.001.003.03].freeze
@@ -39,7 +40,7 @@ module SEPA
     validates_inclusion_of :service_level, in: %w[SEPA URGP], allow_nil: true
     validates_length_of :category_purpose, within: 1..4, allow_nil: true
     validates_inclusion_of :charge_bearer, in: CHARGE_BEARERS, allow_nil: true
-    validates_address :creditor_address
+    validates :creditor_address, :creditor_contact_details, nested_model: true, allow_nil: true
 
     convert :debtor_agent_instruction, :instruction_for_debtor_agent,
             :credit_transfer_mandate_id, to: :text
@@ -50,11 +51,6 @@ module SEPA
     validates_length_of :credit_transfer_mandate_id, within: 1..35, allow_nil: true
     validates_inclusion_of :credit_transfer_mandate_frequency, in: FREQUENCY_CODES, allow_nil: true
 
-    validate do |t|
-      next unless t.creditor_contact_details && !t.creditor_contact_details.valid?
-
-      t.creditor_contact_details.errors.each { |error| t.errors.add(:creditor_contact_details, error.full_message) }
-    end
     validate { |t| t.validate_requested_date_after(Date.today) }
     validate :validate_instructions_for_creditor_agent
     validate :validate_regulatory_reportings

data/lib/sepa_rator/transaction/direct_debit_transaction.rb

@@ -16,7 +16,8 @@ module SEPA
                   :original_debtor_account,
                   :same_mandate_new_debtor_agent,
                   :original_creditor_account,
-                  :debtor_contact_details
+                  :debtor_contact_details,
+                  :debtor_address
 
     CHARGE_BEARERS = %w[DEBT CRED SHAR SLEV].freeze
 
@@ -25,23 +26,14 @@ module SEPA
     validates_inclusion_of :local_instrument, in: LOCAL_INSTRUMENTS
     validates_inclusion_of :sequence_type, in: SEQUENCE_TYPES
     validates_inclusion_of :charge_bearer, in: CHARGE_BEARERS, allow_nil: true
-    validates_address :debtor_address
-    validate do |t|
-      next unless t.debtor_contact_details && !t.debtor_contact_details.valid?
-
-      t.debtor_contact_details.errors.each { |error| t.errors.add(:debtor_contact_details, error.full_message) }
-    end
+    validates :debtor_address, :debtor_contact_details, :creditor_account, nested_model: true, allow_nil: true
     validate { |t| t.validate_requested_date_after(Date.today.next) }
 
     validate do |t|
       errors.add(:original_mandate_id, 'is invalid') if original_mandate_id && !original_mandate_id.to_s.match?(MandateIdentifierValidator::REGEX)
 
-      errors.add(:creditor_account, 'is not correct') if creditor_account && !creditor_account.valid?
-
-      if original_debtor_account && !original_debtor_account.to_s.empty?
-        iban_str = original_debtor_account.to_s
-        errors.add(:original_debtor_account, 'is not a valid IBAN') unless
-          IBANTools::IBAN.valid?(iban_str) && iban_str.match?(IBANValidator::REGEX)
+      if original_debtor_account && !original_debtor_account.to_s.empty? && !IBANValidator.valid_iban?(original_debtor_account)
+        errors.add(:original_debtor_account, 'is not a valid IBAN')
       end
 
       if t.mandate_date_of_signature.is_a?(Date)

data/lib/sepa_rator/transaction.rb

@@ -2,25 +2,9 @@
 
 module SEPA
   class Transaction
-    include ActiveModel::Validations
-    include AttributeInitializer
+    include ActiveModel::Model
     extend Converter
 
-    # DSL to declare and validate address fields on subclasses (ISP-compliant).
-    # Each subclass declares only the address it actually uses.
-    def self.validates_address(*fields)
-      fields.each do |field|
-        attr_accessor field
-
-        validate do |t|
-          address = t.public_send(field)
-          next unless address && !address.valid?
-
-          address.errors.each { |error| t.errors.add(field, error.full_message) }
-        end
-      end
-    end
-
     # Convention SEPA: 1999-01-01 signifies "execute as soon as possible" (ASAP).
     # When no specific date is requested, this sentinel value tells the bank
     # to process the payment at the earliest opportunity.
@@ -70,7 +54,8 @@ module SEPA
     UETR_REGEX = /\A[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}\z/
     validates_format_of :uetr, with: UETR_REGEX, allow_nil: true
     validates_inclusion_of :batch_booking, in: [true, false]
-    validates_with BICValidator, IBANValidator, message: 'is invalid'
+    validates_with BICValidator, message: 'is invalid'
+    validates_with IBANValidator
     validates_with LEIValidator, field_name: :agent_lei, message: 'is invalid'
 
     validate do |t|

data/lib/sepa_rator/validator.rb

@@ -1,17 +1,38 @@
 # frozen_string_literal: true
 
 module SEPA
+  # ISO 7064 Mod 97-10 checksum used by IBAN, LEI, and Creditor Identifier
+  def self.mod97_valid?(alphanumeric_string)
+    numeric = alphanumeric_string.gsub(/[A-Z]/i) { |c| c.upcase.ord - 55 }
+    numeric.to_i % 97 == 1
+  end
+
   class IBANValidator < ActiveModel::Validator
-    # IBAN2007Identifier (taken from schema)
-    REGEX = /\A[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}\z/
+    def self.valid_iban?(value)
+      iban = Ibandit::IBAN.new(value.to_s)
+      iban.valid? && value.to_s == iban.iban
+    end
 
     def validate(record)
       field_name = options[:field_name] || :iban
       value = record.public_send(field_name).to_s
 
-      return if IBANTools::IBAN.valid?(value) && value.match?(REGEX)
+      iban = Ibandit::IBAN.new(value)
+      unless iban.valid?
+        record.errors.add(field_name, :invalid, message: options[:message] || iban_error_message(iban))
+        return
+      end
+      return if value == iban.iban
 
-      record.errors.add(field_name, :invalid, message: options[:message])
+      record.errors.add(field_name, :invalid,
+                        message: options[:message] || 'is invalid (must be uppercase with no spaces)')
+    end
+
+    private
+
+    def iban_error_message(iban)
+      details = iban.errors.map { |key, msg| "#{key} #{msg}" }.join(', ')
+      details.empty? ? 'is invalid' : "is invalid (#{details})"
     end
   end
 
@@ -63,9 +84,7 @@ module SEPA
       # Strip non-alphanumeric chars from national id before check (the spec allows +?/:().,'-
       # but they are ignored for mod-97 computation)
       check_base = creditor_identifier[0..3] + creditor_identifier[7..].gsub(/[^A-Za-z0-9]/, '')
-      rearranged = check_base[4..] + check_base[0..3]
-      numeric = rearranged.gsub(/[A-Z]/i) { |c| c.upcase.ord - 55 }
-      numeric.to_i % 97 == 1
+      SEPA.mod97_valid?(check_base[4..] + check_base[0..3])
     end
   end
 
@@ -91,9 +110,17 @@ module SEPA
       value = record.public_send(field_name)
 
       return unless value
-      return if value.to_s.match?(REGEX)
+      return if valid_lei?(value.to_s)
 
       record.errors.add(field_name, :invalid, message: options[:message])
     end
+
+    private
+
+    def valid_lei?(value)
+      return false unless value.match?(REGEX)
+
+      SEPA.mod97_valid?(value)
+    end
   end
 end

data/lib/sepa_rator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SEPA
-  VERSION = '0.15.0'
+  VERSION = '0.16.0'
 end

data/lib/sepa_rator.rb

@@ -3,12 +3,12 @@
 require 'active_model'
 require 'bigdecimal'
 require 'nokogiri'
-require 'iban-tools'
+require 'ibandit'
 
 require 'sepa_rator/error'
 require 'sepa_rator/converter'
 require 'sepa_rator/validator'
-require 'sepa_rator/concerns/attribute_initializer'
+require 'sepa_rator/nested_model_validator'
 require 'sepa_rator/concerns/schema_validation'
 require 'sepa_rator/concerns/xml_builder'
 require 'sepa_rator/concerns/regulatory_reporting_validator'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sepa_rator
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Georg Leciejewski
@@ -32,19 +32,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '9'
 - !ruby/object:Gem::Dependency
-  name: iban-tools
+  name: ibandit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -86,7 +86,6 @@ files:
 - lib/sepa_rator/account/creditor_address.rb
 - lib/sepa_rator/account/debtor_account.rb
 - lib/sepa_rator/account/debtor_address.rb
-- lib/sepa_rator/concerns/attribute_initializer.rb
 - lib/sepa_rator/concerns/regulatory_reporting_validator.rb
 - lib/sepa_rator/concerns/schema_validation.rb
 - lib/sepa_rator/concerns/xml_builder.rb
@@ -95,6 +94,7 @@ files:
 - lib/sepa_rator/message.rb
 - lib/sepa_rator/message/credit_transfer.rb
 - lib/sepa_rator/message/direct_debit.rb
+- lib/sepa_rator/nested_model_validator.rb
 - lib/sepa_rator/transaction.rb
 - lib/sepa_rator/transaction/credit_transfer_transaction.rb
 - lib/sepa_rator/transaction/direct_debit_transaction.rb

data/lib/sepa_rator/concerns/attribute_initializer.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module SEPA
-  module AttributeInitializer
-    def self.included(base)
-      base.include ActiveModel::AttributeAssignment
-      base.extend ClassMethods
-    end
-
-    module ClassMethods
-      def permitted_attributes
-        @permitted_attributes ||= begin
-          own_setters = instance_methods(false)
-                        .select { |m| m.to_s.end_with?('=') }
-                        .to_set { |m| m.to_s.chomp('=') }
-
-          if superclass.respond_to?(:permitted_attributes)
-            own_setters | superclass.permitted_attributes
-          else
-            own_setters
-          end
-        end.freeze
-      end
-    end
-
-    def initialize(attributes = {})
-      assign_attributes(attributes)
-    rescue ActiveModel::UnknownAttributeError => e
-      raise ArgumentError, "Unknown attribute: #{e.attribute}"
-    end
-
-    private
-
-    def _assign_attribute(key, value)
-      raise ArgumentError, "Unknown attribute: #{key}" unless self.class.permitted_attributes.include?(key.to_s)
-
-      public_send("#{key}=", value)
-    end
-  end
-end