chook 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b631aba4dbfb2011eb6abea5d062777d8ac7c647036feab40a7ba5ba92e2c27c
-  data.tar.gz: 7376d389c06770904df9f37703e5be350dbf9c320e78c7939f6d3f76ce8e6887
+  metadata.gz: 1c4ec862f7ad2fdbbc49daeb67862dd096a7524be67a5d5901e1d948a7857ae2
+  data.tar.gz: 3da70bf1d76edbf10371abc819b645e3620bd259a7973d9bdc39e71be74f95b1
 SHA512:
-  metadata.gz: 07d7bfbe3723f6ce659b13e8cfcfe38b5d3fcc2e7b6ed2db6360ef087448a7eed36129f642efe58e845a73399e2227cabe8bd62e5ade6a9627068d65060af727
-  data.tar.gz: eb3b1fbf06ba0b915b9914bba71afbd81235bf77a8f5b8eed8f4e57f7c29490753e12eb0247bbe9572bbfa7ed7a79bf5fc96df1664f148246529346e400c1a49
+  metadata.gz: 1a81f5307c33b300e307a28fa59bfd008f1513d1b135c46855a4f0a41b8033269b346790d65f3c168423bb5c363cb17e04062b780ef73b3190b05e59b3e48339
+  data.tar.gz: 81fb57becdf2dc470be52fc287b955ccf6cbbb72dd5cab955924b925ff2cfc66d1d2c2dad35cfd7bdbdbc9f4cf0c7eb410100f939b2ffdad78a47a82e8b1bad2

data/CHANGES.md

@@ -1,5 +1,17 @@
 # Chook Change Log
 
+## v 1.1.2,  2019-01-24
+
+- code cleanup & bugfixes
+
+- thread ids show up in debug logging
+
+- go back to calling Thread.new explicitly, so that the JSS gets immediate acknowlegment of reciept of the POST
+
+- don't use sessions for the event-handling route
+
+- update README.md to be more server focused, since thats the primary use of Chook
+
 ## v 1.1.1,  2018-10-18
 
 - Admin web page authentication is now separated from Webhooks HTTP Basic Auth.

data/README.md

