authstrategies 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NmY5MzNhOTc3ZDVlMGNiODg4OTkxZmY4ZjU2MTE1MmFjOTdmNGI2OQ==
+    NmUzMWJmYmNhMzgwOTNkYzllMTc3ZDA1OWU1YzcxNzdkYzFhYTZmMw==
   data.tar.gz: !binary |-
-    ZjE4YmVhYjhhNDVhMmU2N2ZhOTBiZmRlNmU5M2VlYWRhM2E4OGE0Mg==
+    NWJmMWNjMzUzMTUwNjg3NWMyZjUyNGJlMDkxYzMxMWM5NGU2ZTA1Mg==
 SHA512:
   metadata.gz: !binary |-
-    OWMwZDJlZTQ5NTRlNzUyNTI4NWQ3ZjY0ODQ3MGQzYjAyNTU0ZmM5NWY3Y2Zi
-    NWFmMWNlMTI0N2IwZGNmYjNiOTRjMWFkOWMxNDI4NGNhYzg2ODZjNDIyYTA2
-    Y2EzNjVkNTQxZjlhMTAzOGNmZjk5ZGNmNTVmMzE5OTI3ZGQwNjQ=
+    NTlhMTlkZDM1YTI1NDZhNWEyNjg4NDY2YzA2OTM0YWVmYzc1NGQ0ZWU5ZDQz
+    MmM2YWU0YmU4N2ZmYTRkMzc5ZDJlMjk0MmMxZDJiNmZhNDllNGUzMWZkNmU1
+    OWIxM2MyZTM3MTE4NmU2MDk3MjczYWVhOWYyNzVhMjUxMGI5MGY=
   data.tar.gz: !binary |-
-    NzM4MDJiNzQzMWFhNmQ3MGY1YWZmMTBiZjAyZjI2ZjdhNWM3NGQwMzhiMjkw
-    MGJiNjliMDc1YjliYTZlOGI0NzEzN2FmOWJmNjQ3ZDQxOTU5ZWM5ZDNlMTRj
-    MTczMDEyZjQxZjczNmE5ODMxNDQ0NDYyZTc1ZTEwNjFjNWI1MTI=
+    ZmUwYzBmOGUxMDdhOTdkMDdmMjE0NWM4ZTgwOTA4ZDZlZDY2ZjAxMGEyODk2
+    ZmQ1MTIzN2VjN2ZhZjk2NmNlYjE5ODEwNzg3OWY4MmJkZDEzMThmMjM4YWYw
+    OTFiY2Y1Njk3NDA0ODdkNzFmMWE2YTYxY2M0NGU0MWViNTU2ZmQ=

data/README.md

@@ -25,14 +25,14 @@ Authstrategies uses sinatra-activerecord as orm. There is currently no rake task
 				t.string :email,							:null => false, :defautl => ""
 				t.string :encrypted_password, :null => false, :default => ""
 
-				t.string remember_token
+				t.string  :remember_token
 				t.boolean :remember_me
 
 				t.timestamps
 			end
 
-			add_index :users, :email,			:unique => true
-			add_index :remember_token,		:unique => true
+			add_index :users, :email,			     :unique => true
+			add_index :users, :remember_token, :unique => true
 	  end
 
 
@@ -68,6 +68,88 @@ To logout the user class logout.
 login_path returns the login path as a string
 logout_path returns the logout path as a string
 signup_path returns the signup path as a string
+
+## Callbacks
+
+    after_set_user
+This is called every time the user is set. The user is set:
+=> on each request when they are accessed for the first time via env['warden'].user
+=> when the user is initially authenticated
+=> when the user is set via the set_user method
+Courtesy of Warden, for more information check the warden callbacks wiki
+
+    after_authentication
+
+Executed every time the user is authenticated
+(first time in each session).
+Courtesy of Warden, for more information check the warden callbacks wiki
+
+    before_login_failure
+
+This callback is run right before the failure application is called.
+Courtesy of Warden, for more information
+check the warden callbacks wiki
+
+    after_login_failure
+
+This is called in the failure application
+Useful for redirecting the user after he logs in
+2 params are passed to this callback
+=>request - the request data
+=>response - the response data
+
+    before_logout
+
+This callback is run before each user is logged out.
+Courtesy of Warden, for more information
+check the warden callbacks wiki
+
+    after_logout
+
+This is called after the user is logged out.
+Useful for redirecting the user after logging out
+2 parameters are passed to this callback
+=>request - the request data
+=>response - the response data
+
+    after_logout_path
+
+This defines a path to redirect the user to
+after he logs out and a flash message to print
+path default is root path
+message default is 'Logged out successfully!'
+
+    after_login
+
+This is called each time after the user logs in
+3 parameters are passed to this callback
+=>current_user - the user that hase just been set
+=>request - the request data
+=>response - the response data
+
+    after_login_path
+
+This defines a path to redirect the user to
+after he logs in and a flash message to print
+path default is root path
+message default is 'Logged in successfully!'
+
+    after_signup
+
+This is called after the user is saved into
+the database
+3 parameters are passed to this callback
+=>user - the user that just signed up
+=>request - the request data
+=>response - the response data
+Also since the user is set to session via env['warden'].set_user
+after_set_user is also called after the user signs up
+
+    after_signup_path
+This defines a path to redirect the user to
+after he signs up and a flash message to print
+path default is root path
+message default is 'Successfully signed up!
 ## Contributing
 
 1. Fork it

data/authstrategies.gemspec

@@ -26,7 +26,6 @@ Gem::Specification.new do |spec|
 	spec.add_runtime_dependency "protected_attributes"
 	spec.add_runtime_dependency "warden"
 	spec.add_runtime_dependency "bcrypt-ruby"
-	spec.add_runtime_dependency "rack"
 	spec.add_runtime_dependency "rack-flash3", '1.0.5'
 
 end

data/lib/authstrategies/middleware.rb

@@ -1,64 +1,68 @@
 module Authstrategies
 	class Middleware < Sinatra::Base
-			register Base
-			register RememberMe
+    register Base
+    register RememberMe
 
-			get '/login/?' do
-				redirect '/' if authenticated?
-				erb :login
-			end
+    include Manager
 
-			post '/login' do
-				redirect '/' if authenticated?
-				authenticate!
-				if authenticated?
-					if params["remember_me"] == "on"
-						current_user.remember_me!
-						response.set_cookie("authstrategies",
-							:value => current_user.remember_token,
-							:expires => Time.now + 7 * 24 * 3600
-						)
-					end
-					flash[:notice] = "Logged in successfully!"
-					redirect '/'
-				else
-					flash[:error] = env["warden"].message
-					redirect '/login'
-				end
-			end
+    get '/login/?' do
+      redirect '/' if authenticated?
+      erb :login
+    end
 
-			get '/logout/?' do
-				if authenticated?
-					current_user.forget_me!
-					response.delete_cookie("authstrategies")
-					logout
-					flash[:notice] = "Successfully logged out!"
-					redirect '/'
-				end
-				redirect '/'
-			end
+    post '/login' do
+      redirect '/' if authenticated?
+      authenticate!
+      if authenticated?
+        if params["remember_me"] == "on"
+          current_user.remember_me!
+          response.set_cookie("authstrategies",
+            :value => current_user.remember_token,
+            :expires => Time.now + 7 * 24 * 3600
+          )
+        end
+        Manager.call :after_login, [current_user, request, response]
+        flash[:notice] = Manager._after_login_msg
+        redirect Manager._after_login_path
+      end
+    end
 
-			post '/unauthenticated' do
-				flash[:error] = env["warden"].message
-				redirect '/login'
-			end
+    get '/signup/?' do
+      redirect '/' if authenticated?
+      erb :signup
+    end
 
-			get '/signup/?' do
-				redirect '/' if authenticated?
-				erb :signup
-			end
+    post '/signup' do
+      redirect '/' if authenticated?
+      user = User.new(params)
+      if user.valid?
+        user.save
+        env['warden'].set_user(user)
+        Manager.call :after_signup, [user, request, response]
+        flash[:notice] = Manager._after_signup_msg
+        redirect Manager._after_signup_path
+      else
+        flash[:error] = user.errors.messages
+        redirect '/signup'
+      end
+    end
 
-			post '/signup' do
-				redirect '/' if authenticated?
-				user = User.new(params)
-				if user.valid?
-					user.save
-					flash[:notice] = "Successfully signed up!"
-					redirect '/'
-				else
-					flash[:error] = user.errors.messages
-					redirect '/signup'
-				end
-			end
+    get '/logout/?' do
+      if authenticated?
+        current_user.forget_me!
+        response.delete_cookie("authstrategies")
+        logout
+        Manager.call :after_logout, [request, response]
+        flash[:notice] = Manager._after_logout_msg
+        redirect Manager._after_logout_path
+      end
+      redirect '/'
+    end
+
+    post '/unauthenticated' do
+      Manager.call :after_login_failure, [request, response]
+      flash[:error] = env["warden"].message
+      redirect '/login'
+    end
 	end
 end

data/lib/authstrategies/models/user.rb

@@ -20,8 +20,8 @@ class User < ActiveRecord::Base
   end
 
 	def password= password
-		@password = Password.create(password)
-		self.encrypted_password = @password
+    @password = password
+		self.encrypted_password = Password.create(@password)
 	end
 
 	def authenticate request

data/lib/authstrategies/version.rb

@@ -1,3 +1,3 @@
 module Authstrategies
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/authstrategies/views/login.erb

@@ -3,6 +3,6 @@
 <form action="login" method="post">
 	<p>Username:<input type="text" name="email" /></p>
 	<p>Password:<input type="password" name="password" /></p>
-	<p>Remember Me: <input type="radio" name="remember_me" /></p>
+	<p>Remember Me: <input type="checkbox" name="remember_me" /></p>
 	<p><input type="submit" name="Submit" /></p>
 </form>

data/lib/authstrategies.rb

@@ -11,26 +11,179 @@ require "authstrategies/remember_me.rb"
 require "authstrategies/models/user.rb"
 
 module Authstrategies
