auth-slice 0.1.0

data/app/models/adapter/datamapper.rb

@@ -0,0 +1,80 @@
+require 'dm-validations'
+require 'dm-timestamps'
+require 'dm-aggregates'
+
+module AuthSlice
+  module Adapter
+    module Datamapper
+      def self.create_user_model
+        Object.class_eval <<-end_eval
+          class ::AuthSlice::User
+            include AuthSlice::Adapter::Datamapper
+          end
+        end_eval
+      end
+      
+      def self.included(base)
+        base.class_eval do
+          include ::DataMapper::Resource
+          include AuthSlice::BaseModel
+          extend ClassMethods
+          
+          storage_names[:default] = 'users'
+          
+          property :id, Integer, :serial => true
+          property :name, String, :length => 3..40, :nullable => false
+          property :username, String, :length => 3..40, :nullable => false
+          property :email, String, :format => :email_address, :nullable => false
+          property :crypted_password, String, :length => 40
+          property :salt, String, :length => 40
+          property :remember_token_expires_at, Date
+          property :remember_token, String
+          property :created_at, DateTime
+          property :updated_at, DateTime
+  
+          validates_is_unique :username, :email
+          validates_length :password, :in => 4..40, :if => :password_required?
+          validates_is_confirmed :password, :groups => :create
+
+          before :save, :encrypt_password
+          
+          def username=(value)
+            attribute_set(:username, value.downcase) if value
+          end
+        end
+      end
+      
+      module ClassMethods
+        def create_db_table
+          self.auto_migrate!
+        end
+        
+        def drop_db_table
+          self.repository do |r|
+            r.adapter.destroy_model_storage(r, self)
+          end
+        end
+        
+        def find_by_id(id)
+          AuthSlice::User.first(:id => id)
+        end
+
+        def find_by_remember_token(rt)
+          AuthSlice::User.first(:remember_token => rt)
+        end
+
+        def find_by_username(username)
+          if AuthSlice::User.properties[:activated_at]
+            AuthSlice::User.first(:username => username, :activated_at.not => nil)
+          else
+            AuthSlice::User.first(:username => username)
+          end
+        end
+
+        def find_by_activiation_code(activation_code)
+          AuthSlice::User.first(:activation_code => activation_code)
+        end
+      end
+    end
+  end
+end

data/app/models/base_model.rb

