zipcoder 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33e7e2b9eb15e35a4b1248e3a16772d6763880e7
-  data.tar.gz: db823f8dccbfb1292b85be3bd2111e96f237f748
+  metadata.gz: 81f8212570017ee9537ad0ff17af68e6d4abec2d
+  data.tar.gz: c24abbd919537c6ebcc4d9f21f72abff19979613
 SHA512:
-  metadata.gz: db14e8d94211f815d508eaaf375ffbe2dc5472a31c525597d3d1de9d3519f0a3b0e0502a44bd8467fa86603b6cabeab49dbea7bb1f647eed653dc62b6c584a59
-  data.tar.gz: 672abf7c9f868cc4fe0083472e66b1ad3989155f1829bd04181db34985bdc3c7fa0b83f4c138a5bb8ef3160a8f52872f3f1d31968be0363c743cd1aaa2ba5ce0
+  metadata.gz: b6c6b76529f9741f02b1e46c743452b496483d72b89e2c4d0cb164646aa5764d6fd2ed3e9e63760cfc12f98606bc96066fb66ea50be1a12b5c3ca8906301b069
+  data.tar.gz: 16f706497a1007b065a70aa50bcc08c3b94c7934da54f682601751065b8ce47727922a993089d11d7273f1e534e82eb0c861787f24b6131a2be73ea5006661e3

data/README.md

@@ -1,12 +1,16 @@
 # Zipcoder
 [![Gem Version](https://badge.fury.io/rb/zipcoder.svg)](https://badge.fury.io/rb/zipcoder)
-[![Circle CI](https://circleci.com/gh/ericchapman/zipcoder/tree/master.svg?&style=shield&circle-token=92813c17f9c9510c4c644e41683e7ba2572e0b2a)](https://circleci.com/gh/ericchapman/zipcoder/tree/master)
+[![Circle CI](https://circleci.com/gh/ericchapman/zipcoder/tree/master.svg?&style=shield&circle-token=a6120adc7b90f211b8c19b16e184da4123de671c)](https://circleci.com/gh/ericchapman/zipcoder/tree/master)
 [![Codecov](https://img.shields.io/codecov/c/github/ericchapman/zipcoder/master.svg)](https://codecov.io/github/ericchapman/zipcoder)
 
 Gem for performing zip code lookup operations
 
 ## Revision History
 
+ - v0.2.0:
+   - Internal code rework
+   - API Change!! - changed "city,state" to return normalized info rather
+     than array of zips, lats, longs
  - v0.1.0:
    - Initial Revision
 
@@ -68,6 +72,8 @@ puts 78748.zip_info
 # > {:zip=>"78748", :city=>"AUSTIN", :state=>"TX", :lat=>30.26, :long=>-97.74}
 ```
 
+##### "keys" argument
+
 You can filter the keys that are returned by including the "keys" argument
 as shown below
 
@@ -86,14 +92,20 @@ This will return info about a city
 require 'zipcoder'
 
 puts "Austin, TX".city_info
-# > {:zips=>["73301", ...], :city=>"AUSTIN", :state=>"TX", :lats=>[30.26, ...], :longs=>[-97.74, ...]}
+# > {:zip=>"78701-78799", :city=>"AUSTIN", :state=>"TX", :lat=>30.26, :long=>-97.74}
 ```
 
-The "zips", "lats", and "longs" are all arrays where each value is representing
-the info for a specific zip code.
+Notes:
+
+ - the "zip", "lat", "long" are the combined values from all of the 
+   individual zip codes
+ - the library will normalize the key by removing all of the whitespace
+   and capitalizing the letters.  So for example, "Austin, TX" becomes 
+   "AUSTIN,TX"
+ - the library will cache the normalized cities to improve performance
+   on subsequent calls
 
-Note that the library will normalize the key by removing all of the whitespace
-and capitalizing the letters.  So for example, "Austin, TX" becomes "AUSTIN,TX".
+##### "keys" argument
 
 You can filter the keys that are returned by including the "keys" argument
 as shown below
@@ -101,14 +113,15 @@ as shown below
 ``` ruby
 require 'zipcoder'
 
-puts "Austin, TX".city_info(keys: [:zips])
-# > {:zips=>["73301", ...]}
+puts "Austin, TX".city_info(keys: [:zip])
+# > {:zip=>"78701-78799"}
 ```
 
 ### Updating Data
 
-The library is using the free public zip code data base located [here](http://federalgovernmentzipcodes.us/).
-To update the database, run the following at command line from the top directory
+The library is using the free public zip code data base located 
+[here](http://federalgovernmentzipcodes.us/). To update the database, run the 
+following at command line from the top directory
 
 ```
 %> rake zipcoder:update  # Pulls the latest CSV file from the website
@@ -117,9 +130,14 @@ To update the database, run the following at command line from the top directory
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, 
+run `rake spec` to run the tests. You can also run `bin/console` for an interactive 
+prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To 
+release a new version, update the version number in `version.rb`, and then run 
+`bundle exec rake release`, which will create a git tag for the version, push 
+git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/Rakefile

@@ -38,6 +38,8 @@ namespace :zipcoder do
     csv = CSV.parse(csv_text, :headers => true)
     puts "Importing data from '#{filename}'"
     csv.each do |row|
+      next if row["ZipCodeType"] != "STANDARD"
+
       zip_code = row["Zipcode"]
       city = row["City"]
       state = row["State"]
@@ -46,32 +48,11 @@ namespace :zipcoder do
 
       # Write the zip_lookup_data
       zip_lookup_data[zip_code] = { zip: zip_code, city: city, state: state, lat: lat, long: long }
-
-      # Write the city_lookup_data
-      city_key = "#{city},#{state}"
-      city_data = city_lookup_data[city_key] || {}
-
-      zips = city_data[:zips] || []
-      zips << zip_code
-
-      lats = city_data[:lats] || []
-      lats << lat
-
-      longs = city_data[:longs] || []
-      longs << long
-
-      city_lookup_data[city_key] = { zips: zips, city: city, state: state, lats: lats, longs: longs }
     end
 
     # Write the data to the yaml file
-    zip_lookup = "lib/data/zip_lookup.yml"
-    puts "Writing data to '#{zip_lookup}'"
-    File.open(zip_lookup, 'w') {|file| file.write zip_lookup_data.to_yaml }
-
-    # Write the city lookup data
-    city_lookup = "lib/data/city_lookup.yml"
-    puts "Writing data to '#{city_lookup}'"
-    File.open(city_lookup, 'w') {|file| file.write city_lookup_data.to_yaml }
-
+    zip_data = "lib/data/zip_data.yml"
+    puts "Writing data to '#{zip_data}'"
+    File.open(zip_data, 'w') {|file| file.write zip_lookup_data.to_yaml }
   end
 end