zaikio-webhooks 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59f8182e718c5ded0c81a0fbde73afa950407aa3d0373922855cb2111e969190
-  data.tar.gz: aadae2eb05d434998fa6d4d94c2981d910a25ccda0bac5fe105a07a62c284678
+  metadata.gz: cf6756e5fa3c37dfe5d4aed4cc5566d3390071a8e00be34345db988175dd4906
+  data.tar.gz: 0a0ca2e2511ce82f4ec2505ca1389ced5062f23edaee106431162fa3d7cb93d2
 SHA512:
-  metadata.gz: 076bdcb6a097ddab10d2eeb18a55d088fa8f5976eea1f3d1be0e02cee53d2e4025a3de8f3f5ac76a1e4e1611a183098651d10f1af89c976af29f7948f0fc0048
-  data.tar.gz: 9828497a523bcdae0f946d2319de93381c894daf0b44c3490d2808b04220d3a66b2ef6f9dbb5bcbf5026850f94ca2c7d562ba66e89dfe0a8a636ac2b0e022de5
+  metadata.gz: 9945cb3f9ab6f0b08650ee1ca71e40c82c04e4f52844fe6774d46718361d22443b2d41c337b86e66de23ccb4e663768a0ad079c8da83929c6d93c45765b99270
+  data.tar.gz: b85e483c5e7fc506aaee90c171b62a336ab99e88d11ffbf9ff67f4257bc931768bcb1719e48aeba79c4e20f6fd0f6d0c36b266e757cbbf7e32fbb4df6e28cf31

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

@@ -5,9 +5,10 @@ module Zaikio
       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
@@ -29,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.3".freeze
+    VERSION = "0.0.8".freeze
   end
 end

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-webhooks
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
 - Zaikio GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-27 00:00:00.000000000 Z
+date: 2021-01-28 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
+        version: 5.0.0
   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
+        version: 5.0.0
 description: Handle incoming Zaikio loom webhooks
 email:
 - js@crispymtn.com
@@ -41,6 +35,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 +43,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 +59,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