us_zipcode 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53d43033c31d31ac68965cdead72e8773b697010
+  data.tar.gz: bc506c4a298bfdfe6d98b87c1f55993e73056332
+SHA512:
+  metadata.gz: 7c091e5a454709020baa2025a9cc68e7112ce4c22e543f9986d28e7a54c21b5e1440ecb7f01c2e5f0246b9d71c972914517d2f17f1d00597e858650e67010e2c
+  data.tar.gz: 66f68df2b60e9c270ddd2c1fa03a22d5e58f1c18efecb0a2853628683ae1a0fcd0a5d4206bf6bcd7e2f078f4be94551f4d9d18ea3d030108727c46df6915c7ce

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/*
+vendor/bundle
+lib/generators/generators

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+bundler_args: --without development
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  
+before_script:
+#  - psql -c 'create database my_zipcode_gem_test;' -U postgres
+#  - mysql -e 'create database my_zipcode_gem_test;'
+  
+gemfile:
+  - rails3_2.gemfile
+  - rails4_0.gemfile
+  - rails4_1.gemfile
+  
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,21 @@
+source 'https://rubygems.org'
+
+gemspec
+
+# jquery-rails is used by the dummy application
+gem 'jquery-rails'
+gem 'sqlite3'
+gem 'mysql2'
+gem 'pg'
+gem 'midwire_common'
+
+group :test do
+  gem 'capybara'
+  gem 'guard-rspec'
+  gem 'guard-spork'
+  gem 'shoulda', '~> 3.5.0'
+  gem 'rspec'
+  gem 'rspec-rails', '~> 2.12.0'
+  gem 'cucumber'
+  gem 'cucumber-rails', '~> 1.3.0', require: false
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Chris Blackburn
+
+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.textile

@@ -0,0 +1,179 @@
+h1. Us Zip Code
+
+
+Simple gem to handle zipcode lookups and related functionality.  @rake zipcodes:update@ will automatically download and update your local zipcode database.  Generates three models for extended zipcode functionality.
+
+h2. Installation
+
+Add the following line to your Gemfile:
+
+bc. gem 'us_zipcode'
+
+Run:
+
+bc. rake bundle install
+
+Generate the models and populate the data:
+
+bc. rails g us_zipcode:models
+rake db:migrate
+rake zipcodes:update
+
+You should now have three new tables and three new models, Zipcode, State, County.
+
+h2. Usage
+
+bc. zipcode = Zipcode.find_by_code '66206'
+zipcode.state.abbr    # => 'KS'
+zipcode.city          # => 'Shawnee Mission'
+zipcode.county.name   # => 'Johnson'
+zipcode.lat.to_s      # => '38.959356', it is actually a BigDecimal object converted to_s for documentation.
+zipcode.lon.to_s      # => '-94.716155', ditto
+zipcode.is_geocoded?  # => true, most if not all should be pre-geocoded.
+
+
+You can use State and County objects as follows:
+
+bc. state = State.find_by_abbr "MO"
+state.cities.count    # => 963
+state.cities          # gives you a sorted array of all cities for the state
+state.zipcodes.count  # => 1195
+...
+county = state.counties.first
+county.cities.count   # => 5
+county.cities         # gives you a sorted array of all cities for the county
+county.zipcodes.count # => 5
+
+
+h3. Look Up City by State & zip code + county by city
+
+First you have to select a state .On state selection , you can see the cities drop down which are associated with the selected state.
+On city selection, you can see the corresponding county with its zip code.
+
+Write the following code in your view:
+
+<%= select_tag "state",options_from_collection_for_select(State.all, "id", "name") %>
+<div id ="city"></div>
+<div id ="county"></div>
+<script>
+  $("#state").on("change", function () {
+    $.ajax({
+      url: "/mycontroller/get_cities_by_state",
+      dataType: "script",
+      method: "get",
+      data: {state_id: $(this).val()}
+    });
+    $("#county").html('');
+  });
+</script> 
+
+Create mycontroller & paste the following code:
+
+  def get_cities_by_state
+    @cities = Zipcode.group(:city).where(state_id: params[:state_id])
+  end
+
+  def get_county_and_zip_by_city    
+    @zipcodes = Zipcode.find_by_city(params[:city])
+  end
+
+Create the following two js.erb files in app/views/mycontroller/
+
+1.get_cities_by_state.js.erb & paste the following code:
+
+$("#city").html('<%= escape_javascript(select_tag "city", options_from_collection_for_select(@cities, :id, :city)) %>');
+$("#city").on("change", function(){
+  $.ajax({
+    url: "/home/get_county_and_zip_by_city",
+    dataType: "script",
+    method: "get",
+    data: {city: $("#city select option:selected"). text()}
+  });
+});
+
+2.get_county_and_zip_by_city.js.erb
+
+$("#county").html('<%= escape_javascript(select_tag "county", options_from_collection_for_select(@zipcodes, :id, :county_and_zip)) %>');
+
+In the last update your routes:
+
+  scope '/mycontroller' do
+    get 'get_cities_by_state' => 'mycontroller#get_cities_by_state'
+    get 'get_county_and_zip_by_city' => 'mycontroller#get_county_and_zip_by_city'
+  end
+
+
+
+h3. Automatic JQuery/AJAX lookup
+
+You can have a user enter a zipcode and automatically lookup their city, state and county.
+
+Put something like this in your view:
+
+bc. f.text_field :zip, :size => 5, :maxlength => 5, :class => 'zipcode_interactive'
+f.text_field :city, :size => 20, :maxlength => 60, :readonly => true
+f.text_field(:state, :size => 2, :maxlength => 2, :readonly => true)
+f.text_field(:county, :size => 20, :maxlength => 60, :readonly => true)
+
+Then add this to your application.js, but remember to replace [mycontrollername] with your own controller.
+
+bc.    $(document).ready(function() {
+        // Interactive Zipcodes
+        $('input.zipcode_interactive').blur(function(data) {
+            var elem_id = $(this).attr("id");
+            var base_id = elem_id.substring(0, elem_id.lastIndexOf("_"));
+            $.get("/mycontrollername/get_zip_data/" + this.value, {},
+            function(data) {
+                var zipcode = $.parseJSON(data);
+                var city = $('#' + base_id + '_city');
+                var state = $('#' + base_id + '_state');
+                var county = $('#' + base_id + '_county');
+                if (zipcode.err) {
+                    alert(zipcode.err);
+                } else {
+                    city.val(zipcode.city);
+                    state.val(zipcode.state)
+                    county.val(zipcode.county)
+                }
+            })
+        });
+    });
+
+You will also need a controller method similar to this, which will return the data to your form:
+
+bc.    def get_zip_data
+      @zipcode = Zipcode.find_by_code(params[:code], :include => [:county, :state])
+      if @zipcode
+        @counties = County.find(:all, :conditions => [ "state_id = ?", @zipcode.county.state_id ])
+        data = {
+          'state' => @zipcode.state.abbr,
+          'county' => @zipcode.county.name,
+          'city' => @zipcode.city.titleize
+        }
+        render :text => data.to_json
+      else
+        if params[:code].blank?
+          return true
+        else
+          if params[:code].is_zipcode?
+            data = {
+              'err' => "Could not find Zipcode [#{params[:code]}].  If this is a valid zipcode please notify support <support@mydomain.com>, so we can update our database."
+            }
+          else
+            data = {
+              'err' => "[#{params[:code]}] is not a valid Zipcode."
+            }
+          end
+          render :text => data.to_json
+        end
+      end
+    end
+
+And define a route for the AJAX function in routes.rb:
+
+bc. get 'mycontrollername/get_zip_data/:code', :controller => 'mycontrollername', :action => 'get_zip_data'
+
+That's about it.
+
+Let me know if there are any errors.  I cut and pasted the code above from a working application, but there may be some gotchas that I missed.
+

data/README.textile~

@@ -0,0 +1,184 @@
+h1. Us Zip Code
+
+
+Simple gem to handle zipcode lookups and related functionality.  @rake zipcodes:update@ will automatically download and update your local zipcode database.  Generates three models for extended zipcode functionality.
+
+h2. Installation
+
+Add the following line to your Gemfile:
+
+bc. gem 'us_zipcode'
+
+Run:
+
+bc. rake bundle install
+
+Generate the models and populate the data:
+
+bc. rails g us_zipcode:models
+rake db:migrate
+rake zipcodes:update
+
+You should now have three new tables and three new models, Zipcode, State, County.
+
+h2. Usage
+
+bc. zipcode = Zipcode.find_by_code '66206'
+zipcode.state.abbr    # => 'KS'
+zipcode.city          # => 'Shawnee Mission'
+zipcode.county.name   # => 'Johnson'
+zipcode.lat.to_s      # => '38.959356', it is actually a BigDecimal object converted to_s for documentation.
+zipcode.lon.to_s      # => '-94.716155', ditto
+zipcode.is_geocoded?  # => true, most if not all should be pre-geocoded.
+
+
+You can use State and County objects as follows:
+
+bc. state = State.find_by_abbr "MO"
+state.cities.count    # => 963
+state.cities          # gives you a sorted array of all cities for the state
+state.zipcodes.count  # => 1195
+...
+county = state.counties.first
+county.cities.count   # => 5
+county.cities         # gives you a sorted array of all cities for the county
+county.zipcodes.count # => 5
+
+
+h3. Look Up City by State & zip code + county by city
+
+First you have to select a state .On state selection , you can see the cities drop down which are associated with the selected state.
+On city selection, you can see the corresponding county with its zip code.
+
+Write the following code in your view:
+
+<%= select_tag "state",options_from_collection_for_select(State.all, "id", "name") %>
+<div id ="city"></div>
+<div id ="county"></div>
+<script>
+  $("#state").on("change", function () {
+    $.ajax({
+      url: "/mycontroller/get_cities_by_state",
+      dataType: "script",
+      method: "get",
+      data: {state_id: $(this).val()}
+    });
+    $("#county").html('');
+  });
+</script> 
+
+Create mycontroller & paste the following code:
+
+  def get_cities_by_state
+    @cities = Zipcode.group(:city).where(state_id: params[:state_id])
+  end
+
+  def get_county_and_zip_by_city    
+    @zipcodes = Zipcode.find_by_city(params[:city])
+  end
+
+Create the following two js.erb files in app/views/mycontroller/
+
+1.get_cities_by_state.js.erb & paste the following code:
+
+$("#city").html('<%= escape_javascript(select_tag "city", options_from_collection_for_select(@cities, :id, :city)) %>');
+$("#city").on("change", function(){
+  $.ajax({
+    url: "/home/get_county_and_zip_by_city",
+    dataType: "script",
+    method: "get",
+    data: {city: $("#city select option:selected"). text()}
+  });
+});
+
+2.get_county_and_zip_by_city.js.erb
+
+$("#county").html('<%= escape_javascript(select_tag "county", options_from_collection_for_select(@zipcodes, :id, :county_and_zip)) %>');
+
+In the last update your routes:
+
+  scope '/mycontroller' do
+    get 'get_cities_by_state' => 'mycontroller#get_cities_by_state'
+    get 'get_county_and_zip_by_city' => 'mycontroller#get_county_and_zip_by_city'
+  end
+
+
+
+h3. Automatic JQuery/AJAX lookup
+
+You can have a user enter a zipcode and automatically lookup their city, state and county.
+
+Put something like this in your view:
+
+bc. f.text_field :zip, :size => 5, :maxlength => 5, :class => 'zipcode_interactive'
+f.text_field :city, :size => 20, :maxlength => 60, :readonly => true
+f.text_field(:state, :size => 2, :maxlength => 2, :readonly => true)
+f.text_field(:county, :size => 20, :maxlength => 60, :readonly => true)
+
+Then add this to your application.js, but remember to replace [mycontrollername] with your own controller.
+
+bc.    $(document).ready(function() {
+        // Interactive Zipcodes
+        $('input.zipcode_interactive').blur(function(data) {
+            var elem_id = $(this).attr("id");
+            var base_id = elem_id.substring(0, elem_id.lastIndexOf("_"));
+            $.get("/mycontrollername/get_zip_data/" + this.value, {},
+            function(data) {
+                var zipcode = $.parseJSON(data);
+                var city = $('#' + base_id + '_city');
+                var state = $('#' + base_id + '_state');
+                var county = $('#' + base_id + '_county');
+                if (zipcode.err) {
+                    alert(zipcode.err);
+                } else {
+                    city.val(zipcode.city);
+                    state.val(zipcode.state)
+                    county.val(zipcode.county)
+                }
+            })
+        });
+    });
+
+You will also need a controller method similar to this, which will return the data to your form:
+
+bc.    def get_zip_data
+      @zipcode = Zipcode.find_by_code(params[:code], :include => [:county, :state])
+      if @zipcode
+        @counties = County.find(:all, :conditions => [ "state_id = ?", @zipcode.county.state_id ])
+        data = {
+          'state' => @zipcode.state.abbr,
+          'county' => @zipcode.county.name,
+          'city' => @zipcode.city.titleize
+        }
+        render :text => data.to_json
+      else
+        if params[:code].blank?
+          return true
+        else
+          if params[:code].is_zipcode?
+            data = {
+              'err' => "Could not find Zipcode [#{params[:code]}].  If this is a valid zipcode please notify support <support@mydomain.com>, so we can update our database."
+            }
+          else
+            data = {
+              'err' => "[#{params[:code]}] is not a valid Zipcode."
+            }
+          end
+          render :text => data.to_json
+        end
+      end
+    end
+
+And define a route for the AJAX function in routes.rb:
+
+bc. get 'mycontrollername/get_zip_data/:code', :controller => 'mycontrollername', :action => 'get_zip_data'
+
+That's about it.
+
+Let me know if there are any errors.  I cut and pasted the code above from a working application, but there may be some gotchas that I missed.
+
+h2. LOG
+
+h3. 05/03/2011:
+
+Initial Release

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+begin
+  require 'midwire_common/rake_tasks'
+rescue StandardError => e
+  puts('>>> Can\'t load midwire_common/rake_tasks.')
+  puts(">>> Did you 'bundle exec'?: #{e.message}")
+  exit
+end
+
+require 'cucumber'
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format progress"
+end
+
+task :default => :features
+task :test => :features

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,76 @@
+When(/^I run "([^\"]*)"$/) do |command|
+  system("cd #{@current_directory} && #{command}").should be_true
+end
+
+When(/^I add "([^\"]*)" to file "([^\"]*)"$/) do |content, short_path|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  File.open(path, 'a') { |f| f.write(content + "\n") }
+end
+
+When(/^I replace "([^\"]*)" with "([^\"]*)" in file "([^\"]*)"$/) do |old_content, new_content, short_path|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  content = File.read(path).gsub(old_content, new_content)
+  File.open(path, 'w') { |f| f.write(content) }
+end
+
+When(/^I insert "([^\"]*)" into "([^\"]*)" after line (\d+)$/) do |content, short_path, after_line|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  lines = File.read(path).split("\n")
+  lines[after_line.to_i, 0] = content
+  File.open(path, 'w') { |f| f.write(lines.join("\n")) }
+end
+
+Then(/^I should see file "([^\"]*)"$/) do |path|
+  File.should exist(File.join(@current_directory, path))
+end
+
+Then(/^I should see "(.*)" in file "([^\"]*)"$/) do |content, short_path|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  File.readlines(path).join.should include(content)
+end
+
+Then(/^I should not see "(.*)" in file "([^\"]*)"$/) do |content, short_path|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  File.readlines(path).join.should_not include(content)
+end
+
+Then(/^I should see the following files$/) do |table|
+  table.raw.flatten.each do |path|
+    File.should exist(File.join(@current_directory, path))
+  end
+end
+
+Then(/^I should see the following in file "([^\"]*)"$/) do |short_path, table|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  table.raw.flatten.each do |content|
+    File.readlines(path).join.should include(content)
+  end
+end
+
+Then(/^I should successfully run "([^\"]*)"$/) do |command|
+  system("cd #{@current_directory} && #{command}").should be_true
+end
+
+Then(/^I should see "([^\"]*)" when running "([^\"]*)"$/) do |expected_response, command|
+  `cd #{@current_directory} && #{command}`.should include(expected_response)
+end
+
+Then(/^I should see (\d+) records in the "([^\"]*)" table$/) do |count, table_name|
+  FileUtils.chdir(@current_directory)
+  ActiveRecord::Base.establish_connection(
+    :adapter => 'sqlite3', 
+    :database => "db/test.sqlite3",
+    :pool => 5,
+    :timeout => 5000
+  )
+  sql = "SELECT COUNT(*) FROM #{table_name}"
+  result = ActiveRecord::Base.connection.select_rows(sql)
+  puts ">>> result: [#{result.flatten.first}]"
+  "Record Count:#{result.flatten.first}".should == "Record Count:#{count}"
+end

data/features/step_definitions/rails_setup_steps.rb

@@ -0,0 +1,17 @@
+Given(/^a new Rails app$/) do
+  FileUtils.rm_rf "tmp/rails_app"
+  FileUtils.mkdir_p("tmp")
+  system("rails new tmp/rails_app -T").should be_true
+  system("ln -s ../../../lib/generators tmp/rails_app/lib/generators").should be_true
+  @current_directory = File.expand_path("tmp/rails_app")
+end
+
+Given %{a new migrated Rails app} do
+  # Don't delete the rails app
+  FileUtils.mkdir_p("tmp")
+  system("rails new tmp/rails_app -f").should be_true
+  system("ln -sf ../../../lib/generators tmp/rails_app/lib/generators").should be_true
+  @current_directory = File.expand_path("tmp/rails_app")
+  When %{I run "rails g us_zipcode:models"}
+  Then %{I should successfully run "rake db:migrate"}
+end

data/features/step_definitions/rails_setup_steps.rb~

@@ -0,0 +1,17 @@
+Given(/^a new Rails app$/) do
+  FileUtils.rm_rf "tmp/rails_app"
+  FileUtils.mkdir_p("tmp")
+  system("rails new tmp/rails_app -T").should be_true
+  system("ln -s ../../../lib/generators tmp/rails_app/lib/generators").should be_true
+  @current_directory = File.expand_path("tmp/rails_app")
+end
+
+Given %{a new migrated Rails app} do
+  # Don't delete the rails app
+  FileUtils.mkdir_p("tmp")
+  system("rails new tmp/rails_app -f").should be_true
+  system("ln -sf ../../../lib/generators tmp/rails_app/lib/generators").should be_true
+  @current_directory = File.expand_path("tmp/rails_app")
+  When %{I run "rails g my_zipcode_gem:models"}
+  Then %{I should successfully run "rake db:migrate"}
+end

data/features/support/env.rb

@@ -0,0 +1,10 @@
+require 'cucumber'
+require 'rspec'
+require 'rails'
+require 'active_record'
+
+ENV["RAILS_ENV"] = "test"
+
+Before do
+  # FileUtils.rm_rf "tmp/rails_app"
+end