ruby-jss 4.1.1 → 4.2.0b2

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

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -43,7 +43,7 @@ module Jamf
   ###
   ### @see Jamf::APIObject
   ###
-  class Peripheral  < Jamf::APIObject
+  class Peripheral < Jamf::APIObject
 
     #####################################
     ### MixIns
@@ -65,7 +65,7 @@ module Jamf
     #####################################
 
     ### The base for REST resources of this class
-    RSRC_BASE = "peripherals"
+    RSRC_BASE = 'peripherals'
 
     ### the hash key used for the JSON list output of all objects in the JSS
     RSRC_LIST_KEY = :peripherals
@@ -100,11 +100,9 @@ module Jamf
     ### @return [String] the "bar code 1" value
     attr_reader :bar_code_1
 
-
     ### @return [String] the "bar code 2" value
     attr_reader :bar_code_2
 
-
     ### @return [Integer] the id number of the computer to which  this periph is connected
     attr_reader :computer_id
 
@@ -116,25 +114,26 @@ module Jamf
     ### @see APIObject
     ###
     def initialize(**args)
-
       ### periphs don't really have names, and the JSS module list method for
       ### periphs gives the computer_id as the name, so give it a temp
       ### name of "-1", which shouldn't ever exist in the JSS
-      args[:name] ||= "-1"
+      args[:name] ||= '-1'
 
       super
 
       if args[:id] == :new
-        raise Jamf::InvalidDataError, "New Peripherals must have a :type, which must be one of those defined in the JSS." unless args[:type]
+        raise Jamf::InvalidDataError, 'New Peripherals must have a :type, which must be one of those defined in the JSS.' unless args[:type]
+
         @type = args[:type]
         raise Jamf::InvalidDataError, "No peripheral type '#{@type}' in the JSS" unless Jamf::PeripheralType.all_names(:refresh, cnx: @cnx).include? @type
+
         @fields = {}
         @rest_rsrc = 'peripherals/id/-1'
-        @site = "None"
+        @site = 'None'
         return
       end
 
-      @type =  @init_data[:general][:type]
+      @type = @init_data[:general][:type]
       @site = Jamf::APIObject.get_name(@init_data[:general][:site])
       @bar_code_1 = @init_data[:general][:bar_code_1]
       @bar_code_2 = @init_data[:general][:bar_code_2]
@@ -142,15 +141,12 @@ module Jamf
 
       ### fill in the fields
       @fields = {}
-      @init_data[:general][:fields].each{|f| @fields[f[:name]] = f[:value] }
+      @init_data[:general][:fields].each { |f| @fields[f[:name]] = f[:value] }
 
       ### get the field defs for this PeriphType, omitting the leading nil
-      @field_defs ||= Jamf::PeripheralType.fetch(:name => @type).fields.compact
-
-
+      @field_defs ||= Jamf::PeripheralType.fetch(name: @type).fields.compact
     end # initialize
 
-
     ###
     ### reset the restrsrc after creation
     ###
@@ -165,7 +161,7 @@ module Jamf
     ###
     ### periphs don't have names
     ###
-    def name= (newname)
+    def name=(_newname)
       raise Jamf::UnsupportedError, "Peripherals don't have names."
     end
 
@@ -175,9 +171,7 @@ module Jamf
     ###   Each key is the fields name, as a String
     ###   and the value is the fields value, also as a String
     ###
-    def fields
-      @fields
-    end
+    attr_reader :fields
 
     ###
     ### Set the value of a field. It will be checked to ensure validity.
@@ -201,12 +195,11 @@ module Jamf
     ###
     ### @return [void]
     ###
-    def bar_code_1= (new_value)
-        @bar_code_1 = new_value
-        @need_to_update = true
+    def bar_code_1=(new_value)
+      @bar_code_1 = new_value
+      @need_to_update = true
     end
 
-
     ###
     ### Set the value of barcode 2
     ###
@@ -214,12 +207,11 @@ module Jamf
     ###
     ### @return [void]
     ###
-    def bar_code_2= (new_value)
-        @bar_code_2 = new_value
-        @need_to_update = true
+    def bar_code_2=(new_value)
+      @bar_code_2 = new_value
+      @need_to_update = true
     end
 
-
     ###
     ### Associate this peripheral with a computer.
     ###
