oauth_provider_engine 0.0.1

data/README.rdoc

@@ -0,0 +1,64 @@
+= OauthProviderEngine
+
+A Rails Engine that allow the site to act as an OAuth provider
+
+== Installation
+
+In your Gemfile add:
+
+  gem 'oauth_provider_engine'
+
+Install your gems:
+
+  bundle install
+
+That's it!
+
+== Configuration
+
+OauthProviderEngine makes no assumptions about how you manage your
+user authentication.  You can configure OauthProviderEngine by setting
+Proc's that are evaluated at runtime.
+
+For example, in an initializer:
+
+  OauthProviderEngine.configure do |config|
+    # runs as a before_filter to the /oauth/authenticate endpoint to
+    #   ensure the user is logged in before authorizing an app
+    config.authenticate_method = Proc.new{|controller|
+      controller.redirect_to login_path unless controller.logged_in?
+    }
+  
+    # runs as a before_filter to the /oauth/applications resource to
+    #  ensure the user can manage the oauth applications
+    config.admin_authenticate_method = Proc.new{|controller|
+      render :text => '', :status => 401 unless controller.current_user && 
+        controller.current_user.allowed?("manage_oauth")
+    }
+  
+    # returns the current user's id so we know who is allowing access
+    config.user_method = Proc.new{|controller|
+      controller.current_user.id
+    end
+  end
+
+== Data Model
+
+OauthProviderEngine uses ActiveRecord to manage 3 tables:
+
+* applications (OauthProviderEngine::Application)
+* request_tokens (OauthProviderEngine::RequestToken)
+* access_tokens (OauthProviderEngine::AccessToken)
+
+A rails generator is provided for your convenience:
+
+  bundle exec rails generate oauth_provider_engine
+
+You may also generate your migration by hand, if you'd like to take
+advantage of database specific features (like foreign keys for InnoDB
+MySQL tables).
+
+== Contributing
+
+If you'd like to contribute to this project, please fork and send me a pull
+request.

data/lib/generators/oauth_provider_engine/oauth_provider_engine_generator.rb

@@ -0,0 +1,16 @@
+class OauthProviderEngineGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path("../templates", __FILE__)
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.new.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template "migration.rb", "db/migrate/create_oauth_provider_engine_tables.rb"
+  end
+end

data/lib/generators/oauth_provider_engine/templates/migration.rb

@@ -0,0 +1,33 @@
+class CreateOauthProviderEngineTables < ActiveRecord::Migration
+
+  def self.up
+    create_table :applications do |t|
+      t.string :name
+      t.string :url
+      t.string :key
+      t.string :secret
+    end
+
+    create_table :access_tokens do |t|
+      t.integer :application_id
+      t.string :token
+      t.string :secret
+      t.integer :user_id
+      t.datetime :expires_at
+    end
+
+    create_table :request_tokens do |t|
+      t.integer :application_id
+      t.string :token
+      t.string :secret
+      t.integer :user_id
+    end
+  end
+
+  def self.down
+    drop_table :request_tokens
+    drop_table :access_tokens
+    drop_table :applications
+  end
+
+end

data/lib/oauth_provider_engine.rb

@@ -0,0 +1,42 @@
+require 'oauth'
+require 'oauth/request_proxy/rack_request'
+module OauthProviderEngine
+
+  class << self
+    # this method is used to protect the oauth#authenticate action.  you should check to
+    #   see if the user is logged in.  if the user is not logged in, redirect them to 
+    #   your login page. upon successful login, they should be redirected back to the
+    #   authenticate action with the same oauth_token param
+    class_attribute :authenticate_method
+    self.authenticate_method = Proc.new{|c| raise "need to override the authenticate method"}
+
+    # this method is used to protect the applications controller.  if you do not protect the controller,
+    #   anyone can create their own applications (which is a valid scenario).
+    class_attribute :admin_authenticate_method
+    self.admin_authenticate_method = Proc.new{|c| raise "need to override the admin authenticate method"}
+
+    # this proc should be used to fetch the uniq user id from the controller
+    class_attribute :user_method
+    self.user_method = Proc.new{|c| raise "need to override the method of retrieving the user id"}
+
+    # these settings allow you to specify what layout to use for the applications resource and the 
+    #   oauth authorize page
+    class_attribute :admin_layout
+    class_attribute :oauth_layout
+
+    def generate_key(length = 32)
+      Digest::SHA1.hexdigest("--#{Time.now.to_s}--#{rand(1000)}--")[0,length-1]
+    end
+
+    def configure(opts = {})
+      opts.each do |k,v|
+        self.send("#{k}=", v)
+      end
+
+      yield self if block_given?
+    end
+  end
+end
+
+require 'oauth_provider_engine/version'
+require 'oauth_provider_engine/engine'

data/lib/oauth_provider_engine/engine.rb

@@ -0,0 +1,5 @@
+module OauthProviderEngine
+  class Engine < Rails::Engine
+
+  end
+end

data/lib/oauth_provider_engine/version.rb

@@ -0,0 +1,3 @@
+module OauthProviderEngine
+  VERSION = "0.0.1"
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

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

data/test/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "oauth_provider_engine"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,26 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,49 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Specifies the header that your server uses for sending files
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,35 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/test/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/test/dummy/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/test/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/test/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = '37ab94d12ef5efbbad265eb8721b36129d1f7403bc14ac8707676ed5a37ec0e20073a3ae923c1b428b10ea2d9da65b520fe69e6010fc2d5fc60ee8f28fb5ce55'

data/test/dummy/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store

data/test/dummy/config/routes.rb

@@ -0,0 +1,58 @@
+Dummy::Application.routes.draw do
+  # The priority is based upon order of creation:
+  # first created -> highest priority.
+
+  # Sample of regular route:
+  #   match 'products/:id' => 'catalog#view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+
+  # Sample resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+
+  # Sample resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+
+  # Sample resource route with more complex sub-resources
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', :on => :collection
+  #     end
+  #   end
+
+  # Sample resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+
+  # You can have the root of your site routed with "root"
+  # just remember to delete public/index.html.
+  # root :to => "welcome#index"
+
+  # See how all your routes lay out with "rake routes"
+
+  # This is a legacy wild controller route that's not recommended for RESTful applications.
+  # Note: This route will make all actions in every controller accessible via GET requests.
+  # match ':controller(/:action(/:id(.:format)))'
+end

data/test/integration/navigation_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class NavigationTest < ActiveSupport::IntegrationCase
+  test "truth" do
+    assert_kind_of Dummy::Application, Rails.application
+  end
+end

data/test/support/integration_case.rb

@@ -0,0 +1,5 @@
+# Define a bare test case to use with Capybara
+class ActiveSupport::IntegrationCase < ActiveSupport::TestCase
+  include Capybara
+  include Rails.application.routes.url_helpers
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+# Configure Rails Envinronment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+
+ActionMailer::Base.delivery_method = :test
+ActionMailer::Base.perform_deliveries = true
+ActionMailer::Base.default_url_options[:host] = "test.com"
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Configure capybara for integration testing
+require "capybara/rails"
+Capybara.default_driver   = :rack_test
+Capybara.default_selector = :css
+
+# Run any available migration
+ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: oauth_provider_engine
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jeff Ching
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: jeff@chingr.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/oauth_provider_engine.rb
+- lib/generators/oauth_provider_engine/templates/migration.rb
+- lib/generators/oauth_provider_engine/oauth_provider_engine_generator.rb
+- lib/oauth_provider_engine/version.rb
+- lib/oauth_provider_engine/engine.rb
+- test/support/integration_case.rb
+- test/integration/navigation_test.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/config/routes.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/environment.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/application.rb
+- test/test_helper.rb
+- README.rdoc
+homepage: http://github.com/chingor13/oauth_provider_engine
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Rails Engine that allow the site to act as an OAuth provider
+test_files: []
+