ruby-jss 1.2.6 → 1.4.1

data/lib/jss/api_object/script.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jss/api_object/self_servable.rb

@@ -1,5 +1,5 @@
 
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -51,12 +51,12 @@ module JSS
   # - :security
   #
   # Additionally, items that apper in macOS Slf Svc have these keys:
-  # - :self_service_display_name
+  # - :self_service_display_name (but not JSS::MacApplication)
   # - :install_button_text
-  # - :reinstall_button_text
+  # - :reinstall_button_text (but not JSS::MacApplication)
   # - :force_users_to_view_description
   # - :notification
-  # - :notification_location # PENDING API FIX
+  # - :notification_location # PENDING API FIX, and also, not JSS::MacApplication
   # - :notification_subject
   # - :notification_message
   #
@@ -178,15 +178,14 @@ module JSS
         notification_reminders: true
       },
       JSS::MacApplication => {
-        # in_self_service_data_path was finally implemnted in JamfPro 10.9
-        # Jamf Product Issue [PI-003773]
-        in_self_service_data_path: [:general, :deployment_type],
+        in_self_service_data_path: %i[general deployment_type],
         in_self_service: MAKE_AVAILABLE,
         not_in_self_service: AUTO_INSTALL_OR_PROMPT,
         targets: [:macos],
         payload: :app,
         can_display_in_categories: true,
         can_feature_in_categories: true,
+        notifications_supported: :ssvc_and_nctr,
         url_entity: 'app'
         # OTHER BUG: no notification options seem to be changable via the API
       },
@@ -329,6 +328,7 @@ module JSS
     #
     def self_service_view_url
       return nil unless @self_service_data_config[:url_entity]
+
       "#{USER_URL_BASE}#{@self_service_data_config[:url_entity]}&id=#{id}&action=#{USER_URL_VIEW_ACTION}"
     end
 
@@ -336,6 +336,7 @@ module JSS
     #
     def self_service_execute_url
       return nil unless @self_service_data_config[:url_entity]
+
       "#{USER_URL_BASE}#{@self_service_data_config[:url_entity]}&id=#{id}&action=#{USER_URL_EXEC_ACTION}"
     end
 
@@ -347,8 +348,9 @@ module JSS
     # @return [void]
     #
     def self_service_description=(new_val)
-      new_val.strip!
+      new_val = new_val.strip
       return if @self_service_description == new_val
+
       @self_service_description = new_val
       @need_to_update = true
     end
@@ -358,7 +360,7 @@ module JSS
     # @return [void]
     #
     def self_service_display_name=(new_val)
-      new_val.strip!
+      new_val = new_val.strip
       return nil if @self_service_dislay_name == new_val
       raise JSS::InvalidDataError, 'Only macOS Self Service items have display names' unless self_service_targets.include? :macos
       @self_service_dislay_name = new_val
@@ -372,7 +374,7 @@ module JSS
     # @return [void]
     #
     def self_service_install_button_text=(new_val)
-      new_val.strip!
+      new_val = new_val.strip
       return nil if @self_service_install_button_text == new_val
       raise JSS::InvalidDataError, 'Only macOS Self Service Items can have custom button text' unless self_service_targets.include? :macos
       @self_service_install_button_text = new_val
@@ -384,7 +386,7 @@ module JSS
     # @return [void]
     #
     def self_service_reinstall_button_text=(new_val)
-      new_val.strip!
+      new_val = new_val.strip
       return nil if @self_service_reinstall_button_text == new_val
       raise JSS::InvalidDataError, 'Only macOS Self Service Items can have custom button text' unless self_service_targets.include? :macos
       @self_service_reinstall_button_text = new_val
@@ -532,7 +534,7 @@ module JSS
     # @return [void]
     #
     def self_service_notification_subject=(subj)
-      subj.strip!
+      subj = subj.strip
       return if subj == @self_service_notification_subject
       validate_notifications_supported
       @self_service_notification_subject = subj
@@ -544,7 +546,7 @@ module JSS
     # @return [void]
     #
     def self_service_notification_message=(msg)
-      msg.strip!
+      msg = msg.strip
       return if msg == @self_service_notification_message
       validate_notifications_supported
       @self_service_notification_message = msg
@@ -820,7 +822,7 @@ module JSS
       # ssvc subset...
       add_in_self_service_xml doc_root
 
-      subset_key = @self_service_data_config[:self_service_subset] ? @self_service_data_config[:self_service_subset] : :self_service
+      subset_key = @self_service_data_config[:self_service_subset] || :self_service
 
       ssvc = doc_root.add_element subset_key.to_s
 
@@ -857,6 +859,7 @@ module JSS
     # add the xml specific to profiles
     def add_self_service_profile_xml(ssvc, doc_root)
       return unless self_service_payload == :profile
