Module: JSSWebHooks

Defined in:

lib/jss/webhooks.rb,
lib/jss/webhooks/event.rb,
lib/jss/webhooks/version.rb,
lib/jss/webhooks/server_app.rb,
lib/jss/webhooks/configuration.rb,
lib/jss/webhooks/event/webhook.rb,
lib/jss/webhooks/event_objects.rb,
lib/jss/webhooks/event/handlers.rb,
lib/jss/webhooks/event/push_sent.rb,
lib/jss/webhooks/event/jss_startup.rb,
lib/jss/webhooks/server_app/server.rb,
lib/jss/webhooks/event/jss_shutdown.rb,
lib/jss/webhooks/event/computer_added.rb,
lib/jss/webhooks/event/scep_challenge.rb,
lib/jss/webhooks/server_app/routes/home.rb,
lib/jss/webhooks/event/computer_check_in.rb,
lib/jss/webhooks/event/rest_api_operation.rb,
lib/jss/webhooks/server_app/self_signed_cert.rb,
lib/jss/webhooks/event/mobile_device_check_in.rb,
lib/jss/webhooks/event/mobile_device_enrolled.rb,
lib/jss/webhooks/event/mobile_device_push_sent.rb,
lib/jss/webhooks/event/computer_policy_finished.rb,
lib/jss/webhooks/event/mobile_device_unenrolled.rb,
lib/jss/webhooks/event/computer_inventory_completed.rb,
lib/jss/webhooks/event/patch_software_title_updated.rb,
lib/jss/webhooks/event/mobile_device_command_completed.rb,
lib/jss/webhooks/event/computer_push_capability_changed.rb,
lib/jss/webhooks/server_app/routes/handle_webhook_event.rb,
lib/jss/webhooks/event/smart_group_computer_membership_change.rb,
lib/jss/webhooks/event/smart_group_mobile_device_membership_change.rb

Overview

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.

Defined Under Namespace

Modules: EventObjects Classes: ComputerAddedEvent, ComputerCheckInEvent, ComputerInventoryCompletedEvent, ComputerPolicyFinishedEvent, ComputerPushCapabilityChangedEvent, Configuration, Event, JSSShutdownEvent, JSSStartupEvent, MobileDeviceCheckInEvent, MobileDeviceCommandCompletedEvent, MobileDeviceEnrolledEvent, MobileDevicePushSentEvent, MobileDeviceUnEnrolledEvent, PatchSoftwareTitleUpdatedEvent, PushSentEvent, RestAPIOperationEvent, SCEPChallengeEvent, SelfSignedCert, Server, SmartGroupComputerMembershipChangeEvent, SmartGroupMobileDeviceMembershipChangeEvent

Constant Summary

VERSION =

The version of the JSS WebHooks framework

'0.0.1'

CONFIG =

The single instance of Configuration

JSSWebHooks::Configuration.instance

Class Method Summary

• .event_handler(&block) {|The| ... } ⇒ Proc

  This method is used by the Ruby event-handler files.

• .sample_jsons ⇒ Object

Class Method Details

.event_handler(&block) {|The| ... } ⇒ Proc

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

Parameters:

• block (Block) —

  the block to be used as an event handler

Yield Parameters:

• The (JSS::WebHooks::Event subclass) —

  event to be handled

Returns:

• (Proc) —

  the block converted to a Proc

# File 'lib/jss/webhooks/event/handlers.rb', line 46

def self.event_handler(&block)
  Event::Handlers.loaded_event_handler = Proc.new(&block)
end

.sample_jsons ⇒ Object

# File 'lib/jss/webhooks.rb', line 42

def self.sample_jsons
  @sample_jsons
end