arkaan 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fc29c2556a878524ea37ef5f8c2933fe7cff23f
-  data.tar.gz: 20c49fa9926ff15d5a02cd879eae8213c1b4cc79
+  metadata.gz: a717f0bef44b378a3208b435b394af28bbbc9e8a
+  data.tar.gz: bbbe7049150eb2ec195cb3af5f343bdc5862f005
 SHA512:
-  metadata.gz: 6e8f0ce7c13ca74686895d8433bc5bcbdc4ae75ece7184ab818e59bace7db8608172426347b0833209205ade5ea9d6527f986c6950601c6bec4005e91a6121c8
-  data.tar.gz: 0b837b8901a81755f308c69e0a36905d9b20100976989723ef8c60c4220441fece3c96e5f6d2a6a9d55ed602c9b3ec477107f133cebcf69cf73621085c2a97b0
+  metadata.gz: 19dc0d167af5df2e6812117b0bb34cc611a03bec1f0a1e5299dbf42fc6ef7f40e9b7f233d2b4534b764c1fbe614b070969d388ff3d151c451d24f0dc63e99371
+  data.tar.gz: 289875757787eb1a8c4c15e0fc7a50a86b5eb90085f9460aadf213cf3ce2fc37baf80137b78e471f1c43192c30517f84d5a17f4088ded45ff40232154cc92fff

data/lib/arkaan/concerns.rb

@@ -1,8 +1,9 @@
 module Arkaan
   # This module holds the shared concerns to include in the desired models.
-  # @authro Vincent Courtois <courtois.vincent@outlook.com>
+  # @author Vincent Courtois <courtois.vincent@outlook.com>
   module Concerns
     autoload :Sluggable, 'arkaan/concerns/sluggable'
     autoload :Activable, 'arkaan/concerns/activable'
+    autoload :Diagnosticable, 'arkaan/concerns/diagnosticable'
   end
 end

data/lib/arkaan/concerns/diagnosticable.rb

@@ -0,0 +1,26 @@
+module Arkaan
+  module Concerns
+    # Includes the diagnostic URL field, and the related validations.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Diagnosticable
+      extend ActiveSupport::Concern
+
+      # Module holding the class methods for the classes including this concern.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      module ClassMethods
+        # Add the field and its validations in the model including it.
+        # @param entity_type [String,Symbol] the name of the model including it, to be included in the error messages.
+        def make_diagnosticable(entity_type)
+          # @!attribute [rw] diagnostic
+          #   @return [String] the diagnostic URL to know the status of an entity (usually a gateway, or an instance of a service).
+          field :diagnostic, type: String, default: '/status'
+
+          validates :diagnostic,
+            presence: {message: "#{entity_type}.diagnostic.blank"},
+            length: {minimum: 4, message: "#{entity_type}.diagnostic.short"},
+            format: {with: /\A(\/[a-z]+)+\z/, message: "#{entity_type}.diagnostic.format"}
+        end
+      end
+    end
+  end
+end

data/lib/arkaan/concerns/sluggable.rb

@@ -5,12 +5,22 @@ module Arkaan
     module Sluggable
       extend ActiveSupport::Concern
 
-      included do
-        # @!attribute [rw] slug
-        #   @return [String] the slug of the current entity ; it must be snake-cased, longer than four characters, unique for the entity and given.
-        field :slug, type: String
+      # Module holding the class methods for the classes including this concern.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      module ClassMethods
+        # Add the field and its validations in the model including it.
+        # @param entity_type [String,Symbol] the name of the model including it, to be included in the error messages.
+        def make_sluggable(entity_type)
+          # @!attribute [rw] slug
+          #   @return [String] the slug of the current entity ; it must be snake-cased, longer than four characters, unique for the entity and given.
+          field :slug, type: String
 
-        validates :slug, length: {minimum: 4}, format: {with: /\A[a-z]+(_[a-z]+)*\z/}, uniqueness: true, presence: true
+          validates :slug,
+            length: {minimum: 4, message: "#{entity_type}.slug.short"},
+            format: {with: /\A[a-z]+(_[a-z]+)*\z/, message: "#{entity_type}.slug.format"},
+            uniqueness: {message: "#{entity_type}.slug.uniq"},
+            presence: {message: "#{entity_type}.slug.blank"}
+        end
       end
     end
   end

data/lib/arkaan/monitoring/gateway.rb

@@ -1,9 +1,12 @@
 module Arkaan
   module Monitoring
+    # A gateway is a portal by which you access the different web services of the application suite.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
     class Gateway
       include Mongoid::Document
       include Mongoid::Timestamps
       include Arkaan::Concerns::Activable
+      include Arkaan::Concerns::Diagnosticable
 
       # @!attribute [rw] url
       #   @return [String] the URL of the gateway, where the requests will be issued.
@@ -14,6 +17,8 @@ module Arkaan
 
       scope :running , ->{ where(running: true) }
 
+      make_diagnosticable 'gateway'
+
       validates :url,
         presence: {message: 'gateway.url.blank'},
         format: {with: /\A(https?:\/\/)([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*\/?\z/, message: 'gateway.url.format', if: :url?}

data/lib/arkaan/monitoring/instance.rb

@@ -1,7 +1,7 @@
 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.
-    # @param Vincent Courtois <courtois.vincent@outlook.com>
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
     class Instance
       include Mongoid::Document
       include Mongoid::Timestamps

data/lib/arkaan/monitoring/service.rb

@@ -6,6 +6,7 @@ module Arkaan
       include Mongoid::Document
       include Mongoid::Timestamps
       include Arkaan::Concerns::Activable
+      include Arkaan::Concerns::Diagnosticable
 
       # @!attribute [rw] key
       #   @return [String] the name, or title of the service, optionally given to identify it more easily.
@@ -13,6 +14,8 @@ module Arkaan
       # @!attribute [rw] path
       #   @return [String] the path the service will be mapped on in the API.
       field :path, type: String, default: '/'
+      
+      make_diagnosticable 'service'
 
       # @!attribute [rw] creator
       #   @return [Arkaan::Account] the creator of this service.

data/lib/arkaan/permissions/category.rb

@@ -6,6 +6,8 @@ module Arkaan
       include Mongoid::Document
       include Mongoid::Timestamps
       include Arkaan::Concerns::Sluggable
+
+      make_sluggable 'category'
     end
   end
 end

data/lib/arkaan/permissions/group.rb

@@ -13,6 +13,8 @@ module Arkaan
       # @!attribute [rw] rights
       #   @return [Array<Arkaan::Permissions::Right>] the rights granted by belonging to this group.
       has_and_belongs_to_many :rights, class_name: 'Arkaan::Permissions::Right', inverse_of: :groups
+
+      make_sluggable 'group'
     end
   end
 end

data/lib/arkaan/permissions/right.rb

@@ -10,6 +10,8 @@ module Arkaan
       # @!attribute [rw] groups
       #   @return [Array<Arkaan::Permissions::Group>] the groups granted with the permission to access features opened by this right.
       has_and_belongs_to_many :groups, class_name: 'Arkaan::Permissions::Group', inverse_of: :rights
+
+      make_sluggable 'right'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-22 00:00:00.000000000 Z
+date: 2017-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -160,6 +160,7 @@ files:
 - lib/arkaan/account.rb
 - lib/arkaan/concerns.rb
 - lib/arkaan/concerns/activable.rb
+- lib/arkaan/concerns/diagnosticable.rb
 - lib/arkaan/concerns/sluggable.rb
 - lib/arkaan/monitoring.rb
 - lib/arkaan/monitoring/gateway.rb