ruby-jss 0.7.0 → 0.8.1

data/lib/jss/api_object/computer_invitation.rb

@@ -26,127 +26,116 @@
 ###
 module JSS
 
-  #####################################
-  ### Module Constants
+  # Module Constants
   #####################################
 
-  #####################################
-  ### Module Variables
+  # Module Variables
   #####################################
 
+  # Module Methods
   #####################################
-  ### Module Methods
-  #####################################
-
-  ###
-  ### This class represents a Computer Invitation in the JSS.
-  ###
-  ### ===Adding Computer Invitations to the JSS
-  ###
-  ### This class is meant only to generate and hold the response of creating
-  ### an invitation.
-  ###
-  ### @see APIObject
-  ### @see Creatable
-  ###
 
+  # This class represents a Computer Invitation in the JSS.
+  #
+  # ===Adding Computer Invitations to the JSS
+  #
+  # This class is meant only to generate and hold the response of creating
+  # an invitation.
+  #
+  # @see APIObject
+  # @see Creatable
+  #
   class ComputerInvitation < JSS::APIObject
 
-    #####################################
-    ### MixIns
+    # MixIns
     #####################################
 
     include JSS::Creatable
 
-    #####################################
-    ### Class Variables
+    # Class Variables
     #####################################
 
-    #####################################
-    ### Class Methods
+    # Class Methods
     #####################################
 
-    #####################################
-    ### Class Constants
+    # Class Constants
     #####################################
 
-    ### The base for REST resources of this class
-    RSRC_BASE = "computerinvitations"
+    # The base for REST resources of this class
+    RSRC_BASE = 'computerinvitations'.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 = :computer_invitations
 
-    ### 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 = :computer_invitation
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:invitation]
+    # these keys, as well as :id and :name,  are present in valid API JSON data for this class
+    VALID_DATA_KEYS = [:invitation].freeze
 
-    #####################################
-    ### 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
+    # 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 invitation name
+    # @return [String] the invitation name
     attr_reader :name
 
-    ### @return [String] the invitation type
-    ###
-    ### Valid values are: URL and EMAIL. Will default to DEFAULT.
+    # @return [String] the invitation type
+    #
+    # Valid values are: URL and EMAIL. Will default to DEFAULT.
     attr_accessor :invitation_type
 
-    ### @return [String] whether or not to create the account if required
-    ###
-    ### "true" or "false" are valid values.
+    # @return [String] whether or not to create the account if required
+    #
+    # "true" or "false" are valid values.
     attr_accessor :create_account_if_does_not_exist
 
-    ### @return [String]
-    ###
-    ### Time since epoch that the invitation will expire at.
-    ###
-    ### Note: defaults to "Unlimited", so only set if it should expire.
+    # @return [String]
+    #
+    # Time since epoch that the invitation will expire at.
+    #
+    # Note: defaults to "Unlimited", so only set if it should expire.
     attr_accessor :expiration_date_epoch
 
-    ### @return [String]
-    ###
-    ### The username of the ssh user to be created.
-    ###
-    ### REQUIRED for valid setup.
+    # @return [String]
+    #
+    # The username of the ssh user to be created.
+    #
+    # REQUIRED for valid setup.
     attr_accessor :ssh_username
 
-    ### @return [String]
-    ###
-    ### The whether or not to hide the ssh user.
+    # @return [String]
+    #
+    # The whether or not to hide the ssh user.
     attr_accessor :hide_account
 
-    ### @return [String]
-    ###
-    ### The invitation_status.
+    # @return [String]
+    #
+    # The invitation_status.
     attr_accessor :invitation_status
 
-    ### @return [String]
-    ###
-    ### Whether the invitation can be used multiple times (boolean).
+    # @return [String]
+    #
+    # Whether the invitation can be used multiple times (boolean).
     attr_accessor :multiple_uses_allowed
 
-    #####################################
-    ### Public Instance Methods
+    # Public Instance Methods
     #####################################
 
-    ###
-    ### @see APIObject#initialize
-    ###
+    # @see APIObject#initialize
+    #
     def initialize(args = {
       id: :new,
-      name: "some_new_name",
-      ssh_username: "casper_remote",
-      hide_account: "true" } )
+      name: 'some_new_name',
+      ssh_username: 'casper_remote',
+      hide_account: 'true'
+    })
 
-      super args, []
+      super args
 
       @name = @init_data[:invitation]
       @invitation_type = @init_data[:invitation_type]
@@ -158,15 +147,13 @@ module JSS
       @multiple_uses_allowed = @init_data[:multiple_uses_allowed] || args[:multiple_uses_allowed]
     end
 
-    #####################################
-    ### Public Class Methods
+    # Public Class Methods
     #####################################
 
-    ###
-    ### Needed to support creation of new Computer Invitations to set their name.
-    ###
-    ### @return [JSS::ComputerInvitation]
-    ###
+    # Needed to support creation of new Computer Invitations to set their name.
+    #
+    # @return [JSS::ComputerInvitation]
+    #
     def create
       new_invitation_id = super
 