+  module Manager
+
+    @@callbacks = {}
+
+    @@_after_login_path = '/'
+    @@_after_login_msg = 'Successfully logged in!'
+
+    @@_after_logout_path = '/'
+    @@_after_logout_msg = 'Successfully logged out!'
+
+    @@_after_signup_path = '/'
+    @@_after_signup_msg = 'Successfully signed up!'
+
+    def self.registered? hook
+      @@callbacks.has_key? hook
+    end
+
+    def self.register hook, &block
+      if @@callbacks[hook].class == Array
+        @@callbacks[hook].push block
+      else
+        @@callbacks[hook] = [block]
+      end
+    end
+
+    def self.call hook, args = []
+      if @@callbacks.has_key? hook
+        @@callbacks[hook].each do |callback|
+          callback.call(args)
+        end
+      end
+    end
+
+    # This is called every time the user is set. The user is set:
+    # => on each request when they are accessed for the first time via env['warden'].user
+    # => when the user is initially authenticated
+    # => when the user is set via the set_user method
+    # Courtesy of Warden, for more information
+    # check the warden callbacks wiki
+    def self.after_set_user &block
+      Warden::Manager.after_set_user do |user, auth, opts|
+        yield(user, auth, opts)
+      end
+    end
+
+    # Executed every time the user is authenticated
+    # (first time in each session).
+    # Courtesy of Warden, for more information
+    # check the warden callbacks wiki
+    def self.after_authentication &block
+      Warden::Manager.after_authentication do |user, auth, opts|
+        yield(user, auth, opts)
+      end
+    end
+
+    # This callback is run right before the failure application is called.
+    # Courtesy of Warden, for more information
+    # check the warden callbacks wiki
+    def self.before_login_failure &block
+      Warden::Manager.before_failure do |env, opts|
+        yield(env, opts)
+      end
+    end
+
+    # This is called in the failure application
+    # Useful for redirecting the user after he logs in
+    # 2 params are passed to this callback
+    # =>request - the request data
+    # =>response - the response data
+    def self.after_login_failure &block
+      self.register :after_login_failure, &block
+    end
+
+    #This callback is run before each user is logged out.
+    # Courtesy of Warden, for more information
+    # check the warden callbacks wiki
+    def self.before_logout &block
+      Warden::Manager.before_logout do |user, auth, opts|
+        yield(user, auth, opts)
+      end
+    end
+
+    # This is called after the user is logged out.
+    # Useful for redirecting the user after logging out
+    # 2 parameters are passed to this callback
+    # =>request - the request data
+    # =>response - the response data
+    def self.after_logout &block
+      self.register :after_logout, &block
+    end
+
+    # This defines a path to redirect the user to
+    # after he logs out and a flash message to print
+    # path default is root path
+    # message default is 'Logged out successfully!'
+    def self.after_logout_path path, message
+      @@_after_logout_path, @@after_logout_msg = path, message
+    end
+
+    def self._after_logout_path
+      @@_after_logout_path
+    end
+
+    def self._after_logout_msg
+       @@_after_logout_msg
+    end
+
+    # This is called each time after the user logs in
+    # 3 parameters are passed to this callback
+    # =>current_user - the user that hase just been set
+    # =>request - the request data
+    # =>response - the response data
+    def self.after_login &block
+      self.register :after_login, &block
+    end
+
+    # This defines a path to redirect the user to
+    # after he logs in and a flash message to print
+    # path default is root path
+    # message default is 'Logged in successfully!'
+    def self.after_login_path path, message
+      @@_after_login_path, @@after_login_msg = path, message
+    end
+
+    def self._after_login_path
+      @@_after_login_path
+    end
+
+    def self._after_login_msg
+       @@after_login_msg
+    end
+
+    # This is called after the user is saved into
+    # the database
+    # 3 parameters are passed to this callback
+    # =>user - the user that just signed up
+    # =>request - the request data
+    # =>response - the response data
+    # Also since the user is set to session via env['warden'].set_user
+    # after_set_user is also called after the user signs up
+    def self.after_signup &block
+      self.register :after_signup, &block
+    end
+
+    # This defines a path to redirect the user to
+    # after he signs up and a flash message to print
+    # path default is root path
+    # message default is 'Successfully signed up!
+    def self.after_signup_path path, message
+      @@_after_signup_path, @@after_signup_msg = path, message
+    end
+
+  end
+
 	module Base
-		def self.registered(app)
+    def self.registered(app)
 			app.helpers Helpers
+      app.use Warden::Manager do |manager|
+        manager.failure_app = app
+        manager.default_strategies :password
+      end
 
-			app.use Warden::Manager do |manager|
-				manager.failure_app = app
-				manager.default_strategies :password, :remember_me
-			end
-
-			Warden::Manager.before_failure do |env,opts|
-						env['REQUEST_METHOD'] = 'POST'
+			Manager.before_login_failure do |env,opts|
+				env['REQUEST_METHOD'] = 'POST'
 			end
 			Warden::Strategies.add(:password, PasswordStrategy)
-		end
+    end
 	end
 
 	module RememberMe
 		def self.registered(app)
 			Warden::Strategies.add(:remember_me, RememberMeStrategy)
-		end
-	end
+    end
+  end
 end
 require "authstrategies/middleware.rb"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authstrategies
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dobromir Ivanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-24 00:00:00.000000000 Z
+date: 2013-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,20 +108,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-flash3
   requirement: !ruby/object:Gem::Requirement