ruby-jss 0.7.0 → 0.8.1

data/lib/jss/webhooks/data/sample_jsons/PatchSoftwareTitleUpdated.json

@@ -1,14 +0,0 @@
-{
-  "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

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

data/lib/jss/webhooks/data/sample_jsons/RestAPIOperation.json

@@ -1,15 +0,0 @@
-{
-  "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

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

data/lib/jss/webhooks/data/sample_jsons/SmartGroupComputerMembershipChange.json

@@ -1,13 +0,0 @@
-{
-  "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

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

data/lib/jss/webhooks/event.rb

@@ -1,139 +0,0 @@
-### 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 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

@@ -1,38 +0,0 @@
-### 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 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

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

@@ -1,38 +0,0 @@
-### 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 JSSWebHooks
-
-  class ComputerCheckInEvent < Event
-
-    EVENT_NAME = 'ComputerCheckIn'.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[ComputerCheckInEvent::EVENT_NAME] = ComputerCheckInEvent
-
-end # module

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

@@ -1,38 +0,0 @@
-### 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 JSSWebHooks
-
-  class ComputerInventoryCompletedEvent < Event
-
-    EVENT_NAME = 'ComputerInventoryCompleted'.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[ComputerInventoryCompletedEvent::EVENT_NAME] = ComputerInventoryCompletedEvent
-
-end # module

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

@@ -1,38 +0,0 @@
-### 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 JSSWebHooks
-
-  class ComputerPolicyFinishedEvent < Event
-
-    EVENT_NAME = 'ComputerPolicyFinished'.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[ComputerPolicyFinishedEvent::EVENT_NAME] = ComputerPolicyFinishedEvent
-
-end # module

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

@@ -1,38 +0,0 @@
-### 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 JSSWebHooks
-
-  class ComputerPushCapabilityChangedEvent < Event
-
-    EVENT_NAME = 'ComputerPushCapabilityChanged'.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[ComputerPushCapabilityChangedEvent::EVENT_NAME] = ComputerPushCapabilityChangedEvent
-
-end # module

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

@@ -1,192 +0,0 @@
-### 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 JSSWebHooks
-
-  # This method is used by the Ruby event-handler files.
-  #
-  # Loading them should call this method and pass in a block
-  # with one parameter: a JSS::WebHooks::Event subclass object.
-  #
-  # The block is then converted to a Proc instance in @loaded_event_handler
-  # and from there can be stored for use by the event identified by the filename.
-  #
-  # NOTE: the files should be read with 'load' not 'require', so that they can
-  # be re-loaded as needed
-  #
-  # @see_also JSSWebHooks::load_handlers
-  #
-  # @param [Block] block the block to be used as an event handler
-  #
-  # @yieldparam [JSS::WebHooks::Event subclass] The event to be handled
-  #
-  # @return [Proc] the block converted to a Proc
-  #
-  def self.event_handler(&block)
-    Event::Handlers.loaded_event_handler = Proc.new(&block)
-  end
-
-  class Event
-
-    module Handlers
-
-      ############################
-      # Module constants
-
-      DEFAULT_HANDLER_DIR = '/Library/Application Support/JSSWebHooks'.freeze
-
-      ############################
-      # Module Instance Variables, & accessors
-
-      @loaded_event_handler = nil
-
-      # Getter for @loaded_event_handler
-      #
-      # @return [Proc,nil] the most recent Proc loaded from a handler file.
-      # destined for storage in @event_handlers
-      #
-      def self.loaded_event_handler
-        @loaded_event_handler
-      end
-
-      # Setter for @loaded_event_handler
-      #
-      # @param [Proc] a_proc the most recent Proc loaded from a handler file.
-      # destined for storage in @event_handlers
-      #
-      def self.loaded_event_handler=(a_proc)
-        @loaded_event_handler = a_proc
-      end
-
-      @event_handlers = {}
-
-      # Getter for @event_handlers
-      #
-      # @return [Hash{String => Array}] a mapping of Event Names as the come from
-      # the JSS to an Array of handlers for the event. The handlers are either
-      # Proc objects to call from within ruby, or Pathnames to executable files
-      # which will take raw JSON on stdin.
-      def self.event_handlers
-        @event_handlers
-      end
-
-      ############################
-      # Module Methods
-
-      # Load all the event handlers from the handler_dir or an arbitrary dir.
-      #
-      # @param [String, Pathname] from_dir directory from which to
-      #   load the handlers
-      # @param [Boolean] reload should we reload handlers if they've already
-      #   been loaded?
-      #
-      # @return [void]
-      #
-      def self.load_handlers(from_dir = CONFIG.handler_dir, reload = false)
-        from_dir ||= DEFAULT_HANDLER_DIR
-
-        if reload
-          @handlers_loaded_from = nil
-          @event_handlers = {}
-          @loaded_event_handler = nil
-        end
-
-        handler_dir = Pathname.new(from_dir)
-        return unless handler_dir.directory? && handler_dir.readable?
-
-        handler_dir.children.each do |handler_file|
-          load_handler(handler_file) if handler_file.file? && handler_file.readable?
-        end
-
-        @handlers_loaded_from = handler_dir
-      end # load handlers
-
-      # Load an even handler from a file.
-      # 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:
-      # ComputerAdded
-      # computeradded.sh
-      # COMPUTERAdded_notify_team
-      # 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:
-      #     JSSWebHooks.event_handler do |event|
-      #       # your code goes here.
-      #     end
-      #
-      # (see HERE for details about writing the ruby handlers)
-      #
-      # @param [Pathname] from_file the file from which to
-      #
-      # @return [Type] description of returned object
-      #
-      def self.load_handler(from_file)
-        handler_file = Pathname.new from_file
-        event_name = event_name_from_handler_filename(handler_file)
-        return unless event_name
-
-        # create an array for this event's handlers, if needed
-        @event_handlers[event_name] ||= []
-
-        if handler_file.executable?
-          # store as a Pathname, we'll pipe JSON to it
-          @event_handlers[event_name] << handler_file unless \
-            @event_handlers[event_name].include? handler_file
-        else
-          # load the file. If written correctly, it will
-          # put a Proc into @loaded_event_handler
-          load handler_file.to_s
-          # store as a Proc, to be called when the event is handled.
-          @event_handlers[event_name] << @loaded_event_handler unless \
-            @event_handlers[event_name].include? @loaded_event_handler
-
-        end # if handler_file.executable?
-      end # self.load_handler(handler_file)
-
-      # Given a handler filename, return the event name it wants to handle
-      #
-      # @param [Pathname] filename The filename from which to glean the
-      #   event name.
-      #
-      # @return [String,nil] The matching event name or nil if no match
-      #
-      def self.event_name_from_handler_filename(filename)
-        @event_names ||= JSSWebHooks::Event.event_to_class_names.keys
-        desired_event_name = filename.basename.to_s.split(/\.|-|_/).first
-        @event_names.select { |n| desired_event_name.casecmp(n).zero? }.first
-      end
-
-    end # module Handler
-
-  end # class event
-
-end # module