+
       if self_service_targets.include? :ios
         sec = ssvc.add_element('security')
         sec.add_element('removal_disallowed').text = PROFILE_REMOVAL_BY_USER[@self_service_user_removable]
@@ -871,6 +874,7 @@ module JSS
     def add_self_service_category_xml(ssvc)
       cats = ssvc.add_element('self_service_categories')
       return if self_service_categories.empty?
+
       self_service_categories.each do |cat|
         catelem = cats.add_element('category')
         catelem.add_element('name').text = cat[:name]
@@ -882,10 +886,14 @@ module JSS
     # set macOS settings in ssvc xml
     def add_self_service_macos_xml(ssvc)
       return unless self_service_targets.include? :macos
-      ssvc.add_element('self_service_display_name').text = self_service_display_name if self_service_display_name
+
       ssvc.add_element('install_button_text').text = self_service_install_button_text if self_service_install_button_text
-      ssvc.add_element('reinstall_button_text').text = self_service_reinstall_button_text if self_service_reinstall_button_text
       ssvc.add_element('force_users_to_view_description').text = self_service_force_users_to_view_description.to_s
+
+      return if self.class == JSS::MacApplication
+
+      ssvc.add_element('self_service_display_name').text = self_service_display_name if self_service_display_name
+      ssvc.add_element('reinstall_button_text').text = self_service_reinstall_button_text if self_service_reinstall_button_text
     end
 
 

data/lib/jss/api_object/self_servable/icon.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jss/api_object/sitable.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jss/api_object/site.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jss/api_object/software_update_server.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jss/api_object/updatable.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jss/api_object/uploadable.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -103,7 +103,7 @@ module JSS
     #  Methods
     #####################################
 
-    #
+
     # Upload a file to the JSS via the REST Resource of the
     # object to which this module is mixed in.
     #

data/lib/jss/api_object/user.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -144,7 +144,7 @@ module JSS
 
     ### @return [Array<Hash>]
     ###
-    ### The vpp assignments associated with this user
+    ### The user-based vpp assignments associated with this user
     ###
     ### Each Hash has then :id and :name for one assignment
     ###
@@ -249,6 +249,47 @@ module JSS
       @need_to_update = true
     end
 
+    # Workaround for the recurring Jamf Classic API Bug where
+    # JSON is missing data that should come in an array of hashes, but
+    # only comes as a hash with a single hash inside, with data for only
+    # the last item in the XML array.
+    #
+    # When needed, we fetch and parse the XML, which has the desired data.
+    # Use any truthy parameter to re-fetch the XML data, otherwise the
+    # data last fetched is used.
+    #
+    # In this case, the user group data is fetched as XML and returned as
+    # an Array of Hashes, one per group the user is a member of. Each hash
+    # containing three Symbol keys:
+    #
+    #   id: Integer, the group id
+    #   name: String, the group name
+    #   is_smart: Boolean, is it a smart group or a static group?
+    #
+    # @param refresh[Boolean] Re-fetch the group data from the API
+    #
+    # @return [Array<Hash>] The groups the user is a member of.
+    #
+    def user_groups(refresh = false)
+      @grp_array = nil if refresh
+      return @grp_array if @grp_array
+
+      @grp_array = []
+      raw_xml = @api.get_rsrc "/users/id/#{@id}", :xml
+      xmlroot = REXML::Document.new(raw_xml).root
+      xml_grps = xmlroot.elements['user_groups']
+
+      xml_grps.each do |xml_grp|
+        next if xml_grp.name == 'size'
+
+        gid = xml_grp.elements['id'].text.to_i
+        gname = xml_grp.elements['name'].text
+        smart = xml_grp.elements['is_smart'].text == 'true'
+        @grp_array << { id: gid, name: gname, is_smart: smart }
+      end # groups.each
+
+      @grp_array
+    end # user_groups
 
     #####################################
     ### Private Instance Methods

data/lib/jss/api_object/vpp_account.rb

