ncua 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e329a8d091a46b2798649cc3ddd24d42163fed3b
+  data.tar.gz: 8842978e48032d39ef122a5cee6f99edcd70ff2e
+SHA512:
+  metadata.gz: a035575691a5c83843d75548f8053d23761ae5b9c28f6cb0fddb34148191dcf401cf09f70d55c26777cb8c523414585fad5fc4152a6df6e2069ba00cbd9e5760
+  data.tar.gz: 6d5791fb1ffef2964f20dbfd4d15a1be7726b2f9dc3a55c6cb26fdc1dbf395bf2379761586777ca61c3ac355b40f05abc5e70643fcb80978f4322fc018c6e387

data/.gitignore

@@ -0,0 +1,10 @@
+ncua-*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ncua.gemspec
+gemspec

data/README.md

@@ -0,0 +1,76 @@
+# Ncua
+
+The NCUA [lets you search for a credit union office](http://www.ncua.gov/NCUAMapping/Pages/NCUAGOVMapping.aspx) by name, address and charter number. Their site uses a JSON api behind their
+
+This gem is a ruby client to that API. It's totally unaffiliated with the NCUA.
+It's open source, so anyone can use it, and anyone can help maintain it. At
+this point, it's maintained by [the
+developers](http://engineering.continuity.net/) at
+[Continuity](http://continuity.net).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+  gem 'ncua'
+```
+
+And then execute:
+```
+  $ bundle
+```
+Or install it yourself as:
+```
+  $ gem install ncua
+```
+## Usage
+
+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:
+
+```ruby
+  credit_unions = NCUA.find_by_name('Federal')  #=> [NCUA::CreditUnion, ... ]
+```
+
+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):
+```ruby
+  credit_unions = NCUA.find_by_charter_number(12345)  #=> [NCUA::CreditUnion, ... ]
+
+  credit_unions = NCUA.find_by_address("125 Main St., Anywhere, CT", radius: 50)  #=> [NCUA::CreditUnion, ... ]
+  
+```
+
+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`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ContinuityControl/ncua.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ncua"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ncua.rb

@@ -0,0 +1,22 @@
+require 'httparty'
+require 'ncua/version'
+require 'ncua/client'
+require 'ncua/record'
+require 'ncua/credit_union'
+
+module NCUA
+  def self.find_by_address(address, opts={radius: 100})
+    resp = Client.new.find_credit_union_by_address(address, opts[:radius])
+    resp["list"].map { |result| CreditUnion.new(result) }
+  end
+
+  def self.find_by_name(name)
+    resp = Client.new.find_credit_union_by_name(name)
+    resp["list"].map { |result| CreditUnion.new(result) }
+  end
+
+  def self.find_by_charter_number(charter_number)
+    resp = Client.new.find_credit_union_by_charter_number(charter_number)
+    resp["list"].map { |result| CreditUnion.new(result) }
+  end
+end

data/lib/ncua/client.rb

@@ -0,0 +1,35 @@
+module NCUA
+  class Client
+    include HTTParty
+
+    base_uri 'http://mapping.ncua.gov'
+    format :json
+    #debug_output $stderr
+
+    def find_credit_union_by_address(address, radius)
+      self.class.get(query_endpoint, query: {
+        address: address,
+        type: 'address',
+        radius: radius.to_s })
+    end
+
+    def find_credit_union_by_name(name)
+      self.class.get(query_endpoint, query: {
+        address: name,
+        type: 'cuname' })
+    end
+
+    def find_credit_union_by_charter_number(charter_number)
+      self.class.get(query_endpoint, query: {
+        address: charter_number,
+        type: 'cunumber' })
+    end
+
+    private
+
+    def query_endpoint
+      '/findCUByRadius.aspx'
+    end
+
+  end
+end

data/lib/ncua/credit_union.rb

@@ -0,0 +1,20 @@
+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)
+  end
+end

data/lib/ncua/record.rb

@@ -0,0 +1,34 @@
+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/version.rb

@@ -0,0 +1,3 @@
+module NCUA
+  VERSION = "0.4.0"
+end

data/ncua.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ncua/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ncua"
+  spec.version       = NCUA::VERSION
+  spec.authors       = ["Tom Reznick"]
+  spec.email         = ["treznick@continuty.net"]
+
+  spec.summary       = %q{A Ruby client for the NCUA's "Find a Credit Union tool"}
+  spec.description   = %q{The NCUA recently started using asynchronous json requests in their Find a Credit Union tool. We make that query-able from Ruby.}
+  spec.homepage      = "https://github.com/ContinuityControl/ncua"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "httparty", "~> 0.13"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: ncua
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Tom Reznick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: The NCUA recently started using asynchronous json requests in their Find
+  a Credit Union tool. We make that query-able from Ruby.
+email:
+- treznick@continuty.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ncua.rb
+- lib/ncua/client.rb
+- lib/ncua/credit_union.rb
+- lib/ncua/record.rb
+- lib/ncua/version.rb
+- ncua.gemspec
+homepage: https://github.com/ContinuityControl/ncua
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A Ruby client for the NCUA's "Find a Credit Union tool"
+test_files: []