arkaan 0.7.4 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c15ef80800e647f2a5f06482e9794678fc3bf05c
-  data.tar.gz: e4b2c527ea546b7e42489e0182c559cecba3a6b0
+  metadata.gz: dc727a94560a7d9ab37e10b788a28e322ba0b346
+  data.tar.gz: 75877dfb1faff014c23f8e3afb828de8edfb071f
 SHA512:
-  metadata.gz: 46934cd25c1c983e1a5b9af0a67bf200b589c3067ca2c91b30d93b0f0419d9247eee39a1eb2e189a9758f1fb9ee77bb3c63e9147a895b2cb2951c1d5ea597702
-  data.tar.gz: 264858f396fa4371f48ea4cc97d009b2204faec9b04eba84c96715a77415ed67f60ba08f9c99568b5a8fb5a7118f01fa115548c2ad279b065402352804d27837
+  metadata.gz: 0636b1c58ce076e7594afc504232f7014e3a17021b337c96dd36a74702c98a45618516b3df20dd5ab7f21acc9d74e27eb1562c45272dd76f4951b871fe6f870c
+  data.tar.gz: 991da6be9cd21c206ab54c320eddb089be6a62e0c6eb84de842c6a98402fab5340e017c42fc9f6731dc43c251409e8215cd9ae228f002a675314013be506c135

data/lib/arkaan/utils/controller.rb

@@ -20,24 +20,28 @@ module Arkaan
         end
       end
 
-      def self.declare_service(key)
-        @@micro_service = Arkaan::Monitoring::Service.find_by(key: key)
-      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, &block)
         self.declare_route_with(verb, path, false, &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, &block)
         self.declare_route_with(verb, path, true, &block)
       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, &block)
-        unless @@micro_service.nil?
-          if @@micro_service.routes.where(path: path, verb: verb).first.nil?
-            @@micro_service.routes << Arkaan::Monitoring::Route.new(path: path, verb: verb, premium: premium)
-            @@micro_service.save!
-          end
+        service = Arkaan::Utils::MicroService.instance.service
+        unless service.nil? || !service.routes.where(path: path, verb: verb).first.nil?
+          Arkaan::Monitoring::Route.create(path: path, verb: verb, premium: premium, service: service)
         end
         self.public_send(verb, path, &block)
       end

data/lib/arkaan/utils/micro_service.rb

@@ -1,68 +1,112 @@
 module Arkaan
   module Utils
-    # The MicroService class is the loader for a micro service in general.
+    # 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] root
-      #   @return [String] the root path of the application, from where each path is deduced.
-      attr_reader :root
       # @!attribute [r] name
-      #   @return [String] the name of the service, given when initializing it.
-      attr_reader :name
-      # @!attribute [r] test_mode
-      #   @return [Boolean] TRUE if the micro service is initialized from a test suite, FALSE otherwise.
-      attr_reader :test_mode
-      # @!attribute [r] service
-      #   @return [Arkaan::Monitoring::Service] the service stored in the database corresponding to this application.
+      #   @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
 
-      # 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:, test_mode: false)
-        @root = test_mode ? File.join(root, '..') : root
-        @name = name
-        @test_mode = test_mode
-        require_mongoid_config(root)
-        @service = register_service
+      def initialize
+        @location = false
+        @service = false
       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!
-        require_folder(root, 'decorators')
-        require_folder(root, 'controllers')
-        if test_mode
-          require_folder(root, 'spec', 'support')
-          require_folder(root, 'spec', 'shared')
-        end
-        return
+      # 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
 
-      # Creates the service instance if necessary, and returns it.
-      # @return [Arkaan::Monitoring::Service] the service in the registry corresponding to this micro-service.
-      def register_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)
+      # 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
+
+      # Getter for the name of the service.
+      # @return [String, Boolean] the name of the service as it is registered in the database, or FALSE if it's not set already.
+      def name
+        return service ? service.key : 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)
+        @service = Arkaan::Monitoring::Service.where(key: service_name).first
+        register_service if @service.nil?
+        register_instance
+        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
+
+      private
+
+      def register_service(key)
+        @service = Arkaan::Service.create(key: key, path: "/#{key}")
+      end
+
+      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'])
         end
-        return service
+        return instance
+      end
+
+      def load_application(test_mode: false)
+        @location = File.join(location, '..')
+        load_mongoid_configuration
+        load_standard_files
+        load_test_files if test_mode
+        return self
+      end
+
+      def load_mongoid_configuration
+        Mongoid.load!(File.join(location, 'config', 'mongoid.yml'))
       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)
-        Dir[File.join(paths_elements, '**', '*.rb')].each { |filename| require filename }
+      def load_standard_files
+        require_folder('decorators')
+        require_folder('controllers')
       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'))
+      def load_test_files
+        require_folder('spec', 'support')
+        require_folder('spec', 'factories')
+        require_folder('spec', 'shared')
+      end
+
+      def require_folder(*folders)
+        Dir[File.join(location, folders)].each do |filename|
+          require filename
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.5
 platform: ruby
 authors:
 - Vincent Courtois