ruby-jss 0.10.2 → 0.11.0a5

data/lib/jss/api_object/computer_invitation.rb

@@ -51,9 +51,7 @@ module JSS
     #####################################
 
     include JSS::Creatable
-
-    # Class Variables
-    #####################################
+    include JSS::Sitable
 
     # Class Methods
     #####################################
@@ -88,6 +86,9 @@ module JSS
     # See {APIObject#add_object_history_entry}
     OBJECT_HISTORY_OBJECT_TYPE = 84
 
+    # Where is site data located in the API JSON?
+    SITE_SUBSET = :top
+
     # Attributes
     #####################################
 
@@ -200,6 +201,7 @@ module JSS
       obj.add_element('hide_account').text = hide_account
       obj.add_element('invitation_status').text = invitation_status
       obj.add_element('multiple_uses_allowed').text = multiple_uses_allowed
+      add_site_to_xml(doc)
       doc.to_s
     end
 

data/lib/jss/api_object/ebook.rb

@@ -6,6 +6,8 @@ module JSS
   #
   class EBook < APIObject
 
+    include Sitable
+
     ### The base for REST resources of this class
     RSRC_BASE = 'ebooks'.freeze
 
@@ -21,6 +23,9 @@ module JSS
     # See {APIObject#add_object_history_entry}
     OBJECT_HISTORY_OBJECT_TYPE = 24
 
+    # Where is the Site data in the API JSON?
+    SITE_SUBSET = :general
+
   end
 
 end

data/lib/jss/api_object/extendable.rb

@@ -172,8 +172,21 @@ module JSS
       @need_to_update = true
     end
 
+    # are there any changes in the EAs needing to be saved?
+    #
+    # @return [Boolean]
+    #
+    def unsaved_eas?
+      @need_to_update && @changed_eas && !@changed_eas.empty?
+    end
+
     # @api private
     #
+    # TODO: make this (and all XML amending) method take the in-progress XML doc and
+    # add (or not) the EA xml to it.
+    # See how Sitable#add_site_to_xml works, as called from
+    # Computer.rest_xml
+    #
     # @return [REXML::Element] An <extension_attribute> element to be
     #  included in the rest_xml of objects that mix-in this module.
     #

data/lib/jss/api_object/group/computer_group.rb

@@ -56,6 +56,7 @@ module JSS
     #####################################
     ### Mix-Ins
     #####################################
+    include JSS::MDM
 
     #####################################
     ### Class Methods
@@ -86,6 +87,9 @@ module JSS
     # See {APIObject#add_object_history_entry}
     OBJECT_HISTORY_OBJECT_TYPE = 7
 
+    # what kind of devices are these WRT MDM
+    MDM_COMMAND_TARGET = :computergroups
+
     #####################################
     ### Class Variables
     #####################################

data/lib/jss/api_object/group/mobile_device_group.rb

@@ -56,7 +56,7 @@ module JSS
     #####################################
     ### Mix-Ins
     #####################################
-
+    include JSS::MDM
 
     #####################################
     ### Class Constants
@@ -83,6 +83,9 @@ module JSS
     # See {APIObject#add_object_history_entry}
     OBJECT_HISTORY_OBJECT_TYPE = 25
 
+    # what kind of devices are these WRT MDM
+    MDM_COMMAND_TARGET = :mobiledevicegroups
+
     #####################################
     ### Class Variables
     #####################################

data/lib/jss/api_object/group.rb

@@ -67,6 +67,7 @@ module JSS
     include JSS::Creatable
     include JSS::Updatable
     include JSS::Criteriable
+    include JSS::Sitable
 
 
     #####################################
@@ -76,6 +77,9 @@ module JSS
     ### the types of groups allowed for creation
     GROUP_TYPES = [:smart, :static]
 
+    # Where is the Site data in the API JSON?
+    SITE_SUBSET = :top
+
     #####################################
     ### Class Variables
     #####################################
@@ -357,7 +361,6 @@ module JSS
       doc = REXML::Document.new JSS::APIConnection::XML_HEADER
       group = doc.add_element self.class::RSRC_OBJECT_KEY.to_s
       group.add_element('name').text = @name
-      group.add_element('site').add_element('name').text = @site if @site
       group.add_element('is_smart').text = @is_smart
       if @is_smart
         group << @criteria.rest_xml if @criteria
@@ -365,6 +368,8 @@ module JSS
         group << self.class::MEMBER_CLASS.xml_list(@members, :id)
       end
 
+      add_site_to_xml(doc)
+
       return doc.to_s
 
     end #rest_xml

data/lib/jss/api_object/mac_application.rb

@@ -6,6 +6,8 @@ module JSS
   #
   class MacApplication < APIObject
 
+    include Sitable
+
     ### The base for REST resources of this class
     RSRC_BASE = 'macapplications'.freeze
 
@@ -21,6 +23,9 @@ module JSS
     # See {APIObject#add_object_history_entry}
     OBJECT_HISTORY_OBJECT_TYPE = 350
 
+    # Where is the Site data in the API JSON?
+    SITE_SUBSET = :general
+
   end
 
 end

data/lib/jss/api_object/management_history/audit_event.rb

@@ -0,0 +1,45 @@
+#
+module JSS
+
+  #
+  module ManagementHistory
+
+    # AuditEvent - an auditiable event in a Jamf Object's Management History
+    #
+    # This should only be instantiated by the ManagementHistory.audits method
+    # when mixed in to Computers or Mobile devices.
+    #
+    # That method will return an array of these objects.
+    #
+    class AuditEvent < ImmutableStruct.new(
+
+      :event,
+      :username,
+      :date_time_epoch
+    )
+
+      # @!attribute [r] event
+      #  @return [String] The description of the event.
+
+      alias description event
+
+      # @!attribute [r] username
+      #  @return [String] The name of the JSS user who caused the event
+
+      alias admin username
+
+      # @!attribute [r] date_time_epoch
+      #  @return [Integer] When the event occured on the server, as
+      #    a unix epoch timestamp with milliseconds
+
+      #  @return [Time] When the event occured on the server, as a ruby Time object
+      #
+      def date_time
+        JSS.epoch_to_time @date_time_epoch if @date_time_epoch
+      end
+
+    end # AuditEvent
+
+  end #   module ManagementHistory
+
+end # module JSS

data/lib/jss/api_object/management_history/casper_imaging_log.rb

@@ -0,0 +1,37 @@
+#
+module JSS
+
+  #
+  module ManagementHistory
+
+    # CasperImagingLog - a casper imaging event in a Jamf Computer's Management History
+    #
+    # This should only be instantiated by the ManagementHistory.casper_imaging_logs method
+    # when mixed in to Computers devices.
+    #
+    # That method will return an array of these objects.
+    #
+    class CasperImagingLog < ImmutableStruct.new(
+
+      :status,
+      :date_time_epoch
+    )
+
+      # @!attribute [r] status
+      #  @return [String] The status of the event.
+
+      # @!attribute [r] date_time_epoch
+      #  @return [Integer] When the event occured on the server, as
+      #    a unix epoch timestamp with milliseconds
+
+      #  @return [Time] When the event occured on the server, as a ruby Time object
+      #
+      def date_time
+        JSS.epoch_to_time @date_time_epoch if @date_time_epoch
+      end
+
+    end # CasperRemoteEvent
+
+  end #   module ManagementHistory
+
+end # module JSS

data/lib/jss/api_object/management_history/casper_remote_log.rb

