chook 1.0.0.b1

data/lib/chook/subject.rb

@@ -0,0 +1,143 @@
+### 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 Subject objects, both handled and test.
+  # It holds constants, methods, and attributes that are common to all
+  # subjects in Chook
+  #
+  # A 'subject' within Chook is the ruby-abstraction of a the 'event_object'
+  # part of the JSON payload of an event.
+  #
+  # 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.
+  # Those attributes are objects which are subclasses of Chook::Subject, q.v.
+  #
+  class Subject
+
+    # the various subclasses of Subject will have a constant
+    # SUBJECT_NAME that contains a string - the name of the
+    # subject as known to the JSS
+    NAME_CONSTANT = 'SUBJECT_NAME'.freeze
+
+    # The name of the Computer subject (a.k.a. 'event_object')
+    # as known to the JSS. Also the class name of such subjects in
+    # Chook::HandledSubjects and Chook::TestSubjects
+    COMPUTER = 'Computer'.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
+    JAMF_SOFTWARE_SERVER = 'JSS'.freeze
+
+    # The name of the MobileDevice subject (a.k.a. 'event_object')
+    # as known to the JSS. Also the class name of such subjects in
+    # Chook::HandledSubjects and Chook::TestSubjects
+    MOBILE_DEVICE = 'MobileDevice'.freeze
+
+    # The name of the PatchSoftwareTitleUpdated subject (a.k.a. 'event_object')
+    # as known to the JSS. Also the class name of such subjects in
+    # Chook::HandledSubjects and Chook::TestSubjects
+    PATCH_SW_UPDATE = 'PatchSoftwareTitleUpdated'.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
+    PUSH = 'Push'.freeze
+
+    # The name of the RestAPIOperation subject (a.k.a. 'event_object')
+    # as known to the JSS. Also the class name of such subjects in
+    # Chook::HandledSubjects and Chook::TestSubjects
+    REST_API_OPERATION = 'RestAPIOperation'.freeze
+
+    # The name of the SCEPChallenge subject (a.k.a. 'event_object')
+    # as known to the JSS. Also the class name of such subjects in
+    # Chook::HandledSubjects and Chook::TestSubjects
+    SCEP_CHALLENGE = 'SCEPChallenge'.freeze
+
+    # The name of the SmartGroup subject (a.k.a. 'event_object')
+    # as known to the JSS. Also the class name of such subjects in
+    # Chook::HandledSubjects and Chook::TestSubjects
+    SMART_GROUP = 'SmartGroup'.freeze
+
+    # Define a 'classes' class method (actually a class-instance attribute)
+    # that defines all of the possible Subject subclasses so they can
+    # be dynamically created.
+    #
+    # The definitions will be added as the subject-files are loaded.
+    #
+    # This method returns a Hash with one item per subject-type.
+    #
+    # The key is the subject name [String] as known to the JSS and is defined
+    # in a Constant in Chook::Subject, e.g. Chook::Subject::COMPUTER = 'Computer'.
+    # That name is also used for the class names of the subject classes
+    # in the HandledSubjects and TestSubjects modules.
+    #
+    # The values are also hashes, with one item per attribute for that
+    # subject-type.  The keys are the attribute names as Symbols, and the
+    # values are hashes defining the attribute. Attributes may have these keys:
+    #    :converter => a Proc or a method-name (as a Symbol) to convert the raw
+    #      value to its interally stored version. E.g. Time objects in JSON
+    #      are left as Strings by the JSON.parse method. A converter can be
+    #      used to make it a Time object.
+    #    :validation => Class or Proc. When creating a TestSubject, this
+    #      attribute is settable, and new values are validated. If a Class, then
+    #      the new value must be an instance of the class. If a Proc, the value
+    #      is passed to the proc, which must return True.
+    #    :randomizer => Symbol. When creating a TestSubject,
+    #      this is the class-method to call on Chook::TestSubject
+    #      to generate a valid random value for this attribute.
+    #    :sampler => Symbol: When creating a TestSubject, this is the
+    #      Chook::TestSubject class method which will pull a random value from
+    #      a real JSS.
+    #    :api_object_attribute => Symbol or Array of Symbols or a Proc:
+    #       When creating a TestSubject, this represents the location of values in an API object
+    #       Symbol: A method name to call on an API object
+    #       Array: Array[0] is a method name to call on an API object
+    #         subsequent items are Hash keys to be called on Array[0]'s output
+    #       Proc: Pass an API object to the PROC to get a value
+    #
+    def self.classes
+      @classes
+    end
+    @classes = {}
+
+  end # class Subject
+
+end # module
+
+# The subject definitions must be loaded before the meta classes
+# so that the metaclasses can create the subject classes
+require 'chook/subject/computer'
+require 'chook/subject/jss'
+require 'chook/subject/mobile_device'
+require 'chook/subject/patch_software_title_update'
+require 'chook/subject/push'
+require 'chook/subject/rest_api_operation'
+require 'chook/subject/scep_challenge'
+require 'chook/subject/smart_group'
+require 'chook/test_subjects'

