ruby-jss 2.0.0 → 2.1.0b5

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

@@ -1,83 +1,65 @@
-### Copyright 2022 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
-
-  #####################################
-  ### Module Constants
-  #####################################
+# Copyright 2022 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 Variables
-  #####################################
-
-  #####################################
-  ### Module Methods
-  #####################################
+module Jamf
 
-  #####################################
-  ### Classes
+  # Classes
   #####################################
 
-  ###
-  ### A computer group in the JSS
-  ###
-  ### See also the parent class Jamf::Group
-  ###
-  ### @see Jamf::APIObject
-  ###
-  ### @see Jamf::Group
-  ###
+  
+  # A computer group in the JSS
+  # 
+  # See also the parent class Jamf::Group
+  # 
+  # @see Jamf::APIObject
+  # 
+  # @see Jamf::Group
+  # 
   class ComputerGroup < Jamf::Group
 
-    #####################################
-    ### Mix-Ins
+    
+    # Mix-Ins
     #####################################
     include Jamf::MDM
     include Jamf::MacOSManagedUpdates
+    include Jamf::MacOSRedeployMgmtFramework
 
-    #####################################
-    ### Class Methods
-    #####################################
-
-    #####################################
-    ### Class Constants
+    # Class Constants
     #####################################
 
-    ### The base for REST resources of this class
-    RSRC_BASE = "computergroups"
+    # The base for REST resources of this class
+    RSRC_BASE = 'computergroups'
 
-    ### the hash key used for the JSON list output of all objects in the JSS
+    # the hash key used for the JSON list output of all objects in the JSS
     RSRC_LIST_KEY = :computer_groups
 
-    ### The hash key used for the JSON object output.
-    ### It's also used in various error messages
+    # The hash key used for the JSON object output.
+    # It's also used in various error messages
     RSRC_OBJECT_KEY = :computer_group
 
-    ### this allows the parent Group class to do things right
+    # this allows the parent Group class to do things right
     MEMBER_CLASS = Jamf::Computer
 
     # the XML element for immediate member additions via PUT
@@ -94,45 +76,27 @@ module Jamf
     # what kind of devices are these WRT MDM
     MDM_COMMAND_TARGET = :computergroups
 
-    #####################################
-    ### Class Variables
-    #####################################
-
-    #####################################
-    ### Class Methods
-    #####################################
-
-    #####################################
-    ### Attributes
+    # Public Instance Methods
     #####################################
 
-    #####################################
-    ### Public Instance Methods
-    #####################################
-
-
-    ###
-    ### The serial numbers of members in this group
-    ###
-    ### @return [Array<String>] the member serial numbers
-    ###
+    # 
+    # The serial numbers of members in this group
+    # 
+    # @return [Array<String>] the member serial numbers
+    # 
     def member_serial_numbers
-      @members.map{|m| m[:serial_number]}
+      @members.map { |m| m[:serial_number] }
     end
 
-    ###
-    ### Return an array of the mac_addrs of members in this group
-    ###
-    ### @return [Array<String>] the member mac addresses
-    ###
+    # 
+    # Return an array of the mac_addrs of members in this group
+    # 
+    # @return [Array<String>] the member mac addresses
+    # 
     def member_mac_addresses
-      @members.map{|m| m[:mac_address]} + @members.map{|m| m[:alt_mac_address]}
+      @members.map { |m| m[:mac_address] } + @members.map { |m| m[:alt_mac_address] }
     end
 
-    #####################################
-    ### Private Instance Methods
-    #####################################
-
   end # class ComputerGroup
 
 end # module

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

@@ -194,7 +194,7 @@ module Jamf
     #
     # See Jamf::APIObject#initialize
     #
-    def initialize(args)
+    def initialize(**args)
       super
       general = @init_data[:general]
       @display_name = general[:display_name]

data/lib/jamf/api/jamf_pro/mixins/bulk_deletable.rb

@@ -39,7 +39,7 @@ module Jamf
     # @param cnx [Jamf::Connection] The connection to use, default: Jamf.cnx
     #
     # TODO: fix this return value, no more ErrorInfo
