zaikio-webhooks 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0ee2ef247126427165c340256d3cfba655163fb972af0ca7432325b458dc66c
-  data.tar.gz: c46971db7afb01ad0737eb944b8c3436fe1a06428663a0ffb5443fc270743582
+  metadata.gz: e420117c2009934fc5c4ee8281ee573524049248150d8736f186873058f285ea
+  data.tar.gz: fca8d5cce41d584140ee826923f0bf953964dc9c391d5fc15859260943ae8f13
 SHA512:
-  metadata.gz: 7aba2a560667865fbc588bc096fa042db1a5f7436ff962d34f63ece00ca7ac98798346f390b0fc03ea5f7f59cfc9fb8fc741807d6ef0f6fe9a9549bc7874b415
-  data.tar.gz: b970e85c1793d09f67e6fa6b691aae310e1d6f17f9fc8c5c14903321d22d8e2484ec22ab9d321d123814f638cfbfb57596ab821f8c0e5e80e541ddf29d94d95a
+  metadata.gz: 2ac964b2e38bf3545881626c30ba5b5832e2fb0183ab45a90d8e839b7d36533537337085fe5622388529e97e9ef529c6d38bdd3c6ac7deb10ac639f717c0b70f
+  data.tar.gz: 8cbbb481eafb8d6e853351fde476ec0db1b7716013a49d7aa106be96eefee3630743f0e30a7fe16cf3f7fd0865a3eaf0d81cecdf8efc0c2a0230a8fd4edd69d5

data/README.md

@@ -34,13 +34,6 @@ Zaikio::Webhooks.configure do |config|
     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
@@ -77,3 +70,47 @@ class AddMachineJob < ApplicationJob
   end
 end
 ```
+
+### 6. Add Webhook URL to Zaikio Hub
+
+Login to [Zaikio Hub](https://directory.zaikio.com/) and go to your Apps and go to Edit App and add your webhook URL e.g. `https://mydomain.de/zaikio/webhook/my_app_name`.
+
+Now you should receive all events you subscribed to.
+
+### 7. Usage
+
+When everything is set up you can register events with custom jobs, using the
+`Zaikio::Webhooks.on` function. This is idempotent and can be safely re-executed.
+
+For Rails 6.0 and above, we can setup an initializer like so:
+
+```rb
+# config/initializers/zaikio_webhooks.rb
+
+# We need to add this special wrapper here because we're referencing autoloaded constants
+# (RevokeAccessTokenJob, AddMachineJob) at boot time. For more information, see:
+# https://guides.rubyonrails.org/autoloading_and_reloading_constants.html#autoloading-when-the-application-boots
+Rails.application.reloader.to_prepare do
+  # 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
+end
+```
+
+If you're using a Rails v5.2 or less, you can skip the outer `Rails.application.reloader`
+block and just use the inner section directly.
+
+## Contributing
+
+- Make your changes and submit a pull request for them
+- Make sure to update `CHANGELOG.md`
+
+To release a new version of the gem:
+- Update the version in `lib/zaikio/webhooks/version.rb`
+- Update `CHANGELOG.md` to include the new version and its release date
+- Commit and push your changes
+- Create a [new release on GitHub](https://github.com/zaikio/zaikio-webhooks/releases/new)
+- CircleCI will build the Gem package and push it Rubygems for you

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

@@ -1,12 +1,14 @@
 module Zaikio
   module Webhooks
     class WebhooksController < ApplicationController
+      skip_before_action :verify_authenticity_token
       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))
+        Zaikio::Webhooks.webhooks_for(params[:client_name], event_params[:name])
+                        .each do |job_klass, options|
+          job_klass.public_send(options[:perform_now] ? :perform_now : :perform_later,
+                                Zaikio::Webhooks::Event.new(event_params))
         end
 
         head :ok
@@ -28,7 +30,8 @@ module Zaikio
       end
 
       def event_params
-        params.permit(:id, :name, :subject, :timestamp, :version, :link, :received_at, payload: {})
+        params.permit(:id, :client_name, :name, :subject, :timestamp,
+                      :version, :link, :received_at, payload: {})
       end
     end
   end

data/config/initializers/register_zaikio_webhooks_event_serializer.rb

@@ -0,0 +1 @@
+Rails.application.config.active_job.custom_serializers << Zaikio::Webhooks::EventSerializer

data/lib/zaikio/webhooks.rb

@@ -1,5 +1,7 @@
+require "active_support/core_ext/integer/time"
 require "zaikio/webhooks/configuration"
 require "zaikio/webhooks/event"
+require "zaikio/webhooks/event_serializer"
 require "zaikio/webhooks/engine"
 
 module Zaikio
@@ -30,7 +32,7 @@ module Zaikio
       end
 
       def webhooks_for(client_name, event_name)
-        (@webhooks.dig(client_name.to_s, event_name.to_s) || [])
+        (@webhooks.dig(client_name.to_s, event_name.to_s) || {})
       end
 
       def on(event_name, job_klass, client_name: nil, perform_now: false)
@@ -40,10 +42,9 @@ module Zaikio
           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
+            @webhooks[name][event_name.to_s] ||= {}
+            @webhooks[name][event_name.to_s][job_klass] = {
+              perform_now: perform_now
             }
           end
         end

data/lib/zaikio/webhooks/configuration.rb

@@ -12,7 +12,7 @@ module Zaikio
       end
 
       def logger
-        @logger ||= Logger.new(STDOUT)
+        @logger ||= Logger.new($stdout)
       end
 
       def register_client(name)

data/lib/zaikio/webhooks/event.rb

@@ -5,7 +5,8 @@ module Zaikio
     class Event
       extend Forwardable
       attr_reader :data
-      def_delegators :data, :id, :name, :version, :payload, :link
+
+      def_delegators :data, :id, :name, :version, :payload, :link, :client_name, :to_h
 
       def initialize(event_data)
         @data = OpenStruct.new(event_data)

data/lib/zaikio/webhooks/event_serializer.rb

@@ -0,0 +1,17 @@
+module Zaikio
+  module Webhooks
+    class EventSerializer < ActiveJob::Serializers::ObjectSerializer
+      def serialize?(argument)
+        argument.is_a? Event
+      end
+
+      def serialize(event)
+        super(event.to_h)
+      end
+
+      def deserialize(data)
+        Event.new(data)
+      end
+    end
+  end
+end

data/lib/zaikio/webhooks/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module Webhooks
-    VERSION = "0.0.2".freeze
+    VERSION = "0.0.7".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-webhooks
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.7
 platform: ruby
 authors:
 - Zaikio GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-27 00:00:00.000000000 Z
+date: 2021-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -41,6 +41,7 @@ files:
 - README.md
 - Rakefile
 - app/controllers/zaikio/webhooks/webhooks_controller.rb
+- config/initializers/register_zaikio_webhooks_event_serializer.rb
 - config/routes.rb
 - lib/tasks/zaikio/webhook_tasks.rake
 - lib/zaikio/webhooks.rb
@@ -48,11 +49,14 @@ files:
 - lib/zaikio/webhooks/configuration.rb
 - lib/zaikio/webhooks/engine.rb
 - lib/zaikio/webhooks/event.rb
+- lib/zaikio/webhooks/event_serializer.rb
 - lib/zaikio/webhooks/version.rb
-homepage: https://www.zaikio.com/
+homepage: https://github.com/zaikio/zaikio-webhooks
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/zaikio/zaikio-webhooks/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/zaikio/zaikio-webhooks
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -61,14 +65,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Handle incoming Zaikio loom webhooks