ruby-jss 1.6.4 → 2.0.0b1

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

@@ -1,4 +1,4 @@
-# Copyright 2020 Pixar
+# 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
@@ -20,7 +20,7 @@
 #    KIND, either express or implied. See the Apache License for the specific
 #    language governing permissions and limitations under the Apache License.
 
-module JSS
+module Jamf
 
   # Classes
   #####################################
@@ -28,11 +28,11 @@ module JSS
 
   # An extension attribute as defined in the JSS
   #
-  # @see JSS::ExtensionAttribute
+  # @see Jamf::ExtensionAttribute
   #
-  # @see JSS::APIObject
+  # @see Jamf::APIObject
   #
-  class MobileDeviceExtensionAttribute < JSS::ExtensionAttribute
+  class MobileDeviceExtensionAttribute < Jamf::ExtensionAttribute
 
     # Class Constants
     #####################################
@@ -48,10 +48,10 @@ module JSS
     RSRC_OBJECT_KEY = :mobile_device_extension_attribute
 
     # these ext attribs are related to these kinds of objects
-    TARGET_CLASS = JSS::MobileDevice
+    TARGET_CLASS = Jamf::MobileDevice
 
     # A criterion that will return all members of the TARGET_CLASS
-    ALL_TARGETS_CRITERION = JSS::Criteriable::Criterion.new(and_or: 'and', name: 'Last Inventory Update', search_type: 'after (yyyy-mm-dd)', value: '2003-01-01')
+    ALL_TARGETS_CRITERION = Jamf::Criteriable::Criterion.new(and_or: 'and', name: 'Last Inventory Update', search_type: 'after (yyyy-mm-dd)', value: '2003-01-01')
 
     # the object type for this object in
     # the object history table.
@@ -61,18 +61,18 @@ module JSS
     # Public Instance Methods
     #####################################
 
-    # @see JSS::ExtensionAttribute#web_display=
+    # @see Jamf::ExtensionAttribute#web_display=
     #
     def web_display=(new_val)
-      raise JSS::InvalidDataError, "Mobile Device Extension Attributes web_display cannot be '#{WEB_DISPLAY_CHOICE_OS}'" if new_val == WEB_DISPLAY_CHOICE_OS
+      raise Jamf::InvalidDataError, "Mobile Device Extension Attributes web_display cannot be '#{WEB_DISPLAY_CHOICE_OS}'" if new_val == WEB_DISPLAY_CHOICE_OS
 
       super
     end # end web_display
 
-    # @see JSS::ExtensionAttribute#input_type=
+    # @see Jamf::ExtensionAttribute#input_type=
     #
     def input_type=(new_val)
-      raise JSS::InvalidDataError, "Mobile Device Extension Attribute input_type cannot be '#{INPUT_TYPE_SCRIPT}'" if new_val == INPUT_TYPE_SCRIPT
+      raise Jamf::InvalidDataError, "Mobile Device Extension Attribute input_type cannot be '#{INPUT_TYPE_SCRIPT}'" if new_val == INPUT_TYPE_SCRIPT
 
       super
     end # end input_type
@@ -83,20 +83,20 @@ module JSS
     # * :value - String, Integer, or Time, depending on @data_type
     # * :timestamp - Time
     #
-    # This method requires a MySQL database connection established via JSS::DB_CNX.connect
+    # This method requires a MySQL database connection established via Jamf::DB_CNX.connect
     #
-    # @see JSS::DBConnection
+    # @see Jamf::DBConnection
     #
     # @param mobiledevice[Integer,String] the id or name of the MobileDevice.
     #
     # @return [Array<Hash{:timestamp=>Time,:value=>String,Integer,Time}>]
     #
     def history(mobiledevice)
-      raise JSS::NoSuchItemError, "EA Not In JSS! Use #create to create this #{RSRC_OBJECT_KEY}." unless @in_jss
-      raise JSS::InvalidConnectionError, "Database connection required for 'history' query." unless JSS::DB_CNX.connected?
+      raise Jamf::NoSuchItemError, "EA Not In JSS! Use #create to create this #{RSRC_OBJECT_KEY}." unless @in_jss
+      raise Jamf::InvalidConnectionError, "Database connection required for 'history' query." unless Jamf::DB_CNX.connected?
 
-      mobile_device_id = JSS::MobileDevice.valid_id mobiledevice, api: @api
-      raise JSS::NoSuchItemError, "No MobileDevice found matching '#{mobiledevice}'" unless mobile_device_id
+      mobile_device_id = Jamf::MobileDevice.valid_id mobiledevice, cnx: @cnx
+      raise Jamf::NoSuchItemError, "No MobileDevice found matching '#{mobiledevice}'" unless mobile_device_id
 
       the_query = <<-END_Q
       SELECT eav.value_on_client AS value, r.date_entered_epoch AS timestamp_epoch
