ncua 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 398980c10ce254d16210333409e04c87bb466da2
-  data.tar.gz: a1bd3146b069403d2e26bcbc06d21b7b980727a4
+  metadata.gz: f7e2e496175b1a98a96270345f3685e360cab0cb
+  data.tar.gz: 8b84ad589f325b8077cb74233db773eac5bdce08
 SHA512:
-  metadata.gz: 7dc57569862938332daca4e6e6357aa69e42aeb4e6291c0735c33b38ee6fb3ff0ccffb35624c15a888769a17100d6c0c607cac8293dbfc10f78c9b41557f1510
-  data.tar.gz: b824aece7492cccc508b30233a4003be96482d33bfbe41d6eebad135966c6d9cf71391e04f92ad1e1325771d896b6f7da5a9f92a63443e396861aea0523808b3
+  metadata.gz: ec03e928a657aaa4bcc8bf765b1ac1f10d135489e308e1a0e015ea74d5a376359021d063a3dd17e0e695adf974490d0afc9ff5fb5b6dda6075f2785c163af18c
+  data.tar.gz: 2b47405597a38b5599d451be70bcc4e5fa470ae19b5fe26d74203329675c3d71e7a402d24d7b24c8ba9c1d256de3bbb50bed77eea55319d99220480d180c9333

data/README.md

@@ -116,6 +116,26 @@ If for some reason the NCUA returns a 500 error when directly scraping for credi
 
 In fact, we only really expect response codes in the 200 range. If the NCUA returns another response, the gem will raise `NCUA::CreditUnion::ServerError` with the response code in the description.
 
