arkaan 2.5.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80b65e16a31919ea1c4b6958699a8f04761f2c3274295bcaac34fc70a46fabed
-  data.tar.gz: 2e3373367d3d606bb3428071019ab3855c48fbbc046b493389854fa194d65f0e
+  metadata.gz: a4990a4abb8ed39b023c47fed7560e0cad8aea739b74ed3a849ede6cf903f655
+  data.tar.gz: c83e4c79e96321d68b2a95774d7203a649850c27883b4bd0aa2f758c9d7bc9ea
 SHA512:
-  metadata.gz: aecaa05461f94dcd92e220a8c190cf2f63128c9a5d452f8e439e9ac6364484895b7c539db63ed3cdcbc2c77aef6d4f2a8499bb7fa5486f708b829b629ed42927
-  data.tar.gz: '09c8362fabd66d216e7f22b20d2792ed5071c255ad356a39c222422eefeb013f0c9b0c68d100461980e05522d3e34b8263ef53eee410c9c04392d48b6a9dbe04'
+  metadata.gz: 511fac191930fd795fc4f3961a249ef44159b0f21680f3a009efdd64b3e80c60a2de1046e938b73ae2eb6889a61e8355889367b6cb868ca2eb4f97eedd730c17
+  data.tar.gz: 72b3aa7b65f4f2bc142c5cab8c4859ca569e57f978d261c50c20c7495724dadbb33f554a9eaf911c12b7774f9f7690bef956891d10250965383d901c748c1b35

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/monitoring.rb

@@ -2,12 +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 :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/version.rb

@@ -1,3 +1,3 @@
 module Arkaan
-  VERSION = '2.5.1'
+  VERSION = '2.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.6.0
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-23 00:00:00.000000000 Z
+date: 2020-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -272,15 +272,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

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