census_api 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 642511253be7aea4c68837c8cc2c769a866a27fa
-  data.tar.gz: 072c04b497dafce02b299a697f9d1f0546a164a2
+  metadata.gz: a62e626a1fbdc56c582ddb174cc461bf115dc7e6
+  data.tar.gz: 3e58b79d93058fc2f4395d27336ad2632d152c9d
 SHA512:
-  metadata.gz: f44224cf3a16e0ebe6892b08eb9b8253753850d936cfeb724098c7e7bc7930d465d750cd159275f8d05fd23409d390a09a0f1400fa67d07b19a71a170eecc537
-  data.tar.gz: 274f4ed8b1af0caa138d1d892f6ae697f43e360a86e5732712f08fb6f51c605bd725560c90a3a855f6556cf87fe0536ba28e65fc6a53df6edcc68e8217bec678
+  metadata.gz: 5f6f49c3e3b567fac345a4fba23014fa2e52356436142bd4f2618fea8ec7568d6c383b7a82fc0d344907a7a28434736ad4dfc1ad3455167337b223a74c8ac3d7
+  data.tar.gz: 06141acd1d396546659618f5333cd051c34ab021e46fea50357606acb8e6d226c716cf1c09d3e89dbab06a6cb6a357be0b804868f1b6b8b21e51dd66d764a549

data/README.md

