anoubis_sso_client 1.0.1

data/app/models/anoubis_sso_client/application_record.rb

@@ -0,0 +1,125 @@
+##
+# Main Active Record object inherited from {https://www.rubydoc.info/gems/anoubis/Anoubis/ApplicationRecord Anoubis::ApplicationRecord}
+class AnoubisSsoClient::ApplicationRecord < Anoubis::ApplicationRecord
+  self.abstract_class = true
+
+  ##
+  # Returns SSO Menu model.
+  # Can be redefined in Rails.application configuration_anoubis_sso_menu_model configuration parameter.
+  # By default returns {AnoubisSsoClient::Menu} model class
+  # @return [Class] Menu model class
+  def self.menu_model
+    begin
+      value = Object.const_get Rails.configuration.anoubis_sso_menu_model
+    rescue StandardError
+      value = AnoubisSsoClient::Menu
+    end
+
+    value
+  end
+
+  ##
+  # Returns SSO Menu model.
+  # Can be redefined in Rails.application configuration_anoubis_sso_menu_model configuration parameter.
+  # By default returns {AnoubisSsoClient::Menu} model class
+  # @return [Class] Menu model class
+  def menu_model
+    AnoubisSsoClient::ApplicationRecord.menu_model
+  end
+
+  ##
+  # Returns SSO Group model.
+  # Can be redefined in Rails.application configuration_anoubis_sso_group_model configuration parameter.
+  # By default returns {AnoubisSsoClient::Group} model class
+  # @return [Class] Group model class
+  def self.group_model
+    begin
+      value = Object.const_get Rails.configuration.anoubis_sso_group_model
+    rescue StandardError
+      value = AnoubisSsoClient::Group
+    end
+
+    value
+  end
+
+  ##
+  # Returns SSO Group model.
+  # Can be redefined in Rails.application configuration_anoubis_sso_group_model configuration parameter.
+  # By default returns {AnoubisSsoClient::Group} model class
+  # @return [Class] Group model class
+  def group_model
+    AnoubisSsoClient::ApplicationRecord.group_model
+  end
+
+  ##
+  # Returns SSO GroupMenu model.
+  # Can be redefined in Rails.application configuration_anoubis_sso_group_menu_model configuration parameter.
+  # By default returns {AnoubisSsoClient::GroupMenu} model class
+  # @return [Class] GroupMenu model class
+  def self.group_menu_model
+    begin
+      value = Object.const_get Rails.configuration.anoubis_sso_group_menu_model
+    rescue StandardError
+      value = AnoubisSsoClient::GroupMenu
+    end
+
+    value
+  end
+
+  ##
+  # Returns SSO GroupMenu model.
+  # Can be redefined in Rails.application configuration_anoubis_sso_group_menu_model configuration parameter.
+  # By default returns {AnoubisSsoClient::GroupMenu} model class
+  # @return [Class] GroupMenu model class
+  def group_menu_model
+    AnoubisSsoClient::ApplicationRecord.group_menu_model
+  end
+
+  ##
+  # Returns SSO GroupUser model.
+  # Can be redefined in Rails.application configuration_anoubis_sso_group_user_model configuration parameter.
+  # By default returns {AnoubisSsoClient::GroupUser} model class
+  # @return [Class] GroupUser model class
+  def self.group_user_model
+    begin
+      value = Object.const_get Rails.configuration.anoubis_sso_group_user_model
+    rescue StandardError
+      value = AnoubisSsoClient::GroupUser
+    end
+
+    value
+  end
+
+  ##
+  # Returns SSO GroupUser model.
+  # Can be redefined in Rails.application configuration_anoubis_sso_group_user_model configuration parameter.
+  # By default returns {AnoubisSsoClient::GroupUser} model class
+  # @return [Class] GroupUser model class
+  def group_user_model
+    AnoubisSsoClient::ApplicationRecord.group_user_model
+  end
+
+  ##
+  # Returns SSO User model.
+  # Can be redefined in Rails.application configuration_anoubis_sso_user_model configuration parameter.
+  # By default returns {AnoubisSsoClient::User} model class
+  # @return [Class] User model class
+  def self.user_model
+    begin
+      value = Object.const_get Rails.configuration.anoubis_sso_user_model
+    rescue
+      value = AnoubisSsoClient::User
+    end
+
+    value
+  end
+
+  ##
+  # Returns SSO User model.
+  # Can be redefined in Rails.application configuration_anoubis_sso_user_model configuration parameter.
+  # By default returns {AnoubisSsoClient::User} model class
+  # @return [Class] User model class
+  def user_model
+    AnoubisSsoClient::ApplicationRecord.user_model
+  end
+end

data/app/models/anoubis_sso_client/group.rb

@@ -0,0 +1,101 @@
+##
+# User group model
+class AnoubisSsoClient::Group < AnoubisSsoClient::ApplicationRecord
+  self.table_name = 'groups'
+
+  ## Identifier validation constant
+  VALID_IDENT_REGEX = /\A[a-z]*\z/i
+
+  # @!attribute ident
+  #   @return [String] the group's identifier. Identifier consists of lowercase alphabetical symbols.
+  validates :ident, length: { minimum: 3, maximum: 50 }, uniqueness: { case_sensitive: false }, format: { with: VALID_IDENT_REGEX }
+
+  validates :title, presence: true, length: { maximum: 100 }
+
+  has_many :group_menus, class_name: 'AnoubisSsoClient::GroupMenu'
+  has_many :group_users, class_name: 'AnoubisSsoClient::GroupUser'
+
+  ##
+  # Returns title according by I18n.locale
+  # @return [String] Localized title
+  def title
+    get_locale_field 'title_locale'
+  end
+
+  ##
+  # Defines title according by I18n.locale
+  # @param value [String] Localized title
+  def title=(value)
+    set_locale_field 'title_locale', value
+  end
+
+  ##
+  # Create multi language group
+  # @param [Hash] params initial model options
+  # @option params [String] :ident group identifier
+  # @option params [String] :translate translate identifier
+  # @return [Group] returns created group object
+  def self.create_group(params)
+    return nil if !params.key? :ident
+    return nil if !params.key? :translate
+
+    group = group_model.find_or_create_by ident: params[:ident]
+
+    return nil unless group
+
+    I18n.available_locales.each do |locale|
+      I18n.locale = locale
+      group.title = I18n.t(params[:translate])
+    end
+    group.save if group.changed?
+
+    group
+  end
+
+  ##
+  # Add access to menu element for current group
+  # @param [Hash] params parameters
+  # @option params [Menu | Array<Menu>] :menu {Menu} model or array of {Menu} models
+  # @option params [String] :access access mode ('read', 'write', 'disable'). Optional. By default set to 'read'
+  def add_menu(params = {})
+    return if !params.has_key? :menu
+
+    params[:access] = 'read' unless params.key? :access
+
+    if params[:menu].class == Array
+      params[:menu].each do |menu|
+        data = group_menu_model.find_or_create_by group_id: id, menu: menu
+        if group_menu_model.accesses[params[:access].to_sym] > group_menu_model.accesses[data.access.to_sym]
+          data.access = params[:access]
+          data.save
+        end
+      end
+    else
+      data = group_menu_model.find_or_create_by group_id: id, menu: params[:menu]
+      if group_menu_model.accesses[params[:access].to_sym] > group_menu_model.accesses[data.access.to_sym]
+        data.access = params[:access]
+        data.save
+      end
+    end
+
+    nil
+  end
+
+  ##
+  # Add user to current group
+  # @param [Hash] params parameters
+  # @option params [User | Array<User>] :user {User} model or array of {User} models
+  def add_user(params = {})
+    return if !params.has_key? :user
+
+    if params[:user].class == Array
+      params[:user].each do |user|
+        group_menu_model.find_or_create_by group_id: id, user: user
+      end
+    else
+      group_menu_model.find_or_create_by group_id: id, user: params[:user]
+    end
+
+    nil
+  end
+end

data/app/models/anoubis_sso_client/group_menu.rb

