ruby-jss 4.1.1 → 4.2.0

data/lib/jamf/api/classic/api_objects/web_hook.rb

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# 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
@@ -22,7 +22,6 @@
 #
 #
 
-#
 module Jamf
 
   # Classes
@@ -62,7 +61,7 @@ module Jamf
     }.freeze
 
     # The available webhook events.
-    EVENTS = %w(
+    EVENTS = %w[
       ComputerAdded
       ComputerCheckIn
       ComputerInventoryCompleted
@@ -81,7 +80,7 @@ module Jamf
       SCEPChallenge
       SmartGroupComputerMembershipChange
       SmartGroupMobileDeviceMembershipChange
-    ).freeze
+    ].freeze
 
     # the object type for this object in
     # the object history table.
@@ -135,9 +134,11 @@ module Jamf
     #
     def enabled=(new_val)
       return nil if new_val == @enabled
+
       new_val = false if new_val.to_s.empty?
       raise Jamf::InvalidDataError, "enabled must be boolean 'true' or 'false'" unless \
         Jamf::TRUE_FALSE.include? new_val
+
       @enabled = new_val
       @need_to_update = true
     end
@@ -150,9 +151,11 @@ module Jamf
     #
     def url=(new_val)
       return nil if new_val == @url
+
       # handy - from http://stackoverflow.com/questions/1805761/check-if-url-is-valid-ruby#1805788
-      url_ok = new_val =~ /\A#{URI.regexp(%w(http https))}\z/
+      url_ok = new_val =~ /\A#{URI::DEFAULT_PARSER.make_regexp(%w[http https])}\z/
       raise Jamf::InvalidDataError, 'New value is not a valid http(s) url' unless url_ok && url_ok.zero?
+
       @url = new_val
       @need_to_update = true
     end
@@ -168,6 +171,7 @@ module Jamf
       return nil if new_val == @content_type
       raise Jamf::InvalidDataError, "content_type must be one of :#{CONTENT_TYPES.keys.join ', :'}" unless \
         CONTENT_TYPES.keys.include? new_val
+
       @content_type = new_val
       @need_to_update = true
     end
@@ -182,6 +186,7 @@ module Jamf
     def event=(new_val)
       return nil if new_val == @event
       raise Jamf::InvalidDataError, 'Unknown webhook event' unless EVENTS.include? new_val
+
       @event = new_val
       @need_to_update = true
     end
@@ -195,6 +200,7 @@ module Jamf
     #
     def enable
       raise Jamf::NoSuchItemError, 'Save the webhook before enabling it' unless @in_jss
+
       self.enabled = true
       save
     end
@@ -205,6 +211,7 @@ module Jamf
     #
     def disable
       raise Jamf::NoSuchItemError, 'Save the webhook before disabling it' unless @in_jss
+
       self.enabled = false
       save
     end

data/lib/jamf/api/classic/base_classes/advanced_search.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -62,7 +62,6 @@ module Jamf
     include Jamf::Criteriable
     include Jamf::Sitable
 
-
     # Class Constants
     #####################################
 
@@ -144,7 +143,7 @@ module Jamf
     # @see APIObject#initialize
     #
     def initialize(**args)
-      super **args
+      super(**args)
 
       # @init_data now has the raw data
       # so fill in our attributes or set defaults
@@ -220,14 +219,15 @@ module Jamf
     def save(get_results = false)
       if @in_jss
         raise Jamf::UnsupportedError, 'Updating this object in the JSS is currently not supported by ruby-jss' unless updatable?
+
         update get_results
       else
         raise Jamf::UnsupportedError, 'Creating this object in the JSS is currently not supported by ruby-jss' unless creatable?
+
         create get_results
       end
     end
 
-
     # Requery the API for the search results.
     #
     # This can be very slow, so temporarily reset the API timeout to 30 minutes
@@ -257,6 +257,7 @@ module Jamf
     def display_fields=(new_val)
       raise Jamf::InvalidDataError, 'display_fields must be an Array.' unless new_val.is_a? Array
       return if new_val.sort == @display_fields.sort
+
       @display_fields = new_val
       @need_to_update = true
     end
@@ -287,9 +288,7 @@ module Jamf
 
       out = Pathname.new output_file
 
-      unless overwrite
-        raise Jamf::AlreadyExistsError, "The output file already exists: #{out}" if out.exist?
-      end
+      raise Jamf::AlreadyExistsError, "The output file already exists: #{out}" if !overwrite && out.exist?
 
       case format
       when :csv

data/lib/jamf/api/classic/base_classes/api_object.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -1160,7 +1160,15 @@ module Jamf
     def self.new(**args)
       validate_not_metaclass(self)
 
-      calling_method = caller_locations(1..1).first.label
+      # calling_method = caller_locations(1..1).first.label
+      #
+      # Temp workaround for ruby 3.4 until I figure out the best way to deal with 
+      # the new behavior of caller_locations. `label` used to return just the method name
+      # e.g. `fetch` but now it returns, e.g. `Jamf::APIObject.fetch`
+      # See https://docs.ruby-lang.org/en/3.4/Thread/Backtrace/Location.html
+      # and investigate the `base_label` method
+      calling_method = caller_locations(1..1).first.label.to_s.split('.').last
+
       raise Jamf::UnsupportedError, 'Use .fetch or .create to instantiate APIObject classes' unless OK_INSTANTIATORS.include? calling_method
 
       super

data/lib/jamf/api/classic/base_classes/configuration_profile.rb

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

data/lib/jamf/api/classic/base_classes/extension_attribute.rb

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2025 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -272,9 +272,7 @@ module Jamf
     #
     def web_display=(new_val)
       return if @web_display == new_val
-      unless WEB_DISPLAY_CHOICES.include? new_val
-        raise Jamf::InvalidDataError, "inventory_display must be a string, one of: #{WEB_DISPLAY_CHOICES.join(', ')}"
-      end
+      raise Jamf::InvalidDataError, "inventory_display must be a string, one of: #{WEB_DISPLAY_CHOICES.join(', ')}" unless WEB_DISPLAY_CHOICES.include? new_val
 
       @web_display = new_val
       @need_to_update = true

data/lib/jamf/api/classic/base_classes/group.rb

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2025 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -325,7 +325,7 @@ module Jamf
 
       params[:criteria] = [] if params[:criteria].nil?
 
-      criteria = params[:criteria]
+      params[:criteria]
 
       @is_smart = true
       @need_to_update = true
@@ -429,8 +429,9 @@ module Jamf
     def remove_member(mem)
       raise UnsupportedError, "Smart group members can't be changed." if smart?
 
-      # See if we have the identifier in the @members hash
+      # See if we have the identifier in the @members array of hashes
       id_to_remove = @members.select { |mm| mm.values.include? mem }.first&.dig :id
+
       # But the members hash might not have SN, macaddr, etc, and never has udid, so
       # look at the MEMBER_CLASS if needed
       id_to_remove ||= self.class::MEMBER_CLASS.valid_id mem
@@ -438,7 +439,7 @@ module Jamf
       # nothing to do if that id isn't one of our members
       return unless id_to_remove && member_ids.include?(id_to_remove)
 
-      @members.delete_if { |k, v| k == :id && v == id_to_remove }
+      @members.delete_if { |h| h[:id] == id_to_remove } # { |k, v| k == :id && v == id_to_remove }
       @need_to_update = true
     end
 
@@ -483,7 +484,6 @@ module Jamf
       @members = @cnx.c_get(@rest_rsrc)[self.class::RSRC_OBJECT_KEY][self.class::MEMBER_CLASS::RSRC_LIST_KEY]
     end
 
-
     # Public Instance Methods
     #####################################
     private

data/lib/jamf/api/classic/base_classes/patch_source.rb

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

data/lib/jamf/api/classic/xml_workaround.rb

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

data/lib/jamf/api/connection/attributes.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### 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

data/lib/jamf/api/connection/cache.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### 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

data/lib/jamf/api/connection/classic_api.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### 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

data/lib/jamf/api/connection/connect.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### 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

data/lib/jamf/api/connection/constants.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### 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

data/lib/jamf/api/connection/default_connection.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### 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

data/lib/jamf/api/connection/jamf_pro_api.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### 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
@@ -35,7 +35,7 @@ module Jamf
 
       # create the faraday JPAPI connection object
       #######################################################
-      def create_jp_connection(parse_json: true)
+      def create_jp_connection(parse_json: true, upload: false)
         Faraday.new(@jp_base_url, ssl: ssl_options) do |cnx|
           # use a proc for the token value, so its looked up on every request
           # meaning we don't have to validate that the token is still valid before every request
@@ -45,8 +45,10 @@ module Jamf
           cnx.options[:timeout] = @timeout
           cnx.options[:open_timeout] = @open_timeout
 
+          cnx.request :multipart if upload
+
           if parse_json
-            cnx.request :json
+            cnx.request :json unless upload
             cnx.response :json, parser_options: { symbolize_names: true }
           end
 
@@ -178,6 +180,30 @@ module Jamf
         raise Jamf::Connection::JamfProAPIError, resp
       end
 
+      # @param rsrc[String] the API resource being uploadad-to,
+      #   the URL part after 'JSSResource/'
+      #
+      # @param local_file[String, Pathname] the local file to upload
+      #
+      # @return [String] the xml response from the server.
+      #
+      def jp_upload(rsrc, local_file)
+        upload_cnx = create_jp_connection upload: true
+
+        rsrc = rsrc.delete_prefix Jamf::Connection::SLASH
+
+        payload = {}
+        payload[:file] = Faraday::Multipart::FilePart.new(local_file.to_s, 'application/octet-stream')
+
+        resp = upload_cnx.post rsrc, payload
+
+        @last_http_response = resp
+
+        return resp.body if resp.success?
+
+        raise Jamf::Connection::JamfProAPIError, resp
+      end # upload
+
     end # module
 
   end # class

data/lib/jamf/api/connection/jamf_pro_api_error.rb

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2025 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -93,10 +93,10 @@ module Jamf
         msg << errors.map do |err|
           err_str = +''
           err_str << " Field: #{err.field}" unless err.field.to_s.empty?
-          err_str << ' Error:' if err.code || err.description
-          err_str << " #{err.code}" if err.code
-          err_str << " #{err.description}" if err.description
-          err_str << " Object ID: '#{err.id}'" if err.id
+          err_str << ', Error:' if err.code || err.description
+          err_str << ", #{err.code}" if err.code
+          err_str << ", #{err.description}" if err.description
+          err_str << ", Object ID: '#{err.id}'" if err.id
           err_str
         end.join('; ')
         msg

data/lib/jamf/api/connection/token.rb

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

data/lib/jamf/api/connection.rb

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### 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

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2025 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -66,7 +66,7 @@ module Jamf
 
     ############# API PATHS
 
-    # The path for GETting the list of all objects in the collection, possibly
+    # LIST_PATH: The path for GETting the list of all objects in the collection, possibly
     # filtered, sorted, and/or paged
     # REQUIRED for all collection resources
     #
@@ -105,6 +105,9 @@ module Jamf
       id displayName
     ].freeze
 
+    # The attribute holding the object's name
+    OBJECT_NAME_ATTR = :displayName
+
     # Class Methods
     ###############################
 
@@ -137,9 +140,6 @@ module Jamf
     # Instance Attributes and Methods
     ###########################
 
-
-
-
     # For this API Client, replace the existing clientSecret with a new one, to be
     # used with the clientID for generating a connection token.
     #
@@ -167,7 +167,6 @@ module Jamf
     alias roles_insert authorizationScopes_insert
     alias roles_prepend authorizationScopes_prepend
 
-
   end # class
 
 end # module

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

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

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2025 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -121,6 +121,9 @@ module Jamf
       id displayName
     ].freeze
 
+    # The attribute holding the object's name
+    OBJECT_NAME_ATTR = :displayName
+
     # Class Methods
     ###############################
 

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

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2025 Pixar
 #
 # frozen_string_literal: true
 
@@ -38,7 +38,7 @@ module Jamf
   # collection, i.e. the 'GET_OBJECT' similar to the POST_OBJECT defined in the
   # class below.
   #
-  class ComputerPrestage < Jamf::OAPISchemas::GetComputerPrestageV2
+  class ComputerPrestage < Jamf::OAPISchemas::GetComputerPrestageV3
 
     include Jamf::CollectionResource
     include Jamf::Prestage

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

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

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

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

data/lib/jamf/api/jamf_pro/api_objects/{jp_building.rb → j_building.rb}

@@ -1,4 +1,4 @@
-# Copyright 2023 Pixar
+# Copyright 2025 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -38,7 +38,7 @@ module Jamf
   # collection, i.e. the 'GET_OBJECT' similar to the POST_OBJECT defined in the
   # class below.
   #
-  class JpBuilding < Jamf::OAPISchemas::Building
+  class JBuilding < Jamf::OAPISchemas::Building
 
     include Jamf::CollectionResource
     extend Jamf::Filterable
@@ -113,4 +113,7 @@ module Jamf
 
   end # class
 
+  # Backwards compatibility with the old name of JBuilding
+  JpBuilding = JBuilding
+
 end # module