ruby-jss 1.2.6 → 1.4.1

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")
@@ -23,12 +23,11 @@
 ###
 ###
 
-# This is just a stub for now.
 
 #
 module JSS
 
-  #
+  # This is just a stub for now.
   class EBook < APIObject
 
     include Sitable

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")
@@ -179,9 +179,10 @@ module JSS
       # deprecated - no longer in the UI
       @recon_display = @init_data[:recon_display] || @web_display
 
-      # the name of the EA might have spaces and caps, which the will come to us as symbols with the spaces
-      # as underscores, like this.
-      @symbolized_name = @name.gsub(/-| /, '_').to_sym
+      # When used in Advanced Search results, the EA name
+      # has colons removed, spaces & dashes turned to underscores.
+      # and then ruby-jss symbolizes the name.
+      @symbolized_name = @name.gsub(':', '').gsub(/-| /, '_').to_sym
     end # init
 
     # Public Instance Methods

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")
@@ -22,15 +22,19 @@
 ###    language governing permissions and limitations under the Apache License.
 ###
 
-# This is just a stub for now.
-
-#
 module JSS
 
-  #
-  class MacApplication < APIObject
+  # This is just a stub for now.
+  class MacApplication < JSS::APIObject
 
-    include Sitable
+    # Mix-Ins
+    #####################################
+    include JSS::Updatable
+    include JSS::Scopable
+    include JSS::SelfServable
+    include JSS::Categorizable
+    include JSS::VPPable
+    include JSS::Sitable
 
     ### The base for REST resources of this class
     RSRC_BASE = 'macapplications'.freeze
@@ -47,9 +51,104 @@ module JSS
     # See {APIObject#add_object_history_entry}
     OBJECT_HISTORY_OBJECT_TYPE = 350
 
+    # See JSS::Scopable
+    SCOPE_TARGET_KEY = :computers
+
+    # Where is the Category in the API JSON?
+    CATEGORY_SUBSET = :general
+
+    # How is the category stored in the API data?
+    CATEGORY_DATA_TYPE = Hash
+
     # Where is the Site data in the API JSON?
     SITE_SUBSET = :general
 
-  end
+    # Attributes
+    #############################################
+
+    # @return [String]
+    attr_reader :version
+
+    # @return [Boolean]
+    attr_reader :is_free
+    alias free? is_free
+
+    # @return [String]
+    attr_reader :bundle_id
+
+    # @return [String]
+    attr_reader :url
+
+    ## Constructor
+    #####################################
+
+    def initialize(args = {})
+      super
+      general = @init_data[:general]
+      @version = general[:version]
+      @is_free = general[:is_free]
+      @bundle_id = general[:bundle_id]
+      @url = general[:url]
+    end
+
+    # Overrides, because consistency isn't alway a thing in the
+    # classic API
+    #############################################
+
+    # Override self_service_display_name getter
+    def self_service_display_name
+      raise JSS::UnsupportedError, 'MacApplications do not have separate display names. Please use the object name.'
+    end
+
+    # Override self_service_display_name setter
+    def self_service_display_name=(_newname)
+      raise JSS::UnsupportedError, 'MacApplications do not have separate display names. Please use the object name.'
+    end
+
+    # Override reinstall_button_text getter
+    def reinstall_button_text
+      raise JSS::UnsupportedError, 'MacApplications do not have separate text for reinstall buttons. Please use install_button_text.'
+    end
+
+    # Override reinstall_button_text setter
+    def reinstall_button_text=(_new)
+      raise JSS::UnsupportedError, 'MacApplications do not have separate text for reinstall buttons. Please use install_button_text.'
+    end
+
+    # Alas, SSvc icons are not uploadable via the API for
+    # mac apps
+    def upload(_type, _local_file)
+      raise JSS::UnsupportedError, 'The Classic API does not support uploading icons for MacApplications. Please use the Web UI'
+    end
+
+    ## Private Instance Methods
+    #####################################
+    private
+
+    ### Return the xml for creating or updating this script in the JSS
+    ###
+    def rest_xml
+      doc = REXML::Document.new APIConnection::XML_HEADER
+      obj = doc.add_element RSRC_OBJECT_KEY.to_s
+
+      general = obj.add_element('general')
+
+      general.add_element('version').text = @version
+      general.add_element('is_free').text = @is_free.to_s
+      general.add_element('bundle_id').text = @bundle_id
+      general.add_element('url').text = @url
+
+      obj << @scope.scope_xml
+
+      add_self_service_xml doc
+      add_category_to_xml doc
+      add_site_to_xml doc
+      add_vpp_xml doc
+
+      doc.to_s
+
+    end
+
+  end # class MacApplication
 
-end
+end # Module JSS

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")

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")