+## Validating this Gem's Schema Assumptions
+
+This gem relies upon both the schema of an unpublished public JSON API and the particular markup of a page on the NCUA's website remaining constant.
+
+Obviously, this is a bad practice. Until the NCUA publishes a versioned, public API of their data, we will continue to rely upon these unorthodox methods of data retrieval.
+
+To help current users of this gem, we have provided an API for validating the assumed schema of the NCUA's data.
+
+Calling `NCUA.schema_valid?` will return `true` if the gem is safe to use. Note that this makes an actual call to the NCUA's endpoints, so be mindful of its use.
+
+Calling `NCUA.validate_schema!` will similarly return `true` if the gem is safe to use, but will raise a more detailed exception if the schema is invalid.
+
+The gem provides an internal rake task, `rake ncua:validate_schema!`, which calls `NCUA.validate_schema!`. For the convenience of Rails users, we have used a Railtie to automatically provide this rake task in your application.
+
+If you do not use Rails, you can add the following to your `Rakefile` to expose this task.
+```ruby
+require 'ncua'
+NCUA::NCUATasks.new.install_tasks
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ContinuityControl/ncua.

data/Rakefile

@@ -1,6 +1,10 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require './lib/tasks/ncua_tasks'
+
 
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+Bundler::GemHelper.install_tasks
+NCUA::NCUATasks.new.install_tasks

data/lib/ncua.rb

@@ -2,13 +2,18 @@ require 'httparty'
 require 'nokogiri'
 require 'ncua/version'
 require 'ncua/client'
+require 'ncua/client_validator'
 require 'ncua/credit_union/record'
 require 'ncua/credit_union/office'
 require 'ncua/credit_union/details'
 require 'ncua/credit_union/scraper'
+require 'ncua/credit_union/scraper_validator'
 require 'ncua/credit_union/details_client'
+require 'tasks/ncua_tasks'
 
 module NCUA
+  require "ncua/railtie" if defined?(Rails)
+
   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::Office.new(result) }
@@ -27,4 +32,20 @@ module NCUA
   def self.find_credit_union(charter_number)
     CreditUnion::Details.new(CreditUnion::Scraper.new(charter_number).scrape!)
   end
+
+  def self.validate_schema!
+    unless NCUA::CreditUnion::ScraperValidator.new.schema_valid?
+      raise "NCUA CreditUnion Scraper Schema is invalid. Please contact Gem Maintainer"
+    end
+
+    unless NCUA::ClientValidator.schema_valid?
+      raise "NCUA Client Schema is invalid. Please contact Gem Maintainer"
+    end
+
+    true
+  end
+
+  def self.schema_valid?
+    NCUA::CreditUnion::Scraper.new(42).schema_valid? && NCUA::ClientValidator.schema_valid?
+  end
 end

data/lib/ncua/client.rb

@@ -6,7 +6,7 @@ module NCUA
     format :json
     #debug_output $stderr
 
-    def find_credit_union_by_address(address, radius)
+    def find_credit_union_by_address(address, radius = 100)
       self.class.get(query_endpoint, query: {
         address: address,
         type: 'address',
@@ -30,6 +30,5 @@ module NCUA
     def query_endpoint
       '/findCUByRadius.aspx'
     end
-
   end
 end

data/lib/ncua/client_validator.rb

@@ -0,0 +1,30 @@
+module NCUA
+  class ClientValidator
+    def self.schema_valid?
+      base_fields_valid? && list_fields_valid?
+    end
+
+    private
+
+    def self.base_fields_valid?
+      methods = [:find_credit_union_by_name, :find_credit_union_by_charter_number, :find_credit_union_by_address]
+      expected_keys = ['list', 'latitude', 'longitude'].sort
+
+      methods.all? { |method_name|
+        Client.new.send(method_name, "Something Fake").keys.sort == expected_keys
+      }
+    end
+
+    def self.list_fields_valid?
+      expected_keys = ['CU_NAME', 'AddressLongitude', 'AddressLatitude',
+                       'CU_SITENAME', 'CU_NUMBER', 'City', 'CityPhysical',
+                       'Country', 'index', 'IsMainOffice', 'Phone',
+                       'SiteFunctions', 'SiteId', 'SiteName', 'State', 'URL',
+                       'Zipcode', 'distance', 'Street'].sort
+      found_keys = Client.new.find_credit_union_by_charter_number(42)["list"].first.keys.sort
+      # return expected_fields is a subset of found_keys
+      found_keys == expected_keys
+    end
+
+  end
+end

data/lib/ncua/credit_union/scraper_validator.rb

@@ -0,0 +1,56 @@
+module NCUA
+  module CreditUnion
+    class ScraperValidator
+      def schema_valid?
+        has_a_table?  &&
+        has_correctly_formatted_key_value_rows? &&
+        has_correct_keys?
+      end
+
+      private
+
+      def has_a_table?
+        !html_doc.at_css('table#MainContent_newDetails').nil?
+      end
+
+      def has_correctly_formatted_key_value_rows?
+        key_value_rows.all? { |tr|
+          key_value_row?(tr.css("td")) || sub_header_row?(tr.css("td"))
+        }
+      end
+
+      def has_correct_keys?
+        found_keys = key_value_rows.map { |tr| tr.at_css('td.dvHeader') }.compact.map(&:text)
+        expected_keys = ["Credit Union Name:", "Charter Number:", "Credit Union Type:",
+                         "Credit Union Status:", "Corporate Credit Union:",
+                         "Credit Union Charter Year:", "Current Charter Issue Date:",
+                         "Date Insured:", "Charter State:", "Region:",
+                         "Field of Membership Type:", "Low Income Designation:",
+                         "Member of FHLB:", "Assets:", "Peer Group:", "Number of Members:",
+                         "Address:", "City, State Zip code:", "Country:", "County:", "Phone:",
+                         "Website:", "CEO/Manager:"]
+        found_keys == expected_keys
+      end
+
+      def key_value_row?(tr_cells)
+        tr_cells.count == 2 && tr_cells.first[:class] == 'dvHeader'
+      end
+
+      def sub_header_row?(tr_cells)
+        tr_cells.count == 1 && tr_cells.first[:class] == 'subheader'
+      end
+
+      def request
+        @request ||= DetailsClient.new.get_details(42)
+      end
+
+      def html_doc
+        @html_doc ||= Nokogiri::HTML(request.body)
+      end
+
+      def key_value_rows
+        @key_value_rows ||= html_doc.at_css("table#MainContent_newDetails").css("tr")
+      end
+    end
+  end
+end

data/lib/ncua/railtie.rb

@@ -0,0 +1,9 @@
+require 'ncua'
+require 'rails'
+module NCUA
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      NCUA::NCUATasks.new.install_tasks
+    end
+  end
+end

data/lib/ncua/version.rb

@@ -1,3 +1,3 @@
 module NCUA
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

data/lib/tasks/ncua_tasks.rb

@@ -0,0 +1,13 @@
+module NCUA
+  class NCUATasks
+    include Rake::DSL if defined? Rake::DSL
+    def install_tasks
+      namespace :ncua do
+        desc "Verify Schema"
+        task(:validate_schema!) do
+          ::NCUA.validate_schema!
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ncua
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Tom Reznick
@@ -118,12 +118,16 @@ files:
 - bin/setup
 - lib/ncua.rb
 - lib/ncua/client.rb
+- lib/ncua/client_validator.rb
 - lib/ncua/credit_union/details.rb
 - lib/ncua/credit_union/details_client.rb
 - lib/ncua/credit_union/office.rb
 - lib/ncua/credit_union/record.rb
 - lib/ncua/credit_union/scraper.rb
+- lib/ncua/credit_union/scraper_validator.rb
+- lib/ncua/railtie.rb
 - lib/ncua/version.rb
+- lib/tasks/ncua_tasks.rb
 - ncua.gemspec
 homepage: https://github.com/ContinuityControl/ncua
 licenses: