oauned 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2010 Damien MATHIEU
+
+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.md

@@ -0,0 +1,74 @@
+# Oauned
+
+Rails Engine that lets you become an OAuth Provider.
+
+## Installation
+
+You can use the latest gem which is on rubygems.
+
+    gem install oauned
+
+Don't forget to add it to your Gemfile !
+
+Then, you must create the local models.
+
+    rails g oauned:install
+
+This will create three models in your application : `Application`, `Authorization`, `Connection`  
+You'll need a fourth one, which is not created : `User`. The authentication management gem you're using should be creating it, not us.
+
+You can easily rename those models. Just change their name and the relations names between them.
+
+A route is also created.
+
+    scope '/oauth' { oauned_routing }
+
+What's important is the call to `oauned_routing`. Wherever you call this method in your routes, the oauth routes will be created.  
+They can be created several times but it's not really advised.  
+In the above case, they'll be created in the `/oauth` path.
+
+You can now start your rails server, and start connecting to your application using OAuth.
+
+## Controller Helpers
+
+There are several controller helpers intended to allow you to manage your oauth connections.
+
+- deny_auth - This is a class method. When called, the specified actions won't be accessible while using OAuth.  
+`deny_oauth, :only => :index`  
+The `:only` and `:except` options are available.
+
+- oauth_user - This represents the oauth_user. You almost never need to use it.
+- current_user - This method usually represents your user, whether he's connected "normally" or via OAuth.
+- oauth_allowed? - Has oauth been allowed or denied for the current action ?
+
+## Personnalize the view
+
+When a user tries to connect via OAuth, he'll see a page asking for acceptation. You can personalize this page.  
+Create the file `app/views/oauned/oauth/index.html.erb` (or any rendering engine you wish to use other than erb) and put your content in it.  
+You can find the default view at [app/views/oauned/oauth/index.html.erb](https://github.com/dmathieu/oauned/blob/master/app/views/oauned/oauth/index.html.erb).
+
+## Let the users create and manage applications
+
+OAuned manages only user authentication. It's your task to allow your users to create new applications and provide them an interface to see what applications they've accepted.  
+To do that, you can manipulate the models directly.
+
+* **Application** - Represents any application created.
+* **Connection** - Represents a connection between a user and an application.
+
+The **Authorization** model is used only to authorize the user when establishing the connection. You shouldn't use it.
+
+## Contributing
+
+We're open to any contribution. It has to be tested properly though.
+
+* [Fork](http://help.github.com/forking/) the project
+* Do your changes and commit them to your repository
+* Test your changes. We won't accept any untested contributions (except if they're not testable).
+* Create an [issue](https://github.com/dmathieu/oauned/issues) with a link to your commits.
+
+## Maintainers
+
+* Damien MATHIEU (http://github.com/dmathieu)
+
+## License
+MIT License. Copyright 2010 Damien MATHIEU. http://dmathieu.com

data/Rakefile

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+task :default => :spec
+RSpec::Core::RakeTask.new(:spec)
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Oauned'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/generators/oauned/helpers.rb

@@ -0,0 +1,14 @@
+module Oauned
+  module Generators
+    module Helpers
+      
+      def model_exists?(model)
+        File.exists?(File.join(destination_root, model_path(model)))
+      end
+      
+      def model_path(model)
+        File.join("app", "models", "#{model}.rb")
+      end
+    end
+  end
+end

data/lib/generators/oauned/install_generator.rb

@@ -0,0 +1,49 @@
+require 'rails/generators/active_record'
+require 'generators/oauned/helpers'
+
+module Oauned
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      include Oauned::Generators::Helpers
+
+      desc "Creates the oauned routes and models"
+      def add_oauned_routes
+        route "scope '/scoped' { oauned_routing }"
+      end
+      
+      def create_models
+        [:application, :authorization, :connection].each do |model|
+          invoke "active_record:model", [model], :migration => false unless model_exists?(model) && behavior == :invoke
+        end
+      end
+      
+      def inject_application_content
+        inject_into_class model_path(:application), Application, <<EOS if model_exists?(:authorization)
+  include Oauned::Models::Application
+  
+  has_many   :authorizations
+  has_many   :connections
+EOS
+      end
+      
+      def inject_authorization_content
+        inject_into_class model_path(:authorization), Application, <<EOS if model_exists?(:authorization)
+  include Oauned::Models::Authorization
+  
+  belongs_to       :user
+  belongs_to       :application
+EOS
+      end
+      
+      def inject_connection_content
+        inject_into_class model_path(:connection), Application, <<EOS if model_exists?(:authorization)
+  include Oauned::Models::Connection
+  
+  belongs_to       :user
+  belongs_to       :application
+EOS
+      end
+    end
+  end
+end

data/lib/oauned.rb

@@ -0,0 +1,7 @@
+module Oauned
+  autoload :ControllerMethods, 'oauned/controller_methods'
+  autoload :Models, 'oauned/models'
+  
+end
+
+require 'oauned/rails'

data/lib/oauned/controller_methods.rb

@@ -0,0 +1,45 @@
+module Oauned
+  module ControllerMethods
+    def self.included(klass)
+      klass.class_eval do
+        cattr_accessor :oauth_options, :oauth_options_proc
+          
+        protected
+        def self.deny_oauth(options = {}, &block)
+          raise 'options cannot contain both :only and :except' if options[:only] && options[:except]
+        
+          [:only, :except].each do |k|
+            if values = options[k]
+              options[k] = Array(values).map(&:to_s).to_set
+            end
+          end
+          self.oauth_options = options
+          self.oauth_options_proc = block
+        end
+          
+        def oauth_user
+          @oauth_user ||= oauth_allowed? ? user_from_oauth : nil
+        end          
+          
+        alias :normal_user :current_user
+        def current_user
+          normal_user || oauth_user
+        end
+        
+        private
+        def user_from_oauth
+          token = Connection.where(:access_token => params[:access_token]).first
+          token.user if (token && !token.expired?)
+        end
+        
+        def oauth_allowed?
+          return true if (oauth_options_proc && !oauth_options_proc.call(self)) || oauth_options.nil?
+          return false if oauth_options.empty?
+          return true if oauth_options[:only] && !oauth_options[:only].include?(action_name)
+          return true if oauth_options[:except] && oauth_options[:except].include?(action_name)
+          false
+        end
+      end
+    end
+  end
+end

data/lib/oauned/models.rb

@@ -0,0 +1,5 @@
+module Oauned::Models
+  autoload :Application, 'oauned/models/application'
+  autoload :Authorization, 'oauned/models/authorization'
+  autoload :Connection, 'oauned/models/connection'
+end

data/lib/oauned/models/application.rb

@@ -0,0 +1,16 @@
+module Oauned::Models::Application
+  def self.included(klass)
+    klass.class_eval do
+      before_create    :set_default
+
+      def authorize!(user)
+        Authorization.create!(:user_id => user.id, :application_id => id)
+      end
+
+      private
+      def set_default
+        self.consumer_secret = SecureRandom.hex(40)
+      end
+    end
+  end
+end

data/lib/oauned/models/authorization.rb

@@ -0,0 +1,25 @@
+module Oauned::Models::Authorization
+  def self.included(klass)
+    klass.class_eval do
+      before_create    :set_default
+
+      def expires_in
+        (expires_at - Time.now).to_i
+      end
+      def expired?
+        expires_in <= 0
+      end
+
+      def tokenize!
+        self.destroy
+        Connection.create!(:user_id => user.id, :application_id => application.id)
+      end
+
+      private
+      def set_default
+        self.code = SecureRandom.hex(20)
+        self.expires_at = 1.hour.from_now
+      end
+    end
+  end
+end

data/lib/oauned/models/connection.rb

@@ -0,0 +1,25 @@
+module Oauned::Models::Connection
+  def self.included(klass)
+    klass.class_eval do
+      before_create    :set_default
+
+      def expires_in
+        (expires_at - Time.now).to_i
+      end
+      def expired?
+        expires_in <= 0
+      end
+
+      def refresh
+        self.destroy
+        Connection.create!(:user_id => user.id, :application_id => application.id)
+      end
+
+      private
+      def set_default
+        self.access_token = SecureRandom.hex(20)
+        self.expires_at = 1.hour.from_now
+      end
+    end
+  end
+end

data/lib/oauned/rails.rb

@@ -0,0 +1,15 @@
+require 'oauned/rails/routing'
+
+module Oauned
+  class Engine < ::Rails::Engine
+    # Force routes to be loaded if we are doing any eager load.
+    config.before_eager_load { |app| app.reload_routes! }
+    
+    initializer "oauned.controller_helpers", :after=> :disable_dependency_loading do
+      ActiveSupport.on_load(:action_controller) do
+        include Oauned::ControllerMethods
+        
+      end
+    end
+  end
+end

data/lib/oauned/rails/routing.rb

@@ -0,0 +1,10 @@
+module ActionDispatch::Routing
+  class Mapper
+    
+    def oauned_routing
+      get '/' => 'oauned/oauth#index', :as => 'oauth'
+      post '/' => 'oauned/oauth#authorize'
+      post '/token' => 'oauned/oauth#token'
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: oauned
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: []
+
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-21 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Rails Engine to be an Oauth Provider
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/generators/oauned/helpers.rb
+- lib/generators/oauned/install_generator.rb
+- lib/oauned/controller_methods.rb
+- lib/oauned/models/application.rb
+- lib/oauned/models/authorization.rb
+- lib/oauned/models/connection.rb
+- lib/oauned/models.rb
+- lib/oauned/rails/routing.rb
+- lib/oauned/rails.rb
+- lib/oauned.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Oauth Provider
+test_files: []
+