wschenk-ws_api 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,7 @@
+*.sw?
+.DS_Store
+coverage
+pkg
+example/tmp
+example/log/*
+example/db/*.sqlite3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Workstreamer, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,16 @@
+= ws_api
+
+This gem provides a ruby wrapper to interface with workstreamer.com.  It 
+depends on the "nokogiri" and "oauth" gems.  Also included is an example
+rails application which has an example of how to use the gem.
+
+Documentation on how to use the API can be found http://workstreamer.pbworks.com/
+
+To use the rails application, you need to first get a ClientApplication key from
+workstreamer as documented here: http://workstreamer.pbworks.com/Authentication
+
+Then edit example/config/app_config.yml
+
+== Copyright
+
+Copyright (c) 2009 Workstreamer, LLC. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ws_api"
+    gem.summary = %Q{TODO}
+    gem.email = "wschenk@gmail.com"
+    gem.homepage = "http://github.com/wschenk/ws_api"
+    gem.authors = ["Will Schenk"]
+    gem.rubyforge_project = "ws_api"
+    gem.add_dependency 'oauth'
+    gem.add_dependency 'nokogiri'
+    # gem.add_dependency 'httparty'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+  Jeweler::RubyforgeTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ws_api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/example/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

data/example/app/controllers/application.rb

@@ -0,0 +1,15 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+
+  # See ActionController::RequestForgeryProtection for details
+  # Uncomment the :secret if you're not using the cookie session store
+  protect_from_forgery # :secret => 'ccc9497e74859d264d4fc9a3aaa1b817'
+  
+  # See ActionController::Base for details 
+  # Uncomment this to filter the contents of submitted sensitive data parameters
+  # from your application log (in this case, all fields with names like "password"). 
+  # filter_parameter_logging :password
+end

data/example/app/controllers/user_controller.rb

@@ -0,0 +1,12 @@
+class UserController < ApplicationController
+  def create
+    u = User.create
+    session[:user_id] = u.id
+    redirect_to root_url
+  end
+  
+  def switch
+    session[:user_id] = params[:id].to_i
+    redirect_to root_url
+  end
+end

data/example/app/controllers/workstreamer_controller.rb

@@ -0,0 +1,154 @@
+class WorkstreamerController < ApplicationController
+  before_filter :load_user, :except => :index
+  before_filter :require_token, :except => [:index, :callback]
+
+  rescue_from WsApi::Unauthorized, :with => :incorrect_token
+  rescue_from WsApi::Forbidden, :with => :incorrect_token
+  
+  def info
+    @info = workstreamer.user_info
+    
+    if @info && @info['login']
+      @user.update_attribute( "login", @info['login'])
+    end
+  end
+  
+  def status_update
+    create_content "Status update", workstreamer.post_status_update( params[:content] )
+  end
+
+  def direct_message
+    create_content "Direct message", workstreamer.post_direct_message( params[:user_name], params[:message] )
+  end
+  
+  def get_content
+    result = workstreamer.get_content( params[:id] )
+    
+    master_content = result['hash']['master-content']
+    
+    @stream = [master_content]
+    
+    render :action => "stream"
+  end
+  
+  def feed_item
+    create_content "Feed Item", workstreamer.post_feed_item( params )
+  end
+
+  def message
+    create_content "Message", workstreamer.post_message( params[:title], params[:content], { :recipients => params[:recipients], :project => params[:project]} )
+  end
+  
+  def comment
+    create_content "Comment", workstreamer.create_comment( params[:comment], params[:parent_id] )
+  end
+  
+  def create_task
+    create_content "Task", workstreamer.create_task( params[:title], params[:assigned_to], params[:content] )
+  end
+  
+  def lookup_users
+    @info = workstreamer.lookup_users( params[:usernames] )
+    render :action => "info"
+  end
+  
+  def lookup_project
+    @info = workstreamer.lookup_project( params[:project] )
+    render :action => "info"
+  end
+  
+  def stream
+    @stream = workstreamer.stream
+  end
+
+  def callback
+    request_token = OAuth::RequestToken.new(workstreamer.consumer,
+                                            session[:request_token],
+                                            session[:request_token_secret])
+
+    # Exchange the request token for an access token.
+    access_token = request_token.get_access_token
+    
+    @user.update_attributes( :token => access_token.token, :secret => access_token.secret )
+    
+    flash[:notice] = "You have been authorized!"
+    
+    redirect_to :action => "info"
+  end
+
+  protected
+  def load_user
+    begin
+      @user = User.find session[:user_id] if session[:user_id]
+    rescue
+      @user = nil
+    end
+    
+    if @user.nil?
+      flash[:notice] = "You need to have a user first!"
+      redirect_to root_url
+      return false
+    end
+    
+    @user
+  end
+  
+  def require_token
+    # If the user doesn't have a token, then redirect them
+    if @user.token.nil?
+      return incorrect_token
+    end
+    
+    @user
+  end
+  
+  def incorrect_token
+    logger.info( "Called incorrect token" )
+    if @user
+      @user.update_attributes( :token => nil, :secret => nil )
+      @user = nil
+    end
+    
+    @workstreamer = nil
+    
+    request_token = workstreamer.request_token
+    
+    session[:request_token] = request_token.token
+    session[:request_token_secret] = request_token.secret
+
+    redirect_to request_token.authorize_url      
+    return false
+  end    
+
+  def workstreamer
+    @workstreamer ||= WorkstreamerController.create_ws_api( @user )
+  end
+
+  ##
+  # This method was pulled out just so we can call it from script/console
+  def WorkstreamerController.create_ws_api( user = nil )
+    user_token = nil
+    user_secret = nil
+    
+    if user
+      user_token = user.token
+      user_secret = user.secret
+    end
+    
+    WsApi::Workstreamer.new(  APP_CONFIG[:consumer_key],
+                              APP_CONFIG[:consumer_secret], 
+                              APP_CONFIG[:site],
+                              user_token,
+                              user_secret )
+  end
+  
+  def create_content( type, result )
+    if result
+      flash[:notice] = "#{type} was created successfully"
+    else
+      flash[:notice] = "#{type} was NOT created!"
+    end
+    
+    redirect_to "/workstreamer/stream"
+  end
+end

data/example/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/example/app/helpers/user_helper.rb

@@ -0,0 +1,2 @@
+module UserHelper
+end

data/example/app/helpers/workstreamer_helper.rb

@@ -0,0 +1,2 @@
+module WorkstreamerHelper
+end

data/example/app/models/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/example/app/views/layouts/application.rhtml

@@ -0,0 +1,158 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+  "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+  <head>
+    <title>Workstreamer API example application</title>
+  </head>
+  
+  <body>
+    <% if flash[:notice] %>
+    <h1><%= flash[:notice] %></h1>
+    <% end %>
+    <ul>
+    <% User.find( :all ).each do |user| %>
+      <li><%= link_to "Become user ##{user.id}", :controller => "user", :action => "switch", :id => user.id %>
+        <%= user.login %>
+        <%= user.token %>
+        <% if user.id == session[:user_id] %>
+          Active user
+        <% end %>
+      </li>
+    <% end %>
+      <li><%= link_to "Create a new user", :controller => "user", :action => "create" %>
+    </ul>
+    <table border="1">
+  <tr>
+    <td>
+    <%= link_to "User Info", :controller => "workstreamer", :action => "info" %>
+    </td>
+  </tr>
+
+  <tr>
+    <td>
+      <%= link_to "Get user's stream", :controller => "workstreamer", :action => "stream" %>
+    </td>
+  </tr>
+  
+  <tr>
+    <form action="/workstreamer/lookup_users">
+      <td>
+        <input type="text" name="usernames">
+      </td>
+      <td>
+        <input type="submit" value="Lookup Users">
+      </td>
+    </form>
+  </tr>
+
+
+  <tr>
+    <form action="/workstreamer/lookup_project">
+      <td>
+        <input type="text" name="project">
+      </td>
+      <td>
+        <input type="submit" value="Lookup Project Info">
+      </td>
+    </form>
+  </tr>
+
+  <tr>
+    <form action="/workstreamer/get_content">
+      <td>
+        <input type="text" name="id">
+      </td>
+      <td>
+        <input type="submit" value="Get content from id">
+      </td>
+    </form>
+  </tr>
+
+  <hr>  
+
+  <tr>
+    <form action="/workstreamer/status_update">
+      <td>
+        <input type="text" name="content">
+      </td>
+      <td>
+        <input type="submit" value="Post status update">
+      </td>
+    </form>
+  </tr>
+  
+  <tr>
+    <form action="/workstreamer/direct_message">
+      <td>
+        To user<br/>
+        <input type="text" name="user_name"><br/>
+        One liner<br/>
+        <input type="text" name="message">
+      </td>
+      <td>
+        <input type="submit" value="Post direct message">
+      </td>
+    </form>
+  </tr>
+  
+
+  <tr>
+    <form action="/workstreamer/message">
+    <td>
+      Subject (*)<br/>
+      <input type="text" name="title"><br/>
+      Recipient List<br/>
+      <input type="text" name="recipients"><br/>
+      Project<br/>
+      <input type="text" name="project"><br/>
+
+    </td>
+    <td>
+      Message body (*)<br/>
+      <textarea name="content" rows="8"></textarea>
+      <input type="submit" value="Post message">
+    </td>
+    </form>
+  </tr>
+  
+  <tr>
+    <form action="/workstreamer/feed_item">
+      <td>
+        Title (*)<br/>
+        <input type="text" name="title"><br/>
+        URL<br/>
+        <input type="text" name="url"><br/>
+        Created At/Published<br/>
+        <input type="text" name="created_at"><br/>
+        remote_id<br/>
+        <input type="text" name="remote_id"><br/>
+      </td>
+      <td>
+      Extended<br/>
+      <textarea name="content" rows="8"></textarea>
+      <input type="submit" value="Post Feed Item">
+      </td>
+    </form>
+  </tr>
+  
+  <tr>
+    <form action="/workstreamer/create_task">
+      <td>
+        Task Assignee (*)<br/>
+        <input type="text" name="assigned_to"><br/>
+        Task title (*)<br/>
+        <input type="text" name="title"><br/>
+      </td>
+      <td>
+      Extended<br/>
+      <textarea name="content" rows="8"></textarea>
+      <input type="submit" value="Create a task">
+      </td>
+    </form>
+  </tr>
+
+</table>
+<hr/>
+    <%= yield %>
+  </body>
+</html>