bullet_train-outgoing_webhooks-api 1.0.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42a50b611f7a9e0eab87254a3535f934c1295760abf6c74b24be7a5753b385a3
-  data.tar.gz: 212c8c1df83bcbc394570ee5fb8e1cf86641f8106c3d708ee72f486b50d0a17c
+  metadata.gz: 7d1dcf8e1fa9328862e8cf38e8522825b823dd03407b47c142e90223d655565c
+  data.tar.gz: d44193115033570f9a06400f54ab7fe79ad2d4c6863ad51f1cf1eaefe3dcf687
 SHA512:
-  metadata.gz: c6e2aecb15bbe86d486f3ad312cb55abd26caaa144c31e9ba0792dd8bae7ea69b976a7c672529474655856778e0ff67c0f3e8af690a17527bd266a6ddcf64063
-  data.tar.gz: 0e4ac88ab742f1b87ece1f97f98c0979b6d63ad9afc4b7b447bd848fcc06010587678e8b34883405e98532a5ccd57eddf1e61dbfd4a45ce14acdcf06d245f8e4
+  metadata.gz: 37d66efb78e4d82291a8b7e856a214b4ceeac7a7c5c4ab5238125efaa5c2290763ed840c4225140e276fc883d8f9b05bba2b9c3f8335cf93c2bfd4596484a61b
+  data.tar.gz: da7d83075169233051b0e3d28e4420a8f77d57f674b5265a4ad0078db439f47765bc0f4277c2e640078c6801e15fe38be7a11696e517724f565aaf269cf519b1

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

