sepa_king 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72f5b41884bc29b3dfe4032b8973d0b4f99fce20
-  data.tar.gz: 49097e2be968e3ac86c9660214d18512a9d289b6
+  metadata.gz: c78e42fd31151e02569f9f54ee43fc82691ba3f9
+  data.tar.gz: 100d813077c65787e992689fe15eede1a7424f3d
 SHA512:
-  metadata.gz: f17e0ff69c50df21d785deb0b92d57f2c16ad34c3fe9ba4a828032d01322b1dba0f705207cf843ed166bad6d13129a91388b2991373fa2f7199e48d7c5c20614
-  data.tar.gz: 626b15c006d37daa9bb4882c2cf973efd6fae25f0d595ca202edc42e81fe129fbf14260de7452caafa1c370e9d8099c1569ed7937d601728e275afe1e1af0145
+  metadata.gz: 7a1c98624cd47da6dfaffe4aa498a6a35f24c22b74abfc1f0f8fdb442c2603bea00a381df53ee6a9ef0fdd2d5d7fff32c366d7d49c4e95f22993fa5640079b1f
+  data.tar.gz: d72486654271db57e2a778cc396ec0183d998949eb19646720fbb4131e0ce2eb62901f4f807a4acecc3e88db471b9ce6bdbac4765c8779fda10f200fcd81b9bc

data/.travis.yml

@@ -1,3 +1,4 @@
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0

data/README.md

@@ -23,7 +23,7 @@ BTW: **pain** is a shortcut for **Pa**yment **In**itiation.
 
 ## Requirements
 
-* Ruby 1.9.3 or 2.0.0
+* Ruby 1.9.3 or newer
 
 
 ## Installation