@@ -181,14 +168,12 @@ module JSS
       @multiple_uses_allowed = jss_me.multiple_uses_allowed
     end
 
-    #####################################
-    ### Private Instance Methods
+    # Private Instance Methods
     #####################################
     private
 
-    ###
-    ### Sets invitation expiration 4 hours after request.
-    ###
+    # Sets invitation expiration 4 hours after request.
+    #
     def rest_xml
       doc = REXML::Document.new APIConnection::XML_HEADER
       obj = doc.add_element RSRC_OBJECT_KEY.to_s
@@ -201,7 +186,9 @@ module JSS
       obj.add_element('hide_account').text = hide_account
       obj.add_element('invitation_status').text = invitation_status
       obj.add_element('multiple_uses_allowed').text = multiple_uses_allowed
-      return doc.to_s
+      doc.to_s
     end
+
   end
+
 end

data/lib/jss/api_object/criteriable.rb

@@ -1,26 +1,26 @@
 ### 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.
-### 
+###
 ###
 
 ###
@@ -68,7 +68,6 @@ module JSS
   ###   inform the subclass instance that it has changed and needs an #update
   ###
   ### Classes mixing in this module *must*
-  ### *  call #parse_criteria during initialization.
   ### *  If they are Updatable or Creatable, they must insert
   ###    self.criteria.rest_xml into their own xml output.
   ###

data/lib/jss/api_object/ebook.rb

@@ -0,0 +1,21 @@
+# This is just a stub for now.
+
+#
+module JSS
+
+  #
+  class EBook < APIObject
+
+    ### The base for REST resources of this class
+    RSRC_BASE = 'ebooks'.freeze
+
+    ### the hash key used for the JSON list output of all objects in the JSS
+    RSRC_LIST_KEY = :ebooks
+
+    ### The hash key used for the JSON object output.
+    ### It's also used in various error messages
+    RSRC_OBJECT_KEY = :ebook
+
+  end
+
+end

data/lib/jss/api_object/extendable.rb

@@ -1,26 +1,26 @@
 ### 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.
-### 
+###
 ###
 
 ###
@@ -61,8 +61,6 @@ module JSS
   ### For Example, {JSS::Computer} sets this:
   ###   EXT_ATTRIB_CLASS = JSS::ComputerExtensionAttribute
   ###
-  ### During initialization those classes must call {#parse_ext_attrs} to populate the @extension_attributes
-  ### attribute from @init_data.
   ###
   ### Parsing also populates @ext_attrs which is a Hash of name => value for each EA.
   ###

data/lib/jss/api_object/group.rb

@@ -155,8 +155,6 @@ module JSS
 
       @site = JSS::APIObject.get_name(@init_data[:site])
 
-      parse_criteria
-
     end #init
 
     #####################################
@@ -378,4 +376,3 @@ end # module JSS
 require "jss/api_object/group/computer_group"
 require "jss/api_object/group/mobile_device_group"
 require "jss/api_object/group/user_group"
-

data/lib/jss/api_object/locatable.rb

@@ -1,26 +1,26 @@
 ### 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.
-### 
+###
 ###
 
 ###
@@ -52,8 +52,7 @@ module JSS
   ### - :username => String
   ###
   ### Including this module in an {APIObject} subclass will give it attributes
-  ### matching those keys, which are populated by calling {#parse_location} in the
-  ### subclass's constructor after calling super.
+  ### matching those keys.
   ###
   ### If the subclass is creatable or updatable, calling {#location_xml} returns
   ### a REXML element representing the location subset, to be included with the
@@ -70,13 +69,13 @@ module JSS
     #####################################
     ###  Variables
     #####################################
-    
-    
+
+
     #####################################
     ###  Attribtues
     #####################################
 
-    ### 
+    ###
     ### Objects with a Location subset have those values stored as
     ### primary attributes here, not in a single Hash attribute
     ### as the other subsets
@@ -104,7 +103,7 @@ module JSS
 
     ### @return [String]
     attr_reader :username
-    
+
 
     #####################################
     ###  Mixed-in Instance Methods
@@ -130,12 +129,12 @@ module JSS
       @username = @init_data[:location][:username]
     end
 
-    
+
     ###
     ### All the location data in a Hash, as it comes from the API.
     ###
     ### The reason it isn't stored this way is to prevent editing of the hash directly.
-    ### 
+    ###
     ### @return [Hash<String>] the location data
     ###
     def location
@@ -150,8 +149,8 @@ module JSS
         :username => @username
       }
     end
-    
-    
+
+
     ###
     ###
     ### Setters
@@ -254,12 +253,12 @@ module JSS
       @room = ''
       @need_to_update = true
     end
-    
-    
+
+
     ### aliases
     alias user username
-    
-    
+
+
     ###
     ### @api private
     ###