anoubis 1.0.0

data/app/models/anoubis/tenant/user.rb

@@ -0,0 +1,225 @@
+##
+# Main User model. Stores inforation about all users that can access to the portal.
+class Anubis::Tenant::User < ApplicationRecord
+  # @!attribute patronymic
+  #   @return [String] user's patronymic
+
+  # @!attribute login
+  #   @return [String] user's full login with {Tenant#ident} suffix.
+
+  has_secure_password
+
+  # Redefines default table name
+  self.table_name = 'users'
+
+  before_validation :before_validation_anubis_user_on_create, on: :create
+  before_validation :before_validation_anubis_user_on_update, on: :update
+  before_save :before_save_anubis_user
+  before_destroy :before_destroy_anubis_user
+  after_destroy :after_destroy_anubis_user
+
+  # Email must be valid email address
+  VALID_EMAIL_REGEX = /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i
+
+  # @!attribute email
+  #   @return [String] user's email
+  validates :email, presence: true, length: { maximum: 50 }, format: { with: VALID_EMAIL_REGEX }
+  validates :email, uniqueness: { case_sensitive: true, scope: [:tenant_id] }, if: :email_unique
+
+  # @!attribute name
+  #   @return [String] user's name
+  validates :name, length: { maximum: 100 }
+  validates :name, presence: true, if: :name_presence
+
+  # @!attribute surname
+  #   @return [String] user's surname
+  validates :surname, length: { maximum: 100 }
+  validates :surname, presence: true, if: :name_presence
+
+  validates :password, length: { in: 5..30 }, on: [:create]
+  validates :password, length: { in: 5..30 }, on: [:update], if: :password_changed?
+  validates :password_confirmation, length: { in: 5..30 }, on: [:create]
+  validates :password_confirmation, length: { in: 5..30 }, on: [:update], if: :password_changed?
+
+  # @!attribute auth_key
+  #   @return [String] user's auth key. Variable is used for storing key to restore password or confirm email.
+  validates :auth_key, length: { maximum: 32 }
+
+  # @!attribute auth_key
+  #   @return [Integer] user's session timeout. Default vaule is 3600
+  validates :timeout, presence: true, numericality: {only_integer: true, greater_than_or_equal_to: 0}
+
+  # @!attribute uuid_bin
+  #   @return [Blob] user's binary representation of UUID
+  validates :uuid_bin, uniqueness: { case_sensitive: false, scope: [:tenant_id] }
+
+  # @!attribute status
+  #   @return ['enabled', 'disabled'] the status of menu element.
+  #     - 'enabled' --- user is enabled and can login to system.
+  #     - 'disabled' --- user is disabled and can't login to system.
+  #     - 'pending' --- user isn't confirmed.
+  enum status: {enabled: 0, disabled: 1, pending: 2}
+
+  # @!attribute uuid
+  #   @return [String] user's UUID
+  attr_accessor :uuid
+
+  # @!attribute groups_access
+  #   @return [Array] array of user access groups
+  attr_accessor :groups_access
+
+  # @!attribute tenant
+  #   @return [Tenant] the tenant that owns this user.
+  belongs_to :tenant, class_name: 'Anubis::Tenant::Tenant'
+  has_many :user_groups, class_name: 'Anubis::Tenant::UserGroup'
+
+  has_one_attached :avatar
+
+  ##
+  # Is called before validation when new user is being created. Checks user parameters before create new user.
+  # Generates new UUID. Sets default system parameters for first user.
+  def before_validation_anubis_user_on_create
+    self.uuid = self.new_uuid
+    if self.id
+      if self.id == 1
+        self.password = 'admin'
+        self.password_confirmation = 'admin'
+        self.status = 0
+        self.tenant_id = 1
+        self.timeout = 3600
+        return true
+      end
+    end
+    validate_anubis_user true
+  end
+
+  ##
+  # Is called before validation when user is being updated. Checks user parameters before create new user.
+  # Generates new UUID. Sets default system parameters for first user.
+  def before_validation_anubis_user_on_update
+    validate_anubis_user false
+  end
+
+  ##
+  # Validates users element. Sets default missing parameters. Prevents changing tenant for existing user.
+  # @param is_new [Boolean] sets into true when user is being created
+  def validate_anubis_user(is_new)
+    self.locale = 'ru-RU' if !self.locale
+    self.timeout = 3600 if !self.timeout
+    self.tenant_id = self.tenant_id_was if !is_new # Can't change tenant for existing user
+    self.status = 0 if self.id == 1 # Can't disable Main Administrator
+
+    if !password.blank?
+      if password != password_confirmation
+        errors.add(:password, I18n.t('users.errors.different_passwords'))
+        errors.add(:password_confirmation, I18n.t('users.errors.different_passwords'))
+        return false
+      end
+    end
+
+    return true
+  end
+
+  ##
+  # Is called before user will be stored in database. Changes {#login} and {#email} values to lower case.
+  # Deletes user cache in Redis database when user's parameters has been changed.
+  def before_save_anubis_user
+    self.timezone = 'GMT' if !self.timezone
+    self.email = self.email.downcase
+    self.login = self.email+'.'+self.tenant.ident
+    self.redis.del(self.redis_prefix + 'user:' + self.uuid) if self.redis
+  end
+
+  ##
+  # Checks if password has been changed
+  # @return [Boolean] return true if password has been changed
+  def password_changed?
+    !password.blank?
+  end
+
+  ##
+  # Is called before delete user from database. Destroys all access groups for this user
+  def before_destroy_anubis_user
+    if self.id == 1
+      errors.add(:base, I18n.t('users.errors.cant_destroy_tenant_admin'))
+      throw(:abort, __method__)
+    end
+
+    Anubis::Tenant::UserGroup.where(user_id: self.id).delete_all
+  end
+
+  ##
+  # Is called after user was deleted from database. Also deletes all cache for this user from Redis database.
+  def after_destroy_anubis_user
+    if self.redis
+      self.redis.del self.uuid
+      self.redis.keys(self.uuid+'_*').each do |data|
+        self.redis.del data
+      end
+    end
+  end
+
+  ##
+  # UUID representations in string format
+  # @return [String] string representaion of user UUID
+  def uuid
+    self.bin_to_uuid self.uuid_bin
+  end
+
+  ##
+  # Sets UUID into binary format
+  # @param value [String] string representation of UUID
+  def uuid=(value)
+    self.uuid_bin = self.uuid_to_bin value
+  end
+
+  ##
+  # Excludes password from json output and uuid_bin from
+  # @param options [Hash] additional options
+  def to_json(options={})
+    options[:except] ||= [:password_digest, :uuid_bin]
+    super(options)
+  end
+
+  ##
+  # Returns user model system title
+  # @return [String] user system title
+  def sys_title
+    self.title
+  end
+
+  ##
+  # Attach groups to user json outputs
+  def as_json(options={})
+    h = super(options)
+    h[:groups_access] = []
+    self.user_groups.each do |ug|
+      h[:groups_access].push ug.group.full_ident
+    end
+    h
+  end
+
+  ##
+  # Array of user access group
+  def groups_access
+    @groups_access ||= get_groups_access
+  end
+
+  ##
+  # Generate user access groups
+  def get_groups_access
+    h = []
+    self.user_groups.each do |ug|
+      h[:groups_access].push ug.group.full_ident
+    end
+    h
+  end
+
+  def name_presence
+    true
+  end
+
+  def email_unique
+    true
+  end
+end

