arkaan 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fbb8f59c892ce91e7c016d76b3bd36a666a251c
-  data.tar.gz: 1a185db4880c3d0986cd70b462c96e2f7eaf446e
+  metadata.gz: 8b55f4b19871258edaa210f4803de26d312ff87a
+  data.tar.gz: 385cdfa3c03601ea33e3c789cf68b418305c2d38
 SHA512:
-  metadata.gz: 2cacca5e1e77eb380d2f8847281524ce5b70f87cd49d98a02dae68d2c8f98f44615157fbc36fb08d4ce7c3d2defed8123d20caadee44ea620c79c71c9c5e4c21
-  data.tar.gz: e181c90141dd6a63d81be1ef2517e7a9f0e3bbdceef64877958a379957fee5a6e182ea630cfcf23c91cdc7f93287cd2ef313f9b48ebefabb1812696d04131555
+  metadata.gz: 044482743f1eb117fa8ca0001540c406702f3a6c4adb9f0b568b33b0ebb992f65a1bdeb5d4dacfd85fd60f43f3b1685a26c8377392a065af2f7d91f21d14f8a5
+  data.tar.gz: 4e302ff1f70e0bf36afd2e558244f2e5ca4f6e22b4532b47e9f2364be9cdca00243da68510d5a1f760e9889dd86bc64863e58a972ceb71565bc648a5af4d10d4

data/lib/arkaan/utils.rb

@@ -2,7 +2,7 @@ module Arkaan
   # Utility classes for the different micro-services of the suite.
   # @author Vincent Courtois <courtois.vincent@outlook.com>
   module Utils
-    autoload :Controller, 'arkaan/utils/controller'
-    autoload :Seeder    , 'arkaan/utils/seeder'
+    autoload :Controller  , 'arkaan/utils/controller'
+    autoload :MicroService, 'arkaan/utils/micro_service'
   end
 end

data/lib/arkaan/utils/micro_service.rb

@@ -0,0 +1,59 @@
+module Arkaan
+  module Utils
+    # The MicroService class is the loader for a micro service in general.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    class MicroService
+
+      # @!attribute [r] root
+      #   @return [String] the root path of the application, from where each path is deduced.
+      attr_reader :root
+
+      attr_reader :name
+
+      # loads the application by requiring the files from the folders they're supposed to be in.
+      # @param name [String] the snake-cased name of the application, for service registration purpose mainly.
+      # @param root [String]
+      def initialize(name:, root:)
+        @root = root
+        @name = name
+      end
+
+      # Loads the necessary components for the application by requiring the needed files.
+      # @param test_mode [Boolean] TRUE if the application i supposed to be launched from the spec_helper, FALSE otherwise.
+      def load(test_mode: false)
+        self.require_mongoid_config(root)
+        self.require_folder(root, 'decorators')
+        self.require_folder(root, 'controllers')
+        if test_mode
+          self.require_folder(root, 'spec', 'support')
+          self.require_folder(root, 'spec', 'shared')
+        end
+      end
+
+      # Creates the service instance if necessary, and returns it.
+      # @return [Arkaan::Monitoring::Service] the service in the registry corresponding to this micro-service.
+      def registered_service
+        service = Arkaan::Monitoring::Service.where(key: @name).first
+        if service.nil?
+          service = Arkaan::Monitoring::Service.create!(key: @name, path: "/#{@name}", 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
+
+      # Require all the files from a folder iteratively by assembling the parts given as parameters.
+      # @param paths_elements [Array<String>] the elements to assemble to form the path of the folder.
+      def require_folder(*paths_elements)
+        File.join(path_elements, '**', '*.rb').each { |filename| block.call(filename) }
+      end
+
+      # Requires and loads the mongoid configuration from its default location.
+      # @param root [String] the root folder of the application from where require the configuration path;
+      def require_mongoid_config(root)
+        Mongoid.load!(File.join(root, 'config', 'mongoid.yml'))
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Vincent Courtois
@@ -209,6 +209,7 @@ files:
 - lib/arkaan/permissions/right.rb
 - lib/arkaan/utils.rb
 - lib/arkaan/utils/controller.rb
+- lib/arkaan/utils/micro_service.rb
 - lib/arkaan/utils/seeder.rb
 homepage: https://rubygems.org/gems/arkaan
 licenses: