ru.Bee 2.2.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5d297ac622918eccf7bd285f4cfdf848e2909cbd19f57378105022505dfd222
-  data.tar.gz: 8976743ad813675bdd5c32d9149c5ffd70c3254980ab4a3b25835532e852d0cc
+  metadata.gz: 48d957ceb9eadc87893584969f6bb3fba784ed2f8d348acf8f7741bcfba1c345
+  data.tar.gz: 01f3ec0459b20095934ff5848ddfee75be62a72cb80ce6bfb9c5bfa44ba3614c
 SHA512:
-  metadata.gz: 0d9053f14123576c2a28e58fe39398a207bd5b350e96b871bf291f24ae9470ec15659cfbbbce643fb54a689fb9f45199792b571a3be4634397c7988bc5e9b42d
-  data.tar.gz: 3f2572054237820d93a8cec5daee95f86df00e36991b74e74fa1b5cf5bfeffc088c96d01026d07a1d163486fc8ad47d594c3f484396e8b467832e2946adea869
+  metadata.gz: 86961f349607ca22989c7d963c829c41e84e4fa9a6620198b4715444bf5dda83d8bf3fa25652cd4f6a32bbc7dfb20f9629efbf8baa61a530c45b3f7947b48aac
+  data.tar.gz: af077aced4ecbc32d28c3d4c31069b7bc2740dfe969d043d6348461f6de7f9a72ee50b47d97719607295a0fa8096533e79d8cc8e98289db14d978a2d5dbcef89

data/lib/inits/charged_hash.rb

@@ -12,5 +12,27 @@ module ChargedHash
     def wrap(value)
       value.is_a?(Hash) ? value.extend(ChargedHash) : value
     end
+
+    def keys_to_string!
+      keys_to(:string, self)
+    end
+
+    def keys_to_sym!
+      keys_to(:symbol, self)
+    end
+
+    def keys_to(type, obj)
+      case obj
+      when Hash
+        obj.each_with_object({}) do |(k, v), result|
+          key = k.to_s
+          result[key] = keys_to(type, v)
+        end
+      when Array
+        obj.map { |v| keys_to(type, v) }
+      else
+        obj
+      end
+    end
   end
 end

data/lib/rubee/controllers/extensions/auth_tokenable.rb

@@ -34,7 +34,7 @@ module Rubee
         elsif @request.cookies['jwt'] && valid_token?
           token = @request.cookies['jwt']
           hash = ::JWT.decode(token, Rubee::AuthTokenable::KEY, true, { algorithm: 'HS256' })
-          @authentificated_user ||= ::User.where(email: hash[0]['username']).first
+          @authentificated_user ||= user_model.where(login => hash[0]["login"][login.to_s]).first
         end
       end
 
@@ -42,7 +42,7 @@ module Rubee
         return false unless authentificated_user(user_model:, login:, password:)
 
         # Generate token
-        payload = { username: params[login], exp: Time.now.to_i + EXPIRE }
+        payload = { login: { login => params[login] }, klass: user_model.name, exp: Time.now.to_i + EXPIRE }
         @token = ::JWT.encode(payload, KEY, 'HS256')
         # Set jwt token to the browser within cookie, so next browser request will include it.
         # make sure it passed to response_with headers options

data/lib/rubee/controllers/middlewares/auth_token_middleware.rb

@@ -27,11 +27,11 @@ module Rubee
 
     def valid_token?(token)
       return false unless token
-
       hash = decode_jwt(token)
-      email = hash[:username]
+      login_params = hash[:login]
+      klass = hash[:klass]&.split('::')&.inject(Object) { |o, c| o.const_get(c) }
 
-      ::User.where(email:)&.any? if email
+      klass&.where(login_params.transform_keys(&:to_sym))&.any?
     end
 
     def decode_jwt(token)

data/lib/rubee.rb

@@ -17,7 +17,7 @@ module Rubee
   CSS_DIR = File.join(APP_ROOT, LIB, 'css') unless defined?(CSS_DIR)
   ROOT_PATH = File.expand_path(File.join(__dir__, '..')) unless defined?(ROOT_PATH)
 
-  VERSION = '2.2.0'
+  VERSION = '2.2.2'
 
   require_relative 'rubee/router'
   require_relative 'rubee/logger'

data/lib/tests/controllers/auth_tokenable_test.rb

@@ -68,7 +68,7 @@ class AuthTokenableTest < Minitest::Test
       route.get('/testtwo/show', to: 'testtwo#show')
     end
     User.create(email: '9oU8S@example.com', password: '123456')
-    Client.create(name: '9oU8S@example.com', digest_password: '123456')
+    Client.create(name: '9o@example.com', digest_password: '123456')
   end
 
   def test_test_controller_included_auth_tokenable
@@ -92,7 +92,7 @@ class AuthTokenableTest < Minitest::Test
   end
 
   def test_test_controller_included_auth_tokenable_authenticated_custom_model
-    post('/testtwo/login', { name: '9oU8S@example.com', digest_password: '123456' })
+    post('/testtwo/login', { name: '9o@example.com', digest_password: '123456' })
     rack_mock_session.cookie_jar["jwt"] = last_response.cookies["jwt"].value.last
     get('/testtwo/show')
 

data/readme.md

@@ -978,6 +978,7 @@ rubee db run:create_users
 This will create table users and initiate first user with demo credentials.
 email: "ok@ok.com", password: "password"
 Feel free to customize it in the /db/create_users.rb file before running migration.
+Please note user model is default but are free to use any model you need. See more examples below.
 
 Then in the controller you can include the AuthTokenable module and use its methods:
 ```ruby
@@ -1015,6 +1016,54 @@ class UsersController < Rubee::BaseController
   end
 end
 ```
+For security reason it is recommended to initialize JWT_KEY while starting ru.Bee application.
+```bash
+JWT_KEY=SDJwer0wer23j rubee start
+```
+User is a default model for validation but using it is not a mandatory. You can use any model you need by
+passing arguments to authentificate! and unauthentificate! methods.
+
+```ruby
+class Client < Sequel::Model
+  attr_accessor :id, :name, :digest_password, :created, :updated
+end
+
+class ClientController < Rubee::BaseController
+  include Rubee::AuthTokenable
+  # List methods you want to restrict
+  auth_methods :index
+
+  # GET /clinets/login (login form page)
+  def edit
+    response_with
+  end
+
+  # POST /clients/login (login logic)
+  def login
+    if authentificate! user_model: Client, login: :name, password: :digest_password
+      response_with type: :redirect, to: "/clinets", headers: @token_header
+    else
+      @error = "Wrong login or password"
+      response_with render_view: "clinets_edit"
+    end
+  end
+
+  # POST /clinets/logout
+  def logout
+    unauthentificate! user_model: Client, login: :name, password: :digest_password
+    response_with type: :redirect, to: "/clients/login", headers: @zeroed_token_header
+  end
+
+  # GET /clinets (restricted endpoint)
+  def index
+    response_with object: Client.all, type: :json
+  end
+end
+
+```
+
+[Back to content](#content)
+
 ## OAuth authentification
 If you want to plug in the OAuth 2.0 authentication, you can use the following code using OAuth2 gem:
 First thing you need to do is to add the gem to your Gemfile

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ru.Bee
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.2
 platform: ruby
 authors:
 - Oleg Saltykov