ibandit 0.11.28 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 31afcc0a061c33a69c2fdf4dc857603ebb91fd7c
-  data.tar.gz: 7f692e0706dc2410613e2e246349f95d9c6f938e
+SHA256:
+  metadata.gz: 13ca505f43dfd880ea0de62afe35c6b6a18c5036b523f7656b0cc36983af4a06
+  data.tar.gz: 913d870c4c191e184189c3872bbbdef83abe3f5074670856ef8eb2d4166988cc
 SHA512:
-  metadata.gz: 3f41f600cbd7a54a809ebdb8d9f4b3976aa23cdace895d03f4184585ebfe615bbfd9c12920df48d438e1d0ad8c15e52ba434e1d8a3803ca588e71e573ae8ae01
-  data.tar.gz: 0d269f41269d38e134b54e83a5c559fd75e5fabbd0d86fd8b461cb6f7eab7418fbe7a2af2f662b3c0dc30f83a293c312966f9e52529761557791bbc495a3e316
+  metadata.gz: 429b3a3de4af3d7b1a7620e7be46594f354e963bfedda97fcfb87ee983d17ae3cf87bcd7ae3891080e90392917b7c33955c0442efe38ab7404fd09484e55d1e9
+  data.tar.gz: ac9ff959b43a974efc436dbe809784e33c6e68c8065421b9a5a194b5bf24a5e64fd469cc79223c36d70f2f8bd43a12d8af82f3fe1ec0c2ff32ce9b5d02c4261b

data/.rubocop.yml

@@ -1,9 +1,9 @@
 inherit_from: .rubocop_todo.yml
 inherit_gem:
-  ruboconfig: rubocop.yml
+  gc_ruboconfig: rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.4
 
 # Limit lines to 80 characters.
 LineLength:
@@ -21,9 +21,6 @@ SingleLineMethods:
 NumericLiterals:
   Enabled: false
 
-Performance/RegexpMatch:
-  Enabled: false
-
 # Wants you to use the same argument names for every reduce. This seems kinda
 # naff compared to naming them semantically
 SingleLineBlockParams:

data/.rubocop_todo.yml

@@ -1,27 +1,82 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-12-08 13:56:37 +0000 using RuboCop version 0.27.1.
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-05-30 14:34:05 +0100 using RuboCop version 0.70.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 4
+# Offense count: 10
 Metrics/AbcSize:
-  Max: 28
+  Max: 25
+
+# Offense count: 4
+Metrics/CyclomaticComplexity:
+  Max: 8
 
 # Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 110
+# Configuration parameters: EnforcedStyleForLeadingUnderscores.
+# SupportedStylesForLeadingUnderscores: disallowed, required, optional
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'lib/ibandit/sweden/bank_lookup.rb'
 
 # Offense count: 1
-Metrics/CyclomaticComplexity:
-  Max: 10
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: io, id, to, by, on, in, at, ip, db
+Naming/UncommunicativeMethodParamName:
+  Exclude:
+    - 'lib/ibandit/german_details_converter.rb'
 
-# Offense count: 4
-Style/Documentation:
-  Enabled: false
+# Offense count: 1
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/ibandit/structure_spec.rb'
 
-# Offense count: 4
-Style/NumericPredicate:
-  Enabled: false
+# Offense count: 1
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/ibandit/iban_spec.rb'
+
+# Offense count: 1
+RSpec/ExpectInHook:
+  Exclude:
+    - 'spec/ibandit/german_details_converter_spec.rb'
+
+# Offense count: 12
+# Configuration parameters: AggregateFailuresByDefault.
+RSpec/MultipleExpectations:
+  Max: 2
+
+# Offense count: 20
+# Configuration parameters: IgnoreSharedExamples.
+RSpec/NamedSubject:
+  Exclude:
+    - 'spec/ibandit/iban_spec.rb'
+
+# Offense count: 367
+RSpec/NestedGroups:
+  Max: 6
+
+# Offense count: 3
+RSpec/ScatteredLet:
+  Exclude:
+    - 'spec/ibandit/iban_spec.rb'
+
+# Offense count: 18
+RSpec/ScatteredSetup:
+  Exclude:
+    - 'spec/ibandit/iban_assembler_spec.rb'
+    - 'spec/ibandit/iban_spec.rb'
+
+# Offense count: 13
+RSpec/SubjectStub:
+  Exclude:
+    - 'spec/ibandit/iban_spec.rb'
+
+# Offense count: 5
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/ibandit/iban_spec.rb'

data/.travis.yml

@@ -4,10 +4,10 @@ matrix:
   allow_failures:
 
 rvm:
-  - 2.1.10
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
+  - 2.4
+  - 2.5
+  - 2.6
+
 
 sudo: false
 

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.0.0 - October 24, 2019
+
+- Discontinued support for older Ruby versions (2.1.10, 2.2.7, 2.3.4 and 2.4.1)
+- Update rubocop and ruboconfig
+- Updates the example bank details for the United States
+- Updates the definition of the structure for IBANs in Costa Rica (courtesy @sprileyMSTS)
+
 ## 0.11.28 - March 21, 2019
 
 - Handle bad input more gracefully (`bank_code` being nil)

data/Gemfile

@@ -5,7 +5,5 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem "ruboconfig",
-      git: "https://github.com/gocardless/ruboconfig.git",
-      tag: "v1.2.0"
+  gem "gc_ruboconfig"
 end

data/README.md

@@ -566,16 +566,16 @@ iban.account_number       # => "3333333044"
 # USA
 iban = Ibandit::IBAN.new(
   country_code: 'US',
-  bank_code: '965498456',      # 9-digit routing number
-  account_number: '0123456789' # 1 to 17 digits
+  bank_code: '026073150',      # 9-digit routing number
+  account_number: '2715500356' # 1 to 17 digits
 )
-iban.pseudo_iban               # => "USZZ965498456_______0123456789"
+iban.pseudo_iban               # => "USZZ026073150_______2715500356"
 iban.iban                      # => nil
 
-iban = Ibandit::IBAN.new('USZZ965498456_______0123456789')
+iban = Ibandit::IBAN.new('USZZ026073150_______2715500356')
 iban.country_code              # => "US"
