zipcoder 0.8.4 → 0.9.0

data/lib/zipcoder/cacher/base.rb

@@ -1,15 +1,70 @@
 require_relative '../ext/array'
 
+=begin
+
+The ZipCoder::Cacher::Base class generates different data structures and then stores
+them for later access based on whichever cacher is selected.  For example, they could
+be stored in memory, Redis, etc.
+
+The generated data structures are as follows
+
+## zipcoder:zip:ZIP
+
+Information for each zip code
+
+ - zip: zip code (e.g. "55340")
+ - city: city name (e.g. "Hamel")
+ - county: County(s) for the zip code (e.g. ["Travis"])
+ - state: state (e.g. "MN")
+ - lat: latitude for the city (e.g. "45.07")
+ - long: longitude for the city (e.g. "-93.58")
+
+## zipcoder:city:CITY,STATE
+
+Information for each city
+
+ - city: city name (e.g. "Anderson")
+ - county: city county(s) (e.g. ["Travis"])
+ - state: city state (e.g. "IN")
+ - zip: list of zip codes for the city (e.g. "46011-46013,46016-46017")
+ - lat: latitude for the city (e.g. "40.09")
+ - long: longitude for the city (e.g. "-85.68")
+
+## zipcoder:county:COUNTY,STATE
+
+Information for each county
+
+ - county: county name
+ - cities: cities in the county
+ - state: county state
+ - zip: list of zip codes for the county (e.g. "46011-46013,46016-46017")
+ - lat: latitude for the county (e.g. "40.09")
+ - long: longitude for the county (e.g. "-85.68")
+
+## zipcoder:state:cities:STATE
+
+List of cities in the state
+
+## zipcoder:state:counties:STATE
+
+List of counties in the state
+
+## zipcoder:states
+
+List of the states in the US
+
+=end
+
 module Zipcoder
   module Cacher
-    # The cacher base class places all of the objects in memory.  The
-    # abstraction will later allow us to override for MemCacher and
-    # Redis implementations
     class Base
+
       KEY_BASE = "zipcoder"
       KEY_ZIP = "#{KEY_BASE}:zip"
       KEY_CITY = "#{KEY_BASE}:city"
-      KEY_STATE = "#{KEY_BASE}:state"
+      KEY_COUNTY = "#{KEY_BASE}:county"
+      KEY_STATE_CITIES = "#{KEY_BASE}:state:cities"
+      KEY_STATE_COUNTIES = "#{KEY_BASE}:state:counties"
       KEY_STATES = "#{KEY_BASE}:states"
 
       #region Override These
@@ -40,6 +95,8 @@ module Zipcoder
       end
 
       def load
+        start_time = Time.now
+
         this_dir = File.expand_path(File.dirname(__FILE__))
 
         # Load zip cache from file
@@ -49,7 +106,8 @@ module Zipcoder
         # Initialize
         _empty_cache
         city_states = {}
-        state_lookup = {}
+        state_cities_lookup = {}
+        state_counties_lookup = {}
 
         # Add the zip codes to the cache
         zip_codes.each do |zip, cities|
@@ -80,19 +138,32 @@ module Zipcoder
           normalized = _normalize_city(infos)
           _write_cache _city_cache(city_state), normalized
 
-          # Populate the State Cache
-          cities = state_lookup[state] || []
+          # Populate the State City Cache
+          cities = state_cities_lookup[state] || []
           cities << city
-          state_lookup[state] = cities
+          state_cities_lookup[state] = cities
+
+          # Populate the State Counties Cache
+          counties = state_counties_lookup[state] || []
+          counties += normalized[:county].split(",")
+          state_counties_lookup[state] = counties
         end
 
         # Set the cities cache
-        state_lookup.each do |state, cities|
-          _write_cache _state_cache(state), cities.sort
+        state_cities_lookup.each do |state, cities|
+          _write_cache _state_cities_cache(state), cities.sort
+        end
+
+        # Set the cities cache
+        state_counties_lookup.each do |state, counties|
+          _write_cache _state_counties_cache(state), counties.sort.uniq
         end
 
         # Set the states cache
