blueprint-api-rails 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67fc79456b463a6eb05d67efd1140268c5b35afc
-  data.tar.gz: aa3c1baa961ce4b425278719259e35319c17dcbe
+  metadata.gz: 25fbdd1b8e7997ef380128605fe7ab82e722a7d0
+  data.tar.gz: 8507af124a651f53a6c5c4adf942f4f896b20c36
 SHA512:
-  metadata.gz: 6a902708353af1dcd9800f0f170be411bcfd91e99b533e006eedb2fdeaa5f6234584fc50d7a2611d4ec86a8dc8753abb35a8e9a10996bcadb389cd26214eb661
-  data.tar.gz: 45352ac51e430b72b193c174f1bf057ba3d3519dd2b370d2b35e2e9b72f949dd50c97d6dfd8054d8763b60f130b7dc3afba948eba511250d14fcb9dd8ef69379
+  metadata.gz: 6754321e91df4685448af47e3abf5ee7b827af0a4ab883bcbe254d9f4171b9c775319e3aacfcd4d6a375c572f0fc3c93d8b03a772d7127cb512ca6bcb1de06b8
+  data.tar.gz: df721189d10ae7d9bc4b9de5dcb1a4a77dd813a00073cdd8266d7707dd296fdd0865003b4b92410d35fa798b57d06b56cca1ee470ed9b98aa1de211af062d279

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

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

data/lib/blueprint/api/rails.rb

@@ -6,18 +6,14 @@ module Blueprint
   BLUEPRINT_SERVER = ENV['BLUEPRINT_SERVER'] || 'http://anaxim.io'
   BLUEPRINT_URL_CONTEXT = '/api/v1/events'
 
+  # TODO deprecate all of the branch stuff
+  # TODO limit messages that are lists to a maximum of 10 elements
 
   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
@@ -25,7 +21,7 @@ module Blueprint
 
   # call this to create a structure and get a design context
   def self.start(structure_id, name)
-    DesignContext.new(@api_key, structure_id).send STRUCTURE_NEW, { :name => name }
+    StructureDesignContext.new(@api_key, structure_id).send STRUCTURE_NEW, { :name => name }
   end
 
 
@@ -35,6 +31,41 @@ module Blueprint
 
   class DesignContext
 
+    # utility method for sending JSON payloads to the Anaxim servers - should never be called directly
+    def send(event_type, properties = { }, message = { })
+
+      # construct the base payload
+      payload = {
+          :header => {
+              :structure_id => @structure_id,
+              :properties => properties,
+              :branch => {
+                  :name => @branch || 'master'
+              },
+              :eventType => event_type
+          }
+      }
+
+      # merge (append) the properties hash onto the payload (properties vary per event type)
+      payload.merge! message
+
+      @conn.post do |req|
+        req.url BLUEPRINT_URL_CONTEXT
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['X-Api-Key'] = @api_key
+        req.body = payload.to_json
+      end
+
+      self
+    end
+
+  end
+
+  ##
+  # Design context for a structure (a group of nodes and links)
+  ##
+  class StructureDesignContext < DesignContext
+
     def initialize(api_key, structure_id)
       @api_key = api_key
       @structure_id = structure_id
@@ -47,6 +78,7 @@ module Blueprint
       end
     end
 
+
     # creates a design context between source and target
     def link(source, target)
       LinkDesignContext.new(@api_key, @structure_id, source, target)
@@ -63,75 +95,45 @@ 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)
+    def begin(name)
+      ActivityDesignContext.new(@api_key, @structure_id, name)
     end
 
     # logs a message between two nodes in the structure
-    def log(source, target, type, message = { }, extras = { })
-      self.send MESSAGE,
-                {
-                    :source => source,
-                    :target => target
-                },
-                {
-                    :type => type,
-                    :payload => {
-                        :message => message,       # the message that was sent
-                        :extras => extras          # extra details about the message that can aid classification
-                }
-          }
-      nil
-    end
-
-    # utility method for sending JSON payloads to the Anaxim servers - should never be called directly
-    def send(event_type, properties = { }, message = { })
-
-      # construct the base payload
-      payload = {
-          :header => {
-              :structure_id => @structure_id,
-              :properties => properties,
-              :branch => {
-                  :name => @branch || 'master'
-              },
-              :eventType => event_type
-          }
-      }
-
-      # merge (append) the properties hash onto the payload (properties vary per event type)
-      payload.merge! message
+    def log(message = { }, extras = { }, type = nil, source = nil, target = nil)
+      properties = Hash.new.tap do |h|
+        h[:source] = source unless source.blank?
+        h[:target] = target unless target.blank?
+      end
 
