arkaan 2.5.0 → 2.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7876afd3de8047883f8c7a4cedd1311c4b40dc3fdd711c3ebfa9b6abd118e330
-  data.tar.gz: 975ad0b4de93452222925f704460cb25f8d760cc26643bc2c1cd6377964a7fe4
+  metadata.gz: 49b4f5f61273d5bb04c52296fbd6d98d2132e960872d2f3ef13c0abb9843f16c
+  data.tar.gz: 2f6a9767b394c101937eee1275116c034a5aec3152ecd55a81f27d771cf2619e
 SHA512:
-  metadata.gz: 799b4bc8be02916ef27d7e3b99ee57991849450f7b0b2cab54945ebe8863a85a858836de4745725325fa76408b7799b284b7a28e91cc3bf3a294310b02daa314
-  data.tar.gz: 9e233034348c67b2a29672e3fe9154e252c5ce42819474c19b68cbf0adec613d1fb2dd9ce86ce3cba4823c46097bc7801a247132361ac2f08991b670f5f20326
+  metadata.gz: 988474c07ee9facdd07b1d5e29baaadfbe65c68b4b7dd9b6c85474f4bdf31363205d85a5dc91e3a298d10ef436317922953b5867699165b84986911caf4b8186
+  data.tar.gz: aaa639ed45955ca052dc7aea2fec0090b9e6fc9d8c69afb2ed1258f5b161e902a96593124848666fa4c340626b240455a09428bca1da4250a061c10e4e44a817

data/lib/arkaan.rb

@@ -13,6 +13,7 @@ module Arkaan
   autoload :Chatroom      , 'arkaan/chatroom'
   autoload :Chatrooms     , 'arkaan/chatrooms'
   autoload :Concerns      , 'arkaan/concerns'
+  autoload :Event         , 'arkaan/event'
   autoload :Factories     , 'arkaan/factories'
   autoload :Files         , 'arkaan/files'
   autoload :Monitoring    , 'arkaan/monitoring'

data/lib/arkaan/account.rb

@@ -57,9 +57,6 @@ module Arkaan
     # @!attribute [rw] invitations
     #   @return [Array<Arkaan::Campaigns::Invitation>] the invitations you've issued yourself to other players.
     has_many :created_invitations, class_name: 'Arkaan::Campaigns::Invitation', inverse_of: :creator
-    # @!attribute [rw] websockets
-    #   @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] permissions
     #   @return [Array<Arkaan::Files::Permission>] the file access permissions granted to this account.
     has_many :permissions, class_name: 'Arkaan::Files::Permission', inverse_of: :account

data/lib/arkaan/campaign.rb

@@ -51,14 +51,18 @@ module Arkaan
     # @param account [Arkaan::Account] the account of the creator for this campaign.
     def creator=(account)
       if !invitations.where(account: account).exists?
-        Arkaan::Campaigns::Invitation.create(campaign: self, account: account, enum_status: :creator)
+        invitation = Arkaan::Campaigns::Invitation.create(
+          campaign: self,
+          account: account,
+          status: :creator
+        )
       end
     end
 
     # Getter for the creator account of this campaign.
     # @return [Arkaan::Account] the account of the player creating this campaign.
     def creator
-      return invitations.where(enum_status: :creator).first.account
+      invitations.to_a.find(&:status_creator?).account
     end
 
     # Adds an error message if the account creating this campaign already has a campaign with the very same name.
@@ -83,7 +87,9 @@ module Arkaan
 
     # @return [Array<Arkaan::Campaigns::Invitation>] the players in this campaign.
     def players
-      invitations.where(enum_status: :accepted)
+      invitations.to_a.select do |invitation|
+        [:creator, :accepted].include? invitation.enum_status
+      end
     end
 
     # @return [Integer] the number of players in this campaign.

data/lib/arkaan/campaigns/invitation.rb

@@ -1,15 +1,16 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Campaigns
-    # An invitation is the linked between a player and a campaign, accepted or not.
+    # An invitation is the linked between a player and a campaign.
+    # It keeps the history of the interaction between the player and the campaign.
+    #
     # @author Vincent Courtois <courtois.vincent@outlook.com>
     class Invitation
       include Mongoid::Document
       include Mongoid::Timestamps
       include Arkaan::Concerns::Enumerable
-
-      # @!attribute [rw] status
-      #   @return [Symbol] the current status of the invitation.
-      enum_field :status, [:accepted, :blocked, :expelled, :ignored, :left, :pending, :refused, :request, :creator], default: :pending
+      include Arkaan::Concerns::Historizable
 
       # @!attribute [rw] account
       #   @return [Arkaan::Account] the account the invitation has been issued to.
@@ -17,6 +18,12 @@ module Arkaan
       # @!attribute [rw] campaign
       #   @return [Arkaan::Campaign] the campaign the invitation has been made in.
       belongs_to :campaign, class_name: 'Arkaan::Campaign', inverse_of: :invitations
+
+      # @!attribute [rw] status
+      #   @return [Symbol] the current status of the invitation.
+      historize enum_field :status,
+        [:pending, :request, :accepted, :refused, :expelled, :left, :master, :creator],
+        default: :pending
     end
   end
-end
+end

data/lib/arkaan/campaigns/tag.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Arkaan
   module Campaigns
     # A campaign tag is a string describing a characteristic of the campaign it's in.
@@ -13,9 +15,7 @@ module Arkaan
       #   @return [Integer] the number of campaigns this tag is in, avoiding a join.
       field :count, type: Integer, default: 1
 
-      validates :content,
-        presence: {message: 'required'},
-        uniqueness: {message: 'uniq'}
+      validates :content, presence: { message: 'required' }, uniqueness: { message: 'uniq' }
     end
   end
-end
+end

data/lib/arkaan/concerns.rb

@@ -5,6 +5,7 @@ module Arkaan
     autoload :Activable     , 'arkaan/concerns/activable'
     autoload :Diagnosticable, 'arkaan/concerns/diagnosticable'
     autoload :Enumerable    , 'arkaan/concerns/enumerable'
+    autoload :Historizable  , 'arkaan/concerns/historizable'
     autoload :MimeTypable   , 'arkaan/concerns/mime_typable'
     autoload :Premiumable   , 'arkaan/concerns/premiumable'
     autoload :Sluggable     , 'arkaan/concerns/sluggable'

data/lib/arkaan/concerns/enumerable.rb

@@ -14,7 +14,7 @@ module Arkaan
         # @param values [Array<Symbol>] the possible values of the enumerated field.
         # @param options [Hash<Symbol, Any>] the possible options for the field.
         def enum_field(field_name, values, options = {})
-          field :"enum_#{field_name}", type: Symbol, default: options[:default]
+          returned = field :"enum_#{field_name}", type: Symbol, default: options[:default]
 
           validates :"enum_#{field_name}", inclusion: {in: values.map(&:to_sym), message: 'inclusion'}
 
@@ -37,6 +37,10 @@ module Arkaan
               self["enum_#{field_name}"] == value
             end
           end
+
+          # This is to make enumerations historizable by
+          # returning the field object created by Mongoid.
+          returned
         end
       end
     end

