chook 1.0.0.b1

data/lib/chook/subject/smart_group.rb

@@ -0,0 +1,50 @@
+### 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::SMART_GROUP] = {
+  name: {
+    validation: String,
+    randomizer: :word,
+    # sampler: :smart_group,
+    api_object_attribute: :name
+  },
+  smartGroup: {
+    validation: :boolean,
+    randomizer: Chook::Procs::ALWAYS_TRUE, # If this were false, it wouldn't be a Smart Group...
+    # sampler: Chook::Procs::ALWAYS_TRUE,
+    api_object_attribute: :is_smart
+  },
+  jssid: {
+    validation: Integer,
+    randomizer: :int,
+    # sampler: :smart_group_jssid,
+    api_object_attribute: :id
+  },
+  computer: { # SmartGroupComputerMembershipChange == true, SmartGroupMobileDeviceMembershipChange == false
+    validation: :boolean,
+    randomizer: :bool,
+    # sampler: ,
+    # api_object_attribute: :computer
+  }
+}

data/lib/chook/subject/test_subject.rb

@@ -0,0 +1,195 @@
+### 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 with a TestEvent class, to be sent to
+  # a Webhook server, simulating one from the JSS.
+  #
+  # This is the parent class to all classes in the Chook::TestSubjects module.
+  #
+  # All constants, methods, and attributes that are common to TestSubject
+  # classes are defined here.
+  #
+  class TestSubject < Chook::Subject
+
+    # Dynamically generate the varios subclasses to TestSubject
+    # and store them in the TestSubjects module.
+    def self.generate_classes
+      Chook::Subject.classes.each do |classname, attribs|
+        # Don't redefine anything.
+        next if Chook::TestSubjects.const_defined? classname
+
+        # new subclass of Chook::TestSubject
+        new_class = Class.new(Chook::TestSubject) do
+          # add getter, setters, validators for all the attribs.
+          attribs.each do |attrib, deets|
+            # getter
+            attr_reader attrib
+            validator = deets[:validation]
+
+            # setter with validator
+            define_method("#{attrib}=") do |new_val|
+              if validator.is_a? Class
+                raise "Invalid value for #{attrib}, must be a #{validator}" unless new_val.is_a? validator
+              elsif !validator.nil?
+                raise "Invalid value for #{attrib}" unless Chook::Validators.send validator, new_val
+              end
+              instance_variable_set(('@' + attrib.to_s), new_val)
+            end # end define method
+          end # end do |attrib, deets|
+        end # end new_class
+        # 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::TestSubjects module
+        Chook::TestSubjects.const_set classname, new_class
+      end # end Chook::Subject.classes.each do |classname, attribs|
+    end # end generate_classes
+
+    # a random test subject,
+    def self.random
+      random_vals = {}
+      Chook::Subject.classes[].each do |attrib, deets|
+        random_vals[attrib] = Chook::Randomizers.send deets[:randomizer]
+      end # each do |attr_def|
+      new random_vals
+    end # end random
+
+    # a sampled test subject (real data from real JSS objects)
+    # NOTE: a valid ruby-jss JSS::APIConnection must exist
+    def self.sample(ids = 'random', api: JSS.api)
+      classname = self.const_get Chook::Subject::NAME_CONSTANT
+      ids = [ids] if ids.is_a? Integer
+      # !!Kernel.const_get('JSS::' + classname) rescue false
+      if classname == 'PatchSoftwareTitleUpdated'
+        all_ids = Chook::Samplers.all_patch_ids('blah', api: api)
+      else
+        all_ids = Kernel.const_get('JSS::' + classname).all_ids(api: api) # (api: api)
+      end
+      ids = [all_ids.sample] if ids == 'random'
+
+      ok = true
+      if ids.is_a? Array
+        ids.each { |id| ok == false unless id.is_a? Integer }
+      else
+        ok = false
+      end
+      raise 'ids must be an Array of Integers' unless ok
+
+      raw_samples = []
+      samples = []
+
+      valid_ids = ids & all_ids
+      raise "Invalid JSS IDs: #{ids}" if valid_ids.empty?
+
+      valid_ids.each do |id|
+        if classname == 'PatchSoftwareTitleUpdated'
+          raw_samples << Chook::Samplers.all_patches(api: api).select { |patch| patch[:id] == id }
+          raw_samples.flatten!
+        else
+          raw_samples << Kernel.const_get('JSS::' + classname).fetch(id: id, api: api)
+        end
+      end
+
+      raw_samples.each do |sample|
+        subject_details = {}
+        Chook::Subject.classes[classname].map do |subject_key, details|
+          extractor = details[:api_object_attribute]
+          subject_details[subject_key] =
+            case extractor
+            when Symbol
+              if classname == 'PatchSoftwareTitleUpdated'
+                # If there is a sampler method available, call it.
+                if details[:sampler]
+                  extractor = details[:sampler]
+                  Chook::Samplers.send(extractor, sample)
+                else
+                  # Otherwise use it like a hash key
+                  sample[extractor]
+                end
+              else
+                sample.send extractor
+              end
+            when Array
+              extractor = extractor.dup # If this doesn't get duplicated, shift will change details[:api_object_attribute]
+              method = extractor.shift
+              raw_hash_keys = extractor
+              method_result = sample.send(method)
+              raw_hash_keys.each { |key| method_result = method_result[key] }
+              method_result
+            when Proc
+              extractor.call sample
+            end
+        end # do |subject_key, details|
+        samples << Kernel.const_get('Chook::TestSubjects::' + classname).new(subject_details)
+      end # end samples.each do |sample|
+      samples
+    end # end sample
+
+    def json_hash
+      # Verify that input is a child of TestSubjects, raise if not
+      raise 'Invalid TestSubject' unless self.class.superclass == Chook::TestSubject
+      test_subject_attributes = Chook::Subject.classes[self.class.to_s.split('::')[-1]]
+      raw_hash_form = {}
+      test_subject_attributes.each do |attribute, details|
+        if details.keys.include? :to_json
+          raw_hash_form[attribute] = send(attribute).send details[:to_json]
+        else
+          raw_hash_form[attribute] = instance_variable_get('@' + attribute.to_s)
+        end
+      end # end test_subject_attributes.keys.each do |attribute, details|
+      raw_hash_form
+    end # end json_hash
+
+    # All the subclassses will inherit this constructor
+    #
+    # The argument is a Hash with keys from the appropriate keys defiend
+    # in Chook::Subject.classes
+    #
+    def initialize(subject_data = nil)
+      classname = self.class.const_get Chook::Subject::NAME_CONSTANT
+      attribs = Chook::Subject.classes[classname]
+
+      if subject_data
+        subject_data.each do |key, value|
+          # ignore unknown attributes. Shouldn't get any, but...
+          next unless attribs[key]
+
+          # does the value need conversion?
+          converter = attribs[key][:converter]
+          if converter
+            value = converter.is_a?(Symbol) ? value.send(converter) : converter.call(value)
+          end # if converter
+          instance_variable_set(('@' + key.to_s), value)
+        end # each key value
+      else
+        attribs.keys.each { |key| instance_variable_set(('@' + key.to_s), nil) }
+      end # if subject_data
+    end # init
+
+  end # class TestSubject
+
+end # module