-    # @return [Array<Jamf::Connection::APIError::ErrorInfo] Info about any ids
+    # @return [Array<Jamf::Connection::JamfProAPIError::ErrorInfo] Info about any ids
     #   that failed to be deleted.
     #
     def bulk_delete(ids, cnx: Jamf.cnx)
@@ -49,7 +49,7 @@ module Jamf
       begin
         cnx.post "#{rsrc_path}/#{DELETE_MULTIPLE_ENDPOINT}", request_body
         []
-      rescue Jamf::Connection::APIError => e
+      rescue Jamf::Connection::JamfProAPIError => e
         raise e unless e.httpStatus == 400
 
         e.errors

data/lib/jamf/api/jamf_pro/mixins/collection_resource.rb

@@ -101,12 +101,10 @@ module Jamf
       #
       # Classes including CollectionResource really need to define GET_PATH if it
       # is not the same as the LIST_PATH.
-      # rubocop:disable Naming/AccessorMethodName
       ######################################
       def get_path
         @get_path ||= defined?(self::GET_PATH) ? self::GET_PATH : self::LIST_PATH
       end
-      # rubocop:enable Naming/AccessorMethodName
 
       # The path for PUTting (replacing) a single object. The desired object id will
       # be appended to the end, e.g. if this value is 'v1/buildings' and you want
@@ -570,7 +568,7 @@ module Jamf
       # @param cnx [Jamf::Connection] The connection to use, default: Jamf.cnx
       #
       #
-      # @return [Array<Jamf::Connection::APIError::ErrorInfo] Info about any ids
+      # @return [Array<Jamf::Connection::JamfProAPIError::ErrorInfo] Info about any ids
       #   that failed to be deleted.
       #
       ######################################

data/lib/jamf/api/jamf_pro/mixins/macos_managed_updates.rb

@@ -156,7 +156,7 @@ module Jamf
     #
     # @see MacOSManagedUpdates.send_managed_os_update
     #
-    def send_managed_os_update(updateAction:, maxDeferrals: nil, version: nil, skipVersionVerification: false, applyMajorUpdate: false, forceRestart: false, cnx: Jamf.cnx)
+    def send_managed_os_update(updateAction:, maxDeferrals: nil, version: nil, skipVersionVerification: false, applyMajorUpdate: false, forceRestart: false)
       deviceIds = is_a?(Jamf::Computer) ? @id : nil
       groupId = is_a?(Jamf::Computer) ? nil : @id
 

data/lib/jamf/api/jamf_pro/mixins/macos_redeploy_mgmt_framework.rb

