ruby-jss 2.0.0a10 → 2.0.0b3

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

@@ -144,7 +144,7 @@ module Jamf
     # @see APIObject#initialize
     #
     def initialize(**args)
-      super
+      super **args
 
       # @init_data now has the raw data
       # so fill in our attributes or set defaults
@@ -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
 
@@ -559,7 +560,7 @@ module Jamf
       ident = lookup_keys[ident]
       raise Jamf::InvalidDataError, "No identifier :#{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 +661,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.
@@ -1027,7 +1027,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 +1055,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.
@@ -1087,13 +1087,13 @@ module Jamf
 
       args[:api] ||= 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 +1102,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 +1253,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 +1508,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 +1535,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 +1611,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

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

@@ -112,7 +112,7 @@ module Jamf
       cnx = api if api
 
       raise Jamf::NoSuchItemError, "No #{self} matching '#{group}'" unless (group_id = valid_id group, cnx: cnx)
-      raise Jamf::UnsupportedError, "Not a static group, can't change membership directly" if map_all_ids_to(:is_smart, cnx: cnx)[group_id]
+      raise Jamf::UnsupportedError, "Not a static group, can't change membership" if map_all(:id, to: :is_smart, cnx: cnx)[group_id]
 
       add_members = [add_members].flatten
       remove_members = [remove_members].flatten
@@ -123,6 +123,8 @@ module Jamf
       # that isn't in the group (which is kinda lame - it should just
       # ignore this, like it does when we add a member that's already
       # in the group.)
+      # Its even more lame because we have to instantiate the group
+      # and part of the point of this class method is to avoid that.
       current_member_ids = fetch(id: group_id, cnx: cnx).member_ids
 
       # nil if no changes to be made
@@ -189,7 +191,6 @@ module Jamf
     end
     private_class_method :member_removals_xml
 
-
     # Attributes
     #####################################
 
@@ -207,10 +208,12 @@ module Jamf
 
     # @return [Boolean] is this a smart group
     attr_reader :is_smart
+    alias smart? is_smart
 
     # @return [Boolean] does this group send notifications when it changes?
     attr_reader :notify_on_change
-
+    alias notify_on_change? notify_on_change
+    alias notify? notify_on_change
 
     # Constructor
     #####################################
@@ -221,20 +224,14 @@ module Jamf
     # @see Jamf::APIObject
     #
     def initialize(**args)
-      if args[:id] == :new
-        raise Jamf::InvalidDataError, 'New group creation must specify a :type of :smart or :static' unless GROUP_TYPES.include? args[:type]
-      end
+      raise Jamf::InvalidDataError, 'New group creation must specify a :type of :smart or :static' if args[:id] == :new && !(GROUP_TYPES.include? args[:type])
 
       super
 
       @is_smart = @init_data[:is_smart] || (args[:type] == :smart)
 
       @members =
-        if @init_data[self.class::MEMBER_CLASS::RSRC_LIST_KEY]
-          @init_data[self.class::MEMBER_CLASS::RSRC_LIST_KEY]
-        else
-          []
-        end
+        @init_data[self.class::MEMBER_CLASS::RSRC_LIST_KEY] || []
     end # init
 
     # Public Instance Methods
@@ -251,9 +248,8 @@ module Jamf
     #   happens, try again this many times with a 1 second pause between attempts.
     #
     def create(calculate_members: true, retries: 10)
-      if @is_smart
-        raise Jamf::MissingDataError, 'No criteria specified for smart group' unless @criteria
-      end
+      raise Jamf::MissingDataError, 'No criteria specified for smart group' if @is_smart && !@criteria
+
       super()
 
       if calculate_members
@@ -289,10 +285,10 @@ module Jamf
       if @in_jss
         raise Jamf::UnsupportedError, 'Updating this object in the JSS is currently not supported by ruby-jss' unless updatable?
 
-
         update refresh: params[:refresh]
       else
         raise Jamf::UnsupportedError, 'Creating this object in the JSS is currently not supported by ruby-jss' unless creatable?
+
         create calculate_members: params[:calculate_members], retries: params[:retries]
       end
     end
@@ -321,8 +317,10 @@ module Jamf
     #
     # @param args[Hash] the options and settings use for switching the computer group from static group to smart group
     #
-    # @option args criteria[Array] The criterias to be user for the smart group
-    def set_smart(*params)
+    # @option args criteria[Array] The criteria to be user for the smart group
+    #
+    # @return [void]
+    def make_smart(**params)
       return if @is_smart
 
       params[:criteria] = [] if params[:criteria].nil?
