virtuatable-core 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eaef58986378462da6ff78e3aeac595cbed418f3351254e3e99b303059fe21d1
-  data.tar.gz: 1ed97f4ff856ecfbe5ccf969547ee0141f03f1e9c59304661880f6d4e87bfaf7
+  metadata.gz: 9afbc1d8f75f5d0b94194432b3a379a7b02d90d2490deeed47d46d9c89036b01
+  data.tar.gz: 56cfd05e3f53df001a852d26b6abf992313d52598902ecb21809cd16708ae266
 SHA512:
-  metadata.gz: ffc760f437db7e376de09c5e88fa794e440729600819f8cce7474d4db6a122185fc20472020e131ae889d6371f1cf95f0fb7389506ac4ec1f5a9840a3ed2dc98
-  data.tar.gz: '08addb4e9612082536359a2a624f5eded215ba382a8f9b16aebf016cfc35b9c9dbc12a503a3160780dc81896bdabf0434f1966062d5eb339e999eadef92cbec1'
+  metadata.gz: 7f4fdde3ecd17bb2b33a535ce22c927783ab5d88c00f639ee9374fcc7b36c6680ed0e2f1ce50071a22e1c4784d453c1b74b0bc71d5b817bd72e0501faf637611
+  data.tar.gz: 7622404c051938c9cee8567de61f25005e7f178ae4a7dd22146d279aa8413a52c92c25c36db2472a59588c2f0a10db22322d4f0ff8348fc3609124798bcd4587

data/lib/core/controllers/base.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+require 'sinatra/config_file'
+require 'sinatra/custom_logger'
+
+module Core
+  module Controllers
+    # This class represents a base controller for the system, giving access
+    # to checking methods for sessions, gateways, applications, etc.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Base < Sinatra::Base
+      register Sinatra::ConfigFile
+      helpers Sinatra::CustomLogger
+      # Includes the custom errors throwers and responses helpers.
+      include Core::Helpers::Errors
+      include Core::Helpers::Responses
+      # Includes the checking methods for sessions.
+      include Core::Helpers::Sessions
+      # Include the checkers and getters for OAuth apps
+      include Core::Helpers::Applications
+      # Include checkers for field requirement and check
+      include Core::Helpers::Fields
+      # Include the getter for the currently requested route.
+      include Core::Helpers::Routes
+      # Include the getter and checkers for accounts.
+      include Core::Helpers::Accounts
+      # Include the loading of the parameters from the JSON body
+      include Core::Helpers::Parameters
+      # This module is extended, not included, because it provides routes
+      # declaration methods used in class declarations.
+      extend Core::Helpers::Declarators
+
+      configure do
+        set :logger, Logger.new(STDOUT)
+        logger.level = Logger::ERROR if ENV['RACK_ENV'] == 'test'
+        # This configuration options allow the error handler to work in tests.
+        set :show_exceptions, false
+        set :raise_errors, false
+      end
+
+      error Mongoid::Errors::Validations do |errors|
+        key = errors.document.errors.messages.keys.first
+        message = errors.document.errors.messages[key][0]
+        api_bad_request key, message: message
+      end
+
+      error Core::Helpers::Errors::NotFound do |exception|
+        api_not_found exception.message
+      end
+
+      error Core::Helpers::Errors::BadRequest do |exception|
+        api_bad_request exception.message
+      end
+
+      error Core::Helpers::Errors::Forbidden do |exception|
+        api_forbidden exception.message
+      end
+
+      if ENV['RACK_ENV'] != 'test'
+        error StandardError do |error|
+          api_error 500, "unknown_field.#{error.class.name}"
+        end
+      end
+    end
+  end
+end

data/lib/core/controllers.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Core
+  # Controllers are to be subclassed in each service.
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
+  module Controllers
+    autoload :Base, 'core/controllers/base'
+  end
+end

data/lib/core/helpers/accounts.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Core
+  module Helpers
+    # These helpers provide methods used to get and check accounts.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Accounts
+      # Raises a bad request error if the account if not found.
+      # @raise [Virtuatable::API::Errors::BadRequest] the error raised when the account is not found.
+      def account
+        return @account unless @account.nil?
+
+        session_id_required if !respond_to?(:session) || session.nil?
+        @account = session.account
+      end
+
+      def account_id_not_found
+        api_bad_request('session_id.required')
+      end
+    end
+  end
+end

