ruby-jss 4.2.0b2 → 4.2.1

data/lib/jamf/composer.rb

@@ -1,97 +1,104 @@
-### Copyright 2025 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.
-###
-###
-
-###
+# Copyright 2025 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.
+#
+#
+
 module Jamf
 
-  ###
-  ### This module provides two methods for building very simple Casper-happy .pkg and .dmg packages for deployment.
-  ###
-  ### Unlike Composer.app from JAMF, this module currently doesn't offer a way to do a before/after disk scan
-  ### and use the differences to build the root folder from which the package is built. Nor does the module support
-  ### editing the pre/post install scripts in .pkgs.
-  ###
-  ### The 'root folder', a folder representing the root filesystem of the target machine where the package will be installed,
-  ### must already exist and be fully populated and with correct permissions.
-  ###
+  # This module provides two methods for building very simple Casper-happy .pkg and .dmg
+  # packages for deployment.
+  #
+  # Unlike Composer.app from JAMF, this module currently doesn't offer a way to do a
+  # before/after disk scan
+  # and use the differences to build the root folder from which the package is built.
+  # Nor does the module support
+  # editing the pre/post install scripts in .pkgs.
+  #
+  # The 'root folder', a folder representing the root filesystem of the target machine
+  # where the package will be installed,
+  # must already exist and be fully populated and with correct permissions.
+  #
+  #
+  # TODO: Support building Distribution-style packages using the 'productbuild' tool,
+  # since they are needed for deploying packages via MDM - Component packages created
+  # by pkgbuild are not supported for MDM deployment.
+  #
   module Composer
 
     #####################################
-    ### Constants
+    # Constants
     #####################################
 
-    ### the apple pkgutil tool
+    # the apple pkgutil tool
     PKG_UTIL = Pathname.new '/usr/sbin/pkgutil'
 
-    ### The location of the cli tool for making .pkgs
+    # The location of the cli tool for making .pkgs
     PKGBUILD = Pathname.new '/usr/bin/pkgbuild'
 
-    ### the default bundle identifier prefix for pkgs
+    # the default bundle identifier prefix for pkgs
     PKG_BUNDLE_ID_PFX = 'ruby-jss-composer'.freeze
 
-    ### Apple's hdiutil for making dmgs
+    # Apple's hdiutil for making dmgs
     HDI_UTIL = '/usr/bin/hdiutil'.freeze
 
-    ### Where to save the output ?
+    # Where to save the output ?
     DEFAULT_OUT_DIR = Pathname.new '/Users/Shared'
 
-    ### Make a casper-happy .pkg out of a root folder, permissions are assumed to be correct.
-    ###
-    ### @param name[String] the name of the .pkg. The .pkg suffix will be added if not present
-    ###
-    ### @param version[String] the version of the .pkg, needed for building the .pkg
-    ###
-    ### @param root[String, Pathname] the path to the 'root folder' representing
-    ###   the root file system of the target install drive
-    ###
-    ### @param opts[Hash] the options for building the .pkg
-    ###
-    ### @options opts :pkg_id[String] the full package if for the new pkg.
-    ###   e.g. 'com.mycompany.myapp'
-    ###
-    ### @option opts :bundle_id_prefix[String] the pkg bundle identifier prefix.
-    ###   If no :pkg_id is provided, one is made using this prefix and
-    ###   the name provided. e.g. 'com.mycompany'
-    ###   Defaults to '{PKG_BUNDLE_ID_PFX}'. See 'man pkgbuild' for more info
-    ###
-    ### @option opts :out_dir[String,Pathname] he folder in which the .pkg will be
-    ###   created. Defaults to {DEFAULT_OUT_DIR}
-    ###
-    ### @option opts :preserve_ownership[Boolean] If true, the owner/group of the
-    ###   rootpath are preserved.
-    ###   Default is false: they become the pkgbuild/installer 'recommended'
-    ###   (root/wheel or root/admin)
-    ###
-    ### @option opts :signing_identity[String] the optional name of the signing identity (certificate) to
-    ###   use for signing the pkg. See `man pkgbuild` for details
-    ###
-    ### @option opts :signing_options[String] the optional string of options to pass to pkgbuild.
-    ###  See `man pkgbuild` for details
-    ###
-    ### @return [Pathname] the local path to the new .pkg
-    ###
+    # Make a casper-happy .pkg out of a root folder, permissions are assumed to be correct.
+    #
+    # @param name[String] the name of the .pkg. The .pkg suffix will be added if not present
+    #
+    # @param version[String] the version of the .pkg, needed for building the .pkg
+    #
+    # @param root[String, Pathname] the path to the 'root folder' representing
+    #   the root file system of the target install drive
+    #
+    # @param opts[Hash] the options for building the .pkg
+    #
+    # @options opts :pkg_id[String] the full package if for the new pkg.
+    #   e.g. 'com.mycompany.myapp'
+    #
+    # @option opts :bundle_id_prefix[String] the pkg bundle identifier prefix.
+    #   If no :pkg_id is provided, one is made using this prefix and
+    #   the name provided. e.g. 'com.mycompany'
+    #   Defaults to '{PKG_BUNDLE_ID_PFX}'. See 'man pkgbuild' for more info
+    #
+    # @option opts :out_dir[String,Pathname] he folder in which the .pkg will be
+    #   created. Defaults to {DEFAULT_OUT_DIR}
+    #
+    # @option opts :preserve_ownership[Boolean] If true, the owner/group of the
+    #   rootpath are preserved.
+    #   Default is false: they become the pkgbuild/installer 'recommended'
+    #   (root/wheel or root/admin)
+    #
+    # @option opts :signing_identity[String] the optional name of the signing identity (certificate) to
+    #   use for signing the pkg. See `man pkgbuild` for details
+    #
+    # @option opts :signing_options[String] the optional string of options to pass to pkgbuild.
+    #  See `man pkgbuild` for details
+    #
+    # @return [Pathname] the local path to the new .pkg
+    #
     def self.mk_pkg(name, version, root, **opts)
       raise NoSuchItemError, "Missing pkgbuild tool. Please make sure you're running 10.8 or later." unless PKGBUILD.executable?
 
@@ -111,28 +118,28 @@ module Jamf
         signing = ''
       end # if opts[:signing_identity]
 
-      ### first, run 'analyze' to get a 'component plist' in which we can change some settings
-      ### for any bundles in the root (bundles like .apps, frameworks, plugins, etc..)
-      ###
-      ### we edit the settings thus:
-      ### BundleOverwriteAction = upgrade, totally replace any version current on disk
-      ### BundleIsVersionChecked = false, allow us to install regardless of what version is currently installed
-      ### BundleIsRelocatable = false,  if there's a version of this in some other location, Do Not move this one there after installation
-      ### BundleHasStrictIdentifier = false, don't care if there's something at the install path with a different bundle id.
-      ###
-      ### In other words, just install the thing!
-      ### (see 'man pkgbuild' for more info)
-      ###
-      ###
+      # first, run 'analyze' to get a 'component plist' in which we can change some settings
+      # for any bundles in the root (bundles like .apps, frameworks, plugins, etc..)
+      #
+      # we edit the settings thus:
+      # BundleOverwriteAction = upgrade, totally replace any version current on disk
+      # BundleIsVersionChecked = false, allow us to install regardless of what version is currently installed
+      # BundleIsRelocatable = false,  if there's a version of this in some other location, Do Not move this one there after installation
+      # BundleHasStrictIdentifier = false, don't care if there's something at the install path with a different bundle id.
+      #
+      # In other words, just install the thing!
+      # (see 'man pkgbuild' for more info)
+      #
+      #
       comp_plist_out = Pathname.new "/tmp/#{PKG_BUNDLE_ID_PFX}-#{pkg_filename}.plist"
       system "#{PKGBUILD} --analyze --root '#{root}' '#{comp_plist_out}'"
       comp_plist = JSS.parse_plist comp_plist_out
 
-      ### if the plist is empty, there are no bundles in the pkg
+      # if the plist is empty, there are no bundles in the pkg
       if comp_plist[0].nil?
         comp_plist_arg = ''
       else
-        ### otherwise, edit the bundle dictionaries
+        # otherwise, edit the bundle dictionaries
         comp_plist.each do |bndl|
           bndl.delete 'ChildBundles' if bndl['ChildBundles']
           bndl['BundleOverwriteAction'] = 'upgrade'
@@ -140,12 +147,12 @@ module Jamf
           bndl['BundleIsRelocatable'] = false
           bndl['BundleHasStrictIdentifier'] = false
         end
-        ### write out the edits
+        # write out the edits
         comp_plist_out.open('w') { |f| f.write JSS.xml_plist_from(comp_plist) }
         comp_plist_arg = "--component-plist '#{comp_plist_out}'"
       end
 
-      ### now build the pkg
+      # now build the pkg
       begin
         it_built = system "#{PKGBUILD} --identifier '#{pkg_id}' --version '#{version}' --ownership #{pkg_ownership} --install-location / --root '#{root}' #{signing} #{comp_plist_arg} '#{pkg_out}'"
 
@@ -157,18 +164,18 @@ module Jamf
       Pathname.new pkg_out
     end # mk_dot_pkg
 
-    ###
-    ### Make a casper-happy .dmg out of a root folder, permissions are assumed to be correct.
-    ###
-    ### @param name[String] The name of the .dmg, the suffix will be added if needed
-    ###
-    ### @param root[String, Pathname]  the path to the "root folder" representing the root file system of the target install drive
-    ###
-    ### @param out_dir[String, Pathname] the folder in which the .pkg will be created. Defaults to {DEFAULT_OUT_DIR}
-    ###
-    ### @return [Pathname] the local path to the new .dmg
-    ###
-    ###
+    #
+    # Make a casper-happy .dmg out of a root folder, permissions are assumed to be correct.
+    #
+    # @param name[String] The name of the .dmg, the suffix will be added if needed
+    #
+    # @param root[String, Pathname]  the path to the "root folder" representing the root file system of the target install drive
+    #
+    # @param out_dir[String, Pathname] the folder in which the .pkg will be created. Defaults to {DEFAULT_OUT_DIR}
+    #
+    # @return [Pathname] the local path to the new .dmg
+    #
+    #
     def self.mk_dmg(name, root, out_dir = DEFAULT_OUT_DIR)
       dmg_filename = "#{name}.dmg"
       dmg_vol = name
@@ -178,7 +185,7 @@ module Jamf
         dmg_out.rename mv_to
       end # if dmg out exist
 
-      ### TODO - this may need to be sudo'd to handle proper internal permissions.
+      # TODO: - this may need to be sudo'd to handle proper internal permissions.
       system "#{HDI_UTIL} create -volname '#{dmg_vol}' -scrub -srcfolder '#{root}' '#{dmg_out}'"
 
       raise 'There was an error building the .dmg' unless $?.exitstatus.zero?

data/lib/jamf/oapi_validate.rb

@@ -163,6 +163,7 @@ module Jamf
 
       # try to instantiate the class with the value. It should raise an error
       # if not good
+      # TODO: Does this method name need to be in Jamf::JPAPIResource::NEW_CALLERS
       klass.new val
     rescue => e
       raise_invalid_data_error(msg || "#{attr_name} value must be a #{klass}, or #{klass}.new must accept it as the only parameter, but #{klass}.new raised: #{e.class}: #{e}")

data/lib/jamf/utility.rb

@@ -65,27 +65,33 @@ module Jamf
     #
     # 12 is the default for the current OS and higher
     # (and hoping apple doesn't release, e.g.,  11.13)
+    #
+    # There is no 16-25 because in 2025 Apple changed the numbering
+    # scheme to match the year after release. So the OS released in
+    # 2025 is versino 26, not 16.
+    #
+    # This array should take us thru to 2039.
     MAC_OS_MAXS = {
       11 => 12,
       12 => 12,
       13 => 12,
       14 => 12,
       15 => 12,
-      16 => 12,
-      17 => 12,
-      18 => 12,
-      19 => 12,
-      20 => 12,
-      21 => 12,
-      22 => 12,
-      23 => 12,
-      24 => 12,
-      25 => 12,
       26 => 12,
       27 => 12,
       28 => 12,
       29 => 12,
-      30 => 12
+      30 => 12,
+      31 => 12,
+      32 => 12,
+      33 => 12,
+      34 => 12,
+      35 => 12,
+      36 => 12,
+      37 => 12,
+      38 => 12,
+      39 => 12,
+      40 => 12
     }
 
     # Converts an OS Version into an Array of equal or higher OS versions, up to
@@ -188,7 +194,7 @@ module Jamf
       # e.g. 11.x, or 11.x.x
       # expand to 11.x, 12.x, 13.x, ... 30.x
       if minor == 'x'
-        ((major.to_i)..MAC_OS_MAXS.keys.max).each { |v| ok_oses << "#{v}.x" }
+        ((major.to_i)..MAC_OS_MAXS.keys.max).each { |v| ok_oses << "#{v}.x" unless (16..25).include?(v) } # skip 16-25
 
       # e.g. 11.2.x
       # expand to 11.2.x, 11.3.x, ... 11.12.x,
@@ -202,7 +208,7 @@ module Jamf
         end # each m
 
         # then add the majors out to 20
-        ((major.to_i + 1)...MAC_OS_MAXS.keys.max).each { |v| ok_oses << "#{v}.x" }
+        ((major.to_i + 1)...MAC_OS_MAXS.keys.max).each { |v| ok_oses << "#{v}.x" unless (16..25).include?(v) }
 
       # e.g. 11.2.3
       # expand to 11.2.3, 11.2.4, ... 11.2.10,
@@ -219,7 +225,7 @@ module Jamf
         ((minor.to_i + 1)..max_minor_for_major).each { |min| ok_oses << "#{major}.#{min}.x" }
 
         # then add the majors out to 20
-        ((major.to_i + 1)..MAC_OS_MAXS.keys.max).each { |v| ok_oses << "#{v}.x" }
+        ((major.to_i + 1)..MAC_OS_MAXS.keys.max).each { |v| ok_oses << "#{v}.x" unless (16..25).include?(v) }
       end
 
       ok_oses

data/lib/jamf/version.rb

@@ -27,6 +27,6 @@
 module Jamf
 
   ### The version of ruby-jss
-  VERSION = '4.2.0b2'.freeze
+  VERSION = '4.2.1'.freeze
 
 end # module

data/test/bin/runtests

@@ -80,7 +80,7 @@ class App
   OPTS = GetoptLong.new(
     ['--host', '-h', GetoptLong::REQUIRED_ARGUMENT],
     ['--port', '-p', GetoptLong::REQUIRED_ARGUMENT],
-    ['--re-save', '-r', GetoptLong::REQUIRED_ARGUMENT],
+    ['--re-save', '-r', GetoptLong::NO_ARGUMENT],
     ['--help', '-H', GetoptLong::NO_ARGUMENT]
   )
 
@@ -154,7 +154,7 @@ class App
 
   ###################################
   def connect
-    JamfTest::Auth.delete_api_creds(@api_server) if @re_save_creds
+    JamfTest::Auth.delete_api_creds(host: @api_server) if @re_save_creds
     JamfTest::Auth.connect_to_api host: @api_server, port: @api_port
   end
 

data/test/lib/jamf_test/collection_tests.rb

@@ -329,9 +329,17 @@ module JamfTest
 
     ################
     def validate_fetched
-      raise 'Original ruby object created with .create is not == to the one re-fetched after saving!' unless @fetched_new_object == @unsaved_new_object
+      # TODO: this doesn't work for some JPAPI classes, which compare sha1 hashes.
+      # See TODO in oapi_object.rb -> <=> method
 
-      say "Fetched instance of #{collection_class} is == to the original one we made with .create"
+      if @unsaved_new_object.respond_to? :sha1_hash
+        say "unsaved_new_object instance of #{collection_class} sha1 is #{@unsaved_new_object.sha1_hash}"
+        say "fetched_new_object instance of #{collection_class} sha1 is #{@fetched_new_object.sha1_hash}"
+      else
+        raise 'Original ruby object created with .create is not == to the one re-fetched after saving!' unless @fetched_new_object == @unsaved_new_object
+
+        say "Fetched instance of #{collection_class} is == to the original one we made with .create"
+      end
     end
 
     ################

data/test/tests/computer_group.rb

@@ -47,29 +47,44 @@ module JamfTest
     ################
     def add_data_to_new
       @all_comps_shuffled = Jamf::Computer.all.dup.shuffle
+      if @all_comps_shuffled.empty?
+        say 'No computers found in Jamf to add to the new Static Group!'
+        return
+      end
+
       @comps_added_to_static_group = []
 
       comp_1 = @all_comps_shuffled.shift
-      @unsaved_new_object.add_member comp_1[:id]
-      @comps_added_to_static_group << comp_1[:id]
-      say "Added computer id #{comp_1[:id]} to unsaved Static Group"
+      if comp_1
+        @unsaved_new_object.add_member comp_1[:id]
+        @comps_added_to_static_group << comp_1[:id]
+        say "Added computer id #{comp_1[:id]} to unsaved Static Group"
+      end
 
       comp_2 = @all_comps_shuffled.shift
-      @unsaved_new_object.add_member comp_2[:name]
-      @comps_added_to_static_group << comp_2[:name]
-      say "Added computer name #{comp_2[:name]} to unsaved Static Group"
+      if comp_2
+        @unsaved_new_object.add_member comp_2[:name]
+        @comps_added_to_static_group << comp_2[:name]
+        say "Added computer name #{comp_2[:name]} to unsaved Static Group"
+      end
 
       comp_3 = @all_comps_shuffled.shift
-      @unsaved_new_object.add_member comp_3[:serial_number]
-      @comps_added_to_static_group << comp_3[:serial_number]
-      say "Added computer serial_number #{comp_3[:serial_number]} to unsaved Static Group"
+      if comp_3
+        @unsaved_new_object.add_member comp_3[:serial_number]
+        @comps_added_to_static_group << comp_3[:serial_number]
+        say "Added computer serial_number #{comp_3[:serial_number]} to unsaved Static Group"
+      end
 
       comp_4 = @all_comps_shuffled.shift
-      @unsaved_new_object.add_member comp_4[:udid]
-      @comps_added_to_static_group << comp_4[:udid]
-      say "Added computer udid #{comp_4[:udid]} to unsaved Static Group"
+      if comp_4
+        @unsaved_new_object.add_member comp_4[:udid]
+        @comps_added_to_static_group << comp_4[:udid]
+        say "Added computer udid #{comp_4[:udid]} to unsaved Static Group"
+      end
 
       comp_5 = @all_comps_shuffled.shift
+      return unless comp_5
+
       @unsaved_new_object.add_member comp_5[:mac_address]
       @comps_added_to_static_group << comp_5[:mac_address]
       say "Added computer mac_address #{comp_5[:mac_address]} to unsaved Static Group"
@@ -109,6 +124,8 @@ module JamfTest
       say "Modified/saved/refetched instance of #{collection_class} has correct membership."
 
       # Test the class method for changing membership without instantiating/saving
+      return unless @all_comps_shuffled.size > 4
+
       adds = []
       adds << @all_comps_shuffled.shift[:id]
       adds << @all_comps_shuffled.shift[:serial_number]

data/test/tests/{jp_building.rb → j_building.rb}

@@ -25,11 +25,11 @@
 
 module JamfTest
 
-  class JpBuilding < JamfTest::APITest
+  class JBuilding < JamfTest::APITest
 
     include JamfTest::CollectionTests
 
-    COLLECTION_CLASS = Jamf::JpBuilding
+    COLLECTION_CLASS = Jamf::JBuilding
 
     # run the tests
     def run_class_tests

data/test/tests/j_package.rb

@@ -0,0 +1,47 @@
+### Copyright 2025 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.
+###
+###
+
+module JamfTest
+
+  class JPackage < JamfTest::APITest
+
+    include JamfTest::CollectionTests
+
+    COLLECTION_CLASS = Jamf::JPackage
+
+    # run the tests
+    def run_class_tests
+      run_collection_tests
+    end
+
+    def create_new
+      @unsaved_new_object = collection_class.create packageName: test_object_name
+      @unsaved_new_object.fileName = "#{test_object_name}.pkg"
+      say "Created new #{collection_class}, to be saved in Jamf."
+    end
+
+  end # class
+
+end # module JamfTest