ibandit 0.11.25 → 0.11.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25eea6c456d9782856e5600061dc8414d90f651a
-  data.tar.gz: c81156af68d0817c88dd9faad9a908a7a75bab2d
+  metadata.gz: 73a5ffec9e66a0ebf5dccf613bedb5e0da311444
+  data.tar.gz: a6d3de9434b4b87e3df2b9a6a4e6c841331b949c
 SHA512:
-  metadata.gz: 343b1bf9e56d78bc6ee805e75d260f20596770d3ff7b9ce6107579cad1dee21d9cbdec714fa7b7c0c4fd59f2facd8ab5e290ccfe4238cba82fca014f321b3511
-  data.tar.gz: 45ddb672d2b7db64b3c2dec6bceb6e3b87be62dda0cca036b0f55d77f9e9756e6ad454fd257ab3610d98d1de9206786fb31022816dae13fa61e2e97ad491ec95
+  metadata.gz: ce3d098232431f5d49b2c533afe6eac7ca260cabfcda9add4ff4cc2b3b0a3bb1bae8d98e3a0bfda1416d5ea0c96533bb9b31b38ab4f5cc06800a49e93d7f19f0
+  data.tar.gz: 6612b734b2bad0b49af6d2460b4536a26bea154ed81011c654c02202c68bc3d34db4b290dc1731831c0b77480202dc7f32c88bb86f507894a3bc3d23f9b4ddae

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.11.26 - January 30, 2019
+
+- Add support for US pseudo-IBANs
+
 ## 0.11.25 - January 10, 2019
 
 - Prevent account numbers from being all-zero in Australia

data/README.md

@@ -57,6 +57,7 @@ For example:
 | Spain           | :white_check_mark:           | :white_check_mark: |                    |
 | Sweden          | :white_check_mark:           |                    | :white_check_mark: |
 | United Kingdom  | :white_check_mark:           | :white_check_mark: |                    |
+| USA             |                              |                    | :white_check_mark: |
 
 ## Usage
 
@@ -561,6 +562,21 @@ iban.country_code         # => "NZ"
 iban.bank_code            # => "01"
 iban.branch_code          # => "0004"
 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
