fdic 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a960c1ecf07c6e286b5b543633c34e18379d1841
-  data.tar.gz: 10ec5ce24ce877441df8be9e9f19c31bfc6e32d9
+  metadata.gz: bcf10e68f158d536e5fa76857a547c5a186a8198
+  data.tar.gz: 5edb0f2ac6558e1a9352bdf6ca79a1da6b4d1c15
 SHA512:
-  metadata.gz: cd5aa39e4d85247ff17ff60dbe124aa6395e60907fe0739d126416d769cd32c67d8d26d87d2ff0717ee15684cab6f88d63416fddbfdbd1d55ebb0baa69022406
-  data.tar.gz: 64eddddf554c07038d6cefb7f62e70a1f9dbf470c2d9c10f5085ced999e10fed4c5f5de49d147f854cc95685c57d3037b24d91e505fdd6247a60c06d2998cba8
+  metadata.gz: 8bbd0f3c0587947f9708955b89096a6feb499c2a5bdd658f1587315ffa0890240c75d212a5621191c6077891c9e711e3cc0f5c8dd30dc19338b5672d8c3af34b
+  data.tar.gz: 6a0c8d31cc6ccd604e0497cd9dff38752007ff050140e1c0f8e97a8e4a46f3f4711004941367059ff510150443c7f36d2ab2fb4fa1cbf5c8361d8b2f1b0f6ea5

data/README.md

@@ -40,14 +40,16 @@ Or install it yourself as:
 
 The FDIC API lets you find an Institution if you have its FDIC Certificate Number:
 
+Currently all of our features are namespaced under the `FDIC::BankFind` module
+
 ```
-institution = FDIC.find_institution(26588)  #=> FDIC::Institution
+institution = FDIC::BankFind.find_institution(26588)  #=> FDIC::BankFind::Institution
 ```
 
 If you don't have the certificate number, you can search for a Bank by name, and get back all matching Banks:
 
 ```
-banks = FDIC.find_bank('Dedicated Community Bank')  #=> [FDIC::Bank, FDIC::Bank, ...]
+banks = FDIC::BankFind.find_bank('Dedicated Community Bank')  #=> [FDIC::BankFind::Bank, FDIC::BankFind::Bank, ...]
 ```
 
 Once you have a Bank, you can get its Institution, which has much more data available:
@@ -56,14 +58,14 @@ Once you have a Bank, you can get its Institution, which has much more data avai
 institution = banks.first.find_institution!  # Bang, because it's another network request
 ```
 
-The API also exposes information about an Institution's branches, and its history. You can query both of these on the FDIC module directly, or on the Institution:
+The API also exposes information about an Institution's branches, and its history. You can query both of these on the FDIC::BankFind module directly, or on the Institution:
 
 ```
-institution.find_branches!  #=> [FDIC::Branch, FDIC::Branch, ...]
-FDIC.find_branches(25688)   #=> [FDIC::Branch, FDIC::Branch, ...]
+institution.find_branches!  #=> [FDIC::BankFind::Branch, FDIC::BankFind::Branch, ...]
+FDIC::BankFind.find_branches(25688)   #=> [FDIC::BankFind::Branch, FDIC::BankFind::Branch, ...]
 
