ruby-jss 2.0.0b1 → 2.0.0b3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe30c0681cd2c394be81e8f15797e5222d6ce95c7458717a206c91d9d1704137
-  data.tar.gz: 275bfb95e7924dd12612e4077fea75da21105b2b8fc7239e989704cdc9bca65a
+  metadata.gz: e4da473b27e4faa5f1a6e9249b5fd8ac6347161bd6db568335b47d57ee0c6600
+  data.tar.gz: b4864c373f399e8a2b73d7191d9c8407b3df0a7e134f35593a13acde67548652
 SHA512:
-  metadata.gz: 747af106fa7e86e60535a831cbd36af1b850e6682cacee07fea2e30ed079188be1ddf6c17e06d25d8887cbda3e35411329fe91a5d2e60c49b5f93a3d2e1b03a3
-  data.tar.gz: 5e56d93b2dc5fa52faa6a385352d71b5d5691ce9a7428f459eece369d991504729b3ddfe0eea721f6e888306e524684a0bade6572e5c96752605d0179c8e923f
+  metadata.gz: 9f85ca5790b4c365a9c85c58a803d54e79b4916d2b4d4e4afb32d98b4131bc0137df647f65c4144d5d711890c6453532ff30b24565db443ab6fa9d698a28e2b1
+  data.tar.gz: 76434531dba3201bcc711d19154798bd5ac2a4deb998aea3b82dd07aaebc4a69df41909848fe2cffb466b5752f04735b2f09a54dc2f127ddcdd3ead3e31efb51

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

@@ -50,7 +50,6 @@ module Jamf
     include Jamf::VPPable
     include Jamf::Sitable
 
-
     # Class Methods
     #####################################
 
@@ -162,6 +161,10 @@ module Jamf
     #   does its backups (to icloud or itunes)?
     attr_reader :prevent_backup_of_app_data
 
+    # @return [Boolean] Should this app auto-update on devices?
+    attr_reader :keep_app_updated_on_devices
+    alias auto_update? keep_app_updated_on_devices
+
     # @return [Boolean] should the JSS update the icon and description from the app
     #   source?
     attr_reader :keep_description_and_icon_up_to_date
@@ -185,7 +188,6 @@ module Jamf
     #   which contains a plist <dict> element with config data.
     attr_reader :configuration_prefs
 
-
     # Constructor
     #####################################
 
@@ -208,6 +210,7 @@ module Jamf
       @itunes_country_region = general[:itunes_country_region]
       @itunes_sync_time = general[:itunes_sync_time]
       @deploy_as_managed_app = general[:deploy_as_managed_app]
+      @keep_app_updated_on_devices = general[:keep_app_updated_on_devices]
       @remove_app_when_mdm_profile_is_removed = general[:remove_app_when_mdm_profile_is_removed]
       @prevent_backup_of_app_data = general[:prevent_backup_of_app_data]
       @keep_description_and_icon_up_to_date = general[:keep_description_and_icon_up_to_date]
@@ -232,6 +235,7 @@ module Jamf
     #
     def display_name=(new_val)
       return nil if new_val.to_s == @display_name
+
       @display_name = new_val.to_s
       @need_to_update = true
     end
@@ -274,6 +278,7 @@ module Jamf
     #
     def url=(new_val)
       return nil if new_val == @url
+
       @url = new_val
       @need_to_update = true
     end
@@ -288,6 +293,7 @@ module Jamf
     def make_available_after_install=(new_val)
       return nil if new_val == @make_available_after_install
       raise Jamf::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+
       @make_available_after_install = new_val
       @need_to_update = true
     end
@@ -302,10 +308,25 @@ module Jamf
     def deploy_as_managed_app=(new_val)
       return nil if new_val == @deploy_as_managed_app
       raise Jamf::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+
       @deploy_as_managed_app = new_val
       @need_to_update = true
     end
 
+    # Set whether or not this app should be auto-updated on devices
+    #
+    # @param new_val[Boolean] The new value
+    #
+    # @return [void]
+    #
+    def keep_app_updated_on_devices=(new_val)
+      return nil if new_val == @keep_app_updated_on_devices
+      raise Jamf::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+
+      @keep_app_updated_on_devices = new_val
+      @need_to_update = true
+    end
+    alias auto_update= keep_app_updated_on_devices=
 
     # Set whether or not this app should be removed when
     # the device is unmanaged
@@ -317,6 +338,7 @@ module Jamf
     def remove_app_when_mdm_profile_is_removed=(new_val)
       return nil if new_val == @remove_app_when_mdm_profile_is_removed
       raise Jamf::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+
       @remove_app_when_mdm_profile_is_removed = new_val
       @need_to_update = true
     end
