swiss_bank_validator 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3d7762e4e03b89969464a21bce678f3e1baade2f8c6ac10699053df10c2e85c7
+  data.tar.gz: 813db18abed54ecc1bd9539bf153f4f9e892adb4b7b4bd0bc1e2f1fd986d60cd
+SHA512:
+  metadata.gz: 4ba3584616147db8d03d2c8ec32dce06d132d2c6588cd70c365e4af22825eb90c4fbf54b74c41567ba580e66135112f1a90c69d845da795d3c4211225174c61a
+  data.tar.gz: '0139dd4488250ff2f3d52b5cc9e92687c09cc46c532098c84805a57ba6da2b28f73f5cc103fcd528ac81fa20c0f9f2ae33cecbf9f6f47bf1beb7abb2b737de0d'

data/.github/workflows/ruby.yml

@@ -0,0 +1,30 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-20.04
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests & Rubocop
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/BlockLength:
+  Max: 50

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jbiolaz@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in iban_validator.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    swiss_bank_validator (0.5.0)
+      activemodel (~> 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.2)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.0.0)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.5.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.0)
+      rexml
+      rubocop-ast (>= 1.2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.5)
+  swiss_bank_validator!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jonathan Biolaz
+
+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,52 @@
+# SwissBankValidator
+
+Allow to valid a Swiss Iban passed on the rules of http://www.swissiban.com/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swiss_bank_validator'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install swiss_bank_validator
+
+## Usage
+
+```ruby
+ class Account < ActiveRecord::Base
+   validates_iban_format_of :account_number
+ end
+
+ # or
+
+ class Account < ActiveRecord::Base
+   validates :account_number, iban: true
+ end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/iban_validator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/iban_validator/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SwissBankValidator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/iban_validator/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options << '--config'
+  t.options << File.expand_path('.rubocop.yml', __dir__)
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'iban_validator'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/swiss_bank_validator.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module SwissBankValidator
+  require 'swiss_bank_validator/version'
+  require 'swiss_bank_validator/constants'
+  require 'swiss_bank_validator/validates_iban_format_of'
+
+  I18n.load_path += Dir[File.join(__dir__, 'swiss_bank_validator/locale/*.yml')]
+end

data/lib/swiss_bank_validator/constants.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SwissBankValidator
+  IBAN_REGEX = /\ACH[A-Z0-9]{2}\d{5}[A-Z0-9]{12}\z/.freeze
+  IBAN_LENGTH = 21
+end

data/lib/swiss_bank_validator/locale/de.yml

@@ -0,0 +1,11 @@
+de:
+  activemodel: &activemodel
+    errors:
+      messages:
+        invalid_iban_length: "Überprüfe bitte die Länge der angegebenen IBAN. Sie muss %{value} Charakter lang sein."
+        space_not_authorized_in_iban: Abstände sind nicht zugelassen.
+        iban_format_not_valid: Das Format der angegebenen IBAN ist nicht gültig.
+        must_start_with_ch: "Beginnt mit CH"
+
+  activerecord:
+    <<: *activemodel

data/lib/swiss_bank_validator/locale/en.yml

@@ -0,0 +1,11 @@
+en:
+  activemodel: &activemodel
+    errors:
+      messages:
+        invalid_iban_length: "IBAN length is not valid. must be %{value}"
+        space_not_authorized_in_iban: "Spaces are not authorized"
+        iban_format_not_valid: "Your IBAN format is not valid"
+        must_start_with_ch: "Must start with CH"
+
+  activerecord:
+    <<: *activemodel

data/lib/swiss_bank_validator/locale/fr.yml

@@ -0,0 +1,11 @@
+fr:
+  activemodel: &activemodel
+    errors:
+      messages:
+        invalid_iban_length: "La longueur de l'IBAN n'est pas correct. Il doit être de %{value}"
+        space_not_authorized_in_iban: "Les espaces ne sont pas autorisés"
+        iban_format_not_valid: "Le format de l'IBAN n'est pas valide"
+        must_start_with_ch: "doit commencer par CH"
+
+  activerecord:
+    <<: *activemodel

data/lib/swiss_bank_validator/validates_iban_format_of.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+# Based on http://www.swissiban.com/fr.htm
+module ActiveModel
+  module Validations
+    class IbanValidator < EachValidator
+      def validate_each(record, attribute, value)
+        return if value.blank? && options[:allow_blank]
+        return if value.nil? && options[:allow_nil]
+
+        return unless validate_iban_length(record, attribute, value, options)
+
+        validate_start_with_ch(record, attribute, value, options)
+        validate_iban_with_regex(record, attribute, value, options)
+        validate_iban_format(record, attribute, value, options)
+      end
+
+      def validate_iban_length(record, attribute, value, options)
+        return true if value.length == SwissBankValidator::IBAN_LENGTH
+
+        record.errors.add(
+          attribute,
+          :invalid_iban_length,
+          message: options[:message],
+          value: SwissBankValidator::IBAN_LENGTH
+        )
+
+        false
+      end
+
+      def validate_iban_with_regex(record, attribute, value, options)
+        return if SwissBankValidator::IBAN_REGEX.match(value).present?
+
+        record.errors.add(
+          attribute,
+          :space_not_authorized_in_iban,
+          message: options[:message],
+          value: value
+        )
+      end
+
+      def validate_iban_format(record, attribute, value, options)
+        return if iban_format_valid?(value)
+
+        record.errors.add(
+          attribute,
+          :iban_format_not_valid,
+          message: options[:message],
+          value: value
+        )
+      end
+
+      def validate_start_with_ch(record, attribute, value, options)
+        return if value.downcase.start_with?('ch')
+
+        record.errors.add(
+          attribute,
+          :must_start_with_ch,
+          message: options[:message],
+          value: value
+        )
+      end
+
+      def iban_format_valid?(iban)
+        iban_numerified = numerify_iban(iban)
+        return false if iban_numerified.nil?
+
+        iban_numerified.to_i % 97 == 1
+      end
+
+      def numerify_iban(iban)
+        return '' if iban.blank?
+
+        numerified = ''
+        code = iban.to_s.strip.gsub(/\s+/, '').upcase
+        (code[4..] + code[0..3]).each_byte do |byte|
+          numerified += case byte
+                          # 0..9
+                        when 48..57 then byte.chr
+                          # 'A'..'Z'
+                        when 65..90 then (byte - 55).to_s # 55 = 'A'.ord + 10
+                        else
+                          return nil
+                        end
+        end
+        numerified
+      end
+    end
+
+    module ClassMethods
+      # Validates whether or not the specified iban is valid.
+      #
+      #   class Account < ActiveRecord::Base
+      #     validates_iban_format_of :iban
+      #   end
+      #
+      def validates_iban_format_of(*attr_names)
+        validates_with IbanValidator, _merge_attributes(attr_names)
+      end
+
+      alias validates_iban validates_iban_format_of
+    end
+  end
+end

data/lib/swiss_bank_validator/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SwissBankValidator
+  VERSION = '0.5.0'
+end

data/swiss_bank_validator.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/swiss_bank_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'swiss_bank_validator'
+  spec.version       = SwissBankValidator::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ['QoQa dev Team']
+  spec.email         = ['dev@qoqa.com']
+
+  spec.summary       = 'All you need to validate a Swiss Iban'
+  spec.homepage      = 'https://github.com/qoqa/swiss_bank_validator'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/qoqa/swiss_bank_validator'
+  spec.metadata['changelog_uri'] = 'https://github.com/qoqa/swiss_bank_validator/main/changelog.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activemodel', '~> 6.0'
+
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.5'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: swiss_bank_validator
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- QoQa dev Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: 
+email:
+- dev@qoqa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- changelog.md
+- lib/swiss_bank_validator.rb
+- lib/swiss_bank_validator/constants.rb
+- lib/swiss_bank_validator/locale/de.yml
+- lib/swiss_bank_validator/locale/en.yml
+- lib/swiss_bank_validator/locale/fr.yml
+- lib/swiss_bank_validator/validates_iban_format_of.rb
+- lib/swiss_bank_validator/version.rb
+- swiss_bank_validator.gemspec
+homepage: https://github.com/qoqa/swiss_bank_validator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/qoqa/swiss_bank_validator
+  source_code_uri: https://github.com/qoqa/swiss_bank_validator
+  changelog_uri: https://github.com/qoqa/swiss_bank_validator/main/changelog.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: All you need to validate a Swiss Iban
+test_files: []