iso-swift 0.0.1

data/lib/data/zm.yml

@@ -0,0 +1,94 @@
+---
+ABBAZMLU:
+  institution: AB BANK ZAMBIA LTD.
+  city: LUSAKA
+  branch: ''
+AZAMZMLU:
+  institution: ACCESS BANK ZAMBIA LIMITED
+  city: LUSAKA
+  branch: ''
+FMBZZMLX:
+  institution: AFRICAN BANKING CORPORATION ZAMBIA
+  city: LUSAKA
+  branch: ''
+BKCHZMLU:
+  institution: BANK OF CHINA (ZAMBIA) LTD
+  city: LUSAKA
+  branch: ''
+BAZAZMLU:
+  institution: BANK OF ZAMBIA
+  city: LUSAKA
+  branch: AUTHORISED SETTLEMENT AGENT
+BAZAZMLUASA:
+  institution: BANK OF ZAMBIA
+  city: LUSAKA
+  branch: ''
+BARCZMLXKPC:
+  institution: BARCLAYS BANK PLC ZAMBIA
+  city: KITWE
+  branch: KITWE PROCESSING CENTRE
+BARCZMLX:
+  institution: BARCLAYS BANK PLC ZAMBIA
+  city: LUSAKA
+  branch: HEAD OFFICE
+CVMTZMLU:
+  institution: CAVMONT MERCHANT BANK LIMITED
+  city: LUSAKA
+  branch: ''
+CITIZMLU:
+  institution: CITIBANK ZAMBIA LTD
+  city: LUSAKA
+  branch: ''
+ECOCZMLU:
+  institution: ECOBANK ZAMBIA
+  city: LUSAKA
+  branch: ''
+ZFBAZMLU:
+  institution: FINANCE BANK ZAMBIA LIMITED.
+  city: LUSAKA
+  branch: ''
+FALLZMLU:
+  institution: FIRST ALLIANCE BANK
+  city: LUSAKA
+  branch: ''
+ICZAZMLU:
+  institution: FIRST CAPITAL BANK (Z) LTD (FORMERLY KNOWN AS INTERNATIONAL COMMERCIAL
+    BANK ZAMBIA LIMITED)
+  city: LUSAKA
+  branch: ''
+FIRNZMLX:
+  institution: FIRST NATIONAL BANK ZAMBIA LIMITED
+  city: LUSAKA
+  branch: ''
+INZAZMLX:
+  institution: INDO-ZAMBIA BANK
+  city: LUSAKA
+  branch: ''
+IDHZZMLU:
+  institution: INTERMARKET BANKING CORPORATION LIMITED
+  city: LUSAKA
+  branch: ''
+VSTRZMLU:
+  institution: INVESTRUST BANK LTD
+  city: LUSAKA
+  branch: ''
+SBICZMLX:
+  institution: STANBIC BANK ZAMBIA LTD.
+  city: LUSAKA
+  branch: LUSAKA BRANCH
+SCBLZMLX:
+  institution: STANDARD CHARTERED BANK ZAMBIA LTD
+  city: LUSAKA
+  branch: ''
+SCBLZMLXSSU:
+  institution: STANDARD CHARTERED BANK ZAMBIA LTD
+  city: LUSAKA
+  branch: SECURITIES SERVICES UNIT
+UNAFZMLU:
+  institution: UNITED BANK FOR AFRICA ZAMBIA LIMITED
+  city: LUSAKA
+  branch: ''
+ZNCOZMLU:
+  institution: ZAMBIA NATIONAL COMMERCIAL
+  city: LUSAKA
+  branch: ''

data/lib/data/zw.yml

