ruby-jss 1.4.1 → 1.6.0

data/lib/jss/api_object.rb

@@ -849,11 +849,7 @@ module JSS
         raise ArgumentError, 'Missing searchterm or fetch key'
       end
 
-      begin
-        return new fetch_rsrc: fetch_rsrc, api: api
-      rescue RestClient::NotFound
-        raise JSS::NoSuchItemError, "No #{self::RSRC_OBJECT_KEY} found #{err_detail}" unless fetch_rsrc
-      end
+      new fetch_rsrc: fetch_rsrc, api: api
     end # fetch
 
     # Fetch the mostly- or fully-raw JSON or XML data for an object of this
@@ -895,8 +891,6 @@ module JSS
       return data if format == :json || as_string
 
       REXML::Document.new(data)
-    rescue RestClient::NotFound
-      raise JSS::NoSuchItemError, "No #{self} with id #{id}"
     end
 
     # PUT some raw XML to the API for a given id in this subclass.
@@ -925,8 +919,6 @@ module JSS
       validate_not_metaclass(self)
       rsrc = "#{self::RSRC_BASE}/id/#{id}"
       REXML::Document.new(api.put_rsrc rsrc, xml.to_s)
-    rescue RestClient::NotFound
-      raise JSS::NoSuchItemError, "No #{self} with id #{id}"
     end
 
     # POST some raw XML to the API for a given id in this subclass.
@@ -1223,14 +1215,8 @@ module JSS
     #
     def delete
       return unless @in_jss
-      begin
-        @api.delete_rsrc @rest_rsrc
-      rescue RestClient::NotFound, RestClient::ResourceNotFound
-        # over slow connections (?) or more likely
-        # split-tunnel VPN connections, sometimes the thing gets deleted
-        # the call gets a 404 anyway
-        nil
-      end
+
+      @api.delete_rsrc @rest_rsrc
 
       @rest_rsrc = "#{self.class::RSRC_BASE}/name/#{CGI.escape @name.to_s}"
       @id = nil
@@ -1433,8 +1419,6 @@ module JSS
         end
 
       raw_json[args[:rsrc_object_key]]
-    rescue RestClient::ResourceNotFound
-      raise NoSuchItemError, "No #{self.class::RSRC_OBJECT_KEY} found matching resource #{rsrc}"
     end
 
     # Start examining the @init_data recieved from the API

data/lib/jss/api_object/categorizable.rb

@@ -198,7 +198,7 @@ module JSS
 
       if cat.is_a? String
         @category_name = cat
-        @category_id = JSS::Category.category_id_from_name @category_name
+        @category_id = JSS::Category.category_id_from_name @category_name, api: @api
       else
         @category_name = cat[:name]
         @category_id = cat[:id]

data/lib/jss/api_object/computer.rb

@@ -1046,6 +1046,19 @@ module JSS
       @need_to_update = true
     end
 
+    # flush the logs for this computer in a given policy
+    # @see JSS::Policy.flush_logs
+    #
+    def flush_policy_logs(policy, older_than: 0, period: :days)
+      JSS::Policy.flush_logs(
+        policy,
+        older_than: older_than,
+        period: period,
+        computers: [@id],
+        api: @api
+      )
+    end
+
     def barcode1=(new_val)
       new_val = new_val.strip
       return nil if @barcode1 == new_val

data/lib/jss/api_object/configuration_profile.rb

@@ -23,7 +23,6 @@
 #
 #
 
-#
 module JSS
 
   # Classes
@@ -56,6 +55,11 @@ module JSS
     # which DISTRIBUTION_METHODS means we're in self service?
     SELF_SERVICE_DIST_METHOD = 'Make Available in Self Service'.freeze
 
+    # when a change is made, which in-scope machines should get
+    # the changed profile?
+    REDEPLOY_NEWLY_ASSIGNED = 'Newly Assigned'.freeze
+    REDEPLOY_ALL = 'All'.freeze
+
     # Our SelfService deploys profiles
     SELF_SERVICE_PAYLOAD = :profile
 
@@ -68,7 +72,6 @@ module JSS
     # How is the category stored in the API data?
     CATEGORY_DATA_TYPE = Hash
 
-
     # Attributes
     ###################################
 
@@ -78,7 +81,11 @@ module JSS
     # @return [String] the uuid of this profile. NOT Updatable
     attr_reader :uuid
 
-    # @return [Boolean] Should this profile be redeployed when an inventory update happens?
+    # @return [String] When a change is made to the profile, which scoped machines
+    #   should get the changes? This will always contain REDEPLOY_NEWLY_ASSIGNED
+    #   when fetched, but can be set to REDEPLOY_ALL via the redeploy_to_all:
+    #   parameter to #update & #save. After the update is complete, it reverts
+    #   to REDEPLOY_NEWLY_ASSIGNED
     attr_reader :redeploy_on_update
 
     # @return [String] the plist containing the payloads for this profile. NOT Updatable
@@ -116,7 +123,7 @@ module JSS
     #
     # @return [Hash] the parsed payloads plist.
     def parsed_payloads
-      Plist.parse_xml @payloads
+      JSS.parse_plist @payloads
     end
 
     # @return [Array<Hash>] the individual payloads from the payload Plist
@@ -125,12 +132,58 @@ module JSS
       parsed_payloads['PayloadContent']
     end
 
+    # @param new_content [Array<Hash>] replace the payload content entirely.
+    #
+    #   The 'payload' of a config profile is an XML Plist. The top-level key
+    #   of that plist 'PayloadContent' contains an Array of Dicts, each one being
+    #   a part of the payload for the profile.
+    #
+    #   When replacing the PayloadContent Array, using this method, provide a
+    #   *ruby* Array full of *ruby* hashes, and they will be converted to a
+    #   Plist and embedded into the API XML appropriately.
+    #
+    #   WARNING: This is experimental! Editing the Plist Payload of a Config
+    #   profile may break the profile. Make sure you test on a fake profile
+    #   before using this method in production.
+    #
+    # @return [void]
+    #
+    def payload_content=(new_content)
+      payload_plist_data = parsed_payloads
+      payload_plist_data['PayloadContent'] = new_content
+      @payloads = JSS.xml_plist_from new_content
+      @need_to_update = true
+      @update_payloads = true
+    end
+
     # @return [Array<String>] the PayloadType of each payload (e.g. com.apple.caldav.account)
     #
     def payload_types
       payload_content.map { |p| p['PayloadType'] }
     end
 
+    # clear flag after updating
+    def update(redeploy_to_all: false)
+      @redeploy_on_update = redeploy_to_all ? REDEPLOY_ALL : REDEPLOY_NEWLY_ASSIGNED
+      super()
+      # always reset to newly assigned
+      @redeploy_on_update = REDEPLOY_NEWLY_ASSIGNED
+      @update_payloads = nil
+    end
+
+    # wrapper with param
+    def save(redeploy_to_all: false)
+      if @in_jss
+        raise JSS::UnsupportedError, 'Updating this object in the JSS is currently not supported by ruby-jss' unless updatable?
+
+        update redeploy_to_all: redeploy_to_all
+      else
+        raise JSS::UnsupportedError, 'Creating this object in the JSS is currently not supported by ruby-jss' unless creatable?
+
+        create
+      end
+    end
+
     # Private Instance Methods
     ###################################
     private
@@ -142,7 +195,10 @@ module JSS
       gen = obj.add_element('general')
       gen.add_element('description').text = @description
       gen.add_element('redeploy_on_update').text = @redeploy_on_update
-
+      if @update_payloads
+        payloads_plist_xml = JSS.escape_xml(@payloads.gsub(/^\t*/, '').gsub(">\n", '>'))
+        gen.add_element('payloads').text = payloads_plist_xml
+      end
       obj << @scope.scope_xml
       add_self_service_xml doc
       add_category_to_xml doc

data/lib/jss/api_object/directory_binding_type.rb

@@ -25,66 +25,72 @@
 
 module JSS
 
