muck-oauth 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,31 @@
+**/*.pid
+log/*.log
+log/*.pid
+tmp
+.DS_Store
+public/cache/**/*
+public/system/**/*
+doc/**/*
+db/*.sqlite3
+.project
+.loadpath
+nbproject/
+.idea
+testjour.log
+*.so
+*.o
+Makefile
+mkmf.log
+*.bundle
+conftest
+content/
+.idea
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+pkg/*
+log/*
+global_config.yml
+test/rails_root/config/initializers/oauth_consumers.rb

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tatemae.com
+
+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,30 @@
+= muck-oauth
+This gem wraps oauth and oauth-plugin to make it simple to get tokens for services that muck can interact with various services.
+
+For more documentation see:
+http://github.com/pelle/oauth-plugin
+http://stakeventures.com/articles/2009/07/21/consuming-oauth-intelligently-in-rails
+http://stakeventures.com/articles/2008/02/23/developing-oauth-clients-in-ruby
+
+== Installation
+Add the following to environment.rb
+  config.gem "oauth"
+  config.gem "oauth-plugin"
+  config.gem "muck-oauth"
+
+Add the following to your user model:
+  has_many :client_applications
+  has_many :tokens, :class_name => "OauthToken", :order => "authorized_at desc", :include => [:client_application]
+
+  has_one  :twitter_token, :class_name => "TwitterToken", :dependent => :destroy
+  
+== Usage
+Add configuration for services to:
+  intializers/oauth_consumers.rb
+
+Link to each service like this:
+  <a href="/oauth_consumers/twitter">Twitter</a>
+  <a href="/oauth_consumers/google">Google</a>
+  
+
+Copyright (c) 2009 Tatemae.com. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,70 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+task :test => :check_dependencies
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "muck-oauth"
+    gem.summary = %Q{OAuth for muck}
+    gem.description = %Q{A simple wrapper for the oauth and oauth-plugin gems so that it is faster to include oauth in muck based applications.}
+    gem.email = "justin@tatemae.com"
+    gem.homepage = "http://github.com/tatemae/muck-oauth"
+    gem.authors = ["Justin Ball"]
+    gem.add_development_dependency "shoulda"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test/rails_root/test'
+  t.pattern = 'test/rails_root/test/**/*_test.rb'
+  t.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    #t.libs << 'lib'
+    t.libs << 'test/rails_root/lib'
+    t.pattern = 'test/rails_root/test/**/*_test.rb'
+    t.verbose = true
+    t.output_dir = 'coverage'
+    t.rcov_opts << '--exclude "gems/*"'
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+require 'rake/rdoctask'
+desc 'Generate documentation for the muck-oauth gem.'
+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 = "muck_oauth #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Translate this gem'
+task :translate do
+  file = File.join(File.dirname(__FILE__), 'locales', 'en.yml')
+  system("babelphish -o -y #{file}")
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/controllers/oauth_clients_controller.rb

@@ -0,0 +1,52 @@
+class OauthClientsController < ApplicationController
+  before_filter :login_required
+  before_filter :get_client_application, :only => [:show, :edit, :update, :destroy]
+  
+  def index
+    @client_applications = current_user.client_applications
+    @tokens = current_user.tokens.find :all, :conditions => 'oauth_tokens.invalidated_at is null and oauth_tokens.authorized_at is not null'
+  end
+
+  def new
+    @client_application = ClientApplication.new
+  end
+
+  def create
+    @client_application = current_user.client_applications.build(params[:client_application])
+    if @client_application.save
+      flash[:notice] = t('muck.oauth.registered_successfully')
+      redirect_to :action => "show", :id => @client_application.id
+    else
+      render :action => "new"
+    end
+  end
+  
+  def show
+  end
+
+  def edit
+  end
+  
+  def update
+    if @client_application.update_attributes(params[:client_application])
+      flash[:notice] = t('muck.oauth.updated_successfully')
+      redirect_to :action => "show", :id => @client_application.id
+    else
+      render :action => "edit"
+    end
+  end
+
+  def destroy
+    @client_application.destroy
+    flash[:notice] = t('muck.oauth.destroyed_successfully')
+    redirect_to :action => "index"
+  end
+  
+  private
+  def get_client_application
+    unless @client_application = current_user.client_applications.find(params[:id])
+      flash.now[:error] = t('muck.oauth.wrong_id')
+      raise ActiveRecord::RecordNotFound
+    end
+  end
+end

data/app/controllers/oauth_consumers_controller.rb

@@ -0,0 +1,19 @@
+require 'oauth/controllers/consumer_controller'
+class OauthConsumersController < ApplicationController
+  include Oauth::Controllers::ConsumerController
+  
+  def index
+    @consumer_tokens = ConsumerToken.all :conditions=>{:user_id => current_user.id}
+    @services = OAUTH_CREDENTIALS.keys-@consumer_tokens.collect{|c| c.class.service_name}
+  end
+  
+  protected
+  
+  # Change this to decide where you want to redirect user to after callback is finished.
+  # params[:id] holds the service name so you could use this to redirect to various parts
+  # of your application depending on what service you're connecting to.
+  def go_back
+    redirect_to root_url
+  end
+  
+end

data/app/controllers/oauth_controller.rb

@@ -0,0 +1,11 @@
+require 'oauth/controllers/provider_controller'
+class OauthController < ApplicationController
+  include OAuth::Controllers::ProviderController
+  
+  # Override this to match your authorization page form
+  # It currently expects a checkbox called authorize
+  # def user_authorizes_token?
+  #   params[:authorize] == '1'
+  # end
+  
+end

data/app/models/access_token.rb

@@ -0,0 +1,16 @@
+class AccessToken < OauthToken
+  validates_presence_of :user
+  before_create :set_authorized_at
+  
+  # Implement this to return a hash or array of the capabilities the access token has
+  # This is particularly useful if you have implemented user defined permissions.
+  # def capabilities
+  #   {:invalidate=>"/oauth/invalidate",:capabilities=>"/oauth/capabilities"}
+  # end
+  
+  protected 
+  
+  def set_authorized_at
+    self.authorized_at = Time.now
+  end
+end

data/app/models/client_application.rb

@@ -0,0 +1,55 @@
+require 'oauth'
+class ClientApplication < ActiveRecord::Base
+  belongs_to :user
+  has_many :tokens, :class_name => "OauthToken"
+  validates_presence_of :name, :url, :key, :secret
+  validates_uniqueness_of :key
+  before_validation_on_create :generate_keys
+
+  validates_format_of :url, :with => /\Ahttp(s?):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-\/]))?/i
+  validates_format_of :support_url, :with => /\Ahttp(s?):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-\/]))?/i, :allow_blank=>true
+  validates_format_of :callback_url, :with => /\Ahttp(s?):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-\/]))?/i, :allow_blank=>true
+
+  attr_accessor :token_callback_url
+  
+  def self.find_token(token_key)
+    token = OauthToken.find_by_token(token_key, :include => :client_application)
+    if token && token.authorized?
+      token
+    else
+      nil
+    end
+  end
+  
+  def self.verify_request(request, options = {}, &block)
+    begin
+      signature = OAuth::Signature.build(request, options, &block)
+      return false unless OauthNonce.remember(signature.request.nonce, signature.request.timestamp)
+      value = signature.verify
+      value
+    rescue OAuth::Signature::UnknownSignatureMethod => e
+      logger.info "ERROR"+e.to_s
+      false
+    end
+  end
+  
+  def oauth_server
+    @oauth_server ||= OAuth::Server.new("http://your.site")
+  end
+  
+  def credentials
+    @oauth_client ||= OAuth::Consumer.new(key, secret)
+  end
+    
+  def create_request_token
+    RequestToken.create :client_application => self,:callback_url=>self.token_callback_url
+  end
+  
+protected
+  
+  def generate_keys
+    oauth_client = oauth_server.generate_consumer_credentials
+    self.key = oauth_client.key[0,20]
+    self.secret = oauth_client.secret[0,40]
+  end
+end

data/app/models/consumer_token.rb

@@ -0,0 +1,5 @@
+require 'oauth/models/consumers/token'
+class ConsumerToken < ActiveRecord::Base
+  include Oauth::Models::Consumers::Token
+  
+end

data/app/models/oauth_nonce.rb

@@ -0,0 +1,13 @@
+# Simple store of nonces. The OAuth Spec requires that any given pair of nonce and timestamps are unique.
+# Thus you can use the same nonce with a different timestamp and viceversa.
+class OauthNonce < ActiveRecord::Base
+  validates_presence_of :nonce, :timestamp
+  validates_uniqueness_of :nonce, :scope => :timestamp
+  
+  # Remembers a nonce and it's associated timestamp. It returns false if it has already been used
+  def self.remember(nonce, timestamp)
+    oauth_nonce = OauthNonce.create(:nonce => nonce, :timestamp => timestamp)
+    return false if oauth_nonce.new_record?
+    oauth_nonce
+  end
+end

data/app/models/oauth_token.rb

@@ -0,0 +1,31 @@
+class OauthToken < ActiveRecord::Base
+  belongs_to :client_application
+  belongs_to :user
+  validates_uniqueness_of :token
+  validates_presence_of :client_application, :token, :secret
+  before_validation_on_create :generate_keys
+  
+  def invalidated?
+    invalidated_at != nil
+  end
+  
+  def invalidate!
+    update_attribute(:invalidated_at, Time.now)
+  end
+  
+  def authorized?
+    authorized_at != nil && !invalidated?
+  end
+    
+  def to_query
+    "oauth_token=#{token}&oauth_token_secret=#{secret}"
+  end
+    
+  protected
+  
+  def generate_keys
+    oauth_token = client_application.oauth_server.generate_credentials
+    self.token = oauth_token[0][0,20]
+    self.secret = oauth_token[1][0,40]
+  end
+end

data/app/models/request_token.rb

@@ -0,0 +1,40 @@
+class RequestToken < OauthToken
+  
+  attr_accessor :provided_oauth_verifier
+  
+  def authorize!(user)
+    return false if authorized?
+    self.user = user
+    self.authorized_at = Time.now
+    self.verifier=OAuth::Helper.generate_key(16)[0,20] unless oauth10?
+    self.save
+  end
+  
+  def exchange!
+    return false unless authorized?
+    return false unless oauth10? || verifier==provided_oauth_verifier
+    
+    RequestToken.transaction do
+      access_token = AccessToken.create(:user => user, :client_application => client_application)
+      invalidate!
+      access_token
+    end
+  end
+  
+  def to_query
+    if oauth10?
+      super
+    else
+      "#{super}&oauth_callback_confirmed=true"
+    end
+  end
+  
+  def oob?
+    self.callback_url=='oob'
+  end
+  
+  def oauth10?
+    (defined? OAUTH_10_SUPPORT) && OAUTH_10_SUPPORT && self.callback_url.blank?
+  end
+
+end

data/app/views/oauth/authorize.html.erb

@@ -0,0 +1,14 @@
+<h1>Authorize access to your account</h1>
+<p>Would you like to authorize <%= link_to @token.client_application.name,@token.client_application.url %> (<%= link_to @token.client_application.url,@token.client_application.url %>) to access your account?</p>
+<% form_tag authorize_url do %>
+  <%= hidden_field_tag "oauth_token", @token.token %>
+  <%- if params[:oauth_callback] -%>
+  <%= hidden_field_tag "oauth_callback", params[:oauth_callback] %>
+<%- end -%>
+<p>
+  <%= check_box_tag 'authorize' %> authorize access
+</p>
+<p>
+  <%= submit_tag %>
+</p>
+<% end %>

data/app/views/oauth/authorize_failure.html.erb

@@ -0,0 +1 @@
+<h1>You have disallowed this request</h1>

data/app/views/oauth/authorize_success.html.erb

@@ -0,0 +1 @@
+<h1>You have allowed this request</h1>

data/app/views/oauth_clients/_form.html.erb

@@ -0,0 +1,17 @@
+<%= error_messages_for :client_application %>
+<div class="field">
+  <label for="client_application_name">Name*</label><br/>
+  <%= f.text_field :name %>
+</div>
+<div class="field">
+  <label for="client_application_url">Main Application URL*</label><br/>
+  <%= f.text_field :url %>
+</div>
+<div class="field">
+  <label for="client_application_callback_url">Callback URL*</label><br/>
+  <%= f.text_field :callback_url %>
+</div>
+<div class="field">
+  <label for="client_application_support_url">Support URL</label><br/>
+  <%= f.text_field :support_url %>
+</div>

data/app/views/oauth_clients/edit.html.erb

@@ -0,0 +1,7 @@
+<h1>Edit your application</h1>
+<% form_for :client_application, @client_application, :url => oauth_client_path(@client_application), :html => {:method => :put}  do |f| %>
+       <%= render :partial => "form", :locals => { :f => f } %>
+       <%= submit_tag "Edit" %>
+<% end %>
+<%= link_to 'Show', oauth_client_path(@client_application) %> |
+<%= link_to 'Back', oauth_clients_path %>

data/app/views/oauth_clients/index.html.erb

@@ -0,0 +1,43 @@
+<div class="flash"><%= flash[:notice] %></div>
+<h1>OAuth Client Applications</h1>
+<% unless @tokens.empty? %>
+<p>The following tokens have been issued to applications in your name</p>
+<table>
+  <tr><th>Application</th><th>Issued</th><th>&nbsp;</th></tr>
+  <% @tokens.each do |token|%>
+    <% content_tag_for :tr, token do %>
+      <td><%= link_to token.client_application.name, token.client_application.url %></td>
+      <td><%= token.authorized_at %></td>
+      <td>
+        <% form_tag :controller => 'oauth', :action => 'revoke' do %>
+        <%= hidden_field_tag 'token', token.token %>
+        <%= submit_tag "Revoke!" %>
+        <% end %>
+      </td>
+    <% end %>
+  <% end %>
+  
+</table>
+<% end %>
+<h3>Application Developers</h3>
+<% if @client_applications.empty? %>
+  <p>
+    Do you have an application you would like to register for use with us using the <a href="http://oauth.net">OAuth</a> standard?
+  </p>
+  <p>
+    You must register your web application before it can make OAuth requests to this service
+  </p>
+<% else %>
+  <p>
+    You have the following client applications registered:
+  </p>
+  <% @client_applications.each do |client|%>
+    <% div_for client do %>
+      <%= link_to client.name, oauth_client_path(client) %>- 
+        <%= link_to 'Edit', edit_oauth_client_path(client) %>
+        <%= link_to 'Delete', oauth_client_path(client), :confirm => "Are you sure?", :method => :delete %>
+    <% end %>
+  <% end %>
+<% end %>
+<br />
+<h3><%= link_to "Register your application", :action => :new %></h3>

data/app/views/oauth_clients/new.html.erb

@@ -0,0 +1,5 @@
+<h1>Register a new application</h1>
+<% form_for :client_application, :url => { :action => :create } do |f| %>
+   <%= render :partial => "form", :locals => { :f => f } %>
+   <%= submit_tag "Register" %>
+<% end %>

data/app/views/oauth_clients/show.html.erb

@@ -0,0 +1,27 @@
+<h1>OAuth details for <%=@client_application.name %></h1>
+<p>
+  <strong>Consumer Key:</strong>
+  <code><%=@client_application.key %></code>
+</p>
+<p>
+  <strong>Consumer Secret:</strong>
+  <code><%=@client_application.secret %></code>
+</p>
+<p>
+  <strong>Request Token URL</strong>
+  <code>http<%='s' if request.ssl? %>://<%= request.host_with_port %><%=@client_application.oauth_server.request_token_path %></code>
+</p>
+<p>
+  <strong>Access Token URL</strong>
+  <code>http<%='s' if request.ssl? %>://<%= request.host_with_port %><%=@client_application.oauth_server.access_token_path %></code>
+</p>
+<p>
+  <strong>Authorize URL</strong>
+  <code>http<%='s' if request.ssl? %>://<%= request.host_with_port %><%=@client_application.oauth_server.authorize_path %></code>
+</p>
+
+<p>
+  We support hmac-sha1 (recommended) as well as plain text in ssl mode.
+</p>
+<%= link_to 'Edit', edit_oauth_client_path(@client_application) %> |
+<%= link_to 'Back', oauth_clients_path %>

data/app/views/oauth_consumers/index.html.erb

