RubyGems - merb-auth-slice-password-reset - Versions diffs - 1.1.0 - Mend

merb-auth-slice-password-reset 1.1.0

Files changed (35) hide show

data/.gitignore +15 -0
data/LICENSE +20 -0
data/README.textile +219 -0
data/Rakefile +41 -0
data/TODO +2 -0
data/app/controllers/application.rb +5 -0
data/app/controllers/passwords.rb +49 -0
data/app/helpers/application_helper.rb +64 -0
data/app/helpers/mailer_helper.rb +28 -0
data/app/mailers/password_reset_mailer.rb +13 -0
data/app/mailers/views/password_reset_mailer/password_reset.text.erb +3 -0
data/app/views/layout/merb_auth_slice_password_reset.html.erb +16 -0
data/app/views/passwords/forgot_password.html.erb +7 -0
data/app/views/passwords/reset.html.erb +15 -0
data/config/init.rb +80 -0
data/lib/merb-auth-slice-password-reset.rb +82 -0
data/lib/merb-auth-slice-password-reset/merbtasks.rb +112 -0
data/lib/merb-auth-slice-password-reset/mixins/senile_user.rb +81 -0
data/lib/merb-auth-slice-password-reset/mixins/senile_user/ar_senile_user.rb +19 -0
data/lib/merb-auth-slice-password-reset/mixins/senile_user/dm_senile_user.rb +22 -0
data/lib/merb-auth-slice-password-reset/mixins/senile_user/mm_senile_user.rb +22 -0
data/lib/merb-auth-slice-password-reset/mixins/senile_user/sq_senile_user.rb +20 -0
data/lib/merb-auth-slice-password-reset/slicetasks.rb +18 -0
data/lib/merb-auth-slice-password-reset/spectasks.rb +75 -0
data/public/javascripts/master.js +0 -0
data/public/stylesheets/master.css +2 -0
data/spec/mailers/password_reset_mailer_spec.rb +50 -0
data/spec/mixins/senile_user_spec.rb +111 -0
data/spec/requests/passwords_spec.rb +85 -0
data/spec/spec_helper.rb +61 -0
data/stubs/app/controllers/passwords.rb +13 -0
data/stubs/app/mailers/views/password_reset_mailer/new_password.html.erb +3 -0
data/stubs/app/mailers/views/password_reset_mailer/password_reset.text.erb +5 -0
data/stubs/app/views/passwords/forgot_password.html.erb +7 -0
metadata +169 -0

data/app/mailers/password_reset_mailer.rb ADDED

@@ -0,0 +1,13 @@
+class MerbAuthSlicePasswordReset::PasswordResetMailer < Merb::MailController
+  include Merb::MerbAuthSlicePasswordReset::MailerHelper
+  controller_for_slice MerbAuthSlicePasswordReset, :templates_for => :mailer, :path => "views"
+  def password_reset
+    @user = params[:user]
+    Merb.logger.info "Sending Password Reset to #{@user.email} with code #{@user.password_reset_code}"
+    render_mail :layout => nil
+  end
+end

data/app/mailers/views/password_reset_mailer/password_reset.text.erb ADDED

@@ -0,0 +1,3 @@
+To reset your password, please visit:
+  <%= password_reset_url(@user) %>

data/app/views/layout/merb_auth_slice_password_reset.html.erb ADDED

@@ -0,0 +1,16 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-us" lang="en-us">
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+    <title>Fresh MerbAuthSlicePasswordReset Slice</title>
+    <link href="<%= public_path_for :stylesheet, 'master.css' %>" type="text/css" charset="utf-8" rel="stylesheet" media="all" />
+    <script src="<%= public_path_for :javascript, 'master.js' %>" type="text/javascript" charset="utf-8"></script>
+  </head>
+  <!-- you can override this layout at slices/merb-auth-slice-password-reset/app/views/layout/merb-auth-slice-password-reset.html.erb -->
+  <body class="merb-auth-slice-password-reset-slice">
+  <div id="container">
+	  <h1>MerbAuthSlicePasswordReset Slice</h1>
+    <div id="main"><%= catch_content :for_layout %></div>
+  </div>
+  </body>
+</html>

