frb-participants 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 71f48b2e53492e20f33c820b865c895acc8ba3d4
+  data.tar.gz: af0778c9625cb332e59ebe2492ec5fb5e9412bea
+SHA512:
+  metadata.gz: 8dd47c9b145874e7bf750e0685f7f335cfa7b06f69d4852d5113bbfbf63f47901f29d4a96e80aab7afe3fa5d88f5baf0f273e571fe3967d96a153ca4a01b28de
+  data.tar.gz: a3f6961d75c1ce7128d5f3eb2d2ec5167e97de73301ceac1071a367a339050386b4bb3b6e3bc5bdc291d7e91ed08c2f4c5a8befda97f2a496100f1c62ada914f

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'slither', git: 'https://github.com/ryanwood/slither'
+
+# Specify your gem's dependencies in frb-participants.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,84 @@
+GIT
+  remote: https://github.com/ryanwood/slither
+  revision: 268fde22ebb756b154abdd3fa1e9f7fc7badf035
+  specs:
+    slither (0.99.5)
+
+PATH
+  remote: .
+  specs:
+    frb-participants (0.1.0)
+      activesupport (>= 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.0.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    domain_name (0.5.20170223)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    i18n (0.8.1)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    minitest (5.10.1)
+    neatjson (0.8.3)
+    netrc (0.11.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rest-client (2.0.1)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    slop (3.6.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.13)
+  frb-participants!
+  neatjson (~> 0.8)
+  pry (~> 0.10)
+  rake (~> 10.0)
+  rest-client (~> 2.0)
+  rspec (~> 3.0)
+  rspec-its (~> 1.2)
+  slither!
+
+BUNDLED WITH
+   1.14.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Wealthsimple
+
+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,108 @@
+# frb-participants [![CircleCI](https://circleci.com/gh/wealthsimple/frb-participants.svg?style=svg)](https://circleci.com/gh/wealthsimple/frb-participants) [![](https://img.shields.io/gem/v/frb-participants.svg)](https://rubygems.org/gems/frb-participants)
+
+Provides data from the The Federal Reserve Banks' Fedwire & FedACH participants in JSON format, mapping routing number to associated bank name and branch info.
+
+For more details, see [Federal Reserve Bank Services: Download E-Payments Routing Directories](https://www.frbservices.org/EPaymentsDirectory/download.html)
+
+## Rubygem:
+
+```ruby
+gem 'frb-participants', git: 'https://github.com/wealthsimple/frb-participants'
+```
+
+You can do basic queries of data:
+
+```ruby
+FrbParticipants::FedachParticipant.find_by_routing_number("322170016")
+=> #<OpenStruct
+      type=:ach,
+      customer_name="BANK OF AMERICA, N.A. - ARIZONA",
+      known_normalized_name="Bank of America",
+      best_attempt_normalized_name="Bank Of America, N.A. - Arizona"
+      office_type="main",
+      servicing_frb_number="121000374",
+      record_type_code="1",
+      revision_date="121503",
+      new_routing_number=nil,
+      address="VA2-430-01-01",
+      city="RICHMOND",
+      state="VA",
+      zip="23261",
+      zip_extension="7025",
+      telephone="8004460135">
+```
+
+```ruby
+FrbParticipants::FedwireParticipant.find_by_routing_number("325182946")
+=> #<OpenStruct
+      type=:wire,
+      telegraphic_name="UMPQUA BANK WA",
+      customer_name="UMPQUA BANK",
+      known_normalized_name=nil,
+      best_attempt_normalized_name="Umpqua Bank",
+      state="OR",
+      city="HILLSBORO",
+      funds_transfer_eligible=true,
+      settlement_only=false,
+      securities_transfer_eligible=false,
+      revision_date="20160526">
+```
+
+Important! If you are using this on a production service, it is recommended that you preload the data in an initializer:
+
+```ruby
+require 'frb-participants'
+FrbParticipants::Data.preload!
+```
+
+## Normalized data:
+
+ **[fedwire-participants.json](https://github.com/wealthsimple/frb-participants/blob/master/data/fedwire-participants.json)**
+
+```json
+{
+  "325182836":{
+    "telegraphic_name":"LOWER VALLEY CU WA",
+    "customer_name":"LOWER VALLEY CREDIT UNION",
+    "state":"WA",
+    "city":"SUNNYSIDE",
+    "funds_transfer_eligible":true,
+    "settlement_only":false,
+    "securities_transfer_eligible":true,
+    "revision_date":"20120702"
+  },
+  "325182946":{
+    "telegraphic_name":"UMPQUA BANK WA",
+    "customer_name":"UMPQUA BANK",
+    "state":"OR",
+    "city":"HILLSBORO",
+    "funds_transfer_eligible":true,
+    "settlement_only":false,
+    "securities_transfer_eligible":false,
+    "revision_date":null
+  },
+  ...
+}
+```
+
+ **[fedach-participants.json](https://github.com/wealthsimple/frb-participants/blob/master/data/fedach-participants.json)**
+
+```json
+{
+  "011000015":{
+    "office_type":"main",
+    "servicing_frb_number":"011000015",
+    "record_type_code":"0",
+    "revision_date":"122415",
+    "new_routing_number":null,
+    "customer_name":"FEDERAL RESERVE BANK",
+    "address":"1000 PEACHTREE ST N.E.",
+    "city":"ATLANTA",
+    "state":"GA",
+    "zip":"30309",
+    "zip_extension":"4470",
+    "telephone":"8773722457"
+  },
+  ...
+}
+```

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "frb-participants"
+
+# 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

data/bin/fedach-parse.rb

@@ -0,0 +1,67 @@
+require "active_support/all"
+require "slither"
+require "pp"
+require "json"
+require "neatjson"
+require "yaml"
+
+# Format is defined at:
+# https://www.frbservices.org/EPaymentsDirectory/achFormat.html
+Slither.define :fedach_participants, by_bytes: false do |definition|
+  definition.body do |body|
+    body.trap { true }
+    # The institution's routing number
+    body.column :routing_number, 9, type: :string
+    # Main office or branch O=main B=branch
+    body.column :office_type, 1, type: :string
+    # Servicing Fed's main office routing number
+    body.column :servicing_frb_number, 9, type: :string
+    # The code indicating the ABA number to be used to route or send ACH items to the RFI
+    # 0 = Institution is a Federal Reserve Bank
+    # 1 = Send items to customer routing number
+    # 2 = Send items to customer using new routing number field
+    body.column :record_type_code, 1, type: :string
+    # Date of last change to CRF information (MMDDYY)
+    body.column :revision_date, 6, type: :string
+    # Institution's new routing number resulting from a merger or renumber
+    body.column :new_routing_number, 9, type: :string
+    # Commonly used abbreviated name
+    body.column :customer_name, 36, type: :string
+    # Delivery address
+    body.column :address, 36, type: :string
+    # City name in the delivery address
+    body.column :city, 20, type: :string
+    # State code of the state in the delivery address
+    body.column :state, 2, type: :string
+    # Zipcode in the delivery address
+    body.column :zip, 5, type: :string
+    # Zipcode extension in the delivery address
+    body.column :zip_extension, 4, type: :string
+    # CRF contact telephone number
+    body.column :telephone, 10, type: :string
+    # Code is based on the customers receiver code
+    # 1=Receives Gov/Comm
+    # body.column :institution_status, 1, type: :string
+    # 1=Current view
+    # body.column :data_view, 1, type: :string
+  end
+end
+
+parsed = Slither.parse("./vendor/FedACHdir.txt", :fedach_participants)[:body]
+
+# Normalize fields where possible
+parsed.map do |line|
+  line[:new_routing_number] = nil if line[:new_routing_number] == "000000000"
+  line[:zip_extension] = nil if line[:zip_extension] == "0000"
+  line[:office_type] = {"O" => "main", "B" => "branch"}[line[:office_type]]
+  line
+end
+
+# Participants keyed by routing number.
+participants = {}
+parsed.each do |line|
+  participants[line[:routing_number]] = line.except(:routing_number)
+end
+
+File.write("./data/fedach-participants.json", JSON.neat_generate(participants, wrap: 200, after_comma: 1))
+File.write("./data/fedach-participants.yml", participants.to_yaml)

data/bin/fedwire-parse.rb

@@ -0,0 +1,43 @@
+require "active_support/all"
+require "slither"
+require "pp"
+require "json"
+require "neatjson"
+require "yaml"
+
+# Format is defined at:
+# https://www.frbservices.org/EPaymentsDirectory/fedwireFormat.html
+Slither.define :fedwire_participants, by_bytes: false do |definition|
+  definition.body do |body|
+    body.trap { true }
+    body.column :routing_number, 9, type: :string
+    body.column :telegraphic_name, 18, type: :string
+    body.column :customer_name, 36, type: :string
+    body.column :state, 2, type: :string
+    body.column :city, 25, type: :string
+    body.column :funds_transfer_eligible, 1, type: :string
+    body.column :settlement_only, 1, type: :string
+    body.column :securities_transfer_eligible, 1, type: :string
+    body.column :revision_date, 8, type: :string
+  end
+end
+
+parsed = Slither.parse("./vendor/fpddir.txt", :fedwire_participants)[:body]
+
+# Convert boolean fields from string => boolean
+parsed.map do |line|
+  line[:funds_transfer_eligible] = line[:funds_transfer_eligible] == "Y"
+  line[:settlement_only] = line[:settlement_only] == "S"
+  line[:securities_transfer_eligible] = line[:securities_transfer_eligible] == "Y"
+  line[:revision_date] = line[:revision_date].presence
+  line
+end
+
+# Participants keyed by routing number.
+participants = {}
+parsed.each do |line|
+  participants[line[:routing_number]] = line.except(:routing_number)
+end
+
+File.write("./data/fedwire-participants.json", JSON.neat_generate(participants, wrap: 200, after_comma: 1))
+File.write("./data/fedwire-participants.yml", participants.to_yaml)

data/bin/normalize-names.rb

@@ -0,0 +1,47 @@
+require "active_support/all"
+require "pp"
+require "json"
+require "neatjson"
+require "yaml"
+require "rest-client"
+
+participants = YAML.load_file("./data/fedwire-participants.yml")
+names = participants.map do |_, data|
+  data[:customer_name]
+end.uniq.sort
+
+# Institutions keyed by fedwire name.
+institutions = {}
+
+# Remove excess. Examples:
+# KANSAS STATE BANK => The Kansas State Bank (Scranton) => Kansas State Bank
+# ALLIANCE BANK CENTRAL TEXAS => Alliance Bank - Central Texas => Alliance Bank Central Texas
+def normalize_name(fedwire_name, plaid_name)
+  return plaid_name if plaid_name.size == fedwire_name.size
+
+  start_index = plaid_name.upcase.index(fedwire_name)
+  if !start_index
+    plaid_name.gsub!(" - ", " ")
+    start_index = plaid_name.upcase.index(fedwire_name)
+    return plaid_name if !start_index
+  end
+  plaid_name.slice(start_index, fedwire_name.size)
+end
+
+names.each_with_index do |name, i|
+  puts "#{i+1}/#{names.size}: #{name}"
+
+  response = RestClient.get("https://tartan.plaid.com/institutions/all/search?p=connect&q=#{CGI::escape(name)}")
+  response = JSON.parse(response)
+
+  # Only if there is one result, consider that to be an exact match.
+  next  unless response.size == 1
+
+  institutions[name] = normalize_name(name, institution[:name])
+
+  # Something reasonable to ensure we aren't overloading Plaid
+  sleep 0.5
+end
+
+File.write("./data/plaid-institution-names.json", JSON.neat_generate(institutions, wrap: 200, after_comma: 1))
+File.write("./data/plaid-institution-names.yml", institutions.to_yaml)