blueprint-api-rails 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc3793b11d16cd30bb0df966bdb1f8703434f2eb
-  data.tar.gz: bc03e1d82da6f70b97146616e5d64cf7da46caa4
+  metadata.gz: 67fc79456b463a6eb05d67efd1140268c5b35afc
+  data.tar.gz: aa3c1baa961ce4b425278719259e35319c17dcbe
 SHA512:
-  metadata.gz: f1df5c5292e6a748e6bb732e54fe49c134abbf706ca8da73c469ad6a62058b5a198c645d0a9f9859d0f2e60ea2d78bf81e54315efc47b146d043edc8c0e42b4b
-  data.tar.gz: b03f5f4a6b3558e1b460547d3c12928f475735889b1ea26ce029b747aa3477a3b6d5c42c653f2a195221bfeec3ebf3186a2e099cad975005f02805df2c1b6c3d
+  metadata.gz: 6a902708353af1dcd9800f0f170be411bcfd91e99b533e006eedb2fdeaa5f6234584fc50d7a2611d4ec86a8dc8753abb35a8e9a10996bcadb389cd26214eb661
+  data.tar.gz: 45352ac51e430b72b193c174f1bf057ba3d3519dd2b370d2b35e2e9b72f949dd50c97d6dfd8054d8763b60f130b7dc3afba948eba511250d14fcb9dd8ef69379

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

@@ -1,7 +1,7 @@
 module Blueprint
   module Api
     module Rails
-      VERSION = '0.1.3'
+      VERSION = '0.1.4'
     end
   end
 end

data/lib/blueprint/api/rails.rb

@@ -8,9 +8,16 @@ module Blueprint
 
 
   STRUCTURE_NEW = 'start'
+
   MESSAGE = 'message'
   CLASSIFIER_NEW = 'classifier-new'
 
+  ACTIVITY_NEW = 'activity-new'
+  ACTIVITY_PERFORM = 'activity-perform'
+  ACTIVITY_DECIDE = 'activity-decide'
+  ACTIVITY_OUTCOME = 'activity-outcome'
+  ACTIVITY_END = 'activity-end'
+
   # allow users to set the API key
   def self.set_api_key api_key
     @api_key = api_key
@@ -22,6 +29,10 @@ module Blueprint
   end
 
 
+  ##
+  # The default design context for logging messages, etc. Also implements uitlity methods (like send())
+  ##
+
   class DesignContext
 
     def initialize(api_key, structure_id)
@@ -52,6 +63,17 @@ module Blueprint
       nil
     end
 
+    def activity(component, name, start_state)
+      self.send ACTIVITY_NEW,
+                {
+                    :component => component,
+                    :name => name,
+                    :state => start_state
+                }
+
+      ActivityDesignContext.new(@api_key, @structure_id, component, name)
+    end
+
     # logs a message between two nodes in the structure
     def log(source, target, type, message = { }, extras = { })
       self.send MESSAGE,
@@ -99,6 +121,209 @@ module Blueprint
 
   end
 
