votesmart 0.3.0

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/History.txt

@@ -0,0 +1,20 @@
+== 0.3.0 2010-03-25
+
+* 3 major enhancement:
+  * Rename the project/gem to just 'votesmart'
+  * Move http access to Patron for performance
+  * Add retry logic on HTTP failure, with exponential backoff
+
+* 2 minor enhancements:
+  * Add Official#party to reflect the PVS officeParties data
+  * Sig descriptions:
+    * sometimes included UTF control characters for punctuation, which are now translated to ascii
+    * often started and ended in a quote, which is now avoided
+
+* 1 bug fix:
+  * Fix that Rating.get_sig_list would blow up on a bad parameter
+
+== 0.0.1 2009-02-10
+
+* 1 major enhancement:
+  * Initial release

data/README.rdoc

@@ -0,0 +1,48 @@
+= project-vote-smart
+
+* FIX (url)
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIXME full name
+
+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/Rakefile

@@ -0,0 +1,45 @@
+%w[rubygems rake rake/clean fileutils].each { |f| require f }
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "votesmart"
+    s.summary = "A wrapper for the Project Vote Smart API"
+    s.email = "ben.woosley@gmail.com"
+    s.homepage = "http://github.com/Empact/votesmart"
+    s.description = "A wrapper for the Project Vote Smart API"
+    s.authors = ["Dan Cunning", "Ben Woosley"]
+    s.add_dependency 'patron', '>=0.4.6'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "votesmart #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 3
+:patch: 0

data/lib/mcll4r/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Mobile Commons
+
+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/lib/mcll4r/README

