ncua 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d80b3ab492107fa4574336a527522217465ac829
-  data.tar.gz: 89b3e21b98a1feaa85d3555d4fe7a3a7b01535dc
+  metadata.gz: ddc3ec546e01ed562477979e46f561a9d2d92a35
+  data.tar.gz: 083c148ab6e1d1a38018095dc8356b6be59d1a8a
 SHA512:
-  metadata.gz: 7f1ece268d4b81aebc6b6ac37654aa67dd1b5c2b0772caa7258b9aaa9bd87a2174f3fee57e2c838e61fcec4b8348762c6826e8ca29634216f0aebad534872457
-  data.tar.gz: adead7d121f4afa6b779b1e8fab4890d90e0423ec508b7156e30fc39e7e984e2d677f3d09ea8858dfd0b4cd711269231900e91231bfb7f1bef58018f7e601e60
+  metadata.gz: ebe48264ba4e9aee02ac366b7256a73f8654406c70ba785da3076c2b29acc02c2b0955bb9f072367ff3b867e1e31872d326ae4ba0b7db84b35f433dd921e4ace
+  data.tar.gz: b68cff3ab80ea08baac13ac9e8a8d09221414b0095dfa46ddb83845473bb3f7bc2f090b2e555fb16466738754ed670cdb2d092411c3071c0f2760777f6c83dee

data/.gitignore

@@ -8,3 +8,4 @@ ncua-*.gem
 /pkg/
 /spec/reports/
 /tmp/
+/private/

data/README.md

@@ -28,44 +28,81 @@ Or install it yourself as:
 
 Currently all of our features are namespaced under the `NCUA` module.
 
-The NCUA lets you find a Credit Union office by its name, charter number, or within an address:
+The NCUA lets you find a Credit Union Office by its name, charter number, or within an address:
 
 ```ruby
-  credit_unions = NCUA.find_by_name('Federal')  #=> [NCUA::CreditUnion, ... ]
+  credit_unions = NCUA.find_office_by_name('Federal')  #=> [NCUA::CreditUnion::Office, ... ]
 ```
 
-You can `find_by` `name`, `address`, `charter_number`. Searching by address takes an optional radius argument to limit the scope of the address query (units are in miles):
+You can also find an office by `name`, `address`, `charter_number`. Searching by address takes an optional radius argument to limit the scope of the address query (units are in miles):
 ```ruby
-  credit_unions = NCUA.find_by_charter_number(12345)  #=> [NCUA::CreditUnion, ... ]
+  credit_unions = NCUA.find_office_by_charter_number(12345)  #=> [NCUA::CreditUnion::Office, ... ]
 
-  credit_unions = NCUA.find_by_address("125 Main St., Anywhere, CT", radius: 50)  #=> [NCUA::CreditUnion, ... ]
-  
+  credit_unions = NCUA.find_office_by_address("125 Main St., Anywhere, CT", radius: 50)  #=> [NCUA::CreditUnion::Office, ... ]
 ```
 
-Right now, an `NCUA::CreditUnion` has all of the following getters:
-
- | ----------------------------- | ------------------------------------------------------------- |
- | Method                        | Explanation                                                   |
- | ----------------------------- | ------------------------------------------------------------- |
- | `name`                        | The Credit Union's Name                                       |
- | `long`                        | The Longitude of the Credit Union                             |
- | `lat`                         | The Latitude of the Credit Union                              |
- | `site_name`                   | The name of the Credit Union office or branch                 |
- | `charter_number`              | The Credit Union's Charter Number                             |
- | `city`                        | The Credit Union's City                                       |
- | `country`                     | The Credit Union's Country                                    |
- | `main_office?`                | Whether the Credit Union office is the Main Office            |
- | `phone`                       | The Credit Union's phone number                               |
- | `site_functions`              | The Credit Union's Site functions.\*                           |
- | `site_id`                     | The Credit Union's Site ID                                    |
- | `state`                       | The Credit Union's State                                      |
- | `url`                         | The Credit Union's Url                                        |
- | `zip`                         | The Credit Union's Zip Code                                   |
- | `distance_from_query_address` | The Distance between the queried address and the Credit Union |
- | `street`                      | The Credit Union's Street address                             |
- | ----------------------------- | ------------------------------------------------------------- |
-
-\*Currently these are limited to `Member Services`, `Drive Through` and `ATM`
+Right now, an `NCUA::CreditUnion::Office` has all of the following getters:
+
+ ```
+ | --------------------------- | ------------------------------------------------------------- |
+ | Method                      | Explanation                                                   |
+ | --------------------------- | ------------------------------------------------------------- |
+ | name                        | The Credit Union's Name                                       |
+ | long                        | The Longitude of the Credit Union                             |
+ | lat                         | The Latitude of the Credit Union                              |
+ | site_name                   | The name of the Credit Union office or branch                 |
+ | charter_number              | The Credit Union's Charter Number                             |
+ | city                        | The Credit Union's City                                       |
+ | country                     | The Credit Union's Country                                    |
+ | main_office?                | Whether the Credit Union office is the Main Office            |
+ | phone                       | The Credit Union's phone number                               |
+ | site_functions              | The Credit Union's Site functions.*                           |
+ | site_id                     | The Credit Union's Site ID                                    |
+ | state                       | The Credit Union's State                                      |
+ | url                         | The Credit Union's Url                                        |
+ | zip                         | The Credit Union's Zip Code                                   |
+ | distance_from_query_address | The Distance between the queried address and the Credit Union |
+ | street                      | The Credit Union's Street address                             |
+ | --------------------------- | ------------------------------------------------------------- |
+
+*Currently these are limited to `Member Services`, `Drive Through` and `ATM`
+```
+
+`NCUA::CreditUnion::Office` also exposes a `#details` method. This scrapes the NCUA's show page for a particular credit union, and returns an `NCUA::CreditUnion::Details` object. This object contains the details of a particular Credit Union, instead of a particular office location.
+
+Keep in mind, this _scrapes_ data from html, so this might break regularly.
+
+Right now, an `NCUA::CreditUnion::Details` object has the following getters:
+```
+        | field                      | description                                                                                                  |
+        | -------------------------- | ------------------------------------------------------------------------------------------------------------ |
+        | credit_union_name          | The Credit Union's name                                                                                      |
+        | charter_number             | The Credit Union's NCUA charter number                                                                       |
+        | credit_union_type          | The Type of Credit Union (Either Federal Credit Union [FCU] or Federally Insured State Credit Union [FISCU]) |
+        | active?                    | Whether the Credit Union is active or not                                                                    |
+        | corporate_credit_union?    | Whether the Credit Union is a corporate credit union or not                                                  |
+        | credit_union_charter_year  | The year the Credit Union was chartered                                                                      |
+        | current_charter_issue_date | The date the current charter was issued                                                                      |
+        | date_insured               | The date that the Credit Union was insured as of                                                             |
+        | charter_state              | The charter state of the Credit Union                                                                        |
+        | region                     | The Credit Union's region                                                                                    |
+        | field_of_membership_type   | The Credit Union's field of membership type                                                                  |
+        | low_income_designation?    | Whether the Credit Union has low income designation                                                          |
+        | member_of_fhlb?            | Whether the Credit Union is a member of the Federal Home Loan Bank System                                    |
+        | assets                     | The total assets of the Credit Union, as a floating point decimal                                            |
+        | peer_group                 | The Credit Union's Peer Group                                                                                |
+        | number_of_members          | The Credit Union's number of Members                                                                         |
+        | address                    | The street address of the Credit Union                                                                       |
+        | city_state_zip_code        | The City, State and Zip code of the Credit Union                                                             |
+        | country                    | The Country of the Credit Union                                                                              |
+        | county                     | The County of the Credit Union                                                                               |
+        | phone                      | The Phone number of the Credit Union                                                                         |
+        | website                    | The Website of the Credit Union                                                                              |
+        | ceo_or_manager             | The name of the CEO or Manager of the Credit Union                                                           |
+        | -------------------------- | ------------------------------------------------------------------------------------------------------------ |
+```
+
+You can also scrape this directly from the NCUA module by calling `NCUA.find_credit_union(charter_number)`
 
 ## Contributing
 

data/lib/ncua.rb

@@ -2,23 +2,28 @@ require 'httparty'
 require 'nokogiri'
 require 'ncua/version'
 require 'ncua/client'
-require 'ncua/record'
-require 'ncua/credit_union'
-require 'ncua/scraper'
+require 'ncua/credit_union/record'
+require 'ncua/credit_union/office'
+require 'ncua/credit_union/details'
+require 'ncua/credit_union/scraper'
 
 module NCUA
-  def self.find_by_address(address, opts={radius: 100})
+  def self.find_office_by_address(address, opts={radius: 100})
     resp = Client.new.find_credit_union_by_address(address, opts[:radius])
-    resp["list"].map { |result| CreditUnion.new(result) }
+    resp["list"].map { |result| CreditUnion::Office.new(result) }
   end
 
-  def self.find_by_name(name)
+  def self.find_office_by_name(name)
     resp = Client.new.find_credit_union_by_name(name)
-    resp["list"].map { |result| CreditUnion.new(result) }
+    resp["list"].map { |result| CreditUnion::Office.new(result) }
   end
 
-  def self.find_by_charter_number(charter_number)
+  def self.find_office_by_charter_number(charter_number)
     resp = Client.new.find_credit_union_by_charter_number(charter_number)
-    resp["list"].map { |result| CreditUnion.new(result) }
+    resp["list"].map { |result| CreditUnion::Office.new(result) }
+  end
+
+  def self.find_credit_union(charter_number)
+    CreditUnion::Details.new(CreditUnion::Scraper.new(charter_number).scrape!)
   end
 end

data/lib/ncua/credit_union/details.rb

@@ -0,0 +1,29 @@
+module NCUA
+  module CreditUnion
+    class Details < Record
+      field :credit_union_name
+      field :charter_number
+      field :credit_union_type
+      field(:active?, :credit_union_status) { |value| value == "Active" }
+      field(:corporate_credit_union?, :corporate_credit_union) { |value| value == "Yes" }
+      field :credit_union_charter_year
+      field(:current_charter_issue_date) { |value| Date.strptime(value, '%m/%d/%Y') }
+      field(:date_insured) { |value| Date.strptime(value, '%m/%d/%Y') }
+      field :charter_state
+      field :region
+      field :field_of_membership_type
+      field(:low_income_designation?, :low_income_designation) { |value| value == "Yes" }
+      field(:member_of_fhlb?, :member_of_fhlb) { |value| value == "Yes" }
+      field(:assets) { |value| value.gsub(/[$,]/,"").to_f }
+      field :peer_group
+      field(:number_of_members) { |value| value.gsub(",","").to_i }
+      field :address
+      field :city_state_zip_code
+      field :country
+      field :county
+      field :phone
+      field :website
+      field :ceo_or_manager
+    end
+  end
+end

data/lib/ncua/credit_union/office.rb

@@ -0,0 +1,32 @@
+module NCUA
+  module CreditUnion
+    class Office < Record
+      field :name, 'CU_NAME'
+      field :long, 'AddressLongitude'
+      field :lat, 'AddressLatitude'
+      field :site_name, 'CU_SITENAME'
+      field :charter_number, 'CU_NUMBER'
+      field :city, 'City'
+      field :country, 'Country'
+      field :main_office?, 'IsMainOffice'
+      field :phone, 'Phone'
+      field(:site_functions, 'SiteFunctions') { |value| value.split(";") }
+      field :site_id, 'SiteId'
+      field :state, 'State'
+      field :url, 'URL'
+      field :zip, 'Zipcode'
+      field(:distance_from_query_address, 'distance') { |value| nil if value < 0 }
+      field(:street, 'Street', &:strip)
+
+      def details
+        @details ||= Details.new(get_details!)
+      end
+
+      private
+
+      def get_details!
+        @scraped_attributes ||= Scraper.new(charter_number).scrape!
+      end
+    end
+  end
+end

data/lib/ncua/credit_union/record.rb

@@ -0,0 +1,34 @@
+module NCUA
+  module CreditUnion
+    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) {
+          if response_key.is_a? Symbol
+            value = attributes[response_key]
+          else
+            value = attributes[response_key.to_s]
+          end
+          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.date_field(method_name, response_key=method_name)
+        field(method_name, response_key) { |value|
+          Date.parse(value)
+        }
+      end
+    end
+  end
+end

data/lib/ncua/credit_union/scraper.rb

@@ -0,0 +1,49 @@
+module NCUA
+  module CreditUnion
+    class Scraper
+      #This bit is as brittle as glass, as coupled as conjoined twins, and as stinky as bad cheese
+      include HTTParty
+
+      base_uri 'http://mapping.ncua.gov'
+      def initialize(charter_number)
+        @charter_number = charter_number
+      end
+
+      def scrape!
+        Hash[html_doc.at_css("table#MainContent_newDetails").css("tr").map do |tr|
+          if tr.at_css("td.dvHeader") && tr.at_css("td.dvHeader + td")
+            [clean_header(tr.at_css("td.dvHeader").text), clean_value(tr.at_css("td.dvHeader + td").text)]
+          end
+        end]
+      end
+
+      private
+
+      def clean_header(text)
+        text.gsub(/[,:]/,"").
+          gsub("/", " or ").
+          gsub(" ","_").
+          downcase.
+          to_sym
+      end
+
+      def clean_value(text)
+        text.gsub(/[\n\r]/,"").strip
+      end
+
+      def html_doc
+        Nokogiri::HTML(request.body)
+      end
+
+      def request
+        self.class.get(endpoint, query: {
+          "ID" => @charter_number
+        })
+      end
+
+      def endpoint
+        '/SingleResult.aspx'
+      end
+    end
+  end
+end

data/lib/ncua/version.rb

@@ -1,3 +1,3 @@
 module NCUA
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/ncua.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "httparty", "~> 0.13"
-  spec.add_runtime_dependency "nokogiri", "~> 1.6.0"
+  spec.add_runtime_dependency 'nokogiri', '~> 1.6', '>= 1.6.0'
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ncua
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Tom Reznick
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-09 00:00:00.000000000 Z
+date: 2015-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -29,6 +29,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.0
   type: :runtime
@@ -36,6 +39,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.0
 - !ruby/object:Gem::Dependency
@@ -98,9 +104,10 @@ files:
 - bin/setup
 - lib/ncua.rb
 - lib/ncua/client.rb
-- lib/ncua/credit_union.rb
-- lib/ncua/record.rb
-- lib/ncua/scraper.rb
+- lib/ncua/credit_union/details.rb
+- lib/ncua/credit_union/office.rb
+- lib/ncua/credit_union/record.rb
+- lib/ncua/credit_union/scraper.rb
 - lib/ncua/version.rb
 - ncua.gemspec
 homepage: https://github.com/ContinuityControl/ncua

data/lib/ncua/credit_union.rb

@@ -1,28 +0,0 @@
-module NCUA
-  class CreditUnion < Record
-    field :name, 'CU_NAME'
-    field :long, 'AddressLongitude'
-    field :lat, 'AddressLatitude'
-    field :site_name, 'CU_SITENAME'
-    field :charter_number, 'CU_NUMBER'
-    field :city, 'City'
-    field :country, 'Country'
-    field :main_office?, 'IsMainOffice'
-    field :phone, 'Phone'
-    field(:site_functions, 'SiteFunctions') { |value| value.split(";") }
-    field :site_id, 'SiteId'
-    field :state, 'State'
-    field :url, 'URL'
-    field :zip, 'Zipcode'
-    field(:distance_from_query_address, 'distance') { |value| nil if value < 0 }
-    field(:street, 'Street', &:strip)
-
-    def munge!
-      @scraped_attributes ||= Scraper.new(charter_number).scrape!
-    end
-
-    def additional_attributes
-      @scraped_attributes
-    end
-  end
-end

data/lib/ncua/record.rb

@@ -1,34 +0,0 @@
-module NCUA
-  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) { |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
-  end
-end

data/lib/ncua/scraper.rb

@@ -1,47 +0,0 @@
-module NCUA
-  class Scraper
-    #This bit is as brittle as glass, as coupled as conjoined twins, and as stinky as bad cheese
-    include HTTParty
-
-    base_uri 'http://mapping.ncua.gov'
-    def initialize(charter_number)
-      @charter_number = charter_number
-    end
-
-    def scrape!
-      Hash[html_doc.at_css("table#MainContent_newDetails").css("tr").map do |tr|
-        if tr.at_css("td.dvHeader") && tr.at_css("td.dvHeader + td")
-          [clean_header(tr.at_css("td.dvHeader").text), clean_value(tr.at_css("td.dvHeader + td").text)]
-        end
-      end]
-    end
-
-    private
-
-    def clean_header(text)
-      text.gsub(/[,:]/,"").
-        gsub("/", " or ").
-        gsub(" ","_").
-        downcase.
-        to_sym
-    end
-
-    def clean_value(text)
-      text.gsub(/[\n\r]/,"").strip
-    end
-
-    def html_doc
-      Nokogiri::HTML(request.body)
-    end
-
-    def request
-      self.class.get(endpoint, query: {
-        "ID" => @charter_number
-      })
-    end
-
-    def endpoint
-      '/SingleResult.aspx'
-    end
-  end
-end