bullet_train-outgoing_webhooks 1.2.9 → 1.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74eccc06e9bac4c34f9d57665a043f47818085eb0b0c4c53cdca3fe5cbdb49a4
-  data.tar.gz: b6ed8bd2705b78422b4d133c97f86d3e7e3e81619d62e9893fddfe069feba977
+  metadata.gz: d44b251cd89a804615ec264c52649e52bbc6c79f27e292713153be356c4ba099
+  data.tar.gz: b045ede97a1140a494dd9e11ae3853f3ac8f106b8e73dd33392cc76636c0ed08
 SHA512:
-  metadata.gz: d0cd98a77bc6d65bb507f3e6adad488572579ca73373fbda33d961ea540fd598d11b43259bda446de85865bedf638e4de9bd9cf529b26d8303b351903613d9f9
-  data.tar.gz: 8318b904b4cfe110378aed89de7d98e2cebba99abf38ecb8fa60b49c7ed7c48a4577531e25efbb07a611e2c37dc213eb25cdf1b6618bee5e3291a70e8b9c71bd
+  metadata.gz: 6b50b117f3313cdcf7b009f1f656a9ba9593e354958c29a62c88235f497a18db35aba83587a27e8d12fb0b9ff4343fb844c5fc156dcfb0d4dd73d83474dc32ba
+  data.tar.gz: c857cf75207fce59abe42e84fed7c836da7d92941ee628312a31cb02f1f0dd3781714c407e2fb2ca5f8d1938bff40760ac608d44dd6e5e29708b463e822bfe53

data/app/controllers/api/v1/webhooks/outgoing/endpoints_controller.rb

@@ -41,6 +41,7 @@ class Api::V1::Webhooks::Outgoing::EndpointsController < Api::V1::ApplicationCon
         *permitted_fields,
         :url,
         :name,
+        :version,
         :scaffolding_absolutely_abstract_creative_concept_id,
         # 🚅 super scaffolding will insert new fields above this line.
         *permitted_arrays,

data/app/controllers/api/v1/webhooks/outgoing/events_controller.rb

@@ -0,0 +1,13 @@
+class Api::V1::Webhooks::Outgoing::EventsController < Api::V1::ApplicationController
+  account_load_and_authorize_resource :event, through: :team, through_association: :webhooks_outgoing_events
+
+  # GET /api/v1/teams/:team_id/webhooks/outgoing/events
+  def index
+    render json: @events.map(&:payload)
+  end
+
+  # GET /api/v1/webhooks/outgoing/events/:id
+  def show
+    render json: @event.payload
+  end
+end

data/app/jobs/webhooks/outgoing/generate_job.rb

@@ -1,7 +1,8 @@
 class Webhooks::Outgoing::GenerateJob < ApplicationJob
   queue_as :default
 
-  def perform(obj, action)
-    obj.generate_webhook_perform(action)
+  # `= [1]` ensures backwards compatibility for older installations when they upgrade.
+  def perform(obj, action, api_versions = [1])
+    obj.generate_webhook_perform(action, api_versions)
   end
 end

data/app/models/concerns/webhooks/outgoing/delivery_support.rb

@@ -32,6 +32,8 @@ module Webhooks::Outgoing::DeliverySupport
   end
 
   def deliver
+    # TODO If we ever do away with the `async: true` default for webhook generation, then I believe this needs to
+    # change otherwise we'd be attempting the first delivery of webhooks inline.
     if delivery_attempts.create.attempt
       touch(:delivered_at)
     else

data/app/models/concerns/webhooks/outgoing/endpoint_support.rb

@@ -15,10 +15,11 @@ module Webhooks::Outgoing::EndpointSupport
 
     before_validation { url&.strip! }
 
-    validates :url, presence: true, allowed_uri: true
+    validates :url, presence: true, allowed_uri: BulletTrain::OutgoingWebhooks.advanced_hostname_security
 
     after_initialize do
       self.event_type_ids ||= []
+      self.api_version ||= I18n.t("webhooks/outgoing/endpoints.fields.api_version.options").keys.last
     end
 
     after_save :touch_parent

data/app/models/concerns/webhooks/outgoing/event_support.rb

@@ -28,7 +28,7 @@ module Webhooks::Outgoing::EventSupport
   end
 
   def endpoints
-    endpoints = send(BulletTrain::OutgoingWebhooks.parent_association).webhooks_outgoing_endpoints.listening_for_event_type_id(event_type_id)
+    endpoints = send(BulletTrain::OutgoingWebhooks.parent_association).webhooks_outgoing_endpoints.where(api_version: api_version).listening_for_event_type_id(event_type_id)
 
     case subject_type
     when "Scaffolding::AbsolutelyAbstract::CreativeConcept"

data/app/models/concerns/webhooks/outgoing/issuing_model.rb

@@ -32,24 +32,31 @@ module Webhooks::Outgoing::IssuingModel
     # and this object has a parent where an associated outgoing webhooks endpoint could be registered.
     if event_type
       # Only generate an event record if an endpoint is actually listening for this event type.
-      if parent.endpoints_listening_for_event_type?(event_type)
+      # If there are endpoints listening, make sure we know which API versions they're looking for.
+      if (api_versions = parent.endpoint_api_versions_listening_for_event_type(event_type)).any?
         if async
           # serialization can be heavy so run it as a job
-          Webhooks::Outgoing::GenerateJob.perform_later(self, action)
+          Webhooks::Outgoing::GenerateJob.perform_later(self, action, api_versions)
         else
-          generate_webhook_perform(action)
+          generate_webhook_perform(action, api_versions)
         end
       end
     end
   end
 
-  def generate_webhook_perform(action)
+  def generate_webhook_perform(action, api_versions)
     event_type = Webhooks::Outgoing::EventType.find_by(id: "#{self.class.name.underscore}.#{action}")
-    # TODO This is crazy that we generate JSON just to parse it. Can't be good for performance.
-    # Does Jbuilder support generating a hash instead of a JSON string?
-    data = JSON.parse(to_api_json)
-    webhook = send(BulletTrain::OutgoingWebhooks.parent_association).webhooks_outgoing_events.create(event_type_id: event_type.id, subject: self, data: data)
-    webhook.deliver
+
+    api_versions.each do |api_version|
+      webhook = send(BulletTrain::OutgoingWebhooks.parent_association).webhooks_outgoing_events.create(
+        event_type_id: event_type.id,
+        subject: self,
+        data: to_api_json(api_version),
+        api_version: api_version
+      )
+
+      webhook.deliver
+    end
   end
 
   def generate_created_webhook

data/app/models/concerns/webhooks/outgoing/team_support.rb

@@ -12,15 +12,19 @@ module Webhooks::Outgoing::TeamSupport
     true
   end
 
-  def endpoints_listening_for_event_type?(event_type)
+  def endpoint_api_versions_for_event_type(event_type)
+    webhooks_outgoing_endpoints.listening_for_event_type_id(event_type.id).pluck(:api_version).uniq
+  end
+
+  def endpoint_api_versions_listening_for_event_type(event_type)
     if should_cache_endpoints_listening_for_event_type?
-      key = "#{cache_key_with_version}/endpoints_for_event_type/#{event_type.cache_key}"
+      key = "#{cache_key_with_version}/endpoints_for_event_type/#{event_type.cache_key}/api_version"
 
       Rails.cache.fetch(key, expires_in: 24.hours, race_condition_ttl: 5.seconds) do
-        webhooks_outgoing_endpoints.listening_for_event_type_id(event_type.id).any?
+        endpoint_api_versions_for_event_type(event_type)
       end
     else
-      webhooks_outgoing_endpoints.listening_for_event_type_id(event_type.id).any?
+      endpoint_api_versions_for_event_type(event_type)
     end
   end
 

data/app/models/concerns/webhooks/outgoing/uri_filtering.rb

@@ -100,6 +100,8 @@ module Webhooks::Outgoing::UriFiltering
   end
 
   def _allowed_uri?(uri)
+    return true unless uri.present?
+
     config = Rails.configuration.outgoing_webhooks
     hostname = uri.hostname.downcase
 

data/app/views/account/webhooks/outgoing/endpoints/_form.html.erb

@@ -4,6 +4,9 @@
   <% with_field_settings form: form do %>
     <%= render 'shared/fields/text_field', method: :name, options: {autofocus: true} %>
     <%= render 'shared/fields/text_field', method: :url %>
