govkit 0.3.2 → 0.4.0

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.4.0

data/govkit.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{govkit}
-  s.version = "0.3.2"
+  s.version = "0.4.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-09-16}
+  s.date = %q{2010-09-29}
   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 = [

data/lib/gov_kit/follow_the_money.rb

@@ -9,13 +9,17 @@ module GovKit
 
       e = doc.search("//error")
 
-      # API Key invalid
+      # Deal with whatever error comes back
       if e.size > 0
         raise case e.first.attributes['code']
         when "100"
           GovKit::NotAuthorized
         when "300"
           GovKit::InvalidRequest
+        when "200"
+          GovKit::ResourceNotFound
+        else
+          GovKit::InvalidRequest
         end, e.first.attributes['text']
       end
 
@@ -42,7 +46,7 @@ module GovKit
           end
         end
 
-        instantiate_collection(result)
+        parse(result)
       end
     end
 
@@ -61,7 +65,7 @@ module GovKit
             contribution.attributes.to_hash
           end
         end
-        instantiate_collection(result)
+        parse(result)
       end
 
       def self.top(nimsp_id)
@@ -71,7 +75,7 @@ module GovKit
           contribution.attributes.to_hash
         end
 
-        instantiate_collection(result)
+        parse(result)
       end
     end
 
@@ -83,7 +87,7 @@ module GovKit
           contribution.attributes.to_hash
         end
 
-        instantiate_collection(result)
+        parse(result)
       end
     end
 
@@ -95,7 +99,7 @@ module GovKit
           contribution.attributes.to_hash
         end
 
-        instantiate_collection(result)
+        parse(result)
       end
     end
 
@@ -107,7 +111,7 @@ module GovKit
           contribution.attributes.to_hash
         end
 
-        instantiate_collection(result)
+        parse(result)
       end
     end
   end

data/lib/gov_kit/open_states.rb

@@ -13,53 +13,58 @@ module GovKit
     class State < OpenStatesResource
       def self.find_by_abbreviation(abbreviation)
         response = get("/metadata/#{abbreviation}/")
-        instantiate_record(response)
+        parse(response)
       end
     end
 
     class Bill < OpenStatesResource
-      # http://openstates.sunlightlabs.com/api/v1/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
+      # http://openstates.sunlightlabs.com/api/v1/bills/ca/20092010/AB667/
+      class << self
+        def find(state_abbrev, session, bill_id, chamber = '')
+          response = get("/bills/#{state_abbrev}/#{session}/#{chamber.blank? ? '' : chamber + '/'}#{bill_id}/")
+          parse(response)
+        end
 
-      def self.search(query, options = {})
-        response = get('/bills/', :query => {:q => query}.merge(options))
-        instantiate_collection(response)
-      end
+        def search(query, options = {})
+          response = get('/bills/', :query => {:q => query}.merge(options))
+          parse(response)
+        end
 
-      def self.latest(updated_since, state_abbrev)
-        response = get('/bills/latest/', :query => {:updated_since => updated_since, :state => state_abbrev})
-        instantiate_collection(response)
+        def latest(updated_since, state_abbrev)
+          response = get('/bills/latest/', :query => {:updated_since => updated_since, :state => state_abbrev})
+          parse(response)
+        end
       end
     end
 
     class Legislator < OpenStatesResource
-      def self.find(legislator_id)
-        response = get("/legislators/#{legislator_id}/")
-        instantiate_record(response)
-      end
+      class << self
+        def find(legislator_id)
+          response = get("/legislators/#{legislator_id}/")
+          parse(response)
+        end
 
-      def self.search(options = {})
-        response = get('/legislators/', :query => options)
-        instantiate_collection(response)
+        def search(options = {})
+          response = get('/legislators/', :query => options)
+          parse(response)
+        end
       end
     end
     
     class Committee < OpenStatesResource
-      def self.find(committee_id)
-        response = get("/committees/#{committee_id}/")
-        instantiate_record(response)
-      end
+      class << self
+        def find(committee_id)
+          response = get("/committees/#{committee_id}/")
+          parse(response)
+        end
 
-      def self.search(options = {})
-        response = get('/committees/', :query => options)
-        instantiate_collection(response)
+        def search(options = {})
+          response = get('/committees/', :query => options)
+          parse(response)
+        end
       end
     end
     
-
     class Role < OpenStatesResource; end
 
     class Sponsor < OpenStatesResource; end
@@ -75,7 +80,7 @@ module GovKit
     class Vote < OpenStatesResource
       def self.find(vote_id)
         response = get("/votes/#{vote_id}/")
-        instantiate_record(response)
+        parse(response)
       end
     end
   end

data/lib/gov_kit/resource.rb

@@ -9,35 +9,52 @@ module GovKit
     def initialize(attributes = {})
       @attributes = {}
       @raw_response = attributes
+
       unload(attributes)
     end
 
     class << self
-      def instantiate_record(record)
-        raise ResourceNotFound, "Resource not found" unless !record.blank?
-        new(record)
-      end
-
-      def instantiate_collection(collection)
-        collection.collect! { |record| instantiate_record(record) }
-      end
+      def parse(response)
+        # This method handles the basic responses we might get back from
+        # Net::HTTP. But if a service returns something other than a 404 when an object is not found,
+        # you'll need to handle that in the subclass.
+              
+        raise ResourceNotFound, "Resource not found" unless !response.blank?
 
-      def parse(json)
-        instantiate(json)
+        if response.class == HTTParty::Response
+          case response.response
+            when Net::HTTPNotFound
+              raise ResourceNotFound, "404 Not Found"
+            when Net::HTTPUnauthorized
+              raise NotAuthorized, "401 Not Authorized; have you set up your API key?"
+          end
+        end
+        
+        instantiate(response)
       end
 
       def instantiate(record)
         case record
           when Array
             instantiate_collection(record)
-          when Hash
+          else
             instantiate_record(record)
         end
       end
+
+      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
@@ -74,7 +91,7 @@ module GovKit
     end
 
     def find_or_create_resource_for(name)
-      resource_name = name.to_s.gsub(/^[_+]/,'').gsub(/^(\d)/, "n#{$1}").gsub(/\s/, '').camelize
+      resource_name = name.to_s.gsub(/^(\d)/, "n#{$1}").gsub(/\s/, '').camelize
       if self.class.parents.size > 1
         find_resource_in_modules(resource_name, self.class.parents)
       else

data/lib/gov_kit/search_engines/wikipedia.rb

@@ -10,7 +10,11 @@ module GovKit
         response = get("/wiki/#{query}")
         doc = Hpricot(Iconv.conv('utf-8//IGNORE', 'gb2312', response))
 
-        doc.at('#bodyContent > table.toc').previous_sibling.inner_html.scrub rescue ""
+        bio = doc.at('#bodyContent > p:first').inner_html.scrub rescue ""
+
+        return "" if bio =~ /may refer to:/
+
+        bio
       end
 
       def self.make_request(host, path)

data/lib/gov_kit/vote_smart.rb

@@ -8,32 +8,32 @@ module GovKit
     class Address < VoteSmartResource
       def self.find(candidate_id)
         response = get("/Address.getOffice", :query => {"candidateId" => candidate_id})
-        instantiate_record(response['address'])
+        parse(response['address'])
       end
     end
 
     class WebAddress < VoteSmartResource
       def self.find(candidate_id)
         response = get("/Address.getOfficeWebAddress", :query => {"candidateId" => candidate_id})
-        instantiate_record(response['webaddress'])
+        parse(response['webaddress'])
       end
     end
 
     class Bio < VoteSmartResource
       def self.find(candidate_id)
         response = get("/CandidateBio.getBio", :query => {"candidateId" => candidate_id})
-        
-        # Sometimes this returns nil if no one is found!
-        raise(ResourceNotFound, 'Could not find bio for candidate ' + candidate_id.to_s) if response.blank? || response['error']
 
-        instantiate_record(response['bio']['candidate'])
+        # Sometimes VoteSmart returns nil if no one is found!
+        raise(ResourceNotFound, 'Could not find bio for candidate') if response.blank? || response['error']
+
+        parse(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'])
+        parse(response['categories']['category'])
       end
     end
 
@@ -41,14 +41,14 @@ module GovKit
       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.'
+        raise(ResourceNotFound, response['error']['errorMessage']) if response['error']
 
-        instantiate(response['sigs']['sig'])
+        parse(response['sigs']['sig'])
       end
 
       def self.find(sig_id)
         response = get("/Rating.getSig", :query => {"sigId" => sig_id})
-        instantiate(response['sig'])
+        parse(response['sig'])
       end
     end
 
@@ -56,35 +56,35 @@ module GovKit
       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.'
+        raise(ResourceNotFound, response['error']['errorMessage']) if response['error']
 
-        instantiate(response['candidateRating']['rating'])
+        parse(response['candidateRating']['rating'])
       end
     end
 
     class Bill < VoteSmartResource
       def self.find(bill_id)
         response = get('/Votes.getBill', :query => {'billId' => bill_id})
-        instantiate_record(response['bill'])
+        parse(response['bill'])
       end
 
       def self.find_by_year_and_state(year, 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'])
+        parse(response['bills'])
       end
 
       def self.find_recent_by_state(state_abbrev)
         response = get('/Votes.getBillsByStateRecent', :query => {'stateId' => state_abbrev})
-        instantiate_record(response['bills'])
+        parse(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'])
+        parse(response['bills'])
       end
 
       def self.find_by_category_and_year(category_id, year)
@@ -95,7 +95,7 @@ module GovKit
     class BillCategory < VoteSmartResource
       def self.find(year, state_abbrev)
         response = get("/Votes.getCategories", :query => {'year' => year, 'stateId' => state_abbrev})
-        instantiate(response['categories']['category'])
+        parse(response['categories']['category'])
       end
     end
 
@@ -106,13 +106,13 @@ module GovKit
       # 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})
-        instantiate_record(response['committees'])
+        parse(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})
-        instantiate_record(response['committee'])
+        parse(response['committee'])
       end
     end
   end

data/lib/gov_kit.rb

@@ -21,16 +21,6 @@ module GovKit
   end
 
   class GovKitError < StandardError
-    attr_reader :response
-
-    def initialize(response, message = nil)
-      @response = response
-      @message  = message
-    end
-
-    def to_s
-      "Failed with #{response.code if response.respond_to?(:code)} #{response.message if response.respond_to?(:message)}"
-    end
   end
 
   class NotAuthorized < GovKitError; end

data/spec/open_states_spec.rb

@@ -7,7 +7,7 @@ module GovKit::OpenStates
 
       urls = [
         ['/ca/\?',                             'state.response'],
-        ['/ca/20092010/lower/bills/AB667/',    'bill.response'],
+        ['/bills/ca/20092010/AB667/',    'bill.response'],
         ['/bills/search/\?',                   'bill_query.response'],
         ['/bills/latest/\?',                   'bill_query.response'],
         ['/legislators/2462/\?',               'legislator.response'],

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 2
-  version: 0.3.2
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Participatory Politics Foundation
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-16 00:00:00 -07:00
+date: 2010-09-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency