zaikio-webhooks 0.0.5 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0284963ea43cfb186d4f911a8ae0ac18bf5f4d79ce7ed9171f16b39ab31a27b6'
-  data.tar.gz: a428431616525d08df2219592481f335a1e79aaabf0f72ac5a9c8ac85db1b89f
+  metadata.gz: c1e4bb1dfafbb05d683f49875dfd21bec26c616a4e526e3e2d2c0de5cd2b1871
+  data.tar.gz: 198c277707f4f25d9a76c69a16f23d15b59b22bf46041748adb1f685ee9e2409
 SHA512:
-  metadata.gz: 26bd963797a01f76f803f40dd1480fff156783423f8441a0cf6161c14955fe664cfbeda545a0d45bf1f88d31d456a9aee9f67e7493321e55fac09ca2a0b82385
-  data.tar.gz: c98a228af1b46b23e836f7f39da6fa9c6fe08d815e129881af15e323182232a8b3f5e18612da09f140bc353e4b8b336c081da15cd192529cbf6dd135e136a221
+  metadata.gz: 97c1264c19fce2edd41dcc3055a7ac6f02951b7a8c2806f60bf59c40831af2d40452adf3fcbf489892cfee56523ccd39114a3135f826463332a09b354dbc7624
+  data.tar.gz: 6993041564dbae221625fc61fa916381d4838958fca8ece7dfea4ca8eb410e4ab06d31e4410dbfad20bd166acbab90fe56d121ae34d19ce5af1ce8b213b31e17

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,38 @@ 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.
+
+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/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,7 +5,8 @@ module Zaikio
     class Event
       extend Forwardable
       attr_reader :data
-      def_delegators :data, :id, :name, :version, :payload, :link, :to_h
+
+      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/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module Webhooks
-    VERSION = "0.0.5".freeze
+    VERSION = "0.0.10".freeze
   end
 end

metadata

@@ -1,17 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-webhooks
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.10
 platform: ruby
 authors:
 - Zaikio GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-30 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: actionpack
+  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
+- !ruby/object:Gem::Dependency
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -51,10 +71,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 +85,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