auth_logic_user_session_helper 2.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [Brent Greeff]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,40 @@
+= AuthLogic UserSession Helper
+
+Bunch of convenience methods for use with AuthLogic and Rails.
+
+Only works if you are using a standard user, and user_session.
+
+Will be able to specify the model(s) names in the future.
+
+== Example
+
+
+* Get the current_user from the session
+      current_user
+
+* Is there a user logged in?
+      user?
+
+* Is there no user currently logged in?
+      no_user?
+
+* A user is required! (use as before filter to redirect to '/login')
+      user_required
+
+* A user cannot be logged in (will redirect to the root_url, whatever that is mapped to)
+      no_user_required
+
+* If you need to remember what the user was trying to do before you made them login
+    store_location
+    redirect_back_or_default
+
+=== user_required will store the requested location before redirecting.
+=== Call redirect_back_or_default after login to enable this behaviour.
+
+
+== Testing
+
+Adds login_as and logout methods to tests.
+
+
+Copyright (c) 2009 [Brent Greeff], released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the auth_logic_user_session_helper plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the auth_logic_user_session_helper plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AuthLogicUserSessionHelper'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+2.0.0

data/lib/auth_logic_user_session_helper.rb

@@ -0,0 +1,22 @@
+module AuthLogic
+  module UserSessionHelper
+    
+    def self.included(base)
+      base.class_eval do
+        include InstanceMethods
+        
+        helper_method :current_user
+        helper_method :user?
+        helper_method :no_user?
+      end
+    end
+  end    
+end
+
+ActionController::Base.send(:include, AuthLogic::UserSessionHelper)
+
+if RAILS_ENV.eql? 'test'
+  require 'test_help'
+  require 'auth_logic_user_session_helper/auth_logic_test_helper'
+  ActiveSupport::TestCase.send(:include, AuthLogic::TestHelper)
+end

data/lib/auth_logic_user_session_helper/auth_logic_test_helper.rb

@@ -0,0 +1,20 @@
+module AuthLogic
+  module TestHelper
+    def login_as(someone)
+      login_user(someone)
+    end
+    
+    def login_user(user)
+      raise 'Cannot login, user is not a User' unless user.is_a? User
+      UserSession.create(user)
+    end
+    
+    def logout
+      logout_user
+    end
+    
+    def logout_user
+      @request.session[:user_credentials] = nil
+    end
+  end
+end

data/lib/auth_logic_user_session_helper/instance_methods.rb

@@ -0,0 +1,50 @@
+module AuthLogic
+  module UserSessionHelper
+    
+    module InstanceMethods
+      def current_user_session
+        return @current_user_session if defined?(@current_user_session)
+        @current_user_session = UserSession.find
+      end
+      
+      def current_user
+        return @current_user if defined?(@current_user)
+        @current_user = current_user_session && current_user_session.record
+      end
+      
+      def user?
+        return current_user.is_a? User
+      end
+      
+      def no_user?
+        return current_user.nil?
+      end
+      
+      def user_required
+        return if user?
+        
+        store_location
+        flash[:error] = 'Please log in first'
+        redirect_to login_url
+      end
+      
+      def no_user_required
+        return if no_user?
+        
+        flash[:error] = 'You are already logged in'
+        redirect_to root_url
+      end
+      
+      # Redirect back
+      
+      def store_location
+        session[:return_to] = request.request_uri
+      end
+      
+      def redirect_back_or_default(default)
+        redirect_to(session[:return_to] || default)
+        session[:return_to] = nil
+      end
+    end
+  end
+end

data/test/auth_logic_user_session_helper_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class AuthLogicUserSessionHelperTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: auth_logic_user_session_helper
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 2
+  - 0
+  - 0
+  version: 2.0.0
+platform: ruby
+authors: 
+- Brent Greeff
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-29 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Convenience methods for use with AuthLogic and Rails. :current_user, user? etc
+email: email@brentgreeff.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/auth_logic_user_session_helper.rb
+- lib/auth_logic_user_session_helper/auth_logic_test_helper.rb
+- lib/auth_logic_user_session_helper/instance_methods.rb
+- test/auth_logic_user_session_helper_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/brentgreeff/auth_logic_user_session_helper
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Convenience methods for use with AuthLogic and Rails. :current_user, user? etc.
+test_files: []
+