@@ -0,0 +1,113 @@
+---
+FMBZZWHX:
+  institution: AFRICAN BANKING CORP.OF ZIMBABWE LTD.
+  city: HARARE
+  branch: ''
+AGRZZWHA:
+  institution: AGRICULTURAL BANK OF ZIMBABWE LTD
+  city: HARARE
+  branch: ''
+BARCZWHX:
+  institution: BARCLAYS BANK OF ZIMBABWE
+  city: HARARE
+  branch: ''
+CBBLZWHX:
+  institution: CAPITAL BANK CORPORATION LTD
+  city: HARARE
+  branch: ''
+CABSZWHA:
+  institution: CENTRAL AFRICA BUILDING SOCIETY
+  city: HARARE
+  branch: ''
+COCUZWHA:
+  institution: COMESA CLEARING HOUSE
+  city: HARARE
+  branch: ''
+COBZZWHA:
+  institution: COMMERCIAL BANK OF ZIMBABWE LIMITED
+  city: HARARE
+  branch: ''
+ECOCZWHX:
+  institution: ECOBANK ZIMBABWE LIMITED
+  city: HARARE
+  branch: ''
+FBCPZWHA:
+  institution: FBC BANK LTD
+  city: HARARE
+  branch: ''
+ZDBLZWHA:
+  institution: INFRASTRUCTURE DEVELOPMENT BANK OF ZIMBABWE ED
+  city: HARARE
+  branch: ''
+IFMBZWHA:
+  institution: INTERFINBANK
+  city: HARARE
+  branch: ''
+KFISZWHA:
+  institution: KINGDOM BANK LIMITED (KBL)
+  city: HARARE
+  branch: ''
+MBCAZWHX:
+  institution: MBCA BANK LIMITED
+  city: HARARE
+  branch: ''
+MBOZZWHA:
+  institution: METROPOLITAN BANK OF ZIMBABWE LTD
+  city: HARARE
+  branch: ''
+NMBLZWHXBYO:
+  institution: NMB BANK LIMITED
+  city: BULAWAYO
+  branch: BULAWAYO BRANCH
+NMBLZWHX:
+  institution: NMB BANK LIMITED
+  city: HARARE
+  branch: ''
+PWSBZWHX:
+  institution: PEOPLE’S OWN SAVINGS BANK
+  city: HARARE
+  branch: ''
+REBZZWHQ:
+  institution: RESERVE BANK OF ZIMBABWE
+  city: HARARE
+  branch: ''
+REBZZWHX:
+  institution: RESERVE BANK OF ZIMBABWE
+  city: HARARE
+  branch: ''
+REBZZWHXPCH:
+  institution: RESERVE BANK OF ZIMBABWE
+  city: HARARE
+  branch: ''
+SBICZWHX:
+  institution: STANBIC BANK ZIMBABWE LIMITED
+  city: HARARE
+  branch: ''
+SCBLZWHXSSU:
+  institution: STANDARD CHARTERED BANK ZIMBABWE LIMITED
+  city: HARARE
+  branch: SECURITIES SERVICES UNIT
+SCBLZWHX:
+  institution: STANDARD CHARTERED BANK ZIMBABWE LIMITED
+  city: HARARE
+  branch: ''
+STBLZWHX:
+  institution: STEWARD BANK LIMITED
+  city: HARARE
+  branch: ''
+TTSLZWHX:
+  institution: TETRAD INVESTMENT BANK LIMITED
+  city: HARARE
+  branch: ''
+ZABCZWHA:
+  institution: ZIMBABWE ALLIED BANKING GROUP
+  city: HARARE
+  branch: ''
+ZBCOZWHXBYO:
+  institution: ZIMBABWE BANKING CORPORATION LTD.
+  city: BULAWAYO
+  branch: ''
+ZBCOZWHX:
+  institution: ZIMBABWE BANKING CORPORATION LTD.
+  city: HARARE
+  branch: ''

data/lib/iso.rb

@@ -0,0 +1,2 @@
+require 'iso/version'
+require 'iso/swift'

data/lib/iso/swift.rb

