bcardarella-deepthroat 0.3.0

data/test/unit/test_contributions.rb

@@ -0,0 +1,181 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestContributions < Test::Unit::TestCase
+  
+  def setup
+    shared_attributes
+    DeepThroat.api_key = "validApiKey"
+    web_faker(:contributions, :cid => @cid, :cycle => @cycle, :apikey => DeepThroat.api_key)
+  end
+  
+  context "Finding all contributions for Hilary Clinton in 2006" do
+    setup { @contributions = DeepThroat::Contributions.find(:cid => @cid, :cycle => @cycle) }
+    
+    should "map #cid" do
+      assert_equal @cid, @contributions.cid
+    end
+    
+    should "map #cycle" do
+      assert_equal @cycle, @contributions.cycle
+    end
+        
+    should "map #name" do
+      assert_equal @contributions.name, @contributions.name
+    end
+    
+    should "map #origin" do
+      assert_equal @contributions.origin, @contributions.origin
+    end
+    
+    should "map #source" do
+      assert_equal @contributions.source, @contributions.source
+    end
+    
+    should_eventually "map #contributors" do
+      assert_kind_of Array, @contributions.contributors
+    end
+  end
+  
+  context "Finding all contributions for Hillary Clinton with no cycle defined" do
+    setup do
+      web_faker(:contributions, :cid => @cid, :apikey => DeepThroat.api_key)
+    end
+    
+    should "not raise any errors" do
+      assert_nothing_raised do
+        @contributions = DeepThroat::Contributions.find(:cid => @cid)
+      end
+    end
+  end
+  
+  context "A new instance with missing attributes" do
+    should "raise a 'DeepThroat::NoCIDError' when not given a cid" do
+      assert_raise DeepThroat::NoCIDError do
+        DeepThroat::Contributions.find(:cycle => @cycle)
+      end
+    end    
+  end
+  
+  context "Obtaining the XML" do
+    setup { @xml_response = DeepThroat::Contributions.get_xml(:cid => @cid, :cycle => @cycle, :method => "candContrib") }
+  
+    should "return an XML feed" do
+      assert_equal @test_xml, @xml_response
+    end
+  end
+  
+  context "Parsing the XML" do
+    setup { @contributions = DeepThroat::Contributions.parse(@test_xml)[0] }
+  
+    should "the return a 'DeepThroat::Contributions::Details' object" do
+      assert_kind_of DeepThroat::Contributions, @contributions
+    end
+    
+    should "assign :name" do
+      assert_equal @name, @contributions.name
+      assert_kind_of String, @contributions.name
+    end
+    
+    should "assign :origin" do
+      assert_equal @origin, @contributions.origin
+      assert_kind_of String, @contributions.origin
+    end
+    
+    should "assign :source" do
+      assert_equal @source, @contributions.source
+      assert_kind_of String, @contributions.source
+    end
+  
+    should "assign :contributors" do
+      assert_kind_of Array, @contributions.contributors
+    end
+  end
+  
+  
+  context "Sad Paths" do
+    setup do
+      # invalid ApiKey
+      web_faker(:contributions_bad_api_key, :cid => @cid, :cycle => @cycle, :apikey => "badApiKey")
+      # blank ApiKey
+      web_faker(:contributions_bad_api_key, :cid => @cid, :cycle => @cycle, :apikey => "")
+      # no ApiKey
+      web_faker(:contributions_bad_api_key, :cid => @cid, :cycle => @cycle)
+      
+      # invalid CID
+      web_faker(:contributions_bad_cid, :cid => "badCID", :cycle => @cycle, :apikey => @api_key)
+    end
+    
+    context "ApiKey" do
+      should "raise 'DeepThroat::InvalidOrMissing::ApiKeyError' when given a bad ApiKey" do
+        DeepThroat.api_key = "badApiKey"
+        assert_raise DeepThroat::InvalidOrMissing::ApiKeyError do
+          DeepThroat::Contributions.find(:cid => @cid, :cycle => @cycle)
+        end
+      end
+      
+      should "raise 'DeepThroat::InvalidOrMissing::ApiKeyError' when given a blank ApiKey" do
+        DeepThroat.api_key = ""
+        assert_raise DeepThroat::InvalidOrMissing::ApiKeyError do
+          DeepThroat::Contributions.find(:cid => @cid, :cycle => @cycle)
+        end
+      end
+  
+      should "raise 'DeepThroat::InvalidOrMissing::ApiKeyError' when given no ApiKey" do
+        DeepThroat.api_key = nil
+        assert_raise DeepThroat::InvalidOrMissing::ApiKeyError do
+          DeepThroat::Contributions.find(:cid => @cid, :cycle => @cycle)
+        end
+      end
+    end
+  
+    context "CID" do
+      should "raise 'DeepThroat::InvalidOrMissing::CIDError' when given a bad CID" do
+        @bad_cid = "badCID"
+        assert_raise DeepThroat::InvalidOrMissing::CIDError do
+          DeepThroat::Contributions.find(:cid => @bad_cid, :cycle => @cycle)
+        end
+      end      
+    end
+  
+    context "Cycle" do
+      should "raise 'DeepThroat::InvalidOrMissing::CycleError' when given a bad Cycle" do
+        @bad_cycle = 2000
+        assert_raise DeepThroat::InvalidOrMissing::CycleError do
+          DeepThroat::Contributions.find(:cid => @cid, :cycle => @bad_cycle)
+        end
+      end
+    end
+  
+  end
+  
+  context "CONSTANTS" do
+    should "have CYCLES defined as an Array" do
+      assert_kind_of Array, DeepThroat::Contributions::CYCLES
+    end
+    
+    context "CYCLES" do
+      should "include the year 2006" do
+        assert DeepThroat::Contributions::CYCLES.include?(2006)
+      end
+      
+      should "include the year 2008" do
+        assert DeepThroat::Contributions::CYCLES.include?(2008)
+      end
+    end
+  end
+  
+  
+  private
+  
+  def shared_attributes
+    @cid      = "N00000019"
+    @cycle    = 2006
+    @api_key  = DeepThroat.api_key
+  
+    @test_xml = contributions_xml.match(/<response>.*/)[0]
+
+    @name     = "Hillary Clinton (D)"
+    @origin   = "Center for Responsive Politics"
+    @source   = "http://www.opensecrets.org/politicians/contrib.php?cid=N00000019&cycle=2006"    
+  end
+end