@@ -0,0 +1,37 @@
+#
+module JSS
+
+  #
+  module ManagementHistory
+
+    # CasperRemoteEvent - an casper remote event in a Jamf Computer's Management History
+    #
+    # This should only be instantiated by the ManagementHistory.usage_logs method
+    # when mixed in to Computers devices.
+    #
+    # That method will return an array of these objects.
+    #
+    class CasperRemoteLog < ImmutableStruct.new(
+
+      :status,
+      :date_time_epoch
+    )
+
+      # @!attribute [r] status
+      #  @return [String] The status of the event.
+
+      # @!attribute [r] date_time_epoch
+      #  @return [Integer] When the event occured on the server, as
+      #    a unix epoch timestamp with milliseconds
+
+      #  @return [Time] When the event occured on the server, as a ruby Time object
+      #
+      def date_time
+        JSS.epoch_to_time @date_time_epoch if @date_time_epoch
+      end
+
+    end # CasperRemoteEvent
+
+  end #   module ManagementHistory
+
+end # module JSS

data/lib/jss/api_object/management_history/computer_usage_log.rb

@@ -0,0 +1,43 @@
+#
+module JSS
+
+  #
+  module ManagementHistory
+
+    # ComputerUsageEvent - an usage event in a Jamf Compter's Management History
+    #
+    # This should only be instantiated by the ManagementHistory.usage_logs method
+    # when mixed in to Computers devices.
+    #
+    # That method will return an array of these objects.
+    #
+    class ComputerUsageLog < ImmutableStruct.new(
+
+      :event,
+      :username,
+      :date_time_epoch
+    )
+
+      # @!attribute [r] event
+      #  @return [String] The description of the event.
+
+      alias description event
+
+      # @!attribute [r] username
+      #  @return [String] The name of the JSS user who caused the event
+
+      # @!attribute [r] date_time_epoch
+      #  @return [Integer] When the event occured on the server, as
+      #    a unix epoch timestamp with milliseconds
+
+      #  @return [Time] When the event occured on the server, as a ruby Time object
+      #
+      def date_time
+        JSS.epoch_to_time @date_time_epoch if @date_time_epoch
+      end
+
+    end # ComputerUsageEvent
+
+  end #   module ManagementHistory
+
+end # module JSS

data/lib/jss/api_object/management_history/ebook.rb

@@ -0,0 +1,70 @@
+#
+module JSS
+
+  #
+  module ManagementHistory
+
+    # EBook - an app deployed to a MobileDevice
+    #
+    # This should only be instantiated by the ManagementHistory.ebooks method
+    # when mixed in to Mobile devices.
+    #
+    # That method will return an array of these objects.
+    #
+    # NOTE: some attributes will be nil for some statuses
+    # (e.g. no source data if not installed)
+    #
+    class EBook < ImmutableStruct.new(
+
+      :title,
+      :author,
+      :version,
+      :kind,
+      :management_status,
+      :source
+    )
+
+      # @!attribute [r] title
+      #  @return [String] The name of the ebook.
+
+      alias name title
+
+      # @!attribute [r] version
+      #  @return [String] The version of the ebook.
+
+      # @!attribute [r] author
+      #  @return [String] The author of the ebook.
+
+      # @!attribute [r] kind
+      #  @return [String] 'IBOOK', 'PDF', etc..
+
+      # @!attribute [r] management_status
+      #  @return [String] The raw status, used for #managed? and #status
+
+      # @!attribute [r] source
+      #  @return [Symbol] :in_house or :ibookstore
+
+      # @return [Symbol] :installed, :pending, :failed, or :unknown
+      #
+      def status
+        case @management_status
+        when HIST_RAW_STATUS_INSTALLED then :installed
+        when HIST_RAW_STATUS_MANAGED then :installed
+        when HIST_RAW_STATUS_UNMANAGED then :installed
+        when HIST_RAW_STATUS_PENDING then :pending
+        when HIST_RAW_STATUS_FAILED then :failed
+        else :unknown
+        end
+      end
+
+      #  @return [Boolean] If :installed and :in_house, is it managed?
+      #
+      def managed?
+        @management_status == HIST_RAW_STATUS_MANAGED
+      end
+
+    end # EBook
+
+  end #   module ManagementHistory
+
+end # module JSS

data/lib/jss/api_object/management_history/mac_app_store_app.rb

@@ -0,0 +1,69 @@
+#
+module JSS
+
+  #
+  module ManagementHistory
+
+    # MacAppStoreApp - an app store app deployed to a Computer
+    #
+    # This should only be instantiated by the ManagementHistory.app_store_app_history method
+    # when mixed in to Computers.
+    #
+    # That method will return an array of these objects.
+    #
+    # NOTE: some attributes will be nil for some statuses
+    # (e.g. no size data if not installed)
+    #
+    class MacAppStoreApp < ImmutableStruct.new(
+
+      :name,
+      :version,
+      :status,
+      :deployed_epoch,
+      :last_update_epoch,
+      :size_mb
+    )
+
+      # @!attribute [r] name
+      #   @return [String] the name of the app.
+
+      # @!attribute [r] version
+      #   @return [String] The version of the app
+
+      # @!attribute [r] status
+      #   @return [Symbol] :installed, :pending, or :failed
+
+      # @!attribute [r] deployed_epoch
+      #   @return [Integer] If :pending, when was it first deployed as
+      #   a unix epoch timestamp with milliseconds
+
+      # @!attribute [r] last_update_epoch
+      #   @return [Integer] If :pending, when as the last attempt to
+      #   install it, as a unix epoch timestamp with milliseconds
+
+      alias last_push_epoch last_update_epoch
+
+      # @!attribute [r] size_mb
+      #   @return [Integer] If :installed, its size in Mb
+
+      # @return [Time]  If :pending, when was it first deployed as
+      #   as a ruby Time object
+      #
+      def deployed
+        JSS.epoch_to_time @deployed_epoch if @deployed_epoch
+      end
+
+
+      # @return [Time]  If :pending, when as the last attempt to
+      #   install it, as a ruby Time object
+      #
+      def last_update
+        JSS.epoch_to_time @last_update_epoch if @last_update_epoch
+      end
+      alias last_push last_update
+
+    end # MobileDeviceApp
+
+  end # module ManagementHistory
+
+end # module JSS

data/lib/jss/api_object/management_history/mdm_command.rb

@@ -0,0 +1,96 @@
+#
+module JSS
+
+  #
+  module ManagementHistory
+
+    # MDMCommand - an issued MDM command in a Jamf Object's Management History
+    #
+    # This should only be instantiated by the ManagementHistory.mdm_commands method
+    # when mixed in to Computers or Mobile devices.
+    #
+    # That method will return an array of these objects.
+    #
+    # NOTE: some attributes will be nil for some statuses
+    # (e.g. no error message if not failed, no completed time if not completed)
+    #
+    class MDMCommand < ImmutableStruct.new(
+
+      :name,
+      :username,
+      :status,
+      :error,
+      :issued_epoch,
+      :failed_epoch,
+      :completed_epoch,
+      :last_push_epoch
+    )
+
+      def initialize(args = {})
+        args[:completed_epoch] ||= args[:date_time_completed_epoch]
+        args[:issued_epoch] ||= args[:date_time_issued_epoch]
+        args[:failed_epoch] ||= args[:date_time_failed_epoch]
+        super args
+      end
+
+      # @!attribute [r] name
+      #   @return [String] the name of the command.
+
+      # @!attribute [r] username
+      #   @return [String] the username of associated with the command.
+
+      # @!attribute [r] status
+      #   @return [Symbol] :completed, :pending, or :failed
+
+      # @!attribute [r] error
+      #   @return [String] The error message if status == :failed
+
+      # @!attribute [r] issued_epoch
+      #   @return [Integer] When the command was issued, as
+      #    a unix epoch timestamp with milliseconds
+
+      # @!attribute [r] failed_epoch
+      #   @return [Integer] When the command failed, as
+      #   a unix epoch timestamp with milliseconds
+
+      # @!attribute [r] completed_epoch
+      #   @return [Integer] When the command was completed, as
+      #   a unix epoch timestamp with milliseconds
+
+      # @!attribute [r] last_push_epoch
+      #   @return [Integer] When the most recent attempt was made on a
+      #   pending command, a unix epoch timestamp with milliseconds
+
+      # @return [Time] When the command was issued, as a ruby
+      #   Time object
+      #
+      def issued
+        JSS.epoch_to_time @issued_epoch if @issued_epoch
+      end
+
+      # @return [Time] When the command failed, as a ruby
+      #   Time object
+      #
+      def failed
+        JSS.epoch_to_time @failed_epoch if @failed_epoch
+      end
+
+      # @return [Time] When the command completed, as a ruby
+      #   Time object
+      #
+      def completed
+        JSS.epoch_to_time @completed_epoch if @completed_epoch
+      end
+
+      # @return [Time] When the most recent attempt was made on a pending
+      #   command, as a ruby Time object
+      #
+      def last_push
+        JSS.epoch_to_time @last_push_epoch if @last_push_epoch
+      end
+
+    end # MDMCommand
+
+  end #   module ManagementHistory
+
+end # module JSS