@@ -0,0 +1,76 @@
+require 'digest/sha1'
+
+module AuthSlice
+  module BaseModel
+    def self.included(base)
+      base.send(:include, InstanceMethods)
+      base.send(:extend,  ClassMethods)
+      
+      base.class_eval do
+        attr_accessor :password, :password_confirmation
+      end
+    end
+    
+    module InstanceMethods
+      def authenticated?(password)
+        crypted_password == encrypt(password)
+      end      
+
+      # before filter 
+      def encrypt_password
+        return if password.blank?
+        self.salt = Digest::SHA1.hexdigest("--#{Time.now.to_s}--#{username}--") if new_record?
+        self.crypted_password = encrypt(password)
+      end
+      
+      # Encrypts the password with the user salt
+      def encrypt(password)
+        self.class.encrypt(password, salt)
+      end
+      
+      def remember_token?
+        remember_token_expires_at && Date.today < remember_token_expires_at
+      end
+
+      def remember_me_until(time)
+        self.remember_token_expires_at = time
+        self.remember_token            = encrypt("#{email}--#{remember_token_expires_at}")
+        save
+      end
+
+      def remember_me_for(days)
+        remember_me_until (Date.today + days)
+      end
+
+      # These create and unset the fields required for remembering users between browser closes
+      # Default of 2 weeks 
+      def remember_me
+        remember_me_for(14)
+      end
+
+      def forget_me
+        self.remember_token_expires_at = nil
+        self.remember_token            = nil
+        self.save
+      end
+      
+      protected
+        def password_required?
+          crypted_password.blank? || !password.blank?
+        end      
+    end
+    
+    module ClassMethods
+      # Encrypts some data with the salt.
+      def encrypt(password, salt)
+        Digest::SHA1.hexdigest("--#{salt}--#{password}--")
+      end
+      
+      # Authenticates a user by their username and unencrypted password.  Returns the user or nil.
+      def authenticate(username, password)
+        u = find_by_username(username) # need to get the salt
+        u && u.authenticated?(password) ? u : nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+<!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>
+    <title>Auth::Slice Sample Layout</title>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+    <link rel="stylesheet" type="text/css" href="http://yui.yahooapis.com/2.5.1/build/reset-fonts-grids/reset-fonts-grids.css"> 
+    <link rel="stylesheet" type="text/css" href="http://yui.yahooapis.com/2.5.1/build/base/base-min.css"> 
+    <link href="<%= public_path_for :stylesheet, 'master.css' %>" type="text/css" charset="utf-8" rel="stylesheet" media="all"/>    
+    <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.2.6/jquery.min.js"></script>
+    <script type="text/javascript">
+      (function($) {
+        $(document).ready(function() {
+          $(":text:visible:enabled:first").focus(); 
+        });
+      })(jQuery);
+    </script>
+  </head>
+  <body>
+    <div id="container">
+      <div id="header-container">
+        <span style="float:right;margin-right:50px">
+        <% if logged_in? %>
+          Welcome <%= current_user.name %>
+          | <a href="<%= url(:logout) %>">Sign out</a>
+        <% else %>
+          <a href="<%= url(:signup) %>">Join now</a>
+          | <a href="<%= url(:login) %>">Sign in</a>
+        <% end %>
+        </span>
+        <h1>Sample AuthSlice App</h1>
+        <hr />
+      </div>
+
+      <div id="main-container">
+        <%= catch_content :for_layout %>
+      </div>
+
+      <hr />
+      
+      <div id="footer-container">
+        <div class="left"><%= __FILE__ %></div>
+        <div class="right">&copy; 2008 PragmaQuest Inc.  All rights reserved.</div>
+      </div>
+    </div>
+  </body>
+</html>
+

data/app/views/users/login.html.erb

