oauth-plugin 0.3.5

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the oauth plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the oauth plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Oauth'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "oauth-plugin"
+    gemspec.summary = "Ruby on Rails Plugin for OAuth Provider and Consumer"
+    gemspec.description = "Rails plugin for implementing an OAuth Provider or Consumer"
+    gemspec.email = "oauth-ruby@googlegroups.com"
+    gemspec.homepage = "http://github.com/pelle/oauth-plugin/tree/master"
+    gemspec.authors = ["Pelle Braendgaard"]
+    gemspec.add_dependency('oauth', '>= 0.3.5')
+    gemspec.rubyforge_project = 'oauth'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.5

data/generators/oauth_consumer/USAGE

@@ -0,0 +1,10 @@
+./script/generate oauth_consumer
+
+This creates an OAuth Provider controller as well as requisite models.
+
+It requires an authentication framework such as acts_as_authenticated, restful_authentication or restful_open_id_authentication that provides the methods "login_required" and "current_user".
+
+If you generated the migration file (true by default), make sure you run
+rake db:migrate
+
+See README.rdoc for more.

data/generators/oauth_consumer/oauth_consumer_generator.rb

@@ -0,0 +1,49 @@
+require File.expand_path(File.dirname(__FILE__) + "/../oauth_provider/lib/insert_routes.rb")
+
+class OauthConsumerGenerator < Rails::Generator::Base
+  default_options :skip_migration => false
+
+  def manifest
+    record do |m|
+      
+      # Controller, helper, views, and test directories.
+      m.directory File.join('app/models')
+      m.directory File.join('app/controllers')
+      m.directory File.join('app/helpers')
+      m.directory File.join('app/views', 'oauth_consumers')
+      m.directory File.join('config/initializers')
+      
+      m.template 'oauth_config.rb',File.join('config/initializers', "oauth_consumers.rb")
+      m.template 'consumer_token.rb',File.join('app/models',"consumer_token.rb")
+
+      m.template 'controller.rb',File.join('app/controllers',"oauth_consumers_controller.rb")
+      m.route_entry "map.resources :oauth_consumers,:member=>{:callback=>:get}"
+      
+      @template_extension= options[:haml] ? "haml" : "erb"
+      
+      m.template "show.html.#{@template_extension}",  File.join('app/views', 'oauth_consumers', "show.html.#{@template_extension}")
+      
+      unless options[:skip_migration] 
+        m.migration_template 'migration.rb', 'db/migrate', :assigns => {
+          :migration_name => "CreateOauthConsumerTokens"
+        }, :migration_file_name => "create_oauth_consumer_tokens"
+      end
+    end
+  end
+
+  protected
+    def banner
+      "Usage: #{$0} #{spec.name}"
+    end
+
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--skip-migration", 
+             "Don't generate a migration file") { |v| options[:skip_migration] = v }
+#      opt.on("--test-unit", 
+#             "Generate the Test::Unit compatible tests instead of RSpec") { |v| options[:test_unit] = v }
+      opt.on("--haml", 
+            "Templates use haml") { |v| options[:haml] = v }
+    end
+end

data/generators/oauth_consumer/templates/consumer_token.rb

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

data/generators/oauth_consumer/templates/controller.rb

@@ -0,0 +1,14 @@
+require 'oauth/controllers/consumer_controller'
+class OauthConsumersController < ApplicationController
+  include Oauth::Controllers::ConsumerController
+  
+  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/generators/oauth_consumer/templates/migration.rb

@@ -0,0 +1,20 @@
+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
+      t.string :secret
+      t.timestamps
+    end
+    
+    add_index :consumer_tokens, :token, :unique
+    
+  end
+
+  def self.down
+    drop_table :consumer_tokens
+  end
+
+end

data/generators/oauth_consumer/templates/oauth_config.rb

@@ -0,0 +1,37 @@
+# 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={
+#   :twitter=>{
+#     :key=>"",
+#     :secret=>""
+#   },
+#   :agree2=>{
+#     :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/generators/oauth_consumer/templates/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/generators/oauth_consumer/templates/show.html.haml

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

data/generators/oauth_provider/USAGE

@@ -0,0 +1,20 @@
+./script/generate oauth_provider 
+
+This creates an OAuth Provider controller as well as the requisite models.
+
+It requires an authentication framework such as acts_as_authenticated, restful_authentication or restful_open_id_authentication.
+
+If you generated the migration file (true by default), make sure you run
+
+  rake db:migrate
+
+include the following in your user.rb
+
+  has_many :client_applications
+  has_many :tokens, :class_name=>"OauthToken",:order=>"authorized_at desc",:include=>[:client_application]
+
+For legacy OAUTH 1.0 support add the following constant in your environment.rb
+
+  OAUTH_10_SUPPORT = true
+
+Note, you should only do this if you really positively require to support old OAuth1.0 clients. There is a serious security issue with this.

