arkaan 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e039bc7b87c996ca5b223e578161c649cd68ce9230580a580ac2162c6dbd302
-  data.tar.gz: 04c8e8dc6c30467dd05a5523da86f6294956414eba9b8d0e10ab3dddebb8230a
+  metadata.gz: cf94af22c1c55882c5232b5aa8db7aeae048ccfc91849318b04a3f19553f9f5f
+  data.tar.gz: adeb1a47fb02a84701f041a488b14205a1c9cf4975134d52fb13f49e242ebf77
 SHA512:
-  metadata.gz: 4a038e2756faf5fed3f24b72b8b9bcc6be1d9dc774ba6dcdc99ab3b6da64b3db3c7143415920173d0d05f937357949f01f3655cc668251888e3fa510dd299152
-  data.tar.gz: 73a86435ff14dbc93a268bfa3300417f1351c40532f7ff3f0bc65b5c4cb00e228211271dcf2b40a4ec1d82fc7c62431b020552416d34a2d2a7ed0a79a048b12d
+  metadata.gz: 6494b1baaa4d884de245074401f5a15a03f8be88affdcda791cdf10b3692da9428d44ca3bab0cb4f80796e3cabd758e5307a6ae8e7654e8c0fdbba5525515f6a
+  data.tar.gz: edb13f0173ff449b29f57d4ff3965de7d9af90a6d1c5a85326203c50ffe9f741ad8ff18972a67ea2775c64114c9c2d8b987d40491afee7fb8f22468409e2adfd

data/lib/arkaan/monitoring.rb

@@ -7,6 +7,7 @@ module Arkaan
     autoload :Instance , 'arkaan/monitoring/instance'
     autoload :Route    , 'arkaan/monitoring/route'
     autoload :Service  , 'arkaan/monitoring/service'
+    autoload :Vigilante, 'arkaan/monitoring/vigilante'
     autoload :Websocket, 'arkaan/monitoring/websocket'
   end
 end

data/lib/arkaan/monitoring/vigilante.rb

@@ -0,0 +1,15 @@
+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 < Arkaan::Monitoring::Service
+
+      # @!attribute [rw] token
+      #   @return [String] the token the vigilante uses to identify himself in the services
+      field :token, type: String
+
+      validates :token, presence: {message: 'required'}
+    end
+  end
+end

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

@@ -26,6 +26,26 @@ module Arkaan
           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.
@@ -55,6 +75,7 @@ module Arkaan
           else
             self.public_send(verb, complete_path, &block)
           end
+          complete_path
         end
 
         # Loads the errors configuration file from the config folder.

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

@@ -6,8 +6,15 @@ module Arkaan
       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

data/lib/arkaan/utils/micro_service.rb

@@ -146,7 +146,7 @@ module Arkaan
 
       def load_mongoid_configuration(test_mode: false)
         environment = test_mode ? 'test' : (ENV['RACK_ENV'] || 'development')
-        Mongoid.load!('config/mongoid.yml', environment)
+        Mongoid.load!(File.join(@location, 'config', 'mongoid.yml'), environment)
       end
 
       def load_standard_files

data/lib/arkaan/version.rb

@@ -1,3 +1,3 @@
 module Arkaan
-  VERSION = '1.5.2'
+  VERSION = '1.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-24 00:00:00.000000000 Z
+date: 2019-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -332,6 +332,7 @@ files:
 - lib/arkaan/monitoring/instance.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