ruby-jss 4.2.0 → 4.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19c9e79713c2ae52e27acf1baaecdf03446328ebce206b0d4a6d6c995d98e0cf
-  data.tar.gz: b05700b3f5e07771b257af10da6b73cf44334916cbdc0442d9d7aca539518af9
+  metadata.gz: 1c7c5b51e4752d7be68fb4e6caab5fa98d00e2bba66bfa356a316004a5f7ea49
+  data.tar.gz: 455ef851b1e8bb75faf2e9abc171a0fbd84a8a1b30156c18b30933fc0ad51edf
 SHA512:
-  metadata.gz: d400c1033d40a4128d5021e21f3fd367158caf2ed176108bf912198f76f4669bfd3500b26e0677279a9d87c65dc69974fe636588d100256f64a79315d64747b0
-  data.tar.gz: 631190601b377d45d1cb1ba80ec54decf662f7b6223d311f6b6e3a73dfea5731b86bac7d5046d47a6364395a3abb5b4ef4c1b1add424868da917ed037152fa8c
+  metadata.gz: c8c9d09216f3105002b9c9200896223d94a191a5601cb21cde79df1aeb1745275d86481765cfa840ed25fcb93ba9d634f1efd4332e774d8a74d079a7a036604f
+  data.tar.gz: 640aef2c3794c0337ab6ce7c08598eb096280e3feab54d245f5e0af7cef62903898f0c8d405c0265c2febe065f2bac05182081f3736c5d5fe75f879ce44d40ba

data/CHANGES.md

@@ -14,6 +14,47 @@ __Please update all installations of ruby-jss to at least v1.6.0.__
 
 Many many thanks to actae0n of Blacksun Hackers Club for reporting this issue and providing examples of how it could be exploited.
 
+--------
+## \[4.2.2] Unreleased
+
+### Fixed
+  - Class `Jamf::JPackage` no longer raises `Errno::EINVAL Invalid argument @ io_fread` when generating manifest checksums for very large package files.
+
+
+### Deprecated
+
+  - Class `Jamf::DBConnection`. Access to the MySQL backend database for on-prem Jamf Pro installations will be removed in a future release, probably some time in mid-late 2026. If you use this class, please update your code to make and use such connections independently of ruby-jss. This removal also includes the 'default' instance stored in `Jamf::DB_CNX` and `Jamf.db`. 
+  
+    The following methods will also be removed, as they require that class for direct database access.
+    - `Jamf::ComputerExtensionAttribute#history`
+    - `Jamf::MobileDeviceExtensionAttribute#history`
+    - `Jamf::Icon.all`
+    - `Jamf::SelfServable#validate_icon`
+    - `Jamf::APIObject#add_object_history_entry`
+
+    Note that some objects in the Jamf Pro API have access to their object_history. As classes are migrated (see release notes for 4.2.0 below) that access will be included when available.
+ 
+  
+
+--------
+## \[4.2.1] 2025-08-11
+
+### Fixed
+
+  - `Jamf::JPackage#osRequirements=` now properly expands versions starting with '>='
+  - `OAPIObject` no longer overwrites custom getters & setters with autogenerated ones.
+  - calling `.all instantiate: true` no longer raises an error for JPAPI collection classes in ruby 3.x
+
+### Changed
+
+  - `Jamf.expand_min_os` now knows that Apple has skipped macOS v16-25, and that starting with 
+     Tahoe, the os is v26, incremented yearly. It now expands to v40, which should hold us for over 
+     a decade.
+
+### Added
+
+  - `OAPIObject` subclasses now have an attr_reader `creating_from_create` indicating that they are being instantiated by the `.create` class method, as opposed to being fetched or given API data
+
 --------
 ## \[4.2.0] 2025-06-11
 
@@ -52,7 +93,7 @@ If you have thoughts or comments on this, please reach out:
 
   - Collection Resource classes from the Jamf Pro API can now define a constant OBJECT_NAME_ATTR, which indicates the attribute that holds the individual object's name, if that isn't "name". 
 