data/lib/core/helpers/applications.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Core
+  module Helpers
+    # Helpers to get and check OAuth applications connecting the the application.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Applications
+      # Looks for the application sending the API's request, and raises error if not found.
+      # @param [Arkaan::OAuth::Application] the application requesting the service.
+      def application(premium: false)
+        return @application unless @application.nil?
+
+        check_presence 'app_key'
+        @application = application_model.find_by(key: params['app_key'])
+        api_not_found 'app_key.unknown' if @application.nil?
+        api_forbidden 'app_key.forbidden' if premium && !@application.premium
+
+        @application
+      end
+
+      def application_model
+        Arkaan::OAuth::Application
+      end
+    end
+  end
+end

data/lib/core/helpers/declarators.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Core
+  module Helpers
+    # This helpers module is a bit larger than the others as it provides methods
+    # to declare routes whithin a service, performing needed checks and filters.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Declarators
+      # @!attribute [r] routes
+      #   @return [Array<Arkaan::Monitoring::Route>] the currently declared routes.
+      attr_reader :api_routes
+
+      # Main method to declare new routes, persisting them in the database and
+      # declaring it in the Sinatra application with the needed before checks.
+      #
+      # @param verb [String] the HTTP method for the route.
+      # @param path [String] the whole URI with parameters for the route.
+      # @param options [Hash] the additional options for the route.
+      def api_route(verb, path, options: {}, &block)
+        options = default_options.merge(options)
+        route = add_route(verb: verb, path: path, options: options)
+
+        # TODO : do everything in the #send itself to avoid
+        # route reload issues when premium is changed. It will
+        # add some treatments but avoid many problems if route.premium
+        send(route.verb, route.path) do
+          application(premium: current_route.premium)
+          session if current_route.authenticated
+          instance_eval(&block)
+        end
+      end
+
+      # Add a route to the database, then to the routes array.
+      # @param verb [String] the HTTP method used to request this route.
+      # @param path [String] the path used to request this route.
+      # @return [Arkaan::Monitoring::Route] the created route.
+      def add_route(verb:, path:, options:)
+        route = Arkaan::Monitoring::Route.find_or_create_by!(
+          path: path,
+          verb: verb.downcase,
+          premium: options[:premium],
+          authenticated: options[:authenticated]
+        )
+        api_routes.nil? ? @api_routes = [route] : push_route(route)
+        add_permissions(route)
+        route
+      end
+
+      # Pushes the route in the api routes list, by creating it if needed
+      # @param route [Arkaan::Monitoring::Route] the route to push in the list of routes.
+      def push_route(route)
+        @api_routes << route if api_routes.none? do |tmp_route|
+          route.id == tmp_route.id
+        end
+      end
+
+      # Add the default access permissions to a route. Any group tagged superuser
+      # can automatically access any newly declared_route.
+      # params route [Arkaan::Monitoring::Route] the route to add the permissions to.
+      def add_permissions(route)
+        groups = Arkaan::Permissions::Group.where(is_superuser: true)
+        groups.each do |group|
+          unless route.groups.where(id: group.id).exists?
+            route.groups << group
+            route.save!
+          end
+        end
+      end
+
+      # The default options for a route, being the most used value for each key.
+      # @return [Hash] the default options as a hash.
+      def default_options
+        {
+          # If TRUE the application MUST be premium to access the route.
+          # Mainly used to protect administration routes against illegal accesses.
+          premium: false,
+          # If TRUE the user MUST be authenticated to access the route.
+          authenticated: true
+        }
+      end
+    end
+  end
+end

data/lib/core/helpers/errors/bad_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Core
+  module Helpers
+    module Errors
+      # A bad request error is raised when the data given to a model makes this model invalid.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class BadRequest < Core::Helpers::Errors::Base
+        def initialize(field:, error:)
+          super(field: field, error: error, status: 400)
+        end
+      end
+    end
+  end
+end

