ruby-jss 0.6.5 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edccb1a8e4436aae8603aecc748d5cd817115144
-  data.tar.gz: 7f169bdfa8623ee12699e241872ddee9259d19b9
+  metadata.gz: cc64e9aded3743cf2fd02ec8fb482457e9f39bd0
+  data.tar.gz: 56ffca6c41aee0c3716911327f7498b9076ce31d
 SHA512:
-  metadata.gz: a25d238371cdfd1157b3e11320002ac10f6da9b90acf4b10cadfba5f54cc932d0b3d4525d22f3e471f318b778ed0c45afc987a560bb08afd3a86b0eec66bb19a
-  data.tar.gz: 48f2c4bc65aad055eb5e84eb3ef2a195706d4253cdb7b4a0ba3675d76fea364921ef7fb79002e78aea358138a4dd3b19056a4b1f425b4589cb3b5a3e2b929f3b
+  metadata.gz: 5331d7bfedde26f888004442a3093201abaa1d8ad0baafacfc06997192d91526604996d00a0a688e648516c513372532a80eb239e7ff4f7db79b391dbe5ac838
+  data.tar.gz: c353adf65aa0031cddcc381a1e0eec3fbd10c7cb83b92a7ce329a2aff97244b62ac1affa9447f3760906269409db9aa4214c4f0ad0dec92ca0959d762d701c6c

data/CHANGES.md

@@ -1,5 +1,57 @@
 # Change History
 
+## v0.6.6 2016-11-30
+
+- Added String#jss_to_pathname to convert Strings to Pathname instances in JSS::Configuration.
+
+- JSS::DBConnection#connect now returns the server hostname, to match the behavior of JSS::APIConnection#connect
+
+- JSS::Client: added .console_user method
+
+- JSS::Policy, now creatable, and self-servable, and more attributes are updatable
+
+- JSS::SelfServable, finally getting this module functional, at least for policies
+
+- JSS::Creatable, added #clone method - all creatable objects can be cloned easily.
+
+- JSS::APIObject, added .exist? and .valid_id class methods and #to_s instance method
+
+- Change the mountpoint directory for JSS::DistributionPoint#mount to /tmp, because Sierra doesn't allow mounting in /Volumes except by root. (Thanks @LM2807! )
+
+- Starting cleaning up code to better adhere to [RuboCop](http://rubocop.readthedocs.io/en/latest/) standards
+
+- Added alpha version of a JSS WebHooks framwork
+
+## v0.6.5 2016-08-10
+
+- Cleanup of redundant constants (Thanks @aurica!)
+
+- Added JSS::ComputerInvitation class (Thanks @tostart-pickagreatname!)
+
+- Added JSS::Account class (Thanks @JonPulsifer!)
+
+- Added JSS::OSXConfigurationProfile class (Thanks @tostart-pickagreatname!)
+
+- JSS::Computer: added methods #boot_drive, #filevault2_enabled?, and #filevault1_accounts
+
+- Various small bugfixes & improvements
+
+## v0.6.4 2016-03-24
+
+- JSS::Package#dlete can optionally delete the master file at the same time
+
+- Added an example ruby-jss.conf file with internal documentation
+
+- Various small bugfixes & improvements
+
+- Updated the config file name to match the new gem name, maintaining backwards compatibility
+
+- Improved error messages
+
+## v0.6.3 2016-03-09
+
+Maintenence version bump to fix an issue uploading to rubygems.org
+
 ## v0.6.2 2016-03-08
 
 As of v0.6.2, the github project, and rubygem have been renamed to 'ruby-jss'. The 'require' name is now 'jss'.
@@ -19,7 +71,7 @@ The 'jss-api' gem has been updated one last time, also to v0.6.2. That gem has a
 #### bugfixes
 
 - JSS::stdin_lines no longer uses a constant to store incoming stdin data at load time, which causes hangs when there's no terminal on stdin. Now stdin is only read when the method is called, and data stored in a module variable.
- 
+
 - JSS::Composer::mk_dmg fix for building/indexing dmg's, no longer creates an unreadable .Trashes folder.
 
 - Several small typos and other tiny bugs.
@@ -33,10 +85,10 @@ The 'jss-api' gem has been updated one last time, also to v0.6.2. That gem has a
 
 ## v0.6.0 2016-01-06
 
-This version of the jss-api gem incorporates changes needed for the upcoming release of d3 (a.k.a. depot3), 
+This version of the jss-api gem incorporates changes needed for the upcoming release of d3 (a.k.a. depot3),
 a package/patch management system for Casper, which was the reason for the jss-api gem to begin with.
 
-As such, while the JSS module will continue to be a separate git repo, specific commits of it will be 
+As such, while the JSS module will continue to be a separate git repo, specific commits of it will be
 submodules of the depot3 git repo, starting with this one, or one shortly hereafter.
 
 
@@ -74,7 +126,7 @@ Also: As of casper 9.72, the argument requirements havechanged for 'jamf install
 #### bugfixes & cleanup
 
 - location.rb: location value setters are now properly converted to strings
-- api_connection.rb: #connect now takes :use_ssl option (defaults to true) 
+- api_connection.rb: #connect now takes :use_ssl option (defaults to true)
 - api_connection.rb: #connect will accept arbitrary ports when :use_ssl is true
 
 #### additions & features
@@ -107,6 +159,6 @@ Also: As of casper 9.72, the argument requirements havechanged for 'jamf install
 - many documentation updates as we adjust to being live
 - minor bugfixes
 
-## v0.5.0 2014-10-23 
+## v0.5.0 2014-10-23
 
 - first opensource release

data/lib/jss.rb

@@ -23,18 +23,17 @@
 ###
 
 ###
-### JSS, A Ruby module for interacting with the JAMF Software Server via it's REST API.
+### JSS, A Ruby module for interacting with the JAMF Pro Server via it's REST API.
 ###
 module JSS
 
   ### The minimum Ruby version that works with this gem
-  MINIMUM_RUBY_VERSION = "2.0.0"
+  MINIMUM_RUBY_VERSION = '2.0.0'.freeze
 
   if Gem::Version.new(RUBY_VERSION) < Gem::Version.new(MINIMUM_RUBY_VERSION)
     raise "Can't use the JSS module, ruby itself must be version #{MINIMUM_RUBY_VERSION} or greater."
   end
 
-  #####################################
   ### Required Libraries, etc
   #####################################
 
@@ -45,12 +44,13 @@ module JSS
   require 'pathname'
   require 'fileutils'
   require 'uri'
-  require "ipaddr"
-  require "rexml/document"
-  require "base64"
-  require "shellwords"
-  require "digest"
+  require 'ipaddr'
+  require 'rexml/document'
+  require 'base64'
+  require 'shellwords'
+  require 'digest'
   require 'yaml'
+  require 'open3'
 
   ###################
   ### Gems
@@ -58,145 +58,129 @@ module JSS
   require 'json'
   require 'plist'
 
-
-
-  #####################################
   ### Constants
   #####################################
 
   ### The minimum JSS version that works with this gem, as returned by the API
   ### in the deprecated 'jssuser' resource
-  MINIMUM_SERVER_VERSION = "9.4"
-
-
+  MINIMUM_SERVER_VERSION = '9.4'.freeze
 
   ### The current local UTC offset as a fraction of a day  (Time.now.utc_offset is the offset in seconds,
   ### 60*60*24 is the seconds in a day)
-  TIME_ZONE_OFFSET =  Rational(Time.now.utc_offset, 60*60*24)
+  TIME_ZONE_OFFSET =  Rational(Time.now.utc_offset, 60 * 60 * 24)
 
   ### These are handy for testing values without making new arrays, strings, etc every time.
-  TRUE_FALSE = [true, false]
+  TRUE_FALSE = [true, false].freeze
 
   ### When parsing a date/time data into a Time object, these will return nil
-  NIL_DATES = [0, nil, '', '0']
-
+  NIL_DATES = [0, nil, '', '0'].freeze
 
-  #####################################
   ### Module Variables
   #####################################
 
   ### The contents of anything piped to stdin, split into lines. See {JSS.stdin}
   @@stdin_lines = nil
 
-  #####################################
   ### Module Methods
   #####################################
 
-
-  ###
   ### Define classes and submodules here so that they don't
   ### generate errors when referenced during the loading of
   ### the library.
   ###
 
-  #####################################
   ### Sub Modules
   #####################################
 
-  module Composer ; end
+  module Composer; end
 
   ### Mix-in Sub Modules
 
-  module Creatable ; end
-  module FileUpload ; end
-  module Locatable ; end
-  module Matchable ; end
-  module Purchasable ; end
-  module Updatable ; end
-  module Extendable ; end
+  module Creatable; end
+  module FileUpload; end
+  module Locatable; end
+  module Matchable; end
+  module Purchasable; end
+  module Updatable; end
+  module Extendable; end
 
   ### Mix-in Sub Modules with Classes
 
-  module Criteriable ; end
-  class Criteriable::Criteria ; end
-  class Criteriable::Criterion ; end
-
-  module Scopable ; end
-  class Scopable::Scope ; end
+  module Criteriable
+    class Criteria; end
+    class Criterion; end
+  end
+  module Scopable
+    class Scope ; end
+  end
 
-  #####################################
   ### Classes
   #####################################
 
-  class APIObject ; end
-  class APIConnection ; end
-  class Client ; end
-  class DBConnection ; end
-  class Server ; end
-  class Preferences ; end
+  class APIObject; end
+  class APIConnection; end
+  class Client; end
+  class DBConnection; end
+  class Server; end
+  class Preferences; end
 
-  #####################################
   ### SubClasses
   #####################################
 
   ### APIObject Classes with SubClasses
 
-  class AdvancedSearch < JSS::APIObject ; end
-  class AdvancedComputerSearch < JSS::AdvancedSearch ; end
-  class AdvancedMobileDeviceSearch < JSS::AdvancedSearch ; end
-  class AdvancedUserSearch <  JSS::AdvancedSearch ; end
-
+  class AdvancedSearch < JSS::APIObject; end
+  class AdvancedComputerSearch < JSS::AdvancedSearch; end
+  class AdvancedMobileDeviceSearch < JSS::AdvancedSearch; end
+  class AdvancedUserSearch < JSS::AdvancedSearch; end
 
-  class ExtensionAttribute < JSS::APIObject ; end
-  class ComputerExtensionAttribute < JSS::ExtensionAttribute ; end
-  class MobileDeviceExtensionAttribute < JSS::ExtensionAttribute ; end
-  class UserExtensionAttribute < JSS::ExtensionAttribute ; end
+  class ExtensionAttribute < JSS::APIObject; end
+  class ComputerExtensionAttribute < JSS::ExtensionAttribute; end
+  class MobileDeviceExtensionAttribute < JSS::ExtensionAttribute; end
+  class UserExtensionAttribute < JSS::ExtensionAttribute; end
 
-  class Group < JSS::APIObject ; end
-  class ComputerGroup < JSS::Group ; end
-  class MobileDeviceGroup < JSS::Group ; end
-  class UserGroup < JSS::Group ; end
+  class Group < JSS::APIObject; end
+  class ComputerGroup < JSS::Group; end
+  class MobileDeviceGroup < JSS::Group; end
+  class UserGroup < JSS::Group; end
 
   ### APIObject Classes without SubClasses
 
-  class Account < JSS::APIObject ; end
-  class Building < JSS::APIObject ; end
-  class Category < JSS::APIObject ; end
-  class Computer < JSS::APIObject ; end
-  class Department < JSS::APIObject ; end
-  class DistributionPoint < JSS::APIObject ; end
-  class LDAPServer < JSS::APIObject ; end
-  class MobileDevice < JSS::APIObject ; end
-  class NetBootServer < JSS::APIObject ; end
-  class NetworkSegment < JSS::APIObject ; end
-  class OSXConfigurationProfile < JSS::APIObject ; end
-  class Package < JSS::APIObject ; end
-  class PeripheralType < JSS::APIObject ; end
-  class Peripheral < JSS::APIObject ; end
-  class Policy < JSS::APIObject ; end
-  class RemovableMacAddress < JSS::APIObject ; end
-  class RestrictedSoftware < JSS::APIObject ; end
-  class Script < JSS::APIObject ; end
-  class Site < JSS::APIObject ; end
-  class SoftwareUpdateServer < JSS::APIObject ; end
-  class User < JSS::APIObject ; end
-
+  class Account < JSS::APIObject; end
+  class Building < JSS::APIObject; end
+  class Category < JSS::APIObject; end
+  class Computer < JSS::APIObject; end
+  class Department < JSS::APIObject; end
+  class DistributionPoint < JSS::APIObject; end
+  class LDAPServer < JSS::APIObject; end
+  class MobileDevice < JSS::APIObject; end
+  class NetBootServer < JSS::APIObject; end
+  class NetworkSegment < JSS::APIObject; end
+  class OSXConfigurationProfile < JSS::APIObject; end
+  class Package < JSS::APIObject; end
+  class PeripheralType < JSS::APIObject; end
+  class Peripheral < JSS::APIObject; end
+  class Policy < JSS::APIObject; end
+  class RemovableMacAddress < JSS::APIObject; end
+  class RestrictedSoftware < JSS::APIObject; end
+  class Script < JSS::APIObject; end
+  class Site < JSS::APIObject; end
+  class SoftwareUpdateServer < JSS::APIObject; end
+  class User < JSS::APIObject; end
 
 end # module JSS
 
-
-##################
 ### Load the rest of the module
 
-require "jss/utility"
-require "jss/composer"
-require "jss/compatibility"
-require "jss/ruby_extensions"
-require "jss/exceptions"
-require "jss/api_connection"
-require "jss/api_object"
-require "jss/server"
-require "jss/client"
-require "jss/configuration"
-require "jss/db_connection"
-require "jss/version"
+require 'jss/utility'
+require 'jss/composer'
+require 'jss/compatibility'
+require 'jss/ruby_extensions'
+require 'jss/exceptions'
+require 'jss/api_connection'
+require 'jss/api_object'
+require 'jss/server'
+require 'jss/client'
+require 'jss/configuration'
+require 'jss/db_connection'
+require 'jss/version'

data/lib/jss/api_connection.rb

@@ -233,6 +233,14 @@ module JSS
       return @connected ? @server_host : nil
     end # connect
 
+    ### A useful string about this connection
+    ###
+    ### @return [String]
+    ###
+    def to_s
+      @connected ? "Using #{@rest_url} as user #{@jss_user}" : "not connected"
+    end
+
     ###
     ### Reset the response timeout for the rest connection
     ###

data/lib/jss/api_object.rb

@@ -25,19 +25,15 @@
 ###
 module JSS
 
-  #####################################
   ### Module Variables
   #####################################
 
-  #####################################
   ### Module Methods
   #####################################
 
-  #####################################
   ### Classes
   #####################################
 
-  ###
   ### This class is the parent to all JSS API objects. It provides standard methods and structures
   ### that apply to all API resouces.
   ###
@@ -113,11 +109,9 @@ module JSS
   ###
   class APIObject
 
-    #####################################
     ### Mix-Ins
     #####################################
 
-    #####################################
     ### Class Variables
     #####################################
 
@@ -131,11 +125,9 @@ module JSS
     ###
     @@all_items = {}
 
-    #####################################
     ### Class Methods
     #####################################
 
-    ###
     ### Return an Array of Hashes for all objects of this subclass in the JSS.
     ###
     ### This method is only valid in subclasses of JSS::APIObject, and is
@@ -167,13 +159,12 @@ module JSS
     ### @return [Array<Hash{:name=>String, :id=> Integer}>]
     ###
     def self.all(refresh = false)
-      raise JSS::UnsupportedError, ".all can only be called on subclasses of JSS::APIObject" if self == JSS::APIObject
+      raise JSS::UnsupportedError, '.all can only be called on subclasses of JSS::APIObject' if self == JSS::APIObject
       @@all_items[self::RSRC_LIST_KEY] = nil if refresh
       return @@all_items[self::RSRC_LIST_KEY] if @@all_items[self::RSRC_LIST_KEY]
       @@all_items[self::RSRC_LIST_KEY] = JSS::API.get_rsrc(self::RSRC_BASE)[self::RSRC_LIST_KEY]
     end
 
-    ###
     ### Returns an Array of the JSS id numbers of all the members
     ### of the subclass.
     ###
@@ -185,10 +176,9 @@ module JSS
     ### @return [Array<Integer>] the ids of all items of this subclass in the JSS
     ###
     def self.all_ids(refresh = false)
-      self.all(refresh).map{|i| i[:id]}
+      all(refresh).map { |i| i[:id] }
     end
 
-    ###
     ### Returns an Array of the JSS names of all the members
     ### of the subclass.
     ###
@@ -200,10 +190,9 @@ module JSS
     ### @return [Array<String>] the names of all item of this subclass in the JSS
     ###
     def self.all_names(refresh = false)
-      self.all(refresh).map{|i| i[:name]}
+      all(refresh).map { |i| i[:name] }
     end
 
-    ###
     ### Return a hash of all objects of this subclass
     ### in the JSS where the key is the id, and the value
     ### is some other key in the data items returned by the JSS::APIObject.all.
@@ -232,11 +221,10 @@ module JSS
     ###
     def self.map_all_ids_to(other_key, refresh = false)
       h = {}
-      self.all(refresh).each{|i| h[i[:id]] = i[other_key]}
+      all(refresh).each { |i| h[i[:id]] = i[other_key] }
       h
     end
 
-
     ### Return an Array of JSS::APIObject subclass instances
     ### e.g when called on JSS::Package, return all JSS::Package
     ### objects in the JSS.
@@ -251,12 +239,52 @@ module JSS
       objects_key = "#{self::RSRC_LIST_KEY}_objects".to_sym
       @@all_items[objects_key] = nil if refresh
       return @@all_items[objects_key] if @@all_items[objects_key]
-      @@all_items[objects_key] = self.all(refresh = false).map{|o| self.new :id => o[:id]}
+      @@all_items[objects_key] = all(refresh = false).map { |o| new id: o[:id] }
     end
 
+    ### Return true or false if an object of this subclass
+    ### with the given name or id exists on the server
+    ###
+    ### @param identfier [String,Integer] The name or id of object to check for
+    ###
+    ### @param refresh [Boolean] Should the data be re-read from the server
+    ###
+    ### @return [Boolean] does an object with the given name or id exist?
+    ###
+    def self.exist?(identfier, refresh = false)
+      case identfier
+      when Integer
+        all_ids(refresh).include? identfier
+      when String
+        all_names(refresh).include? identfier
+      else
+        raise ArgumentError, 'Identifier must be a name (String) or id (Integer)'
+      end
+    end
 
-
+    ### Return an id or nil if an object of this subclass
+    ### with the given name or id exists on the server
+    ###
+    ### Subclasses may want to override this method to support more
+    ### identifiers than name and id.
     ###
+    ### @param identfier [String,Integer] The name or id of object to check for
+    ###
+    ### @param refresh [Boolean] Should the data be re-read from the server
+    ###
+    ### @return [Integer, nil] the id of the matching object, or nil if it doesn't exist
+    ###
+    def self.valid_id(identfier, refresh = false)
+      case identfier
+      when Integer
+        return identfier if all_ids(refresh).include? identfier
+      when String
+        return map_all_ids_to(:name).invert[identfier] if all_names(refresh).include? identfier
+      else
+        raise ArgumentError, 'Identifier must be a name (String) or id (Integer)'
+      end
+    end
+
     ### Convert an Array of Hashes of API object data to a
     ### REXML element.
     ###
@@ -303,7 +331,6 @@ module JSS
       JSS.item_list_to_rexml_list self::RSRC_LIST_KEY, self::RSRC_OBJECT_KEY, array, content
     end
 
-    ###
     ### Some API objects contain references to other API objects. Usually those
     ### references are a Hash containing the :id and :name of the target. Sometimes,
     ### however the reference is just the name of the target.
@@ -332,35 +359,31 @@ module JSS
     ###
     def self.get_name(a_thing)
       case a_thing
-        when String
-          a_thing
-        when Hash
-          a_thing[:name]
-        when nil
-          nil
+      when String
+        a_thing
+      when Hash
+        a_thing[:name]
+      when nil
+        nil
       end
     end
 
-    #####################################
     ### Class Constants
     #####################################
 
-    ###
     ### These Symbols are added to VALID_DATA_KEYS for performing the
     ### :data validity test described above.
     ###
-    REQUIRED_DATA_KEYS = [:id, :name]
+    REQUIRED_DATA_KEYS = [:id, :name].freeze
 
-    ###
     ### By default, these keys are available for object lookups
     ### Others can be added by subclasses using an array of them
     ### as the second argument to super(initialize)
     ### The keys must be Symbols that  match the keyname in the resource url.
     ### e.g. :serialnumber  for JSSResource/computers/serialnumber/xxxxx
     ###
-    DEFAULT_LOOKUP_KEYS = [:id, :name]
+    DEFAULT_LOOKUP_KEYS = [:id, :name].freeze
 
-    #####################################
     ### Attributes
     #####################################
 
@@ -376,11 +399,9 @@ module JSS
     ### @return [String] the Rest resource for API access (the part after "JSSResource/" )
     attr_reader :rest_rsrc
 
-    #####################################
     ### Constructor
     #####################################
 
-    ###
     ### The args hash must include :id, :name, or :data.
     ### * :id or :name will be looked up via the API
     ### * * if the subclass includes JSS::Creatable, :id can be :new, to create a new object in the JSS.
@@ -402,56 +423,57 @@ module JSS
     ###
     def initialize(args = {}, other_lookup_keys = [])
 
-      ################################
-      ################################
       ####### Previously looked-up JSON data
       if args[:data]
 
         @init_data = args[:data]
         ### Does this data come in subsets?
-        @got_subsets = @init_data[:general].kind_of?(Hash)
+        @got_subsets = @init_data[:general].is_a?(Hash)
 
         ### data must include all they keys in REQUIRED_DATA_KEYS + VALID_DATA_KEYS
         ### in either the main hash keys or the :general sub-hash, if it exists
         hash_to_check = @got_subsets ? @init_data[:general] : @init_data
         combined_valid_keys = self.class::REQUIRED_DATA_KEYS + self.class::VALID_DATA_KEYS
         keys_ok = (hash_to_check.keys & combined_valid_keys).count == combined_valid_keys.count
-        raise JSS::InvalidDataError, ":data is not valid JSON for a #{self.class::RSRC_OBJECT_KEY} from the API. It needs at least the keys :#{combined_valid_keys.join ', :'}" unless keys_ok
+        unless keys_ok
+          raise(
+            JSS::InvalidDataError,
+            ":data is not valid JSON for a #{self.class::RSRC_OBJECT_KEY} from the API. It needs at least the keys :#{combined_valid_keys.join ', :'}"
+          )
+        end
 
         ### and the id must be in the jss
-        raise NoSuchItemError, "No #{self.class::RSRC_OBJECT_KEY} with JSS id: #{@init_data[:id]}" unless  self.class.all_ids.include? hash_to_check[:id]
+        raise NoSuchItemError, "No #{self.class::RSRC_OBJECT_KEY} with JSS id: #{@init_data[:id]}" unless \
+          self.class.all_ids.include? hash_to_check[:id]
 
-
-      ################################
-      ################################
       ###### Make a new one in the JSS, but only if we've included the Creatable module
       elsif args[:id] == :new
 
-        raise JSS::UnsupportedError, "Creating #{self.class::RSRC_LIST_KEY} isn't yet supported. Please use other Casper workflows." unless defined? self.class::CREATABLE
-
-        raise JSS::MissingDataError, "You must provide a :name for a new #{self.class::RSRC_OBJECT_KEY}." unless args[:name]
+        raise JSS::UnsupportedError, "Creating #{self.class::RSRC_LIST_KEY} isn't yet supported. Please use other Casper workflows." \
+          unless defined? self.class::CREATABLE
 
-        raise JSS::AlreadyExistsError, "A #{self.class::RSRC_OBJECT_KEY} already exists with the name '#{args[:name]}'" if self.class.all_names.include? args[:name]
+        raise JSS::MissingDataError, "You must provide a :name for a new #{self.class::RSRC_OBJECT_KEY}." \
+          unless args[:name]
 
+        raise JSS::AlreadyExistsError, "A #{self.class::RSRC_OBJECT_KEY} already exists with the name '#{args[:name]}'" \
+          if self.class.all_names.include? args[:name]
 
         ### NOTE: subclasses may want to pre-populate more keys in @init_data when :id == :new
         ### then parse them into attributes later.
         @name = args[:name]
-        @init_data = {:name => args[:name]}
+        @init_data = { name: args[:name] }
         @in_jss = false
         @rest_rsrc = "#{self.class::RSRC_BASE}/name/#{CGI.escape @name}"
         @need_to_update = true
         return
 
-      ################################
-      ################################
       ###### Look up the data via the API
       else
         ### what lookup key are we using?
         combined_lookup_keys = self.class::DEFAULT_LOOKUP_KEYS + other_lookup_keys
         lookup_key = (combined_lookup_keys & args.keys)[0]
 
-        raise JSS::MissingDataError, "Args must include :#{combined_lookup_keys.join(', :')}, or :data"  unless lookup_key
+        raise JSS::MissingDataError, "Args must include :#{combined_lookup_keys.join(', :')}, or :data" unless lookup_key
 
         rsrc = "#{self.class::RSRC_BASE}/#{lookup_key}/#{args[lookup_key]}"
 
@@ -477,7 +499,7 @@ module JSS
       # Whereever both :id and :name are, that's the main subset
 
       @init_data.keys.each do |subset|
-        @main_subset = @init_data[subset] if @init_data[subset].kind_of? Hash and @init_data[subset][:id] and @init_data[subset][:name]
+        @main_subset = @init_data[subset] if @init_data[subset].is_a?(Hash) && @init_data[subset][:id] && @init_data[subset][:name]
         break if @main_subset
       end
       @main_subset ||= @init_data
@@ -487,27 +509,25 @@ module JSS
 
       # many things have  a :site
       if @main_subset[:site]
-        @site = JSS::APIObject.get_name( @main_subset[:site])
+        @site = JSS::APIObject.get_name(@main_subset[:site])
       end
 
       # many things have a :category
       if @main_subset[:category]
-        @category = JSS::APIObject.get_name( @main_subset[:category])
+        @category = JSS::APIObject.get_name(@main_subset[:category])
       end
 
       # set empty strings to nil
       @init_data.jss_nillify! '', :recurse
 
       @in_jss = true
-      @rest_rsrc =  "#{self.class::RSRC_BASE}/id/#{@id}"
+      @rest_rsrc = "#{self.class::RSRC_BASE}/id/#{@id}"
       @need_to_update = false
     end # init
 
-    #####################################
     ### Public Instance Methods
     #####################################
 
-    ###
     ### Either Create or Update this object in the JSS
     ###
     ### If this item is creatable or updatable, then
@@ -517,18 +537,16 @@ module JSS
     ###
     def save
       if @in_jss
-        raise JSS::UnsupportedError, "Updating this object in the JSS is currently not supported" \
+        raise JSS::UnsupportedError, 'Updating this object in the JSS is currently not supported' \
           unless defined? self.class::UPDATABLE
-        return self.update
+        update
       else
-        raise JSS::UnsupportedError, "Creating this object in the JSS is currently not supported" \
+        raise JSS::UnsupportedError, 'Creating this object in the JSS is currently not supported' \
           unless defined? self.class::CREATABLE
-        return self.create
+        create
       end
     end
 
-
-    ###
     ### Delete this item from the JSS.
     ###
     ### Subclasses may want to redefine this method,
@@ -544,14 +562,23 @@ module JSS
       @id = nil
       @in_jss = false
       @need_to_update = false
+      :deleted
     end # delete
 
-    #####################################
+
+    ### A meaningful string representation of this object
+    ###
+    ### @return [String]
+    ###
+    def to_s
+      "#{self.class}, name: #{@name}, id: #{@id}"
+    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
@@ -562,59 +589,56 @@ module JSS
       doc = REXML::Document.new APIConnection::XML_HEADER
       tmpl = doc.add_element self.class::RSRC_OBJECT_KEY.to_s
       tmpl.add_element('name').text = @name
-      return doc.to_s
+      doc.to_s
     end
 
-
     ### Aliases
 
     alias in_jss? in_jss
 
   end # class APIObject
 
-
-
 end # module JSS
 
 ### Mix-in Sub Modules
-require "jss/api_object/creatable"
-require "jss/api_object/uploadable"
-require "jss/api_object/locatable"
-require "jss/api_object/matchable"
-require "jss/api_object/purchasable"
-require "jss/api_object/updatable"
-require "jss/api_object/extendable"
-require "jss/api_object/self_servable"
+require 'jss/api_object/creatable'
+require 'jss/api_object/uploadable'
+require 'jss/api_object/locatable'
+require 'jss/api_object/matchable'
+require 'jss/api_object/purchasable'
+require 'jss/api_object/updatable'
+require 'jss/api_object/extendable'
+require 'jss/api_object/self_servable'
 
 ### Mix-in Sub Modules with Classes
-require "jss/api_object/criteriable"
-require "jss/api_object/scopable"
+require 'jss/api_object/criteriable'
+require 'jss/api_object/scopable'
 
 ### APIObject SubClasses with SubClasses
-require "jss/api_object/advanced_search"
-require "jss/api_object/extension_attribute"
-require "jss/api_object/group"
+require 'jss/api_object/advanced_search'
+require 'jss/api_object/extension_attribute'
+require 'jss/api_object/group'
 
 ### APIObject SubClasses without SubClasses
-require "jss/api_object/account"
-require "jss/api_object/building"
-require "jss/api_object/category"
-require "jss/api_object/computer"
-require "jss/api_object/computer_invitation"
-require "jss/api_object/department"
-require "jss/api_object/distribution_point"
-require "jss/api_object/ldap_server"
-require "jss/api_object/mobile_device"
-require "jss/api_object/netboot_server"
-require "jss/api_object/network_segment"
-require "jss/api_object/osx_configuration_profile"
-require "jss/api_object/package"
-require "jss/api_object/peripheral_type"
-require "jss/api_object/peripheral"
-require "jss/api_object/policy"
-require "jss/api_object/removable_macaddr"
-require "jss/api_object/restricted_software"
-require "jss/api_object/script"
-require "jss/api_object/site"
-require "jss/api_object/software_update_server"
-require "jss/api_object/user"
+require 'jss/api_object/account'
+require 'jss/api_object/building'
+require 'jss/api_object/category'
+require 'jss/api_object/computer'
+require 'jss/api_object/computer_invitation'
+require 'jss/api_object/department'
+require 'jss/api_object/distribution_point'
+require 'jss/api_object/ldap_server'
+require 'jss/api_object/mobile_device'
+require 'jss/api_object/netboot_server'
+require 'jss/api_object/network_segment'
+require 'jss/api_object/osx_configuration_profile'
+require 'jss/api_object/package'
+require 'jss/api_object/peripheral_type'
+require 'jss/api_object/peripheral'
+require 'jss/api_object/policy'
+require 'jss/api_object/removable_macaddr'
+require 'jss/api_object/restricted_software'
+require 'jss/api_object/script'
+require 'jss/api_object/site'
+require 'jss/api_object/software_update_server'
+require 'jss/api_object/user'