+)
+iban.pseudo_iban               # => "USZZ965498456_______0123456789"
+iban.iban                      # => nil
+
+iban = Ibandit::IBAN.new('USZZ965498456_______0123456789')
+iban.country_code              # => "US"
+iban.bank_code                 # => "965498456"
+iban.account_number            # => "_______0123456789"
+iban.iban                      # => nil
 ```
 
 ## Other libraries

data/data/structures.yml

@@ -897,3 +897,14 @@ CA:
   :pseudo_iban_bank_code_length: 4
   :pseudo_iban_branch_code_length: 5
   :pseudo_iban_account_number_length: 12
+US:
+  :bank_code_length: 9
+  :branch_code_length: 0
+  :account_number_length: 17
+  :bank_code_format: "\\d{9}"
+  # TODO: update account number format based on inputs from user research
+  :account_number_format: ".{1,17}"
+  :national_id_length: 9
+  :pseudo_iban_bank_code_length: 9
+  :pseudo_iban_branch_code_length: 0
+  :pseudo_iban_account_number_length: 17

data/lib/ibandit/constants.rb

@@ -4,7 +4,7 @@ module Ibandit
                                           HR HU IE IS IT LT LU LV MC MT NL NO PL
                                           PT RO SE SI SK SM].freeze
 
-    PSEUDO_IBAN_COUNTRY_CODES = %w[AU SE NZ CA].freeze
+    PSEUDO_IBAN_COUNTRY_CODES = %w[AU SE NZ CA US].freeze
     DECONSTRUCTABLE_IBAN_COUNTRY_CODES =
       CONSTRUCTABLE_IBAN_COUNTRY_CODES - PSEUDO_IBAN_COUNTRY_CODES
 
@@ -15,6 +15,7 @@ module Ibandit
       "AU" => "_", # Using _ because AU account numbers are alphanumeric
       "NZ" => "_",
       "CA" => "_",
+      "US" => "_",
     }.freeze
 
     SUPPORTED_COUNTRY_CODES = (

data/lib/ibandit/iban.rb

@@ -284,6 +284,7 @@ module Ibandit
       when "AU" then valid_australian_details?
       when "NZ" then valid_nz_details?
       when "CA" then valid_ca_details?
+      when "US" then bank_code_passes_checksum_test?
       else true
       end
     end
@@ -383,6 +384,24 @@ module Ibandit
       valid_modulus_check_branch_code?
     end
 
+    # rubocop:disable Metrics/AbcSize
+    def bank_code_passes_checksum_test?
+      return false if swift_bank_code.length != 9
+
+      code_digits = swift_bank_code.chars.map(&:to_i)
+      mod =
+        (
+          3 * (code_digits[0] + code_digits[3] + code_digits[6]) +
+          7 * (code_digits[1] + code_digits[4] + code_digits[7]) +
+          1 * (code_digits[2] + code_digits[5] + code_digits[8])
+        ) % 10
+
+      @errors[:bank_code] = Ibandit.translate(:is_invalid) unless mod.zero?
+
+      mod.zero?
+    end
+    # rubocop:enable Metrics/AbcSize
+
     ###################
     # Private methods #
     ###################

data/lib/ibandit/local_details_cleaner.rb

@@ -32,7 +32,8 @@ module Ibandit
 
     def self.required_fields(country_code)
       case country_code
-      when "AT", "CY", "DE", "FI", "LT", "LU", "LV", "NL", "RO", "SI", "SK"
+      when "AT", "CY", "DE", "FI", "LT", "LU",
+            "LV", "NL", "RO", "SI", "SK", "US"
         %i[bank_code account_number]
       when "BE", "CZ", "DK", "EE", "ES", "HR",
             "HU", "IS", "NO", "PL", "SE", "NZ"
@@ -99,6 +100,18 @@ module Ibandit
       }
     end
 
+    def self.clean_us_details(local_details)
+      return {} unless local_details[:bank_code].length == 9
+
+      account_number = local_details[:account_number].delete(" ")
+      return {} unless (1..17).cover?(account_number.length)
+
+      {
+        bank_code: local_details[:bank_code],
+        account_number: account_number.rjust(17, "_"),
+      }
+    end
+
     def self.clean_bg_details(local_details)
       # Bulgarian national bank details were replaced with IBANs in 2006.
       local_details

data/lib/ibandit/version.rb

@@ -1,3 +1,3 @@
 module Ibandit
-  VERSION = "0.11.25".freeze
+  VERSION = "0.11.26".freeze
 end

data/spec/ibandit/iban_spec.rb

@@ -601,6 +601,138 @@ describe Ibandit::IBAN do
           to eq(account_number: "is the wrong length (should be 10 characters)")
       end
     end
+
+    context "when the IBAN was created with local details for US" do
+      let(:arg) do
+        {
+          country_code: "US",
+          bank_code: bank_code,
+          account_number: account_number,
+        }
+      end
+
+      context "and a 9 digit bank code" do
+        let(:bank_code) { "965498456" }
+        let(:account_number) { "01234567890123456" }
+
+        its(:country_code) { is_expected.to eq("US") }
+        its(:bank_code) { is_expected.to eq(bank_code) }
+        its(:account_number) { is_expected.to eq(account_number) }
+        its(:swift_bank_code) { is_expected.to eq(bank_code) }
+        its(:swift_branch_code) { is_expected.to eq(nil) }
+        its(:swift_account_number) { is_expected.to eq(account_number) }
+        its(:swift_national_id) { is_expected.to eq(bank_code) }
+        its(:pseudo_iban) do
+          is_expected.to eq("USZZ96549845601234567890123456")
+        end
+
+        its(:iban) { is_expected.to be_nil }
+        its(:valid?) { is_expected.to eq(true) }
+        its(:to_s) { is_expected.to eq("") }
+      end
+
+      context "and a 7 digit bank code" do
+        let(:bank_code) { "0123456" }
+        let(:account_number) { "01234567890123456" }
+
+        its(:country_code) { is_expected.to eq("US") }
+        its(:bank_code) { is_expected.to eq(bank_code) }
+        its(:account_number) { is_expected.to eq(account_number) }
+        its(:swift_bank_code) { is_expected.to eq(bank_code) }
+        its(:swift_branch_code) { is_expected.to eq(nil) }
+        its(:swift_account_number) { is_expected.to eq(account_number) }
+        its(:swift_national_id) { is_expected.to eq(bank_code) }
+        its(:pseudo_iban) do
+          is_expected.to eq("USZZ__012345601234567890123456")
+        end
+
+        its(:iban) { is_expected.to be_nil }
+        its(:valid?) { is_expected.to eq(false) }
+        its(:to_s) { is_expected.to eq("") }
+      end
+
+      context "and bank code that doesn't pass checksum test" do
+        let(:bank_code) { "900000000" }
+        let(:account_number) { "01234567890123456" }
+
+        its(:iban) { is_expected.to be_nil }
+
+        it "returns an error on bank_code attribute" do
+          expect(subject.valid?).to eq(false)
+          expect(subject.errors).to eq(bank_code: "is invalid")
+        end
+      end
+
+      context "and a 7 digit account number" do
+        let(:account_number) { "0123456" }
+        let(:bank_code) { "965498456" }
+
+        its(:country_code) { is_expected.to eq("US") }
+        its(:bank_code) { is_expected.to eq(bank_code) }
+        its(:account_number) { is_expected.to eq("__________0123456") }
+        its(:swift_bank_code) { is_expected.to eq(bank_code) }
+        its(:swift_branch_code) { is_expected.to eq(nil) }
+        its(:swift_account_number) { is_expected.to eq("__________0123456") }
+        its(:swift_national_id) { is_expected.to eq(bank_code) }
+        its(:pseudo_iban) do
+          is_expected.to eq("USZZ965498456__________0123456")
+        end
+
+        its(:iban) { is_expected.to be_nil }
+        its(:valid?) { is_expected.to eq(true) }
+        its(:to_s) { is_expected.to eq("") }
+      end
+
+      context "and a 17 digit account number" do
+        let(:account_number) { "01234567890123456" }
+        let(:bank_code) { "965498456" }
+
+        its(:country_code) { is_expected.to eq("US") }
+        its(:bank_code) { is_expected.to eq(bank_code) }
+        its(:account_number) { is_expected.to eq("01234567890123456") }
+        its(:swift_bank_code) { is_expected.to eq(bank_code) }
+        its(:swift_branch_code) { is_expected.to eq(nil) }
+        its(:swift_account_number) { is_expected.to eq(account_number) }
+        its(:swift_national_id) { is_expected.to eq(bank_code) }
+        its(:pseudo_iban) do
+          is_expected.to eq("USZZ96549845601234567890123456")
+        end
+
+        its(:iban) { is_expected.to be_nil }
+        its(:valid?) { is_expected.to be true }
+        its(:to_s) { is_expected.to eq("") }
+      end
+    end
+
+    context "when the IBAN was created from a US pseudo-IBAN" do
+      let(:arg) { "USZZ96549845601234567890123456" }
+
+      its(:country_code) { is_expected.to eq("US") }
+      its(:bank_code) { is_expected.to eq("965498456") }
+      its(:branch_code) { is_expected.to be_nil }
+      its(:account_number) { is_expected.to eq("01234567890123456") }
+      its(:swift_bank_code) { is_expected.to eq("965498456") }
+      its(:swift_branch_code) { is_expected.to eq(nil) }
+      its(:swift_account_number) { is_expected.to eq("01234567890123456") }
+      its(:swift_national_id) { is_expected.to eq("965498456") }
+      its(:pseudo_iban) do
+        is_expected.to eq("USZZ96549845601234567890123456")
+      end
+
+      its(:iban) { is_expected.to be_nil }
+      its(:valid?) { is_expected.to be true }
+      its(:to_s) { is_expected.to eq("") }
+    end
+
+    context "when the input is an invalid US pseudo-IBAN" do
+      let(:arg) { "USZZ__012345601234567890123456" }
+
+      it "is invalid and has the correct errors" do
+        expect(subject.valid?).to eq(false)
+        expect(subject.errors).
+          to eq(bank_code: "is the wrong length (should be 9 characters)")
+      end
+    end
   end
 
   describe "#to_s" do

data/spec/ibandit/local_details_cleaner_spec.rb

@@ -1158,4 +1158,24 @@ describe Ibandit::LocalDetailsCleaner do
       it { is_expected.to eq(local_details_with_swift) }
     end
   end
+
+  context "US" do
+    context "when the account number has space characters" do
+      let(:country_code) { "US" }
+      let(:bank_code) { "012345678" }
+      let(:account_number) { "0123-45678 1234567" }
+
+      its([:bank_code]) { is_expected.to eq(bank_code) }
+      its([:account_number]) { is_expected.to eq("0123-456781234567") }
+    end
+
+    context "when the account number is shorter than the maximum length" do
+      let(:country_code) { "US" }
+      let(:bank_code) { "012345678" }
+      let(:account_number) { "0123456789" }
+
+      its([:bank_code]) { is_expected.to eq(bank_code) }
+      its([:account_number]) { is_expected.to eq("_______0123456789") }
+    end
+  end
 end

data/spec/ibandit/pseudo_iban_assembler_spec.rb

@@ -189,6 +189,42 @@ describe Ibandit::PseudoIBANAssembler do
     end
   end
 
+  context "for US" do
+    context "with valid parameters" do
+      let(:local_details) do
+        {
+          country_code: "US",
+          bank_code: "012345678",
+          account_number: "01234567890123456",
+        }
+      end
+
+      it { is_expected.to eq("USZZ01234567801234567890123456") }
+    end
+
+    context "without a bank_code" do
+      let(:local_details) do
+        {
+          country_code: "US",
+          account_number: "01234567890123456",
+        }
+      end
+
+      it { is_expected.to be_nil }
+    end
+
+    context "without an account number" do
+      let(:local_details) do
+        {
+          country_code: "US",
+          bank_code: "012345678",
+        }
+      end
+
+      it { is_expected.to be_nil }
+    end
+  end
+
   context "for a country that does not have pseudo-IBANs" do
     let(:local_details) do
       {

data/spec/ibandit/pseudo_iban_splitter_spec.rb

@@ -95,5 +95,29 @@ describe Ibandit::PseudoIBANSplitter do
       its([:branch_code]) { is_expected.to eq("00063") }
       its([:account_number]) { is_expected.to eq("012345678900") }
     end
+
+    context "for a US pseudo-IBAN without padding" do
+      let(:pseudo_iban) { "USZZ0123456780123456" }
+
+      its([:country_code]) { is_expected.to eq("US") }
+      its([:bank_code]) { is_expected.to eq("012345678") }
+      its([:account_number]) { is_expected.to eq("0123456") }
+    end
+
+    context "for a US pseudo-IBAN with padding" do
+      let(:pseudo_iban) { "USZZ012345678__________0123456" }
+
+      its([:country_code]) { is_expected.to eq("US") }
+      its([:bank_code]) { is_expected.to eq("012345678") }
+      its([:account_number]) { is_expected.to eq("0123456") }
+    end
+
+    context "for a US pseudo-IBAN with a 17-digit account number" do
+      let(:pseudo_iban) { "USZZ01234567801234567890123456" }
+
+      its([:country_code]) { is_expected.to eq("US") }
+      its([:bank_code]) { is_expected.to eq("012345678") }
+      its([:account_number]) { is_expected.to eq("01234567890123456") }
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibandit
 version: !ruby/object:Gem::Version
-  version: 0.11.25
+  version: 0.11.26
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-11 00:00:00.000000000 Z
+date: 2019-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -210,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Convert national banking details into IBANs, and vice-versa.