data/app/models/anoubis/tenant/user_group.rb

@@ -0,0 +1,32 @@
+##
+# UserGroup model. It links User and Group models.
+class Anoubis::Tenant::UserGroup < ApplicationRecord
+  self.table_name = 'user_groups'
+
+  before_update :before_update_user_group
+  after_create :after_modify_user_group
+  after_destroy :after_modify_user_group
+
+  belongs_to :group, class_name: 'Anoubis::Tenant::Group'
+  validates :group, presence: true, uniqueness: { scope: [:user_id] }
+  belongs_to :user, class_name: 'Anoubis::Tenant::User'
+  validates :user, presence: true, uniqueness: { scope: [:group_id] }
+
+  ##
+  # Can't change elements
+  def before_update_user_group
+    self.user_id = self.user_id_was if self.user_id_changed?
+    self.group_id = self.group_id_was if self.group_id_changed?
+  end
+
+  ##
+  # Delete all redis keys of menu for defined user
+  def after_modify_user_group
+    if self.redis
+      self.redis.keys(self.redis_prefix + self.user.uuid.to_s + '_*').each do |data|
+        self.redis.del data
+      end
+      self.redis.del self.redis_prefix + self.user.uuid.to_s
+    end
+  end
+end

data/app/services/anoubis/core_service.rb

@@ -0,0 +1,16 @@
+class Anoubis::CoreService
+  attr_accessor :redis
+
+  def initialize
+    self.redis = Redis.new
+  end
+
+  def redis_prefix
+    begin
+      value = Rails.configuration.redis_prefix
+    rescue
+      return ''
+    end
+    return value + ':'
+  end
+end

data/app/services/anoubis/session_service.rb

@@ -0,0 +1,17 @@
+class Anubis::SessionService < Anubis::CoreService
+  def initialize
+    super
+  end
+
+  def clear
+    self.redis.scan_each(:match => self.redis_prefix + 'session:*') do |key|
+      begin
+        data = JSON.parse redis.get(key), { symbolize_names: true }
+      rescue
+        data = {}
+      end
+      data[:ttl] = Time.now - 1.day unless data.key? :ttl
+      self.redis.del(key) if data[:ttl] < Time.now
+    end
+  end
+end

data/app/validators/presence_in_tenant_validator.rb

@@ -0,0 +1,20 @@
+class PresenceInTenantValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    if value
+      if value.class.to_s.index 'ActiveRecord_Associations_CollectionProxy'
+        value.each do |dat|
+          if record.tenant_id != dat.tenant_id
+            record.errors.add(attribute, :not_in_tenant, message: I18n.t('activerecord.errors.models.'+record.model_name.i18n_key.to_s+'.attributes.'+attribute.to_s+'.not_in_tenant', :default => ['activerecord.errors.messages.not_in_tenant'.to_sym]))
+            return
+          end
+        end
+      else
+        if record.tenant_id != value.tenant_id
+          record.errors.add(attribute, :not_in_tenant, message: I18n.t('activerecord.errors.models.'+record.model_name.i18n_key.to_s+'.attributes.'+attribute.to_s+'.not_in_tenant', :default => ['activerecord.errors.messages.not_in_tenant'.to_sym]))
+        end
+      end
+    else
+      record.errors.add(attribute, :blank, message: I18n.t('activerecord.errors.models.'+record.model_name.i18n_key.to_s+'.attributes.'+attribute.to_s+'.blank', :default => ['activerecord.errors.messages.blank'.to_sym]))
+    end
+  end
+end

data/config/initializers/mime_type.rb

@@ -0,0 +1 @@
+Mime::Type.register "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", :xlsx

data/config/locales/en.yml

@@ -0,0 +1,120 @@
+en:
+  success: Successful
+  errors:
+    no_api_version: API version not defined
+    invalid_locale: Invalid locale
+    access_not_allowed: Access not allowed
+    authentication_required: Authentication required
+    session_expired: Session expired
+    invalid_login_parameters: Invalid login parameters. Required 'login' and 'password'.
+    invalid_login_or_password: Invalid login or password
+    invalid_menu_output: Invalid menu output
+    internal_error: Internal error
+    update_error: Error updating data on server
+    delete_error: Error deleting data on server
+    incorrect_parameters: Incorrect request parameters
+    field_error: field error
+  install:
+    menu:
+      anoubis/admin:
+        title: Administration
+        page_title: System administration
+      anoubis/tenants:
+        title: Tenants
+        page_title: Tenants management
+        short_title: Tenants
+      anoubis/users:
+        title: Users
+        page_title: Users management
+        short_title: Users
+
+  anoubis:
+    default_tab: Default
+    default_tab_hint: This is default tab
+    install:
+      groups:
+        admin: Administrators
+        user: Users
+
+      tenant_title: System Tenant
+      system_title: Main System
+      admins_group: Administrators
+      admin_name: Administrator
+      admin_surname: Main
+    table:
+      buttons:
+        edit: "Edit: %{title}"
+        delete: "Delete: %{title}"
+    form:
+      titles:
+        edit: "Edit element: %{title}"
+        new: "Add new element"
+
+    tenants:
+      errors:
+        cant_change_ident: of system tetnant can't be changed
+        cant_destroy: System tetant can't be destroyed
+        has_childs: Tenant has child users or systems access
+    systems:
+      errors:
+        cant_change_ident: of main system can't be changed
+        cant_destroy: Main system can't be destroyed
+        has_childs: System has child groups
+    groups:
+      errors:
+        cant_change_admin_ident: of admin group can't be changed
+        cant_destroy_admin_group: Admin group of main system can't be destroyed
+        cant_destroy_group_with_users: Can't destroy group with users in it
+    users:
+      errors:
+        different_passwords: must be identical
+        cant_destroy_tenant_admin: Main Administrator can't be destroyed
+    menus:
+      errors:
+        has_childs: This menu has child sub menu
+    group_menus:
+      errors:
+        no_access: System of this group has no access to this menu
+
+  activerecord:
+    attributes:
+      anoubis/tenant/tenant:
+        title: Title
+        ident: Identifier
+      anoubis/tenant/system:
+        title: Title
+        ident: Identifier
+      anoubis/tenant/group:
+        title: Title
+        ident: Identifier
+      anoubis/tenant/user:
+        login: Login
+        email: Email
+        name: Name
+        surname: Surname
+        timezone: Timezone
+        password: Password
+        password_confirmation: Password confirmation
+        phone: Phone
+        auth_key: Authorization key
+        recover_key: Recovery key
+        status: Status
+        tenant: Tenant
+        timeout: Session timeout
+      anoubis/tenant/user_group:
+        group: Group
+        group_id: Group
+        user: User
+      anoubis/tenant/tenant_system:
+        tenant: Tenant
+        system: System
+      anoubis/tenant/menu:
+        mode: Path
+        action: Action
+        page_size: Page Size
+        position: Position
+      anoubis/tenant/menu_locale:
+        title: Title
+        page_title: Page Title
+        short_title: Short Title
+

data/config/locales/ru.yml

@@ -0,0 +1,245 @@
+ru:
+  all: Все
+  success: Успешное завершение
+  actions:
+      edit: "Редактировать: %{title}"
+      delete: "Удалить: %{title}"
+  errors:
+    no_api_version: Не указана версия API
+    invalid_locale: Некорректная версия локали
+    access_not_allowed: Доступ запрещен
+    authentication_required: Требуется авторизация пользователя
+    session_expired: Сессия завершена
+    invalid_login_parameters: Некорректные параметры входа. Требуется задать 'login' и 'password'.
+    invalid_login_or_password: Некорректный логин или пароль.
+    invalid_menu_output: Некорректный вывод меню
+    internal_error: Внутренняя ошибка сервера
+    update_error: Ошибка обновления данных на сервере
+    delete_error: Ошибка удаления данных на сервере
+    incorrect_parameters: Некорректные параметры запроса
+    field_error: ошибка поля
+  install:
+    menu:
+      anoubis/admin:
+        title: Управление
+        page_title: Управление системой
+      anoubis/tenants:
+        title: Тенанты
+        page_title: Управление тенантами
+        short_title: Тенанты
+      anoubis/users:
+        title: Пользователи
+        page_title: Управление пользователями
+        short_title: Пользователи
+
+  anoubis:
+    core:
+      success: Завершено корректно
+      errors:
+        incorrect_system: Некорректная система
+        incorrect_parameters: Некорректные параметры
+        error_changing_data: Ошибка изменения данных
+
+    default_tab: Основная
+    default_tab_hint: Это основная вкладка
+    months:
+      main:
+        - Январь
+        - Февраль
+        - Март
+        - Апрель
+        - Май
+        - Июнь
+        - Июль
+        - Август
+        - Сентябрь
+        - Октябрь
+        - Ноябрь
+        - Декабрь
+      second:
+        - Января
+        - Февраля
+        - Марта
+        - Апреля
+        - Мая
+        - Июня
+        - Июля
+        - Августа
+        - Сентября
+        - Октября
+        - Ноября
+        - Декабря
+      short:
+        - янв
+        - фев
+        - мар
+        - апр
+        - май
+        - июн
+        - июл
+        - авг
+        - сен
+        - окт
+        - ноя
+        - дек
+    install:
+      groups:
+        admin: Администраторы
+        user: Пользователи
+
+      tenant_title: Основной тенант
+      system_title: Основная система
+      admins_group: Администраторы
+      admin_name: Администратор
+      admin_surname: Главный
+    table:
+      buttons:
+        edit: "Редактировать: %{title}"
+        delete: "Удалить: %{title}"
+    form:
+      titles:
+        edit: "Редактирование элемента: %{title}"
+        show: "Просмотр элемента: %{title}"
+        new: "Добавление нового элемента"
+
+    tenants:
+      errors:
+        cant_change_ident: основного тенанта изменить нельзя
+        cant_destroy: Невозможно удалить основной тенант
+        has_childs: Тенант содержит пользователей или имеет доступ к системам
+    systems:
+      errors:
+        cant_change_ident: основной системы изменить нельзя
+        cant_destroy: Невозможно удалить основную систему
+        has_childs: Система содержит группы
+    groups:
+      errors:
+        cant_change_admin_ident: группы администрирования изменить нельзя
+        cant_destroy_admin_group: Группа администраторов основной системы не может быть удалена
+        cant_destroy_group_with_users: Нельзя удалить группу содержащую пользователей
+    users:
+      errors:
+        different_passwords: должен быть идентичным
+        cant_destroy_tenant_admin: Главный Администратор не может быть удален
+    menus:
+      errors:
+        has_childs: Меню имеет вложенные пункты меню
+    group_menus:
+      errors:
+        no_access: Система которой принадлежит группа не имеет доступа к данному пункту меню
+
+  activerecord:
+    options:
+      anoubis/locale:
+        ru: Русский
+        en: Английский
+        kz: Казахский
+      anoubis/group_menu:
+        access:
+          not: Не определен
+          read: Чтение
+          write: Запись
+          disabled: Блокирован
+    attributes:
+      anoubis/tenant:
+        title: Название
+        ident: Идентификатор
+      anoubis/system:
+        title: Название
+        ident: Идентификатор
+      anoubis/group:
+        title: Название
+        ident: Идентификатор
+      anoubis/user:
+        login: Логин
+        email: Электронный адрес
+        name: Имя
+        surname: Фамилия
+        timezone: Временная зона
+        password: Пароль
+        password_confirmation: Повтор пароля
+        phone: Телефон
+        auth_key: Ключ авторизации
+        recover_key: Ключ восстановления
+        status: Статус
+        tenant: Тенант
+        timeout: Время завершения сессии
+      anoubis/user_group:
+        group: Группа
+        group_id: Группа
+        user: Пользователь
+      anoubis/tenant_system:
+        tenant: Тенант
+        system: Система
+      anoubis/menu:
+        mode: Путь
+        action: Действие
+        page_size: Количество строк таблицы
+        position: Позиция
+      anoubis/menu_locale:
+        title: Название
+        page_title: Заголовок страницы
+        short_title: Короткое название
+
+    errors:
+      messages:
+        not_in_tenant: отсутсвует в тенанте
+        required: должен существовать
+        too_short:
+          one: "должен быть длиннее одного символа"
+          other: "должен быть больше %{count} символов"
+        too_long:
+          one: "должен быть длиннее одного символа"
+          other: "должен быть короче %{count} символов"
+        invalid: некорректен
+        record_invalid: некорректен
+        taken: уже существует
+        blank: не может быть пустым
+        not_an_integer: должен быть целым числом
+        not_a_number: должен быть вещественным числом
+        greater_than_or_equal_to: "должен быть больше или равен %{count}"
+        less_than_or_equal_to: "должен быть меньше или равен %{count}"
+        inclusion: "значение не попадает в список"
+
+      models:
+        anoubis/tenant/tenant:
+          attributes:
+            title:
+              too_short: "должно быть больше %{count} символов"
+              too_long: "должно быть короче %{count} символов"
+        anoubis/tenant/system:
+          attributes:
+            title:
+              too_short: "должно быть больше %{count} символов"
+              too_long: "должно быть короче %{count} символов"
+        anoubis/tenant/user_group:
+          attributes:
+            group:
+              required: должна существовать
+        anoubis/tenant/user:
+          attributes:
+            name:
+              too_long: "должно быть короче %{count} символов"
+            surname:
+              blank: не может быть пустой
+              too_long: "должна быть короче %{count} символов"
+            timeout:
+              not_a_number: "должно быть целым числом"
+              greater_than_or_equal_to: "должно быть больше или равно %{count}"
+
+        anoubis/tenant/tenant_system:
+          attributes:
+            system:
+              required: должна существовать
+        anoubis/tenant/menu:
+          attributes:
+            position:
+              not_a_number: должна быть целым числом
+            page_size:
+              greater_than_or_equal_to: "должно быть больше или равно %{count}"
+        anoubis/tenant/menu_locale:
+          attributes:
+            title:
+              too_short: "должно быть больше %{count} символов"
+              too_long: "должно быть короче %{count} символов"
+