chook 1.0.0.b1

data/data/sample_handlers/RestAPIOperation-executable

@@ -0,0 +1,91 @@
+#!/bin/bash
+
+### 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.
+###
+###
+
+# NOTE: Native bash doesn't have any easy way to parse JSON.
+# Instead, you should really use a tool like 'jq' https://stedolan.github.io/jq/.
+#
+# If you have jq, set its correct path in the JQ variable below.
+#
+# If not, this script will use a hacky, VERY inappropriate and breakable
+# way to parse JSON!
+# But, it works enough to demonstrate the idea of using bash to write a handler.
+
+# Enter your path to jq
+JQ=/usr/local/bin/jq
+
+# read all of stdin into a variable
+while read line ; do JSON="$JSON $line" ; done
+
+# use jq if we can
+if [ -x "$JQ" ] ; then
+
+  hookname=`echo $JSON | "$JQ" -r '.webhook.name'`
+  authname=`echo $JSON | "$JQ" -r '.event.authorizedUsername'`
+  otype=`echo $JSON | "$JQ" -r '.event.objectTypeName'`
+  oname=`echo $JSON | "$JQ" -r '.event.objectName'`
+  oid=`echo $JSON | "$JQ" -r '.event.objectID'`
+  optype=`echo $JSON | "$JQ" -r '.event.restAPIOperationType'`
+
+# otherwise, hacky bash parsing.
+else
+
+  # use a comma as the field separator for the for-loop
+  IFS=','
+
+  # loop thru comma-separated chunks
+  for chunk in $JSON ; do
+    hookre='"name": "(.+)"'
+    [[ $chunk =~ $hookre ]] && hookname="${BASH_REMATCH[1]}"
+    authunamere='"authorizedUsername": "(.+)"'
+    [[ $chunk =~ $authunamere ]] && authname="${BASH_REMATCH[1]}"
+    otypere='"objectTypeName": "(.+)"'
+    [[ $chunk =~ $otypere ]] && otype="${BASH_REMATCH[1]}"
+    onamere='"objectName": "(.+)"'
+    [[ $chunk =~ $onamere ]] && oname="${BASH_REMATCH[1]}"
+    oidre='"objectID": (.+)'
+    [[ $chunk =~ $oidre ]] && oid="${BASH_REMATCH[1]}"
+    optypere='"restAPIOperationType": "(.+)"'
+    [[ $chunk =~ $optypere ]] && optype="${BASH_REMATCH[1]}"
+  done
+
+fi # if [ -x "$JQ" ] ; then
+
+# make an 'action' out of the operation type
+# or exit if we don't know or don't care.
+case $optype in
+  GET) exit 0 ;;
+  PUT) action=create ;;
+  POST) action=update ;;
+  DELETE) action=delete ;;
+  *) exit 15 ;;
+esac
+
+# output
+echo "The JSS WebHook named '${hookname}' was just triggered.
+It indicates that Casper user '${authname}' just used the JSS API to ${action}
+the JSS ${otype}named '${oname}' (id ${oid})
+"

data/data/sample_handlers/RestAPIOperation.rb

@@ -0,0 +1,45 @@
+### 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.
+###
+###
+
+Chook.event_handler do |event|
+  eobject = event.event_object
+  whook = event.webhook
+
+  REPORT_ACTIONS = {
+    'PUT' => 'update',
+    'POST' => 'create',
+    'DELETE' => 'delete'
+  }.freeze unless defined? REPORT_ACTIONS
+
+  action = REPORT_ACTIONS[eobject.restAPIOperationType]
+
+  return nil unless action
+
+  puts <<-ENDMSG
+The JSS WebHook named '#{whook.name}' was just triggered.
+It indicates that Casper user '#{eobject.authorizedUsername}' just used the JSS API to #{action}
+the JSS #{eobject.objectTypeName} named '#{eobject.objectName}' (id #{eobject.objectID})
+ENDMSG
+end

data/data/sample_handlers/SmartGroupComputerMembershipChange-executable

@@ -0,0 +1,47 @@
+#!/bin/bash
+### 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.
+###
+###
+
+# NOTE: Native bash doesn't have any easy way to parse JSON.
+# Instead, you should really use a tool like 'jq' https://stedolan.github.io/jq/.
+#
+# If you have jq, set its correct path in the JQ variable below.
+#
+# It's beyond the scope of this example to parse the JSON with regular expressions
+# which is a horrible idea anyway.
+
+# Enter your path to jq
+JQ=/usr/local/bin/jq
+
+HANDLER_NAME=`basename "$0"`
+CHANGELOG='/tmp/smart-computer-group-changes.log'
+
+# read all of stdin into a variable
+while read line ; do JSON="$JSON $line" ; done
+now=`date +'%Y-%m-%d %H:%M:%S'`
+groupname=`echo $JSON | "$JQ" -r '.event.name'`
+
+msg="$now $HANDLER_NAME: Smart Computer Group '$groupname' changed."
+
+echo "$msg" >> "$CHANGELOG"

data/data/sample_handlers/SmartGroupComputerMembershipChange.rb

@@ -0,0 +1,33 @@
+### 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.
+###
+###
+
+HANDLER_NAME = File.basename __FILE__
+CHANGELOG = '/tmp/smart-computer-group-changes.log'.freeze
+
+Chook.event_handler do |event|
+  now = Time.now.strftime '%Y-%m-%d %H:%M:%S'
+  msg = "#{now} #{HANDLER_NAME}: Smart Computer Group '#{event.event_object.name}' changed.\n"
+  open(CHANGELOG, 'a') { |file| file.write msg }
+end

data/data/sample_jsons/ComputerAdded.json

@@ -0,0 +1,27 @@
+{
+  "webhook": {
+    "id": 1,
+    "name": "ComputerAdded Webhook",
+    "webhookEvent": "ComputerAdded"
+  },
+  "event": {
+    "udid": "99848AF0-xxxx-XXXX-xxxx-B79B9F65D7F8",
+    "deviceName": "wanderer",
+    "model": "MacBookPro10,1",
+    "macAddress": "yy:E0:yy:16:yy:E9",
+    "alternateMacAddress": "32:xx:1A:xx:xx:60",
+    "serialNumber": "VM87S764H831",
+    "osVersion": "10.15.2",
+    "osBuild": "48673",
+    "userDirectoryID": "-1",
+    "username": "username",
+    "realName": "User Name",
+    "emailAddress": "user@school.edu",
+    "phone": "x3369",
+    "position": "Apple Peeler",
+    "department": "MacBack",
+    "building": "Soho",
+    "room": "s167",
+    "jssID": 1322
+  }
+}

data/data/sample_jsons/ComputerCheckIn.json

@@ -0,0 +1,27 @@
+{
+  "webhook": {
+    "id": 2,
+    "name": "ComputerCheckin Webhook",
+    "webhookEvent": "ComputerCheckin"
+  },
+  "event": {
+    "udid": "99848AF0-xxxx-XXXX-xxxx-B79B9F65D7F8",
+    "deviceName": "wanderer",
+    "model": "MacBookPro10,1",
+    "macAddress": "yy:E0:yy:16:yy:E9",
+    "alternateMacAddress": "32:xx:1A:xx:xx:60",
+    "serialNumber": "VM87S764H831",
+    "osVersion": "10.15.2",
+    "osBuild": "48673",
+    "userDirectoryID": "-1",
+    "username": "username",
+    "realName": "User Name",
+    "emailAddress": "user@school.edu",
+    "phone": "x3369",
+    "position": "Apple Peeler",
+    "department": "MacBack",
+    "building": "Soho",
+    "room": "s167",
+    "jssID": 1322
+  }
+}

data/data/sample_jsons/ComputerInventoryCompleted.json

@@ -0,0 +1,27 @@
+{
+  "webhook": {
+    "id": 3,
+    "name": "ComputerInventoryCompleted Webhook",
+    "webhookEvent": "ComputerInventoryCompleted"
+  },
+  "event": {
+    "udid": "99848AF0-xxxx-XXXX-xxxx-B79B9F65D7F8",
+    "deviceName": "wanderer",
+    "model": "MacBookPro10,1",
+    "macAddress": "yy:E0:yy:16:yy:E9",
+    "alternateMacAddress": "32:xx:1A:xx:xx:60",
+    "serialNumber": "VM87S764H831",
+    "osVersion": "10.15.2",
+    "osBuild": "48673",
+    "userDirectoryID": "-1",
+    "username": "username",
+    "realName": "User Name",
+    "emailAddress": "user@school.edu",
+    "phone": "x3369",
+    "position": "Apple Peeler",
+    "department": "MacBack",
+    "building": "Soho",
+    "room": "s167",
+    "jssID": 1322
+  }
+}

data/data/sample_jsons/ComputerPolicyFinished.json

@@ -0,0 +1,27 @@
+{
+  "webhook": {
+    "id": 4,
+    "name": "ComputerPolicyFinished Webhook",
+    "webhookEvent": "ComputerPolicyFinished"
+  },
+  "event": {
+    "udid": "99848AF0-xxxx-XXXX-xxxx-B79B9F65D7F8",
+    "deviceName": "wanderer",
+    "model": "MacBookPro10,1",
+    "macAddress": "yy:E0:yy:16:yy:E9",
+    "alternateMacAddress": "32:xx:1A:xx:xx:60",
+    "serialNumber": "VM87S764H831",
+    "osVersion": "10.15.2",
+    "osBuild": "48673",
+    "userDirectoryID": "-1",
+    "username": "username",
+    "realName": "User Name",
+    "emailAddress": "user@school.edu",
+    "phone": "x3369",
+    "position": "Apple Peeler",
+    "department": "MacBack",
+    "building": "Soho",
+    "room": "s167",
+    "jssID": 1322
+  }
+}

data/data/sample_jsons/ComputerPushCapabilityChanged.json

@@ -0,0 +1,27 @@
+{
+  "webhook": {
+    "id": 5,
+    "name": "ComputerPushCapabilityChanged Webhook",
+    "webhookEvent": "ComputerPushCapabilityChanged"
+  },
+  "event": {
+    "udid": "99848AF0-xxxx-XXXX-xxxx-B79B9F65D7F8",
+    "deviceName": "wanderer",
+    "model": "MacBookPro10,1",
+    "macAddress": "yy:E0:yy:16:yy:E9",
+    "alternateMacAddress": "32:xx:1A:xx:xx:60",
+    "serialNumber": "VM87S764H831",
+    "osVersion": "10.15.2",
+    "osBuild": "48673",
+    "userDirectoryID": "-1",
+    "username": "username",
+    "realName": "User Name",
+    "emailAddress": "user@school.edu",
+    "phone": "x3369",
+    "position": "Apple Peeler",
+    "department": "MacBack",
+    "building": "Soho",
+    "room": "s167",
+    "jssID": 1322
+  }
+}

data/data/sample_jsons/JSSShutdown.json

@@ -0,0 +1,14 @@
+{
+ "webhook": {
+   "id": 7,
+   "name": "JSSShutdown Webhook",
+   "webhookEvent": "JSSShutdown"
+ },
+ "event": {
+   "institution": "MyCoolSchool",
+   "hostAddress": "casper.mycoolschool.edu",
+   "webApplicationPath": "/path/to/web/app",
+   "isClusterMaster": true,
+   "jssUrl": "https://casper.mycoolschool.edu:8443/"
+ }
+}

data/data/sample_jsons/JSSStartup.json

@@ -0,0 +1,14 @@
+{
+ "webhook": {
+   "id": 8,
+   "name": "JSSStartup Webhook",
+   "webhookEvent": "JSSStartup"
+ },
+ "event": {
+   "institution": "MyCoolSchool",
+   "hostAddress": "casper.mycoolschool.edu",
+   "webApplicationPath": "/path/to/web/app",
+   "isClusterMaster": true,
+   "jssUrl": "https://casper.mycoolschool.edu:8443/"
+ }
+}

data/data/sample_jsons/MobileDeviceCheckIn.json

@@ -0,0 +1,26 @@
+{
+  "webhook": {
+    "id": 9,
+    "name": "MobileCheckin Webhook",
+    "webhookEvent": "MobileDeviceCheckIn"
+  },
+  "event": {
+    "udid": "0d12c74062dxyxyxb4b234f4ac1yxyxyx1efccd0",
+    "deviceName": "tipple",
+    "version": "4.71.00",
+    "model": "iPhone7,2",
+    "bluetoothMacAddress": "xx:xx:37:yy:78:xx",
+    "wifiMacAddress": "yy:yy:37:xx:78:yy",
+    "imei": "xx yyyyyy zzzzzz 0",
+    "icciID": "aaaa bbbb cccc dddd eeee",
+    "product": null,
+    "serialNumber": "C8EM25KSG5PT",
+    "userDirectoryID": "-1",
+    "room": "s167",
+    "osVersion": "9.3.4",
+    "osBuild": "13G35",
+    "modelDisplay": "iPhone 6",
+    "username": "username",
+    "jssID": 158
+  }
+}

data/data/sample_jsons/MobileDeviceCommandCompleted.json

@@ -0,0 +1,26 @@
+{
+  "webhook": {
+    "id": 10,
+    "name": "MobileCommandComplete Webhook",
+    "webhookEvent": "MobileDeviceCommandCompleted"
+  },
+  "event": {
+    "udid": "0d12c74062dxyxyxb4b234f4ac1yxyxyx1efccd0",
+    "deviceName": "tipple",
+    "version": "4.71.00",
+    "model": "iPhone7,2",
+    "bluetoothMacAddress": "xx:xx:37:yy:78:xx",
+    "wifiMacAddress": "yy:yy:37:xx:78:yy",
+    "imei": "xx yyyyyy zzzzzz 0",
+    "icciID": "aaaa bbbb cccc dddd eeee",
+    "product": null,
+    "serialNumber": "C8EM25KSG5PT",
+    "userDirectoryID": "-1",
+    "room": "s167",
+    "osVersion": "9.3.4",
+    "osBuild": "13G35",
+    "modelDisplay": "iPhone 6",
+    "username": "username",
+    "jssID": 158
+  }
+}