data/app/views/passwords/forgot_password.html.erb ADDED

@@ -0,0 +1,7 @@
+<form action="" method="post">
+  <p>
+    <label for="<%= @login_param_name %>"><%= @login_param_name.to_s.capitalize.t %></label>
+    <input type="text" class="text" name="<%= @login_param_name %>" id="<%= @login_param_name %>" />
+  </p>
+  <input type="submit" value="Reset password" />
+</form>

data/app/views/passwords/reset.html.erb ADDED

@@ -0,0 +1,15 @@
+<h1>Please set a new password</h1>
+<form action="<%= slice_url(:reset_check) %>" method="post">
+  <table>
+    <tr>
+      <td>Password</td>
+      <td><input type="password" name="user[password]" value="" id="user_password" /></td>
+    </tr>
+    <tr>
+      <td>Confirmation</td>
+      <td><input type="password" name="user[password_confirmation]" value="" id="user_password_confirmation" /></td>
+    </tr>
+  </table>
+  <input type="submit" value="Reset password" />
+</form>

data/config/init.rb ADDED

@@ -0,0 +1,80 @@
+#
+# ==== Standalone MerbAuthSlicePasswordReset configuration
+#
+# This configuration/environment file is only loaded by bin/slice, which can be
+# used during development of the slice. It has no effect on this slice being
+# loaded in a host application. To run your slice in standalone mode, just
+# run 'slice' from its directory. The 'slice' command is very similar to
+# the 'merb' command, and takes all the same options, including -i to drop
+# into an irb session for example.
+#
+# The usual Merb configuration directives and init.rb setup methods apply,
+# including use_orm and before_app_loads/after_app_loads.
+#
+# If you need need different configurations for different environments you can
+# even create the specific environment file in config/environments/ just like
+# in a regular Merb application.
+#
+# In fact, a slice is no different from a normal # Merb application - it only
+# differs by the fact that seamlessly integrates into a so called 'host'
+# application, which in turn can override or finetune the slice implementation
+# code and views.
+#
+require(File.join(File.expand_path(File.dirname(__FILE__)),"..","lib","merb-auth-slice-password-reset"))
+# Setup the required configuration for the slice
+Merb::Slices::config[:merb_auth_slice_password_reset][:from_email]          = "homer@example.com"
+Merb::Slices::config[:merb_auth_slice_password_reset][:password_reset_host] = "example.com"
+Merb::BootLoader.before_app_loads do
+  require "dm-core"
+  DataMapper.setup(:default, "sqlite3::memory:")
+  class User
+    include DataMapper::Resource
+    include Merb::Authentication::Mixins::SenileUser
+    property :id,    Serial
+    property :email, String
+    property :login, String
+    property :password, String
+    def password_confirmation=(val); end;
+  end
+  class Merb::Authentication
+    def self.user_class
+      ::User
+    end
+    def store_user(user)
+      return nil if user.nil?
+      user.login
+    end
+    def fetch_user(user_id)
+      User.first(:login => login)
+    end
+  end
+end
+Merb::Config.use do |c|
+  # Sets up a custom session id key which is used for the session persistence
+  # cookie name.  If not specified, defaults to '_session_id'.
+  # c[:session_id_key] = '_session_id'
+  # The session_secret_key is only required for the cookie session store.
+  c[:session_secret_key]  = 'fe91f7d7dc909e8d5f59f8db8b4f6f866f358fae'
+  # There are various options here, by default Merb comes with 'cookie',
+  # 'memory', 'memcache' or 'container'.
+  # You can of course use your favorite ORM instead:
+  # 'datamapper', 'sequel' or 'activerecord'.
+  c[:session_store] = 'cookie'
+  # When running a slice standalone, you're usually developing it,
+  # so enable template reloading by default.
+  c[:reload_templates] = true
+end

data/lib/merb-auth-slice-password-reset.rb ADDED

@@ -0,0 +1,82 @@
+if defined?(Merb::Plugins)
+  $:.unshift File.dirname(__FILE__)
+  require(File.expand_path(File.dirname(__FILE__) / "merb-auth-slice-password-reset" / "mixins") / "senile_user")
+  Merb::Plugins.add_rakefiles "merb-auth-slice-password-reset/merbtasks", "merb-auth-slice-password-reset/slicetasks", "merb-auth-slice-password-reset/spectasks"
+  # Register the Slice for the current host application
+  Merb::Slices::register(__FILE__)
+  # Slice configuration - set this in a before_app_loads callback.
+  # By default a Slice uses its own layout, so you can swicht to
+  # the main application layout or no layout at all if needed.
+  #
+  # Configuration options:
+  # :layout - the layout to use; defaults to :merb-auth-slice-password-reset
+  # :mirror - which path component types to use on copy operations; defaults to all
+  Merb::Slices::config[:merb_auth_slice_password_reset][:layout] ||= :application
+  # All Slice code is expected to be namespaced inside a module
+  module MerbAuthSlicePasswordReset
+    # Slice metadata
+    self.description = "MerbAuthSlicePasswordReset is a merb slice that adds password-reset functionality for merb-auth-based merb applications."
+    self.version = "1.1.0"
+    self.author = "Daniel Neighman, Christian Kebekus"
+    # Stub classes loaded hook - runs before LoadClasses BootLoader
+    # right after a slice's classes have been loaded internally.
+    def self.loaded
+    end
+    # Initialization hook - runs before AfterAppLoads BootLoader
+    def self.init
+    end
+    # Activation hook - runs after AfterAppLoads BootLoader
+    def self.activate
+    end
+    # Deactivation hook - triggered by Merb::Slices.deactivate(MerbAuthSlicePasswordReset)
+    def self.deactivate
+    end
+    # Setup routes inside the host application
+    #
+    # @param scope<Merb::Router::Behaviour>
+    #  Routes will be added within this scope (namespace). In fact, any
+    #  router behaviour is a valid namespace, so you can attach
+    #  routes at any level of your router setup.
+    #
+    # @note prefix your named routes with :merb_auth_slice_password_reset_
+    #   to avoid potential conflicts with global named routes.
+    def self.setup_router(scope)
+      scope.match("/reset_password/:password_reset_code", :method => :get).to(:controller => "passwords", :action => "reset").name(:reset_password)
+      scope.match("/reset_check/:password_reset_code", :method => :post).to(:controller => "passwords", :action => "reset_check").name(:reset_check)
+      scope.match("/forgot_password", :method => :get).to(:controller => "passwords", :action => "forgot_password").name(:forgot_password)
+      scope.match("/forgot_password", :method => :post).to(:controller => "passwords", :action => "send_confirmation")
+    end
+  end
+  # Setup the slice layout for MerbAuthSlicePasswordReset
+  #
+  # Use MerbAuthSlicePasswordReset.push_path and MerbAuthSlicePasswordReset.push_app_path
+  # to set paths to merb-auth-slice-password-reset-level and app-level paths. Example:
+  #
+  # MerbAuthSlicePasswordReset.push_path(:application, MerbAuthSlicePasswordReset.root)
+  # MerbAuthSlicePasswordReset.push_app_path(:application, Merb.root / 'slices' / 'merb-auth-slice-password-reset')
+  # ...
+  #
+  # Any component path that hasn't been set will default to MerbAuthSlicePasswordReset.root
+  #
+  # Or just call setup_default_structure! to setup a basic Merb MVC structure.
+  MerbAuthSlicePasswordReset.setup_default_structure!
+  MaSPR = MerbAuthSlicePasswordReset unless defined?(MaSPR)
+  # Add dependencies for other MerbAuthSlicePasswordReset classes below. Example:
+  # dependency "merb-auth-slice-password-reset/other"
+end

data/lib/merb-auth-slice-password-reset/merbtasks.rb ADDED