data/test/unit/test_contributions_contributor.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestContributionsContributor < Test::Unit::TestCase
+  def setup
+    shared_attributes
+    DeepThroat.api_key = "fakeapi_key"
+    web_faker(:contributions, :cid => @cid, :cycle => @cycle, :api_key => DeepThroat.api_key)
+  end
+    
+  context "Parsing the XML" do
+    setup { @contributor = DeepThroat::Contributions::Contributor.parse(@test_xml) }
+
+    should "the return a 'DeepThroat::Contributions::Contributor' object" do
+      assert_kind_of DeepThroat::Contributions::Contributor, @contributor
+    end
+    
+    should "assign :organization" do
+      assert_equal @organization, @contributor.organization
+      assert_kind_of String, @contributor.organization
+    end
+    
+    should "assign :total" do
+      assert_equal @total, @contributor.total
+      assert_kind_of Integer, @contributor.total
+    end
+  end
+  
+  private
+  
+  def shared_attributes
+    @cid          = "N00000019"
+    @cycle        = 2006
+  
+    @test_xml     = "<contributor org_name=\"Goldman Sachs\" total=\"193570\" />"
+    @organization = "Goldman Sachs"
+    @total        = 193570    
+  end
+end

data/test/unit/test_industries.rb

@@ -0,0 +1,181 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestIndustries < Test::Unit::TestCase
+  
+  def setup
+    shared_attributes
+    DeepThroat.api_key = "validApiKey"
+    web_faker(:industries, :cid => @cid, :cycle => @cycle, :apikey => DeepThroat.api_key)
+  end
+  
+  context "Finding all contributions by industries for Hilary Clinton in 2006" do
+    setup { @industries = DeepThroat::Industries.find(:cid => @cid, :cycle => @cycle) }
+    
+    should "map #cid" do
+      assert_equal @cid, @industries.cid
+    end
+    
+    should "map #cycle" do
+      assert_equal @cycle, @industries.cycle
+    end
+        
+    should "map #name" do
+      assert_equal @industries.name, @industries.name
+    end
+    
+    should "map #origin" do
+      assert_equal @industries.origin, @industries.origin
+    end
+    
+    should "map #source" do
+      assert_equal @industries.source, @industries.source
+    end
+    
+    should_eventually "map #industries" do
+      assert_kind_of Array, @industries.industries
+    end
+  end
+  
+  context "Finding all industries for Hillary Clinton with no cycle defined" do
+    setup do
+      web_faker(:industries, :cid => @cid, :apikey => DeepThroat.api_key)
+    end
+    
+    should "not raise any errors" do
+      assert_nothing_raised do
+        @industries = DeepThroat::Industries.find(:cid => @cid)
+      end
+    end
+  end
+  
+  context "A new instance with missing attributes" do
+    should "raise a 'DeepThroat::NoCIDError' when not given a cid" do
+      assert_raise DeepThroat::NoCIDError do
+        DeepThroat::Industries.find(:cycle => @cycle)
+      end
+    end    
+  end
+  
+  context "Obtaining the XML" do
+    setup { @xml_response = DeepThroat::Industries.get_xml(:cid => @cid, :cycle => @cycle, :method => "candIndustry") }
+  
+    should "return an XML feed" do
+      assert_equal @test_xml, @xml_response
+    end
+  end
+  
+  context "Parsing the XML" do
+    setup { @industries = DeepThroat::Industries.parse(@test_xml)[0] }
+  
+    should "the return a 'DeepThroat::Industries::Details' object" do
+      assert_kind_of DeepThroat::Industries, @industries
+    end
+    
+    should "assign :name" do
+      assert_equal @name, @industries.name
+      assert_kind_of String, @industries.name
+    end
+    
+    should "assign :origin" do
+      assert_equal @origin, @industries.origin
+      assert_kind_of String, @industries.origin
+    end
+    
+    should "assign :source" do
+      assert_equal @source, @industries.source
+      assert_kind_of String, @industries.source
+    end
+  
+    should "assign :industries" do
+      assert_kind_of Array, @industries.industries
+    end
+  end
+  
+  
+  context "Sad Paths" do
+    setup do
+      # invalid ApiKey
+      web_faker(:industries_bad_api_key, :cid => @cid, :cycle => @cycle, :apikey => "badApiKey")
+      # blank ApiKey
+      web_faker(:industries_bad_api_key, :cid => @cid, :cycle => @cycle, :apikey => "")
+      # no ApiKey
+      web_faker(:industries_bad_api_key, :cid => @cid, :cycle => @cycle)
+      
+      # invalid CID
+      web_faker(:industries_bad_cid, :cid => "badCID", :cycle => @cycle, :apikey => @api_key)
+    end
+    
+    context "ApiKey" do
+      should "raise 'DeepThroat::InvalidOrMissing::ApiKeyError' when given a bad ApiKey" do
+        DeepThroat.api_key = "badApiKey"
+        assert_raise DeepThroat::InvalidOrMissing::ApiKeyError do
+          DeepThroat::Industries.find(:cid => @cid, :cycle => @cycle)
+        end
+      end
+      
+      should "raise 'DeepThroat::InvalidOrMissing::ApiKeyError' when given a blank ApiKey" do
+        DeepThroat.api_key = ""
+        assert_raise DeepThroat::InvalidOrMissing::ApiKeyError do
+          DeepThroat::Industries.find(:cid => @cid, :cycle => @cycle)
+        end
+      end
+  
+      should "raise 'DeepThroat::InvalidOrMissing::ApiKeyError' when given no ApiKey" do
+        DeepThroat.api_key = nil
+        assert_raise DeepThroat::InvalidOrMissing::ApiKeyError do
+          DeepThroat::Industries.find(:cid => @cid, :cycle => @cycle)
+        end
+      end
+    end
+  
+    context "CID" do
+      should "raise 'DeepThroat::InvalidOrMissing::CIDError' when given a bad CID" do
+        @bad_cid = "badCID"
+        assert_raise DeepThroat::InvalidOrMissing::CIDError do
+          DeepThroat::Industries.find(:cid => @bad_cid, :cycle => @cycle)
+        end
+      end      
+    end
+  
+    context "Cycle" do
+      should "raise 'DeepThroat::InvalidOrMissing::CycleError' when given a bad Cycle" do
+        @bad_cycle = 2000
+        assert_raise DeepThroat::InvalidOrMissing::CycleError do
+          DeepThroat::Industries.find(:cid => @cid, :cycle => @bad_cycle)
+        end
+      end
+    end
+  
+  end
+  
+  context "CONSTANTS" do
+    should "have CYCLES defined as an Array" do
+      assert_kind_of Array, DeepThroat::Industries::CYCLES
+    end
+    
+    context "CYCLES" do
+      should "include the year 2006" do
+        assert DeepThroat::Industries::CYCLES.include?(2006)
+      end
+      
+      should "include the year 2008" do
+        assert DeepThroat::Industries::CYCLES.include?(2008)
+      end
+    end
+  end
+  
+  
+  private
+  
+  def shared_attributes
+    @cid      = "N00000019"
+    @cycle    = 2006
+    @api_key  = DeepThroat.api_key
+  
+    @test_xml = industries_xml.match(/<response>.*/)[0]
+
+    @name     = "Hillary Clinton (D)"
+    @origin   = "Center for Responsive Politics"
+    @source   = "http://www.opensecrets.org/politicians/industries.php?cid=N00000019&cycle=2006"    
+  end
+end

