ruby-jss 1.6.0 → 2.0.0a11

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

@@ -1,4 +1,4 @@
-module JSS
+module Jamf
     ### Module Constants
     #####################################
 
@@ -13,13 +13,13 @@ module JSS
 
     ### Printer object inside JSS
     ###
-    ### @see JSS::APIObject
-    class Printer < JSS::APIObject
+    ### @see Jamf::APIObject
+    class Printer < Jamf::APIObject
         ## Mix-Ins
         #####################################
-        include JSS::Creatable
-        include JSS::Updatable
-        include JSS::Categorizable
+        include Jamf::Creatable
+        include Jamf::Updatable
+        include Jamf::Categorizable
 
         ## Class Constants
         #####################################
@@ -86,8 +86,8 @@ module JSS
         #####################################
 
         ###
-        def initialize(args = {})
-            super args
+        def initialize(**args)
+            super
 
             if self.in_jss?
 
@@ -106,22 +106,22 @@ module JSS
                 @os_requirements = @init_data[:os_requirements]
             else
 
-                raise JSS::MissingDataError, "CUPS_name must be provided." unless !@init_data[:CUPS_name].nil?
-                raise JSS::MissingDataError, "uri must be provided." unless !@init_data[:uri].nil?
-
-                raise JSS::InvalidDataError, "uri must be a String." unless @init_data[:uri].is_a?(String) || @init_data[:uri].nil?
-                raise JSS::InvalidDataError, "CUPS_name must be a String." unless @init_data[:CUPS_name].is_a?(String)
-                raise JSS::InvalidDataError, "location must be a String." unless @init_data[:location].is_a?(String) || @init_data[:location].nil?
-                raise JSS::InvalidDataError, "model must be a String." unless @init_data[:model].is_a?(String) || @init_data[:model].nil?
-                raise JSS::InvalidDataError, "info must be a String." unless @init_data[:info].is_a?(String) || @init_data[:info].nil?
-                raise JSS::InvalidDataError, "notes must be a String." unless @init_data[:notes].is_a?(String) || @init_data[:notes].nil?
-                raise JSS::InvalidDataError, "ppd must be a String." unless @init_data[:ppd].is_a?(String) || @init_data[:ppd].nil?
-                raise JSS::InvalidDataError, "ppd_contents must be a String." unless @init_data[:ppd_contents].is_a?(String) || @init_data[:ppd_contents].nil?
-                raise JSS::InvalidDataError, "ppd_path must be a String." unless @init_data[:ppd_path].is_a?(String) || @init_data[:ppd_path].nil?
-                raise JSS::InvalidDataError, "os_requirements must be a String." unless @init_data[:os_requirements].is_a?(String) || @init_data[:os_requirements].nil?
-                raise JSS::InvalidDataError, "shared must be a String." unless (@init_data[:shared].is_a?(TrueClass) || @init_data[:shared].is_a?(FalseClass)) || @init_data[:shared].nil?
-                raise JSS::InvalidDataError, "make_default must be a String." unless (@init_data[:make_default].is_a?(TrueClass) || @init_data[:make_default].is_a?(FalseClass)) || @init_data[:make_default].nil?
-                raise JSS::InvalidDataError, "use_generic must be a String." unless (@init_data[:use_generic].is_a?(TrueClass) || @init_data[:use_generic].is_a?(FalseClass)) || @init_data[:use_generic].nil?
+                raise Jamf::MissingDataError, "CUPS_name must be provided." unless !@init_data[:CUPS_name].nil?
+                raise Jamf::MissingDataError, "uri must be provided." unless !@init_data[:uri].nil?
+
+                raise Jamf::InvalidDataError, "uri must be a String." unless @init_data[:uri].is_a?(String) || @init_data[:uri].nil?
+                raise Jamf::InvalidDataError, "CUPS_name must be a String." unless @init_data[:CUPS_name].is_a?(String)
+                raise Jamf::InvalidDataError, "location must be a String." unless @init_data[:location].is_a?(String) || @init_data[:location].nil?
+                raise Jamf::InvalidDataError, "model must be a String." unless @init_data[:model].is_a?(String) || @init_data[:model].nil?
+                raise Jamf::InvalidDataError, "info must be a String." unless @init_data[:info].is_a?(String) || @init_data[:info].nil?
+                raise Jamf::InvalidDataError, "notes must be a String." unless @init_data[:notes].is_a?(String) || @init_data[:notes].nil?
+                raise Jamf::InvalidDataError, "ppd must be a String." unless @init_data[:ppd].is_a?(String) || @init_data[:ppd].nil?
+                raise Jamf::InvalidDataError, "ppd_contents must be a String." unless @init_data[:ppd_contents].is_a?(String) || @init_data[:ppd_contents].nil?
+                raise Jamf::InvalidDataError, "ppd_path must be a String." unless @init_data[:ppd_path].is_a?(String) || @init_data[:ppd_path].nil?
+                raise Jamf::InvalidDataError, "os_requirements must be a String." unless @init_data[:os_requirements].is_a?(String) || @init_data[:os_requirements].nil?
+                raise Jamf::InvalidDataError, "shared must be a String." unless (@init_data[:shared].is_a?(TrueClass) || @init_data[:shared].is_a?(FalseClass)) || @init_data[:shared].nil?
+                raise Jamf::InvalidDataError, "make_default must be a String." unless (@init_data[:make_default].is_a?(TrueClass) || @init_data[:make_default].is_a?(FalseClass)) || @init_data[:make_default].nil?
+                raise Jamf::InvalidDataError, "use_generic must be a String." unless (@init_data[:use_generic].is_a?(TrueClass) || @init_data[:use_generic].is_a?(FalseClass)) || @init_data[:use_generic].nil?
 
                 @uri = @init_data[:uri]
                 @CUPS_name = @init_data[:CUPS_name]
