chook 1.0.0.b1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be77286c156ae0dd290704d210128d545f71186f
+  data.tar.gz: 39ceafe849ab9f66cf26e98b1868c8657aa688ea
+SHA512:
+  metadata.gz: 6d3874811333ab0b06791cb49f2791ac5138a6b0fa0724f88c1251ffb0613ea44505c1ebfbc3f95304fa6cf4fc0362c8940f2898d68166c4f9601aa50e77afd7
+  data.tar.gz: c87b572097bc89d91c9eae034d06c1324965d97c037fe530ba15e0265d479fba9c5232b6d0addd041ea4f00c3ff1c879e0bad88d3ad78b1e9d4450a1318658e9

data/LICENSE.txt

@@ -0,0 +1,174 @@
+
+                               Modified Apache 2.0 License
+
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor
+      and its affiliates, except as required to comply with Section 4(c) of
+      the License and to reproduce the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

data/README.md

@@ -0,0 +1,259 @@
+
+# Chook
+
+- [Introduction](#introduction)
+- [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)
+- [Installing Chook alongside ruby-jss](#installing-chook-alongside-ruby-jss)
+- [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.
+
+Chook also provides a simple, sinatra-based HTTP server for handling those Events,
+and classes for sending simulated TestEvents to a webhook handling server.
+
+** You do not need to be a Ruby developer to use this framework! **
+
+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.
+
+Chook is still in development. While many of the basics work,
+there is much to be done before it can be considered complete.
+
+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.
+
+For more detail about the JSS webhooks API and the JSON data it passes, please see
+[Bryson Tyrrell's documentation.](https://unofficial-jss-api-docs.atlassian.net/wiki/display/JRA/Webhooks+API)
+
+**Note:** When creating webhooks from your JSS to be handled by the framework, you must
+specify JSON in the "Content Type" section. This framework does not support XML.
+
+## 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.
+
+
+### Event Handlers
+
+A handler is a file containing code to run when a webhook event occurs. 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.
+
+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
+filenames are case-insensitive.
+
+All of these file names are valid handlers for ComputerAdded events:
+
+- ComputerAdded
+- computeradded.sh
+- COMPUTERAdded_notify_team
+- Computeradded-update-ldap
+
+There are two kinds of handlers:
+
+#### Internal Handlers
+
+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.
+
+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
+
+```ruby
+Chook.event_handler do |event|
+  cname = event.subject.deviceName
+  uname = event.subject.realName
+  puts "Computer '#{cname}' was just added to the JSS for user #{uname}."
+end
+```
+
+In this example, the code block takes one parameter, which it expects to be
+a Chook::ComputerAddedEvent instance, and uses it in the variable "event."
+It then extracts the "deviceName" and "realName" values from the subject
+contained in the event, and uses them to send a message to stdout.
+
+Internal handlers **must not** be executable files. Executability is how the
+framework determines if a handler is internal or external.
+
+#### External Handlers
+
+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.
+
+Here's a simple example using bash and [jq](https://stedolan.github.io/jq/) to
+do the same as the ruby example above:
+
+```bash
+#!/bin/bash
+JQ="/usr/local/bin/jq"
+while read line ; do JSON="$JSON $line" ; done
+cname=`echo $JSON | "$JQ" -r '.event.deviceName'`
+uname=`echo $JSON | "$JQ" -r '.event.realName'`
+echo "Computer '${cname}' was just added to the JSS for user ${uname}."
+```
+
+External handlers **must** be executable files. Executability is how the
+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
+
+Here is a commented sample of ruby code that uses the framework to process a
+ComputerAdded Event:
+
+```ruby
+# load the framework
+require 'chook'
+
+# 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]
+
+# 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
+```
+
+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.
+
+### 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).
+
+Each Event class is a subclass of `Chook::Event`, where all of their
+functionality is defined.
+
+The Subject classes aren't subclasses, but are dynamically-defined members of
+the `Chook::Subjects` module.
+
+| Event Classes | Subject Classes |
+| -------------- | ------------ |
+| Chook::ComputerAddedEvent | Chook::Subjects::Computer |
+| Chook::ComputerCheckInEvent | Chook::Subjects::Computer |
+| Chook::ComputerInventoryCompletedEvent | Chook::Subjects::Computer |
+| Chook::ComputerPolicyFinishedEvent | Chook::Subjects::Computer |
+| Chook::ComputerPushCapabilityChangedEvent | Chook::Subjects::Computer |
+| Chook::JSSShutdownEvent | Chook::Subjects::JSS |
+| Chook::JSSStartupEvent | Chook::Subjects::JSS |
+| Chook::MobileDeviceCheckinEvent | Chook::Subjects::MobileDevice |
+| Chook::MobileDeviceCommandCompletedEvent | Chook::Subjects::MobileDevice |
+| Chook::MobileDeviceEnrolledEvent | Chook::Subjects::MobileDevice |
+| Chook::MobileDevicePushSentEvent | Chook::Subjects::MobileDevice |
+| Chook::MobileDeviceUnenrolledEvent | Chook::Subjects::MobileDevice |
+| Chook::PatchSoftwareTitleUpdateEvent | Chook::Subjects::PatchSoftwareTitleUpdate |
+| Chook::PushSentEvent | Chook::Subjects::Push |
+| Chook::RestAPIOperationEvent | Chook::Subjects::RestAPIOperation |
+| Chook::SCEPChallengeEvent | Chook::Subjects::SCEPChallenge |
+| Chook::SmartGroupComputerMembershipChangeEvent | Chook::Subjects::SmartGroup |
+| Chook::SmartGroupMobileDeviveMembershipChangeEvent | Chook::Subjects::SmartGroup |
+
+
+## The Server
+
+Chook comes with a simple HTTP 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/)
+ruby gem (`gem install sinatra`).
+
+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.
+
+## Installing Chook
+
+`gem install chook -n /usr/local/bin`. It will also install "sinatra."
+
+Then fire up `irb` and `require chook` to start playing around.
+
+OR
+
+run `/usr/local/bin/chook` and point some JSS webhooks at that machine.
+
+
+## TODOs
+
+- Add SSL support to the server
+- Improved thread management for handlers
+- Logging and Debug options
+- Handler reloading for individual, or all, Event subclasses
+- Better YARD docs
+- Better namespace protection for internal handlers
+- Improved configuration
+- Proper documentation beyond this README
+- I'm sure there's more to do...

data/bin/chook-server

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby
+
+### Copyright 2017 Pixar
+
+###
+###    Licensed under the Apache License, Version 2.0 (the "Apache License")
+###    with the following modification; you may not use this file except in
+###    compliance with the Apache License and the following modification to it:
+###    Section 6. Trademarks. is deleted and replaced with:
+###
+###    6. Trademarks. This License does not grant permission to use the trade
+###       names, trademarks, service marks, or product names of the Licensor
+###       and its affiliates, except as required to comply with Section 4(c) of
+###       the License and to reproduce the content of the NOTICE file.
+###
+###    You may obtain a copy of the Apache License at
+###
+###        http://www.apache.org/licenses/LICENSE-2.0
+###
+###    Unless required by applicable law or agreed to in writing, software
+###    distributed under the Apache License with the above modification is
+###    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+###    KIND, either express or implied. See the Apache License for the specific
+###    language governing permissions and limitations under the Apache License.
+###
+###
+require 'chook/server'
+Chook::Server.run!