jsmestad-merb-auth-slice-activation 1.0.0

data/README.textile

@@ -0,0 +1,205 @@
+h3. MerbAuthSliceActivation
+
+This slice provides a check to make sure that a user is active on login.  It also provides 
+activation on the "user" object via an activation action (slice_url :activate).  When loggin in,
+the "user" object found by merb-auth-core will be asked
+
+Do you respond_to?(:active?):
+# If yes, check if active and return the user if they are
+# If no,  return the user (i.e. no activation check)
+
+This slice adds a mixin that you should include in your user model to priovide the active? method. 
+The mixin will automatically select the correct sub mixin for all supported orms. 
+ 
+<pre><code>
+class User
+  include DataMapper::Resource
+  include Merb::Authentication::Mixins::ActivatedUser
+
+  property :id,    Serial
+end
+</code></pre>
+
+The mixin provides a number of methods.  The most common are: 
+
+<pre><code>
+  @user.activate!   # activates (and saves) the user
+  @user.activated?  # Returns the "active" status of the user
+  @user.active?     # Alias for activated?
+</pre></code>
+
+h3. Migration Requirements
+
+The mixin requires some fields to be in-place on your model.  Where needed include these in your migrations.
+<pre><code>
+  :activated_at,    DateTime
+  :activation_code, String
+</code></pre>
+
+h3. Mailers
+
+The slice contains 2 mailing actions that are setup as callback hooks on the model.  When the model is created
+a "signup" email is sent with the link to follow to activate the account.  Also an activation acknowledgment 
+email.
+
+h3. Configuration Options
+
+These options may be declared in your @init.rb@ or @environment/*.rb@ files
+
+Use the standard slice configuration hash to set these up @Merb::Slices::config[:'merb-auth-slice-activation']@
+
+
+h4. Required
+
+:from_email         # The email account to send the email from
+:activation_host    # The host to go to for activation.  This is used to construct the 
+                    # activation link.  Symbol, String or Procs are available.
+                    # Procs will have the @user@ object passed in
+
+h4. Optional
+
+:welcome_subject    # The subject of the email to send after activation (Welcome)
+:activation_subject # The subject of the email sent to ask for activation
+
+h3. Customizing the emails
+
+To customize your emails, rake the slices stubs
+
+<pre><code>
+	$ rake slices:merb-auth-slice-activation:stubs
+</code></pre>
+
+This will create stubs of the views in @slices/merb-auth-slice-activation/app/mailers/views/@
+
+To create HTML emails just add an html template like @signup.html.erb@
+
+h3. Customize the Redirect after activation
+
+rake the slices stubs as above. There is an @activations.rb@ controller in the
+@slices/merb-auth-slice-activation/app/controllers@ directory.  You can overwrite the stubbed 
+method in there to have it change it's redirection behavior.
+
+
+# Rake tasks to package/install the gem - edit this to modify the manifest.
+# The slice application: controllers, models, helpers, views.
+# The default layout, as specified in @Merb::Slices::config[:'merb-auth-slice-activation'][:layout]@ change this to :application to use the app's layout.
+# Standard rake tasks available to your application.
+# Your custom application rake tasks.
+# The main slice file - contains all slice setup @logic/config@.
+# Public assets you (optionally) install using @rake slices:merb-auth-slice-activation:install@
+# Specs for basis slice behaviour - you usually adapt these for your slice.
+# Stubs of classes/views/files for the end-user to override - usually these mimic the files in @app/@ and/or @public/@; use @rake slices:merb-auth-slice-activation:stubs@ to get started with the override stubs. Also, @rake slices:merb-auth-slice-activation:patch@ will copy over views to override in addition to the files found in /stubs.
+   
+
+To see all available tasks for MerbAuthSliceActivation run:
+
+<pre><code>
+	$ rake -T slices:merb-auth-slice-activation
+</code></pre>
+
+
+
+------------------------------------------------------------------------------
+
+Instructions for installation:
+
+file: config/init.rb
+
+# add the slice as a regular dependency
+
+dependency 'merb-auth-slice-activation'
+
+# if needed, configure which slices to load and in which order
+
+Merb::Plugins.config[:merb_slices] = { :queue => ["MerbAuthSliceActivation", ...] }
+
+# optionally configure the plugins in a before_app_loads callback
+
+Merb::BootLoader.before_app_loads do
+  
+  Merb::Slices::config[:merb-auth-slice-activation][:option] = value
+  
+end
+
+file: config/router.rb
+
+# example: /merb-auth-slice-activation/:controller/:action/:id
+
+add_slice(:MerbAuthSliceActivation)
+
+# example: /foo/:controller/:action/:id
+
+add_slice(:MerbAuthSliceActivation, 'foo') # same as :path => 'foo'
+
+# example: /:lang/:controller/:action/:id
+
+add_slice(:MerbAuthSliceActivation, :path => ':lang')
+
+# example: /:controller/:action/:id
+
+slice(:MerbAuthSliceActivation)
+
+Normally you should also run the following rake task:
+
+rake slices:merb-auth-slice-activation:install
+
+------------------------------------------------------------------------------
+
+You can put your application-level overrides in:
+
+host-app/slices/merb-auth-slice-activation/app - controllers, models, views ...
+
+Templates are located in this order:
+
+1. host-app/slices/merb-auth-slice-activation/app/views/*
+2. gems/merb-auth-slice-activation/app/views/*
+3. host-app/app/views/*
+
+You can use the host application's layout by configuring the
+merb-auth-slice-activation slice in a before_app_loads block:
+
+Merb::Slices.config[:merb-auth-slice-activation] = { :layout => :application }
+
+By default :merb-auth-slice-activation is used. If you need to override
+stylesheets or javascripts, just specify your own files in your layout
+instead/in addition to the ones supplied (if any) in 
+host-app/public/slices/merb-auth-slice-activation.
+
+In any case don't edit those files directly as they may be clobbered any time
+rake merb-auth-slice-activation:install is run.
+
+------------------------------------------------------------------------------
+
+About Slices
+============
+
+Merb-Slices is a Merb plugin for using and creating application 'slices' which
+help you modularize your application. Usually these are reuseable extractions
+from your main app. In effect, a Slice is just like a regular Merb MVC
+application, both in functionality as well as in structure.
+
+When you generate a Slice stub structure, a module is setup to serve as a
+namespace for your controller, models, helpers etc. This ensures maximum
+encapsulation. You could say a Slice is a mixture between a Merb plugin (a
+Gem) and a Merb application, reaping the benefits of both.
+
+A host application can 'mount' a Slice inside the router, which means you have
+full over control how it integrates. By default a Slice's routes are prefixed
+by its name (a router :namespace), but you can easily provide your own prefix
+or leave it out, mounting it at the root of your url-schema. You can even
+mount a Slice multiple times and give extra parameters to customize an
+instance's behaviour.
+
+A Slice's Application controller uses controller_for_slice to setup slice
+specific behaviour, which mainly affects cascaded view handling. Additionaly,
+this method is available to any kind of controller, so it can be used for
+Merb Mailer too for example.
+
+There are many ways which let you customize a Slice's functionality and
+appearance without ever touching the Gem-level code itself. It's not only easy
+to add template/layout overrides, you can also add/modify controllers, models
+and other runtime code from within the host application.
+
+To create your own Slice run this (somewhere outside of your merb app):
+
+$ merb-gen slice <your-lowercase-slice-name>

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'merb-core'
+require 'merb-core/tasks/merb'
+require 'merb-core/test/tasks/spectasks'
+
+GEM_NAME = "merb-auth-slice-activation"
+AUTHOR = "Daniel Neighman, Christian Kebekus"
+EMAIL = "has.sox@gmail.com"
+HOMEPAGE = "http://merbivore.com/"
+SUMMARY = "Merb Slice that adds basic activation functionality to merb-auth."
+GEM_VERSION = "1.0"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'merb'
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.textile", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb-slices', '>= 1.0')
+  s.add_dependency('merb-auth-core', ">= 1.0")
+  s.add_dependency('merb-auth-more', ">= 1.0")
+  s.add_dependency('merb-mailer', ">= 1.0")
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README.textile Rakefile TODO) + Dir.glob("{lib,spec,app,public,stubs}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install the gem"
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+desc 'Default: run spec examples'
+task :default => 'spec'

data/app/controllers/activations.rb

@@ -0,0 +1,24 @@
+class MerbAuthSliceActivation::Activations <  MerbAuthSliceActivation::Application
+
+  after :redirect_after_activation
+
+  # Activate a user from the submitted activation code.
+  #
+  # ==== Returns
+  # String:: Empty string.
+  def activate
+    session.user = Merb::Authentication.user_class.find_with_activation_code(params[:activation_code])
+    raise NotFound if session.user.nil?
+    if session.authenticated? && !session.user.activated?
+      session.user.activate!
+    end
+    ""
+  end
+
+  private
+
+  def redirect_after_activation
+    redirect "/", :message => {:notice => "Activation Successful"}
+  end
+
+end # MerbAuthSliceActivation::Activations

data/app/controllers/application.rb

@@ -0,0 +1,5 @@
+class MerbAuthSliceActivation::Application < Merb::Controller
+  
+  controller_for_slice
+  
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,64 @@
+module Merb
+  module MerbAuthSliceActivation
+    module ApplicationHelper
+      
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def image_path(*segments)
+        public_path_for(:image, *segments)
+      end
+      
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def javascript_path(*segments)
+        public_path_for(:javascript, *segments)
+      end
+      
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def stylesheet_path(*segments)
+        public_path_for(:stylesheet, *segments)
+      end
+      
+      # Construct a path relative to the public directory
+      # 
+      # @param <Symbol> The type of component.
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def public_path_for(type, *segments)
+        ::MerbAuthSliceActivation.public_path_for(type, *segments)
+      end
+      
+      # Construct an app-level path.
+      # 
+      # @param <Symbol> The type of component.
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path within the host application, with added segments.
+      def app_path_for(type, *segments)
+        ::MerbAuthSliceActivation.app_path_for(type, *segments)
+      end
+      
+      # Construct a slice-level path.
+      # 
+      # @param <Symbol> The type of component.
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path within the slice source (Gem), with added segments.
+      def slice_path_for(type, *segments)
+        ::MerbAuthSliceActivation.slice_path_for(type, *segments)
+      end
+      
+    end
+  end
+end

data/app/helpers/mailer_helper.rb

@@ -0,0 +1,29 @@
+module Merb
+  module MerbAuthSliceActivation
+    module MailerHelper
+
+      # Does it's best to
+      def activation_url(user)
+        @activation_host      ||= MaSA[:activation_host] || MaSA[:default_activation_host]
+        @activation_protocol  ||= MaSA[:activation_protocol] || "http"
+
+        if base_controller # Rendering from a web controller
+          @activation_host      ||= base_controller.request.host
+          @activation_protocol  ||= "http"
+        end
+
+        @activation_host ||= case @activation_host
+        when Proc
+          @activation_host.call(user)
+        when String
+          @activation_host
+        end
+
+        raise  "There is no host set for the activation email. Set Merb::Slices::config[:merb_auth_slice_activation][:activation_host]" unless @activation_host
+
+        "#{@activation_protocol}://#{@activation_host}#{slice_url(:activate, :activation_code => user.activation_code)}"
+      end
+
+    end # MailerHelper
+  end # MerbAuthSliceActivation
+end # Merb

data/app/mailers/activation_mailer.rb

@@ -0,0 +1,18 @@
+class MerbAuthSliceActivation::ActivationMailer < Merb::MailController
+  include Merb::MerbAuthSliceActivation::MailerHelper
+  
+  controller_for_slice MerbAuthSliceActivation, :templates_for => :mailer, :path => "views"
+
+  def signup
+    @user = params[:user]
+    Merb.logger.info "Sending Signup to #{@user.email} with code #{@user.activation_code}"
+    render_mail :layout => nil
+  end
+
+  def activation
+    @user = params[:user]
+    Merb.logger.info "Sending Activation email to #{@user.email}"
+    render_mail :layout => nil
+  end
+
+end

data/app/mailers/views/activation_mailer/activation.text.erb

@@ -0,0 +1 @@
+Your email has been authenticated <%= @user.email %>

data/app/mailers/views/activation_mailer/signup.text.erb

@@ -0,0 +1,7 @@
+Your account has been created.
+
+  Username: <%= @user.login %>
+
+Visit this url to activate your account:
+
+  <%= activation_url(@user) %>

data/app/views/layout/merb_auth_slice_activation.html.erb

@@ -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 MerbAuthSliceActivation 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-activation/app/views/layout/merb-auth-slice-activation.html.erb -->
+  <body class="merb-auth-slice-activation-slice">
+  <div id="container">
+	  <h1>MerbAuthSliceActivation Slice</h1>
+    <div id="main"><%= catch_content :for_layout %></div>
+  </div>
+  </body>
+</html>

data/config/init.rb

@@ -0,0 +1,84 @@
+#
+# ==== Standalone MerbAuthSliceActivation 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 'merb-auth-core'
+# require File.join(File.expand_path(File.dirname(__FILE__)), "..", "lib", "merb-auth-slice-activation", "mixins", "activated_user")
+
+require(File.join(File.expand_path(File.dirname(__FILE__)),"..","lib","merb-auth-slice-activation"))
+
+# Setup the required configuration for the slice
+Merb::Slices::config[:merb_auth_slice_activation][:from_email]        = "homer@example.com"
+Merb::Slices::config[:merb_auth_slice_activation][:activation_host]   = "example.com"
+
+
+Merb::BootLoader.before_app_loads do
+  
+  DataMapper.setup(:default, "sqlite3::memory:")
+  class User
+    include DataMapper::Resource
+    include Merb::Authentication::Mixins::ActivatedUser
+
+    property :id,    Serial
+    property :email, String
+    property :login, String
+
+  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
+
+# puts Merb::Authentication.respond_to?(:user_class)
+# Merb::Authentication.user_class = User
+
+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]  = '72c5184af853f00f83d84adb562c56f3f1248d89'
+  
+  # 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] = 'memory'
+  
+  # When running a slice standalone, you're usually developing it,
+  # so enable template reloading by default.
+  c[:reload_templates] = true
+  
+end