data/lib/chook/subject/computer.rb

@@ -0,0 +1,121 @@
+### 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::COMPUTER] = {
+  udid: {
+    validation: String,
+    randomizer: :computer_udid,
+    api_object_attribute: :udid
+  },
+  deviceName: {
+    validation: String,
+    randomizer: :word,
+    api_object_attribute: :name
+  },
+  model: {
+    validation: String,
+    randomizer: :computer_model,
+    api_object_attribute: [:hardware, :model]
+  },
+  macAddress: {
+    validation: String, #:validate_mac_address,
+    randomizer: :mac_address,
+    api_object_attribute: :mac_address
+  },
+  alternateMacAddress: {
+    validation: String, #:validate_mac_address, # TODO: sometimes this value is nil !
+    randomizer: :mac_address,
+    api_object_attribute: :alt_mac_address
+  },
+  serialNumber: {
+    validation: String, #:validate_serial_number,
+    randomizer: :computer_serial_number,
+    api_object_attribute: :serial_number
+  },
+  osVersion: {
+    validation: String,
+    randomizer: :computer_os_version,
+    api_object_attribute: [:hardware, :os_version]
+  },
+  osBuild: {
+    validation: String,
+    randomizer: :os_build,
+    api_object_attribute: [:hardware, :os_build]
+  },
+  userDirectoryID: {
+    validation: String,
+    randomizer: :int,
+    api_object_attribute: Chook::Procs::COMPUTER_USERID
+  },
+  username: {
+    validation: String,
+    randomizer: :word,
+    api_object_attribute: :username
+  },
+  realName: {
+    validation: String,
+    randomizer: :name,
+    api_object_attribute: :real_name
+  },
+  emailAddress: {
+    validation: String, #:validate_email,
+    randomizer: :email_address,
+    api_object_attribute: :email_address
+  },
+  phone: {
+    validation: String, #:validate_phone_number,
+    randomizer: :phone,
+    api_object_attribute: :phone
+  },
+  position: {
+    validation: String,
+    randomizer: :word,
+    api_object_attribute: :position
+  },
+  department: {
+    validation: String,
+    randomizer: :word,
+    api_object_attribute: :department
+  },
+  building: {
+    validation: String,
+    randomizer: :word,
+    api_object_attribute: :building
+  },
+  room: {
+    validation: String,
+    randomizer: :room,
+    api_object_attribute: :room
+  },
+  jssID: {
+    validation: Integer,
+    randomizer: :int,
+    api_object_attribute: :id
+  }
+}

data/lib/chook/subject/handled_subject.rb

@@ -0,0 +1,84 @@
+### 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
+
+  # A subject that will be used within a HandledEvent class, to be received by
+  # a Webhook server and processed.
+  #
+  # This is the parent class to all classes in the Chook::HandledSubjects module.
+  #
+  # All constants, methods, and attributes that are common to HandledSubject
+  # classes are defined here.
+  #
+  class HandledSubject < Chook::Subject
+
+    def self.generate_classes
+      Chook::Subject.classes.each do |classname, attribs|
+        # Don't redefine anything.
+        next if Chook::HandledSubjects.const_defined? classname
+
+        # new subclass of Chook::HandledSubject
+        new_class = Class.new(Chook::HandledSubject) do
+          # add getters for all the attributes.
+          # no need for setters, as handled objects are immutable
+          attribs.keys.each { |attrib| attr_reader attrib }
+        end
+
+        # set a class constant so each class knows it's name
+        new_class.const_set Chook::Subject::NAME_CONSTANT, classname
+
+        # add the class to the Chook::HandledSubjects namespace module
+        Chook::HandledSubjects.const_set classname, new_class
+      end # classes.each do |classname, attribs|
+    end # generate_classes
+
+    # All the subclassses will inherit this constructor
+    #
+    # The argument is a Hash, the parsed 'event_object' data
+    # from the JSON blob for a webhook.
+    #
+    def initialize(subject_data_from_json)
+      my_classname = self.class.const_get Chook::Subject::NAME_CONSTANT
+      my_attribs = Chook::Subject.classes[my_classname]
+
+      subject_data_from_json.each do |key, value|
+        # ignore unknown attributes. Shouldn't get any,but....
+        next unless my_attribs[key]
+
+        # does the value need conversion?
+        converter = my_attribs[key][:converter]
+        if converter
+          value = converter.is_a?(Symbol) ? value.send(converter) : converter.call(value)
+        end # if converter
+
+        # set the value.
+        instance_variable_set "@#{key}", value
+      end # each key value
+    end # init
+
+  end # class handled subject
+
+end # module

