lib/jss/api_object/site.rb in ruby-jss-0.10.2a5 vs lib/jss/api_object/site.rb in ruby-jss-0.10.2

@@ -1,68 +1,99 @@
-# Copyright 2017 Pixar
+### 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.
-#
-#
+###
+###    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
-  ###################################
+  #####################################
+  ### Module Variables
+  #####################################
 
-  # A Site in the JSS.
-  #
-  # These are simple, in that they only have an ID and a name.
-  #
-  # @see JSS::APIObject
-  #
+  #####################################
+  ### Module Methods
+  #####################################
+
+
+  #####################################
+  ### Classes
+  #####################################
+
+  ###
+  ### A Site in the JSS.
+  ###
+  ### These are simple, in that they only have an ID and a name.
+  ###
+  ### @see JSS::APIObject
+  ###
   class Site < JSS::APIObject
 
-    # Mix-Ins
-    ###################################
+    #####################################
+    ### Mix-Ins
+    #####################################
     include JSS::Creatable
     include JSS::Updatable
 
-    # Class Constants
-    ###################################
+    #####################################
+    ### Class Methods
+    #####################################
 
-    # The base for REST resources of this class
-    RSRC_BASE = 'sites'.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 = "sites"
+
+    ### the hash key used for the JSON list output of all objects in the JSS
     RSRC_LIST_KEY = :sites
 
-    # 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 = :site
 
-    # these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [].freeze
+    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
+    VALID_DATA_KEYS = []
 
     # the object type for this object in
     # the object history table.
     # See {APIObject#add_object_history_entry}
     OBJECT_HISTORY_OBJECT_TYPE = 44
+
+    #####################################
+    ### Attributes
+    #####################################
+
+    #####################################
+    ### Constructor
+    #####################################
+
+
+    #####################################
+    ### Public Instance Methods
+    #####################################
+
 
   end # class site
 
 end # module