-    For example, Computer and MobileDevice prestage objects, the name is in the "displayName" attribute.  For JPackages via the Jamf Pro API, the package object's name (not its file name) is in the "packageName" object.
+    For example, Computer and MobileDevice prestage objects, the name is in the "displayName" attribute.  For JPackages via the Jamf Pro API, the package object's name (not its file name) is in the "packageName" attribute.
     
     When the OBJECT_NAME_ATTR is defined, the class can use "name" as a alias of the OBJECT_NAME_ATTR with getters & setters (`name=` is an alias of `displayName=`, etc) and can be used for .fetch and .valid_id:  `Jamf::JPackage.fetch name: 'foo'`  is the same as `Jamf::JPackage.fetch packageName: 'foo'`
 

data/lib/jamf/api/jamf_pro/api_objects/j_package.rb

@@ -340,6 +340,12 @@ module Jamf
       self.suppressEula = DEFAULT_SUPPRESS_EULA if suppressEula.nil?
       self.suppressRegistration = DEFAULT_SUPPRESS_REGISTRATION if suppressRegistration.nil?
 
+      if creating_from_create && osRequirements
+        # if we're creating a new object, and osRequirements is set,
+        # convert it to a comma-separated string
+        @osRequirements = osRequirements_as_comma_sep_string(osRequirements)
+      end
+
       @checksum =
         case hashType
         when CHECKSUM_HASH_TYPE_MD5
@@ -374,16 +380,36 @@ module Jamf
     # @return [void]
     #############################
     def osRequirements=(new_val)
-      # make sure we have an array
-      new_val = [new_val].flatten.compact.uniq.map(&:to_s)
-      new_val.map! do |vers|
+      orig_osRequirements = osRequirements
+
+      new_val = osRequirements_as_comma_sep_string(new_val)
+      @osRequirements = new_val
+
+      note_unsaved_change :osRequirements, orig_osRequirements
+    end
+
+    # Take a value for osRequirements, and return it as a comma-separated string,
+    # possibly expanded if any of them starts with '>='.
+    #
+    # @see Jamf.expand_min_os
+    #
+    # @param val [String,Array<String>] comma-separated string, or array of os versions
+    #
+    # @return [Array<String>] the osRequirements as an array of strings
+    #############################
+    def osRequirements_as_comma_sep_string(val)
+      # make sure we have a flat array of strings
+      val = val.split(',').map(&:strip) if val.is_a? String
+      val = [val].flatten.compact.uniq.map(&:to_s)
+
+      # expand any minimum OS versions
+      val.map! do |vers|
         vers.start_with?('>=') ? Jamf.expand_min_os(vers) : vers
       end
 
-      orig_osRequirements = osRequirements
-      @osRequirements = new_val.join(', ')
-      note_unsaved_change :osRequirements, orig_osRequirements
+      val.flatten.join(', ')
     end
+    private :osRequirements_as_comma_sep_string
 
     # Recalculate the checksum of the package file from a given filepath, and update the
     # object's checksum and hashValue attributes.
@@ -635,7 +661,15 @@ module Jamf
     # @return [void]
     ##############################
     def calculate_manifest_checksums(file, new_manifest, chunk_size: nil)
+      # we need the whole file checksum even if chunking, so
+      # get that first
+      # The Digest::SHA256.file method will read even huge files successfully
+      # without loading the whole file into memory, as would File.read.
+      #
+      whole_file_checksum = Digest::SHA256.file(file).hexdigest
+
       # are we chunking the download?
+      # we need checksums for each chunk, and the size of each chunk
       if chunk_size.is_a? Integer
         new_manifest[:items][0][:assets][0]['sha256-size'] = chunk_size
         file.open do |f|
@@ -644,23 +678,17 @@ module Jamf
           end
         end
 
-      # not chunking, use the file filesize
+      # not chunking, use the file filesize and whole-file checksum
       else
         new_manifest[:items][0][:assets][0]['sha256-size'] = file.size
-        new_manifest[:items][0][:assets][0]['sha256s'] = [Digest::SHA256.hexdigest(file.read)]
+        new_manifest[:items][0][:assets][0]['sha256s'] = [whole_file_checksum]
       end
 
       # Store the whole-file checksum in
