anoubis 1.0.1 → 1.0.10

data/app/controllers/anoubis/data/setup.rb

@@ -0,0 +1,102 @@
+module Anoubis
+  ##
+  # Module consists all procedures and functons of {DataController}
+  module Data
+    ##
+    # Module setups system parameters for {DataController}
+    module Setup
+      ##
+      # Setups frame data information. It loads menu data, sets titles and tabs of the frame.
+      def setup_frame
+        self.load_menu_data
+        if self.etc.menu
+          self.get_parent_data
+          if self.etc.data.parent
+            self.output.title = self.etc.menu.page_title.sub '%{title}', self.etc.data.parent.sys_title.to_s
+          else
+            self.output.title = self.etc.menu.page_title
+          end
+          self.output.short = self.etc.menu.short_title
+          self.output.mode = self.etc.menu.mode
+          self.output.access = self.etc.menu.access
+        end
+        tabs = self.tabs
+        tabs.each do |key, item|
+          item = self.get_tab key, item
+          self.output.addTab(item)
+        end
+      end
+
+      ##
+      # Setups order for current tab. Parameters is set into {Anoubis::Etc::TabItem#sort self.etc.tab.sort} and
+      # {Anoubis::Etc::TabItem#order self.etc.tab.order} attributes.
+      def setup_order
+        sort = nil
+        first = nil
+        self.etc.data.fields.each do |key, field|
+          if field.order
+            first = key if !first
+            first = key if field.order.default
+            if params.key? :sort
+              sort = key if params[:sort] == key.to_s
+            end
+          end
+        end
+        sort = first if !sort
+        if sort
+          self.etc.tab.sort = sort.to_s
+          self.etc.tab.order = self.etc.data.fields[sort].order.order
+          if params.key? :order
+            self.etc.tab.order = :desc if params[:order] == 'desc'
+            self.etc.tab.order = :asc if params[:order] == 'asc'
+          end
+        end
+      end
+
+      ##
+      # @!group Block of fields setup functions
+
+      ##
+      # Setups defined fields and places it into attribute {Anoubis::Etc::Data#fields self.etc.data.fields}
+      def setup_fields
+        if !self.etc.data.fields
+          self.etc.data.fields = {}
+
+          fields = self.fields
+
+          fields.each_key do |key|
+            if fields[key].key? :edit
+              if self.menu_access fields[key][:edit], false
+                fields[key][:editable] = fields[key][:edit]
+              end
+            end
+            self.etc.data.fields[key] = Anoubis::Etc::Field.new(key, self.get_model, fields[key].merge(action: self.etc.action))
+          end
+          self.setup_order if %w[index export].include? self.etc.action
+        end
+      end
+
+      ##
+      # Setups additional parameters for table field with type 'datetime'
+      # Resulting data placed in {Etc::Data#fields self.etc.data.fields} (Hash)
+      # @param key [Symbol] key of table field.
+      def setup_fields_datetime (key)
+        self.etc.data.fields[key][:format] = 'full' if !self.etc.data.fields[key].has_key? :format
+        self.etc.data.fields[key][:format] = 'full' if !['full', 'month', 'date', 'datetime'].include? self.etc.data.fields[key][:format]
+      end
+
+
+
+      ##
+      # Setups additional parameters for table field with type 'float'
+      # Resulting data placed in {Etc::Data#fields self.etc.data.fields} (Hash)
+      # @param key [Symbol] key of table field.
+      def setup_fields_float (key)
+        self.etc.data.fields[key][:precision] = 2 if !self.etc.data.fields[key][:precision]
+        self.etc.data.fields[key][:point] = ',' if !self.etc.data.fields[key][:point]
+        self.etc.data.fields[key][:separator] = '' if !self.etc.data.fields[key][:separator]
+      end
+      # @!endgroup
+    end
+  end
+end

data/app/controllers/anoubis/data_controller.rb

@@ -0,0 +1,21 @@
+require_dependency "anoubis/data/actions"
+require_dependency "anoubis/data/load"
+require_dependency "anoubis/data/get"
+require_dependency "anoubis/data/set"
+require_dependency "anoubis/data/setup"
+require_dependency "anoubis/data/defaults"
+require_dependency "anoubis/data/convert"
+require_dependency "anoubis/data/callbacks"
+
+##
+# Main data controller class
+class Anoubis::DataController < Anoubis::ApplicationController
+  include Anoubis::Data::Actions
+  include Anoubis::Data::Load
+  include Anoubis::Data::Get
+  include Anoubis::Data::Set
+  include Anoubis::Data::Setup
+  include Anoubis::Data::Defaults
+  include Anoubis::Data::Convert
+  include Anoubis::Data::Callbacks
+end

data/app/controllers/anoubis/etc/field.rb

@@ -152,6 +152,13 @@ module Anoubis
 
       end
 
+      ##
+      # Initialize additional parameters for {Anoubis::Etc::Field#type 'hash' field type} for controller actions.
+      # @param options [Hash] field's initial options
+      def initialize_hash (options)
+
+      end
+
       ##
       # Initialize additional parameters for {Anoubis::Etc::Field#type 'number' field type} for controller actions.
       # @param options [Hash] field's initial options

data/app/controllers/anoubis/output/basic.rb

@@ -30,7 +30,7 @@ module Anoubis
         self.result = 0
         self.tab = ''
         self.messages = {
-            '0': I18n.t('success'),
+            '0': I18n.t('anoubis.success'),
             '-1': I18n.t('errors.access_not_allowed'),
             '-2': I18n.t('errors.incorrect_parameters')
         }

data/app/controllers/anoubis/sso/client/index_controller.rb

@@ -1,5 +1,5 @@
-require_dependency "anubis/sso/client/index/actions"
-require_dependency "anubis/sso/client/index/callbacks"
+require_dependency "anoubis/sso/client/index/actions"
+require_dependency "anoubis/sso/client/index/callbacks"
 
 class Anoubis::Sso::Client::IndexController < Anoubis::Sso::Client::ApplicationController
   include Anoubis::Sso::Client::Index::Actions

data/app/controllers/anoubis/sso/server/login_controller.rb

@@ -23,7 +23,7 @@ class Anoubis::Sso::Server::LoginController < Anoubis::Sso::Server::ApplicationC
 
     result = {
       result: 0,
-      message: I18n.t('core.success')
+      message: I18n.t('anoubis.success')
     }
     code = 200
 
@@ -107,7 +107,7 @@ class Anoubis::Sso::Server::LoginController < Anoubis::Sso::Server::ApplicationC
   def create
     result = {
       result: 0,
-      message: I18n.t('core.success')
+      message: I18n.t('anoubis.success')
     }
     code = 200
 
@@ -155,7 +155,7 @@ class Anoubis::Sso::Server::LoginController < Anoubis::Sso::Server::ApplicationC
   def update
     result = {
       result: 0,
-      message: I18n.t('core.success')
+      message: I18n.t('anoubis.success')
     }
 
     if self.system
@@ -213,7 +213,7 @@ class Anoubis::Sso::Server::LoginController < Anoubis::Sso::Server::ApplicationC
   def destroy
     result = {
       result: 0,
-      message: I18n.t('core.success')
+      message: I18n.t('anoubis.success')
     }
 
     begin
@@ -263,7 +263,7 @@ class Anoubis::Sso::Server::LoginController < Anoubis::Sso::Server::ApplicationC
   def show
     result = {
       result: 0,
-      message: I18n.t('core.success')
+      message: I18n.t('anoubis.success')
     }
 
     if self.system

data/app/controllers/anoubis/sso/server/user_controller.rb

@@ -6,7 +6,7 @@ class Anoubis::Sso::Server::UserController < Anoubis::Sso::Server::ApplicationCo
   def show
     result = {
       result: 0,
-      message: I18n.t('anubis.core.success')
+      message: I18n.t('anoubis.success')
     }
     code = 200
 
@@ -25,7 +25,7 @@ class Anoubis::Sso::Server::UserController < Anoubis::Sso::Server::ApplicationCo
   def update
     result = {
       result: 0,
-      message: I18n.t('anubis.core.success')
+      message: I18n.t('anoubis.success')
     }
     code = 200
 

data/app/controllers/anoubis/tenant/index_controller.rb

@@ -1,6 +1,6 @@
-require_dependency "anubis/tenant/application_controller"
-require_dependency "anubis/tenant/index/actions"
-require_dependency "anubis/tenant/index/callbacks"
+require_dependency "anoubis/tenant/application_controller"
+require_dependency "anoubis/tenant/index/actions"
+require_dependency "anoubis/tenant/index/callbacks"
 
 module Anoubis
   ##

data/app/models/anoubis/application_record.rb

@@ -2,9 +2,29 @@
 class Anoubis::ApplicationRecord < ActiveRecord::Base
   self.abstract_class = true
 
+  after_initialize :initialize_anubis_application_record
+
   ## Redis database variable
   attr_accessor :redis
 
+  # @!attribute [rw] need_refresh
+  #   @return [Boolean] defines when table representation data should be updated even after simple update
+  attr_accessor :need_refresh
+
+  ##
+  # Fires after ApplicationRecord initialized for define default values
+  def initialize_anubis_application_record
+    self.need_refresh = false
+
+    after_initialize_anubis_application_record
+  end
+
+  ##
+  # Fires after initialize default variables
+  def after_initialize_anubis_application_record
+
+  end
+
   ##
   # Returns {https://github.com/redis/redis-rb Redis database} class
   # @return [Class] {https://github.com/redis/redis-rb Redis} class reference
@@ -42,4 +62,125 @@ class Anoubis::ApplicationRecord < ActiveRecord::Base
     end
     return value + ':'
   end
+
+  ##
+  # Return defined locale according by I18n
+  # @return [String] current locale
+  def current_locale
+    I18n.locale.to_s
+  end
+
+  ##
+  # Returns {current_locale}. If current locale isn't set then returns {default_locale}.
+  # @return [String] current locale
+  def get_locale
+    if current_locale && current_locale != ''
+      return current_locale
+    end
+
+    default_locale
+  end
+
+  ##
+  # Default locale that setup in Rails.configuration.i18n.default_locale configuration parameter
+  # @return [String] default locale
+  def default_locale
+    Rails.configuration.i18n.default_locale.to_s
+  end
+
+  ##
+  # Returns localized field by identifier
+  # @param field [String] Field identifier
+  # @param used_locale [String | nil] Locale identifier (by default used {current_locale})
+  # @return [String] localized field
+  def get_locale_field(field, used_locale = nil)
+    field = field.to_s.to_sym
+    used_locale = current_locale.to_s unless used_locale
+
+    return '' unless self[field]
+    return self[field][used_locale] if self[field].key? used_locale
+    return '' unless self[field].key? default_locale.to_s
+
+    self[field][default_locale.to_s]
+  end
+
+  ##
+  # Sets localized data
+  # @param field [String] field identifier
+  # @param value [String] localized string
+  # @param used_locale [String | nil] Locale identifier (by default used {current_locale})
+  def set_locale_field(field, value, used_locale = nil)
+    field = field.to_s.to_sym
+    used_locale = current_locale.to_s unless used_locale
+
+    self[field] = {} unless self[field]
+    self[field][default_locale.to_s] = value unless self[field].key? default_locale.to_s
+    self[field][used_locale] = value
+  end
+
+  ##
+  # Returns true if field has localized data
+  # @param field [String] Field identifier
+  # @param used_locale [String | nil] Locale identifier (by default used {current_locale})
+  # @return [Boolean] true if field has localized data
+  def is_field_localized(field, used_locale = nil)
+    field = field.to_s.to_sym
+    used_locale = current_locale.to_s unless used_locale
+
+    return false unless self[field]
+    return true if self[field].key? used_locale
+
+    false
+  end
+
+  ##
+  # Checks if this record may be destroyed.
+  def can_destroy?
+    result = true
+    self.class.reflect_on_all_associations.all? do |assoc|
+      result = self.send(assoc.name).nil? if assoc.macro == :has_one
+      result = self.send(assoc.name).empty? if (assoc.macro == :has_many) && result
+    end
+    result
+  end
+
+  ##
+  # Returns system title of table element
+  # @return [String] System title
+  def sys_title
+    id.to_s
+  end
+
+  ##
+  # Returns the ability to create new data. By default all items may be deleted. For another result
+  # procedure should be overridden.
+  # @param args [Hash] transferred parameters
+  # @option args [String] :controller Called controller identifier
+  # @option args [String] :tab Called controller tab element
+  # @return [Boolean] true if new data may be created.
+  def can_new(args = {})
+    true
+  end
+
+  ##
+  # Returns the ability to edit the data. By default all items may be edited. For another result
+  # procedure should be overridden.
+  # @param args [Hash] transferred parameters
+  # @option args [String] :controller Called controller identifier
+  # @option args [String] :tab Called controller tab element
+  # @return [Boolean] true if data may be edited
+  def can_edit(args = {})
+    true
+  end
+
+  ##
+  # Returns the ability to delete a data. By default all items may be deleted. For another result
+  # procedure should be overridden.
+  # @param args [Hash] transferred parameters
+  # @option args [String] :controller Called controller identifier
+  # @option args [String] :tab Called controller tab element
+  # @return [Boolean] true if data may be deleted
+  def can_delete(args = {})
+    true
+  end
 end

data/app/services/anoubis/log_service.rb

@@ -0,0 +1,97 @@
+##
+# Graylog logging service
+class Anoubis::LogService
+  # {https://www.rubydoc.info/gems/gelf/GELF/Notifier GELF::Notifier} service
+  attr_accessor :logger
+  # Hash of permanent parameters that added before sending data to Graylog server
+  attr_accessor :perm
+
+  ##
+  # Returns Graylog server URL
+  # @return [String] Graylog server URL
+  def url
+    begin
+      value = Rails.configuration.graylog_server
+    rescue StandardError
+      value = '127.0.0.1'
+    end
+
+    value
+  end
+
+  ##
+  # Returns Graylog server port
+  # @return [String] Graylog server port
+  def port
+    begin
+      value = Rails.configuration.graylog_port
+    rescue StandardError
+      value = 12201
+    end
+
+    value
+  end
+
+  ##
+  # Returns Graylog facility identifier in input source
+  # @return [String] Graylog facility identifier
+  def facility
+    begin
+      value = Rails.configuration.graylog_facility
+    rescue StandardError
+      value = 'Graylog'
+    end
+
+    value
+  end
+
+  ##
+  # Setups basic initialization parameters.
+  def initialize
+    self.logger = GELF::Notifier.new(url, port, 'WAN', { facility: facility })
+    logger.collect_file_and_line = false
+    logger.rescue_network_errors = true
+    self.perm = {}
+  end
+
+  ##
+  # Send data to Graylog server
+  # @param text [String] Logged text data
+  # @param type [String] Log level ('debug', 'error', 'info', 'warn')
+  # @param object [Hash] Additional parameters for logged data
+  def log(text, type = 'info', object = nil)
+    type = 'info' unless %w[info warn error].include? type.downcase
+    loc = caller_locations(1, 1).first
+
+    data = {
+      short_message: text,
+      level: level(type),
+      line: loc.lineno,
+      file: loc.path
+    }
+
+    data.merge!(object) if object
+    data.merge!(self.perm)
+    logger.notify data
+    nil
+  end
+
+  ##
+  # Returns {https://www.rubydoc.info/github/graylog-labs/gelf-rb/GELF/Levels GELF::Levels} according by type
+  # @param type [String] Log level ('debug', 'error', 'info', 'warn')
+  # @return [GELF::Levels] GELF::Levels
+  def level(type)
+    case type
+    when 'debug'
+      return GELF::DEBUG
+    when 'info'
+      return GELF::INFO
+    when 'warn'
+      return GELF::WARN
+    when 'error'
+      return GELF::ERROR
+    end
+
+    GELF::UNKNOWN
+  end
+end

data/app/services/anoubis/request_service.rb

