virtuatable-core 1.6.0.dev0 → 1.6.0.dev1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ebed77d032ef7111c0bde0982cdfc947a4a1933c1dc22e2cb09a3edeca12af1
-  data.tar.gz: '081072a04de88c52c94df498047f6cec83147fccf8c163e2c5856a9bde5398ac'
+  metadata.gz: d04349e236702f20e0c4a2542187eb4d1a0ef59d6ff4b44f90ff7d1a2484f783
+  data.tar.gz: f1e41d1f2b0a89c2851d617c2642222351a96cda77f0baeefed1a67eb98150d5
 SHA512:
-  metadata.gz: db0b0b6d2343f36483293ce34e0e93e6d0cc9a803959f1f84caafaf338309984aaf6b226f33a363a612e4b3724c9b225dc2dfc97139a729d55dfeb2f6a9ef70f
-  data.tar.gz: 7fc28600dbd1fa9c0a2cab48fc8431e0778e599a07ab98af8d87d3e9f4dc1e34423d1bfe0daa3fffdaa1744be92097dbab7aa9f32a59961d2e913675ad08b73e
+  metadata.gz: d1a87bca549bdc10d5f9dbee7c483051a0af0d7ec0cfb5594051a64b617e07fe8e32f8fcb7231398a078e4ca30d4d51e3434eb703bbdf5f5790474da897d8c6d
+  data.tar.gz: 910921c135060a8b78065c146e41ccc6e13f32e24ed75bafd4b3f507058ccb22a47c88f75ecfff991831c65382e1c56c3971124b07855e7e7513242871eec184

data/lib/core/decorators/account.rb

@@ -0,0 +1,9 @@
+module Core
+  module Decorators
+    class Account < Core::Decorators::Base
+      def has_password?(password)
+        BCrypt::Password.new(object.password_digest) == password
+      end
+    end
+  end
+end

data/lib/core/decorators/application.rb

@@ -0,0 +1,17 @@
+module Core
+  module Decorators
+    class Application < Core::Decorators::Base
+      def to_h
+        {
+          client_id: client_id,
+          name: name,
+          premium: premium
+        }
+      end
+
+      def has_secret?(secret)
+        object.client_secret == secret
+      end
+    end
+  end
+end

data/lib/core/decorators/session.rb

@@ -0,0 +1,13 @@
+module Core
+  module Decorators
+    class Session < Core::Decorators::Base
+      def to_h
+        {
+          token: token,
+          account_id: account.id.to_s,
+          created_at: created_at.iso8601
+        }
+      end
+    end
+  end
+end

data/lib/core/decorators.rb

@@ -1,7 +1,10 @@
 module Core
   module Decorators
+    autoload :Account, 'core/decorators/account'
+    autoload :Application, 'core/decorators/application'
     autoload :Base, 'core/decorators/base'
     autoload :Campaign, 'core/decorators/campaign'
+    autoload :Session, 'core/decorators/session'
     autoload :Token, 'core/decorators/token'
   end
 end

data/lib/core/services/accounts.rb

@@ -2,17 +2,41 @@
 
 module Core
   module Services
-    class Accounts
+    # Service managing user accounts.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Accounts < Core::Services::Base
       include Singleton
 
-      def get_by_username(username)
+      # Gets an account given the nickname of the user.
+      #
+      # @param username [String] the nickname the user chose at account creation.
+      # @return [Core::Models::Account] the account linked to this username.
+      #
+      # @raise [Core::Helpers::Errors::BadRequest] if the username is not given.
+      # @raise [Core::Helpers::Errors::NotFound] if the username does not exist.
+      def get_by_username(username: nil, **ignored)
+        require_parameters username: username
         account = Core::Models::Account.find_by(username: username)
