josevalim-auth_helpers 0.2.1 → 0.3.0

data/CHANGELOG

@@ -1,3 +1,10 @@
+# Version 0.3
+
+* Included controllers.
+
+  AuthHelpers::Controller::Confirmable
+  AuthHelpers::Controller::Recoverable
+
 # Version 0.2
 
 * First version with the following modules:

data/README

@@ -1,6 +1,6 @@
 AuthHelpers
 License: MIT
-Version: 0.2.1
+Version: 0.3.0
 
 You can also read this README in pretty html at the GitHub project Wiki page:
 
@@ -13,6 +13,17 @@ AuthHelpers is a collection of modules to improve your Authlogic models. It
 mainly exposes some convenience methods to help on confirmation and passwords
 management, it also deals automatically with associations and notifications.
 
+Authlogic also include some controllers to deal with the modules added. For
+example, if you add Recoverable to your model, you can have all password
+management for free, if you inherit from the Recoverable controller:
+
+  class AccountPasswordsController < AuthHelpers::Controller:Recoverable
+  end
+
+This functionality is powered by InheritedResources, available at:
+
+  http://github.com/josevalim/inherited_resources
+
 Installation
 ------------
 

data/lib/auth_helpers/controller/confirmable.rb

@@ -0,0 +1,71 @@
+module AuthHelpers
+  module Controller
+    class Confirmable < ::ApplicationController
+      unloadable
+
+      include InheritedResources::BaseHelpers
+      include AuthHelpers::Controller::Helpers
+
+      class << self
+        alias :has_confirmable :set_class_accessors_with_class
+      end
+
+      # GET /account/confirmation/new
+      def new(&block)
+        object = get_or_set_with_send(:new)
+        respond_to(:with => object, &block)
+      end
+      alias :new! :new
+
+      # POST /account/confirmation
+      # POST /account/confirmation.xml
+      def create(&block)
+        object = get_or_set_with_send(:find_and_resend_confirmation_instructions, params[self.instance_name])
+        respond_block, redirect_block = select_block_by_arity(block)
+
+        if object.errors.empty?
+          set_flash_message!(:notice, 'We sent confirmation instructions to your email, please check your inbox.')
+
+          respond_to_with_dual_blocks(true, block) do |format|
+            format.html { redirect_to_block_or_scope_to(redirect_block, :session) }
+            format.all  { head :ok }
+          end
+        else
+          set_flash_message!(:error)
+          options = { :with => object.errors, :status => :unprocessable_entity }
+
+          respond_to_with_dual_blocks(false, block, options) do |format|
+            format.html { render :action => 'new' }
+          end
+        end
+      end
+      alias :create! :create
+
+      # GET /account/confirmation?account[perishable_token]=xxxx
+      # GET /account/confirmation.xml?account[perishable_token]=xxxx
+      def show(&block)
+        object = get_or_set_with_send(:find_and_confirm, params[self.instance_name])
+        respond_block, redirect_block = select_block_by_arity(block)
+
+        if object.errors.empty?
+          set_flash_message!(:notice, '{{resource_name}} was successfully confirmed.')
+
+          respond_to_with_dual_blocks(true, block) do |format|
+            format.html { redirect_to_block_or_scope_to(redirect_block, :session) }
+            format.all  { head :ok }
+          end
+        else
+          set_flash_message!(:error, object.errors.on(:perishable_token))
+          options = { :with => object.errors, :status => :unprocessable_entity }
+
+          respond_to_with_dual_blocks(false, block, options) do |format|
+            format.html { redirect_to :action => 'new' }
+          end
+        end
+      end
+      alias :show! :show
+
+      protected :show!, :new!, :create!
+    end
+  end
+end

data/lib/auth_helpers/controller/helpers.rb

@@ -0,0 +1,63 @@
+module AuthHelpers
+  module Controller
+    module Helpers
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        protected
+
+          # Writes the inherited hook for the included class based on its name.
+          #
+          def inherited(base) #:nodoc:
+            super
+
+            base.send :cattr_accessor, :resource_class, :instance_name, :route_name, :instance_writter => false
+
+            # Converts:
+            #
+            #   Mockable::ConfirmationsController #=> mockable
+            #   MockablePasswordsController       #=> mockable
+            #
+            resource = base.controller_path.gsub('/', '_').split('_')[0..-2].join('_')
+
+            begin
+              base.resource_class = resource.classify.constantize
+              base.route_name     = resource.singularize
+              base.instance_name  = resource.singularize
+            rescue NameError
+              nil
+            end
+          end
+
+          def set_class_accessors_with_class(klass)
+            self.resource_class = klass
+            self.instance_name  = klass.name.downcase
+            self.route_name     = klass.name.downcase
+          end
+      end
+
+      protected
+
+        # If a block is given, redirect to the url in the block, otherwise
+        # try to call the url given by scope, for example:
+        #
+        #   new_account_session_url
+        #   new_account_password_url
+        #
+        def redirect_to_block_or_scope_to(redirect_block, scope) #:nodoc:
+          redirect_to redirect_block ? redirect_block.call : send("new_#{self.route_name}_#{scope}_url")
+        end
+
+        # Try to get the instance variable, otherwise send the args given to
+        # the resource class and store the result in the same instance variable.
+        #
+        def get_or_set_with_send(*args) #:nodoc:
+          instance_variable_get("@#{self.instance_name}") || instance_variable_set("@#{self.instance_name}", resource_class.send(*args))
+        end
+
+    end
+  end
+

data/lib/auth_helpers/controller/recoverable.rb

@@ -0,0 +1,79 @@
+module AuthHelpers
+  module Controller
+    class Recoverable < ::ApplicationController
+      unloadable
+
+      include InheritedResources::BaseHelpers
+      include AuthHelpers::Controller::Helpers
+
+      class << self
+        alias :has_recoverable :set_class_accessors_with_class
+      end
+
+      # GET /account/password/new
+      def new(&block)
+        object = get_or_set_with_send(:new)
+        respond_to(:with => object, &block)
+      end
+      alias :new! :new
+
+      # POST /account/password
+      # POST /account/password.xml
+      def create(&block)
+        object = get_or_set_with_send(:find_and_send_reset_password_instructions, params[self.instance_name])
+        respond_block, redirect_block = select_block_by_arity(block)
+
+        if object.errors.empty?
+          set_flash_message!(:notice, 'We sent instruction to reset your password, please check your inbox.')
+
+          respond_to_with_dual_blocks(true, block) do |format|
+            format.html { redirect_to_block_or_scope_to(redirect_block, :session) }
+            format.all  { head :ok }
+          end
+        else
+          set_flash_message!(:error)
+          options = { :with => object.errors, :status => :unprocessable_entity }
+
+          respond_to_with_dual_blocks(false, block, options) do |format|
+            format.html { render :action => 'new' }
+          end
+        end
+      end
+      alias :create! :create
+
+      # GET /account/password/edit?account[perishable_token]=xxxx
+      def edit(&block)
+        object = get_or_set_with_send(:new)
+        object.perishable_token = params[self.instance_name].try(:fetch, :perishable_token)
+        respond_to(:with => object, &block)
+      end
+      alias :edit! :edit
+
+      # PUT /account/password
+      # PUT /account/password.xml
+      def update(&block)
+        object = get_or_set_with_send(:find_and_reset_password, params[self.instance_name])
+        respond_block, redirect_block = select_block_by_arity(block)
+
+        if object.errors.empty?
+          set_flash_message!(:notice, 'Your password was successfully reset.')
+
+          respond_to_with_dual_blocks(true, block) do |format|
+            format.html { redirect_to_block_or_scope_to(redirect_block, :session) }
+            format.all  { head :ok }
+          end
+        else
+          set_flash_message!(:error)
+          options = { :with => object.errors, :status => :unprocessable_entity }
+
+          respond_to_with_dual_blocks(false, block, options) do |format|
+            format.html { render :action => 'edit' }
+          end
+        end
+      end
+      alias :update! :update
+
+      protected :new!, :create!, :edit!, :update!
+    end
+  end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: josevalim-auth_helpers
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-24 00:00:00 -07:00
+date: 2009-05-03 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -37,6 +37,9 @@ files:
 - init.rb
 - lib/auth_helpers.rb
 - lib/auth_helpers/notifier.rb
+- lib/auth_helpers/controller/confirmable.rb
+- lib/auth_helpers/controller/helpers.rb
+- lib/auth_helpers/controller/recoverable.rb
 - lib/auth_helpers/model/associatable.rb
 - lib/auth_helpers/model/confirmable.rb
 - lib/auth_helpers/model/recoverable.rb