-        self._write_cache _states, state_lookup.keys.sort
+        self._write_cache _states, state_cities_lookup.keys.sort
+
+        # Print the alpsed time
+        puts "ZipCoder initialization time: #{Time.now-start_time}"
       end
 
       def read_zip_cache(zip)
@@ -103,8 +174,12 @@ module Zipcoder
         _read_cache _city_cache(city_state)
       end
 
-      def read_state_cache(state)
-        _read_cache _state_cache(state)
+      def read_state_cities_cache(state)
+        _read_cache _state_cities_cache(state)
+      end
+
+      def read_state_counties_cache(state)
+        _read_cache _state_counties_cache(state)
       end
 
       def read_states
@@ -137,8 +212,12 @@ module Zipcoder
         "#{KEY_CITY}:#{city_state}"
       end
 
-      def _state_cache(state)
-        "#{KEY_STATE}:#{state}"
+      def _state_cities_cache(state)
+        "#{KEY_STATE_CITIES}:#{state}"
+      end
+
+      def _state_counties_cache(state)
+        "#{KEY_STATE_COUNTIES}:#{state}"
       end
 
       def _states
@@ -152,7 +231,8 @@ module Zipcoder
       # Normalizes the values
       def _normalize_city(infos)
         # Values
-        zips =[]
+        zips = []
+        counties = []
         lat_min = 200
         lat_max = -200
         long_min = 200
@@ -167,6 +247,7 @@ module Zipcoder
             long_max = info[:long] if info[:long] > long_max
           end
           zips << info[:zip]
+          counties += info[:county].split(",")
         end
 
         # Create the normalized value