@@ -0,0 +1,112 @@
+namespace :slices do
+  namespace :"merb-auth-slice-password-reset" do
+    desc "Install MerbAuthSlicePasswordReset"
+    task :install => [:preflight, :setup_directories, :copy_assets, :migrate]
+    desc "Test for any dependencies"
+    task :preflight do # see slicetasks.rb
+    end
+    desc "Setup directories"
+    task :setup_directories do
+      puts "Creating directories for host application"
+      MerbAuthSlicePasswordReset.mirrored_components.each do |type|
+        if File.directory?(MerbAuthSlicePasswordReset.dir_for(type))
+          if !File.directory?(dst_path = MerbAuthSlicePasswordReset.app_dir_for(type))
+            relative_path = dst_path.relative_path_from(Merb.root)
+            puts "- creating directory :#{type} #{File.basename(Merb.root) / relative_path}"
+            mkdir_p(dst_path)
+          end
+        end
+      end
+    end
+    desc "Copy stub files to host application"
+    task :stubs do
+      puts "Copying stubs for MerbAuthSlicePasswordReset - resolves any collisions"
+      copied, preserved = MerbAuthSlicePasswordReset.mirror_stubs!
+      puts "- no files to copy" if copied.empty? && preserved.empty?
+      copied.each { |f| puts "- copied #{f}" }
+      preserved.each { |f| puts "! preserved override as #{f}" }
+    end
+    desc "Copy stub files and views to host application"
+    task :patch => [ "stubs", "freeze:views" ]
+    desc "Copy public assets to host application"
+    task :copy_assets do
+      puts "Copying assets for MerbAuthSlicePasswordReset - resolves any collisions"
+      copied, preserved = MerbAuthSlicePasswordReset.mirror_public!
+      puts "- no files to copy" if copied.empty? && preserved.empty?
+      copied.each { |f| puts "- copied #{f}" }
+      preserved.each { |f| puts "! preserved override as #{f}" }
+    end
+    desc "Migrate the database"
+    task :migrate do # see slicetasks.rb
+    end
+    desc "Freeze MerbAuthSlicePasswordReset into your app (only merb-auth-slice-password-reset/app)"
+    task :freeze => [ "freeze:app" ]
+    namespace :freeze do
+      desc "Freezes MerbAuthSlicePasswordReset by installing the gem into application/gems"
+      task :gem do
+        ENV["GEM"] ||= "merb-auth-slice-password-reset"
+        Rake::Task['slices:install_as_gem'].invoke
+      end
+      desc "Freezes MerbAuthSlicePasswordReset by copying all files from merb-auth-slice-password-reset/app to your application"
+      task :app do
+        puts "Copying all merb-auth-slice-password-reset/app files to your application - resolves any collisions"
+        copied, preserved = MerbAuthSlicePasswordReset.mirror_app!
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      desc "Freeze all views into your application for easy modification"
+      task :views do
+        puts "Copying all view templates to your application - resolves any collisions"
+        copied, preserved = MerbAuthSlicePasswordReset.mirror_files_for :view
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      desc "Freeze all mailers into your application for easy modification"
+      task :mailers do
+        puts "Copying all mailer templates to your application - resolves any collisions"
+        copied, preserved = MerbAuthSlicePasswordReset.mirror_files_for :mailer
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      desc "Freeze all models into your application for easy modification"
+      task :models do
+        puts "Copying all models to your application - resolves any collisions"
+        copied, preserved = MerbAuthSlicePasswordReset.mirror_files_for :model
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      desc "Freezes MerbAuthSlicePasswordReset as a gem and copies over merb-auth-slice-password-reset/app"
+      task :app_with_gem => [:gem, :app]
+      desc "Freezes MerbAuthSlicePasswordReset by unpacking all files into your application"
+      task :unpack do
+        puts "Unpacking MerbAuthSlicePasswordReset files to your application - resolves any collisions"
+        copied, preserved = MerbAuthSlicePasswordReset.unpack_slice!
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+    end
+  end
+end

data/lib/merb-auth-slice-password-reset/mixins/senile_user.rb ADDED