-institution.find_history_events!                              #=> [FDIC::HistoryEvent, ...]
-FDIC.find_history_events('Dedicated Community Bank', 26588)   #=> [FDIC::HistoryEvent, ...]
+institution.find_history_events!                              #=> [FDIC::BankFind::HistoryEvent, ...]
+FDIC::BankFind.find_history_events('Dedicated Community Bank', 26588)   #=> [FDIC::BankFind::HistoryEvent, ...]
 ```
 
 Since a `Bank` knows its certificate number, it can look up its branch and history information, too.

data/lib/fdic/bank.rb

@@ -1,26 +1,28 @@
 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
+  module BankFind
+    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_institution!
+        @institution ||= BankFind.find_institution(certificate_number)
+      end
 
-    def find_history_events!
-      @history_events ||= FDIC.find_history_events(legal_name, certificate_number)
-    end
+      def find_history_events!
+        @history_events ||= BankFind.find_history_events(legal_name, certificate_number)
+      end
 
-    def find_branches!
-      @branches ||= FDIC.find_branches(certificate_number)
+      def find_branches!
+        @branches ||= BankFind.find_branches(certificate_number)
+      end
     end
   end
 end

data/lib/fdic/branch.rb

@@ -21,19 +21,21 @@
 =end
 
 module FDIC
-  class Branch < Record
-    field :fdic_id, 'id'
-    field(:branch_name, 'branchName', &:strip)
-    field :certificate_number, :certNumber
+  module BankFind
+    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 :address
+      field :city
+      field :county
+      field :state
+      field :zip
 
-    field :branch_number, :branchNum
-    date_field :established_date, :establishedDate
-    date_field :acquired_date, :acquiredDate
+      field :branch_number, :branchNum
+      date_field :established_date, :establishedDate
+      date_field :acquired_date, :acquiredDate
+    end
   end
 end

data/lib/fdic/client.rb

@@ -1,52 +1,54 @@
 module FDIC
-  class Client
-    include HTTParty
-    base_uri 'https://odata.fdic.gov/v1/financial-institution/'
-    format :json
+  module BankFind
+    class Client
+      include HTTParty
+      base_uri 'https://odata.fdic.gov/v1/financial-institution/'
+      format :json
 
-    #logger ::Logger.new 'httparty.log', :debug, :curl
-    #debug_output
+      #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_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_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_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
+      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
+      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("'", "''")
+      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
 end

data/lib/fdic/history_event.rb

@@ -1,22 +1,24 @@
 module FDIC
-  class HistoryEvent < Record
+  module BankFind
+    class HistoryEvent < Record
 
-    field :fdic_id, :id
-    field(:legal_name, :legalName, &:strip)
-    field :certificate_number, :certNumber
+      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
+      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 :trust_power, :trustPower
+      field :trust_power_check, :trustPowerCheck
 
-    field :city
-    field :state
+      field :city
+      field :state
 
-    field :primary_regulatory_agency_check, :primaryRegulatoryAgencyCheck
-    field :primary_regulatory_agency, :primaryRegulatoryAgency
+      field :primary_regulatory_agency_check, :primaryRegulatoryAgencyCheck
+      field :primary_regulatory_agency, :primaryRegulatoryAgency
+    end
   end
 end

data/lib/fdic/institution.rb

@@ -1,41 +1,43 @@
 module FDIC
-  class Institution < Record
-    field :fdic_id, :id
-    field(:legal_name, :legalName, &:strip)
-    field :certificate_number, :certNumber
+  module BankFind
+    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 :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"
+      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 :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.
+      date_field :report_date, "reportDate"  # This is NOT the date the query was made.
 
-    int_field :office_count, "officeCount"
-    currency_field :total_assets, 'totalAssets'
-    currency_field :total_deposits, "totalDeposits"
-    currency_field :domestic_deposits, "domesticDeposits"
-    currency_field :bank_equity_capital, "bankEquityCapital"
+      int_field :office_count, "officeCount"
+      currency_field :total_assets, 'totalAssets'
+      currency_field :total_deposits, "totalDeposits"
+      currency_field :domestic_deposits, "domesticDeposits"
+      currency_field :bank_equity_capital, "bankEquityCapital"
 
-    def find_history_events!
-      @history_events ||= FDIC.find_history_events(legal_name, certificate_number)
-    end
+      def find_history_events!
+        @history_events ||= BankFind.find_history_events(legal_name, certificate_number)
+      end
 
-    def find_branches!
-      @branches ||= FDIC.find_branches(certificate_number)
+      def find_branches!
+        @branches ||= BankFind.find_branches(certificate_number)
+      end
     end
   end
 end

data/lib/fdic/record.rb

@@ -1,38 +1,40 @@
 module FDIC
-  class Record
-    def initialize(attributes)
-      @attributes = attributes
-      @attributes.freeze
-    end
+  module BankFind
+    class Record
+      def initialize(attributes)
+        @attributes = attributes
+        @attributes.freeze
+      end
 
-    attr_reader :attributes
+      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.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.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) { |value|
-        value.to_f * 1000
-      }
-    end
+      def self.currency_field(method_name, response_key=method_name)
+        field(method_name, response_key) { |value|
+          value.to_f * 1000
+        }
+      end
 
-    def self.date_field(method_name, response_key=method_name)
-      field(method_name, response_key) { |value|
-        Date.parse(value)
-      }
-    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']
+      def uri
+        attributes['__metadata']['uri']
+      end
     end
   end
 end

data/lib/fdic/version.rb

@@ -1,3 +1,3 @@
 module FDIC
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/fdic.rb

@@ -9,33 +9,35 @@ require 'fdic/branch'
 require 'fdic/history_event'
 
 module FDIC
+  module BankFind
 
-  def find_bank(bank_name)
-    resp = Client.new.find_bank(bank_name)
-    resp['d']['results'].map { |result|
-      FDIC::Bank.new(result)
-    }
-  end
+    def find_bank(bank_name)
+      resp = Client.new.find_bank(bank_name)
+      resp['d']['results'].map { |result|
+        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_institution(certificate_number)
+      resp = Client.new.find_institution(certificate_number)
+      result = resp['d']['results'].first
+      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_branches(certificate_number)
+      resp = Client.new.find_branches(certificate_number)
+      resp['d']['results'].map { |result|
+        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
+    def find_history_events(bank_name, certificate_number)
+      resp = Client.new.find_history_events(bank_name, certificate_number)
+      resp['d']['results'].map { |result|
+        HistoryEvent.new(result)
+      }
+    end
 
-  extend self
+    extend self
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fdic
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tom Reznick
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-06 00:00:00.000000000 Z
+date: 2015-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty