govkit 0.0.0.pre

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Carl Tashian
+
+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.markdown

@@ -0,0 +1,31 @@
+Govkit
+======
+
+Govkit is a Ruby gem that provides simple access to open government APIs around the web.
+
+Setup
+=====
+
+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.
+
+  >> Govkit::FiftyStates::State.find_by_abbrev('CA')
+
+(TODO: add usage examples...)
+
+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.
+
+Copyright (c) 2010 Participatory Politics Foundation, released under the MIT license

data/Rakefile

@@ -0,0 +1,80 @@
+require 'rubygems'
+require 'rake'
+require 'rake/rdoctask'
+
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  begin
+    gem 'rspec-rails', '>= 1.0.0'
+    require 'spec/rake/spectask'
+  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 Fifty 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"]
+    gem.add_dependency('httparty', '>= 0.5.2')
+    gem.add_dependency('json', '>= 1.2.4')
+    # 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/VERSION

@@ -0,0 +1 @@
+0.0.0.pre

data/generators/govkit_generator.rb

@@ -0,0 +1,20 @@
+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')
+    end
+  end
+    
+  protected
+  
+  def banner
+    %{Usage: #{$0} #{spec.name}\nCopies a config initializer to config/initializers/govkit.rb}
+  end
+  
+end

data/generators/templates/govkit.rb

@@ -0,0 +1,12 @@
+if defined? Govkit
+
+  # Get an API key for Sunlight's Fifty States project here:
+  # http://services.sunlightlabs.com/accounts/register/
+  Govkit::FiftyStates::apikey = 'YOUR_FIFTYSTATES_API_KEY'
+  
+  # Get a key for the VoteSmart API here:
+  # http://votesmart.org/services_api.php
+  Govkit::Votesmart::apikey = 'YOUR_VOTESMART_API_KEY'
+
+
+end

data/govkit.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{govkit}
+  s.version = "0.0.0.pre"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Participatory Politics Foundation", "Srinivas Aki", "Carl Tashian"]
+  s.date = %q{2010-04-28}
+  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 = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "USAGE",
+     "VERSION",
+     "generators/govkit_generator.rb",
+     "generators/templates/govkit.rb",
+     "govkit.gemspec",
+     "lib/govkit.rb",
+     "lib/govkit/fifty_states.rb",
+     "rails/init.rb"
+  ]
+  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.summary = %q{Simple access to open government APIs around the web}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= 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"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.5.2"])
+      s.add_dependency(%q<json>, [">= 1.2.4"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.5.2"])
+    s.add_dependency(%q<json>, [">= 1.2.4"])
+  end
+end
+

data/lib/govkit/fifty_states.rb

@@ -0,0 +1,177 @@
+require 'httparty'
+
+module Govkit::FiftyStates
+
+  ROLE_MEMBER = "member"
+  ROLE_COMMITTEE_MEMBER = "committee member"
+  CHAMBER_UPPER = "upper"
+  CHAMBER_LOWER = "lower"
+
+  class FiftyStatesError < 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 < FiftyStatesError;
+  end
+
+  class InvalidRequestError < StandardError;
+  end
+
+  class NotFoundError < FiftyStatesError;
+  end
+
+  class NameError < FiftyStatesError;
+  end
+
+  class Base
+    include HTTParty
+    format :json
+    default_params :output => 'json'
+    base_uri 'fiftystates-dev.sunlightlabs.com/api'
+
+    attr_accessor :attributes
+
+    def initialize(attributes = {})
+      @attributes = {}
+      unload(attributes)
+    end
+
+    class << self
+      def instantiate_record(record)
+        new(record)
+      end
+
+      def instantiate_collection(collection)
+        collection.collect! { |record| instantiate_record(record) }
+      end
+    end
+
+    def unload(attributes)
+      raise ArgumentError, "expected an attributes Hash, got #{attributes.inspect}" unless attributes.is_a?(Hash)
+      attributes.each do |key, value|
+        @attributes[key.to_s] =
+          case value
+            when Array
+              resource = resource_for_collection(key)
+              value.map do |attrs|
+                if attrs.is_a?(String) || attrs.is_a?(Numeric)
+                  attrs.duplicable? ? attrs.dup : attrs
+                else
+                  resource.new(attrs)
+                end
+              end
+            when Hash
+              resource = find_or_create_resource_for(key)
+              resource.new(value)
+            else
+              value.dup rescue value
+          end
+      end
+      self
+    end
+
+    private
+    def resource_for_collection(name)
+      find_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) }
+        return namespace.const_get(resource_name)
+      else
+        raise NameError, "Namespace for #{namespace} not found"
+      end
+    end
+
+    def find_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)
+      else
+        self.class.const_get(resource_name)
+      end
+    rescue NameError
+      #TODO: May be we should create new classes based on unknown records
+    end
+
+    def method_missing(method_symbol, *arguments) #:nodoc:
+      method_name = method_symbol.to_s
+
+      case method_name.last
+        when "="
+          attributes[method_name.first(-1)] = arguments.first
+        when "?"
+          attributes[method_name.first(-1)]
+        when "]"
+          attributes[arguments.first.to_s]
+        else
+          attributes.has_key?(method_name) ? attributes[method_name] : super
+      end
+    end
+  end
+
+  class State < Base
+    def self.find_by_abbreviation(abbreviation)
+      response = get("/#{abbreviation}")
+      instantiate_record(response)
+    end
+  end
+
+  class Bill < Base
+    # 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}/")
+      instantiate_record(response)
+    end
+
+    def self.search(query, options = {})
+      response = get('/bills/search', :query => {:q => query}.merge(options))
+      instantiate_collection(response)
+    end
+
+    def self.latest(updated_since, state_abbrev)
+      response = get('/bills/latest/', :query => {:updated_since => updated_since, :state => state_abbrev})
+      instantiate_collection(response)
+    end
+  end
+
+  class Legislator < Base
+    def self.find(legislator_id)
+      response = get("/legislators/#{legislator_id}")
+      instantiate_record(response)
+    end
+
+    def self.search(options = {})
+      response = get('/legislators/search', :query => options)
+      instantiate_collection(response)
+    end
+  end
+
+  class Session < Base; end
+
+  class Role < Base; end
+
+  class Action < Base; end
+
+  class Vote < Base; end
+
+  class Sponsor < Base; end
+
+  class Version < Base; end
+
+  class Source < Base; end
+end

data/lib/govkit.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'active_support'
+
+module Govkit
+  autoload :FiftyStates, 'govkit/fifty_states'
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require File.join(File.dirname(__FILE__), *%w[.. lib govkit])

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: govkit
+version: !ruby/object:Gem::Version 
+  prerelease: true
+  segments: 
+  - 0
+  - 0
+  - 0
+  - pre
+  version: 0.0.0.pre
+platform: ruby
+authors: 
+- Participatory Politics Foundation
+- Srinivas Aki
+- Carl Tashian
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 4
+        version: 1.2.4
+  type: :runtime
+  version_requirements: *id002
+description: 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.
+email: carl@ppolitics.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- USAGE
+- VERSION
+- generators/govkit_generator.rb
+- generators/templates/govkit.rb
+- govkit.gemspec
+- lib/govkit.rb
+- lib/govkit/fifty_states.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/opengovernment/govkit
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Simple access to open government APIs around the web
+test_files: []
+