data/lib/chook/subject/validators.rb

@@ -0,0 +1,117 @@
+require 'uri'
+
+module Chook
+
+  # A namespace to hold validation methods for use with
+  # Test Events and Test Subjects.
+  # Each method taks a value, and returns a boolean
+  # indicating the validity of the value.
+  #
+  module Validators
+
+    # Validate MAC Address
+    #
+    # @param [String] MAC address formatted String
+    # @return [Boolean]
+    #
+    def self.mac_address(mac)
+      mac =~ /^([a-f\d]{2}:){5}[a-f\d]{2}$/i ? true : false
+    end # end mac_address
+
+    # Validate E-mail Address
+    #
+    # @param [String] E-mail address formatted String e.g. FirstNameLastName@randomword.com
+    # @return [Boolean]
+    #
+    def self.email(email_address)
+      email_address =~ /^[a-zA-Z]([\w -]*[a-zA-Z])\@\w*\.\w*$/ ? true : false
+    end # end email
+
+    # Validate URL
+    #
+    # @param [String] URL formatted String
+    # @return [Boolean]
+    #
+    def self.url(url)
+      uri = URI.parse(url)
+      uri.is_a?(URI::HTTP) && !uri.host.nil? ? true : false
+    end # end url
+
+    # Validate Serial Number
+    #
+    # @param [String] Serial Number Formatted String
+    # @return [Boolean]
+    #
+    def self.serial_number(serial)
+      raise TypeError unless serial.is_a? String
+      serial_array = serial.scan(/\w/)
+      return false if serial.empty?
+      serial_array.each_with_index do |character, index|
+        return false unless (Chook::Randomizers::MOBILE_SERIAL_CHARACTER_SETS[index].include? character) || (Chook::Randomizers::COMPUTER_SERIAL_CHARACTER_SETS[index].include? character)
+      end
+      true
+    end # end serial_number
+
+    # Validate Push
+    #
+    # @param [String] Push Type
+    # @return [Boolean]
+    #
+    def self.push(push)
+      raise TypeError unless push.is_a? String
+      return false if push.empty?
+      return false unless Chook::Randomizers::PUSH_COMMANDS.include? push
+      true
+    end # end push
+
+    # Validate IMEI
+    #
+    # @param [String] A 17-15 digit sequence of numbers
+    # @return [Boolean]
+    #
+    def self.imei(imei)
+      imei_length = imei.delete(' ').size
+      (15...17).cover? imei_length
+    end # end imei
+
+    # Validate ICCID
+    #
+    # @param [String] ICCID
+    # @return [Boolean]
+    #
+    def self.iccid(iccid)
+      iccid_length = iccid.delete(' ').size
+      return true if iccid_length < 23
+    end # end iccid
+
+    # Validate Boolean
+    #
+    # @param [Boolean] Make sure input is valid Boolean, because Ruby doesn't have a Boolean Class
+    # @return [Boolean]
+    #
+    def self.boolean(true_or_false)
+      [true, false].include? true_or_false
+    end # end boolean
+
+    # Validate Patch
+    #
+    # @param [String] Name of a Patch Reporting Software Title
+    # @return [Boolean]
+    #
+    def self.patch(patch_name)
+      Chook::Randomizers::PATCH_SOFTWARE_TITLES.include? patch_name
+    end # end patch
+
+    # Validate Test Subject
+    #
+    # @param [String] Name of an Event class
+    # @param [Chook::TestSubjects] An instance of a Chook::TestSubjects subclass
+    # @return [Boolean]
+    #
+    def self.valid_test_subject(event_class, subject)
+      Chook::Event::EVENTS[event_class].include? subject.class.to_s.split('::')[-1]
+    end # end valid_test_subject
+
+  end # module validators
+
+end # module Chook