@@ -150,12 +150,12 @@ module JSS
         #
         # @param newvalue [String]
         #
-        # @raise [JSS::InvalidDataError] If newvalue is not a String
+        # @raise [Jamf::InvalidDataError] If newvalue is not a String
         #
         # @return [void]
         def uri=(newvalue)
 
-            raise JSS::InvalidDataError, "URI must be a string." unless newvalue.is_a? String
+            raise Jamf::InvalidDataError, "URI must be a string." unless newvalue.is_a? String
 
             @uri = newvalue
 
@@ -169,12 +169,12 @@ module JSS
         #
         # @param newvalue [String]
         #
-        # @raise [JSS::InvalidDataError] If newvalue is not a String
+        # @raise [Jamf::InvalidDataError] If newvalue is not a String
         #
         # @return [void]
         def CUPS_name=(newvalue)
 
-            raise JSS::InvalidDataError, "CUPS_name must be a string." unless newvalue.is_a? String
+            raise Jamf::InvalidDataError, "CUPS_name must be a string." unless newvalue.is_a? String
 
             @CUPS_name = newvalue
 
@@ -188,12 +188,12 @@ module JSS
         #
         # @param newvalue [String]
         #
-        # @raise [JSS::InvalidDataError] If newvalue is not a String
+        # @raise [Jamf::InvalidDataError] If newvalue is not a String
         #
         # @return [void]
         def location=(newvalue)
 
-            raise JSS::InvalidDataError, "location must be a string." unless newvalue.is_a? String
+            raise Jamf::InvalidDataError, "location must be a string." unless newvalue.is_a? String
 
             @location = newvalue
 
@@ -207,12 +207,12 @@ module JSS
         #
         # @param newvalue [String]
         #
-        # @raise [JSS::InvalidDataError] If newvalue is not a String
+        # @raise [Jamf::InvalidDataError] If newvalue is not a String
         #
         # @return [void]
         def model=(newvalue)
 
-            raise JSS::InvalidDataError, "model must be a string." unless newvalue.is_a? String
+            raise Jamf::InvalidDataError, "model must be a string." unless newvalue.is_a? String
 
             @model = newvalue
 
@@ -226,12 +226,12 @@ module JSS
         #
         # @param newvalue [Boolean]
         #
-        # @raise [JSS::InvalidDataError] If newvalue is not a Boolean
+        # @raise [Jamf::InvalidDataError] If newvalue is not a Boolean
         #
         # @return [void]
         def shared=(newvalue)
 
-            raise JSS::InvalidDataError, "shared must be a string." unless newvalue.is_a?(TrueClass) || newvalue.is_a?(FalseClass)
+            raise Jamf::InvalidDataError, "shared must be a string." unless newvalue.is_a?(TrueClass) || newvalue.is_a?(FalseClass)
 
             @shared = newvalue
 
@@ -245,12 +245,12 @@ module JSS
         #
         # @param newvalue [String]
         #
-        # @raise [JSS::InvalidDataError] If newvalue is not a String
+        # @raise [Jamf::InvalidDataError] If newvalue is not a String
         #
         # @return [void]
         def info=(newvalue)
 
-            raise JSS::InvalidDataError, "info must be a string." unless newvalue.is_a? String
+            raise Jamf::InvalidDataError, "info must be a string." unless newvalue.is_a? String
 
             @info = newvalue
 
@@ -264,12 +264,12 @@ module JSS
         #
         # @param newvalue [String]
         #
-        # @raise [JSS::InvalidDataError] If newvalue is not a String
+        # @raise [Jamf::InvalidDataError] If newvalue is not a String
         #
         # @return [void]
         def notes=(newvalue)
 
-            raise JSS::InvalidDataError, "notes must be a string." unless newvalue.is_a? String
+            raise Jamf::InvalidDataError, "notes must be a string." unless newvalue.is_a? String
 
             @notes = newvalue
 
@@ -283,12 +283,12 @@ module JSS
         #
         # @param newvalue [Boolean]
         #
-        # @raise [JSS::InvalidDataError] If newvalue is not a Boolean
+        # @raise [Jamf::InvalidDataError] If newvalue is not a Boolean
         #
         # @return [void]
         def make_default=(newvalue)
 
-            raise JSS::InvalidDataError, "make_default must be a string." unless newvalue.is_a?(TrueClass) || newvalue.is_a?(FalseClass)
+            raise Jamf::InvalidDataError, "make_default must be a string." unless newvalue.is_a?(TrueClass) || newvalue.is_a?(FalseClass)
 
             @make_default = newvalue
 
@@ -302,12 +302,12 @@ module JSS
         #
         # @param newvalue [Boolean]
         #
-        # @raise [JSS::InvalidDataError] If newvalue is not a Boolean
+        # @raise [Jamf::InvalidDataError] If newvalue is not a Boolean
         #
         # @return [void]
         def use_generic=(newvalue)
 
-            raise JSS::InvalidDataError, "use_generic must be a string." unless newvalue.is_a?(TrueClass) || newvalue.is_a?(FalseClass)
+            raise Jamf::InvalidDataError, "use_generic must be a string." unless newvalue.is_a?(TrueClass) || newvalue.is_a?(FalseClass)
 
             @use_generic = newvalue
 
@@ -321,12 +321,12 @@ module JSS
         #
         # @param newvalue [String]
         #
-        # @raise [JSS::InvalidDataError] If newvalue is not a String
+        # @raise [Jamf::InvalidDataError] If newvalue is not a String
         #
         # @return [void]
         def ppd=(newvalue)
 
-            raise JSS::InvalidDataError, "ppd must be a string." unless newvalue.is_a? String
+            raise Jamf::InvalidDataError, "ppd must be a string." unless newvalue.is_a? String
 
             @ppd = newvalue
 
@@ -340,12 +340,12 @@ module JSS
         #
         # @param newvalue [String]
         #
-        # @raise [JSS::InvalidDataError] If newvalue is not a String
+        # @raise [Jamf::InvalidDataError] If newvalue is not a String
         #
         # @return [void]
         def ppd_contents=(newvalue)
 
-            raise JSS::InvalidDataError, "ppd_contents must be a string." unless newvalue.is_a? String
+            raise Jamf::InvalidDataError, "ppd_contents must be a string." unless newvalue.is_a? String
 
             @ppd_contents = newvalue
 
@@ -359,12 +359,12 @@ module JSS
         #
         # @param newvalue [String]
         #
-        # @raise [JSS::InvalidDataError] If newvalue is not a String
+        # @raise [Jamf::InvalidDataError] If newvalue is not a String
         #
         # @return [void]
         def ppd_path=(newvalue)
 
-            raise JSS::InvalidDataError, "ppd_path must be a string." unless newvalue.is_a? String
+            raise Jamf::InvalidDataError, "ppd_path must be a string." unless newvalue.is_a? String
 
             @ppd_path = newvalue
 
@@ -378,7 +378,7 @@ module JSS
         #
         # @param newvalue [String, Float, Array[String], Array[Float]]
         #
-        # @raise [JSS::InvalidDataError] If newvalue is not a String, Float, Array containing Strings, or Array containing Floats.
+        # @raise [Jamf::InvalidDataError] If newvalue is not a String, Float, Array containing Strings, or Array containing Floats.
         #
         # @example Limit Printer object to only High Sierra devices and Mojave 10.14.5 OS versions
         #   printer.os_requirements = "10.13.x, 10.14.5"
@@ -388,12 +388,12 @@ module JSS
 
             if newvalue.is_a? Array
                 # Parse Array
-                raise JSS::InvalidDataError, "If setting os_requirements with an array, it must contain strings or floats." unless newvalue[0].is_a?(String) || newvalue[0].is_a?(Float)
+                raise Jamf::InvalidDataError, "If setting os_requirements with an array, it must contain strings or floats." unless newvalue[0].is_a?(String) || newvalue[0].is_a?(Float)
                 newvalue = newvalue.map { |x| x.to_s }.join(',')
             else
-                raise JSS::InvalidDataError, "os_requirements must either be a string, float, or an array containing strings or floats." unless (newvalue.is_a?(String) || newvalue.is_a?(Float)) && !newvalue.nil?
+                raise Jamf::InvalidDataError, "os_requirements must either be a string, float, or an array containing strings or floats." unless (newvalue.is_a?(String) || newvalue.is_a?(Float)) && !newvalue.nil?
             end
-                
+
             @os_requirements = newvalue
 
             @need_to_update = true

data/lib/{jss/api_object → jamf/api/classic/api_objects}/purchasable.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
 
   #####################################
   ### Module Variables
@@ -140,7 +140,7 @@ module JSS
 
     ### @return [void]
     def lease_expires= (date)
-      parsed_date = JSS.parse_datetime date
+      parsed_date = Jamf.parse_time date
       return nil if @lease_expires == parsed_date
       @lease_expires = parsed_date
       @need_to_update = true
@@ -176,7 +176,7 @@ module JSS
 
     ### @return [void]
     def po_date= (date)
-      parsed_date = JSS.parse_datetime date
+      parsed_date = Jamf.parse_time date
       return nil if @po_date == parsed_date
       @po_date = parsed_date
       @need_to_update = true
@@ -205,7 +205,7 @@ module JSS
 
     ### @return [void]
     def warranty_expires= (date)
-      parsed_date = JSS.parse_datetime date
+      parsed_date = Jamf.parse_time date
       return nil if @warranty_expires == parsed_date
       @warranty_expires = parsed_date
       @need_to_update = true
@@ -312,4 +312,4 @@ module JSS
     alias purchased? is_purchased
 
   end # module Purchasable
-end # module JSS
+end # module Jamf

data/lib/{jss/api_object → jamf/api/classic/api_objects}/removable_macaddr.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
 
   #####################################
   ### Module Variables
@@ -43,15 +43,15 @@ module JSS
   ###
   ### These are simple, in that they only have an ID and a name
   ###
-  ### @see JSS::APIObject
+  ### @see Jamf::APIObject
   ###
-  class RemovableMacAddress  < JSS::APIObject
+  class RemovableMacAddress  < Jamf::APIObject
 
     #####################################
     ### Mix-Ins
     #####################################
-    include JSS::Creatable
-    include JSS::Updatable
+    include Jamf::Creatable
+    include Jamf::Updatable
 
     #####################################
     ### Class Methods
@@ -86,7 +86,7 @@ module JSS
     #####################################
 
     ###
-    ### See JSS::APIObject#initialize
+    ### See Jamf::APIObject#initialize
     ###
 
     #####################################

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

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -22,20 +22,20 @@
 ###    language governing permissions and limitations under the Apache License.
 ###
 
