zaikio-webhooks 0.0.4 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27fbeb3ce67b0e03b8215f4cd2344d30b3df01630ce95ccaa14b2d511be033c7
-  data.tar.gz: a980c357f59e5466edca94db1128aac9c8f0188dea3de2a733fef3dcf145e6f0
+  metadata.gz: 80a5c7439ef2f8e609deb2f93547dfe0fd1deee14ed4edb5ccbf8d64c47805b0
+  data.tar.gz: 0b364bfdce4a6aa78a49baabae4a6e91761fafd2d02fad86bbceb90f669c8ac9
 SHA512:
-  metadata.gz: 84738f12afd7bb68e76cc82526c406c1aeb63f4ae57312a31f5ed7abc49ff9f52c7fc0391271ea1cba921dae0b6d80c3b63d379fc39a96fb4811ca7c88481cd3
-  data.tar.gz: 89c6e95be27de8d33c6e6b9aaef7ebe6d9bc8d732142ba5f27ec78e96dac461447aeb9c98eeae26e2f9aa5b321c2086d9cb3e83232d9a6b9a246494e92151ef8
+  metadata.gz: 52b6fc351a564085b841cef8bf9a4c9a122abfb8619ed34eb418c6cec94e5435f7782d72a3f2024e5b183cf6586cdc1fe4d8bf0f35de7b0928e203b6cd7603ac
+  data.tar.gz: 58c166ae90fbac2c41022ceb833c8734f976c996394502f6f04addd8e5ab5a1b8373d7f0a666e2c9d09b76804d0e7ca75d26e154bc33cdcaed2326881e944484

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,44 @@ 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.
+
+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
+```
+
+## 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

@@ -30,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

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.4".freeze
+    VERSION = "0.0.9".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-webhooks
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.9
 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
@@ -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