-      @conn.post do |req|
-        req.url BLUEPRINT_URL_CONTEXT
-        req.headers['Content-Type'] = 'application/json'
-        req.headers['X-Api-Key'] = @api_key
-        req.body = payload.to_json
+      payload = Hash.new.tap do |h|
+        h[:type] = type unless type.blank?
+        h[:payload] = {
+            :message => message,
+            :extras => extras
+        }
       end
 
-      self
+      # send the message
+      self.send MESSAGE, properties, payload
+
+      # return nil so that no further calls can be made to the fluent API
+      nil
     end
 
   end
 
   ##
-  # Design context for activities
+  # Design context for a group of messages (steps)
   ##
 
   class ActivityDesignContext < DesignContext
 
-    def initialize(api_key, structure_id, component_name, activity_name)
+    def initialize(api_key, structure_id, name)
       @api_key = api_key
       @structure_id = structure_id
-      @component_name = component_name
-      @activity_name = activity_name
+      @instance_id = SecureRandom.uuid
+      @name = name
       @branch = `git rev-parse --abbrev-ref HEAD 2>&1`.strip! || 'master'
 
       # initialise faraday
@@ -141,69 +143,25 @@ module Blueprint
       end
     end
 
-    def perform(description)
-      self.send ACTIVITY_PERFORM,
-                {
-                    :component => @component_name,
-                    :activity => @activity_name,
-                    :description => description
-                }
-
-      self
+    def instance_id
+      @instance_id
     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)
+    def name
+      @name
     end
 
-    def end(description)
-      self.send ACTIVITY_END,
-                {
-                    :component => @component_name,
-                    :activity => @activity_name,
-                    :description => description
-                }
-
-      ActivityEndDesignContext.new(@api_key, @structure_id, @activity_name)
+    def step(description)
+      StepDesignContext.new(@api_key, @structure_id, self, description)
     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
-                    }
-                }
+    class StepDesignContext < DesignContext
 
-      self
-    end
-
-    ##
-    # Design context for activity decisions
-    ##
-
-    class ActivityDecisionDesignContext < DesignContext
-
-      def initialize(api_key, structure_id, component_name, activity_name, parent = nil)
+      def initialize(api_key, structure_id, activity_ctx, step)
         @api_key = api_key
         @structure_id = structure_id
-        @component_name = component_name
-        @activity_name = activity_name
-        @parent = parent
+        @activity_ctx = activity_ctx
+        @step = step
         @branch = `git rev-parse --abbrev-ref HEAD 2>&1`.strip! || 'master'
 
         # initialise faraday
@@ -213,114 +171,31 @@ module Blueprint
         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
+      def log(message = { }, extras = { }, type = nil, source = nil, target = nil)
+        properties = Hash.new.tap do |h|
+          h[:instance_id] = @activity_ctx.instance_id
+          h[:activity] = @activity_ctx.name
+          h[:step] = @step
+          h[:source] = source unless source.blank?
+          h[:target] = target unless target.blank?
         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)
+        payload = Hash.new.tap do |h|
+          h[:type] = type unless type.blank?
+          h[:payload] = {
+              :message => message,
+              :extras => extras
+          }
         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
+        self.send MESSAGE, properties, payload
 
+        # return the parent activity context so that users can keep making calls to it to add further steps
+        @activity_ctx
       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
 
@@ -341,20 +216,23 @@ module Blueprint
     end
 
     # logs a message between two nodes in the structure
-    def log(type, message = { }, extras = { })
-      self.send MESSAGE,
-                {
-                    :source => @source,
-                    :target => @target
+    def log(message = { }, extras = { }, type = nil)
+      properties = Hash.new.tap do |h|
+        h[:source] = @source unless @source.blank?
+        h[:target] = @target unless @target.blank?
+      end
 
-                },
-                {
-                    :type => type,
-                    :payload => {
-                        :message => message,       # the message that was sent
-                        :extras => extras          # extra details about the message that can aid classification
-                    }
-                }
+      payload = Hash.new.tap do |h|
+        h[:type] = type unless type.blank?
+        h[:payload] = {
+            :message => message,
+            :extras => extras
+        }
+      end
+
+      self.send MESSAGE, properties, payload
+
+      # return nil so that no further calls can be made to the fluent API
       nil
     end
 

metadata

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