zipcoder 0.8.4 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88837eb066b6b89505fb433f64a8d822bd81e262
-  data.tar.gz: 451dcbbf801fca16cfa93ad2fdcbe21c069e4198
+  metadata.gz: 382bf99325cd32e9e8289b9638333b4635f6d99b
+  data.tar.gz: 3c1261c069f7f08a92a233bfef54bd7aaa1a09a1
 SHA512:
-  metadata.gz: c3225a66cb6b94fb0eed9a6196530e2c8c5d20cec409f99baff3e8c9ae6422f212ac40e2d00c33d79efe835bf24f1a50e942ef69057e1172e52446435a3124f6
-  data.tar.gz: f58b48e2fb82564a59a621ea5cb29c9f8477c8bcf36ca3b72bebe0cbb4bf8e64eef2ca1b08e0a6e4a5fc4c7abe832e5e9568bea8357df48589ec250b0b635d89
+  metadata.gz: 36d427b2293cbd5bfb143937e836403a49a44b1da70d65930f579256e95d94816844fcdc0223b74ca36d1ed9eb7fd353cdcf0b932f0ab3b19f76019867cde9f8
+  data.tar.gz: d510c2d4fbca592ccbcc9b4dd4bc7a1c5fb7714d107197c010365b71e9163946bedd81e68fa05bc943074dfef6de0b9cd9f9be8d6ab4617586ee7d01a0ecf157

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Eric Chapman
+Copyright (c) 2019 E2 Technologies LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -7,6 +7,14 @@ Gem for performing zip code lookup operations
 
 ## Revision History
 
+ - v0.9.0:
+   - added counties - note that there is a slight inaccuracy.  When a city is in
+     multiple counties (for example Austin, TX), ALL of the zip codes for Austin
+     will list ALL of the counties that Austin is in, even though the individual
+     zip codes aren't necessarily in all of the counties.  This is an artifact
+     of the data being from multiple sources
+   - added printing out the time it took to load the data for performance reasons
+   - updated copyright
  - v0.8.4:
    - fixed data corruption issue due to not cloning city before modifying
  - v0.8.3:
@@ -54,6 +62,12 @@ Gem for performing zip code lookup operations
  - v0.1.0:
    - Initial Revision
 
