ruby-jss 2.0.0a11 → 2.0.0b5

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

@@ -180,6 +180,7 @@ module Jamf
         info[:source_id] = info[:source_id].to_i
       end
       return data unless source_id
+
       data.select { |p| p[:source_id] == source_id }
     end
 
@@ -311,9 +312,11 @@ module Jamf
     # so all other lookup values have to be converted to ID before
     # the call to super
     #
-    def self.fetch(identifier = nil, **params)
-      # default api
-      api = params[:api] ? params[:api] : Jamf.cnx
+    def self.fetch(identifier = nil, **params)      
+      # default connection if unspecified
+      cnx = params.delete :cnx
+      cnx ||= params.delete :api # backward compatibility, deprecated
+      cnx ||= Jamf.cnx
 
       # source: and source_id: are considered the same, source_id: wins
       params[:source_id] ||= params[:source]
@@ -349,8 +352,8 @@ module Jamf
       cnx = api if api
 
       id = all_ids(refresh, cnx: cnx).include?(ident) ? ident : nil
-      id ||= map_all_ids_to(:source_name_id).invert[ident]
-      id ||= map_all_ids_to(:name).invert[ident]
+      id ||= map_all(:id, to: :source_name_id).invert[ident]
+      id ||= map_all(:id, to: :name).invert[ident]
       id
     end
 
@@ -376,7 +379,6 @@ module Jamf
     attr_reader :email_notification
     alias email_notification? email_notification
 
-    #
     def initialize(**args)
       super
 
@@ -421,11 +423,11 @@ module Jamf
     def versions
       return @versions unless in_jss
       return @versions unless @versions.empty?
+
       # if we are in jss, and versions is empty, re-fetch them
       @versions = self.class.fetch(id: id).versions
     end
 
-
     # @return [Hash] Subset of @versions, containing those which have packages
     #   assigned
     #
@@ -442,6 +444,7 @@ module Jamf
     def email_notification=(new_setting)
       return if email_notification == new_setting
       raise Jamf::InvalidDataError, 'New Setting must be boolean true or false' unless Jamf::TRUE_FALSE.include? @email_notification = new_setting
+
       @need_to_update = true
     end
 
@@ -454,6 +457,7 @@ module Jamf
     def web_notification=(new_setting)
       return if web_notification == new_setting
       raise Jamf::InvalidDataError, 'New Setting must be boolean true or false' unless Jamf::TRUE_FALSE.include? @web_notification = new_setting
+
       @need_to_update = true
     end
 
@@ -467,8 +471,8 @@ module Jamf
 
     # wrapper to fetch versions after creating
     def create
-      response = super
-      response
+      super
+      
     end
 
     # wrapper to clear @changed_pkgs after updating
@@ -535,6 +539,7 @@ module Jamf
         pkg = velem.add_element 'package'
         # leave am empty package element to remove the pkg assignement
         next if versions[vers].package_id == :none
+
         pkg.add_element('id').text = versions[vers].package_id.to_s
       end # do vers
     end

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

@@ -1425,29 +1425,21 @@ module Jamf
     #
     # @option [Symbol] priority: either :before or :after
     #
-    # @option [String] parameter4: the value of the 4th parameter passed to the script. this
-    #   overrides the same parameter in the script object itself.
+    # @option [String] parameter4: the value of the 4th parameter passed to the script.
     #
-    # @option [String] parameter5: the value of the 5th parameter passed to the script. this
-    #   overrides the same parameter in the script object itself.
+    # @option [String] parameter5: the value of the 5th parameter passed to the script.
     #
-    # @option [String] parameter6: the value of the 6th parameter passed to the script. this
-    #   overrides the same parameter in the script object itself.
+    # @option [String] parameter6: the value of the 6th parameter passed to the script.
     #
-    # @option [String] parameter7: the value of the 7th parameter passed to the script. this
-    #   overrides the same parameter in the script object itself.
+    # @option [String] parameter7: the value of the 7th parameter passed to the script.
     #
-    # @option [String] parameter8: the value of the 8th parameter passed to the script. this
-    #   overrides the same parameter in the script object itself.
+    # @option [String] parameter8: the value of the 8th parameter passed to the script.
     #
-    # @option [String] parameter9: the value of the 9th parameter passed to the script. this
-    #   overrides the same parameter in the script object itself.
+    # @option [String] parameter9: the value of the 9th parameter passed to the script.
     #
-    # @option [String] parameter10: the value of the 10th parameter passed to the script. this
-    #   overrides the same parameter in the script object itself.
+    # @option [String] parameter10: the value of the 10th parameter passed to the script.
     #