data/lib/arkaan/concerns/historizable.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Arkaan
+  module Concerns
+    # This module is what I call "a beautiful piece of Ruby engineering"
+    # It takes any mongoid field that you may have declared, and historizes
+    # it in a dedicated relation if this relation does not already exists.
+    #
+    # What it does exactly :
+    # - Creates the :history relation if it does not already exists.
+    # - Creates a method to check for changes of a specific attribute.
+    # - Check for changes at initialization to insert the first value.
+    # - Check for changes at update/save to store the history.
+    #
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Historizable
+      extend ActiveSupport::Concern
+
+      # Adds an entry in the history table for the given field.
+      # It checks several things to make the history entry valid :
+      # - the new value is different from the old value
+      # - the old value is identical to the last recorded new value.
+      #
+      # @param field [String] the name of the field to historize
+      # @param from [Any] the old value before update
+      # @param to [Any] the new value after update.
+      def add_history(field:, from:, to:)
+        return if from == to
+        return if !history.empty? && history.order_by(:created_at.desc).first.to != from
+
+        event = Arkaan::Event.create(field: field, from: from, to: to, document: self)
+        event.save
+      end
+
+      # Submodule holding all the static methods add to the current subclass.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      module ClassMethods
+        
+        # Takes the Mongoid declared field and creates the callbacks
+        # to intercept any value change and add it to the history.
+        # @field field [Mongoid::Fields::Standard] the Mongoid field to historize.
+        def historize(field)
+
+          unless relations.key?('history')
+            embeds_many :history, class_name: 'Arkaan::Event'
+          end
+
+          after_initialize do |doc|
+            add_history(field: field.name, from: nil, to: doc[field.name])
+          end
+
+          after_save do |doc|
+            if doc.changed_attributes.key?(field.name)
+              from = doc.changed_attributes[field.name]
+              add_history(field: field.name, from: from, to: doc[field.name])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/arkaan/event.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Arkaan
+  # An event is symbolizing a timestamped change in a model.
+  # It is recommended NOT to use this class directly but to use
+  # the Arkaan::Concerns::Historizable concern in a model.
+  #
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
+  class Event
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    # @!attribute [rw] field
+    #   @return [String] the name of the field being historized
+    field :field, type: String
+    # @!attribute [rw] from
+    #   @return [Any] the value of the field before update
+    field :from
+    # @!attribute [rw] to
+    #   @return [Any] the value of the field after update
+    field :to
+
+    # @!attribute [rw] document
+    #   @return [Any] the model in which the history is embedded
+    embedded_in :document, polymorphic: true, inverse_of: :history
+
+    validates :field, presence: { message: 'required' }
+  end
+end

data/lib/arkaan/monitoring.rb

@@ -2,13 +2,7 @@ module Arkaan
   # The monitoring module holds all the logic about the services so they can be activated or deactivated.
   # @author Vincent Courtois <courtois.vincent@outlook.com>
   module Monitoring
-    autoload :Action   , 'arkaan/monitoring/action'
-    autoload :Gateway  , 'arkaan/monitoring/gateway'
-    autoload :Instance , 'arkaan/monitoring/instance'
-    autoload :Results  , 'arkaan/monitoring/results'
-    autoload :Route    , 'arkaan/monitoring/route'
-    autoload :Service  , 'arkaan/monitoring/service'
-    autoload :Vigilante, 'arkaan/monitoring/vigilante'
-    autoload :Websocket, 'arkaan/monitoring/websocket'
+    autoload :Route  , 'arkaan/monitoring/route'
+    autoload :Service, 'arkaan/monitoring/service'
   end
 end

data/lib/arkaan/monitoring/service.rb

@@ -10,21 +10,15 @@ module Arkaan
       include Arkaan::Concerns::Premiumable
 
       # @!attribute [rw] key
-      #   @return [String] the name, or title of the service, optionally given to identify it more easily.
+      #   @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.
+      #   @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] test_mode
-      #   @return [Boolean] TRUE if the service is currently in test mode and thus the gateway shall only qurty local instances.
-      field :test_mode, type: Boolean, default: false
 
       # @!attribute [rw] creator
       #   @return [Arkaan::Account] the creator of this service.
       belongs_to :creator, class_name: 'Arkaan::Account', optional: true, inverse_of: :services
