ruby-jss 0.6.4 → 0.6.5

data/lib/jss/api_object/package.rb

@@ -86,11 +86,6 @@ module JSS
     ### 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)
 
@@ -190,7 +185,7 @@ module JSS
 
       @priority = @init_data[:priority] || DEFAULT_PRIORITY
       @reboot_required = @init_data[:reboot_required]
-      @required_processor = @init_data[:required_processor] || DEFAULT_CPU_TYPE
+      @required_processor = @init_data[:required_processor] || DEFAULT_PROCESSOR
       @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
@@ -270,7 +265,7 @@ module JSS
       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
+      $stderr.puts "WARNING: you must change the filename on the master Distribution Point. See JSS::Package.update_master_filename." if @in_jss
       @filename = new_val
       @need_to_update = true
     end
@@ -573,6 +568,39 @@ module JSS
     end # upload
 
 
+    ### Change the name of a package file on the master distribution point.
+    ###
+    ### @param new_file_name[String]
+    ###
+    ### @param old_file_name[default: @filename, String]
+    ###
+    ### @param unmount[Boolean] whether or not ot unount the distribution point when finished.
+    ###
+    ### @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}
+    ###
+    ### @return [nil]
+    ###
+    def update_master_filename(old_file_name, new_file_name, rw_pw , unmount = true )
+      raise JSS::NoSuchItemError, "#{old_file_name} does not exist in the jss." unless @in_jss
+      mdp = JSS::DistributionPoint.master_distribution_point
+      pkgs_dir =  mdp.mount(rw_pw, :rw) + "#{DIST_POINT_PKGS_FOLDER}"
+      old_file = pkgs_dir + old_file_name
+      new_file = pkgs_dir + new_file_name
+      if new_file.extname.empty? 
+      ### use the extension of the original file.
+        new_file = pkgs_dir + (new_file_name + old_file.extname)
+      end
+      if old_file.exist?
+        old_file.rename new_file
+      else
+        raise JSS::NoSuchItemError, "Original file not found on the master distribution point at #{DIST_POINT_PKGS_FOLDER}/#{old_file_name}."
+      end # if exist
+      mdp.unmount if unmount
+      return nil
+    end # update_master_filename
+
+
     ### 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
@@ -692,8 +720,8 @@ module JSS
             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}")
+            # 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}#{CGI.escape mdp.http_username}:#{CGI.escape ro_pw}@#{$2}")
           end
 
         # or with filesharing?
@@ -703,11 +731,12 @@ module JSS
         end
 
         # look at the pkgs folder
-        src_path += "#{DIST_POINT_PKGS_FOLDER}"
+        src_path += "#{DIST_POINT_PKGS_FOLDER}/"
       end # if args[:alt_download_url]
 
-      src_path += "/#{@filename}" unless no_filename_in_url
-
+      if using_http
+        src_path += "#{@filename}" unless no_filename_in_url
+      end
 
       ### are we doing "fill existing users" or "fill user template"?
       do_feu = args[:feu] ? "-feu" : ""

data/lib/jss/api_object/restricted_software.rb

@@ -0,0 +1,86 @@
+module JSS
+  #####################################
+  ### Classes
+  #####################################
+
+  ###
+  ### Restricted Software in the JSS.
+  ###
+  ### This class only supports showing of object data.
+  ###
+  ### @see JSS::APIObject
+  ###
+  class RestrictedSoftware < JSS::APIObject
+
+    #####################################
+    ### Mix-Ins
+    #####################################
+
+    include JSS::Scopable
+
+    #####################################
+    ### Class Constants
+    #####################################
+
+    ### The base for REST resources of this class
+    RSRC_BASE = "restrictedsoftware"
+
+    ### the hash key used for the JSON list output of all objects in the JSS
+    RSRC_LIST_KEY = :restricted_software
+
+    ### The hash key used for the JSON object output.
+    ### It's also used in various error messages
+    RSRC_OBJECT_KEY = :restricted_software
+
+    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
+    VALID_DATA_KEYS = [:scope]
+
+    ### Our scopes deal with computers
+    SCOPE_TARGET_KEY = :computers
+
+    #####################################
+    ### Attributes
+    #####################################
+
+    ### The values returned in the General, Location, and Purchasing subsets are stored as direct attributes
+    ### Location and Purchasing are defined in the Locatable and Purchasable mixin modules.
+    ### Here's General, in alphabetical order
+
+    ### @return [String] the process name
+    attr_reader :process_name
+
+    ### @return [Boolean] whether to return match exact process name
+    attr_reader :match_exact_process_name
+
+    ### @return [Boolean] whether to send a notification
+    attr_reader :send_notification
+
+    ### @return [Boolean] whether to kill the running process
+    attr_reader :kill_process
+
+    ### @return [Boolean] whether to delete the executable
+    attr_reader :delete_executable
+
+    ### @return [String] message displayed to the user
+    attr_reader :display_message
+
+    ### @return [Hash] the :name and :id of the site for this machine
+    attr_reader :site
+
+    #####################################
+    ### Instance Methods
+    #####################################
+
+    def initialize(args = {})
+      super args, []
+
+      @process_name = @init_data[:general][:process_name]
+      @match_exact_process_name = @init_data[:general][:match_exact_process_name]
+      @send_notification = @init_data[:general][:send_notification]
+      @kill_process = @init_data[:general][:kill_process]
+      @delete_executable = @init_data[:general][:delete_executable]
+      @display_message = @init_data[:general][:display_message]
+      @site = JSS::APIObject.get_name(@init_data[:general][:site])
+    end
+  end
+end

data/lib/jss/api_object/script.rb

@@ -193,7 +193,7 @@ module JSS
       @name = new_val
 
       ### if our REST resource is based on the name, update that too
-      @rest_rsrc = "#{RSRC_BASE}/name/#{URI.escape @name}" if @rest_rsrc.include? '/name/'
+      @rest_rsrc = "#{RSRC_BASE}/name/#{CGI.escape @name}" if @rest_rsrc.include? '/name/'
       @need_to_update = true
     end #name=
 

data/lib/jss/api_object/self_servable.rb

@@ -1,25 +1,25 @@
 ### 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.
-### 
+###
 ###
 
 ###
@@ -41,19 +41,19 @@ module JSS
   ###
   ### The JSS objects that have Self Service data return it in a :self_service subset,
   ### which all have similar data, a hash with at least these keys:
-  ### - :self_service_description 
-  ### - :self_service_icon 
+  ### - :self_service_description
+  ### - :self_service_icon
   ###
   ### Most also have:
   ### - :feature_on_main_page
   ### - :self_service_categories
   ###
-  ### iOS Profiles in self service have this key: 
-  ### - :security 
+  ### iOS Profiles in self service have this key:
+  ### - :security
   ###
   ### Additionally, items that apper in OS X SlfSvc have these keys:
   ### - :install_button_text
-  ### - :force_users_to_view_description 
+  ### - :force_users_to_view_description
   ###
   ### See the attribute definitions for details of these values and structures.
   ###
@@ -71,14 +71,14 @@ module JSS
   ### - Define the constant SELF_SERVICE_PAYLOAD which contains one of :policy, :profile, or :app
   ### - Call {#parse_self_service} in the subclass's constructor after calling super
   ### - Include the result of {#self_service_xml} in their #rest_xml output
-  ### - Define the method #in_self_service? which returns a Boolean indicating that the item is 
+  ### - Define the method #in_self_service? which returns a Boolean indicating that the item is
   ###   available in self service. Different API objects indicate this in different ways.
   ### - Define the method #user_removable? which returns Boolean indicating that the item (a profile)
   ###   can be removed by the user in SSvc. OS X profiles store this in the :user_removable key of the
   ###   :general subset as a boolean, whereas iOS profiles stor it in :security as one of 3 strings
   ###
   ###
-  ### Notes: 
+  ### Notes:
   ### - Self service icons cannot be modified via this code. Use the Web UI.
   ### - There an API bug in handling categories, and all but the last one are ommitted. Until this is fixed, categories
   ###   cannot be saved via this code since that would cause data-loss when more than one category is applied.
@@ -90,19 +90,19 @@ module JSS
     #####################################
 
     SELF_SERVABLE = true
-    
+
     IOS_PROFILE_REMOVAL_OPTIONS = ["Always", "With Authorization", "Never"]
-    
+
     #####################################
     ###  Variables
     #####################################
-    
-    
+
+
     #####################################
     ###  Attribtues
     #####################################
 
-    
+
     ### @return [String] The verbage that appears in SelfSvc for this item
     attr_reader :self_service_description
 
@@ -127,7 +127,7 @@ module JSS
     ### - :display_in => [Boolean] should the item be displayed in this category in SSvc? (OSX SSvc only)
     ### - :feature_in => [Boolean] should the item be featured in this category in SSVC? (OSX SSvc only)
     ###
-    ### NOTE: as of Casper 9.61 there's a bug in the JSON output from the API, and only the last 
+    ### NOTE: as of Casper 9.61 there's a bug in the JSON output from the API, and only the last
     ### category is returned, if more than one are set.
     ###
     attr_reader :self_service_categories
@@ -145,7 +145,7 @@ module JSS
 
     ### @return [String] The text label on the install button in SSvc (OSX SSvc only)
     attr_reader :self_service_install_button_text
-    
+
     ### @return [Boolean] Should an extra window appear before the user can install the item? (OSX SSvc only)
     attr_reader :self_service_force_users_to_view_description
 
@@ -165,32 +165,29 @@ module JSS
     def parse_self_service
       @init_data[:self_service] ||= {}
       ss_data = @init_data[:self_service]
-      
+
       @self_service_description = ss_data[:self_service_description]
       @self_service_icon = ss_data[:self_service_icon]
-      
+
       @self_service_feature_on_main_page = ss_data[:feature_on_main_page]
-      
-      # TEMPORARY - until JAMF fixes the category data in JSON
-      @self_service_categories = [
-        ss_data[:self_service_categories][:category]
-      ]
-      
+
+      @self_service_categories = ss_data[:self_service_categories]
+
       # make this an empty hash if needed
       @self_service_security = ss_data[:security] || {}
-      
-      # if this is an osx profile, set @self_service_security[:removal_disallowed] to "Always" or "Never" 
+
+      # if this is an osx profile, set @self_service_security[:removal_disallowed] to "Always" or "Never"
       # to indicate the boolean :user_removable
       if @init_data[:general].keys.include? :user_removable
         @self_service_security[:removal_disallowed] = @init_data[:general][:user_removable] ? "Always" : "Never"
       end
-      
+
       @self_service_install_button_text = ss_data[:install_button_text]
       @self_service_force_users_to_view_description = ss_data[:force_users_to_view_description]
 
     end
 
-    
+
     ###
     ###
     ### Setters
@@ -218,9 +215,9 @@ module JSS
       @self_service_install_button_text = new_val.strip
       @need_to_update = true
     end
-    
+
     ###
-    ### @param new_val[Boolean] should this appear on the main SelfSvc page? 
+    ### @param new_val[Boolean] should this appear on the main SelfSvc page?
     ###
     ### @return [void]
     ###
@@ -230,9 +227,9 @@ module JSS
       @self_service_feature_on_main_page = new_val
       @need_to_update = true
     end
-    
+
     ###
-    ### @param new_val[Boolean] should this appear on the main SelfSvc page? 
+    ### @param new_val[Boolean] should this appear on the main SelfSvc page?
     ###
     ### @return [void]
     ###
@@ -243,7 +240,7 @@ module JSS
       @self_service_force_users_to_view_description = new_val
       @need_to_update = true
     end
-    
+
     ###
     ### Add or change one of the categories for this item in SSvc.
     ###
@@ -260,21 +257,21 @@ module JSS
       raise JSS::NoSuchItemError, "No category '#{new_cat}' in the JSS" unless JSS::Category.all_names(:refresh).include? new_cat
       raise JSS::InvalidDataError, "display_in must be true or false" unless JSS::TRUE_FALSE.include? display_in
       raise JSS::InvalidDataError, "feature_in must be true or false" unless JSS::TRUE_FALSE.include? feature_in
-      
+
       new_data = {:name => new_cat, :display_in => display_in, :feature_in => feature_in }
-      
+
       # see if this category is already among our categories.
       idx = @self_service_categories.index{|c| c[new_cat]}
-      
-      if idx 
+
+      if idx
         @self_service_categories[idx] = new_data
       else
         @self_service_categories << new_data
       end
-      
+
       @need_to_update = true
     end
-    
+
     ###
     ### Remove a category from those for this item in SSvc
     ###
@@ -296,17 +293,17 @@ module JSS
     ### @return [void]
     ###
     def profile_can_be_removed (new_val)
-      
-      new_val = "Always" if new_val === true 
+
+      new_val = "Always" if new_val === true
       new_val = "Never" if new_val === false
-      
+
       return nil if new_val == @self_service_security[:removal_disallowed]
       raise JSS::InvalidDataError, "" unless IOS_PROFILE_REMOVAL_OPTIONS.include? new_val
-      
+
       @self_service_security[:removal_disallowed] = new_val
     end
-    
-    
+
+
     ###
     ### @api private
     ###
@@ -317,16 +314,16 @@ module JSS
     ### @return [REXML::Element]
     ###
     def self_service_xml
-      
+
       ssvc = REXML::Element.new('self_service')
-      
+
       return ssvc unless self.in_self_service?
-      
+
       ssvc.add_element('self_service_description').text = @self_service_description
       ssvc.add_element('feature_on_main_page').text = @self_service_feature_on_main_page
-      
+
       ### TEMPORARY - re-enable this when the category bug is fixed.
-      
+
 #       cats = ssvc.add_element('self_service_categories')
 #       @self_service_categories.each do |cat|
 #         catelem = cats.add_element('category')
@@ -334,22 +331,22 @@ module JSS
 #         catelem.add_element('display_in').text = cat[:display_in] if cat.keys.include? :display_in
 #         catelem.add_element('feature_in').text = cat[:feature_in] if cat.keys.include? :feature_in
 #       end
-      
+
       unless @self_service_security.empty?
         sec = ssvc.add_element('security')
         sec.add_element('removal_disallowed').text = @self_service_security[:removal_disallowed] if @self_service_security[:removal_disallowed]
         sec.add_element('password').text = @self_service_security[:password] if @self_service_security[:password]
       end
-      
+
       ssvc.add_element('install_button_text').text = @self_service_install_button_text if @self_service_install_button_text
       ssvc.add_element('force_users_to_view_description').text = @self_service_force_users_to_view_description unless @self_service_force_users_to_view_description.nil?
 
       return ssvc
     end
-    
+
     ### aliases
     alias change_self_service_category add_self_service_category
-    
+
   end # module SelfServable
 
 end # module JSS