add template.preferences_updated webhook support

  - add template.preferences_updated to account default webhook events
  - guard account create_careerplug_webhook against missing CAREERPLUG_WEBHOOK_URL env var
  - create partnership-scoped webhook for template.preferences_updated on partnership creation
  - add template.preferences_updated to WebhookUrl::EVENTS
  - update PARTNERSHIP_EVENTS to only include template.preferences_updated
  - return WebhookUrl.none instead of raising for templates with neither account nor partnership
  - extend webhooks:setup_development rake task to create partnership webhooks

Author: ryanarakawa

app/models/account.rb

@@ -78,11 +78,11 @@ def default_template_folder
   private
 
   def create_careerplug_webhook
-    return if ENV['CAREERPLUG_WEBHOOK_SECRET'].blank?
+    return if ENV['CAREERPLUG_WEBHOOK_SECRET'].blank? || ENV['CAREERPLUG_WEBHOOK_URL'].blank?
 
     webhook_urls.create!(
       url: ENV.fetch('CAREERPLUG_WEBHOOK_URL'),
-      events: %w[form.viewed form.started form.completed form.declined],
+      events: %w[form.viewed form.started form.completed form.declined template.preferences_updated],
       secret: { 'X-CareerPlug-Secret' => ENV.fetch('CAREERPLUG_WEBHOOK_SECRET') }
     )
   end

app/models/partnership.rb

@@ -22,6 +22,8 @@ class Partnership < ApplicationRecord
   validates :external_partnership_id, presence: true, uniqueness: true
   validates :name, presence: true
 
+  after_commit :create_careerplug_webhook, on: :create
+
   def self.find_or_create_by_external_id(external_id, name, attributes = {})
     find_by(external_partnership_id: external_id) ||
       create!(attributes.merge(external_partnership_id: external_id, name: name))
@@ -34,4 +36,14 @@ def default_template_folder(author)
       template_folders.create!(name: TemplateFolder::DEFAULT_NAME,
                                author: author)
   end
+
+  def create_careerplug_webhook
+    return if ENV['CAREERPLUG_WEBHOOK_SECRET'].blank? || ENV['CAREERPLUG_WEBHOOK_URL'].blank?
+
+    webhook_urls.create!(
+      url: ENV.fetch('CAREERPLUG_WEBHOOK_URL'),
+      events: %w[template.preferences_updated],
+      secret: { 'X-CareerPlug-Secret' => ENV.fetch('CAREERPLUG_WEBHOOK_SECRET') }
+    )
+  end
 end

app/models/webhook_url.rb

@@ -38,12 +38,12 @@ class WebhookUrl < ApplicationRecord
     submission.archived
     template.created
     template.updated
+    template.preferences_updated
   ].freeze
 
   # Partnership webhooks can only use template events since partnerships don't have submissions/submitters
   PARTNERSHIP_EVENTS = %w[
-    template.created
-    template.updated
+    template.preferences_updated
   ].freeze
 
   belongs_to :account, optional: true

lib/params/submission_create_validator.rb

@@ -3,7 +3,6 @@
 module Params
   class SubmissionCreateValidator < BaseValidator
     def call
-      binding.pry
       if params[:submission].blank? && (params[:emails].present? || params[:email].present?)
         validate_creation_from_emails(params)
       elsif params.key?(:submitters)

lib/tasks/webhooks.rake

@@ -26,32 +26,49 @@ namespace :webhooks do
     end
   end
 
-  desc 'Set up development webhook URLs for all accounts (creates URLs + configures secret)'
+  desc 'Set up development webhook URLs for all accounts and partnerships (creates URLs + configures secret)'
   task setup_development: :environment do
     abort 'This task is only for development' unless Rails.env.development?
 
     url = 'http://localhost:3000/api/docuseal/events'
     secret = { 'X-CareerPlug-Secret' => 'development_webhook_secret' }
-    events = %w[form.viewed form.started form.completed form.declined]
+    sha1 = Digest::SHA1.hexdigest(url)
+    account_events = %w[form.viewed form.started form.completed form.declined template.preferences_updated]
+    partnership_events = %w[template.preferences_updated]
 
     created = 0
     updated = 0
 
     Account.find_each do |account|
-      webhook_url = WebhookUrl.find_or_initialize_by(account: account, sha1: Digest::SHA1.hexdigest(url))
+      webhook_url = WebhookUrl.find_or_initialize_by(account:, sha1:)
 
       if webhook_url.new_record?
-        webhook_url.assign_attributes(url: url, events: events, secret: secret)
+        webhook_url.assign_attributes(url:, events: account_events, secret:)
         webhook_url.save!
         created += 1
         puts "Created webhook URL for account #{account.id}: #{account.name}"
       elsif webhook_url.secret != secret
