ruby-jss 2.0.0rc1 → 2.1.0b4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89974abcf43374bb65bbb1e0e91a2c147b0a28e7143f8f5e995c372c7ecdef7d
-  data.tar.gz: 720708403ca790ca523b11cedffa5c4c218f67720bc0ef3cce57f97ef9ce7490
+  metadata.gz: 5a00af3813560fa65f8597fc6a516d1b9933eb333f2aee3478646df1f93a45b9
+  data.tar.gz: 892e4f5ed6b7271c55377671ff13ccb7778a51b34d57b9da67086cd95ec7d0ca
 SHA512:
-  metadata.gz: b0e93ad88ec4cf67ae0200d5bd57b57b2a56ccd5eac63a4ee6d44a6ec6f8d750d35f6f8a73166c6be23fe1ad2ae749ba2edeada06cce2679dac5eee6636b591e
-  data.tar.gz: 5f7cc9072b0b180fb2f066b4caf89869e59b426dba275f2ee7431b9db99aa236b00ac799eb4ba6e1aa08a1a64c053cd5c754342c2b24805ba4323070fd641c95
+  metadata.gz: 6461d576566cfd365c77ff36758a8c9558deb2bad8936b87be03f12dd3c7f7662734ec2eaaa7f1f4b5b83c9bb0264c9e06609c2f8f0ef20106d3c8db8be45484
+  data.tar.gz: 30a9a4dcf60a9aa0a25c4a64429e34f1f8cf6cf9609f80c94b675c0e498f74f46f3fc0842fab2d20ed248f0a792c2349a7373a273905ec45c3994b3b6f4fc3eb

data/CHANGES.md

@@ -4,30 +4,49 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## **IMPORTANT: Known Security Issue in v1.5.3 and below**
+## _IMPORTANT_: Known Security Issue in v1.5.3 and below
 
-Versions of ruby-jss prior to 1.6.0 contain a known security issue due to the use of the 'plist' gem.
+Versions of ruby-jss prior to 1.6.0 contain a known security issue due to how we were using the 'plist' gem.
 
 This has been resolved in 1.6.0, which now uses the CFProperlyList gem.
 
-Please update all installations of ruby-jss to at least v1.6.0.
+__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.
 
-## \[2.0.0] - Unreleased
+## \[2.1.0] - unreleased
+
+### Added
+
+  - Support for the `/v1/jamf-management-framework/redeploy/{id}` Jamf Pro API endpoint in `Jamf::Computer` and 
+  `Jamf::ComputerGroup`. The method `redeploy_mgmt_framework` is both a Class and an Instance method for those classes
+    - The instance method sends the redeployment to the single computer or all the members of the single computer group.
+    - The class method accepts a single id, or an array of ids.  
+      - When using `Jamf::Computer.redeploy_mgmt_framework` provide computer ids
+      - When using `Jamf::ComputerGroup.redeploy_mgmt_framework` provide group ids, and all members of all groups will get
+        the redeployment
+  - In all cases the result is a Hash of target computer ids (keys) and result value for each (Strings).
+    -  The result is either the UUID of the sent MDM command, or an error message if the MDM command couldn't be sent.
+  - All the code is in the `Jamf::MacOSRedeployMgmtFramework` module, q.v. in the [rubydoc documentation](https://www.rubydoc.info/gems/ruby-jss/Jamf/MacOSRedeployMgmtFramework)
+
+### Fixed
+
+  - A few internal rescues of a deprecated exception class
+  - Removed auto-loading of deprecation files; now explicitly loaded.
+
+## \[2.0.0] - 2022-09-12
 
 Version 2.0.0 is a major refactoring of ruby-jss. While attempting to provide as much backward compatibility as possible, there are some significant changes and v2.0.0 is not fully backward compatible. **PLEASE TEST YOUR CODE EXTENSIVELY**
 
-Here are the high-level changes and there are many many others. For more details, see [CHANGES-2.0.0](CHANGES-2.0.0.md)
+Here are the high-level changes and there are many many others. For more details, see [CHANGES-2.0.0.md](CHANGES-2.0.0.md)
 
-- Combined access to both APIs.
-  - The Classic and Jamf Pro APIs are no longer separated into the JSS and Jamf modules. There is only the `Jamf` module, and `JSS` is merely an alias of it, so all your code refering to the JSS module should still work.
-- Auto-generated classes for the Jamf Pro API
-  - Base classes for JamfPro API objects are automatically generated from the OAPI3 Schema available at https://your.jamf.server/api/schema. This make it much simpler for ruby-jss to implement and update new and changed objects and endpoints in the Jamf Pro API.
-- Code is auto-loaded from disk
-  - Because the auto-generated classes add hundreds of files to the gem, ruby-jss now uses [Zeitwerk](https://github.com/fxn/zeitwerk) to auto-load only the files it needs when they are needed.
 - Support for Ruby 3.x
-
+  - tested in 3.0 and 3.1
+- Combined access to both the Classic and Jamf Pro APIs
+  - A single namespace module
+  - Connection objects talk to both APIs & automatically handle details like bearer tokens
+- Auto-generated code for Jamf Pro API objects
+- Autoloading of code using [Zeitwerk](https://github.com/fxn/zeitwerk)
 
 ## \[1.6.7] - 2022-02-22
 

data/README-2.0.0.md

@@ -31,6 +31,7 @@ These changes have been in mind for some time, but the requirement in late 2022
   - [No Attribute aliases for Jamf Pro API objects](#no-attribute-aliases-for-jamf-pro-api-objects)
   - [Class/Mixin hierarchy for Jamf Pro API objects](#classmixin-hierarchy-for-jamf-pro-api-objects)
   - [Support for 'Sticky Sessions' in Jamf Cloud](#support-for-sticky-sessions-in-jamf-cloud)
+  - [The valid_id method for Classic API collection classes](#the-valid_id-method-for-classic-api-collection-classes)
 - [Planned deprecations](#planned-deprecations)
   - [Use of the term 'api'](#use-of-the-term-api)
   - [.map_all_ids_to method for Classic API collection classes](#map_all_ids_to-method-for-classic-api-collection-classes)
@@ -156,6 +157,9 @@ So far we've only uncovered a few areas where our ruby-jss 1.x code didn't work
 - Subclassing ruby-jss classes in your own code.
   - Those classes, and methods called on them, may need to be updated to match the new ruby-jss classes, in order to maintain _their_ backward compatibility.
 
+- If you make calls to Classic API's `.valid_id` class method for collection classes, and you pass in an integer as a String, e.g. '1234', expecting to get the valid id of the object with the _name_ or _serial_number_ '1234' you will now get back the id 1234 if there is an object with that id. That may not be the id of the object you were looking for.
+  - See [The valid_id method for Classic API collection classes](#the-valid_id-method-for-classic-api-collection-classes) below for details and how to do such a validation now.
+
 ## Notable changes from ruby-jss 1.x
 
 ### Paged queries to the Jamf Pro API
@@ -213,6 +217,43 @@ For details about Sticky Sessions see [Sticky Sessions for Jamf Cloud](https://d
 
 **WARNING:** Jamf recommends NOT using sticky sessions unless they are needed. Using them inappropriately may negatively impact performance, especially for large automated processes.
 
+### The `valid_id` method for Classic API collection classes 
+
+In the Classic API, object ids are Integers, but in the Jamf Pro API, they are Strings containing integers. 
+
+In previous versions of ruby-jss, the `valid_id` class method for the Jamf Pro API will accept Integers and convert them to Strings to search for the valid id. In order to provide the same flexibility, `valid_id` now works the same way for regardless of which API is used.
+
+Previously, the Classic API collection classes would return nil (no match) if you passed in an id as a string, unless you had an object with a name or other identifier with that numeric string value.
+
+So for example, assuming you wanted to find out if the id 1234 was valid, you could do
+
+```ruby
+ok_id = JSS::Computer.valid_id 1234
+# =>  1234, or nil if 1234 is not a valid id
+```
+
+But if you did
+
+```ruby
+ok_id = JSS::Computer.valid_id '1234'
+# => nil, or the id of a computer _named_ '1234'
+# (no computer would have '1234' as a serialnumber, udid, or macaddress)
+```
+you would likely not get the integer id 1234 back.
+
+In ruby-jss 2.0.0, the valid_id method has changed so that the second example above will return the integer id 1234, if it exists as an id. If not, it will look at other identifiers with the string value, and return the id of any match, or nil if there's no match.
+
+The downside of this is: what if you really _are_ looking for the id of the object with the name '1234'? 
+
+To deal with that situation, the valid_id method for the Classic API now behaves like the one for the Jamf Pro API: it can accept an arbitrary key: value pair, limiting the search to the indentifier used as the key.  
+
+So you can use this to get what you're looking for
+
+```ruby
+ok_id = JSS::Computer.valid_id name: '1234'
+# => nil, or the id of a computer named '1234'
+```
+
 ## Planned deprecations
 
 Even though it was publically released in 2014, ruby-jss's origins are from 2009, so it's been around for a while. We've learned a lot since then, and lots of the old lingering code is terribly out of date.

data/README.md

@@ -3,8 +3,10 @@
 
 ## Version 2.0.0 has been released
 
-Version 2.0.0 has major changes! While we've strived for backward compatibility, and have done lots of testing, YMMV.  Please report any issues.
+Version 2.0.0 has major changes! While we've strived for _mostly_ being backward compatible, and have done lots of testing, YMMV.  Please report any issues.
 
+_NOTE_: ruby-jss 2.0 is not completely backward compatible, please see  [README-2.0.0.md](README-2.0.0.md) for more info
+ 
 ### Highlights
 
 - Support for Ruby 3.x

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

@@ -159,6 +159,7 @@ module Jamf
     include Jamf::MDM
     include Jamf::ManagementHistory
     include Jamf::MacOSManagedUpdates
+    include Jamf::MacOSRedeployMgmtFramework
 
     extend Jamf::Matchable
 

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/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.0rc1'.freeze
+  VERSION = '2.1.0b4'.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'

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: ruby-jss
 version: !ruby/object:Gem::Version
-  version: 2.0.0rc1
+  version: 2.1.0b4
 platform: ruby
 authors:
 - Chris Lasell
 - Aurica Hayes
 - Kristoffer Landes
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-07 00:00:00.000000000 Z
+date: 2022-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: CFPropertyList
@@ -290,6 +290,7 @@ files:
 - lib/jamf/api/jamf_pro/mixins/jpapi_resource.rb
 - lib/jamf/api/jamf_pro/mixins/lockable.rb
 - lib/jamf/api/jamf_pro/mixins/macos_managed_updates.rb
+- lib/jamf/api/jamf_pro/mixins/macos_redeploy_mgmt_framework.rb
 - lib/jamf/api/jamf_pro/mixins/prestage.rb
 - lib/jamf/api/jamf_pro/mixins/sortable.rb
 - lib/jamf/api/jamf_pro/mixins/uncreatable.rb
@@ -747,6 +748,7 @@ files:
 - lib/jamf/configuration.rb
 - lib/jamf/constants.rb
 - lib/jamf/db_connection.rb
+- lib/jamf/deprecations.rb
 - lib/jamf/deprecations/deprecated_api_connection_class.rb
 - lib/jamf/deprecations/deprecated_api_constant.rb
 - lib/jamf/deprecations/deprecated_config_constant.rb
@@ -806,7 +808,7 @@ homepage: http://pixaranimationstudios.github.io/ruby-jss/
 licenses:
 - Nonstandard
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options:
 - "--title"
 - JSS
@@ -826,8 +828,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: A Ruby interface to the Jamf Pro REST APIs
 test_files: []