@@ -0,0 +1,107 @@
+##
+# Model links {Menu} and {Group}. Describes group access to menu.
+class AnoubisSsoClient::GroupMenu < AnoubisSsoClient::ApplicationRecord
+  # Redefines default table name
+  self.table_name = 'group_menus'
+
+  before_validation :before_validation_sso_client_group_menu
+  after_create :after_create_sso_client_group_menu
+  before_update :before_update_sso_client_group_menu
+  after_destroy :after_destroy_sso_client_group_menu
+
+  # @!attribute group
+  #   @return [Group] reference to the {Group} model
+  belongs_to :group, class_name: 'AnoubisSsoClient::Group'
+  validates :group, presence: true, uniqueness: { scope: [:menu_id] }
+
+  # @!attribute menu
+  #   @return [Menu] reference to the {Menu} model
+  belongs_to :menu, class_name: 'AnoubisSsoClient::Menu'
+  validates :menu, presence: true, uniqueness: { scope: [:group_id] }
+
+  # @!attribute access
+  #   @return ['read', 'write', 'disable'] group access to menu element.
+  #     - 'read' --- group has access to menu element only for read data
+  #     - 'write' --- group has access to menu element for read and write data
+  #     - 'disable' --- group hasn't access to menu element
+  enum access: { read: 0, write: 50, disable: 100 }
+
+  ##
+  # Is called before validation when the link between menu and group is being created or updated.
+  # Procedure checks if group belongs a system that has access to this menu element. If {#access} doesn't
+  # defined then {#access} sets to 'read'
+  def before_validation_sso_client_group_menu
+    self.access = 'read' unless access
+  end
+
+  ##
+  # Is called after new link between menu and group was created. If new element has parent with link that
+  # doesn't present in database then adds this link to database with {#access} defined as 'read'.
+  def after_create_sso_client_group_menu
+    if menu.menu_id
+      AnoubisSsoClient::GroupMenu.find_or_create_by(menu_id: menu.menu_id, group_id: group_id) do |menu|
+        menu.access = 'read'
+      end
+    end
+  end
+
+  ##
+  # Is called before link between menu and group will be updated. Procedure prevents changing {#menu}
+  # and {#group} value.
+  def before_update_sso_client_group_menu
+    self.menu_id = menu_id_was if menu_id_changed?
+    self.group_id = group_id_was if group_id_changed?
+  end
+
+  ##
+  # Is called after link between menu and group had been deleted from database. It also deletes all child links.
+  def after_destroy_sso_client_group_menu
+    AnoubisSsoClient::Menu.select(:id).where(menu_id: menu_id).each do |menu|
+      AnoubisSsoClient::GroupMenu.where(menu_id: menu.id, group_id: group_id).each do |group_menu|
+        group_menu.destroy
+      end
+    end
+  end
+
+  ##
+  # Return localized title of menu element
+  # @return [String] localized title
+  def title
+    get_localized_menu 'title'
+  end
+
+  ##
+  # Return localized page_title of menu element
+  # @return [String] localized page_title
+  def page_title
+    get_localized_menu 'page_title'
+  end
+
+  ##
+  # Return localized short_title of menu element
+  # @return [String] localized short_title
+  def short_title
+    get_localized_menu 'short_title'
+  end
+
+  ##
+  # Return localized field
+  # @param [String] field Field name
+  # @return [String] localized field
+  def get_localized_menu(field)
+    loc_field = (field.to_s + '_locale').to_sym
+    begin
+      self[loc_field] = JSON.parse(self[loc_field]) if self[loc_field]
+    rescue
+
+    end
+
+    begin
+      result = get_locale_field loc_field.to_s
+    rescue
+      result = eval('self.menu.' + field.to_s)
+    end
+
+    result
+  end
+end

data/app/models/anoubis_sso_client/group_user.rb

