lato_core 1.1.1 → 1.1.3

data/lib/lato_core/interface/navigation.rb

@@ -1,108 +1,94 @@
 module LatoCore
-  module Interface
-    # Insieme di funzioni che determinano e gestiscono le informazioni
-    # riguardo alla navigazione tra le sezioni offerte dai moduli lato
-    module Navigation
-      
-      # Ritorna un array contenente le voci che andranno a formare il menu
-      # di navigazione del backoffice.
-      # * *Returns* :
-      # - array di hash contenenti i dati delle voci di menu
-      def core_getNavbarItems
-        return CORE_NAVIGATION if defined? CORE_NAVIGATION
-        getApplicationNavbarItems + getLatoNavbarItems
-      end
+  # This module contains funtions used for the navigation inside the application.
+  module Interface::Navigation
+
+    # This function return an array with navbar voices.
+    def core_getNavbarItems
+      return CORE_NAVIGATION if defined? CORE_NAVIGATION
+      getApplicationNavbarItems + getLatoNavbarItems
+    end
 
-      # Ritorna un array contenente le voci delle gemme lato che andranno
-      # a formare il menu di navigazione del backoffice.
-      # * *Returns* :
-      # - array di hash contenenti i dati delle voci di menu
-      private def getLatoNavbarItems
-        # inizializzo la lista delle voci della navbar
-        navbar_items = []
-        # identifico la lista di gemme del progetto Lato usate dalla
-        # applicazione
-        gems = core_getLatoGems
-        # per ogni gemma estraggo i dati necessari a riempire la navbar
-        gems.each do |name|
-          module_name = name.camelize
-          module_root = module_name.constantize::Engine.root
+    # This function return an array with lato navbar voices.
+    private def getLatoNavbarItems
+      # inizializzo la lista delle voci della navbar
+      navbar_items = []
+      # identifico la lista di gemme del progetto Lato usate dalla
+      # applicazione
+      gems = core_getLatoGems
+      # per ogni gemma estraggo i dati necessari a riempire la navbar
+      gems.each do |name|
+        module_name = name.camelize
+        module_root = module_name.constantize::Engine.root
 
-          next unless File.exist? "#{module_root}/config/config.yml"
-          # accedo al config.yml
-          config = YAML.load(
-            File.read(File.expand_path("#{module_root}/config/config.yml",
-                                       __FILE__))
-          )
-          # estraggo i dati dallo yaml
-          data = getConfigNavbarData(config)
-          # aggiungo i dati nella risposta
-          data.each do |single_voice|
-            navbar_items.push(single_voice)
-          end
+        next unless File.exist? "#{module_root}/config/config.yml"
+        # accedo al config.yml
+        config = YAML.load(
+          File.read(File.expand_path("#{module_root}/config/config.yml",
+                                     __FILE__))
+        )
+        # estraggo i dati dallo yaml
+        data = getConfigNavbarData(config)
+        # aggiungo i dati nella risposta
+        data.each do |single_voice|
+          navbar_items.push(single_voice)
         end
-        # ritorno il risultato
-        navbar_items
       end
+      # ritorno il risultato
+      navbar_items
+    end
 
-      # Ritorna un array contenente le voci della applicazione principale
-      # che andranno a formare il menu di navigazione del backoffice.
-      # * *Returns* :
-      # - array di hash contenenti i dati delle voci di menu
-      private def getApplicationNavbarItems
-        directory = core_getCacheDirectory
-        # inizializzo la lista delle voci della navbar
-        navbar_items = []
+    # This function return an array with application navbar voices.
+    private def getApplicationNavbarItems
+      directory = core_getCacheDirectory
+      # inizializzo la lista delle voci della navbar
+      navbar_items = []
 
-        if File.exist? "#{directory}/config.yml"
-          # accedo al config.yml
-          directory = core_getCacheDirectory
-          config = YAML.load(
-            File.read(File.expand_path("#{directory}/config.yml", __FILE__))
-          )
-          # estraggo i dati dallo yaml
-          data = getConfigNavbarData(config)
-          # aggiungo i dati nella risposta
-          data.each do |single_voice|
-            navbar_items.push(single_voice)
-          end
+      if File.exist? "#{directory}/config.yml"
+        # accedo al config.yml
+        directory = core_getCacheDirectory
+        config = YAML.load(
+          File.read(File.expand_path("#{directory}/config.yml", __FILE__))
+        )
+        # estraggo i dati dallo yaml
+        data = getConfigNavbarData(config)
+        # aggiungo i dati nella risposta
+        data.each do |single_voice|
+          navbar_items.push(single_voice)
         end
