postal_code 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: daaa90755eb46bfbef2decfb6b91c49b6c25bc7c
-  data.tar.gz: a38b2fc6cec36696b12c5484ce9ce66fa471a46a
+SHA256:
+  metadata.gz: 3669d039774fdfe02d784606417d34a0934e9ed9f6f75bcb93b1cdb484838f56
+  data.tar.gz: 626a654598f0458f751fa526c758303c0e93a51f7bb2712a9567096d9f4f7b4a
 SHA512:
-  metadata.gz: c0487f3d28c9beb054fa391364a9f13ef509343a918f8c364be990f027df56894977d1df6b3624cddc62b00bdddea21a3580f90890aeb13ad7f8fa319e2c4d3d
-  data.tar.gz: cff36cba72e7eeec5b42e43188fdea432484c277c590203314315227ed91e3845b2b32a3ea8046df59393135700181af0da4972be2b9ae17693fa34a23106e6b
+  metadata.gz: ea844f0dd9fd458cd214a0bef221e96193ece2406b6218469cdd9a3d0ae59e4dd5603ca4058434ef47fc149792771d2bcfff21172e637b2ae61d301f07852602
+  data.tar.gz: ffe0b33ff04b423fce648bb0d16cb9045f77bdfeebb7ef617936f6bfcde54359dec6ae49bae49944bacb135b5b090f2d1b9d2144b55aa29d3fc2f326772fc104

data/README.rdoc

@@ -82,6 +82,14 @@ details.
   PostalCode.city  '00000'       #=> nil
   PostalCode.state '00000'       #=> nil
 
+=== Validate postal code
+
+  PostalCode.valid_format? 1     #=> TypeError (postal code must be a string)
+
+  PostalCode.valid_format? '1'          #=> false
+  PostalCode.valid_format? '00000'      #=> true
+  PostalCode.valid_format? '00000-0000' #=> true
+
 === Load entire postal code database into memory
 
   PostalCode.load_cache
@@ -148,12 +156,18 @@ Bug Tracker :: https://bitbucket.org/pachl/postal_code/issues
 8. 2017-12-04, v0.3.5
    * Update US database. (515 additions and 7 deletions)
 