data/lib/core/helpers/errors/base.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Core
+  module Helpers
+    module Errors
+      # Standard class parent to all specialized http errors.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class Base < StandardError
+        # @!attribute [rw] field
+        #   @return [String, Symbol] the name of the field in error in the model.
+        attr_accessor :field
+        # @!attribute [rw] action
+        #   @return [String] the name of the action the user was trying to perform on the model (often crate or update).
+        attr_accessor :action
+        # @attribute [rw] error
+        #   @return [String] the label of the error returned by the model.
+        attr_accessor :error
+        # @attribute [rw] status
+        #   @return [Integer] the HTTP status code as a number (eg: 400, 422 or 500)
+        attr_accessor :status
+
+        def initialize(field:, error:, status:)
+          @field = field.to_s
+          @error = error
+          @status = status
+        end
+
+        # Returns the formatted message for this exception.
+        # @return [String] a message indicating what field fails, and why.
+        def message
+          "#{field}.#{error}"
+        end
+      end
+    end
+  end
+end

data/lib/core/helpers/errors/forbidden.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Core
+  module Helpers
+    module Errors
+      # A forbidden error occurs when a user tries to perform an action he's not allowed to.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class Forbidden < Core::Helpers::Errors::Base
+        def initialize(field:, error:)
+          super(field: field, error: error, status: 403)
+        end
+      end
+    end
+  end
+end

data/lib/core/helpers/errors/not_found.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Core
+  module Helpers
+    module Errors
+      # A not found error occurs when a user tries to reach a resource that does not exist.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class NotFound < Core::Helpers::Errors::Base
+        def initialize(field:, error:)
+          super(field: field, error: error, status: 404)
+        end
+      end
+    end
+  end
+end

data/lib/core/helpers/errors.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Core
+  module Helpers
+    # This module defines method to raise HTTP errors in the routes easily.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Errors
+      autoload :Base, 'core/helpers/errors/base'
+      autoload :BadRequest, 'core/helpers/errors/bad_request'
+      autoload :Forbidden, 'core/helpers/errors/forbidden'
+      autoload :NotFound, 'core/helpers/errors/not_found'
+
+      # Stops the executing and raises an HTTP error in the route.
+      # The message MUST be of the for <field>.<error> to be correctly parsed.
+      # The action is automatically parsed from the route call and added.
+      #
+      # @param status [Integer] the HTTP status code the response will have
+      # @param message [String] the raw message to split and format as body.
+      def api_error(status, message)
+        field, error = message.split('.')
+        docs = settings.errors.try(field).try(error)
+        errors = { status: status, field: field, error: error, docs: docs }
+        halt status, errors.to_json
+      end
+
+      # Stops the execution to return a NOT FOUND response.
+      # @param field [String] the field in params concerned by the error.
+      # @param message [String] the message if different of "unknown".
+      def api_not_found(field, message: 'unknown')
+        api_error 404, "#{field}.#{message}"
+      end
+
+      # Stops the execution to return a BAD REQUEST response.
+      # @param field [String] the field in params concerned by the error.
+      # @param message [String] the message if different of "required".
+      def api_bad_request(field, message: 'required')
+        api_error 400, "#{field}.#{message}"
+      end
+
+      # Stops the execution to return a FORBIDDEN response.
+      # @param field [String] the field in params concerned by the error.
+      # @param message [String] the message if different of "forbidden".
+      def api_forbidden(field, message: 'forbidden')
+        api_error 403, "#{field}.#{message}"
+      end
+    end
+  end
+end

data/lib/core/helpers/fields.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Core
+  module Helpers
+    # Helpers for the parameters of a request.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Fields
+      # Checks the presence of several fields given as parameters and halts the execution if it's not present.
+      # @param fields [Array<String>] an array of fields names to search in the parameters
+      def check_presence(*fields)
+        fields.each do |field|
+          api_bad_request "#{field}.required" unless field_defined?(field)
+        end
+      end
+
+      # Checks the presence of either fields given in parameters.
+      # It halts with an error only if ALL parameters are not given.
+      #
+      # @param fields [Array<String>] an array of fields names to search in the parameters
+      # @param key [String] the key to search in the errors configuration file.
+      def check_either_presence(*fields, key:)
+        api_bad_request "#{key}.required" if fields.none? do |field|
+          field_defined?(field)
+        end
+      end
+
+      # Checks if a given field is defined in the params
+      # @param field [String] the name of the field to check in the params
+      # @return [Boolean] TRUE if the field exists, FALSE otherwise.
+      def field_defined?(field)
+        !params.nil? && params.key?(field) && params[field] != ''
+      end
+    end
+  end
+end