-        # ritorno il risultato
-        navbar_items
       end
+      # ritorno il risultato
+      navbar_items
+    end
 
-      # Estrae i dati relativi alla navbar dal file config.yml di una
-      # applicazione controllando che la struttura del file sia corretta
-      private def getConfigNavbarData(config)
-        # inizializzo la lista di dati
-        results = []
-        # se il file e' formattato correttamente esamino ogni sua voce
-        if config and config['menu']
-          config['menu'].each do |voice|
-            # estraggo i dati
-            unique_name = voice[0]
-            name = voice[1]['name'].capitalize
-            url = voice[1]['url'].downcase
-            icon = voice[1]['icon'].downcase
-            position = voice[1]['position']
-            permission = voice[1]['permission']
-            # genero l'oggetto con le informazioni di output
-            output_voice = {
-              unique_name: unique_name,
-              name: name,
-              url:  url,
-              icon: icon,
-              position: position,
-              permission: permission
-            }
-            # aggiungo la voce al risultato
-            results.push(output_voice)
-          end
+    # This function read and return config datas about navbar from a config file.
+    private def getConfigNavbarData(config)
+      # inizializzo la lista di dati
+      results = []
+      # se il file e' formattato correttamente esamino ogni sua voce
+      if config and config['menu']
+        config['menu'].each do |voice|
+          # estraggo i dati
+          unique_name = voice[0]
+          name = voice[1]['name'].capitalize
+          url = voice[1]['url'].downcase
+          icon = voice[1]['icon'].downcase
+          position = voice[1]['position']
+          permission = voice[1]['permission']
+          # genero l'oggetto con le informazioni di output
+          output_voice = {
+            unique_name: unique_name,
+            name: name,
+            url:  url,
+            icon: icon,
+            position: position,
+            permission: permission
+          }
+          # aggiungo la voce al risultato
+          results.push(output_voice)
         end
-        # ritorno il risultato
-        results
       end
-
+      # ritorno il risultato
+      results
     end
 
   end

data/lib/lato_core/interface/session.rb

@@ -1,71 +1,57 @@
 module LatoCore
-  module Interface
-    # Insieme di funzioni che permettono alla applicazione di gestire
-    # le sessioni di utenze per l'accesso al backoffice.
-    module Session
-      
-      # Funzione che crea una nuova sessione per permettere di accedere
-      # alle funzionalita' del backoffice.
-      # * *Args* :
-      # - +username+ -> username dell'utente
-      # - +password+ -> password dell'utente
-      # * *Returns* :
-      # - true se l'utente se la sessione e' stata creata correttamente
-      # - false se i dati ricevuti come parametro non sono corretti
-      def core_createSession(username, password)
-        user = LatoCore::Superuser.find_by(username: username)
-        if user && user.authenticate(password)
-          # genero un session_code
-          code = SecureRandom.urlsafe_base64
-          # memorizzo il session_code sul db
-          user.update_attribute('session_code', code)
-          # genero le sessioni
-          session[:user] = user.id
-          session[:session_code] = code
-          # ritorno true
-          return true
-        else
-          # ritorno false
-          return false
-        end
+  # This module contains functions used to get information about user session.
+  module Interface::Session
+
+    # This function create a new session for user with username and
+    # password received as params.
+    def core_createSession(username, password)
+      user = LatoCore::Superuser.find_by(username: username)
+      if user && user.authenticate(password)
+        # genero un session_code
+        code = SecureRandom.urlsafe_base64
+        # memorizzo il session_code sul db
+        user.update_attribute('session_code', code)
+        # genero le sessioni
+        session[:user] = user.id
+        session[:session_code] = code
+        # ritorno true
+        return true
+      else
+        # ritorno false
+        return false
       end
+    end
 
-      # Funzione che elimina una sessione di accesso al backoffice se presente
-      # * *Returns* :
-      # - true se la sessione e' stata eliminata
-      # - false se la sessione e' ancora attiva
-      def core_destroySession
-        if session[:user] && session[:session_code]
-          # determino l'utente della sessione
-          user = LatoCore::Superuser.find(session[:user])
-          # se l'utente esiste elimino il suo session_code dal db
-          user.update_attribute('session_code', nil) if user
-          # elimino le sessioni
-          session[:user] = nil
-          session[:session_code] = nil
-          # ritorno true
-          return true
-        else
-          # ritorno false
-          return false
-        end
+    # This function destroy the current user session.
+    def core_destroySession
+      if session[:user] && session[:session_code]
+        # determino l'utente della sessione
+        user = LatoCore::Superuser.find(session[:user])
+        # se l'utente esiste elimino il suo session_code dal db
+        user.update_attribute('session_code', nil) if user
+        # elimino le sessioni
+        session[:user] = nil
+        session[:session_code] = nil
+        # ritorno true
+        return true
+      else
+        # ritorno false
+        return false
       end
+    end
 
-      # Funzione che controlla se l'utente ha una sessione valida.
-      # * *Returns* :
-      # - true se la sessione dell'utente risulta valida
-      # - false se la sessione non esiste o non e' valida
-      def core_controlSession
-        user = LatoCore::Superuser.find(session[:user]) if session[:user]
+    # This function check if user session is valid.
+    def core_controlSession
+      user = LatoCore::Superuser.find(session[:user]) if session[:user]
 
-        if user && session[:session_code] &&
-           user.session_code === session[:session_code] &&
-           !user.session_code.nil?
-          return true
-        else
-          return false
-        end
+      if user && session[:session_code] &&
+         user.session_code === session[:session_code] &&
+         !user.session_code.nil?
+        return true
+      else
+        return false
       end
     end
+
   end
 end

data/lib/lato_core/interface/superusers.rb

@@ -1,143 +1,134 @@
 module LatoCore
-  module Interface
-    # Insieme di funzioni che gestiscono varie impostazioni sulla gestione
-    # e visualizzazione dei superusers
-    module Superusers
+  # This module contains function used to manage superusers.
+  module Interface::Superusers
 
-      # Funzione che richiede come parametri un utente, un titolo e un messaggio
-      # e invia tale contenuto come notifica email all'utente
-      def core_notifyUser(user, title, message)
-        # richiamo mailer corretto
-        LatoCore::SuperusersMailer.notify(user, title, message).deliver
-      end
+    # This function send a notification email to user with title and
+    # description.
+    def core_notifyUser(user, title, message)
+      # richiamo mailer corretto
+      LatoCore::SuperusersMailer.notify(user, title, message).deliver
+    end
 
-      # Funzione che ritorna una lista dei possibili permessi per gli utenti
-      # utilizzando la seguente struttura: [[1, 'Nome'], [2, 'Nome']].
-      # Il risultato della funzione e' compatibile con la componente input select
-      # di lato_view
-      def core_getUsersPermissions
-        # definisco permessi iniziali
-        initial_permissions = (1...11).to_a
+    # This function return a list of possible permissions for superusers with
+    # the string name for every permission.
+    def core_getUsersPermissions
+      # definisco permessi iniziali
+      initial_permissions = (1...11).to_a
 
-        unpermitted = core_getHideUsersPermissionsSettings
-        return initial_permissions if !unpermitted
-        permitted_permissions = initial_permissions - unpermitted
+      unpermitted = core_getHideUsersPermissionsSettings
+      permitted_permissions = initial_permissions
+      permitted_permissions = initial_permissions - unpermitted if unpermitted
 
-        permissions = []
-        names = core_getUsersPermissionsNamesSettings
-        return permitted_permissions if !names
+      permissions = []
+      names = core_getUsersPermissionsNamesSettings
+      return permitted_permissions if !names
 
-        permitted_permissions.each do |permission|
-          names.each do |name|
-            permissions.push([permission, name.last]) if permission === name.first.to_i
-          end
+      permitted_permissions.each do |permission|
+        names.each do |name|
+          permissions.push([permission, name.last]) if permission === name.first.to_i
         end
-
-        return permissions
       end
 
