virtuatable 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 664caa63ef674481d52d3e64d130b8d77d84b17d056bf67a83bdebaf8080b242
+  data.tar.gz: 561d5e41f63903e40b6aa6475f4ca02adcc21f72e83e5d05bced1455032798d2
+SHA512:
+  metadata.gz: f3922bbe8ef2e8028bf038325230de839cfc72ed5ad55cb8a939ae8998cfbe76914efc15e824c7ae6088d07363502632562afc976b70417e0231e4620ecebc53
+  data.tar.gz: 17f71d7877daf35d1451dfa2057231686751a40f4843aa48b227175a75689a7c7c7342e521c034ed364814d5427fd6080d3f96aebfec21e069eb2bebbe6914d6

data/lib/virtuatable/api/errors/bad_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module API
+    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 < Virtuatable::API::Errors::Base
+        def initialize(field:, error:)
+          super(field: field, error: error, status: 400)
+        end
+      end
+    end
+  end
+end

data/lib/virtuatable/api/errors/base.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module API
+    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
+
+        def message
+          "#{field}.#{error}"
+        end
+      end
+    end
+  end
+end

data/lib/virtuatable/api/errors/forbidden.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module API
+    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 < Virtuatable::API::Errors::Base
+        def initialize(field:, error:)
+          super(field: field, error: error, status: 403)
+        end
+      end
+    end
+  end
+end

data/lib/virtuatable/api/errors/not_found.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module API
+    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 < Virtuatable::API::Errors::Base
+        def initialize(field:, error:)
+          super(field: field, error: error, status: 404)
+        end
+      end
+    end
+  end
+end

data/lib/virtuatable/api/errors.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module API
+    # This module defines method to raise HTTP errors in the routes easily.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Errors
+      autoload :Base, 'virtuatable/api/errors/base'
+      autoload :BadRequest, 'virtuatable/api/errors/bad_request'
+      autoload :Forbidden, 'virtuatable/api/errors/forbidden'
+      autoload :NotFound, 'virtuatable/api/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/virtuatable/api.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  # The API module gathers all classes called inside a route, for
+  # example the errors thrown from the routes as HTTP status.
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
+  module API
+    autoload :Errors, 'virtuatable/api/errors'
+  end
+end

data/lib/virtuatable/application.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  # Wrapping class to easily create builders.
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
+  class Application
+    include Singleton
+
+    # @!attribute [rw] builder
+    #   @return [Virtuatable::Builders::Base] the base builder for the application.
+    attr_accessor :builder
+
+    # Loads the application in normal mode, call this from a config.ru file to
+    # load the environment, configuration, and require the necessary files.
+    # @param name [String] the name of the service you're loading.
+    def self.load!(name, locations: caller_locations, path: '.')
+      builder = Virtuatable::Builders::Base.new(
+        locations: locations,
+        path: path,
+        name: name
+      )
+      self.instance.builder = builder
+      builder.load!
+      builder
+    end
+
+    # Loads the application from a spec/spec_helper to load the specs.
+    # @param name [String] the name of the service to load the specs of.
+    def self.load_tests!(name, locations: caller_locations, path: '..')
+      builder = Virtuatable::Builders::Tests.new(
+        locations: locations,
+        path: path,
+        name: name
+      )
+      self.instance.builder = builder
+      builder.load!
+      builder
+    end
+
+    # Wrapper to simplify the call to instance.:builder
+    # @return [Virtuatable::Builders::Base] the builder of the current application.
+    def self.builder
+      instance.builder
+    end
+  end
+end