-      # manifest[:items][0][:metadata]['sha256-whole']. taking it from
-      # manifest[:items][0][:assets][0]['sha256s'][0], if available, or generate it if needed
+      # manifest[:items][0][:metadata]['sha256-whole'], a non-standard key used by ruby-jss.
       # It is used by the deploy_via_mdm method.
       # This value is required for MDM deployments, even if the file is chunked in the manifest.
-      new_manifest[:items][0][:metadata]['sha256-whole'] =
-        if new_manifest[:items][0][:assets][0]['sha256s'].size == 1
-          new_manifest[:items][0][:assets][0]['sha256s'][0]
-        else
-          Digest::SHA256.hexdigest(file.read)
-        end
+      new_manifest[:items][0][:metadata]['sha256-whole'] = whole_file_checksum
     end
     private :calculate_manifest_checksums
 

data/lib/jamf/api/jamf_pro/base_classes/oapi_object.rb

@@ -118,6 +118,9 @@ module Jamf
     # create a getter for an attribute, and any aliases needed
     ##############################
     def self.create_getters(attr_name, attr_def)
+      # if the getter has already been defined, don't overwrite it
+      return if instance_methods.include? attr_name.to_sym
+
       # multi_value - only return a frozen dup, no direct editing of the Array
       if attr_def[:multi]
         define_method(attr_name) do
@@ -139,6 +142,11 @@ module Jamf
     # create setter(s) for an attribute, and any aliases needed
     ##############################
     def self.create_setters(attr_name, attr_def)
+      setter_method_name = "#{attr_name}="
+
+      # if the setter has already been defined, don't overwrite it
+      return if instance_methods.include? setter_method_name.to_sym
+
       # multi_value
       if attr_def[:multi]
         create_array_setters(attr_name, attr_def)
@@ -146,7 +154,7 @@ module Jamf
       end
 
       # single value
-      define_method("#{attr_name}=") do |new_value|
+      define_method(setter_method_name) do |new_value|
         new_value = validate_attr attr_name, new_value
         old_value = instance_variable_get("@#{attr_name}")
         return if new_value == old_value
@@ -345,6 +353,11 @@ module Jamf
     # @return [Hash]
     attr_reader :init_data
 
+    # If this is true, we are being created via the .create method
+    # and not fetched from the API.
+    # @return [Boolean]
+    attr_reader :creating_from_create
+
     # Constructor
     #####################################
 
@@ -356,9 +369,9 @@ module Jamf
       @init_data = data
 
       # creating a new one via ruby-jss, not fetching one from the API
-      creating = data.delete :creating_from_create if data.is_a?(Hash)
+      @creating_from_create = data.delete :creating_from_create if data.is_a?(Hash)
 
-      if creating
+      if @creating_from_create
         self.class::OAPI_PROPERTIES.each_key do |attr_name|
           # we'll enforce required values when we save
           next unless data.key? attr_name

data/lib/jamf/api/jamf_pro/other_classes/pager.rb

@@ -226,7 +226,13 @@ module Jamf
 
       data = @cnx.jp_get "#{@query_path}&page=#{page_number}"
       data = data[:results]
-      data.map! { |r| @instantiate.new r } if @instantiate
+
+      if @instantiate
+        data.map! do |r|
+          r[:cnx] = @cnx
+          @instantiate.new(**r)
+        end
+      end
 
       if increment_next
         @last_fetched_page = page_number

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.0'.freeze
+  VERSION = '4.2.2'.freeze
 
 end # module

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-jss
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.2.2
 platform: ruby
 authors:
 - Chris Lasell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-06-12 00:00:00.000000000 Z
+date: 2025-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: CFPropertyList
@@ -502,7 +502,7 @@ files:
 - test/tests/policy.rb
 homepage: http://pixaranimationstudios.github.io/ruby-jss/
 licenses:
-- Nonstandard
+- LicenseRef-LICENSE.txt
 metadata:
   source_code_uri: https://github.com/PixarAnimationStudios/ruby-jss
   changelog_uri: https://github.com/PixarAnimationStudios/ruby-jss/blob/master/CHANGES.md