transparency_data 0.0.1

data/README.md

@@ -0,0 +1,71 @@
+# TransparencyData.com Ruby Wrapper
+
+By Wynn Netherland, Jeremy Hinegardner, and Luigi Montanez
+
+Before using this library, please read the official [TransparencyData.com API documentation](http://transparencydata.com/api/). Query parameters and return formats are described there.
+
+## Setup
+
+Get an API key from [Sunlight Labs](http://services.sunlightlabs.com/).
+
+Required gems:
+
+* monster_mash
+* hashie
+
+After a `gem install transparency_data`, you can do:
+
+    require 'transparency_data'
+    TransparencyData.api_key = 'YOUR_KEY_HERE'
+      
+Within a Rails app, create a `config/initializers/transparency_data.rb` and stick this in:
+
+    TransparencyData.configure do |config|
+     config.api_key = 'YOUR_KEY_HERE'
+    end
+
+## Usage
+
+See the official [API docs](http://transparencydata.com/api/) for all parameters you can send in, and the [schema docs](http://transparencydata.com/docs/) for what you get back:
+
+    contributions = TransparencyData::Client.contributions(:contributor_ft => 'steve jobs')
+    contributions.each do |contribution|
+      puts "Amount: #{contribution.amount}"
+      puts "Date: #{contribution.date}"
+    end
+    
+    lobbyings = TransparencyData::Client.lobbying(:client_ft => "apple inc")
+    lobbyings.each do |lobbying|
+      puts "Amount: #{lobbying.amount}"
+      puts "Year: #{lobbying.year}"
+    end
+
+As described in the API docs, the TransparencyData.com API supports a special syntax as the parameter value for specifying ranges and sets on amount, cycle, year, and date. You can either pass in strings, or use a more Rubyish approach:
+
+    # contributions with an amount greater than or equal to $1000
+    TransparencyData::Client.contributions(:contributor_ft => 'steve jobs', :amount => {:gte => 1000})
+
+    # contributions with an amount less than or equal to $500
+    TransparencyData::Client.contributions(:contributor_ft => 'bill gates', :amount => {:lte => 500})
+    
+    # contributions in the 2006 or 2008 cycle
+    TransparencyData::Client.contributions(:contributor_ft => 'eric schmidt', :cycle => [2006,2008]})
+
+    # contributions to Obama made between in Q1 2008
+    TransparencyData::Client.contributions(:recipient_ft => 'barack obama',
+                                           :date => {:between => ['2008-01-01','2008-03-31']})
+                                           
+## Contributing
+
+Required gems for running tests:
+
+* mg
+* shoulda
+* jnunemaker-matchy
+* mocha
+* fakeweb
+* vcr
+
+Run the test suite:
+
+    rake test

data/lib/transparency_data.rb

@@ -0,0 +1,52 @@
+require 'hashie'
+require 'json'
+require 'monster_mash'
+
+Hash.send :include, Hashie::HashExtensions
+
+
+
+module TransparencyData
+  
+  VERSION = "0.0.1".freeze
+  
+  # config/initializers/transparency_data.rb (for instance)
+  # 
+  # TransparencyData.configure do |config|
+  #   config.api_key = 'api_key'
+  # end
+  # 
+  def self.configure
+    yield self
+    true
+  end
+  
+  def self.api_url(endpoint, version = self.api_version)
+    "http://transparencydata.com/api/#{version}#{endpoint}.json"
+  end
+
+  # class << self
+  #   attr_accessor :api_key
+  #   attr_accessor :api_version
+  # end
+  
+  def self.api_version
+    @api_version || "1.0"
+  end
+  
+  def self.api_version=(value)
+    @api_version = value
+  end
+  
+  def self.api_key
+    @api_key
+  end
+  
+  def self.api_key=(value)
+    @api_key = value
+  end
+
+  
+end
+
+require 'lib/transparency_data/client'

data/lib/transparency_data/client.rb

@@ -0,0 +1,50 @@
+module TransparencyData
+  class Client < MonsterMash::Base
+    
+    defaults do
+      params :apikey => TransparencyData.api_key
+    end
+    
+    get(:contributions) do |api_params|
+      uri TransparencyData.api_url("/contributions")
+      params TransparencyData::Client.prepare_params(api_params)
+      handler do |response|
+        TransparencyData::Client.handle_response(response)
+      end
+    end
+    
+    get(:lobbying) do |api_params|
+      uri TransparencyData.api_url("/lobbying")
+      params TransparencyData::Client.prepare_params(api_params)
+      handler do |response|
+        TransparencyData::Client.handle_response(response)
+      end
+    end
+    
+    def self.prepare_params(params)
+      params.each do |key, value|
+        if value.is_a?(Hash)
+          
+          case value.keys.first
+          when :gte
+            params[key] = ">|#{value.values.first}"
+          when :lte
+            params[key] = "<|#{value.values.first}"
+          when :between
+            params[key] = "><|#{value.values.first.join('|')}"
+          end
+          
+        elsif value.is_a?(Array)
+          params[key] = value.join("|")
+        end
+      end
+      params
+    end
+    
+    def self.handle_response(response)
+      # TODO: raise_errors
+      JSON.parse(response.body).map {|c| Hashie::Mash.new(c)}
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification 
+name: transparency_data
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Wynn Netherland
+- Jeremy Hinegardner
+- Luigi Montanez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-06 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: monster_mash
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 10
+        - 1
+        version: 2.10.1
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: jnunemaker-matchy
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 5
+        version: 1.2.5
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: vcr
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 1
+        version: 0.4.1
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: mg
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 8
+        version: 0.0.8
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  version_requirements: *id010
+description: Wrapper for the Sunlight Transparency data API
+email: 
+- wynn.netherland@gmail.com
+- jeremy@hinegardner.org
+- luigi.montanez@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- lib/transparency_data.rb
+- lib/transparency_data/client.rb
+has_rdoc: false
+homepage: http://github.com/pengwynn/transparency_data
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Wrapper for the Sunlight Transparency data API
+test_files: []
+