fdic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: add200a412197e304c2a7e2248ebf6a602e6b107
+  data.tar.gz: 066321ccc3f906f473c0ee1fff106f7d06887a8c
+SHA512:
+  metadata.gz: 6afed6e86475264c939298e6d17e785a29d636343a48426aa55d920939b8aaa8c2de58dfb3e35c8e70f11ea3e17e8755f835139ffbda0e3d256ac401727c5dcf
+  data.tar.gz: 390906519e45984ddf10404b71495f1f5f671dd1efca79f89fadd606db87c25f8d24f9ab69fcf03ed3f2e8573abbd624096e7aba2233e1f899c13cafb3f9eeb5

data/.gitignore

@@ -0,0 +1 @@
+fdic-*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fdic.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    fdic (0.1.0)
+      httparty (~> 0.13)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    httparty (0.13.5)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.3)
+    multi_xml (0.5.5)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  codeclimate-test-reporter
+  fdic!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.10.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Continuity
+
+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,75 @@
+[![Code Climate](https://codeclimate.com/github/ContinuityControl/fdic/badges/gpa.svg)](https://codeclimate.com/github/ContinuityControl/fdic)
+[![Test Coverage](https://codeclimate.com/github/ContinuityControl/fdic/badges/coverage.svg)](https://codeclimate.com/github/ContinuityControl/fdic/coverage)
+
+# FDIC
+
+The FDIC [lets you find information on FDIC-insured banking
+institutions](https://research.fdic.gov/bankfind/index.html). Their site uses
+[a JSON
+API](http://www.programmableweb.com/news/fdic-bank-data-api-available-official-announcement-pending/2015/02/06)
+to look up financial information, branch information, etc.
+
+This gem is a ruby client to that API. It's totally unaffiliated with the FDIC.
+It's open source, so anyone can use it, and anyone can help maintain it. At
+this point, it's maintained by [the
+developers](http://engineering.continuity.net/) at
+[Continuity](http://continuity.net).
+
+If you need help understanding the data returned by that API, and this gem, it
+can help to look at [the FDIC's BankFind glossary of
+terms](https://research.fdic.gov/bankfind/glossary.html).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fdic'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fdic
+
+## Usage
+
+You can look up a Bank by its name, and find all matching Banks:
+
+```
+# Returns an Array:
+FDIC.find_bank('Dedicated Community Bank')  #=> [FDIC::Bank, FDIC::Bank, ...]
+```
+
+You can look up an Institution by its FDIC Certificate number:
+
+```
+# Returns only one:
+FDIC.find_institution(26588)  #=> FDIC::Institution
+```
+
+You can look up a Bank's branches by its FDIC Certificate number:
+
+```
+# Returns an Array:
+FDIC.find_branches(25688)  #=> [FDIC::Branch, FDIC::Branch, ...]
+```
+
+You can look up a Bank's history by its name and FDIC Certificate number:
+
+```
+# Returns an Array:
+FDIC.find_history_events('Dedicated Community Bank', 26588)  #=> [FDIC::HistoryEvent, ...]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ContinuityControl/fdic.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fdic.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fdic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fdic"
+  spec.version       = FDIC::VERSION
+  spec.authors       = ["Tom Reznick", "Dan Bernier"]
+  spec.email         = ["treznick@continuity.net", "dbernier@continuity.net"]
+
+  spec.summary       = %q{A Ruby client to the FDIC's BankFind API}
+  spec.description   = %q{The FDIC recently exposed a JSON-over-HTTP API behind its BankFind website. This gem makes that API easy to use from Ruby.}
+  spec.homepage      = "https://github.com/ContinuityControl/fdic"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "httparty", "~> 0.13"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/fdic.rb

@@ -0,0 +1,41 @@
+require 'httparty'
+require 'logger'
+require "fdic/version"
+require 'fdic/client'
+require 'fdic/record'
+require 'fdic/bank'
+require 'fdic/institution'
+require 'fdic/branch'
+require 'fdic/history_event'
+
+module FDIC
+
+  def find_bank(bank_name)
+    resp = Client.new.find_bank(bank_name)
+    resp['d']['results'].map { |result|
+      FDIC::Bank.new(result)
+    }
+  end
+
+  def find_institution(certificate_number)
+    resp = Client.new.find_institution(certificate_number)
+    result = resp['d']['results'].first
+    FDIC::Institution.new(result)
+  end
+
+  def find_branches(certificate_number)
+    resp = Client.new.find_branches(certificate_number)
+    resp['d']['results'].map { |result|
+      FDIC::Branch.new(result)
+    }
+  end
+
+  def find_history_events(bank_name, certificate_number)
+    resp = Client.new.find_history_events(bank_name, certificate_number)
+    resp['d']['results'].map { |result|
+      FDIC::HistoryEvent.new(result)
+    }
+  end
+
+  extend self
+end

data/lib/fdic/bank.rb

@@ -0,0 +1,22 @@
+module FDIC
+  class Bank < Record
+    field :fdic_id, 'id'
+    field(:legal_name, 'legalName', &:strip)
+    field :certificate_number, :certNumber
+    field(:active?, 'activeFlag') { |value| value == 'Y' }
+    field :address
+    field :city
+    field :state
+    field :zip
+    field :office_count, :officeCount
+    date_field :effective_date, :effectiveDate
+
+    def find_institution!
+      @institution ||= FDIC.find_institution(certificate_number)
+    end
+
+    def find_history_events!
+      @history_events ||= FDIC.find_history_events(legal_name, certificate_number)
+    end
+  end
+end

data/lib/fdic/branch.rb

@@ -0,0 +1,39 @@
+=begin
+{ "__metadata"=> {
+    "uri"=>"http://odata.fdic.gov:80/v1/financial-institution/Branch('10345')",
+    "type"=>"financial-institutionModel.Branch"
+    },
+  "id"=>"10345",
+  "branchName"=>"First National Bank Alaska",
+  "certNumber"=>"16130",
+  "address"=>"101 W. 36th Avenue",
+  "city"=>"Anchorage",
+  "county"=>"Anchorage",
+  "state"=>"AK",
+  "zip"=>"99510.0",
+  "branchNum"=>nil,
+  "establishedDate"=>"1922-01-30 00:00:00.0",
+  "acquiredDate"=>nil,
+
+  "fiUninum"=>"10345",
+  "servTypeCd"=>"11"
+}
+=end
+
+module FDIC
+  class Branch < Record
+    field :fdic_id, 'id'
+    field(:branch_name, 'branchName', &:strip)
+    field :certificate_number, :certNumber
+
+    field :address
+    field :city
+    field :county
+    field :state
+    field :zip
+
+    field :branch_number, :branchNum
+    date_field :established_date, :establishedDate
+    date_field :acquired_date, :acquiredDate
+  end
+end

data/lib/fdic/client.rb

@@ -0,0 +1,52 @@
+module FDIC
+  class Client
+    include HTTParty
+    base_uri 'https://odata.fdic.gov/v1/financial-institution/'
+    format :json
+
+    #logger ::Logger.new 'httparty.log', :debug, :curl
+    #debug_output
+
+    def find_bank(bank_name)
+      self.class.get('/Bank',
+                     query:
+                     { '$inlinecount' => 'all',
+                       '$format' => 'json',
+                       '$filter' => "(substringof('#{escape_single_quotes(bank_name.upcase)}',name))"})
+    end
+
+    def find_institution(certificate_number)
+      self.class.get('/Institution',
+                     query:
+                     { '$inlinecount' => 'all',
+                       '$format' => 'json',
+                       '$filter' => "certNumber eq #{certificate_number}"})
+    end
+
+    def find_branches(certificate_number)
+      self.class.get('/Branch',
+                     query:
+                     { '$inlinecount' => 'allpages',
+                       '$format' => 'json',
+                       '$filter' => "certNumber eq #{certificate_number}"})
+    end
+
+    def find_history_events(bank_name, certificate_number)
+      filter = "legalName eq '#{escape_single_quotes(bank_name.upcase)}' and certNumber eq #{certificate_number}"
+      self.class.get('/History',
+                     query:
+                     { '$inlinecount' => 'all',
+                       '$format' => 'json',
+                       '$filter' => filter})
+    end
+
+    private
+
+    def escape_single_quotes(string)
+      # Urm? The API 500's if you have a single-quote in name: "People's United Bank."
+      # Their web forms double-up the single-quotes to escape them.
+      # NB: let's keep an eye on this flim-flam, and be sure it doesn't get out of hand.
+      string.gsub("'", "''")
+    end
+  end
+end

data/lib/fdic/history_event.rb

@@ -0,0 +1,22 @@
+module FDIC
+  class HistoryEvent < Record
+
+    field :fdic_id, :id
+    field(:legal_name, :legalName, &:strip)
+    field :certificate_number, :certNumber
+
+    date_field :effective_date, :orgEffDate
+    field :event_description, :eventDescription
+    field :change_code, :changeCode
+    field :change_description, :changeDesc
+
+    field :trust_power, :trustPower
+    field :trust_power_check, :trustPowerCheck
+
+    field :city
+    field :state
+
+    field :primary_regulatory_agency_check, :primaryRegulatoryAgencyCheck
+    field :primary_regulatory_agency, :primaryRegulatoryAgency
+  end
+end

data/lib/fdic/institution.rb

@@ -0,0 +1,41 @@
+module FDIC
+  class Institution < Record
+    field :fdic_id, :id
+    field(:legal_name, :legalName, &:strip)
+    field :certificate_number, :certNumber
+
+    field :supervising_authority, :FACodeText
+    field :supervising_authority_code, :FACode
+
+    field(:active?, 'activeFlag') { |value| value == 'Y' }
+    date_field :inactive_as_of_date, "inActiveAsofDt"
+    field :address
+    field :city
+    field :county
+    field :state
+    field :zip
+    field :web_site, "webSite"
+
+    date_field :insured_date, 'insuredDate'
+    date_field :insured_from_date, "insuredFrmDt"
+    date_field :insured_to_date, "insuredToDt"
+    date_field :established_date, 'establishedDate'
+    date_field :as_of_date, 'asOfDate'
+
+    date_field :report_date, "reportDate"  # This is NOT the date the query was made.
+
+    int_field :office_count, "officeCount"
+    currency_field :total_assets_in_thousands, 'totalAssets'
+    currency_field :total_deposits_in_thousands, "totalDeposits"
+    currency_field :domestic_deposits_in_thousands, "domesticDeposits"
+    currency_field :bank_equity_capital_in_thousands, "bankEquityCapital"
+
+    def find_history_events!
+      @history_events ||= FDIC.find_history_events(legal_name, certificate_number)
+    end
+
+    def find_branches!
+      @branches ||= FDIC.find_branches(certificate_number)
+    end
+  end
+end

data/lib/fdic/record.rb

@@ -0,0 +1,36 @@
+module FDIC
+  class Record
+    def initialize(attributes)
+      @attributes = attributes
+      @attributes.freeze
+    end
+
+    attr_reader :attributes
+
+    def self.field(method_name, response_key=method_name, &munger)
+      munger ||= lambda { |x| x }
+      define_method(method_name) {
+        value = attributes[response_key.to_s]
+        value && munger.call(value)
+      }
+    end
+
+    def self.int_field(method_name, response_key=method_name)
+      field(method_name, response_key, &:to_i)
+    end
+
+    def self.currency_field(method_name, response_key=method_name)
+      field(method_name, response_key, &:to_f)
+    end
+
+    def self.date_field(method_name, response_key=method_name)
+      field(method_name, response_key) { |value|
+        Date.parse(value)
+      }
+    end
+
+    def uri
+      attributes['__metadata']['uri']
+    end
+  end
+end

data/lib/fdic/version.rb

@@ -0,0 +1,3 @@
+module FDIC
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: fdic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Reznick
+- Dan Bernier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: The FDIC recently exposed a JSON-over-HTTP API behind its BankFind website.
+  This gem makes that API easy to use from Ruby.
+email:
+- treznick@continuity.net
+- dbernier@continuity.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fdic.gemspec
+- lib/fdic.rb
+- lib/fdic/bank.rb
+- lib/fdic/branch.rb
+- lib/fdic/client.rb
+- lib/fdic/history_event.rb
+- lib/fdic/institution.rb
+- lib/fdic/record.rb
+- lib/fdic/version.rb
+homepage: https://github.com/ContinuityControl/fdic
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: A Ruby client to the FDIC's BankFind API
+test_files: []