@@ -332,22 +330,28 @@ module Jamf
       @is_smart = true
       @need_to_update = true
     end
+    # backward compatility
+    alias set_smart make_smart
 
     # Change smart group to static group
     #
     # @param args[Hash] the options and settings use for switching the computer group from smart group to static group
     #
     # @option args preserve_members[Boolean] Should the smart group preserve it's current members?
-    def set_static(*params)
+    #
+    # @return [void]
+    def make_static(**params)
       return unless @is_smart
 
       preserve_members = params.include? :preserve_members
 
       @is_smart = false
 
-      clear() unless preserve_members
+      clear unless preserve_members
     end
-
+    # backward compatility
+    alias set_static make_static
+        
     # How many members of the group?
     #
     # @return [Integer] the number of members of the group
@@ -355,6 +359,13 @@ module Jamf
     def size
       @members.count
     end
+    alias count size
+
+    # @return [Boolean] Is this a static group?
+    def static?
+      !smart?
+    end
+    alias is_static static?
 
     # @return [Array<String>] the names of the group members
     #
@@ -381,6 +392,7 @@ module Jamf
     def members=(new_members)
       raise UnsupportedError, "Smart group members can't be changed." if @is_smart
       raise InvalidDataError, 'Arg must be an array of names and/or ids' unless new_members.is_a? Array
+
       ok_members = []
       new_members.each do |m|
         ok_members << check_member(m)
@@ -390,6 +402,7 @@ module Jamf
 
       # make sure we've actually changed...
       return if members.map { |m| m[:id] }.sort == ok_members.map { |m| m[:id] }.sort
+
       @members = ok_members
       @need_to_update = true
     end
@@ -401,22 +414,32 @@ module Jamf
     # @return [void]
     #
     def add_member(mem)
-      raise UnsupportedError, "Smart group members can't be changed." if @is_smart
+      raise UnsupportedError, "Smart group members can't be changed." if smart?
+
       @members << check_member(mem)
       @need_to_update = true
     end
 
     # Remove a member by id, or name
     #
-    # @param m[Integer,String] the id or name of the member to remove
+    # @param m[Integer,String] an identifier for the item to remove
     #
     # @return [void]
     #
     def remove_member(mem)
-      raise InvalidDataError, "Smart group members can't be changed." if @is_smart
-      raise InvalidDataError, "Can't remove nil" if mem.nil?
-      removed = @members.reject! { |mm| [mm[:id], mm[:name], mm[:username]].include? mem }
-      @need_to_update = true if removed
+      raise UnsupportedError, "Smart group members can't be changed." if smart?
+
+      # See if we have the identifier in the @members hash
+      id_to_remove = @members.select { |mm| mm.values.include? mem }.first&.dig :id
+      # But the members hash might not have SN, macaddr, etc, and never has udid, so
+      # look at the MEMBER_CLASS if needed
+      id_to_remove ||= self.class::MEMBER_CLASS.valid_id mem
+
+      # nothing to do if that id isn't one of our members
+      return unless id_to_remove && member_ids.include?(id_to_remove)
+
+      @members.delete_if { |k, v| k == :id && v == id_to_remove }
+      @need_to_update = true 
     end
 
     # Remove all members
@@ -426,6 +449,7 @@ module Jamf
     def clear
       raise InvalidDataError, "Smart group members can't be changed." if @is_smart
       return if @members.empty?
+
       @members.clear
       @need_to_update = true
     end
@@ -458,13 +482,7 @@ module Jamf
     def refresh_members
       @members = @cnx.c_get(@rest_rsrc)[self.class::RSRC_OBJECT_KEY][self.class::MEMBER_CLASS::RSRC_LIST_KEY]
     end
-
-    # aliases
-
-    alias smart? is_smart
-    alias notify_on_change? notify_on_change
-    alias notify? notify_on_change
-    alias count size
+  
 
     # Public Instance Methods
     #####################################
@@ -477,13 +495,12 @@ module Jamf
     # @return [Hash{:id=>Integer,:name=>String}] the valid id and name
     #
     def check_member(m)
