ruby-jss 0.10.2a5 → 0.10.2

data/lib/jss/api_object/mobile_device_configuration_profile.rb

@@ -6,13 +6,6 @@ module JSS
   #
   class MobileDeviceConfigurationProfile < APIObject
 
-    # Mix-Ins
-    ###################################
-    include JSS::Categorizable
-    include JSS::Sitable
-    include JSS::Scopable
-    include JSS::SelfServable
-
     ### The base for REST resources of this class
     RSRC_BASE = 'mobiledeviceconfigurationprofiles'.freeze
 
@@ -28,35 +21,6 @@ module JSS
     # See {APIObject#add_object_history_entry}
     OBJECT_HISTORY_OBJECT_TYPE = 22
 
-    # Our scopes deal with computers
-    SCOPE_TARGET_KEY = :mobile_devices
-
-    SITE_SUBSET = :general
-
-    # 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
-
   end
 
 end

data/lib/jss/api_object/osx_configuration_profile.rb

@@ -1,122 +1,141 @@
-# Copyright 2017 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.
-#
-#
-
-#
+### Copyright 2017 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
 
-  # 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
-  #
+  #####################################
+  ### 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
-    ###################################
+    #####################################
+    ### Mix-Ins
+    #####################################
     include JSS::Updatable
     include JSS::Scopable
     include JSS::SelfServable
-    include JSS::Categorizable
-    include JSS::Sitable
 
-    # Class Constants
-    ###################################
+    #####################################
+    ### Class Variables
+    #####################################
+
+    #####################################
+    ### Class Methods
+    #####################################
 
-    # The base for REST resources of this class
-    RSRC_BASE = 'osxconfigurationprofiles'.freeze
+    #####################################
+    ### Class Constants
+    #####################################
 
-    # the hash key used for the JSON list output of all objects in the JSS
+    ### 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
+    ### 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 = %i[distribution_method scope redeploy_on_update].freeze
+    ### 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
+    ### Our scopes deal with computers
     SCOPE_TARGET_KEY = :computers
 
-    # Our SelfService happens on OSX
+    ### Our SelfService happens on OSX
     SELF_SERVICE_TARGET = :osx
 
-    # Our SelfService deploys profiles
+    ### Our SelfService deploys profiles
     SELF_SERVICE_PAYLOAD = :profile
 
-    # The possible values for the :distribution_method
-    DISTRIBUTION_METHODS = ['Install Automatically', 'Make Available in Self Service'].freeze
+    ### 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'.freeze
+    SELF_SERVICE_DIST_METHOD = "Make Available in Self Service"
 
-    # The possible values for :level
-    LEVELS = %w[user computer].freeze
+    ### The possible values for :level
+    LEVELS = ["user", "computer"]
 
     # the object type for this object in
     # the object history table.
     # See {APIObject#add_object_history_entry}
     OBJECT_HISTORY_OBJECT_TYPE = 4
 
-    # Where is the Site data in the API JSON?
-    SITE_SUBSET = :general
-
-    # Attributes
-    ###################################
+    #####################################
+    ### Attributes
+    #####################################
 
-    # @return [String] the description of this profile
+    ### @return [String] the description of this profile
     attr_reader :description
 
-    # @return [String] the distribution_method of this profile
+    ### @return [String] the distribution_method of this profile
     attr_reader :distribution_method
 
-    # @return [Boolean] can the user remove this profile
+    ### @return [Boolean] can the user remove this profile
     attr_reader :user_removable
 
-    # @return [String] the level (user/computer) of this profile
+    ### @return [String] the level (user/computer) of this profile
     attr_reader :level
 
-    # @return [String] the uuid of this profile. NOT Updatable
+    ### @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 [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
+    ### @return [String] the plist containing the payloads for this profile. NOT Updatable
     attr_reader :payloads
 
-    # Constructor
-    ###################################
+    #####################################
+    ### Constructor
+    #####################################
+
+    ###
+    ### See JSS::APIObject#initialize
+    ###
+    def initialize (args = {})
 