@@ -0,0 +1,113 @@
+# Copyright 2022 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 should be mixed in to Jamf::Computer and Jamf::ComputerGroup
+  #
+  # It provides access to the macos-managed-software-updates JPAPI resource for 
+  # managed OS update commands to managed macs running Big Sur or higher.
+  #
+  module MacOSRedeployMgmtFramework
+
+    # when this module is included, also extend our Class Methods
+    def self.included(includer)
+      Jamf.load_msg "--> #{includer} is including #{self}"
+      includer.extend(ClassMethods)
+    end
+
+    # The JP API resource for redeploying the management framework
+    # to a computer. The id will be appended when used.
+    REDEPLOY_RSRC = 'v1/jamf-management-framework/redeploy'
+
+    # Class Methods
+    #####################################
+    module ClassMethods
+
+      # when this module is included, also extend our Class Methods
+      def self.extended(extender)
+        Jamf.load_msg "--> #{extender} is extending #{self}"
+      end
+
+      # Redeploy the Jamf Management framework to target Computers or members of ComputerGroups
+      #
+      # IMPORTANT: This only re-deploys the Jamf binary and related framework. The MDM system
+      # must be functioning. The target computer(s) will not re-install the framework if they
+      # never recieve the MDM command.
+      #
+      # @param target_ids [String, Integer, Array<String, Integer>] Jamf IDs for the 
+      #   Computer or ComputerGroup targets.
+      #
+      # @param cnx [Jamf::Connection] The API connection to use. Defaults to Jamf.cnx 
+      #
+      # @return [Hash{Integer => String}] The result for each computer, either the 
+      #   uuid of the sent MDM command, or an error message.
+      ########################
+      def redeploy_mgmt_framework(target_ids, cnx: Jamf.cnx)
+        target_ids = target_ids.is_a?(Array) ? target_ids : [target_ids]
+        target_comp_ids = 
+          if self == Jamf::Computer 
+            target_ids
+            
+          elsif self == Jamf::ComputerGroup
+            group_ids = target_ids.is_a?(Array) ? target_ids : [target_ids]
+            comp_ids = []
+            group_ids.each { |gid| comp_ids += JSS::ComputerGroup.fetch(id: gid).member_ids }
+            comp_ids
+
+          else
+            raise Jamf::UnsupportedError, 'This method is only available for Jamf::Computer and Jamf::ComputerGroup' 
+          end
+
+        results = {}
+
+        target_comp_ids.uniq.compact.each do |comp_id|
+          result = cnx.jp_post "#{REDEPLOY_RSRC}/#{comp_id}", Jamf::BLANK
+
+          result = Jamf::OAPISchemas::RedeployJamfManagementFrameworkResponse.new result
+          results[comp_id] = result.commandUuid
+        rescue Jamf::Connection::JamfProAPIError => e
+          results[comp_id] = "ERROR: #{e}"          
+        end
+
+        results
+      end
+
+    end # module ClassMethods
+
+    # Instance Methods
+    ######################################
+
+    # Send a managed update command to an instance of Computer or ComputerGroup.
+    # This just calls the class method of the same name.
+    #
+    # @see MacOSRedeployMgmtFramework.redeploy_mgmt_framework
+    #
+    def redeploy_mgmt_framework
+      self.class.redeploy_mgmt_framework @id, cnx: @cnx
+    end
+
+  end # module MacOSRedeployMgmtFramework
+
+end # module Jamf

data/lib/jamf/configuration.rb

@@ -79,6 +79,7 @@ module Jamf
   ###   {APIConnection#connect}, or by custom means.
   ###
   class Configuration
+
     include Singleton
 
     #####################################
@@ -89,31 +90,31 @@ module Jamf
     ### The first matching file is used - the array provides
     ### backward compatibility with earlier versions.
     ### Saving will always happen to the first filename
-    CONF_FILES = [ "ruby-jss.conf", "jss_gem.conf"]
+    CONF_FILES = ['ruby-jss.conf', 'jss_gem.conf']
 
     ### The Pathname to the machine-wide preferences plist
-    GLOBAL_CONFS =  CONF_FILES.map{|cf| Pathname.new "/etc/#{cf}"}
+    GLOBAL_CONFS = CONF_FILES.map { |cf| Pathname.new "/etc/#{cf}" }
 
     ### The Pathname to the user-specific preferences plist
-    USER_CONFS =  CONF_FILES.map{|cf| ENV["HOME"] ? Pathname.new("~/.#{cf}").expand_path : nil }.compact
+    USER_CONFS = CONF_FILES.map { |cf| ENV['HOME'] ? Pathname.new("~/.#{cf}").expand_path : nil }.compact
 
     ### The attribute keys we maintain, and the type they should be stored as
     CONF_KEYS = {
-      :api_server_name => :to_s,
-      :api_server_port => :to_i,
-      :api_ssl_version => :to_s,
-      :api_verify_cert => :jss_to_bool,
-      :api_username => :to_s,
-      :api_timeout_open => :to_i,
-      :api_timeout => :to_i,
-      :db_server_name => :to_s,
-      :db_server_port => :to_i,
-      :db_server_socket => :to_s,
-      :db_username => :to_s,
-      :db_name => :to_s,
-      :db_connect_timeout => :to_i,
-      :db_read_timeout => :to_i,
-      :db_write_timeout => :to_i
+      api_server_name: :to_s,
+      api_server_port: :to_i,
+      api_ssl_version: :to_s,
+      api_verify_cert: :jss_to_bool,
+      api_username: :to_s,
+      api_timeout_open: :to_i,
+      api_timeout: :to_i,
+      db_server_name: :to_s,
+      db_server_port: :to_i,
+      db_server_socket: :to_s,
+      db_username: :to_s,
+      db_name: :to_s,
+      db_connect_timeout: :to_i,
+      db_read_timeout: :to_i,
+      db_write_timeout: :to_i
     }
 
     #####################################
