ruby-jss 1.2.10 → 1.5.2

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
@@ -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 = payload_plist_data.to_plist
+      @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.rb

@@ -0,0 +1,273 @@
+### Copyright 2019 Rixar
+
+###
+###    Licensed under the Apache License, Version 2.0 (the "Apache License")
+###    with the following modification; you may not use this file except in
+###    compliance with the Apache License and the following modification to it:
+###    Section 6. Trademarks. is deleted and replaced with:
+###
+###    6. Trademarks. This License does not grant permission to use the trade
+###       names, trademarks, service marks, or product names of the Licensor
+###       and its affiliates, except as required to comply with Section 4(c) of
+###       the License and to reproduce the content of the NOTICE file.
+###
+###    You may obtain a copy of the Apache License at
+###
+###        http://www.apache.org/licenses/LICENSE-2.0
+###
+###    Unless required by applicable law or agreed to in writing, software
+###    distributed under the Apache License with the above modification is
+###    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+###    KIND, either express or implied. See the Apache License for the specific
+###    language governing permissions and limitations under the Apache License.
+###
+###
+
+module JSS
+
+    # Module Variables
+    #####################################
+
+    # Module Methods
+    #####################################
+
+    # Classes
+    #####################################
+
+    # A Directory Binding object in the JSS
+    # These are rather complex objects, and contain settings specific to the directory object's type.
+    #
+    # @see JSS::APIObject
+    # @see JSS::DirectoryBindingType
+    # @note "JSS::DirectoryBinding.fetch name: 'BindingName'" seems to be returning a 500 error in my test evironment. Use "JSS::DirectoryBinding.fetch 'BindingName' instead."
+    #
+    class DirectoryBinding < JSS::APIObject
+
+        # Mix-Ins
+        #####################################
+        include JSS::Creatable
+        include JSS::Updatable
+        include JSS::DirectoryBindingType
+
+        # Class Methods
+        #####################################
+
+        # Class Constants
+        #####################################
+
+        #! You CAN update this
+        DIRECTORY_BINDING_TYPE = {
+            open_directory: "Open Directory",
+            active_directory: "Active Directory",
+            powerbroker_identity_services: "PowerBroker Identity Services",
+            admitmac: "ADmitMac",
+            centrify: "Centrify"
+        }.freeze
+
+        DIRECTORY_BINDING_TYPE_CLASSES = {
+            "Open Directory" => JSS::DirectoryBindingType::OpenDirectory,
+            "Active Directory" => JSS::DirectoryBindingType::ActiveDirectory,
+            "PowerBroker Identity Services" => JSS::DirectoryBindingType::PowerBroker,
+            "ADmitMac" => JSS::DirectoryBindingType::ADmitMac,
+            "Centrify" => JSS::DirectoryBindingType::Centrify
+        }
+
+        # The base for REST resources of this class
+        RSRC_BASE = 'directorybindings'.freeze
+
+        # the hash key used for the JSON list output of all objects in the JSS
+        RSRC_LIST_KEY = :directory_bindings
+
+        # The hash key used for the JSON object output.
+        # It's also used in various error messages
+        RSRC_OBJECT_KEY = :directory_binding
+
+        # the object type for this object in
+        # the object history table.
+        # See {APIObject#add_object_history_entry}
+        # OBJECT_HISTORY_OBJECT_TYPE = 41
+
+        # Attributes
+        #####################################
+        attr_reader :id
+        attr_reader :name
+        attr_reader :priority
+        attr_reader :domain
+        attr_reader :username
+        attr_reader :password_sha256
+        attr_reader :computer_ou
+        attr_reader :type
+        attr_reader :type_settings
+        attr_reader :password
+
+        # Constructor
+        # @see JSS::APIObject.initialize
+        # @note When creating an object with specific properties use the
+        # objects name and then the settings.
+        # Ex: Creating an Active Directory object:
+        # JSS::DirectoryBinding.make name: "Example Binding", username: "BindingUser", password: "SuperMonkey123", computer_ou: "computers", active_directory: { multiple_domains: false }, domain: your.domain.server
+        #####################################
+        def initialize(args = {})
+            super args
+
+            if self.in_jss?
+                @priority = @init_data[:priority]
+                @domain = @init_data[:domain]
+                @username = @init_data[:username]
+                @password_sha256 = @init_data[:password_sha256]
+                @computer_ou = @init_data[:computer_ou]
+                @type = @init_data[:type]
+
+                class_key = DIRECTORY_BINDING_TYPE.select { |k,v| v == @type }.map { |k,v| k }.first
+                self.set_type_settings (DIRECTORY_BINDING_TYPE_CLASSES[@type.to_s].new @init_data[class_key])
+            else
+                # Build
+                raise JSS::MissingDataError, "domain must be provided." if @init_data[:domain].nil?
+                raise JSS::MissingDataError, "username must be provided." if @init_data[:username].nil?
+                raise JSS::MissingDataError, "computer_ou must be provided." if @init_data[:computer_ou].nil?
+                raise JSS::MissingDataError, "password must be provided when creating a DirectoryBinding object." if @init_data[:password].nil?
+                raise JSS::MissingDataError, "Type must be provided, one of \":#{DIRECTORY_BINDING_TYPE.keys.join(",:")}\"." if @init_data[:type].nil?
+                raise JSS::InvalidDataError, "Type must be one of \":#{DIRECTORY_BINDING_TYPE.keys.join(",:")}\"." unless DIRECTORY_BINDING_TYPE.keys.include? @init_data[:type]
+                raise JSS::InvalidDataError, "Priority must be between 1 and 10" if !@init_data[:priority].nil? && (@init_data[:priority] <= 1 || @init_data[:priority] >= 10)
+
+                @domain = @init_data[:domain]
+                @username = @init_data[:username]
+                @computer_ou = @init_data[:computer_ou]
+                @type = DIRECTORY_BINDING_TYPE[@init_data[:type]]
+                @password = @init_data[:password]
+                @priority = @init_data[:priority]
+
+                @priority = 1 if @priority.nil?
+
+
+                class_key = DIRECTORY_BINDING_TYPE.select { |k,v| v == @type }.map { |k,v| k }.first
+                self.set_type_settings (DIRECTORY_BINDING_TYPE_CLASSES[@type.to_s].new @init_data[class_key])
+
+            end
+
+        end
+
+        # Public Instance Methods
+        #####################################
+
+        # The domain the device will be bound to.
+        #
+        # @author Tyler Morgan
+        #
+        # @param newvalue [String]
+        #
+        # @raise [JSS::InvalidDataError] If newvalue is not a String
+        #
+        # @return [void]
+        def domain=(newvalue)
+            raise JSS::InvalidDataError, "Domain must be a String" unless newvalue.is_a? String
+
+            @domain = newvalue.to_s
+            @need_to_update = true
+        end
+
+
+        # The username used to attempt to bind the device to the domain.
+        #
+        # @author Tyler Morgan
+        #
+        # @param newvalue [String]
+        #
+        # @raise [JSS::InvalidDataError] If newvalue is not a String
+        #
+        # @return [void]
+        def username=(newvalue)
+            raise JSS::InvalidDataError, "Username must be a String" unless newvalue.is_a? String
+
+            @username = newvalue
+            @need_to_update = true
+        end
+
+
+        # The priority the domain has over another one.
+        #
+        # @author Tyler Morgan
+        #
+        # @param newvalue [Integer]
+        #
+        # @raise [JSS::InvalidDataError] If newvalue is not an Integer
+        # @raise [JSS::InvalidDataError] If newvalue is not between 1 and 10
+        #
+        # @return [void]
+        def priority=(newvalue)
+            raise JSS::InvalidDataError, "Priority must be a Integer" unless newvalue.is_a? Integer
+            raise JSS::InvalidDataError, "Priority cannot exceed 10" unless newvalue <= 10
+            raise JSS::InvalidDataError, "Priority must be greater than 0" unless newvalue > 0
+
+            @priority = newvalue
+            @need_to_update = true
+        end
+
+        
+        # The OU path the computer object is to be placed
+        #
+        # @author Tyler Morgan
+        #
+        # @param newvalue [String]
+        #
+        # @raise [JSS::InvalidDataError] If newvalue is not a String
+        #
+        # @return [void]
+        def computer_ou=(newvalue)
+            raise JSS::InvalidDataError, "Computer OU must be a String" unless newvalue.is_a? String
+
+            @computer_ou = newvalue
+            @need_to_update = true
+        end
+
+
+        # Sets the password used in conjunction with the username to attempt to bind
+        # the computer to the domain.
+        #
+        # @author Tyler Morgan
+        #
+        # @param newvalue [String]
+        #
+        # @raise [JSS::InvalidDataError] If newvalue is not a String
+        #
+        # @return [void]
+        def password=(newvalue)
+            raise JSS::InvalidDataError, "Password must be a string" unless newvalue.is_a? String
+
+            @password = newvalue
+            @need_to_update = true
+        end
+
+        # private instance methods
+        ######################
+        private
+
+        # the xml formated data for adding or updating this in the JSS
+        #
+        # This method constructs a properly formatted XML document to be handled by the Jamf Pro API
+        #
+        # @author Tyler Morgan
+        #
+        # @return [String]
+        def rest_xml
+            doc = REXML::Document.new APIConnection::XML_HEADER
+            ns = doc.add_element RSRC_OBJECT_KEY.to_s
+            ns.add_element('id').text = @id.to_s
+            ns.add_element('name').text = @name
+            ns.add_element('priority').text = @priority.to_s
+            ns.add_element('domain').text = @domain.to_s
+            ns.add_element('username').text = @username.to_s
+            ns.add_element('computer_ou').text = @computer_ou.to_s
+            ns.add_element('type').text = @type.to_s
+            if !@password.nil?
+                ns.add_element('password').text = @password.to_s
+            end
+
+            ns << @type_settings.type_setting_xml
+
+            return doc.to_s
+        end # rest_xml
+    end
+
+
+end

data/lib/jss/api_object/directory_binding_type.rb

@@ -0,0 +1,96 @@
+### Copyright 2019 Rixar
+
+###
+###    Licensed under the Apache License, Version 2.0 (the "Apache License")
+###    with the following modification; you may not use this file except in
+###    compliance with the Apache License and the following modification to it:
+###    Section 6. Trademarks. is deleted and replaced with:
+###
+###    6. Trademarks. This License does not grant permission to use the trade
+###       names, trademarks, service marks, or product names of the Licensor
+###       and its affiliates, except as required to comply with Section 4(c) of
+###       the License and to reproduce the content of the NOTICE file.
+###
+###    You may obtain a copy of the Apache License at
+###
+###        http://www.apache.org/licenses/LICENSE-2.0
+###
+###    Unless required by applicable law or agreed to in writing, software
+###    distributed under the Apache License with the above modification is
+###    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+###    KIND, either express or implied. See the Apache License for the specific
+###    language governing permissions and limitations under the Apache License.
+###
+###
+
+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
+
+
+    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'