@@ -330,11 +352,11 @@ module Jamf
     def prevent_backup_of_app_data=(new_val)
       return nil if new_val == @prevent_backup_of_app_data
       raise Jamf::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+
       @prevent_backup_of_app_data = new_val
       @need_to_update = true
     end
 
-
     # Set whether or not the jss should update info about this app from the app store
     #
     # @param new_val[Boolean] The new value
@@ -344,6 +366,7 @@ module Jamf
     def keep_description_and_icon_up_to_date=(new_val)
       return nil if new_val == @keep_description_and_icon_up_to_date
       raise Jamf::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+
       @keep_description_and_icon_up_to_date = new_val
       @need_to_update = true
     end
@@ -357,6 +380,7 @@ module Jamf
     def free=(new_val)
       return nil if new_val == @free
       raise Jamf::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+
       @free = new_val
       @need_to_update = true
     end
@@ -371,6 +395,7 @@ module Jamf
     def take_over_management=(new_val)
       return nil if new_val == @take_over_management
       raise Jamf::InvalidDataError, 'New value must be true or false' unless new_val.jss_boolean?
+
       @take_over_management = new_val
       @need_to_update = true
     end
@@ -432,6 +457,7 @@ module Jamf
     #
     def external_url=(new_val)
       return nil if new_val == @external_url
+
       @external_url = new_val
       @need_to_update = true
     end
@@ -445,11 +471,11 @@ module Jamf
     #
     def configuration_prefs=(new_val)
       return nil if new_val == @configuration_prefs
+
       @configuration_prefs = new_val
       @need_to_update = true
     end
 
-
     # Save the application to a file.
     #
     # @param path[Pathname, String] The path to which the file should be saved.
@@ -462,10 +488,12 @@ module Jamf
     #
     def save_ipa(path, overwrite = false)
       return nil unless @ipa[:data]
+
       path = Pathname.new path
-      path = path + @ipa[:name] if path.directory? && @ipa[:name]
+      path += @ipa[:name] if path.directory? && @ipa[:name]
 
       raise Jamf::AlreadyExistsError, "The file #{path} already exists" if path.exist? && !overwrite
+
       path.delete if path.exist?
       path.jss_save Base64.decode64(@ipa[:data])
     end
@@ -507,6 +535,7 @@ module Jamf
     #
     def refresh_ipa
       return nil unless @in_jss
+
       fresh_data = @cnx.c_get(@rest_rsrc)[self.class::RSRC_OBJECT_KEY]
       @ipa = fresh_data[:general][:ipa]
     end
@@ -523,6 +552,7 @@ module Jamf
       gen.add_element('deploy_as_managed_app').text = @deploy_as_managed_app
       gen.add_element('remove_app_when_mdm_profile_is_removed').text = @remove_app_when_mdm_profile_is_removed
       gen.add_element('prevent_backup_of_app_data').text = @prevent_backup_of_app_data
+      gen.add_element('keep_app_updated_on_devices').text = @keep_app_updated_on_devices
       gen.add_element('keep_description_and_icon_up_to_date').text = @keep_description_and_icon_up_to_date
       gen.add_element('free').text = @free
       gen.add_element('take_over_management').text = @take_over_management
@@ -540,7 +570,6 @@ module Jamf
       doc.to_s
     end
 
-
   end # class removable_macaddr
 
 end # module

data/lib/jamf/api/classic/base_classes/api_object.rb

@@ -295,7 +295,7 @@ module Jamf
     # This is called automatically when subclasses are loaded by zeitwerk
     #
     def self.define_identifier_list_methods
-      Jamf.load_msg "defining list-methods for APIObject subclass #{self}"
+      Jamf.load_msg "Defining list-methods for APIObject subclass #{self}"
 
       lookup_keys.each do |als, key|
         meth_name = key.to_s.end_with?('s') ? "all_#{key}es" : "all_#{key}s"

data/lib/jamf/api/connection/token.rb

@@ -87,6 +87,7 @@ module Jamf
       # @return [String] The token data
       attr_reader :token
       alias token_string token
+      alias auth_token token
 
       # @return [URI] The base API url, e.g. https://myjamf.jamfcloud.com/
       attr_reader :base_url

data/lib/jamf/api/connection.rb

@@ -231,8 +231,4 @@ module Jamf
 
   end # class Connection
 
-  # Some backward compatibility
-  # @deprecated
-  APIConnection = Connection
-
 end # module