data/generators/oauth_provider/lib/insert_routes.rb

@@ -0,0 +1,67 @@
+# Stolen from http://github.com/technoweenie/restful-authentication
+
+Rails::Generator::Commands::Create.class_eval do
+  def route_entry(raw)
+    sentinel = 'ActionController::Routing::Routes.draw do |map|'
+ 
+    logger.route raw
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+        "#{match}\n  #{raw}\n"
+      end
+    end
+  end
+
+  def route_resource(*resources)
+    resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+    sentinel = 'ActionController::Routing::Routes.draw do |map|'
+ 
+    logger.route "map.resource #{resource_list}"
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+        "#{match}\n  map.resource #{resource_list}\n"
+      end
+    end
+  end
+  
+  def route_name(name, path, route_options = {})
+    sentinel = 'ActionController::Routing::Routes.draw do |map|'
+    
+    logger.route "map.#{name} '#{path}', :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+        "#{match}\n  map.#{name} '#{path}', :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+      end
+    end
+  end
+end
+ 
+Rails::Generator::Commands::Destroy.class_eval do
+  def route_resource(*resources)
+    resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+    look_for = "\n  map.resource #{resource_list}\n"
+    logger.route "map.resource #{resource_list}"
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{look_for})/mi, ''
+    end
+  end
+  
+  def route_name(name, path, route_options = {})
+    look_for =   "\n  map.#{name} '#{path}', :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+    logger.route "map.#{name} '#{path}',     :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+    unless options[:pretend]
+      gsub_file    'config/routes.rb', /(#{look_for})/mi, ''
+    end
+  end
+end
+ 
+Rails::Generator::Commands::List.class_eval do
+  def route_resource(*resources)
+    resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+    logger.route "map.resource #{resource_list}"
+  end
+  
+  def route_name(name, path, options = {})
+    logger.route "map.#{name} '#{path}', :controller => '{options[:controller]}', :action => '#{options[:action]}'"
+  end
+end

data/generators/oauth_provider/oauth_provider_generator.rb

@@ -0,0 +1,124 @@
+require File.expand_path(File.dirname(__FILE__) + "/lib/insert_routes.rb")
+class OauthProviderGenerator < Rails::Generator::Base
+  default_options :skip_migration => false
+  attr_reader   :class_path,
+                :controller_name,
+                :controller_class_path,
+                :controller_file_path,
+                :controller_class_name,
+                :controller_singular_name,
+                :controller_plural_name
+  alias_method  :controller_file_name,  :controller_singular_name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+
+    @controller_name = args.shift || 'oauth'
+    @controller_singular_name = 'oauth'
+    @controller_plural_name = 'oauth'
+    @controller_file_name = 'oauth'
+    @controller_class_name="Oauth"
+    @class_path=''
+    @controller_class_path=''
+  end
+
+  def manifest
+    record do |m|
+      
+      # Check for class naming collisions.
+      # Check for class naming collisions.
+      m.class_collisions controller_class_path,       "#{controller_class_name}Controller", # Oauth Controller
+                                                      "#{controller_class_name}Helper",
+                                                      "#{controller_class_name}ClientsController",
+                                                      "#{controller_class_name}ClientsHelper"
+      m.class_collisions class_path,                  "ClientApplication","OauthNonce","RequestToken","AccessToken","OauthToken"
+
+      # Controller, model, views, and test directories.
+      m.directory File.join('app/models', class_path)
+      m.directory File.join('app/controllers', controller_class_path)
+      m.directory File.join('app/views', controller_class_path, controller_file_name)
+      m.directory File.join('app/views', controller_class_path, 'oauth_clients')
+
+      m.template 'client_application.rb',File.join('app/models',"client_application.rb")
+      m.template 'oauth_token.rb',    File.join('app/models',"oauth_token.rb")
+      m.template 'request_token.rb',  File.join('app/models',"request_token.rb")
+      m.template 'access_token.rb',   File.join('app/models',"access_token.rb")
+      m.template 'oauth_nonce.rb',    File.join('app/models',"oauth_nonce.rb")
+
+      m.template 'controller.rb',File.join('app/controllers',controller_class_path,"#{controller_file_name}_controller.rb")
+
+      m.template 'clients_controller.rb',File.join('app/controllers',controller_class_path,"#{controller_file_name}_clients_controller.rb")
+      m.route_name 'oauth', '/oauth',:controller=>'oauth',:action=>'index'
+      m.route_name 'authorize', '/oauth/authorize',:controller=>'oauth',:action=>'authorize'
+      m.route_name 'request_token', '/oauth/request_token',:controller=>'oauth',:action=>'request_token'
+      m.route_name 'access_token', '/oauth/access_token',:controller=>'oauth',:action=>'access_token'
+      m.route_name 'test_request', '/oauth/test_request',:controller=>'oauth',:action=>'test_request'
+      m.route_resources "#{controller_file_name}_clients".to_sym
+      
+      if !options[:test_unit]
+        m.directory File.join('spec')
+        m.directory File.join('spec/models')
+        m.directory File.join('spec/fixtures', class_path)
+        m.directory File.join('spec/controllers', controller_class_path)
+        
+        m.template 'client_application_spec.rb',File.join('spec/models',"client_application_spec.rb")
+        m.template 'oauth_token_spec.rb',    File.join('spec/models',"oauth_token_spec.rb")
+        m.template 'oauth_nonce_spec.rb',    File.join('spec/models',"oauth_nonce_spec.rb")
+        m.template 'client_applications.yml',File.join('spec/fixtures',"client_applications.yml")
+        m.template 'oauth_tokens.yml',    File.join('spec/fixtures',"oauth_tokens.yml")
+        m.template 'oauth_nonces.yml',    File.join('spec/fixtures',"oauth_nonces.yml")
+        m.template 'controller_spec_helper.rb', File.join('spec/controllers', controller_class_path,"#{controller_file_name}_controller_spec_helper.rb")
+        m.template 'controller_spec.rb',File.join('spec/controllers',controller_class_path,"#{controller_file_name}_controller_spec.rb")      
+        m.template 'clients_controller_spec.rb',File.join('spec/controllers',controller_class_path,"#{controller_file_name}_clients_controller_spec.rb")
+      else
+        m.directory File.join('test')
+        m.directory File.join('test/unit')
+        m.directory File.join('test/fixtures', class_path)
+        m.directory File.join('test/functional', controller_class_path)
+        m.template 'client_application_test.rb',File.join('test/unit',"client_application_test.rb")
+        m.template 'oauth_token_test.rb',    File.join('test/unit',"oauth_token_test.rb")
+        m.template 'oauth_nonce_test.rb',    File.join('test/unit',"oauth_nonce_test.rb")
+        m.template 'client_applications.yml',File.join('test/fixtures',"client_applications.yml")
+        m.template 'oauth_tokens.yml',    File.join('test/fixtures',"oauth_tokens.yml")
+        m.template 'oauth_nonces.yml',    File.join('test/fixtures',"oauth_nonces.yml")
+        m.template 'controller_test_helper.rb', File.join('test', controller_class_path,"#{controller_file_name}_controller_test_helper.rb")
+        m.template 'controller_test.rb',File.join('test/functional',controller_class_path,"#{controller_file_name}_controller_test.rb")
+        m.template 'clients_controller_test.rb',File.join('test/functional',controller_class_path,"#{controller_file_name}_clients_controller_test.rb")
+      end
+      
+      
+      @template_extension= options[:haml] ? "haml" : "erb"
+      
+      m.template "_form.html.#{@template_extension}",  File.join('app/views', controller_class_path, 'oauth_clients', "_form.html.#{@template_extension}")
+      m.template "new.html.#{@template_extension}",  File.join('app/views', controller_class_path, 'oauth_clients', "new.html.#{@template_extension}")
+      m.template "index.html.#{@template_extension}",  File.join('app/views', controller_class_path, 'oauth_clients', "index.html.#{@template_extension}")
+      m.template "show.html.#{@template_extension}",  File.join('app/views', controller_class_path, 'oauth_clients', "show.html.#{@template_extension}")
+      m.template "edit.html.#{@template_extension}",  File.join('app/views', controller_class_path, 'oauth_clients', "edit.html.#{@template_extension}")
+      m.template "authorize.html.#{@template_extension}",  File.join('app/views', controller_class_path, controller_file_name, "authorize.html.#{@template_extension}")
+      m.template "authorize_success.html.#{@template_extension}",  File.join('app/views', controller_class_path, controller_file_name, "authorize_success.html.#{@template_extension}")
+      m.template "authorize_failure.html.#{@template_extension}",  File.join('app/views', controller_class_path, controller_file_name, "authorize_failure.html.#{@template_extension}")
+      
+      unless options[:skip_migration]
+        m.migration_template 'migration.rb', 'db/migrate', :assigns => {
+          :migration_name => "CreateOauthTables"
+        }, :migration_file_name => "create_oauth_tables"
+      end
+    end
+  end
+
+  protected
+    def banner
+      "Usage: #{$0} #{spec.name}"
+    end
+
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--skip-migration", 
+             "Don't generate a migration file") { |v| options[:skip_migration] = v }
+      opt.on("--test-unit", 
+             "Generate the Test::Unit compatible tests instead of RSpec") { |v| options[:test_unit] = v }
+      opt.on("--haml", 
+            "Templates use haml") { |v| options[:haml] = v }
+    end
+end

data/generators/oauth_provider/templates/_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/generators/oauth_provider/templates/_form.html.haml

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