ruby-jss 2.0.0b3 → 2.0.0

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

@@ -107,27 +107,18 @@ module Jamf
     def self.master_distribution_point(refresh = false, default: nil, api: nil, cnx: Jamf.cnx)
       cnx = api if api
 
-      @master_distribution_point = nil if refresh
-      return @master_distribution_point if @master_distribution_point
-
       all_ids(refresh, cnx: cnx).each do |dp_id|
         dp = fetch id: dp_id, cnx: cnx
-        if dp.master?
-          @master_distribution_point = dp
-          break
-        end
+        return dp if dp.master?
       end
 
-      # If we're here, the Cloud DP might be master, but there's no
-      # access to it in the API :/
-      raise Jamf::NoSuchItemError, 'No Master FileShare Distribtion Point. Use the default: parameter if needed.' unless @master_distribution_point || default
-
-      if @master_distribution_point
-        @master_distribution_point
-      elsif default == :random
-        @master_distribution_point = fetch(id: all_ids.sample, cnx: cnx)
+      case default
+      when :random
+        fetch id: all_ids.sample, cnx: cnx
+      when nil
+        raise Jamf::NoSuchItemError, 'No Master FileShare Distribtion Point. Use the default: parameter if needed.'
       else
-        @master_distribution_point = fetch(default, cnx: cnx)
+        fetch default, cnx: cnx
       end
     end
 
@@ -267,38 +258,9 @@ module Jamf
     # @return [String] the ssh password as a SHA256 digest
     attr_reader :ssh_password_sha256
 
-    # As well as the standard :id, :name, and :data, you can
-    # instantiate this class with :id => :master, in which case you'll
-    # get the Master Distribution Point as defined in the JSS.
-    # An error will be raised if one hasn't been defined.
-    #
-    # You can also do this more easily by calling JSS.master_distribution_point
-    #
     def initialize(**args)
-      # TODO: this looks redundant with super....
-      args[:cnx] ||= args[:api]
-      args[:cnx] ||= Jamf.cnx
-
-      @cnx = args[:cnx]
-
-      @init_data = nil
-
-      # looking for master?
-      if args[:id] == :master
-
-        self.class.all_ids(cnx: @cnx).each do |id|
-          @init_data = @cnx.c_get("#{RSRC_BASE}/id/#{id}")[RSRC_OBJECT_KEY]
-          if @init_data[:is_master]
-            @id = @init_data[:id]
-            @name = @init_data[:name]
-            break
-          end # if data is master
-          @init_data = nil
-        end # each id
-      end # if args is master
-
-      super(args) if @init_data.nil?
-
+      super 
+      
       @ip_address = @init_data[:ip_address]
       @local_path = @init_data[:local_path]
       @enable_load_balancing = @init_data[:enable_load_balancing]
@@ -365,7 +327,7 @@ module Jamf
                when :ro then @read_only_password_sha256
                when :http then @http_password_sha256
                when :ssh then @ssh_password_sha256
-      end # case
+               end # case
 
       return nil if sha256 == EMPTY_PW_256
 
@@ -449,7 +411,7 @@ module Jamf
                    JSS.stdin line
                  else
                    pw
-      end
+                 end
 
       pwok = check_pw(access, password)
       unless pwok
@@ -466,7 +428,7 @@ module Jamf
                  when 'smb' then '/sbin/mount_smbfs'
                  when 'afp' then '/sbin/mount_afp'
                  else raise "Can't mount distribution point #{@name}: no known connection type."
-      end
+                 end
 
       @mountpoint.mkpath
 

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/base_classes/api_object.rb

@@ -557,8 +557,9 @@ 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 || all(refresh, cnx: cnx)
       mapped = list.map do |i|
@@ -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
@@ -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,8 +1142,9 @@ 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)
     end

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

@@ -128,8 +128,9 @@ module Jamf
 
     # Fetch either an internal or external patch source
     #
-    # BUG: there's an API bug: fetching a non-existent
-    # which is why we rescue internal server errors.
+    # BUG: there's an API bug when fetching a non-existent patch source
+    # which is why we rescue 500 internal server errors and report them
+    # as 'no matching patch source'
     #
     # @see APIObject.fetch
     #
@@ -162,7 +163,7 @@ module Jamf
     # @see APIObject.make
     #
     def self.create(**args)
-      case self.name
+      case name
       when 'Jamf::PatchSource'
         Jamf::PatchExternalSource.make args
       when 'Jamf::PatchExternalSource'
@@ -184,7 +185,7 @@ module Jamf
     def self.delete(victims, api: nil, cnx: Jamf.cnx)
       cnx = api if api
 
-      case self.name
+      case name
       when 'Jamf::PatchSource'
         Jamf::PatchExternalSource victims, cnx: cnx
       when 'Jamf::PatchExternalSource'
@@ -292,6 +293,7 @@ module Jamf
 
       return :internel if Jamf::PatchInternalSource.valid_id ident, refresh, cnx: cnx
       return :external if Jamf::PatchExternalSource.valid_id ident, refresh, cnx: cnx
+
       nil
     end
 
@@ -324,7 +326,10 @@ module Jamf
 
     # Init
     def initialize(**args)