@@ -129,8 +130,7 @@ module Jamf
     #####################################
 
     # automatically create accessors for all the CONF_KEYS
-    CONF_KEYS.keys.each {|k| attr_accessor k}
-
+    CONF_KEYS.keys.each { |k| attr_accessor k }
 
     #####################################
     ### Constructor
@@ -140,10 +140,8 @@ module Jamf
     ### Initialize!
     ###
     def initialize
-
       read_global
       read_user
-
     end
 
     #####################################
@@ -156,7 +154,7 @@ module Jamf
     ### @return [void]
     ###
     def clear_all
-      CONF_KEYS.keys.each {|k| self.send "#{k}=".to_sym, nil}
+      CONF_KEYS.keys.each { |k| send "#{k}=".to_sym, nil }
     end
 
     ###
@@ -165,12 +163,12 @@ module Jamf
     ### @return [void]
     ###
     def read_global
-      GLOBAL_CONFS.each { |gcf|
+      GLOBAL_CONFS.each do |gcf|
         if gcf.file? and gcf.readable?
           read gcf
           return
         end
-      }
+      end
     end
 
     ###
@@ -179,15 +177,14 @@ module Jamf
     ### @return [void]
     ###
     def read_user
-      USER_CONFS.each { |ucf|
+      USER_CONFS.each do |ucf|
         if ucf.file? and ucf.readable?
           read ucf
           return
         end
-      }
+      end
     end
 
-
     ###
     ### Clear the settings and reload the prefs files, or another file if provided
     ###
@@ -203,10 +200,9 @@ module Jamf
       end
       read_global
       read_user
-      return true
+      true
     end
 
-
     ###
     ### Save the prefs into a file
     ###
@@ -216,10 +212,10 @@ module Jamf
     ###
     def save(file)
       path = case file
-        when :global then GLOBAL_CONFS.first
-        when :user then USER_CONFS.first
-        else Pathname.new(file)
-      end
+             when :global then GLOBAL_CONFS.first
+             when :user then USER_CONFS.first
+             else Pathname.new(file)
+             end
 
       raise Jamf::MissingDataError, "No HOME environment variable, can't write to user conf file." if path.nil?
 
@@ -229,21 +225,20 @@ module Jamf
 
         # go thru the known attributes/keys
         CONF_KEYS.keys.sort.each do |k|
-
           # if the key exists, update it.
           if data =~ /^#{k}:/
-            data.sub!(/^#{k}:.*$/, "#{k}: #{self.send k}")
+            data.sub!(/^#{k}:.*$/, "#{k}: #{send k}")
 
           # if not, add it to the end unless it's nil
           else
-            data += "\n#{k}: #{self.send k}" unless self.send(k).nil?
+            data += "\n#{k}: #{send k}" unless send(k).nil?
           end # if data =~ /^#{k}:/
-        end #each do |k|
+        end # each do |k|
 
       else # not readable, make a new file
-        data = ""
+        data = ''
         CONF_KEYS.keys.sort.each do |k|
-          data << "#{k}: #{self.send k}\n" unless self.send(k).nil?
+          data << "#{k}: #{send k}\n" unless send(k).nil?
         end
       end # if path readable
 
@@ -252,14 +247,13 @@ module Jamf
       path.jss_save data
     end # read file
 
-
     ###
     ### Print out the current settings to stdout
     ###
     ### @return [void]
     ###
     def print
-      CONF_KEYS.keys.sort.each{|k| puts "#{k}: #{self.send k}"}
+      CONF_KEYS.keys.sort.each { |k| puts "#{k}: #{send k}" }
     end
 
     #####################################
@@ -275,28 +269,29 @@ module Jamf
     ### @return [void]
     ###
     def read(file)
-
       Pathname.new(file).read.each_line do |line|
-          # skip blank lines and those starting with #
-          next if line =~ /^\s*(#|$)/
-
-          line.strip =~ /^(\w+?):\s*(\S.*)$/
-          next unless $1
-          attr = $1.to_sym
-          setter = "#{attr}=".to_sym
-          value = $2.strip
-
-          if CONF_KEYS.keys.include? attr
-            if value
-              # convert the value to the correct class
-              value = value.send(CONF_KEYS[attr])
-            end
-            self.send(setter, value)
-          end  # if
-        end # do line
+        # skip blank lines and those starting with #
+        next if line =~ /^\s*(#|$)/
+
+        line.strip =~ /^(\w+?):\s*(\S.*)$/
+        next unless Regexp.last_match(1)
 
+        attr = Regexp.last_match(1).to_sym
+        setter = "#{attr}=".to_sym
+        value = Regexp.last_match(2).strip
+
+        next unless CONF_KEYS.keys.include? attr
+
+        if value
+          # convert the value to the correct class
+          value = value.send(CONF_KEYS[attr])
+        end
+        send(setter, value)
+        # if
+      end # do line
     end # read file
 
   end # class Preferences
 
+
 end # module

data/lib/jamf/deprecations.rb

@@ -0,0 +1,28 @@
+### Copyright 2022 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.
+###
+###
+
+require 'jamf/deprecations/deprecated_api_connection_class'
+require 'jamf/deprecations/deprecated_api_constant'
+require 'jamf/deprecations/deprecated_config_constant'

data/lib/jamf/version.rb

@@ -27,6 +27,6 @@
 module Jamf
 
   ### The version of ruby-jss
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.1.0b5'.freeze
 
 end # module

data/lib/jamf/zeitwerk_config.rb

@@ -89,8 +89,6 @@ module JamfZeitwerkConfig
     loader.collapse("#{__dir__}/api/jamf_pro/base_classes")
     loader.collapse("#{__dir__}/api/jamf_pro/other_classes")
 
-    loader.collapse("#{__dir__}/deprecations")
-
     ##### Inflected Paths
     
     # filenames => Constants, which don't adhere to zeitwerk's parsing standards.
@@ -130,6 +128,7 @@ module JamfZeitwerkConfig
     loader.inflector.inflect 'md_prestage_names' => 'MobileDevicePrestageNames'
     loader.inflector.inflect 'md_prestage_skip_setup_items' => 'MobileDevicePrestageSkipSetupItems'
     loader.inflector.inflect 'macos_managed_updates' => 'MacOSManagedUpdates'
+    loader.inflector.inflect 'macos_redeploy_mgmt_framework' => 'MacOSRedeployMgmtFramework'
 
     # deprecations, separated so they load only when used.
     # When its time to get rid of them, delete the files from the 
@@ -147,6 +146,8 @@ module JamfZeitwerkConfig
     loader.ignore "#{__dir__}/ruby_extensions.rb"
     loader.ignore "#{__dir__}/ruby_extensions"
     loader.ignore "#{__dir__}/exceptions.rb"
+    loader.ignore "#{__dir__}/deprecations"
+    loader.ignore "#{__dir__}/deprecations.rb"
 
     lib_dir = Pathname.new(__dir__).parent.to_s
     loader.ignore "#{lib_dir}/ruby-jss.rb" 

data/lib/jamf.rb

@@ -89,3 +89,7 @@ JSS = Jamf
 
 # testing zeitwerk loading, the the desired file is present
 JamfZeitwerkConfig.eager_load_for_testing 
+
+# Load more non-autoloaded stuff, but this stuff needs 
+# to happen after zeitwerk loading is active.
+require 'jamf/deprecations'