-      # @!attribute [rw] instances
-      #   @return [Array<Arkaan::Monitoring::Instance>] the instances of this service currently deployed.
-      embeds_many :instances, class_name: 'Arkaan::Monitoring::Instance', inverse_of: :service
       # @!attribute [rw] routes
       #   @return [Array<Arkaan::Monitoring::Route>] the routes associated to this service, accessible from the gateway.
       has_many :routes, class_name: 'Arkaan::Monitoring::Route', inverse_of: :service

data/lib/arkaan/oauth/access_token.rb

@@ -1,6 +1,7 @@
 module Arkaan
   module OAuth
-    # An access token is the value assigned to the application to access the private data of an account.
+    # An access token is the value assigned to the application
+    # to access the data the user is allowed to access.
     # @author Vincent Courtois <courtois.vincent@outlook.com>
     class AccessToken
       include Mongoid::Document
@@ -15,11 +16,17 @@ module Arkaan
 
       # @!attribute [rw] authorization
       #   @return [Arkaan::OAuth::Authorization] the authorization code that issued this token to the application for this user.
-      belongs_to :authorization, class_name: 'Arkaan::OAuth::Authorization', inverse_of: :access_token
+      belongs_to :authorization, class_name: 'Arkaan::OAuth::Authorization', inverse_of: :tokens
 
       validates :value, 
         presence: {message: 'required'},
         uniqueness: {message: 'uniq'}
+
+      # Checks if the current date is inferior to the creation date + expiration period
+      # @return [Boolean] TRUE if the token is expired, FALSE otherwise.
+      def expired?
+        created_at.to_time.to_i + expiration < Time.now.to_i
+      end
     end
   end
 end

data/lib/arkaan/oauth/authorization.rb

@@ -1,6 +1,9 @@
 module Arkaan
   module OAuth
     # An OAuth authorization is granted by a user to an application to access its personal data.
+    # The application then transforms it into an access token to be able to send it with
+    # further requests, so that we know the user has authorized the application to access its data.
+    #
     # @author Vincent Courtois <courtois.vincent@outlook.com>
     class Authorization
       include Mongoid::Document
@@ -18,7 +21,7 @@ module Arkaan
       belongs_to :application, class_name: 'Arkaan::OAuth::Application', inverse_of: :authorizations
       # @!attribute [rw] token
       #   @return [Arkaan::OAuth::AccessToken] the access token used further in the application process to access private data of the account.
-      has_one :token, class_name: 'Arkaan::OAuth::AccessToken', inverse_of: :authorization
+      has_many :tokens, class_name: 'Arkaan::OAuth::AccessToken', inverse_of: :authorization
 
       validates :code,
         presence: {message: 'required'},

data/lib/arkaan/version.rb

@@ -1,3 +1,3 @@
 module Arkaan
-  VERSION = '2.5.0'
+  VERSION = '2.7.2'
 end

metadata

@@ -1,239 +1,253 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.7.2
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-23 00:00:00.000000000 Z
+date: 2020-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 1.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
-  name: rspec-json_expectations
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 6.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: factory_girl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 4.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 4.8.1
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.8.1
+        version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.8.1
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
-  name: factory_bot
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.1
+        version: 0.13.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.1
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 2.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 2.2.3
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.20
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.20
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec-json_expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.8
+        version: 0.90.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.8
+        version: 0.90.0
 - !ruby/object:Gem::Dependency
-  name: faker
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: 0.9.25
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: 0.9.25
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.1
+        version: 7.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 7.0.1
+        version: 7.1.0
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.3
+        version: 6.0.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.3
+        version: 6.0.3.2
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.3
+        version: 6.0.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.3
+        version: 6.0.3.2
 - !ruby/object:Gem::Dependency
   name: bcrypt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.1.11
+        version: 3.1.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.1.11
+        version: 3.1.13
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.7.2
+        version: 2.7.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.7.2
+        version: 2.7.6
 description: This gem holds the model layer for my table-top RPG games application.
 email: courtois.vincent@outlook.com
 executables: []
@@ -258,6 +272,7 @@ files:
 - lib/arkaan/concerns/activable.rb
 - lib/arkaan/concerns/diagnosticable.rb
 - lib/arkaan/concerns/enumerable.rb
+- lib/arkaan/concerns/historizable.rb
 - lib/arkaan/concerns/mime_typable.rb
 - lib/arkaan/concerns/premiumable.rb
 - lib/arkaan/concerns/sluggable.rb
@@ -265,6 +280,7 @@ files:
 - lib/arkaan/decorators/errors.rb
 - lib/arkaan/decorators/errors/env_variable_missing.rb
 - lib/arkaan/decorators/gateway.rb
+- lib/arkaan/event.rb
 - lib/arkaan/factories.rb
 - lib/arkaan/factories/errors.rb
 - lib/arkaan/factories/errors/gateway_not_found.rb
@@ -272,15 +288,8 @@ files:
 - lib/arkaan/files/document.rb
 - lib/arkaan/files/permission.rb
 - lib/arkaan/monitoring.rb
-- lib/arkaan/monitoring/action.rb
-- lib/arkaan/monitoring/instance.rb
-- lib/arkaan/monitoring/results.rb
-- lib/arkaan/monitoring/results/heartbeat.rb
-- lib/arkaan/monitoring/results/report.rb
 - lib/arkaan/monitoring/route.rb
 - lib/arkaan/monitoring/service.rb
-- lib/arkaan/monitoring/vigilante.rb
-- lib/arkaan/monitoring/websocket.rb
 - lib/arkaan/notification.rb
 - lib/arkaan/oauth.rb
 - lib/arkaan/oauth/access_token.rb
@@ -312,7 +321,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: The model layer for my table-RPG application

data/lib/arkaan/monitoring/action.rb

@@ -1,25 +0,0 @@
-module Arkaan
-  module Monitoring
-    # An action is made by an authorized user on the instance of a server to perform a task.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    class Action
-      include Mongoid::Document
-      include Mongoid::Timestamps
-      include Arkaan::Concerns::Enumerable
-
-      # @!attribute [rw] type
-      #   @return [Symbol] the type of action you're making on this instance
-      enum_field :type, [:restart]
-      # @!attribute [rw] success
-      #   @return [Boolean] TRUE if the action succeeded (or at least was successfully launched), FALSE otherwise.
-      field :success, type: Boolean, default: false
-
-      # @!attribute [rw] user
-      #   @return [Arkaan::Account] the user performing the action on the instance.
-      belongs_to :user, class_name: 'Arkaan::Account'
-      # @!attribute [rw] instance
-      #   @return [Arkaan::Monitoring::Instance] the instance of a service on which the action is performed.
-      embedded_in :instance, class_name: 'Arkaan::Monitoring::Instance', inverse_of: :actions
-    end
-  end
-end

data/lib/arkaan/monitoring/instance.rb

@@ -1,38 +0,0 @@
-module Arkaan
-  module Monitoring
-    # An instance is one of the services, deployed on one server. A service may have many instances to balance the load between them all.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    class Instance
-      include Mongoid::Document
-      include Mongoid::Timestamps
-      include Arkaan::Concerns::Activable
-      include Arkaan::Concerns::Typable
-
-      # @!attribute [rw] url
-      #   @return [String] the URL of the instance, where the requests will be issued.
-      field :url, type: String
-      # @!attribute [rw] running
-      #   @return [Boolean] the running status of the instance, indicating if it can be used or not.
-      field :running, type: Boolean, default: false
-      # @!attribute [rw] data
-      #   @return [Hash] the additional datas for this instance (for example for an Heroku instance it's all the data provided by the API)
-      field :data, type: Hash, default: {}
-
-      scope :running , ->{ where(running: true) }
-
-      # @!attribute [r] service
-      #   @return [Arkaan::Monitoring::Service] the service this instance is linked to.
-      embedded_in :service, class_name: 'Arkaan::Monitoring::Service', inverse_of: :instances
-      # @!attribute [rw] actions
-      #   @return [Arkaan::Monitoring::Action] the actions that has been performed on the service.
-      embeds_many :actions, class_name: 'Arkaan::Monitoring::Action', inverse_of: :instance
-
-      has_many :heartbeats, class_name: 'Arkaan::Monitoring::Results::Heartbeat', inverse_of: :instance
-
-      validates :url,
-        presence: {message: 'required'},
-        format: {with: /\A(https?:\/\/)((([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*)|(localhost:[0-9]{2,4})\/?)\z/, message: 'pattern', if: :url?}
-    end
-  end
-end
-

data/lib/arkaan/monitoring/results.rb

@@ -1,10 +0,0 @@
-module Arkaan
-  module Monitoring
-    # The results module handle classes to make results for the vigilante runs.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    module Results
-      autoload :Report, 'arkaan/monitoring/results/report'
-      autoload :Heartbeat, 'arkaan/monitoring/results/heartbeat'
-    end
-  end
-end

data/lib/arkaan/monitoring/results/heartbeat.rb

@@ -1,50 +0,0 @@
-module Arkaan
-  module Monitoring
-    module Results
-      # A record is the result of the vigilante asking the health of one instance.
-      # @author Vincent Courtois <courtois.vincent@outlook.com>
-      class Heartbeat
-        include Mongoid::Document
-
-        # @!attribute [rw] status
-        #   @return [Integer] the HTTP status of the request made for this record.
-        field :status, type: Integer, default: 500
-        # @!attribute [rw] body
-        #   @return [Hash] the JSON parsed body from the heartbeat request.
-        field :body, type: Hash, default: {}
-        # @!attribute [rw] healthy
-        #   @return [Boolean] TRUE if the instance is deemed healthy, FALSE otherwise.
-        field :healthy, type: Boolean, default: false
-        # @!attribute [rw] started_at
-        #   @return [DateTime] the date at which the heartbeat request has started.
-        field :started_at, type: DateTime
-        # @!attribute [rw] ended_at
-        #   @return [DateTime] the date at which the request was terminated.
-        field :ended_at, type: DateTime
-
-        # @!attribute [rw] instance
-        #   @return [Arkaan::Monitoring::Instance] the instance on which the record has been done.
-        belongs_to :instance, class_name: 'Arkaan::Monitoring::Instance', inverse_of: :heartbeats
-
-        # @!attribute [rw] report
-        #   @return [Arkaan::Monitoring::Results::Report] the report made by the vigilante including this record.
-        belongs_to :report, class_name: 'Arkaan::Monitoring::Results::Report', inverse_of: :heartbeats
-
-        attr_readonly :healthy
-
-        def status=(status)
-          self[:status] = status
-          self[:healthy] = status == 200
-        end
-
-        def start!
-          self.started_at = DateTime.now
-        end
-
-        def end!
-          self.ended_at = DateTime.now
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/monitoring/results/report.rb

@@ -1,46 +0,0 @@
-module Arkaan
-  module Monitoring
-    module Results
-      # A report is the result of one call to the API on one instance status route.
-      # @author Vincent Courtois <courtoi.vincent@outlook.com>
-      class Report
-        include Mongoid::Document
-        include Mongoid::Timestamps
-
-        field :started_at, type: DateTime
-        # @!attribute [rw] ended_at
-        #   @return [DateTime] the timestamp at which the report ends.
-        field :ended_at, type: DateTime
-        # @!attribute [rw] total
-        #   @return [Integer] the total number of services monitored.
-        field :total, type: Integer, default: 0
-        # @!attribute [rw] healthy
-        #   @return [Integer] the number of healthy services amongst all the monitored services.
-        field :healthy, type: Integer, default: 0
-
-        # @!attribute [rw] records
-        #   @return [Array<Arkaan::Monitoring::Results::Record>] the records linked to this report.
-        has_many :heartbeats, class_name: 'Arkaan::Monitoring::Results::Heartbeat', inverse_of: :report
-        # @!attribute [rw] vigilante
-        #   @return [Arkaan::Monitoring::Vigilante] the vigilante application that has created this report.
-        belongs_to :vigilante, class_name: 'Arkaan::Monitoring::Vigilante', inverse_of: :reports
-
-        def add_heartbeat(heartbeat)
-          self.heartbeats << heartbeat
-          self.total += 1
-          self.healthy += (heartbeat.healthy ? 1 : 0)
-          heartbeat.end!
-        end
-
-        def start!
-          self.started_at = DateTime.now
-        end
-
-        def end!
-          self.ended_at = DateTime.now
-          self.save!
-        end
-      end
-    end
-  end
-end

data/lib/arkaan/monitoring/vigilante.rb

@@ -1,48 +0,0 @@
-module Arkaan
-  module Monitoring
-    # A vigilante is a specific type of service that watches over the
-    # infrastructure and give a clear look at its global state.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    class Vigilante
-      include Mongoid::Document
-      include Mongoid::Timestamps
-
-      # @!attribute [rw] token
-      #   @return [String] the token the vigilante uses to identify himself in the services
-      field :token, type: String
-      # @!attribute [rw] max_results
-      #   @return [Integer] the number of results the vigilante should be keeping at any time.
-      #     The oldest result should be erased to not go over the limit
-      field :max_results, type: Integer, default: 20
-
-      # @!attribute [rw] reports
-      #   @return [Array<Arkaan::monitoring::Results::Report>] the report generated by running this vigilante.
-      has_many :reports, class_name: 'Arkaan::Monitoring::Results::Report', inverse_of: :vigilante
-
-      validates :token, presence: {message: 'required'}
-
-      validates :max_results, 
-        numericality: {greater_than: 0, message: 'minimum'}
-
-      # Adds a report to the collection of reports by eventually deleting the oldest one.
-      # @param report [Arkaan::Monitoring::Results::Report] the report to add to the vigilante,
-      #   added only if it does not exceed the max number of reports the vigilante can store.
-      def add_report(report)
-        erase_oldest_result if result_full?
-        reports << report
-      end
-
-      # Checks if the list of reports is already full, or if more can be added.
-      # @return [Boolean] TRUE if the number of reports already exceeds the max number.
-      def results_full?
-        reports.to_a.count >= max_results
-      end
-
-      # Erases the oldest results to keep only MAX - 1 results in the list.
-      def erase_oldest_result
-        limit = reports.count + 1 - vigilante.max_results
-        reports.sort_by(created_at: :asc).limit(limit).each(&:delete)
-      end
-    end
-  end
-end

data/lib/arkaan/monitoring/websocket.rb

@@ -1,25 +0,0 @@
-module Arkaan
-  module Monitoring
-    # The websocket is a particular kind of service, just like the gateway. It always has the same signature.
-    # A websocket document is a particular instance of websocket, located on a server and answering to a URL.
-    # @author Vincent Courtois <courtois.vincent@outlook.com>
-    class Websocket
-      include Mongoid::Document
-      include Mongoid::Timestamps
-      include Arkaan::Concerns::Activable
-      include Arkaan::Concerns::Diagnosticable
-
-      # @!attribute [rw] url
-      #   @return [String] the URL of the websocket to be contacted on.
-      field :url, type: String
-
-      # @!attribute [rw] creator
-      #   @return [Arkaan::Account] the account that created this web socket instance in the database.
-      belongs_to :creator, class_name: 'Arkaan::Account', inverse_of: :web_sockets, optional: true
-      
-      validates :url,
-        presence: {message: 'required'},
-        format: {with: /\A(ws:\/\/)([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*\/?\z/, message: 'pattern', if: :url?}
-    end
-  end
-end