govkit 0.0.1 → 0.0.2

data/README.markdown

@@ -1,26 +1,29 @@
-Govkit
-======
+# Govkit
 
 Govkit is a Ruby gem that provides simple access to open government APIs around the web.
 
-Setup
-=====
+# Installation
+
+From gemcutter:
+
+    gem install govkit
+
+# 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
-=======
+# 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')
+    >> Govkit::FiftyStates::State.find_by_abbreviation('CA')
+    >> Govkit::VoteSmart::Address.find(legislator_id)
 
 (TODO: add usage examples...)
 
-Bugs? Questions?
-================
+# 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.
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/generators/govkit/govkit_generator.rb

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

data/generators/govkit/templates/govkit.rb

@@ -1,6 +1,6 @@
-if defined? Govkit
-  
-  Govkit.configure do |config|
+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'

data/govkit.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{govkit}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   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-10}
+  s.date = %q{2010-05-14}
   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 = [
@@ -27,9 +27,15 @@ Gem::Specification.new do |s|
      "generators/govkit/govkit_generator.rb",
      "generators/govkit/templates/govkit.rb",
      "govkit.gemspec",
+     "lib/gov_kit.rb",
+     "lib/gov_kit/configuration.rb",
+     "lib/gov_kit/fifty_states.rb",
+     "lib/gov_kit/resource.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",

data/lib/gov_kit/configuration.rb

@@ -0,0 +1,29 @@
+module GovKit
+  class Configuration
+    attr_accessor :fiftystates_apikey, :fiftystates_base_url
+    attr_accessor :votesmart_apikey, :votesmart_base_url
+
+    def initialize
+      @fiftystates_apikey = ''
+      @fiftystates_base_url = 'fiftystates-dev.sunlightlabs.com/api'
+
+      @votesmart_apikey = ''
+      @votesmart_base_url = 'api.votesmart.org/'
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Configure GovKit in config/initializers/govkit.rb
+  #
+  # @example
+  #   GovKit.configure do |config|
+  #     config.fiftystates_apikey = ''
+  #   end
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

data/lib/gov_kit/fifty_states.rb

@@ -0,0 +1,57 @@
+module GovKit
+  class FiftyStatesResource < Resource
+    default_params :output => 'json', :apikey => GovKit::configuration.fiftystates_apikey
+    base_uri GovKit::configuration.fiftystates_base_url
+  end
+
+  module FiftyStates
+    ROLE_MEMBER = "member"
+    ROLE_COMMITTEE_MEMBER = "committee member"
+    CHAMBER_UPPER = "upper"
+    CHAMBER_LOWER = "lower"
+
+    class State < FiftyStatesResource
+      def self.find_by_abbreviation(abbreviation)
+        response = get("/#{abbreviation}")
+        instantiate_record(response)
+      end
+    end
+
+    class Bill < FiftyStatesResource
+      # 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 < FiftyStatesResource
+      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 Vote < FiftyStatesResource
+      def self.find(vote_id)
+        response = get("/votes/#{vote_id}")
+        instantiate_record(response)
+      end
+    end
+  end
+end

data/lib/gov_kit/resource.rb

@@ -0,0 +1,125 @@
+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
+
+    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
+
+      def parse(json)
+        instantiate_record(json)
+      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_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) }
+        return namespace.const_get(resource_name)
+      else
+        raise NameError, "Namespace for #{namespace} not found"
+      end
+    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)
+      else
+        self.class.const_get(resource_name)
+      end
+    rescue NameError
+      if self.class.const_defined?(resource_name)
+        resource = self.class.const_get(resource_name)
+      else
+        resource = self.class.const_set(resource_name, Class.new(GovKit::Resource))
+      end
+      resource
+    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
+end

data/lib/gov_kit/vote_smart.rb

@@ -0,0 +1,22 @@
+module GovKit
+  class VoteSmartResource < Resource
+    default_params :o => 'JSON', :key => GovKit::configuration.votesmart_apikey
+    base_uri GovKit::configuration.votesmart_base_url
+  end
+
+  module VoteSmart
+    class Address < VoteSmartResource
+      def self.find(candidate_id)
+        response = get("/Address.getOffice", :query => {"candidateId" => candidate_id})
+        instantiate_record(response['address'])
+      end
+    end
+
+    class WebAddress < VoteSmartResource
+      def self.find(candidate_id)
+        response = get("/Address.getOfficeWebAddress", :query => {"candidateId" => candidate_id})
+        instantiate_record(response['webaddress'])
+      end
+    end
+  end
+end

data/lib/gov_kit.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'active_support'
+require 'gov_kit/configuration'
+
+module GovKit
+  autoload :FiftyStates, 'gov_kit/fifty_states'
+  autoload :VoteSmart, 'gov_kit/vote_smart'
+
+  class Bill < Resource; end
+  class Vote < Resource; end
+  class Session < Resource; end
+  class Role < Resource; end
+  class Legislator < Resource; end
+  class Vote < Resource; end
+  class Sponsor < Resource; end
+  class Version < Resource; end
+  class Source < Resource; end
+  class Address < Resource; end
+end

data/lib/govkit/configuration.rb

@@ -1,10 +1,14 @@
 module Govkit
   class Configuration
     attr_accessor :fiftystates_apikey, :fiftystates_base_url
+    attr_accessor :votesmart_apikey, :votesmart_base_url
 
     def initialize
       @fiftystates_apikey = ''
       @fiftystates_base_url = 'fiftystates-dev.sunlightlabs.com/api'
+
+      @votesmart_apikey = ''
+      @votesmart_base_url = 'api.votesmart.org/'
     end
   end
 

data/lib/govkit/vote_smart.rb

@@ -0,0 +1,146 @@
+require 'httparty'
+
+module Govkit::VoteSmart
+  class VoteSmartError < 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 < VoteSmartError;
+  end
+
+  class InvalidRequestError < StandardError;
+  end
+
+  class NotFoundError < VoteSmartError;
+  end
+
+  class NameError < VoteSmartError;
+  end
+
+  class Base
+    include HTTParty
+    default_params :o => 'JSON', :key => Govkit::configuration.votesmart_apikey
+    base_uri Govkit::configuration.votesmart_base_url
+
+    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
+
+      def parse(json)
+        instantiate_record(json)
+      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_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) }
+        return namespace.const_get(resource_name)
+      else
+        raise NameError, "Namespace for #{namespace} not found"
+      end
+    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)
+      else
+        self.class.const_get(resource_name)
+      end
+    rescue NameError
+      if self.class.const_defined?(resource_name)
+        resource = self.class.const_get(resource_name)
+      else
+        resource = self.class.const_set(resource_name, Class.new(Base))
+      end
+      resource
+    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 Address < Base
+    class << self
+      def find(candidate_id)
+        response = get("/Address.getOffice", :query => {"candidateId" => candidate_id})
+        instantiate_record(response['address'])
+      end
+    end
+  end
+
+  class WebAddress < Base
+    class << self
+      def find(candidate_id)
+        response = get("/Address.getOfficeWebAddress", :query => {"candidateId" => candidate_id})
+        instantiate_record(response['webaddress'])
+      end
+    end
+  end
+end

data/lib/govkit.rb

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

data/spec/fifty_states_spec.rb

@@ -2,8 +2,8 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 #TODO: Mock http requests, rather than making an actual call to the api
 
-module Govkit::FiftyStates
-  describe Govkit::FiftyStates do
+module GovKit::FiftyStates
+  describe GovKit::FiftyStates do
     it "should have the base uri set properly" do
       [State, Bill, Legislator].each do |klass|
         klass.base_uri.should == "http://fiftystates-dev.sunlightlabs.com/api"

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Participatory Politics Foundation
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-10 00:00:00 -07:00
+date: 2010-05-14 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,9 +67,15 @@ files:
 - generators/govkit/govkit_generator.rb
 - generators/govkit/templates/govkit.rb
 - govkit.gemspec
+- lib/gov_kit.rb
+- lib/gov_kit/configuration.rb
+- lib/gov_kit/fifty_states.rb
+- lib/gov_kit/resource.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