zipcoder 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6acfa10df7bcb97c1d077f57b44eb8f07db3ff49
-  data.tar.gz: 466550b2bbf85a28a1b67381fb6408c71d3b8fcd
+  metadata.gz: cb1e8913fb697af3a6480f88c203a2185bc04314
+  data.tar.gz: ad5b873b490e4e31f9d1dc692baa4d457bdd9b43
 SHA512:
-  metadata.gz: 268af7c1b49cd0528cc2caae8d040ee64127063d5cb292f4a26ed62b76e3f910785f74c77425b05466fd0c0ee9e591d7e66d7e26293288d43ac15e4ce2fd4ca7
-  data.tar.gz: f2ba366f03a0ec93c31d62b17fb8ab09ddd274c0e53be3bf1ee3deba1ceecfbf581818faea8f6bba17c608a11baa8e13211a67efdbfbfc5eba399e8d0da284d8
+  metadata.gz: b3431d07be11bb3338bf0c73a3cacc0a3b9ca1b54fecea557a8a070acb6e1213f8d15e8efd3fffa6097ad06447b62710362b58a0ba94205d2ddd74f641febeed
+  data.tar.gz: 8b466c4f9d1e334bae0d2726574d5ba1ca73bec5eeb6a7adcb446b54e0410823875a3b7fe4dba30efa6db4abb779682f835ec69a369a8e3d30477784b6d10aec

data/README.md

@@ -7,6 +7,8 @@ Gem for performing zip code lookup operations
 
 ## Revision History
 
+ - v0.6.0:
+   - added "grouped" option to "zip_cities"
  - v0.5.0:
    - added Redis backend support
  - v0.4.2:
@@ -74,7 +76,7 @@ following
 **install the 'redis' Gem (or add to your Gemfile if using Rails):**
 
 ```ruby
-gme 'redis'
+gem 'redis'
 ```
 
 *Note that this Gem supports Ruby >= 2.0 so I could NOT use the latest Redis
@@ -90,8 +92,8 @@ cacher = Zipcoder::Cacher::Redis.new(**args)
 Zipcoder.load_cache(cacher)
 ```
 
-Please check the [here](https://github.com/redis/redis-rb) for the different
-options to use when instantiating the "Redis" client.
+Please check [here](https://github.com/redis/redis-rb) for the different options 
+to use when instantiating the "Redis" client.
 
 ### Methods
 
@@ -104,10 +106,12 @@ Returns the info for the "zip"
 
 **variations:**
 
- - ```Zipcoder.zip_info(78748, **args)```
- - ```Zipcoder.zip_info("78748", **args)```
- - ```"78748".zip_info(**args)```
- - ```78748.zip_info(**args)```
+``` ruby
+Zipcoder.zip_info(78748, **args)
+Zipcoder.zip_info("78748", **args)
+"78748".zip_info(**args)
+78748.zip_info(**args)
+```
 
 **parameters:**
 
@@ -143,8 +147,10 @@ Returns the cities that are covered by the "zip_string"
 
 **variations:**
 
- - ```Zipcoder.zip_cities("78701-78799,78613", **args)```
- - ```"78701-78799,78613".zip_cities(**args)```
+``` ruby
+Zipcoder.zip_cities("78701-78799,78613", **args)
+"78701-78799,78613".zip_cities(**args)
+```
 
 **parameters:**
 
@@ -156,7 +162,8 @@ Returns the cities that are covered by the "zip_string"
 **arguments:**
 
  - keys [Array] - array of keys to include (filters out the others)
- - names_only [Bool] - set to "true" if you only want the city names returned
+ - names_only [Bool] - set to "true" if you only want the city/state names returned
+ - grouped [Bool] - set to "true" if you want the zip codes returned grouped by city/state
  - max [Integer] - maximum number of cities to return
  
 **notes:**
@@ -174,7 +181,15 @@ puts "78701-78750,78613".zip_cities
 
 # Returns just the name of the cities
 puts "78701-78750,78613".zip_cities names_only: true
-# > ["Austin", "Cedar Park"]
+# > ["Austin, TX", "Cedar Park, TX"]
+
+# Returns the cities grouped by city/state
+puts "78701-78750,78613".zip_cities grouped: true
+# > {"78701-78750" => {:zip=>"78748", :city=>"Austin", :state=>"TX", ...
+
+# Returns the cities grouped by city/state with names only
+puts "78701-78750,78613".zip_cities grouped: true, names_only: true
+# > {"78701-78750" => "Austin, TX", "78613" => "Cedar Park"}
 ```
 
 #### Method: Zipcoder.city_info(city_state, **args)
@@ -183,8 +198,10 @@ Returns the zip object for a city
 
 **variations:**
 
- - ```Zipcoder.city_info("Atlanta, GA", **args)```
- - ```"zip_string".zip_cities(**args)```
+``` ruby
+Zipcoder.city_info("Atlanta, GA", **args)
+"Atlanta, GA".city_info(**args)
+```
 
 **parameters:**
 
@@ -218,8 +235,10 @@ This will return the cities in a state
 
 **variations:**
 
- - ```Zipcoder.state_cities("GA", **args)```
- - ```"GA".state_cities(**args)```
+``` ruby
+Zipcoder.state_cities("GA", **args)
+"GA".state_cities(**args)
+```
  
 **parameters:**
 
@@ -252,7 +271,9 @@ This will return the states in the US
 
 **variations:**
 
- - ```Zipcoder.states```
+``` ruby
+Zipcoder.states
+```
  
 **parameters:**
 

data/lib/zipcoder/cacher/base.rb

@@ -1,3 +1,5 @@
+require_relative '../ext/array'
+
 module Zipcoder
   module Cacher
     # The cacher base class places all of the objects in memory.  The
@@ -146,8 +148,7 @@ module Zipcoder
       # Normalizes the values
       def _normalize_city(infos)
         # Values
-        zip_min = 100000
-        zip_max = 0
+        zips =[]
         lat_min = 200
         lat_max = -200
         long_min = 200
@@ -155,9 +156,7 @@ module Zipcoder
 
         # Iterate through the info and get min/max of zip/lat/long
         infos.each do |info|
-          zip = info[:zip].to_i
-          zip_min = zip if zip < zip_min
-          zip_max = zip if zip > zip_max
+          zips << info[:zip]
           lat_min = info[:lat] if info[:lat] < lat_min
           lat_max = info[:lat] if info[:lat] > lat_max
           long_min = info[:long] if info[:long] < long_min
@@ -179,7 +178,7 @@ module Zipcoder
           normalized = {
               city: infos[0][:city],
               state: infos[0][:state],
-              zip: "#{zip_min.to_zip}-#{zip_max.to_zip}",
+              zip: zips.combine_zips,
               lat: ((lat_min+lat_max)/2).round(4),
               long: ((long_min+long_max)/2).round(4)
           }

data/lib/zipcoder/ext/array.rb

@@ -0,0 +1,39 @@
+require_relative 'string'
+
+class Array
+  def combine_zips
+    zips = []
+    start = nil
+    last = nil
+
+    self.sort.each do |zip|
+      zip_int = zip.to_i
+
+      if start == nil
+        start = zip_int
+        last = zip_int
+      else
+        if zip_int == last+1
+          last = zip_int
+        else
+          if last == start
+            zips << start.to_zip
+          else
+            zips << "#{start.to_zip}-#{last.to_zip}"
+          end
+          start = zip_int
+          last = zip_int
+        end
+      end
+
+    end
+
+    if last == start
+      zips << start.to_zip
+    else
+      zips << "#{start.to_zip}-#{last.to_zip}"
+    end
+
+    zips.join ","
+  end
+end

data/lib/zipcoder/ext/string.rb

@@ -20,4 +20,8 @@ class String
     self
   end
 
+  def is_zip?
+    self.length == 5
+  end
+
 end

data/lib/zipcoder/version.rb

@@ -1,3 +1,3 @@
 module Zipcoder
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/zipcoder.rb

@@ -2,6 +2,7 @@ require "zipcoder/version"
 require "zipcoder/cacher/memory"
 require "zipcoder/ext/string"
 require "zipcoder/ext/integer"
+require "zipcoder/ext/array"
 require "yaml"
 
 module Zipcoder
@@ -56,27 +57,49 @@ module Zipcoder
     max = kwargs[:max]
 
     cities = {}
+    last_key = nil
     self._parse_zip_string(zip_string).each do |zip|
       info = zip.zip_info
       if info == nil
+        key = last_key
+      else
+        key = "#{info[:city]}, #{info[:state]}"
+      end
+      last_key = key
+
+      if key == nil
         next
       end
 
-      cities["#{info[:city]}, #{info[:state]}"] = true
+      zip_codes = cities[key] || []
+      zip_codes << zip
+      cities[key] = zip_codes
 
       if max != nil and cities.keys.count >= max
         break
       end
     end
 
-    cities = cities.keys.uniq.sort
 
-    if kwargs[:names_only]
-      zips = cities.map{ |x| x.split(",")[0].strip }
+    if kwargs[:grouped]
+      zips = {}
+      cities.each do |city, zip_codes|
+        key = zip_codes.combine_zips
+        if kwargs[:names_only]
+          zips[key] = city
+        else
+          zips[key] = city.city_info(keys: kwargs[:keys])
+        end
+      end
     else
-      zips = []
-      cities.each do |key|
-        zips << key.city_info(keys: kwargs[:keys])
+      cities = cities.keys.uniq.sort
+      if kwargs[:names_only]
+        zips = cities
+      else
+        zips = []
+        cities.each do |key|
+          zips << key.city_info(keys: kwargs[:keys])
+        end
       end
     end
     zips
@@ -164,11 +187,10 @@ module Zipcoder
 
   # Check the zip codes
   def self._check_zip(zip)
-    if zip.length != 5
+    unless zip.is_zip?
       raise ZipcoderError, "zip code #{zip} is not 5 characters"
     end
     zip
   end
 
-
 end

data/spec/array_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+require "zipcoder/ext/array"
+
+
+describe Array do
+  it 'combines the zip codes' do
+    [
+        [["12345","12346","12347"], "12345-12347"],
+        [["12347","12346","12345"], "12345-12347"],
+        [["12346","12347","12345"], "12345-12347"],
+        [["12346","12347","12345","78746"], "12345-12347,78746"],
+        [["78748","78746","12346","12347","12345"], "12345-12347,78746,78748"],
+    ].each do |test|
+      expect(test[0].combine_zips).to eq(test[1])
+    end
+  end
+end

data/spec/zipcoder_spec.rb

@@ -88,7 +88,7 @@ describe Zipcoder do
       city_info = described_class.city_info "Austin, TX"
       expect(city_info[:city]).to eq("Austin")
       expect(city_info[:state]).to eq("TX")
-      expect(city_info[:zip]).to eq("78701-78799")
+      expect(city_info[:zip].start_with?("78701")).to eq(true)
       expect(city_info[:lat]).to eq(30.315)
       expect(city_info[:long]).to eq(-97.71)
     end
@@ -97,7 +97,7 @@ describe Zipcoder do
       city_info = described_class.city_info " San Antonio , TX"
       expect(city_info[:city]).to eq("San Antonio")
       expect(city_info[:state]).to eq("TX")
-      expect(city_info[:zip]).to eq("78201-78285")
+      expect(city_info[:zip].start_with?("78201")).to eq(true)
       expect(city_info[:lat]).to eq(29.435)
       expect(city_info[:long]).to eq(-98.495)
     end
@@ -106,7 +106,7 @@ describe Zipcoder do
       city_info = described_class.city_info "Austin, TX", keys: [:zip, :lat, :long]
       expect(city_info[:city]).to be_nil
       expect(city_info[:state]).to be_nil
-      expect(city_info[:zip]).to eq("78701-78799")
+      expect(city_info[:zip].start_with?("78701")).to eq(true)
       expect(city_info[:lat]).to eq(30.315)
       expect(city_info[:long]).to eq(-97.71)
     end
@@ -157,7 +157,7 @@ describe Zipcoder do
       zip_info = zip_cities[0]
       expect(zip_info[:city]).to eq("Austin")
       expect(zip_info[:state]).to eq("TX")
-      expect(zip_info[:zip]).to eq("78701-78799")
+      expect(zip_info[:zip].start_with?("78701")).to eq(true)
       expect(zip_info[:lat]).to eq(30.315)
       expect(zip_info[:long]).to eq(-97.71)
     end
@@ -169,7 +169,7 @@ describe Zipcoder do
       zip_info = zip_cities[0]
       expect(zip_info[:city]).to eq("Austin")
       expect(zip_info[:state]).to eq("TX")
-      expect(zip_info[:zip]).to eq("78701-78799")
+      expect(zip_info[:zip].start_with?("78701")).to eq(true)
       expect(zip_info[:lat]).to eq(30.315)
       expect(zip_info[:long]).to eq(-97.71)
 
@@ -188,7 +188,41 @@ describe Zipcoder do
 
     it "returns just names of cities sorted" do
       zip_cities = "13601,78613,78702-78750".zip_cities names_only: true
-      expect(zip_cities).to eq(["Austin", "Cedar Park", "Watertown"])
+      expect(zip_cities).to eq(["Austin, TX", "Cedar Park, TX", "Watertown, NY"])
+    end
+
+    context "#grouped" do
+      it "returns the cities grouped" do
+        zip_cities = "78751,13601,78613,78702-78750".zip_cities grouped: true
+        expect(zip_cities.keys.sort).to eq(["13601", "78613", "78702-78751"])
+
+        zip_info = zip_cities["78702-78751"]
+        expect(zip_info[:city]).to eq("Austin")
+        expect(zip_info[:state]).to eq("TX")
+        expect(zip_info[:zip].start_with?("78701")).to eq(true)
+        expect(zip_info[:lat]).to eq(30.315)
+        expect(zip_info[:long]).to eq(-97.71)
+
+        zip_info = zip_cities["78613"]
+        expect(zip_info[:city]).to eq("Cedar Park")
+        expect(zip_info[:state]).to eq("TX")
+        expect(zip_info[:zip]).to eq("78613")
+        expect(zip_info[:lat]).to eq(30.51)
+        expect(zip_info[:long]).to eq(-97.83)
+
+        zip_info = zip_cities["13601"]
+        expect(zip_info[:city]).to eq("Watertown")
+        expect(zip_info[:state]).to eq("NY")
+        expect(zip_info[:zip]).to eq("13601,13603")
+        expect(zip_info[:lat]).to eq(43.97)
+        expect(zip_info[:long]).to eq(-75.91)
+      end
+
+      it "returns just names of cities grouped" do
+        zip_cities = "78751,13601,78613,78702-78750".zip_cities grouped: true, names_only: true
+        expect(zip_cities.keys.sort).to eq(["13601", "78613", "78702-78751"])
+        expect(zip_cities).to eq({"78702-78751" => "Austin, TX", "78613" => "Cedar Park, TX", "13601" => "Watertown, NY"})
+      end
     end
   end
 
@@ -236,7 +270,7 @@ describe Zipcoder do
         city_info = "Austin, TX".city_info
         expect(city_info[:city]).to eq("Austin")
         expect(city_info[:state]).to eq("TX")
-        expect(city_info[:zip]).to eq("78701-78799")
+        expect(city_info[:zip].start_with?("78701")).to eq(true)
         expect(city_info[:lat]).to eq(30.315)
         expect(city_info[:long]).to eq(-97.71)
       end
@@ -244,7 +278,7 @@ describe Zipcoder do
         city_info = "Austin, TX".city_info keys: [:zip, :city]
         expect(city_info[:city]).to eq("Austin")
         expect(city_info[:state]).to be_nil
-        expect(city_info[:zip]).to eq("78701-78799")
+        expect(city_info[:zip].start_with?("78701")).to eq(true)
         expect(city_info[:lat]).to be_nil
         expect(city_info[:long]).to be_nil
       end

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: zipcoder
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Eric Chapman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-13 00:00:00.000000000 Z
+date: 2018-03-17 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: 
@@ -103,9 +103,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .ruby-version
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -119,9 +119,11 @@ files:
 - lib/zipcoder/cacher/base.rb
 - lib/zipcoder/cacher/memory.rb
 - lib/zipcoder/cacher/redis.rb
+- lib/zipcoder/ext/array.rb
 - lib/zipcoder/ext/integer.rb
 - lib/zipcoder/ext/string.rb
 - lib/zipcoder/version.rb
+- spec/array_spec.rb
 - spec/cacher_redis_spec.rb
 - spec/spec_helper.rb
 - spec/zipcoder_spec.rb
@@ -136,21 +138,22 @@ 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.5.1
 signing_key: 
 specification_version: 4
 summary: Converts zip codes to cities, lat/long, and vice-versa
 test_files:
+- spec/array_spec.rb
 - spec/cacher_redis_spec.rb
 - spec/spec_helper.rb
 - spec/zipcoder_spec.rb