@@ -230,15 +222,16 @@ module Jamf
     def associate(computer)
       if computer =~ /^d+$/
         raise Jamf::NoSuchItemError, "No computer in the JSS with id #{computer}" unless Jamf::Computer.all_ids(cnx: @cnx).include? computer
+
         @computer_id = computer
       else
         raise Jamf::NoSuchItemError, "No computer in the JSS with name #{computer}" unless Jamf::Computer.all_names(cnx: @cnx).include? computer
+
         @computer_id = Jamf::Computer.map_all_ids_to(:name, cnx: @cnx).invert[computer]
       end
       @need_to_update = true
     end
 
-
     ###
     ### Disassociate this peripheral from any computer.
     ###
@@ -252,7 +245,6 @@ module Jamf
       @need_to_update = true
     end
 
-
     #################################
     ### Private Methods below here
     private
@@ -266,20 +258,22 @@ module Jamf
     ###
     def check_field(field, value)
       ### get the field defs for this PeriphType, omitting the leading nil
-      @field_defs ||= Jamf::PeripheralType.fetch(:name => @type, cnx: @cnx).fields.compact
+      @field_defs ||= Jamf::PeripheralType.fetch(name: @type, cnx: @cnx).fields.compact
 
       ### we must have the right number of fields, and they must have the same names
       ### as the definition
-      required_fields = @field_defs.map{|f| f[:name]}
-      raise Jamf::InvalidDataError, "Peripherals of type '#{@type}' doesn't have a field '#{field}', they only have: #{required_fields.join(', ')}" unless required_fields.include? field
+      required_fields = @field_defs.map { |f| f[:name] }
+      unless required_fields.include? field
+        raise Jamf::InvalidDataError, 
+              "Peripherals of type '#{@type}' doesn't have a field '#{field}', they only have: #{required_fields.join(', ')}"
+      end
 
       ### any menu fields can only have values as defined by the type.
-      menu_flds = @field_defs.select{|f| f[:type] == "menu" }
+      menu_flds = @field_defs.select { |f| f[:type] == 'menu' }
       menu_flds.each do |mf|
         next unless mf[:name] == field
         raise Jamf::InvalidDataError, "The value for field '#{field}' must be one of: #{mf[:choices].join(', ')}" unless mf[:choices].include? value
-      end #if menu_flds.include? field
-
+      end # if menu_flds.include? field
     end # check fields
 
     ###
@@ -298,21 +292,17 @@ module Jamf
       general.add_element('computer_id').text = @computer_id
 
       fields = general.add_element('fields')
-      @fields.each do |n,v|
-        fld =  fields.add_element('field')
+      @fields.each do |n, v|
+        fld = fields.add_element('field')
         fld.add_element('name').text = n
         fld.add_element('value').text = v
       end
 
-      if has_location?
-        periph << location_xml
-      end
-      if has_purchasing?
-        periph << purchasing_xml
-      end
+      periph << location_xml if has_location?
+      periph << purchasing_xml if has_purchasing?
       add_site_to_xml doc
 
-      return doc.to_s
+      doc.to_s
     end # rest xml
 
     ### Aliases
@@ -330,4 +320,5 @@ module Jamf
     alias unassign disassociate
 
   end # class Peripheral
+
 end # module

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

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -42,7 +42,7 @@ module Jamf
   ###
   ### @see Jamf::APIObject
   ###
-  class PeripheralType  < Jamf::APIObject
+  class PeripheralType < Jamf::APIObject
 
     #####################################
     ### MixIns
@@ -60,7 +60,7 @@ module Jamf
     #####################################
 
     ### The base for REST resources of this class
-    RSRC_BASE = "peripheraltypes"
+    RSRC_BASE = 'peripheraltypes'
 
     ### the hash key used for the JSON list output of all objects in the JSS
     RSRC_LIST_KEY = :peripheral_types
@@ -69,9 +69,8 @@ module Jamf
     ### It's also used in various error messages
     RSRC_OBJECT_KEY = :peripheral_type
 
-
     ### field types can be one of these, either String or Symbol
-    FIELD_TYPES = [:text, :menu]
+    FIELD_TYPES = %i[text menu]
 
     # the object type for this object in
     # the object history table.
@@ -90,13 +89,13 @@ module Jamf
     ### Initialize
     ###
     def initialize(**args)
-
       super
 
       @fields = []
