bullet_train-incoming_webhooks 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aaf006ee340bd3aa56fd1d12da9ffe5a5ccf243ba82a26c96dc42000ee1656c2
+  data.tar.gz: 16bbc201336d1c2d4c2246db610003ba4595ffa92f993f4bbb737dbc86e0e4ad
+SHA512:
+  metadata.gz: 53d19ad28cb04c5482cdaf6e839c95a91295e9ea729a1e32b9749f9926c16f223386304f81a20acfeff49f7849c027f206e21f623a627145f9afa1dc939bb076
+  data.tar.gz: 3d855fe54addd2a7c98fd4e8dc0ad7b3da98b42c0b22b4d35a5288f5e43cfd217295e7e02a1811fbe037215b5df944e1371571081b4ec116605abfd4f4efc78b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 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/README.md

@@ -0,0 +1,28 @@
+# BulletTrain::IncomingWebhooks
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "bullet_train-incoming_webhooks"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install bullet_train-incoming_webhooks
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/webhooks/incoming/bullet_train_webhooks_controller.rb

@@ -0,0 +1,6 @@
+class Webhooks::Incoming::BulletTrainWebhooksController < Webhooks::Incoming::WebhooksController
+  def create
+    Webhooks::Incoming::BulletTrainWebhook.create(data: JSON.parse(request.body.read)).process_async
+    render json: {status: "OK"}, status: :created
+  end
+end

data/app/controllers/webhooks/incoming/webhooks_controller.rb

@@ -0,0 +1,4 @@
+class Webhooks::Incoming::WebhooksController < ApplicationController
+  skip_before_action :verify_authenticity_token
+  layout false
+end

data/app/jobs/webhooks/incoming/webhook_processing_job.rb

@@ -0,0 +1,7 @@
+class Webhooks::Incoming::WebhookProcessingJob < ApplicationJob
+  queue_as :default
+
+  def perform(webhook)
+    webhook.verify_and_process
+  end
+end

data/app/models/webhooks/incoming/bullet_train_webhook.rb

@@ -0,0 +1,26 @@
+class Webhooks::Incoming::BulletTrainWebhook < ApplicationRecord
+  include Webhooks::Incoming::Webhook
+  include Rails.application.routes.url_helpers
+
+  # there are many ways a service might ask you to verify the validity of a webhook.
+  # whatever that method is, you would implement it here.
+  def verify_authenticity
+    # trying to fix integration tests. if this fixes it, i don't know why puma won't accept another connection here.
+    return true if Rails.env.test?
+
+    uri = URI.parse(api_v1_webhooks_outgoing_event_url(data["event_id"]))
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true if uri.scheme == "https"
+    request = Net::HTTP::Get.new(uri.path)
+    request.add_field("Content-Type", "application/json")
+    # TODO We need to adjust the way we set up authentication here.
+    # request.basic_auth ENV["BULLET_TRAIN_API_KEY"], ENV["BULLET_TRAIN_API_SECRET"]
+    response = http.request(request)
+
+    # ensure that the payload on the server is the same as the payload we received.
+    JSON.parse(response.body) == data
+  end
+
+  def process
+  end
+end

data/app/models/webhooks/incoming/webhook.rb

@@ -0,0 +1,32 @@
+module Webhooks::Incoming::Webhook
+  def verify_authenticity
+    raise "you must either implement `verify_authenticity` in #{self.class.name} or perform verification and set `verified_at` in #{self.class.name}sController."
+  end
+
+  def verified?
+    unless verified_at
+      touch(:verified_at) if verify_authenticity
+    end
+    verified_at.present?
+  end
+
+  def process_async
+    Webhooks::Incoming::WebhookProcessingJob.perform_later(self)
+  end
+
+  def processed?
+    processed_at.present?
+  end
+
+  def mark_processed
+    touch(:processed_at)
+  end
+
+  def verify_and_process
+    return if processed?
+    if verified?
+      process
+      mark_processed
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/bullet_train/incoming_webhooks/engine.rb

@@ -0,0 +1,6 @@
+module BulletTrain
+  module IncomingWebhooks
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/bullet_train/incoming_webhooks/version.rb

@@ -0,0 +1,5 @@
+module BulletTrain
+  module IncomingWebhooks
+    VERSION = "1.0.0"
+  end
+end

data/lib/bullet_train/incoming_webhooks.rb

@@ -0,0 +1,8 @@
+require "bullet_train/incoming_webhooks/version"
+require "bullet_train/incoming_webhooks/engine"
+
+module BulletTrain
+  module IncomingWebhooks
+    # Your code goes here...
+  end
+end

data/lib/tasks/bullet_train/incoming_webhooks_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :bullet_train_incoming_webhooks do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: bullet_train-incoming_webhooks
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrew Culver
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+description: Bullet Train Incoming Webhooks
+email:
+- andrew.culver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/bullet_train_incoming_webhooks_manifest.js
+- app/controllers/webhooks/incoming/bullet_train_webhooks_controller.rb
+- app/controllers/webhooks/incoming/webhooks_controller.rb
+- app/jobs/webhooks/incoming/webhook_processing_job.rb
+- app/models/webhooks/incoming/bullet_train_webhook.rb
+- app/models/webhooks/incoming/webhook.rb
+- config/routes.rb
+- lib/bullet_train/incoming_webhooks.rb
+- lib/bullet_train/incoming_webhooks/engine.rb
+- lib/bullet_train/incoming_webhooks/version.rb
+- lib/tasks/bullet_train/incoming_webhooks_tasks.rake
+homepage: https://github.com/bullet-train-co/bullet_train-incoming_webhooks
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bullet-train-co/bullet_train-incoming_webhooks
+  source_code_uri: https://github.com/bullet-train-co/bullet_train-incoming_webhooks
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Bullet Train Incoming Webhooks
+test_files: []