@@ -0,0 +1,19 @@
+=== mcll4r
+ 
+- [Code on GitHub](http://github.com/mcommons/mcll4r)
+ 
+=== Description
+ 
+Ruby client for Mobile Commons Legislative Lookup API
+ 
+Based on the API described at http://congress.mcommons.com
+ 
+ 
+=== Authors
+ 
+- Maintained by [Benjamin Stein](mailto:ben@mcommons.com), [Mal McKay](mailto:mal@mcommons.com) & [Nathan Woodhull](mailto:nathan@mcommons.com)
+ 
+=== License
+ 
+Copyright (c) 2008 Mobile Commons
+See MIT-LICENSE in this directory.

data/lib/mcll4r/mcll4r.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'httparty'
+
+class Mcll4r
+  include HTTParty
+  base_uri "http://congress.mcommons.com"    
+  format :xml
+  
+  def district_lookup(lat, lng)
+    filter_for_errors self.class.get("/districts/lookup.xml", :query=>{:lat=>lat, :lng=>lng})
+  end
+
+private
+
+  def filter_for_errors(hash)
+    if hash['response']['error']
+      raise DistrictNotFound.new(hash['response']['error'])
+    end
+    hash
+  end
+
+end
+
+class DistrictNotFound < Exception; end

data/lib/mcll4r/mcll4r_test.rb

@@ -0,0 +1,35 @@
+require 'mcll4r'
+require 'test/unit'
+ 
+class Mcll4rTest < Test::Unit::TestCase
+  
+  def setup
+    @mcll4r = Mcll4r.new
+  end
+  
+  def test_assert_we_get_back_correct_district_data
+    expected = {
+      "response"      => {                                                                   
+        "state_upper" => { "district" => "029", "display_name" => "TX 29th", "state" => "TX" },
+        "federal"     => { "district" => "16",  "display_name" => "TX 16th", "state" => "TX" },
+        "state_lower" => { "district" => "077", "display_name" => "TX 77th", "state" => "TX" },
+        "lng"         => "-106.490969",                                                      
+        "lat"         => "31.76321"                                                          
+      }                                                                                      
+    }
+    assert_equal expected, @mcll4r.district_lookup(31.76321, -106.490969)
+  end
+
+  def test_assert_raise_on_error
+    assert_raise DistrictNotFound do
+      @mcll4r.district_lookup(nil,nil)
+    end
+  end
+
+  def test_assert_raise_on_district_not_found
+    assert_raise DistrictNotFound do
+      @mcll4r.district_lookup( 1.0, 1.0 )
+    end
+  end
+
+end

data/lib/vote_smart.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'ym4r/google_maps/geocoding'
+require 'active_support'
+include Ym4r::GoogleMaps
+
+module VoteSmart
+  API_URL = "http://api.votesmart.org/"
+  API_FORMAT = "JSON"
+  
+  mattr_accessor :api_key
+  
+  class RequestFailed < Exception; end
+end
+
+VoteSmart.api_key = "key"
+
+require "#{File.dirname(__FILE__)}/mcll4r/mcll4r.rb"
+require "#{File.dirname(__FILE__)}/vote_smart/common.rb"
+
+Dir["#{File.dirname(__FILE__)}/vote_smart/*.rb"].each do |source_file| 
+  require source_file unless source_file == "#{File.dirname(__FILE__)}/vote_smart/common.rb"
+end

data/lib/vote_smart/address.rb

@@ -0,0 +1,42 @@
+module VoteSmart
+  
+  class Address < Common
+    
+    attr_accessor :type, :street, :city, :state, :zip
+    
+    set_attribute_map "type" => :type, "street" => :street, "city" => :city, "state" => :state, "zip" => :zip
+    
+    
+    # Returns a campaign office's contact information
+    def self.get_campaign can_id
+      request("Address.getCampaign", "candidateId" => can_id)
+    end
+    
+    # Returns a campaign office's contact information
+    def self.get_campaign_web_address can_id
+      request("Address.getCampaignWebAddress", "candidateId" => can_id)
+    end
+    
+    # Returns a campaign office's contact information
+    def self.get_campaign_by_election election_id
+      request("Address.getCampaignByElection", "electionId" => election_id)
+    end
+    
+    # Returns an incumbent office's contact information
+    def self.get_office candidate_id
+      request("Address.getOffice", "candidateId" => candidate_id)
+    end
+    
+    # Returns an incumbent office's contact information
+    def self.get_office_web_address can_id
+      request("Address.getOfficeWebAddress", "candidateId" => can_id)
+    end
+    
+    # Returns a (sometimes)list of offices that fit office_id and state_id
+    def self.get_office_by_office_state office_id, state_id = 'NA'
+      request("Address.getOfficeByOfficeState", "officeId" => office_id, "stateId" => state_id)
+    end
+    
+  end
+  
+end

data/lib/vote_smart/candidate.rb

@@ -0,0 +1,32 @@
+module VoteSmart
+  
+  class Candidate < Common
+    
+    # Returns a list of candidates/incumbents that fit the criteria
+    def self.get_by_office_state office_id, state_id = "NA", election_year = nil
+      request("Candidates.getByOfficeState", "officeId" => office_id, "stateId" => state_id, "electionYear" => election_year)
+    end
+    
+    #Searches for candidates with exact lastname matches
+    def self.get_by_lastname last_name, election_year = nil
+      request("Candidates.getByLastname", "lastName" => last_name, "electionYear" => election_year)
+    end
+    
+    # Searches for candidates with fuzzy lastname match
+    def self.get_by_levenstein last_name, election_year = nil
+      request("Candidates.getByLevenstein", "lastName" => last_name, "electionYear" => election_year)
+    end
+    
+    # Returns candidates in the provided election_id
+    def self.get_by_election election_id
+      request("Candidates.getByElection", "electionId" => election_id)
+    end
+    
+    # Returns candidates in the provided district_id
+    def self.get_by_district district_id, election_year = nil
+      request("Candidates.getByDistrict", "districtId" => district_id, "electionYear" => election_year)
+    end
+    
+  end
+  
+end

data/lib/vote_smart/candidate_bio.rb

@@ -0,0 +1,16 @@
+module VoteSmart
+  
+  class CandidateBio < Common
+    
+    # Returns basic bio details on a candidate
+    def self.get_bio can_id
+      request("CandidateBio.getBio", "candidateId" => can_id)
+    end
+    
+    # 
+    def self.get_addl_bio can_id
+      request("CandidateBio.getAddlBio", "candidateId" => can_id)
+    end
+    
+  end
+end

data/lib/vote_smart/candidate_office.rb

@@ -0,0 +1,15 @@
+module VoteSmart
+  
+  class CandidateOffice < Common
+    
+    attr_accessor :address, :phone, :notes
+    
+    def initialize attributes
+      self.address = Address.new(attributes["address"] || {})
+      self.phone = Phone.new(attributes["phone"] || {})
+      self.notes = Notes.new(attributes["notes"] || {})
+    end
+    
+  end
+  
+end

data/lib/vote_smart/committee.rb

@@ -0,0 +1,23 @@
+module VoteSmart
+  
+  class Committee < Common
+    
+    # Returns committee types for use in other methods
+    def self.get_types
+      request("Committee.getTypes")
+    end
+    
+    def self.get_committees_by_type_state type_id = nil, state_id = 'NA'
+      request("Committee.getCommitteesByTypeState", "typeId" => type_id, "stateId" => state_id)
+    end
+    
+    def self.get_committee committee_id
+      request("Committee.getCommittee", "committeeId" => committee_id)
+    end
+    
+    def self.get_committee_members committee_id
+      request("Committee.getCommitteeMembers", "committeeId" => committee_id)
+    end
+    
+  end
+end

data/lib/vote_smart/common.rb

@@ -0,0 +1,97 @@
+require 'json'
+require 'cgi'
+require 'patron'
+require 'ym4r/google_maps/geocoding'
+
+module VoteSmart
+  
+  class Common
+    
+    class << self
+      attr_reader :attribute_map
+    end
+    
+    def initialize attributes = {}
+      update_attributes attributes
+    end
+    
+    def self.set_attribute_map map
+      @attribute_map = map
+    end
+    
+    def update_attributes attributes
+      map = self.class.attribute_map
+      raise "map not set over-ride needed" unless map
+      
+      attributes.each do |key, value|
+        if key.kind_of?(Symbol)
+          send("#{key}=", value)
+        else
+          map_to = map[key]
+          send("#{map_to}=", value) if map_to
+        end
+      end
+    end
+    
+    def self.response_child response, *children
+      for child in children
+        response = response[child] if response
+      end
+      
+      response || {}
+    end
+
+    def self.request(api_method, params = {})
+      url = construct_url api_method, params
+      
+      json = get_json_data(url)
+      
+      if json['error'] and json['error']['errorMessage'] == 'Authorization failed'
+        raise RequestFailed.new(json['error']['errorMessage'])
+      end
+      
+      json
+    end
+    
+    # Constructs a VoteSmart API-friendly URL
+    def self.construct_url(api_method, params = {})
+      "#{API_URL}#{api_method}?key=#{VoteSmart.api_key}&o=#{API_FORMAT}#{hash2get(params)}"
+    end
+    
+    # Converts a hash to a GET string
+    def self.hash2get(h)
+      h.map do |(key, value)|
+        "&#{key.to_s}=#{CGI::escape(value.to_s)}" if value
+      end.compact.join
+    end
+
+    def self.session
+      @session ||= Patron::Session.new
+    end
+
+    # Use the Net::HTTP and JSON libraries to make the API call
+    #
+    # Usage:
+    #   District.get_json_data("http://someurl.com")    # returns Hash of data or nil
+    def self.get_json_data(url)
+      response = session.get(url)
+      if response.status != 200
+        raise RequestFailed.new("Request was not OK: #{response.class}: #{url} #{response.body}")
+      end
+      JSON.parse(response.body)
+    rescue
+      @json_retries ||= 0
+      if @json_retries < 5
+        puts "Retrying #{url}"
+        sleep(2 ** @json_retries)
+        @json_retries += 1
+        retry
+      end
+      raise
+    ensure
+      @json_retries = 0
+    end
+    
+  end
+  
+end