census_api 1.0.4 → 1.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62d635eb4a50f1607cf754133ec5e2df2458f774
+  data.tar.gz: db81cacdbddc88f77a4202b59329b6ff7e2929b0
+SHA512:
+  metadata.gz: 21714d668b24434213474a8a2647f7a5350a1cf65bcc227c4c402e789ce9c2f5adacbc5141b748575a0564a5faf5a5c1fd21923bb6f24118caa6656c3af45047
+  data.tar.gz: 715488e993f03ccde604f610840c234cd70e6dfdda0c75c05b48b8f011482f16d37bb3e51fcf7d29e9bd2f63e7894c535eba08d0bc100f61d173b7dcc4ca4d7c

data/README.md

@@ -35,6 +35,7 @@ $ export $CENSUS_API_KEY='your-api-key'
 @client = CensusApi::Client.new(API_KEY) 
 @client = CensusApi::Client.new(ENV['CENSUS_API_KEY']) # from the environment variable
 @client = CensusApi::Client.new(API_KEY, dataset: 'SF1') # with a dataset
+@client = CensusApi::Client.new(API_KEY, {vintage: 2012, dataset: 'SF1'}) # specific vintage (year) data; defaults to 2010
 ```
 
 ### Query a Dataset

data/lib/census_api/client.rb

@@ -2,10 +2,10 @@ module CensusApi
   class Client
     require 'rest-client'
 
-    attr_reader   :api_key, :options
+    attr_reader   :api_key, :api_vintage, :options
     attr_accessor :dataset
 
-    DATASETS = %w( sf1 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

data/lib/census_api/request.rb

@@ -10,10 +10,10 @@ module CensusApi
     
     @@census_shapes
     
-    CENSUS_URL = "http://api.census.gov/data/2010"
+    CENSUS_URL = "http://api.census.gov/data"
 
-    def initialize(url, source, options)
-      path = "#{url}/#{source}?#{options.to_params}"
+    def initialize(url, vintage, source, options)
+      path = "#{url}/#{vintage}/#{source}?#{options.to_params}"
       @response = RestClient.get(path) do |response, request, result, &block|
         response
       end
@@ -27,7 +27,8 @@ module CensusApi
       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?
-      request = new(CENSUS_URL, source, params)
+      options.merge!({ :vintage => 2010 }) unless options[:vintage]
+      request = new(CENSUS_URL, options[:vintage], source, params)
       request.parse_response
     end
 

data/lib/census_api/version.rb

@@ -1,3 +1,3 @@
 module CensusApi
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

data/spec/census_api/request_spec.rb

@@ -54,44 +54,87 @@ describe CensusApi::Request do
       end
     
       describe "#{test[:source]} for a geography type in a geography type" do
-         use_vcr_cassette "#{test[:source]}_find_counties_in_state"
-
-         before(:each) do
-           params = {:key=> api_key, :fields => test[:field], :level => 'COUNTY', :within=>['STATE:06']}
-           @collection = CensusApi::Request.find(test[:source], params)      
-         end
-
-         it 'should have one result' do
-           @collection.count.should == 58
-         end
-
-         it 'should include fields for each result' do
-           @collection.each do |result|
-             result.should include(test[:field])
-             result.should include('name')
-             result.should include('state')
-           end
-         end
-       end
-     
-       describe "#{test[:source]} for a geography type and id in a geography type" do
-          use_vcr_cassette "#{test[:source]}_find_county_in_state"
-
-           before(:each) do
-             params = {:key=> api_key, :fields => test[:field], :level => 'COUNTY:001', :within=>['STATE:06']}
-             @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][1]
-             end
-           end
-         end
+        use_vcr_cassette "#{test[:source]}_find_counties_in_state"
+
+        before(:each) do
+          params = {:key=> api_key, :fields => test[:field], :level => 'COUNTY', :within=>['STATE:06']}
+          @collection = CensusApi::Request.find(test[:source], params)
+        end
+
+        it 'should have one result' do
+          @collection.count.should == 58
+        end
+
+        it 'should include fields for each result' do
+          @collection.each do |result|
+            result.should include(test[:field])
+            result.should include('name')
+            result.should include('state')
+          end
+        end
+      end
+
+      describe "#{test[:source]} for a geography type and id in a geography type" do
+        use_vcr_cassette "#{test[:source]}_find_county_in_state"
+
+        before(:each) do
+          params = {:key=> api_key, :fields => test[:field], :level => 'COUNTY:001', :within=>['STATE:06']}
+          @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][1]
+          end
+        end
+      end
+    end
+  end
+
+  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=>[]
+          }
+        end
+
+        it "#{source} should be valid" do
+          @collection = CensusApi::Request.find(source, params)
+          @collection.count.should == 52
+        end
+      end
+    end
+  end
+
+  context ".vintage" do
+    describe "vintage" do
+      use_vcr_cassette "sf1_find_states_vintage"
+
+      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 }))
+      end
+
+      it 'should be valid' do
+        @collection_2010.count.should == 52
+        @collection_2012.count.should == 52
+      end
+
+      it 'should not be same result set' do
+        @collection_2010.should_not == @collection_2012
+      end
     end
   end
 

metadata

@@ -1,94 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: census_api
 version: !ruby/object:Gem::Version
-  version: 1.0.4
-  prerelease: 
+  version: 1.0.5
 platform: ruby
 authors:
 - Ty Rauber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-16 00:00:00.000000000 Z
+date: 2014-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: hpricot
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A Ruby Gem for querying the US Census Bureau API
@@ -98,7 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -117,27 +106,26 @@ files:
 homepage: https://github.com/tyrauber/census_api.git
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Ruby Wrapper for the US Census Bureau API, providing the ability to query
   both the 2010 Census and 2006-2010 ACS5 datasets.
 test_files:
@@ -146,4 +134,3 @@ test_files:
 - spec/census_api/request_spec.rb
 - spec/spec_helper.rb
 - spec/vcr_setup.rb
-has_rdoc: