govkit 0.1.0 → 0.2.0

data/README.markdown

@@ -3,7 +3,7 @@
 Govkit is a Ruby gem that provides simple access to open government APIs around the web, including:
 
  *  [OpenCongress](http://www.opencongress.org/api), which has an API for federal bills, votes, people, and news and blog coverage
- *  [The Fifty States project](http://fiftystates-dev.sunlightlabs.com/), which has a RESTful API for accessing data about state legislators, bills, votes, etc.
+ *  [The Open States project](http://fiftystates-dev.sunlightlabs.com/), which has a RESTful API for accessing data about state legislators, bills, votes, etc.
  *  [Project Vote Smart](http://www.votesmart.org/services_api.php), which has an API with congressional addresses, etc.
  *  [Follow The Money](http://www.followthemoney.org/), whose API reveals campaign contribution data for state officials.
 
@@ -21,7 +21,7 @@ Run <code>./script/generate govkit</code> to copy a config file into <code>confi
 
 # Examples
 
-    >> Govkit::FiftyStates::State.find_by_abbreviation('CA')
+    >> Govkit::OpenStates::State.find_by_abbreviation('CA')
     >> Govkit::VoteSmart::Address.find(votesmart_candidate_id)
     >> GovKit::OpenCongress::Bill.find(:number => 5479, :type => 'h', :congress => '111')
 

data/Rakefile

@@ -2,13 +2,12 @@ require 'rubygems'
 require 'rake'
 require 'rake/rdoctask'
 
-
 begin
-  require 'spec/rake/spectask'
+  require 'rspec/core/rake_task'
 rescue LoadError
   begin
-    gem 'rspec-rails', '>= 1.0.0'
-    require 'spec/rake/spectask'
+    gem 'rspec-rails', '>= 2.0.0'
+    require 'rspec/core/rake_task'
   rescue LoadError
     puts "[govkit:] RSpec - or one of it's dependencies - is not available. Install it with: sudo gem install rspec-rails"
   end
@@ -19,7 +18,7 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "govkit"
     gem.summary = %Q{Simple access to open government APIs around the web}
-    gem.description = %Q{Govkit lets you quickly get encapsulated Ruby objects for common open government APIs. We're starting with Sunlight's Fifty States API and the Project Vote Smart API.}
+    gem.description = %Q{Govkit lets you quickly get encapsulated Ruby objects for common open government APIs. We're starting with Sunlight's Open States API and the Project Vote Smart API.}
     gem.email = "carl@ppolitics.org"
     gem.homepage = "http://github.com/opengovernment/govkit"
     gem.authors = ["Participatory Politics Foundation", "Srinivas Aki", "Carl Tashian"]

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/generators/govkit/templates/govkit.rb

@@ -1,17 +1,17 @@
 if defined? GovKit
   GovKit.configure do |config|
-    # Get an API key for Sunlight's Fifty States project here:
+    # Get an API key for Sunlight's Open States project here:
     # http://services.sunlightlabs.com/accounts/register/
-    config.fiftystates_apikey = 'YOUR_FIFTYSTATES_API_KEY'
+    config.openstates_apikey = 'YOUR_OPENSTATES_API_KEY'
 
     ##API key for Votesmart
     # http://votesmart.org/services_api.php
     config.votesmart_apikey = 'YOUR_VOTESMART_API_KEY'
-    
+
     # API key for NIMSP. Request one here:
     # http://www.followthemoney.org/membership/settings.phtml
     config.ftm_apikey = 'YOUR_FTM_API_KEY'
-    
+
     # Api key for OpenCongress
     # http://www.opencongress.org/api
     config.opencongress_apikey = 'YOUR_OPENCONGRESS_API_KEY'

data/govkit.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{govkit}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Participatory Politics Foundation", "Srinivas Aki", "Carl Tashian"]
-  s.date = %q{2010-06-10}
-  s.description = %q{Govkit lets you quickly get encapsulated Ruby objects for common open government APIs. We're starting with Sunlight's Fifty States API and the Project Vote Smart API.}
+  s.date = %q{2010-08-31}
+  s.description = %q{Govkit lets you quickly get encapsulated Ruby objects for common open government APIs. We're starting with Sunlight's Open States API and the Project Vote Smart API.}
   s.email = %q{carl@ppolitics.org}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -27,10 +27,10 @@ Gem::Specification.new do |s|
      "generators/govkit/govkit_generator.rb",
      "generators/govkit/templates/govkit.rb",
      "govkit.gemspec",
+     "init.rb",
      "lib/gov_kit.rb",
      "lib/gov_kit/acts_as_citeable.rb",
      "lib/gov_kit/configuration.rb",
-     "lib/gov_kit/fifty_states.rb",
      "lib/gov_kit/follow_the_money.rb",
      "lib/gov_kit/open_congress.rb",
      "lib/gov_kit/open_congress/bill.rb",
@@ -41,15 +41,29 @@ Gem::Specification.new do |s|
      "lib/gov_kit/open_congress/roll_call.rb",
      "lib/gov_kit/open_congress/roll_call_comparison.rb",
      "lib/gov_kit/open_congress/voting_comparison.rb",
+     "lib/gov_kit/open_states.rb",
+     "lib/gov_kit/railtie.rb",
      "lib/gov_kit/resource.rb",
      "lib/gov_kit/search_engines.rb",
      "lib/gov_kit/search_engines/google_blog.rb",
      "lib/gov_kit/search_engines/google_news.rb",
      "lib/gov_kit/search_engines/technorati.rb",
+     "lib/gov_kit/search_engines/wikipedia.rb",
      "lib/gov_kit/vote_smart.rb",
      "lib/govkit.rb",
-     "rails/init.rb",
-     "spec/fifty_states_spec.rb",
+     "spec/fixtures/follow_the_money/business-page0.response",
+     "spec/fixtures/follow_the_money/business-page1.response",
+     "spec/fixtures/follow_the_money/contribution.response",
+     "spec/fixtures/follow_the_money/unauthorized.response",
+     "spec/fixtures/open_states/401.response",
+     "spec/fixtures/open_states/410.response",
+     "spec/fixtures/open_states/bill.response",
+     "spec/fixtures/open_states/bill_query.response",
+     "spec/fixtures/open_states/legislator.response",
+     "spec/fixtures/open_states/legislator_query.response",
+     "spec/fixtures/open_states/state.response",
+     "spec/follow_the_money_spec.rb",
+     "spec/open_states_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
@@ -59,7 +73,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Simple access to open government APIs around the web}
   s.test_files = [
-    "spec/fifty_states_spec.rb",
+    "spec/follow_the_money_spec.rb",
+     "spec/open_states_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/init.rb

@@ -0,0 +1,4 @@
+require File.join(File.dirname(__FILE__), "lib", "govkit")
+require 'gov_kit/railtie'
+
+GovKit::Railtie.insert

data/lib/gov_kit/acts_as_citeable.rb

@@ -37,4 +37,4 @@ module GovKit::ActsAsCiteable
       }
     end
   end
-end
+end

data/lib/gov_kit/configuration.rb

@@ -1,13 +1,13 @@
 module GovKit
   class Configuration
-    attr_accessor :fiftystates_apikey, :fiftystates_base_url
+    attr_accessor :openstates_apikey, :openstates_base_url
     attr_accessor :votesmart_apikey, :votesmart_base_url
     attr_accessor :ftm_apikey, :ftm_base_url
     attr_accessor :opencongress_apikey, :opencongress_base_url
 
     def initialize
-      @fiftystates_apikey = @votesmart_apikey = @ftm_apikey = ''
-      @fiftystates_base_url = 'fiftystates-dev.sunlightlabs.com/api'
+      @openstates_apikey = @votesmart_apikey = @ftm_apikey = ''
+      @openstates_base_url = 'fiftystates-dev.sunlightlabs.com/api'
       @votesmart_base_url = 'api.votesmart.org/'
       @ftm_base_url = 'api.followthemoney.org/'
       @opencongress_base_url = 'www.opencongress.org/'
@@ -22,7 +22,7 @@ module GovKit
   #
   # @example
   #   GovKit.configure do |config|
-  #     config.fiftystates_apikey = ''
+  #     config.openstates_apikey = ''
   #   end
   def self.configure
     self.configuration ||= Configuration.new

data/lib/gov_kit/follow_the_money.rb

@@ -2,6 +2,25 @@ module GovKit
   class FollowTheMoneyResource < Resource
     default_params :key => GovKit::configuration.ftm_apikey
     base_uri GovKit::configuration.ftm_base_url
+
+    def self.get_xml(path, options)
+      response = get(path, options)
+      doc = Hpricot::XML(response)
+
+      e = doc.search("//error")
+
+      # API Key invalid
+      if e.size > 0
+        raise case e.first.attributes['code']
+        when "100"
+          GovKit::NotAuthorized
+        when "300"
+          GovKit::InvalidRequest
+        end, e.first.attributes['text']
+      end
+
+      doc
+    end
   end
 
   module FollowTheMoney
@@ -9,12 +28,10 @@ module GovKit
       def self.list
         next_page, result, page_num = "yes", [], 0
 
-        until next_page == "no"
-          puts "Getting batch number #{page_num}"
-
-          response = get("/base_level.industries.list.php", :query => {:page => page_num})
+        until next_page != "yes"
+          # puts "Getting batch number #{page_num}"
 
-          doc = Hpricot::XML(response)
+          doc = get_xml("/base_level.industries.list.php", :query => {:page => page_num})
 
           next_page = doc.search("/").first.attributes['next_page']
 
@@ -33,9 +50,8 @@ module GovKit
       def self.find(nimsp_id)
         next_page, result, page_num = "yes", [], 0
 
-        until next_page == "no"
-          response = get("/candidates.contributions.php", :query => {"imsp_candidate_id" => nimsp_id, :page => page_num})
-          doc = Hpricot::XML(response)
+        until next_page != "yes"
+          doc = get_xml("/candidates.contributions.php", :query => {"imsp_candidate_id" => nimsp_id, :page => page_num})
 
           next_page = doc.search("/").first.attributes['next_page']
 
@@ -49,8 +65,8 @@ module GovKit
       end
 
       def self.top(nimsp_id)
-        response = get("/candidates.top_contributor.php", :query => {"imsp_candidate_id" => nimsp_id})
-        doc = Hpricot::XML(response)
+        doc = get_xml("/candidates.top_contributor.php", :query => {"imsp_candidate_id" => nimsp_id})
+
         result = doc.search('//top_contributor').collect do |contribution|
           contribution.attributes.to_hash
         end
@@ -61,8 +77,7 @@ module GovKit
 
     class IndustryContribution < Contribution
       def self.find(nimsp_id)
-        response = get("/candidates.industries.php", :query => {"imsp_candidate_id" => nimsp_id})
-        doc = Hpricot::XML(response)
+        doc = get_xml("/candidates.industries.php", :query => {"imsp_candidate_id" => nimsp_id})
 
         result = doc.search('//candidate_industry').collect do |contribution|
           contribution.attributes.to_hash
@@ -74,8 +89,7 @@ module GovKit
 
     class SectorContribution < Contribution
       def self.find(nimsp_id)
-        response = get("/candidates.sectors.php", :query => {"imsp_candidate_id" => nimsp_id})
-        doc = Hpricot::XML(response)
+        doc = get_xml("/candidates.sectors.php", :query => {"imsp_candidate_id" => nimsp_id})
 
         result = doc.search('//candidate_sector').collect do |contribution|
           contribution.attributes.to_hash
@@ -87,8 +101,8 @@ module GovKit
 
     class BusinessContribution < Contribution
       def self.find(nimsp_id)
-        response = get("/candidates.businesses.php", :query => {"imsp_candidate_id" => nimsp_id})
-        doc = Hpricot::XML(response)
+        doc = get_xml("/candidates.businesses.php", :query => {"imsp_candidate_id" => nimsp_id})
+
         result = doc.search('//candidate_business').collect do |contribution|
           contribution.attributes.to_hash
         end

data/lib/gov_kit/{fifty_states.rb → open_states.rb}

@@ -1,23 +1,23 @@
 module GovKit
-  class FiftyStatesResource < Resource
-    default_params :output => 'json', :apikey => GovKit::configuration.fiftystates_apikey
-    base_uri GovKit::configuration.fiftystates_base_url
+  class OpenStatesResource < Resource
+    default_params :output => 'json', :apikey => GovKit::configuration.openstates_apikey
+    base_uri GovKit::configuration.openstates_base_url
   end
 
-  module FiftyStates
+  module OpenStates
     ROLE_MEMBER = "member"
     ROLE_COMMITTEE_MEMBER = "committee member"
     CHAMBER_UPPER = "upper"
     CHAMBER_LOWER = "lower"
 
-    class State < FiftyStatesResource
+    class State < OpenStatesResource
       def self.find_by_abbreviation(abbreviation)
-        response = get("/#{abbreviation}")
+        response = get("/#{abbreviation}/")
         instantiate_record(response)
       end
     end
 
-    class Bill < FiftyStatesResource
+    class Bill < OpenStatesResource
       # http://fiftystates-dev.sunlightlabs.com/api/ca/20092010/lower/bills/AB667/
       def self.find(state_abbrev, session, chamber, bill_id)
         response = get("/#{state_abbrev}/#{session}/#{chamber}/bills/#{bill_id}/")
@@ -25,7 +25,7 @@ module GovKit
       end
 
       def self.search(query, options = {})
-        response = get('/bills/search', :query => {:q => query}.merge(options))
+        response = get('/bills/search/', :query => {:q => query}.merge(options))
         instantiate_collection(response)
       end
 
@@ -35,21 +35,33 @@ module GovKit
       end
     end
 
-    class Legislator < FiftyStatesResource
+    class Legislator < OpenStatesResource
       def self.find(legislator_id)
-        response = get("/legislators/#{legislator_id}")
+        response = get("/legislators/#{legislator_id}/")
         instantiate_record(response)
       end
 
       def self.search(options = {})
-        response = get('/legislators/search', :query => options)
+        response = get('/legislators/search/', :query => options)
         instantiate_collection(response)
       end
     end
 
-    class Vote < FiftyStatesResource
+    class Role < OpenStatesResource; end
+
+    class Sponsor < OpenStatesResource; end
+
+    class Version < OpenStatesResource; end
+
+    class Source < OpenStatesResource; end
+
+    class Address < OpenStatesResource; end
+
+    class Action < OpenStatesResource; end
+
+    class Vote < OpenStatesResource
       def self.find(vote_id)
-        response = get("/votes/#{vote_id}")
+        response = get("/votes/#{vote_id}/")
         instantiate_record(response)
       end
     end

data/lib/gov_kit/railtie.rb

@@ -0,0 +1,20 @@
+require 'govkit'
+
+module GovKit
+  if defined? Rails::Railtie
+    require 'rails'
+    class Railtie < Rails::Railtie
+      initializer 'govkit.insert_into_active_record' do
+        ActiveSupport.on_load :active_record do
+          GovKit::Railtie.insert
+        end
+      end
+    end
+  end
+
+  class Railtie
+    def self.insert
+      ActiveRecord::Base.send(:include, GovKit::ActsAsCiteable)
+    end
+  end
+end

data/lib/gov_kit/resource.rb

@@ -1,29 +1,4 @@
 module GovKit
-  class GovKitError < StandardError
-    attr_reader :response
-
-    def initialize(response, message = nil)
-      @response = response
-      @message  = message
-    end
-
-    def to_s
-      "Failed with #{response.code} #{response.message if response.respond_to?(:message)}"
-    end
-  end
-
-  class NotauthorizedError < GovKitError;
-  end
-
-  class InvalidRequestError < GovKitError;
-  end
-
-  class NotFoundError < GovKitError;
-  end
-
-  class NameError < GovKitError;
-  end
-
   class Resource
     include HTTParty
     format :json
@@ -37,6 +12,7 @@ module GovKit
 
     class << self
       def instantiate_record(record)
+        raise ResourceNotFound, "Resource not found" unless !record.blank?
         new(record)
       end
 
@@ -45,7 +21,16 @@ module GovKit
       end
 
       def parse(json)
-        instantiate_record(json)
+        instantiate(json)
+      end
+
+      def instantiate(record)
+        case record
+          when Array
+            instantiate_collection(record)
+          when Hash
+            instantiate_record(record)
+        end
       end
     end
 
@@ -78,12 +63,8 @@ module GovKit
       find_or_create_resource_for(name.to_s.singularize)
     end
 
-    def find_resource_in_modules(resource_name, module_names)
-      receiver = Object
-      namespaces = module_names[0, module_names.size-1].map do |module_name|
-        receiver = receiver.const_get(module_name)
-      end
-      if namespace = namespaces.reverse.detect { |ns| ns.const_defined?(resource_name) }
+    def find_resource_in_modules(resource_name, ancestors)
+      if namespace = ancestors.detect { |a| a.constants.include?(resource_name.to_sym) }
         return namespace.const_get(resource_name)
       else
         raise NameError, "Namespace for #{namespace} not found"
@@ -91,10 +72,9 @@ module GovKit
     end
 
     def find_or_create_resource_for(name)
-      resource_name = name.to_s.camelize
-      ancestors = self.class.name.split("::")
-      if ancestors.size > 1
-        find_resource_in_modules(resource_name, ancestors)
+      resource_name = name.to_s.gsub(/^_/,'').gsub(/^(\d)/, "n#{$1}").gsub(/\s/, '').camelize
+      if self.class.parents.size > 1
+        find_resource_in_modules(resource_name, self.class.parents)
       else
         self.class.const_get(resource_name)
       end
@@ -114,7 +94,7 @@ module GovKit
         when "="
           attributes[method_name.first(-1)] = arguments.first
         when "?"
-          attributes[method_name.first(-1)]
+          !attributes[method_name.first(-1)].blank?
         when "]"
           attributes[arguments.first.to_s]
         else

data/lib/gov_kit/search_engines/google_news.rb

@@ -18,11 +18,11 @@ module GovKit
         stories.each do |story|
           citation = GovKit::Citation.new
 
-          citation.title = story.at("h2.title a").inner_text.html_safe!
+          citation.title = story.at("h2.title a").inner_text.html_safe
           citation.url = story.at("h2.title a").attributes["href"]
-          citation.date = story.at("div.sub-title > span.date").inner_html.html_safe!
-          citation.source = story.at("div.sub-title > span.source").inner_html.html_safe!
-          citation.excerpt = story.at("div.body > div.snippet").inner_html.html_safe!
+          citation.date = story.at("div.sub-title > span.date").inner_html.html_safe
+          citation.source = story.at("div.sub-title > span.source").inner_html.html_safe
+          citation.excerpt = story.at("div.body > div.snippet").inner_html.html_safe
 
           citations << citation
         end

data/lib/gov_kit/search_engines/wikipedia.rb

@@ -0,0 +1,21 @@
+module GovKit
+  module SearchEngines
+    class Wikipedia
+      include HTTParty
+      default_params :format => 'xml'
+      base_uri "en.wikipedia.org"
+      headers 'User-Agent' => 'GovKit +http://opengovernment.org'
+
+      def self.search(query, options={})
+        response = get("/wiki/#{query}")
+        doc = Hpricot(Iconv.conv('utf-8//IGNORE', 'gb2312', response))
+
+        doc.at('#bodyContent > table.toc').previous_sibling.inner_html.scrub rescue ""
+      end
+
+      def self.make_request(host, path)
+        response = Net::HTTP.get(host, path)
+      end
+    end
+  end
+end

data/lib/gov_kit/search_engines.rb

@@ -2,4 +2,5 @@ module GovKit::SearchEngines
   autoload :GoogleNews, 'gov_kit/search_engines/google_news'
   autoload :GoogleBlog, 'gov_kit/search_engines/google_blog'
   autoload :Technorati, 'gov_kit/search_engines/technorati'
+  autoload :Wikipedia, 'gov_kit/search_engines/wikipedia'
 end

data/lib/gov_kit/vote_smart.rb

@@ -19,16 +19,80 @@ module GovKit
       end
     end
 
+    class Bio < VoteSmartResource
+      def self.find(candidate_id)
+        response = get("/CandidateBio.getBio", :query => {"candidateId" => candidate_id})
+        instantiate_record(response['bio']['candidate'])
+      end
+    end
+
+    class Category < VoteSmartResource
+      def self.list(state_id)
+        response = get("/Rating.getCategories", :query => {"stateId" => state_id})
+        instantiate(response['categories']['category'])
+      end
+    end
+
+    class SIG < VoteSmartResource
+      def self.list(category_id, state_id)
+        response = get("/Rating.getSigList", :query => {"categoryId" => category_id, "stateId" => state_id})
+
+        raise(ResourceNotFound, response['error']['errorMessage']) if response['error'] && response['error']['errorMessage'] == 'No SIGs fit this criteria.'
+
+        instantiate(response['sigs']['sig'])
+      end
+
+      def self.find(sig_id)
+        response = get("/Rating.getSig", :query => {"sigId" => sig_id})
+        instantiate(response['sig'])
+      end
+    end
+
+    class Rating < VoteSmartResource
+      def self.find(candidate_id, sig_id)
+        response = get("/Rating.getCandidateRating", :query => {"candidateId" => candidate_id, "sigId" => sig_id})
+
+        raise(ResourceNotFound, response['error']['errorMessage']) if response['error'] && response['error']['errorMessage'] == 'No Ratings fit this criteria.'
+
+        instantiate(response['candidateRating']['rating'])
+      end
+    end
+
     class Bill < VoteSmartResource
       def self.find(bill_id)
-        response = get("/Votes.getBill", :query => {"billId" => bill_id})
+        response = get('/Votes.getBill', :query => {'billId' => bill_id})
         instantiate_record(response['bill'])
       end
 
       def self.find_by_year_and_state(year, state_abbrev)
-        response = get("/Votes.getBillsByYearState", :query => {"year" => year, "stateId" => state_abbrev})
+        response = get('/Votes.getBillsByYearState', :query => {'year' => year, 'stateId' => state_abbrev})
+        raise(ResourceNotFound, response['error']['errorMessage']) if response['error'] && response['error']['errorMessage'] == 'No bills for this state and year.'
+
+        instantiate_record(response['bills'])
+      end
+
+      def self.find_recent_by_state(state_abbrev)
+        response = get('/Votes.getBillsByStateRecent', :query => {'stateId' => state_abbrev})
         instantiate_record(response['bills'])
       end
+      
+      def self.find_by_category_and_year_and_state(category_id, year, state_abbrev = nil)
+        response = get('/Votes.getBillsByCategoryYearState', :query => {'stateId' => state_abbrev, 'year' => year, 'categoryId' => category_id})
+        raise(ResourceNotFound, response['error']['errorMessage']) if response['error'] && response['error']['errorMessage'] == 'No bills for this state, category, and year.'
+
+        instantiate_record(response['bills'])
+      end
+
+      def self.find_by_category_and_year(category_id, year)
+        find_by_category_and_year_and_state(category_id, year)
+      end
+    end
+    
+    class BillCategory < VoteSmartResource
+      def self.find(year, state_abbrev)
+        response = get("/Votes.getCategories", :query => {'year' => year, 'stateId' => state_abbrev})
+        instantiate(response['categories']['category'])
+      end
     end
 
     # See http://api.votesmart.org/docs/Committee.html
@@ -37,13 +101,13 @@ module GovKit
       # If type_id is nil, defaults to all types.
       # This method maps to Committee.getCommitteesByTypeState()
       def self.find_by_type_and_state(type_id, state_abbrev)
-        response = get("/Committee.getCommitteesByTypeState", :query => {"typeId" => type_id, "stateId" => state_abbrev})
+        response = get('/Committee.getCommitteesByTypeState', :query => {'typeId' => type_id, 'stateId' => state_abbrev})
         instantiate_record(response['committees'])
       end
 
       # Find a committee by VoteSmart committeeId. Maps to Committee.getCommittee()
       def self.find(committee_id)
-        response = get("/Committee.getCommittee", :query => {"committeeId" => committee_id})
+        response = get('/Committee.getCommittee', :query => {'committeeId' => committee_id})
         instantiate_record(response['committee'])
       end
     end