+## Data
+The data for this library is taken from several different open source areas and combined together
+
+ - zip codes: [Federal Goverment Zip Codes](http://federalgovernmentzipcodes.us/free-zipcode-database.csv)
+ - counties: [grammakov Github](https://raw.githubusercontent.com/grammakov/USA-cities-and-states/master/us_cities_states_counties.csv)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -113,7 +127,7 @@ cacher = Zipcoder::Cacher::Redis.new(**args)
 Zipcoder.load_cache(cacher)
 ```
 
-Please check [here](https://github.com/redis/redis-rb) for the different options 
+Please visit [Redis Github](https://github.com/redis/redis-rb) for the different options 
 to use when instantiating the "Redis" client.
 
 ### Methods
@@ -154,11 +168,11 @@ require 'zipcoder'
 
 # Looks up a zip code by string
 puts "78748".zip_info
-# > {:zip=>"78748", :city=>"AUSTIN", :state=>"TX", :lat=>30.26, :long=>-97.74}
+# > {:zip=>"78748", :city=>"Austin", :county=>"Travis,Williamson,Hays", :state=>"TX", :lat=>30.26, :long=>-97.74}
 
 # Looks up a zip code by integer
 puts 78748.zip_info
-# > {:zip=>"78748", :city=>"Austin", :state=>"TX", :lat=>30.26, :long=>-97.74}
+# > {:zip=>"78748", :city=>"Austin", :county=>"Travis,Williamson,Hays", :state=>"TX", :lat=>30.26, :long=>-97.74}
 
 ```
 
@@ -198,7 +212,7 @@ require 'zipcoder'
 
 # Returns the cities for a zip_code
 puts "78701-78750,78613".zip_cities
-# > [{:zip=>"78701-78705,78710,78712,78717,...", :specified_zip => "78701-78750", :city=>"Austin", :state=>"TX", :lat=>30.26, :long=>-97.74}, ...
+# > [{:zip=>"78701-78705,78710,78712,78717,...", :specified_zip => "78701-78750", :city=>"Austin", :county=>"Travis,...", :state=>"TX", :lat=>30.26, :long=>-97.74}, ...
 
 # Returns just the name of the cities
 puts "78701-78750,78613".zip_cities names_only: true
@@ -249,13 +263,13 @@ Zipcoder.city_info("Atlanta, GA", **args)
 require 'zipcoder'
 
 puts "Austin, TX".city_info
-# > {:zip=>"78701-78705,78710,78712,78717,...", :city=>"AUSTIN", :state=>"TX", :lat=>30.26, :long=>-97.74}
+# > {:zip=>"78701-78705,78710,78712,78717,...", :city=>"Austin", :county=>"Travis,...", :state=>"TX", :lat=>30.26, :long=>-97.74}
 
 puts "Austin, TX".city_info(zips_only: true)
 # > ["78701", "78702", "78703", ...]
 
 puts "Austin, TX".city_info(filter: "78701-78704,78748")
-# > {:zip=>"78701-78705,78710,78712,78717,...", :specified_zip=> "78701-78704,78748", :city=>"AUSTIN", :state=>"TX", :lat=>30.26, :long=>-97.74}
+# > {:zip=>"78701-78705,78710,78712,78717,...", :specified_zip=> "78701-78704,78748", :city=>"Austin", :county=>"Travis,...", :state=>"TX", :lat=>30.26, :long=>-97.74}
 ```
 
 #### Method: Zipcoder.state_cities(state, **args)
@@ -294,6 +308,36 @@ puts "TX".state_cities names_only: true
 # > ["Abbott", ...
 ```
 
+#### Method: Zipcoder.state_counties(state, **args)
+
+This will return the cities in a state
+
+**variations:**
+
+``` ruby
+Zipcoder.state_counties("GA", **args)
+"GA".state_counties(**args)
+```
+ 
+**parameters:**
+
+ - state [String] - the 2 letter state abbreviation
+ - **return** [Array] - list of county names
+
+**arguments:**
+
+ - none
+ 
+**examples:**
+
+``` ruby
+require 'zipcoder'
+
+# Returns List
+puts "TX".state_counties
+# > ["Anderson", ...
+```
+
 #### Method: Zipcoder.states
 
 This will return the states in the US

data/Rakefile

@@ -13,30 +13,56 @@ 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.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) }
+    def download(url, output)
+      puts "Downloading data from '#{url}'"
+      puts "   writing to the file '#{output}'"
+
+      # Download the file
+      uri = URI(url)
+      doc = Net::HTTP.get(uri)
+
+      # Write the file to the file system
+      File.open(output, 'w') { |file| file.write(doc.to_s) }
+    end
+
+    # Fetch the latest zip code file
+    download "http://federalgovernmentzipcodes.us/free-zipcode-database.csv", "lib/data/zipcode.csv"
+
+    # Fetch the latest county file
+    download "https://raw.githubusercontent.com/grammakov/USA-cities-and-states/master/us_cities_states_counties.csv", "lib/data/county.csv"
   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)
+    def open_file(filename)
+      puts "Importing data from '#{filename}'"
+      File.read(filename)
+    end
+
+    # Open the county files
+    county_csv_text = open_file "lib/data/county.csv"
+    city_county = {}
+    county_csv_text.split("\n").each do |line|
+      components = line.split("|")
+      next if components.length < 5
+      state = components[1]
+      county = components[3]
+      city = components[4]
+
+      key = "#{city.upcase},#{state}"
+      counties = city_county[key] || []
+      counties << county.capitalize
+      city_county[key] = counties.uniq
+    end
+
+    # Open the zip file
+    zip_csv_text = open_file "lib/data/zipcode.csv"
 
     # Import the CSV file and build the data structure
     zip_lookup_data = {}
-    csv = CSV.parse(csv_text, :headers => true)
-    puts "Importing data from '#{filename}'"
-    csv.each do |row|
+    zip_csv = CSV.parse(zip_csv_text, :headers => true)
+    zip_csv.each do |row|
       next if row["ZipCodeType"] != "STANDARD" or not (["PRIMARY", "ACCEPTABLE"].include? row["LocationType"])
 
       zip_code = row["Zipcode"]
@@ -46,9 +72,13 @@ namespace :zipcoder do
       lat = row["Lat"].to_f
       long = row["Long"].to_f
 
+      # Pull the county
+      key = "#{city.upcase},#{state}"
+      county = (city_county[key] || []).join(",")
+
       # Write the zip_lookup_data
       areas = zip_lookup_data[zip_code] || []
-      areas << { zip: zip_code, city: city, state: state, lat: lat, long: long, primary: primary }
+      areas << { zip: zip_code, city: city, county: county, state: state, lat: lat, long: long, primary: primary }
       zip_lookup_data[zip_code] = areas
     end