ruby-jss 0.8.2 → 0.9.0.b1

data/lib/jss/api_object/mobile_device_application.rb

@@ -52,6 +52,10 @@ module JSS
     # Class Methods
     #####################################
 
+    def self.all_bundle_ids(refresh = false)
+      all(refresh).map { |mda| mda[:bundle_id] }
+    end
+
     # Class Constants
     #####################################
 
@@ -78,6 +82,12 @@ module JSS
       attachment: :mobiledeviceapplications
     }.freeze
 
+    # see JSS::APIObject
+    OTHER_LOOKUP_KEYS = {
+      bundleid: {rsrc_id: :bundleid, list: :all_bundle_ids},
+      bundle_id: {rsrc_id: :bundleid, list: :all_bundle_ids}
+    }.freeze
+
     # Attributes
     #####################################
 
@@ -412,7 +422,7 @@ module JSS
     #
     def refresh_ipa
       return nil unless @in_jss
-      fresh_data = JSS::API.get_rsrc(@rest_rsrc)[self.class::RSRC_OBJECT_KEY]
+      fresh_data = JSS.api_connection.get_rsrc(@rest_rsrc)[self.class::RSRC_OBJECT_KEY]
       @ipa = fresh_data[:general][:ipa]
     end
 

data/lib/jss/api_object/package.rb

@@ -631,7 +631,7 @@ module JSS
       #    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]
+      our_vers = JSS.parse_jss_version(JSS.api_connection.server.raw_version)[:version]
       no_filename_in_url = (our_vers < append_at_vers)
 
       # use a provided alternative url for an http download

data/lib/jss/api_object/policy.rb

@@ -78,7 +78,6 @@ module JSS
     include JSS::SelfServable
     include JSS::Categorizable
 
-
     #####################################
     ### Class Methods
     #####################################
@@ -207,8 +206,44 @@ module JSS
       custom: :trigger_other
     }.freeze
 
+    NO_USER_LOGGED_IN = [
+      'Do not restart',
+      'Restart immediately',
+      'Restart if a package or update requires it'
+    ].freeze
+
+    USER_LOGGED_IN = [
+      'Do not restart',
+      'Restart',
+      'Restart if a package or update requires it',
+      'Restart immediately'
+    ].freeze
+
     SCOPE_TARGET_KEY = :computers
 
+    # Log Flushing
+
+    LOG_FLUSH_RSRC = 'logflush'.freeze
+
+    LOG_FLUSH_INTERVAL_INTEGERS = {
+      0 => 'Zero',
+      1 => 'One',
+      2 => 'Two',
+      3 => 'Three',
+      6 => 'Six'
+    }.freeze
+
+    LOG_FLUSH_INTERVAL_PERIODS = {
+      day: 'Day',
+      days: 'Day',
+      week: 'Week',
+      weeks: 'Week',
+      month: 'Month',
+      months: 'Month',
+      year: 'Year',
+      years: 'Year'
+    }.freeze
+
     ######################
     ### Attributes
     ######################
@@ -599,7 +634,6 @@ module JSS
 
         @printers = @init_data[:printers]
 
-
         ### Not in jss yet
       end
 
@@ -713,6 +747,136 @@ module JSS
       @need_to_update = true
     end
 
+    ### Set Server Side Activation
+    ###
+    ### @param activation[Time] Activation date and time
+    ###
+    ### @return [void]
+    ###
+    def server_side_activation=(activation)
+      raise JSS::InvalidDataError, 'Activation must be a Time' unless activation.is_a? Time
+      @server_side_limitations[:activation] = activation
+      @need_to_update = true
+    end
+
+    ### Set Server Side Expiration
+    ###
+    ### @param expiration[Time] Expiration date and time
+    ###
+    ### @return [void]
+    ###
+    def server_side_expiration=(expiration)
+      raise JSS::InvalidDataError, 'Expiration must be a Time' unless expiration.is_a? Time
+      @server_side_limitations[:expiration] = expiration
+      @need_to_update = true
+    end
+
+    ### Reboot Options
+    ### Set Reboot Message
+    ###
+    ### @param reboot_message[String] Text of Reboot Message
+    ###
+    ### @return [void] description of returned object
+    ###
+    def message=(reboot_message)
+      raise JSS::InvalidDataError, 'Reboot message must be a String' unless reboot_message.is_a? String
+      @reboot_options[:message] = reboot_message
+      @need_to_update = true
+    end
+
+    ### Reboot Options
+    ### Set Startup Disk
+    ### Only Supports 'Specify Local Startup Disk' at the moment
+    ###
+    ### @param startup_disk_option[String]
+    ###
+    ### @return [void]
+    ###
+    def startup_disk=(startup_disk_option)
+      raise JSS::InvalidDataError, "#{startup_disk_option} is not a valid Startup Disk" unless startup_disk_option.is_a? String
+      @reboot_options[:startup_disk] = 'Specify Local Startup Disk'
+      self.specify_startup = startup_disk_option
+      @need_to_update = true
+    end
+
+    ### Reboot Options
+    ### Specify Startup Volume
+    ### Only Supports "Specify Local Startup Disk"
+    ###
+    ### @param startup_volume[String] a Volume to reboot to
+    ###
+    ### @return [void]
+    ###
+    def specify_startup=(startup_volume)
+      raise JSS::InvalidDataError, "#{startup_volume} is not a valid Startup Disk" unless startup_volume.is_a? String
+      @reboot_options[:specify_startup] = startup_volume
+      @need_to_update = true
+    end
+
+    ### Reboot Options
+    ### No User Logged In
+    ###
+    ### @param no_user_option[String] Any one of the Strings from NO_USER_LOGGED_IN
+    ###
+    ### @return [void]
+    ###
+    def no_user_logged_in=(no_user_option)
+      raise JSS::InvalidDataError, "no_user_logged_in options: #{NO_USER_LOGGED_IN.join(', ')}" unless NO_USER_LOGGED_IN.include? no_user_option
+      @reboot_options[:no_user_logged_in] = no_user_option
+      @need_to_update = true
+    end
+
+    ### Reboot Options
+    ### User Logged In
+    ###
+    ### @param logged_in_option[String] Any one of the Strings from USER_LOGGED_IN
+    ###
+    ### @return [void]
+    ###
+    def user_logged_in=(logged_in_option)
+      raise JSS::InvalidDataError, "user_logged_in options: #{USER_LOGGED_IN.join(', ')}" unless USER_LOGGED_IN.include? logged_in_option
+      @reboot_options[:user_logged_in] = logged_in_option
+      @need_to_update = true
+    end
+
+    ### Reboot Options
+    ### Do Not Reboot
+    ### Shortcut method to suppress Reboot Options
+    ###
+    ### @return [void]
+    ###
+    def do_not_reboot
+      @reboot_options[:user_logged_in] = 'Do not restart'
+      @reboot_options[:no_user_logged_in] = 'Do not restart'
+      @need_to_update = true
+    end
+
+    ### Reboot Options
+    ### Minutes Until Reboot
+    ###
+    ### @param minutes[String] The number of minutes to delay prior to reboot
+    ###
+    ### @return [void]
+    ###
+    def minutes_until_reboot=(minutes)
+      raise JSS::InvalidDataError, 'Minutes until reboot must be an Integer' unless minutes.is_a? Integer
+      @reboot_options[:minutes_until_reboot] = minutes
+      @need_to_update = true
+    end
+
+    ### Reboot Options
+    ### FileVault Authenticated Reboot
+    ###
+    ### @param fv_bool[Boolean] true or false
+    ###
+    ### @return [void]
+    ###
+    def file_vault_2_reboot=(fv_bool)
+      raise JSS::InvalidDataError, 'FileVault 2 Reboot must be a Boolean' unless fv_bool.jss_boolean?
+      @reboot_options[:file_vault_2_reboot] = fv_bool
+      @need_to_update = true
+    end
+
     ###### Files & Processes
 
     ### @return [String] The unix shell command to run on ths client.
@@ -1103,6 +1267,33 @@ module JSS
       $CHILD_STATUS.exitstatus.zero? ? true : false
     end
 
+    # Flush all policy logs for this policy older than
+    # some number of days, weeks, months or years.
+    #
+    # With no parameters, flushes all logs
+    #
+    # NOTE: Currently the API doesn't have a way to
+    # flush only failed policies.
+    #
+    # @param older_than[Integer] 0, 1, 2, 3, or 6
+    #
+    # @param period[Symbol] :days, :weeks, :months, or :years
+    #
+    # @return [void]
+    #
+    def flush_logs(older_than: 0, period: :days)
+      raise JSS::NoSuchItemError, "Policy doesn't exist in the JSS. Use #create first." \
+        unless @in_jss
+      raise JSS::InvalidDataError, "older_than must be one of: #{LOG_FLUSH_INTERVAL_INTEGERS.keys.join ', '}" \
+        unless LOG_FLUSH_INTERVAL_INTEGERS.keys.include? older_than
+      raise JSS::InvalidDataError, "period must be one of: :#{LOG_FLUSH_INTERVAL_PERIODS.keys.join ', :'}" \
+        unless LOG_FLUSH_INTERVAL_PERIODS.keys.include? period
+
+      interval = "#{LOG_FLUSH_INTERVAL_INTEGERS[older_than]}+#{LOG_FLUSH_INTERVAL_PERIODS[period]}"
+
+      JSS.api_connection.delete_rsrc "#{LOG_FLUSH_RSRC}/policy/id/#{@id}/interval/#{interval}"
+    end
+
     ###### Aliases
 
     alias enabled? enabled
@@ -1130,8 +1321,21 @@ module JSS
 
       JSS.hash_to_rexml_array(@trigger_events).each { |t| general << t }
 
+      date_time_limitations = general.add_element 'date_time_limitations'
+      date_time_limitations.add_element('expiration_date_epoch').text = @server_side_limitations[:expiration].to_jss_epoch if @server_side_limitations[:expiration]
+      date_time_limitations.add_element('activation_date_epoch').text = @server_side_limitations[:activation].to_jss_epoch if @server_side_limitations[:activation]
+
       obj << @scope.scope_xml
 
+      reboot = obj.add_element 'reboot'
+      reboot.add_element('message').text = @reboot_options[:message] if @reboot_options[:message]
+      reboot.add_element('startup_disk').text = @reboot_options[:startup_disk] if @reboot_options[:startup_disk]
+      reboot.add_element('specify_startup').text = @reboot_options[:specify_startup] if @reboot_options[:specify_startup]
+      reboot.add_element('no_user_logged_in').text = @reboot_options[:no_user_logged_in] if @reboot_options[:no_user_logged_in]
+      reboot.add_element('user_logged_in').text = @reboot_options[:user_logged_in] if @reboot_options[:user_logged_in]
+      reboot.add_element('minutes_until_reboot').text = @reboot_options[:minutes_until_reboot] if @reboot_options[:minutes_until_reboot]
+      reboot.add_element('file_vault_2_reboot').text = @reboot_options[:file_vault_2_reboot] if @reboot_options[:file_vault_2_reboot]
+
       files_processes = obj.add_element 'files_processes'
       JSS.hash_to_rexml_array(@files_processes).each { |f| files_processes << f }
 

data/lib/jss/api_object/restricted_software.rb

@@ -1,79 +1,67 @@
 module JSS
-  #####################################
-  ### Classes
-  #####################################
-
-  ###
-  ### Restricted Software in the JSS.
-  ###
-  ### This class only supports showing of object data.
-  ###
-  ### @see JSS::APIObject
-  ###
+
+  # Restricted Software items in the JSS.
+  #
+  # @see JSS::APIObject
+  #
   class RestrictedSoftware < JSS::APIObject
 
+    # Mix-Ins
     #####################################
-    ### Mix-Ins
-    #####################################
-
+    include JSS::Updatable
+    include JSS::Creatable
     include JSS::Scopable
 
-    #####################################
-    ### Class Constants
+    # Class Constants
     #####################################
 
-    ### The base for REST resources of this class
-    RSRC_BASE = "restrictedsoftware"
+    # The base for REST resources of this class
+    RSRC_BASE = 'restrictedsoftware'.freeze
 
-    ### the hash key used for the JSON list output of all objects in the JSS
+    # 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
+    # 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]
+    # these keys, as well as :id and :name,  are present in valid API JSON data for this class
+    VALID_DATA_KEYS = [:scope].freeze
 
-    ### Our scopes deal with computers
+    # Our scopes deal with computers
     SCOPE_TARGET_KEY = :computers
 
-    #####################################
-    ### Attributes
+    # 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
+    # @return [String] the process name
     attr_reader :process_name
 
-    ### @return [Boolean] whether to return match exact process name
+    # @return [Boolean] whether to return match exact process name
     attr_reader :match_exact_process_name
 