data/lib/chook/subject/jss.rb

@@ -0,0 +1,56 @@
+### 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::Subject.classes[Chook::Subject::JAMF_SOFTWARE_SERVER] = {
+  institution: {
+    validation: String,
+    randomizer: :word,
+    # sampler: :institution,
+    # api_object_attribute: :institution
+  },
+  hostAddress: {
+    validation: String,
+    randomizer: :host,
+    # sampler: ,
+    # api_object_attribute: :hostAddress
+  },
+  webApplicationPath: {
+    validation: String,
+    # randomizer: ,
+    # sampler: ,
+    # api_object_attribute: :webApplicationPath
+  },
+  isClusterMaster: {
+    validation: :boolean,
+    randomizer: :bool
+    # sampler: ,
+    # api_object_attribute: :isClusterMaster
+  },
+  jssUrl: {
+    validation: :url,
+    randomizer: :url,
+    # sampler: ,
+    # api_object_attribute: :jssUrl
+  }
+}

data/lib/chook/subject/mobile_device.rb

@@ -0,0 +1,115 @@
+### 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::Subject.classes[Chook::Subject::MOBILE_DEVICE] = {
+  udid: {
+    validation: String,
+    randomizer: :mobile_udid,
+    api_object_attribute: :udid
+  },
+  deviceName: {
+    validation: String,
+    randomizer: :word,
+    api_object_attribute: :name
+  },
+  version: {
+    validation: String,
+    randomizer: :version,
+    api_object_attribute: [:network, :carrier_settings_version]
+  },
+  model: {
+    validation: String,
+    randomizer: :mobile_model,
+    api_object_attribute: :model
+  },
+  bluetoothMacAddress: {
+    validation: String, #:validate_mac_address,
+    randomizer: :mac_address,
+    api_object_attribute: :bluetooth_mac_address
+  },
+  wifiMacAddress: {
+    validation: String, #:validate_mac_address,
+    randomizer: :mac_address,
+    api_object_attribute: :wifi_mac_address
+  },
+  imei: {
+    validation: :imei,
+    randomizer: :imei,
+    api_object_attribute: [:network, :imei]
+  },
+  icciID: {
+    validation: String, #:iccid,
+    randomizer: :iccid,
+    api_object_attribute: [:network, :iccid]
+  },
+  product: {
+    # Product is null in the sample JSONs... And there isn't anything labeled "product" in JSS::API.get_rsrc("mobiledevices/id/#{id}")
+    validation: NilClass,
+    randomizer: :product,
+    api_object_attribute: Chook::Procs::PRODUCT
+  },
+  serialNumber: {
+    validation: :serial_number,
+    randomizer: :mobile_serial_number,
+    # sampler: :serial_number,
+    api_object_attribute: :serial_number
+  },
+  userDirectoryID: {
+    # userDirectoryID is -1 in the sample JSONs... And there isn't anything labeled "userDirectoryID" in JSS::API.get_rsrc("mobiledevices/id/#{id}")
+    validation: String,
+    randomizer: Chook::Procs::MOBILE_USERID,
+    api_object_attribute: Chook::Procs::MOBILE_USERID
+  },
+  room: {
+    validation: String,
+    randomizer: :room,
+    api_object_attribute: :room
+  },
+  osVersion: {
+    validation: String,
+    randomizer: :mobile_os_version,
+    api_object_attribute: :os_version
+  },
+  osBuild: {
+    validation: String,
+    randomizer: :os_build,
+    api_object_attribute: :os_build
+  },
+  modelDisplay: {
+    validation: String,
+    randomizer: :mobile_model,
+    api_object_attribute: :model
+  },
+  username: {
+    validation: String,
+    randomizer: :random_word,
+    api_object_attribute: :username
+  },
+  jssID: {
+    validation: Integer,
+    randomizer: :int,
+    api_object_attribute: :id
+  }
+}