zipcoder 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf957bd4626db1ebe9a43b99295f34943097a527
-  data.tar.gz: e94e650a6d81852ff2b759036fe73866e7c0b932
+  metadata.gz: d5ea79e54e07f65092ff72021e80e076cba9e348
+  data.tar.gz: d5193fdcbcb13cb7fa7badf543c02b23027c21e2
 SHA512:
-  metadata.gz: 289ee870b6d3c3eed976d9b5123a479dbdde315c66dc97d77d22e9eeafe93ae9258edcefd4af2dc34fbda2ceaa37bc5b36e8dd9469462266cc8c095ee25c4412
-  data.tar.gz: d4290d8be7b8790935509e2f164ac8769f0f7a1a60424c60aacd6c3c7ae931dd4cce916f653a4ee6f990a93ec1573325344e929e10c66cf9dea201d70c6356ba
+  metadata.gz: b87a6b2a6fcaa9f2312a933341fb77bdd2c05656a074eb3546b283efd13a9850ab2871d2461dc604df7a8a5289838c10417c730ebdfbcdd590553cb37fedb1d3
+  data.tar.gz: c68067f063772d7a9e0bb2c3d4752da71f3656cb302a8fafe8b2887dc09a2778a617a9b255b9c21138897c405546c2ef8706247ff3070d927c7687918d90f83b

data/README.md

@@ -7,6 +7,8 @@ Gem for performing zip code lookup operations
 
 ## Revision History
 
+ - v0.8.1:
+   - added "filter" argument to "city_info" to filter the zip codes
  - v0.8.0:
    - added support for acceptable cities as well.  The "zip_code" lookup will return
      the primary but the "city, state" lookup will support the acceptable cities
@@ -225,6 +227,7 @@ Zipcoder.city_info("Atlanta, GA", **args)
 
  - keys [Array] - array of keys to include (filters out the others)
  - zips_only [Bool] - set to "true" if you want an array of just the zip codes for the city
+ - filter [String] - zip code string (i.e. "78701-78704,78748") that will filter the zip codes (ignored if "zip_code")
  
 **notes:**
 
@@ -244,6 +247,9 @@ puts "Austin, TX".city_info
 
 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}
 ```
 
 #### Method: Zipcoder.state_cities(state, **args)

data/lib/zipcoder/version.rb

@@ -1,3 +1,3 @@
 module Zipcoder
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

data/lib/zipcoder.rb

@@ -113,6 +113,13 @@ module Zipcoder
     cache_key = self._cache_key(city_state)
     cached_value = self.cacher.read_city_cache(cache_key)
 
+    # If filter specified, create "specified_zip"
+    if kwargs[:filter]
+      normal_zips = cached_value[:zip].breakout_zips
+      filter_zips = kwargs[:filter].breakout_zips
+      cached_value[:specified_zip] = (normal_zips & filter_zips).combine_zips
+    end
+
     # Return it
     if cached_value == nil
       nil

data/spec/zipcoder_spec.rb

@@ -299,6 +299,16 @@ describe Zipcoder do
         expect(zip_codes[-1]).to eq('78799')
       end
 
+      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[:state]).to eq("TX")
+        expect(city_info[:specified_zip]).to eq("78701-78704,78748")
+        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
+
       it "returns an nil when the city state is non-existent" do
         zip_codes = ", ".city_info
         expect(zip_codes).to be_nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zipcoder
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Eric Chapman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-20 00:00:00.000000000 Z
+date: 2018-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler