ruby-jss 1.2.4a4 → 1.3.3

data/lib/jss/api_object/ebook.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jss/api_object/extendable.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -180,31 +180,21 @@ module JSS
     #
     # @return [void]
     #
-    def set_ext_attr(name, value, validate_popup_choice: true, refresh: false)
-      raise ArgumentError, "Unknown Extension Attribute Name: '#{name}'" unless ea_types.key? name
+    def set_ext_attr(ea_name, value, validate_popup_choice: true, refresh: false)
+      raise ArgumentError, "Unknown Extension Attribute Name: '#{ea_name}'" unless ea_types.key? ea_name
 
-      value ||= JSS::BLANK
-      validate_popup_value(name, value, refresh) if validate_popup_choice
+      value = validate_ea_value(ea_name, value, validate_popup_choice, refresh)
 
-      case ea_types[name]
-      when JSS::ExtensionAttribute::DATA_TYPE_DATE
-        raise JSS::InvalidDataError, "The value for #{name} must be a date, cannot be blank" if value == JSS::BLANK
-
-        value = JSS.parse_datetime value
-
-      when *JSS::ExtensionAttribute::NUMERIC_TYPES
-        raise JSS::InvalidDataError, "The value for #{name} must be an integer" unless value.is_a? Integer
+      # update this ea hash in the @extension_attributes array
+      ea_hash = @extension_attributes.find { |ea| ea[:name] == ea_name }
 
-      else # String
-        value = value.to_s
-      end # case
+      raise JSS::NoSuchItemError, "#{self.class} '#{name}'(id #{id}) does not know about ExtAttr '#{ea_name}'. Please re-fetch and try again." unless ea_hash
 
-      # update this ea hash in the @extension_attributes array
-      @extension_attributes.each { |ea| ea[:value] = value if ea[:name] == name }
+      ea_hash[:value] = value
 
       # update the shortcut hash too
-      @ext_attrs[name] = value if @ext_attrs
-      @changed_eas << name
+      @ext_attrs[ea_name] = value if @ext_attrs
+      @changed_eas << ea_name
       @need_to_update = true
     end
 
@@ -248,22 +238,71 @@ module JSS
       eaxml
     end
 
-    # Used by set_ext_attr
-    def validate_popup_value(name, value, refresh)
-      # all popups can take blanks
-      return if value == JSS::BLANK
+    # is the value being passed to set_ext_attr valid?
+    # Converts values as needed (e.g. strings to integers or Times)
+    #
+    # If the EA is defined to hold a string, any value is accepted and
+    # converted with #to_s
+    #
+    # Note: All EAs can be blank
+    #
+    # @param name[String] the name of the extension attribute to set
+    #
+    # @param value[String,Time,Integer] the new value for the extension
+    #   attribute for this user
+    #
+    # @param validate_popup_choice[Boolean] validate the new value against the E.A. definition.
+    #   Defaults to true.
+    #
+    # @param refresh[Boolean] Re-read the ext. attrib definition from the API,
+    #   for popup validation.
+    #
+    # @return [Object] the possibly modified valid value
+    #
+    def validate_ea_value(ea_name, value, validate_popup_choice, refresh)
+      return JSS::BLANK if value.to_s == JSS::BLANK
+
+      value =
+        case ea_types[ea_name]
+        when JSS::ExtensionAttribute::DATA_TYPE_DATE
+          JSS.parse_datetime(value).to_s
+        when *JSS::ExtensionAttribute::NUMERIC_TYPES
+          validate_integer_ea_value ea_name, value
+        else
+          value.to_s
+        end # case
+
+      validate_popup_value(ea_name, value, refresh) if validate_popup_choice
+
+      value
+    end
+
+    # raise error if the value isn't an integer
+    def validate_integer_ea_value(ea_name, value)
+      if value.is_a? Integer
+        value
+      elsif value.to_s.jss_integer?
+        value.to_s.to_i
+      else
+        raise JSS::InvalidDataError, "The value for #{ea_name} must be an integer"
+      end # if
+    end
 
+    # Raise an error if the named EA has a popup menu,
+    # but the provided value isn't one of the menu items
+    #
+    def validate_popup_value(ea_name, value, refresh)
       # get the ea def. instance from the api cache, or the api
       api.ext_attr_definition_cache[self.class] ||= {}
-      api.ext_attr_definition_cache[self.class][name] = nil if refresh
-      api.ext_attr_definition_cache[self.class][name] ||= self.class::EXT_ATTRIB_CLASS.fetch name: name, api: api
+      api.ext_attr_definition_cache[self.class][ea_name] = nil if refresh
+      api.ext_attr_definition_cache[self.class][ea_name] ||= self.class::EXT_ATTRIB_CLASS.fetch name: ea_name, api: api
 
-      ea_def = api.ext_attr_definition_cache[self.class][name]
+      ea_def = api.ext_attr_definition_cache[self.class][ea_name]
       return unless ea_def.from_popup_menu?
 
       return if ea_def.popup_choices.include? value.to_s
 
-      raise JSS::UnsupportedError, "The value for #{name} must be one of: '#{ea_def.popup_choices.join("' '")}'"
+      raise JSS::UnsupportedError, "The value for #{ea_name} must be one of: '#{ea_def.popup_choices.join("' '")}'"
     end
 
   end # module extendable

