opensecrets 0.0.4 → 0.0.5

data/README.rdoc

@@ -20,12 +20,20 @@ like to contribute please see : http://sunlightlabs.com/projects/opensecrets-rub
     require 'crack'
     require 'pp'
 
+    # Note, you can also provide your API key in an environment variable for security and convenience.
+    #   export OPENSECRETS_API_KEY=YOUR_API_KEY
+    # If you provide your key this way you do not have to provide a key in the OpenSecrets::*.new constructors.
+    # A key provided to the constructor overrides any environment variable that is set.
+
     member = OpenSecrets::Member.new('YOUR OPEN SECRETS API KEY')
     pp member.pfd({:cid => 'N00007360', :year => '2008'})["response"]
 
     cand = OpenSecrets::Candidate.new('YOUR OPEN SECRETS API KEY')
     pp cand.summary({:cid => 'N00007360'})["response"]
 
+    com = OpenSecrets::Committee.new('YOUR OPEN SECRETS API KEY')
+    pp com.by_industry({:cmte => 'HARM', :congno => '110', :indus => 'F10'})["response"]
+
 
 == Project Websites
 

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/examples/example.rb

@@ -7,12 +7,15 @@ require 'crack'
 require 'pp'
 
 
-# For convenience and security you can export an environment variable to hold your API key.
-API_KEY = ENV['OPENSECRETS_API_KEY'] ||= 'YOUR_API_KEY'
+########
+# NOTE : You should 'export OPENSECRETS_API_KEY=YOUR_API_KEY' before running this script.
+########
+
+
 CID = 'N00007360' # Nancy Pelosi
 
 
-member = OpenSecrets::Member.new(API_KEY)
+member = OpenSecrets::Member.new
 
 puts "\n\nMEMBER : PFD PROFILE\n\n"
 pp member.pfd({:cid => CID, :year => '2008'})["response"]
@@ -21,7 +24,7 @@ puts "\n\nMEMBER : TRAVEL & TRIPS\n\n"
 pp member.trips({:cid => CID, :year => '2008'})["response"]
 
 
-cand = OpenSecrets::Candidate.new(API_KEY)
+cand = OpenSecrets::Candidate.new
 
 puts "\n\nCANDIDATE : SUMMARY\n\n"
 pp cand.summary({:cid => CID})["response"]
@@ -39,7 +42,7 @@ puts "\n\nCANDIDATE : SECTOR\n\n"
 pp cand.sector({:cid => CID})["response"]
 
 
-com = OpenSecrets::Committee.new(API_KEY)
+com = OpenSecrets::Committee.new
 
 puts "\n\nCOMMITTEE\n\n"
 pp com.by_industry({:cmte => 'HARM', :congno => '110', :indus => 'F10'})["response"]

data/lib/opensecrets.rb

@@ -2,21 +2,30 @@ require 'httparty'
 
 module OpenSecrets
 
-  class Member
+  class Base
+
     include HTTParty
     base_uri 'http://www.opensecrets.org/api'
     default_params :output => 'xml'
     format :xml
 
-    # OpenSecrets information about a Member of Congress.
+    # OpenSecrets Base constructor.  All OpenSecrets API classes inherit from this one which provides
+    # the common initialization function.  For convenience you can skip providing an 'apikey' to the
+    # constructor if you instead export a OPENSECRETS_API_KEY environment variable which is set to the
+    # value of your API key.
     #
-    # @option options [String] apikey ("") an OpenSecrets API Key
+    # @option options [String] apikey (nil) an OpenSecrets API Key, this can also be provided in an OPENSECRETS_API_KEY shell environment variable for security and convenience.
     #
-    def initialize(apikey)
-      raise ArgumentError, 'You must provide an API Key' if apikey.blank?
-      self.class.default_params :apikey => apikey
+    def initialize(apikey = nil)
+      key =  apikey ||= ENV['OPENSECRETS_API_KEY']
+      raise ArgumentError, 'You must provide an API Key' if key.blank?
+      self.class.default_params :apikey => key
     end
 
+  end
+
+  class Member < OpenSecrets::Base
+
     # Returns Personal Financial Disclosure (PFD) information for a member of Congress.
     #
     # See : http://www.opensecrets.org/api/?method=memPFDprofile&output=doc
@@ -47,20 +56,7 @@ module OpenSecrets
 
   end # member
 
-  class Candidate
-    include HTTParty
-    base_uri 'http://www.opensecrets.org/api'
-    default_params :output => 'xml'
-    format :xml
-
-    # OpenSecrets information about a Candidate.
-    #
-    # @option options [String] apikey ("") an OpenSecrets API Key
-    #
-    def initialize(apikey)
-      raise ArgumentError, 'You must provide an API Key' if apikey.blank?
-      self.class.default_params :apikey => apikey
-    end
+  class Candidate < OpenSecrets::Base
 
     # Provides summary fundraising information for specified politician.
     #
@@ -131,20 +127,7 @@ module OpenSecrets
 
   end # candidate
 
-  class Committee
-    include HTTParty
-    base_uri 'http://www.opensecrets.org/api'
-    default_params :output => 'xml'
-    format :xml
-
-    # OpenSecrets information about a specific committee.
-    #
-    # @option options [String] apikey ("") an OpenSecrets API Key
-    #
-    def initialize(apikey)
-      raise ArgumentError, 'You must provide an API Key' if apikey.blank?
-      self.class.default_params :apikey => apikey
-    end
+  class Committee < OpenSecrets::Base
 
     # Provides summary fundraising information for a specific committee, industry and Congress number.
     #

data/opensecrets.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{opensecrets}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Glenn Rempe"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: opensecrets
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Glenn Rempe