ateam-merb-auth-old 0.0.1

data/lib/merb-auth/controller/controller.rb

@@ -0,0 +1,113 @@
+module MerbAuth
+  module Controller
+    module Helpers
+      protected
+        # Returns true or false if the user is logged in.
+        # Preloads @current_ma_user with the user model if they're logged in.
+        def logged_in?
+          !!current_ma_user
+        end
+    
+        # Accesses the current user from the session.  Set it to :false if login fails
+        # so that future calls do not hit the database.
+        def current_ma_user
+          @current_ma_user ||= (login_from_session || login_from_basic_auth || login_from_cookie || false)
+        end
+    
+        # Store the given user in the session.
+        def current_ma_user=(new_user)
+          session[MA[:single_resource]] = (!new_user || !new_user.kind_of?(MA[:user])) ? nil : new_user.id
+          @current_ma_user = new_user
+        end
+    
+        # Check if the user is authorized
+        #
+        # Override this method in your controllers if you want to restrict access
+        # to only a few actions or if you want to check if the user
+        # has the correct rights.
+        #
+        # Example:
+        #
+        #  # only allow nonbobs
+        #  def authorized?
+        #    current_ma_user.login != "bob"
+        #  end
+        def authorized?
+          logged_in?
+        end
+
+        # Filter method to enforce a login requirement.
+        #
+        # To require logins for all actions, use this in your controllers:
+        #
+        #   before_filter :login_required
+        #
+        # To require logins for specific actions, use this in your controllers:
+        #
+        #   before_filter :login_required, :only => [ :edit, :update ]
+        #
+        # To skip this in a subclassed controller:
+        #
+        #   skip_before_filter :login_required
+        #
+        def login_required
+          authorized? || throw(:halt, :access_denied)
+        end
+
+        # Redirect as appropriate when an access request fails.
+        #
+        # The default action is to redirect to the login screen.
+        #
+        # Override this method in your controllers if you want to have special
+        # behavior in case the user is not authorized
+        # to access the requested action.  For example, a popup window might
+        # simply close itself.
+        def access_denied
+          case content_type
+          when :html
+            store_location
+            redirect url(:merb_auth_login)
+          when :xml
+            basic_authentication.request
+          end
+        end
+    
+        # Store the URI of the current request in the session.
+        #
+        # We can return to this location by calling #redirect_back_or_default.
+        def store_location
+          session[:return_to] = request.uri
+        end
+    
+        # Redirect to the URI stored by the most recent store_location call or
+        # to the passed default.
+        def redirect_back_or_default(default, notice = "")
+          url = session[:return_to] || default
+          session[:return_to] = nil
+          redirect url, :notice => notice
+        end
+
+        # Called from #current_ma_user.  First attempt to login by the user id stored in the session.
+        def login_from_session
+          self.current_ma_user = MA[:user].find_with_conditions(:id => session[MA[:single_resource]]) if session[MA[:single_resource]]
+        end
+
+        # Called from #current_ma_user.  Now, attempt to login by basic authentication information.
+        def login_from_basic_auth
+          basic_authentication.authenticate do |email, password|
+            self.current_ma_user = MA[:user].authenticate(email, password)
+          end
+        end
+
+        # Called from #current_ma_user.  Finaly, attempt to login by an expiring token in the cookie.
+        def login_from_cookie     
+          user = cookies[:auth_token] && MA[:user].find_with_conditions(:remember_token => cookies[:auth_token])
+          if user && user.remember_token?
+            user.remember_me
+            cookies[:auth_token] = { :value => user.remember_token, :expires => Time.parse(user.remember_token_expires_at.to_s) }
+            self.current_ma_user = user
+          end
+        end
+    end # Helpers
+  end# Controllers
+end # MerbAuth

data/lib/merb-auth/controller/sessions_base.rb

@@ -0,0 +1,41 @@
+module MerbAuth
+  module Controller
+    # Provides basic functionality for sessions.  eg Allows login and logout.
+    module SessionsBase
+      
+      def self.included(base)
+        # base.send(:skip_before, :login_required)
+        base.send(:include, InstanceMethods)
+        base.send(:show_action, :new, :create, :destroy)
+      end
+      
+      module InstanceMethods
+        def new
+          render
+        end
+
+        def create
+          self.current_ma_user = MA[:user].authenticate(params[MA[:login_field]], params[:password])
+          if logged_in?
+            if params[:remember_me] == "1"
+              self.current_ma_user.remember_me
+              expires = Time.parse(self.current_ma_user.remember_token_expires_at.to_s)
+              cookies[:auth_token] = { :value => self.current_ma_user.remember_token , :expires => expires }
+            end
+            redirect_back_or_default('/')
+          else
+            render :new
+          end
+        end
+
+        def destroy
+          self.current_ma_user.forget_me if logged_in?
+          cookies.delete :auth_token
+          session.clear
+          redirect_back_or_default('/')
+        end
+      end # InstanceMethods
+      
+    end # SessionsBase
+  end # Controller
+end # MerbAuth

