ruby-jss 3.0.0 → 3.1.0b1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed31b6de65dd9f753522997db8bee3030036d7b7f3064c9a1586ecda06c2e593
-  data.tar.gz: 7c6e77eb322d52934729b7f5a26283a46921f0b52c8f6046d8bee57f0dd8cc5b
+  metadata.gz: 4bce47ef4c036e883a7b41d44220f6405bec40d1c3ea20f141d4923ce29dc837
+  data.tar.gz: c14adc7dc8fd8b08c31c5cbe0257b667dcb18003b30754675da0c68edf268893
 SHA512:
-  metadata.gz: 82fbcfb1a88e333ed07d04e37878ec3f9c4fa9c5aa6705a5860285222e52d9b9adeb5ad329520868ce223e68338eac576888eb387774abe4b066804ee9c5b921
-  data.tar.gz: 65095fd093104fd752a9c4294ff1cd0e41e570f9b928a1c8497cada0c56b2990a87f432f84f6a4332d400e3ac90cbd4852776d0ba9e9a85198580816e5dac731
+  metadata.gz: f8ea25d3586028883d908e6d7718b5ce8b5146d0412871c02d40f742c9bb86d7cb047c24a3a9e2e41cc3b011439fb901d7e657f4f1cf9193394d3d9ae8e75f02
+  data.tar.gz: fd6edb4cbf4941c67961c2da6863bdf37b0185f4b7512acf9c4783e8c2994e82f1f0eb8c1036227206f087c324d8695f22b869b151498956a84baa6d82a4623c

data/CHANGES.md

@@ -15,6 +15,25 @@ __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.
 
 --------
+## \[3.1.0] 2023-06-05
+
+### Added
+  - Jamf::Computer.filevault_info and Jamf::Computer#filevault_info can retrieve FileVault info from v1/computer-inventory/filevault and related endpoints
+  - Jamf::Computer.recovery_lock_password and Jamf::Computer#recovery_lock_password can retrieve stored recovery lock passwords
+  - There are now several ways to set scopes to all targets.
+    - The original #include_all has been renamed #set_all_targets, and #include_all is an alias to it
+    - The symbol :all can be passed to the #set_targets, and #add_target methods as they 'key' parameter, and they will just call #set_all_targets
+    - There is now a setter #all_targets=(bool) which calls #set_all_targets, or sets @all_targets to false
+
+### Fixed
+  - Fixed a bug in Jamf::Pager#initialize when constructing the query-path of the paged resource URL
+  - Fixed a bug in Jamf::Pager#initialize: The instantiate: parameter takes a class, not a boolean
+  - Fixed a bug in Jamf::CollectionResource.pager: The instantiate: parameter takes a boolean, but must pass a class to Jamf::Pager#initialize
+  - Jamf::OAPIObject base-class: can now instantiate objects that hold a single value
+
+### Changed
+  - Auto-generated OAPISchemas have been refreshed from Jamf Pro 10.46.0
+
 
 ## \[3.0.0] - 2023-05-22
 Major version bump because changes to policy log flushing are not backward compatible.

data/README.md

@@ -486,6 +486,6 @@ If you have questions or feedback about ruby-jss, please reach out  to us via:
 
 ## LICENSE
 
-Copyright 2022 Pixar
+Copyright 2023 Pixar
 
 Licensed under a modified Apache License, Version 2.0. See LICENSE.txt for details

data/bin/cgrouper

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-### Copyright 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/bin/jamfHelperBackgrounder

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-### Copyright 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/bin/netseg-update

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-### Copyright 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/data/ruby-jss.conf.example

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

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

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

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

@@ -1,4 +1,4 @@
-### Copyright 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -26,19 +26,15 @@
 ###
 module Jamf
 
-
   # Module Variables
   #####################################
 
-
   # Module Methods
   #####################################
 
-
   # Classes
   #####################################
 
-
   # An AdvancedComputerSearch in the JSS
   #
   # @see Jamf::AdvancedSearch
@@ -47,11 +43,9 @@ module Jamf
   #
   class AdvancedComputerSearch < Jamf::AdvancedSearch
 
-
     # Mix-Ins
     #####################################
 
-
     # Class Constants
     #####################################
 
@@ -70,7 +64,7 @@ module Jamf
 
     # what data fields come back along with the display fields
     # for each computer?
-    RESULT_ID_FIELDS = [:id, :name, :udid].freeze
+    RESULT_ID_FIELDS = %i[id name udid].freeze
 
     # the object type for this object in
     # the object history table.
@@ -80,15 +74,12 @@ module Jamf
     # Attributes
     #####################################
 
-
     # Constructor
     #####################################
 
-
     # Public Instance Methods
     #####################################
 
-
     # Private Instance Methods
     #####################################
 

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

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

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

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

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

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

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

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

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

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

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

@@ -1,4 +1,4 @@
-### Copyright 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -160,6 +160,8 @@ module Jamf
     include Jamf::ManagementHistory
     include Jamf::MacOSManagedUpdates
     include Jamf::MacOSRedeployMgmtFramework
+    include Jamf::FileVault
+    include Jamf::ComputerRecoveryLock
 
     extend Jamf::Matchable
 
@@ -265,6 +267,12 @@ module Jamf
 
     COMPUTER_APPLICATIONS_RSRC = 'computerapplications/application'.freeze
 
+    # The base resource for computer data in the JPAPI
+    JPAPI_INVENTORY_RSRC = 'v1/computers-inventory'
+
+    # The resource for getting all inventory data for a computer at once
+    JPAPI_INVENTORY_DETAIL_RSRC = 'v1/computers-inventory-detail'
+
     # the object type for this object in
     # the object history table.
     # See {APIObject#add_object_history_entry}

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

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

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

@@ -1,45 +1,45 @@
-# Copyright 2022 Pixar
+# Copyright 2023 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
 
   # Classes
   #####################################
 
-  
+
   # 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
     #####################################
     include Jamf::MDM
@@ -79,20 +79,20 @@ module Jamf
     # Public Instance Methods
     #####################################
 
-    # 
+    #
     # 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] }
     end
 
-    # 
+    #
     # 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] }
     end

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

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

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

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

data/lib/jamf/api/classic/api_objects/criteriable/criteria.rb

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

data/lib/jamf/api/classic/api_objects/criteriable/criterion.rb

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

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

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

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

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

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

@@ -1,4 +1,4 @@
-# Copyright 2022 Pixar
+# Copyright 2023 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/classic/api_objects/ebook.rb

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

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

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

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

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

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

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

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

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

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

@@ -1,4 +1,4 @@
-### Copyright 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -70,7 +70,6 @@ module Jamf
     ###  Variables
     #####################################
 
-
     #####################################
     ###  Attribtues
     #####################################
@@ -104,7 +103,6 @@ module Jamf
     ### @return [String]
     attr_reader :username
 
-
     #####################################
     ###  Mixed-in Instance Methods
     #####################################
@@ -129,7 +127,6 @@ module Jamf
       @username = @init_data[:location][:username]
     end
 
-
     ###
     ### All the location data in a Hash, as it comes from the API.
     ###
@@ -139,85 +136,101 @@ module Jamf
     ###
     def location
       {
-        :building => @building,
-        :department => @department,
-        :email_address => @email_address,
-        :phone => @phone,
-        :position => @position,
-        :real_name => @real_name,
-        :room => @room,
-        :username => @username
+        building: @building,
+        department: @department,
+        email_address: @email_address,
+        phone: @phone,
+        position: @position,
+        real_name: @real_name,
+        room: @room,
+        username: @username
       }
     end
 
-
     ###
     ###
     ### Setters
     ###
 
     ###
-    def building= (new_val)
+    def building=(new_val)
       return nil if @building == new_val
+
       new_val = new_val.to_s.strip