-      if @init_data[:fields]
-        @init_data[:fields].each{ |f|  @fields[f[:order]] = f }
-      end
+      return unless @init_data[:fields]
+
+      @init_data[:fields].each { |f| @fields[f[:order]] = f }
+      
     end # initialize
 
     ### The definitions of the fields stored for this peripheral type.
@@ -131,9 +130,7 @@ module Jamf
     ###
     ### @return [Array<Hash>] The field definitions
     ###
-    def fields
-      @fields
-    end
+    attr_reader :fields
 
     ###
     ### Replace the entire Array of field definitions.
@@ -144,12 +141,11 @@ module Jamf
     ###
     ### @return [void]
     ###
-    def fields= (new_fields)
-      unless new_fields.kind_of? Array and  new_fields.reject{|c| c.kind_of? Hash }.empty?
-        raise Jamf::InvalidDataError, "Argument must be an Array of Hashes."
-      end
-      raise "A peripheral type can have a maximmum of 20 fields"  if new_fields.count > 20
-      new_fields.each{ |f| field_ok? f }
+    def fields=(new_fields)
+      raise Jamf::InvalidDataError, 'Argument must be an Array of Hashes.' unless new_fields.is_a? Array and new_fields.reject { |c| c.is_a? Hash }.empty?
+      raise 'A peripheral type can have a maximmum of 20 fields' if new_fields.count > 20
+
+      new_fields.each { |f| field_ok? f }
       @fields = new_fields
       order_fields
       @need_to_update = true
@@ -169,6 +165,7 @@ module Jamf
     ###
     def set_field(order, **field)
       raise Jamf::NoSuchItemError, "No field with number '#{order}'. Use #append_field, #prepend_field, or #insert_field" unless @fields[order]
+
       field_ok? field
       @fields[order] = field
       @need_to_update = true
@@ -213,7 +210,7 @@ module Jamf
     ###
     def insert_field(order, **field)
       field_ok? field
-      @fields.insert((order -1), field)
+      @fields.insert((order - 1), field)
       order_fields
       @need_to_update = true
     end
@@ -226,15 +223,14 @@ module Jamf
     ### @return [void]
     ###
     def delete_field(order)
-      if @fields[order]
-        raise Jamf::MissingDataError, "Fields can't be empty" if @fields.count == 1
-        @fields.delete_at index
-        order_fields
-        @need_to_update = true
-      end
-    end
-
+      return unless @fields[order]
+      raise Jamf::MissingDataError, "Fields can't be empty" if @fields.count == 1
 
+      @fields.delete_at index
+      order_fields
+      @need_to_update = true
+      
+    end
 
     ##############################
     ### private methods
@@ -246,13 +242,13 @@ module Jamf
     ### Return true or raise an exception
     ###
     def field_ok?(field)
-      raise Jamf::InvalidDataError, "Field elements must be hashes with :name, :type, and possibly :choices" unless field.kind_of? Hash
-      raise Jamf::InvalidDataError, "Fields require names" if field[:name].to_s.empty?
+      raise Jamf::InvalidDataError, 'Field elements must be hashes with :name, :type, and possibly :choices' unless field.is_a? Hash
+      raise Jamf::InvalidDataError, 'Fields require names' if field[:name].to_s.empty?
       raise Jamf::InvalidDataError, "Fields :type must be one of: :#{FIELD_TYPES.join(', :')}" unless FIELD_TYPES.include? field[:type].to_sym
 
       if field[:type].to_sym == :menu
-        unless field[:choices].kind_of? Array and  field[:choices].reject{|c| c.kind_of? String}.empty?
-          raise Jamf::InvalidDataError, "Choices for menu fields must be an Array of Strings"
+        unless field[:choices].is_a? Array and field[:choices].reject { |c| c.is_a? String }.empty?
+          raise Jamf::InvalidDataError, 'Choices for menu fields must be an Array of Strings'
         end # unless
       else
         field[:choices] = []
@@ -265,11 +261,10 @@ module Jamf
     ###
     def order_fields
       @fields.compact!
-      @fields.each_index{|i| @fields[i][:order] = i+1}
+      @fields.each_index { |i| @fields[i][:order] = i + 1 }
       @fields.unshift nil
     end
 
-
     ###
     ###
     ###
