pitosalas-govsdk 0.0.4 → 0.0.5

data/README.textile

@@ -22,22 +22,46 @@ Unfortunately for now, each of the different services request that you use it's
 
 h2. IDs
 
-There are various IDs (identifiers assigned by some outside, real world agency to some outside real world thing) throughout the government. One you know is a drivers license number assigned to a person. Within our universe here are some of the IDs:
+There are various IDs (identifiers assigned by some outside, real world agency to some outside real world thing) throughout the government. One you know is a drivers license number assigned to a person. 
+
+h2. Basic usage
+
+Here is a very simplistic minimal example:
+<pre>
+<code>
+# You always have to start off by declaring that you want to use Govsdk. You need to supply one or more of your API keys. 
+GovSdk.init :sunlight => "enter your API key..."
+
+#Lookup a congress person "barney" "frank". The call returns an array of matching congresspeople
+cp = CongressPerson.find_by_names("barney", "frank")
+
+# print the photo url of the first congress person matching
+puts cp[0].photo_url
+</code>
+</pre>
 
-# CrpId - Center for responsible politics IDs for congress persons
-	
-In many cases none of the APIs furnish a useful ID. 
 
 h1. KEY CLASSES
 
+# CongressPerson - Work with legislators: senators and congressmen
+	
+#### self.find_by_name - return an array of CongressPersons
+#### self.find_by_zipcode - return an array of CongressPersons
+#### self.find_by_crp_id - return the CongressPerson with specified crp id
+
+h2. Internal classes
+
 # APIMgr - Parent class of each of the manager classes below
 ## NewYorkTimesAPI - Class managing access to the New York Times API
 ## SunlightAPI - Class managing access to the Sunlight API
 ## SpenSecretsAPI - Class managing the OpenSecrets API
 ### Methods: setAPIKey/getAPIKey
 	
-# CongressPerson - Work with legislators: senators and congressmen
-	
-#### self.find_by_name - return an array of CongressPersons
-#### self.find_by_zipcode - return an array of CongressPersons
-#### self.find_by_crp_id - return the CongressPerson with specified crp id
+
+
+h1. Utils
+
+There are lots of simple transformations which come up in using these 
+APIs and so for convenience sake some of those are built right into this library
+
+Utils.lookup_state_name(string) -> two letter state code for that state

data/VERSION.yml

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

data/lib/congress_person.rb

@@ -32,7 +32,7 @@ class CongressPerson < GovSdkBase
   
   attr_reader :firstname, :lastname, :party, :state, :congress_office, :phone, :fax, :emai,
               :website, :webform, :website_url, :bioguide_id, :congresspedia_url, :state_machine_id,
-              :district, :title, :govtrack_id, :crp_id, :nickname, :votesmart_id
+              :district, :title, :govtrack_id, :crp_id, :nickname, :votesmart_id, :votesmart_id
               
   # Maps specific set of CongressPerson attributes to Sunlight APIs. Mapping is structured as
   # "name of attr in CongressPerson object" => "name of hash key in result returned from API call"
@@ -78,7 +78,16 @@ class CongressPerson < GovSdkBase
     sunlight_hash = GovSdk.sunlight_api.legislators_search(name)
     sunlight_hash.collect {|leg| convert_to_congressperson(leg["result"]["legislator"])}
   end
-
+  
+  # Return an array of Congress People, searching using first and last name
+  def self.find_by_names(firstname, lastname)
+    assume_string lastname
+    assume_string firstname
+    assume_uses_sunl_api
+    result_array = GovSdk.sunlight_api.legislators_getlist(:firstname => firstname, :lastname => lastname)
+    result_array.collect { |leg| convert_to_congressperson(leg["legislator"])}
+  end    
+    
   def self.find_by_zipcode(zip)
     raise ArgumentError, 'zipcodes must be Strings' unless zip.is_a?(String)
   end

data/lib/govsdk_base.rb

@@ -36,19 +36,36 @@ class GovSdkBase
   end
   
   def assume_uses_google_api
-    raise ArgumentError, "Call requires Google API and Google key" + called.shift unless GovSdk.google_api.initialized?
+    raise ArgumentError, "Call requires Google API and Google key" + caller.shift unless GovSdk.google_api.initialized?
+  end
+  
+  def self.assume_uses_sunl_api
+    raise ArgumentError, "Call requires Sunlight API, so it needs you to set the Sunlight API key" + caller.shift unless GovSdk.sunlight_api.initialized?
+  end
+
+  def assume_uses_sunl_api
+    self.assume_uses_sunl_api
   end
   
   def assume_nil_or_integer val
