blueprint-api-rails 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18a23084533dcc625ff392693ca1a0b41f3652a8
-  data.tar.gz: ca5f2d2ccba38944e6007137de9c69568c593691
+  metadata.gz: 785506963749b0ec9c534c6ae2a2f29b43d51531
+  data.tar.gz: 692c18d746600e1f399d54d25422c00e6bcb18c7
 SHA512:
-  metadata.gz: 764c8bf1203f279cd57a830d975e094760397175ca94c2c8e610f09417b3e6e0ada0c5175eae64ba137559eae11a71d1a51de448c7e1b937611b7705d0dc439e
-  data.tar.gz: 929979c8e821eeba1c1d8948439dfa60991c6e9c4398ba4e527da09f4cd4a7e718e25e0e62d03996b69a4b098789d81d04121334195552ecf4209b901e349582
+  metadata.gz: dddbdc7efef2de303de2e3c8a84862d56e9c01044a89a640e336b9f7db88a638584ee3a2428eb8dccc8063d753463950cb4ba532aeba9db53c83e1990d89b8b8
+  data.tar.gz: 1288df1666ab966e2316b523827cc970540abc5680b8477f2428791f9c38953cb07f49c3942e2543799d356b5c6f7b9b3c6239f9892a1c83ea806b8f565954a7

data/lib/blueprint/api/rails/version.rb

@@ -1,7 +1,7 @@
 module Blueprint
   module Api
     module Rails
-      VERSION = '0.2.5'
+      VERSION = '0.2.6'
     end
   end
 end

data/lib/blueprint/api/rails.rb

@@ -9,6 +9,7 @@ module Blueprint
   # TODO deprecate all of the branch stuff
   # TODO limit messages that are lists to a maximum of 10 elements
   # TODO add support for getting the current user (so we can analysis log messages per user)
+  # TODO only log messages to the Blueprint server if there is an API key (if there isn't we can still check rules locally)
 
   STRUCTURE_NEW = 'start'
 
@@ -20,6 +21,9 @@ module Blueprint
 
   CONTAINS = 'contains'
 
+  # the set of validation and verification rules for the system (executed locally)
+  RULES = { }
+
   # allow users to set the API key
   def self.set_api_key api_key
     @api_key = api_key
@@ -84,6 +88,37 @@ module Blueprint
       end
     end
 
+    # checks that the action that the system just took does not violate any architectural rules
+    def check_rules(source, target, type)
+      # the list of violations for this action
+      violations = [ ]
+
+      unless type.nil?
+        # is the type restricted to a certain structural element?
+
+        unless RULES[type].nil?   # are there any rules for this type?
+
+          if RULES[type].has_key?(:only)    # do the rules for this type include an 'only' restriction?
+            allowed_element = RULES[type][:only]
+
+            unless allowed_element.eql?(source)
+              violations << "The type #{type} is allowed only within #{allowed_element} and it was used in #{source}."
+            end
+          end
+        end
+      end
+
+      # output architectural violations
+      # TODO make this output more obvious (and configurable?)
+      unless violations.empty?
+        p '### Architectural violations found ###'
+        violations.each { |v|
+          p '  ' + v
+        }
+        p '### End of violations ###'
+      end
+    end
+
   end
 
   ##
@@ -184,6 +219,9 @@ module Blueprint
 
     # logs a message between two nodes in the structure
     def log(message = { }, extras = { }, type = nil, source = nil, target = nil)
+      # always check the logged message for architectural rules violations
+      check_rules(source, target, type)
+
       properties = Hash.new.tap do |h|
         h[:source] = source unless source.blank?
         h[:target] = target unless target.blank?
@@ -335,6 +373,15 @@ module Blueprint
       self
     end
 
+    # verification methods
+    def only(element)
+      unless RULES.has_key?(@name)
+        RULES[@name] = { }
+      end
+
+      RULES[@name][:only] = element
+    end
+
   end
 
   ##
@@ -387,6 +434,9 @@ module Blueprint
 
 
       def log(message = { }, extras = { }, type = nil, source = nil, target = nil)
+        # always check the logged message for architectural rules violations
+        check_rules(source, target, type)
+
         properties = Hash.new.tap do |h|
           h[:instance_id] = @activity_ctx.instance_id
           h[:activity] = @activity_ctx.name
@@ -431,6 +481,9 @@ module Blueprint
 
     # logs a message between two nodes in the structure
     def log(message = { }, extras = { }, type = nil)
+      # always check the logged message for architectural rules violations
+      check_rules(@source, @target, type)
+
       properties = Hash.new.tap do |h|
         h[:source] = @source unless @source.blank?
         h[:target] = @target unless @target.blank?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blueprint-api-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - benjii
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-09 00:00:00.000000000 Z
+date: 2016-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler