arkaan 1.10.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3f79b8da492a5bfaf83581bd87a361d6037294f185ce6c2f2287f1d2a65b0e7
-  data.tar.gz: fc6f180aff359447096bbda6b5b7014c0b87de9f448d536024eac852a8581954
+  metadata.gz: edf2d8ccd56f2083589f47086566a40400b98295249d3b2cefe0dc980584cb86
+  data.tar.gz: 1c27bc8b6fae7cec149f26f89ec9265892ff29d09e51a4b346cc57e2b171e6f1
 SHA512:
-  metadata.gz: 6dfb33ab03f87d8a8b8dadffa1c3ed4111924eb23c3cfb97863a3cfa104cae4f98ff4167b3c2aef0d88456db78d04ea13dad69c3e046aadf3e04259e3c4ec2ee
-  data.tar.gz: 99db55a4ae62a79d4c5aaab2f3922b30db0455aafa3083255ebd6be60f912c473c8d1445183b8d803b6bd4fba0ce7f501b3dfb5e5f0c77c69fc7c1df84db104c
+  metadata.gz: 063cde9a9b391fcea46b43829e251c25649f98e063fa8344294b15168b5d0c90b63248e4102d503e19a6624cd082023a5ed279d95fb679c315eaeb4fed6525b2
+  data.tar.gz: ee49a9fda2912e8efc873207914aec9e61c575290d742012458d86dfa75ec50b1631a3a65a4fb87d262ecb6bcecdd405204bdb5798de0cd086a244493dd2f897

data/lib/arkaan.rb

@@ -17,7 +17,6 @@ module Arkaan
   autoload :Campaign      , 'arkaan/campaign'
   autoload :Campaigns     , 'arkaan/campaigns'
   autoload :Concerns      , 'arkaan/concerns'
-  autoload :Decorators    , 'arkaan/decorators'
   autoload :Factories     , 'arkaan/factories'
   autoload :Monitoring    , 'arkaan/monitoring'
   autoload :Notification  , 'arkaan/notification'
@@ -25,5 +24,4 @@ module Arkaan
   autoload :Permissions   , 'arkaan/permissions'
   autoload :Phone         , 'arkaan/phone'
   autoload :Ruleset       , 'arkaan/ruleset'
-  autoload :Utils         , 'arkaan/utils'
 end

data/lib/arkaan/account.rb

@@ -61,9 +61,6 @@ module Arkaan
     #   @return [Array<Arkaan::Monitoring::Websocket>] the websockets created by the owner of this account.
     has_many :websockets, class_name: 'Arkaan::Monitoring::Websocket', inverse_of: :creator
 
-    # @!attribute [rw] phones
-    #   @return [Array<Arkaan::Phone>] the phone numbers given by the user.
-    embeds_many :phones, class_name: 'Arkaan::Phone', inverse_of: :account
     # @!attribute [rw] notifications
     #  @return [Array<Arkaan::Notification>] the notifications linked to this user.
     embeds_many :notifications, class_name: 'Arkaan::Notification', inverse_of: :account

data/lib/arkaan/version.rb

@@ -1,3 +1,3 @@
 module Arkaan
-  VERSION = '1.10.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-22 00:00:00.000000000 Z
+date: 2019-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -319,7 +319,6 @@ files:
 - lib/arkaan/concerns/premiumable.rb
 - lib/arkaan/concerns/sluggable.rb
 - lib/arkaan/concerns/typable.rb
-- lib/arkaan/decorators.rb
 - lib/arkaan/decorators/errors.rb
 - lib/arkaan/decorators/errors/env_variable_missing.rb
 - lib/arkaan/decorators/gateway.rb
@@ -348,22 +347,7 @@ files:
 - lib/arkaan/permissions/category.rb
 - lib/arkaan/permissions/group.rb
 - lib/arkaan/permissions/right.rb
-- lib/arkaan/phone.rb
 - lib/arkaan/ruleset.rb