-    # See JSS::APIObject#initialize
-    #
-    def initialize(args = {})
       super
 
       @description = @main_subset[:description]
@@ -128,82 +147,100 @@ module JSS
       @payloads = @main_subset[:payloads]
     end
 
-    # Public Instance Methods
-    ###################################
+    #####################################
+    ### Public Instance Methods
+    #####################################
 
-    # @param new_val[String] the new discription
-    #
-    # @return [void]
-    #
-    def description=(new_val)
+    ###
+    ### @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?
+    end
+
 
-    #
-    # @return [void]
-    #
-    def distribution_method=(new_val)
+    ###
+    ### @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)
+    ###
+    ### @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
+      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)
+    ###
+    ### @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?
+    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?
+    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
+    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
-    #
+    ###
+    ### @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)
-    #
+    ###
+    ### @return [Array<String>] the PayloadType of each payload (e.g. com.apple.caldav.account)
+    ###
     def payload_types
-      payload_content.map { |p| p['PayloadType'] }
+      payload_content.map{|p| p['PayloadType'] }
     end
 
-    ###################################
-    # Private Instance Methods
-    ###################################
+    #####################################
+    ### Private Instance Methods
+    #####################################
     private
 
     def rest_xml
@@ -218,10 +255,9 @@ module JSS
       gen.add_element('redeploy_on_update').text = @redeploy_on_update
 
       obj << @scope.scope_xml
-      add_self_service_xml doc
-      add_category_to_xml doc
-      add_site_to_xml doc
-      doc.to_s
+      obj << self_service_xml
+
+      return doc.to_s
     end
 
   end # class OSXConfigurationProfile

data/lib/jss/api_object/peripheral.rb

@@ -51,10 +51,16 @@ module JSS
 
     include JSS::Creatable
     include JSS::Updatable
+
+    ### periphs have a purchasing subset
     include JSS::Purchasable
+
+    ### periphs have a location subset, which will be
+    ### stored in primary attributes.
     include JSS::Locatable
+
+    ### periphs can take uploaded files.
     include JSS::Uploadable
-    include JSS::Sitable
 
     #####################################
     ### Class Methods
@@ -82,9 +88,6 @@ module JSS
     # See {APIObject#add_object_history_entry}
     OBJECT_HISTORY_OBJECT_TYPE = 8
 
-    # Where is the Site data in the API JSON?
-    SITE_SUBSET = :general
-
     #####################################
     ### Class Variables
     #####################################
@@ -313,7 +316,6 @@ module JSS
       if has_purchasing?
         periph << purchasing_xml
       end
-      add_site_to_xml doc
 
       return doc.to_s
     end # rest xml

data/lib/jss/api_object/policy.rb

@@ -77,7 +77,6 @@ module JSS
     include JSS::Uploadable
     include JSS::SelfServable
     include JSS::Categorizable
-    include JSS::Sitable
 
     #####################################
     ### Class Methods
@@ -250,9 +249,6 @@ module JSS
     # See {APIObject#add_object_history_entry}
     OBJECT_HISTORY_OBJECT_TYPE = 3
 
-    # Where is the Site data in the API JSON?
-    SITE_SUBSET = :general
-
     ######################
     ### Attributes
     ######################
@@ -1364,7 +1360,6 @@ module JSS
       end
 
       add_self_service_xml doc
-      add_site_xml doc
 
       doc.to_s
     end

data/lib/jss/api_object/restricted_software.rb

@@ -11,7 +11,6 @@ module JSS
     include JSS::Updatable
     include JSS::Creatable
     include JSS::Scopable
-    include JSS::Sitable
 
     # Class Constants
     #####################################
@@ -37,9 +36,6 @@ module JSS
     # See {APIObject#add_object_history_entry}
     OBJECT_HISTORY_OBJECT_TYPE = 5
 
-    # Where is the Site data in the API JSON?
-    SITE_SUBSET = :general
-
     # Attributes
     #####################################
 
@@ -166,7 +162,6 @@ module JSS
       site.add_element('name').text = @site
 
       obj << @scope.scope_xml
-      add_self_service_xml doc
       doc.to_s
     end # rest_xml