-      raise Jamf::UnsupportedError, 'PatchSource is an abstract metaclass. Please use PatchInternalSource or PatchExternalSource' if self.class == Jamf::PatchSource
+      if instance_of?(Jamf::PatchSource)
+        raise Jamf::UnsupportedError, 
+              'PatchSource is an abstract metaclass. Please use PatchInternalSource or PatchExternalSource'
+      end
 
       super
 

data/lib/jamf/api/connection.rb

@@ -106,7 +106,7 @@ module Jamf
   # If you provide connection details when calling 'new', they will be passed
   # to the {#connect} method immediately. Otherwise you can call {#connect} later.
   #
-  #   production_api = Jamf::Connection.new(
+  #   production_server = Jamf::Connection.new(
   #     'https://produser@prodserver.address.org:8443/'
   #     name: 'prod',
   #     pw: :prompt

data/lib/jamf/api/jamf_pro/mixins/collection_resource.rb

@@ -24,6 +24,7 @@
 #
 
 module Jamf
+
   # A Collection Resource in Jamf Pro
   #
   # See {Jamf::Resource} for general info about API resources.
@@ -60,6 +61,7 @@ module Jamf
   # @abstract
   ######################################
   module CollectionResource
+
     include Jamf::JPAPIResource
 
     # when this module is included, also extend our Class Methods
@@ -71,6 +73,7 @@ module Jamf
     # Class Methods
     #####################################
     module ClassMethods
+
       # 'include' all of these, so their methods become defined in this
       # module, and will become Class Methods when this module
       # is extended.
@@ -128,7 +131,6 @@ module Jamf
         @patch_path ||= defined?(self::PATCH_PATH) ? self::PATCH_PATH : self::LIST_PATH
       end
 
-
       # The path for POSTing to create a single object in the collection.
       #
       # Classes including CollectionResource really need to define POST_PATH if it
@@ -256,7 +258,6 @@ module Jamf
       #
       ######################################
       def all(sort: nil, filter: nil, instantiate: false, cnx: Jamf.cnx, refresh: nil)
-
         # if we are here, we need to query for all items, possibly filtered and
         # sorted
         sort = Jamf::Sortable.parse_url_sort_param(sort)
@@ -287,7 +288,6 @@ module Jamf
       #   arbitrary pages from the collection.
       #
       def pager(page_size: Jamf::Pager::DEFAULT_PAGE_SIZE, sort: nil, filter: nil, instantiate: false, cnx: Jamf.cnx)
-
         sort = Jamf::Sortable.parse_url_sort_param(sort)
         filter = filterable? ? Jamf::Filterable.parse_url_filter_param(filter) : nil
 
@@ -325,7 +325,6 @@ module Jamf
 
         raise Jamf::NoSuchItemError, "No attribute :#{to} for class #{self}" unless self::OAPI_PROPERTIES.key? to
 
-
         list = cached_list || all(cnx: cnx)
         to_class = self::OAPI_PROPERTIES[to][:class]
         to_multi = self::OAPI_PROPERTIES[to][:multi]
@@ -362,7 +361,7 @@ module Jamf
       #   raw_data some_value
       #
       # If some_value is an integer or a string containing an integer, it
-      # is assumed to be an :id otherwise all the available identifers
+      # is assumed to be an :id, otherwise all the available identifers
       # are searched, in the order you see them when you call <class>.identifiers
       #
       # If no matching object is found, nil is returned.
@@ -382,8 +381,6 @@ module Jamf
       #
       ######################################
       def raw_data(searchterm = nil, ident: nil, value: nil, cnx: Jamf.cnx)
-
-
         # given a value with no ident key
         return raw_data_by_searchterm_only(searchterm, cnx: cnx) if searchterm
 
@@ -491,15 +488,13 @@ module Jamf
       #
       # @return [Boolean]
       ######################################
-       def creatable?
+      def creatable?
         true
       end
 
       # Make a new thing to be added to the API
       ######################################
       def create(**params)
-
-
         # no such animal when .creating
         params.delete :id
 
@@ -582,7 +577,7 @@ module Jamf
       def delete(*ids, cnx: Jamf.cnx)
         raise Jamf::UnsupportedError, "Deleting #{self} objects is not currently supported" unless deletable?
 
-        return bulk_delete(ids, cnx: Jamf.cnx) if self.bulk_deletable?
+        return bulk_delete(ids, cnx: Jamf.cnx) if bulk_deletable?
 
         errs = []
         ids.each do |id_to_delete|
@@ -650,7 +645,6 @@ module Jamf
             raise NoMethodError, "no method '#{list_method_name}': '#{attr_name}' is not an indentifier for #{self}"
           end
         end
-
       end # create_identifier_list_method
       private :create_identifier_list_method
 
@@ -758,5 +752,7 @@ module Jamf
         raise Jamf::MissingDataError, "Attribute '#{attr_name}' cannot be nil, must be a #{attr_def[:class]}"
       end
     end
+
   end # class CollectionResource
+
 end # module JAMF

data/lib/jamf/version.rb

@@ -27,6 +27,6 @@
 module Jamf
 
   ### The version of ruby-jss
-  VERSION = '2.0.0b3'.freeze
+  VERSION = '2.0.0'.freeze
 
 end # module