ruby-jss 0.6.5 → 0.6.6

data/lib/jss/webhooks/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/lib/jss/webhooks/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/lib/jss/webhooks/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/lib/jss/webhooks/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/lib/jss/webhooks/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
+  }
+}

data/lib/jss/webhooks/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/lib/jss/webhooks/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/lib/jss/webhooks/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/lib/jss/webhooks/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/lib/jss/webhooks/data/sample_jsons/PushSent.json

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

data/lib/jss/webhooks/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/lib/jss/webhooks/data/sample_jsons/SCEPChallenge.json

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

data/lib/jss/webhooks/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/lib/jss/webhooks/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/jss/webhooks/event.rb

@@ -0,0 +1,138 @@
+### Copyright 2016 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 JSSWebHooks
+
+  # The superclass of all webhook events.
+  #
+  # Almost all processing happens here in the Superclass. The Subclasses
+  # define specfic-event-related details.
+  # As such, the Subclasses must define these constants:
+  #
+  # HANDLER_KEY = The JSSWebHooks::Configuration key pointing to the handler
+  #   file for this event. See Event#handle for details.
+  #
+  # OBJECT_CLASS = the JSSWebHooks::EventObjects (q.v.) class representing the
+  #   event object with this event
+  #
+  class Event
+
+    #########################
+    # Class Instance Variables
+
+    # Holds a mapping of Event names as they come from the JSS to the
+    # Event subclasses that represent them. Will be populated
+    # as the event subclasses are required.
+    @event_to_class_names ||= {}
+
+    # Getter for @event_to_class_names
+    #
+    # @return [Hash{String => Class} a mapping of Event names as they come from
+    #   the JSS to the JSSWebHooks::Event subclasses that represent them
+    #
+    def self.event_to_class_names
+      @event_to_class_names
+    end
+
+    # Given the raw json from the JSS webhook,
+    # create an object of the correct Event subclass
+    #
+    # @param [String] raw_event_json The JSON http POST content from the JSS
+    #
+    # @return [JSSWebHooks::Event subclass] the Event subclass matching the event
+    #
+    def self.parse_event(raw_event_json)
+      event_json = JSON.parse(raw_event_json, symbolize_names: true)
+      event_name = event_json[:webhook][:webhookEvent]
+      JSSWebHooks::Event.event_to_class_names[event_name].new event_json, raw_event_json
+    end
+
+    # @return [String] the raw JSON recieved from the JSS
+    attr_reader :raw_json
+
+    # @return [Hash] The parsed JSON recieved from the JSS
+    attr_reader :event_json
+
+    # @return [JSSWebHooks::WebHook] The webhook in the JSS that caused this event
+    attr_reader :webhook
+
+    # @return [JSSWebHooks::EventObjects class] The event object sent with the event
+    attr_reader :event_object
+
+    # @return [Array<Proc,Pathname>] the handlers defined for this event
+    attr_reader :handlers
+
+    def initialize(event_json, raw_json)
+      @event_json = event_json
+      @raw_json = raw_json
+
+      # make a WebHook instance out of the webhook data for the event
+      @webhook = WebHook.new(event_json[:webhook])
+
+      # make an Event Objects class instance for the event object that
+      # came with this event.
+      @event_object = self.class::OBJECT_CLASS.new(event_json[:event])
+
+      # An array of handlers for this event type.
+      @handlers = JSSWebHooks::Event::Handlers.event_handlers[self.class::EVENT_NAME]
+      @handlers ||= []
+    end # init
+
+    def handle
+      @handlers.each do |handler|
+        case handler
+        when Pathname
+          pipe_to_executable handler
+        when Proc
+          handle_with_proc handler
+        end # case
+      end # @handlers.each do |handler|
+
+      # the handle method should return a string, since
+      # it's what gets called by the Post processor
+      # and it's output it returned as the HTTP Result
+      # body.
+      "Processed by #{@handlers.count} handlers"
+    end # def handle
+
+    # TODO: have something here that
+    # cleans up old threads and forks
+    def pipe_to_executable(handler)
+      thread = Thread.new do
+        IO.popen([handler.to_s], 'w') { |h| h.puts @raw_json }
+      end
+    end
+
+    def handle_with_proc(handler)
+      thread = Thread.new { handler.call self }
+    end
+
+  end # class event
+
+end # module
+
+# load in the subclass definitions
+Pathname.new(__FILE__).parent.+('event').children.each do |file|
+  require file.to_s if file.extname == '.rb'
+end

data/lib/jss/webhooks/event/computer_added.rb

@@ -0,0 +1,37 @@
+### Copyright 2016 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 JSSWebHooks
+
+  class ComputerAddedEvent < Event
+
+    EVENT_NAME = 'ComputerAdded'.freeze
+    OBJECT_CLASS = JSSWebHooks::EventObjects::Computer
+
+  end # class
+
+  # map the EVENT_NAME (which comes from the JSS) with this class
+  JSSWebHooks::Event.event_to_class_names[ComputerAddedEvent::EVENT_NAME] = ComputerAddedEvent
+
+end # module