-    # @option [String] parameter11: the value of the 11th parameter passed to the script. this
-    #   overrides the same parameter in the script object itself.
+    # @option [String] parameter11: the value of the 11th parameter passed to the script.
     #
     # @return [Array, nil]  the new @scripts array, nil if script was already in the policy
     #
@@ -1643,7 +1635,6 @@ module Jamf
       @printers
     end
 
-
     # Remove a specific printer object from the policy.
     #
     # @author Tyler Morgan

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

@@ -389,7 +389,7 @@ module Jamf
       raise Jamf::MissingDataError, 'script_contents does not start with #!' unless @script_contents.to_s.start_with? '#!'
 
       opts[:target] ||= '/'
-      opts[:computer_name] ||= Jamf::Client.run_jamf('getComputerName')[/>(.)</, 1]
+      opts[:computer_name] ||= Jamf::Client.run_jamf('getComputerName')[/>(.*?)</, 1]
       opts[:username] ||= Jamf::Client.console_user
 
       params = [opts[:target], opts[:computer_name], opts[:username]]

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

@@ -189,7 +189,7 @@ module Jamf
       raise Jamf::InvalidDataError, 'Jamf::Criteriable::Criteria instance required' unless @criteria.is_a? Jamf::Criteriable::Criteria
       raise Jamf::InvalidDataError, 'display_fields must be an Array.' unless @display_fields.is_a? Array
 
-      orig_timeout = @cnx.cnx.options[:timeout]
+      orig_timeout = @cnx.timeout
       @cnx.timeout = 1800
       super()
       requery_search_results if get_results
@@ -207,7 +207,7 @@ module Jamf
     # @return [Integer] the id of the updated search
     #
     def update(get_results = false)
-      orig_timeout = @cnx.cnx.options[:timeout]
+      orig_timeout = @cnx.timeout
       @cnx.timeout = 1800
       super()
       requery_search_results if get_results
@@ -235,8 +235,8 @@ module Jamf
     # @return [Array<Hash>] the new search results
     #
     def requery_search_results
-      orig_open_timeout = @cnx.cnx.options[:open_timeout]
-      orig_timeout = @cnx.cnx.options[:timeout]
+      orig_open_timeout = @cnx.open_timeout
+      orig_timeout = @cnx.timeout
       @cnx.timeout = 1800
       @cnx.open_timeout = 1800
       begin

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

@@ -295,14 +295,13 @@ 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"
-
         if als == key
           # the all_ method - skip if defined in the class
-          next if singleton_methods.include? meth_name
+          next if singleton_methods.include? meth_name.to_sym
 
           define_singleton_method meth_name do |refresh = false, cached_list: nil, api: nil, cnx: Jamf.cnx|
             cnx = api if api
@@ -314,8 +313,9 @@ module Jamf
         else
           # an alias - skip if defined in the class
           als_name = als.to_s.end_with?('s') ? "all_#{als}es" : "all_#{als}s"
-          next if singleton_methods.include? als_name
 
+          next if singleton_methods.include? als_name.to_sym
+          
           define_singleton_method als_name do |refresh = false, api: nil, cnx: Jamf.cnx|
             cnx = api if api
             send meth_name, refresh, cnx: cnx
@@ -323,7 +323,8 @@ module Jamf
           Jamf.load_msg "Defined alias '#{als_name}' of #{self}##{meth_name}"
 
         end # if
-      end # lookup_keys.eachs
+      end # lookup_keys.each
+      
       true
     end # self.define_identifier_list_methods
 
@@ -534,7 +535,7 @@ module Jamf
           dups[obj[:name]] = 1
         end # if
       end # all(refresh, cnx: cnx).each
-      dups.delete_if { |k,v| v == 1 }
+      dups.delete_if { |_k, v| v == 1 }
       dups
     end
 
@@ -556,10 +557,11 @@ module Jamf
     #
     ######################################
     def self.map_all(ident, to:, cnx: Jamf.cnx, refresh: false, cached_list: nil)
+      orig_ident = ident
       ident = lookup_keys[ident]
-      raise Jamf::InvalidDataError, "No identifier :#{ident} for class #{self}" unless ident
+      raise Jamf::InvalidDataError, "No identifier :#{orig_ident} for class #{self}" unless ident
 
