govkit 0.0.2 → 0.1.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Carl Tashian
+Copyright (c) 2010 Participatory Politics Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -1,6 +1,11 @@
 # Govkit
 
-Govkit is a Ruby gem that provides simple access to open government APIs around the web.
+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.
+ *  [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.
 
 # Installation
 
@@ -14,14 +19,11 @@ Add govkit to your environment.rb or Gemfile
 
 Run <code>./script/generate govkit</code> to copy a config file into <code>config/initializers/govkit.rb</code>. You will need to add your API keys to this config file.
 
-# Example
-
-[http://fiftystates-dev.sunlightlabs.com/](The Fifty States project) has a RESTful API for accessing data about state legislators, bills, votes, etc.
+# Examples
 
     >> Govkit::FiftyStates::State.find_by_abbreviation('CA')
-    >> Govkit::VoteSmart::Address.find(legislator_id)
-
-(TODO: add usage examples...)
+    >> Govkit::VoteSmart::Address.find(votesmart_candidate_id)
+    >> GovKit::OpenCongress::Bill.find(:number => 5479, :type => 'h', :congress => '111')
 
 # Bugs? Questions?
 

data/Rakefile

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'rake/rdoctask'
 
+
 begin
   require 'spec/rake/spectask'
 rescue LoadError
@@ -23,7 +24,8 @@ begin
     gem.homepage = "http://github.com/opengovernment/govkit"
     gem.authors = ["Participatory Politics Foundation", "Srinivas Aki", "Carl Tashian"]
     gem.add_dependency('httparty', '>= 0.5.2')
-    gem.add_dependency('json', '>= 1.2.4')
+    gem.add_dependency('json', '>= 1.4.3')
+    gem.add_dependency('hpricot', '>= 0.8.2')
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/USAGE

@@ -0,0 +1 @@
+See README.markdown for full usage details.

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.1.0

data/generators/govkit/templates/govkit.rb

@@ -1,9 +1,19 @@
 if defined? GovKit
-
   GovKit.configure do |config|
     # Get an API key for Sunlight's Fifty States project here:
     # http://services.sunlightlabs.com/accounts/register/
     config.fiftystates_apikey = 'YOUR_FIFTYSTATES_API_KEY'
-  end
 
+    ##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'
+  end
 end

data/govkit.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{govkit}
-  s.version = "0.0.2"
+  s.version = "0.1.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-05-14}
+  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.email = %q{carl@ppolitics.org}
   s.extra_rdoc_files = [
@@ -28,14 +28,26 @@ Gem::Specification.new do |s|
      "generators/govkit/templates/govkit.rb",
      "govkit.gemspec",
      "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",
+     "lib/gov_kit/open_congress/blog_post.rb",
+     "lib/gov_kit/open_congress/news_post.rb",
+     "lib/gov_kit/open_congress/person.rb",
+     "lib/gov_kit/open_congress/person_stat.rb",
+     "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/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/vote_smart.rb",
      "lib/govkit.rb",
-     "lib/govkit/configuration.rb",
-     "lib/govkit/fifty_states.rb",
-     "lib/govkit/vote_smart.rb",
      "rails/init.rb",
      "spec/fifty_states_spec.rb",
      "spec/spec.opts",
@@ -44,7 +56,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/opengovernment/govkit}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  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",
@@ -55,16 +67,19 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<httparty>, [">= 0.5.2"])
-      s.add_runtime_dependency(%q<json>, [">= 1.2.4"])
+      s.add_runtime_dependency(%q<json>, [">= 1.4.3"])
+      s.add_runtime_dependency(%q<hpricot>, [">= 0.8.2"])
     else
       s.add_dependency(%q<httparty>, [">= 0.5.2"])
-      s.add_dependency(%q<json>, [">= 1.2.4"])
+      s.add_dependency(%q<json>, [">= 1.4.3"])
+      s.add_dependency(%q<hpricot>, [">= 0.8.2"])
     end
   else
     s.add_dependency(%q<httparty>, [">= 0.5.2"])
-    s.add_dependency(%q<json>, [">= 1.2.4"])
+    s.add_dependency(%q<json>, [">= 1.4.3"])
+    s.add_dependency(%q<hpricot>, [">= 0.8.2"])
   end
 end
 

data/lib/gov_kit/acts_as_citeable.rb

@@ -0,0 +1,40 @@
+module GovKit::ActsAsCiteable
+
+  def self.included(base)
+    base.extend ActMethods
+  end
+
+  module ActMethods
+    def acts_as_citeable(options={})
+      options[:keywords] ||= []
+
+      class_inheritable_accessor :options
+      self.options = options
+
+      unless included_modules.include? InstanceMethods
+        extend ClassMethods
+        include InstanceMethods
+      end
+    end
+  end
+
+  module ClassMethods
+  end
+
+  module InstanceMethods
+
+    def raw_citations
+      params = self.options[:keywords].clone
+      attributes = self.options[:with].clone
+
+      attributes.each do |attr|
+        params << self.instance_eval("#{attr}")
+      end
+      {
+        :google_news => GovKit::SearchEngines::GoogleNews.search(params),
+        :google_blogs => GovKit::SearchEngines::GoogleBlog.search(params),
+        :technorati => GovKit::SearchEngines::Technorati.search(params)
+      }
+    end
+  end
+end

data/lib/gov_kit/configuration.rb

@@ -2,13 +2,15 @@ module GovKit
   class Configuration
     attr_accessor :fiftystates_apikey, :fiftystates_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 = ''
+      @fiftystates_apikey = @votesmart_apikey = @ftm_apikey = ''
       @fiftystates_base_url = 'fiftystates-dev.sunlightlabs.com/api'
-
-      @votesmart_apikey = ''
       @votesmart_base_url = 'api.votesmart.org/'
+      @ftm_base_url = 'api.followthemoney.org/'
+      @opencongress_base_url = 'www.opencongress.org/'
     end
   end
 

data/lib/gov_kit/follow_the_money.rb

@@ -0,0 +1,100 @@
+module GovKit
+  class FollowTheMoneyResource < Resource
+    default_params :key => GovKit::configuration.ftm_apikey
+    base_uri GovKit::configuration.ftm_base_url
+  end
+
+  module FollowTheMoney
+    class Business < FollowTheMoneyResource
+      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})
+
+          doc = Hpricot::XML(response)
+
+          next_page = doc.search("/").first.attributes['next_page']
+
+          page_num += 1
+
+          result += doc.search('//business_detail').collect do |business|
+            business.attributes.to_hash
+          end
+        end
+
+        instantiate_collection(result)
+      end
+    end
+
+    class Contribution < FollowTheMoneyResource
+      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)
+
+          next_page = doc.search("/").first.attributes['next_page']
+
+          page_num += 1
+
+          result = doc.search('//contribution').collect do |contribution|
+            contribution.attributes.to_hash
+          end
+        end
+        instantiate_collection(result)
+      end
+
+      def self.top(nimsp_id)
+        response = get("/candidates.top_contributor.php", :query => {"imsp_candidate_id" => nimsp_id})
+        doc = Hpricot::XML(response)
+        result = doc.search('//top_contributor').collect do |contribution|
+          contribution.attributes.to_hash
+        end
+
+        instantiate_collection(result)
+      end
+    end
+
+    class IndustryContribution < Contribution
+      def self.find(nimsp_id)
+        response = get("/candidates.industries.php", :query => {"imsp_candidate_id" => nimsp_id})
+        doc = Hpricot::XML(response)
+
+        result = doc.search('//candidate_industry').collect do |contribution|
+          contribution.attributes.to_hash
+        end
+
+        instantiate_collection(result)
+      end
+    end
+
+    class SectorContribution < Contribution
+      def self.find(nimsp_id)
+        response = get("/candidates.sectors.php", :query => {"imsp_candidate_id" => nimsp_id})
+        doc = Hpricot::XML(response)
+
+        result = doc.search('//candidate_sector').collect do |contribution|
+          contribution.attributes.to_hash
+        end
+
+        instantiate_collection(result)
+      end
+    end
+
+    class BusinessContribution < Contribution
+      def self.find(nimsp_id)
+        response = get("/candidates.businesses.php", :query => {"imsp_candidate_id" => nimsp_id})
+        doc = Hpricot::XML(response)
+        result = doc.search('//candidate_business').collect do |contribution|
+          contribution.attributes.to_hash
+        end
+
+        instantiate_collection(result)
+      end
+    end
+  end
+end