-module JSS
+module Jamf
 
   # Restricted Software items in the JSS.
   #
-  # @see JSS::APIObject
+  # @see Jamf::APIObject
   #
-  class RestrictedSoftware < JSS::APIObject
+  class RestrictedSoftware < Jamf::APIObject
 
     # Mix-Ins
     #####################################
-    include JSS::Updatable
-    include JSS::Creatable
-    include JSS::Scopable
-    include JSS::Sitable
+    include Jamf::Updatable
+    include Jamf::Creatable
+    include Jamf::Scopable
+    include Jamf::Sitable
 
     # Class Constants
     #####################################
@@ -88,8 +88,8 @@ module JSS
     # Instance Methods
     #####################################
 
-    def initialize(args = {})
-      super args
+    def initialize(**args)
+      super
 
       @init_data[:general] ||= {}
       @process_name = @init_data[:general][:process_name]
@@ -98,9 +98,9 @@ module JSS
       @kill_process = @init_data[:general][:kill_process]
       @delete_executable = @init_data[:general][:delete_executable]
       @display_message = @init_data[:general][:display_message]
-      @site = JSS::APIObject.get_name(@init_data[:general][:site])
+      @site = Jamf::APIObject.get_name(@init_data[:general][:site])
       @site ||= 'None'
-      @scope ||= JSS::Scopable::Scope.new SCOPE_TARGET_KEY, nil
+      @scope ||= Jamf::Scopable::Scope.new SCOPE_TARGET_KEY, nil
     end # init
 
     def process_name=(new_val)
@@ -139,24 +139,24 @@ module JSS
 
     def site=(new_val)
       if new_val.is_a? Integer
-        raise JSS::NoSuchItemError, "No site found with id #{new_val}" unless JSS::Site.all_ids(api: @api).include? new_val
-        new_val = JSS::Site.map_all_ids_to(:name, api: @api)[new_val]
+        raise Jamf::NoSuchItemError, "No site found with id #{new_val}" unless Jamf::Site.all_ids(cnx: @cnx).include? new_val
+        new_val = Jamf::Site.map_all_ids_to(:name, cnx: @cnx)[new_val]
       else
         new_val = new_val.to_s
-        raise JSS::NoSuchItemError, "No site found with name #{new_val}" unless JSS::Site.all_names(api: @api).include? new_val
+        raise Jamf::NoSuchItemError, "No site found with name #{new_val}" unless Jamf::Site.all_names(cnx: @cnx).include? new_val
       end
       @site = new_val
       @need_to_update = true
     end
 
     def create
-      raise JSS::MissingDataError, 'process_name must be set before creating' if @process_name.to_s.empty?
-      raise JSS::AlreadyExistsError, "A #{RSRC_OBJECT_KEY} named #{@name} already exists in the JSS" if self.class.all_names(:refresh, api: @api).include? @name
+      raise Jamf::MissingDataError, 'process_name must be set before creating' if @process_name.to_s.empty?
+      raise Jamf::AlreadyExistsError, "A #{RSRC_OBJECT_KEY} named #{@name} already exists in the JSS" if self.class.all_names(:refresh, cnx: @cnx).include? @name
       super
     end
 
     def update
-      raise JSS::MissingDataError, 'process_name must be set before updating' if @process_name.to_s.empty?
+      raise Jamf::MissingDataError, 'process_name must be set before updating' if @process_name.to_s.empty?
       super
     end
 
@@ -171,7 +171,7 @@ module JSS
     private
 
     def rest_xml
-      doc = REXML::Document.new 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'
@@ -187,15 +187,14 @@ module JSS
       site.add_element('name').text = @site
 
       obj << @scope.scope_xml
-      add_self_service_xml doc
       doc.to_s
     end # rest_xml
 
     # TODO: Move this into a Validators module
     def confirm_boolean(val)
-      raise JSS::InvalidDataError, 'Value must be boolean true or false' unless JSS::TRUE_FALSE.include? val
+      raise Jamf::InvalidDataError, 'Value must be boolean true or false' unless Jamf::TRUE_FALSE.include? val
     end
 
   end # class
 
-end # module JSS
+end # module Jamf