@@ -106,14 +106,14 @@ module JSS
       ORDER BY timestamp_epoch
       END_Q
 
-      qrez = JSS::DB_CNX.db.query the_query
+      qrez = Jamf::DB_CNX.db.query the_query
       history = []
       qrez.each_hash do |entry|
         value =
           case @data_type
           when 'String' then entry['value']
           when 'Integer' then entry['value'].to_i
-          when 'Date' then JSS.parse_datetime(entry['value'])
+          when 'Date' then Jamf.parse_time(entry['value'])
           end # case
         newhash = { value: value, timestamp: JSS.epoch_to_time(entry['timestamp_epoch']) }
         history << newhash

data/lib/{jss/api_object/group → jamf/api/classic/api_objects}/mobile_device_group.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 Constants
@@ -45,18 +45,18 @@ module JSS
   ###
   ### A Mobile Device group in the JSS
   ###
-  ### See also the parent class JSS::Group
+  ### See also the parent class Jamf::Group
   ###
-  ### @see JSS::APIObject
+  ### @see Jamf::APIObject
   ###
-  ### @see JSS::Group
+  ### @see Jamf::Group
   ###
-  class MobileDeviceGroup < JSS::Group
+  class MobileDeviceGroup < Jamf::Group
 
     #####################################
     ### Mix-Ins
     #####################################
-    include JSS::MDM
+    include Jamf::MDM
 
     #####################################
     ### Class Constants
@@ -73,7 +73,7 @@ module JSS
     RSRC_OBJECT_KEY = :mobile_device_group
 
     ### this allows the parent Group class to do things right
-    MEMBER_CLASS = JSS::MobileDevice
+    MEMBER_CLASS = Jamf::MobileDevice
 
     # the XML element for immediate member additions via PUT
     ADD_MEMBERS_ELEMENT = 'mobile_device_additions'.freeze

data/lib/{jss/api_object → jamf/api/classic/api_objects}/netboot_server.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
@@ -44,9 +44,9 @@ module JSS
   ###
   ### Only minimally implemented, mostly for access to the APIObject list methods
   ###
-  ### @see JSS::APIObject
+  ### @see Jamf::APIObject
   ###
-  class NetBootServer < JSS::APIObject
+  class NetBootServer < Jamf::APIObject
 
     #####################################
     ### Mix-Ins
@@ -121,10 +121,10 @@ module JSS
     #####################################
 
     ###
-    ### See JSS::APIObject#initialize
+    ### See Jamf::APIObject#initialize
     ###
 
-    def initialize (args = {})
+    def initialize(**args)
       super
       @boot_args = @init_data[:boot_args]
       @boot_device = @init_data[:boot_device]

data/lib/{jss/api_object → jamf/api/classic/api_objects}/network_segment.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
   #####################################
@@ -38,12 +38,12 @@ module JSS
   ### A Network Segment in the JSS
   ###
   ###
-  class NetworkSegment < JSS::APIObject
+  class NetworkSegment < Jamf::APIObject
 
     ### Mix Ins
     #####################################
-    include JSS::Creatable
-    include JSS::Updatable
+    include Jamf::Creatable
+    include Jamf::Updatable
     include Comparable
 
     ### Class Constants
@@ -87,17 +87,19 @@ module JSS
     #
     # @param refresh[Boolean] should the data be re-queried?
     #
-    # @param api[JSS::APIConnection] the API to query
+    # @param cnx [Jamf::Connection] the API to query
     #
     # @return [Hash{Integer => Range}] the network segments as IPv4 address Ranges
     #   keyed by id
     #
