ruby-jss 0.7.0 → 0.8.1

data/lib/jss/api_object/advanced_search/advanced_computer_search.rb

@@ -1,94 +1,94 @@
 ### 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
 
-  #####################################
-  ### Module Variables
-  #####################################
 
+  # Module Variables
   #####################################
-  ### Module Methods
-  #####################################
 
+
+  # Module Methods
   #####################################
-  ### Classes
+
+
+  # Classes
   #####################################
 
-  ###
-  ### An AdvancedComputerSearch in the JSS
-  ###
-  ### @see JSS::AdvancedSearch
-  ###
-  ### @see JSS::APIObject
-  ###
+
+  # An AdvancedComputerSearch in the JSS
+  #
+  # @see JSS::AdvancedSearch
+  #
+  # @see JSS::APIObject
+  #
   class AdvancedComputerSearch < JSS::AdvancedSearch
 
-    #####################################
-    ### Mix-Ins
-    #####################################
 
+    # Mix-Ins
     #####################################
-    ### Class Constants
+
+
+    # Class Constants
     #####################################
 
-    ### The base for REST resources of this class
-    RSRC_BASE = "advancedcomputersearches"
+    # The base for REST resources of this class
+    RSRC_BASE = 'advancedcomputersearches'.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 = :advanced_computer_searches
 
-    ### 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 = :advanced_computer_search
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:sql_text, :display_fields, :computers]
+    # these keys, as well as :id and :name,  are present in valid API JSON data for this class
+    VALID_DATA_KEYS = [:sql_text, :display_fields, :computers].freeze
 
-    ### what kind of thing is returned by this search?
+    # what kind of thing is returned by this search?
     RESULT_CLASS = JSS::Computer
 
-    ### what data fields come back along with the display fields
-    ### for each computer?
-    RESULT_ID_FIELDS = [:id, :name, :udid]
+    # what data fields come back along with the display fields
+    # for each computer?
+    RESULT_ID_FIELDS = [:id, :name, :udid].freeze
 
-    #####################################
-    ### Attributes
-    #####################################
 
-    #####################################
-    ### Constructor
+    # Attributes
     #####################################
 
-    #####################################
-    ### Public Instance Methods
+
+    # Constructor
     #####################################
 
+
+    # Public Instance Methods
     #####################################
-    ### Private Instance Methods
+
+
+    # Private Instance Methods
     #####################################
 
   end # class

data/lib/jss/api_object/advanced_search/advanced_mobile_device_search.rb

@@ -1,95 +1,85 @@
 ### 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
 
-  #####################################
-  ### Module Variables
+  # Module Variables
   #####################################
 
-  #####################################
-  ### Module Methods
+  # Module Methods
   #####################################
 
-  #####################################
-  ### Classes
+  # Classes
   #####################################
 
-  ###
-  ### An AdvancedComputerSearch in the JSS
-  ###
-  ### @see JSS::AdvancedSearch
-  ###
-  ### @see JSS::APIObject
-  ###
+  # An AdvancedComputerSearch in the JSS
+  #
+  # @see JSS::AdvancedSearch
+  #
+  # @see JSS::APIObject
+  #
   class AdvancedMobileDeviceSearch < JSS::AdvancedSearch
 
-    #####################################
-    ### Mix-Ins
+    # Mix-Ins
     #####################################
 
-    #####################################
-    ### Class Constants
+    # Class Constants
     #####################################
 
-    ### The base for REST resources of this class
-    RSRC_BASE = "advancedmobiledevicesearches"
+    # The base for REST resources of this class
+    RSRC_BASE = 'advancedmobiledevicesearches'.freeze
 
-    ### the hash key used for the JSON list output of all objects in the JSS
-    ### NOTE - THIS IS A BUG, it should be advanced_mobile_device_searches
+    # the hash key used for the JSON list output of all objects in the JSS
+    # NOTE - THIS IS A BUG, it should be advanced_mobile_device_searches
     RSRC_LIST_KEY = :advanced_computer_searches
 
-    ### 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 = :advanced_mobile_device_search
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:sql_text, :display_fields, :mobile_devices]
+    # these keys, as well as :id and :name,  are present in valid API JSON data for this class
+    VALID_DATA_KEYS = [:sql_text, :display_fields, :mobile_devices].freeze
 
-    ### what kind of thing is returned by this search?
+    # what kind of thing is returned by this search?
     RESULT_CLASS = JSS::MobileDevice
 
-    ### what data fields come back along with the display fields
-    ### for each mobiledevices?
-    RESULT_ID_FIELDS = [:id, :name, :udid]
+    # what data fields come back along with the display fields
+    # for each mobiledevices?
+    RESULT_ID_FIELDS = [:id, :name, :udid].freeze
 
-    #####################################
-    ### Attributes
+    # Attributes
     #####################################
 
-    #####################################
-    ### Constructor
+    # Constructor
     #####################################
 
-    #####################################
-    ### Public Instance Methods
+    # Public Instance Methods
     #####################################
 
-    #####################################
-    ### Private Instance Methods
+    # Private Instance Methods
     #####################################
 
   end # class

data/lib/jss/api_object/advanced_search/advanced_user_search.rb

@@ -1,94 +1,84 @@
 ### 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
 
-  #####################################
-  ### Module Variables
+  # Module Variables
   #####################################
 
-  #####################################
-  ### Module Methods
+  # Module Methods
   #####################################
 
-  #####################################
-  ### Classes
+  # Classes
   #####################################
 
-  ###
-  ### An AdvancedUserSearch in the JSS
-  ###
-  ### @see JSS::AdvancedSearch
-  ###
-  ### @see JSS::APIObject
-  ###
-  class AdvancedUserSearch <  JSS::AdvancedSearch
+  # An AdvancedUserSearch in the JSS
+  #
+  # @see JSS::AdvancedSearch
+  #
+  # @see JSS::APIObject
+  #
+  class AdvancedUserSearch < JSS::AdvancedSearch
 
-    #####################################
-    ### Mix-Ins
+    # Mix-Ins
     #####################################
 
-    #####################################
-    ### Class Constants
+    # Class Constants
     #####################################
 
-    ### The base for REST resources of this class
-    RSRC_BASE = "advancedusersearches"
+    # The base for REST resources of this class
+    RSRC_BASE = 'advancedusersearches'.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 = :advanced_user_searches
 
-    ### 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 = :advanced_user_search
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:criteria, :display_fields, :users]
+    # these keys, as well as :id and :name,  are present in valid API JSON data for this class
+    VALID_DATA_KEYS = [:criteria, :display_fields, :users].freeze
 
-    ### what kind of thing is returned by this search?
+    # what kind of thing is returned by this search?
     RESULT_CLASS = JSS::User
 
-    ### what data fields come back along with the display fields
-    ### for each user?
-    RESULT_ID_FIELDS = [:id, :name]
+    # what data fields come back along with the display fields
+    # for each user?
+    RESULT_ID_FIELDS = [:id, :name].freeze
 
-    #####################################
-    ### Attributes
+    # Attributes
     #####################################
 
-    #####################################
-    ### Constructor
+    # Constructor
     #####################################
 
-    #####################################
-    ### Public Instance Methods
+    # Public Instance Methods
     #####################################
 
-    #####################################
-    ### Private Instance Methods
+    # Private Instance Methods
     #####################################
 
   end # class

data/lib/jss/api_object/building.rb

@@ -1,93 +1,80 @@
 ### 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
-  
-  #####################################
-  ### Module Variables
-  #####################################
 
-  #####################################
-  ### Module Methods
+  # Module Variables
   #####################################
 
-  
+  # Module Methods
   #####################################
-  ### Classes
+
+  # Classes
   #####################################
 
-  ### 
-  ### A Building in the JSS.
-  ### These are simple, in that they only have an ID and a name.
-  ###
-  ### @see JSS::APIObject
-  ### 
+  # A Building in the JSS.
+  # These are simple, in that they only have an ID and a name.
+  #
+  # @see JSS::APIObject
+  #
   class Building < JSS::APIObject
-    
-    #####################################
-    ### Mix-Ins
+
+    # Mix-Ins
     #####################################
     include JSS::Creatable
     include JSS::Updatable
-    
-    #####################################
-    ### Class Methods
-    #####################################
-         
+
+    # Class Methods
     #####################################
-    ### Class Constants
+
+    # Class Constants
     #####################################
-    
-    ### The base for REST resources of this class
-    RSRC_BASE = "buildings"
-    
-    ### 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 = 'buildings'.freeze
+
+    # the hash key used for the JSON list output of all objects in the JSS
     RSRC_LIST_KEY = :buildings
-    
-    ### 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 = :building
-    
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = []
-    
-    #####################################
-    ### Attributes
-    #####################################
-    
-    #####################################
-    ### Constructor 
+
+    # these keys, as well as :id and :name,  are present in valid API JSON data for this class
+    VALID_DATA_KEYS = [].freeze
+
+    # Attributes
     #####################################
-    
 
+    # Constructor
     #####################################
-    ### Public Instance Methods
+
+    # Public Instance Methods
     #####################################
-    
-    
+
   end # class building
-  
+
 end # module