pitosalas-govsdk 0.0.1

data/VERSION.yml

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

data/lib/apimanagers.rb

@@ -0,0 +1,124 @@
+=begin
+  * Name: GovSDK
+  * Description: 
+  * 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/>.
+=end
+
+require 'rubygems'
+require 'httparty'
+require 'cgi'
+require 'net/http'
+
+#require "ruby-debug"
+#Debugger.settings[:autolist] = 1 # list nearby lines on stop
+#Debugger.settings[:autoeval] = 1
+#Debugger.start
+
+class GenericAPI  
+  
+  def initialized?
+    !@api_key.nil? || @api_key.kind_of?(String)
+  end
+  
+end
+
+# Control Access to Sunlight API.
+
+class Sunlight < GenericAPI
+  include HTTParty
+  Sunlight.base_uri "services.sunlightlabs.com"
+
+  def legislators_search(params)
+    result = Sunlight.get("/api/legislators.search", :query => {:name => params})
+    result["response"]["results"]
+  end
+  
+  # Simply declare and remember the API Key
+  def key=(key)
+    @api_key = key
+    Sunlight.default_params :apikey => key
+  end
+
+  # Call any of the various legal Sunlight queries
+  def legislators_get(params)
+    begin
+      result = Sunlight.get("/api/legislators.get", :query => params)
+      result = result["response"]["legislator"]
+    rescue Net::HTTPServerException => exception
+      puts "EXCEPTION: from Sunlight - legislators.get: #{exception.response.body}"
+      return nil
+    end
+  end
+  
+end
+
+# Control Access to OpenSecrets API.
+class OpenSecrets < GenericAPI
+  include HTTParty
+  base_uri "www.opensecrets.org/api/"
+  format :xml
+
+  def key=(key)
+    @api_key = key
+    OpenSecrets.default_params :apikey => key
+  end
+  
+  def get_cand_info(method_name, crpID, cycle)
+    query_hash = {:method => method_name}
+    begin
+      result = OpenSecrets.get("", :query => query_hash.merge({:cid => crpID, :cycle => cycle}))
+    rescue Net::HTTPServerException => exception
+      puts "EXCEPTION: from Opensecrets! #{method_name}: #{exception.response.body}"
+      return nil
+    end
+  end
+  
+  def get_cand_summary_for_crpID(crpID, cycle = "")
+    result = get_cand_info("candSummary", crpID, cycle)
+    result["response"]["summary"]
+  end
+  
+  def get_cand_pfd_assets(crpID, cycle = "")
+    result = get_cand_info("memPFDprofile", crpID, cycle)
+    result["response"]["member_profile"]["assets"]["asset"]
+  end
+  
+  def get_cand_pfd_transactions(crpID, cycle = "")
+    result = get_cand_info("memPFDprofile", crpID, cycle)
+    result["response"]["member_profile"]["transactions"]["transaction"]
+  end
+  
+  def get_cand_pfd_positions_held(crpID, cycle = "")
+    result = get_cand_info("memPFDprofile", crpID, cycle)
+    result = result["response"]["member_profile"]
+    if result.has_key?("positions")
+      result["positions"]["position"]
+    else
+      nil
+    end
+  end
+end
+
+
+
+  
+
+

data/lib/govsdk.rb

@@ -0,0 +1,59 @@
+=begin
+  * Name: GovSDK
+  * Description: 
+  * 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/>.
+=end
+
+#require "ruby-debug"
+#Debugger.settings[:autolist] = 1 # list nearby lines on stop
+#Debugger.settings[:autoeval] = 1
+#Debugger.start
+
+class GovSdk
+
+  def self.load_apis
+    @sunl_api = Sunlight.new
+    @opens_api = OpenSecrets.new
+  end
+  
+  def self.sunlight_api
+    @sunl_api
+  end
+  
+  def self.opensecrets_api
+    @opens_api
+  end
+  
+  def self.followmoney_api
+    @followm_api
+  end
+  
+  def self.init(apikeys = {})
+    apikeys.keys.each { |x| raise ArgumentError unless [:followmoney, :sunlight, :opensecrets].include?(x) }
+    GovSdk.load_apis
+    apikeys.each do |key, val|
+      @sunl_api.key = val if key == :sunlight
+      @opens_api.key = val if key == :opensecrets
+      @followm_api.key = val if key == :followmoney
+    end
+  end
+  
+end

data/lib/govsdkgem.rb

@@ -0,0 +1,27 @@
+=begin
+  * Name: GovSDK
+  * Description: 
+  * 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/>.
+=end
+
+require 'govsdk'
+require 'apimanagers'
+require 'congressperson'

data/lib/template.rb

@@ -0,0 +1,23 @@
+=begin
+  * Name: GovSDK
+  * Description: 
+  * 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/>.
+=end

data/test/apimanagers_test.rb

@@ -0,0 +1,109 @@
+require File.dirname(__FILE__) + '/test_helper'
+=begin
+  * Name: GovSDK
+  * Description: 
+  * 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/>.
+=end
+
+class TestAPIs < Test::Unit::TestCase
+  context "brand new API manager" do
+    setup do
+      @apim = GenericAPI.new
+    end
+
+    should "not be initialized" do
+      assert_equal false, @apim.initialized?
+    end
+  end
+  
+  context "Sunlight API" do
+    setup do      
+      GovSdk.load_apis
+      GovSdk.sunlight_api.key = "4ffa22917ab1ed010a8e681c550c9593"
+    end
+
+    should "be initialized once APIkey is set" do
+      assert_equal true, GovSdk.sunlight_api.initialized?
+    end
+    
+    should "return no legislator called Pito Salas" do
+      result = GovSdk.sunlight_api.legislators_search("Pito Salas")
+      assert_equal 0, result.length        
+    end
+    
+    should "return a single legislator called Ted Kennedy" do    
+      result = GovSdk.sunlight_api.legislators_search("Ted Kennedy")
+      assert 1, result.length
+    end
+    
+    should "return a single legislator with the nickname ted" do
+      result = GovSdk.sunlight_api.legislators_get(:nickname => "Ted", :lastname => "Kennedy")
+      assert_equal "Ted", result["nickname"]
+    end
+    
+    should "be able to locate crp_id N00000308" do
+      result = GovSdk.sunlight_api.legislators_get(:crp_id => "N00000308")
+    end
+    
+    should "be able to go from name to crp_id and back" do
+      result = GovSdk.sunlight_api.legislators_get(:nickname => "ted", :lastname => "Kennedy")
+      crp_id = result["crp_id"]
+      result = GovSdk.sunlight_api.legislators_get(:crp_id => crp_id)
+      assert_equal "Ted", result["nickname"]
+    end
+
+  end
+  
+  context "OpenSecrets API manager" do
+    setup do
+      GovSdk.load_apis
+      GovSdk.opensecrets_api.key = "09c975b6d3f19eb865805b2244311065"
+      @os_api = GovSdk.opensecrets_api
+    end
+
+    should "be initialized once APIkey is set" do
+      assert_equal true,  @os_api.initialized?
+    end
+    
+    should "locate candidate summary for N00000308 and he's in MA" do
+      assert_equal "MA", @os_api.get_cand_summary_for_crpID("N00000308", 2006)["state"]
+    end
+    
+    should "locate asset list for N00000360 and check that he has 3" do
+      assert_equal 3, @os_api.get_cand_pfd_assets("N00000360", cycle = "").length
+    end
+    
+    should "locate transaction list for N00000019 and check that he has 3" do
+      assert_equal 20, @os_api.get_cand_pfd_transactions("N00000019", cycle = "").length
+    end
+    
+    should "locate list of positions held for N00000360 and check the count" do
+      assert_equal 16, @os_api.get_cand_pfd_positions_held("N00000360", cycle = "").length
+    end
+    
+    should "locate list of positions held for N00000308 and check the count" do
+      assert_equal 4, @os_api.get_cand_pfd_positions_held("N00000308", cycle = "").length
+      assert_equal 2, @os_api.get_cand_pfd_positions_held("N00000019", cycle = "").length
+    end
+    
+  end
+  
+end

data/test/congressperson_test.rb