-    def self.network_ranges(refresh = false, api: JSS.api)
+    def self.network_ranges(refresh = false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
       @network_ranges = nil if refresh
       return @network_ranges if @network_ranges
 
       @network_ranges = {}
-      all(refresh, api: api).each do |ns|
+      all(refresh, cnx: cnx).each do |ns|
         @network_ranges[ns[:id]] = IPAddr.new(ns[:starting_address])..IPAddr.new(ns[:ending_address])
       end
       @network_ranges
@@ -115,17 +117,19 @@ module JSS
     #
     # @param refresh[Boolean] should the data be re-queried?
     #
-    # @param api[JSS::APIConnection] the APIConnection to query
+    # @param cnx [Jamf::Connection] the APIConnection to query
     #
     # @return [Hash{Integer => Range}] the network segments as Integer Ranges
     #   keyed by id
     #
-    def self.network_ranges_as_integers(refresh = false, api: JSS.api)
+    def self.network_ranges_as_integers(refresh = false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
       @network_ranges_as_integers = nil if refresh
       return @network_ranges_as_integers if @network_ranges_as_integers
 
       @network_ranges_as_integers = {}
-      all(refresh, api: api).each do |ns|
+      all(refresh, cnx: cnx).each do |ns|
         first = IPAddr.new(ns[:starting_address]).to_i
         last = IPAddr.new(ns[:ending_address]).to_i
         @network_ranges_as_integers[ns[:id]] = first..last
@@ -139,8 +143,10 @@ module JSS
     ###
     ### @see {NetworkSegment::network_ranges}
     ###
-    def self.subnets(refresh = false, api: JSS.api)
-      network_ranges refresh, api: api
+    def self.subnets(refresh = false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
+      network_ranges refresh, cnx: cnx
     end
 
     ### Given a starting address & ending address, mask, or cidr,
@@ -181,7 +187,7 @@ module JSS
     ### @return [Range<IPAddr>] the valid Range
     ###
     def self.ip_range(starting_address: nil, ending_address: nil, mask: nil, cidr: nil)
-      raise JSS::MissingDataError, 'starting_address: must be provided' unless starting_address
+      raise Jamf::MissingDataError, 'starting_address: must be provided' unless starting_address
 
       starting_address = masked_starting_address(starting_address: starting_address, mask: mask, cidr: cidr)
 
@@ -227,7 +233,7 @@ module JSS
     def self.validate_ip_range(startip, endip)
       return nil if IPAddr.new(startip.to_s) <= IPAddr.new(endip.to_s)
 
-      raise JSS::InvalidDataError, "Starting IP #{startip} is higher than ending ip #{endip} "
+      raise Jamf::InvalidDataError, "Starting IP #{startip} is higher than ending ip #{endip} "
     end
 
     ### Find the ids of the network segments that contain a given IP address.
@@ -240,15 +246,17 @@ module JSS
     ###
     ### @param refresh[Boolean] should the data be re-queried?
     ###
-    ### @param api[JSS::APIConnection] The API connection to query
+    ### @param cnx [Jamf::Connection] The API connection to query
     ###
     ### @return [Array<Integer>] the ids of the NetworkSegments containing the given ip
     ###
-    def self.network_segments_for_ip(ipaddr, refresh = false, api: JSS.api)
+    def self.network_segments_for_ip(ipaddr, refresh = false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
       # get the ip as a 32bit interger
       ip = IPAddr.new(ipaddr.to_s).to_i
       # a hash of NetSeg ids => Range<Integer>
-      network_ranges_as_integers(refresh, api: api).select { |_id, range| range.include? ip }.keys
+      network_ranges_as_integers(refresh, cnx: cnx).select { |_id, range| range.include? ip }.keys
     end
 
     # Which network segment is seen as current for a given IP addr?
@@ -262,11 +270,13 @@ module JSS
     #
     # @return [Integer, nil] the id of the current net segment, or nil
     #
-    def self.network_segment_for_ip(ipaddr, refresh: false, api: JSS.api)
+    def self.network_segment_for_ip(ipaddr, refresh: false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
       # get the ip as a 32bit interger
       ip = IPAddr.new(ipaddr.to_s).to_i
       # a hash of NetSeg ids => Range<Integer>
-      ranges = network_ranges_as_integers(refresh, api: api).select { |_id, range| range.include? ip }
+      ranges = network_ranges_as_integers(refresh, cnx: cnx).select { |_id, range| range.include? ip }
 
       # we got nuttin
       return nil if ranges.empty?
@@ -310,11 +320,13 @@ module JSS
     #
     # @return [Array<Integer>,Array<String>] the NetworkSegment ids or names for this machine right now.
     #
-    def self.my_network_segments(refresh = false, names: false, api: JSS.api)
-      ids = network_segments_for_ip JSS::Client.my_ip_address, refresh, api: api
+    def self.my_network_segments(refresh = false, names: false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
+      ids = network_segments_for_ip Jamf::Client.my_ip_address, refresh, cnx: cnx
       return ids unless names
 
-      ids_to_names = map_all_ids_to :name
+      ids_to_names = map_all_ids_to :name, cnx: cnx
       ids.map { |id| ids_to_names[id] }
     end
 
@@ -326,14 +338,16 @@ module JSS
     # @param name [Boolean] return the name of the netsegment, not the id
     #
     # @return [Integer, String, nil] the id of the current net segment, or nil
-    def self.my_network_segment(refresh = false, name: false, api: JSS.api)
-      my_ip = JSS::Client.my_ip_address
+    def self.my_network_segment(refresh = false, name: false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
+      my_ip = Jamf::Client.my_ip_address
       return nil unless my_ip
 
-      id = network_segment_for_ip(my_ip, refresh: refresh, api: api)
+      id = network_segment_for_ip(my_ip, refresh: refresh, cnx: cnx)
       return id unless name
 
-      map_all_ids_to(:name)[id]
+      map_all_ids_to(:name, cnx: cnx)[id]
     end
 
     ### Attributes
@@ -371,11 +385,11 @@ module JSS
 
     ### Instantiate a NetworkSegment
     ###
-    ### @see_also JSS::NetworkSegment.ip_range for how starting and ending
+    ### @see_also Jamf::NetworkSegment.ip_range for how starting and ending
     ### addresses can be provided when using id: :new
     ###
-    def initialize(args = {})
-      super args
+    def initialize(**args)
+      super
 
       if args[:id] == :new
         range = self.class.ip_range(
@@ -412,13 +426,13 @@ module JSS
 
     ### Does this network segment overlap with another?
     ###
-    ### @param other_segment[JSS::NetworkSegment] the other segment to check
+    ### @param other_segment[Jamf::NetworkSegment] the other segment to check
     ###
     ### @return [Boolean] Does the other segment overlap this one?
     ###
     def overlap?(other_segment)
-      raise TypeError, 'Argument must be a JSS::NetworkSegment' unless \
-        other_segment.is_a? JSS::NetworkSegment
+      raise TypeError, 'Argument must be a Jamf::NetworkSegment' unless \
+        other_segment.is_a? Jamf::NetworkSegment
       other_range = other_segment.range
       range.include?(other_range.begin) || range.include?(other_range.end)
     end
@@ -426,12 +440,12 @@ module JSS
     ### Does this network segment include an address or another segment?
     ### Inclusion means the other is completely inside this one.
     ###
-    ### @param thing[JSS::NetworkSegment, String, IPAddr] the other thing to check
+    ### @param thing[Jamf::NetworkSegment, String, IPAddr] the other thing to check
     ###
     ### @return [Boolean] Does this segment include the other?
     ###
     def include?(thing)
-      if thing.is_a? JSS::NetworkSegment
+      if thing.is_a? Jamf::NetworkSegment
         @starting_address <= thing.range.begin && @ending_address >= thing.range.end
       else
         thing = IPAddr.new thing.to_s
@@ -443,13 +457,13 @@ module JSS
     ### Does this network segment equal another?
     ### equality means the ranges are equal
     ###
-    ### @param other_segment[JSS::NetworkSegment] the other segment to check
+    ### @param other_segment[Jamf::NetworkSegment] the other segment to check
     ###
     ### @return [Boolean] Does this segment include the other?
     ###
     def ==(other)
-      raise TypeError, 'Argument must be a JSS::NetworkSegment' unless \
-        other.is_a? JSS::NetworkSegment
+      raise TypeError, 'Argument must be a Jamf::NetworkSegment' unless \
+        other.is_a? Jamf::NetworkSegment
       range == other.range
     end
 
@@ -462,12 +476,12 @@ module JSS
     def building=(newval)
       new =
         if newval.to_s.empty?
-          JSS::BLANK
+          Jamf::BLANK
         else
-          id = JSS::Building.valid_id newval
-          raise JSS::MissingDataError, "No building matching '#{newval}'" unless id
+          id = Jamf::Building.valid_id newval
+          raise Jamf::MissingDataError, "No building matching '#{newval}'" unless id
 
-          JSS::Building.map_all_ids_to(:name)[id]
+          Jamf::Building.map_all_ids_to(:name)[id]
         end
 
       @building = new
@@ -481,7 +495,7 @@ module JSS
     ### @return [void]
     ###
     def override_buildings=(newval)
-      raise JSS::InvalidDataError, 'New value must be boolean true or false' unless JSS::TRUE_FALSE.include? newval
+      raise Jamf::InvalidDataError, 'New value must be boolean true or false' unless Jamf::TRUE_FALSE.include? newval
       @override_buildings = newval
       @need_to_update = true
     end
@@ -495,12 +509,12 @@ module JSS
     def department=(newval)
       new =
         if newval.to_s.empty?
-          JSS::BLANK
+          Jamf::BLANK
         else
-          id = JSS::Department.valid_id newval
-          raise JSS::MissingDataError , "No department matching '#{newval}' in the JSS" unless id
+          id = Jamf::Department.valid_id newval
+          raise Jamf::MissingDataError , "No department matching '#{newval}' in the JSS" unless id
 
-          JSS::Department.map_all_ids_to(:name)[id]
+          Jamf::Department.map_all_ids_to(:name)[id]
         end
       @department = new
       @need_to_update = true
@@ -514,7 +528,7 @@ module JSS
     ###
     ###
     def override_departments=(newval)
-      raise JSS::InvalidDataError, 'New value must be boolean true or false' unless JSS::TRUE_FALSE.include? newval
+      raise Jamf::InvalidDataError, 'New value must be boolean true or false' unless Jamf::TRUE_FALSE.include? newval
       @override_departments = newval
       @need_to_update = true
     end
@@ -528,12 +542,12 @@ module JSS
     def distribution_point=(newval)
       new =
         if newval.to_s.empty?
-          JSS::BLANK
+          Jamf::BLANK
         else
-          id = JSS::DistributionPoint.valid_id newval
-          raise JSS::MissingDataError, "No distribution_point matching '#{newval}' in the JSS" unless id
+          id = Jamf::DistributionPoint.valid_id newval
+          raise Jamf::MissingDataError, "No distribution_point matching '#{newval}' in the JSS" unless id
 
-          JSS::DistributionPoint.map_all_ids_to(:name)[id]
+          Jamf::DistributionPoint.map_all_ids_to(:name)[id]
         end
 
       @distribution_point = new
@@ -549,12 +563,12 @@ module JSS
     def netboot_server=(newval)
       new =
         if newval.to_s.empty?
-          JSS::BLANK
+          Jamf::BLANK
         else
-          id = JSS::NetBootServer.valid_id newval
-          raise JSS::MissingDataError, "No netboot_server matching '#{newval}' in the JSS" unless id
+          id = Jamf::NetBootServer.valid_id newval
+          raise Jamf::MissingDataError, "No netboot_server matching '#{newval}' in the JSS" unless id
 
-          JSS::NetbootServer.map_all_ids_to(:name)[id]
+          Jamf::NetbootServer.map_all_ids_to(:name)[id]
         end
 
       @netboot_server = new
@@ -570,12 +584,12 @@ module JSS
     def swu_server=(newval)
       new =
         if newval.to_s.empty?
-          JSS::BLANK
+          Jamf::BLANK
         else
-          id = JSS::SoftwareUpdateServer.valid_id newval
-          raise JSS::MissingDataError, "No swu_server matching '#{newval}' in the JSS" unless id
+          id = Jamf::SoftwareUpdateServer.valid_id newval
+          raise Jamf::MissingDataError, "No swu_server matching '#{newval}' in the JSS" unless id
 
-          JSS::SoftwareUpdateServer.map_all_ids_to(:name)[id]
+          Jamf::SoftwareUpdateServer.map_all_ids_to(:name)[id]
         end
 
       @swu_server = new
@@ -661,7 +675,7 @@ module JSS
     ### the xml formated data for adding or updating this in the JSS
     ###
     def rest_xml
-      doc = REXML::Document.new APIConnection::XML_HEADER
+      doc = REXML::Document.new Jamf::Connection::XML_HEADER
       ns = doc.add_element 'network_segment'
       ns.add_element('building').text = @building
       ns.add_element('department').text = @department

data/lib/{jss/api_object/configuration_profile → jamf/api/classic/api_objects}/osx_configuration_profile.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
 
   # Classes
   ###################################
@@ -34,9 +34,9 @@ module JSS
   # Note that the profile payloads and the profile UUID cannot be edited or updated with this via this class.
   # Use the web UI.
   #
-  # @see JSS::APIObject
+  # @see Jamf::APIObject
   #
-  class OSXConfigurationProfile < JSS::ConfigurationProfile
+  class OSXConfigurationProfile < Jamf::ConfigurationProfile
 
     # Class Constants
     ###################################
@@ -77,9 +77,9 @@ module JSS
     # Constructor
     ###################################
 
-    # See JSS::APIObject#initialize
+    # See Jamf::APIObject#initialize
     #
-    def initialize(args = {})
+    def initialize(**args)
       super
       @level = @main_subset[:level]
     end
@@ -93,7 +93,7 @@ module JSS
     #
     def level=(new_val)
       return nil if @level == new_val
-      raise JSS::InvalidDataError, "New value must be one of '#{LEVELS.join("' '")}'" unless LEVELS.include? new_val
+      raise Jamf::InvalidDataError, "New value must be one of '#{LEVELS.join("' '")}'" unless LEVELS.include? new_val
       @level = new_val
       @need_to_update = true
     end #