+  ##
+  # Design context for activities
+  ##
+
+  class ActivityDesignContext < DesignContext
+
+    def initialize(api_key, structure_id, component_name, activity_name)
+      @api_key = api_key
+      @structure_id = structure_id
+      @component_name = component_name
+      @activity_name = activity_name
+      @branch = `git rev-parse --abbrev-ref HEAD 2>&1`.strip! || 'master'
+
+      # initialise faraday
+      @conn = Faraday.new(:url => BLUEPRINT_SERVER) do |faraday|
+        faraday.response :logger                  # log requests to STDOUT
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+    end
+
+    def perform(description)
+      self.send ACTIVITY_PERFORM,
+                {
+                    :component => @component_name,
+                    :activity => @activity_name,
+                    :description => description
+                }
+
+      self
+    end
+
+    def decide(description)
+      self.send ACTIVITY_DECIDE,
+                {
+                    :component => @component_name,
+                    :activity => @activity_name,
+                    :description => description
+                }
+
+      ActivityDecisionDesignContext.new(@api_key, @structure_id, @component_name, @activity_name, description)
+    end
+
+    def end(description)
+      self.send ACTIVITY_END,
+                {
+                    :component => @component_name,
+                    :activity => @activity_name,
+                    :description => description
+                }
+
+      ActivityEndDesignContext.new(@api_key, @structure_id, @activity_name)
+    end
+
+    def log(source, target, type, message = { }, extras = { })
+      self.send MESSAGE,
+                {
+                    :source => source,
+                    :target => target,
+                    :input_for => @activity_name
+                },
+                {
+                    :type => type,
+                    :payload => {
+                        :message => message,       # the message that was sent
+                        :extras => extras          # extra details about the message that can aid classification
+                    }
+                }
+
+      self
+    end
+
+    ##
+    # Design context for activity decisions
+    ##
+
+    class ActivityDecisionDesignContext < DesignContext
+
+      def initialize(api_key, structure_id, component_name, activity_name, parent = nil)
+        @api_key = api_key
+        @structure_id = structure_id
+        @component_name = component_name
+        @activity_name = activity_name
+        @parent = parent
+        @branch = `git rev-parse --abbrev-ref HEAD 2>&1`.strip! || 'master'
+
+        # initialise faraday
+        @conn = Faraday.new(:url => BLUEPRINT_SERVER) do |faraday|
+          faraday.response :logger                  # log requests to STDOUT
+          faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+        end
+      end
+
+      def yes
+        OutcomeDesignContext.new @api_key, @structure_id, @component_name, @activity_name, @parent
+      end
+
+      def no
+        OutcomeDesignContext.new @api_key, @structure_id, @component_name, @activity_name, @parent, false
+      end
+
+      ##
+      # Design context for decision outcomes (only possible after an activity decision)
+      ##
+
+      class OutcomeDesignContext < DesignContext
+
+        def initialize(api_key, structure_id, component_name, activity_name, parent = nil, positive = true)
+          @api_key = api_key
+          @structure_id = structure_id
+          @component_name = component_name
+          @activity_name = activity_name
+          @parent = parent
+          @positive = positive
+          @branch = `git rev-parse --abbrev-ref HEAD 2>&1`.strip! || 'master'
+
+          # initialise faraday
+          @conn = Faraday.new(:url => BLUEPRINT_SERVER) do |faraday|
+            faraday.response :logger                  # log requests to STDOUT
+            faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+          end
+        end
+
+        def perform(description)
+          self.send ACTIVITY_PERFORM,
+                    {
+                        :component => @component_name,
+                        :activity => @activity_name,
+                        :parent => @parent,
+                        :description => description,
+                        :positive => @positive
+                    }
+
+          self
+        end
+
+        def decide(description)
+          self.send ACTIVITY_DECIDE,
+                    {
+                        :component => @component_name,
+                        :activity => @activity_name,
+                        :parent => @parent,
+                        :description => description,
+                        :positive => @positive
+                    }
+
+          ActivityDecisionDesignContext.new(@api_key, @structure_id, @component_name, @activity_name, description)
+        end
+
+        def end(description)
+          self.send ACTIVITY_END,
+                    {
+                        :component => @component_name,
+                        :activity => @activity_name,
+                        :parent => @parent,
+                        :description => description,
+                        :positive => @positive
+                    }
+
+          ActivityEndDesignContext.new(@api_key, @structure_id, @activity_name)
+        end
+
+      end
+
+    end
+  end
+
+  ##
+  # Design context for the end of an activity
+  ##
+  class ActivityEndDesignContext < DesignContext
+
+    def initialize(api_key, structure_id, activity_name)
+      @api_key = api_key
+      @structure_id = structure_id
+      @activity_name = activity_name
+      @branch = `git rev-parse --abbrev-ref HEAD 2>&1`.strip! || 'master'
+
+      # initialise faraday
+      @conn = Faraday.new(:url => BLUEPRINT_SERVER) do |faraday|
+        faraday.response :logger                  # log requests to STDOUT
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+    end
+
+    def log(source, target, type, message = { }, extras = { })
+      self.send MESSAGE,
+                {
+                    :source => source,
+                    :target => target,
+                    :output_for => @activity_name
+                },
+                {
+                    :type => type,
+                    :payload => {
+                        :message => message,       # the message that was sent
+                        :extras => extras          # extra details about the message that can aid classification
+                    }
+                }
+      self
+    end
+
+  end
+
   class LinkDesignContext < DesignContext
 
     def initialize(api_key, structure_id, source, target)
@@ -135,87 +360,4 @@ module Blueprint
 
   end
 
-end
-
-
-# # activity diagram event types
-# ACTIVITY_START = 'activity-start'
-# ACTIVITY_ACTION = 'activity-action'
-# ACTIVITY_DECISION = 'activity-decision'
-# ACTIVITY_DECISION_OUTCOME = 'activity-decision-outcome'
-# ACTIVITY_OUTCOME = 'activity-outcome'
-# ACTIVITY_END = 'activity-end'
-
-# COMPONENTS_START = 'components-start'
-# COMPONENTS_NEW = 'components-new'
-# COMPONENTS_LINK = 'components-link'
-#
-# MESSAGE = 'message'
-
-
-# # use this to create a new activity - returns a design context, which can be used for subsequent calls
-# def self.start_activity(diagram, name, start_state)
-#   DesignContext.new(@api_key, diagram).send ACTIVITY_START, { :name => name, :state => start_state }
-# end
-
-# # use this to create a new set of system components - returns a design context, which can be used for subsequent calls
-# def self.declare_system(diagram, name)
-#   DesignContext.new(@api_key, diagram).send COMPONENTS_START, { :name => name }
-# end
-
-# def self.log_message(diagram, identifier, type, message = { })
-#   DesignContext.new(@api_key, diagram, identifier, nil)
-#       .send MESSAGE, { :type => type, :message => message }
-#   nil
-# end
-
-
-
-# # -----------------------------------------------------------------------
-# # activity diagram API calls
-#
-# def decide(identifier, condition)
-#   # returns a new design context that represents the decision
-#   DesignContext.new(@api_key, @diagram, identifier, self)
-#                .send ACTIVITY_DECISION, { :condition => condition }
-# end
-#
-# def positive(*args)
-#   if args.length == 1
-#     outcome 'positive', args[0]
-#   elsif args.length == 2
-#     decision_outcome args[0], 'positive', args[1]
-#   end
-# end
-#
-# def negative(*args)
-#   if args.length == 1
-#     outcome 'negative', args[0]
-#   elsif args.length == 2
-#     decision_outcome args[0], 'negative', args[1]
-#   end
-# end
-#
-# def decision_outcome(identifier, outcome, condition)
-#   # returns a new design context that represents the outcome
-#   DesignContext.new(@api_key, @diagram, identifier, self)
-#                .send ACTIVITY_DECISION_OUTCOME, { :outcome => outcome, :condition => condition }
-# end
-#
-# def outcome(outcome, action)
-#   # returns a new design context that represents the outcome
-#   DesignContext.new(@api_key, @diagram, nil, self)
-#                .send ACTIVITY_OUTCOME, { :outcome => outcome, :action => action }
-# end
-#
-# def action(identifier, action)
-#   # returns a new design context that represents the action
-#   DesignContext.new(@api_key, @diagram, identifier, self)
-#                .send ACTIVITY_ACTION, { :action => action }
-# end
-#
-# def end(state)
-#   # returns a new design context that represents the end of the activity
-#   DesignContext.new(@api_key, @diagram, nil, self)
-#                .send ACTIVITY_END, { :state => state }
-# end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blueprint-api-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - benjii
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-13 00:00:00.000000000 Z
+date: 2016-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler