chook 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05defee2dbf9d0d71b7657d491ac8eebf3c87529d1de1077365a3a2e82cc48fe
-  data.tar.gz: 845d410b10290129a233915600cf57ca7c89a855b2d504cb5593da885e5eef8c
+  metadata.gz: b631aba4dbfb2011eb6abea5d062777d8ac7c647036feab40a7ba5ba92e2c27c
+  data.tar.gz: 7376d389c06770904df9f37703e5be350dbf9c320e78c7939f6d3f76ce8e6887
 SHA512:
-  metadata.gz: 153586d027c5c81d7ec5d0f0678d0c520879db7cef84cf3454134a4f7439601faa12463a3d227e7dd1ce6b561c18d4c95be781f39b2d0d787be742d5ea0b44fa
-  data.tar.gz: 10e36a024704ab54f38bfbfeec7f91da08a294c9a3d0c1b3c103d0aa924719045197a4f62e49ef4e4add8397004fc8578186d3c50ec03d53501839ac716384a5
+  metadata.gz: 07d7bfbe3723f6ce659b13e8cfcfe38b5d3fcc2e7b6ed2db6360ef087448a7eed36129f642efe58e845a73399e2227cabe8bd62e5ade6a9627068d65060af727
+  data.tar.gz: eb3b1fbf06ba0b915b9914bba71afbd81235bf77a8f5b8eed8f4e57f7c29490753e12eb0247bbe9572bbfa7ed7a79bf5fc96df1664f148246529346e400c1a49

data/CHANGES.md

@@ -1,21 +1,24 @@
 # Chook Change Log
 
+## v 1.1.1,  2018-10-18
+
+- Admin web page authentication is now separated from Webhooks HTTP Basic Auth.
+  It can be turned off completely, set to a single username/password, or pointed
+  at a Jamf Pro server for admin authentication. See the Admin Interface section
+  of README.md, and/or chook.conf.example for details.
+
 ## v 1.1.0,  2018-10-15
 
 For details about the new features, please see README.md
 
 - Now requires 'thin' as the server engine.
 
-
 - Supports SSL and HTTP Basic Authentication
 
-
 - Server logging is now a thing, with access to logging from both internal and external handlers
 
-
 - A simple admin interface is available by pointing your browser at the chook server
 
-
 - Internal handlers are now stored as anonymous objects rather than Procs, and the handler code block
   is stored as an instance method on the object. This means that either 'break' or 'return' will work
   to exit a handler.

data/README.md

@@ -1,115 +1,189 @@
-
 # Chook
 
 Documentation is a work in progress. Please [get in touch](mailto:chook@pixar.com) for assistance. <3
 
 - [Introduction](#introduction)
 - [Installing Chook](#installing-chook)
-- [The Framework](#the-framework)
-  - [Event Handlers](#event-handlers)
-    - [Internal Handlers](#internal-handlers)
-    - [External Handlers](#external-handlers)
-  - [Putting It Together](#putting-it-together)
-  - [Events and Subjects](#events-and-subjects)
 - [The Server](#the-server)
-  - [Server Configuration](#server-configuration)
-  - [SSL](#ssl)
-  - [Logging](#logging)
-  - [Admin Interface](#admin-interface)
+	- [Server Configuration](#server-configuration)
+	- [SSL](#ssl)
+	- [Logging](#logging)
+	- [Admin Interface](#admin-interface)
+	- [Event Handlers](#event-handlers)
+  	- [Internal Handlers - Ruby](#internal-handlers-ruby)
+	  - [External Handlers - Any Language](#external-handlers-any-language)
+	  - [Logging from handlers](#logging-from-handlers)
   - [Pointing Jamf Pro at your Chook server](#pointing-jamf-pro-at-your-chook-server)
+- [The Framework](#the-framework)
+	- [Events and Subjects](#events-and-subjects)
+	- [Putting It Together](#putting-it-together)
 - [TODOs](#todos)
 
-
 ## Introduction
 
 Chook is a Ruby module that implements a framework for working with webhook events
-sent by the JSS, the core of [Jamf Pro](https://www.jamf.com/products/jamf-pro/),
-a management tool for Apple devices!
+sent by a [Jamf Pro](https://www.jamf.com/products/jamf-pro/) Server,
+a management tool for Apple devices.
 
-Chook also provides a simple, sinatra-based HTTP server for handling those Events,
-and classes for sending simulated TestEvents to a webhook handling server.
+Chook also provides a simple [sinatra](http://sinatrarb.com/)-based HTTP server for receiving and processing those Events, and classes for sending simulated TestEvents to any Jamf webhook handling server.
 
 **You do not need to be a Ruby developer to use Chook!**
 
-The webhook handling server that comes with Chook can use "Event Handlers" written in
-any language. See _Event Handlers_ and _The Server_ 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),
-it's a separate tool, and the two projects aren't dependent. However, ruby-jss
-does become a requirement when using sampling features to generate TestEvents.
+Although Chook integrates well with [ruby-jss](http://pixaranimationstudios.github.io/ruby-jss/index.html), especially for processing webjook 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 JSS webhooks API and the JSON data it passes, please see
+For more detail about the Jamf Pro Webhooks API and the JSON data it passes, please see
 [JAMF's developer reference.](http://developer.jamf.com/webhooks)
 
-**Note:** When creating webhooks from your JSS to be handled by the framework, you must
+**Note:** When enabling webhooks from your Jamf Pro server to be handled by the framework, you must
 specify JSON in the "Content Type" section. This framework does not support XML and
 will only generate Test Events in JSON format.
 
 
 ## Installing Chook
 
-`gem install chook -n /usr/local/bin`
+As with most Ruby gems:  `gem install chook -n /usr/local/bin`
 
-It will also install "sinatra" and "thin", and their dependencies.
+It will automatically install "sinatra" and "thin", and their dependencies.
 
-Then fire up `irb` and `require 'chook'` to start playing around.
+If you'll be using a Jamf Pro server to authenticate access to Chook's admin web page, or if you'll be generating Chook TestEvents using data sampled from a Jamf Pro server you'll also need to `gem install ruby-jss`
 
-OR
+## The Server
 
-run `/usr/local/bin/chook-server` and point some JSS webhooks at `http://my.computer.org/handle_webhook_event`
+Chook comes with a simple HTTP(S) server that uses the Chook framework
+to handle incoming webhook POST requests from a Jamf Pro server via a single URL `https://my.chookserver.org/handle_webhook_event`.
 
-## The Framework
+After Installing chook, just run `/usr/local/bin/chook-server` and then point your Jamf Pro webhooks at: http://my_hostname/handle_webhook_event
 
-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`
+It will then process incoming webhook POST requests using whatever handlers
+you have installed.
 
-Each Event instance contains these important attributes:
+To automate it on a dedicated Mac, just make a LaunchDaemon plist to run
+that command and keep it running.
 
-* **webhook_id:** A read-only instance of the webhook ID stored in the JSS
-  which caused the POST request. This attribute matches the "webhook[:id]"
-  dictionary of the POSTed JSON.
+### Server Configuration
 
-* **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.
+The Chook server looks for a config file at `/etc/chook.conf`. If not found, default
+values are used. Full descriptions of the config values are provided in the sample
+config file at:
+/path/to/your/gem/folder/chook-<version>/data/chook.conf.example
 
-* **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
-  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.
+Each config setting is on a single line like: `key: value`. Blank lines and those starting with # are ignored.
 
-  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.
+Here's a summary of possible configuration keys:
 
-* **event_json:** The JSON content from the POST request, parsed into
-  a Ruby hash with symbolized keys (meaning the JSON key "deviceName" becomes
-  the symbol :deviceName).
+ - port: The server port
+   - default = 443 (SSL), or 80 (no SSL)
+ - concurrency: Should events be processed simultaneously? (otherwise, one at a time)
+   - default = true
+ - handler_dir: The directory holding the event handler files to load.
+   - default = /Library/Application Support/Chook
+ - use_ssl: Should the server use SSL (https)
+   - default = false
+ - ssl_cert_path: If SSL is used, the path to the server certificate
+   - no default
+ - ssl_private_key_path: If SSL is used, the path to the certificate key
+   - no default
+ - log_file: The path to the server log file
+   - default = /var/log/chook-server.log
+ - log_level: The severity level for log entries
+   - default = info
+ - logs_to_keep: How many old log files to keep when rotating
+   - default = 10
+ - log_max_megs: How big can a log file get before it's rotated.
+   - default = 10
+ - webhooks_user: The username for Basic Authentication
+   - no default, leave unset for no authentication
+ - webhooks_user_pw: The file path, or command, to get the password for the webhooks_user.
+   - no default
+ - admin_user: the username for access to the Chook admin web page, or 'use_jamf'
+   - no default, leave unset for no authentication
+ - admin_pw: if the admin user is NOT 'use_jamf', The file path, or command, to get the password for the admin_user.
+   - no default
+ - admin_session_expires: How many seconds is an admin login valid?
+   - default: 86400 (24 hours)
+ - jamf_server: if admin_user is 'use_jamf', the Jamf Pro server to use for admin authentication
+   - default: none, but /etc/ruby-jss.conf is honored.
+ - jamf_port: if admin_user is 'use_jamf', the Jamf Pro server port to use for admin authentication
+   - default: none, but /etc/ruby-jss.conf is honored.
+ - jamf_use_ssl: if admin_user is 'use_jamf', use SSL to talk to the Jamf Pro server? true/false
+   - default: none, but /etc/ruby-jss.conf is honored.
+ - jamf_verify_cert: if admin_user is 'use_jamf', verify the SSL certificate from the Jamf Pro server?  true/false
+   - default: none, but /etc/ruby-jss.conf is honored.
+   -
+See the sample config file for details about all of these settings.
 
-* **raw_json:** A String containing the raw JSON from the POST
-  request.
+### SSL
 
-* **handlers:** An Array of custom plug-ins for working with the
-  event. See _Event Handlers_, below.
+It is recommended to use SSL (https) if possible for security, although its beyond the scope
+of this document to go into a lot of detail about SSL and certificates.  That said, here
+are some pointers:
+
+- The certificate and key files should be in .pem format
+
+- Make sure you use a certificate that can be verified by the JSS.
+  - This might involved adding a CA to the JSS's Java Keystore.
+
+- If running on macOS, the 'thin' webserver and it's underlying 'eventmachine' gem may not
+  like the OS's openssl replacement 'libressl'.
+  - One solution is to use [homebrew](https://brew.sh/) to install openssl and then
+    install eventmachine using that openssl, something like this:
+
+    `brew install openssl ; brew link openssl --force ; gem install eventmachine -- --with-ssl-dir=/usr/local/`
+
+### Logging
+
+The Chook server logs activity into the file defined in the `log_file` config setting,
+`/var/log/chook-server.log` by default.
+
+It uses a standard ruby [Logger](http://ruby-doc.org/stdlib-2.3.3/libdoc/logger/rdoc/index.html)
+instance, which provides 5 severity levels: fatal (lowest), error, warn, info, and debug (highest).
+
+The `log_level` config setting defines the level when the server starts up, and log
+messages of that level or lower will be written to the log.
+
+The log can automatically rotate when it reaches a certain size, as specified by the log_max_megs configuration setting, and the logs_to_keep settings tells chook how many it should keep in total - older log files will be deleted automatically.
+
+If you want to manage the log rotation on your own, set logs_to_keep to zero, or leave it unset,
+and the log will never automatically rotate.
+
+See below for how to write to the Chook log from within a handler
+
+### Admin Interface
 
+If you point your web browser at your Chook server `http(s)://your.chookserver.org/` , you'll see a simple admin interface.
+
+If an `admin_user` is set in the configuration, you'll need to provide that name and password, or if `admin_user` is `use_jamf` you'll need to provide the username and password of any Jamf Pro user on
+the server indicated in the config.
+
+The first section provides a live-stream of the server log file, and provides a way to
+change the server's log level on the fly. Note that this change affects the server itself
+not just the view in your browser. If you'd like to stop the stream temporarily (e.g. to
+scroll back, or select some text), just pause and unpause with the checkbox.
+
+The second section lets you see which handlers are currently loaded, and if they are
+internal or external. The (view) button shows the contents of the handler file.
+
+There's also a button to reload the handlers from the handler directory without restarting the server - useful when you add, delete, or modify them.
+
+The final section just shows your current /etc/chook.conf file, or if there is none,
+the sample config file is shown, since it shows the default values.
+
+The admin page cannot be used to edit or upload handlers or change the config. For security
+reasons, you must do that on the server machine itself though normal administrative methods.
 
 ### Event Handlers
 
-A handler is a file containing code to run when a webhook event occurs. These
+A handler is a file containing code to run when a webhook event is received. These
 files are located in a specified directory, `/Library/Application
-Support/Chook/` by default, and are loaded at runtime. It's up to the Jamf
-administrator to create these handlers to perform desired tasks. Each class of
-event can have as many handlers as desired, all will be executed when the event's
-`handle` method is called.
+Support/Chook/` by default, and are loaded when the server starts, or the (reload)
+button is clicked on the admin web page.
 
 Handler files must begin with the name of the event they handle, e.g.
-ComputerAdded, followed by: nothing, a dot, a dash, or an underscore. Handler
+`ComputerAdded`, followed by: nothing, a dot, a dash, or an underscore. Handler
 filenames are case-insensitive.
 
 All of these file names are valid handlers for ComputerAdded events:
@@ -119,18 +193,22 @@ All of these file names are valid handlers for ComputerAdded events:
 - COMPUTERAdded_notify_team
 - Computeradded-update-ldap
 
+Each kind of event can have as many handlers as desired, all will be executed when webhook event
+is recieved. If all four of the above files existed in the handler directory, every
+ComputerAdded event would run all four of them.
+
 There are two kinds of handlers, distinguished by their file-executability.
 
-#### Internal Handlers
+#### Internal Handlers - Ruby
 
 These handlers are _non-executable_ files containing Ruby code. The code is
-loaded at runtime and executed in the context of the Chook Framework when
-called by an event.
+loaded at runtime and executed as a thread in the Chook server process when
+a matching event is received.
 
 Internal handlers must be defined as a [ruby code block](http://rubylearning.com/satishtalim/ruby_blocks.html) passed to the
 `Chook.event_handler` method. The block must take one parameter, the
 Chook::Event subclass instance being handled. Here's a simple example of
-a handler for a Chook::ComputerAddedEvent
+a handler for a ComputerAdded webhook event.
 
 ```ruby
 Chook.event_handler do |event|
@@ -140,18 +218,19 @@ Chook.event_handler do |event|
 end
 ```
 
-The code block takes one parameter, which will be a Chook::ComputerAddedEvent instance,
-and in this example stores it in the variable "event."
+The code block, between `do` and `end`, takes one parameter which will be a Chook::HandledEvents::ComputerAddedEvent object. In this example the object is stored in the variable "event" and used inside the block.
 
-It then extracts the "deviceName" and "realName" values from the subject
+This handler then extracts the "deviceName" and "realName" values from the subject
 contained in the event, and uses them to log a message in the chook log.
 
+The subject of an event is the thing that the event affected. In the case of ComputerAdded events, the subject is a Computer. In Chook, it's an object of the class Chook::HandledSubjects::ComputerAdded.
+
 **NameSpacing**
 
 Be careful when writing internal handlers - they all run in the same Ruby process!
 
 Not only do they have to be thread-safe, but be wary of cluttering the default
-namespace with constants that might overwrite each other.
+namespace with constants or methods that might overwrite each other.
 
 A good, very ruby-like, practice is to put the guts of your code into a Module or a Class
 and use that from inside the handler definition. Here's an example using a Class:
@@ -165,18 +244,20 @@ class ComputerAdder
 
   def initialize(event)
     @event = event
-    @cname = @event.subject.deviceName
+    @comp_name = @event.subject.deviceName
+    @user_name = @event.subject.realName
   end
 
   def run
-    @event.logger.info "Adder Starting for computer #{@cname}"
+    @event.logger.info "Adder Starting for computer #{@comp_name}"
     notify_admins
-    @event.logger.info "Adder Finished for computer #{@cname}"
+    @event.logger.info "Adder Finished for computer #{@comp_name}"
   end
 
   def notify_admins
-    SlackEm.send message: "Computer '#{@cname}' was just added to the JSS for user #{@event.subject.realName}.", channel: SLACK_CHANNEL
-    @event.logger.debug "Admins notified about computer #{@cname}"
+    msg = "Computer '#{@comp_name}' was just enrolled for user #{@user_name}."
+    SlackEm.send message: msg, channel: SLACK_CHANNEL
+    @event.logger.debug "Admins notified about computer #{@comp_name}"
   end
 
 end
@@ -187,7 +268,7 @@ end
 ```
 
 Here, the handler file defines a 'ComputerAdder' class that does all the work.
-The handler block merely creates an instance of ComputerAdder with the event,
+The handler block merely creates an instance of ComputerAdder, passing it the event,
 and tells the ComputerAdder instance to run. The instance's run method can
 then perform any steps desired.
 
@@ -199,19 +280,21 @@ use ComputerAdder::SLACK_CHANNEL.
 This way, similar handlers can have their own SLACK_CHANNEL constants and
 there won't be any interference.
 
+For more details about event and subject classes, see [The Framework](#the-framework)
+
 NOTE: Internal handlers **must not** be executable files. Executability is how the
 framework determines if a handler is internal or external.
 
-#### External Handlers
+#### External Handlers - Any Language
 
 External handlers are _executable_ files that are executed when called by an
 event. They can be written in any language, but they must accept raw JSON on
 their standard input. It's up to them to parse that JSON and react to it as
-desired. In this case the Chook framework is merely a conduit for passing
-the Posted JSON to the executable program.
+desired. In this case the Chook server is merely a conduit for passing
+the Posted JSON from the Jamf Pro server to the executable program.
 
 Here's a simple example using bash and [jq](https://stedolan.github.io/jq/) to
-do the same as the first ruby example above:
+do something similar to the first ruby example above:
 
 ```bash
 #!/bin/bash
@@ -228,31 +311,121 @@ framework determines if a handler is internal or external.
 See `data/sample_handlers/RestAPIOperation-executable`
 for a more detailed bash example that handles RestAPIOperation events.
 
-### Putting It Together
+See the [Jamf Developer Site](https://developer.jamf.com/webhooks) for details about the JSON contents of webhook events.
 
-Here is a commented sample of ruby code that uses the framework to process a
-ComputerAdded Event:
+### Logging from handlers
+
+**Internal handlers**
+
+To write to the Chook log file from within an internal handler, use the `#logger` method of the `event` object
+inside the handler block, like so:
 
 ```ruby
-# load the framework
-require 'chook'
+Chook.event_handler do |event|
+  event.logger.debug "This line appears in the log if the level is debug"
+  event.logger.info "This line appears in the log if the level is info or debug"
+  event.logger.error "This line appears in the log if the level is error, warn, info, or debug"
+end
+```
 
-# The framework comes with sample JSON files for each Event type.
-# In reality, a webserver would extract this from the data POSTed from the JSS
-posted_json = Chook.sample_jsons[:ComputerAdded]
+If you want to log a Ruby exception with its backtrace, you can pass the entire
+exception to the event logger's  'log_exception' method like this:
+```ruby
+  begin
+    # something horribly wrong happens here
+  rescue => execption
+    event.logger.log_exception exception
+  end
+```
 
-# Create Chook::HandledEvents::ComputerAddedEvent instance for the event
-event = Chook::HandledEvent.parse_event posted_json
+Log entries written through event objects are preceded with `Event xxxxxxxxx:`  where xxxxxxxxx is
+an internal ID number for the specific even that wrote the entry.
+
+**External handlers**
+
+External Handlers can use a URL to make log entries by POSTing to `https://my.chookserver/log`
+
+The request body must be a JSON object wth 2 keys 'level' and 'message' where both values are strings.
+
+The 'level' must be one of the known log levels: fatal, error, warn, info, or debug. The message is a single line of text to be added to the log.
+
+If your chook server is using Basic Authentication for webhook events, it must be provided for logging also.
+
+Here's an example with curl, split to multi-line for clarity:
 
-# Call the events #handle method, which will execute any ComputerAdded
-# handlers that were in the Handler directory when the framework was loaded.
-event.handle
+```
+curl -u 'auth-user:auth-pw' \
+  -H 'Content-Type: application/json' \
+  -X POST \
+  --data '{"level":"debug", "message":"It Worked"}' \
+  https://chookserver.myorg.org/log
 ```
 
-Of course, you can use the framework without using the built-in #handle method,
-and if you don't have any handlers in the directory, it won't do anything
-anyway. Instead you are welcome to use the objects as desired in your own
-Ruby code.
+Messages logged via this url show up in the log preceded by `ExternalEntry: `
+
+Any info needed to indentify a log entry with a specific event must be included in
+your log message.
+
+### Pointing Jamf Pro at your Chook server
+
+Once your server is up and running, and you have a handler or two in place, you can create webhooks in your Jamf Pro interface:
+
+1. Navigate to Settings => Global Management => Webhooks
+2. Click "New"
+3. Give your webhook a display name
+4. Enter the URL for your Chook server, ending with 'handle_webhook_event', e.g:
+  - `http://my.chookserver.edu/handle_webhook_event`
+  - `https://my.chookserver.edu:8443/handle_webhook_event`
+5. If you use Basic Authentication, enter the name and password
+6. The default timeouts should be OK, but raise them a bit if you're experiencing errors.
+7. Set the content type to JSON
+8. Select the event that triggers the webook
+9. Click "Enabled" at the top.
+10. Click "Save"
+
+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`
+
+Each Event instance contains these important attributes:
+
+* **webhook_id:** A read-only instance of the webhook ID stored in the JSS
+  which caused the POST request. This attribute matches the "webhook[:id]"
+  dictionary 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.
+
+* **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
+  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.
+
+* **event_json:** The JSON content from the POST request, parsed into
+  a Ruby hash with symbolized keys (meaning the JSON key "deviceName" becomes
+  the symbol :deviceName).
+
+* **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
 
@@ -302,179 +475,31 @@ the `Chook::Subjects` module.
 | Chook::TestEvents::MobileDeviceUnenrolledEvent | Chook::TestSubjects::MobileDevice |
 | Chook::TestEvents::PatchSoftwareTitleUpdateEvent | Chook::TestSubjects::PatchSoftwareTitleUpdate |
 
-## The Server
-
-Chook comes with a simple HTTP(S) server that uses the Chook framework
-to handle all incoming webhook POST requests from the JSS via a single URL.
-
-To use it you'll need the [sinatra](http://www.sinatrarb.com/) web framework
-and the [thin](http://code.macournoyer.com/thin/) web server.
-Both will be installed automatically when you install chook as mentioned below.
-
-After that, just run the `chook-server` command located in the bin directory
-for chook and then point your webhooks at: http://my_hostname/handle_webhook_event
-
-It will then process all incoming webhook POST requests using whatever handlers
-you have installed.
-
-To automate it on a dedicated machine, just make a LaunchDaemon plist to run
-that command and keep it running.
-
-### Server Configuration
-
-The Chook server looks for a config file at `/etc/chook.conf`. If not found, default
-values are used. Full descriptions of the config values are provided in the sample
-config file at:
-/path/to/your/gem/folder/chook-<version>/data/chook.conf.example
-
-Each config setting is on a single line thus: `key: value`. Blank lines and those starting with # are ignored.
-
-Here's a summary:
-
- - port: The server port
-   - default = 80 or 443
- - concurrency: Should events be processed simultaneously, or one-at-a time
-   - default = true
- - handler_dir: The directory holding the andlers to load.
-   - default = /Library/Application Support/Chook
- - use_ssl: Should the server use SSL (https)
-   - default = false
- - ssl_cert_path: If SSL is used, the path to the server certificate
-   - no default
- - ssl_private_key_path: If SSL is used, the path to the certificate key
-   - no default
- - log_file: The path to the server log file
-   - default = /var/log/chook-server.log
- - log_level: The severity level for log entries
-   - default = info
- - logs_to_keep: How many old log files to keep when rotating
-   - default = 10
- - log_max_megs: How big can a log file get before it's rotated.
-   - default = 10
- - webhooks_user: The username for Basic Authentication
-   - no default, leave unset for no Authentication
- - webhooks_user_pw: The file path, or command, to get the password for the webhooks_user.
-   - no default.
-
-See the sample config file for details about all of these settings.
-
-### SSL
-
-It is recommended to use SSL (https) if possible for security, although its beyond the scope
-of this document to go into a lot of detail about SSL and certificates.  That said, here
-are some pointers:
-
-- The certificate and key files should be in .pem format
-
-- Make sure you use a certificate that can be verified by the JSS.
-  - This might involved adding a CA to the JSS's Java Keystore.
-
-- If running on macOS, the 'thin' webserver and it's underlying 'eventmachine' gem may not
-  like the OS's openssl replacement 'libressl'.
-  - One solution is to use [homebrew](https://brew.sh/) to install openssl and then
-    install eventmachine using that openssl, something like this:
-
-    `brew install openssl ; brew link openssl --force ; gem install eventmachine -- --with-ssl-dir=/usr/local/`
-
-### Logging
-
-The Chook server logs activity into the file defined in the `log_file` config setting,
-`/var/log/chook-server.log` by default.
-
-It uses a standard ruby [Logger](http://ruby-doc.org/stdlib-2.3.3/libdoc/logger/rdoc/index.html)
-instance, which provides 5 severity levels: fatal (lowest), error, warn, info, and debug (highest).
-
-The `log_level` config setting defines the level when the server starts up, and log
-messages of that level or lower will be written to the log.
-
-The logger is generally available via `Chook.logger`. If you want to log an exeption with its backtrace, you can use `Chook.log_exception exception` to get the Exception class, message, and backtrace in the log.
-
-However, for logging from inside handlers, read on...
-
-#### Logging from handlers
-
-**Internal handlers**
+### Putting It Together
 
-To write to the log file from within an internal handler, use the `#logger` method of the `event` object
-inside the handler block, like so:
+Here is a commented sample of ruby code that uses the framework to process a
+ComputerAdded Event:
 
 ```ruby
-Chook.event_handler do |event|
-  event.logger.debug "This line appears in the log if the level is debug"
-  event.logger.info "This line appears in the log if the level is info or debug"
-  event.logger.error "This line appears in the log if the level is error, warn, info, or debug"
-end
-```
-
-If you want to log an exeption with its backtrace, you can pass the entire exception to the
-event loggers  'log_exception' method:  `event.logger.log_exception exception`
-
-Log entries written through event objects are preceded with 'Event *event_id*'  where *event_id* is
-an internal ID number for the specific even that wrote the entry.
-
-
-**External handlers**
-
-External Handlers can use a URL to make log entries by POSTing to `https://my.chookserver/log`
-
-The request body must be a JSON object wth 2 keys 'level' and 'message' where both values are strings.
-The 'level' must be one of the levels mentioned above, and the message is a single line of
-text.
+# load the framework
+require 'chook'
 
-If your chook server is using Basic Authentication, it must be provided.
+# The framework comes with sample JSON files for each Event type.
+# In reality, a webserver would extract this from the data POSTed from the JSS
+posted_json = Chook.sample_jsons[:ComputerAdded]
 
-Here's an example with curl, split to multi-line for clarity:
+# Create Chook::HandledEvents::ComputerAddedEvent instance for the event
+event = Chook::HandledEvent.parse_event posted_json
 
+# Call the events #handle method, which will execute any ComputerAdded
+# handlers that were in the Handler directory when the framework was loaded.
+event.handle
 ```
-curl -H "Content-Type: application/json" \
-  -X POST \
-  --data '{"level":"debug", "message":"It Worked"}' \
-  https://user:passwd@chookserver.myorg.org/log
-```
-
-Messages logged via this url show up in the log preceded by 'ExternalEntry: '
 
-Any info needed to connect a log entry to a specific event must be included in
-your log message.
-
-### Admin Interface
-
-If you point your web browser at your Chook server, you'll see a simple admin interface.
-If your server uses Basic Authentication, you'll need to provide the name and password.
-
-The first section provides a live-stream of the server log file, and provides a way to
-change the server's log level on the fly. Note that this change affect the server itself
-not just the view in your browser. If you'd like to stop the stream temporarily (e.g. to
-select and copy some text from it), just pause and unpause with the checkbox.
-
-The second section lets you see which handlers are currently loaded, and if they are
-internal or external. There's also a button to reload the handlers from the handler
-directory without restarting the server - useful when you add, delete, or modify them.
-
-The final section just shows your current /etc/chook.conf file, or if there is none,
-the sample config file is shown, since it shows the default values.
-
-The admin page cannot be used to edit or upload handlers or change the config. For security
-reasons, you must do that on the server itself though normal administrative methods.
-
-### Pointing Jamf Pro at your Chook server
-
-Once your server is up and running, you can create webhooks in your Jamf Pro interface.
-
-1. Navigate to Settings => Global Management => Webhooks
-2. Click "New"
-3. Give your webhook a display name
-4. Enter the URL for your Chook server, ending with 'handle_webhook_event', e.g:
-  - `http://my.chookserver.edu/handle_webhook_event`
-  - `https://my.chookserver.edu:8443/handle_webhook_event`
-5. If you use Basic Authentication, enter the name and password
-6. The default timeouts should be OK, but raise them a bit if you're experiencing errors.
-7. Set the content type to JSON
-8. Select the event that triggers the webook
-9. Click "Enabled" at the top.
-10. Click "Save"
-
-Watch the Chook log, with the level at info or debug, to see events come in.
+Of course, you can use the framework without using the built-in #handle method,
+and if you don't have any handlers in the directory, it won't do anything
+anyway. Instead you are welcome to use the objects as desired in your own
+Ruby code.
 
 ## TODOs