-      potential_members = self.class::MEMBER_CLASS.map_all_ids_to(:name, cnx: @cnx)
-      if m.to_s =~ /^\d+$/
-        return { id: m.to_i, name: potential_members[m] } if potential_members.key?(m.to_i)
-      else
-        return { name: m, id: potential_members.invert[m] } if potential_members.value?(m)
-      end
-      raise Jamf::NoSuchItemError, "No #{self.class::MEMBER_CLASS::RSRC_OBJECT_KEY} matching '#{m}' in the JSS."
+      desired_id = self.class::MEMBER_CLASS.valid_id m, cnx: @cnx
+      raise Jamf::NoSuchItemError, "No #{self.class::MEMBER_CLASS::RSRC_OBJECT_KEY} matching '#{m}' in the JSS." unless desired_id
+
+      desired_name = self.class::MEMBER_CLASS.map_all(:id, to: :name, cnx: @cnx)[desired_id]
+
+      { name: desired_name, id: desired_id }      
     end
 
     # the xml formated data for adding or updating this in the JSS,

data/lib/jamf/api/connection/attributes.rb

@@ -70,6 +70,53 @@ module Jamf
       attr_reader :connect_time
       alias login_time connect_time
 
+      # @return [Boolean] are we using a sticky session?
+      attr_reader :sticky_session
+      alias sticky_session? sticky_session
+      alias sticky? sticky_session
+      
+      # @return [String, nil] The current sticky_session cookie. nil unless
+      #   sticky_session is set to true, either as a param to 'connect' or via
+      #   #sticky_session=
+      #
+      #   When set via .connect, the cookie is gleaned from the token creation 
+      #   reponse. When set via #sticky_session=, a HEAD request is made, and the
+      #   cookie will be in the response.
+      #   
+      #    Only valid when the connection is to a Jamf Cloud server.
+      attr_reader :sticky_session_cookie
+
+      ##########################################
+
+      # Turn sticky-sessions on or off. If turning on, host must be a Jamf Cloud
+      # server, with a hostname ending with Jamf::Connection::JAMFCLOUD_DOMAIN
+      #
+      # @param value [Boolean] should we use a sticky session?
+      #
+      # @return [void]
+      #
+      def sticky_session=(value)
+        @sticky_session ||= false
+
+        # convert boolean-y to boolean
+        value = value ? true : false
+        
+        return if @sticky_session == value
+
+        if value
+          raise Jamf::UnsupportedError, 'Sticky Sessions may only be used with Jamf Cloud servers.' unless host.end_with? Jamf::Connection::JAMFCLOUD_DOMAIN
+
+          @sticky_session = true
+          enable_sticky_session Jamf.cnx.jp_cnx.head.headers
+
+        else
+          @sticky_session = false
+          @sticky_session_cookie = nil
+          @c_cnx&.headers&.delete Jamf::Connection::COOKIE_HEADER
+          @jp_cnx&.headers&.delete Jamf::Connection::COOKIE_HEADER
+        end
+      end
+
       # Reset the response timeout for the rest connection
       #
       # @param timeout[Integer] the new timeout in seconds
@@ -78,8 +125,8 @@ module Jamf
       #
       def timeout=(new_timeout)
         @timeout = new_timeout.to_i
-        @c_cnx.options[:timeout] = @timeout if @c_cnx
-        @jp_cnx.options[:timeout] = @timeout if @jp_cnx
+        @c_cnx&.options[:timeout] = @timeout 
+        @jp_cnx&.options[:timeout] = @timeout 
       end
 
       # Reset the open-connection timeout for the rest connection
@@ -90,8 +137,8 @@ module Jamf
       #
       def open_timeout=(new_timeout)
         @open_timeout = new_timeout.to_i
-        @c_cnx.options[:open_timeout] = @open_timeout if @c_cnx
-        @jp_cnx.options[:open_timeout] = @open_timeout if @jp_cnx
+        @c_cnx&.options[:open_timeout] = @open_timeout
+        @jp_cnx&.options[:open_timeout] = @open_timeout 
       end
 
       # @return [URI::HTTPS] the base URL to the server

data/lib/jamf/api/connection/classic_api.rb

@@ -65,6 +65,7 @@ module Jamf
         resp =
           @c_cnx.get(rsrc) do |req|
             req.headers[Jamf::Connection::HTTP_ACCEPT_HEADER] = format == :json ? Jamf::Connection::MIME_JSON : Jamf::Connection::MIME_XML
+            # puts "Classic API Cookie is: #{req.headers['Cookie']}"
           end
         @last_http_response = resp
         unless resp.success?
@@ -222,7 +223,7 @@ module Jamf
 
           cnx.options[:timeout] = @timeout
           cnx.options[:open_timeout] = @open_timeout
-
+          
           cnx.request :multipart
           cnx.request :url_encoded