+9. 2020-02-19, v0.3.6
+   * Add API method PostalCode.valid\_format?
+   * Raise TypeError when a postal code parameter is not a string.
+   * Clean up validation tests.
+   * Update US database. (66 additions and 37 deletions)
+
 
 == License
 
 ({ISC License}[https://opensource.org/licenses/ISC])
 
-Copyright (c) 2017, Clint Pachl <pachl@ecentryx.com>
+Copyright (c) 2020, Clint Pachl <pachl@ecentryx.com>
 
 Permission to use, copy, modify, and/or distribute this software for any purpose
 with or without fee is hereby granted, provided that the above copyright notice

data/db/US.tsv

@@ -3169,7 +3169,6 @@
 09461	APO AE	
 09462	APO AE	
 09463	APO AE	
-09464	APO AA	
 09464	APO AE	
 09467	APO AE	
 09468	APO AE	
@@ -6696,6 +6695,7 @@
 17332	Hanover	PA
 17333	Hanover	PA
 17334	Hanover	PA
+17335	Hanover	PA
 17337	Idaville	PA
 17339	Lewisberry	PA
 17340	Littlestown	PA
@@ -7960,6 +7960,7 @@
 20245	Washington	DC
 20250	Washington	DC
 20251	Washington	DC
+20252	Washington	DC
 20254	Washington	DC
 20260	Washington	DC
 20261	Washington	DC
@@ -8015,6 +8016,7 @@
 20414	Washington	DC
 20415	Washington	DC
 20416	Washington	DC
+20417	Washington	DC
 20418	Washington	DC
 20419	Washington	DC
 20420	Washington	DC
@@ -8112,11 +8114,13 @@
 20581	Washington	DC
 20585	Washington	DC
 20586	Washington	DC
+20588	Dhs	MD
 20590	Washington	DC
 20591	Washington	DC
 20593	Washington	DC
 20594	Washington	DC
 20597	Washington	DC
+20598	Dhs	VA
 20599	Washington	DC
 20601	Waldorf	MD
 20602	Waldorf	MD
@@ -9624,6 +9628,7 @@
 24201	Bristol	VA
 24202	Bristol	VA
 24203	Bristol	VA
+24205	Bristol	VA
 24209	Bristol	VA
 24210	Abingdon	VA
 24211	Abingdon	VA
@@ -10363,6 +10368,7 @@
 25879	Minden	WV
 25880	Mount Hope	WV
 25882	Mullens	WV
+25888	Mount Hope	WV
 25901	Oak Hill	WV
 25902	Odd	WV
 25904	Pax	WV
@@ -10744,31 +10750,31 @@
 27094	Rural Hall	NC
 27098	Rural Hall	NC
 27099	Rural Hall	NC
-27101	Winston Salem	NC
-27102	Winston Salem	NC
-27103	Winston Salem	NC
-27104	Winston Salem	NC
-27105	Winston Salem	NC
-27106	Winston Salem	NC
-27107	Winston Salem	NC
-27108	Winston Salem	NC
-27109	Winston Salem	NC
-27110	Winston Salem	NC
-27111	Winston Salem	NC
-27113	Winston Salem	NC
-27114	Winston Salem	NC
-27115	Winston Salem	NC
-27116	Winston Salem	NC
-27117	Winston Salem	NC
-27120	Winston Salem	NC
-27127	Winston Salem	NC
-27130	Winston Salem	NC
-27150	Winston Salem	NC
-27152	Winston Salem	NC
-27155	Winston Salem	NC
-27157	Winston Salem	NC
-27198	Winston Salem	NC
-27199	Winston Salem	NC
+27101	Winston-Salem	NC
+27102	Winston-Salem	NC
+27103	Winston-Salem	NC
+27104	Winston-Salem	NC
+27105	Winston-Salem	NC
+27106	Winston-Salem	NC
+27107	Winston-Salem	NC
+27108	Winston-Salem	NC
+27109	Winston-Salem	NC
+27110	Winston-Salem	NC
+27111	Winston-Salem	NC
+27113	Winston-Salem	NC
+27114	Winston-Salem	NC
+27115	Winston-Salem	NC
+27116	Winston-Salem	NC
+27117	Winston-Salem	NC
+27120	Winston-Salem	NC
+27127	Winston-Salem	NC
+27130	Winston-Salem	NC
+27150	Winston-Salem	NC
+27152	Winston-Salem	NC
+27155	Winston-Salem	NC
+27157	Winston-Salem	NC
+27198	Winston-Salem	NC
+27199	Winston-Salem	NC
 27201	Alamance	NC
 27202	Altamahaw	NC
 27203	Asheboro	NC
@@ -10808,6 +10814,7 @@
 27263	High Point	NC
 27264	High Point	NC
 27265	High Point	NC
+27268	High Point	NC
 27278	Hillsborough	NC
 27281	Jackson Springs	NC
 27282	Jamestown	NC
@@ -12968,10 +12975,12 @@
 31136	Atlanta	GA
 31139	Atlanta	GA
 31141	Atlanta	GA
+31144	Kennesaw	GA
 31145	Atlanta	GA
 31146	Atlanta	GA
 31150	Atlanta	GA
 31156	Atlanta	GA
+31169	Peachtree City	GA
 31192	Atlanta	GA
 31193	Atlanta	GA
 31195	Atlanta	GA
@@ -13895,6 +13904,7 @@
 33097	Coconut Creek	FL
 33101	Miami	FL
 33102	Miami	FL
+33106	Miami	FL
 33109	Miami Beach	FL
 33111	Miami	FL
 33112	Miami	FL
@@ -14586,6 +14596,7 @@
 34433	Dunnellon	FL
 34434	Dunnellon	FL
 34436	Floral City	FL
+34441	Hernando	FL
 34442	Hernando	FL
 34445	Holder	FL
 34446	Homosassa	FL
@@ -14901,6 +14912,7 @@
 35260	Birmingham	AL
 35261	Birmingham	AL
 35266	Birmingham	AL
+35270	Birmingham	AL
 35282	Birmingham	AL
 35283	Birmingham	AL
 35285	Birmingham	AL
@@ -16985,6 +16997,7 @@
 40161	Rhodelia	KY
 40162	Rineyville	KY
 40165	Shepherdsville	KY
+40166	Shepherdsville	KY
 40170	Stephensport	KY
 40171	Union Star	KY
 40175	Vine Grove	KY
@@ -17198,6 +17211,7 @@
 40743	London	KY
 40744	London	KY
 40745	London	KY
+40750	London	KY
 40755	Pittsburg	KY
 40759	Rockholds	KY
 40763	Siler	KY
@@ -17292,7 +17306,9 @@
 41017	Ft Mitchell	KY
 41018	Erlanger	KY
 41019	Covington	KY
+41021	Hebron	KY
 41022	Florence	KY
+41025	Erlanger	KY
 41030	Crittenden	KY
 41031	Cynthiana	KY
 41033	De Mossville	KY
@@ -17960,6 +17976,7 @@
 43160	Washington Court House	OH
 43162	West Jefferson	OH
 43164	Williamsport	OH
+43194	Lockbourne	OH
 43195	Groveport	OH
 43199	Groveport	OH
 43201	Columbus	OH
@@ -19382,6 +19399,7 @@
 46208	Indianapolis	IN
 46209	Indianapolis	IN
 46211	Indianapolis	IN
+46213	Indianapolis	IN
 46214	Indianapolis	IN
 46216	Indianapolis	IN
 46217	Indianapolis	IN
@@ -21881,6 +21899,8 @@
 50950	Des Moines	IA
 50980	Des Moines	IA
 50981	Des Moines	IA
+50982	Des Moines	IA
+50983	Des Moines	IA
 51001	Akron	IA
 51002	Alta	IA
 51003	Alton	IA
@@ -25106,6 +25126,7 @@
 58795	Wildrose	ND
 58801	Williston	ND
 58802	Williston	ND
+58803	Williston	ND
 58830	Alamo	ND
 58831	Alexander	ND
 58833	Ambrose	ND
@@ -25721,6 +25742,7 @@
 60415	Chicago Ridge	IL
 60416	Coal City	IL
 60417	Crete	IL
+60418	Crestwood	IL
 60419	Dolton	IL
 60420	Dwight	IL
 60421	Elwood	IL
@@ -25848,6 +25870,7 @@
 60566	Naperville	IL
 60567	Naperville	IL
 60568	Aurora	IL
+60569	Aurora	IL
 60572	Aurora	IL
 60585	Plainfield	IL
 60586	Plainfield	IL
@@ -30665,6 +30688,7 @@
 72225	Little Rock	AR
 72227	Little Rock	AR
 72231	Little Rock	AR
+72255	Little Rock	AR
 72260	Little Rock	AR
 72295	Little Rock	AR
 72301	West Memphis	AR
@@ -30916,6 +30940,7 @@
 72704	Fayetteville	AR
 72711	Avoca	AR
 72712	Bentonville	AR
+72713	Bentonville	AR
 72714	Bella Vista	AR
 72715	Bella Vista	AR
 72716	Bentonville	AR
@@ -31837,6 +31862,7 @@
 75033	Frisco	TX
 75034	Frisco	TX
 75035	Frisco	TX
+75036	Frisco	TX
 75038	Irving	TX
 75039	Irving	TX
 75040	Garland	TX
@@ -31867,6 +31893,7 @@
 75069	Mckinney	TX
 75070	Mckinney	TX
 75071	Mckinney	TX
+75072	Mckinney	TX
 75074	Plano	TX
 75075	Plano	TX
 75076	Pottsboro	TX
@@ -32477,6 +32504,7 @@
 76181	Fort Worth	TX
 76182	North Richland Hills	TX
 76185	Fort Worth	TX
+76190	Fort Worth	TX
 76191	Fort Worth	TX
 76192	Fort Worth	TX
 76193	Fort Worth	TX
@@ -35433,9 +35461,9 @@
 83811	Clark Fork	ID
 83812	Clarkia	ID
 83813	Cocolalla	ID
-83814	Coeur D Alene	ID
-83815	Coeur D Alene	ID
-83816	Coeur D Alene	ID
+83814	Coeur d'Alene	ID
+83815	Coeur d'Alene	ID
+83816	Coeur d'Alene	ID
 83821	Coolin	ID
 83822	Oldtown	ID
 83823	Deary	ID
@@ -35909,12 +35937,14 @@
 85087	New River	AZ
 85097	Phoenix	AZ
 85098	Phoenix	AZ
+85117	Apache Junction	AZ
 85118	Gold Canyon	AZ
 85119	Apache Junction	AZ
 85120	Apache Junction	AZ
 85121	Bapchule	AZ
 85122	Casa Grande	AZ
 85123	Arizona City	AZ
+85127	Chandler Heights	AZ
 85128	Coolidge	AZ
 85130	Casa Grande	AZ
 85131	Eloy	AZ
@@ -35931,6 +35961,9 @@
 85147	Sacaton	AZ
 85172	Stanfield	AZ
 85173	Superior	AZ
+85178	Apache Junction	AZ
+85190	Tortilla Flat	AZ
+85191	Valley Farms	AZ
 85192	Winkelman	AZ
 85193	Casa Grande	AZ
 85194	Casa Grande	AZ
@@ -36438,6 +36471,7 @@
 87125	Albuquerque	NM
 87131	Albuquerque	NM
 87144	Rio Rancho	NM
+87151	Albuquerque	NM
 87153	Albuquerque	NM
 87154	Albuquerque	NM
 87158	Albuquerque	NM
@@ -36567,6 +36601,7 @@
 87583	Villanueva	NM
 87592	Santa Fe	NM
 87594	Santa Fe	NM
+87654	Spaceport City	NM
 87701	Las Vegas	NM
 87710	Angel Fire	NM
 87711	Anton Chico	NM
@@ -36632,6 +36667,7 @@
 88009	Playas	NM
 88011	Las Cruces	NM
 88012	Las Cruces	NM
+88013	Las Cruces	NM
 88020	Animas	NM
 88021	Anthony	NM
 88022	Arenas Valley	NM
@@ -39077,6 +39113,7 @@
 95211	Stockton	CA
 95212	Stockton	CA
 95213	Stockton	CA
+95214	Stockton	CA
 95215	Stockton	CA
 95219	Stockton	CA
 95220	Acampo	CA
@@ -39961,14 +39998,6 @@
 96863	FPO AA	
 96863	Mcbh Kaneohe Bay	HI
 96898	Wake Island	HI
-96940	Palau	PW
-96941	Pohnpei	FM
-96942	Chuuk	FM
-96943	Yap	FM
-96944	Kosrae	FM
-96950	Saipan	MP
-96951	Rota	MP
-96952	Tinian	MP
 96960	Marshall Islands	MH
 96970	Ebeye	MH
 97001	Antelope	OR

data/lib/postal_code.rb

@@ -1,6 +1,6 @@
 module PostalCode
 
-  VERSION = '0.3.5'
+  VERSION = '0.3.6'
 
   CityOffset  = 0
   StateOffset = 1
@@ -45,13 +45,17 @@ module PostalCode
   end
 
   # 
-  # * All postal code parameters must be strings.
-  # * Postal codes are not calculable, therefore should not be numeric.
-  # * A postal code with a leading zero would be an octal. However, *08880* is
-  #   an invalid octal numeric, yet a valid postal code.
+  # Postal codes must be strings because:
+  # 1. Postal codes are not calculable, therefore should not be numeric.
+  # 2. A postal code with a leading zero would be an octal. However, *08880* is
+  #    an invalid octal numeric, yet a valid postal code.
   #
   def self.valid_format? postal_code
-    postal_code =~ /^\d{5}(-\d{4})?$/
+    unless postal_code.is_a? String
+      raise(TypeError, "postal code must be a string")
+    end
+
+    (postal_code =~ /^\d{5}(-\d{4})?$/) ? true : false
   end
 
   #
@@ -74,6 +78,6 @@ module PostalCode
     end
   end
 
-  private_class_method :fetch, :valid_format?
+  private_class_method :fetch
 
 end

data/test/test_postal_code.rb

@@ -1,7 +1,7 @@
 require 'minitest/autorun'
 require 'postal_code'
 
-class PostalCodeTest < Minitest::Unit::TestCase
+class PostalCodeTest < Minitest::Test
 
   ProductionDB = PostalCode::DB.dup
   TestDB = File.dirname(__FILE__) + '/data/US.tsv'
@@ -72,15 +72,22 @@ class PostalCodeTest < Minitest::Unit::TestCase
   end
 
   def test_postal_code_validations
-    refute PostalCode.send(:valid_format?, '99999').nil?
-    refute PostalCode.send(:valid_format?, '00001').nil?
-    refute PostalCode.send(:valid_format?, '00001-1234').nil?
-    assert PostalCode.send(:valid_format?, '00001-123').nil?
-    assert PostalCode.send(:valid_format?, '00001-').nil?
-    assert PostalCode.send(:valid_format?, 99999).nil?
-    assert PostalCode.send(:valid_format?, 00001).nil?
-    assert PostalCode.send(:valid_format?, '1').nil?
-    assert PostalCode.send(:valid_format?, 1).nil?
+    assert PostalCode.valid_format?('01234-1234')
+    refute PostalCode.valid_format?('01234-123')
+    refute PostalCode.valid_format?('01234-12')
+    refute PostalCode.valid_format?('01234-1')
+    refute PostalCode.valid_format?('01234-')
+    assert PostalCode.valid_format?('01234')
+    refute PostalCode.valid_format?('0123')
+    refute PostalCode.valid_format?('012')
+    refute PostalCode.valid_format?('01')
+    refute PostalCode.valid_format?('0')
+  end
+
+  def test_postal_code_validation_exceptions
+    assert_raises(TypeError) { PostalCode.valid_format? 99999 }
+    assert_raises(TypeError) { PostalCode.valid_format? 00001 }
+    assert_raises(TypeError) { PostalCode.valid_format? 1 }
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postal_code
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Clint Pachl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-05 00:00:00.000000000 Z
+date: 2020-02-19 00:00:00.000000000 Z
 dependencies: []
 description: Resolve a postal (ZIP) code to a corresponding city or state.
 email: pachl@ecentryx.com
@@ -48,8 +48,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Postal (ZIP) Code Resolver