+    <% unless I18n.t("webhooks/outgoing/endpoints.fields.api_version.options").keys.one? %>
+      <%= render 'shared/fields/super_select', method: :api_version %>
+    <% end %>
     <%= render 'shared/fields/super_select', method: :event_type_ids, html_options: {multiple: true},
       choices: @endpoint.valid_event_types.map { |event_type| [event_type.label_string, event_type.id] } %>
     <%= render 'shared/fields/super_select', method: :scaffolding_absolutely_abstract_creative_concept_id,

data/app/views/api/v1/open_api/index.yaml.erb

@@ -16,6 +16,7 @@ components:
       scheme: bearer
   schemas:
     <%= automatic_components_for Webhooks::Outgoing::Endpoint %>
+    <%= automatic_components_for Webhooks::Outgoing::Event %>
     <%# 🚅 super scaffolding will insert new components above this line. %>
   parameters:
     id:
@@ -28,4 +29,5 @@ security:
   - BearerAuth: []
 paths:
   <%= automatic_paths_for Webhooks::Outgoing::Endpoint, Team %>
+  <%= automatic_paths_for Webhooks::Outgoing::Event, Team, except: %i[create update delete] %>
   <%# 🚅 super scaffolding will insert new paths above this line. %>

data/app/views/api/v1/webhooks/outgoing/events/_event.json.jbuilder

@@ -0,0 +1,12 @@
+json.data schema: {object: OpenStruct.new, object_title: I18n.t("webhooks/outgoing/events.fields.data.heading"), object_description: I18n.t("webhooks/outgoing/events.fields.data.heading")} do
+  json.id schema: {type: :integer, description: I18n.t("webhooks/outgoing/events.fields.data.id.heading")}
+  json.name schema: {type: :string, description: I18n.t("webhooks/outgoing/events.fields.data.name.heading")}
+  json.description schema: {type: :string, description: I18n.t("webhooks/outgoing/events.fields.data.description.heading")}
+  json.created_at schema: {type: :string, format: "date-time", description: I18n.t("webhooks/outgoing/events.fields.data.created_at.heading")}
+  json.updated_at schema: {type: :string, format: "date-time", description: I18n.t("webhooks/outgoing/events.fields.data.updated_at.heading")}
+end
+
+json.event_id schema: {type: :string, description: I18n.t("webhooks/outgoing/events.fields.event_id.heading")}
+json.event_type schema: {type: :integer, description: I18n.t("webhooks/outgoing/events.fields.event_type.heading")}
+json.subject_id schema: {type: :integer, description: I18n.t("webhooks/outgoing/events.fields.subject_id.heading")}
+json.subject_type schema: {type: :string, description: I18n.t("webhooks/outgoing/events.fields.subject_type.heading")}

data/app/views/api/v1/webhooks/outgoing/events/index.json.jbuilder

@@ -0,0 +1 @@
+json.array! @events, partial: "api/v1/webhooks/outgoing/events/event", as: :event

data/app/views/api/v1/webhooks/outgoing/events/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial! "api/v1/webhooks/outgoing/events/event", event: @event

data/config/locales/en/webhooks/outgoing/endpoints.en.yml

@@ -39,6 +39,13 @@ en:
         label: *url
         heading: *url
 
+      api_version:
+        _: &api_version API Version
+        label: *api_version
+        heading: *api_version
+        options:
+          1: V1
+
       event_type_ids: &event_types
         _: &event_type_ids Event Types
         label: *event_type_ids
@@ -114,8 +121,9 @@ en:
       webhooks/outgoing/endpoint:
         name: *name
         url: *url
+        api_version: *api_version
         event_type_ids: *event_type_ids
+        scaffolding_absolutely_abstract_creative_concept_id: *scaffolding_absolutely_abstract_creative_concept_id
         # 🚅 super scaffolding will insert new activerecord attributes above this line.
         created_at: *created_at
-        updated_at: *updated_at
-        scaffolding_absolutely_abstract_creative_concept_id: *scaffolding_absolutely_abstract_creative_concept_id
+        updated_at: *updated_at

data/config/locales/en/webhooks/outgoing/events.en.yml

@@ -1,10 +1,72 @@
 en:
-  webhooks/outgoing/events:
-    fields:
-      uuid: &uuid
-        heading: Event UUID
-      short_uuid: *uuid
-      event_type_name:
-        heading: Event Type
+  webhooks/outgoing/events: &events
+    label: &label Webhooks Events
+    fields: &fields
+      data:
+        _: &data Event Data
+        label: *data
+        heading: *data
+
+        id:
+          _: &id Event ID
+          label: *id
+          heading: *id
+
+        name:
+          _: &name Event Name
+          label: *name
+          heading: *name
+
+        description:
+          _: &description Event Description
+          label: *description
+          heading: *description
+
+        created_at:
+          _: &created_at DateTime Event was added
+          label: *created_at
+          heading: *created_at
+        updated_at:
+          _: &updated_at DateTime Event was updated
+          label: *updated_at
+          heading: *updated_at
+
+      event_id:
+        _: &event_id Event UUID
+        label: *event_id
+        heading: *event_id
+
+      event_type:
+        _: &event_type Event Type
+        label: *event_type
+        heading: *event_type
+
+      subject_id:
+        _: &subject_id Subject ID
+        label: *subject_id
+        heading: *subject_id
+
+      subject_type:
+        _: &subject_type Subject Type
+        label: *subject_type
+        heading: *subject_type
+
       payload:
-        heading: JSON Payload
+        _: &payload Payload
+        label: *payload
+        heading: *payload
+
+      uuid:
+        _: &uuid UUID
+        label: *uuid
+        heading: *uuid
+
+      short_uuid:
+        _: &short_uuid Short UUID
+        label: *short_uuid
+        heading: *short_uuid
+
+      event_type_name:
+        _: &event_type_name Event Type Name
+        label: *event_type_name
+        heading: *event_type_name

data/config/routes.rb

@@ -6,10 +6,9 @@ Rails.application.routes.draw do
       resources BulletTrain::OutgoingWebhooks.parent_resource do
         namespace :webhooks do
           namespace :outgoing do
-            resources :events
             resources :endpoints do
-              resources :deliveries, only: [:index, :show] do
-                resources :delivery_attempts, only: [:index, :show]
+              resources :deliveries, only: %i[index show] do
+                resources :delivery_attempts, only: %i[index show]
               end
             end
           end
@@ -25,6 +24,7 @@ Rails.application.routes.draw do
           namespace :webhooks do
             namespace :outgoing do
               resources :endpoints, defaults: {format: :json}
+              resources :events, only: %i[index show], defaults: {format: :json}
             end
           end
         end

data/lib/bullet_train/outgoing_webhooks/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module OutgoingWebhooks
-    VERSION = "1.2.9"
+    VERSION = "1.2.10"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-outgoing_webhooks
 version: !ruby/object:Gem::Version
-  version: 1.2.9
+  version: 1.2.10
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-28 00:00:00.000000000 Z
+date: 2022-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -71,6 +71,7 @@ files:
 - app/controllers/api/v1/webhooks.rb
 - app/controllers/api/v1/webhooks/outgoing.rb
 - app/controllers/api/v1/webhooks/outgoing/endpoints_controller.rb
+- app/controllers/api/v1/webhooks/outgoing/events_controller.rb
 - app/jobs/webhooks/outgoing/delivery_job.rb
 - app/jobs/webhooks/outgoing/generate_job.rb
 - app/models/concerns/webhooks/outgoing/delivery_attempt_support.rb
@@ -126,6 +127,9 @@ files:
 - app/views/api/v1/webhooks/outgoing/endpoints/_endpoint.json.jbuilder
 - app/views/api/v1/webhooks/outgoing/endpoints/index.json.jbuilder
 - app/views/api/v1/webhooks/outgoing/endpoints/show.json.jbuilder
+- app/views/api/v1/webhooks/outgoing/events/_event.json.jbuilder
+- app/views/api/v1/webhooks/outgoing/events/index.json.jbuilder
+- app/views/api/v1/webhooks/outgoing/events/show.json.jbuilder
 - config/locales/en/webhooks/outgoing/deliveries.en.yml
 - config/locales/en/webhooks/outgoing/delivery_attempts.en.yml
 - config/locales/en/webhooks/outgoing/endpoints.en.yml
@@ -178,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Allow users of your Rails application to subscribe and receive webhooks when