-# Module for containing the different types of DirectoryBindings stored within the JSS
-module DirectoryBindingType
-
-        # Module Variables
-        #####################################
-
-        # Module Methods
-        #####################################
-        def should_update
-            @need_to_update = true
-        end
-
-        def set_type_settings(settings)
-            @type_settings = settings
-            @type_settings.container = self
-        end
-
-        # Classes
-        #####################################
-
-        # A generic binding type class that sets common variables, methods, and constructors 
-        # for all the different directory binding types.
-        #
-        # @author Tyler Morgan        
-        class DirectoryBindingType
-            # Mix-Ins
-            #####################################
-
-            # Class Methods
-            #####################################
-
-            # Class Constants
-            #####################################
-
-            # The different network protocols supported.
-            NETWORK_PROTOCOL = {
-                afp: "AFP",
-                smb: "SMB"
-            }.freeze
-
-
-            # The different home folder types.
-            HOME_FOLDER_TYPE = {
-                network: "Network",
-                local: "Local",
-                either: "Either",
-                mobile: "Mobile"
-            }.freeze
-
-            # Attributes
-            #####################################
-
-            # This is used to properly handle updating the containing object.
-            attr_accessor :container
-        end
+  # Module for containing the different types of DirectoryBindings stored within the JSS
+  module DirectoryBindingType
+
+    # Module Variables
+    #####################################
+
+    # Module Methods
+    #####################################
+    def should_update
+      @need_to_update = true
+    end
+
+    def set_type_settings(settings)
+      @type_settings = settings
+      @type_settings.container = self
+    end
+
+    # Classes
+    #####################################
+
+    # A generic binding type class that sets common variables, methods, and constructors
+    # for all the different directory binding types.
+    #
+    # @author Tyler Morgan
+    class DirectoryBindingType
+
+
+      # Mix-Ins
+      #####################################
+
+      # Class Methods
+      #####################################
+
+      # Class Constants
+      #####################################
+
+      # The different network protocols supported.
+      NETWORK_PROTOCOL = {
+        afp: 'AFP',
+        smb: 'SMB'
+      }.freeze
+
+      # The different home folder types.
+      HOME_FOLDER_TYPE = {
+        network: 'Network',
+        local: 'Local',
+        either: 'Either',
+        mobile: 'Mobile'
+      }.freeze
+
+      # Attributes
+      #####################################
+
+      # This is used to properly handle updating the containing object.
+      attr_accessor :container
+
+
+  end
+
+
     end
+
 end
 
-require "jss/api_object/directory_binding_type/active_directory"
-require "jss/api_object/directory_binding_type/open_directory"
-require "jss/api_object/directory_binding_type/admitmac"
-require "jss/api_object/directory_binding_type/centrify"
-require "jss/api_object/directory_binding_type/powerbroker_identity_services"
+require 'jss/api_object/directory_binding_type/active_directory'
+require 'jss/api_object/directory_binding_type/open_directory'
+require 'jss/api_object/directory_binding_type/admitmac'
+require 'jss/api_object/directory_binding_type/centrify'
+require 'jss/api_object/directory_binding_type/powerbroker_identity_services'

data/lib/jss/api_object/directory_binding_type/active_directory.rb

@@ -259,11 +259,17 @@ module JSS
             # @return [void]
             def default_shell=(newvalue)
 
-                # Data Check
-                raise JSS::InvalidDataError, "default_shell must be a string." unless newvalue.is_a? String
+                new =
+                    if newvalue.to_s.empty?
+                        JSS::BLANK
+                    else
+                        # Data Check
+                        raise JSS::InvalidDataError, "default_shell must be a string." unless newvalue.is_a? String
+                        newvalue
+                    end
 
                 # Update Value
-                @default_shell = newvalue
+                @default_shell = new
 
                 # Set the object to needing to be updated.
                 self.container&.should_update
@@ -280,12 +286,17 @@ module JSS
             #
             # @return [void]
             def uid=(newvalue)
-
-                # Data Check
-                raise JSS::InvalidDataError, "uid must be either an integer or a string." unless (newvalue.is_a? Integer || newvalue.is_a?(String))
+                new =
+                    if newvalue.to_s.empty?
+                        JSS::BLANK
+                    else
+                        # Data Check
+                        raise JSS::InvalidDataError, "uid must be either an integer or a string." unless (newvalue.is_a? Integer || newvalue.is_a?(String))
+                        newvalue
+                    end
 
                 # Update Value
