jss-api 0.6.1 → 0.6.2

data/lib/jss-api/api_object/osx_configuration_profile.rb

@@ -1,261 +0,0 @@
-### Copyright 2016 Pixar
-###  
-###    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
-  #####################################
-
-  ### 
-  ### An OS X Configuration Profile in the JSS.
-  ###
-  ### Note that the profile payloads and the profile UUID cannot be edited or updated with this via this class.
-  ### Use the web UI.
-  ###
-  ### @see JSS::APIObject
-  ### 
-  class OSXConfigurationProfile < JSS::APIObject
-    
-    #####################################
-    ### Mix-Ins
-    #####################################
-    include JSS::Updatable
-    include JSS::Scopable
-    include JSS::SelfServable
-    
-    #####################################
-    ### Class Methods
-    #####################################
-         
-    #####################################
-    ### Class Constants
-    #####################################
-    
-    ### The base for REST resources of this class
-    RSRC_BASE = "osxconfigurationprofiles"
-    
-    ### the hash key used for the JSON list output of all objects in the JSS
-    RSRC_LIST_KEY = :os_x_configuration_profiles
-    
-    ### The hash key used for the JSON object output.
-    ### It's also used in various error messages
-    RSRC_OBJECT_KEY = :os_x_configuration_profile
-    
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:distribution_method, :scope, :redeploy_on_update]
-    
-    ### Our scopes deal with computers
-    SCOPE_TARGET_KEY = :computers
-    
-    ### Our SelfService happens on OSX
-    SELF_SERVICE_TARGET = :osx
-    
-    ### Our SelfService deploys profiles
-    SELF_SERVICE_PAYLOAD = :profile
-    
-    ### The possible values for the :distribution_method
-    DISTRIBUTION_METHODS = ["Install Automatically", "Make Available in Self Service"]
-    
-    SELF_SERVICE_DIST_METHOD = "Make Available in Self Service"
-    
-    ### The possible values for :level
-    LEVELS = ["user", "computer"]
-    
-    
-    #####################################
-    ### Attributes
-    #####################################
-    
-    ### @return [String] the description of this profile
-    attr_reader :description
-    
-    ### @return [String] the distribution_method of this profile
-    attr_reader :distribution_method
-    
-    ### @return [Boolean] can the user remove this profile
-    attr_reader :user_removable
-    
-    ### @return [String] the level (user/computer) of this profile
-    attr_reader :level
-    
-    ### @return [String] the uuid of this profile. NOT Updatable
-    attr_reader :uuid
-    
-    ### @return [Boolean] Should this profile be redeployed when an inventory update happens?
-    attr_reader :redeploy_on_update
-    
-    ### @return [String] the plist containing the payloads for this profile. NOT Updatable
-    attr_reader :payloads
-    
-    #####################################
-    ### Constructor 
-    #####################################
-    
-    ###
-    ### See JSS::APIObject#initialize
-    ###
-    def initialize (args = {})
-      
-      super
-      
-      @description = @main_subset[:description]
-      @distribution_method = @main_subset[:distribution_method]
-      @user_removable = @main_subset[:user_removable]
-      @level = @main_subset[:level]
-      @uuid = @main_subset[:uuid]
-      @redeploy_on_update = @main_subset[:redeploy_on_update]
-      @payloads = @main_subset[:payloads]
-      
-      self.parse_scope
-      self.parse_self_service
-      
-    end
-
-    #####################################
-    ### Public Instance Methods
-    #####################################
-
-    ###
-    ### @param new_val[String] the new discription
-    ###
-    ### @return [void]
-    ###
-    def description= (new_val)
-      return nil if @self_service_description == new_val
-      @description = new_val.strip!
-      @need_to_update = true
-    end
-    
-    
-    ###
-    ### @param new_val[String] how should this be distributed to clients?
-    ###
-    ### @return [void]
-    ###
-    def distribution_method= (new_val)
-      return nil if @distribution_method == new_val
-      raise JSS::InvalidDataError, "New value must be one of '#{DISTRIBUTION_METHODS.join("' '")}'" unless DISTRIBUTION_METHODS.include? new_val
-      @distribution_method = new_val
-      @need_to_update = true
-    end
-    
-    ###
-    ### @param new_val[Boolean] should the user be able to remove this?
-    ###
-    ### @return [void]
-    ###
-    def user_removable= (new_val)
-      return nil if @self_service_feature_on_main_page == new_val
-      raise JSS::InvalidDataError, "Distribution method must be '#{SELF_SERVICE_DIST_METHOD}' to let the user remove it." unless in_self_service?
-      raise JSS::InvalidDataError, "New value must be true or false" unless JSS::TRUE_FALSE.include? new_val
-      @user_removable = new_val
-      @need_to_update = true
-    end
-    
-    ###
-    ### @param new_val[String] the new level for this profile (user/computer)
-    ###
-    ### @return [void]
-    ###
-    def level= (new_val)
-      return nil if @level == new_val
-      raise JSS::InvalidDataError, "New value must be one of '#{LEVELS.join("' '")}'" unless LEVELS.include? new_val
-      @level = new_val
-      @need_to_update = true
-    end
-    
-    
-    ###
-    ### @return [Boolean] is this profile available in Self Service?
-    ###
-    def in_self_service?
-      @distribution_method == SELF_SERVICE_DIST_METHOD
-    end
-    
-    
-    ###
-    ### @return [Boolean] is this profile removable by the user?
-    ###
-    def user_removable?
-      @user_removable
-    end
-    
-    
-    ### 
-    ### @return [Hash] The payload plist parsed into a Ruby hash
-    ###
-    def parsed_payloads
-      Plist.parse_xml @payloads
-    end
-    
-    ###
-    ### @return [Array<Hash>] the individual payloads from the payload Plist
-    ###
-    def payload_content
-      parsed_payloads['PayloadContent']
-    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
-    
-    #####################################
-    ### Private Instance Methods
-    #####################################
-    private
-    
-    def rest_xml
-      doc = REXML::Document.new
-      
-      obj = doc.add_element RSRC_OBJECT_KEY.to_s
-      gen = obj.add_element('general')
-      gen.add_element('description').text = @description
-      gen.add_element('distribution_method').text = @distribution_method
-      gen.add_element('user_removable').text = @user_removable
-      gen.add_element('level').text = @level
-      gen.add_element('redeploy_on_update').text = @redeploy_on_update
-      
-      obj << @scope.scope_xml
-      obj << self_service_xml
-      
-      return doc.to_s
-    end
-    
-  end # class OSXConfigurationProfile
-  
-end # module

data/lib/jss-api/api_object/package.rb

@@ -1,812 +0,0 @@
-### Copyright 2016 Pixar
-###
-###    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 Constants
-  #####################################
-
-  #####################################
-  ### Module Variables
-  #####################################
-
-  #####################################
-  ### Module Methods
-  #####################################
-
-  #####################################
-  ### Classes
-  #####################################
-
-  ###
-  ### A Package in the JSS
-  ###
-  ### Also the API provides no access to the package's
-  ### file list (index), so indexing must be done separately (usually via Casper Admin)
-  ###
-  ###
-  ### @see JSS::APIObject
-  ###
-  class Package  < JSS::APIObject
-
-    #####################################
-    ### Mix-Ins
-    #####################################
-
-    include JSS::Creatable
-    include JSS::Updatable
-
-    #####################################
-    ### Class Methods
-    #####################################
-
-    #####################################
-    ### Class Constants
-    #####################################
-
-    ### The base for REST resources of this class
-    RSRC_BASE = "packages"
-
-    ### the hash key used for the JSON list output of all objects in the JSS
-    RSRC_LIST_KEY = :packages
-
-    ### The hash key used for the JSON object output.
-    ### It's also used in various error messages
-    RSRC_OBJECT_KEY = :package
-
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:fill_existing_users, :fill_user_template, :reboot_required ]
-
-    ### The pkg storage folder on the distribution point
-    DIST_POINT_PKGS_FOLDER = "Packages"
-
-    ### The possible values for cpu_type (required_processor) in a JSS package
-    CPU_TYPES = ["None", "x86", "ppc"]
-
-    # TO DO - this is redundant with DEFAULT_PROCESSOR, but both are in use
-    # clean them up!
-    ### which is default?  there must be one to make a new pkg
-    DEFAULT_CPU_TYPE = "None"
-
-    ### the possible priorities
-    PRIORITIES = (1..20)
-
-    ### the default priority, since one is needed for making new pkgs
-    DEFAULT_PRIORITY = 10
-
-    ### by default, no processor requirement
-    DEFAULT_PROCESSOR = "None"
-
-    ### When we shouldn't install anything (e.g. switch w/package)
-    DO_NOT_INSTALL = "Do Not Install"
-
-    #####################################
-    ### Class Variables
-    #####################################
-
-    #####################################
-    ### Class Methods
-    #####################################
-
-    #####################################
-    ### Attributes
-    #####################################
-
-    ### @return [String] the filename of the .pkg, .mpkg, or .dmg on the Casper server
-    attr_reader :filename
-
-    ### @return [Pathname] the local receipt when this pkg is installed
-    attr_reader :receipt
-
-    ### @return [Boolean] does this item 'Fill Existing Users' when jamf installs it?
-    attr_reader :fill_existing_users
-
-    ### @return [Boolean] does this pkg also get install in the OS user homedir template
-    attr_reader :fill_user_template
-
-    ### @return [Boolean] does this item require a reboot after installation? If so, it'll be a puppy-install in d3
-    attr_reader :reboot_required
-
-    ### @return [Array<String>] the OS versions this can be installed onto. For all minor versions, the format is 10.5.x
-    attr_reader :os_requirements
-
-    ### @return [String] limit installation to these architectures: 'x86',  'ppc', 'None'
-    attr_reader :required_processor
-
-    ### @return [String] the name of a pkg to install (or "Do Not Install") when this pkg can't be installed
-    attr_reader :switch_with_package
-
-    ### @return [Boolean] can this item be uninstalled? Some, e.g. OS Updates, can't
-    attr_reader :allow_uninstalled
-
-    ### @return [String] the category of this pkg, stored in the JSS as the id number from the categories table
-    attr_reader :category
-
-    ### @return [String] the info field for this pkg - stores d3's basename & swupdate values
-    attr_reader :info
-
-    ### @return [String] the notes field for this pkg
-    attr_reader :notes
-
-    ### @return [Boolean] only install this pkg if it's available in the commandline softwareupdate.
-    attr_reader :install_if_reported_available
-
-    ### @return [Boolean] should this pkg be installed on the boot volume during imaging
-    attr_reader :boot_volume_required
-
-    ### @return [Integer] Priority to use for deploying or uninstalling the package
-    attr_reader :priority
-
-    ### @return [Boolean] does this pkg cause a notification to be sent on self-heal?
-    attr_reader :send_notification
-
-
-    ###
-    ### @see JSS::APIObject#initialize
-    ###
-    def initialize (args = {})
-
-      super
-
-      ### now we have pkg_data with something in it, so fill out the instance vars
-      @allow_uninstalled = @init_data[:allow_uninstalled]
-      @boot_volume_required = @init_data[:boot_volume_required]
-      @category = JSS::APIObject.get_name(@init_data[:category])
-      @category = nil if @category.to_s.casecmp("No category assigned") == 0
-      @filename = @init_data[:filename] || @init_data[:name]
-      @fill_existing_users = @init_data[:fill_existing_users]
-      @fill_user_template = @init_data[:fill_user_template]
-      @info = @init_data[:info]
-      @install_if_reported_available = @init_data[:install_if_reported_available]
-      @notes = @init_data[:notes]
-      @os_requirements = @init_data[:os_requirements].split(/\s*,\s*/) if @init_data[:os_requirements]
-      @os_requirements ||= []
-
-      @priority = @init_data[:priority] || DEFAULT_PRIORITY
-      @reboot_required = @init_data[:reboot_required]
-      @required_processor = @init_data[:required_processor] || DEFAULT_CPU_TYPE
-      @required_processor = nil if @required_processor.to_s.casecmp('none') == 0
-      @send_notification = @init_data[:send_notification]
-      @switch_with_package = @init_data[:switch_with_package] || DO_NOT_INSTALL
-
-      # the receipt is the filename with any .zip extension removed.
-      @receipt = @filename ? (JSS::Client::RECEIPTS_FOLDER + @filename.to_s.sub(/.zip$/, '')) : nil
-    end # init
-
-
-
-    ###
-    ### Change the 'allow to be uninstalled' field in the JSS
-    ### NOTE The package must be indexed before this works. Right now, that means
-    ### using CasperAdmin.app
-    ###
-    ### @param new_val[Boolean]
-    ###
-    ### @return [void]
-    ###
-    def allow_uninstalled= (new_val)
-      return nil if new_val == @allow_uninstalled
-
-      ### removable? defaults to false
-      ### even though we usually want to be able to ununstall things, it would be
-      ### dangerous to do on things like OS updates, so it must be turned on explicitly.
-      ### packages must be indexed with Casper Admin in order to be uninstalled.
-      new_val = false if new_val.to_s.empty?
-      raise JSS::InvalidDataError, "allow_uninstalled must be boolean 'true' or 'false'" unless JSS::TRUE_FALSE.include? new_val
-
-      @allow_uninstalled= new_val
-      @need_to_update = true
-
-    end
-
-
-    ###
-    ### Change the boot volume required field in the JSS
-    ###
-    ### @param new_val[Boolean]
-    ###
-    ### @return [void]
-    ###
-    def boot_volume_required=(new_val)
-      return nil if new_val == @boot_volume_required
-      new_val = false if new_val.to_s.empty?
-      raise JSS::InvalidDataError, "install_if_reported_available must be boolean true or false" unless JSS::TRUE_FALSE.include? new_val
-      @boot_volume_required = new_val
-      @need_to_update = true
-    end
-
-
-    ###
-    ### Change the category in the JSS
-    ###
-    ### @param new_val[String]  must be one listed by 'JSS::Category.all_names'
-    ###
-    ### @return [void]
-    ###
-    def category= (new_val)
-      return nil if new_val == @category
-      new_val = nil if new_val == ''
-      new_val ||= JSS::Category::DEFAULT_CATEGORY
-      raise JSS::InvalidDataError, "Category #{new_val} is not known to the JSS" unless JSS::Category.all_names.include? new_val
-      @category = new_val
-      @need_to_update = true
-    end
-
-    ###
-    ### Change the package filename.
-    ### Setting it to nil or empty will make it match the display name
-    ###
-    ### @param new_val[String]
-    ###
-    ### @return [void]
-    ###
-    def filename= (new_val)
-      new_val = nil if new_val == ''
-      new_val ||= @name
-      return nil if new_val == @filename
-      $stderr.puts "WARNING: you must manualy change the filename on the Distribution Point(s)" if @in_jss
-      @filename = new_val
-      @need_to_update = true
-    end
-
-
-    ###
-    ### Change the Fill Existing Users value
-    ###
-    ### @param new_val[Boolean]
-    ###
-    ### @return [void]
-    ###
-    def fill_existing_users= (new_val)
-      return nil if new_val == @fill_existing_users
-      new_val = false if new_val.to_s.empty?
-      raise JSS::InvalidDataError, "fill_existing_users must be boolean 'true' or 'false'" unless JSS::TRUE_FALSE.include? new_val
-      @fill_existing_users = new_val
-      @need_to_update = true
-    end
-
-    ###
-    ### Change the fill_user_template value
-    ###
-    ### @param new_val[Boolean]
-    ###
-    ### @return [void]
-    ###
-    def fill_user_template= (new_val)
-      return nil if new_val == @fill_user_template
-      new_val = false if new_val.to_s.empty?
-      raise JSS::InvalidDataError, "fill_user_template must be boolean 'true' or 'false'" unless JSS::TRUE_FALSE.include? new_val
-      @fill_user_template = new_val
-      @need_to_update = true
-    end
-
-
-
-    ###
-    ### Change the info field in the JSS.
-    ###
-    ### @param new_val[String]
-    ###
-    ### @return [void]
-    ###
-    def info= (new_val)
-      return nil if new_val == @info
-      ### line breaks should be \r
-      new_val = new_val.to_s.gsub(/\n/, "\r")
-      @info = new_val
-      @need_to_update = true
-    end
-
-
-    ###
-    ### Change the if_in_swupdate field in the JSS
-    ###
-    ### @param new_val[Boolean]
-    ###
-    ### @return [void]
-    ###
-    def install_if_reported_available= (new_val)
-      return nil if new_val == @install_if_reported_available
-      new_val = false if new_val.to_s.empty?
-      raise JSS::InvalidDataError, "install_if_reported_available must be boolean true or false" unless JSS::TRUE_FALSE.include? new_val
-      @install_if_reported_available = new_val
-      @need_to_update = true
-    end
-
-
-
-    ###
-    ### Change the notes field in the JSS.NewLines are converted \r.
-    ###
-    ### @param new_val[String]
-    ###
-    ### @return [void]
-    ###
-    def notes= (new_val)
-      return nil if new_val == @notes
-      ### line breaks should be \r
-      new_val = new_val.to_s.gsub(/\n/, "\r")
-      @notes = new_val
-      @need_to_update = true
-    end
-
-    ###
-    ### Change the os_requirements field in the JSS
-    ### E.g. 10.5, 10.5.3, 10.6.x
-    ###
-    ### @param new_val[String,Array] comma-separated string, or array of os versions
-    ###
-    ### @return [void]
-    ###
-    ### Extra feature: Minumum OS's can now be specified as a
-    ### string using the notation ">=10.6.7".
-    ###
-    ### @see JSS.expand_min_os
-    ###
-    def os_requirements= (new_val)
-      ### nil should be an empty array
-      new_val = [] if new_val.to_s.empty?
-
-      ### if any value starts with >=, expand it
-      case new_val
-        when String
-          new_val = JSS.expand_min_os(new_val) if new_val =~ /^>=/
-        when Array
-          new_val.map!{|a|  a =~ /^>=/ ? JSS.expand_min_os(a) : a }
-          new_val.flatten!
-          new_val.uniq!
-        else
-          raise JSS::InvalidDataError, "os_requirements must be a String or an Array of strings"
-      end
-      ### get the array version
-      @os_requirements = JSS.to_s_and_a(new_val)[:arrayform]
-      @need_to_update = true
-    end
-
-
-    ###
-    ### Change the priority field in the JSS
-    ###
-    ### @param new_val[Integer] one of PRIORITIES
-    ###
-    ### @return [void]
-    ###
-    def priority= (new_val)
-      return nil if new_val == @priority
-      new_val = DEFAULT_PRIORITY if new_val.to_s.empty?
-      raise JSS::InvalidDataError, ":priority must be an integer from 1-20" unless PRIORITIES.include? new_val
-      @priority = new_val
-      @need_to_update = true
-    end
-
-    ###
-    ### Change the reboot-required field in the JSS
-    ###
-    ### @param new_val[Boolean]
-    ###
-    ### @return [void]
-    ###
-    def reboot_required= (new_val)
-      return nil if new_val == @reboot_required
-      new_val = false if new_val.to_s.empty?
-      raise JSS::InvalidDataError, "reboot must be boolean 'true' or 'false'" unless JSS::TRUE_FALSE.include? new_val
-      @reboot_required = new_val
-      @need_to_update = true
-    end
-
-
-
-    ###
-    ### Change the required processor field in the JSS
-    ###
-    ### @param new_val[String] one of {CPU_TYPES}
-    ###
-    ### @return [void]
-    ###
-    def required_processor= (new_val)
-      return nil if new_val == @required_processor
-
-      new_val = DEFAULT_PROCESSOR if new_val.to_s.empty?
-      raise JSS::InvalidDataError, "Required_processor must be one of: #{CPU_TYPES.join ', '}" unless CPU_TYPES.include? new_val
-
-      @required_processor = new_val
-      @need_to_update = true
-    end
-
-
-    ###
-    ### Change the notify field in the JSS
-    ###
-    ### @param new_val[Boolean]
-    ###
-    ### @return [void]
-    ###
-    def send_notification= (new_val)
-      return nil if new_val == @send_notification
-      new_val = false if new_val.to_s.empty?
-      raise JSS::InvalidDataError, "send_notification must be boolean true or false" unless JSS::TRUE_FALSE.include? new_val
-      @send_notification = new_val
-      @need_to_update = true
-    end
-
-
-
-    ###
-    ### Change which pkg should be installed if this one can't.
-    ###
-    ### @param new_val[String] the name of an existing package or "Do Not Install"
-    ###
-    ### @return [void]
-    ###
-    def switch_with_package= (new_val)
-      return nil if new_val == @switch_with_package
-      new_val = nil if new_val.to_s.empty?
-
-      raise JSS::NoSuchItemError, "No package named '#{new_val}' exists in the JSS" if new_val and not self.class.all_names.include? new_val
-
-      new_val ||= DO_NOT_INSTALL
-      @switch_with_package = new_val
-      @need_to_update = true
-    end
-
-    ###
-    ### Is this packaged installed on the current machine (via casper)?
-    ### We just look for the receipt, which is the @filename less any possible .zip extension.
-    ###
-    ### @return [Boolean]
-    ###
-    def installed?
-      @receipt.file?
-    end
-
-    ###
-    ### Upload a locally-readable file to the master distribution point.
-    ### If the file is a directory (like a bundle .pk/.mpkg) it will be zipped before
-    ### uploading and the @filename will be adjusted accordingly
-    ###
-    ### If you'll be uploading several files you can specify unmount as false, and do it manually when all
-    ### are finished with JSS::DistributionPoint.master_distribution_point.unmount
-    ###
-    ### @param local_file_path[String,Pathname] the local path to the file to be uploaded
-    ###
-    ### @param rw_pw[String,Symbol] the password for the read/write account on the master Distribution Point,
-    ###   or :prompt, or :stdin# where # is the line of stdin containing the password See {JSS::DistributionPoint#mount}
-    ###
-    ### @param unmount[Boolean] whether or not ot unount the distribution point when finished.
-    ###
-    ### @return [void]
-    ###
-    def upload_master_file (local_file_path, rw_pw, unmount = true)
-
-      raise JSS::NoSuchItemError, "Please create this package in the JSS before uploading it." unless @in_jss
-
-      mdp = JSS::DistributionPoint.master_distribution_point
-      destination = mdp.mount(rw_pw, :rw) +"#{DIST_POINT_PKGS_FOLDER}/#{@filename}"
-
-      local_path = Pathname.new local_file_path
-      raise JSS::NoSuchItemError, "Local file '#{@local_file}' doesn't exist" unless local_path.exist?
-
-      ### should we zip it?
-      if local_path.directory?
-        begin
-          zipdir = Pathname.new "/tmp/jssgemtmp-#{Time.new.strftime "%Y%m%d%H%M%S"}-#{$$}"
-          zipdir.mkpath
-          zipdir.chmod 0700
-          zipfile = zipdir + (local_path.basename.to_s + ".zip")
-
-          ### go to the same dir as the local file
-          wd = Dir.pwd
-          Dir.chdir local_path.parent
-
-          ### the contents of the zip file have to have the same  name as the zip file itself (minus the .zip)
-          ### so temporarily rename the source
-          local_path.rename(local_path.parent + @filename)
-          raise "There was a problem zipping the pkg bundle" unless system "/usr/bin/zip -qr '#{zipfile}' '#{@filename}'"
-
-        ensure
-          ### rename the source to the original name
-          (local_path.parent + @filename).rename local_path
-          ### go back where we started
-          Dir.chdir wd
-        end # begin
-
-        ### update our info
-        local_path = zipfile
-
-        self.filename = zipfile.basename.to_s
-
-      end # if directory
-      self.update
-      FileUtils.copy_entry local_path, destination
-
-      mdp.unmount if unmount
-    end # upload
-
-    ###
-    ### Delete the filename from the master distribution point, if it exists.
-    ###
-    ### If you'll be uploading several files you can specify unmount as false, and do it manually when all
-    ### are finished.
-    ###
-    ### @param rw_pw[String] the password for the read/write account on the master Distribution Point
-    ###   or :prompt, or :stdin# where # is the line of stdin containing the password. See {JSS::DistributionPoint#mount}
-    ###
-    ### @param unmount[Boolean] whether or not ot unount the distribution point when finished.
-    ###
-    ### @return [Boolean] was the file deleted?
-    ###
-    def delete_master_file (rw_pw, unmount = true)
-      mdp = JSS::DistributionPoint.master_distribution_point
-      file = mdp.mount(rw_pw, :rw) +"#{DIST_POINT_PKGS_FOLDER}/#{@filename}"
-      if file.exist?
-        file.delete
-        did_it = true
-      else
-        did_it = false
-      end # if exists
-      mdp.unmount if unmount
-      return did_it
-    end # delete master file
-
-
-    ### Install this package via the jamf binary 'install' command from the
-    ### distribution point for this machine.
-    ### See {JSS::DistributionPoint.my_distribution_point}
-    ###
-    ### @note This code must be run as root to install packages
-    ###
-    ### The read-only or http passwd for the dist. point must be provided,
-    ### except for non-authenticated http downloads)
-    ###
-    ### @param args[Hash] the arguments for installation
-    ###
-    ### @option args :ro_pw[String] the read-only or http password for the
-    ###   distribution point for the local machine
-    ###   (http will be used if available, and may not need a pw)
-    ###
-    ### @option args :target[String,Pathname] The drive on which to install
-    ###  the package, defaults to '/'
-    ###
-    ### @option args :verbose [Boolean] be verbose to stdout, defaults to false
-    ###
-    ### @option args :feu[Boolean] fill existing users, defaults to false
-    ###
-    ### @option args :fut[Boolean] fill user template, defaults to false
-    ###
-    ### @option args :unmount[Boolean] unmount the distribution point when
-    ###   finished?(if we mounted it), defaults to false
-    ###
-    ### @option args :no_http[Boolean] don't use http downloads even if they
-    ###   are enabled for the dist. point.
-    ###
-    ### @option args :alt_download_url [String] Use this url for an http
-    ###   download, regardless of distribution point settings. This can be used
-    ###   to access Cloud Distribution Points if the fileshare isn't available.
-    ###   The URL should already be ur
-    ###   The package filename will be removed or appended as needed.
-    ###
-    ### @return [Boolean] did the jamf install succeed?
-    ###
-    ### @todo deal with cert-based https authentication in dist points
-    ###
-    def install (args = {})
-
-      raise JSS::UnsupportedError, "You must have root privileges to install packages" unless JSS.superuser?
-
-      args[:target] ||= '/'
-
-      ro_pw = args[:ro_pw]
-
-      # as of Casper 9.72, with http downloads, the jamf binary requires
-      # the filename must be at the  end of the -path url, but before 9.72
-      # it can't be.
-      # e.g.
-      #    in  <9.72:  jamf install  -package foo.pkg -path http://mycasper.myorg.edu/CasperShare/Packages
-      # but
-      #    in >=9.72:  jamf install  -package foo.pkg -path http://mycasper.myorg.edu/CasperShare/Packages/foo.pkg
-      #
-      append_at_vers = JSS.parse_jss_version("9.72")[:version]
-      our_vers = JSS.parse_jss_version(JSS::API.server.raw_version)[:version]
-      no_filename_in_url = (our_vers < append_at_vers)
-
-      # use a provided alternative url for an http download
-      if args[:alt_download_url]
-
-        # we'll re-add the filename below if needed.
-        src_path = args[:alt_download_url].chomp "/#{@filename}"
-
-      # use our appropriate dist. point for download
-      else
-        mdp = JSS::DistributionPoint.my_distribution_point
-
-        ### how do we access our dist. point? with http?
-        if mdp.http_downloads_enabled and (not args[:no_http])
-          using_http = true
-          src_path = mdp.http_url
-          if mdp.username_password_required
-            raise JSS::MissingDataError, "No password provided for http download" unless ro_pw
-            raise JSS::InvaldDatatError, "Incorrect password for http access to distribution point." unless mdp.check_pw(:http, ro_pw)
-            # insert the name and pw into the uri
-            reserved_chars = Regexp.new("[^#{URI::REGEXP::PATTERN::UNRESERVED}]") # we'll escape all the chars that aren't unreserved
-            src_path = src_path.sub(%r{(https?://)(\S)}, "#{$1}#{URI.escape mdp.http_username,reserved_chars}:#{URI.escape ro_pw, reserved_chars}@#{$2}")
-          end
-
-        # or with filesharing?
-        else
-          using_http = false
-          src_path = mdp.mount(ro_pw)
-        end
-
-        # look at the pkgs folder
-        src_path += "#{DIST_POINT_PKGS_FOLDER}"
-      end # if args[:alt_download_url]
-
-      src_path += "/#{@filename}" unless no_filename_in_url
-
-
-      ### are we doing "fill existing users" or "fill user template"?
-      do_feu = args[:feu] ? "-feu" : ""
-      do_fut = args[:fut] ? "-fut" : ""
-
-      ### the install args for jamf
-      command_args = "-package '#{@filename}' -path '#{src_path}'  -target '#{args[:target]}' #{do_feu} #{do_fut} -showProgress -verbose"
-
-      ### run it via a client cmd
-      install_out = JSS::Client.run_jamf :install, command_args, args[:verbose]
-
-      install_out =~ %r{<exitCode>(\d+)</exitCode>}
-      install_exit = $1 ? $1.to_i : nil
-      install_exit ||= $?.exitstatus
-
-
-      if (args.include? :unmount)
-        mdp.unmount unless using_http
-      end
-
-      return install_exit == 0 ? true : false
-    end
-
-    ###
-    ### @note This code must be run as root to uninstall packages
-    ###
-    ### Causes the pkg to be uninstalled via the jamf command.
-    ###
-    ### @param args[Hash] the arguments for installation
-    ###
-    ### @option args :target[String,Pathname] The drive from which to uninstall the package, defaults to '/'
-    ###
-    ### @option args :verbose[Boolean] be verbose to stdout, defaults to false
-    ###
-    ### @option args :feu[Boolean] fill existing users, defaults to false
-    ###
-    ### @option args :fut[Boolean] fill user template, defaults to false
-    ###
-    ### @return [Process::Status] the result of the 'jamf uninstall' command
-    ###
-    def uninstall (args = {})
-
-      raise JSS::UnsupportedError, \
-        "This package cannot be uninstalled. Please use CasperAdmin to index it and allow uninstalls" unless removable?
-      raise JSS::UnsupportedError, "You must have root privileges to uninstall packages" unless JSS.superuser?
-      args[:target] ||= '/'
-
-      ### are we doing "fill existing users" or "fill user template"?
-      do_feu = args[:feu] ? "-feu" : ""
-      do_fut = args[:fut] ? "-fut" : ""
-
-      ### use jamf binary to uninstall the pkg
-      jamf_opts = "-target '#{args[:target]}' -id '#{@id}' #{do_feu} #{do_fut}"
-
-      ### run it via a client
-      uninstall_out = JSS::Client.run_jamf "uninstall", jamf_opts, args[:verbose]
-
-      return $?
-    end
-
-
-
-    ### What type of package is this?
-    ###
-    ### @return [Symbol] :pkg or :dmg or:unknown
-    ###
-    def type
-      case @filename
-      when /\.m?pkg(\.zip)?$/ then :pkg
-      when /\.dmg$/ then :dmg
-      else :unknown
-      end
-    end
-
-
-    ################################
-    ### Private Instance Methods
-    ################################
-
-    private
-
-
-    ###
-    ### Return the REST XML for this pkg, with the current values,
-    ### for saving or updating
-    ###
-    def rest_xml
-      doc = REXML::Document.new APIConnection::XML_HEADER
-      pkg = doc.add_element "package"
-      pkg.add_element('allow_uninstalled').text = @allow_uninstalled
-      pkg.add_element('boot_volume_required').text = @boot_volume_required
-      pkg.add_element('category').text = @category.to_s.casecmp("No category assigned") == 0 ? "" : @category
-      pkg.add_element('filename').text = @filename
-      pkg.add_element('fill_existing_users').text = @fill_existing_users
-      pkg.add_element('fill_user_template').text = @fill_user_template
-      pkg.add_element('info').text = @info
-      pkg.add_element('install_if_reported_available').text = @install_if_reported_available
-      pkg.add_element('name').text = @name
-      pkg.add_element('notes').text = @notes
-      pkg.add_element('os_requirements').text = JSS.to_s_and_a(@os_requirements)[:stringform]
-      pkg.add_element('priority').text = @priority
-      pkg.add_element('reboot_required').text = @reboot_required
-      pkg.add_element('required_processor').text = @required_processor.to_s.empty? ? "None" : @required_processor
-      pkg.add_element('send_notification').text = @send_notification
-      pkg.add_element('switch_with_package').text = @switch_with_package
-      return doc.to_s
-    end # rest xml
-
-    public
-
-    # aliases under their methods seem to confuse the YARD documenter, so I'm putting them all here.
-    alias feu fill_existing_users
-    alias feu? fill_existing_users
-    alias fut fill_user_template
-    alias fut? fill_user_template
-    alias reboot reboot_required
-    alias reboot? reboot_required
-    alias oses os_requirements
-    alias cpu_type required_processor
-    alias removable allow_uninstalled
-    alias removable? allow_uninstalled
-    alias if_in_swupdate install_if_reported_available
-    alias if_in_swupdate? install_if_reported_available
-    alias boot boot_volume_required
-    alias boot? boot_volume_required
-    alias notify send_notification
-
-    alias removable= allow_uninstalled=
-    alias boot= boot_volume_required=
-    alias feu= fill_existing_users=
-    alias fut= fill_user_template=
-    alias if_in_swupdate= install_if_reported_available=
-    alias oses= os_requirements=
-    alias reboot= reboot_required=
-    alias cpu_type= required_processor=
-    alias notify= send_notification=
-
-
-
-
-
-  end # class Package
-
-end # module jss