data/lib/virtuatable/builders/base.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  # The builders classes declares the micro service at startup in one of the services
+  # It provides chainable methods to be able to configure and correctly launch the
+  # micro-service by requiring dependencies, files, and mounting controllers.
+  #
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
+  module Builders
+    # The base class provides methods to load all elements of the application.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Base
+      extend Virtuatable::Builders::Helpers::Loaders
+      # We include this module only for test purposes to mock require_all
+      include RequireAll
+      # Include all the helpers now that loaders can be declared.
+      include Virtuatable::Builders::Helpers::Controllers
+      include Virtuatable::Builders::Helpers::Environment
+      include Virtuatable::Builders::Helpers::Folders
+      include Virtuatable::Builders::Helpers::Mongoid
+      include Virtuatable::Builders::Helpers::Registration
+
+      # @!attribute [r] directory
+      #   @return [String] the directory from which the application is loaded.
+      #     In most case, just pass __dir__ from the config.ru file.
+      attr_reader :directory
+      # @!attribute [r] mode
+      #   @return [Symbol] :test or :development depending on what you're trying to
+      #     load the service for.
+      attr_reader :mode
+      # @!attribute [rw] name
+      #   @return [String] the name of the micro-service.
+      attr_accessor :name
+
+      # Constructor of the builder, initializing needed attributes.
+      # @param directory [String] the directory from which load the application.
+      def initialize(locations: caller_locations, path: '.', name:)
+        # The base folder of the file calling the builder
+        filedir = File.dirname(locations.first.absolute_path)
+        @directory = File.absolute_path(File.join(filedir, path))
+        @mode = :development
+        @name = name.to_s
+      end
+
+      def load!
+        all_loaders.each do |loader|
+          send(:"load_#{loader[:name]}!")
+        end
+      end
+
+      # Checks the presence of all the needed environment variables.
+      # @raise [Virtuatable::Builders::Errors::MissingEnv] if a variable is not present,
+      #   for a variable to be present she has to be a key of the ENV constant.
+      def check_variables!
+        names = ['INSTANCE_TYPE']
+        names.each do |varname|
+          exception_klass = Virtuatable::Builders::Errors::MissingEnv
+          raise exception_klass.new(variable: varname) unless ENV.key?(varname)
+        end
+      end
+
+      # Returns the type of the instance, default being a UNIX server
+      # @return [Symbol] the type of instance currently loading.
+      def type
+        ENV['INSTANCE_TYPE'].nil? ? :unix : ENV['INSTANCE_TYPE'].to_sym
+      end
+
+      # Loads a list of folders given as method parameters
+      # @param *folders [Array<String>] the folders names passed as parameters.
+      def require_folders(*folders)
+        folders.each do |folder|
+          path = File.join(directory, folder)
+          require_all(path) if File.directory?(path)
+        end
+      end
+
+      def sanitized_ancestors
+        self.class.ancestors - self.class.included_modules
+      end
+
+      # Gets the loaders of the current class and all its ancestors that have loaders
+      # @return [Array<Symbol>] the name of the loaders declared.
+      def all_loaders
+        superclasses = sanitized_ancestors.select do |ancestor|
+          ancestor != self.class
+        end
+        ancestors_loaders = superclasses.map do |ancestor|
+          ancestor.respond_to?(:loaders) ? ancestor.loaders : []
+        end
+        flattened_loaders = (ancestors_loaders + self.class.loaders).flatten
+        flattened_loaders.sort_by { |loader| loader[:priority] }
+      end
+    end
+  end
+end

data/lib/virtuatable/builders/errors/missing_env.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module Builders
+    module Errors
+      # This error is raised when a variable is missing.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class MissingEnv < StandardError
+        # @!attribute [r] variable
+        #   @return [String] the nam:e of the missing variable.
+        attr_reader :variable
+
+        def initialize(variable:)
+          @variable = variable
+        end
+      end
+    end
+  end
+end

data/lib/virtuatable/builders/errors.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module Builders
+    # Module holding the errors raised at the loading of the service
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Errors
+      autoload :MissingEnv, 'virtuatable/builders/errors/missing_env'
+    end
+  end
+end

data/lib/virtuatable/builders/helpers/controllers.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module Builders
+    module Helpers
+      # Loading helpers to require and map all controllers classes inside a service.
+      # A controller is defined as a class inside de "Controllers" root module.
+      # If the module "Controllers" has not been defined, the list of controllers is
+      # always empty, as no controller can be loaded.
+      #
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      module Controllers
+        # Loads all of the controllers, given that the /controllers folder
+        # has already been fully required, therefore all constants are declared.
+        def controllers
+          return [] if defined?(::Controllers).nil?
+
+          classes = Controllers.constants.map { |symbol| get_const(symbol) }
+          classes.select { |symbol| symbol.is_a? Class }
+        end
+      end
+    end
+  end
+end

data/lib/virtuatable/builders/helpers/environment.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module Builders
+    module Helpers
+      # Loads the environment variables from the .env file at the project's root.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      module Environment
+        extend ActiveSupport::Concern
+
+        included do
+          declare_loader(:environment, priority: 0)
+        end
+
+        def load_environment!
+          Dotenv.load
+        end
+      end
+    end
+  end
+end

data/lib/virtuatable/builders/helpers/folders.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module Builders
+    module Helpers
+      # This module loads the file for a standard application,
+      # not loading the files needed for specs or websockets.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      module Folders
+        extend ActiveSupport::Concern
+
+        included do
+          declare_loader(:folders, priority: 2)
+        end
+
+        def load_folders!
+          require_folders('controllers', 'services', 'decorators')
+        end
+      end
+    end
+  end
+end

data/lib/virtuatable/builders/helpers/loaders.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module Builders
+    module Helpers
+      # Add the methods to declare an array of loaders into a builder class.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      module Loaders
+        # @!attribute [rw] loaders
+        #   @return [Array] an array of loading functions invoked at startup.
+        attr_accessor :loaders
+
+        # Declares a loader in the current builder class.
+        # @param loader [Symbol] the name of the loader, infered as the method name to call.
+        def declare_loader(loader, priority:)
+          loader_h = {name: loader.to_sym, priority: priority}
+          @loaders.nil? ? @loaders = [loader_h] : @loaders << loader_h
+        end
+      end
+    end
+  end
+end

data/lib/virtuatable/builders/helpers/mongoid.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module Builders
+    module Helpers
+      # Loads the Mongoid Configuration given the folder from where the application
+      # is loaded, and the type of job requiring it (specs or a service basically)
+      module Mongoid
+        extend ActiveSupport::Concern
+
+        included do
+          declare_loader(:mongoid, priority: 1)
+        end
+
+        def load_mongoid!
+          filepath = File.join(@directory, 'config', 'mongoid.yml')
+          ::Mongoid.load!(filepath, @mode)
+        end
+      end
+    end
+  end
+end

data/lib/virtuatable/builders/helpers/registration.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module Builders
+    module Helpers
+      # Registers the service in the database by declaring it as a
+      # Arkaan::Monitoring::Service object, and declaring the instance.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      module Registration
+        extend ActiveSupport::Concern
+
+        # @!attribute [r] service
+        #   @return [Arkaan::Monitoring::Service] the service linked to this application.
+        attr_reader :service
+        # @!attribute [r] instance
+        #   @return [Arkaan::Monitoring::Instance] the instance of this application.
+        attr_reader :instance
+
+        included do
+          declare_loader(:registration, priority: 3)
+        end
+
+        # Registers the service in the micro-services registry (consisting in
+        # the arkaan_monitoring_services and arkaan_monitoring_instances collections)
+        def load_registration!
+          @service = Arkaan::Monitoring::Service.first_or_create!(
+            key: @name,
+            path: "/#{@name}"
+          )
+          @instance = service.instances.first_or_create!(
+            type: type,
+            url: ENV['SERVICE_URL']
+          )
+        end
+      end
+    end
+  end
+end

data/lib/virtuatable/builders/helpers/tests.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module Builders
+    module Helpers
+      # This helpers loads the folders specific in a specs loading scenario.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      module Tests
+        extend ActiveSupport::Concern
+
+        included do
+          declare_loader(:tests, priority: 4)
+        end
+
+        def load_tests!
+          require_folders('spec/support', 'spec/shared')
+        end
+      end
+    end
+  end
+end

data/lib/virtuatable/builders/helpers.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module Builders
+    # These helpers are used when loading the application.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Helpers
+      autoload :Controllers, 'virtuatable/builders/helpers/controllers'
+      autoload :Environment, 'virtuatable/builders/helpers/environment'
+      autoload :Folders, 'virtuatable/builders/helpers/folders'
+      autoload :Loaders, 'virtuatable/builders/helpers/loaders'
+      autoload :Mongoid, 'virtuatable/builders/helpers/mongoid'
+      autoload :Registration, 'virtuatable/builders/helpers/registration'
+      autoload :Tests, 'virtuatable/builders/helpers/tests'
+    end
+  end
+end

data/lib/virtuatable/builders/tests.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module Builders
+    # Builder used to declare an application from a spec/spec_helper file, loading everything
+    # a normal loader requires, then adding the files specialized in tests.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class Tests < Virtuatable::Builders::Base
+      include Virtuatable::Builders::Helpers::Tests
+
+      def initialize(path: '..', name:, locations: caller_locations)
+        super(locations: locations, path: path, name: name)
+        @mode = :test
+      end
+    end
+  end
+end

data/lib/virtuatable/builders.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  # Builders are used to load all the needed elements in the application,
+  # either from the config.ru as an app, or the spec_helper as tests.
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
+  module Builders
+    autoload :Base, 'virtuatable/builders/base'
+    autoload :Errors, 'virtuatable/builders/errors'
+    autoload :Helpers, 'virtuatable/builders/helpers'
+    autoload :Tests, 'virtuatable/builders/tests'
+  end
+end

data/lib/virtuatable/controllers/base.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  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.
+      include Virtuatable::API::Errors
+      # Includes the checking methods for sessions.
+      include Virtuatable::Helpers::Sessions
+      # Include the checkers and getters for the API gateway.
+      include Virtuatable::Helpers::Gateways
+      # Include the checkers and getters for OAuth apps
+      include Virtuatable::Helpers::Applications
+      # Include checkers for field requirement and check
+      include Virtuatable::Helpers::Fields
+      # Include the getter for the currently requested route.
+      include Virtuatable::Helpers::Routes
+      # Include the getter and checkers for accounts.
+      include Virtuatable::Helpers::Accounts
+      # This module is extended, not included, because it provides routes
+      # declaration methods used in class declarations.
+      extend Virtuatable::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|
+        api_bad_request errors.document.errors.messages.keys.first
+      end
+
+      error Virtuatable::API::Errors::NotFound do |exception|
+        api_not_found exception.message
+      end
+
+      error Virtuatable::API::Errors::BadRequest do |exception|
+        api_bad_request exception.message
+      end
+
+      error Virtuatable::API::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/virtuatable/controllers.rb

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

data/lib/virtuatable/helpers/accounts.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module Helpers
+    # These helpers provide methods used to get and check accounts.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Accounts
+      # Gets the account linked to the current session.
+      # @return [Arkaan::Account] the account linked to the current session.
+      def account
+        !respond_to?(:session) || session.nil? ? nil : session.account
+      end
+
+      def account!
+        api_bad_request 'session_id.required' if account.nil?
+      end
+    end
+  end
+end

data/lib/virtuatable/helpers/applications.rb

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

data/lib/virtuatable/helpers/declarators.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  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) && gateway!
+          session! if current_route.authenticated
+        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: complete_path(path),
+          verb: verb.downcase,
+          premium: options[:premium],
+          service: builder.service,
+          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
+
+      def add_permissions(route)
+        route.groups = Arkaan::Permissions::Group.where(is_superuser: true)
+        route.save!
+        route
+      end
+
+      def complete_path(path)
+        service_path = builder.service.path == '/' ? '' : builder.service.path
+        "#{service_path}#{path}"
+      end
+
+      # Returns the current builder loading the application.
+      # @return [Virtuatable::Builers::Base] the current builder of the application.
+      def builder
+        Virtuatable::Application.builder
+      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/virtuatable/helpers/fields.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  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/virtuatable/helpers/gateways.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module Helpers
+    # These helpers holds getters and checkers about API gateways.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Gateways
+      # Gets the gateway associated to the gatexway token in parameters.
+      # @return [Arkaan::Monitoring::Gateway] the gateway requesting the service
+      def gateway
+        Arkaan::Monitoring::Gateway.where(token: params['token']).first
+      end
+
+      # Checks the gateway requesting the service and raises an error if necessary.
+      def gateway!
+        check_presence 'token'
+        api_not_found 'token.unknown' if gateway.nil?
+
+        gateway
+      end
+    end
+  end
+end

data/lib/virtuatable/helpers/routes.rb

@@ -0,0 +1,11 @@
+module Virtuatable
+  module Helpers
+    module Routes
+      def current_route
+        splitted = request.env['sinatra.route'].split(' ')
+        verb = splitted.first.downcase
+        Arkaan::Monitoring::Route.find_by(verb: verb, path: splitted.last)
+      end
+    end
+  end
+end

data/lib/virtuatable/helpers/sessions.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  module Helpers
+    # This helper gives access to methods about user's session on the API.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Sessions
+      # Returns the session of the user requesting the API.
+      # @return [Arkaan::Authentication::Session] the session of the requester.
+      def session
+        Arkaan::Authentication::Session.where(token: params['session_id']).first
+      end
+
+      # 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.
+      def session!
+        check_presence 'session_id'
+        api_not_found 'session_id.unknown' if session.nil?
+
+        session
+      end
+    end
+  end
+end

data/lib/virtuatable/helpers.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  # The helpers are used inside the controllers to dynamically
+  # add features and functions.
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
+  module Helpers
+    autoload :Accounts, 'virtuatable/helpers/accounts'
+    autoload :Applications, 'virtuatable/helpers/applications'
+    autoload :Declarators, 'virtuatable/helpers/declarators'
+    autoload :Fields, 'virtuatable/helpers/fields'
+    autoload :Gateways, 'virtuatable/helpers/gateways'
+    autoload :Routes, 'virtuatable/helpers/routes'
+    autoload :Sessions, 'virtuatable/helpers/sessions'
+  end
+end

data/lib/virtuatable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Virtuatable
+  VERSION = '0.3.0'
+end

data/lib/virtuatable.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Main module of the application, containing each other one.
+# @author Vincent Courtois <courtois.vincent@outlook.com>
+module Virtuatable
+  autoload :API, 'virtuatable/api'
+  autoload :Application, 'virtuatable/application'
+  autoload :Builders, 'virtuatable/builders'
+  autoload :Controllers, 'virtuatable/controllers'
+  autoload :Helpers, 'virtuatable/helpers'
+  autoload :Loader, 'virtuatable/application'
+end

metadata

@@ -0,0 +1,411 @@
+--- !ruby/object:Gem::Specification
+name: virtuatable
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Vincent Courtois
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: rspec-json_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.7
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.76.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.76.0
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.0.1
+- !ruby/object:Gem::Dependency
+  name: arkaan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.11
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: platform-api
+  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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+- !ruby/object:Gem::Dependency
+  name: draper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: This gem holds controllers, errors, service delcarations, etc. for the
+  Virtuatable services.
+email: courtois.vincent@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/virtuatable.rb
+- lib/virtuatable/api.rb
+- lib/virtuatable/api/errors.rb
+- lib/virtuatable/api/errors/bad_request.rb
+- lib/virtuatable/api/errors/base.rb
+- lib/virtuatable/api/errors/forbidden.rb
+- lib/virtuatable/api/errors/not_found.rb
+- lib/virtuatable/application.rb
+- lib/virtuatable/builders.rb
+- lib/virtuatable/builders/base.rb
+- lib/virtuatable/builders/errors.rb
+- lib/virtuatable/builders/errors/missing_env.rb
+- lib/virtuatable/builders/helpers.rb
+- lib/virtuatable/builders/helpers/controllers.rb
+- lib/virtuatable/builders/helpers/environment.rb
+- lib/virtuatable/builders/helpers/folders.rb
+- lib/virtuatable/builders/helpers/loaders.rb
+- lib/virtuatable/builders/helpers/mongoid.rb
+- lib/virtuatable/builders/helpers/registration.rb
+- lib/virtuatable/builders/helpers/tests.rb
+- lib/virtuatable/builders/tests.rb
+- lib/virtuatable/controllers.rb
+- lib/virtuatable/controllers/base.rb
+- lib/virtuatable/helpers.rb
+- lib/virtuatable/helpers/accounts.rb
+- lib/virtuatable/helpers/applications.rb
+- lib/virtuatable/helpers/declarators.rb
+- lib/virtuatable/helpers/fields.rb
+- lib/virtuatable/helpers/gateways.rb
+- lib/virtuatable/helpers/routes.rb
+- lib/virtuatable/helpers/sessions.rb
+- lib/virtuatable/version.rb
+homepage: https://rubygems.org/gems/arkaan
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: All the utility classes for the Virtuatable services
+test_files: []