@@ -0,0 +1,31 @@
+
+<div>
+  <div class="form_description">
+  	<h2>Member sign in</h2>
+  </div>
+
+  <form action="<%= url(:login) %>" method="post">
+    <% if request.post? -%>
+    <div class="error">
+      <h2>Incorrect username and password</h2>
+    </div>
+    <% end -%>
+    
+    <p><label for="username">Username or e-mail</label>
+    <input type="text" name="username" value="<%= params[:username] %>"/></p>
+
+    <p><label for="password">Password</label>
+    <input type="password" name="password"/></p>
+
+    <p><input type="checkbox" name='remember_me' id='remember_me'/>
+      <label id='remember_me_lb' for="remember_me">Keep me signed in</label></p>
+
+    <p><input type="submit" value="Sign in"/> <span style="margin-left:20px"><a href="#">Forgot password?</a></span></p>
+  </form>
+  
+  <form action="#" method="post" style="display:none">
+    <p><label for="openid_url">OpenID</label>
+    <input type="text" value="" size="40" id="openid_url" name="openid_url"/>  <small>(e.g. http://username.myopenid.com)</small>
+    </p>
+  </form>
+</div>

data/app/views/users/signup.html.erb

@@ -0,0 +1,29 @@
+
+<div>
+  <div class="form_description">
+  	<h2>Sign up here (it's absolutely free)</h2>
+  </div>
+
+  <% form_for @user, :action => url(:signup) do %>
+    <%= error_messages_for :user, lambda{|err| "<li>#{err.join('<br/>')}</li>"} %>
+
+    <p>
+      <%= text_control :name, :label => "Name" %>
+    </p>
+    <p>
+      <%= text_control :username, :label => "Username" %>
+    </p>
+    <p>
+      <%= text_control :email, :label => "E-mail" %>
+    </p>
+    <p>
+      <%= password_control :password, :label => "Password" %>
+    </p>
+    <p>
+      <%= password_control :password_confirmation, :label => "Password Confirmation" %>
+    </p>
+    <p>
+      <%= submit_button "Sign up" %> <span style="margin-left:20px">Already a member?  <a href="<%= url(:login) %>">Sign in here</a></span>
+    </p>
+  <% end %>
+</div>

data/lib/auth-slice.rb

@@ -0,0 +1,63 @@
+if defined?(Merb::Plugins)
+
+  require 'merb-slices'
+  require 'merb_helpers'
+  require File.join(File.dirname(__FILE__), 'auth-slice', 'model')
+
+  Merb::Plugins.add_rakefiles "auth-slice/merbtasks"
+
+  # 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.
+  Merb::Slices::config[:auth_slice] = { :layout => :auth_slice }  
+  
+  # All Slice code is expected to be namespaced inside a module
+  module AuthSlice
+    # Slice metadata
+    self.description = "AuthSlice is an user authentication Merb slice!"
+    self.version = "0.1.0"
+    self.author = "ctran@pragmaquest.com"
+    
+    # Initialization hook - runs before AfterAppLoads BootLoader
+    def self.init
+    end
+    
+    # Activation hook - runs after AfterAppLoads BootLoader
+    def self.activate
+      AuthSlice.use_adapter(Merb.orm_generator_scope) if Merb.orm_generator_scope != :merb_default
+      Object.const_set(Merb::Slices::config[:auth_slice][:user_model_class], AuthSlice::User) if Merb::Slices::config[:auth_slice][:user_model_class]
+    end
+    
+    # Deactivation hook - triggered by Merb::Slices#deactivate
+    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.
+    def self.setup_router(scope)
+      scope.match('/login').to(:controller => 'users', :action => 'login').name(:login)
+      scope.match('/logout').to(:controller => 'users', :action => 'logout').name(:logout)
+      scope.match('/signup').to(:controller => 'users', :action => 'signup').name(:signup)
+    end
+  end
+  
+  # Setup the slice layout for AuthSlice
+  #
+  # Use AuthSlice.push_path and AuthSlice.push_app_path
+  # to set paths to auth-slice-level and app-level paths. Example:
+  #
+  # AuthSlice.push_path(:application, AuthSlice.root)
+  # AuthSlice.push_app_path(:application, Merb.root / 'slices' / 'auth-slice')
+  # ...
+  #
+  # Any component path that hasn't been set will default to AuthSlice.root
+  #
+  # Or just call setup_default_structure! to setup a basic Merb MVC structure.
+  AuthSlice.setup_default_structure!
+end

data/lib/auth-slice/merbtasks.rb

@@ -0,0 +1,110 @@
+$SLICED_APP=true # we're running inside the host application context
+
+namespace :slices do
+  namespace :auth_slice do
+  
+    desc "Install AuthSlice"
+    task :install => [:preflight, :setup_directories, :copy_assets, :migrate]
+    
+    desc "Test for any dependencies"
+    task :preflight do
+      # implement this to test for structural/code dependencies
+      # like certain directories or availability of other files
+    end
+  
+    desc "Setup directories"
+    task :setup_directories do
+      puts "Creating directories for host application"
+      [:application, :view, :model, :controller, :helper, :mailer, :part, :public].each do |type|
+        if File.directory?(AuthSlice.dir_for(type))
+          if !File.directory?(dst_path = AuthSlice.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 public assets to host application"
+    task :copy_assets do
+      puts "Copying assets for AuthSlice - do not edit these as the will be overwritten!"
+      [:image, :javascript, :stylesheet].each do |type|
+        src_path = AuthSlice.dir_for(type)
+        dst_path = AuthSlice.app_dir_for(type)
+        Dir[src_path / '**/*'].each do |file|
+          relative_path = file.relative_path_from(src_path)
+          puts "- installing :#{type} #{relative_path}"
+          mkdir_p(dst_path / File.dirname(relative_path))
+          copy_entry(file, dst_path / relative_path, false, false, true)
+        end
+      end
+    end
+    
+    desc "Migrate the database"
+    task :migrate do
+      AuthSlice::User.create_db_table
+    end
+    
+    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 AuthSlice 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 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

data/lib/auth-slice/model.rb

@@ -0,0 +1,6 @@
+module AuthSlice
+  def self.use_adapter(adapter)
+    adapter_impl = Object.full_const_get("AuthSlice::Adapter::#{adapter.to_s.to_const_string}")
+    adapter_impl.create_user_model
+  end
+end