fdic 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcf10e68f158d536e5fa76857a547c5a186a8198
-  data.tar.gz: 5edb0f2ac6558e1a9352bdf6ca79a1da6b4d1c15
+  metadata.gz: a272bf5ef7ba4ae55c152d39e39a8e989d0a2676
+  data.tar.gz: ace1b5464a695805a4c120470b6051a786f8a661
 SHA512:
-  metadata.gz: 8bbd0f3c0587947f9708955b89096a6feb499c2a5bdd658f1587315ffa0890240c75d212a5621191c6077891c9e711e3cc0f5c8dd30dc19338b5672d8c3af34b
-  data.tar.gz: 6a0c8d31cc6ccd604e0497cd9dff38752007ff050140e1c0f8e97a8e4a46f3f4711004941367059ff510150443c7f36d2ab2fb4fa1cbf5c8361d8b2f1b0f6ea5
+  metadata.gz: b1b6771c3db012e2cc16af79066acf7a16daede58cc375c98b21aff578c6cba9120b7bcbf1b72f5e9ff2bdb194a27bb47ae622a5b4ecc7402f74d8220b8ba69c
+  data.tar.gz: 9d65c447c1c37923321e6c44670d7de7c427b0957b08667eca2cc7d6858df0b92428b0c668134eb5405e8cf52f055961bd04a27ca88d4f204f770944f7c1da8f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fdic (0.3.0)
+    fdic (0.4.0)
       httparty (~> 0.13)
 
 GEM

data/README.md

@@ -38,29 +38,36 @@ Or install it yourself as:
 
 ## Usage
 
-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
 
+The FDIC API lets you find an Institution if you have its FDIC Certificate Number:
+
+```ruby
+institution = FDIC::BankFind.find_institution(26588)  #=> FDIC::BankFind::Institution
 ```
+
+If your certificate number is incorrect, this will raise an exception:
+
+```ruby
 institution = FDIC::BankFind.find_institution(26588)  #=> FDIC::BankFind::Institution
+# raises FDIC::Exceptions::RecordNotFound
 ```
 
 If you don't have the certificate number, you can search for a Bank by name, and get back all matching Banks:
 
-```
+```ruby
 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:
 
-```
+```ruby
 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::BankFind module directly, or on the Institution:
 
-```
+```ruby
 institution.find_branches!  #=> [FDIC::BankFind::Branch, FDIC::BankFind::Branch, ...]
 FDIC::BankFind.find_branches(25688)   #=> [FDIC::BankFind::Branch, FDIC::BankFind::Branch, ...]
 
@@ -70,7 +77,7 @@ FDIC::BankFind.find_history_events('Dedicated Community Bank', 26588)   #=> [FDI
 
 Since a `Bank` knows its certificate number, it can look up its branch and history information, too.
 
-```
+```ruby
 # These work just like they do on Institutions:
 bank.find_branches!
 bank.find_history_events!
@@ -85,4 +92,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Contin
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/fdic/bank_find/exceptions.rb

@@ -0,0 +1,5 @@
+module FDIC
+  module Exceptions
+    class RecordNotFound < StandardError; end
+  end
+end

data/lib/fdic/bank_find.rb

@@ -0,0 +1,45 @@
+require 'fdic/bank_find/exceptions'
+require 'fdic/bank_find/client'
+require 'fdic/bank_find/record'
+require 'fdic/bank_find/bank'
+require 'fdic/bank_find/institution'
+require 'fdic/bank_find/branch'
+require 'fdic/bank_find/history_event'
+
+module FDIC
+  module BankFind
+
+    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)
+      results = resp.fetch('d').fetch('results')
+      if results.empty? || results.nil?
+        raise FDIC::Exceptions::RecordNotFound, "#{certificate_number} appears to be an invalid certificate number"
+      else
+        Institution.new(results.first)
+      end
+    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|
+        HistoryEvent.new(result)
+      }
+    end
+
+    extend self
+  end
+end

data/lib/fdic/version.rb

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

data/lib/fdic.rb

@@ -1,43 +1,4 @@
 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
-  module BankFind
-
-    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
-      Institution.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|
-        HistoryEvent.new(result)
-      }
-    end
-
-    extend self
-  end
-end
+require 'fdic/bank_find'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fdic
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Tom Reznick
@@ -87,12 +87,14 @@ files:
 - 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/bank_find.rb
+- lib/fdic/bank_find/bank.rb
+- lib/fdic/bank_find/branch.rb
+- lib/fdic/bank_find/client.rb
+- lib/fdic/bank_find/exceptions.rb
+- lib/fdic/bank_find/history_event.rb
+- lib/fdic/bank_find/institution.rb
+- lib/fdic/bank_find/record.rb
 - lib/fdic/version.rb
 homepage: https://github.com/ContinuityControl/fdic
 licenses: