hanami-authentication 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b10f080ce3f404155ac3587c85b888ad678a21a
-  data.tar.gz: 43441401575e80b96f300cead6fe346fe63d17c2
+  metadata.gz: 9bd3070e629eced5a93c261e5fd540d9e79ffb08
+  data.tar.gz: aed73bc00b44b5a4bb5850a6c5196818295a0e9c
 SHA512:
-  metadata.gz: 183dcd04ce198d45cc797252f1a18971bd6fcebbb7d4f18ee2b03dd313ff217072612c100a44d703f63d0a7b4d6258717ab260a3d53bbd9de29b9eef1825ec2f
-  data.tar.gz: b87f623a4b60bec0727850cd3a5be0b818939086c42f2e6de59bb7ecbdfb41d1fff7d9c954e5c023796837b566cf414e8b4c890e43b58bc65201fd7a24399766
+  metadata.gz: 67e0f8d355cbfca31744b0b8c45c7d964016d07c3d0bc7ab59ca5952dc413106468adcfca279fbe71aaffca7d9285e146729ad48dfd352f11fe566a3b8f354a2
+  data.tar.gz: 218e572f9a9ac0d5f15ef1787670c936ff8fd4967fc0390c5e29f39909f13a7f2196b1eb1f823a0bbe701c83cf2ca21f1d5b08e1dfd6c67c132a80a3441eaed3

data/README.md

@@ -20,15 +20,16 @@ gem 'hanami-authentication'
 # application.rb
 controller.prepare do
   include Hanami::Authentication
-  # before authenticate  >> This will use callbacks if authentication is failed.  
-  # before authenticate! >> This forced to halt by 401 if authentication is failed.
+
+  before authenticate  # This will use callbacks if authentication is failed.  
+  before authenticate! # This will force to halt by 401 if authentication is failed.
   
   after_session_expired do # This will be called if authenticate method is called when session is expired.
     flash[:error] = 'The session is expired.'
     redirect_to routes.root_path
   end
 
-  after_session_failed do # This will be called if authenticate method is called when user has not logged in.
+  after_authentication_failed do # This will be called if authenticate method is called when user has not logged in.
     flash[:error] = 'Please login'
     redirect_to routes.root_path
   end
@@ -38,7 +39,34 @@ end
 
 ### Methods
 
-TBD
+#### Login example
+```ruby
+# in_your_login_action.rb
+def call(params)
+  email = params[:email]
+  password = params[:password]
+  remember_me = params[:remember_me]
+
+  @current_user = @repository.find_by_email(email)
+
+  if match_password?(@current_user, password)
+    login(@current_user, remember_me: remember_me)
+    flash[:success] = 'Successful logged in'
+    redirect_to routes.root_path
+  else
+    flash[:error] = 'Email or password is incorrect'
+    redirect_to routes.root_path
+  end
+end
+```
+
+#### Logout example
+```ruby
+# in_your_login_action.rb
+def call(params)
+  logout
+end
+```
 
 ## Contributing
 

data/lib/hanami/authentication.rb

@@ -56,6 +56,7 @@ module Hanami
 
     def self.included(base)
       base.class_eval do
+        _expose :current_user
         extend  ClassMethods
       end
     end

data/lib/hanami/authentication/version.rb

@@ -1,5 +1,5 @@
 module Hanami
   module Authentication
-    VERSION = '0.2.0'
+    VERSION = '0.2.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-authentication
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - LegalForce Inc.