@@ -0,0 +1,29 @@
+<h1>Services</h1>
+
+<% if @consumer_tokens.empty? %>
+  <p>
+    You are currently not connected to any external services.
+  </p>
+<% else %>
+  <p>
+    You are connected to the following services:
+  </p>
+  <ul>
+    <% @consumer_tokens.each do |token| %>
+      <li>
+        <%= link_to token.class.service_name.to_s.humanize, oauth_consumer_path(token.class.service_name) %>
+      </li>
+    <% end %>
+  </ul>
+<% end %>
+
+<% unless @services.empty? %>
+<h3>You can connect to the following services:</h3>
+<ul>
+  <% @services.each do |service| %>
+    <li>
+      <%= link_to service.to_s.humanize, oauth_consumer_path(service) %>
+    </li>
+  <% end %>
+</ul>
+<% end %>

data/app/views/oauth_consumers/show.html.erb

@@ -0,0 +1,7 @@
+<h1>You are already Connected to <%=params[:id].humanize%></h1>
+<% form_tag oauth_consumer_path(params[:id]),:method=>:delete do %>
+  <%=submit_tag "Disconnect" %>
+  or
+  <%=submit_tag "Reconnect" %>
+  if you experienced a problem.
+<% end %>

data/config/initializers/oauth_consumers.rb

@@ -0,0 +1,47 @@
+# edit this file to contain credentials for the OAuth services you support.
+# each entry needs a corresponding token model.
+#
+# eg. :twitter => TwitterToken, :hour_feed => HourFeedToken etc.
+#
+# OAUTH_CREDENTIALS={
+#   get it at: http://twitter.com/apps
+#   :twitter=>{
+#     :key=>"",
+#     :secret=>""
+#   },
+#   :google=>{
+#     :key=>"",
+#     :secret=>"",
+#     :scope=>"" # see http://code.google.com/apis/gdata/faq.html#AuthScopes
+#   },
+#   :agree2=>{
+#     :key=>"",
+#     :secret=>""
+#   },
+#   :fireeagle=>{
+#     :key=>"",
+#     :secret=>""
+#   },
+#   :hour_feed=>{
+#     :key=>"",
+#     :secret=>"",
+#     :options=>{ # OAuth::Consumer options
+#       :site=>"http://hourfeed.com" # Remember to add a site for a generic OAuth site
+#     }
+#   },
+#   :nu_bux=>{
+#     :key=>"",
+#     :secret=>"",
+#     :super_class=>"OpenTransactToken",  # if a OAuth service follows a particular standard 
+#                                         # with a token implementation you can set the superclass
+#                                         # to use
+#     :options=>{ # OAuth::Consumer options
+#       :site=>"http://nubux.heroku.com" 
+#     }
+#   }
+# }
+# 
+OAUTH_CREDENTIALS={
+} unless defined? OAUTH_CREDENTIALS
+
+load 'oauth/models/consumers/service_loader.rb'

data/config/muck_oauth_routes.rb

@@ -0,0 +1,9 @@
+ActionController::Routing::Routes.draw do |map|
+  map.resources :oauth_clients
+  map.test_request '/oauth/test_request', :controller => 'oauth', :action => 'test_request'
+  map.access_token '/oauth/access_token', :controller => 'oauth', :action => 'access_token'
+  map.request_token '/oauth/request_token', :controller => 'oauth', :action => 'request_token'
+  map.authorize '/oauth/authorize', :controller => 'oauth', :action => 'authorize'
+  map.oauth '/oauth', :controller => 'oauth', :action => 'index'
+  map.resources :oauth_consumers,:member=>{:callback=>:get}
+end

data/db/migrate/20091205001023_create_oauth_consumer_tokens.rb

@@ -0,0 +1,21 @@
+class CreateOauthConsumerTokens < ActiveRecord::Migration
+  def self.up
+    
+    create_table :consumer_tokens do |t|
+      t.integer :user_id
+      t.string :type, :limit => 30
+      #t.string :token, :limit => 1024 # This has to be huge because of Yahoo's excessively large tokens
+      t.string :token, :limit => 255 # if the field is to long we can't create an index.  Making it smaller
+      t.string :secret
+      t.timestamps
+    end
+    
+    add_index :consumer_tokens, :token, :unique
+    
+  end
+
+  def self.down
+    drop_table :consumer_tokens
+  end
+
+end