@@ -0,0 +1,25 @@
+##
+# Model links {Menu} and {User}. Describes users that belongs to group.
+class AnoubisSsoClient::GroupUser < AnoubisSsoClient::ApplicationRecord
+  # Redefines default table name
+  self.table_name = 'group_users'
+
+  before_update :before_update_sso_client_group_user
+
+  # @!attribute group
+  #   @return [Group] reference to the {Group} model
+  belongs_to :group, class_name: 'AnoubisSsoClient::Group'
+  validates :group, presence: true, uniqueness: { scope: [:user_id] }
+
+  # @!attribute user
+  #   @return [User] reference to the {User} model
+  belongs_to :user, class_name: 'AnoubisSsoClient::User'
+  validates :user, presence: true, uniqueness: { scope: [:group_id] }
+
+  ##
+  # Procedure prevents changing {User} and {Group} data.
+  def before_update_sso_client_group_user
+    self.user_id = user_id_was if user_id.changed?
+    self.group_id = group_id_was if group_id.changed?
+  end
+end

data/app/models/anoubis_sso_client/menu.rb

@@ -0,0 +1,220 @@
+##
+# Main menu model
+class AnoubisSsoClient::Menu < AnoubisSsoClient::ApplicationRecord
+  # Redefines default table name
+  self.table_name = 'menus'
+
+  before_create :before_sso_client_create_menu
+  before_update :before_sso_client_update_menu
+  before_destroy :before_sso_client_destroy_menu
+  after_destroy :after_sso_client_destroy_menu
+
+  # @!attribute mode
+  #   @return [String] the controller path for menu element.
+  validates :mode, presence: true, uniqueness: true
+
+  # @!attribute action
+  #   @return [String] the default action of menu element ('data', 'menu', etc.).
+  validates :action, presence: true
+
+  # @!attribute tab
+  #   @return [Integer] the nesting level of menu element
+  validates :tab, presence: true, numericality: { only_integer: true, greater_than_or_equal_to: 0 }
+
+  # @!attribute position
+  #   @return [Integer] the order position of menu element in current level.
+  validates :position, presence: true, numericality: { only_integer: true, greater_than_or_equal_to: 0 }
+
+  # @!attribute page_size
+  #   @return [Integer] the default page size for table of data frame.
+  validates :page_size, numericality: { only_integer: true, greater_than_or_equal_to: 0 }
+
+  # @!attribute status
+  #   @return ['enabled', 'disabled'] the status of menu element.
+  #     - 'enabled' --- element is enabled and is used by the system.
+  #     - 'disabled' --- element is disabled and isn't used by the system.
+  enum status: { enabled: 0, disabled: 1 }
+
+  # @!attribute state
+  #   @return ['visible', 'hidden'] the visibility of menu element. Attribute is used in fronted application.
+  #     - 'visible' --- element is visible.
+  #     - 'hidden' --- element is hidden.
+  enum state: { visible: 0, hidden: 1 }
+
+  validates :title, presence: true, length: { maximum: 100 }
+  validates :page_title, presence: true, length: { maximum: 200 }
+  validates :short_title, presence: true, length: { maximum: 200 }
+
+  # @!attribute menu
+  #   @return [Menu, nil] the parent menu for element menu (if exists).
+  belongs_to :menu, class_name: 'AnoubisSsoClient::Menu', optional: true
+  has_many :menus, class_name: 'AnoubisSsoClient::Menu'
+  has_many :group_menus, class_name: 'AnoubisSsoClient::GroupMenu'
+
+  ##
+  # Is called before menu will be created in database. Sets {#position} as last {#position} + 1 on current {#tab}.
+  def before_sso_client_create_menu
+    data = AnoubisSsoClient::Menu.where(menu_id: menu_id).maximum(:position)
+    self.position = data ? data + 1 : 0
+
+    before_sso_client_update_menu
+  end
+
+  ##
+  # Is called before menu will be stored in database. Sets {#mode} and {#action} in lowercase. If {#page_size}
+  # doesn't defined then sets it to 20. If defined parent menu element then sets {#tab} based on {#tab} of
+  # parent menu element + 1.
+  def before_sso_client_update_menu
+    self.menu_id = nil if menu_id == ''
+    self.mode = mode.downcase
+    self.action = action.downcase
+    self.page_size = 20 unless page_size
+    self.page_size = page_size.to_i
+
+    parent_menu = AnoubisSsoClient::Menu.where(id: menu_id).first
+    self.tab = parent_menu ? parent_menu.tab + 1 : 0
+  end
+
+  ##
+  # Is called before menu will be deleted from database. Procedure clears most child components.
+  def before_sso_client_destroy_menu
+    unless menus.empty?
+      errors.add(:base, I18n.t('activerecord.errors.anoubis_sso_client/menu.errors.has_child_menus'))
+      throw(:abort, __method__)
+    end
+  end
+
+  ##
+  # Is called after menu was deleted from database. Procedure recalculates position of other menu elements.
+  def after_sso_client_destroy_menu
+    query = <<-SQL
+            UPDATE menus
+            SET menus.position = menus.position - 1
+            WHERE menus.tab = #{tab} AND menus.position > #{position}
+    SQL
+    AnoubisSsoClient::Menu.connection.execute query
+  end
+
+  ##
+  # Returns title according by I18n.locale
+  # @return [String] Localized title
+  def title
+    get_locale_field 'title_locale'
+  end
+
+  ##
+  # Defines title according by I18n.locale
+  # @param value [String] Localized title
+  def title=(value)
+    set_locale_field 'title_locale', value
+  end
+
+  ##
+  # Returns short title according by I18n.locale
+  # @return [String] Localized title
+  def short_title
+    get_locale_field 'short_title_locale'
+  end
+
+  ##
+  # Defines short title according by I18n.locale
+  # @param value [String] Localized short title
+  def short_title=(value)
+    set_locale_field 'short_title_locale', value
+  end
+
+  ##
+  # Returns page title according by I18n.locale
+  # @return [String] Localized page title
+  def page_title
+    get_locale_field 'page_title_locale'
+  end
+
+  ##
+  # Defines page title according by I18n.locale
+  # @param value [String] Localized page title
+  def page_title=(value)
+    set_locale_field 'page_title_locale', value
+  end
+
+  ##
+  # Create multi language menu
+  # @param [Hash] params initial model options
+  # @option params [String] :mode menu identifier
+  # @option params [String] :action menu action type ('data', 'menu' and etc.)
+  # @option params [String] :access access mode ('read', 'write', 'disable'). Optional. By default set to 'read'
+  # @option params [String] :state menu visibility ('visible', 'hidden'). Optional. By default set to 'visible'
+  # @option params [String] :page_size default table size for action 'data'. Optional. By default set 20
+  # @option params [String] :group User's group or array of user's group. Optional.
+  # @return [AnoubisSsoClient::Menu] returns created menu object
+  def self.create_menu(params)
+    return nil if !params.key? :mode
+    return nil if !params.key? :action
+
+    params[:access] = 'read' unless params.key? :access
+    params[:state] = 'visible' unless params.key? :state
+
+    data = AnoubisSsoClient::Menu.where(mode: params[:mode]).first
+    data = AnoubisSsoClient::Menu.create({ mode: params[:mode], action: params[:action] }) unless data
+
+    return unless data
+
+    data.action = params[:action]
+    if params.key? :parent
+      data.menu = params[:parent]
+    else
+      data.menu_id = nil
+    end
+    data.page_size = params.key?(:page_size) ? params[:page_size] : 20
+    data.state = params[:state]
+
+    prefix = "install.menu.#{params[:mode]}"
+
+    I18n.available_locales.each do |locale|
+      I18n.locale = locale
+      data.title = I18n.t("#{prefix}.title")
+      data.page_title = I18n.t("#{prefix}.page_title")
+      data.short_title = I18n.t("#{prefix}.short_title", default: data.title)
+    end
+
+    if data.changed?
+      unless data.save
+        puts data.errors.full_messages
+        return nil
+      end
+    end
+
+    data.add_group params
+
+    data
+  end
+
+  ##
+  # Add access to group for menu element
+  # @param [Hash] params parameters
+  # @option params [Group | Array<Group>] :group <Group> model or array of <Group> models
+  # @option params [String] :access access mode ('read', 'write', 'disable'). Optional. By default set to 'read'
+  def add_group(params = {})
+    return if !params.has_key? :group
+
+    params[:access] = 'read' unless params.key? :access
+
+    if params[:group].class == Array
+      params[:group].each do |group|
+        data = group_menu_model.find_or_create_by group: group, menu_id: id
+        if group_menu_model.accesses[params[:access].to_sym] > group_menu_model.accesses[data.access.to_sym]
+          data.access = params[:access]
+          data.save
+        end
+      end
+    else
+      data = group_menu_model.find_or_create_by group: params[:group], menu_id: id
+      if group_menu_model.accesses[params[:access].to_sym] > group_menu_model.accesses[data.access.to_sym]
+        data.access = params[:access]
+        data.save
+      end
+    end
+
+    nil
+  end
+end

