zaikio-webhooks 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 700f3b9cfc90a117b10f49b5cd68f442eee7172bea035e93643f02eeed281e0a
-  data.tar.gz: 6c3521ef64b8b4470751c434478790691f56ca75ef86d2ae7132f46f0ec6039b
+  metadata.gz: e420117c2009934fc5c4ee8281ee573524049248150d8736f186873058f285ea
+  data.tar.gz: fca8d5cce41d584140ee826923f0bf953964dc9c391d5fc15859260943ae8f13
 SHA512:
-  metadata.gz: 2ec2242f7d98d23143fb8ee0c7e7f23839a08ea1321d3a7228d8be3c205862e793aa4f3825b608b9c9afb627ec129d6ef98ffec9ec32b25a69beedcd50be9a6b
-  data.tar.gz: eace6be670f3a34c57abb6d6685825461419b08d69db387dcfea13d6df7a616f09e6b2b7bf693758c502afa98fe9e2dee86216c268fc4c97cbb0247808bbefc3
+  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
@@ -83,3 +76,41 @@ end
 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/lib/zaikio/webhooks.rb

@@ -1,3 +1,4 @@
+require "active_support/core_ext/integer/time"
 require "zaikio/webhooks/configuration"
 require "zaikio/webhooks/event"
 require "zaikio/webhooks/event_serializer"

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,6 +5,7 @@ module Zaikio
     class Event
       extend Forwardable
       attr_reader :data
+
       def_delegators :data, :id, :name, :version, :payload, :link, :client_name, :to_h
 
       def initialize(event_data)

data/lib/zaikio/webhooks/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module Webhooks
-    VERSION = "0.0.6".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.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Zaikio GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2021-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -51,10 +51,12 @@ files:
 - 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:
@@ -63,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