From c3d5380f98bc812c113c93bcbcffeb66ecc5f9b6 Mon Sep 17 00:00:00 2001
From: Thiago Talma <thiagotalma@users.noreply.github.com>
Date: Fri, 9 Sep 2016 10:53:29 -0300
Subject: [PATCH] Option to set response code for webhook agent (#1676)

* setting for webhook response code

* some adjustments
---
 app/models/agents/webhook_agent.rb       | 10 +++++++++-
 spec/models/agents/webhook_agent_spec.rb | 20 ++++++++++++++++++++
 2 files changed, 29 insertions(+), 1 deletion(-)

diff --git a/app/models/agents/webhook_agent.rb b/app/models/agents/webhook_agent.rb
index 7fc738bb..f86c1a75 100644
--- a/app/models/agents/webhook_agent.rb
+++ b/app/models/agents/webhook_agent.rb
@@ -26,6 +26,7 @@ module Agents
           For example, "post,get" will enable POST and GET requests. Defaults
           to "post".
         * `response` - The response message to the request. Defaults to 'Event Created'.
+        * `code` - The response code to the request. Defaults to '201'.
         * `recaptcha_secret` - Setting this to a reCAPTCHA "secret" key makes your agent verify incoming requests with reCAPTCHA.  Don't forget to embed a reCAPTCHA snippet including your "site" key in the originating form(s).
         * `recaptcha_send_remote_addr` - Set this to true if your server is properly configured to set REMOTE_ADDR to the IP address of each visitor (instead of that of a proxy server).
       MD
@@ -53,6 +54,9 @@ module Agents
       # check the verbs
       verbs = (interpolated['verbs'] || 'post').split(/,/).map { |x| x.strip.downcase }.select { |x| x.present? }
       return ["Please use #{verbs.join('/').upcase} requests only", 401] unless verbs.include?(method)
+      
+      # check the code
+      code = (interpolated['code'].presence || 201).to_i
 
       # check the reCAPTCHA response if required
       if recaptcha_secret = interpolated['recaptcha_secret'].presence
@@ -84,7 +88,7 @@ module Agents
         create_event(payload: payload)
       end
 
-      [response_message, 201]
+      [response_message, code]
     end
 
     def working?
@@ -95,6 +99,10 @@ module Agents
       unless options['secret'].present?
         errors.add(:base, "Must specify a secret for 'Authenticating' requests")
       end
+
+      if options['code'].present? && options['code'].to_s !~ /\A\s*(\d+|\{.*)\s*\z/
+        errors.add(:base, "Must specify a code for request responses")
+      end
     end
 
     def payload_for(params)
diff --git a/spec/models/agents/webhook_agent_spec.rb b/spec/models/agents/webhook_agent_spec.rb
index de00277d..0b96f3a1 100644
--- a/spec/models/agents/webhook_agent_spec.rb
+++ b/spec/models/agents/webhook_agent_spec.rb
@@ -59,6 +59,26 @@ describe Agents::WebhookAgent do
       expect(out).to eq(['Event Created', 201])
     end
 
+    it 'should respond with customized response code if configured with `code` option' do
+      agent.options['code'] = '200'
+      out = agent.receive_web_request({ 'secret' => 'foobar', 'some_key' => payload }, "post", "text/html")
+      expect(out).to eq(['Event Created', 200])
+    end
+
+    it 'should respond with `201` if the code option is empty, nil or missing' do
+      agent.options['code'] = ''
+      out = agent.receive_web_request({ 'secret' => 'foobar', 'some_key' => payload }, "post", "text/html")
+      expect(out).to eq(['Event Created', 201])
+      
+      agent.options['code'] = nil
+      out = agent.receive_web_request({ 'secret' => 'foobar', 'some_key' => payload }, "post", "text/html")
+      expect(out).to eq(['Event Created', 201])
+
+      agent.options.delete('code')
+      out = agent.receive_web_request({ 'secret' => 'foobar', 'some_key' => payload }, "post", "text/html")
+      expect(out).to eq(['Event Created', 201])
+    end
+
     describe "receiving events" do
 
       context "default settings" do