data/lib/jss/api_object/extension_attribute.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jss/api_object/extension_attribute/computer_extension_attribute.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jss/api_object/extension_attribute/mobile_device_extension_attribute.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in

data/lib/jss/api_object/extension_attribute/user_extension_attribute.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in

data/lib/jss/api_object/group.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jss/api_object/ibeacon.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jss/api_object/ldap_server.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jss/api_object/locatable.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jss/api_object/mac_application.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jss/api_object/management_history.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -293,27 +293,6 @@ module JSS
       end # completed_mdm_commands
       alias completed_commands completed_mdm_commands
 
-      # The time of the most recently completed MDM command.
-      #
-      # For Mobile Devices, this seems to be the best indicator of the real
-      # last-contact time, since the last_inventory_update is changed when
-      # changes are made via the API.
-      #
-      # @param ident [Type] The identifier for the object - id, name, sn, udid, etc.
-      #
-      # @param api [JSS::APIConnection] The API connection to use for the query
-      #   defaults to the currently active connection
-      #
-      # @return [Time, nil] An array of completed MDMCommands
-      #
-      def last_mdm_contact(ident, api: JSS.api)
-        cmds = completed_mdm_commands(ident, api: api)
-        return nil if cmds.empty?
-
-        JSS.epoch_to_time cmds.map{|cmd| cmd.completed_epoch }.max
-      end
-
-
       # The history of pending mdm commands for a target
       #
       # @param ident [Type] The identifier for the object - id, name, sn, udid, etc.
@@ -342,6 +321,28 @@ module JSS
       end # completed_mdm_commands
       alias failed_commands failed_mdm_commands
 
+      # The time of the most recently completed or failed MDM command.
+      # (knowledge of a failure means the device communicated with us)
+      #
+      # For Mobile Devices, this seems to be the best indicator of the real
+      # last-contact time, since the last_inventory_update is changed when
+      # changes are made via the API.
+      #
+      # @param ident [Type] The identifier for the object - id, name, sn, udid, etc.
+      #
+      # @param api [JSS::APIConnection] The API connection to use for the query
+      #   defaults to the currently active connection
+      #
+      # @return [Time, nil] An array of completed MDMCommands
+      #
+      def last_mdm_contact(ident, api: JSS.api)
+        epochs = completed_mdm_commands(ident, api: api).map { |cmd| cmd.completed_epoch }
+        epochs += failed_mdm_commands(ident, api: api).map { |cmd| cmd.failed_epoch }
+        epoch = epochs.max
+        epoch ? JSS.epoch_to_time(epoch) : nil
+      end
+
+
       # The history of app store apps  for a computer
       #
       # @param ident [Type] The identifier for the object - id, name, sn, udid, etc.

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

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

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

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jss/api_object/matchable.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jss/api_object/mdm.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jss/api_object/mobile_device.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -126,8 +126,15 @@ module JSS
       }
     }.freeze
 
+    HW_PREFIX_TV = 'AppleTV'.freeze
+    HW_PREFIX_IPAD = 'iPad'.freeze
+    HW_PREFIX_IPHONE = 'iPhone'.freeze
+
     NON_UNIQUE_NAMES = true
 
+    # file uploads can send attachments to the JSS using :mobiledevices as the sub-resource.
+    UPLOAD_TYPES = { attachment: :mobiledevices }.freeze
+
     # This class lets us seach for computers
     SEARCH_CLASS = JSS::AdvancedMobileDeviceSearch
 
@@ -489,6 +496,19 @@ module JSS
       end
     end # initialize
 
+    def tv?
+      model_identifier.start_with? HW_PREFIX_TV
+    end
+    alias apple_tv? tv?
+
+    def ipad?
+      model_identifier.start_with? HW_PREFIX_IPAD
+    end
+
+    def iphone?
+      model_identifier.start_with? HW_PREFIX_IPHONE
+    end
+
     def name=(new_name)
       super
       @needs_mdm_name_change = true if managed? && supervised?
@@ -510,16 +530,19 @@ module JSS
 
     #
     def asset_tag=(new_val)
+      new_val = new_val.strip
       return nil if @asset_tag == new_val
-      new_val.strip!
+
       @asset_tag = new_val
       @need_to_update = true
     end
 
-    #
-    def update
-      super
-      return @id unless @needs_mdm_name_change
+    # @param no_mdm_rename[Boolean] should a MDM `set device name` command be sent
+    #   if the device is managed and supervised?
+    def update(no_mdm_rename: false)
+      super()
+      return @id if no_mdm_rename || !@needs_mdm_name_change
+
       set_device_name @name if managed? && supervised?
       @needs_mdm_name_change = false
       @id

data/lib/jss/api_object/mobile_device_application.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -444,6 +444,18 @@ module JSS
       refresh_ipa
     end
 
+    # Remove the various cached data
+    # from the instance_variables used to create
+    # pretty-print (pp) output.
+    #
+    # @return [Array] the desired instance_variables
+    #
+    def pretty_print_instance_variables
+      vars = super
+      vars.delete :@ipa
+      vars
+    end
+
     # Private Instance Methods
     ###########################################
     private