@@ -57,14 +57,14 @@ To query the 2006-2010 ACS5 dataset, set the dataset to 'ACS5':
 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.where({ fields: 'P0010001', level: 'COUNTY:001', within: ['STATE: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'])
+@client.find('P0010001', 'COUNTY:001', 'STATE:06')
 
 ```
 
@@ -274,7 +274,7 @@ Retrieve fields for all Counties within a specific Congressional District:
 
 Retrieve fields for a specific County within a specific Congressional District:
 
-`@client.where({ fields: 'P0010001', level: 'COUNTY:01', within: 'STATE:24+CD:01' })`
+`@client.where({ fields: 'P0010001', level: 'COUNTY:003', within: 'STATE:24+CD:01' })`
 
 #### TRACT (Remainder) - *(511) state-congressional district-county-tract*
 
@@ -314,7 +314,7 @@ Retrieve fields for all American Indian Area/Alaska Native Area/Hawaiian Home La
 
 Retrieve fields for a specific American Indian Area/Alaska Native Area/Hawaiian Home Land  within a specific Congressional District:
 
-`@client.where({ fields: 'P0010001', level: 'AIANNH:03800', within: 'STATE:02+CD:00' })`
+__DOES NOT WORK__: `@client.where({ fields: 'P0010001', level: 'AIANNH:0010', within: 'STATE:02+CD:00' })`
 
 #### ANRC (Remainder) - *(560) state-congressional district-alaska native regional corporation*
 
@@ -476,7 +476,7 @@ Retrieve fields for all American Indian Area/Alaska Native Area/Hawaiian Home La
 
 Retrieve fields for a specific American Indian Area/Alaska Native Area/Hawaiian Home Land within a specific State:
 
-`@client.where({ fields: 'B00001_001E', level: 'AIANNH:03800', within: 'STATE:02' })`
+__DOES NOT WORK__: `@client.where({ fields: 'B00001_001E', level: 'AIANNH:03800', within: 'STATE:02' })`
 
 #### CD - *(500) state-congressional district*
 

data/census_api.gemspec

@@ -22,7 +22,6 @@ Gem::Specification.new do |gem|
   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'

data/lib/census_api/client.rb

@@ -36,20 +36,21 @@ module CensusApi
       Request.find(dataset, options)
     end
 
-    def where(options = { key: @api_key,  vintage: @api_vintage })
+    def where(options={})
+      options.merge!(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
+      options[:within] = [options[:within]]
       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
+      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'
         fail "'#{api_key}' is not a valid API key. Check your key for errors,
         or request a new one at census.gov."

data/lib/census_api/request.rb

@@ -14,8 +14,7 @@ module CensusApi
     CENSUS_URL = 'http://api.census.gov/data'
 
     def initialize(url, vintage, source, options)
-      uri = Addressable::URI.parse("#{url}/#{vintage}/#{source}")
-      uri.query_values = options
+      uri = "#{url}/#{vintage}/#{source}?#{to_params(options)}"
       @response = RestClient.get(uri.to_s) do |response, _req, _res, _blk|
         response
       end
@@ -27,7 +26,9 @@ module CensusApi
       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?
+      unless (options[:within].nil? || (options[:within].is_a?(Array) && options[:within].compact.empty?))
+        params.merge!(in: format(options[:within][0], true))
+      end
       options.merge!(vintage: 2010) unless options[:vintage]
       request = new(CENSUS_URL, options[:vintage], source, params)
       request.parse_response
@@ -42,6 +43,10 @@ module CensusApi
       end
     end
 
+    def to_params(options)
+      options.map { |k,v| "#{k}=#{v}" }.join("&")
+    end
+
     protected
 
     def response_success(response)
@@ -55,7 +60,6 @@ module CensusApi
     def response_error(response)
       {
         code: response.code,
-        message: 'Invalid API key or request',
         location: response.headers[:location],
         body: response.body
       }

data/lib/census_api/version.rb

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

data/lib/census_api.rb

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

data/spec/census_api/example_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe 'CensusApi::Examples' do
+  use_vcr_cassette 'census_api examples'
+  let(:client) { CensusApi::Client.new(api_key) }
+
+  describe 'sf1' do
+    before(:each) do
+      client.dataset = 'sf1'
+    end
+    describe '#find' do
+      CensusExamples::SF1.each do |query|
+        it "should retrieve #{query.join(",")}" do
+          response = client.send(:find, query[0], query[1], query[2])
+          expect{ response }.not_to raise_error
+          response.should be_a(Array)
+          response.first.should include('name')
+        end
+      end
+    end
+    describe '#where' do
+      CensusExamples::SF1.each do |query|
+        it "should retrieve #{query.join(",")}" do
+          response = client.send(:where, {fields: query[0], level: query[1], within: query[2]})
+          expect{ response }.not_to raise_error
+          response.should be_a(Array)
+          response.first.should include('name')
+        end
+      end
+    end
+  end
+  
+  describe 'acs5' do
+    before(:each) do
+      client.dataset = 'acs5'
+    end
+    describe '#find' do
+      CensusExamples::ACS5.each do |query|
+        it "should retrieve #{query.join(",")}" do
+          response = client.send(:find, query[0], query[1], query[2])
+          expect{ response }.not_to raise_error
+          response.should be_a(Array)
+          response.first.should include('name')
+        end
+      end
+    end
+    describe '#where' do
+      CensusExamples::ACS5.each do |query|
+        it "should retrieve #{query.join(",")}" do
+          response = client.send(:where, {fields: query[0], level: query[1], within: query[2]})
+          expect{ response }.not_to raise_error
+          response.should be_a(Array)
+          response.first.should include('name')
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ require 'bundler/setup'
 require 'vcr_setup'
 require 'api_key'
 require 'census_api'
+require 'support/census_examples'
 
 def api_key
   RSPEC_API_KEY

data/spec/support/census_examples.rb

@@ -0,0 +1,84 @@
+module CensusExamples
+  SF1 = [
+    ['P0010001', 'STATE'],
+    ['P0010001', 'STATE:06'],
+    ['P0010001', 'STATE:02,06'],
+    ['P0010001', 'COUNTY'],
+    ['P0010001', 'COUNTY', 'STATE:06'],
+    ['P0010001', 'COUNTY:001', 'STATE:06'],
+    ['P0010001', 'COUSUB', 'STATE:02+COUNTY:290'],
+    ['P0010001', 'COUSUB:86690', 'STATE:02+COUNTY:290'],
+    ['P0010001', 'SUBMCD', 'STATE:72+COUNTY:127+COUSUB:79693'],
+    ['P0010001', 'SUBMCD:02350', 'STATE:72+COUNTY:127+COUSUB:79693'],
+    ['P0010001', 'TABBLOCK', 'STATE:02+COUNTY:290+TRACT:00100'],
+    ['P0010001', 'SUBMCD:02350', 'STATE:72+COUNTY:127+COUSUB:79693'],
+    ['P0010001', 'TRACT', 'STATE:02+COUNTY:170'],
+    ['P0010001', 'TRACT:000101', 'STATE:02+COUNTY:170'],
+    ['P0010001', 'BG', 'STATE:02+COUNTY:170+TRACT:000101'],
+    ['P0010001', 'BG:1', 'STATE:02+COUNTY:170+TRACT:000101'],
+    ['P0010001', 'PLACE'],
+    ['P0010001', 'PLACE', 'STATE:06'],
+    ['P0010001', 'PLACE:00135', 'STATE:06'],
+    ['P0010001', 'ANRC'],
+    ['P0010001', 'ANRC', 'STATE:02'],
+    ['P0010001', 'ANRC:00590', 'STATE:02'],
+    ['P0010001', 'AIANNH'],
+    ['P0010001', 'AIANNH', 'STATE:02'],
+    ['P0010001', 'AIANNH:03800', 'STATE:02'],
+    ['P0010001', 'AITS', 'STATE:40+AIANNH:13735'],
+    ['P0010001', 'AITS:83127', 'STATE:40+AIANNH:13735'],
+    ['P0010001', 'CBSA', 'STATE:02'],
+    ['P0010001', 'CBSA:11260', 'STATE:02'],
+    ['P0010001', 'METDIV', 'STATE:06+CBSA:31100'],
+    ['P0010001', 'METDIV', 'STATE:06+CBSA:31100'],
+    ['P0010001', 'METDIV:31084', 'STATE:06+CBSA:31100'],
+    ['P0010001', 'CSA', 'STATE:24'],
+    ['P0010001', 'CSA:428', 'STATE:24'],
+    ['P0010001', 'CD', 'STATE:24'],
+    ['P0010001', 'CD:01', 'STATE:24'],
+    ['P0010001', 'COUNTY', 'STATE:24+CD:01'],
+    ['P0010001', 'COUNTY:003', 'STATE:24+CD:01'],
+    ['P0010001', 'TRACT', 'STATE:24+CD:01+COUNTY:003'],
+    ['P0010001', 'TRACT:702100', 'STATE:24+CD:01+COUNTY:003'],
+    ['P0010001', 'COUSUB', 'STATE:24+CD:01+COUNTY:003'],
+    ['P0010001', 'COUSUB:90100', 'STATE:24+CD:01+COUNTY:003'],
+    ['P0010001', 'PLACE', 'STATE:24+CD:01'],
+    ['P0010001', 'PLACE:00125', 'STATE:24+CD:01'],
+    ['P0010001', 'AIANNH', 'STATE:02+CD:00'],
+    ['P0010001', 'AIANNH:03800', 'STATE:02+CD:00'],
+    ['P0010001', 'AIANNH', 'STATE:02+CD:00'],
+    ['P0010001', 'SLDU', 'STATE:02'],
+    ['P0010001', 'SLDU:00A', 'STATE:02'],
+    ['P0010001', 'SLDL', 'STATE:02'],
+    ['P0010001', 'SLDL:001', 'STATE:02'],
+    ['P0010001', 'ZCTA5', 'STATE:02'],
+    ['P0010001', 'ZCTA5:99501', 'STATE:02']
+  ]
+  ACS5 = [
+    ['B00001_001E', 'STATE'],
+    ['B00001_001E', 'STATE:06'],
+    ['B00001_001E', 'STATE:06,02'],
+    ['B00001_001E', 'COUNTY'],
+    ['B00001_001E', 'COUNTY', 'STATE:06'],
+    ['B00001_001E', 'COUNTY:001', 'STATE:06'],
+    ['B00001_001E', 'COUSUB', 'STATE:02+COUNTY:290'],
+    ['B00001_001E', 'COUSUB:86690', 'STATE:02+COUNTY:290'],
+    ['B00001_001E', 'SUBMCD', 'STATE:72+COUNTY:127+COUSUB:79693'],
+    ['B00001_001E', 'SUBMCD:02350', 'STATE:72+COUNTY:127+COUSUB:79693'],
+    ['B00001_001E', 'PLACE', 'STATE:02+COUNTY:290+COUSUB:86690'],
+    ['B00001_001E', 'PLACE:05750', 'STATE:02+COUNTY:290+COUSUB:86690'],
+    ['B00001_001E', 'TRACT', 'STATE:02+COUNTY:290+COUSUB:86690+PLACE:05750'],
+    ['B00001_001E', 'TRACT:000100', 'STATE:02+COUNTY:290+COUSUB:86690+PLACE:05750'],
+    ['B00001_001E', 'TRACT', 'STATE:02+COUNTY:170'],
+    ['B00001_001E', 'TRACT:000101', 'STATE:02+COUNTY:170'],
+    ['B00001_001E', 'BG', 'STATE:02+COUNTY:170+TRACT:000101'],
+    ['B00001_001E', 'BG:1', 'STATE:02+COUNTY:170+TRACT:000101'],
+    ['B00001_001E', 'PLACE'],
+    ['B00001_001E', 'PLACE', 'STATE:06'],
+    ['B00001_001E', 'PLACE:00135', 'STATE:06'],
+    ['B00001_001E', 'AIANNH'],
+    ['B00001_001E', 'AIANNH', 'STATE:02'],
+    ['B00001_001E', 'CD', 'STATE:24'],
+    ['B00001_001E', 'CD:01', 'STATE:24']
+  ]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: census_api
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
 - Ty Rauber
@@ -24,20 +24,6 @@ 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
@@ -128,8 +114,10 @@ files:
 - lib/yml/census_shapes.yml
 - spec/api_key.sample.rb
 - spec/census_api/client_spec.rb
+- spec/census_api/example_spec.rb
 - spec/census_api/request_spec.rb
 - spec/spec_helper.rb
+- spec/support/census_examples.rb
 - spec/vcr_setup.rb
 homepage: https://github.com/tyrauber/census_api.git
 licenses:
@@ -159,6 +147,8 @@ summary: A Ruby Wrapper for the US Census Bureau API, providing the ability to q
 test_files:
 - spec/api_key.sample.rb
 - spec/census_api/client_spec.rb
+- spec/census_api/example_spec.rb
 - spec/census_api/request_spec.rb
 - spec/spec_helper.rb
+- spec/support/census_examples.rb
 - spec/vcr_setup.rb