census_api 1.0.8 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a62e626a1fbdc56c582ddb174cc461bf115dc7e6
-  data.tar.gz: 3e58b79d93058fc2f4395d27336ad2632d152c9d
+  metadata.gz: 2a7ed25157bf9e34b4bd73269a608cdd1d312f0e
+  data.tar.gz: 9de9fe0553987838d86f9c6621e5638a3222b096
 SHA512:
-  metadata.gz: 5f6f49c3e3b567fac345a4fba23014fa2e52356436142bd4f2618fea8ec7568d6c383b7a82fc0d344907a7a28434736ad4dfc1ad3455167337b223a74c8ac3d7
-  data.tar.gz: 06141acd1d396546659618f5333cd051c34ab021e46fea50357606acb8e6d226c716cf1c09d3e89dbab06a6cb6a357be0b804868f1b6b8b21e51dd66d764a549
+  metadata.gz: e08efa0b1fd2bef67d6cbcab59f3e5e39e0f0f1310558e71d998a737ad647e3fde7b1f3363c639271a86eaa9aad9fe975f859fd28e1a549537c5eb7e19376f11
+  data.tar.gz: 00d11868c1ff9cd83b7439c64a0a44f9bb979e63b6fceb915a07fa000b342c97f603b2107b8a3c9b7dc14717fae5d276aeaaa7438b1e54abf9ece9a28d95bcc2

data/.gitignore

@@ -20,4 +20,6 @@ spec/api_key.rb
 test/tmp
 test/version_tmp
 tmp