@@ -0,0 +1,109 @@
+=begin
+  * Name: GovSDK
+  * Description: 
+  * 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/>.
+=end
+
+require File.dirname(__FILE__) + '/test_helper'
+
+class CongressPersonTest < Test::Unit::TestCase
+  context "In basic CongressPerson cases" do
+    setup do
+      GovSdk.load_apis
+      GovSdk.sunlight_api.key = "4ffa22917ab1ed010a8e681c550c9593"
+      @cpnone = CongressPerson.find_by_name("Pito Salas")
+      @cpkennedy = CongressPerson.find_by_name("Kennedy")
+      @cpkennedy[0].nickname == "Ted" ? @ted_crp_id = @cpkennedy[0].crp_id : @ted_crp_id = @cpkennedy[1].crp_id
+    end
+
+    should "return none" do
+      assert_equal 0, @cpnone.length
+    end
+  
+    should "return two legislators named Kennedy" do
+      assert_equal 2, @cpkennedy.length
+      @cpkennedy.each do |a_kennedy|
+        assert ["Edward", "Patrick Joseph"].include? a_kennedy.firstname
+      end
+    end
+
+    context "trying to use CRP from earlier test" do
+      setup do
+        @cpteddy = CongressPerson.find_by_crp_id(@ted_crp_id)
+      end
+      
+      should "Bad crp should be nil" do
+        @cpbad = CongressPerson.find_by_crp_id("1")   
+        assert_nil @cpbad
+      end
+
+      should "crpid should be for ted kennedy" do
+        assert_equal "Ted", @cpteddy.nickname
+      end
+    end
+
+    context "Get fundraising summary for N00000308" do
+      setup do
+        GovSdk.opensecrets_api.key = "09c975b6d3f19eb865805b2244311065"
+        @mycandidate = CongressPerson.find_by_crp_id("N00000308")
+      end
+
+      should "pull info out of summary" do
+        assert_not_nil @mycandidate.crp_id
+        fund_sum = @mycandidate.get_fundraising_summary(2008)
+        assert_equal 0, fund_sum.debt
+        fund_sum = @mycandidate.get_fundraising_summary(2006)
+        assert_equal 0, fund_sum.debt          
+      end
+    end
+
+    context "Get a look at positions held detail for N00000360 and Clinton" do
+      setup do
+        GovSdk.opensecrets_api.key = "09c975b6d3f19eb865805b2244311065"
+        @mycandidate = CongressPerson.find_by_crp_id("N00000360")
+        @nopositioncandidate = CongressPerson.find_by_name("Clinton")
+      end
+
+      should "see what positions were held for N00000360" do
+        positions_held = @mycandidate.get_positions_held(2008)
+        assert_equal 16, positions_held.length
+      end
+      
+      should "work if candidate has no positions held information" do
+        positions_held = @nopositioncandidate[0].get_positions_held(2008)
+        assert_equal 1, positions_held.length
+      end
+    end
+    
+    context "Try some other odd cases" do
+      setup do
+        GovSdk.opensecrets_api.key = "09c975b6d3f19eb865805b2244311065"
+        @franks = CongressPerson.find_by_name("Frank")[0]
+      end
+
+      should "see that barney frank reported zero positions" do
+        assert_equal 0, @franks.get_positions_held(2008).length        
+      end
+    end
+    
+    
+  end
+end

data/test/govsdk_test.rb

@@ -0,0 +1,45 @@
+=begin
+  * Name: GovSDK
+  * Description: 
+  * 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/>.
+=end
+
+require File.dirname(__FILE__) + '/test_helper'
+
+class GovSdkTest < Test::Unit::TestCase
+  context "" do
+    setup do
+
+    end
+
+    should "Check error checking with invalid arg" do
+      assert_raise ArgumentError do
+        GovSdk.init(:xx => 1)
+      end
+    end
+    should "Check error checking with valid args" do
+      assert_nothing_raised ArgumentError do
+        GovSdk.init(:sunlight => 1, :opensecrets => 2)
+      end
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'pp'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'govsdk'
+require 'apimanagers'
+require 'congressperson'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: pitosalas-govsdk
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Pito Salas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-30 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: TODO
+email: rps@salas.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- VERSION.yml
+- lib/apimanagers.rb
+- lib/congress_person.rb
+- lib/govsdk.rb
+- lib/govsdkgem.rb
+- lib/template.rb
+- test/apimanagers_test.rb
+- test/congressperson_test.rb
+- test/govsdk_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/pitosalas/govsdk
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: []
+