Merge pull request huginn#1239 from cantino/manual_event_agent_supports_liquid

Add support to the ManualEventAgent for Liquid formatting and multiple Events

Author: cantino

app/models/agents/manual_event_agent.rb

@@ -18,8 +18,15 @@ def default_options
 
     def handle_details_post(params)
       if params['payload']
-        create_event(:payload => params['payload'])
-        { :success => true }
+        json = interpolate_options(JSON.parse(params['payload']))
+        if json['payloads'] && (json.keys - ['payloads']).length > 0
+          { :success => false, :error => "If you provide the 'payloads' key, please do not provide any other keys at the top level." }
+        else
+          [json['payloads'] || json].flatten.each do |payload|
+            create_event(:payload => payload)
+          end
+          { :success => true }
+        end
       else
         { :success => false, :error => "You must provide a JSON payload" }
       end

app/views/agents/agent_views/manual_event_agent/_show.html.erb

@@ -1,4 +1,15 @@
-<h3>Manually Create Events</h3>
+<p>
+  Use this form to manually emit Events from this Agent (usually for testing).
+</p>
+
+<p>
+  If you add a top-level key called <code>payloads</code> that points to an array of objects, they will be emitted as a series
+  of Events.  Otherwise, everything entered will be emitted as a single Event.
+</p>
+
+<p>
+  Liquid formatting is supported.
+</p>
 
 <h4 id='event-creation-status'></h4>
 
@@ -22,7 +33,7 @@
       $.ajax({
         url: $form.attr('action'),
         method: "post",
-        data: { payload: JSON.parse($form.find("textarea").val()) },
+        data: { payload: $form.find("textarea").val() },
         dataType: "JSON",
         success: function(json) {
           if (json.success) {

spec/controllers/agents_controller_spec.rb

@@ -21,15 +21,15 @@ def valid_attributes(options = {})
   describe "POST handle_details_post" do
     it "passes control to handle_details_post on the agent" do
       sign_in users(:bob)
-      post :handle_details_post, :id => agents(:bob_manual_event_agent).to_param, :payload => { :foo => "bar" }
+      post :handle_details_post, :id => agents(:bob_manual_event_agent).to_param, :payload => { :foo => "bar" }.to_json
       expect(JSON.parse(response.body)).to eq({ "success" => true })
       expect(agents(:bob_manual_event_agent).events.last.payload).to eq({ 'foo' => "bar" })
     end
 
     it "can only be accessed by the Agent's owner" do
       sign_in users(:jane)
       expect {
-        post :handle_details_post, :id => agents(:bob_manual_event_agent).to_param, :payload => { :foo => :bar }
+        post :handle_details_post, :id => agents(:bob_manual_event_agent).to_param, :payload => { :foo => :bar }.to_json
       }.to raise_error(ActiveRecord::RecordNotFound)
     end
   end

spec/models/agents/manual_event_agent_spec.rb

@@ -0,0 +1,50 @@
+require 'rails_helper'
+
+describe Agents::ManualEventAgent do
+  before do
+    @checker = Agents::ManualEventAgent.new(name: "My Manual Event Agent")
+    @checker.user = users(:jane)
+    @checker.save!
+  end
+
+  describe "#handle_details_post" do
+    it "emits an event with the given payload" do
+      expect {
+        json = { 'foo' => "bar" }.to_json
+        expect(@checker.handle_details_post({ 'payload' => json })).to eq({ success: true })
+      }.to change { @checker.events.count }.by(1)
+      expect(@checker.events.last.payload).to eq({ 'foo' => 'bar' })
+    end
+
+    it "emits multiple events when given a magic 'payloads' key" do
+      expect {
+        json = { 'payloads' => [{ 'key' => 'value1' }, { 'key' => 'value2' }] }.to_json
+        expect(@checker.handle_details_post({ 'payload' => json })).to eq({ success: true })
+      }.to change { @checker.events.count }.by(2)
+      events = @checker.events.order('id desc')
+      expect(events[0].payload).to eq({ 'key' => 'value2' })
+      expect(events[1].payload).to eq({ 'key' => 'value1' })
+    end
+
+    it "errors when given both payloads and other top-level keys" do
+      expect {
+        json = { 'key' => 'value2', 'payloads' => [{ 'key' => 'value1' }] }.to_json
+        expect(@checker.handle_details_post({ 'payload' => json })).to eq({ success: false, error: "If you provide the 'payloads' key, please do not provide any other keys at the top level." })
+      }.to_not change { @checker.events.count }
+    end
+
+    it "supports Liquid formatting" do
+      expect {
+        json = { 'key' => "{{ 'now' | date: '%Y' }}", 'nested' => { 'lowercase' => "{{ 'uppercase' | upcase }}" } }.to_json
+        expect(@checker.handle_details_post({ 'payload' => json })).to eq({ success: true })
+      }.to change { @checker.events.count }.by(1)
+      expect(@checker.events.last.payload).to eq({ 'key' => Time.now.year.to_s, 'nested' => { 'lowercase' => 'UPPERCASE' } })
+    end
+
+    it "errors when not given a JSON payload" do
+      expect {
+        expect(@checker.handle_details_post({ 'foo' =>'bar' })).to eq({ success: false, error: "You must provide a JSON payload" })
+      }.not_to change { @checker.events.count }
+    end
+  end
+end