@@ -0,0 +1,81 @@
+module Merb
+  class Authentication
+    module Mixins
+      # This mixin provides basic password-reset functionality for senile users.
+      #
+      # Added properties:
+      #  :password_reset_code, String
+      #
+      # To use it simply require it and include it into your user class.
+      #
+      # class User
+      #   include Merb::Authentication::Mixins::SenileUser
+      #
+      # end
+      #
+      module SenileUser
+        def self.included(base)
+          base.class_eval do
+            include Merb::Authentication::Mixins::SenileUser::InstanceMethods
+            extend  Merb::Authentication::Mixins::SenileUser::ClassMethods
+            path = File.expand_path(File.dirname(__FILE__)) / "senile_user"
+            if defined?(DataMapper) && DataMapper::Resource > self
+              require path / "dm_senile_user"
+              extend(Merb::Authentication::Mixins::SenileUser::DMClassMethods)
+            elsif defined?(ActiveRecord) && ancestors.include?(ActiveRecord::Base)
+              require path / "ar_senile_user"
+              extend(Merb::Authentication::Mixins::SenileUser::ARClassMethods)
+            elsif defined?(Sequel) && ancestors.include?(Sequel::Model)
+              require path / "sq_senile_user"
+              extend(Merb::Authentication::Mixins::SenileUser::SQClassMethods)
+            elsif MongoMapper::Document > self
+              require path / "mm_senile_user"
+              extend(Merb::Authentication::Mixins::SenileUser::MMClassMethods)
+            end
+          end # base.class_eval
+        end # self.included
+        module ClassMethods
+          def make_key
+            Digest::SHA1.hexdigest( Time.now.to_s.split(//).sort_by {rand}.join )
+          end
+        end # ClassMethods
+        module InstanceMethods
+          def generate_password_reset_code
+            pwreset_key_success = false
+            until pwreset_key_success
+              self.password_reset_code = self.class.make_key
+              respond_to?(:save!) ? save! : save
+              pwreset_key_success = self.errors.on(:password_reset_code).nil? ? true : false
+            end
+          end
+          def password_reset?
+            ! self.password_reset_code.nil?
+          end
+          # Sends out the password reset notification.
+          # Used 'Request to change your password' as subject if +MaSFP[:password_reset_subject]+ is not set.
+          def send_password_reset_notification
+            generate_password_reset_code
+            deliver_password_reset_email(:password_reset, :subject => (MaSPR[:password_reset_subject] || "Request to change your password"))
+          end
+          private
+          # Helper method delivering the email.
+          def deliver_password_reset_email(action, params)
+            from = MaSPR[:from_email]
+            raise "No :from_email option set for Merb::Slices::config[:merb_auth_slice_password_reset][:from_email]" unless from
+            MaSPR::PasswordResetMailer.dispatch_and_deliver(action, params.merge(:from => from, :to => self.email), :user => self)
+          end
+        end # InstanceMethods
+      end # SenileUser
+    end # Mixins
+  end # Authentication
+end # Merb

data/lib/merb-auth-slice-password-reset/mixins/senile_user/ar_senile_user.rb ADDED

@@ -0,0 +1,19 @@
+module Merb
+  class Authentication
+    module Mixins
+      module SenileUser
+        module ARClassMethods
+          def self.extended(base)
+            def find_with_password_reset_code(code)
+              find(:first, :conditions => ["password_reset_code = ?", code])
+            end
+            def find_with_login_param(param_name, value)
+              find(:first, :conditions => ["#{param_name} = ?", value])
+            end
+          end # self.extended
+        end # ARClassMethods
+      end # SenileUser
+    end # Mixins
+  end # Authentication
+end # Merb

data/lib/merb-auth-slice-password-reset/mixins/senile_user/dm_senile_user.rb ADDED

@@ -0,0 +1,22 @@
+module Merb
+  class Authentication
+    module Mixins
+      module SenileUser
+        module DMClassMethods
+          def self.extended(base)
+            base.class_eval do
+              property :password_reset_code, String, :writer => :protected
+            end # base.class_eval
+            def find_with_password_reset_code(code)
+              first(:password_reset_code => code)
+            end
+            def find_with_login_param(param_name, value)
+              first(param_name => value)
+            end
+          end # self.extended
+        end # DMClassMethods
+      end # SenileUser
+    end # Mixins
+  end # Authentication
+end #Merb