arkaan 2.7.1 → 3.0.0

data/lib/arkaan/concerns/diagnosticable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Concerns
     # Includes the diagnostic URL field, and the related validations.
@@ -9,14 +11,14 @@ module Arkaan
       # @author Vincent Courtois <courtois.vincent@outlook.com>
       included do
         # @!attribute [rw] diagnostic
-        #   @return [String] the diagnostic URL to know the status of an entity (usually a gateway, or an instance of a service).
+        #   @return [String] the diagnostic URL to know the status of an instance or a service.
         field :diagnostic, type: String, default: '/status'
 
         validates :diagnostic,
-          presence: {message: "required"},
-          length: {minimum: 4, message: "minlength"},
-          format: {with: /\A(\/[a-z]+)+\z/, message: "pattern"}
+                  presence: { message: 'required' },
+                  length: { minimum: 4, message: 'minlength' },
+                  format: { with: %r{\A(\/[a-z]+)+\z}, message: 'pattern' }
       end
     end
   end
-end
+end

data/lib/arkaan/concerns/enumerable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Concerns
     # Defines enumerations for the Mongoid models. An enumeration is a field that can only use a given set of values.
@@ -8,7 +10,6 @@ module Arkaan
       # Submodule holding all the static methods add to the current subclass.
       # @author Vincent Courtois <courtois.vincent@outlook.com>
       module ClassMethods
-        
         # Creates the field with the given name, set of possible values, and options.
         # @param field_name [String] the name of the enumerated field.
         # @param values [Array<Symbol>] the possible values of the enumerated field.
@@ -16,18 +17,33 @@ module Arkaan
         def enum_field(field_name, values, options = {})
           returned = field :"enum_#{field_name}", type: Symbol, default: options[:default]
 
-          validates :"enum_#{field_name}", inclusion: {in: values.map(&:to_sym), message: 'inclusion'}
+          validates :"enum_#{field_name}", inclusion: { in: values.map(&:to_sym), message: 'inclusion' }
+
+          define_getter(field_name)
+
+          define_setter(field_name, values)
+
+          define_values_methods(field_name, values)
+
+          # This is to make enumerations historizable by
+          # returning the field object created by Mongoid.
+          returned
+        end
 
+        def define_getter(field_name)
           define_method field_name do
             return self["enum_#{field_name}"]
           end
+        end
 
+        def define_setter(field_name, values)
           define_method "#{field_name}=" do |value|
-            if values.include? value.to_sym
-              self["enum_#{field_name}"] = value.to_sym
-            end
+            value = value.to_sym
+            self["enum_#{field_name}"] = value if values.include? value
           end
+        end
 
+        def define_values_methods(field_name, values)
           values.map(&:to_sym).each do |value|
             define_method "#{field_name}_#{value}!" do
               self["enum_#{field_name}"] = value
@@ -37,10 +53,6 @@ module Arkaan
               self["enum_#{field_name}"] == value
             end
           end
-
-          # This is to make enumerations historizable by
-          # returning the field object created by Mongoid.
-          returned
         end
       end
     end

data/lib/arkaan/concerns/historizable.rb

@@ -35,20 +35,22 @@ module Arkaan
       # Submodule holding all the static methods add to the current subclass.
       # @author Vincent Courtois <courtois.vincent@outlook.com>
       module ClassMethods
-        
         # Takes the Mongoid declared field and creates the callbacks
         # to intercept any value change and add it to the history.
         # @field field [Mongoid::Fields::Standard] the Mongoid field to historize.
         def historize(field)
+          embeds_many :history, class_name: 'Arkaan::Event' unless relations.key?('history')
+          historization_after_init(field)
+          historization_after_save(field)
+        end
 
-          unless relations.key?('history')
-            embeds_many :history, class_name: 'Arkaan::Event'
-          end
-
+        def historization_after_init(field)
           after_initialize do |doc|
             add_history(field: field.name, from: nil, to: doc[field.name])
           end
+        end
 
+        def historization_after_save(field)
           after_save do |doc|
             if doc.changed_attributes.key?(field.name)
               from = doc.changed_attributes[field.name]

data/lib/arkaan/concerns/mime_typable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Concerns
     # Includes the MIME type field to files to ensure only supported types are included.
@@ -11,32 +13,38 @@ module Arkaan
         # Defines the MIME type attribute with the given possible MIME types.
         # @param values [Array<String>] the possible MIME types, * can be used as wild cards.
         def mime_type(values)
-
           # @!attribute [rw] mime_type
           #   @return [String] the MIME type of the file, obtained from the uploaded file.
           field :mime_type, type: String