data/lib/merb-auth/controller/users_base.rb

@@ -0,0 +1,58 @@
+module MerbAuth
+  module Controller
+    
+    # Provides basic functionality for the users controller.  Allows creation of a new user and activation
+    module UsersBase
+      
+      def self.included(base)
+        # base.send(:skip_before, :login_required)
+        base.send(:include, InstanceMethods)
+        base.send(:show_action, :new, :create, :activate)
+      end
+      
+      module InstanceMethods
+        # Displays the new form for the user
+        def new
+          only_provides :html
+          @ivar = MA[:user].new(params[MA[:single_resource]] || {})
+          set_ivar
+          display @ivar
+        end
+
+        def create
+          cookies.delete :auth_token
+          @use_recaptcha = Object.const_defined?(:Ambethia)
+
+          @ivar = MA[:user].new(params[MA[:single_resource]])
+          set_ivar
+          #if (!@use_recaptcha || verify_recaptcha(@ivar, :failure_message => nil)) && @ivar.save
+          if (!@use_recaptcha || verify_recaptcha(@ivar, :failure_message => nil)) && @ivar.valid?
+            @ivar.save
+            self.current_ma_user = @ivar unless MA[:use_activation]
+            redirect_back_or_default('/')
+
+          else
+            render :new
+          end
+        end
+
+        def activate
+          self.current_ma_user = MA[:user].find_with_conditions(:activation_code => params[:activation_code])
+          if logged_in? && !current_ma_user.activated?
+            Merb.logger.info "Activated #{current_ma_user}"
+            current_ma_user.activate
+          end
+          redirect_back_or_default('/')
+        end
+
+        private
+        # sets the instance variable for the developer to use eg. @user
+        def set_ivar
+          instance_variable_set("@#{MA[:single_resource]}", @ivar)
+        end
+        
+      end # InstanceMethods
+      
+    end # UsersBase
+  end # Controllers
+end #MerbAuth

data/lib/merb-auth/initializer.rb

@@ -0,0 +1,47 @@
+module MerbAuth
+  
+  # Clears the currently registered adapter list.  
+  def self.clear_adapter_list!
+    @_adapters = nil
+  end
+  
+  # Registers an adapter.
+  # @param [Symbol] name is the name of the adapter.  Supported adapters are :datamapper and :activerecord
+  # @param [String] path is the path to the adapter.  The adapter path _directory_ should include an init.rb file
+  # @param [Hash] opts an options hash
+  def self.register_adapter(name, path, opts = {})
+    adapters[name.to_sym] = opts.merge!(:path => path)
+  end
+  
+  # @return [Hash] A hash of the adapters.  
+  def self.adapters
+    @_adapters ||= Hash.new{|h,k| h[k] = {}}
+  end
+  
+  
+  # Loads the adapter provided, or if not provided, the adapter set in the slices config
+  # @param [Symbol | String] adapter The name of the adapter to load.  This must be registered
+  # @raise [RuntimeError] Raises an error if the adapter is not registered.
+  def self.load_adapter!(adapter = nil)
+    adapter ||= self.config[:adapter] || Merb.orm_generator_scope
+    raise "MerbAuth: No Adapter Specified" if adapter.nil? || adapter.blank?
+    
+    # Check that the adapter is registered
+    raise "MerbAuth: Adapter Not Registered - #{adapter}" unless adapters.keys.include?(adapter.to_sym)
+    
+    if Merb.env?(:test)
+      load adapters[adapter.to_sym][:path] / "init.rb"
+    else
+      require adapters[adapter.to_sym][:path] / "init"
+    end
+  end
+  
+  def self.load_plugins!
+    self.plugins.each do |label, file|
+      Merb.logger.info "Loading MerbAuth Plugin - #{label}"
+      load file
+    end
+    MA.setup_custom_routes!
+  end
+  
+end

data/lib/merb-auth/merbtasks.rb