@@ -281,19 +276,18 @@ module Jamf
       pkg.add_element('name').text = @name
       fields = pkg.add_element 'fields'
 
-      flds =  @fields.compact
+      flds = @fields.compact
       flds.each_index do |i|
         field = fields.add_element 'field'
-        field.add_element('order').text =flds[i][:order]
+        field.add_element('order').text = flds[i][:order]
         field.add_element('name').text = flds[i][:name]
         field.add_element('type').text = flds[i][:type].to_s
         choices = field.add_element('choices')
-        unless flds[i][:choices].empty?
-          flds[i][:choices].each{|c| choices.add_element('choice').text = c}
-        end
+        flds[i][:choices].each { |c| choices.add_element('choice').text = c } unless flds[i][:choices].empty?
       end # each index do i
-      return doc.to_s
+      doc.to_s
     end # rest xml
 
   end # class Peripheral
+
 end # module

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

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

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

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -70,7 +70,7 @@ module Jamf
 
     PURCHASABLE = true
 
-    SUBSET_PURCH = "Purchasing"
+    SUBSET_PURCH = 'Purchasing'
 
     #####################################
     ###  Variables
@@ -116,118 +116,125 @@ module Jamf
     ### @return [Time]
     attr_reader :warranty_expires
 
-
     #####################################
     ###  Mixed-in Instance Methods
     #####################################
 
-
-
-
     ### @return [void]
-    def applecare_id= (new_val)
+    def applecare_id=(new_val)
       return nil if @applecare_id == new_val
+
       @applecare_id = new_val
       @need_to_update = true
     end
 
     ### @return [void]
-    def is_leased= (new_val)
+    def is_leased=(new_val)
       return nil if @is_leased == new_val
+
       @is_leased = new_val
       @need_to_update = true
     end
 
     ### @return [void]
-    def lease_expires= (date)
+    def lease_expires=(date)
       parsed_date = Jamf.parse_time date
       return nil if @lease_expires == parsed_date
+
       @lease_expires = parsed_date
       @need_to_update = true
     end
 
     ### @return [void]
-    def is_purchased= (new_val)
+    def is_purchased=(new_val)
       return nil if @is_purchased == new_val
+
       @is_purchased = new_val
       @need_to_update = true
     end
 
     ### @return [void]
-    def purchase_price= (new_val)
+    def purchase_price=(new_val)
       return nil if @purchase_price == new_val
+
       @purchase_price = new_val
       @need_to_update = true
     end
 
     ### @return [void]
-    def life_expectancy= (new_val)
+    def life_expectancy=(new_val)
       return nil if @life_expectancy == new_val
+
       @life_expectancy = new_val
       @need_to_update = true
     end
 
     ### @return [void]
-    def po_number= (new_val)
+    def po_number=(new_val)
       return nil if @po_number == new_val
+
       @po_number = new_val
       @need_to_update = true
     end
 
     ### @return [void]
-    def po_date= (date)
+    def po_date=(date)
       parsed_date = Jamf.parse_time date
       return nil if @po_date == parsed_date
+
       @po_date = parsed_date
       @need_to_update = true
     end
 
     ### @return [void]
-    def purchasing_account= (new_val)
+    def purchasing_account=(new_val)
       return nil if @purchasing_account == new_val
+
       @purchasing_account = new_val
       @need_to_update = true
     end
 
     ### @return [void]
-    def purchasing_contact= (new_val)
+    def purchasing_contact=(new_val)
       return nil if @purchasing_contact == new_val
+
       @purchasing_contact = new_val
       @need_to_update = true
     end
 
     ### @return [void]
-    def vendor= (new_val)
+    def vendor=(new_val)
       return nil if @vendor == new_val
+
       @vendor = new_val
       @need_to_update = true
     end
 
     ### @return [void]
-    def warranty_expires= (date)
+    def warranty_expires=(date)
       parsed_date = Jamf.parse_time date
       return nil if @warranty_expires == parsed_date
+
       @warranty_expires = parsed_date
       @need_to_update = true
     end
 
-
     ###
     ### @return [Boolean] does this item have any purchasing info?
     ###
     def has_purchasing?
       @applecare_id or \
