mentorenwahl/backend/src/backend/api/schema/user.cr

180 lines
4.4 KiB
Crystal
Raw Normal View History

2022-02-10 07:43:47 +00:00
# Mentorenwahl: A fullstack application for assigning mentors to students based on their whishes.
# Copyright (C) 2022 Dominic Grimm
2022-03-07 13:06:02 +00:00
#
2022-02-10 07:43:47 +00:00
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
2022-03-07 13:06:02 +00:00
#
2022-02-10 07:43:47 +00:00
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
2022-03-07 13:06:02 +00:00
#
2022-02-10 07:43:47 +00:00
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
2022-01-23 08:12:57 +00:00
module Backend
module Api
2022-01-23 08:12:57 +00:00
module Schema
2022-03-20 14:20:06 +00:00
@[GraphQL::Enum]
# Possible roles of a user
enum UserRole
Teacher
Student
# DB representation of the enum
def to_db : Db::UserRole
2022-10-31 08:47:26 +00:00
case self
in Teacher
Db::UserRole::Teacher
in Student
Db::UserRole::Student
end
end
# GraphQL representation of the DB enum
def self.from_db(role : Db::UserRole) : self
role.to_api
end
2022-03-20 14:20:06 +00:00
end
2022-01-23 08:12:57 +00:00
@[GraphQL::Object]
2022-02-09 13:35:35 +00:00
# User model
2022-01-23 08:12:57 +00:00
class User < GraphQL::BaseObject
2022-03-07 17:10:55 +00:00
include Helpers
2022-01-23 08:12:57 +00:00
2022-11-21 18:48:53 +00:00
db_object Db::User, Int32
2022-01-23 08:12:57 +00:00
2023-01-29 10:49:13 +00:00
# @ldap : Ldap::User?
2022-07-28 12:05:10 +00:00
2023-01-29 10:49:13 +00:00
# # LDAP user data
# def ldap : Ldap::User
# if @ldap.nil? && (raw_cache = Redis::CLIENT.get("ldap:user:#{id}")).nil?
# Worker::Jobs::CacheLdapUserJob.new(id).perform
# raw_cache = Redis::CLIENT.get("ldap:user:#{id}").not_nil!
# end
2022-03-07 17:10:55 +00:00
2023-01-29 10:49:13 +00:00
# (@ldap ||= Ldap::User.from_json(raw_cache.not_nil!)).not_nil!
# end
2022-03-07 17:10:55 +00:00
2022-01-23 08:12:57 +00:00
@[GraphQL::Field]
2022-02-09 13:35:35 +00:00
# User's first name
2022-02-25 14:32:11 +00:00
def first_name : String
2023-01-29 10:49:13 +00:00
# ldap.first_name
@model.first_name
2022-01-23 08:12:57 +00:00
end
@[GraphQL::Field]
2022-02-09 13:35:35 +00:00
# User's last name
2022-02-25 14:32:11 +00:00
def last_name : String
2023-01-29 10:49:13 +00:00
# ldap.last_name
@model.last_name
2022-01-23 08:12:57 +00:00
end
2022-02-06 15:42:08 +00:00
@[GraphQL::Field]
2022-02-09 13:35:35 +00:00
# User's full name
2022-10-31 08:47:26 +00:00
def name(formal : Bool = true) : String
2023-01-29 10:49:13 +00:00
# ldap.name(formal)
if formal
"#{@model.last_name}, #{@model.first_name}"
else
"#{@model.first_name} #{@model.last_name}"
end
2022-02-06 15:42:08 +00:00
end
@[GraphQL::Field]
2022-02-09 13:35:35 +00:00
# User's LDAP username
2022-02-06 15:42:08 +00:00
def username : String
@model.username
2022-02-06 15:42:08 +00:00
end
@[GraphQL::Field]
2022-02-09 13:35:35 +00:00
# User is admin
2022-02-06 15:42:08 +00:00
def admin : Bool
@model.admin
2022-02-06 15:42:08 +00:00
end
2022-01-23 08:12:57 +00:00
@[GraphQL::Field]
2022-02-09 13:35:35 +00:00
# User's role
2022-01-23 08:12:57 +00:00
def role : UserRole
@model.role.to_api
2022-01-23 08:12:57 +00:00
end
@[GraphQL::Field]
2022-02-09 13:35:35 +00:00
# User's external ID
2022-10-31 08:47:26 +00:00
def external_id : Int32
case @model.role.to_api
2022-10-31 08:47:26 +00:00
when Db::UserRole::Teacher
@model.teacher
2022-10-31 08:47:26 +00:00
when Db::UserRole::Student
@model.student
2022-10-31 08:47:26 +00:00
end.not_nil!.id
2022-01-23 08:12:57 +00:00
end
@[GraphQL::Field]
2022-02-09 13:35:35 +00:00
# User's external teacher object
2022-01-23 08:12:57 +00:00
def teacher : Teacher?
2022-10-31 08:47:26 +00:00
@model.teacher.try { |t| Teacher.new(t) }
2022-01-23 08:12:57 +00:00
end
@[GraphQL::Field]
2022-02-09 13:35:35 +00:00
# User's external student object
2022-01-23 08:12:57 +00:00
def student : Student?
2022-10-31 08:47:26 +00:00
@model.student.try { |s| Student.new(s) }
2022-01-23 08:12:57 +00:00
end
end
@[GraphQL::InputObject]
2022-02-09 13:35:35 +00:00
# User creation input
2022-01-23 08:12:57 +00:00
class UserCreateInput < GraphQL::BaseInputObject
2022-02-06 15:42:08 +00:00
getter username
2022-01-23 08:12:57 +00:00
getter role
2022-03-07 11:58:35 +00:00
getter admin
2022-01-23 08:12:57 +00:00
@[GraphQL::Field]
def initialize(
2022-02-06 15:42:08 +00:00
@username : String,
2022-03-07 11:58:35 +00:00
@role : UserRole,
@admin : Bool = false
2022-01-23 08:12:57 +00:00
)
end
end
@[GraphQL::Object]
2022-02-09 13:35:35 +00:00
# Login payload returned after successful login
2022-01-23 08:12:57 +00:00
class LoginPayload < GraphQL::BaseObject
2022-02-09 13:35:35 +00:00
# Logged in user
2022-01-23 08:12:57 +00:00
property user
2022-02-09 13:35:35 +00:00
# JWT token
2022-01-23 08:12:57 +00:00
property token
def initialize(
@user : User,
@token : String
)
end
@[GraphQL::Field]
2022-02-09 13:35:35 +00:00
# Logged in user
2022-01-23 08:12:57 +00:00
def user : User
@user
end
@[GraphQL::Field]
2022-02-09 13:35:35 +00:00
# Raw bearer token
2022-01-23 08:12:57 +00:00
def token : String
@token
end
@[GraphQL::Field]
2022-02-09 13:35:35 +00:00
# Ready to use bearer token
2022-01-23 08:12:57 +00:00
def bearer : String
Auth::BEARER + @token
end
end
end
end
end