-        if account.nil?
-          raise Core::Helpers::Errors::NotFound.new(
-            field: 'username',
-            error: 'unknown'
-          )
-        end
+        raise unknown_err(field: 'username') if account.nil?
+
+        Core::Decorators::Account.new(account)
+      end
+
+      # Gets and authenticates an account using its credentials.
+      #
+      # @param username [String] the nickname the user chose at account creation.
+      # @param password [String] the password, in clear, to identify the user with.
+      # @return [Core::Decorators::Account] the account if it is correctly found.
+      #
+      # @raise [Core::Helpers::Errors::BadRequest] if a needed parameter is not given.
+      # @raise [Core::Helpers::Errors::NotFound] if a user with this nickname is not found.
+      # @raise [Core::Helpers::Errors::Forbidden] if the password does not match the user.
+      def get_by_credentials(username: nil, password: nil, **ignored)
+        require_parameters password: password
+        account = get_by_username(username: username)
+
+        raise forbidden_err(field: 'password', error: 'wrong') unless account.has_password?(password)
+
         account
       end
     end

data/lib/core/services/applications.rb

@@ -20,7 +20,7 @@ module Core
       def get_by_credentials(client_id: nil, client_secret: nil, **_ignored)
         require_parameters client_secret: client_secret
         application = get_by_id(client_id: client_id)
-        raise forbidden_err(field: 'client_secret', error: 'wrong') if application.client_secret != client_secret
+        raise forbidden_err(field: 'client_secret', error: 'wrong') unless application.has_secret?(client_secret)
 
         application
       end
@@ -36,7 +36,7 @@ module Core
         application = Core::Models::OAuth::Application.find_by(client_id: client_id)
         raise unknown_err(field: 'client_id') if application.nil?
 
-        application
+        Core::Decorators::Application.new(application)
       end
     end
   end

data/lib/core/services/sessions.rb

@@ -7,8 +7,9 @@ module Core
   module Services
     # Service concerning sessions (log in and log out)
     # @author Vincent Courtois <courtois.vincent@outlook.com>
-    class Sessions
+    class Sessions < Core::Services::Base
       include Singleton
+
       # Creates a new session from the given user credentials. IT will
       # * check that the user exists in the database
       # * check that the password matches the user encrypted password
@@ -18,17 +19,31 @@ module Core
       # @param username [string] the name of the user trying to log in
       # @param password [string] the password the user has provided
       # @return [Core::Models::Authentication::Session] the login session
-      def create(username, password)
-        account = Core.svc.accounts.get_by_username(username)
-        if BCrypt::Password.new(account.password_digest) != password
-          raise Core::Helpers::Errors::Forbidden.new(field: 'password', error: 'wrong')
-        end
-
-        Core::Models::Authentication::Session.create(
+      def create_from_credentials(username: nil, password: nil, **ignored)
+        account = Core.svc.accounts.get_by_credentials(
+          username: username,
+          password: password
+        )
+        session = Core::Models::Authentication::Session.create(
           account: account,
           token: SecureRandom.uuid
         )
       end
+
+      # Gets the session by its unique identifier.
+      #
+      # @param session_id [String] the unique identifier of the session you're searching.
+      # @return [Core::Decorators::Session] the decorated session to display in the API.
+      #
+      # @raise [Core::Helpers::Errors::BadRequest] if the session ID is not given or nil
+      # @raise [Core::Helpers::Errors::NotFound] if no session with its ID exist in the database.
+      def get_by_id(session_id: nil, **ignored)
+        require_parameters session_id: session_id
+        session = Core::Models::Authentication::Session.find_by(token: session_id)
+        raise unknown_err(field: 'session_id') if session.nil?
+
+        Core::Decorators::Session.new(session)
+      end
     end
   end
 end

data/lib/core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Core
-  VERSION = '1.6.0.dev0'
+  VERSION = '1.6.0.dev1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: virtuatable-core
 version: !ruby/object:Gem::Version
-  version: 1.6.0.dev0
+  version: 1.6.0.dev1
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-18 00:00:00.000000000 Z
+date: 2022-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_cleaner
@@ -300,8 +300,11 @@ files:
 - lib/core/controllers.rb
 - lib/core/controllers/base.rb
 - lib/core/decorators.rb
+- lib/core/decorators/account.rb
+- lib/core/decorators/application.rb
 - lib/core/decorators/base.rb
 - lib/core/decorators/campaign.rb
+- lib/core/decorators/session.rb
 - lib/core/decorators/token.rb
 - lib/core/helpers.rb
 - lib/core/helpers/accounts.rb