@@ -0,0 +1,63 @@
+class Api::V1::Webhooks::Outgoing::DeliveriesEndpoint < Api::V1::Root
+  helpers do
+    params :endpoint_id do
+      requires :endpoint_id, type: Integer, allow_blank: false, desc: "Endpoint ID"
+    end
+
+    params :id do
+      requires :id, type: Integer, allow_blank: false, desc: "Delivery ID"
+    end
+
+    params :delivery do
+      optional :event_id, type: String, desc: Api.heading(:event_id)
+      optional :endpoint_url, type: String, desc: Api.heading(:endpoint_url)
+      optional :delivered_at, type: DateTime, desc: Api.heading(:delivered_at)
+      # 🚅 super scaffolding will insert new fields above this line.
+      # 🚅 super scaffolding will insert new arrays above this line.
+
+      # 🚅 super scaffolding will insert processing for new fields above this line.
+    end
+  end
+
+  resource "webhooks/outgoing/endpoints", desc: Api.title(:collection_actions) do
+    after_validation do
+      load_and_authorize_api_resource Webhooks::Outgoing::Delivery
+    end
+
+    #
+    # INDEX
+    #
+
+    desc Api.title(:index), &Api.index_desc
+    params do
+      use :endpoint_id
+    end
+    oauth2
+    paginate per_page: 100
+    get "/:endpoint_id/deliveries" do
+      @paginated_deliveries = paginate @deliveries
+      render @paginated_deliveries, serializer: Api.serializer
+    end
+  end
+
+  resource "webhooks/outgoing/deliveries", desc: Api.title(:member_actions) do
+    after_validation do
+      load_and_authorize_api_resource Webhooks::Outgoing::Delivery
+    end
+
+    #
+    # SHOW
+    #
+
+    desc Api.title(:show), &Api.show_desc
+    params do
+      use :id
+    end
+    oauth2
+    route_param :id do
+      get do
+        render @delivery, serializer: Api.serializer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+class Api::V1::Webhooks::Outgoing::DeliveryAttemptsEndpoint < Api::V1::Root
+  helpers do
+    params :delivery_id do
+      requires :delivery_id, type: Integer, allow_blank: false, desc: "Delivery ID"
+    end
+
+    params :id do
+      requires :id, type: Integer, allow_blank: false, desc: "Delivery Attempt ID"
+    end
+
+    params :delivery_attempt do
+      optional :response_code, type: String, desc: Api.heading(:response_code)
+      optional :response_body, type: String, desc: Api.heading(:response_body)
+      optional :response_message, type: String, desc: Api.heading(:response_message)
+      optional :error_message, type: String, desc: Api.heading(:error_message)
+      optional :attempt_number, type: String, desc: Api.heading(:attempt_number)
+      # 🚅 super scaffolding will insert new fields above this line.
+      # 🚅 super scaffolding will insert new arrays above this line.
+
+      # 🚅 super scaffolding will insert processing for new fields above this line.
+    end
+  end
+
+  resource "webhooks/outgoing/deliveries", desc: Api.title(:collection_actions) do
+    after_validation do
+      load_and_authorize_api_resource Webhooks::Outgoing::DeliveryAttempt
+    end
+
+    #
+    # INDEX
+    #
+
+    desc Api.title(:index), &Api.index_desc
+    params do
+      use :delivery_id
+    end
+    oauth2
+    paginate per_page: 100
+    get "/:delivery_id/delivery_attempts" do
+      @paginated_delivery_attempts = paginate @delivery_attempts
+      render @paginated_delivery_attempts, serializer: Api.serializer
+    end
+  end
+
+  resource "webhooks/outgoing/delivery_attempts", desc: Api.title(:member_actions) do
+    after_validation do
+      load_and_authorize_api_resource Webhooks::Outgoing::DeliveryAttempt
+    end
+
+    #
+    # SHOW
+    #
+
+    desc Api.title(:show), &Api.show_desc
+    params do
+      use :id
+    end
+    oauth2
+    route_param :id do
+      get do
+        render @delivery_attempt, serializer: Api.serializer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,119 @@
+class Api::V1::Webhooks::Outgoing::EndpointsEndpoint < Api::V1::Root
+  helpers do
+    params :team_id do
+      requires :team_id, type: Integer, allow_blank: false, desc: "Team ID"
+    end
+
+    params :id do
+      requires :id, type: Integer, allow_blank: false, desc: "Endpoint ID"
+    end
+
+    params :endpoint do
+      optional :name, type: String, desc: Api.heading(:name)
+      optional :url, type: String, desc: Api.heading(:url)
+      # 🚅 super scaffolding will insert new fields above this line.
+      optional :event_type_ids, type: Array, desc: Api.heading(:event_type_ids)
+      # 🚅 super scaffolding will insert new arrays above this line.
+
+      # 🚅 super scaffolding will insert processing for new fields above this line.
+    end
+  end
+
+  resource "teams", desc: Api.title(:collection_actions) do
+    after_validation do
+      load_and_authorize_api_resource Webhooks::Outgoing::Endpoint
+    end
+
+    #
+    # INDEX
+    #
+
+    desc Api.title(:index), &Api.index_desc
+    params do
+      use :team_id
+    end
+    oauth2
+    paginate per_page: 100
+    get "/:team_id/webhooks/outgoing/endpoints" do
+      @paginated_endpoints = paginate @endpoints
+      render @paginated_endpoints, serializer: Api.serializer
+    end
+
+    #
+    # CREATE
+    #
+
+    desc Api.title(:create), &Api.create_desc
+    params do
+      use :team_id
+      use :endpoint
+    end
+    route_setting :api_resource_options, permission: :create
+    oauth2 "write"
+    post "/:team_id/webhooks/outgoing/endpoints" do
+      if @endpoint.save
+        render @endpoint, serializer: Api.serializer
+      else
+        record_not_saved @endpoint
+      end
+    end
+  end
+
+  resource "webhooks/outgoing/endpoints", desc: Api.title(:member_actions) do
+    after_validation do
+      load_and_authorize_api_resource Webhooks::Outgoing::Endpoint
+    end
+
+    #
+    # SHOW
+    #
+
+    desc Api.title(:show), &Api.show_desc
+    params do
+      use :id
+    end
+    oauth2
+    route_param :id do
+      get do
+        render @endpoint, serializer: Api.serializer
+      end
+    end
+
+    #
+    # UPDATE
+    #
+
+    desc Api.title(:update), &Api.update_desc
+    params do
+      use :id
+      use :endpoint
+    end
+    route_setting :api_resource_options, permission: :update
+    oauth2 "write"
+    route_param :id do
+      put do
+        if @endpoint.update(declared(params, include_missing: false))
+          render @endpoint, serializer: Api.serializer
+        else
+          record_not_saved @endpoint
+        end
+      end
+    end
+
+    #
+    # DESTROY
+    #
+
+    desc Api.title(:destroy), &Api.destroy_desc
+    params do
+      use :id
+    end
+    route_setting :api_resource_options, permission: :destroy
+    oauth2 "delete"
+    route_param :id do
+      delete do
+        render @endpoint.destroy, serializer: Api.serializer
+      end
+    end
+  end
+end

data/lib/bullet_train/outgoing_webhooks/api/engine.rb

@@ -2,6 +2,13 @@ module BulletTrain
   module OutgoingWebhooks
     module Api
       class Engine < ::Rails::Engine
+        initializer "bullet_train.outgoing_webhooks.register_api_endpoints" do |app|
+          if BulletTrain::Api
+            BulletTrain::Api.endpoints << "Api::V1::Webhooks::Outgoing::EndpointsEndpoint"
+            BulletTrain::Api.endpoints << "Api::V1::Webhooks::Outgoing::DeliveriesEndpoint"
+            BulletTrain::Api.endpoints << "Api::V1::Webhooks::Outgoing::DeliveryAttemptsEndpoint"
+          end
+        end
       end
     end
   end

data/lib/bullet_train/outgoing_webhooks/api/version.rb

@@ -1,7 +1,7 @@
 module BulletTrain
   module OutgoingWebhooks
     module Api
-      VERSION = "1.0.0"
+      VERSION = "1.0.4"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-outgoing_webhooks-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.4
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-31 00:00:00.000000000 Z
+date: 2022-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.0
-description: Bullet Train Outgoing Webhooks Api
+description: Bullet Train Outgoing Webhooks API
 email:
 - andrew.culver@gmail.com
 executables: []
@@ -35,9 +35,9 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/bullet_train_outgoing_webhooks_api_manifest.js
-- app/serializers/api/v1/webhooks/outgoing/delivery_attempt_serializer.rb
-- app/serializers/api/v1/webhooks/outgoing/delivery_serializer.rb
-- app/serializers/api/v1/webhooks/outgoing/endpoint_serializer.rb
+- app/controllers/api/v1/webhooks/outgoing/deliveries_endpoint.rb
+- app/controllers/api/v1/webhooks/outgoing/delivery_attempts_endpoint.rb
+- app/controllers/api/v1/webhooks/outgoing/endpoints_endpoint.rb
 - config/routes.rb
 - lib/bullet_train/outgoing_webhooks/api.rb
 - lib/bullet_train/outgoing_webhooks/api/engine.rb
@@ -67,5 +67,5 @@ requirements: []
 rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
-summary: Bullet Train Outgoing Webhooks Api
+summary: Bullet Train Outgoing Webhooks API
 test_files: []

data/app/serializers/api/v1/webhooks/outgoing/delivery_attempt_serializer.rb

@@ -1,16 +0,0 @@
-class Api::V1::Webhooks::Outgoing::DeliveryAttemptSerializer < Api::V1::ApplicationSerializer
-  set_type "webhooks/outgoing/delivery_attempt"
-
-  attributes :id,
-    :delivery_id,
-    :response_code,
-    :response_body,
-    :response_message,
-    :error_message,
-    :attempt_number,
-    # 🚅 super scaffolding will insert new fields above this line.
-    :created_at,
-    :updated_at
-
-  belongs_to :delivery, serializer: Api::V1::Webhooks::Outgoing::DeliverySerializer
-end

data/app/serializers/api/v1/webhooks/outgoing/delivery_serializer.rb

@@ -1,14 +0,0 @@
-class Api::V1::Webhooks::Outgoing::DeliverySerializer < Api::V1::ApplicationSerializer
-  set_type "webhooks/outgoing/delivery"
-
-  attributes :id,
-    :endpoint_id,
-    :event_id,
-    :endpoint_url,
-    :delivered_at,
-    # 🚅 super scaffolding will insert new fields above this line.
-    :created_at,
-    :updated_at
-
-  belongs_to :endpoint, serializer: Api::V1::Webhooks::Outgoing::EndpointSerializer
-end

data/app/serializers/api/v1/webhooks/outgoing/endpoint_serializer.rb

@@ -1,14 +0,0 @@
-class Api::V1::Webhooks::Outgoing::EndpointSerializer < Api::V1::ApplicationSerializer
-  set_type "webhooks/outgoing/endpoint"
-
-  attributes :id,
-    :team_id,
-    :name,
-    :url,
-    :event_type_ids,
-    # 🚅 super scaffolding will insert new fields above this line.
-    :created_at,
-    :updated_at
-
-  belongs_to :team, serializer: Api::V1::TeamSerializer
-end