data/app/models/anoubis_sso_client/user.rb

@@ -0,0 +1,91 @@
+##
+# User model
+class AnoubisSsoClient::User < AnoubisSsoClient::ApplicationRecord
+  self.table_name = 'users'
+
+  after_create :after_sso_client_create_user
+
+  ## Timezone
+  attr_accessor :timezone
+
+  ## Locale
+  attr_accessor :locale
+
+  before_validation :before_validation_sso_client_user_on_create, on: :create
+
+  validates :sso_uuid, presence: true, uniqueness: { case_sensitive: true }
+  validates :uuid, presence: true, length: { maximum: 40 }, uniqueness: { case_sensitive: true }
+
+  has_many :group_users, class_name: 'AnoubisSsoClient::GroupUser'
+
+  ##
+  # Fires before create any User on the server. Procedure generates internal UUID and setup timezone to GMT.
+  # Public user identifier is generated also if not defined.
+  def before_validation_sso_client_user_on_create
+    self.uuid = setup_private_user_id
+  end
+
+  ##
+  # Procedure setup private user identifier. Procedure can be redefined.
+  # @return [String] public user identifier
+  def setup_private_user_id
+    SecureRandom.uuid
+  end
+
+  ##
+  # Update user data information in user database
+  # @param user_data [Hash] - User data information received from SSO server
+  def update_user_data(user_data)
+    self.name = user_data[:name] if user_data.key? :name
+    self.surname = user_data[:surname] if user_data.key? :surname
+    self.email = user_data[:email] if user_data.key? :email
+    self.timezone = user_data.key?(:timezone) ? user_data[:timezone] : 'GMT'
+    self.locale = user_data.key?(:locale) ? user_data[:locale] : 'ru-RU'
+  end
+
+  ##
+  # Returns user data for saving into the session
+  def session_data
+    {
+      name: name,
+      surname: surname,
+      email: email,
+      locale: locale,
+      timezone: timezone
+    }
+  end
+
+  ##
+  # Fires after create new user.
+  def after_sso_client_create_user
+    attach_groups
+  end
+
+  ##
+  # Procedure attaches groups to new created user. By default visitor group is attached to new user
+  def attach_groups
+    gr = group_model.where(ident: 'visitor').first
+
+    return unless gr
+
+    add_group group: gr
+  end
+
+  ##
+  # Add current user to the group
+  # @param [Hash] params parameters
+  # @option params [Group | Array<Group>] :group <Group> model or array of <Group> models
+  def add_group(params = {})
+    return if !params.has_key? :group
+
+    if params[:group].class == Array
+      params[:group].each do |group|
+        group_user_model.find_or_create_by group: group, user_id: id
+      end
+    else
+      group_user_model.find_or_create_by group: params[:group], user_id: id
+    end
+
+    nil
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,28 @@
+en:
+  anoubis:
+    install:
+      groups:
+        admin: "Administrators"
+        user: "Users"
+        visitor: "Visitor"
+
+  activerecord:
+    errors:
+      anoubis_sso_client/menu:
+        errors:
+          has_child_menus: "Has child menu elements"
+
+  install:
+    menu:
+      dashboard:
+        title: "Dashboard"
+        page_title: "Dashboard"
+        short_title: "Dashboard"
+      settings:
+        title: "Settings"
+        page_title: "Settings"
+        short_title: "Settings"
+      settings/menu:
+        title: "Menu"
+        page_title: "Menu administration"
+        short_title: "Menu"