-      list = cached_list ? cached_list : all(refresh, cnx: cnx)
+      list = cached_list || all(refresh, cnx: cnx)
       mapped = list.map do |i|
         [
           i[ident],
@@ -660,7 +662,6 @@ module Jamf
       end
     end
 
-
     # Return the id of the object of this subclass with the given identifier.
     #
     # Return nil if no object has an identifier that matches.
@@ -673,28 +674,85 @@ module Jamf
     # is undefined. In short - dont' use names here unless you know they are
     # unique.
     #
+    # NOTE: Integers passed in as strings, e.g. '12345' will be converted to 
+    # integers and return the matching integer id if it exists.
+    #
+    # This means that if you have names that might match '12345' and you use
+    #    valid_id '12345' 
+    # you will get back the id 12345, if such an id exists, even if it is not
+    # the object with the name '12345'
+    #
+    # To explicitly look for '12345' as a name, use:
+    #      valid_id name: '12345' 
+    #   See the ident_and_val param below.
+    #
     # @param identfier [String,Integer] An identifier for an object, a value for
-    # one of the available lookup_keys
+    #   one of the available lookup_keys. Omit this and use 'identifier: value'
+    #   if you want to limit the search to a specific indentifier key, e.g.
+    #      name: 'somename'
+    #   or
+    #      id: 76538
     #
     # @param refresh [Boolean] Should the data be re-read from the server
     #
+    # @param ident_and_val [Hash] Do not pass in Hash.
+    #   This Hash internally holds the arbitrary identifier key
+    #   and desired value when you call ".valid_id ident: 'value'", e.g. 
+    #   ".valid_id name: 'somename'" or ".valid_id udid: some_udid"
+    #   Using explicit identifier keys like this will speed things up, since
+    #   the method doesn't have to search through all available identifiers
+    #   for the desired value.
+    #
     # @param cnx [Jamf::Connection] an API connection to use for the query.
     #   Defaults to the corrently active API. See {Jamf::Connection}
     #
     # @return [Integer, nil] the id of the matching object, or nil if it doesn't exist
     #
-    def self.valid_id(identifier, refresh = false, api: nil, cnx: Jamf.cnx)
+    def self.valid_id(identifier = nil, refresh = false, api: nil, cnx: Jamf.cnx, **ident_and_val)
       cnx = api if api
 
-      # refresh if needed
+      # refresh the cache if needed
       all(refresh, cnx: cnx) if refresh
 
-      # it its a valid id, return it
+      # Were we given an explict identifier key, like name: or id:?
+      # If so, just look for that.
+      unless ident_and_val.empty?
+        # only the first k/v pair of the ident_and_val hash is used
+        key = ident_and_val.keys.first
+        val = ident_and_val[key]
+
+        # if we are explicitly looking for an id, ensure we use an integer
+        # even if we were given an integer in a string.
+        if key == :id
+          val = val.to_i if val.is_a?(String) && val.j_integer?
+          return all_ids(cnx: cnx).include?(val) ? val : nil
+        end
+
+        # map the identifiers to ids, and return the id if there's
+        # a case-insensitive matching identifire
+        map_all(key, to: :id).each do |ident_val, id|
+          return id if ident_val.to_s.casecmp? val.to_s
+        end
+        nil
+      end
+
+      # If we are here, we need to seach all available identifier keys
+      # Start by looking for it as an id.
+
+      # it its a valid integer id, return it
       return identifier if all_ids(cnx: cnx).include? identifier
 
+      # if its a valid integer-in-a-string id, return it
+      if identifier.is_a?(String) && identifier.j_integer?
+        int_id = identifier.to_i
+        return int_id if all_ids(cnx: cnx).include? int_id
+      end 
+
+      # Now go through all the other identifier keys
       keys_to_check = lookup_keys(no_aliases: true)
       keys_to_check.delete :id # we've already checked :id
 
+      # loop thru looking for a match
       keys_to_check.each do |key|
         mapped_ids = map_all_ids_to key, cnx: cnx
         matches = mapped_ids.select { |_id, ident| ident.casecmp? identifier }
@@ -905,7 +963,7 @@ module Jamf
 
       # which connection?
       cnx = args.delete :cnx
-      cnx ||= args.delete :api
+      cnx ||= args.delete :api # backward compatibility, deprecated
       cnx ||= Jamf.cnx
 
       # refresh the .all list if needed
@@ -1027,7 +1085,7 @@ module Jamf
 
       validate_not_metaclass(self)
       rsrc = "#{self::RSRC_BASE}/id/#{id}"
-      REXML::Document.new(cnx.c_put rsrc, xml.to_s)
+      REXML::Document.new(cnx.c_put(rsrc, xml.to_s))
     end
 
     # POST some raw XML to the API for a given id in this subclass.
@@ -1055,7 +1113,7 @@ module Jamf
 
       validate_not_metaclass(self)
       rsrc = "#{self::RSRC_BASE}/id/-1"
-      REXML::Document.new(cnx.c_post rsrc, xml.to_s)
+      REXML::Document.new(cnx.c_post(rsrc, xml.to_s))
     end
 
     # Make a ruby instance of a not-yet-existing APIObject.
@@ -1073,7 +1131,7 @@ module Jamf
     # @param cnx [Jamf::Connection] the connection thru which to make this
     #   object. Defaults to the deault API connection in Jamf.cnx
     #
-    # @param args[Hash] The data for creating an object, such as name:
+    # @param args [Hash] The data for creating an object, such as name:
     #  See {APIObject#initialize}
     #
     # @return [APIObject] The un-created ruby-instance of a JSS object
@@ -1084,16 +1142,17 @@ module Jamf
         raise Jamf::UnsupportedError, "Creating #{self.class::RSRC_LIST_KEY} isn't yet supported. Please use other Casper workflows."
       end
       raise ArgumentError, "Use '#{self.class}.fetch id: xx' to retrieve existing JSS objects" if args[:id]
-
-      args[:api] ||= Jamf.cnx
+      
+      args[:cnx] ||= args[:api] # deprecated
+      args[:cnx] ||= Jamf.cnx
       args[:id] = :new
-      new **args
+      new(**args)
     end
 
     # backward compatability
     # @deprecated use .create instead
     def self.make(**args)
-      create **args
+      create(**args)
     end
 
     # Disallow direct use of ruby's .new class method for creating instances.
@@ -1102,9 +1161,7 @@ module Jamf
       validate_not_metaclass(self)
 
       calling_method = caller_locations(1..1).first.label
-      unless OK_INSTANTIATORS.include? calling_method
-        raise Jamf::UnsupportedError, 'Use .fetch or .create to instantiate APIObject classes'
-      end
+      raise Jamf::UnsupportedError, 'Use .fetch or .create to instantiate APIObject classes' unless OK_INSTANTIATORS.include? calling_method
 
       super
     end
@@ -1255,24 +1312,24 @@ module Jamf
     #
     def save
       if @in_jss
-        raise Jamf::UnsupportedError, 'Updating this object in the JSS is currently not supported by ruby-jss' unless updatable?
-
-        update_in_jamf
+        update
       else
-        raise Jamf::UnsupportedError, 'Creating this object in the JSS is currently not supported by ruby-jss' unless creatable?
-
-        create_in_jamf
+        create
       end
     end
 
     # @deprecated, use #save
     def create
-      save
+      raise Jamf::UnsupportedError, 'Creating this object in the JSS is currently not supported by ruby-jss' unless creatable?
+
+      create_in_jamf
     end
 
     # @deprecated, use #save
     def update
-      save
+      raise Jamf::UnsupportedError, 'Updating this object in the JSS is currently not supported by ruby-jss' unless updatable?
+
+      update_in_jamf
     end
 
     # Mix-in Modules.
@@ -1510,10 +1567,12 @@ module Jamf
 
       raise Jamf::InvalidConnectionError, 'Not connected to MySQL' unless Jamf::DB_CNX.connected?
 
-      raise Jamf::UnsupportedError, "Object History access is not supported for #{self.class} objects at this time" unless defined? self.class::OBJECT_HISTORY_OBJECT_TYPE
+      unless defined? self.class::OBJECT_HISTORY_OBJECT_TYPE
+        raise Jamf::UnsupportedError, 
+              "Object History access is not supported for #{self.class} objects at this time"
+      end
     end
 
-
     # If we're making a new object in the JSS, make sure we were given
     # valid data to do so, raise exceptions otherwise.
     #
@@ -1535,7 +1594,6 @@ module Jamf
       matches = self.class.all_names(:refresh, cnx: @cnx).select { |n| n.casecmp? args[:name] }
 
       raise Jamf::AlreadyExistsError, "A #{self.class::RSRC_OBJECT_KEY} already exists with the name '#{args[:name]}'" unless matches.empty?
-
     end
 
     # Given initialization args, perform an API lookup for an object.
@@ -1612,6 +1670,7 @@ module Jamf
     def find_main_subset
       return @init_data if @init_data[:id] && @init_data[:name]
       return @init_data[:general] if @init_data[:general] && @init_data[:general][:id] && @init_data[:general][:name]
+
       @init_data.each do |_key, value|
         next unless value.is_a? Hash
         return value if value.keys.include?(:id) && value.keys.include?(:name)

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

@@ -207,8 +207,8 @@ module Jamf
     # @see Jamf::APIObject#delete
     #
     def delete
-      orig_open_timeout = @cnx.cnx.options[:open_timeout]
-      orig_timeout = @cnx.cnx.options[:timeout]
+      orig_open_timeout = @cnx.open_timeout
+      orig_timeout = @cnx.timeout
       @cnx.timeout = orig_timeout + 1800
       @cnx.open_timeout = orig_open_timeout + 1800
       begin