govkit-h 0.7.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format nested
+--backtrace

data/Gemfile

@@ -0,0 +1,13 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem "active_support"
+gem "nokogiri"
+gem "httparty"
+gem "i18n"
+
+group :test do
+  gem "rspec"
+  gem "fakeweb"
+end

data/LICENSE

@@ -0,0 +1,20 @@
+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
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# Govkit
+
+Govkit is a Ruby gem that provides simple access to US 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 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.
+ *  [TransparencyData API](http://transparencydata.com/api) (campaign contributions only)
+
+# Installation
+
+From gemcutter:
+
+    gem install govkit
+
+# Setup
+
+Add govkit to your environment.rb or Gemfile
+
+Run <code>rails generate govkit</code> (Rails 3.x) or <code>script/generate govkit</code> (Rails 2.x) to copy a config file into <code>config/initializers/govkit.rb</code>. You will need to add your API keys to this config file.
+
+Outside of Rails you can configure your API keys like so:
+
+    >> GovKit.configure do |config|
+    >>   config.sunlight_apikey   = 'YOUR_SUNLIGHT_API_KEY'
+    >>   config.votesmart_apikey  = 'YOUR_VOTESMART_API_KEY'
+    >>   config.ftm_apikey        = 'YOUR_FTM_API_KEY'
+    >> end
+
+# Usage Examples
+
+    >> GovKit::OpenStates::State.find_by_abbreviation('CA')
+    >> GovKit::VoteSmart::Address.find(votesmart_candidate_id)
+    >> GovKit::OpenCongress::Bill.find(:number => 5479, :type => 'h', :congress => '111')
+
+Objects returned from GovKit will have attributes for each field coming back from the API:
+
+    >> x = GovKit::OpenStates::State.find_by_abbreviation('CA')
+    => #<GovKit::OpenStates::State:0x00000100f6a5a8 @attributes={"lower_chamber_title"=>"Assemblymember", "lower_chamber_name"=>"Assembly", "upper_chamber_title"=>"Senator", "terms"=>[#<GovKit::OpenStates::State::Term:0x00000100f2a8e0 @attributes={"....
+    >> x.name
+    => "California"
+
+GovKit will raise GovKit::ResourceNotFound if a requested item isn't available.
+
+# Testing & Debugging
+
+For debugging purposes, there's a raw_response reader provided for each object, which typically returns an HTTParty::Response object. To see the body of the HTTP response, you might look here:
+
+    (continuing the example from above)
+    >> x.raw_response.response.body
+    => "{\n    \"lower_chamber_title\": \"Assemblymember\", \n    \"lower_chamber_name\": \"Assembly\", \n  ....
+
+# Bugs? Questions?
+
+Please join the [Govkit Google Group](http://groups.google.com/group/govkit), especially if you'd like to talk about a new feature and get announcements.
+
+[Report a bug](https://participatorypolitics.lighthouseapp.com/projects/51485-govkit) on our Lighthouse page.
+
+Govkit's main repo is on Github: [http://github.com/opengovernment/govkit](http://github.com/opengovernment/govkit), where your contributions, forks, and feedback are greatly welcomed.
+
+# Dear Canadians
+
+For Canadian open government data, our friends up north have created a [govkit-ca](https://github.com/jpmckinney/govkit-ca) gem that lives in the GovKit::CA namespace and should interoperate just fine with this gem.
+
+# A GovKit for your country?
+
+Let us know if you'd like to build a govkit for your region! We'd love to link to you. Your gem should be called, for example, govkit-uk (ISO 3166 country code), and your methods should live in the GovKit::GB namespace (for example).
+
+Copyright (c) 2010 Participatory Politics Foundation, released under the MIT license

data/Rakefile

@@ -0,0 +1,82 @@
+require 'rubygems'
+require 'rake'
+require 'rake/rdoctask'
+
+begin
+  require 'rspec/core/rake_task'
+rescue LoadError
+  begin
+    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
+end
+
+begin
+  require 'jeweler'
+  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 Open States API and the Project Vote Smart API.}
+    gem.email = "develop@opencongress.org"
+    gem.homepage = "http://github.com/opengovernment/govkit"
+    gem.authors = ["Participatory Politics Foundation", "Srinivas Aki", "Carl Tashian"]
+    gem.add_dependency('httparty', '>= 0.7.4')
+    gem.add_dependency('json', '>= 1.4.3')
+    gem.add_dependency('nokogiri', '>= 1.4.4')
+    gem.add_dependency('fastercsv', '>= 1.5.3')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :default => :spec
+
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "govkit #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+if defined?(Spec)
+  desc 'Test the govkit plugin.'
+  Spec::Rake::SpecTask.new('spec') do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ["-c"]
+  end
+
+  desc 'Test the govkit plugin with specdoc formatting and colors'
+  Spec::Rake::SpecTask.new('specdoc') do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ["--format specdoc", "-c"]
+  end
+
+  desc "Run all examples with RCov"
+  Spec::Rake::SpecTask.new('examples_with_rcov') do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec,Library']
+  end
+end

data/USAGE

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

data/VERSION

@@ -0,0 +1 @@
+0.7.1

data/generators/govkit/govkit_generator.rb

@@ -0,0 +1,24 @@
+class GovkitGenerator < Rails::Generator::Base
+
+  def initialize(*runtime_args)
+    super
+  end
+
+  def manifest
+    record do |m|
+      m.directory File.join('config', 'initializers')
+      m.template 'govkit.rb',   File.join('config', 'initializers', 'govkit.rb')
+      m.directory File.join('app', 'models')
+      m.template 'mention.rb',  File.join('app', 'models', 'mention.rb')
+      m.directory File.join('db', 'migrate')
+      m.template 'create_mentions.rb', File.join('db', 'migrate', 'create_mentions.rb')
+    end
+  end
+
+  protected
+
+  def banner
+    %{Usage: #{$0} #{spec.name}\nCopies a config initializer to config/initializers/govkit.rb}
+  end
+
+end

data/generators/govkit/templates/govkit.rb

@@ -0,0 +1,24 @@
+if defined? GovKit
+  GovKit.configure do |config|
+    # Get an API key for Sunlight's Open States project here:
+    # http://services.sunlightlabs.com/accounts/register/
+    config.sunlight_apikey = 'YOUR_SUNLIGHT_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'
+    
+    # Technorati API key
+    # config.technorati_apikey = 'YOUR_TECHNORATI_APIKEY'
+    
+    # Bing App ID
+    config.bing_appid = 'YOUR_BING_APPID'
+    
+    # Other things you could set here include alternate URLs for
+    # the APIs. See GovKit::Configuration for available attributes.
+  end
+end

data/govkit.gemspec

@@ -0,0 +1,130 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{govkit-h}
+  s.version = "0.7.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{2011-06-30}
+  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{develop@opencongress.org}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "USAGE",
+    "VERSION",
+    "generators/govkit/govkit_generator.rb",
+    "generators/govkit/templates/govkit.rb",
+    "govkit.gemspec",
+    "init.rb",
+    "lib/generators/govkit/govkit_generator.rb",
+    "lib/generators/govkit/templates/govkit.rb",
+    "lib/generators/govkit/templates/mention.rb",
+    "lib/generators/govkit/templates/create_mentions.rb",
+    "lib/gov_kit.rb",
+    "lib/gov_kit/acts_as_noteworthy.rb",
+    "lib/gov_kit/configuration.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/open_states.rb",
+    "lib/gov_kit/railtie.rb",
+    "lib/gov_kit/resource.rb",
+    "lib/gov_kit/search_engines.rb",
+    "lib/gov_kit/search_engines/bing.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/transparency_data.rb",
+    "lib/gov_kit/vote_smart.rb",
+    "lib/govkit.rb",
+    "spec/fixtures/bing/news_search.response",
+    "spec/fixtures/bing/no_results.response",
+    "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_congress/person.response",
+    "spec/fixtures/open_states/401.response",
+    "spec/fixtures/open_states/404.response",
+    "spec/fixtures/open_states/410.response",
+    "spec/fixtures/open_states/bill.response",
+    "spec/fixtures/open_states/bill_query.response",
+    "spec/fixtures/open_states/committee_find.response",
+    "spec/fixtures/open_states/committee_query.response",
+    "spec/fixtures/open_states/legislator.response",
+    "spec/fixtures/open_states/legislator_query.response",
+    "spec/fixtures/open_states/state.response",
+    "spec/fixtures/search_engines/google_news.response",
+    "spec/fixtures/transparency_data/contributions.response",
+    "spec/fixtures/transparency_data/entities_search.response",
+    "spec/fixtures/transparency_data/entities_search_limit_0.response",
+    "spec/fixtures/transparency_data/entities_search_limit_1.response",
+    "spec/fixtures/transparency_data/grants_find_all.response",
+    "spec/fixtures/transparency_data/lobbyists_find_all.response",
+    "spec/follow_the_money_spec.rb",
+    "spec/open_congress_spec.rb",
+    "spec/open_states_spec.rb",
+    "spec/search_engines_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/transparency_data_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/opengovernment/govkit}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Simple access to open government APIs around the web}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<active_support>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_runtime_dependency(%q<i18n>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.7.4"])
+      s.add_runtime_dependency(%q<json>, [">= 1.4.3"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 1.4.4"])
+      s.add_runtime_dependency(%q<fastercsv>, [">= 1.5.3"])
+    else
+      s.add_dependency(%q<active_support>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0.7.4"])
+      s.add_dependency(%q<json>, [">= 1.4.3"])
+      s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
+      s.add_dependency(%q<fastercsv>, [">= 1.5.3"])
+    end
+  else
+    s.add_dependency(%q<active_support>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0.7.4"])
+    s.add_dependency(%q<json>, [">= 1.4.3"])
+    s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
+    s.add_dependency(%q<fastercsv>, [">= 1.5.3"])
+  end
+end
+

data/init.rb

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

data/lib/generators/govkit/govkit_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+
+# Generator to setup rails app for using GovKit
+class GovkitGenerator < Rails::Generators::Base
+
+  def initialize(*runtime_args)
+    super
+  end
+
+  desc "Copies files necessary to use govkit"
+
+  source_root File.join(File.dirname(__FILE__), 'templates')
+  
+  # Copies the files necessary to use govkit (initializer, migrations, and models)
+  def copy_initializer_file
+    copy_file 'govkit.rb', File.join('config', 'initializers', 'govkit.rb')
+    copy_file 'mention.rb', File.join('app', 'models', 'mention.rb')
+    copy_file 'create_mentions.rb', File.join('db', 'migrate', "#{ Time.now.utc.strftime "%Y%m%d%H%M%S" }create_mentions.rb")
+  end
+
+end

data/lib/generators/govkit/templates/create_mentions.rb

@@ -0,0 +1,21 @@
+class CreateMentions < ActiveRecord::Migration
+  def self.up
+    create_table :mentions, :force => true do |t|
+      t.string   "url",           :limit => 8000
+      t.string   "excerpt",       :limit => 4000
+      t.string   "title",         :limit => 1000
+      t.string   "source"
+      t.datetime "date"
+      t.float    "weight"
+      t.integer  "owner_id"
+      t.string   "owner_type"
+      t.string   "search_source"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+  end
+  
+  def self.down
+    drop_table :mentions
+  end
+end

data/lib/generators/govkit/templates/govkit.rb

@@ -0,0 +1,24 @@
+if defined? GovKit
+  GovKit.configure do |config|
+    # Get an API key for Sunlight's Open States project here:
+    # http://services.sunlightlabs.com/accounts/register/
+    config.sunlight_apikey = 'YOUR_SUNLIGHT_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'
+    
+    # Technorati API key
+    # config.technorati_apikey = 'YOUR_TECHNORATI_APIKEY'
+    
+    # Bing App ID
+    config.bing_appid = 'YOUR_BING_APPID'
+    
+    # Other things you could set here include alternate URLs for
+    # the APIs. See GovKit::Configuration for available attributes.
+  end
+end