Add JSON response format to webhooks (#2671)

* Add JSON response format to webhooks

Support JSON responses for all webhook endpoints: index, show, create,
update, destroy, and activation. Adds jbuilder views, updates controllers
to use respond_to, and documents the API in docs/API.md.

* Address PR review feedback

- Use distinct board ID in API docs webhook example
- Use render "webhooks/show" in activations controller for consistency

* Address PR review feedback from flavorjones

- Include webhook.board in cache key to avoid stale board data
- Use _url instead of _path for location header consistency

* Fix webhook create test to match Location header format

Use board_webhook_url instead of board_webhook_path since the controller
returns a full URL in the Location header.

* Fix board ID in Location header example in API docs

Use distinct board ID in the Location URL to match the JSON body example.

test/controllers/webhooks/activations_controller_test.rb

@@ -32,4 +32,36 @@ class Webhooks::ActivationsControllerTest < ActionDispatch::IntegrationTest
     post board_webhook_activation_path(webhook.board, webhook)
     assert_response :forbidden
   end
+
+  test "create as JSON" do
+    webhook = webhooks(:inactive)
+
+    assert_not webhook.active?
+
+    assert_changes -> { webhook.reload.active? }, from: false, to: true do
+      post board_webhook_activation_path(webhook.board, webhook), as: :json
+    end
+
+    assert_response :created
+    assert_equal webhook.id, @response.parsed_body["id"]
+    assert_equal true, @response.parsed_body["active"]
+  end
+
+  test "cannot activate webhook on board without access as JSON" do
+    logout_and_sign_in_as :jason
+    webhook = webhooks(:inactive)
+
+    post board_webhook_activation_path(webhook.board, webhook), as: :json
+
+    assert_response :not_found
+  end
+
+  test "non-admin cannot activate webhook as JSON" do
+    logout_and_sign_in_as :jz
+    webhook = webhooks(:active)
+
+    post board_webhook_activation_path(webhook.board, webhook), as: :json
+
+    assert_response :forbidden
+  end
 end

test/controllers/webhooks_controller_test.rb

@@ -130,4 +130,143 @@ class WebhooksControllerTest < ActionDispatch::IntegrationTest
     get board_webhooks_path(webhook.board)
     assert_response :not_found
   end
+
+  test "index as JSON" do
+    board = boards(:writebook)
+
+    get board_webhooks_path(board), as: :json
+
+    assert_response :success
+    assert_kind_of Array, @response.parsed_body
+    assert_equal board.webhooks.count, @response.parsed_body.count
+    assert_equal webhooks(:active).id, @response.parsed_body.first["id"]
+  end
+
+  test "show as JSON" do
+    webhook = webhooks(:active)
+
+    get board_webhook_path(webhook.board, webhook), as: :json
+
+    assert_response :success
+    assert_equal webhook.id, @response.parsed_body["id"]
+    assert_equal webhook.name, @response.parsed_body["name"]
+    assert_equal webhook.url, @response.parsed_body["payload_url"]
+    assert_equal webhook.active?, @response.parsed_body["active"]
+    assert_equal webhook.signing_secret, @response.parsed_body["signing_secret"]
+    assert_equal webhook.subscribed_actions, @response.parsed_body["subscribed_actions"]
+    assert_equal webhook.board.id, @response.parsed_body.dig("board", "id")
+  end
+
+  test "create as JSON" do
+    board = boards(:writebook)
+
+    assert_difference "Webhook.count", 1 do
+      post board_webhooks_path(board), params: {
+        webhook: {
+          name: "Test Webhook",
+          url: "https://example.com/webhook",
+          subscribed_actions: [ "", "card_published", "card_closed" ]
+        }
+      }, as: :json
+    end
+
+    webhook = Webhook.last
+
+    assert_response :created
+    assert_equal board_webhook_url(board, webhook, format: :json), @response.headers["Location"]
+    assert_equal webhook.id, @response.parsed_body["id"]
+    assert_equal "https://example.com/webhook", @response.parsed_body["payload_url"]
+    assert_equal webhook.signing_secret, @response.parsed_body["signing_secret"]
+  end
+
+  test "create with invalid params as JSON" do
+    board = boards(:writebook)
+
+    assert_no_difference "Webhook.count" do
+      post board_webhooks_path(board), params: {
+        webhook: {
+          name: "",
+          url: "invalid-url"
+        }
+      }, as: :json
+    end
+
+    assert_response :unprocessable_entity
+    assert @response.parsed_body["name"].present?
+    assert @response.parsed_body["url"].present?
+  end
+
+  test "update as JSON" do
+    webhook = webhooks(:active)
+
+    patch board_webhook_path(webhook.board, webhook), params: {
+      webhook: {
+        name: "Updated Webhook",
+        subscribed_actions: [ "card_published" ]
+      }
+    }, as: :json
+
+    webhook.reload
+
+    assert_response :success
+    assert_equal "Updated Webhook", webhook.name
+    assert_equal [ "card_published" ], webhook.subscribed_actions
+    assert_equal "Updated Webhook", @response.parsed_body["name"]
+    assert_equal [ "card_published" ], @response.parsed_body["subscribed_actions"]
+  end
+
+  test "update with invalid params as JSON" do
+    webhook = webhooks(:active)
+
+    patch board_webhook_path(webhook.board, webhook), params: {
+      webhook: {
+        name: ""
+      }
+    }, as: :json
+
+    assert_response :unprocessable_entity
+    assert @response.parsed_body["name"].present?
+  end
+
+  test "update does not change url as JSON" do
+    webhook = webhooks(:active)
+
+    assert_no_changes -> { webhook.reload.url } do
+      patch board_webhook_path(webhook.board, webhook), params: {
+        webhook: {
+          name: "Updated Webhook",
+          url: "https://different.com/webhook"
+        }
+      }, as: :json
+    end
+
+    assert_response :success
+    assert_equal webhook.reload.url, @response.parsed_body["payload_url"]
+  end
+
+  test "destroy as JSON" do
+    webhook = webhooks(:active)
+
+    assert_difference "Webhook.count", -1 do
+      delete board_webhook_path(webhook.board, webhook), as: :json
+    end
+
+    assert_response :no_content
+  end
+
+  test "non-admin cannot access webhook endpoints as JSON" do
+    logout_and_sign_in_as :jz
+
+    get board_webhooks_path(boards(:writebook)), as: :json
+
+    assert_response :forbidden
+  end
+
+  test "cannot access webhooks on board without access as JSON" do
+    logout_and_sign_in_as :jason
+
+    get board_webhooks_path(boards(:private)), as: :json
+
+    assert_response :not_found
+  end
 end