census_api 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1e42362ccc80926634c273b9a7a1eb5372226b0
-  data.tar.gz: 82964eda9cfe6f7d764f96575882c57e41133e2f
+  metadata.gz: 642511253be7aea4c68837c8cc2c769a866a27fa
+  data.tar.gz: 072c04b497dafce02b299a697f9d1f0546a164a2
 SHA512:
-  metadata.gz: 982d9a504da1de9f2254dc0eb2116e647228a6c1447564fb3e9c101b0e601a0bdf6dbcebf9bd8efac888a0b3ea60fc08a7c020bbd70835e3336cc4f2b6529935
-  data.tar.gz: 7493ed0eb2d8a301ed7032321c15d0833600e6325425dfc8e8c392b7eefdcf5899cf3e3874438c595b0d49b4156367dc960a49589143fe2313ed218da1a79b75
+  metadata.gz: f44224cf3a16e0ebe6892b08eb9b8253753850d936cfeb724098c7e7bc7930d465d750cd159275f8d05fd23409d390a09a0f1400fa67d07b19a71a170eecc537
+  data.tar.gz: 274f4ed8b1af0caa138d1d892f6ae697f43e360a86e5732712f08fb6f51c605bd725560c90a3a855f6556cf87fe0536ba28e65fc6a53df6edcc68e8217bec678

data/README.md

@@ -54,10 +54,17 @@ To query the 2006-2010 ACS5 dataset, set the dataset to 'ACS5':
 @client.dataset = 'ACS5' # or after initialization, setting the instance variable
 ```
 
-Then, use `Client#find` with the below parameters to query for Census data. For example:
+Then, use `Client#where` with an options hash to query for Census data. The fields and level parameters are required. The within parameter is optional and scopes the query. For example:
 
 ```ruby
-@client.find('P0010001', 'STATE:02,06')
+@client.where({ fields: 'P0010001', level: 'COUNTY:001', within: ['STATE:06'] })
+
+```
+
+The `Client.find` method which takes positional arguments is still available, but deprecated.
+
+```ruby
+@client.find('P0010001', 'COUNTY:001', ['STATE:06'])
 
 ```
 
@@ -67,15 +74,15 @@ For a list of the fields available for each dataset, review the reference PDFs l
 
 The 'fields' parameter is a comma separated string of SF1 field names.
 
-The 'for' parameter is a single geography type, and optionally, the geography ids (geoid) for specific geographies of that type. A colon separates the geography type from the id and a comma separates ids.
+The 'level' parameter is a single geography type, and optionally, the geography ids (geoid) for specific geographies of that type. A colon separates the geography type from the id and a comma separates ids.
 
 For example, 'STATE:06,02' would reference the state of California and Alaska.
 
-The 'in' parameter is a set of geography types or geography. Similar to the 'for' parameter, a colon separates the geography type from the id and a comma separates ids. Sets of geography are separated by a plus symbol.
+The 'within' parameter is a set of geography types or geography. Similar to the 'level' parameter, a colon separates the geography type from the id and a comma separates ids. Sets of geography are separated by a plus symbol.
 
 For example, 'STATE:02+COUNTY:290' would reference the 'Yukon-Koyukuk Census Area' County in the state of Alaska.
 
-The 'in' parameter is optional, or required, depending upon the geography type. The smaller the geography type being required, the more the request must be restricted by the 'in' parameter.
+The 'within' parameter is optional, or required, depending upon the geography type. The smaller the geography type being required, the more the request must be restricted by the 'within' parameter.
 
 ## Census 2010 SF1 Examples and Supported Geography
 
@@ -83,39 +90,39 @@ The 'in' parameter is optional, or required, depending upon the geography type.
 
 Retrieve fields for all States:
 
-`@client.find('P0010001', 'STATE')`
+`@client.where({ fields: 'P0010001', level: 'STATE' })`
 
 Retrieve fields for California (geoid: 06):
 
-`@client.find('P0010001', 'STATE:06')`
+`@client.where({ fields: 'P0010001', level: 'STATE:06' })`
 
 Retrieve fields for California and Alaska:
 
-`@client.find('P0010001', 'STATE:06,02')`
+`@client.where({ fields: 'P0010001', level: 'STATE:06,02' })`
 
 #### COUNTY - *(050) state-county*
 
 Retrieve fields for all Counties:
 
-`@client.find('P0010001', 'COUNTY')`
+`@client.where({ fields: 'P0010001', level: 'COUNTY' })`
 
 Retrieve fields for Counties in California:
 
-`@client.find('P0010001', 'COUNTY', 'STATE:06')`
+`@client.where({ fields: 'P0010001', level: 'COUNTY', within: 'STATE:06' })`
 
 Retrieve fields for a specific County in California:
 
-`@client.find('P0010001', 'COUNTY:001', 'STATE:06')`
+`@client.where({ fields: 'P0010001', level: 'COUNTY:001', within: 'STATE:06' })`
 
 #### COUSUB - *(060) state-county-county subdivision*
 
 Retrieve fields for all County Subdivisions within a specific County:
 
-`@client.find('P0010001', 'COUSUB', 'STATE:02+COUNTY:290')`
+`@client.where({ fields: 'P0010001', level: 'COUSUB', within: 'STATE:02+COUNTY:290' })`
 
 Retrieve fields for a specific County Subdivision within a specific County:
 
-`@client.find('P0010001', 'COUSUB:86690', 'STATE:02+COUNTY:290')`
+`@client.where({ fields: 'P0010001', level: 'COUSUB:86690', within: 'STATE:02+COUNTY:290' })`
 
 Note: You must also specify the State the County belongs to.
 
@@ -123,231 +130,231 @@ Note: You must also specify the State the County belongs to.
 
 Retrieve fields for all Subminor Civil Subdivisions within a specific County Subdivision:
 
-`@client.find('P0010001', 'SUBMCD', 'STATE:72+COUNTY:127+COUSUB:79693')`
+`@client.where({ fields: 'P0010001', level: 'SUBMCD', within: 'STATE:72+COUNTY:127+COUSUB:79693' })`
 
 Retrieve fields for a specific Subminor Civil Subdivisions within a specific County Subdivision:
 
-`@client.find('P0010001', 'SUBMCD:02350', 'STATE:72+COUNTY:127+COUSUB:79693')`
+`@client.where({ fields: 'P0010001', level: 'SUBMCD:02350', within: 'STATE:72+COUNTY:127+COUSUB:79693' })`
 
 #### TABBLOCK - *(101) state-county-tract-block*
 
 Retrieve fields for all Blocks within a specific Tract
 
