Class: Core::Services::Accounts

Inherits:

Base

• Object
• Base
• Core::Services::Accounts

Includes:

Singleton

Defined in:

lib/core/services/accounts.rb

Overview

Service managing user accounts.

Author:

• Vincent Courtois <courtois.vincent@outlook.com>

Instance Method Summary

• #get_by_credentials(username: nil, password: nil, **ignored) ⇒ Core::Decorators::Account

  Gets and authenticates an account using its credentials.

• #get_by_username(username: nil, **ignored) ⇒ Core::Models::Account

  Gets an account given the nickname of the user.

Methods inherited from Base

#bad_request_err, #forbidden_err, #require_parameters, #unknown_err

Instance Method Details

#get_by_credentials(username: nil, password: nil, **ignored) ⇒ Core::Decorators::Account

Gets and authenticates an account using its credentials.

Parameters:

• username (String) (defaults to: nil) —

  the nickname the user chose at account creation.

• password (String) (defaults to: nil) —

  the password, in clear, to identify the user with.

Returns:

• (Core::Decorators::Account) —

  the account if it is correctly found.

Raises:

• (Core::Helpers::Errors::BadRequest) —

  if a needed parameter is not given.

• (Core::Helpers::Errors::NotFound) —

  if a user with this nickname is not found.

• (Core::Helpers::Errors::Forbidden) —

  if the password does not match the user.

# File 'lib/core/services/accounts.rb', line 34

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

#get_by_username(username: nil, **ignored) ⇒ Core::Models::Account

Gets an account given the nickname of the user.

Parameters:

• username (String) (defaults to: nil) —

  the nickname the user chose at account creation.

Returns:

• (Core::Models::Account) —

  the account linked to this username.

Raises:

• (Core::Helpers::Errors::BadRequest) —

  if the username is not given.

• (Core::Helpers::Errors::NotFound) —

  if the username does not exist.

# File 'lib/core/services/accounts.rb', line 17

def get_by_username(username: nil, **ignored)
  require_parameters username: username
  account = Core::Models::Account.find_by(username: username)
  raise unknown_err(field: 'username') if account.nil?

  Core::Decorators::Account.new(account)
end