login-control 0.0.9 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d405f570cde58419604646ceab622e8de958d8f893ac7bb8104f5d52fd959da8
-  data.tar.gz: 7c264d1b9fd77d31a1526bd078816b354f4c4a5dff8a3dbabad0dbf523a6c252
+  metadata.gz: 04536373b256d917d6cfa71c8f75c1b3c0ea1c82b40067a9cdc562b30fdf9fb6
+  data.tar.gz: 79725f93e115f88ae440f509795629283d3cf8f7024af1eba5f37ec191a9d8b3
 SHA512:
-  metadata.gz: 754c4e493d3113066e57ec78282b4067c982c847d7f1a75c2d8e5234e07d3f3a5653c34d692418d260f9a01926804862e65348eaddf661b9fa1597c1bc87573f
-  data.tar.gz: 94abacb50e10de60e44dff6a9629e3b80f903b16c4f94b4ba1781d148aa0dd735bbf480bf08bf1eed6465359dd7804e85651ffa4c2b26601411649d1e9cdb201
+  metadata.gz: 633f01b07051b6df77522f40468dbc3af370af527f89fb528f370c91614d9ca4a1ad84266552643e89db8873ca96ac1c3d21086c6dc3cd32289dbfe356d2e8cc
+  data.tar.gz: e280825da69501748afb49d94539255166a8758c0cac1fde58bce9eccddb96063ce68e6d9dcc2fcdaa5fe022ef1b1d4843a7fe32ff7ba7b3a7e05a70a1b66481

data/README.md

@@ -16,7 +16,7 @@ On localhost captcha is never required.
 
 ## Installation
 
-`gem 'request-control'
+`gem 'request-control'`
 
 run 
 ```
@@ -25,9 +25,17 @@ $ rails g model login_control session_id:string login_name:string scope:string s
 $ rails db:migrate
 ```
 
-Login Form
+initializer
+```
+require 'login_control_module'
+require 'login_control_view_helper'
+```
 
-`include RequestControlViewHelper`
+ApplicationHelper
+
+`include LoginControlViewHelper`
+
+Login Form
 
 ```
   - if captcha_tag?
@@ -39,7 +47,7 @@ Controller example for subclassed devise controller
 ```
 class SessionsController < Devise::SessionsController
 
-  include RequestControlModule
+  include LoginControlModule
 
   def create
     notice_request_attempt

data/lib/login_control_module.rb

@@ -3,7 +3,7 @@ module LoginControlModule
   # check if captcha is to validate (does not store a cookie)
   def captcha_validation?(scope: :global, login_name: nil)
     rec = rc_record(scope, login_name)
-    logger.info "LOGIN-CONTROL => get captcha #{rec&.validate_captcha ? '' : 'NOT '}requested from record LoginControl.#{rec&.id}" if debug_request_control
+    logger.info "LoginControlModule => get captcha #{rec&.validate_captcha ? '' : 'NOT '}requested from record LoginControl.#{rec&.id}" if debug_request_control
     rec ? rec.validate_captcha : true
   end
 
@@ -15,7 +15,7 @@ module LoginControlModule
     rec.last_attempt = DateTime.now
     rec.attempts = 1
     rec.save!
-    logger.info "LOGIN-CONTROL => #{rec.sign_in_success}. successful request noticed" if debug_request_control
+    logger.info "LoginControlModule.notice_successful_request => #{rec.sign_in_success}. successful request noticed" if debug_request_control
   end
 
   # stores cookie, counts up attempts
@@ -25,7 +25,7 @@ module LoginControlModule
     rec.attempts = rec.attempts.to_i + 1
     rec.last_attempt = DateTime.now
     rec.save!
-    logger.info "LOGIN-CONTROL => #{rec.attempts}. failed request noticed" if debug_request_control
+    logger.info "LoginControlModule.notice_request_attempt => #{rec.attempts}. request attempt noticed" if debug_request_control
   end
 
   private

data/lib/login_control_view_helper.rb

@@ -8,38 +8,38 @@ module LoginControlViewHelper
     rc_id = cookies.encrypted.permanent[:login_control]
     captcha_requested = true
     if request.host == 'localhost'
-      logger.info 'LOGIN-CONTROL => no captcha because of localhost' if debug
+      logger.info 'LoginControlViewHelper.captcha_tag? => no captcha because of localhost' if debug
       captcha_requested = false
     elsif !rc_id.present?
-      logger.info 'LOGIN-CONTROL => captcha because no cookie stored yet' if debug
+      logger.info 'LoginControlViewHelper.captcha_tag? => captcha because no cookie stored yet' if debug
       captcha_requested = true
     else
-      logger.info 'LOGIN-CONTROL => cookie found ...' if debug
+      logger.info 'LoginControlViewHelper.captcha_tag? => cookie found ...' if debug
       rec = LoginControl.find_by(session_id: rc_id, scope: scope, login_name: login_name)
       if !rec
-        logger.info 'LOGIN-CONTROL => captcha required because no record found(!)' if debug
+        logger.info 'LoginControlViewHelper.captcha_tag? => captcha required because no record found(!)' if debug
         true
       else
-        logger.info 'LOGIN-CONTROL => record found ...' if debug
+        logger.info 'LoginControlViewHelper.captcha_tag? => record found ...' if debug
 
         attempts_allowed = (Rails.configuration.x.login_control.attempts_allowed || 10)
         retry_after_seconds = (Rails.configuration.x.login_control.retry_after_seconds || 30)
-        logger.info "LOGIN-CONTROL => #{rec.attempts.to_i}. attempt (config.x.attempts_allowed: #{attempts_allowed})" if debug
+        logger.info "LoginControlViewHelper.captcha_tag? => #{rec.attempts.to_i}. attempt (config.x.attempts_allowed: #{attempts_allowed})" if debug
 
         if rec.attempts == 1
           captcha_requested = false
-          logger.info "LOGIN-CONTROL => captcha NOT requested: because first attempt after successful login" if debug
+          logger.info "LoginControlViewHelper.captcha_tag? => captcha NOT requested: because first attempt after successful login" if debug
         elsif rec.attempts.to_i <= attempts_allowed
           secs = Time.now - (rec.last_attempt || Time.now)
           if secs >= retry_after_seconds.to_f
             captcha_requested = false
-            logger.info "LOGIN-CONTROL => captcha #{captcha_requested ? '' : 'NOT '}requested: config.x.retry_after_seconds(#{retry_after_seconds}) >= secs(#{secs})" if debug
+            logger.info "LoginControlViewHelper.captcha_tag? => captcha #{captcha_requested ? '' : 'NOT '}requested: config.x.retry_after_seconds(#{retry_after_seconds}) >= secs(#{secs})" if debug
           end
         end
 
       end
       rec.update!(validate_captcha: captcha_requested)
-      logger.info "LOGIN-CONTROL => set captcha #{captcha_requested ? '' : 'NOT '}requested to record LoginControl.#{rec.id}" if debug
+      logger.info "LoginControlViewHelper.captcha_tag? => set captcha #{captcha_requested ? '' : 'NOT '}requested to record LoginControl.#{rec.id}" if debug
       captcha_requested
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: login-control
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.11
 platform: ruby
 authors:
 - Christian Sedlmair
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-09 00:00:00.000000000 Z
+date: 2023-01-13 00:00:00.000000000 Z
 dependencies: []
 description: Based on Login Attempts check if captcha is necessary. It stores a permanent
   cookie and uses a table for tracking login requests.