fdic 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: add200a412197e304c2a7e2248ebf6a602e6b107
-  data.tar.gz: 066321ccc3f906f473c0ee1fff106f7d06887a8c
+  metadata.gz: bc5a8ff797a755ee5bdad38dd9965d5abc5c9e7a
+  data.tar.gz: 91529a0138f771be7e9c45eebb47858b9864f9f7
 SHA512:
-  metadata.gz: 6afed6e86475264c939298e6d17e785a29d636343a48426aa55d920939b8aaa8c2de58dfb3e35c8e70f11ea3e17e8755f835139ffbda0e3d256ac401727c5dcf
-  data.tar.gz: 390906519e45984ddf10404b71495f1f5f671dd1efca79f89fadd606db87c25f8d24f9ab69fcf03ed3f2e8573abbd624096e7aba2233e1f899c13cafb3f9eeb5
+  metadata.gz: 400441df58e68ca125e0f894e5e101f417a328c31cc1aadee571ffc92c504685c3cabe35189770a1a2884e7f578af3adcb302844a0b3061c8ba127f93173b3eb
+  data.tar.gz: 76282f49a6c5defaafab038d03ec54f218444606d56d60cae9aab8f472e93b00bf88a3eaa0114a594f0557e3c421d3c98725da6af19cf854686402bd80abc1fb

data/README.md

@@ -37,34 +37,44 @@ Or install it yourself as:
 
 ## Usage
 
-You can look up a Bank by its name, and find all matching Banks:
+The FDIC API lets you find an Institution if you have its FDIC Certificate Number:
 
 ```
-# Returns an Array:
-FDIC.find_bank('Dedicated Community Bank')  #=> [FDIC::Bank, FDIC::Bank, ...]
+institution = FDIC.find_institution(26588)  #=> FDIC::Institution
 ```
 
-You can look up an Institution by its FDIC Certificate number:
+If you don't have the certificate number, you can search for a Bank by name, and get back all matching Banks:
 
 ```
-# Returns only one:
-FDIC.find_institution(26588)  #=> FDIC::Institution
+banks = FDIC.find_bank('Dedicated Community Bank')  #=> [FDIC::Bank, FDIC::Bank, ...]
 ```
 
-You can look up a Bank's branches by its FDIC Certificate number:
+Once you have a Bank, you can get its Institution, which has much more data available:
 
 ```
-# Returns an Array:
-FDIC.find_branches(25688)  #=> [FDIC::Branch, FDIC::Branch, ...]
+institution = banks.first.find_institution!  # Bang, because it's another network request
 ```
 
-You can look up a Bank's history by its name and FDIC Certificate number:
+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:
 
 ```
-# Returns an Array:
-FDIC.find_history_events('Dedicated Community Bank', 26588)  #=> [FDIC::HistoryEvent, ...]
+institution.find_branches!  #=> [FDIC::Branch, FDIC::Branch, ...]
+FDIC.find_branches(25688)   #=> [FDIC::Branch, FDIC::Branch, ...]
+
+institution.find_history_events!                              #=> [FDIC::HistoryEvent, ...]
+FDIC.find_history_events('Dedicated Community Bank', 26588)   #=> [FDIC::HistoryEvent, ...]
+```
+
+Since a `Bank` knows its certificate number, it can look up its branch and history information, too.
+
+```
+# These work just like they do on Institutions:
+bank.find_branches!
+bank.find_history_events!
 ```
 
+There are more fields exposed in the Institution API then what we've exposed. Where the field names are obscure or acronym-y, we'd like to clarify them; since we're pre-1.0, if we haven't looked up a field's meaning quite yet, we're holding off. (You can still get all the fields via `#attributes`.)
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ContinuityControl/fdic.

data/lib/fdic/bank.rb

@@ -18,5 +18,9 @@ module FDIC
     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/version.rb

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

metadata

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