-      # Funzione che legge il file di cache e, se e' stato impostato per nascondere
-      # determinati utenti ad altri utenti, ritorna tali informazione attraverso
-      # un array con la seguente struttura: [[1,4], [1,3]]
-      def core_getHideUsersSettings
-        return CORE_SUPERUSERSHIDESETTINGS if defined? CORE_SUPERUSERSHIDESETTINGS
-        # accedo al config.yml
-        directory = core_getCacheDirectory
-        config = YAML.load(
-          File.read(File.expand_path("#{directory}/config.yml", __FILE__))
-        )
-        # controllo che il file di configurazione esista e abbia i dati necessari
-        return false if !config['hide_users'] || config['hide_users'].nil?
-        # estraggo lista impostazioni utenti da nascondere
-        settings = config['hide_users'].split(',')
-        # definisco output
-        output = []
-        # riempio file di output
-        settings.each do |setting|
-          setting.slice! ' '
-          if setting
-            values = setting.split('to')
-            raise 'Permission value not correct on hide_users config' unless (1..11).to_a.include? values.first.to_i
-            raise 'Permission value not correct on hide_users config' unless (1..11).to_a.include? values.last.to_i
-            output.push([values.first, values.last])
-          end
-        end
-        # ritorno l'output
-        return output
-      end
+      return permissions
+    end
 
-      # Funzione che legge il file di configurazione e, se e' stato impostato di
-      # nascondere determinati permessi di utenze dall'interfaccia, ritorna i
-      # valori da nascondere in un array
-      def core_getHideUsersPermissionsSettings
-        return CORE_SUPERUSERSPERMISSIONSHIDESETTINGS if defined? CORE_SUPERUSERSPERMISSIONSHIDESETTINGS
-        # accedo al config.yml
-        directory = core_getCacheDirectory
-        config = YAML.load(
-          File.read(File.expand_path("#{directory}/config.yml", __FILE__))
-        )
-        # controllo che il file di configurazione esista e abbia i dati necessari
-        return false if !config['hide_users_permissions'] || config['hide_users_permissions'].nil?
-        # estraggo lista impostazioni utenti da nascondere
-        settings = config['hide_users_permissions'].to_s.split(',')
-        # definisco output
-        output = []
-        # riempio file di output
-        settings.each do |setting|
-          setting.slice! ' '
-          if setting
-            raise 'Permission value not correct on hide_users_permissions config' unless (1..11).to_a.include? setting.to_i
-            output.push(setting.to_i)
-          end
+    # This function return an array that tells how some users can't see
+    # other users with a specific permission value.
+    def core_getHideUsersSettings
+      return CORE_SUPERUSERSHIDESETTINGS if defined? CORE_SUPERUSERSHIDESETTINGS
+      # accedo al config.yml
+      directory = core_getCacheDirectory
+      config = YAML.load(
+        File.read(File.expand_path("#{directory}/config.yml", __FILE__))
+      )
+      # controllo che il file di configurazione esista e abbia i dati necessari
+      return false if !config['hide_users'] || config['hide_users'].nil?
+      # estraggo lista impostazioni utenti da nascondere
+      settings = config['hide_users'].split(',')
+      # definisco output
+      output = []
+      # riempio file di output
+      settings.each do |setting|
+        setting.slice! ' '
+        if setting
+          values = setting.split('to')
+          raise 'Permission value not correct on hide_users config' unless (1..11).to_a.include? values.first.to_i
+          raise 'Permission value not correct on hide_users config' unless (1..11).to_a.include? values.last.to_i
+          output.push([values.first, values.last])
         end
-        # ritorno l'output
-        return output
       end
+      # ritorno l'output
+      return output
+    end
 