-    raise ArgumentError, "Requires nil or integer argument. Called from " + called.shift unless  val.nil? || val.kind_of?(Integer)
+    raise ArgumentError, "Requires nil or integer argument. Called from " + caller.shift unless  val.nil? || val.kind_of?(Integer)
   end
   
   def self.assume_hash val
-    raise ArgumentError, "Requires a hash argument. Called from " + called.shift unless val.kind_of?(Hash)
+    raise ArgumentError, "Requires a hash argument. Called from " + caller.shift unless val.kind_of?(Hash)
   end    
   
   def assume_hash val
     self.assume_hash val
   end
   
+  def self.assume_string(val)
+    raise ArgumentError, "Requires a string argument. Called from " + caller.shift unless val.kind_of?(String)
+  end
+  
+  def assume_string(val)
+    self.assume_string val
+  end
+  
+  
 end

data/lib/govsdkgem.rb

@@ -31,3 +31,4 @@ require 'congress_person'
 require 'vote_smart_api'
 require 'google_api'
 require 'sunlight_api'
+require 'util'

data/lib/util.rb

@@ -0,0 +1,110 @@
+=begin
+  * Name: util.rb
+  * Description: Small handy translators to support users of govsdk
+  * Author: Pito Salas
+  * Copyright: (c) R. Pito Salas and Associates, Inc.
+  * Date: January 2009
+  * License: GPL
+
+  This file is part of GovSDK.
+
+  GovSDK is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  GovSDK is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with GovSDK.  If not, see <http://www.gnu.org/licenses/>.
+  
+  require "ruby-debug"
+  Debugger.settings[:autolist] = 1 # list nearby lines on stop
+  Debugger.settings[:autoeval] = 1
+  Debugger.start
+  
+=end
+
+STATE_ABBR = {
+  'AL' => 'Alabama',
+  'AK' => 'Alaska',
+  'AS' => 'America Samoa',
+  'AZ' => 'Arizona',
+  'AR' => 'Arkansas',
+  'CA' => 'California',
+  'CO' => 'Colorado',
+  'CT' => 'Connecticut',
+  'DE' => 'Delaware',
+  'DC' => 'District of Columbia',
+  'FM' => 'Micronesia1',
+  'FL' => 'Florida',
+  'GA' => 'Georgia',
+  'GU' => 'Guam',
+  'HI' => 'Hawaii',
+  'ID' => 'Idaho',
+  'IL' => 'Illinois',
+  'IN' => 'Indiana',
+  'IA' => 'Iowa',
+  'KS' => 'Kansas',
+  'KY' => 'Kentucky',
+  'LA' => 'Louisiana',
+  'ME' => 'Maine',
+  'MH' => 'Islands1',
+  'MD' => 'Maryland',
+  'MA' => 'Massachusetts',
+  'MI' => 'Michigan',
+  'MN' => 'Minnesota',
+  'MS' => 'Mississippi',
+  'MO' => 'Missouri',
+  'MT' => 'Montana',
+  'NE' => 'Nebraska',
+  'NV' => 'Nevada',
+  'NH' => 'New Hampshire',
+  'NJ' => 'New Jersey',
+  'NM' => 'New Mexico',
+  'NY' => 'New York',
+  'NC' => 'North Carolina',
+  'ND' => 'North Dakota',
+  'OH' => 'Ohio',
+  'OK' => 'Oklahoma',
+  'OR' => 'Oregon',
+  'PW' => 'Palau',
+  'PA' => 'Pennsylvania',
+  'PR' => 'Puerto Rico',
+  'RI' => 'Rhode Island',
+  'SC' => 'South Carolina',
+  'SD' => 'South Dakota',
+  'TN' => 'Tennessee',
+  'TX' => 'Texas',
+  'UT' => 'Utah',
+  'VT' => 'Vermont',
+  'VI' => 'Virgin Island',
+  'VA' => 'Virginia',
+  'WA' => 'Washington',
+  'WV' => 'West Virginia',
+  'WI' => 'Wisconsin',
+  'WY' => 'Wyoming'
+}
+#
+# Simple collection of Utilities useful to govsdk users
+#
+class Util
+  
+#
+# 2 letter code for state that most closely matches state_name, or nil.
+# 
+  def self.lookup_state_name(state_name)
+    matches = STATE_ABBR.select { |k,v| v.include? state_name.capitalize}
+    if matches.length == 1
+      return matches[0][0]
+    else
+      return nil
+    end
+  end
+
+end
+    
+    