@@ -0,0 +1,168 @@
+$SLICED_APP=true # we're running inside the host application context
+
+namespace :slices do
+  namespace :merb_auth do
+  
+    desc "Install MerbAuth"
+    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"
+      MerbAuth.mirrored_components.each do |type|
+        if File.directory?(MerbAuth.dir_for(type))
+          if !File.directory?(dst_path = MerbAuth.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 MerbAuth - resolves any collisions"
+      copied, preserved = MerbAuth.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 MerbAuth - resolves any collisions"
+      copied, preserved = MerbAuth.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 MerbAuth into your app (only merb-auth/app)" 
+    task :freeze => [ "freeze:app" ]
+
+    namespace :freeze do
+      
+      desc "Freezes MerbAuth by installing the gem into application/gems using merb-freezer"
+      task :gem do
+        begin
+          Object.const_get(:Freezer).freeze(ENV["GEM"] || "merb-auth", ENV["UPDATE"], ENV["MODE"] || 'rubygems')
+        rescue NameError
+          puts "! dependency 'merb-freezer' missing"
+        end
+      end
+      
+      desc "Freezes MerbAuth by copying all files from merb-auth/app to your application"
+      task :app do
+        puts "Copying all merb-auth/app files to your application - resolves any collisions"
+        copied, preserved = MerbAuth.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 = MerbAuth.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 models into your application for easy modification" 
+      task :models do
+        puts "Copying all models to your application - resolves any collisions"
+        copied, preserved = MerbAuth.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 MerbAuth as a gem and copies over merb-auth/app"
+      task :app_with_gem => [:gem, :app]
+      
+      desc "Freezes MerbAuth by unpacking all files into your application"
+      task :unpack do
+        puts "Unpacking MerbAuth files to your application - resolves any collisions"
+        copied, preserved = MerbAuth.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
+    
+    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 MerbAuth 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/merb-auth/slicetasks.rb

@@ -0,0 +1,102 @@
+namespace :slices do
+  namespace :merb_auth do 
+    
+    # add your own merb_auth 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
+
+    desc "Generate Migration"
+    task :generate_migration => :merb_env do
+      puts `merb-gen ma_migration #{MA[:user].name}`
+    end
+    
+    namespace :ar do
+      desc "Print Model Properties"
+      task :model_setup do
+        out =<<-EOS
+        
+# -------------------------------------------------------------------
+  include MerbAuth::Adapter::ActiveRecord
+
+  # Virtual attribute for the unencrypted password
+  attr_accessor :password, :password_confirmation
+  validates_presence_of     :login, :email
+  validates_presence_of     :password,                   :if => :password_required?
+  validates_presence_of     :password_confirmation,      :if => :password_required?
+  validates_length_of       :password, :within => 4..40, :if => :password_required?
+  validates_confirmation_of :password,                   :if => :password_required?
+  validates_length_of       :login,    :within => 3..40
+  validates_length_of       :email,    :within => 3..100
+  validates_uniqueness_of   :login, :email, :case_sensitive => false
+  validates_uniqueness_of   :password_reset_key, :if => Proc.new{|m| !m.password_reset_key.nil?}
+  
+  
+  before_save :encrypt_password
+  before_validation :set_login
+  before_create :make_activation_code
+  after_create :send_signup_notification
+# -------------------------------------------------------------------
+EOS
+        puts "Enter this into your model to make it usable with MerbAuth by default"
+        puts out
+        puts "Enter this into your model to make it usable with MerbAuth by default"
+      end
+      
+    end # ar
+
+    namespace :dm do
+      desc "Print Model Properties"
+      task :model_setup do
+        out =<<-EOS
+
+# -------------------------------------------------------------------
+
+  include MerbAuth::Adapter::DataMapper
+  
+  attr_accessor :password, :password_confirmation
+
+  property :id,                         Integer,  :serial   => true
+  property :login,                      String,   :nullable => false, :length => 3..40, :unique => true
+  property :email,                      String,   :nullable => false, :unique => true
+  property :created_at,                 DateTime
+  property :updated_at,                 DateTime
+  property :activated_at,               DateTime
+  property :activation_code,            String
+  property :crypted_password,           String
+  property :salt,                       String
+  property :remember_token_expires_at,  DateTime
+  property :remember_token,             String
+  property :password_reset_key,         String, :writer => :protected
+
+  validates_is_unique :password_reset_key, :if => Proc.new{|m| !m.password_reset_key.nil?}
+  validates_present        :password, :if => proc{|m| m.password_required?}
+  validates_is_confirmed   :password, :if => proc{|m| m.password_required?}
+
+  before :valid? do
+    set_login
+  end
+
+  before :save,   :encrypt_password
+  before :create, :make_activation_code
+  after  :create, :send_signup_notification
+  
+  # -------------------------------------------------------------------
+  EOS
+          puts "Enter this into your model to make it usable with MerbAuth by default"
+          puts out
+          puts "Enter this into your model to make it usable with MerbAuth by default"
+  
+      end # setup
+    end # dm
+    
+  end # merb_auth
+end # slices