-    ### @return [Boolean] whether to send a notification
+    # @return [Boolean] whether to send a notification
     attr_reader :send_notification
 
-    ### @return [Boolean] whether to kill the running process
+    # @return [Boolean] whether to kill the running process
     attr_reader :kill_process
 
-    ### @return [Boolean] whether to delete the executable
+    # @return [Boolean] whether to delete the executable
     attr_reader :delete_executable
 
-    ### @return [String] message displayed to the user
+    # @return [String] message displayed to the user
     attr_reader :display_message
 
-    ### @return [Hash] the :name and :id of the site for this machine
+    # @return [Hash] the :name and :id of the site for this machine
     attr_reader :site
 
-    #####################################
-    ### Instance Methods
+    # Instance Methods
     #####################################
 
     def initialize(args = {})
-      super args, []
+      super args
 
+      @init_data[:general] ||= {}
       @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]
@@ -81,6 +69,102 @@ module JSS
       @delete_executable = @init_data[:general][:delete_executable]
       @display_message = @init_data[:general][:display_message]
       @site = JSS::APIObject.get_name(@init_data[:general][:site])
+      @site ||= 'None'
+      @scope ||= JSS::Scopable::Scope.new SCOPE_TARGET_KEY, nil
+    end # init
+
+    def process_name=(new_val)
+      @process_name = new_val.to_s
+      @need_to_update = true
+    end
+
+    def match_exact_process_name=(new_val)
+      confirm_boolean(new_val)
+      @match_exact_process_name = new_val
+      @need_to_update = true
+    end
+
+    def send_notification=(new_val)
+      confirm_boolean(new_val)
+      @send_notification = new_val
+      @need_to_update = true
+    end
+
+    def kill_process=(new_val)
+      confirm_boolean(new_val)
+      @kill_process = new_val
+      @need_to_update = true
+    end
+
+    def delete_executable=(new_val)
+      confirm_boolean(new_val)
+      @delete_executable = new_val
+      @need_to_update = true
+    end
+
+    def display_message=(new_val)
+      @display_message = new_val.to_s
+      @need_to_update = true
     end
-  end
-end
+
+    def site=(new_val)
+      if new_val.is_a? Integer
+        raise JSS::NoSuchItemError, "No site found with id #{new_val}" unless JSS::Site.all_ids.include? new_val
+        new_val = JSS::Site.map_all_ids_to(:name)[new_val]
+      else
+        new_val = new_val.to_s
+        raise JSS::NoSuchItemError, "No site found with name #{new_val}" unless JSS::Site.all_names.include? new_val
+      end
+      @site = new_val
+      @need_to_update = true
+    end
+
+    def create
+      raise JSS::MissingDataError, 'process_name must be set before creating' if @process_name.to_s.empty?
+      raise JSS::AlreadyExistsError, "A #{RSRC_OBJECT_KEY} named #{@name} already exists in the JSS" if self.class.all_names(:refresh).include? @name
+      super
+    end
+
+    def update
+      raise JSS::MissingDataError, 'process_name must be set before updating' if @process_name.to_s.empty?
+      super
+    end
+
+    ##### Aliases
+
+    alias match_exact_process_name? match_exact_process_name
+    alias send_notification? send_notification
+    alias kill_process? kill_process
+    alias delete_executable? delete_executable
+
+    ##### Private Instance Methods
+    private
+
+    def rest_xml
+      doc = REXML::Document.new APIConnection::XML_HEADER
+      obj = doc.add_element RSRC_OBJECT_KEY.to_s
+
+      general = obj.add_element 'general'
+      general.add_element('name').text = @name
+      general.add_element('process_name').text = @process_name
+      general.add_element('match_exact_process_name').text = @match_exact_process_name.to_s
+      general.add_element('send_notification').text = @send_notification.to_s
+      general.add_element('kill_process').text = @kill_process.to_s
+      general.add_element('delete_executable').text = @delete_executable.to_s
+      general.add_element('display_message').text = @display_message.to_s
+
+      site = general.add_element 'site'
+      site.add_element('name').text = @site
+
+      obj << @scope.scope_xml
+      doc.to_s
+    end # rest_xml
+
+    # TODO: Move this into a Validators module
+    def confirm_boolean(val)
+      raise JSS::InvalidDataError, 'Value must be boolean true or false' unless JSS::TRUE_FALSE.include? val
+    end
+
+  end # class
+
+end # module JSS