data/lib/core/helpers/parameters.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Core
+  module Helpers
+    # Helpers to correctly build the parameters hash, even from the JSON body.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Parameters
+      # Returns the parameters depending on whether the request has a body
+      # or not. If it has a body, it parses it, otherwise it just returns the params.
+      # @return [Hash] the parameters sent with the request.
+      def params
+        super.merge(body_params)
+      end
+
+      # The parameters from the JSON body if it is sent.
+      # @return [Hash] the JSON body parsed as a dictionary.
+      def body_params
+        request.body.rewind
+        JSON.parse(request.body.read.to_s)
+      rescue JSON::ParserError
+        {}
+      end
+    end
+  end
+end

data/lib/core/helpers/responses.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Core
+  module Helpers
+    # Modules holding the responses that are NOT errors.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Responses
+      # Builds a list of items as a standard API response.
+      # The response will be a JSON hash containing two keys :
+      # - :count will hold the number of items displayed in the list
+      # - :items will hold the list of items.
+      # @param items [Array] the items to format as a standard API response.
+      def api_list(items)
+        halt 200, {
+          count: items.count,
+          items: items.map { |item| enhanced_h(item) }
+        }.to_json
+      end
+
+      # Displays a creation standard response,
+      # returning the informations about the created item.
+      # @param item [Object] any object that responds to #to_h to display to the user.
+      def api_created(item)
+        halt 201, enhanced_json(item)
+      end
+
+      # Displays an item with the standards of the API.
+      # @param item [Object] the item to display as a JSON formatted hash.
+      def api_item(item)
+        halt 200, enhanced_json(item)
+      end
+
+      # Displays a message with a 200 status code
+      # @param message [String] the message to display with the API standards.
+      def api_ok(message)
+        api_item message: message
+      end
+
+      private
+
+      def enhanced_h(item)
+        (item.respond_to?(:enhance) ? item.enhance : item).to_h
+      end
+
+      def enhanced_json(item)
+        enhanced_h(item).to_json
+      end
+    end
+  end
+end

data/lib/core/helpers/routes.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Core
+  module Helpers
+    # This module provides the #current_route method to get the current
+    # Arkaan::Monitoring::Route object from whithin sinatra routes.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Routes
+      # The currently requested API route, used to see inside the block
+      # if the route is premium or not, authenticated or not.
+      # @return [Arkaan::Monitoring::Route] the currently requested route.
+      def current_route
+        splitted = request.env['sinatra.route'].split(' ')
+        verb = splitted.first.downcase
+        self.class.api_routes.find do |route|
+          route.verb == verb && route.path == splitted.last
+        end
+      end
+    end
+  end
+end

data/lib/core/helpers/sessions.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Core
+  module Helpers
+    # This helper gives access to methods about user's session on the API.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Sessions
+      # Checks the session of the user requesting the API and returns an error
+      # if it either not exists with the given token, or the token is not given.
+      #
+      # @raise [Virtuatable::API::Errors::NotFound] if the session is not found
+      #   or the token not given in the parameters of the request.
+      # @raise [Virtuatable::API::Errors::BadRequest] if the session token is
+      #   not correctly given in the parameters.
+      #
+      # @return [Arkaan::Authentication::Session] the current session of the user.
+      def session
+        return @session unless @session.nil?
+
+        check_presence 'session_id'
+        @session = session_model.find_by(token: params['session_id'])
+        @session.nil? ? api_not_found('session_id.unknown') : @session
+      end 
+
+      def session_model
+        Arkaan::Authentication::Session
+      end
+    end
+  end
+end

data/lib/core/helpers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Core
+  # The helpers are used inside the controllers to dynamically
+  # add features and functions.
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
+  module Helpers
+    autoload :Accounts, 'core/helpers/accounts'
+    autoload :Applications, 'core/helpers/applications'
+    autoload :Declarators, 'core/helpers/declarators'
+    autoload :Errors, 'core/helpers/errors'
+    autoload :Fields, 'core/helpers/fields'
+    autoload :Parameters, 'core/helpers/parameters'
+    autoload :Responses, 'core/helpers/responses'
+    autoload :Routes, 'core/helpers/routes'
+    autoload :Sessions, 'core/helpers/sessions'
+  end
+end

data/lib/core/models/account.rb

@@ -46,9 +46,6 @@ module Core
       # @!attribute [rw] authorizations
       #   @return [Array<Core::Models::OAuth::Authorization>] the authorization issued by this account to third-party applications to access its data.
       has_many :authorizations, class_name: 'Core::Models::OAuth::Authorization', inverse_of: :account
-      # @!attribute [rw] services
-      #   @return [Array<Core::Models::Monitoring::Service>] the services created by this user.
-      has_many :services, class_name: 'Core::Models::Monitoring::Service', inverse_of: :creator
       # @!attribute [rw] sessions
       #   @return [Array<Core::Models::Authentication::Session>] the sessions on which this account is, or has been logged in.
       has_many :sessions, class_name: 'Core::Models::Authentication::Session', inverse_of: :account

data/lib/core/models/concerns.rb

@@ -4,7 +4,6 @@ module Core
     # @author Vincent Courtois <courtois.vincent@outlook.com>
     module Concerns
       autoload :Activable     , 'core/models/concerns/activable'
-      autoload :Diagnosticable, 'core/models/concerns/diagnosticable'
       autoload :Enumerable    , 'core/models/concerns/enumerable'
       autoload :Historizable  , 'core/models/concerns/historizable'
       autoload :MimeTypable   , 'core/models/concerns/mime_typable'

data/lib/core/models/permissions/group.rb

@@ -23,7 +23,7 @@ module Core
         has_and_belongs_to_many :rights, class_name: 'Core::Models::Permissions::Right', inverse_of: :groups
         # @!attribute [rw] routes
         #   @return [Array<Core::Models::Monitoring::Route>] the routes this group can access in the API.
-        has_and_belongs_to_many :routes, class_name: 'Core::Models::Monitoring::Route', inverse_of: :groups
+        has_and_belongs_to_many :routes, class_name: 'Core::Models::Permissions::Route', inverse_of: :groups
 
         make_sluggable 'group'
       end

data/lib/core/models/{monitoring → permissions}/route.rb

@@ -1,7 +1,7 @@
 module Core
   module Models
-    module Monitoring
-      # A route is an endpoint accessible in a service. Each route has to have an associated endpoint in the deployed instances.
+    module Permissions
+      # A route is an endpoint accessible in the API. Each route has to have an associated endpoint in the deployed instances.
       # @param Vincent Courtois <courtois.vincent@outlook.com>
       class Route
         include Mongoid::Document
@@ -10,19 +10,14 @@ module Core
         include Core::Models::Concerns::Activable
 
         # @!attribute [rw] path
-        #   @return [String] the path (URI) of the route in the service?
+        #   @return [String] the path (URI) of the route in the API.
         field :path, type: String, default: '/'
         # @!attribute [rw] verb
-        #   @return [String] the verb (HTTP method) of this route in the service.
+        #   @return [String] the verb (HTTP method) of this route in the API.
         field :verb, type: String, default: 'get'
         # @!attribute [rw] authenticated
         #   @return [Boolean] if true, the session_id is needed for this route, if false it is not.
         field :authenticated, type: Boolean, default: true
-
-        # @!attribute [rw] service
-        #   @return [Core::Models::Monitoring::Service] the service in which this route is declared.
-        belongs_to :service, class_name: 'Core::Models::Monitoring::Service', inverse_of: :routes
-
         # @!attribute [rw] groups
         #   @return [Array<Core::Models::Permissions::Group>] the groups having permission to access this route.
         has_and_belongs_to_many :groups, class_name: 'Core::Models::Permissions::Group', inverse_of: :groups