-- lib/arkaan/specs.rb
-- lib/arkaan/utils.rb
-- lib/arkaan/utils/controllers.rb
-- lib/arkaan/utils/controllers/base.rb
-- lib/arkaan/utils/controllers/checked.rb
-- lib/arkaan/utils/errors.rb
-- lib/arkaan/utils/errors/bad_request.rb
-- lib/arkaan/utils/errors/forbidden.rb
-- lib/arkaan/utils/errors/http_error.rb
-- lib/arkaan/utils/errors/not_found.rb
-- lib/arkaan/utils/loaders.rb
-- lib/arkaan/utils/loaders/heroku.rb
-- lib/arkaan/utils/micro_service.rb
-- lib/arkaan/utils/seeder.rb
 - lib/arkaan/version.rb
 homepage: https://rubygems.org/gems/arkaan
 licenses:

data/lib/arkaan/decorators.rb

@@ -1,8 +0,0 @@
-module Arkaan
-  # Decorators are used to enrich the features of the model classes without making it too big.
-  # @author Vincent Courtois <courtois.vincent@outlook.com>
-  module Decorators
-    autoload :Gateway, 'arkaan/decorators/gateway'
-    autoload :Errors , 'arkaan/decorators/errors'
-  end
-end

data/lib/arkaan/phone.rb

@@ -1,24 +0,0 @@
-module Arkaan
-  # A phone number is given by a user so that the persons he has selected can have it to contact him.
-  # @author Vincent Courtois <courtois.vincent@outlook.com>
-  class Phone
-    include Mongoid::Document
-    include Mongoid::Timestamps
-    include Arkaan::Concerns::Enumerable
-
-    # @!attribute [rw] privacy
-    #   @return [Symbol] the level of privacy you want for this phone number.
-    enum_field :privacy, [:players, :public, :private], default: :private
-    # @!attribute [rw] number
-    #   @return [Integer] the phone number the user has given.
-    field :number, type: String
-
-    # @!attribute [rw] account
-    #   @return [Arkaan::Account] the account the phone number is associated to.
-    embedded_in :account, class_name: 'Arkaan::Account', inverse_of: :phones
-
-    validates :number,
-      presence: {message: 'required'},
-      format: {with: /\A[0-9\-\._\/]+\z/, message: 'pattern'}
-  end
-end

data/lib/arkaan/specs.rb

@@ -1,89 +0,0 @@
-module Arkaan
-  # This module holds all the logic for the specs tools for all micro services (shared examples and other things).
-  # @author Vincent Courtois <courtois.vincent@outlook.com>
-  module Specs
-
-    # Includes all the shared examples you could need, describing the basic behaviour of a route.
-    def self.include_shared_examples
-      RSpec.shared_examples 'a route' do |_verb, _path|
-        let(:verb) { _verb }
-        let(:path) { _path }
-
-        def do_request(parameters)
-          public_send verb.to_sym, path, ['get', 'delete'].include?(verb) ? parameters : parameters.to_json
-        end
-
-        describe 'common errors' do
-          describe 'bad request errors' do
-            describe 'no token error' do
-              before do
-                do_request({app_key: 'test_key'})
-              end
-              it 'Raises a bad request (400) error when the parameters don\'t contain the token of the gateway' do
-                expect(last_response.status).to be 400
-              end
-              it 'returns the correct response if the parameters do not contain a gateway token' do
-                expect(JSON.parse(last_response.body)).to eq({
-                  'status' => 400,
-                  'field' => 'token',
-                  'error' => 'required',
-                  'docs' => 'https://github.com/jdr-tools/wiki/wiki/Common-errors#gateway-token-not-given'
-                })
-              end
-            end
-            describe 'no application key error' do
-              before do
-                do_request({token: 'test_token'})
-              end
-              it 'Raises a bad request (400) error when the parameters don\'t contain the application key' do
-                expect(last_response.status).to be 400
-              end
-              it 'returns the correct response if the parameters do not contain a application key' do
-                expect(JSON.parse(last_response.body)).to eq({
-                  'status' => 400,
-                  'field' => 'app_key',
-                  'error' => 'required',
-                  'docs' => 'https://github.com/jdr-tools/wiki/wiki/Common-errors#application-key-not-given'
-                })
-              end
-            end
-          end
-          describe 'not_found errors' do
-            describe 'application not found' do
-              before do
-                do_request({token: 'test_token', app_key: 'another_key'})
-              end
-              it 'Raises a not found (404) error when the key doesn\'t belong to any application' do
-                expect(last_response.status).to be 404
-              end
-              it 'returns the correct body when the application doesn\'t exist' do
-                expect(JSON.parse(last_response.body)).to eq({
-                  'status' => 404,
-                  'field' => 'app_key',
-                  'error' => 'unknown',
-                  'docs' => 'https://github.com/jdr-tools/wiki/wiki/Common-errors#application-key-not-found'
-                })
-                end
-            end
-            describe 'gateway not found' do
-              before do
-                do_request({token: 'other_token', app_key: 'test_key'})
-              end
-              it 'Raises a not found (404) error when the gateway does\'nt exist' do
-                expect(last_response.status).to be 404
-              end
-              it 'returns the correct body when the gateway doesn\'t exist' do
-                expect(JSON.parse(last_response.body)).to eq({
-                  'status' => 404,
-                  'field' => 'token',
-                  'error' => 'unknown',
-                  'docs' => 'https://github.com/jdr-tools/wiki/wiki/Common-errors#gateway-token-not-found'
-                })
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/utils.rb

@@ -1,10 +0,0 @@
-module Arkaan
-  # Utility classes for the different micro-services of the suite.
-  # @author Vincent Courtois <courtois.vincent@outlook.com>
-  module Utils
-    autoload :Controllers , 'arkaan/utils/controllers'
-    autoload :Errors      , 'arkaan/utils/errors'
-    autoload :Loaders     , 'arkaan/utils/loaders'
-    autoload :MicroService, 'arkaan/utils/micro_service'
-  end
-end

data/lib/arkaan/utils/controllers.rb

@@ -1,8 +0,0 @@
-module Arkaan
-  module Utils
-    module Controllers
-      autoload :Base   , 'arkaan/utils/controllers/base'
-      autoload :Checked, 'arkaan/utils/controllers/checked'
-    end
-  end
-end

data/lib/arkaan/utils/controllers/base.rb

@@ -1,215 +0,0 @@
-module Arkaan
-  module Utils
-    module Controllers
-      # Base controller to handle the standard error when accessing the API.
-      # @author Vincent Courtois <courtois.vincenet@outlook.com>
-      class Base < Sinatra::Base
-        register Sinatra::ConfigFile
-        helpers Sinatra::CustomLogger
-
-        configure do
-          set :logger, Logger.new(STDOUT)
-          logger.level = Logger::ERROR if ENV['RACK_ENV'] == 'test'
-        end
-
-        # Creates a premium route whithin the Sinatra application, and registers it in the database if it does not already exists.
-        # @param verb [String] the HTTP method used to create this route.
-        # @param path [String] the path, beginning with a /, of the route to create.
-        def self.declare_route(verb, path, options: {}, &block)
-          self.declare_route_with(verb, path, false, options, &block)
-        end
-
-        # Creates a non premium route whithin the Sinatra application, and registers it in the database if it does not already exists.
-        # @param verb [String] the HTTP method used to create this route.
-        # @param path [String] the path, beginning with a /, of the route to create.
-        def self.declare_premium_route(verb, path, options: {}, &block)
-          self.declare_route_with(verb, path, true, options, &block)
-        end
-
-        # Declares the status route of the service, used by the Vigilante to check its status
-        # @param path [String] the path used to map the route on.
-        def self.declare_status_route(path = '/status')
-          self.declare_route_with('get', path, false, { authanticated: false }) do
-            if params['token'].nil?
-              custom_error 400, 'vigilante.token.required'
-            elsif Arkaan::Monitoring::Vigilante.where(token: params[:token]).first.nil?
-              custom_error 404, 'vigilante.token.unknown'
-            end
-            service = Arkaan::Utils::MicroService.instance.service
-            informations = {
-              key: service.key,
-              path: service.path,
-              health: 'ok'
-            }
-            halt 200, informations.to_json
-          end
-          Arkaan::Utils::MicroService.instance.service.update_attribute(:diagnostic, path)
-        end
-
-        # Creates a route whithin the Sinatra application, and registers it in the database if it does not already exists.
-        # @param verb [String] the HTTP method used to create this route.
-        # @param path [String] the path, beginning with a /, of the route to create.
-        # @param premium [Boolean] TRUE to make the route premium, FALSE otherwise.
-        def self.declare_route_with(verb, path, premium, options, &block)
-          service = Arkaan::Utils::MicroService.instance.service
-          complete_path = "#{Arkaan::Utils::MicroService.instance.path}#{path == '/' ? '' : path}"
-
-          unless service.nil? || !service.routes.where(path: path, verb: verb).first.nil?
-            route = Arkaan::Monitoring::Route.create(path: path, verb: verb, premium: premium, service: service)
-            if !options.nil? && !options[:authenticated].nil?
-              route.update_attribute(:authenticated, false)
-            end
-            Arkaan::Permissions::Group.where(is_superuser: true).each do |group|
-              group.routes << route
-              group.save!
-            end
-          end
-          if premium
-            self.public_send(verb, complete_path) do
-              @sinatra_route = parse_current_route
-              if !@application.premium?
-                custom_error(403, 'common.app_key.forbidden')
-              end
-              instance_eval(&block)
-            end
-          else
-            self.public_send(verb, complete_path, &block)
-          end
-          complete_path
-        end
-
-        # Loads the errors configuration file from the config folder.
-        # @param file [String] send __FILE__
-        def self.load_errors_from(file)
-          config_file File.join(File.dirname(file), '..', 'config', 'errors.yml')
-        end
-
-        def before_checks
-          add_body_to_params
-
-          check_presence('token', 'app_key', route: 'common')
-
-          gateway = Arkaan::Monitoring::Gateway.where(token: params['token']).first
-          @application = Arkaan::OAuth::Application.where(key: params['app_key']).first
-          
-          if gateway.nil?
-            custom_error(404, 'common.token.unknown')
-          elsif @application.nil?
-            custom_error(404, 'common.app_key.unknown')
-          end
-        end
-
-        # 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
-        # @param route [String] the name of the route you're requiring to put in the error message.
-        def check_presence(*fields, route:)
-          fields.each do |field|
-            custom_error(400, "#{route}.#{field}.required") if params[field].nil? || params[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 route [String] the name of the route you're requiring to put in the error message.
-        # @param key [String] the key to search in the errors configuration file.
-        def check_either_presence(*fields, route:, key:)
-          fields.each do |field|
-            return true if !params[field].nil? && params[field] != ''
-          end
-          custom_error 400, "#{route}.#{key}.required"
-        end
-
-        # Checks if the session ID is given in the parameters and if the session exists.
-        # @param action [String] the action used to get the errors from the errors file.
-        # @return [Arkaan::Authentication::Session] the session when it exists.
-        def check_session(action)
-          check_presence('session_id', route: action)
-          session = Arkaan::Authentication::Session.where(token: params['session_id']).first
-          if session.nil?
-            custom_error(404, "#{action}.session_id.unknown")
-          end
-          return session
-        end
-
-        def check_application(action)
-          check_presence('app_key', route: action)
-          application = Arkaan::OAuth::Application.where(key: params['app_key']).first
-          custom_error(404, "#{action}.app_key.unknown") if application.nil?
-          return application
-        end
-
-        # Adds the parsed body to the parameters, overwriting the parameters of the querystring with the values
-        # of the SON body if they have similar keys.
-        def add_body_to_params
-          if request.body.respond_to?(:rewind) && request.body.respond_to?(:read)
-            request.body.rewind 
-            parsed_body = JSON.parse(request.body.read.to_s) rescue {}
-            parsed_body.keys.each do |key|
-              params[key] = parsed_body[key]
-            end
-          end
-        end
-
-        # Gets the current route in the database from the sinatra route.
-        # @return [Arkaan::Monitoring::Route] the route declared in the services registry.
-        def parse_current_route
-          splitted = request.env['sinatra.route'].split(' ')
-          return Arkaan::Monitoring::Route.where(verb: splitted.first.downcase, path: splitted.last).first
-        end
-
-        # Halts the application and creates the returned body from the parameters and the errors config file.
-        # @param status [Integer] the HTTP status to halt the application with.
-        # @param path [String] the path in the configuration file to access the URL.
-        def custom_error(status, path)
-          route, field, error = path.split('.')
-          docs = settings.errors[route][field][error] rescue ''
-          halt status, {status: status, field: field, error: error, docs: docs}.to_json
-        end
-
-        # Halts the application with a Bad Request error affecting a field of a model.
-        # @param instance [Mongoid::Document] the document having a field in error.
-        # @param route [String] the type of action you're currently doing (e.g: 'creation')
-        def model_error(instance, route)
-          messages = instance.errors.messages
-          field = messages.keys.first
-          custom_error(400, "#{route}.#{field}.#{messages[field].first}")
-        end
-
-        # Select parameters in the params hash, by its keys.
-        # @param fields [Array<String>] the keys to select in the params hash.
-        # @return [Hash] the selected chunk of the params hash.
-        def select_params(*fields)
-          return params.select { |key, value| fields.include?(key) }
-        end
-
-        # Creates a custom error from an existing Arkaan exception class.
-        # @param exception {StandardError} the exception to transform in a usable error.
-        def handle_arkaan_exception(exception)
-          custom_error(exception.status, "#{exception.action}.#{exception.field}.#{exception.error}")
-        end
-
-        error Arkaan::Utils::Errors::BadRequest do |exception|
-          handle_arkaan_exception(exception)
-        end
-
-        error Arkaan::Utils::Errors::Forbidden do |exception|
-          handle_arkaan_exception(exception)
-        end
-
-        error Arkaan::Utils::Errors::NotFound do |exception|
-          handle_arkaan_exception(exception)
-        end
-
-        error Arkaan::Factories::Errors::GatewayNotFound do |exception|
-          handle_arkaan_exception(exception)
-        end
-
-        if ENV['RACK_ENV'] != 'test'
-          error StandardError do |exception|
-            custom_error(500, 'system_error.unknown_field.unknown_error')
-          end
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/utils/controllers/checked.rb

@@ -1,21 +0,0 @@
-module Arkaan
-  module Utils
-    module Controllers
-      # Base controller to handle the standard error when accessing the API.
-      # @author Vincent Courtois <courtois.vincenet@outlook.com>
-      class Checked < Arkaan::Utils::Controllers::Base
-
-        before do
-          pass if route_is_diagnostic?
-          before_checks
-        end
-
-        def route_is_diagnostic?
-          service = Arkaan::Utils::MicroService.instance.service
-          diagnostic = "#{service.path}#{service.diagnostic}"
-          request.path_info == diagnostic
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/utils/errors.rb

@@ -1,12 +0,0 @@
-module Arkaan
-  module Utils
-    # Module gathering all the exception classes used throughout the utils module, mainly linked to HTTP errors.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    module Errors
-      autoload :BadRequest, 'arkaan/utils/errors/bad_request'
-      autoload :Forbidden , 'arkaan/utils/errors/forbidden'
-      autoload :NotFound  , 'arkaan/utils/errors/not_found'
-      autoload :HTTPError , 'arkaan/utils/errors/http_error'
-    end
-  end
-end

data/lib/arkaan/utils/errors/bad_request.rb

@@ -1,14 +0,0 @@
-module Arkaan
-  module Utils
-    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 < Arkaan::Utils::Errors::HTTPError
-
-        def initialize(action:, field:, error:)
-          super(action, field, error, 400)
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/utils/errors/forbidden.rb

@@ -1,14 +0,0 @@
-module Arkaan
-  module Utils
-    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 < Arkaan::Utils::Errors::HTTPError
-
-        def initialize (field:, action:, error:)
-          super(action, field, error, 403)
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/utils/errors/http_error.rb

@@ -1,30 +0,0 @@
-module Arkaan
-  module Utils
-    module Errors
-      # Standard class parent to all specialized http errors.
-      # @author Vincent Courtois <courtois.vincent@outlook.com>
-      class HTTPError < 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 (action, field, error, status)
-          @action = action
-          @field = field.to_s
-          @error = error
-          @status = status
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/utils/errors/not_found.rb

@@ -1,14 +0,0 @@
-module Arkaan
-  module Utils
-    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 < Arkaan::Utils::Errors::HTTPError
-
-        def initialize (field:, action:, error:)
-          super(action, field, error, 404)
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/utils/loaders.rb

@@ -1,7 +0,0 @@
-module Arkaan
-  module Utils
-    module Loaders
-      autoload :Heroku, 'arkaaan/utils/loaders/heroku'
-    end
-  end
-end

data/lib/arkaan/utils/loaders/heroku.rb

@@ -1,20 +0,0 @@
-module Arkaan
-  module Utils
-    module Plugins
-      class Heroku
-        # Loads the heroku informations inside the data of the instance.
-        # @param instance [Arkaan::Monitoring::Instance] the instance to put the enrichment inside.
-        def self.load!(instance)
-          if !ENV['OAUTH_TOKEN'].nil? && instance != false && instance.persisted?
-            heroku = PlatformAPI.connect_oauth(ENV['OAUTH_TOKEN'])
-            regex = /\Ahttps?:\/\/([a-z\-]+).herokuapp.com\/?\z/
-            if instance.url.match(regex)
-              app_name = instance.url.scan(regex).first.first
-              instance.update_attribute(:data, heroku.app.info(app_name))
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/utils/micro_service.rb

@@ -1,170 +0,0 @@
-module Arkaan
-  module Utils
-    # This class is a singleton to load and save parameters for the whole application.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    class MicroService
-      include Singleton
-
-      # @!attribute [r] name
-      #   @return [String] the name of the service you want to load.
-      attr_reader :service
-      # @!attribute [r] location
-      #   @return [String] the path to the file loading the whole application, used to deduce the loading paths.
-      attr_reader :location
-      # @!attribute [r] name
-      #   @return [String] the name of the service, used later to instantiate it when the mongoid configuration is fully loaded.
-      attr_reader :name
-      # @!attribute [r] instance
-      #   @return [Arkaan::Monitoring::Instance] the instance of the service currently deployed.
-      attr_reader :instance
-      # @!attribute [r] type
-      #   @return [Symbol] the type of instance the application is declaring
-      attr_reader :type
-
-      def initialize
-        @location = false
-        @service = false
-        @instance = false
-        @name = false
-        @type = ENV['INSTANCE_TYPE'] || :heroku
-        @controller_classes = []
-      end
-
-      def get_controllers
-        return [] if defined?(Controllers).nil?
-        classes = Controllers.constants.map { |symbol| get_const(symbol) }
-        return classes.select { |symbol| symbol.is_a? Class }
-      end
-
-      def get_const(symbol)
-        return Object.const_get("Controllers::#{symbol.to_s}")
-      end
-
-      # Determines if the application can be loaded (all the parameters have been correctly set)
-      # @return [Boolean] TRUE if the application can be safely loaded, FALSE otherwise.
-      def loadable?
-        return !!(service && location)
-      end
-
-      # Getter for the path on which the service is mapped.
-      # @return [String, Boolean] the absolute path in the URL on which the service is mapped upon, or FALSE if it's not set already.
-      def path
-        return service ? service.path : false
-      end
-
-      # Look for the service and sets it if it's found in the database, or set it to nil if not found.
-      # @param [String] service_name - the name of the service to look for in the database.
-      # @return [Arkaan::utils::MicroService] the instance of the micro-service to chain other calls.
-      def register_as(service_name)
-        @name = service_name
-        return self
-      end
-
-      # Sets the location of the file calling the micro service and initializing it so that it's used as root.
-      # @param filename [String] the full naame of the file with the extension.
-      # @return [Arkaan::utils::MicroService] the instance of the micro-service to chain other calls.
-      def from_location(filename)
-        @location = File.dirname(filename)
-        return self
-      end
-
-      # Loads the application in standard (production/development) mode, without the test files.
-      # @return [Arkaan::utils::MicroService] the instance of the micro-service to chain other calls.
-      def in_standard_mode
-        return load_application(test_mode: false)
-      end
-
-      # Loads the application in test mode, by adding the needed files to run the test suite to the standard loading process.
-      # @return [Arkaan::utils::MicroService] the instance of the micro-service to chain other calls.
-      def in_test_mode
-        @location = File.join(location, '..')
-        return load_application(test_mode: true)
-      end
-
-      # Loads the application as a websockets service. Only the websockets application should use that.
-      # @return [Arkaan::utils::MicroService] the instance of the micro-service to chain other calls.
-      def in_websocket_mode
-        load_mongoid_configuration
-        load_standard_files
-
-        Arkaan::Monitoring::Websocket.find_or_create_by(url: ENV['WEBSOCKET_URL']).save
-        return self
-      end
-
-      # Deactivates the current instance and the associated service if no more instances are available.
-      def deactivate!
-        instance.update_attribute(:running, false)
-        service.update_attribute(:test_mode, false) if ENV['TEST_MODE']
-      end
-
-      private
-
-      # Registers the service in the database if it has not been created already.
-      def register_service
-        @service = Arkaan::Monitoring::Service.create(key: @name, path: "/#{@name}")
-      end
-
-      # Register the instance of the currently deployed service in the database.
-      # @return [Arkaan::Monitoring::Instance] the instance of the micro service currently running.
-      def register_instance
-        @instance = @service.instances.where(url: ENV['SERVICE_URL']).first
-        if @instance.nil?
-          @instance = Arkaan::Monitoring::Instance.create(service: @service, url: ENV['SERVICE_URL'], type: type)
-        end
-        @instance.update_attribute(:running, true)
-        return @instance
-      end
-
-      # Loads the configuration for Mongoid, the files of the application, and registers the service and the instance in the database.
-      # @param test_mode [Boolean] TRUE to run in test mode (from /spec), FALSE otherwise.
-      # @return [Arkaan::Utils::MicroService] the current instance of the micro service to chain other calls.
-      def load_application(test_mode: false)
-        Dotenv.load
-        load_mongoid_configuration(test_mode: test_mode)
-        if !!(@name && location)
-          @service = Arkaan::Monitoring::Service.where(key: @name).first
-          register_service if @service.nil?
-          if ENV['TEST_MODE']
-            @service.update_attribute(:test_mode, true)
-          end
-          register_instance
-          load_plugin!
-          if service
-            load_standard_files
-            load_test_files if test_mode
-          end
-        end
-        return self
-      end
-
-      def load_plugin!
-        plugin = ENV['ADDITIONAL_PLUGIN']
-        if !plugin.nil? && Arkaan::Utils::Plugins.constants.include?(plugin)
-          Arkaan::Utils::Plugins.const_get(plugin).load!(@instance)
-        end
-      end
-
-      def load_mongoid_configuration(test_mode: false)
-        environment = test_mode ? 'test' : (ENV['RACK_ENV'] || 'development')
-        Mongoid.load!(File.join(@location, 'config', 'mongoid.yml'), environment)
-      end
-
-      def load_standard_files
-        require_folder('decorators')
-        require_folder('services')
-        require_folder('controllers')
-      end
-
-      def load_test_files
-        require_folder('spec', 'support')
-        require_folder('spec', 'shared')
-      end
-
-      def require_folder(*folders)
-        Dir[File.join(location, folders, '**', '*.rb')].each do |filename|
-          require filename
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/utils/seeder.rb

@@ -1,25 +0,0 @@
-module Arkaan
-  module Utils
-    # This class loads the necessary data in the database if they don't exist yet.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    class Seeder
-      include Singleton
-
-      # Creates the service if it does not exist, and the instance if it does not exist.
-      # @return [Arkaan::Monitoring::Service] the created, or found, service corresponding to this micro-service.
-      def create_service(key)
-        service = Arkaan::Monitoring::Service.where(key: key).first
-
-        if service.nil?
-          service = Arkaan::Monitoring::Service.create!(key: key, path: "/#{key}", premium: true, active: true)
-        end
-
-        if service.instances.where(url: ENV['SERVICE_URL']).first.nil?
-          Arkaan::Monitoring::Instance.create!(url: ENV['SERVICE_URL'], running: true, service: service, active: true)
-        end
-
-        return service
-      end
-    end
-  end
-end