-`@client.find('P0010001', 'TABBLOCK', 'STATE:02+COUNTY:290+TRACT:00100')`
+`@client.where({ fields: 'P0010001', level: 'TABBLOCK', within: 'STATE:02+COUNTY:290+TRACT:00100' })`
 
 Retrieve fields for a specific Subminor Civil Subdivisions within a specific County Subdivision:
 
-`@client.find('P0010001', 'SUBMCD:02350', 'STATE:72+COUNTY:127+COUSUB:79693')`
+`@client.where({ fields: 'P0010001', level: 'SUBMCD:02350', within: 'STATE:72+COUNTY:127+COUSUB:79693' })`
 
 #### TRACT - *(140) state-county-tract*
 
 Retrieve fields for all Tracts within a specific County:
 
-`@client.find('P0010001', 'TRACT', 'STATE:02+COUNTY:170')`
+`@client.where({ fields: 'P0010001', level: 'TRACT', within: 'STATE:02+COUNTY:170' })`
 
 Retrieve fields for a specific Tract within a specific County:
 
-`@client.find('P0010001', 'TRACT:000101', 'STATE:02+COUNTY:170')`
+`@client.where({ fields: 'P0010001', level: 'TRACT:000101', within: 'STATE:02+COUNTY:170' })`
 
 #### BG - *(150) state-county- tract-block group*
 
 Retrieve fields for all Block Groups within a specific Tract:
 
-`@client.find('P0010001', 'BG', 'STATE:02+COUNTY:170+TRACT:000101')`
+`@client.where({ fields: 'P0010001', level: 'BG', within: 'STATE:02+COUNTY:170+TRACT:000101' })`
 
 Retrieve fields for a specific Block Group within a specific Tract:
 
-`@client.find('P0010001', 'BG:1', 'STATE:02+COUNTY:170+TRACT:000101')`
+`@client.where({ fields: 'P0010001', level: 'BG:1', within: 'STATE:02+COUNTY:170+TRACT:000101' })`
 
 #### PLACE -*(160) state-place*
 
 Retrieve fields for all Places:
 
-`@client.find('P0010001', 'PLACE')`
+`@client.where({ fields: 'P0010001', level: 'PLACE' })`
 
 Retrieve fields for all Places within a specific State:
 
-`@client.find('P0010001', 'PLACE', 'STATE:06')`
+`@client.where({ fields: 'P0010001', level: 'PLACE', within: 'STATE:06' })`
 
 Retrieve fields for a specific place within a specific State:
 
-`@client.find('P0010001', 'PLACE:00135', 'STATE:06')`
+`@client.where({ fields: 'P0010001', level: 'PLACE:00135', within: 'STATE:06' })`
 
 #### ANRC - *(260) state-alaska native regional corporation*
 
 Retrieve fields for all Alaska Native Regional Corporations:
 
-`@client.find('P0010001', 'ANRC')`
+`@client.where({ fields: 'P0010001', level: 'ANRC' })`
 
 Retrieve fields for all Alaska Native Regional Corporations within a specific State:
 
-`@client.find('P0010001', 'ANRC', 'STATE:02')`
+`@client.where({ fields: 'P0010001', level: 'ANRC', within: 'STATE:02' })`
 
 Retrieve fields for all Alaska Native Regional Corporations within a specific State:
 
-`@client.find('P0010001', 'ANRC:00590', 'STATE:02')`
+`@client.where({ fields: 'P0010001', level: 'ANRC:00590', within: 'STATE:02' })`
 
 #### AIANNH - *(280) state-american indian area/alaska native area/hawaiian home land*
 
 Retrieve fields for all American Indian Area/Alaska Native Area/Hawaiian Home Land:
 
-`@client.find('P0010001', 'AIANNH')`
+`@client.where({ fields: 'P0010001', level: 'AIANNH' })`
 
 Retrieve fields for all American Indian Area/Alaska Native Area/Hawaiian Home Land within a specific State:
 
-`@client.find('P0010001', 'AIANNH', 'STATE:02')`
+`@client.where({ fields: 'P0010001', level: 'AIANNH', within: 'STATE:02 }')`
 
 Retrieve fields for a specific American Indian Area/Alaska Native Area/Hawaiian Home Land within a specific State:
 
-`@client.find('P0010001', 'AIANNH:03800', 'STATE:02')`
+`@client.where({ fields: 'P0010001', level: 'AIANNH:03800', within: 'STATE:02' })`
 
 #### AITS - *(281) state-american indian area-tribal subdivision*
 
 Retrieve fields for all American Indian Area-Tribal Subdivisions:
 
-__DOES NOT WORK__: `@client.find('P0010001', 'AITS')` 
+__DOES NOT WORK__: `@client.where({ fields: 'P0010001', level: 'AITS' })`
 
 Retrieve fields for all American Indian Area-Tribal Subdivisions in a specific American Indian Area:
 
-`@client.find('P0010001', 'AITS', 'STATE:40+AIANNH:13735')`
+`@client.where({ fields: 'P0010001', level: 'AITS', within: 'STATE:40+AIANNH:13735' })`
 
 Retrieve fields for a specific American Indian Area-Tribal Subdivision in a specific American Indian Area:
 
-`@client.find('P0010001', 'AITS:83127', 'STATE:40+AIANNH:13735')`
+`@client.where({ fields: 'P0010001', level: 'AITS:83127', within: 'STATE:40+AIANNH:13735' })`
 
 #### CBSA - *(320) state-metropolitan statistical area/micropolitan statistical area*
 
 Retrieve fields from all Metropolitan Statistical Areas / Micropolitan Statistical Areas in a specific State:
 
-`@client.find('P0010001', 'CBSA', 'STATE:02')`
+`@client.where({ fields: 'P0010001', level: 'CBSA', within: 'STATE:02' })`
 
 Retrieve fields from a specific Metropolitan Statistical Areas / Micropolitan Statistical Areas in a specific State:
 
-`@client.find('P0010001', 'CBSA:11260', 'STATE:02')`
+`@client.where({ fields: 'P0010001', level: 'CBSA:11260', within: 'STATE:02' })`
 
 #### METDIV - *(323)  state-metropolitan statistical area/micropolitan statistical area- metropolitan division*
 
 Retrieve fields from all Metropolitan Divisions in a specific Metropolitan Statistical Area / Micropolitan Statistical Area:
 
-`@client.find('P0010001', 'METDIV', 'STATE:06+CBSA:31100')`
+`@client.where({ fields: 'P0010001', level: 'METDIV', within: 'STATE:06+CBSA:31100' })`
 
 Retrieve fields from all Metropolitan Division in a specific Metropolitan Statistical Area / Micropolitan Statistical Area:
 
-`@client.find('P0010001', 'METDIV', 'STATE:06+CBSA:31100')`
+`@client.where({ fields: 'P0010001', level: 'METDIV', within: 'STATE:06+CBSA:31100' })`
 
 Retrieve fields from a specific Metropolitan Division in a specific Metropolitan Statistical Area / Micropolitan Statistical Area:
 
-`@client.find('P0010001', 'METDIV:31084', 'STATE:06+CBSA:31100')`
+`@client.where({ fields: 'P0010001', level: 'METDIV:31084', within: 'STATE:06+CBSA:31100' })`
 
 #### CSA - *(340) - state-combined statistical area*
 
 Retrieve fields from all Combined Statistical Areas in a specific State:
 
-`@client.find('P0010001', 'CSA', 'STATE:24')`
+`@client.where({ fields: 'P0010001', level: 'CSA', within: 'STATE:24' })`
 
 Retrieve fields from a specific Combined Statistical Area in a specific State:
 
-`@client.find('P0010001', 'CSA:428', 'STATE:24')`
+`@client.where({ fields: 'P0010001', level: 'CSA:428', within: 'STATE:24' })`
 
 #### CD - *(500) state-congressional district*
 
 Retrieve fields from all Congressional Districts in a specific State:
 
-`@client.find('P0010001', 'CD', 'STATE:24')`
+`@client.where({ fields: 'P0010001', level: 'CD', within: 'STATE:24' })`
 
 Retrieve fields from a specific Congressional District in a specific State:
 
-`@client.find('P0010001', 'CD:01', 'STATE:24')`
+`@client.where({ fields: 'P0010001', level: 'CD:01', within: 'STATE:24' })`
 
 #### COUNTY (Remainder) - *(510) state-congressional district-county*
 
 Retrieve fields for all Counties within a specific Congressional District:
 
-`@client.find('P0010001', 'COUNTY', 'STATE:24+CD:01')`
+`@client.where({ fields: 'P0010001', level: 'COUNTY', within: 'STATE:24+CD:01' })`
 
 Retrieve fields for a specific County within a specific Congressional District:
 
-`@client.find('P0010001', 'COUNTY:01', 'STATE:24+CD:01')`
+`@client.where({ fields: 'P0010001', level: 'COUNTY:01', within: 'STATE:24+CD:01' })`
 
 #### TRACT (Remainder) - *(511) state-congressional district-county-tract*
 
 Retrieve fields for all Tracts within a specific Congressional District, County Remainder:
 
-`@client.find('P0010001', 'TRACT', 'STATE:24+CD:01+COUNTY:003')`
+`@client.where({ fields: 'P0010001', level: 'TRACT', within: 'STATE:24+CD:01+COUNTY:003' })`
 
 Retrieve fields for a specific County within a specific Congressional District, County Remainder:
 
-`@client.find('P0010001', 'TRACT:702100', 'STATE:24+CD:01+COUNTY:003')`
+`@client.where({ fields: 'P0010001', level: 'TRACT:702100', within: 'STATE:24+CD:01+COUNTY:003' })`
 
 ### COUSUB (Remainder) - *(521) state-congressional district-county-county subdivision*
 
 Retrieve fields for all County Subdivisions within a specific Congressional District, County Remainder:
 
-`@client.find('P0010001', 'COUSUB', 'STATE:24+CD:01+COUNTY:003')`
+`@client.where({ fields: 'P0010001', level: 'COUSUB', within: 'STATE:24+CD:01+COUNTY:003' })`
 
 Retrieve fields for a specific County Subdivision within a specific Congressional District, County Remainder:
 
-`@client.find('P0010001', 'COUSUB:90100', 'STATE:24+CD:01+COUNTY:003')`
+`@client.where({ fields: 'P0010001', level: 'COUSUB:90100', within: 'STATE:24+CD:01+COUNTY:003' })`
 
 #### PLACE (Remainder) - *(531) state congressional district-place*
 
 Retrieve fields for all Places within a specific Congressional District:
 
-`@client.find('P0010001', 'PLACE', 'STATE:24+CD:01')`
+`@client.where({ fields: 'P0010001', level: 'PLACE', within: 'STATE:24+CD:01' })`
 
 Retrieve fields for a specific Place within a specific Congressional District, County Remainder:
 
-`@client.find('P0010001', 'PLACE:00125', 'STATE:24+CD:01')`
+`@client.where({ fields: 'P0010001', level: 'PLACE:00125', within: 'STATE:24+CD:01' })`
 
 #### AIANNH (Remainder) - *550) state-congressional district-american indian area/alaska native area/hawaiian home land*
 
 Retrieve fields for all American Indian Area/Alaska Native Area/Hawaiian Home Lands within a specific Congressional District:
 
-`@client.find('P0010001', 'AIANNH', 'STATE:02+CD:00')`
+`@client.where({ fields: 'P0010001', level: 'AIANNH', within: 'STATE:02+CD:00' })`
 
 Retrieve fields for a specific American Indian Area/Alaska Native Area/Hawaiian Home Land  within a specific Congressional District:
 
-`@client.find('P0010001', 'AIANNH:03800', 'STATE:02+CD:00')`
+`@client.where({ fields: 'P0010001', level: 'AIANNH:03800', within: 'STATE:02+CD:00' })`
 
 #### ANRC (Remainder) - *(560) state-congressional district-alaska native regional corporation*
 
 Retrieve fields for all Alaska Native Regional Corporations within a specific Congressional District:
 
-`@client.find('P0010001', 'AIANNH', 'STATE:02+CD:00')`
+`@client.where({ fields: 'P0010001', level: 'AIANNH', within: 'STATE:02+CD:00' })`
 
 Retrieve fields for a specific Alaska Native Regional Corporation  within a specific Congressional District:
 
-`@client.find('P0010001', 'AIANNH:00590', 'STATE:02+CD:00')`
+`@client.where({ fields: 'P0010001', level: 'AIANNH:00590', within: 'STATE:02+CD:00' })`
 
 #### SLDU - *(610) state-state legislative district (upper chamber)*
 
 Retrieve fields for all State Legislative Districts (Upper Chamber) within a State:
 
-`@client.find('P0010001', 'SLDU', 'STATE:02')`
+`@client.where({ fields: 'P0010001', level: 'SLDU', within: 'STATE:02' })`
 
 Retrieve fields for a specific State Legislative District (Upper Chamber) within a State:
 
-`@client.find('P0010001', 'SLDU:00A', 'STATE:02')`
+`@client.where({ fields: 'P0010001', level: 'SLDU:00A', within: 'STATE:02' })`
 
 #### SLDU - *(620) state-state legislative district (lower chamber)*
 
 Retrieve fields for all State Legislative Districts (Lower Chamber) within a State:
 
-`@client.find('P0010001', 'SLDL', 'STATE:02')`
+`@client.where({ fields: 'P0010001', level: 'SLDL', within: 'STATE:02' })`
 
 Retrieve fields for a specific State Legislative District (Lower Chamber) within a State:
 
-`@client.find('P0010001', 'SLDL:001', 'STATE:02')`
+`@client.where({ fields: 'P0010001', level: 'SLDL:001', within: 'STATE:02' })`
 
 #### ZCTA5 - *(871) state-zip code tabulation area*
 
 Retrieve fields for all Zip Code Tabulation Areas within a specific State:
 
-`@client.find('P0010001', 'ZCTA5', 'STATE:02')`
+`@client.where({ fields: 'P0010001', level: 'ZCTA5', within: 'STATE:02' })`
 
 Retrieve fields for a specific Zip Code Tabulation Area within a specific State:
 
-`@client.find('P0010001', 'ZCTA5:99501', 'STATE:02')`
+`@client.where({ fields: 'P0010001', level: 'ZCTA5:99501', within: 'STATE:02' })`
 
 ## ACS5 2010 Examples and Supported Geography
 
@@ -357,39 +364,39 @@ Querying the Census Bureau for ACS5 data is done in the same format as querying
 
 Retrieve fields for all States:
 
-`@client.find('B00001_001E', 'STATE')`
+`@client.where({ fields: 'B00001_001E', level: 'STATE' })`
 
 Retrieve fields for California (geoid: 06):
 
-`@client.find('B00001_001E', 'STATE:06')`
+`@client.where({ fields: 'B00001_001E', level: 'STATE:06' })`
 
 Retrieve fields for California and Alaska:
 
-`@client.find('B00001_001E', 'STATE:06,02')`
+`@client.where({ fields: 'B00001_001E', level: 'STATE:06,02' })`
 
 #### COUNTY - *(050) state-county*
 
 Retrieve fields for all Counties:
 
-`@client.find('B00001_001E', 'COUNTY')`
+`@client.where({ fields: 'B00001_001E', level: 'COUNTY' })`
 
 Retrieve fields for Counties in California:
 
-`@client.find('B00001_001E', 'COUNTY', 'STATE:06')`
+`@client.where({ fields: 'B00001_001E', level: 'COUNTY', within: 'STATE:06' })`
 
 Retrieve fields for a specific County in California:
 
-`@client.find('B00001_001E', 'COUNTY:001', 'STATE:06')`
+`@client.where({ fields: 'B00001_001E', level: 'COUNTY:001', within: 'STATE:06' })`
 
 #### COUSUB - *(060) state-county-county subdivision*
 
 Retrieve fields for all County Subdivisions within a specific County:
 
-`@client.find('B00001_001E', 'COUSUB', 'STATE:02+COUNTY:290')`
+`@client.where({ fields: 'B00001_001E', level: 'COUSUB', within: 'STATE:02+COUNTY:290' })`
 
 Retrieve fields for a specific County Subdivision within a specific County:
 
-`@client.find('B00001_001E', 'COUSUB:86690', 'STATE:02+COUNTY:290')`
+`@client.where({ fields: 'B00001_001E', level: 'COUSUB:86690', within: 'STATE:02+COUNTY:290' })`
 
 Note: You must also specify the State the County belongs to.
 
@@ -397,89 +404,89 @@ Note: You must also specify the State the County belongs to.
 
 Retrieve fields for all Subminor Civil Subdivisions within a specific County Subdivision:
 
-`@client.find('B00001_001E', 'SUBMCD', 'STATE:72+COUNTY:127+COUSUB:79693')`
+`@client.where({ fields: 'B00001_001E', level: 'SUBMCD', within: 'STATE:72+COUNTY:127+COUSUB:79693' })`
 
 Retrieve fields for a specific Subminor Civil Subdivision within a specific County Subdivision:
 
-`@client.find('B00001_001E', 'SUBMCD:02350', 'STATE:72+COUNTY:127+COUSUB:79693')`
+`@client.where({ fields: 'B00001_001E', level: 'SUBMCD:02350', within: 'STATE:72+COUNTY:127+COUSUB:79693' })`
 
 #### PLACE - *(070) state-county-county subdivision-place*
 
 Retrieve fields for all Places within a specific County Subdivision:
 
-`@client.find('B00001_001E', 'PLACE', 'STATE:02+COUNTY:290+COUSUB:86690')`
+`@client.where({ fields: 'B00001_001E', level: 'PLACE', within: 'STATE:02+COUNTY:290+COUSUB:86690' })`
 
 Retrieve fields for a specific Place within a specific County Subdivision:
 
-`@client.find('B00001_001E', 'PLACE:05750', 'STATE:02+COUNTY:290+COUSUB:86690')`
+`@client.where({ fields: 'B00001_001E', level: 'PLACE:05750', within: 'STATE:02+COUNTY:290+COUSUB:86690' })`
 
 #### TRACT - *(080) state-county-county subdivision-place-tract*
 
 Retrieve fields for all Tracts within a specific Place:
 
-`@client.find('B00001_001E', 'TRACT', 'STATE:02+COUNTY:290+COUSUB:86690+PLACE:05750')`
+`@client.where({ fields: 'B00001_001E', level: 'TRACT', within: 'STATE:02+COUNTY:290+COUSUB:86690+PLACE:05750' })`
 
 Retrieve fields for a specific Tract within a specific Place:
 
-`@client.find('B00001_001E', 'TRACT:000100', 'STATE:02+COUNTY:290+COUSUB:86690+PLACE:05750')`
+`@client.where({ fields: 'B00001_001E', level: 'TRACT:000100', within: 'STATE:02+COUNTY:290+COUSUB:86690+PLACE:05750' })`
 
 #### TRACT - *(140) state-county-tract*
 
 Retrieve fields for all Tracts within a specific County:
 
-`@client.find('B00001_001E', 'TRACT', 'STATE:02+COUNTY:170')`
+`@client.where({ fields: 'B00001_001E', level: 'TRACT', within: 'STATE:02+COUNTY:170' })`
 
 Retrieve fields for a specific Tract within a specific County:
 
-`@client.find('B00001_001E', 'TRACT:000101', 'STATE:02+COUNTY:170')`
+`@client.where({ fields: 'B00001_001E', level: 'TRACT:000101', within: 'STATE:02+COUNTY:170' })`
 
 #### BG - *(150) state-county- tract-block group*
 
 Retrieve fields for all Block Groups within a specific Tract:
 
-`@client.find('B00001_001E', 'BG', 'STATE:02+COUNTY:170+TRACT:000101')`
+`@client.where({ fields: 'B00001_001E', level: 'BG', within: 'STATE:02+COUNTY:170+TRACT:000101' })`
 
 Retrieve fields for a specific Block Group within a specific Tract:
 
-`@client.find('B00001_001E', 'BG:1', 'STATE:02+COUNTY:170+TRACT:000101')`
+`@client.where({ fields: 'B00001_001E', level: 'BG:1', within: 'STATE:02+COUNTY:170+TRACT:000101' })`
 
 #### PLACE - *(160) state-place*
 
 Retrieve fields for all Places:
 
-`@client.find('B00001_001E', 'PLACE')`
+`@client.where({ fields: 'B00001_001E', level: 'PLACE' })`
 
 Retrieve fields for all Places within a specific State:
 
-`@client.find('B00001_001E', 'PLACE', 'STATE:06')`
+`@client.where({ fields: 'B00001_001E', level: 'PLACE', within: 'STATE:06' })`
 
 Retrieve fields for a specific place within a specific State:
 
-`@client.find('B00001_001E', 'PLACE:00135', 'STATE:06')`
+`@client.where({ fields: 'B00001_001E', level: 'PLACE:00135', within: 'STATE:06' })`
 
 #### AIANNH - *(280) state-american indian area/alaska native area/hawaiian home land*
 
 Retrieve fields for all American Indian Area/Alaska Native Area/Hawaiian Home Land:
 
-`@client.find('B00001_001E', 'AIANNH')`
+`@client.where({ fields: 'B00001_001E', level: 'AIANNH' })`
 
 Retrieve fields for all American Indian Area/Alaska Native Area/Hawaiian Home Land within a specific State:
 
-`@client.find('B00001_001E', 'AIANNH', 'STATE:02')`
+`@client.where({ fields: 'B00001_001E', level: 'AIANNH', within: 'STATE:02' })`
 
 Retrieve fields for a specific American Indian Area/Alaska Native Area/Hawaiian Home Land within a specific State:
 
-`@client.find('B00001_001E', 'AIANNH:03800', 'STATE:02')`
+`@client.where({ fields: 'B00001_001E', level: 'AIANNH:03800', within: 'STATE:02' })`
 
 #### CD - *(500) state-congressional district*
 
 Retrieve fields from all Congressional Districts in a specific State:
 
-`@client.find('B00001_001E', 'CD', 'STATE:24')`
+`@client.where({ fields: 'B00001_001E', level: 'CD', within: 'STATE:24' })`
 
 Retrieve fields from a specific Congressional District in a specific State:
 
-`@client.find('B00001_001E', 'CD:01', 'STATE:24')`
+`@client.where({ fields: 'B00001_001E', level: 'CD:01', within: 'STATE:24' })`
 
 ## Additional Resources
 

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/census_api.gemspec

@@ -4,23 +4,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'census_api/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "census_api"
+  gem.name          = 'census_api'
   gem.version       = CensusApi::VERSION
-  gem.authors       = ["Ty Rauber"]
+  gem.authors       = ['Ty Rauber']
   gem.license       = 'MIT'
-  gem.email         = ["tyrauber@mac.com"]
-  gem.description   = %q{A Ruby Gem for querying the US Census Bureau API}
-  gem.summary       = %q{A Ruby Wrapper for the US Census Bureau API, providing the ability to query both the 2010 Census and 2006-2010 ACS5 datasets.}
-  gem.homepage      = "https://github.com/tyrauber/census_api.git"
+  gem.email         = ['tyrauber@mac.com']
+  gem.description   = 'A Ruby Gem for querying the US Census Bureau API'
+  gem.summary       = 'A Ruby Wrapper for the US Census Bureau API,
+                      providing the ability to query both the 2010 Census
+                      and 2006-2010 ACS5 datasets.'
+  gem.homepage      = 'https://github.com/tyrauber/census_api.git'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-  
-  gem.add_runtime_dependency "rest-client"
-  gem.add_runtime_dependency "hpricot"
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n")
+                      .map { |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'rest-client'
+  gem.add_runtime_dependency 'addressable', '~> 2.3'
+  gem.add_runtime_dependency 'hpricot'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'fakeweb'
   gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'rubocop'
 end

data/lib/census_api/client.rb

@@ -1,33 +1,59 @@
 module CensusApi
+  # => CensusApi::Client
+  # client#initialize method takes an api_key and options hash,
+  # which includes dataset and vintage. client#where method accepts
+  # an options hash, including fields, level and within. Within is optional.
+  # client#find takes positional arguments and is now deprecated.
   class Client
     require 'rest-client'
 
-    attr_reader   :api_key, :api_vintage, :options
+    attr_reader :api_key, :api_vintage, :options
     attr_accessor :dataset
 
-    DATASETS = %w( sf1 acs1 acs3 acs5 ) # can add more datasets as support becomes available
+    DATASETS = %w( sf1 acs1 acs3 acs5 )
+    # can add more datasets as support becomes available
 
     def initialize(api_key, options = {})
-      raise ArgumentError, "You must set an api_key." unless api_key
-
-      # Use RestClient directly to determine the validity of the API Key
-      path = "http://api.census.gov/data/2010/sf1?key=#{api_key}&get=P0010001&for=state:01"
-      response = RestClient.get(path)
-
-      if response.body.include? "Invalid Key"
-        raise "'#{api_key}' is not a valid API key. Check your key for errors, or request a new one at census.gov."
-      end
-
+      fail ArgumentError, 'You must set an api_key.' unless api_key
+      validate_api_key(api_key)
       @api_key = api_key
       @api_vintage = options[:vintage] || 2010
-      if options[:dataset]
-        @dataset = options[:dataset].downcase if DATASETS.include? options[:dataset].downcase
+      if options[:dataset] && DATASETS.include?(options[:dataset].downcase)
+        @dataset = options[:dataset].downcase
       end
     end
 
     def find(fields, level, *within)
-      raise "Client has not been assigned a dataset to query. Try @client.dataset = 'SF1' or anything from #{DATASETS}" if self.dataset.nil?
-      Request.find(dataset, {key: @api_key,  vintage: @api_vintage, fields: fields, level: level, within: within})
+      warn '[DEPRECATION] `find` is deprecated. Please use `where` instead.'
+      fail "Client requires a dataset (#{DATASETS})." if @dataset.nil?
+      options = {
+        key: @api_key,
+        vintage: @api_vintage,
+        fields: fields,
+        level: level,
+        within: within
+      }
+      Request.find(dataset, options)
+    end
+
+    def where(options = { key: @api_key,  vintage: @api_vintage })
+      fail "Client requires a dataset (#{DATASETS})." if @dataset.nil?
+      [:fields, :level].each do |f|
+        fail ArgumentError, "#{f} is a requied parameter" if options[f].nil?
+      end
+      Request.find(dataset, options)
+    end
+
+    protected
+
+    def validate_api_key(api_key)
+      uri = Addressable::URI.parse('http://api.census.gov/data/2010/sf1')
+      uri.query_values = { key: api_key, get: 'P0010001', for: 'state:01' }
+      response = RestClient.get uri.to_s
+      if response.body.include? 'Invalid Key'
+        fail "'#{api_key}' is not a valid API key. Check your key for errors,
+        or request a new one at census.gov."
+      end
     end
   end
 end

data/lib/census_api/request.rb

@@ -1,78 +1,83 @@
 module CensusApi
+  # => CensusApi::Request
+  # client#initialize method takes an url, vintage, source, options hash.
+  # client#find method accepts source and options hash, which include
+  # :key, :fields, :level, :within and :vintage.
   class Request
-    
     require 'restclient'
     require 'hpricot'
     require 'json'
-    require "yaml"
-    
+    require 'yaml'
+
     attr_accessor :response
-    
-    @@census_shapes
-    
-    CENSUS_URL = "http://api.census.gov/data"
+
+    CENSUS_URL = 'http://api.census.gov/data'
 
     def initialize(url, vintage, source, options)
-      path = "#{url}/#{vintage}/#{source}?#{options.to_params}"
-      @response = RestClient.get(path) do |response, request, result, &block|
+      uri = Addressable::URI.parse("#{url}/#{vintage}/#{source}")
+      uri.query_values = options
+      @response = RestClient.get(uri.to_s) do |response, _req, _res, _blk|
         response
       end
-      return @response
     end
 
-
     def self.find(source, options = {})
       fields = options[:fields]
-      fields = fields.split(",").push("NAME").join(",") if fields.kind_of? String
-      fields = fields.push("NAME").join(",") if fields.kind_of? Array
-      params = { :key => options[:key], :get => fields, :for => format(options[:level],false) }
-      params.merge!({ :in => format(options[:within][0],true) }) if !options[:within].empty?
-      options.merge!({ :vintage => 2010 }) unless options[:vintage]
+      fields = fields.split(',').push('NAME').join(',') if fields.is_a? String
+      fields = fields.push('NAME').join(',') if fields.is_a? Array
+      level  = format(options[:level], false)
+      params = { key: options[:key], get: fields, for: level }
+      params.merge!(in: format(options[:within][0], true)) unless options[:within].empty?
+      options.merge!(vintage: 2010) unless options[:vintage]
       request = new(CENSUS_URL, options[:vintage], source, params)
       request.parse_response
     end
 
-    
     def parse_response
       case @response.code
-        when 200
-          response = JSON.parse(@response)
-          header = response.delete_at(0)
-          return response.map{|r| Hash[header.map{|h| h.gsub("NAME","name")}.zip(r)]}
-        else
-          return {:code => @response.code, :message=> "Invalid API key or request", :location=> @response.headers[:location], :body => @response.body}
-        end
+      when 200
+        response_success(@response)
+      else
+        response_error(@response)
+      end
     end
-    
+
     protected
-  
-      def self.format(str,truncate)
-        result = str.split("+").map{|s|
-          if s.match(":")
-            s = s.split(":")
-          else 
-            s = [s,"*"]
-          end
-          shp = shapes[s[0].upcase]
-          s.shift && s.unshift(shp['name'].downcase.gsub(" ", "+")) if !shp.nil?
-          s.unshift(s.shift.split("/")[0]) if !s[0].scan("home+land").empty? && truncate
-          s.join(":")
-        }
-        return result.join("+")
-      end 
-      
-      def self.shapes
-        return  @@census_shapes if defined?( @@census_shapes)
-        @@census_shapes = {} 
-        YAML.load_file(File.dirname(__FILE__).to_s + '/../yml/census_shapes.yml').each{|k,v| @@census_shapes[k] = v}
-        return @@census_shapes
+
+    def response_success(response)
+      response = JSON.parse(response)
+      header = response.delete_at(0)
+      response.map do |r|
+        Hash[header.map { |h| h.gsub('NAME', 'name') }.zip(r)]
       end
-      
     end
-  end
 
-class Hash
-   def to_params
-     self.map { |k,v| "#{k}=#{v}" }.join("&")
-   end
+    def response_error(response)
+      {
+        code: response.code,
+        message: 'Invalid API key or request',
+        location: response.headers[:location],
+        body: response.body
+      }
+    end
+
+    def self.format(str, truncate)
+      result = str.split('+').map do |s|
+        s = s.match(':') ? s.split(':') : [s, '*']
+        shp = shapes[s[0].upcase]
+        s.shift && s.unshift(shp['name'].downcase.gsub(' ', '+')) unless shp.nil?
+        s.unshift(s.shift.split('/')[0]) if !s[0].scan('home+land').empty? && truncate
+        s.join(':')
+      end
+      result.join('+')
+    end
+
+    def self.shapes
+      return @@census_shapes if defined?(@@census_shapes)
+      @@census_shapes = {}
+      path = "#{File.dirname(__FILE__)}/../yml/census_shapes.yml"
+      YAML.load_file(path).each { |k, v| @@census_shapes[k] = v }
+      @@census_shapes
+    end
+  end
 end

data/lib/census_api/version.rb

@@ -1,3 +1,4 @@
+# => CensusApi::Version
 module CensusApi
-  VERSION = "1.0.6"
+  VERSION = '1.0.7'
 end

data/lib/census_api.rb

@@ -1,3 +1,4 @@
+require 'addressable/uri'
 require 'census_api/client'
 require 'census_api/request'
-require 'census_api/version'
+require 'census_api/version'

data/spec/api_key.sample.rb

@@ -1 +1 @@
-RSPEC_API_KEY = 'abc123'
+RSPEC_API_KEY = 'abc123'

data/spec/census_api/client_spec.rb

@@ -2,9 +2,9 @@ require 'spec_helper'
 
 describe CensusApi::Client do
 
-  describe "client initialization" do
+  describe 'client initialization' do
 
-    use_vcr_cassette "initialize_client"
+    use_vcr_cassette 'initialize_client'
 
     it 'should not initialize without an api_key' do
       lambda { CensusApi::Client.new }.should raise_error
@@ -16,9 +16,9 @@ describe CensusApi::Client do
     end
   end
 
-  describe "client and dataset initialization" do
+  describe 'client and dataset initialization' do
 
-    use_vcr_cassette "initialize_client_and_dataset"
+    use_vcr_cassette 'initialize_client_and_dataset'
 
     it 'should initialize with an api_key and dataset' do
       dataset = 'SF1'
@@ -26,19 +26,110 @@ describe CensusApi::Client do
       @client.api_key.should == api_key
       @client.dataset.should == dataset.downcase
     end
+  end
+
+  describe 'datasets' do
+
+    use_vcr_cassette 'find_method'
+    describe 'sf1' do
+      let(:source) { 'sf1' }
+      let(:options) do
+        { key: api_key,
+          vintage: 2010,
+          fields: 'P0010001',
+          level: 'STATE:06',
+          within: [] }
+      end
+
+      it 'should request sf1' do
+        @client = CensusApi::Client.new(api_key, dataset: source)
+        CensusApi::Request.should_receive(:find).with(@client.dataset, options)
+        @client.where(options)
+      end
+    end
+
+    describe 'acs5' do
+      let(:source) { 'acs5' }
+      let(:options) do
+        { key: api_key,
+          vintage: 2010,
+          fields: 'B00001_001E',
+          level: 'STATE:06',
+          within: [] }
+      end
 
-    it 'should request sf1' do
-      source, options = 'sf1', {:key=> api_key, :vintage => 2010, :fields => 'P0010001', :level => 'STATE:06', :within=>[]}
+      it 'should request acs5' do
+        @client = CensusApi::Client.new(api_key, dataset: source)
+        CensusApi::Request.should_receive(:find).with(@client.dataset, options)
+        @client.where(options)
+      end
+    end
+  end
+
+  describe '#find' do
+
+    use_vcr_cassette 'find_method'
+
+    let(:source) { 'sf1' }
+    let(:options) do
+      { key: api_key,
+        vintage: 2010,
+        fields: 'P0010001',
+        level: 'STATE:06',
+        within: [] }
+    end
+
+    it 'should be deprecated' do
       @client = CensusApi::Client.new(api_key, dataset: source)
-      CensusApi::Request.should_receive(:find).with(@client.dataset, options)
+      @client.should_receive(:warn)
+      .with('[DEPRECATION] `find` is deprecated. Please use `where` instead.')
       @client.find(options[:fields], options[:level])
     end
+  end
+
+  describe '#where' do
+    use_vcr_cassette 'where_method'
+
+    let(:source) { 'sf1' }
+
+    let(:options) do
+      {
+        key: api_key,
+        vintage: 2010,
+        fields: 'P0010001',
+        level: 'STATE:06',
+        within: []
+      }
+    end
+
+    let(:full_params) do
+      options.merge!(level: 'COUNTY:001', within: 'STATE:06')
+    end
 
-    it 'should request acs5' do
-      source, options = 'acs5', {:key=> api_key, :vintage => 2010, :fields => 'B00001_001E', :level => 'STATE:06', :within=>[]}
+    it 'should raise if missing fields params' do
       @client = CensusApi::Client.new(api_key, dataset: source)
-      CensusApi::Request.should_receive(:find).with(@client.dataset, options)
-      @client.find(options[:fields], options[:level])
+      expect { @client.where(fields: options[:fields]) }
+      .to raise_error(ArgumentError)
+    end
+
+    it 'should raise if missing level params' do
+      @client = CensusApi::Client.new(api_key, dataset: source)
+      expect { @client.where(level: options[:level]) }
+      .to raise_error(ArgumentError)
+    end
+
+    it 'should request sf1 with valid fields and level params' do
+      @client = CensusApi::Client.new(api_key, dataset: source)
+      CensusApi::Request.should_receive(:find)
+      .with(@client.dataset, options)
+      expect { @client.where(options) }.not_to raise_error
+    end
+
+    it 'should request sf1 with valid fields, level and within params' do
+      @client = CensusApi::Client.new(api_key, dataset: source)
+      CensusApi::Request.should_receive(:find)
+      .with(@client.dataset, full_params)
+      expect { @client.where(full_params) }.not_to raise_error
     end
   end
-end
+end

data/spec/census_api/request_spec.rb

@@ -2,29 +2,39 @@ require 'spec_helper'
 
 describe CensusApi::Request do
 
-  context "#find" do
-    [{:source => 'sf1', :field => 'P0010001', :results=> [
-        {"P0010001"=>"37253956", "name"=>"California", "state"=>"06"},
-        {"P0010001"=>"1510271", "name"=>"Alameda County", "state"=>"06", "county"=>"001"}
+  context '#find' do
+    [{source: 'sf1', field: 'P0010001', results: [
+        {'P0010001'=>'37253956', 'name'=>'California', 'state'=>'06'},
+        {'P0010001'=>'1510271', 'name'=>'Alameda County', 'state'=>'06', 'county'=>'001'}
       ]},
-      {:source => 'acs5', :field => 'B00001_001E', :results =>[
-        {"B00001_001E"=>"2330290", "name"=>"California", "state"=>"06"},
-        {"B00001_001E"=>"92854", "name"=>"Alameda County, California", "state"=>"06", "county"=>"001"}
+      {source: 'acs5', field: 'B00001_001E', results: [
+        {'B00001_001E'=>'2330290', 'name'=>'California', 'state'=>'06'},
+        {'B00001_001E'=>'92854', 'name'=>'Alameda County, California', 'state'=>'06', 'county'=>'001'}
       ]}
     ].each do |test|
-    
+
       describe "#{test[:source]} for a geography type" do
         use_vcr_cassette "#{test[:source]}_find_states"
 
+        let(:params) do
+          {
+            key: api_key,
+            source: test[:source],
+            vintage: 2010,
+            fields: test[:field],
+            level: 'STATE',
+            within: []
+          }
+        end
+
         before(:each) do
-          params = {:key=> api_key, :fields => test[:field], :level => 'STATE', :within=>[]}
-          @collection = CensusApi::Request.find(test[:source], params)      
+          @collection = CensusApi::Request.find(test[:source], params)
         end
 
         it 'should have 52 results' do
           @collection.count.should == 52
         end
-      
+
         it 'should include fields for each result' do
           @collection.each do |result|
             result.should include(test[:field])
@@ -33,31 +43,50 @@ describe CensusApi::Request do
           end
         end
       end
-    
+
       describe "#{test[:source]} for a geography type and id" do
         use_vcr_cassette "#{test[:source]}_find_state_with_id"
+        let(:params) do
+          {
+            key: api_key,
+            source: test[:source],
+            vintage: 2010,
+            fields: test[:field],
+            level: 'STATE:06',
+            within: []
+          }
+        end
 
         before(:each) do
-          params = {:key=> api_key, :fields => test[:field], :level => 'STATE:06', :within=>[]}
-          @collection = CensusApi::Request.find(test[:source], params)      
+          @collection = CensusApi::Request.find(test[:source], params)
         end
 
         it 'should have one result' do
           @collection.count.should == 1
         end
-      
+
         it 'should include fields for each result' do
           @collection.each do |result|
             result.should == test[:results][0]
           end
         end
       end
-    
-      describe "#{test[:source]} for a geography type in a geography type" do
+
+      describe "#{test[:source]} for a geography type" do
         use_vcr_cassette "#{test[:source]}_find_counties_in_state"
 
+        let(:params) do
+          {
+            key: api_key,
+            source: test[:source],
+            vintage: 2010,
+            fields: test[:field],
+            level: 'COUNTY',
+            within: ['STATE:06']
+          }
+        end
+
         before(:each) do
-          params = {:key=> api_key, :fields => test[:field], :level => 'COUNTY', :within=>['STATE:06']}
           @collection = CensusApi::Request.find(test[:source], params)
         end
 
@@ -74,11 +103,21 @@ describe CensusApi::Request do
         end
       end
 
-      describe "#{test[:source]} for a geography type and id in a geography type" do
+      describe "#{test[:source]} for a geography" do
         use_vcr_cassette "#{test[:source]}_find_county_in_state"
 
+        let(:params) do
+          {
+            key: api_key,
+            source: test[:source],
+            vintage: 2010,
+            fields: test[:field],
+            level: 'COUNTY:001',
+            within: ['STATE:06']
+          }
+        end
+
         before(:each) do
-          params = {:key=> api_key, :fields => test[:field], :level => 'COUNTY:001', :within=>['STATE:06']}
           @collection = CensusApi::Request.find(test[:source], params)
         end
 
@@ -95,17 +134,18 @@ describe CensusApi::Request do
     end
   end
 
-  context "DATASETS" do
+  context 'DATASETS' do
     CensusApi::Client::DATASETS.each do |source|
       describe "#{source}" do
         use_vcr_cassette "dataset_#{source}_find_states"
         let(:params) do
-          { :key=> api_key,
-            :vintage => !!(source.match('sf1')) ? 2010 : 2012,
-            :fields => !!(source.match('sf1')) ? 'P0010001' : 'B00001_001E',
-            :source => source,
-            :level => 'STATE',
-            :within=>[]
+          {
+            key: api_key,
+            source: source,
+            vintage: source.match('sf1') ? 2010 : 2012,
+            fields: source.match('sf1') ? 'P0010001' : 'B00001_001E',
+            level: 'STATE',
+            within: []
           }
         end
 
@@ -117,19 +157,29 @@ describe CensusApi::Request do
     end
   end
 
-  context ".vintage" do
-    describe "vintage" do
-      use_vcr_cassette "sf1_find_states_vintage"
+  context '.vintage' do
+    describe 'vintage' do
+      use_vcr_cassette 'sf1_find_states_vintage'
+
+      let(:params) do
+        {
+          key: api_key,
+          source: 'acs5',
+          vintage: 2010,
+          fields: 'B00001_001E',
+          level: 'STATE',
+          within: []
+        }
+      end
 
       before(:each) do
-        params = {:key=> api_key, :vintage => 2010, :fields => 'B00001_001E', :source => 'acs5', :level => 'STATE', :within=>[]}
         @collection_2010 = CensusApi::Request.find(params[:source], params)
-        @collection_2012 = CensusApi::Request.find(params[:source], params.merge!({ :vintage => 2012 }))
+        params.merge!(vintage: 2012)
+        @collection_2012 = CensusApi::Request.find(params[:source], params)
       end
 
       it 'should be valid' do
-        @collection_2010.count.should == 52
-        @collection_2012.count.should == 52
+        @collection_2010.count.should eq(52)
       end
 
       it 'should not be same result set' do
@@ -138,21 +188,25 @@ describe CensusApi::Request do
     end
   end
 
-  context "#format" do
+  context '#format' do
     it 'should add wildcard after reformatting geography type without id' do
-      CensusApi::Request.format('COUSUB', false).should == 'county+subdivision:*'
+      CensusApi::Request.format('COUSUB', false).should
+      be('county+subdivision:*')
     end
 
     it 'should maintain geography id after reformatting geography type' do
-      CensusApi::Request.format('COUSUB:86690', false).should == 'county+subdivision:86690'
+      CensusApi::Request.format('COUSUB:86690', false).should
+      be('county+subdivision:86690')
     end
 
     it 'should truncate geography type AIANNH' do
-      CensusApi::Request.format('AIANNH', true).should == 'american+indian+area:*'
+      CensusApi::Request.format('AIANNH', true).should
+      be('american+indian+area:*')
     end
 
     it 'should not truncate geography type CBSA' do
-      CensusApi::Request.format('CBSA', true).should == 'metropolitan+statistical+area/micropolitan+statistical+area:*'
+      CensusApi::Request.format('CBSA', true).should
+      be('metropolitan+statistical+area/micropolitan+statistical+area:*')
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -10,4 +10,4 @@ end
 
 RSpec.configure do |config|
   config.extend VCR::RSpec::Macros
-end
+end

data/spec/vcr_setup.rb

@@ -1,8 +1,8 @@
 require 'vcr'
 
 VCR.config do |c|
-  c.cassette_library_dir     = 'spec/vcr_cassettes'
-  c.hook_into                :fakeweb
-  c.ignore_localhost         = true
-  c.default_cassette_options = { :record => :new_episodes }
-end
+  c.cassette_library_dir = 'spec/vcr_cassettes'
+  c.hook_into :fakeweb
+  c.ignore_localhost = true
+  c.default_cassette_options = { record: :new_episodes }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: census_api
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Ty Rauber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-17 00:00:00.000000000 Z
+date: 2014-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: hpricot
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
 description: A Ruby Gem for querying the US Census Bureau API
 email:
 - tyrauber@mac.com