scottmotte-merb_auth_slice_multisite 0.3.2 → 0.6.0

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
-:minor: 3
-:patch: 2
+:minor: 6
+:patch: 0

data/app/controllers/exceptions.rb

@@ -0,0 +1,33 @@
+# the mixin to provide the exceptions controller action for Unauthenticated
+module MerbAuthSliceMultisite::ExceptionsMixin
+  def unauthenticated
+    provides :xml, :js, :json, :yaml
+
+    case content_type
+    when :html
+      render
+    else
+      basic_authentication.request!
+      ""
+    end
+  end # unauthenticated
+end
+
+Merb::Authentication.customize_default do
+  
+  Exceptions.class_eval do
+    include Merb::Slices::Support # Required to provide slice_url
+  
+    # # This stuff allows us to provide a default view
+    the_view_path = File.expand_path(File.dirname(__FILE__) / ".." / "views")
+    self._template_roots ||= []
+    self._template_roots << [the_view_path, :_template_location]
+    self._template_roots << [Merb.dir_for(:view), :_template_location]
+    
+    include MerbAuthSliceMultisite::ExceptionsMixin
+    
+    show_action :unauthenticated
+
+  end# Exceptions.class_eval
+  
+end # Customize default

data/app/controllers/sessions.rb

@@ -0,0 +1,55 @@
+class MerbAuthSliceMultisite::Sessions < MerbAuthSliceMultisite::Application
+  
+  before :_maintain_auth_session_before, :exclude => [:destroy]  # Need to hang onto the redirection during the session.abandon!
+  before :_abandon_session,     :only => [:update, :destroy]
+  before  :_maintain_auth_session_after,  :exclude => [:destroy]  # Need to hang onto the redirection during the session.abandon!
+  before :ensure_authenticated, :only => [:update]
+
+  # redirect from an after filter for max flexibility
+  # We can then put it into a slice and ppl can easily 
+  # customize the action
+  after :redirect_after_login,  :only => :update, :if => lambda{ !(300..399).include?(status) }
+  after :redirect_after_logout, :only => :destroy
+  
+  def update
+    "Add an after filter to do stuff after login"
+  end
+
+  def destroy
+    "Add an after filter to do stuff after logout"
+  end
+  
+  
+  private   
+  # @overwritable
+  def redirect_after_login
+    message[:notice] = "Authenticated Successfully"
+    redirect_back_or "/", :message => message, :ignore => [slice_url(:login), slice_url(:logout)]
+  end
+  
+  # @overwritable
+  def redirect_after_logout
+    message[:notice] = "Logged Out"
+    redirect "/", :message => message
+  end  
+
+  # @private
+  def _maintain_auth_session_before
+    @_maintain_auth_session = {}
+    Merb::Authentication.maintain_session_keys.each do |k|
+      @_maintain_auth_session[k] = session[k]
+    end
+  end
+  
+  # @private
+  def _maintain_auth_session_after
+    @_maintain_auth_session.each do |k,v|
+      session[k] = v
+    end
+  end
+  
+  # @private
+  def _abandon_session
+    session.abandon!
+  end
+end

data/app/views/exceptions/unauthenticated.html.erb

@@ -0,0 +1,29 @@
+<h3>Login</h3>
+
+<div>
+
+  <%= error_messages_for session.authentication %>
+  <% @login_param = Merb::Authentication::Strategies::Multisite::Base.login_param %>
+  <% @password_param = Merb::Authentication::Strategies::Multisite::Base.password_param %>
+	<% @site_id_param = Merb::Authentication::Strategies::Multisite::Base.site_id_param %>
+	<% 
+	# make @current_site value. application.rb does not get call 
+	# because the authentication is protected at the rack level - which is better, 
+	# but it means I have to add the following duplicate line of code as far as I know.
+	@current_site = Site.first(:subdomain => request.first_subdomain)
+	%>
+  
+	<form action="<%= slice_url(:merb_auth_slice_multisite, :perform_login) %>" method="POST" accept-charset="utf-8">
+		<input type="hidden" name="<%= @site_id_param.to_s %>" value="<%= @current_site.id %>" id="<%= @site_id_param.to_s %>">
+	  <input type="hidden" name="_method" value="PUT" />
+	  <div class="formRow">
+	    <label><%= @login_param.to_s.capitalize %>: <input type="text" name="<%= @login_param.to_s %>" value="" id="<%= @login_param.to_s %>"></label>
+	  </div> <!-- close: formRow -->
+	  <div class="formRow">
+	    <label><%= @password_param.to_s.capitalize %>:<input type="password" name="<%= @password_param.to_s %>" value="" id="<%= @password_param.to_s %>"></label>
+	  </div> <!-- close: formRow -->
+	  <div class="formRow">
+	    <input type="submit" name="Submit" value="Log In" id="Submit">
+	  </div> <!-- close: formRow -->
+	</form>
+</div>

