sunlightlabs-tcorps 0.1.1

data/LICENSE

@@ -0,0 +1,10 @@
+Copyright © 2009, Sunlight Foundation
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+    * Neither the name of Sunlight Foundation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,29 @@
+## Introduction
+
+This is a wrapper for the [TransparencyCorps](http://transparencycorps.org) API.  TransparencyCorps is a microtask directory that integrates with external applications to encourage and reward volunteer activity.
+
+You would use this in your TransparencyCorps campaign application to notify TransparencyCorps when a user has completed a task, and they should receive points for their effort.
+
+## Usage
+
+Your campaign will receive a unique task key for each user when they land on your page from TransparencyCorps.  You should hold this key until the task is completed, perhaps in hidden input fields on your forms, or in whatever session store your application might use.
+
+To complete a task and nothing more:
+
+    TransparencyCorps.complete_task "the_actual_task_key"
+    # => #<Net::HTTPOK 200 OK readbody=true>
+
+Your application may want to seamlessly direct users to a new task once they've completed one.  TransparencyCorps can generate a new task for you at the same time as you mark the current task complete, and will return the URL for the app to redirect itself to as the response body.  You can do this with this wrapper by:
+
+    TransparencyCorps.complete_task_and_reassign "the_actual_task_key"
+    # => "http://yoursite.com/yourcampaign?task_key=new_task_key&username=testuser&points=500
+    
+    # or you can get the response body and pull the URL yourself:
+    response = TransparencyCorps.complete_task "the_actual_task_key", true
+    response.body
+    # => "http://yoursite.com/yourcampaign?task_key=new_task_key&username=testuser&points=500
+    
+
+By default, the wrapper directs requests to http://transparencycorps.org.  If you want to use a different URL, (for testing in a local or staging environment, for instance), assign it a different one.
+
+    TransparencyCorps.url = "http://localhost:3000"

data/lib/tcorps.rb

@@ -0,0 +1 @@
+require 'transparency_corps'

data/lib/transparency_corps.rb

@@ -0,0 +1,33 @@
+require 'open-uri'
+require 'net/http'
+
+class TransparencyCorps
+
+  @@url = 'http://transparencycorps.org'
+  COMPLETE_PATH = '/tasks/complete'
+  NEW_TASK_PARAMS = {:new_task => 1}
+  
+  def self.url=(url)
+    @@url = url
+  end
+  
+  def self.url
+    @@url
+  end
+  
+  def self.complete_task_and_reassign(task_key)
+    response = complete_task task_key, true
+    if response.body and response.body.strip.any?
+      response.body
+    else
+      response
+    end
+  end
+  
+  def self.complete_task(task_key, reassign = false)
+    params = {:task_key => task_key}
+    params.merge! NEW_TASK_PARAMS if reassign
+    Net::HTTP.post_form URI.join(url, COMPLETE_PATH), params
+  end
+
+end

data/ruby-tcorps.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name = "tcorps"
+  s.version = "0.1.1"
+  s.date = "2009-08-05"
+  s.summary = "Library for communicating with the TransparencyCorps API."
+  s.description = "Library for communicating with the TransparencyCorps API."
+  s.email = "eric@sunlightfoundation.com"
+  s.homepage = "http://github.com/sunlightlabs/ruby-tcorps/"
+  s.authors = ["Eric Mill"]
+  s.files = ['ruby-tcorps.gemspec', 'lib/tcorps.rb', 'lib/transparency_corps.rb',
+             'README.md', 'LICENSE']
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: sunlightlabs-tcorps
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Eric Mill
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-05 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Library for communicating with the TransparencyCorps API.
+email: eric@sunlightfoundation.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- ruby-tcorps.gemspec
+- lib/tcorps.rb
+- lib/transparency_corps.rb
+- README.md
+- LICENSE
+has_rdoc: false
+homepage: http://github.com/sunlightlabs/ruby-tcorps/
+licenses: 
+post_install_message: 
+rdoc_options: []
+
+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.3.5
+signing_key: 
+specification_version: 2
+summary: Library for communicating with the TransparencyCorps API.
+test_files: []
+