bullet_train-outgoing_webhooks 1.0.1 → 1.0.2

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2022 Andrew Culver
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "bullet_train/outgoing_webhooks"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/jobs/webhooks/outgoing/delivery_job.rb

@@ -1,9 +0,0 @@
-# TODO Make this work off of `ApplicationJob`.
-class Webhooks::Outgoing::DeliveryJob < ActiveJob::Base
-  # TODO Make this configurable.
-  queue_as Webhooks::Outgoing.job_queue
-
-  def perform(delivery)
-    delivery.deliver
-  end
-end

data/lib/models/concerns/webhooks/outgoing/has_uuid.rb

@@ -1,21 +0,0 @@
-module Webhooks::Outgoing::HasUuid
-  extend ActiveSupport::Concern
-
-  # define relationships.
-  included do
-    after_initialize do
-      self.uuid ||= SecureRandom.hex
-    end
-  end
-
-  # define class methods.
-  module ClassMethods
-  end
-
-  # define object methods.
-  def short_uuid
-    self.uuid.first(7)
-  rescue
-    "nil"
-  end
-end

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

@@ -1,57 +0,0 @@
-module Webhooks::Outgoing::IssuingModel
-  extend ActiveSupport::Concern
-
-  # define relationships.
-  included do
-    after_commit :generate_created_webhook, on: [:create]
-    after_commit :generate_updated_webhook, on: [:update]
-    after_commit :generate_deleted_webhook, on: [:destroy]
-    has_many :webhooks_outgoing_events, as: :subject, class_name: "Webhooks::Outgoing::Event", dependent: :nullify
-  end
-
-  # define class methods.
-  module ClassMethods
-  end
-
-  def webhooks_team
-    send(team_association)
-  end
-
-  def team_association
-    Webhooks::Outgoing.team_model.underscore.to_sym
-  end
-
-  def generate_webhook(action)
-    # we can only generate webhooks for objects that return their team.
-    return unless respond_to? team_association
-
-    # Try to find an event type definition for this action.
-    event_type = Webhooks::Outgoing::EventType.find_by(id: "#{self.class.name.underscore}.#{action}")
-
-    # If the event type is defined as one that people can be subscribed to,
-    # and this object has a team where an associated outgoing webhooks endpoint could be registered.
-    if event_type && webhooks_team
-
-      # Only generate an event record if an endpoint is actually listening for this event type.
-      if webhooks_team.webhooks_outgoing_endpoints.listening_for_event_type_id(event_type.id).any?
-        data = "Api::V1::#{self.class.name}Serializer".constantize.new(self).serializable_hash[:data]
-        webhook = webhooks_team.webhooks_outgoing_events.create(event_type_id: event_type.id, subject: self, data: data)
-        webhook.deliver
-      end
-    end
-  end
-
-  def generate_created_webhook
-    generate_webhook("created")
-  end
-
-  def generate_updated_webhook
-    generate_webhook("updated")
-  end
-
-  def generate_deleted_webhook
-    return false unless respond_to?(team_association)
-    return false if webhooks_team&.being_destroyed?
-    generate_webhook("deleted")
-  end
-end

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

@@ -1,15 +0,0 @@
-module Webhooks::Outgoing::TeamSupport
-  extend ActiveSupport::Concern
-
-  included do
-    has_many :webhooks_outgoing_endpoints, class_name: "Webhooks::Outgoing::Endpoint", dependent: :destroy
-    has_many :webhooks_outgoing_events, class_name: "Webhooks::Outgoing::Event", dependent: :destroy
-
-    before_destroy :mark_for_destruction, prepend: true
-  end
-
-  def mark_for_destruction
-    # This allows downstream logic to check whether a team is being destroyed in order to bypass webhook issuance.
-    update_column(:being_destroyed, true)
-  end
-end

data/lib/models/webhooks/outgoing/delivery.rb

@@ -1,62 +0,0 @@
-class Webhooks::Outgoing::Delivery < ActiveRecord::Base
-  belongs_to :endpoint, class_name: "Webhooks::Outgoing::Endpoint"
-  belongs_to :event, class_name: "Webhooks::Outgoing::Event"
-  has_one :team, through: :endpoint
-
-  ATTEMPT_SCHEDULE = {
-    1 => 15.seconds,
-    2 => 1.minute,
-    3 => 5.minutes,
-    4 => 15.minutes,
-    5 => 1.hour,
-  }
-
-  has_many :delivery_attempts, class_name: "Webhooks::Outgoing::DeliveryAttempt", dependent: :destroy, foreign_key: :delivery_id
-
-  def label_string
-    event.short_uuid
-  end
-
-  def next_reattempt_delay
-    ATTEMPT_SCHEDULE[attempt_count]
-  end
-
-  def deliver_async
-    if still_attempting?
-      Webhooks::Outgoing::DeliveryJob.set(wait: next_reattempt_delay).perform_later(self)
-    end
-  end
-
-  def deliver
-    if delivery_attempts.create.attempt
-      touch(:delivered_at)
-    else
-      deliver_async
-    end
-  end
-
-  def attempt_count
-    delivery_attempts.count
-  end
-
-  def delivered?
-    delivered_at.present?
-  end
-
-  def still_attempting?
-    return false if delivered?
-    attempt_count < max_attempts
-  end
-
-  def failed?
-    !(delivered? || still_attempting?)
-  end
-
-  def name
-    event.short_uuid
-  end
-
-  def max_attempts
-    ATTEMPT_SCHEDULE.keys.max
-  end
-end

data/lib/models/webhooks/outgoing/delivery_attempt.rb

@@ -1,49 +0,0 @@
-class Webhooks::Outgoing::DeliveryAttempt < ActiveRecord::Base
-  belongs_to :delivery
-  has_one :team, through: :delivery
-  scope :successful, -> { where(response_code: 200) }
-
-  before_create do
-    self.attempt_number = delivery.attempt_count + 1
-  end
-
-  def still_attempting?
-    error_message.nil? && response_code.nil?
-  end
-
-  def successful?
-    [200, 201, 202, 203, 204, 205, 206, 207, 226].include?(response_code)
-  end
-
-  def failed?
-    !(successful? || still_attempting?)
-  end
-
-  def attempt
-    uri = URI.parse(delivery.endpoint_url)
-    http = Net::HTTP.new(uri.host, uri.port)
-    http.use_ssl = true if uri.scheme == "https"
-    request = Net::HTTP::Post.new(uri.path)
-    request.add_field("Content-Type", "application/json")
-    request.body = delivery.event.payload.to_json
-
-    begin
-      response = http.request(request)
-      self.response_message = response.message
-      self.response_code = response.code
-      self.response_body = response.body
-    rescue Exception => exception
-      self.response_code = 0
-      self.error_message = exception.message
-    end
-
-    save
-    successful?
-  end
-
-  def label_string
-    "#{attempt_number.ordinalize} Attempt"
-  end
-
-  validates :response_code, presence: true
-end

data/lib/models/webhooks/outgoing/endpoint.rb

@@ -1,22 +0,0 @@
-class Webhooks::Outgoing::Endpoint < ActiveRecord::Base
-  belongs_to :team, class_name: Webhooks::Outgoing.team_model
-
-  has_many :deliveries, class_name: "Webhooks::Outgoing::Delivery", dependent: :destroy, foreign_key: :endpoint_id
-  has_many :events, -> { distinct }, through: :deliveries
-
-  scope :listening_for_event_type_id, ->(event_type_id) { where("event_type_ids @> ? OR event_type_ids = '[]'::jsonb", "\"#{event_type_id}\"") }
-
-  validates :name, presence: true
-
-  def valid_event_types
-    Webhooks::Outgoing::EventType.all
-  end
-
-  def event_types
-    event_type_ids.map { |id| Webhooks::Outgoing::EventType.find(id) }
-  end
-
-  def label_string
-    name
-  end
-end

data/lib/models/webhooks/outgoing/event.rb

@@ -1,41 +0,0 @@
-class Webhooks::Outgoing::Event < ActiveRecord::Base
-  include Webhooks::Outgoing::HasUuid
-  belongs_to :team, class_name: Webhooks::Outgoing.team_model
-  belongs_to :event_type, class_name: "Webhooks::Outgoing::EventType"
-  belongs_to :subject, polymorphic: true
-  has_many :deliveries, dependent: :destroy
-
-  before_create do
-    self.payload = generate_payload
-  end
-
-  def generate_payload
-    {
-      event_id: uuid,
-      event_type: event_type_id,
-      subject_id: subject_id,
-      subject_type: subject_type,
-      data: data
-    }
-  end
-
-  def event_type_name
-    payload.dig("event_type")
-  end
-
-  def endpoints
-    team.webhooks_outgoing_endpoints.listening_for_event_type_id(event_type_id)
-  end
-
-  def deliver
-    endpoints.each do |endpoint|
-      unless endpoint.deliveries.where(event: self).any?
-        endpoint.deliveries.create(event: self, endpoint_url: endpoint.url).deliver_async
-      end
-    end
-  end
-
-  def label_string
-    short_uuid
-  end
-end

data/lib/models/webhooks/outgoing/event_type.rb

@@ -1,15 +0,0 @@
-class Webhooks::Outgoing::EventType < ActiveHash::Base
-  include ActiveHash::Associations
-
-  self.data = YAML.load_file("config/models/webhooks/outgoing/event_types.yml").map do |topic, events|
-    events.map { |event| event == "crud" ? ["created", "updated", "deleted"] : event }.flatten.map { |event| {id: "#{topic}.#{event}"} }
-  end.flatten
-
-  def name
-    id
-  end
-
-  def label_string
-    id
-  end
-end

data/lib/models/webhooks/outgoing.rb

@@ -1,11 +0,0 @@
-module Webhooks::Outgoing
-  def self.table_name_prefix
-    "webhooks_outgoing_"
-  end
-
-  mattr_accessor :team_model
-  @@team_model = "Team"
-
-  mattr_accessor :job_queue
-  @@job_queue = :default
-end

data/lib/models/webhooks.rb

@@ -1,2 +0,0 @@
-module Webhooks
-end

data/sig/bullet_train/outgoing_webhooks.rbs

@@ -1,6 +0,0 @@
-module BulletTrain
-  module OutgoingWebhooks
-    VERSION: String
-    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-  end
-end