validates_iban_format_of 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7857aa63e60413b700f7e592b78e93cbfdc0830
+  data.tar.gz: 3e20eab0f8a9e4db63e766368c842ee121ebbcbc
+SHA512:
+  metadata.gz: fc4aa352f55c15a156beaf6e1221d25d710104de24b7b1fd95a4bc88757020d41e2af697899764656b594c82662725755e3a4afb60b082c9b2ac3cdfda598100
+  data.tar.gz: 7c6fddd7ecdd3284dabddeff48da12fca3fece2b2fc6f80b3a0adcad55aedd088c7ec0a5a58f205a0bb19092218c08d3475265cfe9ab62c5f1241a21c96e05b9

data/.gitignore

@@ -0,0 +1,8 @@
+pkg
+test/debug.log
+rdoc
+Gemfile.lock
+*.gem
+*.sqlite3
+*.swp
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2017 Dimitar Kostov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# validates_iban_format_of
+
+Rails IBAN validator based on [iban-tools gem](https://github.com/alphasights/iban-tools)
+
+# Installation
+
+Add it to your Gemfile:
+
+```ruby
+gem 'validates_iban_format_of'
+```
+
+# Usage
+
+## In ActiveRecord model
+
+```ruby
+# I18n locales are loaded automatically.
+
+class BankAccount < ActiveRecord::Base
+  validates_iban_format_of :iban, message_for_invalid: 'is not incorrect', message_for_missing: 'is blank'
+
+  # OR
+  # validates :iban, iban_format: { message_for_invalid: 'is not incorrect', message_for_missing: 'is blank' }
+end
+```
+
+### In your model spec using RSpec:
+
+```ruby
+require "validates_iban_format_of/rspec_matcher"
+
+describe Person do
+  it { should validate_iban_format_of(:iban).with_message('is not looking good') }
+end
+```
+
+### Options
+
+```rdoc
+:message_for_invalid
+   String. A custom error message when the iban is invalid (default is: "is invalid")
+
+:message_for_missing
+   String. A custom error message when the iban is missing (default is: "is missing")
+
+:optional
+   Boolean. Flag to turn off valdiation for blank/nil case
+
+:generate_message
+  Boolean. Return the I18n key of the error message instead of the error message itself (default is false)
+
+:on, :if, :unless, :allow_nil, :allow_blank, :strict
+   Standard ActiveModel validation options.  These work in the ActiveModel/ActiveRecord/Rails syntax only.
+   See http://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validates for details.
+```
+
+# Testing
+
+To execute the unit tests run <tt>rspec</tt>.
+
+# Credits
+
+Written by [Dimitar Kostov](https://github.com/mytrile) [mitko.kostov@gmail.com](mailto:mitko.kostov@gmail.com)
+
+Many thanks to the [iban-tools gem](https://github.com/alphasights/iban-tools) for the real validation
+
+
+# LICENSE
+
+Copyright (c) 2017 Dimitar Kostov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  activemodel: &errors
+    errors:
+      messages:
+        invalid_iban: 'is invalid'
+        missing_iban: 'is missing'
+  activerecord:
+    <<: *errors

data/lib/validates_iban_format_of.rb

@@ -0,0 +1,54 @@
+require 'validates_iban_format_of/version'
+require 'iban-tools'
+
+module ValidatesIbanFormatOf
+  def self.load_i18n_locales
+    require 'i18n'
+    I18n.load_path += Dir.glob(File.expand_path(File.join(File.dirname(__FILE__), '..', 'config', 'locales', '*.yml')))
+  end
+
+  DEFAULT_MESSAGE_FOR_INVALID = 'is invalid'
+  DEFAULT_MESSAGE_FOR_MISSING = 'is missing'
+  ERROR_MESSAGE_INVALID_I18N_KEY = :invalid_iban
+  ERROR_MESSAGE_MISSING_I18N_KEY = :missing_iban
+
+  def self.default_message_for_invalid
+    defined?(I18n) ? I18n.t(ERROR_MESSAGE_INVALID_I18N_KEY, scope: %i(activemodel errors messages), default: DEFAULT_MESSAGE_FOR_INVALID) : DEFAULT_MESSAGE_FOR_INVALID
+  end
+
+  def self.default_message_for_missing
+    defined?(I18n) ? I18n.t(ERROR_MESSAGE_MISSING_I18N_KEY, scope: %i(activemodel errors messages), default: DEFAULT_MESSAGE_FOR_MISSING) : DEFAULT_MESSAGE_FOR_MISSING
+  end
+
+  # Validates whether the specified value is a valid IBAN. Returns nil if the value is valid, otherwise returns an array
+  # containing one or more validation error messages.
+  #
+  # Configuration options:
+  # * <tt>message_for_invalid</tt> - A custom error message for invalid (default is: 'is invalid')
+  # * <tt>message_for_missing</tt> - A custom error message for missing (default is: 'is missing')
+  # * <tt>optional</tt> - Flag to run valdiation ignoring blank/nil case
+  # * <tt>generate_message</tt> Return the I18n key of the error message instead of the error message itself (default is false)
+  def self.validate_iban_format(iban, options={})
+      default_options = {
+        message_for_invalid: options[:generate_message] ? ERROR_MESSAGE_INVALID_I18N_KEY : default_message_for_invalid,
+        message_for_missing: options[:generate_message] ? ERROR_MESSAGE_MISSING_I18N_KEY : default_message_for_missing,
+        generate_message: false,
+        optional: false
+      }
+
+      opts = options.merge(default_options) {|key, old, new| old}  # merge the default options into the specified options, retaining all specified options
+
+      if opts[:optional]
+        return nil if iban.nil? || iban.empty?
+      end
+
+      return [ opts[:message_for_missing] ] if iban.nil? || iban.empty?
+
+      return [ opts[:message_for_invalid] ] unless IBANTools::IBAN.valid?(iban)
+
+      return nil
+  end
+end
+
+require 'validates_iban_format_of/active_model' if defined?(::ActiveModel) && !(ActiveModel::VERSION::MAJOR < 2 || (2 == ActiveModel::VERSION::MAJOR && ActiveModel::VERSION::MINOR < 1))
+require 'validates_iban_format_of/railtie' if defined?(::Rails)

data/lib/validates_iban_format_of/active_model.rb

@@ -0,0 +1,20 @@
+require 'validates_iban_format_of'
+require 'active_model'
+
+module ActiveModel
+  module Validations
+    class IbanFormatValidator < EachValidator
+      def validate_each(record, attribute, value)
+        (ValidatesIbanFormatOf::validate_iban_format(value, options.merge(generate_message: true)) || []).each do |error|
+          record.errors.add(attribute, error)
+        end
+      end
+    end
+
+    module HelperMethods
+      def validates_iban_format_of(*attr_names)
+        validates_with IbanFormatValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

data/lib/validates_iban_format_of/railtie.rb

@@ -0,0 +1,7 @@
+module ValidatesIbanFormatOf
+  class Railtie < Rails::Railtie
+    initializer 'validates_iban_format_of.load_i18n_locales' do |app|
+      ValidatesIbanFormatOf::load_i18n_locales
+    end
+  end
+end

data/lib/validates_iban_format_of/rspec_matcher.rb

@@ -0,0 +1,15 @@
+require 'validates_iban_format_of'
+
+RSpec::Matchers.define :validate_iban_format_of do |attribute|
+  match do
+    actual_class_name = subject.is_a?(Class) ? subject : subject.class
+    actual = actual_class_name.new
+    actual.send(:"#{attribute}=", 'GB82 WEST 1234')
+    expect(actual).to be_invalid
+    @expected_message ||= ValidatesIbanFormatOf.default_message_for_invalid
+    actual.errors[attribute.to_sym].include?(@expected_message)
+  end
+  chain :with_message do |message|
+    @expected_message = message
+  end
+end

data/lib/validates_iban_format_of/version.rb

@@ -0,0 +1,3 @@
+module ValidatesIbanFormatOf
+  VERSION = '1.0.0'
+end

data/spec/rspec_matcher_spec.rb

@@ -0,0 +1,14 @@
+require "#{File.expand_path(File.dirname(__FILE__))}/spec_helper"
+if defined?(ActiveModel)
+  require "validates_iban_format_of/rspec_matcher"
+
+  class Person
+    attr_accessor :iban
+    include ::ActiveModel::Validations
+    validates_iban_format_of :iban
+  end
+
+  describe Person do
+    it { should validate_iban_format_of(:iban) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require "active_model" if Gem.loaded_specs.keys.include?("activemodel")
+
+RSpec::Matchers.define :have_errors_on_iban do
+  match do |actual|
+    expect(actual).not_to be_nil, "#{actual} should not be nil"
+    expect(actual).not_to be_empty, "#{actual} should not be empty"
+    expect(actual.size).to eq(@reasons.size), "#{actual} should have #{@reasons.size} elements"
+    @reasons.each do |reason|
+      reason = "#{"IBAN " if defined?(ActiveModel)}#{reason}"
+      expect(actual).to include(reason), "#{actual} should contain #{reason}"
+    end
+  end
+  chain :because do |reason|
+    (@reasons ||= []) << reason
+  end
+  chain :and_because do |reason|
+    (@reasons ||= []) << reason
+  end
+  match_when_negated do |actual|
+    expect(actual).to (defined?(ActiveModel) ? be_empty : be_nil)
+  end
+end
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    ValidatesIbanFormatOf.load_i18n_locales
+    I18n.enforce_available_locales = false
+  end
+end

data/spec/validates_iban_format_of_spec.rb

@@ -0,0 +1,189 @@
+require "#{File.expand_path(File.dirname(__FILE__))}/spec_helper"
+require "validates_iban_format_of"
+
+describe ValidatesIbanFormatOf do
+  subject do |example|
+    if defined?(ActiveModel)
+      user = Class.new do
+        def initialize(iban)
+          @iban = iban.freeze
+        end
+        attr_reader :iban
+        include ActiveModel::Validations
+        validates_iban_format_of :iban, example.example_group_instance.options
+      end
+      example.example_group_instance.class::User = user
+      user.new(example.example_group_instance.iban).tap(&:valid?).errors.full_messages
+    else
+      ValidatesIbanFormatOf::validate_iban_format(iban.freeze, options)
+    end
+  end
+  let(:options) { {} }
+  let(:iban) { |example| example.example_group.description }
+
+  shared_examples_for :all_specs do
+    # Taken directly from iban-tools gem
+    # Samples from http://www.tbg5-finance.org/?ibandocs.shtml/
+    [
+      "AD1200012030200359100100",
+      "AE070331234567890123456",
+      "AL47212110090000000235698741",
+      "AT611904300234573201",
+      "AZ21NABZ00000000137010001944",
+      "BA391290079401028494",
+      "BE68539007547034",
+      "BG80BNBG96611020345678",
+      "BH67BMAG00001299123456",
+      "BR9700360305000010009795493P1",
+      "CH9300762011623852957",
+      "CY17002001280000001200527600",
+      "CZ6508000000192000145399",
+      "DE89370400440532013000",
+      "DK5000400440116243",
+      "DO28BAGR00000001212453611324",
+      "EE382200221020145685",
+      "ES9121000418450200051332",
+      "FI2112345600000785",
+      "FO7630004440960235",
+      "FR1420041010050500013M02606",
+      "GB29NWBK60161331926819",
+      "GE29NB0000000101904917",
+      "GI75NWBK000000007099453",
+      "GL4330003330229543",
+      "GR1601101250000000012300695",
+      "HR1210010051863000160",
+      "HU42117730161111101800000000",
+      "IE29AIBK93115212345678",
+      "IL620108000000099999999",
+      "IS140159260076545510730339",
+      "IT60X0542811101000000123456",
+      "JO94CBJO0010000000000131000302",
+      "KW81CBKU0000000000001234560101",
+      "KZ86125KZT5004100100",
+      "LB62099900000001001901229114",
+      "LI21088100002324013AA",
+      "LT121000011101001000",
+      "LU280019400644750000",
+      "LV80BANK0000435195001",
+      "MC1112739000700011111000h79",
+      "MD24AG000225100013104168",
+      "ME25505000012345678951",
+      "MK07300000000042425",
+      "MR1300020001010000123456753",
+      "MT84MALT011000012345MTLCAST001S",
+      "MU17BOMM0101101030300200000MUR",
+      "NL91ABNA0417164300",
+      "NO9386011117947",
+      "PL27114020040000300201355387",
+      "PK36SCBL0000001123456702",
+      "PT50000201231234567890154",
+      "QA58DOHB00001234567890ABCDEFG",
+      "RO49AAAA1B31007593840000",
+      "RS35260005601001611379",
+      "SA0380000000608010167519",
+      "SE3550000000054910000003",
+      "SI56191000000123438",
+      "SK3112000000198742637541",
+      "SM86U0322509800000000270100",
+      "TN5914207207100707129648",
+      "TR330006100519786457841326",
+      "UA173052990006762462622943782"
+    ].each do |address|
+      describe address do
+        it { should_not have_errors_on_iban }
+      end
+    end
+
+    [
+      "random string",
+      12345698765432,
+      "gb99 %BC",
+      "NOW9386011117947",
+      "GB69 7654 1234 5698 7654 32",
+      "GB99 WEST 1234 5698 7654 32",
+      "RO7999991B31007593840000"
+    ].each do |address|
+      describe address do
+        it { should have_errors_on_iban.because("is invalid") }
+      end
+    end
+
+    describe "" do
+      it { should have_errors_on_iban.because("is missing") }
+    end
+
+    describe nil do
+      it { should have_errors_on_iban.because("is missing") }
+    end
+
+    describe "with optional config" do
+      let(:options) { { optional: true } }
+      describe "" do
+        it { should_not have_errors_on_iban }
+      end
+
+      describe nil do
+        it { should_not have_errors_on_iban }
+      end
+    end
+
+    describe "custom error messages" do
+      describe "invalid example" do
+        let(:options) { { message_for_invalid: "just because it's invalid" } }
+        it { should have_errors_on_iban.because("just because it's invalid") }
+      end
+      describe "" do
+        let(:options) { { message_for_missing: "is blank" } }
+        it { should have_errors_on_iban.because("is blank") }
+      end
+      describe nil do
+        let(:options) { { message_for_missing: "is blank" } }
+        it { should have_errors_on_iban.because("is blank") }
+      end
+    end
+
+    describe "i18n" do
+      before(:each) do
+        allow(I18n.config).to receive(:locale).and_return(locale)
+      end
+
+      unless defined?(ActiveModel)
+        describe "missing locale" do
+          let(:locale) { :ir }
+          describe "invalid exmaple" do
+            it { should have_errors_on_iban.because("is invalid") }
+          end
+        end
+      end
+    end
+    unless defined?(ActiveModel)
+      describe "without i18n" do
+        before(:each) { hide_const("I18n") }
+        describe "invalid@exmaple." do
+          it { should have_errors_on_iban.because("is invalid") }
+        end
+      end
+    end
+  end
+
+  it_should_behave_like :all_specs
+
+  if defined?(ActiveModel)
+    describe "shorthand ActiveModel validation" do
+      subject do |example|
+        user = Class.new do
+          def initialize(iban)
+            @iban = iban.freeze
+          end
+          attr_reader :iban
+          include ActiveModel::Validations
+          validates :iban, iban_format: example.example_group_instance.options
+        end
+        example.example_group_instance.class::User = user
+        user.new(example.example_group_instance.iban).tap(&:valid?).errors.full_messages
+      end
+
+      it_should_behave_like :all_specs
+    end
+  end
+end

data/validates_iban_format_of.gemspec

@@ -0,0 +1,22 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'validates_iban_format_of/version'
+
+spec = Gem::Specification.new do |s|
+  s.name          = 'validates_iban_format_of'
+  s.version       = ValidatesIbanFormatOf::VERSION
+  s.summary       = 'Validate iban'
+  s.description   = s.summary
+  s.authors       = ['Dimitar Kostov']
+  s.email         = ['mitko.kostov@gmail.com']
+  s.homepage      = 'https://github.com/mytrile/validates_iban_format_of'
+  s.license       = 'MIT'
+  s.test_files    = s.files.grep(%r{^spec/})
+  s.files         = `git ls-files`.split($/)
+  s.require_paths = ['lib']
+
+  s.add_dependency 'i18n', '~> 0.7'
+  s.add_dependency 'activesupport', '~> 4.2'
+  s.add_dependency 'iban-tools', '~> 1.1'
+  s.add_development_dependency 'bundler', '~> 1.13'
+  s.add_development_dependency 'rspec', '~> 3.6'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: validates_iban_format_of
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dimitar Kostov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: iban-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: Validate iban
+email:
+- mitko.kostov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- config/locales/en.yml
+- lib/validates_iban_format_of.rb
+- lib/validates_iban_format_of/active_model.rb
+- lib/validates_iban_format_of/railtie.rb
+- lib/validates_iban_format_of/rspec_matcher.rb
+- lib/validates_iban_format_of/version.rb
+- spec/rspec_matcher_spec.rb
+- spec/spec_helper.rb
+- spec/validates_iban_format_of_spec.rb
+- validates_iban_format_of.gemspec
+homepage: https://github.com/mytrile/validates_iban_format_of
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Validate iban
+test_files: []