-misc/*
+misc/*
+/.ruby-version
+/.ruby-gemset

data/README.md

@@ -61,13 +61,6 @@ Then, use `Client#where` with an options hash to query for Census data. The fiel
 
 ```
 
-The `Client.find` method which takes positional arguments is still available, but deprecated.
-
-```ruby
-@client.find('P0010001', 'COUNTY:001', 'STATE:06')
-
-```
-
 For a list of the fields available for each dataset, review the reference PDFs linked at the bottom of this document.
 
 #### Parameters

data/census_api.gemspec

@@ -11,8 +11,8 @@ Gem::Specification.new do |gem|
   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.'
+                      providing the ability to query both the SF1 and ACS5
+                      datasets.'
   gem.homepage      = 'https://github.com/tyrauber/census_api.git'
 
   gem.files         = `git ls-files`.split("\n")
@@ -21,10 +21,9 @@ Gem::Specification.new do |gem|
                       .map { |f| File.basename(f) }
   gem.require_paths = ['lib']
 
-  gem.add_runtime_dependency 'rest-client'
-  gem.add_runtime_dependency 'hpricot'
+  gem.add_runtime_dependency 'http'
   gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'fakeweb'
+  gem.add_development_dependency 'webmock', '< 2.0'
   gem.add_development_dependency 'vcr'
   gem.add_development_dependency 'rubocop'
 end

data/lib/census_api/client.rb

@@ -3,9 +3,9 @@ module CensusApi
   # 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'
+    require 'http'
+    $census_connection = HTTP.persistent "http://api.census.gov"
 
     attr_reader :api_key, :api_vintage, :options
     attr_accessor :dataset
@@ -23,19 +23,6 @@ module CensusApi
       end
     end
 
-    def find(fields, level, *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={})
       options.merge!(key: @api_key, vintage: @api_vintage)
       fail "Client requires a dataset (#{DATASETS})." if @dataset.nil?
@@ -49,9 +36,9 @@ module CensusApi
     protected
 
     def validate_api_key(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'
+      path = "/data/2010/sf1?key=#{api_key}&get=P0010001&for=state:01"
+      response = $census_connection.get path
+      if response.to_s.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

data/lib/census_api/request.rb

@@ -4,20 +4,16 @@ module CensusApi
   # client#find method accepts source and options hash, which include
   # :key, :fields, :level, :within and :vintage.
   class Request
-    require 'restclient'
-    require 'hpricot'
+    require 'http'
     require 'json'
     require 'yaml'
 
     attr_accessor :response
 
-    CENSUS_URL = 'http://api.census.gov/data'
-
-    def initialize(url, vintage, source, options)
-      uri = "#{url}/#{vintage}/#{source}?#{to_params(options)}"
-      @response = RestClient.get(uri.to_s) do |response, _req, _res, _blk|
-        response
-      end
+    def initialize(vintage, source, options)
+      uri = "/data/#{vintage}/#{source}?#{to_params(options)}"
+      @response = $census_connection.get(uri.to_s)
+      @response.flush
     end
 
     def self.find(source, options = {})
@@ -30,7 +26,7 @@ module CensusApi
         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 = new(options[:vintage], source, params)
       request.parse_response
     end
 

data/lib/census_api/version.rb

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

data/spec/census_api/client_spec.rb

@@ -1,36 +1,31 @@
 require 'spec_helper'
 
-describe CensusApi::Client do
+describe CensusApi::Client, :vcr do
 
-  describe 'client initialization' do
-
-    use_vcr_cassette 'initialize_client'
+  describe 'initialize client' do
 
     it 'should not initialize without an api_key' do
-      lambda { CensusApi::Client.new }.should raise_error
+      expect { CensusApi::Client.new }.to raise_error(ArgumentError)
     end
 
     it 'should initialize with an api_key' do
       @client = CensusApi::Client.new(api_key)
-      @client.api_key.should == api_key
+      expect(@client.api_key).to eq(api_key)
     end
   end
 
-  describe 'client and dataset initialization' do
-
-    use_vcr_cassette 'initialize_client_and_dataset'
+  describe 'initialize client and dataset' do
 
     it 'should initialize with an api_key and dataset' do
       dataset = 'SF1'
       @client = CensusApi::Client.new(api_key, dataset: dataset)
-      @client.api_key.should == api_key
-      @client.dataset.should == dataset.downcase
+      expect(@client.api_key).to eq(api_key)
+      expect(@client.dataset).to eq(dataset.downcase)
     end
   end
 
   describe 'datasets' do
 
-    use_vcr_cassette 'find_method'
     describe 'sf1' do
       let(:source) { 'sf1' }
       let(:options) do
@@ -43,7 +38,7 @@ describe CensusApi::Client do
 
       it 'should request sf1' do
         @client = CensusApi::Client.new(api_key, dataset: source)
-        CensusApi::Request.should_receive(:find).with(@client.dataset, options)
+        expect(CensusApi::Request).to receive(:find).with(@client.dataset, options)
         @client.where(options)
       end
     end
@@ -60,15 +55,13 @@ describe CensusApi::Client do
 
       it 'should request acs5' do
         @client = CensusApi::Client.new(api_key, dataset: source)
-        CensusApi::Request.should_receive(:find).with(@client.dataset, options)
+        expect(CensusApi::Request).to receive(:find).with(@client.dataset, options)
         @client.where(options)
       end
     end
   end
 
-  describe '#find' do
-
-    use_vcr_cassette 'find_method'
+  describe '#where' do
 
     let(:source) { 'sf1' }
     let(:options) do
@@ -79,29 +72,6 @@ describe CensusApi::Client do
         within: [] }
     end
 
-    it 'should be deprecated' do
-      @client = CensusApi::Client.new(api_key, dataset: source)
-      @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
@@ -120,14 +90,14 @@ describe CensusApi::Client do
 
     it 'should request sf1 with valid fields and level params' do
       @client = CensusApi::Client.new(api_key, dataset: source)
-      CensusApi::Request.should_receive(:find)
+      expect(CensusApi::Request).to 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)
+      expect(CensusApi::Request).to receive(:find)
       .with(@client.dataset, full_params)
       expect { @client.where(full_params) }.not_to raise_error
     end

data/spec/census_api/example_spec.rb

@@ -1,56 +1,35 @@
 require 'spec_helper'
 
-describe 'CensusApi::Examples' do
-  use_vcr_cassette 'census_api examples'
+describe 'CensusApi::Examples', :vcr do
   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')
+          expect(response).to be_a(Array)
+          expect(response.first).to 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')
+          expect(response).to be_a(Array)
+          expect(response.first).to include('name')
         end
       end
     end

data/spec/census_api/request_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe CensusApi::Request do
+describe CensusApi::Request, :vcr do
 
   context '#find' do
     [{source: 'sf1', field: 'P0010001', results: [
@@ -14,7 +14,6 @@ describe CensusApi::Request do
     ].each do |test|
 
       describe "#{test[:source]} for a geography type" do
-        use_vcr_cassette "#{test[:source]}_find_states"
 
         let(:params) do
           {
@@ -32,20 +31,19 @@ describe CensusApi::Request do
         end
 
         it 'should have 52 results' do
-          @collection.count.should == 52
+          expect(@collection.count).to eq(52)
         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')
+            expect(result).to include(test[:field])
+            expect(result).to include('name')
+            expect(result).to include('state')
           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,
@@ -62,18 +60,17 @@ describe CensusApi::Request do
         end
 
         it 'should have one result' do
-          @collection.count.should == 1
+          expect(@collection.count).to eq(1)
         end
 
         it 'should include fields for each result' do
           @collection.each do |result|
-            result.should == test[:results][0]
+            expect(result).to eq(test[:results][0])
           end
         end
       end
 
       describe "#{test[:source]} for a geography type" do
-        use_vcr_cassette "#{test[:source]}_find_counties_in_state"
 
         let(:params) do
           {
@@ -91,20 +88,19 @@ describe CensusApi::Request do
         end
 
         it 'should have one result' do
-          @collection.count.should == 58
+          expect(@collection.count).to eq(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')
+            expect(result).to include(test[:field])
+            expect(result).to include('name')
+            expect(result).to include('state')
           end
         end
       end
 
       describe "#{test[:source]} for a geography" do
-        use_vcr_cassette "#{test[:source]}_find_county_in_state"
 
         let(:params) do
           {
@@ -122,12 +118,12 @@ describe CensusApi::Request do
         end
 
         it 'should have one result' do
-          @collection.count.should == 1
+          expect(@collection.count).to eq(1)
         end
 
         it 'should include fields for each result' do
           @collection.each do |result|
-            result.should == test[:results][1]
+            expect(result).to eq(test[:results][1])
           end
         end
       end
@@ -137,7 +133,6 @@ describe CensusApi::Request 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,
@@ -151,7 +146,7 @@ describe CensusApi::Request do
 
         it "#{source} should be valid" do
           @collection = CensusApi::Request.find(source, params)
-          @collection.count.should == 52
+          expect(@collection.count).to eq(52)
         end
       end
     end
@@ -159,7 +154,6 @@ describe CensusApi::Request do
 
   context '.vintage' do
     describe 'vintage' do
-      use_vcr_cassette 'sf1_find_states_vintage'
 
       let(:params) do
         {
@@ -179,34 +173,30 @@ describe CensusApi::Request do
       end
 
       it 'should be valid' do
-        @collection_2010.count.should eq(52)
+        expect(@collection_2010.count).to eq(52)
       end
 
       it 'should not be same result set' do
-        @collection_2010.should_not == @collection_2012
+        expect(@collection_2010).not_to eq(@collection_2012)
       end
     end
   end
 
   context '#format' do
     it 'should add wildcard after reformatting geography type without id' do
-      CensusApi::Request.format('COUSUB', false).should
-      be('county+subdivision:*')
+      expect(CensusApi::Request.format('COUSUB', false)).to eq('county+subdivision:*')
     end
 
     it 'should maintain geography id after reformatting geography type' do
-      CensusApi::Request.format('COUSUB:86690', false).should
-      be('county+subdivision:86690')
+      expect(CensusApi::Request.format('COUSUB:86690', false)).to eq('county+subdivision:86690')
     end
 
     it 'should truncate geography type AIANNH' do
-      CensusApi::Request.format('AIANNH', true).should
-      be('american+indian+area:*')
+      expect(CensusApi::Request.format('AIANNH', true)).to eq('american+indian+area:*')
     end
 
     it 'should not truncate geography type CBSA' do
-      CensusApi::Request.format('CBSA', true).should
-      be('metropolitan+statistical+area/micropolitan+statistical+area:*')
+      expect(CensusApi::Request.format('CBSA', true)).to eq('metropolitan+statistical+area/micropolitan+statistical+area:*')
     end
   end
 end

data/spec/spec_helper.rb

@@ -8,7 +8,3 @@ require 'support/census_examples'
 def api_key
   RSPEC_API_KEY
 end
-
-RSpec.configure do |config|
-  config.extend VCR::RSpec::Macros
-end

data/spec/vcr_setup.rb

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

metadata

@@ -1,31 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: census_api
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.1.0
 platform: ruby
 authors:
 - Ty Rauber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-05 00:00:00.000000000 Z
+date: 2016-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: hpricot
+  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fakeweb
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -139,11 +125,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 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.
+  both the SF1 and ACS5 datasets.
 test_files:
 - spec/api_key.sample.rb
 - spec/census_api/client_spec.rb