chook 1.0.0.b1

data/data/sample_jsons/MobileDeviceEnrolled.json

@@ -0,0 +1,26 @@
+{
+  "webhook": {
+    "id": 11,
+    "name": "MobileEnrolled Webhook",
+    "webhookEvent": "MobileDeviceEnrolled"
+  },
+  "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/MobileDevicePushSent.json

@@ -0,0 +1,26 @@
+{
+  "webhook": {
+    "id": 12,
+    "name": "MobilePush Webhook",
+    "webhookEvent": "MobileDevicePushSent"
+  },
+  "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/MobileDeviceUnEnrolled.json

@@ -0,0 +1,26 @@
+{
+  "webhook": {
+    "id": 13,
+    "name": "MobileUnEnrolled Webhook",
+    "webhookEvent": "MobileDeviceUnEnrolled"
+  },
+  "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/PatchSoftwareTitleUpdated.json

@@ -0,0 +1,14 @@
+{
+  "webhook": {
+    "id": 14,
+    "name": "PatchSoftwareTitleUpdated Webhook",
+    "webhookEvent": "PatchSoftwareTitleUpdated"
+  },
+  "event": {
+    "name": "CoolApp",
+    "latestVersion": "12.4.3",
+    "lastUpdate": 1463054400000,
+    "reportUrl": "http://CoolApp.com/downloads/latest",
+    "jssID": 1
+  }
+}

data/data/sample_jsons/PushSent.json

@@ -0,0 +1,11 @@
+{
+  "webhook": {
+    "id": 15,
+    "name": "PushSent Webhook",
+    "webhookEvent": "PushSent"
+  },
+  "event": {
+    "type": "blank",
+    "jssID": 1322
+  }
+}

data/data/sample_jsons/README

@@ -0,0 +1,4 @@
+
+# a curl command to test the server with a smaple json file
+
+curl -i -H "Accept: application/json" -H "Content-Type: application/json" -X POST --data "$( < /path/to/json/file )"   http://localhost:8000/handle_webhook_event

data/data/sample_jsons/RestAPIOperation.json

@@ -0,0 +1,15 @@
+{
+  "webhook": {
+    "id": 16,
+    "name": "RestAPIOperation Webhook",
+    "webhookEvent": "RestAPIOperation"
+  },
+  "event": {
+    "operationSuccessful": true,
+    "objectID": 1233,
+    "objectName": "wanderer",
+    "objectTypeName": "computer",
+    "authorizedUsername": "username",
+    "restAPIOperationType": "POST"
+  }
+}

data/data/sample_jsons/SCEPChallenge.json

@@ -0,0 +1,10 @@
+{
+  "webhook": {
+    "id": 17,
+    "name": "SCEPChallenge Webhook",
+    "webhookEvent": "SCEPChallenge"
+  },
+  "event": {
+    "targetDevice": "computer"
+  }
+}

data/data/sample_jsons/SmartGroupComputerMembershipChange.json

@@ -0,0 +1,13 @@
+{
+  "webhook": {
+    "id": 18,
+    "name": "SmartGroupComputerMembershipChange Webhook",
+    "webhookEvent": "SmartGroupComputerMembershipChange"
+  },
+  "event": {
+    "name": "OddComputers",
+    "smartGroup": true,
+    "jssid": 95,
+    "computer": true
+  }
+}

data/data/sample_jsons/SmartGroupMobileDeviceMembershipChange.json

@@ -0,0 +1,13 @@
+{
+  "webhook": {
+    "id": 19,
+    "name": "SmartGroupMobileDeviceMembershipChange Webhook",
+    "webhookEvent": "SmartGroupMobileDeviceMembershipChange"
+  },
+  "event": {
+    "name": "OddMobileDevs",
+    "smartGroup": true,
+    "jssid": 99,
+    "computer": false
+  }
+}

data/lib/chook.rb

@@ -0,0 +1,38 @@
+### 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.
+###
+###
+
+# Requiring this file (require 'chook') will load the entire library
+# including event testing, event handling, and the server.
+#
+# To load a subset, use one of:
+#   require 'chook/event_testing'
+#   require 'chook/event_handing'
+#   require 'chook/server'
+
+require 'chook/foundation'
+require 'chook/event_testing'
+
+# the server - it loads the event handling files
+require 'chook/server'

data/lib/chook/configuration.rb

@@ -0,0 +1,198 @@
+### 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 'singleton'
+
+module Chook
+
+  # The configuration object
+  class Configuration
+
+    include ::Singleton
+
+    # The location of the default config file
+    DEFAULT_CONF_FILE = Pathname.new '/etc/chook.conf'
+
+    # The attribute keys we maintain, and the type they should be stored as
+    CONF_KEYS = {
+      server_port: :to_i,
+      server_engine:  :to_sym,
+      handler_dir: nil,
+      use_ssl: Chook::Procs::STRING_TO_BOOLEAN,
+      ssl_private_key_path: Chook::Procs::STRING_TO_PATHNAME,
+      ssl_private_key_pw_path: nil,
+      ssl_cert_path: Chook::Procs::STRING_TO_PATHNAME,
+      ssl_cert_name: nil
+    }.freeze
+
+    # Class Variables
+    #####################################
+
+    # Class Methods
+    #####################################
+
+    # Attributes
+    #####################################
+
+    # automatically create accessors for all the CONF_KEYS
+    CONF_KEYS.keys.each { |k| attr_accessor k }
+
+    # Constructor
+    #####################################
+
+    # Initialize!
+    #
+    def initialize
+      read_global
+    end
+
+    # Public Instance Methods
+    #####################################
+
+    # Clear all values
+    #
+    # @return [void]
+    #
+    def clear_all
+      CONF_KEYS.keys.each { |k| send "#{k}=".to_sym, nil }
+    end
+
+    # (Re)read the global prefs, if it exists.
+    #
+    # @return [Boolean] was the file loaded?
+    #
+    def read_global
+      return false unless DEFAULT_CONF_FILE.file? && DEFAULT_CONF_FILE.readable?
+      read DEFAULT_CONF_FILE
+    end
+
+    # Clear the settings and reload the prefs file, or another file if provided
+    #
+    # @param file[String,Pathname] a non-standard prefs file to load
+    #
+    # @return [Boolean] was the file reloaded?
+    #
+    def reload(file = DEFAULT_CONF_FILE)
+      file = Pathname.new file
+      return false unless file.file? && file.readable?
+      clear_all
+      read file
+    end
+
+    # Save the prefs into a file
+    #
+    # @param file[Symbol,String,Pathname] either :user, :global, or an arbitrary file to save.
+    #
+    # @return [void]
+    #
+    def save(file)
+      path = Pathname.new(file)
+
+      # file already exists? read it in and update the values.
+      # Don't overwrite it, since the user might have comments
+      # in there.
+      if path.readable?
+        data = path.read
+
+        # go thru the known attributes/keys
+        CONF_KEYS.keys.sort.each do |k|
+          # if the key exists, update it.
+          if data =~ /^#{k}:/
+            data.sub!(/^#{k}:.*$/, "#{k}: #{send k}")
+
+          # if not, add it to the end unless it's nil
+          else
+            data += "\n#{k}: #{send k}" unless send(k).nil?
+          end # if data =~ /^#{k}:/
+        end # each do |k|
+
+      else # not readable, make a new file
+        data = ''
+        CONF_KEYS.keys.sort.each do |k|
+          data << "#{k}: #{send k}\n" unless send(k).nil?
+        end
+      end # if path readable
+
+      # make sure we end with a newline, the save it.
+      data << "\n" unless data.end_with?("\n")
+      path.open('w') { |f| f.write data }
+    end # save file
+
+    # Print out the current settings to stdout
+    #
+    # @return [void]
+    #
+    def print
+      CONF_KEYS.keys.sort.each { |k| puts "#{k}: #{send k}" }
+    end
+
+    # Private Instance Methods
+    #####################################
+    private
+
+    # Read in a prefs file
+    #
+    # @param file[String,Pathname] the file to read
+    #
+    # @return [Boolean] was the file read?
+    #
+    def read(file)
+      available_conf_keys = CONF_KEYS.keys
+      Pathname.new(file).read.each_line do |line|
+        # skip blank lines and those starting with #
+        next if line =~ /^\s*(#|$)/
+
+        line.strip =~ /^(\w+?):\s*(\S.*)$/
+        key = Regexp.last_match(1)
+        next unless key
+        attr = key.to_sym
+        next unless available_conf_keys.include? attr
+        setter = "#{key}=".to_sym
+        value = Regexp.last_match(2).strip
+
+        # convert the string value read from the file
+        # to the correct class
+        value &&= case CONF_KEYS[attr]
+                  when Proc
+                    # If its a proc, pass it to the proc
+                    CONF_KEYS[attr].call value
+                  when Symbol
+                    # otherwise its a symbol method name to call on the string
+                    value.send(CONF_KEYS[attr])
+                  else
+                    value
+                  end
+
+        send(setter, value)
+      end # do line
+      true
+    end # read file
+
+  end # class Configuration
+
+  # The single instance of Configuration
+  CONFIG = Chook::Configuration.instance
+
+end # module

data/lib/chook/event.rb

@@ -0,0 +1,153 @@
+### 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.
+###
+###
+
+#
+module Chook
+
+  # This is the MetaClass for all Event objects, both handled and test.
+  # It holds constants, methods, and attributes that are common to all
+  # events in Chook.
+  #
+  # An 'event' within Chook is the ruby-abstraction of a JSON payload
+  # as sent by a JSS Webhook representing an event that takes place in the JSS.
+  #
+  # All events contain a #subject attribute, which represent the thing
+  # upon which the event acted, e.g. a computer, mobile divice, or the
+  # JSS itself.
+  # The #subject attribute contains an object which is a subclass
+  # of Chook::Subject, q.v.
+  #
+  class Event
+
+    # A mapping of the Event Names (as they are known to the JSS)
+    # to the the matching Subject class names
+    #
+    # The event names from the JSS are in the JSON hash as the value of
+    # JSON_hash[:webhook][:webhookEvent] and they are also the names
+    # of the matching event classes within the HandledEvent module and the
+    # TestEvent module.
+    #
+    # E.g.
+    # the HandledEvents class that handles the 'ComputerPolicyFinished'
+    # event is Chook::HandledEvent::ComputerPolicyFinished
+    #
+    # and
+    #
+    # the TestEvents that simulates 'ComputerPolicyFinished' is
+    # Chook::TestEvents::ComputerPolicyFinished
+    #
+    # And, those classes take the matching 'Computer' subject, either
+    # Chook::HandledSubjects::Computer or Chook::TestSubjects::Computer
+    #
+    EVENTS = {
+      'ComputerAdded' => Chook::Subject::COMPUTER,
+      'ComputerCheckIn' => Chook::Subject::COMPUTER,
+      'ComputerInventoryCompleted' => Chook::Subject::COMPUTER,
+      'ComputerPolicyFinished' => Chook::Subject::COMPUTER,
+      'ComputerPushCapabilityChanged' => Chook::Subject::COMPUTER,
+      'JSSShutdown' => Chook::Subject::JAMF_SOFTWARE_SERVER,
+      'JSSStartup' => Chook::Subject::JAMF_SOFTWARE_SERVER,
+      'MobileDeviceCheckIn' => Chook::Subject::MOBILE_DEVICE,
+      'MobileDeviceCommandCompleted' => Chook::Subject::MOBILE_DEVICE,
+      'MobileDeviceEnrolled' => Chook::Subject::MOBILE_DEVICE,
+      'MobileDevicePushSent' => Chook::Subject::MOBILE_DEVICE,
+      'MobileDeviceUnEnrolled' => Chook::Subject::MOBILE_DEVICE,
+      'PatchSoftwareTitleUpdated' => Chook::Subject::PATCH_SW_UPDATE,
+      'PushSent' => Chook::Subject::PUSH,
+      'RestAPIOperation' => Chook::Subject::REST_API_OPERATION,
+      'SCEPChallenge' => Chook::Subject::SCEP_CHALLENGE,
+      'SmartGroupComputerMembershipChange' => Chook::Subject::SMART_GROUP,
+      'SmartGroupMobileDeviceMembershipChange' => Chook::Subject::SMART_GROUP
+    }.freeze
+
+    # Event subclasses will have an EVENT_NAME constant,
+    # which contains the name of the event, one of the keys
+    # from the Event::EVENTS Hash.
+    EVENT_NAME_CONST = 'EVENT_NAME'.freeze
+
+    # Event subclasses will have a SUBJECT_CLASS constant,
+    # which contains the class of the subject of the event, based on one of the
+    # values from the Event::EVENTS Hash.
+    SUBJECT_CLASS_CONST = 'SUBJECT_CLASS'.freeze
+
+    #### Attrbutes common to all events
+
+    # @return [Integer] The webhook id in the JSS that caused this event
+    attr_reader :webhook_id
+
+    # @return [String] The webhook name in the JSS that caused this event
+    attr_reader :webhook_name
+
+    # @return [Object] The subject of this event - i.e. the thing it acted upon.
+    #   An instance of a class from either the Chook::HandledSubjects module
+    #   or the Chook::TestSubjects module
+    attr_reader :subject
+
+    # @return [String, nil] If this event object was initialized with a JSON
+    #  blob as from the JSS, it will be stored here.
+    attr_reader :raw_json
+
+    # @return [Hash, nil] If this event object was initialized with a JSON
+    #  blob as from the JSS, the Hash parsed from it will be stored here.
+    attr_reader :parsed_json
+
+    # Args are a hash (or group of named params)
+    # with these possible keys:
+    #   raw_json: [String] A raw JSON blob for a full event as sent by the JSS
+    #     If this is present, all other keys are ignored and the instance is
+    #     built with this data.
+    #   parsed_json: [Hash] A pre-parsed JSON blob for a full event.
+    #     If this is present, all other keys are ignored and the instance is
+    #     built with this data (however raw_json wins if both are provided)
+    #   webhook_event: [String] The name of the event, one of the keys of EVENTS
+    #   webhook_id: [Integer] The id of the webhook defined in the JSS
+    #   webhook_name: [String] The name of the webhook defined in the JSS
+    # The remaning keys are the attributes of the Subject subclass for this
+    # event. Any not provided will be nil.
+    #
+    def initialize(**args)
+      if args[:raw_json]
+        @raw_json = args[:raw_json]
+        @parsed_json = JSON.parse @raw_json, symbolize_names: true
+      elsif args[:parsed_json]
+        @parsed_json = args[:parsed_json]
+      end
+
+      if @parsed_json
+        @webhook_name = @parsed_json[:webhook][:name]
+        @webhook_id = @parsed_json[:webhook][:id]
+        subject_data = @parsed_json[:event]
+      else
+        @webhook_name = args.delete :webhook_name
+        @webhook_id = args.delete :webhook_id
+        subject_data = args
+      end
+
+      @subject = self.class::SUBJECT_CLASS.new subject_data
+    end
+
+  end # class Event
+
+end # module