state-of-zip 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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.rdoc

@@ -0,0 +1,24 @@
+= StateOfZip
+
+StateOfZip will return a state for a given zip code. It uses Sectional Center Facility locations to determine this. And then scrapes the data from http://en.wikipedia.org/wiki/ZIP_code_prefixes
+
+Note some zip codes serve multiple states. This list may not be entirely accurate.
+
+== Compatibility
+This is a Rails Engine and is only tested against Rails 3.2 and Ruby 1.9.3
+
+== Install
+
+Add the following to your Gemfile 
+  gem 'state-of-zip'
+
+Then run
+  rake state_of_zip:install:migrations
+
+Then run
+  rake db:migrate
+
+
+== Credit
+
+The scraping script was taken from https://github.com/monicao/zip-code-info

data/Rakefile

@@ -0,0 +1,45 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+require 'rspec/core/rake_task'
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'StateOfZip'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+    t.libs << 'lib'
+      t.libs << 'test'
+        t.pattern = 'test/**/*_test.rb'
+          t.verbose = false
+end
+
+
+task :default => :test
+
+desc "Update data.yml file with the zip code state mapping. (This should only be ran in development)"
+task :data_scrape do
+  load 'lib/state-of-zip/data.rb'
+  StateOfZip::DataScrape.scrape
+end

data/app/models/state_of_zip/zip_code.rb

@@ -0,0 +1,11 @@
+module StateOfZip
+  class ZipCode < ActiveRecord::Base
+    def self.lookup(zip_code)
+      if zip_code = where(zip_code_prefix: zip_code[0..2]).first
+        zip_code.state_code
+      else
+        false
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+StateOfZip::Engine.routes.draw do
+  resources :zip_codes
+
+end

data/db/migrate/20121025173341_create_state_of_zip_zip_codes.rb

@@ -0,0 +1,12 @@
+class CreateStateOfZipZipCodes < ActiveRecord::Migration
+  def change
+    create_table :state_of_zip_zip_codes do |t|
+      t.string :zip_code_prefix, :limit => 3
+      t.string :state_code, :limit => 2
+    end
+
+    add_index :state_of_zip_zip_codes, :zip_code_prefix
+
+    StateOfZip::DataLoad.load
+  end
+end

data/lib/state-of-zip.rb

@@ -0,0 +1,5 @@
+require "state-of-zip/engine"
+require "state-of-zip/data_load"
+
+module StateOfZip
+end

data/lib/state-of-zip/data.rb

@@ -0,0 +1,35 @@
+module StateOfZip
+  class DataScrape
+    def self.scrape
+      require "nokogiri"
+      require "open-uri"
+      zip_to_state = {}
+
+      doc = Nokogiri::HTML(open("http://en.wikipedia.org/wiki/ZIP_code_prefixes"))
+
+      puts doc
+
+      doc.css('#bodyContent table td b').each do |code|
+        puts "zip prefix: #{code.content}\n"
+        if code.content.match /^[0-9]{3}/
+          # first three digits of the zip and the state. ex. 384 NJ
+          a = code.content.split
+          if a.length == 2
+            @current_zip = a[0].to_s
+            zip_to_state[@current_zip] = a[1][0..1] unless a[1].length < 2 or @current_zip == "001"
+          end
+        else
+        end
+      end
+
+
+      File.open(File.join(File.dirname(__FILE__), '../..', 'data', 'data.yml'), "w") do |f|
+        f.write zip_to_state.to_yaml
+      end
+
+      # Double check that the data can be loaded properly.
+      data = YAML.load(File.open(File.join(File.dirname(__FILE__), '../..', 'data', 'data.yml')))
+      puts data
+    end
+  end
+end

data/lib/state-of-zip/data_load.rb

@@ -0,0 +1,14 @@
+module StateOfZip
+  class DataLoad
+    def self.load
+      data = YAML.load(File.open(File.join(File.dirname(__FILE__), '../..', 'data', 'data.yml')))
+      data.each do |key, value|
+        #puts "Updating prefix #{key} with State #{value}"
+        zip_code = StateOfZip::ZipCode.where(zip_code_prefix: key).first || StateOfZip::ZipCode.new
+        zip_code.zip_code_prefix = key
+        zip_code.state_code = value
+        zip_code.save!
+      end
+    end
+  end
+end

data/lib/state-of-zip/data_scrape.rb

@@ -0,0 +1,39 @@
+module StateOfZip
+  class DataScrape
+    def self.scrape
+      require "nokogiri"
+      require "open-uri"
+      zip_to_state = {}
+
+      doc = Nokogiri::HTML(open("http://en.wikipedia.org/wiki/ZIP_code_prefixes"))
+
+      puts doc
+
+      doc.css('#bodyContent table td b').each do |code|
+        puts "zip prefix: #{code.content}\n"
+        if code.content.match /^[0-9]{3}/
+          # first three digits of the zip and the state. ex. 384 NJ
+          a = code.content.split
+          if a.length == 2
+            @current_zip = a[0].to_s
+            zip_to_state[@current_zip] = a[1][0..1] unless a[1].length < 2 or @current_zip == "001"
+          end
+        else
+        end
+      end
+
+
+      File.open(File.join(File.dirname(__FILE__), '../..', 'data', 'data.yml'), "w") do |f|
+        f.write zip_to_state.to_yaml
+      end
+
+      # Double check that the data can be loaded properly.
+      data = YAML.load(File.open(File.join(File.dirname(__FILE__), '../..', 'data', 'data.yml')))
+      puts data
+    end
+
+    def self.load
+
+    end
+  end
+end

data/lib/state-of-zip/engine.rb

@@ -0,0 +1,5 @@
+module StateOfZip
+  class Engine < ::Rails::Engine
+    isolate_namespace StateOfZip
+  end
+end

data/lib/state-of-zip/version.rb

@@ -0,0 +1,3 @@
+module StateOfZip
+  VERSION = "1.0.0"
+end

data/lib/tasks/state-of-zip_tasks.rake

@@ -0,0 +1,8 @@
+namespace :state_of_zip do
+  namespace :data do
+    desc "Load the data.yml into StateOfZip::ZipCode"
+    task :load => :environment do
+      StateOfZip::DataLoad.load
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: state-of-zip
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Eric Cranston
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+description: Rails Engine that returns a US State code that a given zip code's sectional
+  center facility resides in. It uses a database table to look up the record.
+email:
+- eric@foodydirect.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/models/state_of_zip/zip_code.rb
+- config/routes.rb
+- db/migrate/20121025173341_create_state_of_zip_zip_codes.rb
+- lib/state-of-zip/data.rb
+- lib/state-of-zip/data_load.rb
+- lib/state-of-zip/data_scrape.rb
+- lib/state-of-zip/engine.rb
+- lib/state-of-zip/version.rb
+- lib/state-of-zip.rb
+- lib/tasks/state-of-zip_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: http://github.com/foodydirect/state-of-zip
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4358455165322927163
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4358455165322927163
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rails Engine that returns a US State code that a given zip code's sectional
+  center facility resides in.
+test_files: []