usatoday-census 0.0.3 → 0.0.4

data/README.md

@@ -26,11 +26,16 @@ or via an environment variable:
     API_KEY = ENV['USAT_CENSUS_API_KEY']
     Base.api_key = API_KEY
   
-The gem queries the USA TODAY Census API to return information about a state's population, ethnicity, housing, racial composition and other geographic details, including the USA TODAY Diversity Index. The initial version of the gem supports state-level requests, so the results will be for states only. Future support for other geographic levels (National, County and City or Town) will be added soon. Users can search for a state by its postal abbreviation or name:
+The gem queries the USA TODAY Census API to return information about a state's population, ethnicity, housing, racial composition and other geographic details, including the USA TODAY Diversity Index. Requests return an array of results and the default geographic level is statewide. Users can search for a state by its postal abbreviation or name. To request results for other geographic levels (National, County and City or Town), you can pass the corresponding "sumlevid" to the search method. The following all return an array consisting of a single object containing statewide results:
 
     Location.search('va') # find demographic information about Virginia
     Ethnicity.search("Virginia", "Placename") # can also search by full state name using the Placename attribute.
     Race.search("51", 'FIPS') # Or search by FIPS code, too.
+    
+These requests return an array of result objects at the county level:
+  
+    Location.search('va', nil, 3) # find demographic information about Virgina counties using the state abbreviation.
+    Ethnicity.search("Virginia", "Placename", 3) # find ethnicity information for Virginia counties.
 
 Check out the tests for further examples. Run the tests via rake test. Note: you'll need to set your API key as an environment variable before running the tests. The API has a limit of two queries per second, so the test requests are delayed by one second to ensure passage.
 

data/lib/usatoday-census/base.rb

@@ -43,9 +43,10 @@ module Usatoday
         value.to_f
       end
     
-      def self.prepare_params(method, keyname=nil)
+      def self.prepare_params(method, keyname=nil, sumlevid=2)
         params = {"keypat" => method }
         params["keyname"] = keyname if keyname
+        params.merge({'sumlevid'=>sumlevid})
         params
       end
 
@@ -62,7 +63,7 @@ module Usatoday
           parsed_reply = JSON.parse reply
           
           raise BadResponseError, "Empty reply returned from API" if parsed_reply.nil?
-          parsed_reply['response'].first
+          response = parsed_reply['response']
         rescue OpenURI::HTTPError => e
           case e.message
             when /^400/

data/lib/usatoday-census/ethnicity.rb

@@ -26,15 +26,17 @@ module Usatoday
         :pct_non_hispanic_white => float_field(params['PctNonHispWhite']),
         :usat_diversity_index => float_field(params['USATDiversityIndex'])
         )
-        ethnicity
       end
       
-      def self.search(keypat, keyname=nil)
-        params = prepare_params(keypat, keyname)
+      def self.search(keypat, keyname=nil, sumlevid=2)
+        result = []
+        params = prepare_params(keypat, keyname, sumlevid)
   			response = invoke('ethnicity', params)
-  			init_from_api(response)
-      end   
-      
+  			response.each do |r|
+    			result << init_from_api(r)
+    		end
+    		result
+      end
     end
   end
 end

data/lib/usatoday-census/housing.rb

@@ -28,10 +28,14 @@ module Usatoday
         housing
       end
       
-      def self.search(keypat, keyname=nil)
-        params = prepare_params(keypat, keyname)
+      def self.search(keypat, keyname=nil, sumlevid=2)
+        result = []
+        params = prepare_params(keypat, keyname, sumlevid)
   			response = invoke('housing', params)
-  			init_from_api(response)
+  			response.each do |r|
+    			result << init_from_api(r)
+    		end
+    		result
       end   
       
     end

data/lib/usatoday-census/location.rb

@@ -46,13 +46,16 @@ module Usatoday
         :longitude => float_field(params['Long']),
         :pct_vacant => float_field(params['PctVacant'])
         )
-        location
       end
     
-      def self.search(keypat, keyname=nil)
-        params = prepare_params(keypat, keyname)
+      def self.search(keypat, keyname=nil, sumlevid=2)
+        result = []
+        params = prepare_params(keypat, keyname, sumlevid)
   			response = invoke('locations', params)
-  			init_from_api(response)
+  			response.each do |r|
+    			result << init_from_api(r)
+    		end
+    		result
       end
     end
   end

data/lib/usatoday-census/population.rb

@@ -30,9 +30,13 @@ module Usatoday
       end
       
       def self.search(keypat, keyname=nil)
+        result = []
         params = prepare_params(keypat, keyname)
   			response = invoke('population', params)
-  			init_from_api(response)
+  			response.each do |r|
+    			result << init_from_api(r)
+    		end
+    		result
       end   
       
     end

data/lib/usatoday-census/race.rb

