virtuatable-core 1.6.0.dev0 → 1.6.0.dev4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ebed77d032ef7111c0bde0982cdfc947a4a1933c1dc22e2cb09a3edeca12af1
-  data.tar.gz: '081072a04de88c52c94df498047f6cec83147fccf8c163e2c5856a9bde5398ac'
+  metadata.gz: ed2fb554bca98c5a51745c7872a81eafd22c8c741ea1025f8757313182f5ba07
+  data.tar.gz: a13f5931693e5a41f21c6aafe664c8ad37e0709ce716f3bb16b01fa45f0f5705
 SHA512:
-  metadata.gz: db0b0b6d2343f36483293ce34e0e93e6d0cc9a803959f1f84caafaf338309984aaf6b226f33a363a612e4b3724c9b225dc2dfc97139a729d55dfeb2f6a9ef70f
-  data.tar.gz: 7fc28600dbd1fa9c0a2cab48fc8431e0778e599a07ab98af8d87d3e9f4dc1e34423d1bfe0daa3fffdaa1744be92097dbab7aa9f32a59961d2e913675ad08b73e
+  metadata.gz: d404bb036b5f7f96ba6b15ac350d3f67c1e409d1be876ab54c8fff997ba1f18994a014cdfdd96e6ced3fe302fd9d77a8ba4964d809944f42812752b13721da8e
+  data.tar.gz: d8a5ef0902184dbbe8c63b908acddad0bbdcf6e9480d44a8c48ce977db627b7083136a3c803e4aba9b83ecda7e54c8bb4c589e4bb922712ea7d7fae85112926e

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/authorization.rb

@@ -0,0 +1,9 @@
+module Core
+  module Decorators
+    class Authorization < Core::Decorators::Base
+      def to_h
+        { code: object.code }
+      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,11 @@
 module Core
   module Decorators
+    autoload :Account, 'core/decorators/account'
+    autoload :Application, 'core/decorators/application'
+    autoload :Authorization, 'core/decorators/authorization'
     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/authorizations.rb

@@ -42,7 +42,7 @@ module Core
         authorization = Core::Models::OAuth::Authorization.find_by(code: authorization_code)
         raise unknown_err(field: 'authorization_code') if authorization.nil?
 
-        authorization
+        Core::Decorators::Authorization.new(authorization)
       end
 
       private

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,16 +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
         )
+        Decorators::Session.new(session)
+      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

data/lib/core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Core
-  VERSION = '1.6.0.dev0'
+  VERSION = '1.6.0.dev4'
 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.dev4
 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
@@ -280,16 +280,16 @@ dependencies:
   name: draper
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.2
 description: This gem holds the model layer for my table-top RPG games application.
 email: courtois.vincent@outlook.com
 executables: []
@@ -300,8 +300,12 @@ 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/authorization.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