@@ -175,6 +256,7 @@ module Zipcoder
         elsif infos.count == 1
           normalized = {
               city: infos[0][:city],
+              county: infos[0][:county],
               state: infos[0][:state],
               zip: infos[0][:zip],
               lat: infos[0][:lat],
@@ -183,6 +265,7 @@ module Zipcoder
         else
           normalized = {
               city: infos[0][:city],
+              county: counties.uniq.join(","),
               state: infos[0][:state],
               zip: zips.combine_zips,
               lat: ((lat_min+lat_max)/2).round(4),

data/lib/zipcoder/ext/string.rb

@@ -16,6 +16,10 @@ class String
     Zipcoder.state_cities self, **kwargs
   end
 
+  def state_counties(**kwargs)
+    Zipcoder.state_counties self, **kwargs
+  end
+
   def to_zip
     self
   end

data/lib/zipcoder/version.rb

@@ -1,3 +1,3 @@
 module Zipcoder
-  VERSION = "0.8.4"
+  VERSION = "0.9.0"
 end

data/lib/zipcoder.rb

@@ -141,12 +141,12 @@ module Zipcoder
     keys = kwargs[:keys]
 
     # Filter the returned cities
-    cities = self.cacher.read_state_cache(state)
+    cities = self.cacher.read_state_cities_cache(state)
     if names_only
       cities
     else
       infos = []
-      self.cacher.read_state_cache(state).each { |city|
+      self.cacher.read_state_cities_cache(state).each { |city|
         infos << self.city_info("#{city}, #{state}", keys: keys)
       }
 
@@ -154,6 +154,14 @@ module Zipcoder
     end
   end
 
+  # Returns the counties in a state
+  def self.state_counties(state, **kwargs)
+    state = state.strip.upcase
+
+    # Return the counties
+    self.cacher.read_state_counties_cache(state)
+  end
+
   # Returns the states
   def self.states
     self.cacher.read_states

data/spec/zipcoder_spec.rb

@@ -22,6 +22,7 @@ describe Zipcoder do
     it "returns the info for a particular zip_code" do
       zip_info = described_class.zip_info "78748"
       expect(zip_info[:city]).to eq("Austin")
+      expect(zip_info[:county]).to eq("Travis,Williamson,Hays")
       expect(zip_info[:state]).to eq("TX")
       expect(zip_info[:zip]).to eq("78748")
       expect(zip_info[:lat]).to eq(30.26)
@@ -31,6 +32,7 @@ describe Zipcoder do
     it "returns the info for a particular zip_code" do
       zip_info = described_class.zip_info 78748
       expect(zip_info[:city]).to eq("Austin")
+      expect(zip_info[:county]).to eq("Travis,Williamson,Hays")
       expect(zip_info[:state]).to eq("TX")
       expect(zip_info[:zip]).to eq("78748")
       expect(zip_info[:lat]).to eq(30.26)
@@ -46,6 +48,7 @@ describe Zipcoder do
       it "only returns specified keys" do
         zip_info = described_class.zip_info "78748", keys: [:city, :state]
         expect(zip_info[:city]).to eq("Austin")
+        expect(zip_info[:county]).to be_nil
         expect(zip_info[:state]).to eq("TX")
         expect(zip_info[:zip]).to be_nil
         expect(zip_info[:lat]).to be_nil
@@ -87,6 +90,7 @@ describe Zipcoder do
     it "returns the normalized city/state value" do
       city_info = described_class.city_info "Austin, TX"
       expect(city_info[:city]).to eq("Austin")
+      expect(city_info[:county]).to eq("Travis,Williamson,Hays")
       expect(city_info[:state]).to eq("TX")
       expect(city_info[:zip].start_with?("78701")).to eq(true)
       expect(city_info[:lat]).to eq(30.315)
@@ -96,6 +100,7 @@ describe Zipcoder do
     it "returns the normalized city/state value with space" do
       city_info = described_class.city_info " San Antonio , TX"
       expect(city_info[:city]).to eq("San Antonio")
+      expect(city_info[:county]).to eq("Bexar,Comal")
       expect(city_info[:state]).to eq("TX")
       expect(city_info[:zip].start_with?("78201")).to eq(true)
       expect(city_info[:lat]).to eq(29.435)
@@ -125,6 +130,7 @@ describe Zipcoder do
 
       city_info = cities[0]
       expect(city_info[:city]).to eq("Abbott")
+      expect(city_info[:county]).to eq("Hill")
       expect(city_info[:state]).to eq("TX")
       expect(city_info[:zip]).to eq("76621")
       expect(city_info[:lat]).to eq(31.88)
@@ -136,6 +142,7 @@ describe Zipcoder do
 
       city_info = cities[0]
       expect(city_info[:city]).to eq("Abbott")
+      expect(city_info[:county]).to be_nil
       expect(city_info[:state]).to be_nil
       expect(city_info[:zip]).to eq("76621")
       expect(city_info[:lat]).to be_nil
@@ -149,6 +156,15 @@ describe Zipcoder do
     end
   end
 
+  describe "#state_counties" do
+    it "returns the names of the counties for a state" do
+      counties = described_class.state_counties "TX"
+      expect(counties.count).to eq(250)
+
+      expect(counties[0]).to eq("Anderson")
+    end
+  end
+
   describe "#zip_cities" do
     it "returns a city for one zip code" do
       zip_cities = "78748".zip_cities
@@ -156,6 +172,7 @@ describe Zipcoder do
 
       zip_info = zip_cities[0]
       expect(zip_info[:city]).to eq("Austin")
+      expect(zip_info[:county]).to eq("Travis,Williamson,Hays")
       expect(zip_info[:state]).to eq("TX")
       expect(zip_info[:zip]).to eq("78701-78705,78710,78712,78717,78719,78721-78739,78741-78742,78744-78754,78756-78759,78798-78799")
       expect(zip_info[:specified_zip]).to eq("78748")
@@ -169,6 +186,7 @@ describe Zipcoder do
 
       zip_info = zip_cities[0]
       expect(zip_info[:city]).to eq("Austin")
+      expect(zip_info[:county]).to eq("Travis,Williamson,Hays")
       expect(zip_info[:state]).to eq("TX")
       expect(zip_info[:zip]).to eq("78701-78705,78710,78712,78717,78719,78721-78739,78741-78742,78744-78754,78756-78759,78798-78799")
       expect(zip_info[:specified_zip]).to eq("78702-78705,78710,78712,78717,78719,78721-78739,78741-78742,78744-78750")
@@ -177,6 +195,7 @@ describe Zipcoder do
 
       zip_info = zip_cities[1]
       expect(zip_info[:city]).to eq("Cedar Park")
+      expect(zip_info[:county]).to eq("Williamson")
       expect(zip_info[:state]).to eq("TX")
       expect(zip_info[:zip]).to eq("78613")
       expect(zip_info[:specified_zip]).to eq("78613")
@@ -201,6 +220,7 @@ describe Zipcoder do
 
         zip_info = zip_cities["78701-78705,78710,78712,78717,78719,78721-78739,78741-78742,78744-78751"]
         expect(zip_info[:city]).to eq("Austin")
+        expect(zip_info[:county]).to eq("Travis,Williamson,Hays")
         expect(zip_info[:state]).to eq("TX")
         expect(zip_info[:zip]).to eq("78701-78705,78710,78712,78717,78719,78721-78739,78741-78742,78744-78754,78756-78759,78798-78799")
         expect(zip_info[:lat]).to eq(30.315)
@@ -208,6 +228,7 @@ describe Zipcoder do
 
         zip_info = zip_cities["78613"]
         expect(zip_info[:city]).to eq("Cedar Park")
+        expect(zip_info[:county]).to eq("Williamson")
         expect(zip_info[:state]).to eq("TX")
         expect(zip_info[:zip]).to eq("78613")
         expect(zip_info[:lat]).to eq(30.51)
@@ -215,6 +236,7 @@ describe Zipcoder do
 
         zip_info = zip_cities["13601"]
         expect(zip_info[:city]).to eq("Watertown")
+        expect(zip_info[:county]).to eq("Jefferson")
         expect(zip_info[:state]).to eq("NY")
         expect(zip_info[:zip]).to eq("13601-13603")
         expect(zip_info[:lat]).to eq(43.97)
@@ -257,6 +279,7 @@ describe Zipcoder do
       it "returns the info for a particular zip_code" do
         zip_info = "78748".zip_info
         expect(zip_info[:city]).to eq("Austin")
+        expect(zip_info[:county]).to eq("Travis,Williamson,Hays")
         expect(zip_info[:state]).to eq("TX")
         expect(zip_info[:zip]).to eq("78748")
         expect(zip_info[:lat]).to eq(30.26)
@@ -266,6 +289,7 @@ describe Zipcoder do
       it "only returns specified keys" do
         zip_info = "78748".zip_info keys: [:city, :state]
         expect(zip_info[:city]).to eq("Austin")
+        expect(zip_info[:county]).to be_nil
         expect(zip_info[:state]).to eq("TX")
         expect(zip_info[:zip]).to be_nil
         expect(zip_info[:lat]).to be_nil
@@ -277,6 +301,7 @@ describe Zipcoder do
       it "returns the info for a particular city" do
         city_info = "Austin, TX".city_info
         expect(city_info[:city]).to eq("Austin")
+        expect(city_info[:county]).to eq("Travis,Williamson,Hays")
         expect(city_info[:state]).to eq("TX")
         expect(city_info[:zip].start_with?("78701")).to eq(true)
         expect(city_info[:lat]).to eq(30.315)
@@ -286,6 +311,7 @@ describe Zipcoder do
       it "only returns specified keys" do
         city_info = "Austin, TX".city_info keys: [:zip, :city]
         expect(city_info[:city]).to eq("Austin")
+        expect(city_info[:county]).to be_nil
         expect(city_info[:state]).to be_nil
         expect(city_info[:zip].start_with?("78701")).to eq(true)
         expect(city_info[:lat]).to be_nil
@@ -302,6 +328,7 @@ describe Zipcoder do
       it "returns the specified zip codes in the filter" do
         city_info = "Austin, TX".city_info filter: "78701-78704,78748,13601"
         expect(city_info[:city]).to eq("Austin")
+        expect(city_info[:county]).to eq("Travis,Williamson,Hays")
         expect(city_info[:state]).to eq("TX")
         expect(city_info[:specified_zip]).to eq("78701-78704,78748")
         expect(city_info[:zip].start_with?("78701")).to eq(true)
@@ -312,6 +339,7 @@ describe Zipcoder do
       it "returns the specified zip codes in the filter with space" do
         city_info = "Austin, TX".city_info filter: " 78701 "
         expect(city_info[:city]).to eq("Austin")
+        expect(city_info[:county]).to eq("Travis,Williamson,Hays")
         expect(city_info[:state]).to eq("TX")
         expect(city_info[:specified_zip]).to eq("78701")
         expect(city_info[:zip].start_with?("78701")).to eq(true)
@@ -332,6 +360,7 @@ describe Zipcoder do
       it "returns the info for an acceptable city" do
         city_info = "West Lake Hills, TX".city_info
         expect(city_info[:city]).to eq("West Lake Hills")
+        expect(city_info[:county]).to eq("Travis")
         expect(city_info[:state]).to eq("TX")
         expect(city_info[:zip]).to eq("78746")
         expect(city_info[:lat]).to eq(30.26)
@@ -346,6 +375,7 @@ describe Zipcoder do
 
         city_info = cities[0]
         expect(city_info[:city]).to eq("Abbott")
+        expect(city_info[:county]).to eq("Hill")
         expect(city_info[:state]).to eq("TX")
         expect(city_info[:zip]).to eq("76621")
         expect(city_info[:lat]).to eq(31.88)
@@ -357,6 +387,7 @@ describe Zipcoder do
 
         city_info = cities[0]
         expect(city_info[:city]).to eq("Abbott")
+        expect(city_info[:county]).to be_nil
         expect(city_info[:state]).to be_nil
         expect(city_info[:zip]).to eq("76621")
         expect(city_info[:lat]).to be_nil
@@ -375,12 +406,22 @@ describe Zipcoder do
         expect(contains_acceptable).to eq(true)
       end
     end
+
+    describe "#state_counties" do
+      it "returns the names of the counties for a state" do
+        counties = "TX".state_counties
+        expect(counties.count).to eq(250)
+
+        expect(counties[0]).to eq("Anderson")
+      end
+    end
   end
 
   describe("Integer") do
     it "returns the info for a particular zip_code" do
       zip_info = 78748.zip_info
       expect(zip_info[:city]).to eq("Austin")
+      expect(zip_info[:county]).to eq("Travis,Williamson,Hays")
       expect(zip_info[:state]).to eq("TX")
       expect(zip_info[:zip]).to eq("78748")
       expect(zip_info[:lat]).to eq(30.26)

data/zipcoder.gemspec

@@ -7,11 +7,10 @@ Gem::Specification.new do |spec|
   spec.name          = "zipcoder"
   spec.version       = Zipcoder::VERSION
   spec.authors       = ["Eric Chapman"]
-  spec.email         = ["eric.chappy@gmail.com"]
+  spec.email         = ["chapman@e2tec.com"]
 
   spec.summary       = %q{Converts zip codes to cities, lat/long, and vice-versa}
-  #spec.description   = %q{TODO: Write a longer description or delete this line.}
-  spec.homepage      = 'https://github.com/ericchapman/zipcoder'
+  spec.homepage      = 'https://github.com/e2technologies/zipcoder'
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: zipcoder
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.9.0
 platform: ruby
 authors:
 - Eric Chapman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-21 00:00:00.000000000 Z
+date: 2019-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
 - !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.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.5
 description: 
 email:
-- eric.chappy@gmail.com
+- chapman@e2tec.com
 executables:
 - console
 - setup
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .ruby-version
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -113,6 +113,7 @@ files:
 - bin/console
 - bin/setup
 - circle.yml
+- lib/data/county.csv
 - lib/data/zip_data.yml
 - lib/data/zipcode.csv
 - lib/zipcoder.rb
@@ -128,7 +129,7 @@ files:
 - spec/spec_helper.rb
 - spec/zipcoder_spec.rb
 - zipcoder.gemspec
-homepage: https://github.com/ericchapman/zipcoder
+homepage: https://github.com/e2technologies/zipcoder
 licenses:
 - MIT
 metadata: {}
@@ -138,17 +139,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Converts zip codes to cities, lat/long, and vice-versa