-      
-          validates :mime_type, presence: {message: 'required'}
+
+          validates :mime_type, presence: { message: 'required' }
 
           validate :mime_type_validity, if: :mime_type?
 
+          mime_type_check(values)
+        end
+
+        def mime_type_check(values)
           # Validates the validity of the MIME type by checking if it respects any of the given mime types.
           # If it does not respect any MIME types possible, it adds an error to the mime_type field and invalidates.
           define_method :mime_type_validity do
-            checked_types = if values.is_a? Symbol
-              self.send(values) rescue []
-            else
-              values
-            end
+            checked_types = parse_values(values)
             return true if checked_types.empty?
+
             checked_types.each do |type|
               type_regex = ::Regexp.new("^#{type.sub(/\*/, '(.+)')}$")
-              return true if !type_regex.match(mime_type).nil?
+              return true unless type_regex.match(mime_type).nil?
             end
             errors.add(:mime_type, 'pattern')
           end
         end
+
+        def parse_values(values)
+          values.is_a?(Symbol) ? send(values) : values
+        rescue StandardError
+          []
+        end
       end
     end
   end
-end
+end

data/lib/arkaan/concerns/premiumable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Concerns
     # Includes the premium field to make the entity including it accessible only to premium applications or not.
@@ -12,4 +14,4 @@ module Arkaan
       end
     end
   end
-end
+end

data/lib/arkaan/concerns/sluggable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Concerns
     # Includes the slug field, always the same in all models.
@@ -9,19 +11,18 @@ module Arkaan
       # @author Vincent Courtois <courtois.vincent@outlook.com>
       module ClassMethods
         # Add the field and its validations in the model including it.
-        # @param entity_type [String,Symbol] the name of the model including it, to be included in the error messages.
-        def make_sluggable(entity_type)
+        def make_sluggable
           # @!attribute [rw] slug
-          #   @return [String] the slug of the current entity ; it must be snake-cased, longer than four characters, unique for the entity and given.
+          #   @return [String] the slug of the current entity, in snake-case.
           field :slug, type: String
 
           validates :slug,
-            length: {minimum: 4, message: 'minlength', if: :slug?},
-            format: {with: /\A[a-z]+(_[a-z]+)*\z/, message: 'pattern', if: :slug?},
-            uniqueness: {message: 'uniq', if: :slug?},
-            presence: {message: 'required'}
+                    length: { minimum: 4, message: 'minlength', if: :slug? },
+                    format: { with: /\A[a-z]+(_[a-z]+)*\z/, message: 'pattern', if: :slug? },
+                    uniqueness: { message: 'uniq', if: :slug? },
+                    presence: { message: 'required' }
         end
       end
     end
   end
-end
+end

data/lib/arkaan/concerns/typable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Concerns
     # Concerns for the objects that can be activated or deactivated, included the corresponding scopes.
@@ -7,11 +9,11 @@ module Arkaan
 
       included do
         include Arkaan::Concerns::Enumerable
-        
+
         # @!attribute [rw] type
         #   @return [Symbol] the type of the instance, determining its way of being deployed, restarted, etc.
-        enum_field :type, [:heroku, :local, :unix], default: :heroku
+        enum_field :type, %i[heroku local unix], default: :heroku
       end
     end
   end
-end
+end

data/lib/arkaan/factories.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Arkaan
   # Static factories are used to create decorated objects easily.
   # @author Vincent Courtois <courtois.vincent@outlook.com>
   module Factories
     autoload :Gateways, 'arkaan/factories/gateways'
-    autoload :Errors  , 'arkaan/factories/errors'
+    autoload :Errors, 'arkaan/factories/errors'
   end
-end
+end

data/lib/arkaan/files.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 module Arkaan
+  # This module holds all logic for the files uploaded in a conversation.
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
   module Files
-    autoload :Document  , 'arkaan/files/document'
+    autoload :Document, 'arkaan/files/document'
     autoload :Permission, 'arkaan/files/permission'
   end
-end
+end

data/lib/arkaan/files/document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Files
     # a document is an uploaded file in the S3 clone application.
@@ -30,9 +32,9 @@ module Arkaan
       #   @return [Array<Arkaan::Files::Permission>] the permissions granted to access this file.
       has_many :permissions, class_name: 'Arkaan::Files::Permission', inverse_of: :file
 
-      validates :name, :extension, :folder, :mime_type, presence: {message: 'required'}
+      validates :name, :extension, :folder, :mime_type, presence: { message: 'required' }
 
-      validates :folder, format: {without: /\/\//, message: 'format'}
+      validates :folder, format: { without: %r{\/\/}, message: 'format' }
 
       validate :filename_unicity
 
@@ -47,4 +49,4 @@ module Arkaan
       end
     end
   end
-end
+end

data/lib/arkaan/files/permission.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Files
     # The permission granted to a user to access and/or delete a file.
@@ -9,7 +11,7 @@ module Arkaan
 
       # @!attribute [rw] type
       #   @return [Symbol] the type of permission granted (is the user able to delete the file ?)
-      enum_field :type, [:read, :read_write]
+      enum_field :type, %i[read read_write]
 
       # @!attribute [rw] file
       #   @return [Arkaan::Files::Document] the document the permission is linked to.
@@ -19,4 +21,4 @@ module Arkaan
       belongs_to :account, class_name: 'Arkaan::Account', inverse_of: :permissions
     end
   end
-end
+end

data/lib/arkaan/monitoring.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Arkaan
   # The monitoring module holds all the logic about the services so they can be activated or deactivated.
   # @author Vincent Courtois <courtois.vincent@outlook.com>
   module Monitoring
-    autoload :Route  , 'arkaan/monitoring/route'
+    autoload :Route, 'arkaan/monitoring/route'
     autoload :Service, 'arkaan/monitoring/service'
   end
-end
+end

data/lib/arkaan/monitoring/route.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Monitoring
-    # A route is an endpoint accessible in a service. Each route has to have an associated endpoint in the deployed instances.
+    # A route is an endpoint accessible in a service. Each route has to have
+    # an associated endpoint in the deployed instances.
     # @param Vincent Courtois <courtois.vincent@outlook.com>
     class Route
       include Mongoid::Document
@@ -27,10 +30,10 @@ module Arkaan
       has_and_belongs_to_many :groups, class_name: 'Arkaan::Permissions::Group', inverse_of: :groups
 
       validates :path,
-        format: {with: /\A(\/|((\/:?[a-zA-Z0-9_]+)+))\z/, message: 'pattern', if: :path?}
+                format: { with: %r{\A(\/|((\/:?[a-zA-Z0-9_]+)+))\z}, message: 'pattern', if: :path? }
 
       validates :verb,
-        inclusion: {message: 'unknown', in: ['get', 'post', 'put', 'delete', 'patch', 'option']}
+                inclusion: { message: 'unknown', in: %w[get post put delete patch option] }
 
       # Returns the complete path, enriched with the path of the service.
       # @return [String] the complete path to access this route from the outside.

data/lib/arkaan/monitoring/service.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Monitoring
     # A service is the representation of one of the applications composing the API.
@@ -23,9 +25,9 @@ module Arkaan
       #   @return [Array<Arkaan::Monitoring::Route>] the routes associated to this service, accessible from the gateway.
       has_many :routes, class_name: 'Arkaan::Monitoring::Route', inverse_of: :service
 
-      validates :key, uniqueness: {message: 'uniq'}
+      validates :key, uniqueness: { message: 'uniq' }
 
-      validates :path, format: {with: /\A(\/:?[a-z]+)+\z/, message: 'pattern'}
+      validates :path, format: { with: %r{\A(\/:?[a-z]+)+\z}, message: 'pattern' }
     end
   end
-end
+end

data/lib/arkaan/notification.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   # A notification is a little something to warn a user that an action concerning him or her occurred.
   # @author Vincent Courtois <courtois.vincent@outlook.com>
@@ -12,11 +14,12 @@ module Arkaan
     #   @return [Boolean] TRUE if the notification has been read (seen by the user), FALSE otherwise.
     field :read, type: Boolean, default: false
     # @!attribute [rw] data
-    #   @return [Hash] the custom data that can be attached to this notification, for example for an invitation it can be the invited username.
+    #   @return [Hash] the custom data that can be attached to this notification,
+    #     for example for an invitation it can be the invited username.
     field :data, type: Hash, default: {}
 
     # @!attribute [rw] account
     #   @return [Arkaan::Account] the account concerned by this notification.
     embedded_in :account, class_name: 'Arkaan::Account', inverse_of: :notifications
   end
-end
+end

data/lib/arkaan/oauth.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Arkaan
   # This module holds the logic for the connection of an application to our API.
   # @author Vincent Courtois <courtois.vincent@outlook.com>
   module OAuth
-    autoload :Application  , 'arkaan/oauth/application'
+    autoload :Application, 'arkaan/oauth/application'
     autoload :Authorization, 'arkaan/oauth/authorization'
-    autoload :AccessToken  , 'arkaan/oauth/access_token'
-    autoload :RefreshToken , 'arkaan/oauth/refresh_token'
+    autoload :AccessToken, 'arkaan/oauth/access_token'
+    autoload :RefreshToken, 'arkaan/oauth/refresh_token'
   end
-end
+end

data/lib/arkaan/oauth/access_token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   module OAuth
     # An access token is the value assigned to the application
@@ -9,18 +11,18 @@ module Arkaan
 
       # @!attribute [rw] value
       #   @return [String] the value of the token, returned to the application when built.
-      field :value, type: String, default: ->{ SecureRandom.hex }
+      field :value, type: String, default: -> { SecureRandom.hex }
       # @!attribute [rw] expiration
-      #   @return [Integer] the time, in seconds, after which the token is declared expired, and thus can't be used anymore.
-      field :expiration, type: Integer, default: 86400
+      #   @return [Integer] the time, in seconds, after which the token is declared expired, and thus can't be used.
+      field :expiration, type: Integer, default: 86_400
 
       # @!attribute [rw] authorization
-      #   @return [Arkaan::OAuth::Authorization] the authorization code that issued this token to the application for this user.
+      #   @return [Arkaan::OAuth::Authorization] the authorization code that issued this token to the application.
       belongs_to :authorization, class_name: 'Arkaan::OAuth::Authorization', inverse_of: :tokens
 
-      validates :value, 
-        presence: {message: 'required'},
-        uniqueness: {message: 'uniq'}
+      validates :value,
+                presence: { message: 'required' },
+                uniqueness: { message: 'uniq' }
 
       # Checks if the current date is inferior to the creation date + expiration period
       # @return [Boolean] TRUE if the token is expired, FALSE otherwise.
@@ -29,4 +31,4 @@ module Arkaan
       end
     end
   end
-end
+end

data/lib/arkaan/oauth/application.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module Arkaan
   module OAuth
-    # An application is what is referred to in the OAuth2.0 RFC as a client, wanting to access private informations about the user.
+    # An application is what is referred to in the OAuth2.0 RFC as a client,
+    # wanting to access private informations about the user.
     # @author Vincent Courtois <courtois.vincent@outlook.com>
     class Application
       include Mongoid::Document
@@ -11,9 +14,10 @@ module Arkaan
       field :name, type: String
       # @!attribute [rw] key
       #   @return [String] the unique key for the application, identifying it when requesting a token for the API.
-      field :key, type: String, default: ->{ SecureRandom.hex }
+      field :application_key, type: String, default: -> { SecureRandom.hex }
       # @!attribute [rw] premium
-      #   @return [Boolean] a value indicating whether the application should automatically receive a token when an account is created, or not.
+      #   @return [Boolean] a value indicating whether the application should automatically receive a token
+      #     when an account is created, or not.
       field :premium, type: Boolean, default: false
       # @!attirbute [rw] redirect_uris
       #   @return [Array<String>] the redirection URIs used for this application.
@@ -23,17 +27,18 @@ module Arkaan
       #   @return [Arkaan::Account] the account that has created this application, considered its owner.
       belongs_to :creator, class_name: 'Arkaan::Account', inverse_of: :applications
       # @!attribute [rw] authorizations
-      #   @return [Array<Arkaan::OAuth::Authorization>] the authorizations linked to the accounts this application can get the data from.
+      #   @return [Array<Arkaan::OAuth::Authorization>] the authorizations linked to the accounts
+      #     this application can get the data from.
       has_many :authorizations, class_name: 'Arkaan::OAuth::Authorization', inverse_of: :application
 
       validates :name,
-        presence: {message: 'required'},
-        length: {minimum: 6, message: 'minlength'},
-        uniqueness: {message: 'uniq'}
+                presence: { message: 'required' },
+                length: { minimum: 6, message: 'minlength' },
+                uniqueness: { message: 'uniq' }
 
-      validates :key,
-        presence: {message: 'required'},
-        uniqueness: {message: 'uniq'}
+      validates :application_key,
+                presence: { message: 'required' },
+                uniqueness: { message: 'uniq' }
 
       validate :redirect_uris_values
 
@@ -41,11 +46,12 @@ module Arkaan
       # - it is a string
       # - it has a correct URL format.
       def redirect_uris_values
+        regex = %r{\A(https?:\/\/)((([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*)|(localhost:[0-9]{2,4})\/?)\z}
         redirect_uris.each do |uri|
           if !uri.is_a? String
             errors.add(:redirect_uris, 'type')
             break
-          elsif uri.match(/\A(https?:\/\/)((([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*)|(localhost:[0-9]{2,4})\/?)\z/).nil?
+          elsif uri.match(regex).nil?
             errors.add(:redirect_uris, 'format')
             break
           end
@@ -53,4 +59,4 @@ module Arkaan
       end
     end
   end
-end
+end