@@ -29,10 +29,9 @@ Chook also provides a simple [sinatra](http://sinatrarb.com/)-based HTTP server
 
 **You do not need to be a Ruby developer to use Chook!**
 
-The Chook webhook handling server can use "Event Handlers" written in
-any language. See below for more information.
+The Chook webhook handling server can use "Event Handlers" written in any language. See below for more information.
 
-Although Chook integrates well with [ruby-jss](http://pixaranimationstudios.github.io/ruby-jss/index.html), especially for processing webjook events,
+Although Chook integrates well with [ruby-jss](http://pixaranimationstudios.github.io/ruby-jss/index.html), especially for processing webhook events,
 it's a separate tool. However, ruby-jss is required when using Jamf-based admin page authentication, or using sampling features to generate TestEvents.
 
 For more detail about the Jamf Pro Webhooks API and the JSON data it passes, please see
@@ -387,33 +386,31 @@ Watch the Chook log, with the level at info or debug, to see events come in.
 
 ## The Framework
 
-The Chook framework abstracts webhook Events and their components as Ruby
-classes. When the JSON payload of a JSS webhook POST request is passed into the
-`Chook::Event.parse_event` method, an instance of the appropriate subclass of
-`Chook::Event` is returned, for example
-`Chook::Event::ComputerInventoryCompletedEvent`
+While most folks will get along fine using the chook server and writing handlers, the server is built upon a framework implemented in the `Chook` ruby module, available after doing`require 'chook'`. For those with very specific needs, this framework can be used to implement your own webhook handling service, or to simulate a JamfPro server sending webhook events to some handling service.
 
-Each Event instance contains these important attributes:
+The Chook framework abstracts webhook Events and their components as Ruby classes, grouped in two namespaces: HandledEvents, and TestEvents.
 
-* **webhook_id:** A read-only instance of the webhook ID stored in the JSS
+When the JSON payload of a JSS webhook POST request is passed into the `Chook::Event.parse_event` method, an instance of the appropriate subclass of `Chook::Event` is returned, for example, given the JSON for a ComputerInventoryCompleted webhook event, a `Chook::Event::ComputerInventoryCompletedEvent` instance is returned by `Chook::Event.parse_event`.
+
+Each such event instance contains these important attributes:
+
+* **webhook_id:** The webhook ID stored in the JSS
   which caused the POST request. This attribute matches the "webhook[:id]"
-  dictionary of the POSTed JSON.
+  value of the POSTed JSON.
 
 * **webhook_name:** A read-only instance of the webhook name stored in the JSS
   which caused the POST request. This attribute matches the "webhook[:name]"
-  dictionary of the POSTed JSON.
+  value of the POSTed JSON.
 
 * **subject:** A read-only instance of a `Chook::Subject::<Class>`
   representing the "subject" that accompanies the event that triggered the
-  webhook. It comes from the "event" dictionary of the POSTed JSON, and
+  webhook. It comes from the "event" object of the POSTed JSON, and
   different events come with different subjects attached. For example, the
   ComputerInventoryCompleted event comes with a "computer" subject containing
   data about the JSS computer that completed inventory.
 
-  This is not full `JSS::Computer` object from the REST API, but rather a group
-  of named attributes about that computer. At the moment, only the Chook Samplers
-  module attempts to look up subject data from the API, but any
-  Handlers written for the event could easily do a similar operation.
+  This is not a ruby-jss `JSS::Computer` object from the REST API, but rather a group
+  of named attributes about that computer.
 
 * **event_json:** The JSON content from the POST request, parsed into
   a Ruby hash with symbolized keys (meaning the JSON key "deviceName" becomes
@@ -422,17 +419,19 @@ Each Event instance contains these important attributes:
 * **raw_json:** A String containing the raw JSON from the POST
   request.
 
-* **handlers:** An Array of custom plug-ins for working with the
-  event. See _Event Handlers_, below.
-
-
-
 ### Events and Subjects
 
 Here are the Event classes supported by the framework and the Subject classes
 they contain.
-For details about the attributes of each Subject, see [The Unofficial JSS API
-Docs](https://unofficial-jss-api-docs.atlassian.net/wiki/display/JRA/Webhooks+API).
+
+For details about the attributes of each Subject, see [the Jamf Developer documentation](https://developer.jamf.com/webhooks).
+
+**A special note about Subjects**
+
+In Jamf's documentation, what Chook refers to as a 'Subject' is
+called an 'event object' because it is a JSON 'object' (a.k.a. dictionary, hash, associative array)
+labeled 'event'. We've chosen the word 'subject' to make talking about this thing a
+bit more clear in the context of object-oriented programming.
 
 Each Event class is a subclass of `Chook::Event`, where all of their
 functionality is defined.
@@ -504,4 +503,4 @@ Ruby code.
 ## TODOs
 
 - Better YARD docs
-- Proper documentation beyond this README
+- more documentation beyond this README

data/lib/chook/event/handled_event.rb

@@ -138,14 +138,19 @@ module Chook
       "Processed by #{handlers.count} handlers"
     end # def handle
 
+    # TODO: these threads will die midstream when the server stops.
+    # Find a way to .join them or otherwise clean them up.
+
     def pipe_to_executable(handler)
       logger.debug "EXTERNAL: Sending JSON to stdin of '#{handler.basename}'"
-      IO.popen([handler.to_s], 'w') { |h| h.puts @raw_json }
+      _thread = Thread.new do
+        IO.popen([handler.to_s], 'w') { |h| h.puts @raw_json }
+      end
     end
 
     def handle_with_proc(handler)
       logger.debug "INTERNAL: Running Handler defined in #{handler.handler_file}"
-      handler.handle self
+      _thread = Thread.new { handler.handle self }
     end
 
     def logger

data/lib/chook/server.rb

@@ -84,7 +84,11 @@ module Chook
         enable :static
         enable :sessions
         set :sessions, expire_after: Chook.config.admin_session_expires if Chook.config.admin_user
-        enable :lock unless Chook.config.concurrency
+        if Chook.config.concurrency
+          set :threaded, true
+        else
+          enable :lock
+        end
       end # configure
 
       Chook::HandledEvent::Handlers.load_handlers

data/lib/chook/server/routes/handle_webhook_event.rb

@@ -43,13 +43,18 @@ module Chook
       else
 
         event.logger.info "START From #{request.ip}, WebHook '#{event.webhook_name}' (id: #{event.webhook_id})"
-
-        event.logger.debug "JSON: #{raw_json}"
+        event.logger.debug "Thread id: #{Thread.current.object_id}; JSON: #{raw_json}"
 
         result = event.handle
 
         event.logger.info "END #{result}"
       end
+
+      # this route shouldn't have a session expiration
+      # And when it does, the date format is wrong, and the
+      # JAMFSoftwareServerLog complains about it for every
+      # webhook sent.
+      env['rack.session.options'].delete :expire_after
       result
     end # post
 

data/lib/chook/version.rb

@@ -27,6 +27,6 @@
 module Chook
 
   ### The version of the Chook framework
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.1.2'.freeze
 
 end # module

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chook
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Chris Lasell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-18 00:00:00.000000000 Z
+date: 2019-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -180,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: A Ruby framework for simulating and processing Jamf Pro Webhook Events