Merge branch 'feature/documentation' into 'develop'
Feature/documentation See merge request 2020-2021/online/s101/group-02/access_controller!25
This commit is contained in:
Кравченко Артем
@@ -13,88 +13,79 @@ class ZendeskAdmin:
|
||||
Класс **ZendeskAdmin** существует, чтобы в каждой фунциии отдельно не проверять аккаунт администратора
|
||||
|
||||
:param credentials: Полномочия (первым указывается учетная запись организации в Zendesk)
|
||||
:type credentials: :class:`list of dictionaries`
|
||||
:type credentials: :class:`dict`
|
||||
:param email: Email администратора, указанный в env
|
||||
:type email: :class:`email`
|
||||
:type email: :class:`str`
|
||||
:param token: Токен администратора (формируется в Zendesk, указывается в env)
|
||||
:type token: :class:`str`
|
||||
:param password: Пароль администратора, указанный в env
|
||||
:type password: :class:`str`
|
||||
|
||||
"""
|
||||
|
||||
credentials = {
|
||||
credentials: dict = {
|
||||
'subdomain': 'ngenix1612197338'
|
||||
}
|
||||
email = os.getenv('ACCESS_CONTROLLER_API_EMAIL')
|
||||
token = os.getenv('ACCESS_CONTROLLER_API_TOKEN')
|
||||
password = os.getenv('ACCESS_CONTROLLER_API_PASSWORD')
|
||||
email: str = os.getenv('ACCESS_CONTROLLER_API_EMAIL')
|
||||
token: str = os.getenv('ACCESS_CONTROLLER_API_TOKEN')
|
||||
password: str = os.getenv('ACCESS_CONTROLLER_API_PASSWORD')
|
||||
|
||||
def __init__(self):
|
||||
self.create_admin()
|
||||
|
||||
def check_user(self, email: str) -> bool:
|
||||
"""
|
||||
Функция **check_user** осуществляет проверку существования пользователя в Zendesk
|
||||
|
||||
:param email: Электронная почта пользователя
|
||||
:type email: :class:`email`
|
||||
:return: True, если существует, иначе False
|
||||
:rtype: :class:`bool`
|
||||
Функция **check_user** осуществляет проверку существования пользователя в Zendesk по email
|
||||
"""
|
||||
return True if self.admin.search(email, type='user') else False
|
||||
|
||||
def get_user_name(self, email: str) -> str:
|
||||
"""
|
||||
Функция **get_user_name** возвращает имя пользователя
|
||||
|
||||
:param user_name: Имя пользователя
|
||||
:type user_name: :class:`str`
|
||||
Функция **get_user_name** возвращает имя пользователя по его email
|
||||
"""
|
||||
user = self.admin.users.search(email).values[0]
|
||||
return user.name
|
||||
|
||||
def get_user_role(self, email: str) -> str:
|
||||
"""
|
||||
Функция **get_user_role** возвращает роль пользователя
|
||||
|
||||
:param user_role: Роль пользователя
|
||||
:type user_role: :class:`str`
|
||||
Функция **get_user_role** возвращает роль пользователя по его email
|
||||
"""
|
||||
user = self.admin.users.search(email).values[0]
|
||||
return user.role
|
||||
|
||||
def get_user_id(self, email: str) -> str:
|
||||
"""
|
||||
Функция **get_user_id** возвращает id пользователя
|
||||
|
||||
:param user_id: ID пользователя
|
||||
:type user_id: :class:`str`
|
||||
Функция **get_user_id** возвращает id пользователя по его email
|
||||
"""
|
||||
user = self.admin.users.search(email).values[0]
|
||||
return user.id
|
||||
|
||||
def get_user_image(self, email: str) -> str:
|
||||
"""
|
||||
Функция **get_user_image** возвращает аватар пользователя
|
||||
|
||||
:param user_image: Аватар пользователя
|
||||
:type user_image: :class:`img`
|
||||
Функция **get_user_image** возвращает аватар пользователя по его email
|
||||
"""
|
||||
user = self.admin.users.search(email).values[0]
|
||||
return user.photo['content_url'] if user.photo else None
|
||||
|
||||
def get_user(self, email: str) -> str:
|
||||
"""
|
||||
Функция **get_user** возвращает пользователя (объект) по его email
|
||||
"""
|
||||
return self.admin.users.search(email).values[0]
|
||||
|
||||
def get_user_org(self, email: str) -> str:
|
||||
"""
|
||||
Функция **get_user_org** возвращает организацию, к которой относится пользователь по его email
|
||||
"""
|
||||
user = self.admin.users.search(email).values[0]
|
||||
return user.organization.name
|
||||
return user.organization
|
||||
|
||||
def create_admin(self) -> None:
|
||||
def create_admin(self) -> Zenpy:
|
||||
"""
|
||||
Функция **Create_admin()** создает администратора, проверяя наличие вводимых данных в env.
|
||||
|
||||
:param credentials: В список полномочий администратора вносятся email, token, password из env
|
||||
:type credentials: :class:`dict`
|
||||
:raise: :class:`ValueError`: исключение, вызываемое если email не введен в env
|
||||
:raise: :class:`APIException`: исключение, вызываемое если пользователя с таким email не существует в Zendesk
|
||||
"""
|
||||
@@ -116,34 +107,43 @@ class ZendeskAdmin:
|
||||
raise ValueError('invalid access_controller`s login data')
|
||||
|
||||
|
||||
def update_role(user_profile, role):
|
||||
def update_role(user_profile: UserProfile, role: str) -> UserProfile:
|
||||
"""
|
||||
Функция **update_role** меняет роль пользователя.
|
||||
"""
|
||||
zendesk = ZendeskAdmin()
|
||||
user = zendesk.get_user(user_profile.user.email)
|
||||
user.custom_role_id = role
|
||||
zendesk.admin.users.update(user)
|
||||
|
||||
|
||||
def make_engineer(user_profile):
|
||||
def make_engineer(user_profile: UserProfile) -> UserProfile:
|
||||
"""
|
||||
Функция **make_engineer** устанавливапет пользователю роль инженера.
|
||||
"""
|
||||
update_role(user_profile, ROLES['engineer'])
|
||||
|
||||
|
||||
def make_light_agent(user_profile):
|
||||
def make_light_agent(user_profile: UserProfile) -> UserProfile:
|
||||
"""
|
||||
Функция **make_light_agent** устанавливапет пользователю роль легкого агента.
|
||||
"""
|
||||
update_role(user_profile, ROLES['light_agent'])
|
||||
|
||||
|
||||
def get_users_list():
|
||||
def get_users_list() -> list:
|
||||
"""
|
||||
Функция **get_users_list** возвращает список пользователей Zendesk, относящихся к организации.
|
||||
"""
|
||||
zendesk = ZendeskAdmin()
|
||||
admin = zendesk.get_user(zendesk.email)
|
||||
org = next(zendesk.admin.users.organizations(user=admin))
|
||||
return zendesk.admin.organizations.users(org)
|
||||
|
||||
|
||||
def update_profile(user_profile: UserProfile):
|
||||
def update_profile(user_profile: UserProfile) -> UserProfile:
|
||||
"""
|
||||
Функция обновляет профиль пользователя в соотвтетствии с текущим в Zendesk
|
||||
|
||||
:param user_profile: Объект профиля пользователя
|
||||
:type user_profile: :class:`main.models.UserProfile`
|
||||
Функция обновляет профиль пользователя в соотвтетствии с текущим в Zendesk
|
||||
"""
|
||||
user = ZendeskAdmin().get_user(user_profile.user.email)
|
||||
user_profile.name = user.name
|
||||
@@ -154,12 +154,7 @@ def update_profile(user_profile: UserProfile):
|
||||
|
||||
def check_user_exist(email: str) -> bool:
|
||||
"""
|
||||
Функция проверяет, существует ли пользователь
|
||||
|
||||
:param email: Электронная почта пользователя
|
||||
:type email: :class:`str`
|
||||
:return: True, если существует, иначе False
|
||||
:rtype: :class:`bool`
|
||||
Функция проверяет, существует ли пользователь
|
||||
"""
|
||||
return ZendeskAdmin().check_user(email)
|
||||
|
||||
@@ -167,11 +162,6 @@ def check_user_exist(email: str) -> bool:
|
||||
def get_user_organization(email: str) -> str:
|
||||
"""
|
||||
Функция возвращает организацию пользователя
|
||||
|
||||
:param email: Электронная почта пользователя
|
||||
:type email: :class:`str`
|
||||
:return: Название организации
|
||||
:rtype: :class:`str`
|
||||
"""
|
||||
return ZendeskAdmin().get_user_org(email)
|
||||
|
||||
@@ -180,13 +170,7 @@ def check_user_auth(email: str, password: str) -> bool:
|
||||
"""
|
||||
Функция проверяет, верны ли входные данные
|
||||
|
||||
:param email: Электроная почта пользователя
|
||||
:type email: :class:`str`
|
||||
:param password: Пароль пользователя
|
||||
:type password: :class:`str`
|
||||
:return: True, если входные данные верны, иначе False
|
||||
:raise: :class:`APIException`: исключение, вызываемое если пользователь не аутентифицирован
|
||||
:rtype: :class:`bool`
|
||||
"""
|
||||
creds = {
|
||||
'email': email,
|
||||
|
||||
@@ -6,11 +6,11 @@ from main.models import UserProfile
|
||||
|
||||
class CustomRegistrationForm(RegistrationFormUniqueEmail):
|
||||
"""
|
||||
Форма для регистрации :class:`django_registration.forms.RegistrationFormUniqueEmail`
|
||||
с добавлением bootstrap-класса 'form-control'
|
||||
Форма для регистрации :class:`django_registration.forms.RegistrationFormUniqueEmail`
|
||||
с добавлением bootstrap-класса 'form-control'
|
||||
|
||||
:param password_zen: Поле для ввода пароля от Zendesk
|
||||
:type password_zen: :class:`django.forms.CharField`
|
||||
:param password_zen: Поле для ввода пароля от Zendesk
|
||||
:type password_zen: :class:`django.forms.CharField`
|
||||
"""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
@@ -29,6 +29,13 @@ class CustomRegistrationForm(RegistrationFormUniqueEmail):
|
||||
|
||||
|
||||
class AdminPageUsers(forms.Form):
|
||||
"""
|
||||
Форма для установки статуса
|
||||
|
||||
:param password_zen: Поле для ввода пароля от Zendesk
|
||||
:type password_zen: :class:`django.forms.CharField`
|
||||
"""
|
||||
|
||||
users = forms.ModelMultipleChoiceField(
|
||||
queryset=UserProfile.objects.filter(role='agent'),
|
||||
widget=forms.CheckboxSelectMultiple(
|
||||
|
||||
@@ -8,19 +8,12 @@ class UserProfile(models.Model):
|
||||
"""
|
||||
Модель профиля пользователя
|
||||
|
||||
:param user: OneToOneField к модели :class:`django.contrib.auth.models.User`
|
||||
:param role: Код роли пользователя
|
||||
:type role: :class:`integer`
|
||||
:param image: Аватарка
|
||||
:type image: :class:`img`
|
||||
:param name: Имя пользователя на нашем сайте
|
||||
:type name: :class:`str`
|
||||
"""
|
||||
|
||||
user = models.OneToOneField(to=User, on_delete=models.CASCADE)
|
||||
role = models.CharField(default='None', max_length=100)
|
||||
image = models.URLField(null=True, blank=True)
|
||||
name = models.CharField(default='None', max_length=100)
|
||||
user = models.OneToOneField(to=User, on_delete=models.CASCADE, help_text='Пользователь')
|
||||
role = models.CharField(default='None', max_length=100, help_text='Код роли пользователя')
|
||||
image = models.URLField(null=True, blank=True, help_text='Аватарка')
|
||||
name = models.CharField(default='None', max_length=100, help_text='Имя пользователя на нашем сайте')
|
||||
|
||||
|
||||
@receiver(post_save, sender=User)
|
||||
@@ -38,17 +31,9 @@ class RoleChangeLogs(models.Model):
|
||||
"""
|
||||
Модель для логирования изменений ролей пользователя
|
||||
|
||||
:param user: Пользователь, которому присвоили другую роль, ForeignKey к модели :class:`django.contrib.auth.models.User`
|
||||
:param name: Имя пользователя
|
||||
:type name: :class:`str`
|
||||
:param new_role: Присвоенная роль
|
||||
:type new_role: :class:`str`
|
||||
:param change_time: Дата изменения роли`
|
||||
:type change_time: :class:`datetime.datetime`
|
||||
:param changed_by: Кем была изменена роль, ForeignKey к модели :class:`django.contrib.auth.models.User`
|
||||
"""
|
||||
user = models.ForeignKey(to=User, on_delete=models.CASCADE)
|
||||
name = models.TextField()
|
||||
new_role = models.TextField()
|
||||
change_time = models.DateTimeField()
|
||||
changed_by = models.ForeignKey(to=User, on_delete=models.CASCADE, related_name='changed_by')
|
||||
user = models.ForeignKey(to=User, on_delete=models.CASCADE, help_text='Пользователь, которому присвоили другую роль')
|
||||
name = models.TextField(help_text='Имя пользователя')
|
||||
new_role = models.TextField(help_text='Присвоенная роль')
|
||||
change_time = models.DateTimeField(help_text='Дата и время изменения роли')
|
||||
changed_by = models.ForeignKey(to=User, on_delete=models.CASCADE, related_name='changed_by', help_text='Кем была изменена роль')
|
||||
|
||||
Reference in New Issue
Block a user