hanami-authentication 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62e60be3cc945a408fffcae2ef4774a2163a7def
-  data.tar.gz: bc8b07543ec3a6aed09a1bcd58e1838529780a76
+  metadata.gz: 8b10f080ce3f404155ac3587c85b888ad678a21a
+  data.tar.gz: 43441401575e80b96f300cead6fe346fe63d17c2
 SHA512:
-  metadata.gz: e5f82f43e0380ead02a41d6d71fc6c9cef30b633470ba621e836afa4bcc38b57a0f0c23f53416d80071aa399c84af01a438e13d3da85f26fa8918ef2d8e933c0
-  data.tar.gz: 5eef9c27d5b23856613f0f4e80c5d7271907dc8514456e7f10fe0f3493daffe2c4e0891aabd6b9101f51f974e887d9124bcd5e744b538b11d03f50979da1c64f
+  metadata.gz: 183dcd04ce198d45cc797252f1a18971bd6fcebbb7d4f18ee2b03dd313ff217072612c100a44d703f63d0a7b4d6258717ab260a3d53bbd9de29b9eef1825ec2f
+  data.tar.gz: b87f623a4b60bec0727850cd3a5be0b818939086c42f2e6de59bb7ecbdfb41d1fff7d9c954e5c023796837b566cf414e8b4c890e43b58bc65201fd7a24399766

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/README.md

@@ -15,6 +15,29 @@ gem 'hanami-authentication'
 
 ## Usage
 
+### Setup
+```ruby
+# 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.
+  
+  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.
+    flash[:error] = 'Please login'
+    redirect_to routes.root_path
+  end
+end
+```
+
+
+### Methods
+
 TBD
 
 ## Contributing

data/hanami-authentication.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'bcrypt', '~> 3.1'
+  spec.add_dependency 'hanami-utils', '~> 1.0'
 
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/hanami/authentication.rb

@@ -7,14 +7,12 @@ module Hanami
     private
 
     def login(user, remember_me: false, expire_seconds: 1 * 60 * 60)
-      return if authenticated?
       session[:current_user] = user
       session[:session_created_at] = Time.now + expire_seconds
       session[:remember_me] = remember_me
     end
 
     def logout
-      return unless authenticated?
       session[:current_user] = nil
       session[:session_created_at] = nil
       session[:remember_me] = nil
@@ -42,11 +40,9 @@ module Hanami
     def authenticate
       if session_expired?
         logout
-        flash[:error] = 'セッションの有効期限が切れました'
-        redirect_to routes.root_path
+        self.class.after_session_expired_callbacks.run(self)
       elsif !authenticated?
-        flash[:error] = 'ログインしてください'
-        redirect_to routes.root_path
+        self.class.after_authentication_failed_callbacks.run(self)
       end
     end
 
@@ -57,5 +53,33 @@ module Hanami
     def session_expired?
       !session[:remember_me] && session[:session_expired_at] && session[:session_expired_at] < Time.now
     end
+
+    def self.included(base)
+      base.class_eval do
+        extend  ClassMethods
+      end
+    end
+
+    module ClassMethods
+      def self.extended(base)
+        base.class_eval do
+          include Utils::ClassAttribute
+
+          class_attribute :after_session_expired_callbacks
+          self.after_session_expired_callbacks = Utils::Callbacks::Chain.new
+
+          class_attribute :after_authentication_failed_callbacks
+          self.after_authentication_failed_callbacks = Utils::Callbacks::Chain.new
+        end
+      end
+
+      def after_session_expired(*callbacks, &blk)
+        after_session_expired_callbacks.append(*callbacks, &blk)
+      end
+
+      def after_authentication_failed(*callbacks, &blk)
+        after_authentication_failed_callbacks.append(*callbacks, &blk)
+      end
+    end
   end
 end

data/lib/hanami/authentication/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-authentication
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - LegalForce Inc.
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: hanami-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -103,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A simple authentication module for hanami.