-      raise Jamf::NoSuchItemError, "No building named #{new_val} exists in the JSS" unless new_val.empty? or Jamf::Building.all_names(cnx: @cnx).include? new_val
+      unless new_val.empty? or Jamf::Building.all_names(cnx: @cnx).include? new_val
+        raise Jamf::NoSuchItemError, 
+              "No building named #{new_val} exists in the JSS"
+      end
+
       @building = new_val
       @need_to_update = true
     end
 
     ###
-    def department= (new_val)
+    def department=(new_val)
       return nil if @department == new_val
+
       new_val = new_val.to_s.strip
-      raise Jamf::NoSuchItemError, "No department named #{new_val} exists in the JSS" unless new_val.empty? or Jamf::Department.all_names(cnx: @cnx).include? new_val
+      unless new_val.empty? or Jamf::Department.all_names(cnx: @cnx).include? new_val
+        raise Jamf::NoSuchItemError, 
+              "No department named #{new_val} exists in the JSS"
+      end
+
       @department = new_val
       @need_to_update = true
     end
 
     ###
-    def email_address= (new_val)
+    def email_address=(new_val)
       return nil if @email_address == new_val
+
       new_val = new_val.to_s.strip
-      raise Jamf::InvalidDataError, "Invalid Email Address" unless new_val.empty? or  new_val =~ /^[^\s@]+@[^\s@]+$/
+      raise Jamf::InvalidDataError, 'Invalid Email Address' unless new_val.empty? or new_val =~ /^[^\s@]+@[^\s@]+$/
+
       @email_address = new_val
       @need_to_update = true
     end
 
     ###
-    def position= (new_val)
+    def position=(new_val)
       return nil if @position == new_val
+
       new_val = new_val.to_s.strip
       @position = new_val
       @need_to_update = true
     end
 
     ###
-    def phone= (new_val)
+    def phone=(new_val)
       return nil if @phone == new_val
+
       new_val = new_val.to_s.strip
       @phone = new_val
       @need_to_update = true
     end
 
     ###
-    def real_name= (new_val)
+    def real_name=(new_val)
       return nil if @real_name == new_val
+
       new_val = new_val.to_s.strip
       @real_name = new_val
       @need_to_update = true
     end
 
     ###
-    def room= (new_val)
+    def room=(new_val)
       return nil if @room == new_val
+
       new_val = new_val.to_s.strip
       @room = new_val
       @need_to_update = true
     end
 
     ###
-    def username= (new_val)
+    def username=(new_val)
       return nil if @username == new_val
+
       new_val = new_val.to_s.strip
       @username = new_val
       @need_to_update = true
@@ -228,13 +241,13 @@ module Jamf
     ###
     def has_location?
       @username or \
-      @real_name or \
-      @email_address or \
-      @position or \
-      @phone or \
-      @department or \
-      @building or \
-      @room
+        @real_name or \
+        @email_address or \
+        @position or \
+        @phone or \
+        @department or \
+        @building or \
+        @room
     end
 
     ###
@@ -248,17 +261,15 @@ module Jamf
       @email_address = ''
       @position = ''
       @phone = ''
-      @department  = ''
+      @department = ''
       @building = ''
       @room = ''
       @need_to_update = true
     end
 
-
     ### aliases
     alias user username
 
-
     ###
     ### @api private
     ###
@@ -278,7 +289,7 @@ module Jamf
       location.add_element('real_name').text = @real_name
       location.add_element('room').text = @room
       location.add_element('username').text = @username
-      return location
+      location
     end
 
   end # module Locatable

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

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

data/lib/jamf/api/classic/api_objects/management_history/audit_event.rb

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

data/lib/jamf/api/classic/api_objects/management_history/casper_imaging_log.rb

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

data/lib/jamf/api/classic/api_objects/management_history/casper_remote_log.rb

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

data/lib/jamf/api/classic/api_objects/management_history/computer_usage_log.rb

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

data/lib/jamf/api/classic/api_objects/management_history/ebook.rb

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

data/lib/jamf/api/classic/api_objects/management_history/hash_like.rb

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

data/lib/jamf/api/classic/api_objects/management_history/mac_app_store_app.rb

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

data/lib/jamf/api/classic/api_objects/management_history/mdm_command.rb

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