ruby-jss 1.6.4 → 2.0.0b1

data/lib/{jss/api_object → jamf/api/classic/api_objects}/mobile_device.rb

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -24,7 +24,7 @@
 ###
 
 ###
-module JSS
+module Jamf
 
   # Module Variables
   #####################################
@@ -42,7 +42,7 @@ module JSS
   # === Adding devices to the JSS
   #
   # When creating new MobileDevices in the JSS with this class
-  # (using {JSS::MobileDevice.make}) you must specify a udid, and serial_number
+  # (using {Jamf::MobileDevice.make}) you must specify a udid, and serial_number
   # before calling `create` or `save`. You can provide these values with the
   # `.make` call, or afterward using setters.
   #
@@ -51,13 +51,13 @@ module JSS
   #
   # MobileDevice Management History and logs can now be retrieved both from a
   # MobileDevice instance, and directly via class methods without fetching an
-  # instance. This is handled by the mixed-in {JSS::ManagementHistory} module,
+  # instance. This is handled by the mixed-in {Jamf::ManagementHistory} module,
   # Q.V. for details.
   #
   # ---
   # === MDM Commands
   #
-  # See the {JSS::MDM} mixin module for Class and Instance methods for
+  # See the {Jamf::MDM} mixin module for Class and Instance methods for
   # sending MDM commands to mobiledevices.
   #
   # To send MDM commands without fetching mobiledevice instances, use the class
@@ -67,22 +67,22 @@ module JSS
   # the DeviceName MDM command will be sent to the device when
   # the changes are sent to the server via {#save} or {#update}
   #
-  class MobileDevice < JSS::APIObject
+  class MobileDevice < Jamf::APIObject
 
     # Mix-Ins
     #####################################
 
-    include JSS::Creatable
-    include JSS::Updatable
-    include JSS::Locatable
-    include JSS::Purchasable
-    include JSS::Uploadable
-    include JSS::Extendable
-    include JSS::Sitable
-    include JSS::MDM
-    include JSS::ManagementHistory
+    include Jamf::Creatable
+    include Jamf::Updatable
+    include Jamf::Locatable
+    include Jamf::Purchasable
+    include Jamf::Uploadable
+    include Jamf::Extendable
+    include Jamf::Sitable
+    include Jamf::MDM
+    include Jamf::ManagementHistory
 
-    extend JSS::Matchable
+    extend Jamf::Matchable
 
     # Class Constants
     #####################################
@@ -106,21 +106,18 @@ module JSS
     # are for proper pluralization of 'mac_address' and such
     OTHER_LOOKUP_KEYS = {
       udid: {
-        aliases: [:uuid, :guid],
+        aliases: %i[uuid guid],
         fetch_rsrc_key: :udid
       },
       serial_number: {
-        aliases: [:serialnumber, :sn],
+        aliases: %i[serialnumber sn],
         fetch_rsrc_key: :serialnumber
       },
       wifi_mac_address: {
-        aliases: [
-          :wifi_mac_addresse,
-          :mac_address,
-          :mac_addresse,
-          :macaddress,
-          :macaddresse,
-          :macaddr
+        aliases: %i[
+          wifi_macaddr
+          mac_address
+          macaddr
         ],
         fetch_rsrc_key: :macaddress
       }
@@ -136,10 +133,10 @@ module JSS
     UPLOAD_TYPES = { attachment: :mobiledevices }.freeze
 
     # This class lets us seach for computers
-    SEARCH_CLASS = JSS::AdvancedMobileDeviceSearch
+    SEARCH_CLASS = Jamf::AdvancedMobileDeviceSearch
 
     # This is the class for relevant Extension Attributes
-    EXT_ATTRIB_CLASS = JSS::MobileDeviceExtensionAttribute
+    EXT_ATTRIB_CLASS = Jamf::MobileDeviceExtensionAttribute
 
     # What kind of devices are we for MDM purposes?
     MDM_COMMAND_TARGET = :mobiledevices
@@ -153,43 +150,59 @@ module JSS
     #####################################
 
     # @return [Array<String>] all mobiledevice phone numbers
-    def self.all_phone_numbers(refresh = false, api: JSS.api)
-      all(refresh, api: api).map { |i| i[:phone_number] }.reject(&:empty?)
+    def self.all_phone_numbers(refresh = false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
+      all(refresh, cnx: cnx).map { |i| i[:phone_number] }.reject(&:empty?)
     end
 
     # @return [Array<Hash>] the list of all managed mobile devices
-    def self.all_managed(refresh = false, api: JSS.api)
-      all(refresh, api: api).select { |d| d[:managed] }
+    def self.all_managed(refresh = false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
+      all(refresh, cnx: cnx).select { |d| d[:managed] }
     end
 
     # @return [Array<Hash>] the list of all unmanaged mobile devices
-    def self.all_unmanaged(refresh = false, api: JSS.api)
-      all(refresh, api: api).reject { |d| d[:managed] }
+    def self.all_unmanaged(refresh = false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
+      all(refresh, cnx: cnx).reject { |d| d[:managed] }
     end
 
     # @return [Array<Hash>] the list of all supervised mobile devices
-    def self.all_supervised(refresh = false, api: JSS.api)
-      all(refresh, api: api).select { |d| d[:supervised] }
+    def self.all_supervised(refresh = false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
+      all(refresh, cnx: cnx).select { |d| d[:supervised] }
     end
 
     # @return [Array<Hash>] the list of all unsupervised mobile devices
-    def self.all_unsupervised(refresh = false, api: JSS.api)
-      all(refresh, api: api).reject { |d| d[:supervised] }
+    def self.all_unsupervised(refresh = false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
+      all(refresh, cnx: cnx).reject { |d| d[:supervised] }
     end
 
     # @return [Array<Hash>] the list of all iPhones
-    def self.all_iphones(refresh = false, api: JSS.api)
-      all(refresh, api: api).select { |d| d[:model].start_with? 'iPhone' }
+    def self.all_iphones(refresh = false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
+      all(refresh, cnx: cnx).select { |d| d[:model].start_with? 'iPhone' }
     end
 
     # @return [Array<Hash>] the list of all iPads
-    def self.all_ipads(refresh = false, api: JSS.api)
-      all(refresh, api: api).select { |d| d[:model].start_with? 'iPad' }
+    def self.all_ipads(refresh = false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
+      all(refresh, cnx: cnx).select { |d| d[:model].start_with? 'iPad' }
     end
 
     # @return [Array<Hash>] the list of all iPads
-    def self.all_apple_tvs(refresh = false, api: JSS.api)
-      all(refresh, api: api).select { |d| d[:model_identifier].start_with? 'AppleTV' }
+    def self.all_apple_tvs(refresh = false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
+      all(refresh, cnx: cnx).select { |d| d[:model_identifier].start_with? 'AppleTV' }
     end
 
     # Attributes
@@ -422,8 +435,8 @@ module JSS
     # udid:, serial_number:, and asset_tag: can be provided in
     # the args.
     #
-    def initialize(args = {})
-      super args
+    def initialize(**args)
+      super
       if @in_jss
 
         gen = @init_data[:general]
@@ -514,21 +527,20 @@ module JSS
       @needs_mdm_name_change = true if managed? && supervised?
     end
 
-    #
     def serial_number=(new_val)
       return nil if new_val == @serial_number
-      @serial_number =  new_val.empty? ? new_val : JSS::Validate.doesnt_already_exist(self.class, :serial_number, new_val, api: api)
+
+      @serial_number =  new_val.empty? ? new_val : Jamf::Validate.doesnt_already_exist(self.class, :serial_number, new_val, cnx: cnx)
       @need_to_update = true
     end
 
-    #
     def udid=(new_val)
       return nil if new_val == @udid
-      @udid = new_val.empty? ? new_val : JSS::Validate.doesnt_already_exist(self.class, :udid, new_val, api: api)
+
+      @udid = new_val.empty? ? new_val : Jamf::Validate.doesnt_already_exist(self.class, :udid, new_val, cnx: cnx)
       @need_to_update = true
     end
 
-    #
     def asset_tag=(new_val)
       new_val = new_val.strip
       return nil if @asset_tag == new_val
@@ -554,7 +566,7 @@ module JSS
     private
 
     def rest_xml
-      doc = REXML::Document.new APIConnection::XML_HEADER
+      doc = REXML::Document.new Jamf::Connection::XML_HEADER
       md = doc.add_element self.class::RSRC_OBJECT_KEY.to_s
       general = md.add_element('general')
       general.add_element('name').text = @name

data/lib/{jss/api_object → jamf/api/classic/api_objects}/mobile_device_application.rb

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -24,7 +24,7 @@
 ###
 
 ###
-module JSS
+module Jamf
 
   # Module Variables
   #####################################
@@ -37,18 +37,18 @@ module JSS
 
   # A Mobile Device Application in the JSS
   #
-  class MobileDeviceApplication < JSS::APIObject
+  class MobileDeviceApplication < Jamf::APIObject
 
     # Mix-Ins
     #####################################
-    include JSS::Creatable
-    include JSS::Updatable
-    include JSS::Scopable
-    include JSS::SelfServable
-    include JSS::Categorizable
-    include JSS::Uploadable
-    include JSS::VPPable
-    include JSS::Sitable
+    include Jamf::Creatable
+    include Jamf::Updatable
+    include Jamf::Scopable
+    include Jamf::SelfServable
+    include Jamf::Categorizable
+    include Jamf::Uploadable
+    include Jamf::VPPable
+    include Jamf::Sitable
 
 
     # Class Methods
@@ -67,17 +67,17 @@ module JSS
     # It's also used in various error messages
     RSRC_OBJECT_KEY = :mobile_device_application
 
-    # See JSS::Scopable
+    # See Jamf::Scopable
     SCOPE_TARGET_KEY = :mobile_devices
 
-    # see JSS::Uploadable
+    # see Jamf::Uploadable
     UPLOAD_TYPES = {
       icon: :mobiledeviceapplicationsicon,
       app: :mobiledeviceapplicationsipa,
       attachment: :mobiledeviceapplications
     }.freeze
 
-    # see JSS::APIObject
+    # see Jamf::APIObject
     OTHER_LOOKUP_KEYS = {
       bundle_id: { aliases: %i[bundleid], fetch_rsrc_key: :bundleid }
     }.freeze
@@ -96,6 +96,12 @@ module JSS
     # How is the category stored in the API data?
     CATEGORY_DATA_TYPE = Hash
 
+    # possible values for os_type
+    OS_TYPES = {
+      ios: 'iOS',
+      tvos: 'tvOS'
+    }
+
     # Attributes
     #####################################
 
@@ -106,7 +112,6 @@ module JSS
     # icon, any other objects with icons keep the icon data in :self_service.
     # As such, all icon handling for this class is done in the SelfServable module
 
-
     # @return [String] The user-facing name (i.e. in self service)
     attr_reader :display_name
 
@@ -131,6 +136,9 @@ module JSS
     # @return [String] The URL for downloading this app
     attr_reader :url
 
+    # @return [String] Is this an iOS or tvOS app?
+    attr_reader :os_type
+
     # @return [String] The URL of this item in the iTunes store, if applicable
     attr_reader :itunes_store_url
 
@@ -182,7 +190,7 @@ module JSS
     #####################################
 
     #
-    # See JSS::APIObject#initialize
+    # See Jamf::APIObject#initialize
     #
     def initialize(args)
       super
@@ -192,6 +200,7 @@ module JSS
       @bundle_id = general[:bundle_id]
       @version = general[:version]
       @ipa = general[:ipa]
+      @os_type = general[:os_type]
       @provisioning_profile = general[:provisioning_profile]
       @url = general[:url]
       @itunes_store_url = general[:itunes_store_url]
@@ -227,7 +236,6 @@ module JSS
       @need_to_update = true
     end
 
-
     # Set the description
     #
     # @param new_val[String] The new value
@@ -236,10 +244,28 @@ module JSS
     #
     def description=(new_val)
       return nil if new_val.to_s == @description
+
       @description = new_val.to_s
       @need_to_update = true
     end
 
+    # Set the os type
+    #
+    # @param new_val[Symbol, String] a key or value from OS_TYPES
+    #
+    # @return [void]
+    #
+    def os_type=(new_val)
+      new_val = OS_TYPES[new_val] if new_val.is_a? Symbol
+
+      raise Jamf::InvalidDataError, "Unknown os_type, must be one of #{OS_TYPES.keys.join ', '}" unless OS_TYPES.values.include?(new_val)
+
+      return if new_val == @os_type
+
+      @os_type = new_val
+      @need_to_update = true
+    end
+
     # Set the url
     #
     # @param new_val[String] The new value
@@ -261,7 +287,7 @@ module JSS
     #
     def make_available_after_install=(new_val)
       return nil if new_val == @make_available_after_install
-      raise JSS::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+      raise Jamf::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
       @make_available_after_install = new_val
       @need_to_update = true
     end
@@ -275,7 +301,7 @@ module JSS
     #
     def deploy_as_managed_app=(new_val)
       return nil if new_val == @deploy_as_managed_app
-      raise JSS::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+      raise Jamf::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
       @deploy_as_managed_app = new_val
       @need_to_update = true
     end
@@ -290,7 +316,7 @@ module JSS
     #
     def remove_app_when_mdm_profile_is_removed=(new_val)
       return nil if new_val == @remove_app_when_mdm_profile_is_removed
-      raise JSS::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+      raise Jamf::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
       @remove_app_when_mdm_profile_is_removed = new_val
       @need_to_update = true
     end
@@ -303,7 +329,7 @@ module JSS
     #
     def prevent_backup_of_app_data=(new_val)
       return nil if new_val == @prevent_backup_of_app_data
-      raise JSS::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+      raise Jamf::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
       @prevent_backup_of_app_data = new_val
       @need_to_update = true
     end
@@ -317,7 +343,7 @@ module JSS
     #
     def keep_description_and_icon_up_to_date=(new_val)
       return nil if new_val == @keep_description_and_icon_up_to_date
-      raise JSS::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+      raise Jamf::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
       @keep_description_and_icon_up_to_date = new_val
       @need_to_update = true
     end
@@ -330,7 +356,7 @@ module JSS
     #
     def free=(new_val)
       return nil if new_val == @free
-      raise JSS::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+      raise Jamf::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
       @free = new_val
       @need_to_update = true
     end
@@ -344,31 +370,41 @@ module JSS
     #
     def take_over_management=(new_val)
       return nil if new_val == @take_over_management
-      raise JSS::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+      raise Jamf::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
       @take_over_management = new_val
       @need_to_update = true
     end
 
-    # Sets the version (only necessary if you are hosting the .ipa externally)
+    # Sets the version (only usable if you are hosting the .ipa externally)
     #
     # @param new_val[String] the version
     #
     # @return [void]
     #
     def version=(new_val)
-      return nil if new_val == @version
+      unless @host_externally
+        raise 'Versions are set automatically from the .ipa file when hosted on your own Jamf-defined distribution point (i.e. #host_externally is false)'
+      end
+
+      return if new_val == @version
+
       @version = new_val
       @need_to_update = true
     end
 
-    # Sets the bundle_id (only necessary if you are hosting the .ipa externally)
+    # Sets the bundle_id (only usable if you are hosting the .ipa externally)
     #
     # @param new_val[String] the bundle id
     #
     # @return [void]
     #
     def bundle_id=(new_val)
-      return nil if new_val == @bundle_id
+      unless @host_externally
+        raise 'Bundle IDs are set automatically from the .ipa file when hosted on your own Jamf-defined distribution point (i.e. #host_externally is false)'
+      end
+
+      return if new_val == @bundle_id
+
       @bundle_id = new_val
       @need_to_update = true
     end
@@ -380,8 +416,10 @@ module JSS
     # @return [void]
     #
     def host_externally=(new_val)
-      return nil if new_val == @host_externally
-      raise JSS::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+      return if new_val == @host_externally
+
+      raise Jamf::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+
       @host_externally = new_val
       @need_to_update = true
     end
@@ -427,7 +465,7 @@ module JSS
       path = Pathname.new path
       path = path + @ipa[:name] if path.directory? && @ipa[:name]
 
-      raise JSS::AlreadyExistsError, "The file #{path} already exists" if path.exist? && !overwrite
+      raise Jamf::AlreadyExistsError, "The file #{path} already exists" if path.exist? && !overwrite
       path.delete if path.exist?
       path.jss_save Base64.decode64(@ipa[:data])
     end
@@ -436,11 +474,14 @@ module JSS
     #
     # @param path[String, Pathname] The path to the .ipa file to upload
     #
+    # @param force_ipa_upload[Boolean] Should the server upload the .ipa file to
+    #   JCDS or AWS if such are confgured for use?
+    #
     # @return [void]
     #
-    def upload_ipa(path)
+    def upload_ipa(path, force_ipa_upload: false)
       new_ipa = Pathname.new path
-      upload(:app, new_ipa)
+      upload(:app, new_ipa, force_ipa_upload: force_ipa_upload)
       refresh_ipa
     end
 
@@ -466,16 +507,17 @@ module JSS
     #
     def refresh_ipa
       return nil unless @in_jss
-      fresh_data = @api.get_rsrc(@rest_rsrc)[self.class::RSRC_OBJECT_KEY]
+      fresh_data = @cnx.c_get(@rest_rsrc)[self.class::RSRC_OBJECT_KEY]
       @ipa = fresh_data[:general][:ipa]
     end
 
     def rest_xml
-      doc = REXML::Document.new JSS::APIConnection::XML_HEADER
+      doc = REXML::Document.new Jamf::Connection::XML_HEADER
       obj = doc.add_element self.class::RSRC_OBJECT_KEY.to_s
       gen = obj.add_element 'general'
       gen.add_element('display_name').text = @display_name
       gen.add_element('description').text = @description
+      gen.add_element('os_type').text = @os_type
       gen.add_element('url').text = @url
       gen.add_element('make_available_after_install').text = @make_available_after_install
       gen.add_element('deploy_as_managed_app').text = @deploy_as_managed_app

data/lib/{jss/api_object/configuration_profile → jamf/api/classic/api_objects}/mobile_device_configuration_profile.rb

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -25,10 +25,10 @@
 # This is just a stub for now.
 
 #
-module JSS
+module Jamf
 
   #
-  class MobileDeviceConfigurationProfile < JSS::ConfigurationProfile
+  class MobileDeviceConfigurationProfile < Jamf::ConfigurationProfile
 
 
     ### The base for REST resources of this class
@@ -62,9 +62,9 @@ module JSS
     # Constructor
     ###################################
 
-    # See JSS::APIObject#initialize
+    # See Jamf::APIObject#initialize
     #
-    def initialize(args = {})
+    def initialize(**args)
       super
       @redeploy_days_before_certificate_expires = @main_subset[:redeploy_days_before_certificate_expires]
     end
@@ -75,7 +75,7 @@ module JSS
     #
     def redeploy_days_before_certificate_expires=(new_val)
       return nil if redeploy_days_before_certificate_expires == new_val
-      raise JSS::InvalidDataError, 'New value must be an integer >= 0' unless new_val.is_a?(Integer) && new_val >= 0
+      raise Jamf::InvalidDataError, 'New value must be an integer >= 0' unless new_val.is_a?(Integer) && new_val >= 0
       @redeploy_days_before_certificate_expires = new_val
       @need_to_update = true
     end #
@@ -93,7 +93,4 @@ module JSS
 
   end # class MobileDeviceConfigurationProfile
 
-end # module JSS
-
-require 'jss/api_object/configuration_profile/mobile_device_configuration_profile'
-require 'jss/api_object/configuration_profile/osx_configuration_profile'
+end # module Jamf