ruby-jss 1.6.0 → 2.0.0a11

data/lib/{jss/api_object → jamf/api/classic/api_objects}/patch_policy.rb

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -24,7 +24,7 @@
 ###
 
 ###
-module JSS
+module Jamf
 
   # A Patch Policy in the JSS
   #
@@ -36,17 +36,17 @@ module JSS
   # :target_version is the string identfier of an available version of
   # the title. The target version MUST have a package assigned to it.
   #
-  # See {JSS::PatchTitle} and {JSS::PatchSource.available_titles} for methods
+  # See {Jamf::PatchTitle} and {Jamf::PatchSource.available_titles} for methods
   # to acquire such info.
   #
-  # @see JSS::APIObject
+  # @see Jamf::APIObject
   #
-  class PatchPolicy < JSS::APIObject
+  class PatchPolicy < Jamf::APIObject
 
-    include JSS::SelfServable
-    include JSS::Scopable
-    include JSS::Creatable
-    include JSS::Updatable
+    include Jamf::SelfServable
+    include Jamf::Scopable
+    include Jamf::Creatable
+    include Jamf::Updatable
 
     RSRC_BASE = 'patchpolicies'.freeze
 
@@ -80,25 +80,25 @@ module JSS
 
     DFT_GRACE_PERIOD_MESSAGE = '$APP_NAMES will quit in $DELAY_MINUTES minutes so that $SOFTWARE_TITLE can be updated. Save anything you are working on and quit the app(s).'.freeze
 
-    # See {JSS::XMLWorkaround}
+    # See {Jamf::XMLWorkaround}
     USE_XML_WORKAROUND = {
       patch_policy: {
         general: {
           id: -1,
-          name: JSS::BLANK,
+          name: Jamf::BLANK,
           enabled: nil,
-          target_version: JSS::BLANK,
+          target_version: Jamf::BLANK,
           release_date: 0,
           incremental_update: nil,
           reboot: nil,
-          minimum_os: JSS::BLANK,
+          minimum_os: Jamf::BLANK,
           kill_apps: [
             {
-              kill_app_name: JSS::BLANK,
-              kill_app_bundle_id: JSS::BLANK
+              kill_app_name: Jamf::BLANK,
+              kill_app_bundle_id: Jamf::BLANK
             }
           ],
-          distribution_method: JSS::BLANK,
+          distribution_method: Jamf::BLANK,
           allow_downgrade: nil,
           patch_unknown: nil
         },
@@ -107,51 +107,51 @@ module JSS
           computers: [
             {
               id: -1,
-              name: JSS::BLANK,
-              udid: JSS::BLANK
+              name: Jamf::BLANK,
+              udid: Jamf::BLANK
             }
           ],
           computer_groups: [
             {
               id: -1,
-              name: JSS::BLANK
+              name: Jamf::BLANK
             }
           ],
           users: [
             {
               id: -1,
-              username: JSS::BLANK
+              username: Jamf::BLANK
             }
           ],
           user_groups: [
             {
               id: -1,
-              name: JSS::BLANK
+              name: Jamf::BLANK
             }
           ],
           buildings: [
             {
               id: -1,
-              name: JSS::BLANK
+              name: Jamf::BLANK
             }
           ],
           departments: [
             {
               id: -1,
-              name: JSS::BLANK
+              name: Jamf::BLANK
             }
           ],
           limitations: {
             network_segments: [
               {
                 id: -1,
-                name: JSS::BLANK
+                name: Jamf::BLANK
               }
             ],
             ibeacons: [
               {
                 id: -1,
-                name: JSS::BLANK
+                name: Jamf::BLANK
               }
             ]
           },
@@ -159,67 +159,67 @@ module JSS
             computers: [
               {
                 id: -1,
-                name: JSS::BLANK,
-                udid: JSS::BLANK
+                name: Jamf::BLANK,
+                udid: Jamf::BLANK
               }
             ],
             computer_groups: [
               {
                 id: -1,
-                name: JSS::BLANK
+                name: Jamf::BLANK
               }
             ],
             users: [
               {
                 id: -1,
-                username: JSS::BLANK
+                username: Jamf::BLANK
               }
             ],
             user_groups: [
               {
                 id: -1,
-                name: JSS::BLANK
+                name: Jamf::BLANK
               }
             ],
             buildings: [
               {
                 id: -1,
-                name: JSS::BLANK
+                name: Jamf::BLANK
               }
             ],
             departments: [
               {
                 id: -1,
-                name: JSS::BLANK
+                name: Jamf::BLANK
               }
             ],
             network_segments: [
               {
                 id: -1,
-                name: JSS::BLANK
+                name: Jamf::BLANK
               }
             ],
             ibeacons: [
               {
                 id: -1,
-                name: JSS::BLANK
+                name: Jamf::BLANK
               }
             ]
           }
         },
         user_interaction: {
-          install_button_text: JSS::BLANK,
-          self_service_description: JSS::BLANK,
+          install_button_text: Jamf::BLANK,
+          self_service_description: Jamf::BLANK,
           self_service_icon: {
             id: -1,
-            filename: JSS::BLANK,
-            uri: JSS::BLANK
+            filename: Jamf::BLANK,
+            uri: Jamf::BLANK
           },
           notifications: {
             notification_enabled: nil,
-            notification_type: JSS::BLANK,
-            notification_subject: JSS::BLANK,
-            notification_message: JSS::BLANK,
+            notification_type: Jamf::BLANK,
+            notification_subject: Jamf::BLANK,
+            notification_message: Jamf::BLANK,
             reminders: {
               notification_reminders_enabled: nil,
               notification_reminder_frequency: 1
@@ -249,11 +249,13 @@ module JSS
     #
     # @return [Array<Hash>] the :id and :name of each policy for the title
     #
-    def self.all_for_title(title, api: JSS.api)
-      title_id = JSS::PatchTitle.valid_id title
-      raise JSS::NoSuchItemError, "No PatchTitle matching '#{title}'" unless title_id
+    def self.all_for_title(title, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
 
-      api.get_rsrc("#{RSRC_BY_PATCH_TITLE}#{title_id}")[RSRC_BY_PATCH_TITLE_LIST_KEY]
+      title_id = Jamf::PatchTitle.valid_id title
+      raise Jamf::NoSuchItemError, "No PatchTitle matching '#{title}'" unless title_id
+
+      cnx.c_get("#{RSRC_BY_PATCH_TITLE}#{title_id}")[RSRC_BY_PATCH_TITLE_LIST_KEY]
     end
 
     # Override APIObject.fetch, since there's no .../patchpolicies/name/... endpoint
@@ -263,7 +265,7 @@ module JSS
       name_search = args.delete :name
       if name_search
         id = valid_id name_search
-        raise JSS::NoSuchItemError, "No #{self::RSRC_OBJECT_KEY} found #{err_detail}" unless id
+        raise Jamf::NoSuchItemError, "No #{self::RSRC_OBJECT_KEY} found #{err_detail}" unless id
 
         args[:id] = id
       end
@@ -347,7 +349,7 @@ module JSS
     #   within @grace_period minutes
     attr_reader :grace_period_message
 
-    # @return [Integer] the id of the JSS::PatchTitle for this policy.
+    # @return [Integer] the id of the Jamf::PatchTitle for this policy.
     #   Can be set with the patch_title: param of .make, but is read-only after
     #   that.
     attr_reader :patch_title_id
@@ -355,12 +357,12 @@ module JSS
     alias software_title_configuration_id patch_title_id
 
     # When making new Patch Polices :patch_title is required and is
-    # a JSS::PatchTitle or the name or id of one
+    # a Jamf::PatchTitle or the name or id of one
     #
     # If target_version: is provided, it must exist in the PatchTitle,
     # and must have a package assigned to it.
     #
-    def initialize(data = {})
+    def initialize(**data)
       super
 
       # creation...
@@ -415,22 +417,22 @@ module JSS
       @kill_apps = gen[:kill_apps]
     end
 
-    # The JSS::PatchTitle to for this PatchPolicy
+    # The Jamf::PatchTitle to for this PatchPolicy
     #
     # @param refresh [Boolean] Should the Title be re-fetched from the API?
     #
-    # @return [JSS::PatchTitle, nil]
+    # @return [Jamf::PatchTitle, nil]
     #
     def patch_title(refresh = false)
       @patch_title = nil if refresh
-      @patch_title ||= JSS::PatchTitle.fetch id: patch_title_id
+      @patch_title ||= Jamf::PatchTitle.fetch id: patch_title_id
     end
 
     # @return [String] the name of the PatchTitle for this patch policy
     #
     def patch_title_name
       return @patch_title.name if @patch_title
-      JSS::PatchTitle.map_all_ids_to(:name)[software_title_configuration_id]
+      Jamf::PatchTitle.map_all_ids_to(:name)[software_title_configuration_id]
     end
 
     # See attr_reader :target_version
@@ -466,7 +468,7 @@ module JSS
     #
     def allow_downgrade=(new_val)
       return if new_val == allow_downgrade
-      @allow_downgrade = JSS::Validate.boolean new_val
+      @allow_downgrade = Jamf::Validate.boolean new_val
       @need_to_update = true
     end
 
@@ -474,7 +476,7 @@ module JSS
     #
     def patch_unknown=(new_val)
       return if new_val == patch_unknown
-      @patch_unknown = JSS::Validate.boolean new_val
+      @patch_unknown = Jamf::Validate.boolean new_val
       @need_to_update = true
     end
 
@@ -482,7 +484,7 @@ module JSS
     #
     def deadline=(days)
       unless days == NO_DEADLINE
-        days = JSS::Validate.integer(days)
+        days = Jamf::Validate.integer(days)
         days = NO_DEADLINE unless days.positive?
       end
       return if days == deadline
@@ -493,7 +495,7 @@ module JSS
     # see attr_reader :grace_period
     #
     def grace_period=(mins)
-      mins = JSS::Validate.integer(mins)
+      mins = Jamf::Validate.integer(mins)
       mins = 0 if mins.negative?
       return if mins == grace_period
       @grace_period = mins
@@ -551,38 +553,38 @@ module JSS
     # raise an error if the patch title we're trying to use isn't available in
     # the jss. If handed a PatchTitle instance, we assume it came from the JSS
     #
-    ## @param new_title[String,Integer,JSS::PatchTitle] the title to validate
+    ## @param new_title[String,Integer,Jamf::PatchTitle] the title to validate
     #
     # @return [Integer] the id of the valid title
     #
     def validate_patch_title(a_title)
-      if a_title.is_a? JSS::PatchTitle
+      if a_title.is_a? Jamf::PatchTitle
         @patch_title = a_title
         return a_title.id
       end
-      raise JSS::MissingDataError, ':patch_title is required' unless a_title
-      title_id = JSS::PatchTitle.valid_id a_title
+      raise Jamf::MissingDataError, ':patch_title is required' unless a_title
+      title_id = Jamf::PatchTitle.valid_id a_title
       return title_id if title_id
-      raise JSS::NoSuchItemError, "No Patch Title matches '#{a_title}'"
+      raise Jamf::NoSuchItemError, "No Patch Title matches '#{a_title}'"
     end
 
     # raise an exception if a given target version is not valid for this policy
     # Otherwise return it
     #
     def validate_target_version(tgt_vers)
-      raise JSS::MissingDataError, "target_version can't be nil" unless tgt_vers
+      raise Jamf::MissingDataError, "target_version can't be nil" unless tgt_vers
 
-      JSS::Validate.non_empty_string tgt_vers
+      Jamf::Validate.non_empty_string tgt_vers
 
       unless patch_title(:refresh).versions.key? tgt_vers
         errmsg = "Version '#{tgt_vers}' does not exist for title: #{patch_title_name}."
-        raise JSS::NoSuchItemError, errmsg
+        raise Jamf::NoSuchItemError, errmsg
       end
 
       return tgt_vers if patch_title.versions_with_packages.key? tgt_vers
 
       errmsg = "Version '#{tgt_vers}' cannot be used in Patch Policies until a package is assigned to it."
-      raise JSS::UnsupportedError, errmsg
+      raise Jamf::UnsupportedError, errmsg
     end
 
     def validate_for_saving
@@ -601,7 +603,7 @@ module JSS
     end
 
     def rest_xml
-      doc = REXML::Document.new JSS::APIConnection::XML_HEADER
+      doc = REXML::Document.new Jamf::Connection::XML_HEADER
       obj = doc.add_element RSRC_OBJECT_KEY.to_s
 
       general = obj.add_element 'general'
@@ -636,4 +638,4 @@ module JSS
 
   end # class PatchPolicy
 
-end # module JSS
+end # module Jamf

data/lib/{jss/api_object → jamf/api/classic/api_objects}/patch_title/version.rb

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -24,10 +24,10 @@
 ###
 
 ###
-module JSS
+module Jamf
 
   #
-  class PatchTitle < JSS::APIObject
+  class PatchTitle < Jamf::APIObject
 
     # A Patch Software Title Version in the JSS.
     #
@@ -35,11 +35,11 @@ module JSS
     # 'patchsoftwaretitles' resource of the API
     #
     # Not only does each one have a 'version', e.g. '8.3.2b12', but
-    # also knows its parent PatchTitle, the matching JSS::Package,
+    # also knows its parent PatchTitle, the matching Jamf::Package,
     # if any, and can report the names and ids of the computers
     # that have it installed.
     #
-    # To set or change the JSS::Package associated with a PatchTitle::Version,
+    # To set or change the Jamf::Package associated with a PatchTitle::Version,
     # first fetch the corresponding SoftwareTitle, use the #package= method
     # of the Version object in its #versions attribute, then save the PatchTitle
     # back to the JSS.
@@ -53,15 +53,15 @@ module JSS
       #   name_id is a unique identfier created from the patch name
       attr_reader :version
 
-      # @return [Integer] the id of the JSS::Package that installs this PatchVersion,
+      # @return [Integer] the id of the Jamf::Package that installs this PatchVersion,
       #  if defined.
       attr_reader :package_id
 
-      # @return [String] the name of the JSS::Package that installs this PatchVersion,
+      # @return [String] the name of the Jamf::Package that installs this PatchVersion,
       #  if defined
       attr_reader :package_name
 
-      # This should only be instantiated by the JSS::PatchTitle that contains
+      # This should only be instantiated by the Jamf::PatchTitle that contains
       # this version.
       #
       def initialize(title, data)
@@ -126,29 +126,29 @@ module JSS
         computers.map { |c| c[:udid] }
       end
 
-      # Assign a new JSS::Package to this PatchTitle::Version.
+      # Assign a new Jamf::Package to this PatchTitle::Version.
       # The Package must exist in the JSS. Be
       # sure to call #update on the PatchTitle containing
       # this Version.
       #
-      # @param new_pkg[String,Integer,Symbol] A name or id of a JSS::Package.
+      # @param new_pkg[String,Integer,Symbol] A name or id of a Jamf::Package.
       #   use :none to unset a package for this version.
       #
       def package=(new_pkg)
-        raise JSS::UnsupportedError, "Packages can't be assigned to the Unkown version." if version == JSS::PatchTitle::UNKNOWN_VERSION_ID
+        raise Jamf::UnsupportedError, "Packages can't be assigned to the Unkown version." if version == Jamf::PatchTitle::UNKNOWN_VERSION_ID
 
         pkgid =
           if new_pkg == :none
             :none
           else
-            JSS::Package.valid_id new_pkg, :refresh, api: @title.api
+            Jamf::Package.valid_id new_pkg, :refresh, cnx: @title.cnx
           end
-        raise JSS::NoSuchItemError, "No JSS::Package matches '#{new_pkg}'" unless pkgid
+        raise Jamf::NoSuchItemError, "No Jamf::Package matches '#{new_pkg}'" unless pkgid
 
         return if @package_id == pkgid
 
         @package_id = pkgid
-        @package_name = pkgid == :none ? nil : JSS::Package.map_all_ids_to(:name)[pkgid]
+        @package_name = pkgid == :none ? nil : Jamf::Package.map_all_ids_to(:name)[pkgid]
         @title.changed_pkg_for_version version
       end
 
@@ -168,4 +168,4 @@ module JSS
 
   end # class SoftwareTitle
 
-end # module JSS
+end # module Jamf