ruby-jss 3.0.0 → 3.1.0b2

data/lib/jamf/api/jamf_pro/other_classes/pager.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
@@ -47,9 +47,14 @@ module Jamf
 
     # Return all results from a pageable list path.
     #
-    # Since the JPAPI always returns results in pages of 2000, if there are more
-    # than that many in the collection we must loop through the pages to get
-    # them all.
+    # Pageable resources are always returned in pages, usually defaulting to
+    # 100 items per page, but the max allowed page size is 2000. If there are more
+    # than 2000 items, we must loop through the pages to get them all.
+    #
+    # This method is used to get all pages of data from a giving path, automatically
+    # looping through the pages and collecting the data to be returned in a
+    # single Array. It uses a Pager object to do that, but the Pager itself
+    # is transient, only the resulting Array is returned.
     #
     # @param list_path [String] The Resource URL path that provides the paged
     #   query results
@@ -58,15 +63,16 @@ module Jamf
     #
     # @param filter [String] The optional RSQL filter parameter for the query
     #
-    # @param instantiate [Boolean] Defaults to false. Should the items in the
-    #   returned Array(s) be ruby instances of the CollectionObject subclass, or
-    #   plain Hashes of data as returned by the API?
+    # @param instantiate [Class] Instantiate the results as the given class by
+    #   passing the raw JSON data to the class' .new method. WARNING: Be sure the
+    #   data returned from the API is appropriate for instantiating this class.
     #
     # @param cnx [Jamf::Connection] The API connection to use, default: Jamf.cnx
     #
-    # @return [Type] description_of_returned_object
+    # @return [Array<Hash,Jamf::OAPIObject>] All of the pages of data, returned as one array,
+    #   optionally instantiated into a subclass of Jamf::OAPIObject.
     #
-    def self.all_pages(list_path:, sort: nil, filter: nil, instantiate: false, cnx: Jamf.cnx)
+    def self.all_pages(list_path:, sort: nil, filter: nil, instantiate: nil, cnx: Jamf.cnx)
       sort &&= Jamf::Sortable.parse_url_sort_param(sort)
       filter &&= Jamf::Filterable.parse_url_filter_param(filter)
 
@@ -106,7 +112,11 @@ module Jamf
     # @return [Integer] How many items to return per page
     attr_reader :page_size
 
-    # @return [Integer] The page which will be returned when next_page is called
+    # @return [nil, Integer] The most recent page number fetched by fetch_next_page,
+    #   or nil if it hasn't been called yet.
+    attr_reader :last_fetched_page
+
+    # @return [Integer] The page which will be returned when fetch_next_page is called
     attr_reader :next_page
 
     # @return [] The full r#source URL, with page_size, sort, and filter, but
@@ -134,8 +144,8 @@ module Jamf
     #
     # @param filter [String] The optional RSQL filter parameter for the query
     #
-    # @param instantiate [Class] Should the results be instantiated as
-    #   the given class?
+    # @param instantiate [Class] Instantiate the results as the given class by
+    #   passing the raw JSON data to the class' .new method
     #
     # @param cnx [Jamf::Connection]  The Connection object used for the query.
     #   Defaults to the Default connection
@@ -148,7 +158,7 @@ module Jamf
       @list_path = list_path
       @sort = Jamf::Sortable.parse_url_sort_param(sort)
       @filter = Jamf::Filterable.parse_url_filter_param(filter)
-      @page_size = page_size
+      @page_size ||= DEFAULT_PAGE_SIZE
       @instantiate = instantiate
 
       # start with page 0, the first page
@@ -159,7 +169,7 @@ module Jamf
       @query_path = "#{@list_path}?page-size=#{@page_size}#{@sort}#{@filter}"
 
       # get one item which will contain the total count
-      @total_count = cnx.jp_get("#{@query_path}?page-size=1&page=0#{@filter}")[:totalCount]
+      @total_count = cnx.jp_get("#{@list_path}?page-size=1&page=0#{@filter}")[:totalCount]
       # can't know total pages of filtered query
       @total_pages = @filter ? nil : (@total_count / @page_size.to_f).ceil
     end
@@ -186,7 +196,7 @@ module Jamf
     # is 0, the second is 1, and so on. Asking for page 27 will give you the
     # 28th page of results
     #
