banktools-global 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 78d4250b9292e9803a2901d65ea584860f1063c58dd22fe16d673809b7d67cf6
+  data.tar.gz: b382e03dbedcbc9e5442e0b686f5f816c3efac99c1e4b67679be7e4eccb574ec
+SHA512:
+  metadata.gz: 34839382a704cd679397808ad56803c3f28ff5916720a536381bea62632c68929d22cb6e01687741fc79e624b1f9cd2579fa8f26dfe7b7471fbff6396a1222a5
+  data.tar.gz: f735990bc30ae8202df3daa454d50daf045963118de6a19e1bbe5590460d93b6b70ff9fa9d8892c713ff1e7af772da1a6c95785c25860885fd31f0e4ce3c57c4

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.14
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [Unreleased]
+
+## [1.0.0] - 2021-04-19
+
+- Initial release.
+- Intended to allow/disallow the same IBANs as the last version (0.0.7) of iban-tools, though this gem does not aim to provide an identical API or feature set as iban-tools.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in banktools-global.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    banktools-global (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  banktools-global!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.14

data/LICENSE.txt

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2009 Iulian Dogariu
+and
+Copyright (c) 2021 Auction Network Sweden AB (Auctionet.com)
+
+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,80 @@
+# Banktools::Global
+
+Validate and normalize international bank account numbers like IBAN and BIC.
+
+Based on [iban-tools](https://github.com/iulianu/iban-tools) which became unmaintained.
+
+## Usage
+
+### IBAN
+
+```ruby
+account = BankTools::Global::IBAN.new(" GB82 WEST 1234 5698 765432 ")
+account.valid?  # => true
+account.errors  # => []
+account.normalize  # => "GB82 WEST 1234 5698 7654 32"
+
+account = BankTools::Global::IBAN.new("GB82")
+account.valid?  # => false
+account.errors  # => [:wrong_length]
+
+# Error codes
+
+Banktools::Global::Errors::BAD_CHECKSUM     # => :bad_checksum
+Banktools::Global::Errors::BAD_FORMAT       # => :bad_format
+Banktools::Global::Errors::UNKNOWN_COUNTRY  # => :unknown_country
+Banktools::Global::Errors::WRONG_LENGTH     # => :wrong_length
+```
+
+### BIC
+
+```ruby
+account = BankTools::Global::BIC.new("ESS ESESS")
+account.valid?  # => true
+account.errors  # => []
+account.normalize  # => "ESSESESS"
+
+account = BankTools::Global::BIC.new("ESSEXXSS")
+account.valid?  # => false
+account.errors  # => [:unknown_country]
+
+#  Error codes
+
+Banktools::Global::Errors::BAD_FORMAT       # => :bad_format
+Banktools::Global::Errors::UNKNOWN_COUNTRY  # => :unknown_country
+```
+
+## Also see
+
+* [Our other banktools](https://github.com/barsoom?q=banktools)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "banktools-global"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install banktools-global
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 the created tag, 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/barsoom/banktools-global.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/banktools-global.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/banktools/global/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "banktools-global"
+  spec.version       = BankTools::Global::VERSION
+  spec.authors       = ["Henrik Nyh"]
+  spec.email         = ["henrik@nyh.se"]
+
+  spec.summary       = "Validate and normalize international bank account numbers like IBAN/BIC. Based on iban-tools."
+  spec.homepage      = "https://github.com/barsoom/banktools-global"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/barsoom/banktools-global/blob/master/README.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{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "banktools/global"
+
+# 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/banktools/global.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module BankTools
+  module Global
+  end
+end
+
+require_relative "global/version"
+require_relative "global/iban"
+require_relative "global/bic"

data/lib/banktools/global/bic.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "errors"
+
+class BankTools::Global::BIC
+  E = BankTools::Global::Errors
+
+  # http://sv.wikipedia.org/wiki/ISO_9362
+  RE = /\A
+    [A-Z]{4}
+    ([A-Z]{2})
+    [A-Z0-9]{2}
+    (?:[A-Z0-9]{3})?
+  \z/ix
+
+  COUNTRY_CODES = %w[ AD AE AF AG AI AL AM AN AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR FX GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR ST SV SY SZ TC TD TF TG TH TJ TK TM TN TO TP TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW ]
+
+  def initialize(raw)
+    @raw = raw
+  end
+
+  def valid?
+    errors.empty?
+  end
+
+  def errors
+    match = @raw.to_s.match(RE)
+    return [ E::BAD_FORMAT ] unless match
+
+    country_code = match.captures.first.upcase
+    return [ E::UNKNOWN_COUNTRY ] unless COUNTRY_CODES.include?(country_code)
+
+    []
+  end
+
+  def normalize
+    @raw.to_s.upcase.gsub(/\s/, "")
+  end
+end

data/lib/banktools/global/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class BankTools::Global::Errors
+  BAD_CHECKSUM = :bad_checksum
+  BAD_FORMAT = :bad_format
+  UNKNOWN_COUNTRY = :unknown_country
+  WRONG_LENGTH = :wrong_length
+end

data/lib/banktools/global/iban.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "yaml"
+require_relative "errors"
+
+class BankTools::Global::IBAN
+  E = BankTools::Global::Errors
+
+  def initialize(raw)
+    @raw = raw
+    @pre_normalized = raw.to_s.strip.upcase
+  end
+
+  def valid?
+    errors.empty?
+  end
+
+  def errors
+    rule = rules[country_code]
+    return [ E::UNKNOWN_COUNTRY ] unless rule
+
+    length = rule.fetch("length")
+    return [ E::WRONG_LENGTH ] unless @pre_normalized.length == length
+
+    re = rule.fetch("bban_pattern")
+    return [ E::BAD_FORMAT ] unless bban.match?(re)
+
+    return [ E::BAD_CHECKSUM ] unless good_checksum?
+
+    []
+  end
+
+  def normalize
+     @pre_normalized.gsub(/.{4}/, '\0 ').strip
+  end
+
+  private
+
+  def good_checksum?
+    number_string =
+      (bban + country_code + check_digits).chars.map { |char|
+        case char
+        when "0".."9" then char
+        when "A".."Z" then (char.ord - 55).to_s
+        else raise "Unexpected byte '#{byte}' in IBAN '#{normalize}'!"
+        end
+      }.join
+
+    number_string.to_i % 97 == 1
+  end
+
+  def country_code
+    @pre_normalized[0..1]
+  end
+
+  def check_digits
+    @pre_normalized[2..3]
+  end
+
+  def bban
+    @pre_normalized[4..-1]
+  end
+
+  def rules
+    @@rules ||=
+      YAML.load(File.read(File.join(File.dirname(__FILE__), "iban_rules.yml")))
+        .transform_values { |h| h.merge("bban_pattern" => /\A#{h.fetch("bban_pattern")}\z/) }
+  end
+end

data/lib/banktools/global/iban_rules.yml

@@ -0,0 +1,281 @@
+# Data originally from http://www.tbg5-finance.org/?ibandocs.shtml/
+
+'AD':
+  # Andorra
+  length: 24
+  bban_pattern: '\d{8}[A-Z0-9]{12}'
+
+'AE':
+  # United Arab Emirates
+  length: 23
+  bban_pattern: '\d{19}'
+
+'AL':
+  # Albania
+  length: 28
+  bban_pattern: '\d{8}[A-Z0-9]{16}'
+
+'AT':
+  # Austria
+  length: 20
+  bban_pattern: '\d{16}'
+
+'BA':
+  # Bosnia
+  length: 20
+  bban_pattern: '\d{16}'
+
+'BE':
+  # Belgium
+  length: 16
+  bban_pattern: '\d{12}'
+
+'BG':
+  # Bulgaria
+  length: 22
+  bban_pattern: '[A-Z]{4}\d{6}[A-Z0-9]{8}'
+
+'BH':
+  # Bahrain
+  length: 22
+  bban_pattern: '[A-Z]{4}[A-Z0-9]{14}'
+
+'CH':
+  # Switzerland
+  length: 21
+  bban_pattern: '\d{5}[A-Z0-9]{12}'
+
+'CY':
+  # Cyprus
+  length: 28
+  bban_pattern: '\d{8}[A-Z0-9]{16}'
+
+'CZ':
+  # Czech Republic
+  length: 24
+  bban_pattern: '\d{20}'
+
+'DE':
+  # Germany
+  length: 22
+  bban_pattern: '\d{18}'
+
+'DK':
+  # Denmark
+  length: 18
+  bban_pattern: '\d{14}'
+
+'DO':
+  # Dominican Republic
+  length: 28
+  bban_pattern: '[A-Z]{4}\d{20}'
+
+'EE':
+  # Estonia
+  length: 20
+  bban_pattern: '\d{16}'
+
+'ES':
+  # Spain
+  length: 24
+  bban_pattern: '\d{20}'
+
+'FI':
+  # Finland
+  length: 18
+  bban_pattern: '\d{14}'
+
+'FO':
+  # Faroe Islands
+  length: 18
+  bban_pattern: '\d{14}'
+
+'FR':
+  # France
+  length: 27
+  bban_pattern: '\d{10}[A-Z0-9]{11}\d{2}'
+
+'GB':
+  # United Kingdom
+  length: 22
+  bban_pattern: '[A-Z]{4}\d{14}'
+
+'GE':
+  # Georgia
+  length: 22
+  bban_pattern: '[A-Z]{2}\d{16}'
+
+'GI':
+  # Gibraltar
+  length: 23
+  bban_pattern: '[A-Z]{4}[A-Z0-9]{15}'
+
+'GL':
+  # Greenland
+  length: 18
+  bban_pattern: '\d{14}'
+
+'GR':
+  # Greece
+  length: 27
+  bban_pattern: '\d{7}[A-Z0-9]{16}'
+
+'HR':
+  # Croatia
+  length: 21
+  bban_pattern: '\d{17}'
+
+'HU':
+  # Hungary
+  length: 28
+  bban_pattern: '\d{24}'
+
+'IE':
+  # Ireland
+  length: 22
+  bban_pattern: '[A-Z]{4}\d{14}'
+
+'IL':
+  # Israel
+  length: 23
+  bban_pattern: '\d{19}'
+
+'IS':
+  # Iceland
+  length: 26
+  bban_pattern: '\d{22}'
+
+'IT':
+  # Italy
+  length: 27
+  bban_pattern: '[A-Z]\d{10}[A-Z0-9]{12}'
+
+'KW':
+  # Kuwait
+  length: 30
+  bban_pattern: '[A-Z]{4}\d{22}'
+
+'KZ':
+  # Kazakhstan
+  length: 20
+  bban_pattern: '\d{3}[A-Z]{3}\d{10}'
+
+'LB':
+  # Lebanon
+  length: 28
+  bban_pattern: '\d{4}[A-Z0-9]{20}'
+
+'LI':
+  # Liechtenstein
+  length: 21
+  bban_pattern: '\d{5}[A-Z0-9]{12}'
+
+'LT':
+  # Lithuania
+  length: 20
+  bban_pattern: '\d{16}'
+
+'LU':
+  # Luxembourg
+  length: 20
+  bban_pattern: '\d{3}[A-Z0-9]{13}'
+
+'LV':
+  # Latvia
+  length: 21
+  bban_pattern: '[A-Z]{4}[A-Z0-9]{13}'
+
+'MC':
+  # Monaco
+  length: 27
+  bban_pattern: '\d{10}[A-Z0-9]{11}\d{2}'
+
+'ME':
+  # Montenegro
+  length: 22
+  bban_pattern: '\d{18}'
+
+'MK':
+  # Macedonia
+  length: 19
+  bban_pattern: '\d{3}[A-Z0-9]{10}\d{2}'
+
+'MR':
+  # Mauritania
+  length: 27
+  bban_pattern: '\d{23}'
+
+'MT':
+  # Malta
+  length: 31
+  bban_pattern: '[A-Z]{4}\d{5}[A-Z0-9]{18}'
+
+'MU':
+  # Mauritius
+  length: 30
+  bban_pattern: '[A-Z]{4}\d{19}[A-Z]{3}'
+
+'NL':
+  # Netherlands
+  length: 18
+  bban_pattern: '[A-Z]{4}\d{10}'
+
+'NO':
+  # Norway
+  length: 15
+  bban_pattern: '\d{11}'
+
+'PL':
+  # Poland
+  length: 28
+  bban_pattern: '\d{8}[A-Z0-9]{16}'
+
+'PT':
+  # Portugal
+  length: 25
+  bban_pattern: '\d{21}'
+
+'RO':
+  # Romania
+  length: 24
+  bban_pattern: '[A-Z]{4}[A-Z0-9]{16}'
+
+'RS':
+  # Serbia
+  length: 22
+  bban_pattern: '\d{18}'
+
+'SA':
+  # Saudi Arabia
+  length: 24
+  bban_pattern: '\d{2}[A-Z0-9]{18}'
+
+'SE':
+  # Sweden
+  length: 24
+  bban_pattern: '\d{20}'
+
+'SI':
+  # Slovenia
+  length: 19
+  bban_pattern: '\d{15}'
+
+'SK':
+  # Slovakia
+  length: 24
+  bban_pattern: '\d{20}'
+
+'SM':
+  # San Marino
+  length: 27
+  bban_pattern: '[A-Z]\d{10}[A-Z0-9]{12}'
+
+'TN':
+  # Tunisia
+  length: 24
+  bban_pattern: '\d{20}'
+
+'TR':
+  # Turkey
+  length: 26
+  bban_pattern: '\d{5}[A-Z0-9]{17}'

data/lib/banktools/global/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BankTools
+  module Global
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: banktools-global
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Henrik Nyh
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-04-19 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- henrik@nyh.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- banktools-global.gemspec
+- bin/console
+- bin/setup
+- lib/banktools/global.rb
+- lib/banktools/global/bic.rb
+- lib/banktools/global/errors.rb
+- lib/banktools/global/iban.rb
+- lib/banktools/global/iban_rules.yml
+- lib/banktools/global/version.rb
+homepage: https://github.com/barsoom/banktools-global
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/barsoom/banktools-global
+  source_code_uri: https://github.com/barsoom/banktools-global
+  changelog_uri: https://github.com/barsoom/banktools-global/blob/master/README.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.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: Validate and normalize international bank account numbers like IBAN/BIC.
+  Based on iban-tools.
+test_files: []