simple_auth 0.1.8 → 1.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+pkg
+.rubyrc
+.rvmrc
+log
+.bundle

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/Gemfile

@@ -0,0 +1,13 @@
+source :rubygems
+
+gem "rspec-rails", "2.0.0.rc"
+gem "rails", "3.0.0"
+gem "sqlite3-ruby", :require => "sqlite3"
+
+platforms :mri_18 do
+  gem "ruby-debug"
+end
+
+platforms :mri_19 do
+  gem "ruby-debug19", :require => "ruby-debug"
+end

data/Gemfile.lock

@@ -0,0 +1,109 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.0)
+      actionpack (= 3.0.0)
+      mail (~> 2.2.5)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    archive-tar-minitar (0.5.2)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    columnize (0.3.1)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.1)
+    linecache (0.43)
+    linecache19 (0.5.11)
+      ruby_core_source (>= 0.1.4)
+    mail (2.2.5)
+      activesupport (>= 2.3.6)
+      mime-types
+      treetop (>= 1.4.5)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.4)
+      rack (>= 1.0)
+    rails (3.0.0)
+      actionmailer (= 3.0.0)
+      actionpack (= 3.0.0)
+      activerecord (= 3.0.0)
+      activeresource (= 3.0.0)
+      activesupport (= 3.0.0)
+      bundler (~> 1.0.0)
+      railties (= 3.0.0)
+    railties (3.0.0)
+      actionpack (= 3.0.0)
+      activesupport (= 3.0.0)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    rspec (2.0.0.rc)
+      rspec-core (= 2.0.0.rc)
+      rspec-expectations (= 2.0.0.rc)
+      rspec-mocks (= 2.0.0.rc)
+    rspec-core (2.0.0.rc)
+    rspec-expectations (2.0.0.rc)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.rc)
+      rspec-core (= 2.0.0.rc)
+      rspec-expectations (= 2.0.0.rc)
+    rspec-rails (2.0.0.rc)
+      rspec (= 2.0.0.rc)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    ruby-debug-base19 (0.11.24)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.4)
+      archive-tar-minitar (>= 0.5.2)
+    sqlite3-ruby (1.3.1)
+    thor (0.14.0)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rails (= 3.0.0)
+  rspec-rails (= 2.0.0.rc)
+  ruby-debug
+  ruby-debug19
+  sqlite3-ruby

data/README.markdown

@@ -8,15 +8,9 @@ This library only supports in-site authentication and won't implement OpenID, Fa
 Installation
 ------------
 
-As plugin:
-
-	script/plugin install git://github.com/fnando/simple_auth.git
-
-As gem:
-
 	sudo gem install simple_auth
 
-Then run `script/generate simple_auth` to copy the initializer file.
+Then run `rails generate simple_auth:install` to copy the initializer file.
 
 Usage
 -----
@@ -44,23 +38,15 @@ Your user model should have the attributes `password_hash` and `password_salt`.
 	  end
 	end
 
-If your user model is other than `User`, you have to set it in your `config/initializer/simple_auth.rb` initializer file.
-You can also set up the credentials attributes.
-
-	SimpleAuth.setup do |config|
-	  config.model = :account
-	  config.credentials = [:username]
-	end
-
-On your model, call the method `has_authentication`.
+In your model, use the `authentication` macro.
 
 	class User < ActiveRecord::Base
-	  has_authentication
+	  authentication
 	end
 
-This will add some callbacks and password validations.
+This will add some callbacks and password validations. It will also inject helper methods like `Model.authenticate`.
 
-After you set up the model, you can go the controller.
+After you set up the model, you can go to the controller.
 
 	class SessionsController < ApplicationController
 	  def new
@@ -97,6 +83,11 @@ Here's some usage examples:
 	redirect_logged_user :only => [:index], :to => login_path
 	redirect_logged_user :except => [:public], :to => login_path
 
+You can skip the `:to` option if you set it globally on your initializer:
+
+	SimpleAuth::Config.logged_url = {:controller => "session", :action => "new"}
+	SimpleAuth::Config.logged_url = proc { login_path }
+
 To require a logged user, use the `require_logged_user` macro:
 
 	class DashboardController < ApplicationController
@@ -112,8 +103,8 @@ Here's some usage examples:
 
 You can skip the `:to` option if you set it globally on your initializer:
 
-	SimpleAuth::Config.redirect_to = {:controller => "session", :action => "new"}
-	SimpleAuth::Config.redirect_to = proc { login_path }
+	SimpleAuth::Config.login_url = {:controller => "session", :action => "new"}
+	SimpleAuth::Config.login_url = proc { login_path }
 
 There are some helpers:
 
@@ -122,19 +113,12 @@ There are some helpers:
 	current_session         # controller & views
 	when_logged(&block)		# views
 
-If you're having problems to use any helper, include the module <tt>SimpleAuth::Helper</tt> to your <tt>ApplicationHelper</tt>.
+If you're having problems to use any helper, include the module <tt>SimpleAuth::Helper</tt> on your <tt>ApplicationHelper</tt>.
 
 	module ApplicationHelper
 	  include SimpleAuth::Helper
 	end
 
-Sinatra support
----------------
-
-Sinatra is not fully supported. For now, you can only use the ActiveRecord part:
-
-	require "simple_auth/active_record"
-
 Troubleshooting
 ---------------
 

data/Rakefile

@@ -1,39 +1,27 @@
-require 'rake'
-
-if ENV["TARGET"] == "rails3"
-  require 'rspec/core/rake_task'
-  Rspec::Core::RakeTask.new(:spec)
-else
-  require 'spec/rake/spectask'
-  desc 'Run the specs'
-  Spec::Rake::SpecTask.new(:spec) do |t|
-    t.spec_opts = ['--colour --format specdoc --loadby mtime --reverse']
-    t.spec_files = FileList['spec/**/*_spec.rb']
-  end
-end
-
-require 'jeweler'
-require File.dirname(__FILE__) + '/lib/simple_auth/version'
+require "rspec/core/rake_task"
+require File.dirname(__FILE__) + "/lib/simple_auth/version"
 
+RSpec::Core::RakeTask.new
 
-desc 'Default: run specs.'
+desc "Default: run specs."
 task :default => :spec
 
+begin
+  require "jeweler"
+
+  JEWEL = Jeweler::Tasks.new do |gem|
+    gem.name = "simple_auth"
+    gem.version = SimpleAuth::Version::STRING
+    gem.summary = "A simple authentication system for Rails apps"
+    gem.description = "When Authlogic & Devise are just too much."
+    gem.authors = ["Nando Vieira"]
+    gem.email = "fnando.vieira@gmail.com"
+    gem.homepage = "http://github.com/fnando/simple_auth"
+    gem.has_rdoc = true
+    gem.add_dependency "rails", ">= 3.0.0"
+  end
 
-JEWEL = Jeweler::Tasks.new do |gem|
-  gem.name = "simple_auth"
-  gem.version = SimpleAuth::Version::STRING
-  gem.summary = "A simple authentication system for Rails apps"
-  gem.description = <<-TXT
-When Authlogic & Devise are just too much.
-TXT
-
-  gem.authors = ["Nando Vieira"]
-  gem.email = "fnando.vieira@gmail.com"
-  gem.homepage = "http://github.com/fnando/simple_auth"
-
-  gem.has_rdoc = false
-  gem.files = %w(Rakefile simple_auth.gemspec init.rb VERSION README.markdown) + Dir["{generators,lib,spec,app,config}/**/*"]
+  Jeweler::GemcutterTasks.new
+rescue LoadError => e
+  puts "You don't Jeweler installed, so you won't be able to build gems."
 end
-
-Jeweler::GemcutterTasks.new

data/lib/simple_auth/action_controller.rb

@@ -1,58 +1,57 @@
 module SimpleAuth
   module ActionController
-    module Implementation
-      def self.included(base)
-        base.prepend_before_filter :activate_simple_auth
-        base.helper_method :current_user, :current_session, :logged_in?
+    def self.included(base)
+      base.class_eval do
+        include InstanceMethods
+        extend ClassMethods
       end
     end
 
     module InstanceMethods
       private
-        def current_session
-          @current_session ||= SimpleAuth::Session.find
-        end
+      def current_session
+        @current_session ||= SimpleAuth::Session.find
+      end
 
-        def current_user
-          current_session && current_session.record
-        end
+      def current_user
+        current_session && current_session.record
+      end
 
-        def authorized?
-          true
-        end
+      def authorized?
+        true
+      end
 
-        def logged_in?
-          current_user != nil
-        end
+      def logged_in?
+        current_user != nil
+      end
 
-        def activate_simple_auth
-          SimpleAuth::Config.controller = self
-        end
+      def activate_simple_auth
+        SimpleAuth::Config.controller = self
+      end
 
-        def simple_auth_path(controller, path)
-          path ||= SimpleAuth::Config.redirect_to
-          path = controller.instance_eval(&path) if path.kind_of?(Proc)
-          path
-        end
+      def simple_auth_url_for(method, controller, path)
+        path ||= SimpleAuth::Config.send(method)
+        path = controller.instance_eval(&path) if path.kind_of?(Proc)
+        path
+      end
     end
 
     module ClassMethods
-      # Redirect unlogged users to the specified :to path
+      # Redirect unlogged users to the specified <tt>:to</tt> path
       #
       #   require_logged_user :to => proc { login_path }
       #   require_logged_user :to => {:controller => "session", :action => "new"}
       #   require_logged_user :only => [:index], :to => login_path
       #   require_logged_user :except => [:public], :to => login_path
       #
-      # You can set :to globally:
+      # You can set login url globally:
+      #
+      #   SimpleAuth::Config.login_url = {:controller => "session", :action => "new"}
+      #   SimpleAuth::Config.login_url = proc { login_path }
       #
-      #   SimpleAuth::Config.redirect_to = {:controller => "session", :action => "new"}
-      #   SimpleAuth::Config.redirect_to = proc { login_path }
       def require_logged_user(options = {})
-        before_filter(options.except(:to)) do |c|
-          c.instance_eval do
-            path = simple_auth_path(c, options[:to])
-
+        before_filter options.except(:to) do |controller|
+          controller.instance_eval do
             unless logged_in? && authorized?
               flash[:alert] = I18n.translate("simple_auth.sessions.need_to_be_logged")
 
@@ -63,23 +62,28 @@ module SimpleAuth
               end
 
               session[:return_to] = return_to if request.get?
-              redirect_to path
+              redirect_to simple_auth_url_for(:login_url, controller, options[:to])
             end
           end
         end
       end
 
-      # Redirect logged users to the specified :to path
+      # Redirect logged users to the specified <tt>:to</tt> path
       #
       #   redirect_logged_user :to => proc { login_path }
       #   redirect_logged_user :to => {:controller => "dashboard"}
       #   redirect_logged_user :only => [:index], :to => login_path
       #   redirect_logged_user :except => [:public], :to => login_path
+      #
+      # You can set the logged url globally:
+      #
+      #   SimpleAuth::Config.logged_url = {:controller => "dashboard", :action => "index"}
+      #   SimpleAuth::Config.logged_url = proc { dashboard_path }
+      #
       def redirect_logged_user(options = {})
-        before_filter(options.except(:to)) do |c|
-          c.instance_eval do
-            path = simple_auth_path(c, options[:to])
-            redirect_to path if logged_in?
+        before_filter options.except(:to) do |controller|
+          controller.instance_eval do
+            redirect_to simple_auth_url_for(:logged_url, controller, options[:to]) if logged_in?
           end
         end
       end

data/lib/simple_auth/active_record.rb

@@ -1,7 +1,48 @@
-require "simple_auth/config" unless defined?(SimpleAuth::Config)
-
 module SimpleAuth
   module ActiveRecord
+    def self.included(base)
+      base.class_eval { extend Macro }
+    end
+
+    module Macro
+      # Set virtual attributes, callbacks and validations.
+      # Is called automatically after setting up configuration with
+      # `SimpleAuth.setup {|config| config.model = :user}`.
+      #
+      #   class User < ActiveRecord::Base
+      #     authentication
+      #   end
+      #
+      # Can set configuration when a block is provided.
+      #
+      #   class User < ActiveRecord::Base
+      #     authentication do |config|
+      #       config.credentials = ["email"]
+      #     end
+      #   end
+      #
+      def authentication(&block)
+        SimpleAuth.setup(&block) if block_given?
+        SimpleAuth::Config.model ||= name.underscore.to_sym
+
+        return if respond_to?(:authenticate)
+
+        attr_reader :password
+        attr_accessor :password_confirmation
+
+        include SimpleAuth::ActiveRecord::InstanceMethods
+        extend  SimpleAuth::ActiveRecord::ClassMethods
+
+        before_save :encrypt_password, :if => :validate_password?
+        after_save  :erase_password
+
+        validates_presence_of     :password,              :if => :validate_password?
+        validates_length_of       :password,              :if => :validate_password?, :minimum => 4, :allow_blank => true
+        validates_presence_of     :password_confirmation, :if => :validate_password?
+        validates_confirmation_of :password,              :if => :validate_password?
+      end
+    end
+
     module InstanceMethods
       def password=(password)
         @password_changed = true
@@ -13,23 +54,23 @@ module SimpleAuth
       end
 
       private
-        def encrypt_password
-          self.password_salt = SimpleAuth::Config.salt.call(self)
-          self.password_hash = SimpleAuth::Config.crypter.call(password, password_salt)
-        end
+      def encrypt_password
+        self.password_salt = SimpleAuth::Config.salt.call(self)
+        self.password_hash = SimpleAuth::Config.crypter.call(password, password_salt)
+      end
 
-        def erase_password
-          self.password = nil
-          self.password_confirmation = nil
+      def erase_password
+        self.password = nil
+        self.password_confirmation = nil
 
-          # Mark password as unchanged after erasing passwords,
-          # or it will be marked as changed anyway
-          @password_changed = false
-        end
+        # Mark password as unchanged after erasing passwords,
+        # or it will be marked as changed anyway
+        @password_changed = false
+      end
 
-        def validate_password?
-          new_record? || password_changed?
-        end
+      def validate_password?
+        new_record? || password_changed?
+      end
     end
 
     module ClassMethods
@@ -61,38 +102,9 @@ module SimpleAuth
         # Compare password
         return nil unless record.password_hash == SimpleAuth::Config.crypter.call(password, record.password_salt)
 
-        return record
-      end
-
-      # Set virtual attributes, callbacks and acts as a wrapper for
-      # SimpleAuth::Config if a block is provided.
-      #
-      #   class User < ActiveRecord::Base
-      #     has_authentication
-      #   end
-      #
-      #   class User < ActiveRecord::Base
-      #     has_authentication do |config|
-      #       config.credentials = [:email]
-      #     end
-      #   end
-      def has_authentication(&block)
-        attr_reader :password
-        attr_accessor :password_confirmation
-
-        SimpleAuth.setup(&block)
-
-        before_save :encrypt_password, :if => :validate_password?
-        after_save  :erase_password
-
-        validates_presence_of     :password,              :if => :validate_password?
-        validates_length_of       :password,              :if => :validate_password?, :minimum => 4, :allow_blank => true
-        validates_presence_of     :password_confirmation, :if => :validate_password?
-        validates_confirmation_of :password,              :if => :validate_password?
+        # Yay! Everything matched so return record.
+        record
       end
     end
   end
 end
-
-::ActiveRecord::Base.send :include, SimpleAuth::ActiveRecord::InstanceMethods
-::ActiveRecord::Base.send :extend, SimpleAuth::ActiveRecord::ClassMethods

data/lib/simple_auth/config.rb

@@ -1,5 +1,5 @@
 module SimpleAuth
-  # Add a shortcut to Authorization::Config
+  # Add a shortcut to SimpleAuth::Config
   def self.setup(&block)
     yield SimpleAuth::Config if block_given?
   end
@@ -32,8 +32,13 @@ module SimpleAuth
     @@controller = nil
 
     # Set the login url
-    cattr_accessor :redirect_to
-    @@redirect_to = proc { login_path }
+    cattr_accessor :login_url
+    @@login_url = proc { login_path }
+
+    # Logged users will be redirect to this url
+    # when +redirect_logged_user+ helper is used.
+    cattr_accessor :logged_url
+    @@logged_url = proc { dashboard_path }
 
     # Reset session before saving the user session
     cattr_accessor :reset_session

data/lib/simple_auth/generator.rb

@@ -0,0 +1,11 @@
+require "rails/generators/base"
+
+module SimpleAuth
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.dirname(__FILE__) + "/../../templates"
+
+    def copy_initializer_file
+      copy_file "initializer.rb", "config/initializers/simple_auth.rb"
+    end
+  end
+end

data/lib/simple_auth/railtie.rb

@@ -0,0 +1,24 @@
+module SimpleAuth
+  class Railtie < Rails::Railtie
+    generators do
+      require "simple_auth/generator"
+    end
+
+    config.after_initialize do
+      ActiveSupport.on_load(:action_controller) do
+        include SimpleAuth::ActionController
+        helper SimpleAuth::Helper
+        prepend_before_filter :activate_simple_auth
+        helper_method :current_user, :current_session, :logged_in?
+      end
+
+      ActiveSupport.on_load(:active_record) do
+        include SimpleAuth::ActiveRecord
+      end
+    end
+
+    initializer "simple_auth.initialize" do |app|
+      ::I18n.load_path += Dir[File.dirname(__FILE__) + "/../../config/locales/*.yml"]
+    end
+  end
+end

data/lib/simple_auth/session.rb

@@ -66,6 +66,10 @@ module SimpleAuth
       true
     end
 
+    def self.model_name
+      ActiveModel::Name.new(self)
+    end
+
     def initialize(options = {})
       options ||= {}
 
@@ -76,10 +80,18 @@ module SimpleAuth
       @errors = Errors.new
     end
 
+    def to_key
+      nil
+    end
+
     def new_record?
       record.nil?
     end
 
+    def persisted?
+      !new_record?
+    end
+
     def valid?
       if record
         true

data/lib/simple_auth/version.rb

@@ -1,8 +1,8 @@
 module SimpleAuth
   module Version
-    MAJOR = "0"
-    MINOR = "1"
-    PATCH = "8"
+    MAJOR = "1"
+    MINOR = "0"
+    PATCH = "1"
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/lib/simple_auth.rb

@@ -1,4 +1,5 @@
 require "digest/sha2"
+require "simple_auth/railtie"
 require "simple_auth/config"
 require "simple_auth/action_controller"
 require "simple_auth/active_record"
@@ -9,10 +10,3 @@ require "simple_auth/version"
 module SimpleAuth
   class NotAuthorized < Exception; end
 end
-
-::ActionController::Base.send :include, SimpleAuth::ActionController::Implementation
-::ActionController::Base.send :include, SimpleAuth::ActionController::InstanceMethods
-::ActionController::Base.send :extend, SimpleAuth::ActionController::ClassMethods
-::ApplicationController.helper SimpleAuth::Helper if defined?(::ApplicationController)
-
-I18n.load_path += Dir[File.dirname(__FILE__) + "/../config/locales/*.yml"]