data/lib/gov_kit/open_congress/bill.rb

@@ -0,0 +1,173 @@
+module GovKit
+  module OpenCongress
+    class Bill < OpenCongressObject
+      attr_accessor :bill_type, :id, :introduced, :last_speech, :last_vote_date, :last_vote_roll, :last_vote_where, :last_action, :number, :plain_language_summary, :session, :sponsor, :co_sponsors, :title_full_common, :status, :most_recent_actions, :bill_titles, :recent_blogs, :recent_news, :ident
+    
+      def initialize(params)
+        params.each do |key, value|
+          instance_variable_set("@#{key}", value) if Bill.instance_methods.include? key
+        end      
+      end
+    
+      def ident
+        "#{session}-#{bill_type}#{number}"
+      end
+    
+      def self.find(params)
+
+        url = construct_url("bills", params)
+      
+        if (result = make_call(url))
+          parse_results(result)
+        else
+          nil
+        end
+
+      end
+    
+      def self.most_blogged_bills_this_week
+        url = construct_url("most_blogged_bills_this_week", {})
+        if (result = make_call(url))
+          bills = parse_results(result)
+          return bills
+        else
+          nil
+        end      
+      end
+
+      def self.bills_in_the_news_this_week
+        url = construct_url("bills_in_the_news_this_week", {})
+        if (result = make_call(url))
+          bills = parse_results(result)
+          return bills
+        else
+          nil
+        end      
+      end
+
+      def self.most_tracked_bills_this_week
+        url = construct_url("most_tracked_bills_this_week", {})
+        if (result = make_call(url))
+          bills = parse_results(result)
+          return bills
+        else
+          nil
+        end      
+      end
+
+      def self.most_supported_bills_this_week
+        url = construct_url("most_supported_bills_this_week", {})
+        if (result = make_call(url))
+          bills = parse_results(result)
+          return bills
+        else
+          nil
+        end      
+      end
+
+      def self.most_opposed_bills_this_week
+        url = construct_url("most_opposed_bills_this_week", {})
+        if (result = make_call(url))
+          bills = parse_results(result)
+          return bills
+        else
+          nil
+        end      
+      end
+    
+      def self.find_by_query(q)
+        url = Bill.construct_url("bills_by_query", {:q => q})
+      
+        if (result = make_call(url))
+          bills = parse_results(result)
+        else
+          nil
+        end
+      end          
+
+      def self.find_by_idents(idents)
+        q = []
+        if idents.class.to_s == "Array"
+          q = idents
+        else
+          q = idents.split(',')
+        end
+      
+        url = Bill.construct_url("bills_by_ident", {:ident => q.join(',')})
+      
+        if (result = make_call(url))
+          bills = parse_results(result)
+        else
+          nil
+        end
+      end   
+
+      def opencongress_users_supporting_bill_are_also
+        url = Bill.construct_url("opencongress_users_supporting_bill_are_also/#{ident}", {})
+        if (result = Bill.make_call(url))
+          bills = Bill.parse_supporting_results(result)
+          return bills
+        else
+          nil
+        end
+      end
+
+      def opencongress_users_opposing_bill_are_also
+        url = Bill.construct_url("opencongress_users_opposing_bill_are_also/#{ident}", {})
+        if (result = Bill.make_call(url))
+          bills = Bill.parse_supporting_results(result)
+          return bills
+        else
+          nil
+        end
+      end
+    
+      def self.parse_results(result)
+      
+        bills = []
+        result["bills"].each do |bill|
+        
+          these_recent_blogs = bill["recent_blogs"]
+          blogs = []
+
+          if these_recent_blogs
+            these_recent_blogs.each do |trb|
+              blogs << BlogPost.new(trb)
+            end
+          end
+
+          bill["recent_blogs"] = blogs
+
+
+          these_recent_news = bill["recent_news"]
+          news = []
+          if these_recent_news
+            these_recent_news.each do |trb|
+              news << NewsPost.new(trb)
+            end
+          end
+
+          bill["recent_news"] = news
+
+          these_co_sponsors = bill["co_sponsors"]
+          co_sponsors = []
+          if these_co_sponsors
+            these_co_sponsors.each do |tcs|
+              co_sponsors << Person.new(tcs)
+            end
+          end
+
+          bill["co_sponsors"] = co_sponsors
+
+        
+          bill["sponsor"] = Person.new(bill["sponsor"]) if bill["sponsor"]
+        
+        
+          bills << Bill.new(bill)
+        end
+        bills
+      end
+
+    end
+  end
+end

data/lib/gov_kit/open_congress/blog_post.rb

@@ -0,0 +1,19 @@
+module GovKit
+  module OpenCongress
+  
+    class BlogPost < OpenCongressObject
+    
+      attr_accessor :title, :date, :url, :source_url, :excerpt, :source, :average_rating
+    
+    
+      def initialize(params)
+        params.each do |key, value|
+          instance_variable_set("@#{key}", value) if BlogPost.instance_methods.include? key
+        end      
+      end      
+      
+      
+    end
+  
+  end
+end

data/lib/gov_kit/open_congress/news_post.rb

@@ -0,0 +1,19 @@
+module GovKit
+  module OpenCongress
+
+    class NewsPost < OpenCongressObject
+    
+      attr_accessor :title, :date, :url, :source_url, :excerpt, :source, :average_rating
+    
+    
+      def initialize(params)
+        params.each do |key, value|
+          instance_variable_set("@#{key}", value) if NewsPost.instance_methods.include? key
+        end      
+      end      
+      
+      
+    end
+  
+  end
+end

data/lib/gov_kit/open_congress/person.rb

@@ -0,0 +1,143 @@
+module GovKit
+  module OpenCongress
+  
+    class Person < OpenCongressObject
+    
+      attr_accessor :firstname, :lastname, :bioguideid, :birthday, :district, :email, :gender, :id, :metavid_id, :middlename,
+                    :name, :nickname, :osid, :party, :religion, :state, :title, :unaccented_name, :url, :user_approval,
+                    :youtube_id, :oc_user_comments, :oc_users_tracking, :abstains_percentage, :with_party_percentage, :recent_news,
+                    :recent_blogs, :person_stats
+    
+      def initialize(params)
+        params.each do |key, value|
+          instance_variable_set("@#{key}", value) if Person.instance_methods.include? key
+        end      
+      end
+    
+      def self.find(params)
+
+        url = construct_url("people", params)
+        if (result = make_call(url))
+          people = parse_results(result)
+          return people
+        else
+          nil
+        end
+
+      end
+
+      def self.compare(person1, person2)
+        url = "#{GovKit::configuration.opencongress_base_url}person/compare.json?person1=#{person1.id}&person2=#{person2.id}"
+        if (result = make_call(url))
+          comparison = VotingComparison.new(result["comparison"])
+        else
+          nil
+        end
+      
+      end
+
+      def self.senators_most_in_the_news_this_week
+
+        url = construct_url("senators_most_in_the_news_this_week", {})
+        if (result = make_call(url))
+          people = parse_results(result)
+          return people
+        else
+          nil
+        end
+
+      end
+
+      def self.representatives_most_in_the_news_this_week
+
+        url = construct_url("representatives_most_in_the_news_this_week", {})
+        if (result = make_call(url))
+          people = parse_results(result)
+          return people
+        else
+          nil
+        end
+
+      end
+
+      def self.most_blogged_senators_this_week
+
+        url = construct_url("most_blogged_senators_this_week", {})
+        if (result = make_call(url))
+          people = parse_results(result)
+          return people
+        else
+          nil
+        end
+
+      end
+
+      def self.most_blogged_representatives_this_week
+
+        url = construct_url("most_blogged_representatives_this_week", {})
+        if (result = make_call(url))
+          people = parse_results(result)
+          return people
+        else
+          nil
+        end
+
+      end
+    
+      def opencongress_users_supporting_person_are_also
+        url = Person.construct_url("opencongress_users_supporting_person_are_also/#{id}", {})
+        if (result = Person.make_call(url))
+          people = Person.parse_supporting_results(result)
+          return people
+        else
+          nil
+        end
+      end
+
+      def opencongress_users_opposing_person_are_also
+        url = Person.construct_url("opencongress_users_opposing_person_are_also/#{id}", {})
+        if (result = Person.make_call(url))
+          people = Person.parse_supporting_results(result)
+          return people
+        else
+          nil
+        end
+      end
+
+      def self.parse_results(result)
+
+          people = []
+          result["people"].each do |person|
+          
+            these_recent_blogs = person["recent_blogs"]
+            blogs = []
+            these_recent_blogs.each do |trb|
+              blogs << BlogPost.new(trb)
+            end
+
+            person["recent_blogs"] = blogs
+
+
+            these_recent_news = person["recent_news"]
+            news = []
+            these_recent_news.each do |trb|
+              news << NewsPost.new(trb)
+            end
+          
+            person["person_stats"] = PersonStat.new(person["person_stats"]) if person["person_stats"]
+          
+            person["recent_news"] = news
+          
+            people << Person.new(person)
+          end      
+        
+          people
+            
+      end    
+      
+      
+    end
+  
+  
+  end
+end