data/lib/jss/api_object/management_history/mobile_device_app.rb

@@ -0,0 +1,99 @@
+#
+module JSS
+
+  #
+  module ManagementHistory
+
+    # MobileDeviceApp - an app deployed to a MobileDevice
+    #
+    # This should only be instantiated by the ManagementHistory.app_history method
+    # when mixed in to Mobile devices.
+    #
+    # That method will return an array of these objects.
+    #
+    # NOTE: some attributes will be nil for some statuses
+    # (e.g. no size data if not installed)
+    #
+    class MobileDeviceApp < ImmutableStruct.new(
+
+      :name,
+      :version,
+      :short_version,
+      :management_status,
+      :source,
+      :bundle_size,
+      :dynamic_size
+    )
+
+      # @!attribute [r] name
+      #   @return [String] the name of the app.
+
+      # @!attribute [r] version
+      #   @return [String] The version of the app
+
+      # @!attribute [r] short_version
+      #   @return [String] The short_version of the app
+
+      # @!attribute [r] management_status
+      #  @return [String] The raw status, used for #managed? and #status
+
+      # @!attribute [r] source
+      #   @return [Symbol] :in_house, :app_store, or :other
+
+      # @!attribute [r] bundle_size
+      #   @return [String] The size of the app bundle as text, e.g. '28 MB'
+
+      # @!attribute [r] dynamic_size
+      #   @return [String] The dynamic size of the app as text, e.g. '28 MB'
+
+      # @return [Symbol] :installed, :pending, :failed, or :unknown
+      #
+      def status
+        case @management_status
+        when HIST_RAW_STATUS_INSTALLED then :installed
+        when HIST_RAW_STATUS_MANAGED then :installed
+        when HIST_RAW_STATUS_UNMANAGED then :installed
+        when HIST_RAW_STATUS_PENDING then :pending
+        when HIST_RAW_STATUS_FAILED then :failed
+        else :unknown
+        end
+      end
+
+      #  @return [Boolean] If :installed and :in_house, is it managed?
+      #
+      def managed?
+        @management_status == HIST_RAW_STATUS_MANAGED
+      end
+
+      # @return [Integer] The size of the app bundle in kb, e.g. 29033
+      #
+      def bundle_size_kb
+        size_to_kb @bundle_size if @bundle_size
+      end
+
+      # @return [Integer] The dynamic size of the app in kb, e.g. 29033
+      #
+      def dynamic_size_kb
+        size_to_kb @dynamic_size if @dynamic_size
+      end
+
+      # @param [String] A raw size value from the API
+      #
+      # @return [Integer] the size as an integer of Kb
+      #
+      def size_to_kb(raw_size)
+        val, unit = raw_size.split ' '
+        val = val.to_i
+        case unit.downcase
+        when 'kb' then val
+        when 'mb' then val * 1024
+        when 'gb' then val * 1024 * 1024
+        end # case unit
+      end
+      private :size_to_kb
+
+    end # MobileDeviceApp
+
+  end # module ManagementHistory
+
+end # module JSS