@@ -0,0 +1,225 @@
+require 'yaml'
+require 'countries'
+
+module ISO
+
+  # SWIFT
+  #
+  # Usage
+  # =====
+  #
+  #     require 'iso/swift'
+  #     ==== new instance - valid SWIFT code
+  #     swift = ISO::SWIFT.new('PSST FR PP SCE') # => #<ISO::SWIFT:0x007fb4a393e220 @data={"formatted"=>"PSSTFRPPSCE", "bank_code"=>"PSST", "country_code"=>"FR", "country_name"=>"France", "location_code"=>"PP", "branch_code"=>"SCE", "bank_name"=>"LA BANQUE POSTALE", "location_name"=>"ORLEANS", "branch_name"=>"CENTRE FINANCIER DORLEANS LA SOURCE"}, @errors=[]>
+  #     ==== validation
+  #     swift.valid? # => true
+  #     swift.errors # => []
+  #     ==== attributes
+  #     swift.original # => "PSST FR PP SCE"
+  #     swift.formatted # => "PSSTFRPPSCE"
+  #     swift.bank_code # => "PSST"
+  #     swift.bank_name # => "LA BANQUE POSTALE"
+  #     swift.country_code # => "FR"
+  #     swift.country_name # => "France"
+  #     swift.location_code # => "PP"
+  #     swift.location_name # => "ORLEANS"
+  #     swift.branch_code # => "SCE"
+  #     swift.branch_name # => "CENTRE FINANCIER DORLEANS LA SOURCE"
+  #
+  #     ==== new instance - invalid SWIFT code
+  #     swift = ISO::SWIFT.new('PSSTFRCEE') # #<ISO::SWIFT:0x007f8abe708820 @data={}, @errors=[:bad_format]>
+  #     ==== validation
+  #     swift.valid? # => false
+  #     swift.errors # => [:bad_format]
+
+  class SWIFT
+
+    # Swift regular expression
+    Regex = /^[A-Z]{4}[A-Z]{2}[A-Z0-9]{2}([A-Z0-9]{3})?$/
+
+    # Attributes
+    AttrReaders = [
+      :original,
+      :formatted,
+      :bank_code,
+      :bank_name,
+      :country_code,
+      :country_name,
+      :location_code,
+      :location_name,
+      :branch_code,
+      :branch_name
+    ]
+
+    AttrReaders.each do |meth|
+      define_method meth do
+        @data[meth.to_s]
+      end
+    end
+
+    attr_reader :data
+    attr_reader :errors
+
+    # @param [String] swift
+    #   The SWIFT in either compact or human readable form.
+    #
+    # @return [ISO::SWIFT]
+    #   A new instance of ISO::SWIFT 
+    def initialize(swift)
+      @data = {}
+      @errors = []
+      @data["original"] = swift
+      swift = parse(swift)
+      validate(swift)
+      if @errors.empty?
+        feed_codes(swift)
+        feed_lookup_info(swift)
+      end
+    end
+
+    # @param [String] swift
+    #   The SWIFT in either compact or human readable form.
+    #
+    # Extracts bank, country, location and branch codes from the parameter 
+    def feed_codes(swift)
+      if @errors.empty?
+        @data["formatted"] = swift
+        @data["bank_code"] = swift[0..3]
+        @data["country_code"] = swift[4..5]
+        country = ::Country.new(country_code)
+        if country
+          @data["country_name"] = country.name
+        else
+          @errors << :bad_country_code
+        end
+        @data["location_code"] = swift[6..7]
+        @data["branch_code"] = swift[8..10]
+      end
+    end
+
+    # @param [String] swift
+    #   The SWIFT in either compact or human readable form.
+    #
+    # Lookup for the formatted swift in data/*country_code*.yml
+    # If found, extract the bank, location and branch names
+    def feed_lookup_info(swift)
+      cc = country_code.downcase
+      path = File.expand_path("../../data/#{cc}.yml", __FILE__)
+      if File.file?(path)
+        db = YAML.load_file(path) || nil
+        if db
+          lk = db[formatted]
+          if lk
+            @data["bank_name"] = lk["institution"]
+            @data["location_name"] = lk["city"]
+            @data["branch_name"] = lk["branch"]
+          end
+        end
+      end
+    end
+
+    # @return [String]
+    #   Retuns the original swift from an ISO::SWIFT instance
+    def original
+      @data["original"]
+    end
+
+    # @return [String]
+    #   Retuns the formatted swift from an ISO::SWIFT instance
+    def formatted
+      @data["formatted"]
+    end
+
+    # @return [String]
+    #   Retuns the bank code from an ISO::SWIFT instance
+    def bank_code
+      @data["bank_code"]
+    end
+
+    # @return [String]
+    #   Retuns the bank name from an ISO::SWIFT instance
+    def bank_name
+      @data["bank_name"]
+    end
+
+    # @return [String]
+    #   Retuns the country code from an ISO::SWIFT instance
+    def country_code
+      @data["country_code"]
+    end
+
+    # @return [String]
+    #   Retuns the country name from an ISO::SWIFT instance
+    #   The country name was fetched using https://github.com/hexorx/countries
+    def country_name
+      @data["country_name"]
+    end
+
+    # @return [String]
+    #   Retuns the location code from an ISO::SWIFT instance
+    def location_code
+      @data["location_code"]
+    end
+
+    # @return [String]
+    #   Retuns the location name from an ISO::SWIFT instance
+    def location_name
+      @data["location_name"]
+    end
+
+    # @return [String]
+    #   Retuns the branch code from an ISO::SWIFT instance
+    def branch_code
+      @data["branch_code"]
+    end
+
+    # @return [String]
+    #   Retuns the branch name from an ISO::SWIFT instance
+    def branch_name
+      @data["branch_name"]
+    end
+
+    # @return [Array<Sym>]
+    #   Retuns an array of errors in symbol format from validation step, if any
+    def errors
+      @errors.to_a
+    end
+
+    # @return [Boolean]
+    #   Returns if the current ISO::SWIFT instance if valid
+    def valid?
+      @errors.empty?
+    end
+
+    private
+
+    # @param [String] swift
+    #   The SWIFT in either compact or human readable form.
+    #
+    # Validation of the length and format of the formatted swift
+    def validate(swift)
+      @errors << :too_short if swift.size < 8
+      @errors << :too_long if swift.size > 11
+      @errors << :bad_chars unless swift =~ /^[A-Z0-9]+$/
+      @errors << :bad_format unless swift =~ Regex
+    end
+
+    # @param [String] swift
+    #   The SWIFT in either compact or human readable form.
+    #
+    # @return [String]
+    #   The SWIFT in compact form, all whitespace and dashes stripped.
+    def strip(swift)
+      swift.delete("\n\r\t -")
+    end
+
+    # @param [String, nil] swift
+    #   The SWIFT in either compact or human readable form.
+    #
+    # @return [String]
+    #   The SWIFT in either compact or human readable form.
+    def parse(swift)
+      strip(swift || "").upcase
+    end
+  end
+end

