jsmestad-merb-auth-slice-activation 1.0.0

data/lib/merb-auth-slice-activation.rb

@@ -0,0 +1,91 @@
+if defined?(Merb::Plugins)
+
+  $:.unshift File.dirname(__FILE__)
+
+  load_dependency 'merb-slices'
+  load_dependency 'merb-auth-core'
+  load_dependency 'merb-auth-more'
+  load_dependency 'merb-mailer'
+  require(File.expand_path(File.dirname(__FILE__) / "merb-auth-slice-activation" / "mixins") / "activated_user")
+  
+  Merb::Plugins.add_rakefiles "merb-auth-slice-activation/merbtasks", "merb-auth-slice-activation/slicetasks", "merb-auth-slice-activation/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-activation
+  # :mirror - which path component types to use on copy operations; defaults to all
+  Merb::Slices::config[:merb_auth_slice_activation][:layout] ||= :application
+
+  # All Slice code is expected to be namespaced inside a module
+  module MerbAuthSliceActivation
+
+    # Slice metadata
+    self.description = "MerbAuthSliceActivation is a merb slice that adds basic activation for merb-auth-based merb applications."
+    self.version = "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
+      # Actually check if the user is active 
+      ::Merb::Authentication.after_authentication do |user, *rest|
+        if user.respond_to?(:active?)
+          user.active? ? user : nil
+        else 
+          user
+        end
+      end
+    end
+
+    # Activation hook - runs after AfterAppLoads BootLoader
+    def self.activate
+    end
+
+    # Deactivation hook - triggered by Merb::Slices.deactivate(MerbAuthSliceActivation)
+    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_activation_
+    #   to avoid potential conflicts with global named routes.
+    def self.setup_router(scope)
+      scope.match("/activate/:activation_code").to(:controller => "activations", :action => "activate").name(:activate)
+    end
+
+  end
+
+  # Setup the slice layout for MerbAuthSliceActivation
+  #
+  # Use MerbAuthSliceActivation.push_path and MerbAuthSliceActivation.push_app_path
+  # to set paths to merb-auth-slice-activation-level and app-level paths. Example:
+  #
+  # MerbAuthSliceActivation.push_path(:application, MerbAuthSliceActivation.root)
+  # MerbAuthSliceActivation.push_app_path(:application, Merb.root / 'slices' / 'merb-auth-slice-activation')
+  # ...
+  #
+  # Any component path that hasn't been set will default to MerbAuthSliceActivation.root
+  #
+  # Or just call setup_default_structure! to setup a basic Merb MVC structure.
+  MerbAuthSliceActivation.setup_default_structure!
+  MaSA = MerbAuthSliceActivation unless defined?(MaSA)
+
+  # Add dependencies for other MerbAuthSliceActivation classes below. Example:
+  # dependency "merb-auth-slice-activation/other"
+
+end

data/lib/merb-auth-slice-activation/merbtasks.rb

@@ -0,0 +1,112 @@
+namespace :slices do
+  namespace :merb_auth_slice_activation do
+
+    desc "Install MerbAuthSliceActivation"
+    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"
+      MerbAuthSliceActivation.mirrored_components.each do |type|
+        if File.directory?(MerbAuthSliceActivation.dir_for(type))
+          if !File.directory?(dst_path = MerbAuthSliceActivation.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 MerbAuthSliceActivation - resolves any collisions"
+      copied, preserved = MerbAuthSliceActivation.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 MerbAuthSliceActivation - resolves any collisions"
+      copied, preserved = MerbAuthSliceActivation.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 MerbAuthSliceActivation into your app (only merb-auth-slice-activation/app)"
+    task :freeze => [ "freeze:app" ]
+
+    namespace :freeze do
+
+      desc "Freezes MerbAuthSliceActivation by installing the gem into application/gems"
+      task :gem do
+        ENV["GEM"] ||= "merb-auth-slice-activation"
+        Rake::Task['slices:install_as_gem'].invoke
+      end
+
+      desc "Freezes MerbAuthSliceActivation by copying all files from merb-auth-slice-activation/app to your application"
+      task :app do
+        puts "Copying all merb-auth-slice-activation/app files to your application - resolves any collisions"
+        copied, preserved = MerbAuthSliceActivation.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 = MerbAuthSliceActivation.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 = MerbAuthSliceActivation.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 = MerbAuthSliceActivation.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 MerbAuthSliceActivation as a gem and copies over merb-auth-slice-activation/app"
+      task :app_with_gem => [:gem, :app]
+
+      desc "Freezes MerbAuthSliceActivation by unpacking all files into your application"
+      task :unpack do
+        puts "Unpacking MerbAuthSliceActivation files to your application - resolves any collisions"
+        copied, preserved = MerbAuthSliceActivation.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-activation/mixins/activated_user.rb

@@ -0,0 +1,118 @@
+module Merb
+  class Authentication
+    module Mixins
+      # This mixin provides basic user activation.
+      #
+      # Added properties:
+      #  :activated_at,    DateTime
+      #  :activation_code, String
+      #
+      # To use it simply require it and include it into your user class.
+      #
+      # class User
+      #   include Authentication::Mixins::ActivatedUser
+      #
+      # end
+      #
+      module ActivatedUser
+        def self.included(base)
+          base.class_eval do
+            include Merb::Authentication::Mixins::ActivatedUser::InstanceMethods
+            extend  Merb::Authentication::Mixins::ActivatedUser::ClassMethods
+
+            path = File.expand_path(File.dirname(__FILE__)) / "activated_user"
+            if defined?(DataMapper) && DataMapper::Resource > self
+              require path / "dm_activated_user"
+              extend(Merb::Authentication::Mixins::ActivatedUser::DMClassMethods)
+            elsif defined?(ActiveRecord) && ancestors.include?(ActiveRecord::Base)
+              require path / "ar_activated_user"
+              extend(Merb::Authentication::Mixins::ActivatedUser::ARClassMethods)
+            elsif defined?(Sequel) && ancestors.include?(Sequel::Model)
+              require path / "sq_activated_user"
+              extend(Merb::Authentication::Mixins::ActivatedUser::SQClassMethods)
+            end
+
+          end # base.class_eval
+        end # self.included
+
+
+        module ClassMethods
+          # Create random key.
+          #
+          # ==== Returns
+          # String:: The generated key
+          def make_key
+            Digest::SHA1.hexdigest( Time.now.to_s.split(//).sort_by {rand}.join )
+          end
+        end # ClassMethods
+
+        module InstanceMethods
+
+          # Activates and saves the user.
+          def activate!
+            self.reload unless self.new_record? # Make sure the model is up to speed before we try to save it
+            set_activated_data!
+            self.save
+
+            # send mail for activation
+            send_activation_notification
+          end
+
+          # Checks if the user has just been activated. Where 'just' means within the current request.
+          # Note that a user can be activate, but the method returns +false+!
+          #
+          # ==== Returns
+          # Boolean:: +true+ is the user has been activated, otherwise +false+.
+          def recently_activated?
+            @activated
+          end
+
+          # Checks to see if a user is active
+          def active?
+            return false if self.new_record?
+            !! activation_code.nil?
+          end
+
+          alias_method :activated?, :active?
+
+          # Creates and sets the activation code for the user.
+          #
+          # ==== Returns
+          # String:: The activation code.
+          def make_activation_code
+            self.activation_code = self.class.make_key
+          end
+
+          # Sends out the activation notification.
+          # Used 'Welcome' as subject if +MaSA[:activation_subject]+ is not set.
+          def send_activation_notification
+            deliver_activation_email(:activation, :subject => (MaSA[:welcome_subject] || "Welcome" ))
+          end
+
+          # Sends out the signup notification.
+          # Used 'Please Activate Your Account' as subject if +MaSA[:activation_subject]+ is not set.
+          def send_signup_notification
+            deliver_activation_email(:signup, :subject => (MaSA[:activation_subject] || "Please Activate Your Account") )
+          end
+
+          private
+
+          # Helper method delivering the email.
+          def deliver_activation_email(action, params)
+            from = MaSA[:from_email]
+            raise "No :from_email option set for Merb::Slices::config[:merb_auth_slice_activation][:from_email]" unless from
+            MaSA::ActivationMailer.dispatch_and_deliver(action, params.merge(:from => from, :to => self.email), :user => self)
+          end
+
+          def set_activated_data!
+            @activated = true
+            self.activated_at = DateTime.now
+            self.activation_code = nil
+            true
+          end
+
+        end # InstanceMethods
+      end # ActivatedUser
+    end # Mixins
+  end # Authentication
+end # Merb

data/lib/merb-auth-slice-activation/mixins/activated_user/ar_activated_user.rb

@@ -0,0 +1,21 @@
+module Merb
+  class Authentication
+    module Mixins
+      module ActivatedUser
+        module ARClassMethods
+          def self.extended(base)
+            base.class_eval do
+              before :create, :make_activation_code
+              after  :create, :send_signup_notification
+            end # base.class_eval
+          
+            def find_with_activation_code(ac)
+              find(:first, :conditions => ["activation_code =?", ac])
+            end
+          
+          end # self.extended
+        end # ARClassMethods
+      end # ActivatedUser
+    end # Mixins
+  end # Authentication
+end # Merb

data/lib/merb-auth-slice-activation/mixins/activated_user/dm_activated_user.rb

@@ -0,0 +1,24 @@
+module Merb
+  class Authentication
+    module Mixins
+      module ActivatedUser
+        module DMClassMethods
+          def self.extended(base)
+            base.class_eval do
+              property :activated_at,    DateTime
+              property :activation_code, String
+
+              before :create, :make_activation_code
+              after  :create, :send_signup_notification
+            end # base.class_eval
+          
+            def find_with_activation_code(ac)
+              first(:activation_code => ac)
+            end
+          
+          end # self.extended
+        end # DMClassMethods
+      end # ActivatedUser
+    end # Mixins
+  end # Authentication
+end #Merb

data/lib/merb-auth-slice-activation/mixins/activated_user/sq_activated_user.rb

@@ -0,0 +1,23 @@
+module Merb
+  class Authentication
+    module Mixins
+      module ActivatedUser
+        module SQClassMethods
+          def self.extended(base)
+            base.class_eval do
+              before_save :make_activation_code
+              after_save  :send_signup_notification
+            end # base.class_eval
+          
+            def find_with_activation_code(ac)
+              self[:activation_code => ac]
+            end
+          end # self.extended
+        end # SQClassMethods
+        module SQInstanceMethods
+        end # SQInstanceMethods
+      
+      end # ActivatedUser
+    end # Mixins
+  end # Authentication
+end # Merb

data/lib/merb-auth-slice-activation/slicetasks.rb

@@ -0,0 +1,18 @@
+namespace :slices do
+  namespace :merb_auth_slice_activation do
+
+    # add your own merb-auth-slice-activation tasks here
+
+    # implement this to test for structural/code dependencies
+    # like certain directories or availability of other files
+    desc "Test for any dependencies"
+    task :preflight do
+    end
+
+    # implement this to perform any database related setup steps
+    desc "Migrate the database"
+    task :migrate do
+    end
+
+  end
+end

data/lib/merb-auth-slice-activation/spectasks.rb

@@ -0,0 +1,75 @@
+namespace :slices do
+  namespace :merb_auth_slice_activation do
+
+    desc "Run slice specs within the host application context"
+    task :spec => [ "spec:explain", "spec:default" ]
+
+    namespace :spec do
+
+      slice_root = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+
+      task :explain do
+        puts "\nNote: By running MerbAuthSliceActivation specs inside the application context any\n" +
+        "overrides could break existing specs. This isn't always a problem,\n" +
+        "especially in the case of views. Use these spec tasks to check how\n" +
+        "well your application conforms to the original slice implementation."
+      end
+
+      Spec::Rake::SpecTask.new('default') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        t.spec_files = Dir["#{slice_root}/spec/**/*_spec.rb"].sort
+      end
+
+      desc "Run all model specs, run a spec for a specific Model with MODEL=MyModel"
+      Spec::Rake::SpecTask.new('model') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        if(ENV['MODEL'])
+          t.spec_files = Dir["#{slice_root}/spec/models/**/#{ENV['MODEL']}_spec.rb"].sort
+        else
+          t.spec_files = Dir["#{slice_root}/spec/models/**/*_spec.rb"].sort
+        end
+      end
+
+      desc "Run all controller specs, run a spec for a specific Controller with CONTROLLER=MyController"
+      Spec::Rake::SpecTask.new('controller') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        if(ENV['CONTROLLER'])
+          t.spec_files = Dir["#{slice_root}/spec/controllers/**/#{ENV['CONTROLLER']}_spec.rb"].sort
+        else
+          t.spec_files = Dir["#{slice_root}/spec/controllers/**/*_spec.rb"].sort
+        end
+      end
+
+      desc "Run all view specs, run specs for a specific controller (and view) with CONTROLLER=MyController (VIEW=MyView)"
+      Spec::Rake::SpecTask.new('view') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        if(ENV['CONTROLLER'] and ENV['VIEW'])
+          t.spec_files = Dir["#{slice_root}/spec/views/**/#{ENV['CONTROLLER']}/#{ENV['VIEW']}*_spec.rb"].sort
+        elsif(ENV['CONTROLLER'])
+          t.spec_files = Dir["#{slice_root}/spec/views/**/#{ENV['CONTROLLER']}/*_spec.rb"].sort
+        else
+          t.spec_files = Dir["#{slice_root}/spec/views/**/*_spec.rb"].sort
+        end
+      end
+
+      desc "Run all mailer specs, run a spec for a specific Mailer with MAILER=MyMailer"
+      Spec::Rake::SpecTask.new('mailer') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        if(ENV['MAILER'])
+          t.spec_files = Dir["#{slice_root}/spec/mailer/**/#{ENV['MAILER']}_spec.rb"].sort
+        else
+          t.spec_files = Dir["#{slice_root}/spec/mailers/**/*_spec.rb"].sort
+        end
+      end
+
+      desc "Run all specs and output the result in html"
+      Spec::Rake::SpecTask.new('html') do |t|
+        t.spec_opts = ["--format", "html"]
+        t.libs = ['lib', 'server/lib' ]
+        t.spec_files = Dir["#{slice_root}/spec/**/*_spec.rb"].sort
+      end
+
+    end
+
+  end
+end