@@ -0,0 +1,209 @@
+### Copyright 2020 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
+
+  # A VPP account defined in the JSS
+  #
+  class VPPAccount < JSS::APIObject
+
+    # Mix-Ins
+    #####################################
+    include JSS::Updatable
+    include JSS::Sitable
+
+    # Class Constants
+    #####################################
+
+    ### The base for REST resources of this class
+    RSRC_BASE = 'vppaccounts'.freeze
+
+    ### the hash key used for the JSON list output of all objects in the JSS
+    RSRC_LIST_KEY = :vpp_accounts
+
+    ### The hash key used for the JSON object output.
+    ### It's also used in various error messages
+    RSRC_OBJECT_KEY = :vpp_account
+
+    SITE_SUBSET = :top
+
+    # Attributes
+    #####################################
+
+    # @return [String] The full name of the local contact person for the acct
+    attr_reader :contact
+
+    # @return [String] The service token for connecting to the account at Apple.
+    #   Currently not visible, appears as '***************'
+    attr_reader :service_token
+
+    # @return [String] The name of the company associated with the Acct/Token
+    attr_reader :account_name
+
+    # @return [Time] The expiration date of the Acct/Token
+    attr_reader :expiration_date
+
+    # @return [String] The location associated with the Acct/Token
+    attr_reader :location_name
+    alias location location_name
+
+    # @return [String] The Country Code associated with the acct
+    attr_reader :country
+
+    # @return [String] The AppleID associated with the acct
+    attr_reader :apple_id
+
+    # @return [Boolean] Automatically populate purchased content from Apple
+    #   School Manager or Apple Business Manager in Jamf Pro
+    attr_reader :populate_catalog_from_vpp_content
+
+    # @return [Boolean] Display a notification to users on their mobile devices
+    #   when a volume purchased app in a user-based volume assignment is no
+    #   longer assigned to them
+    attr_reader :notify_disassociation
+
+    # @return [Boolean] Automatically register users that have Managed Apple IDs
+    #   so they do not receive an invitation and are not prompted to register
+    #   with volume purchasing
+    attr_reader :auto_register_managed_users
+
+    # Constructor
+    #####################################
+
+    # See JSS::APIObject#initialize
+    #
+    def initialize(args = {})
+      super
+      @contact = @init_data[:contact]
+      @service_token = @init_data[:service_token]
+      @account_name = @init_data[:account_name]
+      @expiration_date = @init_data[:expiration_date].to_s.empty? ? nil : Time.parse(@init_data[:expiration_date])
+      @location_name = @init_data[:location_name]
+      @country = @init_data[:country]
+      @apple_id = @init_data[:apple_id]
+      @populate_catalog_from_vpp_content = @init_data[:populate_catalog_from_vpp_content]
+      @notify_disassociation = @init_data[:notify_disassociation]
+      @auto_register_managed_users = @init_data[:auto_register_managed_users]
+    end
+
+    # Public Instance Methods
+    #####################################
+
+    # @param new_val[String] the value
+    #
+    # @return [void]
+    #
+    def contact=(new_val = @contact)
+      return if new_val == @contact
+
+      @contact = JSS::Validate.non_empty_string new_val, 'Contact must be a non-empty String'
+      @need_to_update = true
+    end
+
+    # @param new_val[String] the value
+    #
+    # @return [void]
+    #
+    def country=(new_val = @country)
+      return if new_val == @country
+
+      @country = JSS::Validate.app_store_country_code new_val
+      @need_to_update = true
+    end
+
+    # @param new_val[String] the value
+    #
+    # @return [void]
+    #
+    def apple_id=(new_val = @apple_id)
+      return if new_val == @apple_id
+
+      @apple_id = JSS::Validate.email_address new_val
+      @need_to_update = true
+    end
+
+    # @param new_val[String] the value
+    #
+    # @return [void]
+    #
+    def populate_catalog_from_vpp_content=(new_val = @populate_catalog_from_vpp_content)
+      return if new_val == @populate_catalog_from_vpp_content
+
+      @populate_catalog_from_vpp_content = JSS::Validate.boolean new_val
+      @need_to_update = true
+    end
+
+    # @param new_val[String] the value
+    #
+    # @return [void]
+    #
+    def notify_disassociation=(new_val = @notify_disassociation)
+      return if new_val == @notify_disassociation
+
+      @notify_disassociation = JSS::Validate.boolean new_val
+      @need_to_update = true
+    end
+
+    # @param new_val[String] the value
+    #
+    # @return [void]
+    #
+    def auto_register_managed_users=(new_val = @auto_register_managed_users)
+      return if new_val == @auto_register_managed_users
+
+      @auto_register_managed_users = JSS::Validate.boolean new_val
+      @need_to_update = true
+    end
+
+    # Private Instance Methods
+    #####################################
+    private
+
+    # Return a String with the XML Resource
+    # for submitting creation or changes to the JSS via
+    # the API via the Creatable or Updatable modules
+    #
+    # Most classes will redefine this method.
+    #
+    def rest_xml
+      doc = REXML::Document.new APIConnection::XML_HEADER
+      tmpl = doc.add_element self.class::RSRC_OBJECT_KEY.to_s
+      tmpl.add_element('name').text = @name
+      tmpl.add_element('contact').text = @contact
+      tmpl.add_element('country').text = @country
+      tmpl.add_element('apple_id').text = @apple_id
+      tmpl.add_element('populate_catalog_from_vpp_content').text = @populate_catalog_from_vpp_content.to_s
+      tmpl.add_element('notify_disassociation').text = @notify_disassociation.to_s
+      tmpl.add_element('auto_register_managed_users').text = @auto_register_managed_users.to_s
+
+      add_site_to_xml doc
+
+      doc.to_s
+    end
+
+  end # VPPAccount
+
+end # JSS