data/lib/iso/version.rb

@@ -0,0 +1,3 @@
+module ISO
+  VERSION = "0.0.1"
+end

data/spec/iso_swift_spec.rb

@@ -0,0 +1,192 @@
+# encoding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe '[ISO::SWIFT]' do
+
+  context 'a new ISO::SWIFT instance' do
+
+    let(:swift) { ISO::SWIFT.new('PSSTFRPPSCE') }
+
+    it 'responds to :valid?' do
+      expect(swift).to respond_to(:valid?)
+    end
+
+    it 'responds to :errors' do
+      expect(swift).to respond_to(:errors)
+    end
+
+    it 'responds to :original' do
+      expect(swift).to respond_to(:original)
+    end
+
+    it 'responds to :formatted' do
+      expect(swift).to respond_to(:formatted)
+    end
+
+    it 'responds to :bank_code' do
+      expect(swift).to respond_to(:bank_code)
+    end
+
+    it 'responds to :bank_name' do
+      expect(swift).to respond_to(:bank_name)
+    end
+
+    it 'responds to :country_code' do
+      expect(swift).to respond_to(:country_code)
+    end
+
+    it 'responds to :country_name' do
+      expect(swift).to respond_to(:country_name)
+    end
+
+    it 'responds to :location_code' do
+      expect(swift).to respond_to(:location_code)
+    end
+
+    it 'responds to :location_name' do
+      expect(swift).to respond_to(:location_name)
+    end
+
+    it 'responds to :branch_code' do
+      expect(swift).to respond_to(:bank_code)
+    end
+
+    it 'responds to :branch_name' do
+      expect(swift).to respond_to(:branch_name)
+    end
+  end
+
+  context 'a new ISO::SWIFT instance with a valid SWIFT code' do
+  
+    let(:swift) { ISO::SWIFT.new('PSST FR PP SCE') }
+
+    it 'is valid' do
+      expect(swift).to be_valid
+      expect(swift.valid?).to eq(true)
+    end
+
+    it 'has no error' do
+      expect(swift.errors).to be_empty
+    end
+
+    context '[attributes]' do
+
+      it '[:original] is OK' do
+        expect(swift.original).to eq('PSST FR PP SCE')
+      end
+
+      it '[:formatted] is OK' do
+        expect(swift.formatted).to eq('PSSTFRPPSCE')
+      end
+
+      it '[:bank_code] is OK' do
+        expect(swift.bank_code).to eq('PSST')
+      end
+
+      it '[:bank_name] is OK' do
+        expect(swift.bank_name).to eq('LA BANQUE POSTALE')
+      end
+
+      it '[:country_code] is OK' do
+        expect(swift.country_code).to eq('FR')
+      end
+
+      it '[:country_name] is OK' do
+        expect(swift.country_name).to eq('France')
+      end
+
+      it '[:location_code] is OK' do
+        expect(swift.location_code).to eq('PP')
+      end
+
+      it '[:location_name] is OK' do
+        expect(swift.location_name).to eq('ORLEANS')
+      end
+
+      it '[:branch_code] is OK' do
+        expect(swift.branch_code).to eq('SCE')
+      end
+
+      it '[:branch_name] is OK' do
+        expect(swift.branch_name).to eq('CENTRE FINANCIER DORLEANS LA SOURCE')
+      end
+    end
+  end
+
+  context 'a new ISO::SWIFT instance with ill-formed SWIFT code' do
+
+    let(:swift) { ISO::SWIFT.new('PSSTFRPPS') }
+
+    it 'is not valid' do
+      expect(swift).not_to be_valid
+    end
+
+    it 'has errors' do
+      expect(swift.errors).not_to be_empty
+    end
+
+    it 'has an error array including :bad_format' do
+      expect(swift.errors).to include(:bad_format)
+    end
+
+    context '[attributes]' do
+
+      it '[:original] is OK' do
+        expect(swift.original).to eq('PSSTFRPPS')
+      end
+
+      it 'all other attributes are nil' do
+        expect(swift.formatted).to be_nil
+        expect(swift.bank_code).to be_nil
+        expect(swift.bank_name).to be_nil
+        expect(swift.country_code).to be_nil
+        expect(swift.country_name).to be_nil
+        expect(swift.location_code).to be_nil
+        expect(swift.location_name).to be_nil
+        expect(swift.branch_code).to be_nil
+        expect(swift.branch_name).to be_nil
+      end
+    end
+  end
+
+  context 'a new ISO::SWIFT instance with an invalid country code' do
+
+    let(:swift) { ISO::SWIFT.new('PSSTFAPPSCE') }
+
+    it 'is not valid' do
+      expect(swift).not_to be_valid
+    end
+
+    it 'has errors' do
+      expect(swift.errors).not_to be_empty
+    end
+
+    it 'has an errors array including :bad_country_code' do
+      expect(swift.errors).to include(:bad_country_code)
+    end
+
+    it 'has no country name' do
+      expect(swift.country_name).to be_nil
+    end
+  end
+
+  context 'a new ISO::SWIFT instance with an unknown SWIFT code' do
+
+    let(:swift) { ISO::SWIFT.new('PSSTFIPPSCE') }
+
+    it 'is valid' do
+      expect(swift).to be_valid
+    end
+
+    it 'has no error' do
+      expect(swift.errors).to be_empty
+    end
+
+    it 'has no lookup info' do
+      expect(swift.bank_name).to be_nil
+      expect(swift.location_name).to be_nil
+      expect(swift.branch_name).to be_nil
+    end
+  end
+end