RubyGems - ruby-jss - Versions diffs - 3.0.0b1 → 3.1.0b1 - Mend

ruby-jss 3.0.0b1 → 3.1.0b1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (685) hide show

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

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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/mobile_device_app.rb CHANGED Viewed

@@ -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/policy_log.rb CHANGED Viewed

@@ -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/screen_sharing_log.rb CHANGED Viewed

@@ -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/user_location_change.rb CHANGED Viewed

@@ -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.rb CHANGED Viewed

@@ -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/matchable.rb CHANGED Viewed

@@ -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/mdm.rb CHANGED Viewed

@@ -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/mobile_device.rb CHANGED Viewed

@@ -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/mobile_device_application.rb CHANGED Viewed

@@ -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/mobile_device_configuration_profile.rb CHANGED Viewed

@@ -1,4 +1,4 @@
-### Copyright 2022 Pixar
+### Copyright 2023 Pixar
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -24,13 +24,10 @@
 # This is just a stub for now.
-#
 module Jamf
-  #
   class MobileDeviceConfigurationProfile < Jamf::ConfigurationProfile
     ### The base for REST resources of this class
     RSRC_BASE = 'mobiledeviceconfigurationprofiles'.freeze
@@ -76,9 +73,10 @@ module Jamf
     def redeploy_days_before_certificate_expires=(new_val)
       return nil if redeploy_days_before_certificate_expires == new_val
       raise Jamf::InvalidDataError, 'New value must be an integer >= 0' unless new_val.is_a?(Integer) && new_val >= 0
       @redeploy_days_before_certificate_expires = new_val
       @need_to_update = true
-    end #
+    end
     # Private Instance Methods
     ###################################

data/lib/jamf/api/classic/api_objects/mobile_device_extension_attribute.rb CHANGED Viewed

@@ -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/mobile_device_group.rb CHANGED Viewed

@@ -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/netboot_server.rb CHANGED Viewed

@@ -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/network_segment.rb CHANGED Viewed

@@ -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/osx_configuration_profile.rb CHANGED Viewed

@@ -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/package.rb CHANGED Viewed

@@ -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/patch_external_source.rb CHANGED Viewed

@@ -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/patch_internal_source.rb CHANGED Viewed

@@ -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/patch_policy.rb CHANGED Viewed

@@ -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/patch_title/version.rb CHANGED Viewed

@@ -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/patch_title.rb CHANGED Viewed

@@ -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/peripheral.rb CHANGED Viewed

@@ -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/peripheral_type.rb CHANGED Viewed

@@ -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/policy.rb CHANGED Viewed

@@ -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/purchasable.rb CHANGED Viewed

@@ -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/removable_macaddr.rb CHANGED Viewed

@@ -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/restricted_software.rb CHANGED Viewed

@@ -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/scopable/scope.rb CHANGED Viewed

@@ -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
@@ -397,7 +397,7 @@ module Jamf
       #
       # @return [void]
       #
-      def include_all(clear = false)
+      def set_all_targets(clear = false)
         @targets = {}
         @target_keys.each { |k| @targets[k] = [] }
         @all_targets = true
@@ -410,6 +410,7 @@ module Jamf
         end
         @container&.should_update
       end
+      alias include_all set_all_targets
       # Replace a list of item names for as targets in this scope.
       #
@@ -419,7 +420,8 @@ module Jamf
       # if the item doesn't exist.
       #
       # @param key[Symbol] the key from #{SCOPING_CLASSES} for the kind of items
-      # being included, :computer, :building, etc...
+      # being included, :computer, :building, etc... Use :all to scope to all targets
+      # (the same as calling #set_all_targets)
       #
       # @param list[Array]  identifiers of the items being added
       #
@@ -429,6 +431,11 @@ module Jamf
       # @return [void]
       #
       def set_targets(key, list)
+        if key == :all
+          set_all_targets
+          return
+        end
         key = pluralize_key(key)
         raise Jamf::InvalidDataError, "List must be an Array of #{key} identifiers, it may be empty." unless list.is_a? Array
@@ -454,12 +461,28 @@ module Jamf
       alias set_inclusion set_targets
       alias set_inclusions set_targets
+      # to match the all_targets and all_targets? methods
+      # Just calls #set_all_targets
+      #
+      # @param bool [Boolean] shou\d this scope include all targets?
+      #
+      # @return [void]
+      def all_targets=(bool)
+        if Jamf::Validate.boolean bool
+          set_all_targets
+        else
+          @all_targets = false
+          @container&.should_update
+        end
+      end
       # Add a single item as a target in this scope.
       #
       # The item name will be checked for existence in the JSS, and an exception
       #  raised if the item doesn't exist.
       #
       # @param key[Symbol] the key from #{SCOPING_CLASSES} for the kind of item being added, :computer, :building, etc...
+      #   Use :all to scope to all targets (the same as calling #set_all_targets)
       #
       # @param item[String,integer] a valid identifier of the item being added
       #
@@ -472,6 +495,11 @@ module Jamf
       # @return [void]
       #
       def add_target(key, item)
+        if key == :all
+          set_all_targets
+          return
+        end
         key = pluralize_key(key)
         item_id = validate_item(:target, key, item)
         return if @targets[key]&.include?(item_id)

data/lib/jamf/api/classic/api_objects/scopable.rb CHANGED Viewed

@@ -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/script.rb CHANGED Viewed

@@ -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/self_servable.rb CHANGED Viewed

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

data/lib/jamf/api/classic/api_objects/sitable.rb CHANGED Viewed

@@ -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/site.rb CHANGED Viewed

@@ -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/software_update_server.rb CHANGED Viewed

@@ -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/updatable.rb CHANGED Viewed

@@ -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/uploadable.rb CHANGED Viewed

@@ -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/user.rb CHANGED Viewed

@@ -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/user_extension_attribute.rb CHANGED Viewed

@@ -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/user_group.rb CHANGED Viewed

@@ -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/vpp_account.rb CHANGED Viewed

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