-iban.bank_code                 # => "965498456"
-iban.account_number            # => "_______0123456789"
+iban.bank_code                 # => "026073150"
+iban.account_number            # => "_______2715500356"
 iban.iban                      # => nil
 ```
 

data/data/structures.yml

@@ -149,15 +149,15 @@ CH:
   :bank_code_format: "\\d{5}"
   :account_number_format: "[A-Z0-9]{12}"
 CR:
-  :bank_code_position: 5
+  :bank_code_position: 6
   :bank_code_length: 3
   :branch_code_position: 0
   :branch_code_length: 0
-  :account_number_position: 8
+  :account_number_position: 9
   :account_number_length: 14
-  :total_length: 21
+  :total_length: 22
   :national_id_length: 3
-  :bban_format: "\\d{3}\\d{14}"
+  :bban_format: "0\\d{3}\\d{14}"
   :bank_code_format: "\\d{3}"
   :account_number_format: "\\d{14}"
 CY:

data/ibandit.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require File.expand_path("../lib/ibandit/version", __FILE__)
+require File.expand_path("lib/ibandit/version", __dir__)
 
 Gem::Specification.new do |gem|
   gem.add_development_dependency "nokogiri",        "~> 1.6"
@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "pry-nav",         "~> 0.2"
   gem.add_development_dependency "rspec",           "~> 3.3"
   gem.add_development_dependency "rspec-its",       "~> 1.2"
-  gem.add_development_dependency "rubocop",         "~> 0.52.0"
+  gem.add_development_dependency "rubocop",         "~> 0.70.0"
   gem.add_development_dependency "sax-machine",     "~> 1.3"
 
   gem.add_runtime_dependency "i18n"

data/lib/ibandit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "i18n"
 require "ibandit/version"
 require "ibandit/errors"
@@ -14,8 +16,8 @@ require "ibandit/pseudo_iban_splitter"
 require "ibandit/local_details_cleaner"
 require "ibandit/check_digit"
 
-I18n.load_path += Dir[File.expand_path("../../config/locales/*.{rb,yml}",
-                                       __FILE__)]
+I18n.load_path += Dir[File.expand_path("../config/locales/*.{rb,yml}",
+                                       __dir__)]
 
 module Ibandit
   class << self
@@ -23,12 +25,13 @@ module Ibandit
 
     def find_bic(country_code, national_id)
       raise NotImplementedError, "BIC finder is not defined" unless @bic_finder
+
       @bic_finder.call(country_code, national_id)
     end
 
     def structures
       @structures ||= YAML.load_file(
-        File.expand_path("../../data/structures.yml", __FILE__),
+        File.expand_path("../data/structures.yml", __dir__),
       )
     end
 

data/lib/ibandit/check_digit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ibandit
   module CheckDigit
     ITALIAN_ODD_MAPPING = {

data/lib/ibandit/constants.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ibandit
   module Constants
     CONSTRUCTABLE_IBAN_COUNTRY_CODES = %w[AT BE BG CY CZ DE DK EE ES FI FR GB GR
@@ -8,7 +10,7 @@ module Ibandit
     DECONSTRUCTABLE_IBAN_COUNTRY_CODES =
       CONSTRUCTABLE_IBAN_COUNTRY_CODES - PSEUDO_IBAN_COUNTRY_CODES
 
-    PSEUDO_IBAN_CHECK_DIGITS = "ZZ".freeze
+    PSEUDO_IBAN_CHECK_DIGITS = "ZZ"
 
     PSEUDO_IBAN_PADDING_CHARACTER_FOR = {
       "SE" => "X", # Using X for backwards compatibility

data/lib/ibandit/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ibandit
   class InvalidCharacterError < StandardError; end
   class UnsupportedAccountDetails < StandardError; end

data/lib/ibandit/german_details_converter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # German bank details don't map directly to IBANs in the same way as in other
 # countries - each bank has idiosyncracies for translating its cusomers' bank
 # details. These idiosyncracies are described in a document from the Bundesbank:
@@ -7,7 +9,7 @@ module Ibandit
   module GermanDetailsConverter
     def self.rules
       @rules ||= YAML.load_file(
-        File.expand_path("../../../data/german_iban_rules.yml", __FILE__),
+        File.expand_path("../../data/german_iban_rules.yml", __dir__),
       )
     end
 
@@ -290,6 +292,7 @@ module Ibandit
 
         def valid?
           return false unless valid_length? && valid_account_type?
+
           [master_number[-1].to_i, 10].include?(remainder)
         end
 

data/lib/ibandit/iban.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "yaml"
 
 module Ibandit
@@ -155,7 +157,7 @@ module Ibandit
 
     def valid_bank_code_length?
       return unless valid_country_code?
-      return true if structure[:bank_code_length] == 0
+      return true if structure[:bank_code_length]&.zero?
 
       if swift_bank_code.nil? || swift_bank_code.empty?
         @errors[:bank_code] = Ibandit.translate(:is_required)
@@ -175,7 +177,7 @@ module Ibandit
         return true
       end
 
-      if structure[:branch_code_length] == 0
+      if structure[:branch_code_length]&.zero?
         @errors[:branch_code] = Ibandit.translate(:not_used_in_country,
                                                   country_code: country_code)
       elsif swift_branch_code.nil? || swift_branch_code.empty?
@@ -208,6 +210,7 @@ module Ibandit
 
     def valid_characters?
       return if iban.nil?
+
       if iban.scan(/[^A-Z0-9]/).any?
         @errors[:characters] =
           Ibandit.translate(:non_alphanumeric_characters,
@@ -233,7 +236,7 @@ module Ibandit
 
     def valid_bank_code_format?
       return unless valid_bank_code_length?
-      return true if structure[:bank_code_length] == 0
+      return true if structure[:bank_code_length]&.zero?
 
       if swift_bank_code =~ Regexp.new(structure[:bank_code_format])
         true
@@ -477,7 +480,7 @@ module Ibandit
       @swift_account_number = swift_details[:account_number]
 
       return if Constants::PSEUDO_IBAN_COUNTRY_CODES.
-          include?(@country_code)
+        include?(@country_code)
 
       @bank_code      = swift_details[:bank_code]
       @branch_code    = swift_details[:branch_code]
@@ -530,6 +533,7 @@ module Ibandit
 
     def pseudo_iban?(input)
       return false if input.nil?
+
       input.slice(2, 2) == Constants::PSEUDO_IBAN_CHECK_DIGITS
     end
 

data/lib/ibandit/iban_assembler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ibandit
   module IBANAssembler
     EXCEPTION_COUNTRY_CODES = %w[IT SM BE].freeze

data/lib/ibandit/iban_splitter.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module Ibandit
   module IBANSplitter
     def self.split(iban)
       {
-        country_code:   country_code_from(iban),
-        check_digits:   check_digits_from(iban),
-        bank_code:      bank_code_from(iban),
-        branch_code:    branch_code_from(iban),
+        country_code: country_code_from(iban),
+        check_digits: check_digits_from(iban),
+        bank_code: bank_code_from(iban),
+        branch_code: branch_code_from(iban),
         account_number: account_number_from(iban),
       }
     end
@@ -36,9 +38,8 @@ module Ibandit
     end
 
     def self.branch_code_from(iban)
-      unless decomposable?(iban) && structure(iban)[:branch_code_length] > 0
-        return
-      end
+      return unless decomposable?(iban) &&
+        structure(iban)[:branch_code_length]&.positive?
 
       iban.slice(
         structure(iban)[:branch_code_position] - 1,

data/lib/ibandit/local_details_cleaner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ibandit
   module LocalDetailsCleaner
     def self.clean(local_details)
@@ -57,8 +59,9 @@ module Ibandit
       # Account number may be 4-11 digits long.
       # Add leading zeros to account number if < 11 digits.
       return {} unless local_details[:account_number].length >= 4
+
       {
-        bank_code:      local_details[:bank_code],
+        bank_code: local_details[:bank_code],
         account_number: local_details[:account_number].rjust(11, "0"),
       }
     end
@@ -71,7 +74,7 @@ module Ibandit
       return {} unless local_details[:account_number].length >= 5
 
       {
-        branch_code:    local_details[:branch_code].delete("-"),
+        branch_code: local_details[:branch_code].delete("-"),
         account_number: local_details[:account_number].rjust(10, "0"),
       }
     end
@@ -80,7 +83,7 @@ module Ibandit
       account_number = local_details[:account_number].tr("-", "")
 
       {
-        bank_code:      local_details[:bank_code] || account_number.slice(0, 3),
+        bank_code: local_details[:bank_code] || account_number.slice(0, 3),
         account_number: account_number,
       }
     end
@@ -137,8 +140,8 @@ module Ibandit
         end
 
       {
-        bank_code:      bank_code,
-        branch_code:    branch_code,
+        bank_code: bank_code,
+        branch_code: branch_code,
         account_number: account_number,
       }
     end
@@ -158,7 +161,7 @@ module Ibandit
         end
 
       {
-        bank_code:      local_details[:bank_code],
+        bank_code: local_details[:bank_code],
         account_number: account_number,
       }
     end
@@ -180,7 +183,7 @@ module Ibandit
       return {} unless converted_details[:account_number].length >= 4
 
       {
-        bank_code:      converted_details[:bank_code],
+        bank_code: converted_details[:bank_code],
         account_number: converted_details[:account_number].rjust(10, "0"),
       }
     end
@@ -202,7 +205,7 @@ module Ibandit
       end
 
       {
-        bank_code:      bank_code.rjust(4, "0"),
+        bank_code: bank_code.rjust(4, "0"),
         account_number: account_number.delete("-").rjust(10, "0"),
       }
     end
@@ -246,8 +249,8 @@ module Ibandit
       end
 
       {
-        bank_code:      bank_code,
-        branch_code:    branch_code,
+        bank_code: bank_code,
+        branch_code: branch_code,
         account_number: account_number,
       }
     end
@@ -267,15 +270,15 @@ module Ibandit
         end
 
       {
-        bank_code:      local_details[:bank_code],
+        bank_code: local_details[:bank_code],
         account_number: account_number,
       }
     end
 
     def self.clean_fr_details(local_details)
       {
-        bank_code:      local_details[:bank_code],
-        branch_code:    local_details[:branch_code],
+        bank_code: local_details[:bank_code],
+        branch_code: local_details[:branch_code],
         account_number: local_details[:account_number].gsub(/[-\s]/, ""),
       }
     end
@@ -296,8 +299,8 @@ module Ibandit
       account_number = account_number.rjust(8, "0") if account_number.length > 5
 
       {
-        bank_code:      bank_code,
-        branch_code:    branch_code,
+        bank_code: bank_code,
+        branch_code: branch_code,
         account_number: account_number,
       }
     end
@@ -317,7 +320,7 @@ module Ibandit
       bank_code, account_number = local_details[:account_number].split("-", 2)
 
       {
-        bank_code:      bank_code,
+        bank_code: bank_code,
         account_number: account_number,
       }
     end
@@ -334,14 +337,14 @@ module Ibandit
       case cleaned_acct_number.length
       when 16
         {
-          bank_code:      cleaned_acct_number.slice(0, 3),
-          branch_code:    cleaned_acct_number.slice(3, 4),
+          bank_code: cleaned_acct_number.slice(0, 3),
+          branch_code: cleaned_acct_number.slice(3, 4),
           account_number: cleaned_acct_number.slice(7, 9).ljust(17, "0"),
         }
       when 24
         {
-          bank_code:      cleaned_acct_number.slice(0, 3),
-          branch_code:    cleaned_acct_number.slice(3, 4),
+          bank_code: cleaned_acct_number.slice(0, 3),
+          branch_code: cleaned_acct_number.slice(3, 4),
           account_number: cleaned_acct_number.slice(7, 17),
         }
       else local_details
@@ -363,8 +366,8 @@ module Ibandit
       account_number = account_number.rjust(8, "0") if account_number.length > 5
 
       {
-        bank_code:      bank_code,
-        branch_code:    branch_code,
+        bank_code: bank_code,
+        branch_code: branch_code,
         account_number: account_number,
       }
     end
@@ -381,7 +384,7 @@ module Ibandit
       end
 
       {
-        bank_code:      bank_code.rjust(4, "0"),
+        bank_code: bank_code.rjust(4, "0"),
         account_number: pad_is_account_number(parts),
       }
     end
@@ -389,8 +392,8 @@ module Ibandit
     def self.clean_it_details(local_details)
       # Add leading zeros to account number if < 12 digits.
       {
-        bank_code:      local_details[:bank_code],
-        branch_code:    local_details[:branch_code],
+        bank_code: local_details[:bank_code],
+        branch_code: local_details[:branch_code],
         account_number: local_details[:account_number].rjust(12, "0"),
       }
     end
@@ -430,8 +433,8 @@ module Ibandit
       account_number = account_number.rjust(18, "0")
 
       {
-        bank_code:      bank_code,
-        branch_code:    branch_code,
+        bank_code: bank_code,
+        branch_code: branch_code,
         account_number: account_number,
       }
     end
@@ -439,7 +442,7 @@ module Ibandit
     def self.clean_nl_details(local_details)
       # Add leading zeros to account number if < 10 digits.
       {
-        bank_code:      local_details[:bank_code],
+        bank_code: local_details[:bank_code],
         account_number: local_details[:account_number].rjust(10, "0"),
       }
     end
@@ -458,7 +461,7 @@ module Ibandit
       end
 
       {
-        bank_code:      bank_code,
+        bank_code: bank_code,
         account_number: account_number,
       }
     end
@@ -496,8 +499,8 @@ module Ibandit
       end
 
       {
-        bank_code:      bank_code,
-        branch_code:    branch_code,
+        bank_code: bank_code,
+        branch_code: branch_code,
         account_number: account_number,
       }
     end
@@ -516,7 +519,7 @@ module Ibandit
       end
 
       {
-        bank_code:      bank_code,
+        bank_code: bank_code,
         account_number: account_number,
       }
     end
@@ -549,7 +552,7 @@ module Ibandit
     def self.clean_si_details(local_details)
       # Add leading zeros to account number if < 10 digits.
       {
-        bank_code:      local_details[:bank_code],
+        bank_code: local_details[:bank_code],
         account_number: local_details[:account_number].rjust(10, "0"),
       }
     end
@@ -578,8 +581,8 @@ module Ibandit
 
     def self.swift_details_for(local_details)
       {
-        swift_bank_code:      local_details[:bank_code],
-        swift_branch_code:    local_details[:branch_code],
+        swift_bank_code: local_details[:bank_code],
+        swift_branch_code: local_details[:branch_code],
         swift_account_number: local_details[:account_number],
       }
     end