data/test/congressperson_test.rb

@@ -35,6 +35,8 @@ class CongressPersonTest < Test::Unit::TestCase
     setup do
       GovSdk.load_apis
       GovSdk.sunlight_api.key = "4ffa22917ab1ed010a8e681c550c9593"
+      GovSdk.google_api.key = "ABQIAAAAyvWaJgF_91PvBZhITx5FDxRIYAcXj39F4zFQfQ2X3IEFURxvMRRUi0aCG6WofnUSRRoI-Pgytm5yUA"
+      
       @cpnone = CongressPerson.fuzzy_find_by_name("Pito Salas")
       @cpkennedy = CongressPerson.fuzzy_find_by_name("Kennedy")
       @cpkennedy[0].nickname == "Ted" ? @ted_crp_id = @cpkennedy[0].crp_id : @ted_crp_id = @cpkennedy[1].crp_id
@@ -50,6 +52,13 @@ class CongressPersonTest < Test::Unit::TestCase
         assert ["Edward", "Patrick Joseph"].include? a_kennedy.firstname
       end
     end
+    
+    should "locate barney frank by first and last name" do
+      cp = CongressPerson.find_by_names("barney", "frank")
+      assert_equal 1, cp.length
+      assert_equal "26897", cp[0].votesmart_id
+      pp cp[0].photo_url
+    end
 
     context "trying to use CRP from earlier test" do
       setup do

data/test/test_helper.rb

@@ -17,6 +17,7 @@ require 'generic_api'
 require 'sunlight_api'
 require 'open_secrets_api'
 require 'vote_smart_api'
+require 'util'
 
 class Test::Unit::TestCase
 end

data/test/test_template.rb

@@ -1,4 +1,3 @@
-require File.dirname(__FILE__) + '/test_helper'
 =begin
   * Name: test_template.rb
   * Description: Template for GovSdk Tests
@@ -27,6 +26,7 @@ require File.dirname(__FILE__) + '/test_helper'
   Debugger.settings[:autoeval] = 1
   Debugger.start
 =end
+require File.dirname(__FILE__) + '/test_helper'
 
 class MyTest < Test::Unit::TestCase
   context "Test context" do

data/test/util_test.rb

@@ -0,0 +1,42 @@
+=begin
+  * Name: test_template.rb
+  * Description: Template for GovSdk Tests
+  * Author: Pito Salas
+  * Copyright: (c) R. Pito Salas and Associates, Inc.
+  * Date: January 2009
+  * License: GPL
+
+  This file is part of GovSDK.
+
+  GovSDK is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  GovSDK is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with GovSDK.  If not, see <http://www.gnu.org/licenses/>.
+  
+  require "ruby-debug"
+  Debugger.settings[:autolist] = 1 # list nearby lines on stop
+  Debugger.settings[:autoeval] = 1
+  Debugger.start
+=end
+
+require File.dirname(__FILE__) + '/test_helper'
+
+class MyTest < Test::Unit::TestCase
+  context "Util methods test" do
+
+    should "Lookup a state" do
+      assert_equal "MA", Util.lookup_state_name("Mass")
+      assert_equal "MA", Util.lookup_state_name("mass")
+      assert_equal nil, Util.lookup_state_name("new")
+      assert_equal nil, Util.lookup_state_name("pito")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pitosalas-govsdk
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Pito Salas
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-18 00:00:00 -08:00
+date: 2009-02-25 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -34,6 +34,7 @@ files:
 - lib/govsdk.rb
 - lib/govsdk_base.rb
 - lib/govsdkgem.rb
+- lib/util.rb
 - test/congressperson_test.rb
 - test/google_api_test.rb
 - test/govsdk_test.rb
@@ -41,6 +42,7 @@ files:
 - test/sunlight_api_test.rb
 - test/test_helper.rb
 - test/test_template.rb
+- test/util_test.rb
 - test/vote_smart_api_test.rb
 has_rdoc: true
 homepage: http://github.com/pitosalas/govsdk