chook 1.1.2 → 1.1.5b1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c4ec862f7ad2fdbbc49daeb67862dd096a7524be67a5d5901e1d948a7857ae2
-  data.tar.gz: 3da70bf1d76edbf10371abc819b645e3620bd259a7973d9bdc39e71be74f95b1
+  metadata.gz: a2a39df5350d3ae528addf0baaebe5a122b1701b08e2e503afd9b0500910120c
+  data.tar.gz: a8a277843eb2606251f8c6000cd25b2e11c60a94c69998046e59f5c0010c4489
 SHA512:
-  metadata.gz: 1a81f5307c33b300e307a28fa59bfd008f1513d1b135c46855a4f0a41b8033269b346790d65f3c168423bb5c363cb17e04062b780ef73b3190b05e59b3e48339
-  data.tar.gz: 81fb57becdf2dc470be52fc287b955ccf6cbbb72dd5cab955924b925ff2cfc66d1d2c2dad35cfd7bdbdbc9f4cf0c7eb410100f939b2ffdad78a47a82e8b1bad2
+  metadata.gz: 519c4bf9ab0662a599eeef50e6e6bb637203f22c24a4cdc121bc94f28f239f856d9ff1380422259b67b64cb19554d18e76abb39ceabeb87ea408a9fde6398876
+  data.tar.gz: ad11db916b235f4bc0aaca73aae01b36f38c222555a76004fa4ac7f7e34efa32bc4fb80768366536dfd29a6f56ac5ec0912c6ac7eb1be63e62c7e03cec44170b

data/CHANGES.md

@@ -1,5 +1,25 @@
 # Chook Change Log
 
+## v 1.1.5 2020-12-11
+
+- Add support for handling DeviceAddedToDEP webhook events
+- Updated the handling of ComputerPolicyFinished events to reflect new JSON structure via a PolicyFinished subject class.
+  NOTE: The computer info in the PolicyFinished subject for ComputerPolicyFinished events is located in a hash in the 'computer' attribute of the subject.  So to get the SN of the computer that finished a policy, you'd use `event.subject.computer[:serialNumber]`. See the file ..lib/chook/subject/policy_finished.rb.
+
+### IMPORTANT Note:
+ Version 1.1.5 is probably the last release of v.1x for chook. Version 2 will be a major reworking of the code. While the general principles will remain the same, a lot will be simplified, some will be jettisoned (e.g. the whole TestEvent aspect) and hopefully lots will be optimized to better handle more and faster incoming webhooks. We'll get some test code up to Github asap.
+
+## v 1.1.4, 2020-08-10
+
+- Set the server process name to 'chook'  - some OS utilities will see it
+- remove event START messages from info logging, now only visible when log level is debug.
+- Don't use ruby object IDs as event ids - ruby reuses them.
+- Server uptime is displayed on the simple admin web UI.
+
+## v 1.1.3, 2019-10-28
+
+- Named Handlers!  You can create a handler with any file name, and put it in /Library/Application Support/Chook/NamedHandlers  then call it specifically from a webhook in Jamf Pro using the url http[s]://your.chook.server.com/handler/handler-filename
+
 ## v 1.1.2,  2019-01-24
 
 - code cleanup & bugfixes

data/README.md

@@ -2,6 +2,10 @@
 
 Documentation is a work in progress. Please [get in touch](mailto:chook@pixar.com) for assistance. <3
 
+### IMPORTANT Note:
+Version 1.1.5 is probably the last release of v.1x for chook. Version 2 will be a major reworking of the code. While the general principles will remain the same, a lot will be simplified, some will be jettisoned (e.g. the whole TestEvent aspect) and hopefully lots will be optimized to better handle more and faster incoming webhooks. We'll get some test code up to Github asap.
+
+
 - [Introduction](#introduction)
 - [Installing Chook](#installing-chook)
 - [The Server](#the-server)
@@ -444,8 +448,9 @@ the `Chook::Subjects` module.
 | Chook::HandledEvents::ComputerAddedEvent | Chook::HandledSubjects::Computer |
 | Chook::HandledEvents::ComputerCheckInEvent | Chook::HandledSubjects::Computer |
 | Chook::HandledEvents::ComputerInventoryCompletedEvent | Chook::HandledSubjects::Computer |
-| Chook::HandledEvents::ComputerPolicyFinishedEvent | Chook::HandledSubjects::Computer |
+| Chook::HandledEvents::ComputerPolicyFinishedEvent | Chook::HandledSubjects::PolicyFinished |
 | Chook::HandledEvents::ComputerPushCapabilityChangedEvent | Chook::HandledSubjects::Computer |
+| Chook::HandledEvents::DeviceAddedToDEP | Chook::HandledSubjects::DEPDevice |
 | Chook::HandledEvents::JSSShutdownEvent | Chook::HandledSubjects::JSS |
 | Chook::HandledEvents::JSSStartupEvent | Chook::HandledSubjects::JSS |
 | Chook::HandledEvents::MobileDeviceCheckinEvent | Chook::HandledSubjects::MobileDevice |

data/bin/chook-server

@@ -1,5 +1,7 @@
 #!/usr/bin/ruby
 
+Process.setproctitle('chook')
+
 ### Copyright 2017 Pixar
 
 ###

data/data/com.pixar.chook-server.plist

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+        <key>Label</key>
+        <string>com.pixar.chook-server</string>
+        <key>StandardOutPath</key>
+        <string>/var/log/chook-server.log</string>
+        <key>StandardErrorPath</key>
+        <string>/var/log/chook-server.log</string>
+        <key>ProgramArguments</key>
+        <array>
+                <string>/usr/local/pixar/bin/chook-server</string>
+        </array>
+        <key>RunAtLoad</key>
+        <true/>
+        <key>KeepAlive</key>
+        <true/>
+</dict>
+</plist>

data/data/sample_handlers/RestAPIOperation.rb

@@ -39,11 +39,7 @@ Chook.event_handler do |event|
 
   action = APIOpHandler::REPORT_ACTIONS[event.subject.restAPIOperationType]
 
-  return nil unless action
+  break unless action
 
-  puts <<-ENDMSG
-The JSS WebHook named '#{event.webhook_name}' was just triggered.
-It indicates that Casper user '#{event.subject.authorizedUsername}' just used the JSS API to #{action}
-the JSS #{event.subject.objectTypeName} named '#{event.subject.objectName}' (id #{event.subject.objectID})
-ENDMSG
+  event.logger.info "API #{action}: #{event.subject.objectTypeName} '#{event.subject.objectName}' (id #{event.subject.objectID})"
 end

data/lib/chook/event.rb

@@ -65,8 +65,9 @@ module Chook
       'ComputerAdded' => Chook::Subject::COMPUTER,
       'ComputerCheckIn' => Chook::Subject::COMPUTER,
       'ComputerInventoryCompleted' => Chook::Subject::COMPUTER,
-      'ComputerPolicyFinished' => Chook::Subject::COMPUTER,
+      'ComputerPolicyFinished' => Chook::Subject::POLICY_FINISHED,
       'ComputerPushCapabilityChanged' => Chook::Subject::COMPUTER,
+      'DeviceAddedToDEP' => Chook::Subject::DEP_DEVICE,
       'JSSShutdown' => Chook::Subject::JAMF_SOFTWARE_SERVER,
       'JSSStartup' => Chook::Subject::JAMF_SOFTWARE_SERVER,
       'MobileDeviceCheckIn' => Chook::Subject::MOBILE_DEVICE,
@@ -94,6 +95,9 @@ module Chook
 
     #### Attrbutes common to all events
 
+    # @return [String] A unique identifier for this chook event
+    attr_reader :id
+
     # @return [Integer] The webhook id in the JSS that caused this event
     attr_reader :webhook_id
 
@@ -128,6 +132,7 @@ module Chook
     # event. Any not provided will be nil.
     #
     def initialize(**args)
+      @id = "#{Time.now.to_i}-#{SecureRandom.urlsafe_base64 8}"
       if args[:raw_json]
         @raw_json = args[:raw_json]
         @parsed_json = JSON.parse @raw_json, symbolize_names: true

data/lib/chook/event/handled_event.rb

@@ -118,10 +118,15 @@ module Chook
       super raw_json: raw_event_json
     end # init
 
+    def event_class_name
+      self.class.const_get(Chook::Event::EVENT_NAME_CONST)
+    end
+
+    # Run all the general handlers for this event class
+    #
     def handle
-      handler_key = self.class.const_get(Chook::Event::EVENT_NAME_CONST)
-      handlers = Handlers.handlers[handler_key]
-      return 'No handlers loaded' unless handlers.is_a? Array
+      handlers = Handlers.handlers[event_class_name]
+      return "No handlers loaded for #{event_class_name} events" unless handlers.is_a? Array
 
       handlers.each do |handler|
         case handler
@@ -135,9 +140,23 @@ module Chook
       # the handle method should return a string,
       # which is the body of the HTTP result for
       # POSTing the event
-      "Processed by #{handlers.count} handlers"
+      "Processed by #{handlers.count} general handlers"
     end # def handle
 
+    # run a single handler specified by filename
+    #
+    def handle_by_name(handler_to_run)
+      handler = Handlers.named_handlers[handler_to_run]
+      return "No named handler '#{handler_to_run}'" unless handler
+
+      if handler.is_a? Pathname
+        pipe_to_executable handler
+      else
+        handle_with_proc handler
+      end # if
+      "Processed by named handler '#{handler_to_run}'"
+    end
+
     # TODO: these threads will die midstream when the server stops.
     # Find a way to .join them or otherwise clean them up.
 

data/lib/chook/event/handled_event/handlers.rb

@@ -70,6 +70,11 @@ module Chook
 
       DEFAULT_HANDLER_DIR = '/Library/Application Support/Chook'.freeze
 
+      # Handlers that are only called by name using the route:
+      #     post '/handler/:handler_name'
+      # are located in this subdirection of the handler directory
+      NAMED_HANDLER_SUBDIR = 'NamedHandlers'.freeze
+
       # internal handler files must match this regex somewhere
       INTERNAL_HANDLER_BLOCK_START_RE = /Chook.event_handler( ?\{| do) *\|/
 
@@ -101,12 +106,63 @@ module Chook
       #  (The objects also have a #handler_file attribute that is the Pathname)
       #
       def self.handlers
-        @handlers
+        @handlers ||= {}
+      end
+
+      # Handlers can check Chook::HandledEvent::Handlers.reloading?
+      # and do stuff if desired.
+      def self.reloading?
+        @reloading
+      end
+
+      # getter for @named_handlers
+      # These handlers are called by name via the route
+      # " post '/handler/:handler_name'"
+      #
+      # They are not tied to any event type by their filenames
+      # its up to the writers of the handlers to make sure
+      # the webhook that calls them is sending the correct event
+      # type.
+      #
+      # The data structure of @named_handlers is a
+      # Hash of Strings to Pathnames or Anon Objects:
+      # {
+      #     handler_filename => Pathname or Obj,
+      #     handler_filename => Pathname or Obj,
+      #     handler_filename => Pathname or Obj
+      # }
+      #
+      # @return [Hash {String => Pathname, Proc}]
+      def self.named_handlers
+        @named_handlers ||= {}
+      end
+
+      # the Pathname objects for all loaded handlers
+      #
+      # @return [Array<Pathname>]
+      #
+      def self.all_handler_paths
+        hndlrs = named_handlers.values
+        hndlrs += handlers.values.flatten
+        hndlrs.map do |hndlr|
+          hndlr.is_a?(Pathname) ? hndlr : hndlr.handler_file
+        end
       end
-      @handlers ||= {}
 
       # Load all the event handlers from the handler_dir or an arbitrary dir.
       #
+      #
+      # Handler files must be either:
+      #   - An executable file, which will have the raw JSON from the JSS piped
+      #     to it's stdin when executed
+      # or
+      #   - A non-executable file of ruby code like this:
+      #     Chook.event_handler do |event|
+      #       # your code goes here.
+      #     end
+      #
+      # (see the Chook README for details about writing the ruby handlers)
+      #
       # @param from_dir [String, Pathname] directory from which to load the
       #   handlers. Defaults to CONFIG.handler_dir or DEFAULT_HANDLER_DIR if
       #   config is unset
@@ -120,31 +176,45 @@ module Chook
         # use default if needed
         from_dir ||= DEFAULT_HANDLER_DIR
         handler_dir = Pathname.new(from_dir)
+        named_handler_dir = handler_dir + NAMED_HANDLER_SUBDIR
         load_type = 'Loading'
 
         if reload
+          @reloading = true
           @handlers = {}
+          @named_handlers = {}
           @loaded_handler = nil
           load_type = 'Re-loading'
         end
 
-        Chook.logger.info "#{load_type} handlers from directory: #{handler_dir}"
-
-        unless handler_dir.directory? && handler_dir.readable?
-          Chook.logger.error "Handler directory '#{from_dir}' not a readable directory. No handlers loaded. "
-          return
+        # General Handlers
+        Chook.logger.info "#{load_type} general handlers from directory: #{handler_dir}"
+        if handler_dir.directory? && handler_dir.readable?
+          handler_dir.children.each do |handler_file|
+            load_general_handler(handler_file) if handler_file.file? && handler_file.readable?
+          end
+          Chook.logger.info handlers.empty? ? 'No general handlers found' : "Loaded #{handlers.values.flatten.size} general handlers for #{handlers.keys.size} event triggers"
+        else
+          Chook.logger.error "General handler directory '#{from_dir}' not a readable directory. No general handlers loaded. "
         end
 
-        handler_dir.children.each do |handler_file|
-          load_handler(handler_file) if handler_file.file? && handler_file.readable?
+        # Named Handlers
+        Chook.logger.info "#{load_type} named handlers from directory: #{named_handler_dir}"
+        if named_handler_dir.directory? && named_handler_dir.readable?
+          named_handler_dir.children.each do |handler_file|
+            load_named_handler(handler_file) if handler_file.file? && handler_file.readable?
+          end
+          Chook.logger.info "Loaded #{named_handlers.size} named handlers"
+        else
+          Chook.logger.error "Named handler directory '#{named_handler_dir}' not a readable directory. No named handlers loaded. "
         end
 
-        Chook.logger.info "Loaded #{@handlers.values.flatten.size} handlers for #{@handlers.keys.size} event triggers"
-        @loaded_handler = nil
+        @reloading = false
       end # load handlers
 
-      # Load an event handler from a file.
-      # Handler files must begin with the name of the event they handle,
+      # Load a general event handler from a file.
+      #
+      # General Handler files must begin with the name of the event they handle,
       # e.g. ComputerAdded,  followed by: nothing, a dot, a dash, or
       # and underscore. Case doesn't matter.
       # So all of these are OK:
@@ -154,82 +224,112 @@ module Chook
       # Computeradded-update-ldap
       # There can be as many as desired for each event.
       #
-      # Each must be either:
-      #   - An executable file, which will have the raw JSON from the JSS piped
-      #     to it's stdin when executed
-      # or
-      #   - A non-executable file of ruby code like this:
-      #     Chook.event_handler do |event|
-      #       # your code goes here.
-      #     end
-      #
-      # (see the Chook README for details about writing the ruby handlers)
-      #
-      # @param from_file [Pathname] the file from which to load the handler
+      # @param handler_file [Pathname] the file from which to load the handler
       #
       # @return [void]
       #
-      def self.load_handler(from_file)
-        Chook.logger.debug "Starting load of handler file '#{from_file.basename}'"
-        handler_file = Pathname.new from_file
+      def self.load_general_handler(handler_file)
+        Chook.logger.debug "Starting load of general handler file '#{handler_file.basename}'"
+
         event_name = event_name_from_handler_filename(handler_file)
         unless event_name
-          Chook.logger.debug "Ignoring file '#{from_file.basename}'"
+          Chook.logger.debug "Ignoring general handler file '#{handler_file.basename}': Filename doesn't start with event name"
           return
         end
 
         # create an array for this event's handlers, if needed
-        @handlers[event_name] ||= []
+        handlers[event_name] ||= []
+
+        # external? if so, its executable and we only care about its pathname
+        if handler_file.executable?
+          Chook.logger.info "Loading external general handler file '#{handler_file.basename}' for #{event_name} events"
+          handlers[event_name] << handler_file
+          return
+        end
+
+        # Internal, we store an object with a .handle method
+        Chook.logger.info "Loading internal general handler file '#{handler_file.basename}' for #{event_name} events"
+        load_internal_handler handler_file
+        handlers[event_name] << @loaded_handler if @loaded_handler
+
+      end # self.load_general_handler(handler_file)
+
+      # Load a named event handler from a file.
+      #
+      # Named Handler files can have any name, as they are called directly
+      # from a Jamf webhook via URL.
+      #
+      # @param handler_file [Pathname] the file from which to load the handler
+      #
+      # @return [void]
+      #
+      def self.load_named_handler(handler_file)
+        Chook.logger.debug "Starting load of named handler file '#{handler_file.basename}'"
 
-        return if load_external_handler(handler_file, event_name)
+        # external? if so, its executable and we only care about its pathname
+        if handler_file.executable?
+          Chook.logger.info "Loading external named handler file '#{handler_file.basename}'"
+          named_handlers[handler_file.basename.to_s] = handler_file
+          return
+        end
 
-        load_internal_handler(handler_file, event_name)
-      end # self.load_handler(handler_file)
+        # Internal, we store an object with a .handle method
+        Chook.logger.info "Loading internal named handler file '#{handler_file.basename}'"
+        load_internal_handler handler_file
+        named_handlers[handler_file.basename.to_s] = @loaded_handler if @loaded_handler
+      end # self.load_general_handler(handler_file)
 
       # if the given file is executable, store it's path as a handler for the event
       #
+      # @return [Boolean] did we load an external handler?
       #
-      def self.load_external_handler(handler_file, event_name)
+      def self.load_external_handler(handler_file, event_name, named)
         return false unless handler_file.executable?
 
-        Chook.logger.info "Loading external handler file '#{handler_file.basename}' for #{event_name} events"
+        say_named = named ? 'named ' : ''
+        Chook.logger.info "Loading #{say_named}external handler file '#{handler_file.basename}' for #{event_name} events"
+
+        if named
+          named_handlers[event_name][handler_file.basename.to_s] = handler_file
+        else
+          # store the Pathname, we'll pipe JSON to it
+          handlers[event_name] << handler_file
+        end
 
-        # store the Pathname, we'll pipe JSON to it
-        @handlers[event_name] << handler_file
         true
       end
 
       # if a given path is not executable, try to load it as an internal handler
       #
+      # @param handler_file[Pathname] the handler file
+      #
+      # @return [Object] and anonymous object that has a .handle method
       #
-      def self.load_internal_handler(handler_file, event_name)
+      def self.load_internal_handler(handler_file)
         # load the file. If written correctly, it will
         # put an anon. Object with a #handle method into @loaded_handler
-        Chook.logger.info "Loading internal handler file '#{handler_file.basename}' for #{event_name} events"
-
         unless handler_file.read =~ INTERNAL_HANDLER_BLOCK_START_RE
-          Chook.logger.error "Internal handler file '#{handler_file.basename}' missing event_handler block"
-          return
+          Chook.logger.error "Internal handler file '#{handler_file}' missing event_handler block"
+          return nil
         end
 
         # reset @loaded_handler - the `load` call will refill it
         # see Chook.event_handler
         @loaded_handler = nil
+
         begin
           load handler_file.to_s
           raise '@loaded handler nil after loading file' unless @loaded_handler
         rescue => e
-          Chook.logger.error "FAILED loading internal handler file '#{handler_file.basename}': #{e}"
+          Chook.logger.error "FAILED loading internal handler file '#{handler_file}': #{e}"
           return
         end
 
-        # add a method to the object to get its filename
-        @loaded_handler.define_singleton_method(:handler_file) { handler_file.basename.to_s }
-
-        @handlers[event_name] << @loaded_handler
+        # add a method to the object to get its Pathname
+        @loaded_handler.define_singleton_method(:handler_file) { handler_file }
 
-        Chook.logger.debug "Loaded internal handler file '#{handler_file.basename}'"
-        @loaded_handler = nil
+        # return it
+        @loaded_handler
       end
 
       # Given a handler filename, return the event name it wants to handle

data/lib/chook/event/handled_event_logger.rb

@@ -47,7 +47,7 @@ module Chook
     end
 
     def event_message(msg)
-      "Event #{@event.object_id}: #{msg}"
+      "Event #{@event.id}: #{msg}"
     end
 
     def debug(msg)

data/lib/chook/foundation.rb

@@ -29,6 +29,7 @@ require 'open-uri'
 require 'pathname'
 require 'logger'
 require 'English'
+require 'securerandom'
 
 require 'chook/version'
 require 'chook/procs' # must load before configuration

data/lib/chook/server.rb

@@ -71,6 +71,7 @@ module Chook
     end # self.run
 
     def self.prep_to_run
+      @start_time = Time.now
       log_level ||= Chook.config.log_level
       @log_level = Chook::Procs::STRING_TO_LOG_LEVEL.call log_level
 
@@ -94,6 +95,28 @@ module Chook
       Chook::HandledEvent::Handlers.load_handlers
     end # prep to run
 
+    def self.starttime
+      @start_time
+    end
+
+    def self.uptime
+      @start_time ? "#{humanize_secs(Time.now - @start_time)} ago" : 'Not Running'
+    end
+
+    # Very handy!
+    # lifted from
+    # http://stackoverflow.com/questions/4136248/how-to-generate-a-human-readable-time-range-using-ruby-on-rails
+    #
+    def self.humanize_secs(secs)
+      [[60, :second], [60, :minute], [24, :hour], [7, :day], [52.179, :week], [1_000_000, :year]].map do |count, name|
+        next unless secs.positive?
+
+        secs, n = secs.divmod(count)
+        n = n.to_i
+        "#{n} #{n == 1 ? name : (name.to_s + 's')}"
+      end.compact.reverse.join(' ')
+    end
+
   end # class server
 
 end # module

data/lib/chook/server/public/css/chook.css

@@ -22,6 +22,10 @@
   line-height: 1.6;
 }
 
+#serverstats {
+  vertical-align: bottom;
+}
+
 .def_pronunciation {
   font-style: italic;
   font-size: 1.2em;

data/lib/chook/server/public/js/chook.js

@@ -88,44 +88,23 @@ function hide_handler_viewer() {
 }
 
 // show the handler editor with the selected handler code
-// handler = the path to the hander fle.
-function edit_handler(handler, type) {
-  var code = '';
-  var editing_filename = handler;
-
-  // new handler
-  if (handler == 'new_handler') {
-    editing_filename = new_handler_filename();
-    if (editing_filename == 'Name Already Taken') {
-      code = editing_filename;
-    }
-    document.getElementById("handler_viewer").value = code;
-
-    if (document.getElementById("add_handler_external_radio").checked) {
-      type = 'external';
-    } else {
-      type = 'internal';
-    }
-
-  // existing handler
-  } else {
-    fetch_handler_code(handler) ;
-  }
-  var now_editing = editing_filename + ' (' + type + ')'
-  document.getElementById("currently_viewing_filename").innerHTML = now_editing;
+// handler = the basename of the hander fle.
+function view_handler_code(handler_path, type) {
+  fetch_handler_code(handler_path) ;
+  document.getElementById("currently_viewing_filename").innerHTML = 'Viewing handler file: ' + handler_path + ' (' + type + ')';
   document.getElementById("handler_viewer_div").style.display = 'block';
 }
 
 // get the code for an existing handler into the editor
 function fetch_handler_code(handler) {
-  var editor = document.getElementById("handler_viewer");
-  var url = '/handler_code/' + handler
+  var viewer = document.getElementById("handler_viewer");
+  var url = '/handler_code?filepath=' + encodeURIComponent(handler)
   var xhttp = new XMLHttpRequest();
   xhttp.onreadystatechange = function() {
     if (this.readyState == 4 && this.status == 200) {
-      editor.value = xhttp.responseText;
+      viewer.value = xhttp.responseText;
     } else {
-      editor.value = 'ERROR: File Not Found';
+      viewer.value = 'ERROR: File Not Found';
     }
   };
   xhttp.open("GET", url, true);

data/lib/chook/server/routes.rb

@@ -49,6 +49,7 @@ end # Chook
 
 require 'chook/server/routes/home'
 require 'chook/server/routes/handle_webhook_event'
+require 'chook/server/routes/handle_by_name'
 require 'chook/server/routes/handlers'
 require 'chook/server/routes/login_logout'
 require 'chook/server/routes/log'

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

@@ -0,0 +1,65 @@
+### 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
+
+  # see server.rb
+  class Server < Sinatra::Base
+
+    post '/handler/:handler_name' do
+      # enforce http basic auth if needed
+      protect_via_basic_auth!
+
+      # rewind to ensure read-pointer is at the start
+      request.body.rewind #
+      raw_json = request.body.read
+
+      event = Chook::HandledEvent.parse_event raw_json
+
+      if event.nil?
+        logger.error "Empty JSON from #{request.ip}"
+        result = 400
+      else
+
+        event.logger.debug "START From #{request.ip}, WebHook '#{event.webhook_name}' (id: #{event.webhook_id})"
+        event.logger.debug "Thread id: #{Thread.current.object_id}; JSON: #{raw_json}"
+
+        result = event.handle_by_name params[:handler_name]
+
+        event.logger.debug "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
+
+  end # class
+
+end # module

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

@@ -42,12 +42,12 @@ module Chook
         result = 400
       else
 
-        event.logger.info "START From #{request.ip}, WebHook '#{event.webhook_name}' (id: #{event.webhook_id})"
+        event.logger.debug "START From #{request.ip}, WebHook '#{event.webhook_name}' (id: #{event.webhook_id})"
         event.logger.debug "Thread id: #{Thread.current.object_id}; JSON: #{raw_json}"
 
         result = event.handle
 
-        event.logger.info "END #{result}"
+        event.logger.debug "END #{result}"
       end
 
       # this route shouldn't have a session expiration

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

@@ -35,10 +35,12 @@ module Chook
       'Handlers reloaded'
     end # get /
 
-    # used by javascript to fetch the content of a handler
-    get '/handler_code/:file' do
-      file = Chook.config.handler_dir + params[:file]
-      if file.file?
+    # used by javascript to fetch the content of a handler file
+    get '/handler_code' do
+      file = Pathname.new params[:filepath]
+
+      # only if its a known handler path
+      if Chook::HandledEvent::Handlers.all_handler_paths.include?(file) && file.file?
         body file.read
       else
         404

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

@@ -39,13 +39,28 @@ module Chook
             file = handler
             type = :external
           else
-            file = Pathname.new(Chook.config.handler_dir) + handler.handler_file
+            file = handler.handler_file
             type = :internal
           end # if else
           @handlers_for_admin_page << { event: eventname, file: file, type: type }
         end # handlers each
       end # Handlers.handlers.each
 
+      # a list of current named handlers for the admin page
+      @named_handlers_for_admin_page = []
+
+      Chook::HandledEvent::Handlers.named_handlers.each do |name, handler|
+        if handler.is_a? Pathname
+          file = handler
+          type = :external
+        else
+          file = handler.handler_file
+          type = :internal
+        end # if else
+        @named_handlers_for_admin_page << { file: file, type: type }
+      end # handlers each
+
+
       # the current config, for the admin page
       @config_text =
         if Chook::Configuration::DEFAULT_CONF_FILE.file?

data/lib/chook/server/views/handlers.haml

@@ -5,33 +5,49 @@
     Hide
       
 
-  Current Webhook Handlers (#{@handlers_for_admin_page.size})
-
-#handlers_div
-
-  Handler Directory:
-  %span.monospaced= Chook.config.handler_dir.to_s
-      
+  Current Webhook Handlers (#{@handlers_for_admin_page.size + @named_handlers_for_admin_page.size})
 
   %button#reload_all_handlers_btn{ type: 'button', onClick: 'reload_handlers();', title: 'reload all handlers' }
-    Reload
+    Reload All
     
   %span#reloaded_notification
 
+#handlers_div
+  General Handler Directory:
+  %span.monospaced= Chook.config.handler_dir.to_s
+      
+
   %table#handlers_table
     %tr#handlers_table_header_row
-      %th.handlers_table_cell Event
-      %th.handlers_table_cell{ width: '10%' } Handler Type
       %th.handlers_table_cell File Name
+      %th.handlers_table_cell{ width: '10%' } Handler Type
       %th.handlers_table_cell Actions
 
     - @handlers_for_admin_page.each do |hndlr_info|
       %tr
-        %td.handlers_table_cell= hndlr_info[:event]
+        %td.handlers_table_cell= hndlr_info[:file].basename.to_s
         %td.handlers_table_cell= hndlr_info[:type].to_s
+        %td.handlers_table_cell
+          %button.edit_handler_btn{ type: 'button', onClick: "view_handler_code('#{hndlr_info[:file]}', '#{hndlr_info[:type]}');", title: 'View this handler' }
+            View
+  %br
+  %br
+  Named Handler Directory:
+  %span.monospaced= Chook.config.handler_dir.to_s + "/#{Chook::HandledEvent::Handlers::NAMED_HANDLER_SUBDIR}"
+      
+
+  %table#handlers_table
+    %tr#handlers_table_header_row
+      %th.handlers_table_cell File Name
+      %th.handlers_table_cell{ width: '10%' } Handler Type
+      %th.handlers_table_cell Actions
+
+    - @named_handlers_for_admin_page.each do |hndlr_info|
+      %tr
         %td.handlers_table_cell= hndlr_info[:file].basename.to_s
+        %td.handlers_table_cell= hndlr_info[:type].to_s
         %td.handlers_table_cell
-          %button.edit_handler_btn{ type: 'button', onClick: "edit_handler('#{hndlr_info[:file].basename}', '#{hndlr_info[:type]}');", title: 'View this handler' }
+          %button.edit_handler_btn{ type: 'button', onClick: "view_handler_code('#{hndlr_info[:file]}', '#{hndlr_info[:type]}');", title: 'View this handler' }
             View
 
   #handler_viewer_div
@@ -41,7 +57,6 @@
       %button#hide_handler_viewer_btn{ type: 'button', onClick: 'hide_handler_viewer();', title: 'hide the handler editor' }
         Hide
           
-      Viewing handler:   
       %span.monospaced#currently_viewing_filename -nothing-
 
 

data/lib/chook/server/views/layout.haml

@@ -34,6 +34,11 @@
               %span.def_dialect Australian/NZ informal
               %br/
               %span.def_definition a chicken or fowl
+          %td#serverstats{ valign: 'bottom' }
+            Server started: #{Chook::Server.starttime.strftime '%Y-%m-%d %H:%M:%S'}
+            %br/
+            (#{Chook::Server.uptime})
+
     %hr/
     - if Chook.config.admin_user
       #login_logout_div

data/lib/chook/server/views/logstream.haml

@@ -5,8 +5,17 @@
     Hide
       
 
-  The Live Chook Log
+  The Live Chook Log     
 
+  Server Log Level:
+  %select#log_level_select{ onchange: 'change_log_level();',
+    title: 'changes here affect logging the server, not just your view' }
+
+    %option{ value: 'fatal', selected: Chook.logger.level == Logger::FATAL } fatal
+    %option{ value: 'error', selected: Chook.logger.level == Logger::ERROR } error
+    %option{ value: 'warn', selected: Chook.logger.level == Logger::WARN } warn
+    %option{ value: 'info', selected: Chook.logger.level == Logger::INFO } info
+    %option{ value: 'debug', selected: Chook.logger.level == Logger::DEBUG } debug
 
 #logbox_div
   #logbox_btns
@@ -19,14 +28,6 @@
 
         
 
-    Server Log Level:
-    %select#log_level_select{ onchange: 'change_log_level();',
-      title: 'changes here affect logging the server, not just your view' }
 
-      %option{ value: 'fatal', selected: Chook.logger.level == Logger::FATAL } fatal
-      %option{ value: 'error', selected: Chook.logger.level == Logger::ERROR } error
-      %option{ value: 'warn', selected: Chook.logger.level == Logger::WARN } warn
-      %option{ value: 'info', selected: Chook.logger.level == Logger::INFO } info
-      %option{ value: 'debug', selected: Chook.logger.level == Logger::DEBUG } debug
 
   %textarea.monospaced#logbox{ readonly: true, rows: 20 }

data/lib/chook/subject.rb

@@ -49,6 +49,11 @@ module Chook
     # Chook::HandledSubjects and Chook::TestSubjects
     COMPUTER = 'Computer'.freeze
 
+    # The name of the DeviceAddedtoDEP subject (a.k.a. 'event_object')
+    # as known to the JSS. Also the class name of such subjects in
+    # Chook::HandledSubjects and Chook::TestSubjects
+    DEP_DEVICE = 'DEPDevice'.freeze
+
     # The name of the JSS subject (a.k.a. 'event_object')
     # as known to the JSS. Also the class name of such subjects in
     # Chook::HandledSubjects and Chook::TestSubjects
@@ -64,6 +69,11 @@ module Chook
     # Chook::HandledSubjects and Chook::TestSubjects
     PATCH_SW_UPDATE = 'PatchSoftwareTitleUpdated'.freeze
 
+    # The name of the ComputerPolicyFinished subject (a.k.a. 'event_object')
+    # as known to the JSS. Also the class name of such subjects in
+    # Chook::HandledSubjects and Chook::TestSubjects
+    POLICY_FINISHED = 'PolicyFinished'.freeze
+
     # The name of the Push subject (a.k.a. 'event_object')
     # as known to the JSS. Also the class name of such subjects in
     # Chook::HandledSubjects and Chook::TestSubjects
@@ -140,3 +150,5 @@ require 'chook/subject/rest_api_operation'
 require 'chook/subject/scep_challenge'
 require 'chook/subject/smart_group'
 require 'chook/test_subjects'
+require 'chook/subject/dep_device'
+require 'chook/subject/policy_finished'

data/lib/chook/subject/dep_device.rb

@@ -0,0 +1,81 @@
+### Copyright 2020 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::Subject.classes[Chook::Subject::DEP_DEVICE] = {
+  assetTag: {
+    validation: String,
+    # randomizer: ,
+    # sampler: ,
+    # api_object_attribute:
+  },
+  description: {
+    validation: String,
+    randomizer: :word,
+    # sampler: ,
+    # api_object_attribute:
+  },
+  deviceAssignedDate: {
+    to_json: :to_jss_epoch,
+    validation: Time,
+    randomizer: :time,
+    # sampler: ,
+    # api_object_attribute:
+  },
+  deviceEnrollmentProgramInstanceId: {
+    validation: Integer,
+    randomizer: :int,
+    # sampler: ,
+    # api_object_attribute:
+  },
+  model: {
+    validation: String,
+    randomizer: [:computer_model, :mobile_model], # /:
+    # sampler: ,
+    api_object_attribute: [:hardware, :model]
+  },
+  serialNumber: {
+    validation: String, #:validate_serial_number,
+    # randomizer: :computer_serial_number,
+    # sampler: ,
+    api_object_attribute: :serial_number
+  }
+}
+
+# https://www.jamf.com/developers/webhooks/#deviceaddedtoDEP
+# {
+#     "event": {
+#         "assetTag": "1664194",
+#         "description": "Mac Pro",
+#         "deviceAssignedDate": 1552478234000,
+#         "deviceEnrollmentProgramInstanceId": 1,
+#         "model": "Mac Pro",
+#         "serialNumber": "92D8014694C4BE96B3"
+#     },
+#     "webhook": {
+#         "eventTimestamp": 1553550275590,
+#         "id": 1,
+#         "name": "Webhook Documentation",
+#         "webhookEvent": "DeviceAddedToDEP"
+#     }
+# }

data/lib/chook/subject/policy_finished.rb

@@ -0,0 +1,43 @@
+### 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.
+###
+###
+
+# Add the attrbutes of a Computer subject to the Chook::Subject.attributes
+# hash, to be used in defining Chook::TestSubjects::Computer and
+# Chook::HandledSubjects::Computer
+#
+Chook::Subject.classes[Chook::Subject::POLICY_FINISHED] = {
+  computer: {
+    validation: Hash,
+    api_object_attribute: :computer
+  },
+  policyId: {
+    validation: Integer,
+    api_object_attribute: :policyId
+  },
+  successful: {
+    validation: :boolean,
+    api_object_attribute: :successful
+  }
+}

data/lib/chook/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chook
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.5b1
 platform: ruby
 authors:
 - Chris Lasell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-24 00:00:00.000000000 Z
+date: 2020-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -87,6 +87,7 @@ files:
 - README.md
 - bin/chook-server
 - data/chook.conf.example
+- data/com.pixar.chook-server.plist
 - data/sample_handlers/RestAPIOperation-executable
 - data/sample_handlers/RestAPIOperation.rb
 - data/sample_handlers/SmartGroupComputerMembershipChange-executable
@@ -131,6 +132,7 @@ files:
 - lib/chook/server/public/js/chook.js
 - lib/chook/server/public/js/logstream.js
 - lib/chook/server/routes.rb
+- lib/chook/server/routes/handle_by_name.rb
 - lib/chook/server/routes/handle_webhook_event.rb
 - lib/chook/server/routes/handlers.rb
 - lib/chook/server/routes/home.rb
@@ -145,10 +147,12 @@ files:
 - lib/chook/server/views/sketch_admin
 - lib/chook/subject.rb
 - lib/chook/subject/computer.rb
+- lib/chook/subject/dep_device.rb
 - lib/chook/subject/handled_subject.rb
 - lib/chook/subject/jss.rb
 - lib/chook/subject/mobile_device.rb
 - lib/chook/subject/patch_software_title_update.rb
+- lib/chook/subject/policy_finished.rb
 - lib/chook/subject/push.rb
 - lib/chook/subject/randomizers.rb
 - lib/chook/subject/rest_api_operation.rb
@@ -175,12 +179,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A Ruby framework for simulating and processing Jamf Pro Webhook Events