@@ -33,9 +33,13 @@ module Usatoday
       end
       
       def self.search(keypat, keyname=nil)
+        result = []
         params = prepare_params(keypat, keyname)
   			response = invoke('race', params)
-  			init_from_api(response)
+  			response.each do |r|
+    			result << init_from_api(r)
+    		end
+    		result
       end   
       
     end

data/lib/usatoday-census/version.rb

@@ -1,5 +1,5 @@
 module Usatoday
   module Census
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/test/usatoday-census/test_ethnicity.rb

@@ -5,7 +5,7 @@ class TestUsatoday::TestEthnicity < Test::Unit::TestCase
 		setup do
 		  sleep(1)
 		  response = Base.invoke('ethnicity', {'keypat' => 'pa'})
-			@ethnicity = Ethnicity.init_from_api(response)
+			@ethnicity = Ethnicity.init_from_api(response.first)
 		end
 		
 		should "return an object of the Ethnicity type" do
@@ -13,24 +13,45 @@ class TestUsatoday::TestEthnicity < Test::Unit::TestCase
 		end
   end
   
-  context "Ethnicity.new with placename" do
+  context "Ethnicity.search with placename" do
     setup do
       sleep(1)
-      @ethnicity = Ethnicity.search('Virginia', 'Placename')
+      @ethnicity = Ethnicity.search('Virginia', 'Placename').first
     end
 		should "return an object of the Ethnicity type" do
 			assert_kind_of(Ethnicity, @ethnicity)
 		end
+		should "return the correct results" do
+		  @ethnicity.pct_hispanic == 0.078968
+	  end
+		
 	end
 	
-  context "Ethnicity.new with FIPS" do
+  context "Ethnicity.search with FIPS" do
     setup do
       sleep(1)
-      @ethnicity = Ethnicity.search(51, 'FIPS')
+      @ethnicity = Ethnicity.search(51, 'FIPS').first
     end
 		should "return an object of the Ethnicity type" do
 			assert_kind_of(Ethnicity, @ethnicity)
 		end
+		should "return the correct results" do
+		  @ethnicity.pct_hispanic == 0.078968
+	  end
 	end
 	
+	context "Ethnicity.search with abbrev and county level" do
+	  setup do
+	    sleep(1)
+	    @ethnicities = Ethnicity.search('va', nil, 3)
+	  end
+	  should "return multiple ethnicity objects" do
+	    @ethnicities.size > 0
+	  end
+	  
+	  should "return the correct place name for the first result" do
+	    @ethnicities.first.place_name == 'Accomack'
+	  end
+	  
+	end
 end

data/test/usatoday-census/test_housing.rb

@@ -4,7 +4,7 @@ class TestUsatoday::TestHousing < Test::Unit::TestCase
 		setup do
 		  sleep(1)
 		  response = Base.invoke('housing', {'keypat' => 'va'})
-			@housing = Housing.init_from_api(response)
+			@housing = Housing.init_from_api(response.first)
 		end
 		
 		should "return an object of the Housing type" do
@@ -15,21 +15,27 @@ class TestUsatoday::TestHousing < Test::Unit::TestCase
   context "Housing.new with placename" do
     setup do
       sleep(1)
-      @housing = Housing.search('Virginia', 'Placename')
+      @housing = Housing.search('Virginia', 'Placename').first
     end
 		should "return an object of the Housing type" do
 			assert_kind_of(Housing, @housing)
 		end
+		should "return the correct results" do
+		  @housing.housing_units == 3364939
+	  end
 	end
 
   context "Housing.new with FIPS" do
     setup do
       sleep(1)
-      @housing = Housing.search(51, 'FIPS')
+      @housing = Housing.search(51, 'FIPS').first
     end
 		should "return an object of the Housing type" do
 			assert_kind_of(Housing, @housing)
 		end
+		should "return the correct results" do
+		  @housing.housing_units == 3364939
+	  end
 	end
 
 

data/test/usatoday-census/test_location.rb

@@ -4,7 +4,7 @@ class TestUsatoday::TestLocation < Test::Unit::TestCase
 		setup do
 		  sleep(1)
 		  response = Base.invoke('locations', {'keypat' => 'va'})
-			@location = Location.init_from_api(response)
+			@location = Location.init_from_api(response.first)
 		end
 		
 		should "return an object of the Location type" do
@@ -15,21 +15,43 @@ class TestUsatoday::TestLocation < Test::Unit::TestCase
   context "Location.new with placename" do
     setup do
       sleep(1)
-      @location = Location.search('Virginia', 'Placename')
+      @location = Location.search('Virginia', 'Placename').first
     end
 		should "return an object of the Location type" do
 			assert_kind_of(Location, @location)
 		end
+		
+		should "return the correct hash of names" do
+		  @location.state_postal == "VA"
+	  end
 	end
 
   context "Location.new with FIPS" do
     setup do
       sleep(1)