@@ -0,0 +1,134 @@
+##
+# Request service
+class Anoubis::RequestService
+  ## Redis database variable
+  attr_accessor :redis
+
+  ## Returns {https://github.com/redis/redis-rb Redis} prefix for storing cache data
+  attr_accessor :redis_prefix
+
+  ## Log service {Anoubis::LogService}
+  attr_accessor :log
+
+  ## Cookies data for current session
+  attr_accessor :cookies
+
+  ##
+  # Setups basic initialization parameters.
+  # @param log [Anoubis::LogService] Log service
+  def initialize(log = nil)
+    self.redis = Redis.new
+    @cookies = nil
+    self.log = log ? log : Anoubis::LogService.new
+  end
+
+  ##
+  # Returns cookies data for current session
+  # @return [Hash] Cookies data
+  def cookies
+    return @cookies if @cookies
+
+    @cookies = redis.get cookie_path
+    if @cookies
+      begin
+        @cookies = JSON.parse(self.cookies, { symbolize_names: true })
+      rescue
+        @cookies = {}
+      end
+    else
+      @cookies = {}
+    end
+
+    @cookies
+  end
+
+  ##
+  # Setups cookies data for current session
+  # @param data [Hash] Defined cookies parameters
+  def cookies=(data)
+    @cookies = data
+    store_cookies
+  end
+
+  ##
+  # Returns redis path for storing cookies data
+  # @return [String] Redis storing path
+  def cookie_path
+    redis_prefix + 'cookies'
+  end
+
+  ##
+  # Store current cookies to {https://github.com/redis/redis-rb Redis} cache
+  def store_cookies
+    redis.set cookie_path, @cookies.to_json
+  end
+
+  ##
+  # Unzip {https://www.rubydoc.info/gems/rest-client/RestClient RestClient} response data if returned data is GZipped
+  # @param response [RestClient::RawResponse] Received {https://www.rubydoc.info/gems/rest-client/RestClient/RawResponse RestClient::RawResponse}
+  # @return [String] Unzipped string
+  def unzip(response)
+    result = response.body
+    begin
+      if response.headers.key? :content_encoding
+        if response.headers[:content_encoding] == 'gzip'
+          sio = StringIO.new( response.body )
+          gz = Zlib::GzipReader.new( sio )
+          result = gz.read()
+        end
+      end
+    rescue => e
+      self.log 'Error was received when page encoded. ' + e.to_s, 'debug'
+      result = nil
+    end
+
+    result
+  end
+
+  ##
+  # Store data to file
+  # @param file_name [String] Name of file
+  # @param text [String] Saved text
+  def store(file_name, text)
+    file = File.open(file_name, "w")
+    file.write(text)
+    file.close
+  end
+
+  ##
+  # Transform cookies string to hash
+  # @param str [String] Cookies string
+  # @return [Hash] Cookies data
+  def parse_cookie(str)
+    cookies = { }
+
+    arr = str.split('; ')
+    arr.each do |line|
+      index = line.index '='
+      if index
+        key = line[0..(index - 1)]
+        value = line[(index + 1)..(line.length - 1)]
+      end
+      cookies[key.to_s.to_sym] = value.to_s
+    end
+
+    cookies
+  end
+
+  ##
+  # Returns {https://github.com/redis/redis-rb Redis} prefix for storing cache data. Prefix can be set in Rails.configuration.anoubis_redis_prefix configuration parameter.
+  # @return [String] {https://github.com/redis/redis-rb Redis} prefix
+  def redis_prefix
+    @redis_prefix ||= get_redis_prefix
+  end
+
+  private def get_redis_prefix
+    begin
+      value = Rails.configuration.anoubis_redis_prefix
+    rescue
+      return ''
+    end
+
+    value + ':'
+  end
+end

data/config/locales/en.yml

@@ -30,16 +30,30 @@ en:
 
 
 
+
+
+
   anoubis:
-    all: All
-    success: Successful
-    error: Error
+    all: "All"
+    success: "Successful"
+    error: "Error"
+    errors:
+      incorrect_login: "Incorrect login or password"
+      incorrect_user: "Incorrect user"
+      access_not_allowed: "Access not allowed"
+      session_expired: "Session expired"
     install:
       menu:
         dashboard:
-          title: Dashboard
-          page_title: Dashboad
-          short_title: Dashboard
+          title: "Dashboard"
+          page_title: "Dashboard"
+          short_title: "Dashboard"
+
+
+
+
+
+