oauth_provider_engine 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
data/README.rdoc ADDED
@@ -0,0 +1,64 @@
1
+ = OauthProviderEngine
2
+
3
+ A Rails Engine that allow the site to act as an OAuth provider
4
+
5
+ == Installation
6
+
7
+ In your Gemfile add:
8
+
9
+ gem 'oauth_provider_engine'
10
+
11
+ Install your gems:
12
+
13
+ bundle install
14
+
15
+ That's it!
16
+
17
+ == Configuration
18
+
19
+ OauthProviderEngine makes no assumptions about how you manage your
20
+ user authentication. You can configure OauthProviderEngine by setting
21
+ Proc's that are evaluated at runtime.
22
+
23
+ For example, in an initializer:
24
+
25
+ OauthProviderEngine.configure do |config|
26
+ # runs as a before_filter to the /oauth/authenticate endpoint to
27
+ # ensure the user is logged in before authorizing an app
28
+ config.authenticate_method = Proc.new{|controller|
29
+ controller.redirect_to login_path unless controller.logged_in?
30
+ }
31
+
32
+ # runs as a before_filter to the /oauth/applications resource to
33
+ # ensure the user can manage the oauth applications
34
+ config.admin_authenticate_method = Proc.new{|controller|
35
+ render :text => '', :status => 401 unless controller.current_user &&
36
+ controller.current_user.allowed?("manage_oauth")
37
+ }
38
+
39
+ # returns the current user's id so we know who is allowing access
40
+ config.user_method = Proc.new{|controller|
41
+ controller.current_user.id
42
+ end
43
+ end
44
+
45
+ == Data Model
46
+
47
+ OauthProviderEngine uses ActiveRecord to manage 3 tables:
48
+
49
+ * applications (OauthProviderEngine::Application)
50
+ * request_tokens (OauthProviderEngine::RequestToken)
51
+ * access_tokens (OauthProviderEngine::AccessToken)
52
+
53
+ A rails generator is provided for your convenience:
54
+
55
+ bundle exec rails generate oauth_provider_engine
56
+
57
+ You may also generate your migration by hand, if you'd like to take
58
+ advantage of database specific features (like foreign keys for InnoDB
59
+ MySQL tables).
60
+
61
+ == Contributing
62
+
63
+ If you'd like to contribute to this project, please fork and send me a pull
64
+ request.
@@ -0,0 +1,16 @@
1
+ class OauthProviderEngineGenerator < Rails::Generators::Base
2
+ include Rails::Generators::Migration
3
+ source_root File.expand_path("../templates", __FILE__)
4
+
5
+ def self.next_migration_number(dirname)
6
+ if ActiveRecord::Base.timestamped_migrations
7
+ Time.new.utc.strftime("%Y%m%d%H%M%S")
8
+ else
9
+ "%.3d" % (current_migration_number(dirname) + 1)
10
+ end
11
+ end
12
+
13
+ def create_migration_file
14
+ migration_template "migration.rb", "db/migrate/create_oauth_provider_engine_tables.rb"
15
+ end
16
+ end
@@ -0,0 +1,33 @@
1
+ class CreateOauthProviderEngineTables < ActiveRecord::Migration
2
+
3
+ def self.up
4
+ create_table :applications do |t|
5
+ t.string :name
6
+ t.string :url
7
+ t.string :key
8
+ t.string :secret
9
+ end
10
+
11
+ create_table :access_tokens do |t|
12
+ t.integer :application_id
13
+ t.string :token
14
+ t.string :secret
15
+ t.integer :user_id
16
+ t.datetime :expires_at
17
+ end
18
+
19
+ create_table :request_tokens do |t|
20
+ t.integer :application_id
21
+ t.string :token
22
+ t.string :secret
23
+ t.integer :user_id
24
+ end
25
+ end
26
+
27
+ def self.down
28
+ drop_table :request_tokens
29
+ drop_table :access_tokens
30
+ drop_table :applications
31
+ end
32
+
33
+ end
@@ -0,0 +1,42 @@
1
+ require 'oauth'
2
+ require 'oauth/request_proxy/rack_request'
3
+ module OauthProviderEngine
4
+
5
+ class << self
6
+ # this method is used to protect the oauth#authenticate action. you should check to
7
+ # see if the user is logged in. if the user is not logged in, redirect them to
8
+ # your login page. upon successful login, they should be redirected back to the
9
+ # authenticate action with the same oauth_token param
10
+ class_attribute :authenticate_method
11
+ self.authenticate_method = Proc.new{|c| raise "need to override the authenticate method"}
12
+
13
+ # this method is used to protect the applications controller. if you do not protect the controller,
14
+ # anyone can create their own applications (which is a valid scenario).
15
+ class_attribute :admin_authenticate_method
16
+ self.admin_authenticate_method = Proc.new{|c| raise "need to override the admin authenticate method"}
17
+
18
+ # this proc should be used to fetch the uniq user id from the controller
19
+ class_attribute :user_method
20
+ self.user_method = Proc.new{|c| raise "need to override the method of retrieving the user id"}
21
+
22
+ # these settings allow you to specify what layout to use for the applications resource and the
23
+ # oauth authorize page
24
+ class_attribute :admin_layout
25
+ class_attribute :oauth_layout
26
+
27
+ def generate_key(length = 32)
28
+ Digest::SHA1.hexdigest("--#{Time.now.to_s}--#{rand(1000)}--")[0,length-1]
29
+ end
30
+
31
+ def configure(opts = {})
32
+ opts.each do |k,v|
33
+ self.send("#{k}=", v)
34
+ end
35
+
36
+ yield self if block_given?
37
+ end
38
+ end
39
+ end
40
+
41
+ require 'oauth_provider_engine/version'
42
+ require 'oauth_provider_engine/engine'
@@ -0,0 +1,5 @@
1
+ module OauthProviderEngine
2
+ class Engine < Rails::Engine
3
+
4
+ end
5
+ end
@@ -0,0 +1,3 @@
1
+ module OauthProviderEngine
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,3 @@
1
+ class ApplicationController < ActionController::Base
2
+ protect_from_forgery
3
+ end
@@ -0,0 +1,2 @@
1
+ module ApplicationHelper
2
+ end
@@ -0,0 +1,45 @@
1
+ require File.expand_path('../boot', __FILE__)
2
+
3
+ require "active_model/railtie"
4
+ require "active_record/railtie"
5
+ require "action_controller/railtie"
6
+ require "action_view/railtie"
7
+ require "action_mailer/railtie"
8
+
9
+ Bundler.require
10
+ require "oauth_provider_engine"
11
+
12
+ module Dummy
13
+ class Application < Rails::Application
14
+ # Settings in config/environments/* take precedence over those specified here.
15
+ # Application configuration should go into files in config/initializers
16
+ # -- all .rb files in that directory are automatically loaded.
17
+
18
+ # Custom directories with classes and modules you want to be autoloadable.
19
+ # config.autoload_paths += %W(#{config.root}/extras)
20
+
21
+ # Only load the plugins named here, in the order given (default is alphabetical).
22
+ # :all can be used as a placeholder for all plugins not explicitly named.
23
+ # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
24
+
25
+ # Activate observers that should always be running.
26
+ # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
27
+
28
+ # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
29
+ # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
30
+ # config.time_zone = 'Central Time (US & Canada)'
31
+
32
+ # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
33
+ # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
34
+ # config.i18n.default_locale = :de
35
+
36
+ # JavaScript files you want as :defaults (application.js is always included).
37
+ # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
38
+
39
+ # Configure the default encoding used in templates for Ruby 1.9.
40
+ config.encoding = "utf-8"
41
+
42
+ # Configure sensitive parameters which will be filtered from the log file.
43
+ config.filter_parameters += [:password]
44
+ end
45
+ end
@@ -0,0 +1,10 @@
1
+ require 'rubygems'
2
+ gemfile = File.expand_path('../../../../Gemfile', __FILE__)
3
+
4
+ if File.exist?(gemfile)
5
+ ENV['BUNDLE_GEMFILE'] = gemfile
6
+ require 'bundler'
7
+ Bundler.setup
8
+ end
9
+
10
+ $:.unshift File.expand_path('../../../../lib', __FILE__)
@@ -0,0 +1,5 @@
1
+ # Load the rails application
2
+ require File.expand_path('../application', __FILE__)
3
+
4
+ # Initialize the rails application
5
+ Dummy::Application.initialize!
@@ -0,0 +1,26 @@
1
+ Dummy::Application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb
3
+
4
+ # In the development environment your application's code is reloaded on
5
+ # every request. This slows down response time but is perfect for development
6
+ # since you don't have to restart the webserver when you make code changes.
7
+ config.cache_classes = false
8
+
9
+ # Log error messages when you accidentally call methods on nil.
10
+ config.whiny_nils = true
11
+
12
+ # Show full error reports and disable caching
13
+ config.consider_all_requests_local = true
14
+ config.action_view.debug_rjs = true
15
+ config.action_controller.perform_caching = false
16
+
17
+ # Don't care if the mailer can't send
18
+ config.action_mailer.raise_delivery_errors = false
19
+
20
+ # Print deprecation notices to the Rails logger
21
+ config.active_support.deprecation = :log
22
+
23
+ # Only use best-standards-support built into browsers
24
+ config.action_dispatch.best_standards_support = :builtin
25
+ end
26
+
@@ -0,0 +1,49 @@
1
+ Dummy::Application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb
3
+
4
+ # The production environment is meant for finished, "live" apps.
5
+ # Code is not reloaded between requests
6
+ config.cache_classes = true
7
+
8
+ # Full error reports are disabled and caching is turned on
9
+ config.consider_all_requests_local = false
10
+ config.action_controller.perform_caching = true
11
+
12
+ # Specifies the header that your server uses for sending files
13
+ config.action_dispatch.x_sendfile_header = "X-Sendfile"
14
+
15
+ # For nginx:
16
+ # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
17
+
18
+ # If you have no front-end server that supports something like X-Sendfile,
19
+ # just comment this out and Rails will serve the files
20
+
21
+ # See everything in the log (default is :info)
22
+ # config.log_level = :debug
23
+
24
+ # Use a different logger for distributed setups
25
+ # config.logger = SyslogLogger.new
26
+
27
+ # Use a different cache store in production
28
+ # config.cache_store = :mem_cache_store
29
+
30
+ # Disable Rails's static asset server
31
+ # In production, Apache or nginx will already do this
32
+ config.serve_static_assets = false
33
+
34
+ # Enable serving of images, stylesheets, and javascripts from an asset server
35
+ # config.action_controller.asset_host = "http://assets.example.com"
36
+
37
+ # Disable delivery errors, bad email addresses will be ignored
38
+ # config.action_mailer.raise_delivery_errors = false
39
+
40
+ # Enable threaded mode
41
+ # config.threadsafe!
42
+
43
+ # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
44
+ # the I18n.default_locale when a translation can not be found)
45
+ config.i18n.fallbacks = true
46
+
47
+ # Send deprecation notices to registered listeners
48
+ config.active_support.deprecation = :notify
49
+ end
@@ -0,0 +1,35 @@
1
+ Dummy::Application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb
3
+
4
+ # The test environment is used exclusively to run your application's
5
+ # test suite. You never need to work with it otherwise. Remember that
6
+ # your test database is "scratch space" for the test suite and is wiped
7
+ # and recreated between test runs. Don't rely on the data there!
8
+ config.cache_classes = true
9
+
10
+ # Log error messages when you accidentally call methods on nil.
11
+ config.whiny_nils = true
12
+
13
+ # Show full error reports and disable caching
14
+ config.consider_all_requests_local = true
15
+ config.action_controller.perform_caching = false
16
+
17
+ # Raise exceptions instead of rendering exception templates
18
+ config.action_dispatch.show_exceptions = false
19
+
20
+ # Disable request forgery protection in test environment
21
+ config.action_controller.allow_forgery_protection = false
22
+
23
+ # Tell Action Mailer not to deliver emails to the real world.
24
+ # The :test delivery method accumulates sent emails in the
25
+ # ActionMailer::Base.deliveries array.
26
+ config.action_mailer.delivery_method = :test
27
+
28
+ # Use SQL instead of Active Record's schema dumper when creating the test database.
29
+ # This is necessary if your schema can't be completely dumped by the schema dumper,
30
+ # like if you have constraints or database-specific column types
31
+ # config.active_record.schema_format = :sql
32
+
33
+ # Print deprecation notices to the stderr
34
+ config.active_support.deprecation = :stderr
35
+ end
@@ -0,0 +1,7 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
4
+ # Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
5
+
6
+ # You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
7
+ # Rails.backtrace_cleaner.remove_silencers!
@@ -0,0 +1,10 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Add new inflection rules using the following format
4
+ # (all these examples are active by default):
5
+ # ActiveSupport::Inflector.inflections do |inflect|
6
+ # inflect.plural /^(ox)$/i, '\1en'
7
+ # inflect.singular /^(ox)en/i, '\1'
8
+ # inflect.irregular 'person', 'people'
9
+ # inflect.uncountable %w( fish sheep )
10
+ # end
@@ -0,0 +1,5 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Add new mime types for use in respond_to blocks:
4
+ # Mime::Type.register "text/richtext", :rtf
5
+ # Mime::Type.register_alias "text/html", :iphone
@@ -0,0 +1,7 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Your secret key for verifying the integrity of signed cookies.
4
+ # If you change this key, all old signed cookies will become invalid!
5
+ # Make sure the secret is at least 30 characters and all random,
6
+ # no regular words or you'll be exposed to dictionary attacks.
7
+ Dummy::Application.config.secret_token = '37ab94d12ef5efbbad265eb8721b36129d1f7403bc14ac8707676ed5a37ec0e20073a3ae923c1b428b10ea2d9da65b520fe69e6010fc2d5fc60ee8f28fb5ce55'
@@ -0,0 +1,8 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
4
+
5
+ # Use the database for sessions instead of the cookie-based default,
6
+ # which shouldn't be used to store highly confidential information
7
+ # (create the session table with "rails generate session_migration")
8
+ # Dummy::Application.config.session_store :active_record_store
@@ -0,0 +1,58 @@
1
+ Dummy::Application.routes.draw do
2
+ # The priority is based upon order of creation:
3
+ # first created -> highest priority.
4
+
5
+ # Sample of regular route:
6
+ # match 'products/:id' => 'catalog#view'
7
+ # Keep in mind you can assign values other than :controller and :action
8
+
9
+ # Sample of named route:
10
+ # match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
11
+ # This route can be invoked with purchase_url(:id => product.id)
12
+
13
+ # Sample resource route (maps HTTP verbs to controller actions automatically):
14
+ # resources :products
15
+
16
+ # Sample resource route with options:
17
+ # resources :products do
18
+ # member do
19
+ # get 'short'
20
+ # post 'toggle'
21
+ # end
22
+ #
23
+ # collection do
24
+ # get 'sold'
25
+ # end
26
+ # end
27
+
28
+ # Sample resource route with sub-resources:
29
+ # resources :products do
30
+ # resources :comments, :sales
31
+ # resource :seller
32
+ # end
33
+
34
+ # Sample resource route with more complex sub-resources
35
+ # resources :products do
36
+ # resources :comments
37
+ # resources :sales do
38
+ # get 'recent', :on => :collection
39
+ # end
40
+ # end
41
+
42
+ # Sample resource route within a namespace:
43
+ # namespace :admin do
44
+ # # Directs /admin/products/* to Admin::ProductsController
45
+ # # (app/controllers/admin/products_controller.rb)
46
+ # resources :products
47
+ # end
48
+
49
+ # You can have the root of your site routed with "root"
50
+ # just remember to delete public/index.html.
51
+ # root :to => "welcome#index"
52
+
53
+ # See how all your routes lay out with "rake routes"
54
+
55
+ # This is a legacy wild controller route that's not recommended for RESTful applications.
56
+ # Note: This route will make all actions in every controller accessible via GET requests.
57
+ # match ':controller(/:action(/:id(.:format)))'
58
+ end
@@ -0,0 +1,7 @@
1
+ require 'test_helper'
2
+
3
+ class NavigationTest < ActiveSupport::IntegrationCase
4
+ test "truth" do
5
+ assert_kind_of Dummy::Application, Rails.application
6
+ end
7
+ end
@@ -0,0 +1,5 @@
1
+ # Define a bare test case to use with Capybara
2
+ class ActiveSupport::IntegrationCase < ActiveSupport::TestCase
3
+ include Capybara
4
+ include Rails.application.routes.url_helpers
5
+ end
@@ -0,0 +1,22 @@
1
+ # Configure Rails Envinronment
2
+ ENV["RAILS_ENV"] = "test"
3
+
4
+ require File.expand_path("../dummy/config/environment.rb", __FILE__)
5
+ require "rails/test_help"
6
+
7
+ ActionMailer::Base.delivery_method = :test
8
+ ActionMailer::Base.perform_deliveries = true
9
+ ActionMailer::Base.default_url_options[:host] = "test.com"
10
+
11
+ Rails.backtrace_cleaner.remove_silencers!
12
+
13
+ # Configure capybara for integration testing
14
+ require "capybara/rails"
15
+ Capybara.default_driver = :rack_test
16
+ Capybara.default_selector = :css
17
+
18
+ # Run any available migration
19
+ ActiveRecord::Migrator.migrate File.expand_path("../dummy/db/migrate/", __FILE__)
20
+
21
+ # Load support files
22
+ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
metadata ADDED
@@ -0,0 +1,97 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: oauth_provider_engine
3
+ version: !ruby/object:Gem::Version
4
+ prerelease:
5
+ version: 0.0.1
6
+ platform: ruby
7
+ authors:
8
+ - Jeff Ching
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+
13
+ date: 2012-05-15 00:00:00 Z
14
+ dependencies:
15
+ - !ruby/object:Gem::Dependency
16
+ name: rails
17
+ prerelease: false
18
+ requirement: &id001 !ruby/object:Gem::Requirement
19
+ none: false
20
+ requirements:
21
+ - - ">="
22
+ - !ruby/object:Gem::Version
23
+ version: 3.0.0
24
+ type: :runtime
25
+ version_requirements: *id001
26
+ - !ruby/object:Gem::Dependency
27
+ name: oauth
28
+ prerelease: false
29
+ requirement: &id002 !ruby/object:Gem::Requirement
30
+ none: false
31
+ requirements:
32
+ - - ~>
33
+ - !ruby/object:Gem::Version
34
+ version: 0.4.0
35
+ type: :runtime
36
+ version_requirements: *id002
37
+ description:
38
+ email: jeff@chingr.com
39
+ executables: []
40
+
41
+ extensions: []
42
+
43
+ extra_rdoc_files:
44
+ - README.rdoc
45
+ files:
46
+ - lib/oauth_provider_engine.rb
47
+ - lib/generators/oauth_provider_engine/templates/migration.rb
48
+ - lib/generators/oauth_provider_engine/oauth_provider_engine_generator.rb
49
+ - lib/oauth_provider_engine/version.rb
50
+ - lib/oauth_provider_engine/engine.rb
51
+ - test/support/integration_case.rb
52
+ - test/integration/navigation_test.rb
53
+ - test/dummy/app/helpers/application_helper.rb
54
+ - test/dummy/app/controllers/application_controller.rb
55
+ - test/dummy/config/routes.rb
56
+ - test/dummy/config/initializers/inflections.rb
57
+ - test/dummy/config/initializers/backtrace_silencers.rb
58
+ - test/dummy/config/initializers/session_store.rb
59
+ - test/dummy/config/initializers/secret_token.rb
60
+ - test/dummy/config/initializers/mime_types.rb
61
+ - test/dummy/config/environments/production.rb
62
+ - test/dummy/config/environments/development.rb
63
+ - test/dummy/config/environments/test.rb
64
+ - test/dummy/config/environment.rb
65
+ - test/dummy/config/boot.rb
66
+ - test/dummy/config/application.rb
67
+ - test/test_helper.rb
68
+ - README.rdoc
69
+ homepage: http://github.com/chingor13/oauth_provider_engine
70
+ licenses: []
71
+
72
+ post_install_message:
73
+ rdoc_options: []
74
+
75
+ require_paths:
76
+ - lib
77
+ required_ruby_version: !ruby/object:Gem::Requirement
78
+ none: false
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: "0"
83
+ required_rubygems_version: !ruby/object:Gem::Requirement
84
+ none: false
85
+ requirements:
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: "0"
89
+ requirements: []
90
+
91
+ rubyforge_project:
92
+ rubygems_version: 1.8.24
93
+ signing_key:
94
+ specification_version: 3
95
+ summary: A Rails Engine that allow the site to act as an OAuth provider
96
+ test_files: []
97
+