data/lib/chook/test_events.rb

@@ -0,0 +1,33 @@
+### Copyright 2017 Pixar
+
+###
+###    Licensed under the Apache License, Version 2.0 (the "Apache License")
+###    with the following modification; you may not use this file except in
+###    compliance with the Apache License and the following modification to it:
+###    Section 6. Trademarks. is deleted and replaced with:
+###
+###    6. Trademarks. This License does not grant permission to use the trade
+###       names, trademarks, service marks, or product names of the Licensor
+###       and its affiliates, except as required to comply with Section 4(c) of
+###       the License and to reproduce the content of the NOTICE file.
+###
+###    You may obtain a copy of the Apache License at
+###
+###        http://www.apache.org/licenses/LICENSE-2.0
+###
+###    Unless required by applicable law or agreed to in writing, software
+###    distributed under the Apache License with the above modification is
+###    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+###    KIND, either express or implied. See the Apache License for the specific
+###    language governing permissions and limitations under the Apache License.
+###
+###
+
+module Chook
+
+  # This class is a namespace holding all of the classes that are
+  # subclasses of Chook::TestEvent, q.v.
+  #
+  class TestEvents; end # class TestEvents
+
+end # class Chook

data/lib/chook/test_subjects.rb

@@ -0,0 +1,33 @@
+### Copyright 2017 Pixar
+
+###
+###    Licensed under the Apache License, Version 2.0 (the "Apache License")
+###    with the following modification; you may not use this file except in
+###    compliance with the Apache License and the following modification to it:
+###    Section 6. Trademarks. is deleted and replaced with:
+###
+###    6. Trademarks. This License does not grant permission to use the trade
+###       names, trademarks, service marks, or product names of the Licensor
+###       and its affiliates, except as required to comply with Section 4(c) of
+###       the License and to reproduce the content of the NOTICE file.
+###
+###    You may obtain a copy of the Apache License at
+###
+###        http://www.apache.org/licenses/LICENSE-2.0
+###
+###    Unless required by applicable law or agreed to in writing, software
+###    distributed under the Apache License with the above modification is
+###    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+###    KIND, either express or implied. See the Apache License for the specific
+###    language governing permissions and limitations under the Apache License.
+###
+###
+
+module Chook
+
+  # This module is a namespace holding all of the classes that are
+  # subclasses of Chook::TestSubject, q.v.
+  #
+  module TestSubjects; end # module TestSubjects
+
+end # module

data/lib/chook/version.rb

@@ -0,0 +1,32 @@
+### 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
+
+  ### The version of the Chook framework
+  VERSION = '1.0.0.b1'.freeze
+
+end # module