@@ -194,6 +194,36 @@ xml_string = sct.to_xml # Use latest schema pain.001.003.03
 xml_string = sct.to_xml('pain.001.002.03') # Use former schema pain.001.002.03
 ```
 
+## Validations
+
+You can rely on our internal validations, raising errors when needed, during
+message creation.
+To validate your models holding SEPA related information (e.g. BIC, IBAN,
+mandate_id) you can use our validator classes or rely on some constants.
+
+Examples:
+
+```ruby
+class BankAccount < ActiveRecord::Base
+  # IBAN validation, by default it validates the attribute named "iban"
+  validates_with SEPA::IBANValidator, field_name: :iban_the_terrible
+
+  # BIC validation, by default it validates the attribute named "bic"
+  validates_with SEPA::BICValidator, field_name: :bank_bic
+end
+
+class Payment < ActiveRecord::Base
+  validates_inclusion_of :sepa_sequence_type, in: SEPA::DirectDebitTransaction::SEQUENCE_TYPES
+
+  # Mandate ID validation, by default it validates the attribute named "mandate_id"
+  validates_with SEPA::MandateIdentifierValidator, field_name: :mandate_id
+end
+```
+
+Also see:
+* [lib/sepa_king/validator.rb](https://github.com/salesking/sepa_king/blob/master/lib/sepa_king/validator.rb)
+* [lib/sepa_king/transaction/direct_debit_transaction.rb](https://github.com/salesking/sepa_king/blob/master/lib/sepa_king/transaction/direct_debit_transaction.rb)
+
 
 ## Changelog
 

data/lib/sepa_king/message.rb

@@ -13,7 +13,7 @@ module SEPA
 
     validates_presence_of :transactions
     validate do |record|
-      record.errors.add(:account, 'is invalid') unless record.account.valid?
+      record.errors.add(:account, record.account.errors.full_messages) unless record.account.valid?
     end
 
     class_attribute :account_class, :transaction_class, :xml_main_tag, :known_schemas
@@ -59,6 +59,13 @@ module SEPA
       end
     end
 
+    attr_writer :message_identification # Set unique identifer for the message
+
+    # Unique identifer for the whole message
+    def message_identification
+      @message_identification ||= "SEPA-KING/#{Time.now.to_i}"
+    end
+
   private
     # @return {Hash<Symbol=>String>} xml schema information used in output xml
     def xml_schema(schema_name)
@@ -79,11 +86,6 @@ module SEPA
       end
     end
 
-    # Unique identifer for the whole message
-    def message_identification
-      @message_identification ||= "SEPA-KING/#{Time.now.to_i}"
-    end
-
     # Unique and consecutive identifier (used for the <PmntInf> blocks)
     def payment_information_identification
       @payment_information_counter ||= 0

data/lib/sepa_king/transaction/credit_transfer_transaction.rb

@@ -5,6 +5,12 @@ module SEPA
 
     validates_inclusion_of :service_level, :in => %w(SEPA URGP)
 
+    validate do |t|
+      if t.requested_date.is_a?(Date)
+        errors.add(:requested_date, 'is in the past') if t.requested_date < Date.today
+      end
+    end
+
     def initialize(attributes = {})
       super
       self.service_level ||= 'SEPA'

data/lib/sepa_king/transaction/direct_debit_transaction.rb

@@ -1,12 +1,15 @@
 # encoding: utf-8
 module SEPA
   class DirectDebitTransaction < Transaction
+    SEQUENCE_TYPES = %w(FRST OOFF RCUR FNAL)
+    LOCAL_INSTRUMENTS = %w(CORE COR1 B2B)
+
     attr_accessor :mandate_id, :mandate_date_of_signature, :local_instrument, :sequence_type, :creditor_account
 
-    validates_length_of :mandate_id, within: 1..35
+    validates_with MandateIdentifierValidator, field_name: :mandate_id
     validates_presence_of :mandate_date_of_signature
-    validates_inclusion_of :local_instrument, :in => %w(CORE COR1 B2B)
-    validates_inclusion_of :sequence_type, :in => %w(FRST OOFF RCUR FNAL)
+    validates_inclusion_of :local_instrument, in: LOCAL_INSTRUMENTS
+    validates_inclusion_of :sequence_type, in: SEQUENCE_TYPES
 
     validate do |t|
       if creditor_account
@@ -18,6 +21,10 @@ module SEPA
       else
         errors.add(:mandate_date_of_signature, 'is not a Date')
       end
+
+      if t.requested_date.is_a?(Date)
+        errors.add(:requested_date, 'is not in the future') if t.requested_date <= Date.today
+      end
     end
 
     def initialize(attributes = {})

data/lib/sepa_king/transaction.rb

@@ -16,12 +16,6 @@ module SEPA
     validates_inclusion_of :batch_booking, :in => [true, false]
     validates_with BICValidator, IBANValidator
 
-    validate do |t|
-      if t.requested_date.is_a?(Date)
-        errors.add(:requested_date, 'is not in the future') if t.requested_date <= Date.today
-      end
-    end
-
     def initialize(attributes = {})
       attributes.each do |name, value|
         send("#{name}=", value)

data/lib/sepa_king/validator.rb

@@ -2,31 +2,44 @@
 module SEPA
   class IBANValidator < ActiveModel::Validator
     def validate(record)
-      unless IBANTools::IBAN.valid?(record.iban.to_s)
-        record.errors.add(:iban, :invalid)
+      field_name = options[:field_name] || :iban
+      value = record.send(field_name)
+
+      unless IBANTools::IBAN.valid?(value.to_s)
+        record.errors.add(field_name, :invalid)
       end
     end
   end
 
   class BICValidator < ActiveModel::Validator
+    REGEX = /\A[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}\z/
+
     def validate(record)
-      if record.bic
-        unless record.bic.to_s.match /[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}/
-          record.errors.add(:bic, :invalid)
+      field_name = options[:field_name] || :bic
+      value = record.send(field_name)
+
+      if value
+        unless value.to_s.match(REGEX)
+          record.errors.add(field_name, :invalid)
         end
       end
     end
   end
 
   class CreditorIdentifierValidator < ActiveModel::Validator
+    REGEX = /\A[a-zA-Z]{2,2}[0-9]{2,2}([A-Za-z0-9]|[\+|\?|\/|\-|\:|\(|\)|\.|,|']){3,3}([A-Za-z0-9]|[\+|\?|\/|\-|:|\(|\)|\.|,|']){1,28}\z/
+
     def validate(record)
-      unless valid?(record.creditor_identifier)
-        record.errors.add(:creditor_identifier, :invalid)
+      field_name = options[:field_name] || :creditor_identifier
+      value = record.send(field_name)
+
+      unless valid?(value)
+        record.errors.add(field_name, :invalid)
       end
     end
 
     def valid?(creditor_identifier)
-      if ok = creditor_identifier.to_s.match(/[a-zA-Z]{2,2}[0-9]{2,2}([A-Za-z0-9]|[\+|\?|\/|\-|\:|\(|\)|\.|,|']){3,3}([A-Za-z0-9]|[\+|\?|\/|\-|:|\(|\)|\.|,|']){1,28}/)
+      if ok = creditor_identifier.to_s.match(REGEX)
         # In Germany, the identifier has to be exactly 18 chars long
         if creditor_identifier[0..1].match(/DE/i)
           ok = creditor_identifier.length == 18
@@ -35,4 +48,17 @@ module SEPA
       ok
     end
   end
+
+  class MandateIdentifierValidator < ActiveModel::Validator
+    REGEX = /\A([A-Za-z0-9]|[\+|\?|\/|\-|\:|\(|\)|\.|\,|\']){1,35}\z/
+
+    def validate(record)
+      field_name = options[:field_name] || :mandate_id
+      value = record.send(field_name)
+
+      unless value.to_s.match(REGEX)
+        record.errors.add(field_name, :invalid)
+      end
+    end
+  end
 end

data/lib/sepa_king/version.rb

@@ -1,3 +1,3 @@
 module SEPA
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/credit_transfer_transaction_spec.rb

@@ -33,4 +33,14 @@ describe SEPA::CreditTransferTransaction do
       end
     end
   end
+
+  context 'Requested date' do
+    it 'should allow valid value' do
+      SEPA::CreditTransferTransaction.should accept(nil, Date.today, Date.today.next, Date.today + 2, for: :requested_date)
+    end
+
+    it 'should not allow invalid value' do
+      SEPA::CreditTransferTransaction.should_not accept(Date.new(1995,12,21), Date.today - 1, for: :requested_date)
+    end
+  end
 end

data/spec/direct_debit_transaction_spec.rb

@@ -46,13 +46,13 @@ describe SEPA::DirectDebitTransaction do
     end
   end
 
-  context 'Mandate ID' do
+  context 'Requested date' do
     it 'should allow valid value' do
-      SEPA::DirectDebitTransaction.should accept('XYZ-123', 'X' * 35, for: :mandate_id)
+      SEPA::DirectDebitTransaction.should accept(nil, Date.today.next, Date.today + 2, for: :requested_date)
     end
 
     it 'should not allow invalid value' do
-      SEPA::DirectDebitTransaction.should_not accept(nil, '', 'X' * 36, for: :mandate_id)
+      SEPA::DirectDebitTransaction.should_not accept(Date.new(1995,12,21), Date.today - 1, Date.today, for: :requested_date)
     end
   end
 end

data/spec/message_spec.rb

@@ -33,7 +33,7 @@ describe SEPA::Message do
 
     it 'should fail with invalid account' do
       subject.should_not be_valid
-      subject.should have(1).error_on(:account)
+      subject.should have(2).error_on(:account)
     end
 
     it 'should fail without transactions' do
@@ -41,4 +41,17 @@ describe SEPA::Message do
       subject.should have(1).error_on(:transactions)
     end
   end
+
+  describe :message_identification do
+    subject { DummyMessage.new }
+
+    it 'should have a reader method' do
+      subject.message_identification.should match(/SEPA-KING\/[0-9]+/)
+    end
+
+    it 'should have a writer method' do
+      subject.message_identification = "MY_MESSAGE_ID/#{Time.now.to_i}"
+      subject.message_identification.should match(/MY_MESSAGE_ID/)
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -16,6 +16,10 @@ end
 
 require 'sepa_king'
 
+if I18n.respond_to?(:enforce_available_locales=)
+  I18n.enforce_available_locales = false
+end
+
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
 Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}

data/spec/support/custom_matcher.rb

@@ -36,21 +36,25 @@ RSpec::Matchers.define :have_xml do |xpath, text|
 end
 
 RSpec::Matchers.define :accept do |*values, options|
-  attribute = options[:for]
-
-  match_for_should do |actual|
-    values.all? { |value|
-      expect(
-        actual.new(attribute => value)
-      ).to have(:no).errors_on(attribute)
-    }
+  attributes = Array(options[:for])
+
+  attributes.each do |attribute|
+    match_for_should do |actual|
+      values.all? { |value|
+        expect(
+          actual.new(attribute => value)
+        ).to have(:no).errors_on(attribute)
+      }
+    end
   end
 
-  match_for_should_not do |actual|
-    values.all? { |value|
-      expect(
-        actual.new(attribute => value)
-      ).to have_at_least(1).errors_on(attribute)
-    }
+  attributes.each do |attribute|
+    match_for_should_not do |actual|
+      values.all? { |value|
+        expect(
+          actual.new(attribute => value)
+        ).to have_at_least(1).errors_on(attribute)
+      }
+    end
   end
 end

data/spec/transaction_spec.rb

@@ -75,14 +75,4 @@ describe SEPA::Transaction do
       SEPA::Transaction.should_not accept('', 'X' * 141, for: :remittance_information)
     end
   end
-
-  context 'Requested date' do
-    it 'should allow valid value' do
-      SEPA::Transaction.should accept(nil, Date.today.next, Date.today + 2, for: :requested_date)
-    end
-
-    it 'should not allow invalid value' do
-      SEPA::Transaction.should_not accept(Date.new(1995,12,21), Date.today - 1, Date.today, for: :requested_date)
-    end
-  end
 end

data/spec/validator_spec.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe SEPA::IBANValidator do
+  class Validatable
+    include ActiveModel::Model
+    attr_accessor :iban, :iban_the_terrible
+    validates_with SEPA::IBANValidator
+    validates_with SEPA::IBANValidator, field_name: :iban_the_terrible
+  end
+
+  it 'should accept valid IBAN' do
+    Validatable.should accept('DE21500500009876543210', 'DE87200500001234567890', for: [:iban, :iban_the_terrible])
+  end
+
+  it 'should not accept an invalid IBAN' do
+    Validatable.should_not accept('', 'xxx', 'DE22500500009876543210', 'DE2150050000987654321', for: [:iban, :iban_the_terrible])
+  end
+end
+
+describe SEPA::BICValidator do
+  class Validatable
+    include ActiveModel::Model
+    attr_accessor :bic, :custom_bic
+    validates_with SEPA::BICValidator
+    validates_with SEPA::BICValidator, field_name: :custom_bic
+  end
+
+  it 'should accept valid BICs' do
+    Validatable.should accept('DEUTDEDBDUE', 'DUSSDEDDXXX', for: [:bic, :custom_bic])
+  end
+
+  it 'should not accept an invalid BIC' do
+    Validatable.should_not accept('', 'GENODE61HR', 'DEUTDEDBDUEDEUTDEDBDUE', for: [:bic, :custom_bic])
+  end
+end
+
+describe SEPA::CreditorIdentifierValidator do
+  class Validatable
+    include ActiveModel::Model
+    attr_accessor :creditor_identifier, :crid
+    validates_with SEPA::CreditorIdentifierValidator
+    validates_with SEPA::CreditorIdentifierValidator, field_name: :crid
+  end
+
+  it 'should accept valid creditor_identifier' do
+    Validatable.should accept('DE98ZZZ09999999999', 'AT12ZZZ00000000001', 'FR12ZZZ123456', 'NL97ZZZ123456780001', for: [:creditor_identifier, :crid])
+  end
+
+  it 'should not accept an invalid creditor_identifier' do
+    Validatable.should_not accept('', 'xxx', 'DE98ZZZ099999999990', for: [:creditor_identifier, :crid])
+  end
+end
+
+describe SEPA::MandateIdentifierValidator do
+  class Validatable
+    include ActiveModel::Model
+    attr_accessor :mandate_id, :mid
+    validates_with SEPA::MandateIdentifierValidator
+    validates_with SEPA::MandateIdentifierValidator, field_name: :mid
+  end
+
+  it 'should accept valid mandate_identifier' do
+    Validatable.should accept('XYZ-123', "+?/-:().,'", 'X' * 35, for: [:mandate_id, :mid])
+  end
+
+  it 'should not accept an invalid mandate_identifier' do
+    Validatable.should_not accept(nil, '', 'X' * 36, 'ABC 123', '#/*', 'Ümläüt', for: [:mandate_id, :mid])
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sepa_king
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Georg Leciejewski
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-04 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -204,6 +204,7 @@ files:
 - spec/support/validations.rb
 - spec/transaction_spec.rb
 - spec/validation_spec.rb
+- spec/validator_spec.rb
 homepage: http://github.com/salesking/sepa_king
 licenses:
 - MIT
@@ -224,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby gem for creating SEPA XML files
@@ -248,3 +249,4 @@ test_files:
 - spec/support/validations.rb
 - spec/transaction_spec.rb
 - spec/validation_spec.rb
+- spec/validator_spec.rb