zipcoder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33e7e2b9eb15e35a4b1248e3a16772d6763880e7
+  data.tar.gz: db823f8dccbfb1292b85be3bd2111e96f237f748
+SHA512:
+  metadata.gz: db14e8d94211f815d508eaaf375ffbe2dc5472a31c525597d3d1de9d3519f0a3b0e0502a44bd8467fa86603b6cabeab49dbea7bb1f647eed653dc62b6c584a59
+  data.tar.gz: 672abf7c9f868cc4fe0083472e66b1ad3989155f1829bd04181db34985bdc3c7fa0b83f4c138a5bb8ef3160a8f52872f3f1d31968be0363c743cd1aaa2ba5ce0

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+.idea
+*.tmp
+.DS_Store

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Eric Chapman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,132 @@
+# Zipcoder
+[![Gem Version](https://badge.fury.io/rb/zipcoder.svg)](https://badge.fury.io/rb/zipcoder)
+[![Circle CI](https://circleci.com/gh/ericchapman/zipcoder/tree/master.svg?&style=shield&circle-token=92813c17f9c9510c4c644e41683e7ba2572e0b2a)](https://circleci.com/gh/ericchapman/zipcoder/tree/master)
+[![Codecov](https://img.shields.io/codecov/c/github/ericchapman/zipcoder/master.svg)](https://codecov.io/github/ericchapman/zipcoder)
+
+Gem for performing zip code lookup operations
+
+## Revision History
+
+ - v0.1.0:
+   - Initial Revision
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zipcoder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zipcoder
+
+## Usage
+
+### Setup
+
+By default, the library will lazy-load the data structures when you first try
+to use it.  If you would like to have the data structures already loaded
+when application is loaded, you can do the following RAILS example
+
+**config/initializers/zipcoder.rb:**
+
+``` ruby
+require 'zipcoder'
+Zipcoder.load_data
+```
+
+This will immediately load the data structures
+
+### Methods
+
+The library overrides the String (and in some instances Integer) class to 
+provide the following methods
+
+#### Lookup Zip Code
+
+This will return information about the zip code
+
+``` ruby
+require 'zipcoder'
+
+puts "78748".zip_info
+# > {:zip=>"78748", :city=>"AUSTIN", :state=>"TX", :lat=>30.26, :long=>-97.74}
+```
+
+Note that this also works with Integer zip codes, for example
+
+``` ruby
+require 'zipcoder'
+
+puts 78748.zip_info
+# > {:zip=>"78748", :city=>"AUSTIN", :state=>"TX", :lat=>30.26, :long=>-97.74}
+```
+
+You can filter the keys that are returned by including the "keys" argument
+as shown below
+
+``` ruby
+require 'zipcoder'
+
+puts "78748".zip_info(keys: [:city, :state])
+# > {:city=>"AUSTIN", :state=>"TX"}
+```
+
+#### Lookup City
+
+This will return info about a city
+
+``` ruby
+require 'zipcoder'
+
+puts "Austin, TX".city_info
+# > {:zips=>["73301", ...], :city=>"AUSTIN", :state=>"TX", :lats=>[30.26, ...], :longs=>[-97.74, ...]}
+```
+
+The "zips", "lats", and "longs" are all arrays where each value is representing
+the info for a specific zip code.
+
+Note that the library will normalize the key by removing all of the whitespace
+and capitalizing the letters.  So for example, "Austin, TX" becomes "AUSTIN,TX".
+
+You can filter the keys that are returned by including the "keys" argument
+as shown below
+
+``` ruby
+require 'zipcoder'
+
+puts "Austin, TX".city_info(keys: [:zips])
+# > {:zips=>["73301", ...]}
+```
+
+### Updating Data
+
+The library is using the free public zip code data base located [here](http://federalgovernmentzipcodes.us/).
+To update the database, run the following at command line from the top directory
+
+```
+%> rake zipcoder:update  # Pulls the latest CSV file from the website
+%> rake zipcoder:convert  # Updates the zipcoder data structures
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ericchapman/zipcoder.
+
+
+## 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,77 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'net/http'
+require 'csv'
+require 'yaml'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+namespace :zipcoder do
+
+  desc "Pulls the latest zip code data base file"
+  task :update do
+
+    # Fetch the latest database file
+    uri = URI("http://federalgovernmentzipcodes.us/free-zipcode-database-Primary.csv")
+    puts "Downloading newest zip codes from '#{uri.to_s}'"
+    doc = Net::HTTP.get(uri)
+
+    # Write the file to the file system
+    filename = "lib/data/zipcode.csv"
+    puts "Writing to the file '#{filename}'"
+    File.open(filename, 'w') { |file| file.write(doc.to_s) }
+  end
+
+  desc "Converts the database file into the formats expected for the library"
+  task :convert do
+
+    # Open the file
+    filename = "lib/data/zipcode.csv"
+    puts "Opening the file '#{filename}'"
+    csv_text = File.read(filename)
+
+    # Import the CSV file and build the data structure
+    zip_lookup_data = {}
+    city_lookup_data = {}
+    csv = CSV.parse(csv_text, :headers => true)
+    puts "Importing data from '#{filename}'"
+    csv.each do |row|
+      zip_code = row["Zipcode"]
+      city = row["City"]
+      state = row["State"]
+      lat = row["Lat"].to_f
+      long = row["Long"].to_f
+
+      # Write the zip_lookup_data
+      zip_lookup_data[zip_code] = { zip: zip_code, city: city, state: state, lat: lat, long: long }
+
+      # Write the city_lookup_data
+      city_key = "#{city},#{state}"
+      city_data = city_lookup_data[city_key] || {}
+
+      zips = city_data[:zips] || []
+      zips << zip_code
+
+      lats = city_data[:lats] || []
+      lats << lat
+
+      longs = city_data[:longs] || []
+      longs << long
+
+      city_lookup_data[city_key] = { zips: zips, city: city, state: state, lats: lats, longs: longs }
+    end
+
+    # Write the data to the yaml file
+    zip_lookup = "lib/data/zip_lookup.yml"
+    puts "Writing data to '#{zip_lookup}'"
+    File.open(zip_lookup, 'w') {|file| file.write zip_lookup_data.to_yaml }
+
+    # Write the city lookup data
+    city_lookup = "lib/data/city_lookup.yml"
+    puts "Writing data to '#{city_lookup}'"
+    File.open(city_lookup, 'w') {|file| file.write city_lookup_data.to_yaml }
+
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zipcoder"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,3 @@
+test:
+  post:
+    - bundle exec rake spec