aba_numbers 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp/*

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adrian Madrid
+
+MIT License
+
+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,31 @@
+# AbaNumbers
+
+Get a list of Federal Reserve E-Payments Routing Directory from the Federal Reserve Financial Services.
+This database will provide you with a known list of financial entities and their ABA (routing) numbers plus other useful information like bank name, city, state, etc.
+You can also get a way to validate an unknown ABA number through a simple formula.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'aba_numbers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aba_numbers
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/aba_numbers.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aba_numbers/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'aba_numbers'
+  gem.version       = AbaNumbers::VERSION
+  gem.authors       = ['Adrian Madrid']
+  gem.email         = %w(aemadrid@gmail.com)
+  gem.description   = %q{Get a list of Federal Reserve E-Payments Routing Directory}
+  gem.summary       = %q{Get a list of Federal Reserve E-Payments Routing Directory from the Federal Reserve Financial Services}
+  gem.homepage      = 'https://github.com/NorthPointAdvisors/aba_numbers'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = %w( lib )
+
+  gem.add_development_dependency 'rspec', '~> 2.8.0'
+  gem.add_development_dependency 'simplecov', '~> 0.7.1'
+end

data/lib/aba_numbers.rb

@@ -0,0 +1,14 @@
+module AbaNumbers
+
+  ROOT_PATH = File.expand_path(File.dirname(File.dirname(__FILE__)))
+  LIB_PATH = File.join ROOT_PATH, 'lib'
+  DB_PATH = File.join ROOT_PATH, 'db'
+  TMP_PATH = File.join ROOT_PATH, 'tmp'
+
+end
+
+$LOAD_PATH.unshift(AbaNumbers::LIB_PATH) unless $LOAD_PATH.include?(AbaNumbers::LIB_PATH)
+
+require 'aba_numbers/version'
+require 'aba_numbers/validation'
+require 'aba_numbers/database'

data/lib/aba_numbers/database.rb

@@ -0,0 +1,130 @@
+require 'uri'
+require 'open-uri'
+require 'openssl'
+require 'date'
+require 'net/http'
+require 'net/https'
+
+module AbaNumbers
+  class Database
+
+    class Row
+
+      include Comparable
+
+      attr_reader :aba_number, :short_name, :name, :state, :city
+
+      def initialize(line)
+        @aba_number      = line[0, 9]
+        @short_name      = line[9, 18].strip
+        @name            = line[27, 36].strip
+        @state           = line[63, 2]
+        @city            = line[65, 25].strip
+        @funds_transfer  = line[90, 1]
+        @settlement_only = line[91, 1]
+        @securities      = line[92, 1]
+        @last_updated    = line[93, 8].strip
+      end
+
+      def funds_transfer
+        @funds_transfer == 'Y'
+      end
+
+      def settlement_only
+        @settlement_only == 'S'
+      end
+
+      def securities
+        @securities == 'Y'
+      end
+
+      def last_updated
+        return nil if @last_updated.empty?
+        Date.new @last_updated[0, 4].to_i, @last_updated[4, 2].to_i, @last_updated[6, 2].to_i
+      end
+
+      def to_s
+        "#<AbaNumbers::Database::Row aba_number=#{aba_number.inspect} " +
+          "short_name=#{short_name.inspect} name=#{name.inspect} " +
+          "state=#{state.inspect} city=#{city.inspect} " +
+          "funds_transfer=#{funds_transfer.inspect} settlement_only=#{settlement_only.inspect} " +
+          "securities=#{securities.inspect} last_updated=#{last_updated}>"
+      end
+
+      alias :inspect :to_s
+
+      def <=>(other)
+        if other.respond_to? :aba_number
+          aba_number <=> other.aba_number
+        else
+          to_s <=> other.to_s
+        end
+      end
+
+    end
+
+    attr_reader :url, :path
+
+    FEDERAL_URL = 'https://www.fededirectory.frb.org/fpddir.txt'
+
+    def initialize(url = nil, path = nil)
+      @url  = url || FEDERAL_URL
+      @path = path || File.join(AbaNumbers::DB_PATH, 'fpddir.txt')
+    end
+
+    def file?
+      File.file? path
+    end
+
+    def line_count
+      File.foreach(path).inject(0) { |c, _| c+1 }
+    end
+
+    def get_file_from_url
+      uri   = URI url
+      https = Net::HTTP.new uri.host, uri.port
+
+      if uri.scheme == 'https'
+        https.use_ssl     = true
+        https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      res = https.request_get uri.request_uri
+      File.open(path, 'w') { |f| f.puts res.body }
+    end
+
+    def read_local_file
+      data.clear
+      File.open(path).each_line do |line|
+        line.strip!
+        unless line.empty?
+          row                  = Row.new line
+          data[row.aba_number] = row
+        end
+      end
+    end
+
+    def data
+      if @data.nil?
+        @data = {}
+        reload
+      end
+      @data
+    end
+
+    def [](aba_number)
+      data[aba_number.to_s]
+    end
+
+    def needs_getting_file?
+      !file? || line_count == 0
+    end
+
+    def reload
+      get_file_from_url if needs_getting_file?
+      read_local_file
+      @loaded = true
+    end
+
+  end
+end

data/lib/aba_numbers/validation.rb

@@ -0,0 +1,23 @@
+module AbaNumbers
+  module Validation
+
+    def valid_aba_number?(aba_number)
+      aba_number_str = aba_number.to_s.strip
+
+      return false if aba_number_str.empty?
+      return false unless aba_number_str =~ /^\d{9}$/
+
+      total = 0
+      0.step(9, 3) do |i|
+        total += aba_number_str[i..i].to_i * 3
+        total += aba_number_str[(i+1)..(i+1)].to_i * 7
+        total += aba_number_str[(i+2)..(i+2)].to_i * 1
+      end
+
+      total % 10 == 0
+    end
+
+    module_function :valid_aba_number?
+
+  end
+end

data/lib/aba_numbers/version.rb

@@ -0,0 +1,3 @@
+module AbaNumbers
+  VERSION = '0.0.1'
+end

data/spec/database_spec.rb

@@ -0,0 +1,79 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe AbaNumbers::Database do
+
+  let(:klass) { AbaNumbers::Database }
+  let(:tmp_path) { File.join AbaNumbers::TMP_PATH, 'fpddir_fake.txt' }
+  let(:db) { klass.new nil, tmp_path }
+  let(:line1) { '325170835FBT FSL PT ANBEL  FIRST FEDERAL SAVINGS & LOAN OF PA  WAPORT ANBELES             Y N20060614' }
+  let(:line2) { '325180553AK PAC JUBEAU     ALASKA PASIFIC BANK                 AKJUBEAU                   Y N        ' }
+  let(:row1) { AbaNumbers::Database::Row.new line1 }
+  let(:row2) { AbaNumbers::Database::Row.new line2 }
+
+  before(:all) { File.open(tmp_path, 'w') { |f| f.puts "#{line1}\n#{line2}" } }
+  after(:all) { FileUtils.rm tmp_path }
+
+  describe 'basic' do
+    it { db.url.should == AbaNumbers::Database::FEDERAL_URL }
+    it { db.path.should == tmp_path }
+    it { db.file?.should be_true }
+    it { db.line_count.should == 2 }
+    it { db.needs_getting_file?.should be_false }
+    it { db.instance_variable_get(:@data).should be_nil }
+  end
+
+  describe 'processing' do
+    before(:all) { db.data }
+    after(:all) { db.instance_variable_set :@data, nil }
+    it { db.data.size.should == 2 }
+    it { db.data.size.should == db.line_count }
+    it { db.data[row1.aba_number].should == row1 }
+    it { db[row2.aba_number].should == row2 }
+  end
+
+  describe 'getting data from federal reserve' do
+    if ENV['full_test']
+      it 'should download a valid file from the federal reserve database' do
+        tmp_path = File.join AbaNumbers::TMP_PATH, 'fpddir.txt'
+        FileUtils.rm tmp_path
+        db = klass.new nil, tmp_path
+        expect { db.get_file_from_url }.to_not raise_error
+        db.line_count.should > 0
+      end
+    else
+      pending 'need to run with ENV[\'full_test\'] to test getting an actual data file'
+    end
+  end
+
+  describe AbaNumbers::Database::Row do
+    describe 'basic #1' do
+      it { row1.aba_number.should == '325170835' }
+      it { row1.short_name.should == 'FBT FSL PT ANBEL' }
+      it { row1.name.should == 'FIRST FEDERAL SAVINGS & LOAN OF PA' }
+      it { row1.state.should == 'WA' }
+      it { row1.city.should == 'PORT ANBELES' }
+      it { row1.funds_transfer.should be_true }
+      it { row1.settlement_only.should be_false }
+      it { row1.securities.should be_false }
+      it { row1.last_updated.to_s.should == '2006-06-14' }
+      it { row1.to_s.should == "#<AbaNumbers::Database::Row aba_number=\"325170835\" short_name=\"FBT FSL PT ANBEL\" name=\"FIRST FEDERAL SAVINGS & LOAN OF PA\" state=\"WA\" city=\"PORT ANBELES\" funds_transfer=true settlement_only=false securities=false last_updated=2006-06-14>" }
+      it { row1.to_s.should == row1.inspect }
+    end
+    describe 'basic #2' do
+      let(:exp_to_s) { "#<AbaNumbers::Database::Row aba_number=\"325180553\" short_name=\"AK PAC JUBEAU\" name=\"ALASKA PASIFIC BANK\" state=\"AK\" city=\"JUBEAU\" funds_transfer=true settlement_only=false securities=false last_updated=>" }
+      let(:other) { mock to_s: exp_to_s }
+      it { row2.aba_number.should == '325180553' }
+      it { row2.short_name.should == 'AK PAC JUBEAU' }
+      it { row2.name.should == 'ALASKA PASIFIC BANK' }
+      it { row2.state.should == 'AK' }
+      it { row2.city.should == 'JUBEAU' }
+      it { row2.funds_transfer.should be_true }
+      it { row2.settlement_only.should be_false }
+      it { row2.securities.should be_false }
+      it { row2.last_updated.should be_nil }
+      it { row2.to_s.should == exp_to_s }
+      it { row2.should == other }
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+unless Object.const_defined? :SPEC_HELPER_LOADED
+
+  require 'fileutils'
+
+  begin
+    require 'simplecov'
+    SimpleCov.start
+    SimpleCov.start do
+      add_group 'Libs', 'lib'
+      add_group 'Specs', 'spec'
+    end
+  rescue LoadError
+    puts 'SimpleCov not available, skipping coverage...'
+  end
+
+  require 'bundler/setup'
+  lib = File.expand_path File.dirname(__FILE__)
+  $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+  require 'aba_numbers'
+
+  RSpec.configure do |config|
+    config.treat_symbols_as_metadata_keys_with_true_values = true
+    config.run_all_when_everything_filtered                = true
+    config.filter_run :focus
+    config.order = 'random'
+    config.filter_run_excluding :broken => true, :skipped => true
+  end
+
+  Object.const_set :SPEC_HELPER_LOADED, true
+end

data/spec/validation_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe AbaNumbers::Validation do
+
+  describe 'known valid' do
+    %w{ 011501598 011600774 063112728 113093852 114922090 271171674 325272306 }.each do |aba_number|
+      it { AbaNumbers::Validation.valid_aba_number?(aba_number).should be_true }
+    end
+  end
+
+  describe 'known invalid' do
+    %w{ 011501599 011600775 063112729 113093853 114922091 271171675 325272307 }.each do |aba_number|
+      it { AbaNumbers::Validation.valid_aba_number?(aba_number).should be_false }
+    end
+  end
+
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: aba_numbers
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Adrian Madrid
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-03-26 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 7
+        - 1
+        version: 0.7.1
+  type: :development
+  version_requirements: *id002
+description: Get a list of Federal Reserve E-Payments Routing Directory
+email: 
+- aemadrid@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aba_numbers.gemspec
+- db/fpddir.txt
+- lib/aba_numbers.rb
+- lib/aba_numbers/database.rb
+- lib/aba_numbers/validation.rb
+- lib/aba_numbers/version.rb
+- spec/database_spec.rb
+- spec/spec_helper.rb
+- spec/validation_spec.rb
+has_rdoc: true
+homepage: https://github.com/NorthPointAdvisors/aba_numbers
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Get a list of Federal Reserve E-Payments Routing Directory from the Federal Reserve Financial Services
+test_files: 
+- spec/database_spec.rb
+- spec/spec_helper.rb
+- spec/validation_spec.rb