@@ -32,12 +27,6 @@ module Core
 
         validates :verb,
           inclusion: {message: 'unknown', in: ['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.
-        def complete_path
-          path == '/' ? service.path : "#{service.path}#{path}"
-        end
       end
     end
   end

data/lib/core/models/permissions.rb

@@ -7,6 +7,7 @@ module Core
       autoload :Right   , 'core/models/permissions/right'
       autoload :Group   , 'core/models/permissions/group'
       autoload :Category, 'core/models/permissions/category'
+      autoload :Route   , 'core/models/permissions/route'
     end
   end
 end

data/lib/core/models.rb

@@ -15,13 +15,10 @@ module Core
     autoload :Chatrooms     , 'core/models/chatrooms'
     autoload :Concerns      , 'core/models/concerns'
     autoload :Event         , 'core/models/event'
-    autoload :Factories     , 'core/models/factories'
     autoload :Files         , 'core/models/files'
-    autoload :Monitoring    , 'core/models/monitoring'
     autoload :Notification  , 'core/models/notification'
     autoload :OAuth         , 'core/models/oauth'
     autoload :Permissions   , 'core/models/permissions'
-    autoload :Phone         , 'core/models/phone'
     autoload :Ruleset       , 'core/models/ruleset'
   end
 end

data/lib/core/version.rb

@@ -1,3 +1,3 @@
 module Core
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/core.rb

@@ -6,5 +6,7 @@ require 'dotenv/load'
 # Main module of the application, holding all the subsequent classes.
 # @author Vincent Courtois <courtois.vincent@outlook.com>
 module Core
+  autoload :Controllers, 'core/controllers'
+  autoload :Helpers, 'core/helpers'
   autoload :Models, 'core/models'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: virtuatable-core
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Vincent Courtois
@@ -30,28 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 6.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.1.0
-- !ruby/object:Gem::Dependency
-  name: factory_girl
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 4.8.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 4.8.1
+        version: 6.2.1
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +94,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -179,21 +179,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.9.25
 - !ruby/object:Gem::Dependency
-  name: mongoid
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 6.0.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.1.0
+        version: 6.0.3.2
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
@@ -207,47 +207,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 6.0.3.2
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: bcrypt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.0.3.2
+        version: 3.1.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.0.3.2
+        version: 3.1.13
 - !ruby/object:Gem::Dependency
-  name: bcrypt
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.1.13
+        version: 2.7.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.1.13
+        version: 2.7.6
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.7.6
+        version: 7.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.7.6
+        version: 7.1.0
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 description: This gem holds the model layer for my table-top RPG games application.
 email: courtois.vincent@outlook.com
 executables: []
@@ -255,6 +283,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/core.rb
+- lib/core/controllers.rb
+- lib/core/controllers/base.rb
+- lib/core/helpers.rb
+- lib/core/helpers/accounts.rb
+- lib/core/helpers/applications.rb
+- lib/core/helpers/declarators.rb
+- lib/core/helpers/errors.rb
+- lib/core/helpers/errors/bad_request.rb
+- lib/core/helpers/errors/base.rb
+- lib/core/helpers/errors/forbidden.rb
+- lib/core/helpers/errors/not_found.rb
+- lib/core/helpers/fields.rb
+- lib/core/helpers/parameters.rb
+- lib/core/helpers/responses.rb
+- lib/core/helpers/routes.rb
+- lib/core/helpers/sessions.rb
 - lib/core/models.rb
 - lib/core/models/account.rb
 - lib/core/models/authentication.rb
@@ -271,26 +315,16 @@ files:
 - lib/core/models/chatrooms/message.rb
 - lib/core/models/concerns.rb
 - lib/core/models/concerns/activable.rb
-- lib/core/models/concerns/diagnosticable.rb
 - lib/core/models/concerns/enumerable.rb
 - lib/core/models/concerns/historizable.rb
 - lib/core/models/concerns/mime_typable.rb
 - lib/core/models/concerns/premiumable.rb
 - lib/core/models/concerns/sluggable.rb
 - lib/core/models/concerns/typable.rb
-- lib/core/models/decorators/errors.rb
-- lib/core/models/decorators/errors/env_variable_missing.rb
-- lib/core/models/decorators/gateway.rb
 - lib/core/models/event.rb
-- lib/core/models/factories.rb
-- lib/core/models/factories/errors.rb
-- lib/core/models/factories/errors/gateway_not_found.rb
 - lib/core/models/files.rb
 - lib/core/models/files/document.rb
 - lib/core/models/files/permission.rb
-- lib/core/models/monitoring.rb
-- lib/core/models/monitoring/route.rb
-- lib/core/models/monitoring/service.rb
 - lib/core/models/notification.rb
 - lib/core/models/oauth.rb
 - lib/core/models/oauth/access_token.rb
@@ -301,6 +335,7 @@ files:
 - lib/core/models/permissions/category.rb
 - lib/core/models/permissions/group.rb
 - lib/core/models/permissions/right.rb
+- lib/core/models/permissions/route.rb
 - lib/core/models/ruleset.rb
 - lib/core/version.rb
 homepage: https://rubygems.org/gems/virtuatable-core

data/lib/core/models/concerns/diagnosticable.rb

@@ -1,24 +0,0 @@
-module Core
-  module Models
-    module Concerns
-      # Includes the diagnostic URL field, and the related validations.
-      # @author Vincent Courtois <courtois.vincent@outlook.com>
-      module Diagnosticable
-        extend ActiveSupport::Concern
-
-        # Module holding the class methods for the classes including this concern.
-        # @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).
-          field :diagnostic, type: String, default: '/status'
-
-          validates :diagnostic,
-            presence: {message: "required"},
-            length: {minimum: 4, message: "minlength"},
-            format: {with: /\A(\/[a-z]+)+\z/, message: "pattern"}
-        end
-      end
-    end
-  end
-end

data/lib/core/models/decorators/errors/env_variable_missing.rb

@@ -1,16 +0,0 @@
-module Core
-  module Models
-    module Decorators
-      module Errors
-        # Error raised if the application key variable is missing.
-        # @author Vincent Courtois <courtois.vincent@outlook.com>
-        class EnvVariableMissing < Core::Models::Utils::Errors::HTTPError
-
-          def initialize(action:)
-            super(action, 'app_key', 'not_found', 404)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/core/models/decorators/errors.rb

@@ -1,11 +0,0 @@
-module Core
-  module Models
-    module Decorators
-      # Module holding all the errors concerning the code of the decorators.
-      # @author Vincent Courtois <courtois.vincent@outlook.com>
-      module Errors
-        autoload :EnvVariableMissing, 'core/models/decorators/errors/env_variable_missing'
-      end
-    end
-  end
-end

data/lib/core/models/decorators/gateway.rb

@@ -1,111 +0,0 @@
-module Core
-  module Models
-    module Decorators
-      # Decorator for a service, providing methods to make requests on it.
-      # @author Vincent Courtois <courtois.vincent@outlook.com>
-      class Gateway < Draper::Decorator
-        delegate_all
-
-        # @!attribute [rw] action
-        #   @return [String] the action of the route using this API.
-        attr_accessor :action
-
-        attr_accessor :logger
-
-        def initialize(action, _object)
-          super(_object)
-          @logger = Logger.new(STDOUT)
-          @action = action
-        end
-
-        # Shortcut to make a DELETE request on the API.
-        # @param session [Core::Models::Authentication::Session] the session of the user requesting the API.
-        # @param url [String] the URL you want to reach on the service.
-        # @param params [Hash] the additional parameters to pass in the JSON body.
-        def delete(session:, url:, params:)
-          return make_request_without_body(verb: 'delete', session: session, url: url, params: params)
-        end
-
-        # Shortcut to make a GET request on the API.
-        # @param session [Core::Models::Authentication::Session] the session of the user requesting the API.
-        # @param url [String] the URL you want to reach on the service.
-        # @param params [Hash] the additional parameters to pass in the JSON body.
-        def get(session:, url:, params:)
-          return make_request_without_body(verb: 'get', session: session, url: url, params: params)
-        end
-
-        # Shortcut to make a POST request on the API.
-        # @param session [Core::Models::Authentication::Session] the session of the user requesting the API.
-        # @param url [String] the URL you want to reach on the service.
-        # @param params [Hash] the additional parameters to pass in the JSON body.
-        def post(session:, url:, params:)
-          return make_request(verb: 'post', session: session, url: url, params: params)
-        end
-
-        # Shortcut to make a PUT request on the API.
-        # @param session [Core::Models::Authentication::Session] the session of the user requesting the API.
-        # @param url [String] the URL you want to reach on the service.
-        # @param params [Hash] the additional parameters to pass in the JSON body.
-        def put(session:, url:, params:)
-          return make_request(verb: 'put', session: session, url: url, params: params)
-        end
-
-        private
-
-        # Makes a POST request to the given service with the following steps :
-        # 1. Gets an active and running instance of the service to make the request.
-        # 2. Creates a Faraday connection to use it as a pipeline for the request.
-        # 3. Makes the actual request and returns an object with the status and body of the response.
-        #
-        # @param verb [String] the HTTP verb to use for this request.
-        # @param session [Core::Models::Authentication::Session] the session of the user requesting the API.
-        # @param url [String] the URL you want to reach on the service.
-        # @param params [Hash] the additional parameters to pass in the JSON body.
-        #
-        # @return [Hash, Boolean] FALSE if no instance are found, or an object with :status and :body keys correspding
-        #                         to the status and body of the response to the request
-        def make_request(verb:, session:, url:, params:)
-          params = before_requests(session, params)
-          connection = get_connection
-
-          response = connection.send(verb) do |req|
-            req.url url
-            req.headers['Content-Type'] = 'application/json'
-            req.body = params.to_json
-          end
-
-          return {
-            status: response.status,
-            body: JSON.parse(response.body)
-          }
-        end
-
-        def make_request_without_body(verb:, session:, url:, params:)
-          params = before_requests(session, params)
-          connection = get_connection
-          response = connection.send(verb) do |req|
-            req.url url, params
-            req.headers['Content-Type'] = 'application/json'
-          end
-        end
-
-        def before_requests(session, params)
-          if ENV['APP_KEY'].nil?
-            raise Core::Models::Decorators::Errors::EnvVariableMissing.new(action: action)
-          end
-          params[:app_key] = ENV['APP_KEY']
-          params[:session_id] = session.token
-          return params
-        end
-
-        def get_connection
-          Faraday.new(object.url) do |faraday|
-            faraday.request  :url_encoded
-            faraday.response :logger
-            faraday.adapter  Faraday.default_adapter
-          end
-        end
-      end
-    end
-  end
-end

data/lib/core/models/factories/errors/gateway_not_found.rb

@@ -1,16 +0,0 @@
-module Core
-  module Models
-    module Factories
-      module Errors
-        # Error raised when not gateway active and running is found in the factory.
-        # @author Vincent Courtois <courtois.vincent@outlook.com>
-        class GatewayNotFound < Core::Models::Utils::Errors::HTTPError
-
-          def initialize(action:)
-            super(action, 'gateway_id', 'not_found', 404)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/core/models/factories/errors.rb

@@ -1,11 +0,0 @@
-module Core
-  module Models
-    module Factories
-      # Module holding all the errors concerning the code of the factories.
-      # @author Vincent Courtois <courtois.vincent@outlook.com>
-      module Errors
-        autoload :GatewayNotFound, 'core/models/factories/errors/gateway_not_found'
-      end
-    end
-  end
-end

data/lib/core/models/factories.rb

@@ -1,10 +0,0 @@
-module Core
-  module Models
-    # Static factories are used to create decorated objects easily.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    module Factories
-      autoload :Gateways, 'core/models/factories/gateways'
-      autoload :Errors  , 'core/models/factories/errors'
-    end
-  end
-end

data/lib/core/models/monitoring/service.rb

@@ -1,33 +0,0 @@
-module Core
-  module Models
-    module Monitoring
-      # A service is the representation of one of the applications composing the API.
-      # @author Vincent Courtois <courtois.vincent@outlook.com>
-      class Service
-        include Mongoid::Document
-        include Mongoid::Timestamps
-        include Core::Models::Concerns::Activable
-        include Core::Models::Concerns::Diagnosticable
-        include Core::Models::Concerns::Premiumable
-
-        # @!attribute [rw] key
-        #   @return [String] the name of the service, used as a namespace on the Kubernetes side.
-        field :key, type: String
-        # @!attribute [rw] path
-        #   @return [String] the path the service will be mapped on in the API. This will be used in the Ingress.
-        field :path, type: String, default: '/'
-
-        # @!attribute [rw] creator
-        #   @return [Core::Models::Account] the creator of this service.
-        belongs_to :creator, class_name: 'Core::Models::Account', optional: true, inverse_of: :services
-        # @!attribute [rw] routes
-        #   @return [Array<Core::Models::Monitoring::Route>] the routes associated to this service, accessible from the gateway.
-        has_many :routes, class_name: 'Core::Models::Monitoring::Route', inverse_of: :service
-
-        validates :key, uniqueness: {message: 'uniq'}
-
-        validates :path, format: {with: /\A(\/:?[a-z]+)+\z/, message: 'pattern'}
-      end
-    end
-  end
-end

data/lib/core/models/monitoring.rb

@@ -1,10 +0,0 @@
-module Core
-  module Models
-    # 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  , 'core/models/monitoring/route'
-      autoload :Service, 'core/models/monitoring/service'
-    end
-  end
-end