-        webhook_url.update!(secret: secret)
+        webhook_url.update!(secret:)
         updated += 1
         puts "Updated webhook secret for account #{account.id}: #{account.name}"
       end
     end
 
+    Partnership.find_each do |partnership|
+      webhook_url = WebhookUrl.find_or_initialize_by(partnership:, sha1:)
+
+      if webhook_url.new_record?
+        webhook_url.assign_attributes(url:, events: partnership_events, secret:)
+        webhook_url.save!
+        created += 1
+        puts "Created webhook URL for partnership #{partnership.id}: #{partnership.name}"
+      elsif webhook_url.secret != secret
+        webhook_url.update!(secret:)
+        updated += 1
+        puts "Updated webhook secret for partnership #{partnership.id}: #{partnership.name}"
+      end
+    end
+
     puts "Done: #{created} created, #{updated} updated"
   end
 end

lib/webhook_urls.rb

@@ -4,12 +4,12 @@ module WebhookUrls
   module_function
 
   def for_template(template, events)
+    return WebhookUrl.none if template.partnership_id.blank? && template.account_id.blank?
+
     if template.partnership_id.present?
       for_partnership_id(template.partnership_id, events)
-    elsif template.account_id.present?
-      for_account_id(template.account_id, events)
     else
-      raise ArgumentError, 'Template must have either account_id or partnership_id'
+      for_account_id(template.account_id, events)
     end
   end
 

spec/lib/webhook_urls_spec.rb

@@ -65,12 +65,12 @@
     end
 
     context 'with a template that has neither account nor partnership' do
-      let(:template) { build(:template, account: nil, partnership: nil, author: user) }
+      let(:template) { build(:template, account_id: nil, partnership_id: nil, author: user) }
 
-      it 'raises an ArgumentError' do
-        expect do
-          described_class.for_template(template, 'template.created')
-        end.to raise_error(ArgumentError, 'Template must have either account_id or partnership_id')
+      it 'returns empty relation' do
+        webhooks = described_class.for_template(template, 'template.created')
+        expect(webhooks).to eq(WebhookUrl.none)
+        expect(webhooks.to_a).to be_empty
       end
     end
   end

spec/models/account_create_careerplug_webhook_spec.rb

@@ -63,6 +63,41 @@
     end
   end
 
+  describe '#create_careerplug_webhook' do
+    context 'when both env vars are present' do
+      before do
+        stub_const('ENV', ENV.to_h.merge(
+                            'CAREERPLUG_WEBHOOK_URL' => 'https://example.com/webhook',
+                            'CAREERPLUG_WEBHOOK_SECRET' => 'secret'
+                          ))
+      end
+
+      it 'creates a webhook with the correct events on account creation' do
+        account = create(:account)
+        webhook = account.webhook_urls.last
+
+        expect(webhook).to be_present
+        expect(webhook.events).to match_array(%w[
+                                                form.viewed
+                                                form.started
+                                                form.completed
+                                                form.declined
+                                                template.preferences_updated
+                                              ])
+      end
+    end
+
+    context 'when env vars are missing' do
+      before do
+        stub_const('ENV', ENV.to_h.except('CAREERPLUG_WEBHOOK_URL', 'CAREERPLUG_WEBHOOK_SECRET'))
+      end
+
+      it 'does not create a webhook' do
+        expect { create(:account) }.not_to change(WebhookUrl, :count)
+      end
+    end
+  end
+
   describe '#default_template_folder' do
     it 'creates default folder when none exists' do
       account = create(:account)

spec/models/account_spec.rb

@@ -15,6 +15,35 @@
 #  index_partnerships_on_external_partnership_id  (external_partnership_id) UNIQUE
 #
 describe Partnership do
+  describe '#create_careerplug_webhook' do
+    context 'when both env vars are present' do
+      before do
+        stub_const('ENV', ENV.to_h.merge(
+                            'CAREERPLUG_WEBHOOK_URL' => 'https://example.com/webhook',
+                            'CAREERPLUG_WEBHOOK_SECRET' => 'secret'
+                          ))
+      end
+
+      it 'creates a webhook with the correct events on partnership creation' do
+        partnership = create(:partnership)
+        webhook = partnership.webhook_urls.last
+
+        expect(webhook).to be_present
+        expect(webhook.events).to match_array(%w[template.preferences_updated])
+      end
+    end
+
+    context 'when env vars are missing' do
+      before do
+        stub_const('ENV', ENV.to_h.except('CAREERPLUG_WEBHOOK_URL', 'CAREERPLUG_WEBHOOK_SECRET'))
+      end
+
+      it 'does not create a webhook' do
+        expect { create(:partnership) }.not_to change(WebhookUrl, :count)
+      end
+    end
+  end
+
   describe 'validations' do
     it 'validates presence of external_partnership_id' do
       partnership = build(:partnership, external_partnership_id: nil)