data/test/unit/test_industries_industry.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestIndustriesIndustry < Test::Unit::TestCase
+  def setup
+    shared_attributes
+    DeepThroat.api_key = "fakeapi_key"
+    web_faker(:industries, :cid => @cid, :cycle => @cycle, :api_key => DeepThroat.api_key)
+  end
+    
+  context "Parsing the XML" do
+    setup { @industry = DeepThroat::Industries::Industry.parse(@test_xml) }
+
+    should "the return a 'DeepThroat::Industries::Industry' object" do
+      assert_kind_of DeepThroat::Industries::Industry, @industry
+    end
+    
+    should "assign :industry" do
+      assert_equal @industry_name, @industry.industry
+      assert_kind_of String, @industry.industry
+    end
+    
+    should "assign :indivs" do
+      assert_equal @indivs, @industry.indivs
+      assert_kind_of Integer, @industry.indivs
+    end
+
+    should "assign :pacs" do
+      assert_equal @pacs, @industry.pacs
+      assert_kind_of Integer, @industry.pacs
+    end
+
+    should "assign :total" do
+      assert_equal @total, @industry.total
+      assert_kind_of Integer, @industry.total
+    end
+  end
+  
+  private
+  
+  def shared_attributes
+    @cid           = "N00000019"
+    @cycle         = 2006
+  
+    @test_xml      = "<industry industry_name=\"Education\" indivs=\"713124\" pacs=\"7000\" total=\"720124\" />"
+    @industry_name = "Education"
+    @indivs        = 713124
+    @pacs          = 7000
+    @total         = 720124
+  end
+end