-      @is_leased or \
-      @is_purchased or \
-      @lease_expires or \
-      @life_expectancy or \
-      @po_date or \
-      @po_number or \
-      @purchase_price or \
-      @purchasing_account or \
-      @purchasing_contact or \
-      @vendor or \
-      @warranty_expires
+        @is_leased or \
+        @is_purchased or \
+        @lease_expires or \
+        @life_expectancy or \
+        @po_date or \
+        @po_number or \
+        @purchase_price or \
+        @purchasing_account or \
+        @purchasing_contact or \
+        @vendor or \
+        @warranty_expires
     end
 
     ###
@@ -239,18 +246,18 @@ module Jamf
     ###
     def purchasing
       {
-        :applecare_id => @applecare_id,
-        :is_leased => @is_leased,
-        :is_purchased => @is_purchased,
-        :lease_expires => @lease_expires,
-        :life_expectancy => @life_expectancy,
-        :po_date => @po_date,
-        :po_number => @po_number,
-        :purchase_price => @purchase_price,
-        :purchasing_account => @purchasing_account,
-        :purchasing_contact => @purchasing_contact,
-        :vendor => @vendor,
-        :warranty_expires => @warranty_expires,
+        applecare_id: @applecare_id,
+        is_leased: @is_leased,
+        is_purchased: @is_purchased,
+        lease_expires: @lease_expires,
+        life_expectancy: @life_expectancy,
+        po_date: @po_date,
+        po_number: @po_number,
+        purchase_price: @purchase_price,
+        purchasing_account: @purchasing_account,
+        purchasing_contact: @purchasing_contact,
+        vendor: @vendor,
+        warranty_expires: @warranty_expires
       }
     end
 
@@ -267,9 +274,9 @@ module Jamf
 
       @purchasing = @init_data[:purchasing]
 
-      @lease_expires = JSS.epoch_to_time  @purchasing[:lease_expires_epoch]
-      @po_date = JSS.epoch_to_time  @purchasing[:po_date_epoch]
-      @warranty_expires = JSS.epoch_to_time  @purchasing[:warranty_expires_epoch]
+      @lease_expires = JSS.epoch_to_time @purchasing[:lease_expires_epoch]
+      @po_date = JSS.epoch_to_time @purchasing[:po_date_epoch]
+      @warranty_expires = JSS.epoch_to_time @purchasing[:warranty_expires_epoch]
 
       @applecare_id = @purchasing[:applecare_id]
       @is_leased = @purchasing[:is_leased]
@@ -296,7 +303,7 @@ module Jamf
       purch.add_element('is_purchased').text = @is_purchased.to_s
       purch.add_element('lease_expires_epoch').text = @lease_expires ? @lease_expires.to_jss_epoch : nil
       # Note, life expectancy can't be an empty xml element, it must be zero if emtpy.
-      purch.add_element('life_expectancy').text = @life_expectancy ? @life_expectancy : 0
+      purch.add_element('life_expectancy').text = @life_expectancy || 0
       purch.add_element('po_date_epoch').text = @po_date ? @po_date.to_jss_epoch : nil
       purch.add_element('po_number').text = @po_number
       purch.add_element('purchase_price').text = @purchase_price
@@ -304,7 +311,7 @@ module Jamf
       purch.add_element('purchasing_contact').text = @purchasing_contact
       purch.add_element('vendor').text = @vendor
       purch.add_element('warranty_expires_epoch').text = @warranty_expires ? @warranty_expires.to_jss_epoch : nil
-      return purch
+      purch
     end
 
     ### Aliases
@@ -312,4 +319,5 @@ module Jamf
     alias purchased? is_purchased
 
   end # module Purchasable
+
 end # module Jamf

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

@@ -1,4 +1,4 @@
-### Copyright 2023 Pixar
+### Copyright 2025 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -45,7 +45,7 @@ module Jamf
   ###
   ### @see Jamf::APIObject
   ###
-  class RemovableMacAddress  < Jamf::APIObject
+  class RemovableMacAddress < Jamf::APIObject
 
     #####################################
     ### Mix-Ins
@@ -57,13 +57,12 @@ module Jamf
     ### Class Methods
     #####################################
 
-
     #####################################
     ### Class Constants
     #####################################
 
     ### The base for REST resources of this class
-    RSRC_BASE = "removablemacaddresses"
+    RSRC_BASE = 'removablemacaddresses'
 
     ### the hash key used for the JSON list output of all objects in the JSS
     RSRC_LIST_KEY = :removable_mac_addresses