-    # If increment_next is true, then subsequent calls to #next_page will
+    # If increment_next is true, then subsequent calls to #fetch_next_page will
     # continue from whatever page number was requested.
     #
     # When increment_next is false (the default), the sequence of pages returned
@@ -215,14 +225,14 @@ module Jamf
       validate_page_number page_number
 
       data = @cnx.jp_get "#{@query_path}&page=#{page_number}"
-      data =
-        if @instantiate
-          data[:results].map { |r| @instantiate.new r }
-        else
-          data[:results]
-        end
-
-      @next_page = (page_number + 1) if increment_next
+      data = data[:results]
+      data.map! { |r| @instantiate.new r } if @instantiate
+
+      if increment_next
+        @last_fetched_page = page_number
+        @next_page = (page_number + 1)
+      end
+
       data
     end
 

data/lib/jamf/api/jamf_pro/other_classes/timestamp.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/base_class.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/client/jamf_binary.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/client/jamf_helper.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/client/management_action.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/client.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/composer.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/configuration.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/constants.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/db_connection.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/deprecations/deprecated_api_connection_class.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/deprecations/deprecated_api_constant.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/deprecations/deprecated_config_constant.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/deprecations.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/exceptions.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/oapi_validate.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/ruby_extensions/array/predicates.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/ruby_extensions/array/utils.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/ruby_extensions/array.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/ruby_extensions/filetest/predicates.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/ruby_extensions/filetest.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/ruby_extensions/hash/utils.rb

@@ -1,4 +1,4 @@
-# Copyright 2022 Pixar
+# Copyright 2023 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -22,7 +22,7 @@
 #    language governing permissions and limitations under the Apache License.
 #
 #
-# Copyright 2022 Pixar
+# Copyright 2023 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jamf/ruby_extensions/hash.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/ruby_extensions/ipaddr/utils.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/ruby_extensions/ipaddr.rb

@@ -1,4 +1,4 @@
-### Copyright 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -25,7 +25,6 @@
 
 require 'jamf/ruby_extensions/ipaddr/utils'
 
-
 ############################################
 ### A few augmentations to IPAddr handling.
 ###
@@ -33,5 +32,4 @@ class IPAddr
 
   extend JamfRubyExtensions::IPAddr::Utils
 
-
 end # Class IPAddr

data/lib/jamf/ruby_extensions/object/predicates.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/ruby_extensions/object.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/ruby_extensions/pathname/predicates.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/ruby_extensions/pathname/utils.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/ruby_extensions/pathname.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/ruby_extensions/string/conversions.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/ruby_extensions/string/predicates.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/ruby_extensions/string.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/ruby_extensions/time/utils.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/ruby_extensions/time.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/ruby_extensions.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/utility.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/validate.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/version.rb

@@ -1,4 +1,4 @@
-### Copyright 2022 Pixar
+### Copyright 2023 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -27,6 +27,6 @@
 module Jamf
 
   ### The version of ruby-jss
-  VERSION = '3.0.0'.freeze
+  VERSION = '3.1.0b2'.freeze
 
 end # module

data/lib/jamf/zeitwerk_config.rb

@@ -1,4 +1,4 @@
-# Copyright 2022 Pixar
+# Copyright 2023 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -47,18 +47,18 @@ module JamfZeitwerkConfig
     @verbose_loading ||= ENV.include? VERBOSE_LOADING_ENV
     @verbose_loading
   end
-  
+
   # rubocop: disable Style/StderrPuts
   def self.load_msg(msg)
-    $stderr.puts msg if verbose_loading?    
+    $stderr.puts msg if verbose_loading?
   end
   # rubocop: enable Style/StderrPuts
-        
+
   # The loader object for Xolo
   def self.loader
     @loader
   end
-    
+
   # Configure the Zeitwerk loader, See https://github.com/fxn/zeitwerk
   def self.setup_zeitwerk_loader(zloader)
     @loader = zloader
@@ -67,7 +67,7 @@ module JamfZeitwerkConfig
     loader.ignore __FILE__
 
     ##### Collaped Paths
-    
+
     # these paths all define classes & modules directly below 'Jamf'
     # If we didn't collapse them, then e.g.
     #   /jamf/api/base_classes/classic/group.rb
@@ -90,7 +90,7 @@ module JamfZeitwerkConfig
     loader.collapse("#{__dir__}/api/jamf_pro/other_classes")
 
     ##### Inflected Paths
-    
+
     # filenames => Constants, which don't adhere to zeitwerk's parsing standards.
     #
     # Mostly because the a filename like 'oapi_object' would be
@@ -129,16 +129,17 @@ module JamfZeitwerkConfig
     loader.inflector.inflect 'md_prestage_skip_setup_items' => 'MobileDevicePrestageSkipSetupItems'
     loader.inflector.inflect 'macos_managed_updates' => 'MacOSManagedUpdates'
     loader.inflector.inflect 'macos_redeploy_mgmt_framework' => 'MacOSRedeployMgmtFramework'
+    loader.inflector.inflect 'filevault' => 'FileVault'
 
     # deprecations, separated so they load only when used.
-    # When its time to get rid of them, delete the files from the 
+    # When its time to get rid of them, delete the files from the
     # 'deprecations' directory, and the matching line here.
     loader.inflector.inflect('deprecated_api_constant' => 'API')
     loader.inflector.inflect('deprecated_config_constant' => 'CONFIG')
     loader.inflector.inflect('deprecated_api_connection_class' => 'APIConnection')
 
     ##### Ingored Paths
-    
+
     # These should be ignored, some will be required directly
     #####################################
 
@@ -150,15 +151,15 @@ module JamfZeitwerkConfig
     loader.ignore "#{__dir__}/deprecations.rb"
 
     lib_dir = Pathname.new(__dir__).parent.to_s
-    loader.ignore "#{lib_dir}/ruby-jss.rb" 
-    loader.ignore "#{lib_dir}/jss.rb" 
-    loader.ignore "#{lib_dir}/jss-api.rb" 
-    
+    loader.ignore "#{lib_dir}/ruby-jss.rb"
+    loader.ignore "#{lib_dir}/jss.rb"
+    loader.ignore "#{lib_dir}/jss-api.rb"
+
     ##### Callbacks
 
     # callback for when a specific file/constant loads
-    # duplicate and uncomment this if desired to react to 
-    # specific things loading 
+    # duplicate and uncomment this if desired to react to
+    # specific things loading
     #####################################
     # loader.on_load('Jamf::SomeClass') do |klass, abspath|
     #   Jamf.load_msg "I just loaded #{klass} from #{abspath}"

data/lib/jamf.rb

@@ -1,4 +1,4 @@
-# Copyright 2022 Pixar
+# Copyright 2023 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -67,7 +67,7 @@ module Jamf
   # Use the load_msg method defined for Zeitwerk
   def self.load_msg(msg)
     JamfZeitwerkConfig.load_msg msg
-  end  
+  end
 
   # the single instance of our configuration object
   def self.config
@@ -88,8 +88,8 @@ end # module Jamf
 JSS = Jamf
 
 # testing zeitwerk loading, the the desired file is present
-JamfZeitwerkConfig.eager_load_for_testing 
+JamfZeitwerkConfig.eager_load_for_testing
 
-# Load more non-autoloaded stuff, but this stuff needs 
+# Load more non-autoloaded stuff, but this stuff needs
 # to happen after zeitwerk loading is active.
 require 'jamf/deprecations'

data/lib/jss-api.rb

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

data/lib/jss.rb

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

data/lib/ruby-jss.rb

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

data/test/bin/runtests

@@ -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")
@@ -43,7 +43,7 @@ $save_trace = false
 # the file to hold the traces
 $trace_out = open('/tmp/ruby-jss-tests-trace.txt', 'w')
 
-# the max call-stack depth - adjust this to help catch and 
+# the max call-stack depth - adjust this to help catch and
 # debug SystemStackError exceptions
 $trace_max_call_stack_depth = 1000
 
@@ -52,7 +52,7 @@ set_trace_func proc { |event, file, line, id, _binding, classname|
   if $do_tracing
     begin
       if event == 'call'
-        $trace_out.puts "#{file}:#{line} #{classname}##{id}" if $save_trace 
+        $trace_out.puts "#{file}:#{line} #{classname}##{id}" if $save_trace
         raise 'MaxCallStackReached' if caller_locations.length > $trace_max_call_stack_depth
       end
     rescue => e

data/test/lib/jamf_test/APITest.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/test/lib/jamf_test/advanced_search.rb

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

data/test/lib/jamf_test/auth.rb

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

data/test/lib/jamf_test/collection_tests.rb

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

data/test/lib/jamf_test/prestage_tests.rb

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

data/test/lib/jamf_test.rb

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

data/test/tests/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")