data/test/unit/test_industry.rb

@@ -0,0 +1,243 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class TestIndustry < Test::Unit::TestCase
+  
+  def setup
+    shared_attributes
+    DeepThroat.api_key = "validApiKey"
+    web_faker(:industry, :cid => @cid, :cycle => @cycle, :apikey => DeepThroat.api_key, :ind => "A01")
+  end
+  
+  context "Finding all contributions by industry for Hilary Clinton in 2006" do
+    setup { @industry = DeepThroat::Industry.find(:cid => @cid, :cycle => @cycle, :ind => "A01") }
+    
+    should "map #cid" do
+      assert_equal @cid, @industry.cid
+    end
+    
+    should "map #cycle" do
+      assert_equal @cycle, @industry.cycle
+    end
+        
+    should "map #name" do
+      assert_equal @industry.name, @industry.name
+    end
+    
+    should "map #state" do
+      assert_equal @industry.state, @industry.state
+    end
+    
+    should "map #party" do
+      assert_equal @industry.party, @industry.party
+    end
+    
+    should "map #chamber" do
+      assert_equal @industry.chamber, @industry.chamber
+    end
+    
+    should "map #origin" do
+      assert_equal @industry.origin, @industry.origin
+    end
+    
+    should "map #source" do
+      assert_equal @industry.source, @industry.source
+    end
+  end
+  
+  context "Finding all industry for Hillary Clinton with no cycle defined" do
+    setup do
+      web_faker(:industry, :cid => @cid, :apikey => DeepThroat.api_key, :ind => "A01")
+    end
+    
+    should "not raise any errors" do
+      assert_nothing_raised do
+        @industry = DeepThroat::Industry.find(:cid => @cid, :ind => "A01")
+      end
+    end
+  end
+  
+  context "A new instance with missing attributes" do
+    should "raise a 'DeepThroat::NoCIDError' when not given a :cid" do
+      assert_raise DeepThroat::NoCIDError do
+        DeepThroat::Industry.find(:cycle => @cycle, :ind => "A01")
+      end
+    end
+
+    should "raise 'DeepThroat::InvalidOrMissing::IndustryCodeError' when not given a :ind" do
+      assert_raise DeepThroat::InvalidOrMissing::IndustryCodeError do
+        DeepThroat::Industry.find(:cid => @cid, :cycle => @cycle)
+      end
+    end
+
+  end
+  
+  context "Obtaining the XML" do
+    setup { @xml_response = DeepThroat::Industry.get_xml(:cid => @cid, :cycle => @cycle, :method => "CandIndByInd", :ind => "A01") }
+  
+    should "return an XML feed" do
+      assert_equal @test_xml, @xml_response
+    end
+  end
+  
+  context "Parsing the XML" do
+    setup { @industry = DeepThroat::Industry.parse(@test_xml)[0] }
+  
+    should "the return a 'DeepThroat::Industry::Details' object" do
+      assert_kind_of DeepThroat::Industry, @industry
+    end
+    
+    should "assign :name" do
+      assert_equal @name, @industry.name
+      assert_kind_of String, @industry.name
+    end
+    
+    should "assign :origin" do
+      assert_equal @origin, @industry.origin
+      assert_kind_of String, @industry.origin
+    end
+    
+    should "assign :source" do
+      assert_equal @source, @industry.source
+      assert_kind_of String, @industry.source
+    end
+
+    should "assign :industry" do
+      assert_equal @industry_name, @industry.industry
+      assert_kind_of String, @industry.industry
+    end
+
+    should "assign :chamber" do
+      assert_equal @chamber, @industry.chamber
+      assert_kind_of String, @industry.chamber
+    end
+
+    should "assign :party" do
+      assert_equal @party, @industry.party
+      assert_kind_of String, @industry.party
+    end
+
+    should "assign :state" do
+      assert_equal @state, @industry.state
+      assert_kind_of String, @industry.state
+    end
+
+    should "assign :total" do
+      assert_equal @total, @industry.total
+      assert_kind_of Integer, @industry.total
+    end
+
+    should "assign :indivs" do
+      assert_equal @indivs, @industry.indivs
+      assert_kind_of Integer, @industry.indivs
+    end
+
+    should "assign :pacs" do
+      assert_equal @pacs, @industry.pacs
+      assert_kind_of Integer, @industry.pacs
+    end
+
+    should "assign :rank" do
+      assert_equal @rank, @industry.rank
+      assert_kind_of Integer, @industry.rank
+    end
+  end
+  
+  context "Sad Paths" do
+    setup do
+      # invalid ApiKey
+      web_faker(:industry_bad_api_key, :cid => @cid, :cycle => @cycle, :apikey => "badApiKey", :ind => "A01")
+      # blank ApiKey
+      web_faker(:industry_bad_api_key, :cid => @cid, :cycle => @cycle, :apikey => "", :ind => "A01")
+      # no ApiKey
+      web_faker(:industry_bad_api_key, :cid => @cid, :cycle => @cycle, :ind => "A01")
+            
+      # invalid CID
+      web_faker(:industry_bad_cid, :cid => "badCID", :cycle => @cycle, :apikey => @api_key, :ind => "A01")
+      
+      # no Industry Code
+      # Not certain how to handle yet
+      # web_faker(:industry_bad_indcode, :cid => @cid, :cycle => @cycle, :apikey => DeepThroat.api_key)
+    end
+    
+    context "ApiKey" do
+      should "raise 'DeepThroat::InvalidOrMissing::ApiKeyError' when given a bad ApiKey" do
+        DeepThroat.api_key = "badApiKey"
+        assert_raise DeepThroat::InvalidOrMissing::ApiKeyError do
+          DeepThroat::Industry.find(:cid => @cid, :cycle => @cycle, :ind => "A01")
+        end
+      end
+      
+      should "raise 'DeepThroat::InvalidOrMissing::ApiKeyError' when given a blank ApiKey" do
+        DeepThroat.api_key = ""
+        assert_raise DeepThroat::InvalidOrMissing::ApiKeyError do
+          DeepThroat::Industry.find(:cid => @cid, :cycle => @cycle, :ind => "A01")
+        end
+      end
+  
+      should "raise 'DeepThroat::InvalidOrMissing::ApiKeyError' when given no ApiKey" do
+        DeepThroat.api_key = nil
+        assert_raise DeepThroat::InvalidOrMissing::ApiKeyError do
+          DeepThroat::Industry.find(:cid => @cid, :cycle => @cycle, :ind => "A01")
+        end
+      end
+    end
+  
+    context "CID" do
+      should "raise 'DeepThroat::InvalidOrMissing::CIDError' when given a bad CID" do
+        @bad_cid = "badCID"
+        assert_raise DeepThroat::InvalidOrMissing::CIDError do
+          DeepThroat::Industry.find(:cid => @bad_cid, :cycle => @cycle, :ind => "A01")
+        end
+      end      
+    end
+  
+    context "Cycle" do
+      should "raise 'DeepThroat::InvalidOrMissing::CycleError' when given a bad Cycle" do
+        @bad_cycle = 2000
+        assert_raise DeepThroat::InvalidOrMissing::CycleError do
+          DeepThroat::Industry.find(:cid => @cid, :cycle => @bad_cycle, :ind => "A01")
+        end
+      end
+    end
+  end
+  
+  context "CONSTANTS" do
+    should "have CYCLES defined as an Array" do
+      assert_kind_of Array, DeepThroat::Industry::CYCLES
+    end
+    
+    context "CYCLES" do
+      should "include the year 2006" do
+        assert DeepThroat::Industry::CYCLES.include?(2006)
+      end
+      
+      should "include the year 2008" do
+        assert DeepThroat::Industry::CYCLES.include?(2008)
+      end
+    end
+  end
+  
+  
+  private
+  
+  def shared_attributes
+    @cid           = "N00000019"
+    @cycle         = 2008
+    @api_key       = DeepThroat.api_key
+  
+    @test_xml      = industry_xml.match(/<response>.*/)[0]
+
+    @name          = "Clinton, Hillary"
+    @origin        = "Center for Responsive Politics"
+    @source        = "http://www.opensecrets.org/industries/recips.php?Ind=A01&cycle=2008&recipdetail=S&Mem=Y&sortorder=U"
+    
+    @industry_name = "Crop Production                                   "
+    @chamber       = "S"
+    @party         = "D"
+    @state         = "New York            "
+    @total         = 218291
+    @indivs        = 211491
+    @pacs          = 6800
+    @rank          = 4
+  end
+end