zaikio-webhooks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5bb848ff135992c72aa0b2a6d51478644a2d75540ea64844b971f9008c8d6a77
+  data.tar.gz: ce31b188140afc2fd67a8abf661198ef6653ca8effd9f83f6881da052d74e7ff
+SHA512:
+  metadata.gz: 55f9724010b083168d0673dac2a7e5260ac942ab137d2e7e30a7ca5c0cf85a1c1828d778a8495f63558e98315006069472f6c9ad8c11792c545174b8f58fce00
+  data.tar.gz: d38e8ca4638c8cd650a2c6e69340cbe928170582b5ac028a03f0f0cd9da7fb20a8156c6adbd3b2cfdd57292cc16d42b81b6609ac086e55fbf4796d4546858a66

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Zaikio GmbH
+
+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,79 @@
+# Zaikio::Webhooks
+
+Gem that enables you to easily subscribe to Zaikio's webhooks. It also enables other gems to subscribe to events.
+
+## Installation
+
+### 1. Add this line to your application's Gemfile:
+
+```ruby
+gem 'zaikio-webhooks'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install zaikio-webhook
+```
+
+### 2. Configure the gem:
+
+```rb
+# config/initializers/zaikio_webhooks.rb
+
+Zaikio::Webhooks.configure do |config|
+  config.register_client :my_app do |my_app|
+    my_app.shared_secret = "test-secret"
+  end
+
+  config.register_client :my_other_app do |my_other_app|
+    my_other_app.shared_secret = "test-secret"
+  end
+end
+
+# Perform job immediately, for all clients
+Zaikio::Webhooks.on "directory.revoked_access_token", RevokeAccessTokenJob,
+                    perform_now: true
+# Only for a specific client
+Zaikio::Webhooks.on "directory.machine_added", AddMachineJob,
+                    client_name: :my_app
+```
+
+### 3. Mount Engine
+
+```rb
+mount Zaikio::Webhooks::Engine => "/zaikio/webhook"
+```
+
+The final webhook URL will be:
+
+```
+https://mydomain.de/zaikio/webhook/:client_name
+```
+
+### 4. Configure ActiveJob
+
+It is recommended to configure background processing, if not all events are performed immediately. Read the [ActiveJob Rails Guide](https://guides.rubyonrails.org/active_job_basics.html) for more details.
+
+### 5. Setup Custom Jobs
+
+Every webhook callback expects one job. The job receives the event with useful attributes:
+
+```rb
+class AddMachineJob < ApplicationJob
+  def perform(event)
+    event.id # UUID
+    event.name # directory.machine_added
+    event.subject_type # Organization
+    event.subject_id # UUID of the subject
+    event.link # optional URL
+    event.payload # Hash with the payload data
+    event.created_at # DateTime
+    event.received_at # DateTime
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+require 'rubocop/rake_task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Zaikio::Webhook'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+namespace :test do
+  desc 'Runs RuboCop on specified directories'
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.fail_on_error = false
+  end
+end
+
+Rake::Task[:test].enhance ['test:rubocop']

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

@@ -0,0 +1,35 @@
+module Zaikio
+  module Webhooks
+    class WebhooksController < ApplicationController
+      before_action :verify_signature
+
+      def receive_event
+        Zaikio::Webhooks.webhooks_for(params[:client_name], event_params[:name]).each do |webhook|
+          webhook[:job_klass].public_send(webhook[:perform_now] ? :perform_now : :perform_later,
+                                          Zaikio::Webhooks::Event.new(event_params))
+        end
+
+        head :ok
+      end
+
+      private
+
+      def client_configuration
+        Zaikio::Webhooks.configuration.find!(params[:client_name])
+      end
+
+      def verify_signature
+        unless ActiveSupport::SecurityUtils.secure_compare(
+          OpenSSL::HMAC.hexdigest("SHA256", client_configuration.shared_secret, request.body.read),
+          request.headers["X-Loom-Signature"].to_s
+        )
+          head :ok
+        end
+      end
+
+      def event_params
+        params.permit(:id, :name, :subject, :timestamp, :version, :link, :received_at, payload: {})
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Zaikio::Webhooks::Engine.routes.draw do
+  post "/:client_name", to: "webhooks#receive_event", as: :root
+end

data/lib/tasks/zaikio/webhook_tasks.rake

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

data/lib/zaikio/webhooks/client_configuration.rb

@@ -0,0 +1,9 @@
+require "logger"
+
+module Zaikio
+  module Webhooks
+    class ClientConfiguration
+      attr_accessor :shared_secret
+    end
+  end
+end

data/lib/zaikio/webhooks/configuration.rb

@@ -0,0 +1,32 @@
+require "logger"
+require "zaikio/webhooks/client_configuration"
+
+module Zaikio
+  module Webhooks
+    class Configuration
+      attr_writer :logger
+      attr_reader :client_configurations
+
+      def initialize
+        @client_configurations = {}
+      end
+
+      def logger
+        @logger ||= Logger.new(STDOUT)
+      end
+
+      def register_client(name)
+        @client_configurations[name.to_s] ||= ClientConfiguration.new
+        yield(@client_configurations[name.to_s])
+      end
+
+      def find!(name)
+        @client_configurations[name.to_s] or raise ActiveRecord::RecordNotFound
+      end
+
+      def all_client_names
+        client_configurations.keys
+      end
+    end
+  end
+end

data/lib/zaikio/webhooks/engine.rb

@@ -0,0 +1,9 @@
+module Zaikio
+  module Webhooks
+    class Engine < ::Rails::Engine
+      isolate_namespace Zaikio::Webhooks
+      engine_name "zaikio_webhooks"
+      config.generators.api_only = true
+    end
+  end
+end

data/lib/zaikio/webhooks/event.rb

@@ -0,0 +1,35 @@
+require "ostruct"
+
+module Zaikio
+  module Webhooks
+    class Event
+      extend Forwardable
+      attr_reader :data
+      def_delegators :data, :id, :name, :version, :payload, :link
+
+      def initialize(event_data)
+        @data = OpenStruct.new(event_data)
+      end
+
+      def created_at
+        DateTime.parse(data.timestamp)
+      end
+
+      def received_at
+        DateTime.parse(data.received_at)
+      end
+
+      def subject_id
+        data.subject.split("/").last
+      end
+
+      def subject_type
+        data.subject.split("/").first == "Org" ? "Organization" : "Person"
+      end
+
+      def ==(other)
+        data == other.data
+      end
+    end
+  end
+end

data/lib/zaikio/webhooks/version.rb

@@ -0,0 +1,5 @@
+module Zaikio
+  module Webhooks
+    VERSION = "0.0.1".freeze
+  end
+end

data/lib/zaikio/webhooks.rb

@@ -0,0 +1,38 @@
+require "zaikio/webhooks/configuration"
+require "zaikio/webhooks/event"
+require "zaikio/webhooks/engine"
+
+module Zaikio
+  module Webhooks
+    class << self
+      attr_accessor :configuration
+
+      def configure
+        self.configuration ||= Configuration.new
+        yield(configuration)
+      end
+
+      def reset
+        @webhooks = {}
+      end
+
+      def webhooks_for(client_name, event_name)
+        (@webhooks.dig(client_name.to_s, event_name.to_s) || [])
+      end
+
+      def on(event_name, job_klass, client_name: nil, perform_now: false)
+        @webhooks ||= {}
+
+        client_names = Array(client_name || configuration.all_client_names).map(&:to_s)
+        client_names.each do |name|
+          @webhooks[name] ||= {}
+          @webhooks[name][event_name.to_s] ||= []
+          @webhooks[name][event_name.to_s] << {
+            perform_now: perform_now,
+            job_klass: job_klass
+          }
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: zaikio-webhooks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zaikio GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.2
+description: Handle incoming Zaikio loom webhooks
+email:
+- js@crispymtn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/zaikio/webhooks/webhooks_controller.rb
+- config/routes.rb
+- lib/tasks/zaikio/webhook_tasks.rake
+- lib/zaikio/webhooks.rb
+- lib/zaikio/webhooks/client_configuration.rb
+- lib/zaikio/webhooks/configuration.rb
+- lib/zaikio/webhooks/engine.rb
+- lib/zaikio/webhooks/event.rb
+- lib/zaikio/webhooks/version.rb
+homepage: https://www.zaikio.com/
+licenses:
+- MIT
+metadata: {}
+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.1.2
+signing_key: 
+specification_version: 4
+summary: Handle incoming Zaikio loom webhooks
+test_files: []