-      # Funzione che legge il file di configurazione e, se e' stato impostato di rinominare
-      # dei valori di permessi degli utenti, ritorna tali valori in un array con la seguente
-      # struttura: [[1,'nome'], [4,'nome']]
-      def core_getUsersPermissionsNamesSettings
-        return CORE_SUPERUSERSPERMISSIONSNAMESSETTINGS if defined? CORE_SUPERUSERSPERMISSIONSNAMESSETTINGS
-        # accedo al config.yml
-        directory = core_getCacheDirectory
-        config = YAML.load(
-          File.read(File.expand_path("#{directory}/config.yml", __FILE__))
-        )
-        # controllo che il file di configurazione esista e abbia i dati necessari
-        return false if !config['rename_users_permissions'] || config['rename_users_permissions'].nil?
-        # estraggo lista impostazioni utenti da nascondere
-        settings = config['rename_users_permissions'].split(',')
-        # definisco output
-        output = []
-        # riempio file di output
-        settings.each do |setting|
-          setting.slice! ' '
-          if setting
-            values = setting.split('-')
-            raise 'Permission value not correct on rename_users_permissions config' unless (1..11).to_a.include? values.first.to_i
-            output.push([values.first, values.last])
-          end
+    # This function return an array of permissions value that must be hidden
+    # from the user interface.
+    def core_getHideUsersPermissionsSettings
+      return CORE_SUPERUSERSPERMISSIONSHIDESETTINGS if defined? CORE_SUPERUSERSPERMISSIONSHIDESETTINGS
+      # accedo al config.yml
+      directory = core_getCacheDirectory
+      config = YAML.load(
+        File.read(File.expand_path("#{directory}/config.yml", __FILE__))
+      )
+      # controllo che il file di configurazione esista e abbia i dati necessari
+      return false if !config['hide_users_permissions'] || config['hide_users_permissions'].nil?
+      # estraggo lista impostazioni utenti da nascondere
+      settings = config['hide_users_permissions'].to_s.split(',')
+      # definisco output
+      output = []
+      # riempio file di output
+      settings.each do |setting|
+        setting.slice! ' '
+        if setting
+          raise 'Permission value not correct on hide_users_permissions config' unless (1..11).to_a.include? setting.to_i
+          output.push(setting.to_i)
         end
-        # ritorno l'output
-        return output
       end
+      # ritorno l'output
+      return output
+    end
 
-      # Funzione che controlla se e' permesso il servizio di recupero password
-      # per gli utenti. Ritorna true se è permesso, false altrimenti.
-      def core_getRecoveryPasswordPermission
-        return CORE_RECOVERYPASSWORDPERMISSION if defined? CORE_RECOVERYPASSWORDPERMISSION
-        # accedo al config.yml
-        directory = core_getCacheDirectory
-        config = YAML.load(
-          File.read(File.expand_path("#{directory}/config.yml", __FILE__))
-        )
-        # controllo che il file di configurazione esista e abbia i dati necessari
-        return false if !config['recovery_password'] || config['recovery_password'].nil?
-        # ritorno valore letto
-        return config['recovery_password']
+    # This function return an array with correct name fr every permission
+    # if name is set on config file.
+    def core_getUsersPermissionsNamesSettings
+      return CORE_SUPERUSERSPERMISSIONSNAMESSETTINGS if defined? CORE_SUPERUSERSPERMISSIONSNAMESSETTINGS
+      # accedo al config.yml
+      directory = core_getCacheDirectory
+      config = YAML.load(
+        File.read(File.expand_path("#{directory}/config.yml", __FILE__))
+      )
+      # controllo che il file di configurazione esista e abbia i dati necessari
+      return false if !config['rename_users_permissions'] || config['rename_users_permissions'].nil?
+      # estraggo lista impostazioni utenti da nascondere
+      settings = config['rename_users_permissions'].split(',')
+      # definisco output
+      output = []
+      # riempio file di output
+      settings.each do |setting|
+        setting.slice! ' '
+        if setting
+          values = setting.split('-')
+          raise 'Permission value not correct on rename_users_permissions config' unless (1..11).to_a.include? values.first.to_i
+          output.push([values.first, values.last])
+        end
       end
+      # ritorno l'output
+      return output
+    end
 
+    # This function tells if is possible for user to recover his password.
+    def core_getRecoveryPasswordPermission
+      return CORE_RECOVERYPASSWORDPERMISSION if defined? CORE_RECOVERYPASSWORDPERMISSION
+      # accedo al config.yml
+      directory = core_getCacheDirectory
+      config = YAML.load(
+        File.read(File.expand_path("#{directory}/config.yml", __FILE__))
+      )
+      # controllo che il file di configurazione esista e abbia i dati necessari
+      return false if !config['recovery_password'] || config['recovery_password'].nil?
+      # ritorno valore letto
+      return config['recovery_password']
     end
+
   end
 end