data/lib/jamf/api/jamf_pro/api_objects/inventory_preload_record.rb

@@ -110,7 +110,6 @@ module Jamf
     # Must define this when extending Filterable
     FILTER_KEYS = OAPI_PROPERTIES.keys - [:extensionAttributes]
 
-
     DEVICE_TYPE_COMPUTER = 'Computer'.freeze
 
     DEVICE_TYPE_MOBILE_DEV = 'Mobile Device'.freeze

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

@@ -49,6 +49,10 @@ module Jamf
     # https://developer.jamf.com/jamf-pro/reference/post_v1-macos-managed-software-updates-send-updates
     MANAGED_SW_UPDATES_SEND_UPDATES_RSRC = "#{MANAGED_SW_UPDATES_RSRC}/send-updates"
 
+    # These are the options available in Jamf::OAPISchemas::MacOsManagedSoftwareUpdate::UPDATE_ACTION_OPTIONS
+    DOWNLOAD_AND_INSTALL = 'DOWNLOAD_AND_INSTALL'
+    DOWNLOAD_ONLY = 'DOWNLOAD_ONLY'
+
     # Class Methods
     #####################################
     module ClassMethods
@@ -67,11 +71,11 @@ module Jamf
         Jamf::OAPISchemas::AvailableUpdates.new(data).availableUpdates
       end
 
-      # Send the os update command to target Macs or a group
+      # Send the os update command to target Computers or a ComputerGroup
       #
       # @param updateAction [String] Required. 'DOWNLOAD_AND_INSTALL' or 'DOWNLOAD_ONLY'
       #
-      # @param deviceIds [String, Integer, Array<String, Integer>] Identiiers for the 
+      # @param deviceIds [String, Integer, Array<String, Integer>] Identifiers for the 
       #   computer targets. Required if no groupId is given.
       #
       # @param groupId [String, Integer] Identifier for the computer group target.
@@ -82,19 +86,20 @@ module Jamf
       #   Update will use the InstallLater install action. MaxDeferral is ignored if using the 
       #   DOWNLOAD_ONLY updateAction.
       #
-      # @param version [String] If no value is provided, the version will default to latest
-      #   version based on device eligibility.
+      # @param version [String] The OS version to install. If no value is provided, the 
+      #   version will default to latest version based on device eligibility.
       #
-      # @param skipVersionVerification [Boolean] If no value is provided, will default to false.
+      # @param skipVersionVerification [Boolean] Should the specified version be installed
+      #   even it it isn't applicable to this machine? If no value is provided, will default to false.
       #   If true, the specified version will be forced to complete DownloadAndInstall
       #   install action.
       #
-      # @param applyMajorUpdate [Boolean] available only when updating to the latest version
+      # @param applyMajorUpdate [Boolean] Available only when updating to the latest version
       #   based on device eligibility. Defaults to false. If false the calculated latest version
       #   will only include minor version updates. If a value is provided, the calculated latest
       #   version will include minor and major version updates.
       #
-      # @param forceRestart [Boolean]  will default to false. Can only be true if updateAction 
+      # @param forceRestart [Boolean]  Will default to false. Can only be true if updateAction 
       #   is DOWNLOAD_AND_INSTALLn and the devices the command is sent to are on macOs 11 or higher. 
       #   If true, the DownloadAndInstall action is performed, a restart will be forced. 
       #   MaxDeferral will be ignored if true. 
@@ -146,6 +151,11 @@ module Jamf
     # 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 MacOSManagedUpdates.send_managed_os_update
+    #
     def send_managed_os_update(updateAction:, maxDeferrals: nil, version: nil, skipVersionVerification: false, applyMajorUpdate: false, forceRestart: false, cnx: Jamf.cnx)
       deviceIds = is_a?(Jamf::Computer) ? @id : nil
       groupId = is_a?(Jamf::Computer) ? nil : @id

data/lib/jamf/deprecations/deprecated_api_connection_class.rb

@@ -0,0 +1,29 @@
+# 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.
+
+# @deprecated Use class Jamf::Connection
+module Jamf
+
+  APIConnection = Connection
+
+end

data/lib/jamf/version.rb

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

data/lib/zeitwerk_config.rb

@@ -29,7 +29,7 @@ def setup_zeitwerk_loader(loader)
   loader.ignore __FILE__
 
   # these paths all define classes & modules directly below 'Jamf'
-  # If we didn't collaps them, then e.g.
+  # If we didn't collapse them, then e.g.
   #   /jamf/api/base_classes/classic/group.rb
   # would be expected to define
   #   Jamf::Api::BaseClasses::Classic::Group
@@ -51,7 +51,8 @@ def setup_zeitwerk_loader(loader)
 
   loader.collapse("#{__dir__}/jamf/deprecations")
 
-  # filenames => Constants, which don't adhere to zeitwerk's parsing standards
+  # filenames => Constants, which don't adhere to zeitwerk's parsing standards.
+  #
   # Mostly because the a filename like 'oapi_object' would be
   # loaded by zeitwerk expecting it to define 'OapiObject', but it really
   # defines 'OAPIObject'
@@ -88,15 +89,16 @@ def setup_zeitwerk_loader(loader)
   loader.inflector.inflect 'md_prestage_skip_setup_items' => 'MobileDevicePrestageSkipSetupItems'
   loader.inflector.inflect 'macos_managed_updates' => 'MacOSManagedUpdates'
 
-  # deprecations, separated so they load only when used
+  # deprecations, separated so they load only when used.
+  # 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')
 
   # These should be ignored, some will be required directly
   #####################################
 
-  loader.ignore "#{__dir__}/jamf/api/jamf_pro/pre_oapi"
-
   loader.ignore "#{__dir__}/jamf/db_connection.rb"
   loader.ignore "#{__dir__}/jamf/ruby_extensions.rb"
   loader.ignore "#{__dir__}/jamf/ruby_extensions"
@@ -106,16 +108,18 @@ def setup_zeitwerk_loader(loader)
   loader.ignore "#{__dir__}/ruby-jss.rb"
 
   # callback for when a specific file/constant loads
+  # 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}"
-  end
+  # loader.on_load('Jamf::SomeClass') do |klass, abspath|
+  #   Jamf.load_msg "I just loaded #{klass} from #{abspath}"
+  # end
 
   # callback for when anything loads
   #  - const_path is like "Jamf::SomeClass" or "Jamf::SomeClass::SOME_CONST_ARRY"
   #  - value is the value that constant contains after loading,
-  #    e.g. a the class Jamf::SomeClass for 'Jamf::SomeClass' or
-  #    and Array for the constant  "Jamf::SomeClass::SOME_CONST_ARRY"
+  #    e.g. the class Jamf::SomeClass for 'Jamf::SomeClass' or
+  #    an Array for the constant  "Jamf::SomeClass::SOME_CONST_ARRY"
   #  - abspath is the full path to the file where the constant was loaded from.
   #####################################
   loader.on_load do |const_path, value, abspath|
@@ -123,6 +127,7 @@ def setup_zeitwerk_loader(loader)
 
     # Parse OAPI_PROPERTIES into getters and setters for subclasses of
     # OAPIObject in the JPAPI.
+    #
     # The class we just loaded must have this method and constant
     # and the method must not have run already for the class or any superclass.
     # This prevents running parse_oapi_properties again in subclasses that

data/test/tests/policy.rb

@@ -25,6 +25,7 @@
 
 module JamfTest
 
+  # Policy Tests
   class Policy < JamfTest::APITest
 
     include JamfTest::CollectionTests

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-jss
 version: !ruby/object:Gem::Version
-  version: 2.0.0b1
+  version: 2.0.0b3
 platform: ruby
 authors:
 - Chris Lasell
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-02 00:00:00.000000000 Z
+date: 2022-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: CFPropertyList
@@ -50,42 +50,30 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -107,9 +95,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -117,9 +102,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -144,6 +126,9 @@ dependencies:
   name: rexml
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.9
@@ -151,6 +136,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.9
@@ -159,7 +147,7 @@ description: |
   an enterprise/education tool for managing Apple devices, from jamf.com.
   The Jamf module provides access to both the 'Classic' API and the more modern
   'Jamf Pro' API. Jamf Pro objects are implemented as classes and can interact
-  with each other. Connection tokens, data transfer using JSON or XML and other
+  with each other. Authentication tokens, data transfer using JSON or XML and other
   details are handled automatically under the hood to allow simpler, intuitive
   automation of Jamf-related Tasks.
 email: ruby-jss@pixar.com
@@ -759,6 +747,7 @@ files:
 - lib/jamf/configuration.rb
 - lib/jamf/constants.rb
 - lib/jamf/db_connection.rb
+- lib/jamf/deprecations/deprecated_api_connection_class.rb
 - lib/jamf/deprecations/deprecated_api_constant.rb
 - lib/jamf/deprecations/deprecated_config_constant.rb
 - lib/jamf/exceptions.rb