Merge pull request #170 from kbrock/workflow_comment

add Workflow#comment

lib/floe/workflow.rb

@@ -85,7 +85,7 @@ def wait(workflows, timeout: nil, &block)
       end
     end
 
-    attr_reader :context, :credentials, :payload, :states, :states_by_name, :start_at, :name
+    attr_reader :context, :credentials, :payload, :states, :states_by_name, :start_at, :name, :comment
 
     def initialize(payload, context = nil, credentials = {}, name = nil)
       payload     = JSON.parse(payload)     if payload.kind_of?(String)
@@ -100,6 +100,7 @@ def initialize(payload, context = nil, credentials = {}, name = nil)
       @payload     = payload
       @context     = context
       @credentials = credentials || {}
+      @comment     = payload["Comment"]
       @start_at    = payload["StartAt"]
 
       @states         = payload["States"].to_a.map { |state_name, state| State.build!(self, state_name, state) }

spec/workflow_spec.rb

@@ -351,4 +351,16 @@
       end
     end
   end
+
+  describe "#comment" do
+    it "handles no comment" do
+      workflow = Floe::Workflow.new({"StartAt" => "First", "States" => {"First" => {"Type" => "Succeed"}}}, {})
+      expect(workflow.comment).to be nil
+    end
+
+    it "handles a comment" do
+      workflow = Floe::Workflow.new({"StartAt" => "First", "Comment" => "great stuff", "States" => {"First" => {"Type" => "Succeed"}}}, {})
+      expect(workflow.comment).to eq("great stuff")
+    end
+  end
 end