zip-code-info 0.1.0

data/dev/generate_data.rb

@@ -0,0 +1,38 @@
+# Script to regenerate data/data.yml. This is only used in the gem's development.
+
+require 'rubygems'
+require 'nokogiri'
+require 'open-uri'
+require 'yaml'
+
+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] = {:state => a[1][0..1]} unless a[1].length < 2 or @current_zip == "001"
+    end
+  else
+    # the city name ex. New York
+    # Make sure there are no line breaks in the name (one city has a line break)
+    zip_to_state[@current_zip][:city] = code.content.delete("\n")  
+  end
+end
+
+# puts zip_to_state.to_yaml
+
+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

data/lib/zip-code-info.rb

@@ -0,0 +1,38 @@
+require 'yaml'
+require 'singleton'
+
+class ZipCodeInfo
+  include Singleton 
+  
+  attr_reader :code
+    
+  def initialize
+    @data = YAML.load(File.open(File.join(File.dirname(__FILE__), '..', 'data', 'data.yml')))
+  end 
+  
+  def scf_city_for(code = "")
+    return false unless assign_and_validate_code(code)
+    @data[code_to_key][:city]
+  end
+  
+  def state_for(code = "")
+    return false unless assign_and_validate_code(code)
+    @data[code_to_key][:state]
+  end
+
+  
+  private
+  
+  def assign_and_validate_code(code)
+    @code = code.to_s
+    return @code.match /^[0-9]{5}$/i
+  end
+  
+  # To look up information we only need the first three digits of the zip code
+  def code_to_key
+    @code[0..2]
+  end
+  
+
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'zip-code-info'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/zip-code-info_spec.rb

@@ -0,0 +1,60 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ZipCodeInfo" do
+  
+  describe "Positive Test Cases: " do
+  
+    it "should find the right city" do 
+      zip = ZipCodeInfo.instance.scf_city_for "99100"
+      zip.should eql "Spokane"
+    end
+  
+    it "should find the right state" do 
+      zip = ZipCodeInfo.instance.state_for "99100"
+      zip.should eql "WA"
+    end
+    
+    it "should find the right city when the zip is an integer" do 
+      zip = ZipCodeInfo.instance.scf_city_for 60699
+      ZipCodeInfo.instance.code.should eql "60699"
+      zip.should eql "Chicago"
+    end
+  
+    it "should find the right state when the zip is an integer" do 
+      zip = ZipCodeInfo.instance.state_for 60699
+      ZipCodeInfo.instance.code.should eql "60699"
+      zip.should eql "IL"
+    end
+    
+    it "should find the right city name when the city name contains an &" do 
+      zip = ZipCodeInfo.instance.scf_city_for "11099"
+      zip.should eql "Queens &West Nassau"
+    end
+  
+  end
+  
+  describe "Negative Test Cases: " do
+  
+    it "should handle no zip code" do 
+      zip = ZipCodeInfo.instance.scf_city_for
+      zip.should be_false
+    end
+  
+    it "should handle an invalid zip code - too long" do 
+      zip = ZipCodeInfo.instance.scf_city_for("123456")
+      zip.should be_false
+    end
+  
+    it "should handle an invalid zip code - too short" do 
+      zip = ZipCodeInfo.instance.scf_city_for "1234"
+      zip.should be_false
+    end
+  
+    it "should handle an invalid zip code - alphanum" do 
+      zip = ZipCodeInfo.instance.scf_city_for "1a23g"
+      zip.should be_false 
+    end
+
+  end
+  
+end

data/zip-code-info.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{zip-code-info}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Monica Olinescu"]
+  s.date = %q{2011-03-09}
+  s.description = %q{The data has been collected from wikipedia and stored in a yml file. This gem does not use an external service.}
+  s.email = %q{monica.olinescu@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "data/data.yml",
+    "dev/generate_data.rb",
+    "lib/zip-code-info.rb",
+    "spec/spec_helper.rb",
+    "spec/zip-code-info_spec.rb",
+    "zip-code-info.gemspec"
+  ]
+  s.homepage = %q{http://github.com/monicao/zip-code-info}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.0}
+  s.summary = %q{Looks up the state and city of the Sectional Center Facility for a given zip code.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+    "spec/zip-code-info_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<nokogiri>, [">= 0"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: zip-code-info
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Monica Olinescu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-09 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: The data has been collected from wikipedia and stored in a yml file. This gem does not use an external service.
+email: monica.olinescu@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- data/data.yml
+- dev/generate_data.rb
+- lib/zip-code-info.rb
+- spec/spec_helper.rb
+- spec/zip-code-info_spec.rb
+- zip-code-info.gemspec
+has_rdoc: true
+homepage: http://github.com/monicao/zip-code-info
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -1445853004520550373
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Looks up the state and city of the Sectional Center Facility for a given zip code.
+test_files: 
+- spec/spec_helper.rb
+- spec/zip-code-info_spec.rb