-                @uid = newvalue
+                @uid = new
 
                 # Set the object to needing to be updated.
                 self.container&.should_update
@@ -302,12 +313,17 @@ module JSS
             #
             # @return [void]
             def forest=(newvalue)
-
-                # Data Check
-                raise JSS::InvalidDataError, "forest must be a string." unless newvalue.is_a? String
-
+                new =
+                    if newvalue.to_s.empty?
+                        JSS::BLANK
+                    else
+                        # Data Check
+                        raise JSS::InvalidDataError, "forest must be a string." unless newvalue.is_a? String
+                        newvalue
+                    end
+                
                 # Update Value
-                @forest = newvalue
+                @forest = new
 
                 # Set the object to needing to be updated.
                 self.container&.should_update
@@ -323,12 +339,17 @@ module JSS
             #
             # @return [void]
             def user_gid=(newvalue)
-
-                # Data Check
-                raise JSS::InvalidDataError, "user_gid must be either an integer or a string." unless (newvalue.is_a? Integer || newvalue.is_a?(String))
+                new =
+                    if newvalue.to_s.empty?
+                        JSS::BLANK
+                    else
+                        # Data Check
+                        raise JSS::InvalidDataError, "user_gid must be either an integer or a string." unless (newvalue.is_a? Integer || newvalue.is_a?(String))
+                        newvalue
+                    end
 
                 # Update Value
-                @user_gid = newvalue
+                @user_gid = new
 
                 # Set the object to needing to be updated.
                 self.container&.should_update
@@ -345,12 +366,17 @@ module JSS
             #
             # @return [void]
             def gid=(newvalue)
-
-                # Data Check
-                raise JSS::InvalidDataError, "gid must be either an integer or a string." unless (newvalue.is_a? Integer || newvalue.is_a?(String))
-
+                new =
+                    if newvalue.to_s.empty?
+                        JSS::BLANK
+                    else
+                        # Data Check
+                        raise JSS::InvalidDataError, "gid must be either an integer or a string." unless (newvalue.is_a? Integer || newvalue.is_a?(String))
+                        newvalue
+                    end
+                
                 # Update Value
-                @gid = newvalue
+                @gid = new
 
                 # Set the object to needing to be updated.
                 self.container&.should_update
@@ -389,12 +415,17 @@ module JSS
             #
             # @return [void]
             def preferred_domain=(newvalue)
-
-                # Data Check
-                raise JSS::InvalidDataError, "preferred_domain must be a string." unless newvalue.is_a? String
+                new =
+                    if newvalue.to_s.empty?
+                        JSS::BLANK
+                    else
+                        # Data Check
+                        raise JSS::InvalidDataError, "preferred_domain must be a string." unless newvalue.is_a? String
+                        newvalue
+                    end
 
                 # Update Value
-                @preferred_domain = newvalue
+                @preferred_domain = new
 
                 # Set the object to needing to be updated.
                 self.container&.should_update
@@ -411,16 +442,22 @@ module JSS
             #
             # @return [void]
             def admin_groups=(newvalue)
-
-                # Data Check
-                raise JSS::InvalidDataError, "admin_groups must be either a string or an array of strings." unless (newvalue.is_a? String || newvalue.is_a?(Array))
-
+                new =
+                    if newvalue.to_s.empty?
+                        JSS::BLANK
+                    else
+                        # Data Check
+                        raise JSS::InvalidDataError, "admin_groups must be either a string or an array of strings." unless (newvalue.is_a? String || newvalue.is_a?(Array))
+                        
+                        if newvalue.is_a? Array
+                            newvalue.join ","
+                        else
+                            newvalue
+                        end
+                    end
+                    
                 # Update Value
-                if newvalue.is_a? Array
-                    @admin_groups = newvalue.join ","
-                else
-                    @admin_groups = newvalue
-                end
+                @admin_groups = new
 
                 # Set the object to needing to be updated.
                 self.container&.should_update