data/config/dependencies.rb

@@ -1,6 +1,6 @@
 # dependencies are generated using a strict version, don't forget to edit the dependency versions when upgrading.
-merb_gems_version = "1.0.10"
-dm_gems_version   = "0.9.10"
+merb_gems_version = "1.0.11"
+dm_gems_version   = "0.9.11"
 do_gems_version   = "0.9.11"
 
 # For more information about each component, please read http://wiki.merbivore.com/faqs/merb_components

data/lib/merb-auth-more/strategies/multisite/multisite_password_form.rb

@@ -0,0 +1,88 @@
+require 'merb-auth-more/strategies/abstract_password'
+# This strategy uses a login, password, and site_id parameter.
+#
+# Overwrite the :password_param, :login_param, and :site_id_param
+# to return the name of the field (on the form) that you're using the 
+# login with.  These can be strings or symbols
+#
+# == Required
+#
+# === Methods
+# <User>.authenticate(login_param, password_param)
+#
+class Merb::Authentication
+  module Strategies
+    module Multisite
+      
+      # add site_id to base params.
+      # http://github.com/wycats/merb/blob/784ac7d71780d1a7cfb9152ba4cb0e
+      # 18a990ab7a/merb-auth/merb-auth-more/lib/merb-auth-more/
+      # strategies/abstract_password.rb
+      class Base < Merb::Authentication::Strategy
+        abstract!
+        
+        # Overwrite this method to customize the field
+        def self.password_param
+          (Merb::Plugins.config[:"merb-auth"][:password_param] || :password).to_s.to_sym
+        end
+        
+        # Overwrite this method to customize the field
+        def self.login_param
+          (Merb::Plugins.config[:"merb-auth"][:login_param] || :login).to_s.to_sym
+        end
+        
+        # http://scottmotte.com/archives/194.html
+        def self.site_id_param
+          (Merb::Plugins.config[:"merb-auth"][:site_id_param] || :site_id).to_s.to_sym
+        end
+                
+        def password_param
+          @password_param ||= Base.password_param
+        end
+        
+        def login_param
+          @login_param ||= Base.login_param
+        end
+        
+        # http://scottmotte.com/archives/194.html
+        def site_id_param
+          @site_id_param ||= Base.site_id_param
+        end
+      end
+      
+      # custom strategy taking into account site_id and authenticating with it
+      # the authenticate method is already well defined so for now I made a muck of
+      # if/else statements
+      class Form < Base
+        
+        def run!
+          
+          if (login = request.params[login_param]) && (password = request.params[password_param]) && (site_id = request.params[site_id_param])
+            # see if user exists for the site_id
+            user = user_class.first(login_param => login, site_id_param => site_id)
+            if user
+              # user_class.get(:login)
+              user = user_class.authenticate(login, password)
+              if !user
+                errors = request.session.authentication.errors
+                errors.clear!
+                errors.add(login_param, strategy_error_message)
+              end
+              user
+            else
+              errors = request.session.authentication.errors
+              errors.clear!
+              errors.add(login_param, strategy_error_message)
+            end
+            user
+          end
+        end # run!
+        
+        def strategy_error_message
+          "#{login_param.to_s.capitalize} or #{password_param.to_s.capitalize} were incorrect"
+        end
+        
+      end # Form
+    end # Multisite Password
+  end # Strategies
+end # Authentication

data/lib/merb_auth_slice_multisite/merbtasks.rb

@@ -22,17 +22,17 @@ namespace :slices do
       end
     end
     
-    # desc "Copy stub files to host application"
-    # task :stubs do
-    #   puts "Copying stubs for MerbAuthSliceMultisite - resolves any collisions"
-    #   copied, preserved = MerbAuthSliceMultisite.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 to host application"
+    task :stubs do
+      puts "Copying stubs for MerbAuthSliceMultisite - resolves any collisions"
+      copied, preserved = MerbAuthSliceMultisite.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 stub files and views to host application"
+    task :patch => [ "stubs", "freeze:views" ]
   
     desc "Copy public assets to host application"
     task :copy_assets do
@@ -52,11 +52,11 @@ namespace :slices do
 
     namespace :freeze do
       
-      # desc "Freezes MerbAuthSliceMultisite by installing the gem into application/gems"
-      # task :gem do
-      #   ENV["GEM"] ||= "merb_auth_slice_multisite"
-      #   Rake::Task['slices:install_as_gem'].invoke
-      # end
+      desc "Freezes MerbAuthSliceMultisite by installing the gem into application/gems"
+      task :gem do
+        ENV["GEM"] ||= "merb_auth_slice_multisite"
+        Rake::Task['slices:install_as_gem'].invoke
+      end
       
       desc "Freezes MerbAuthSliceMultisite by copying all files from merb_auth_slice_multisite/app to your application"
       task :app do

data/lib/merb_auth_slice_multisite/mixins/user_belongs_to_site/dm_user_belongs_to_site.rb

@@ -9,8 +9,8 @@ module Merb
               property :site_id, Integer
               # Validations
               validates_present :site_id
-              validates_is_unique :login
-              validates_is_unique :email
+              validates_is_unique :login, :scope => :site_id
+              validates_is_unique :email, :scope => :site_id
               # Relationships/Associations
               belongs_to :site
             end # base.class_eval

data/lib/merb_auth_slice_multisite/slicetasks.rb

@@ -3,18 +3,16 @@ namespace :slices do
     
     # add your own merb_auth_slice_multisite tasks here
     
-    # # Uncomment the following lines and edit the pre defined tasks
-    #
-    # # 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
+    # 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_multisite.rb

@@ -12,6 +12,13 @@ if defined?(Merb::Plugins)
   # Register the Slice for the current host application
   Merb::Slices::register(__FILE__)
   
+  # Register the custom strategy so that this slice may utilize it
+  # from http://github.com/wycats/merb/blob/784ac7d71780d1a7cfb9152ba4cb0
+  # e18a990ab7a/merb-auth/merb-auth-more/lib/merb-auth-more.rb
+  basic_path = File.expand_path(File.dirname(__FILE__)) / "merb-auth-more" / "strategies" / "multisite"
+  
+  Merb::Authentication.register(:multisite_password_form, basic_path / "multisite_password_form.rb")
+  
   # 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.
@@ -36,22 +43,28 @@ if defined?(Merb::Plugins)
     
     # Initialization hook - runs before AfterAppLoads BootLoader
     def self.init
+      require 'merb-auth-more/mixins/redirect_back'      
+      unless MerbAuthSliceMultisite[:no_default_strategies]
+        ::Merb::Authentication.activate!(:default_password_form)
+      end
+      
       
-        # Actually check if the user belongs to the site 
-        ::Merb::Authentication.after_authentication do |user, request, params|
-          # clean this up somehow
-          if request.first_subdomain != nil
-            current_site = Site.first(:subdomain => request.first_subdomain)
-            if user.site_id != current_site.id
-              errors = request.session.authentication.errors
-              errors.clear!
-              errors.add("Label", "User does not belong to this site.")
-              nil
-            else
-              user
-            end
-          end
-        end
+        # from 0.3.2 version of merb_auth_slice_multisite
+        # # Actually check if the user belongs to the site 
+        # ::Merb::Authentication.after_authentication do |user, request, params|
+        #   # clean this up somehow
+        #   if request.first_subdomain != nil
+        #     current_site = Site.first(:subdomain => request.first_subdomain)
+        #     if user.site_id != current_site.id
+        #       errors = request.session.authentication.errors
+        #       errors.clear!
+        #       errors.add("Label", "User does not belong to this site.")
+        #       nil
+        #     else
+        #       user
+        #     end
+        #   end
+        # end
         
     end
     
@@ -73,12 +86,10 @@ if defined?(Merb::Plugins)
     # @note prefix your named routes with :merb_auth_slice_multisite_
     #   to avoid potential conflicts with global named routes.
     def self.setup_router(scope)
-      # # example of a named route
-      # scope.match('/index(.:format)').to(:controller => 'main', :action => 'index').name(:index)
-      # # the slice is mounted at /merb_auth_slice_multisite - note that it comes before default_routes
-      # scope.match('/').to(:controller => 'main', :action => 'index').name(:home)
-      # # enable slice-level default routes by default
-      # scope.default_routes
+      # example of a named route
+      scope.match("/login", :method => :get ).to(:controller => "/exceptions",  :action => "unauthenticated").name(:login)
+      scope.match("/login", :method => :put ).to(:controller => "sessions",     :action => "update"         ).name(:perform_login)
+      scope.match("/logout"                 ).to(:controller => "sessions",     :action => "destroy"        ).name(:logout)
     end
     
   end

data/stubs/app/controllers/sessions.rb

@@ -0,0 +1,19 @@
+class MerbAuthSliceMultisite::Sessions < MerbAuthSliceMultisite::Application
+
+  after :redirect_after_login,  :only => :update, :if => lambda{ !(300..399).include?(status) }
+  after :redirect_after_logout, :only => :destroy
+
+  private   
+  # @overwritable
+  def redirect_after_login
+    message[:notice] = "Authenticated Successfully"
+    redirect_back_or "/", :message => message, :ignore => [slice_url(:login), slice_url(:logout)]
+  end
+  
+  # @overwritable
+  def redirect_after_logout
+    message[:notice] = "Logged Out"
+    redirect "/", :message => message
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: scottmotte-merb_auth_slice_multisite
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.6.0
 platform: ruby
 authors: 
 - scottmotte
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-08 00:00:00 -07:00
+date: 2009-04-29 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -24,6 +24,10 @@ extra_rdoc_files: []
 files: 
 - README.textile
 - VERSION.yml
+- lib/merb-auth-more
+- lib/merb-auth-more/strategies
+- lib/merb-auth-more/strategies/multisite
+- lib/merb-auth-more/strategies/multisite/multisite_password_form.rb
 - lib/merb_auth_slice_multisite
 - lib/merb_auth_slice_multisite/merbtasks.rb
 - lib/merb_auth_slice_multisite/mixins
@@ -41,11 +45,15 @@ files:
 - spec/spec_helper.rb
 - app/controllers
 - app/controllers/application.rb
+- app/controllers/exceptions.rb
+- app/controllers/sessions.rb
 - app/helpers
 - app/helpers/application_helper.rb
 - app/models
 - app/models/site.rb
 - app/views
+- app/views/exceptions
+- app/views/exceptions/unauthenticated.html.erb
 - app/views/layout
 - app/views/layout/merb_auth_slice_multisite.html.erb
 - config/database.yml
@@ -58,7 +66,7 @@ files:
 - public/stylesheets/master.css
 - stubs/app
 - stubs/app/controllers
-- stubs/app/controllers/application.rb
+- stubs/app/controllers/sessions.rb
 has_rdoc: true
 homepage: http://github.com/scottmotte/merb_auth_slice_multisite
 post_install_message: 
@@ -84,7 +92,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: add multisite/subdomain functionality to your merb app on top of merb-auth
 test_files: []
 

data/stubs/app/controllers/application.rb

@@ -1,2 +0,0 @@
-class MerbAuthSliceMultisite::Application < Merb::Controller
-end