-      @location = Location.search(51, 'FIPS')
+      @location = Location.search(51, 'FIPS').first
     end
 		should "return an object of the Location type" do
 			assert_kind_of(Location, @location)
 		end
+		
+		should "return the correct result" do
+		  @location.population == 8001024 
+	  end
+	end
+
+	context "Location.search with abbrev and county level" do
+	  setup do
+	    sleep(1)
+	    @locations = Location.search('va', nil, 3)
+	  end
+	  should "return multiple Location objects" do
+	    @locations.size > 0
+	  end
+	  
+	  should "return the correct place" do
+	    @locations.first.place_name == 'Accomack'
+	  end
 	end
 
 

data/test/usatoday-census/test_population.rb

@@ -4,7 +4,7 @@ class TestUsatoday::TestPopulation < Test::Unit::TestCase
 		setup do
 		  sleep(1)
 		  response = Base.invoke('population', {'keypat' => 'va'})
-			@population = Population.init_from_api(response)
+			@population = Population.init_from_api(response.first)
 		end
 		
 		should "return an object of the Population type" do
@@ -15,21 +15,27 @@ class TestUsatoday::TestPopulation < Test::Unit::TestCase
   context "Population.new with placename" do
     setup do
       sleep(1)
-      @population = Population.search('Virginia', 'Placename')
+      @population = Population.search('Virginia', 'Placename').first
     end
 		should "return an object of the Population type" do
 			assert_kind_of(Population, @population)
 		end
+		should "return the correct results" do
+		  @population.population_density == 202.6
+	  end
 	end
 
   context "Population.new with FIPS" do
     setup do
       sleep(1)
-      @population = Population.search(51, 'FIPS')
+      @population = Population.search(51, 'FIPS').first
     end
 		should "return an object of the Population type" do
 			assert_kind_of(Population, @population)
 		end
+		should "return the correct results" do
+  	  @population.population_density == 202.6
+    end
 	end
 
 

data/test/usatoday-census/test_race.rb

@@ -4,7 +4,7 @@ class TestUsatoday::TestRace < Test::Unit::TestCase
 		setup do
 		  sleep(1)
 		  response = Base.invoke('race', {'keypat' => 'va'})
-			@race = Race.init_from_api(response)
+			@race = Race.init_from_api(response.first)
 		end
 		
 		should "return an object of the Race type" do
@@ -15,21 +15,27 @@ class TestUsatoday::TestRace < Test::Unit::TestCase
   context "Race.new with placename" do
     setup do
       sleep(1)
-      @race = Race.search('Virginia', 'Placename')
+      @race = Race.search('Virginia', 'Placename').first
     end
 		should "return an object of the Race type" do
 			assert_kind_of(Race, @race)
 		end
+		should "return the correct results" do 
+		  @race.pct_white == 0.685769 
+	  end
 	end
 
   context "Race.new with FIPS" do
     setup do
       sleep(1)
-      @race = Race.search(51, 'FIPS')
+      @race = Race.search(51, 'FIPS').first
     end
 		should "return an object of the Race type" do
 			assert_kind_of(Race, @race)
 		end
+    should "return the correct results" do 
+		  @race.pct_white == 0.685769 
+	  end
 	end
 
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: usatoday-census
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Derek Willis
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-09 00:00:00 -04:00
+date: 2011-06-26 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -81,7 +81,6 @@ files:
 - lib/usatoday-census/housing.rb
 - lib/usatoday-census/location.rb
 - lib/usatoday-census/population.rb
-- lib/usatoday-census/query.rb
 - lib/usatoday-census/race.rb
 - lib/usatoday-census/version.rb
 - test/test_helper.rb
@@ -121,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: usatoday-census
-rubygems_version: 1.6.2
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Wrapper for USA Today Census API

data/lib/usatoday-census/query.rb

@@ -1,28 +0,0 @@
-require 'digest'
-
-module Usatoday
-  module Census
-	  ##
-	  # The Query class represents a single query to the Census API.  Supports
-	  # all of the named parameters to C.search as accessor methods.
-	  #
-	  class Query
-      FIELDS = [:only_facets, :except_facets, :begin_date, :end_date, :since, 
-	              :before, :fee, :has_thumbnail, :facets, :fields, :query, :offset] + Article::TEXT_FIELDS.map{|f| f.to_sym}
-      FIELDS.each {|f| attr_accessor f}
-      
-      # Produce a hash which uniquely identifies this query
-      def hash
-        strs = FIELDS.collect {|f| "#{f}:#{send(f).inspect}"}
-        Digest::SHA256.hexdigest(strs.join(' '))
-      end
-      
-      # Perform this query.  Returns result of Article.search
-      def perform
-        params = {}
-        FIELDS.each {|f| params[f] = send(f) unless send(f).nil?}
-        Article.search(params)
-      end
-    end
-  end
-end