ru.Bee 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc6a4fbeb28a460ca66f75ccf1f5c97fe1572f422392f9ee1b72d082e05cb287
-  data.tar.gz: f4dbeaf7338af243f6e225a2a798a87de75b001fa4196bed94345d78887ba8ea
+  metadata.gz: f5d297ac622918eccf7bd285f4cfdf848e2909cbd19f57378105022505dfd222
+  data.tar.gz: 8976743ad813675bdd5c32d9149c5ffd70c3254980ab4a3b25835532e852d0cc
 SHA512:
-  metadata.gz: 996510c80521425797e17a1b641d767d6319877e127883692d519457c7573835ae2670a8ed17950f302b1934a0aae1270d8b065acfee079341935ddb8964a26f
-  data.tar.gz: 75a8ab899d3c98fd492a30ec5501982526318387c9214b78ebdf57ec2c39a91778268283db82cbeb5ae9072aa4c62507b1d175423e7f86beec892cddfea0bb90
+  metadata.gz: 0d9053f14123576c2a28e58fe39398a207bd5b350e96b871bf291f24ae9470ec15659cfbbbce643fb54a689fb9f45199792b571a3be4634397c7988bc5e9b42d
+  data.tar.gz: 3f2572054237820d93a8cec5daee95f86df00e36991b74e74fa1b5cf5bfeffc088c96d01026d07a1d163486fc8ad47d594c3f484396e8b467832e2946adea869

data/lib/db/create_clients.rb

@@ -0,0 +1,15 @@
+class CreateClients
+  def call
+    return if Rubee::SequelObject::DB.tables.include?(:clients)
+
+    Rubee::SequelObject::DB.create_table(:clients) do
+      primary_key(:id)
+      String(:name)
+      String(:digest_password)
+      index(:name)
+      # timestamps
+      datetime(:created)
+      datetime(:updated)
+    end
+  end
+end

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

@@ -3,7 +3,7 @@ require 'date'
 
 module Rubee
   module AuthTokenable
-    KEY = "secret#{Date.today}".freeze unless defined?(KEY) # Feel free to cusomtize it
+    KEY ="secret#{ENV['JWT_KEY']}#{Date.today}".freeze unless defined?(KEY) # Feel free to cusomtize it
     EXPIRE = 3600 unless defined?(EXPIRE)
 
     def self.included(base)
@@ -27,10 +27,10 @@ module Rubee
         @request.env['rack.session']&.[]('authentificated')
       end
 
-      def authentificated_user
-        # User model must be created with email and password properties at least
-        if params[:email] && params[:password]
-          @authentificated_user ||= ::User.where(email: params[:email], password: params[:password]).first
+      def authentificated_user(user_model: ::User, login: :email, password: :password)
+        if params[login] && params[password]
+          query_params = { login => params[login], password => params[password] }
+          @authentificated_user ||= user_model.where(query_params).first
         elsif @request.cookies['jwt'] && valid_token?
           token = @request.cookies['jwt']
           hash = ::JWT.decode(token, Rubee::AuthTokenable::KEY, true, { algorithm: 'HS256' })
@@ -38,11 +38,11 @@ module Rubee
         end
       end
 
-      def authentificate!
-        return false unless authentificated_user
+      def authentificate!(user_model: ::User, login: :email, password: :password)
+        return false unless authentificated_user(user_model:, login:, password:)
 
         # Generate token
-        payload = { username: params[:email], exp: Time.now.to_i + EXPIRE }
+        payload = { username: params[login], 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.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.1.1'
+  VERSION = '2.2.0'
 
   require_relative 'rubee/router'
   require_relative 'rubee/logger'

data/lib/tests/controllers/auth_tokenable_test.rb

@@ -1,5 +1,55 @@
 require_relative '../test_helper'
 
+class TestController < Rubee::BaseController
+  include(Rubee::AuthTokenable)
+  auth_methods(:show)
+  def show
+    response_with(type: :json, object: { ok: :ok })
+  end
+
+  # POST /test/login (login logic)
+  def login
+    if authentificate! # AuthTokenable method that init @token_header
+      # Redirect to restricted area, make sure headers: @token_header is passed
+      response_with(type: :json, object: { ok: :ok }, headers: @token_header)
+    else
+      @error = "Wrong email or password"
+      response_with(type: :json, object: { error: 'user unauthenticated' }, status: :unauthenticated)
+    end
+  end
+
+  # POST /test/logout (logout logic)
+  def logout
+    unauthentificate! # AuthTokenable method aimed to handle logout action.
+    # Make sure @zeroed_token_header is paRssed within headers options
+    response_with(type: :json, object: { ok: 'logged out' }, headers: @zeroed_token_header)
+  end
+end
+
+class TesttwoController < Rubee::BaseController
+  include(Rubee::AuthTokenable)
+  auth_methods(:show)
+  def show
+    response_with(type: :json, object: { ok: :ok })
+  end
+
+  # POST /testtwo/login (login logic)
+  def login
+    if authentificate!(user_model: Client, login: :name, password: :digest_password)
+      response_with(type: :json, object: { ok: :ok }, headers: @token_header)
+    else
+      @error = "Wrong email or password"
+      response_with(type: :json, object: { error: 'user unauthenticated' }, status: :unauthenticated)
+    end
+  end
+
+  # POST /testtwo/logout (logout logic)
+  def logout
+    unauthentificate!(user_model: Client, login: :name, password: :digest_password)
+    response_with(type: :json, object: { ok: 'logged out' }, headers: @zeroed_token_header)
+  end
+end
+
 class AuthTokenableTest < Minitest::Test
   include Rack::Test::Methods
 
@@ -9,21 +59,43 @@ class AuthTokenableTest < Minitest::Test
 
   def setup
     Rubee::Autoload.call
+    Rubee::Router.draw do |route|
+      route.post('/test/login', to: 'test#login')
+      route.post('/test/logout', to: 'test#logout')
+      route.get('/test/show', to: 'test#show')
+      route.post('/testtwo/login', to: 'testtwo#login')
+      route.post('/testtwo/logout', to: 'testtwo#logout')
+      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')
   end
 
-  def teardown
-    # detach auth methods
-    return unless WelcomeController.instance_variable_defined?(:@auth_methods)
+  def test_test_controller_included_auth_tokenable
+    get('/test/show')
 
-    WelcomeController.send(:remove_instance_variable, :@auth_methods)
+    assert_equal(last_response.status, 401)
   end
 
-  def test_welcome_controller_included_auth_tokenable
-    WelcomeController.include(Rubee::AuthTokenable)
-    WelcomeController.auth_methods(:show)
+  def test_test_controller_included_auth_tokenable_authenticated
+    post('/test/login', { email: '9oU8S@example.com', password: '123456' })
+    rack_mock_session.cookie_jar["jwt"] = last_response.cookies["jwt"].value.last
+    get('/test/show')
 
-    get('/')
+    assert_equal(last_response.status, 200)
+  end
+
+  def test_test_controller_included_auth_tokenable_unauthenticated_custom_model
+    get('/testtwo/show')
 
     assert_equal(last_response.status, 401)
   end
+
+  def test_test_controller_included_auth_tokenable_authenticated_custom_model
+    post('/testtwo/login', { name: '9oU8S@example.com', digest_password: '123456' })
+    rack_mock_session.cookie_jar["jwt"] = last_response.cookies["jwt"].value.last
+    get('/testtwo/show')
+
+    assert_equal(last_response.status, 200)
+  end
 end

data/lib/tests/example_models/client.rb

@@ -0,0 +1,3 @@
+class Client < Rubee::SequelObject
+  attr_accessor :id, :name, :digest_password, :created, :updated
+end

data/readme.md

@@ -151,14 +151,14 @@ cd my_project
 
 ***Prerequisites***<br />
 Make sure:
-**Ruby** language (3.1>) is installed
+**Ruby** language (3.1 or higher, 3.4.1 recommended) is installed
 **Bundler** is installed
 
 ```bash
 bundle install
 ```
 
-4. Run RUBER server. Default port is 7000
+4. Run ru.Bee server. Default port is 7000
 ```bash
 rubee start # or rubee start_dev for development
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ru.Bee
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Oleg Saltykov
@@ -58,6 +58,7 @@ files:
 - lib/css/app.css
 - lib/db/create_accounts.rb
 - lib/db/create_addresses.rb
+- lib/db/create_clients.rb
 - lib/db/create_comments.rb
 - lib/db/create_posts.rb
 - lib/db/create_users.rb
@@ -280,6 +281,7 @@ files:
 - lib/tests/controllers/users_controller_test.rb
 - lib/tests/example_models/account.rb
 - lib/tests/example_models/address.rb
+- lib/tests/example_models/client.rb
 - lib/tests/example_models/comment.rb
 - lib/tests/example_models/post.rb
 - lib/tests/example_models/user.rb