ruby-jss 0.6.3

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

@@ -0,0 +1,96 @@
+### Copyright 2016 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
+  #####################################
+
+  #####################################
+  ### Classes
+  #####################################
+
+  ###
+  ### An AdvancedComputerSearch in the JSS
+  ###
+  ### @see JSS::AdvancedSearch
+  ###
+  ### @see JSS::APIObject
+  ###
+  class AdvancedMobileDeviceSearch < JSS::AdvancedSearch
+
+    #####################################
+    ### Mix-Ins
+    #####################################
+
+    #####################################
+    ### Class Constants
+    #####################################
+
+    ### The base for REST resources of this class
+    RSRC_BASE = "advancedmobiledevicesearches"
+
+    ### 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
+    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]
+
+    ### 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]
+
+    #####################################
+    ### Attributes
+    #####################################
+
+    #####################################
+    ### Constructor
+    #####################################
+
+    #####################################
+    ### Public Instance Methods
+    #####################################
+
+    #####################################
+    ### Private Instance Methods
+    #####################################
+
+  end # class
+
+end # module

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

@@ -0,0 +1,95 @@
+### Copyright 2016 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
+  #####################################
+
+  #####################################
+  ### Classes
+  #####################################
+
+  ###
+  ### An AdvancedUserSearch in the JSS
+  ###
+  ### @see JSS::AdvancedSearch
+  ###
+  ### @see JSS::APIObject
+  ###
+  class AdvancedUserSearch <  JSS::AdvancedSearch
+
+    #####################################
+    ### Mix-Ins
+    #####################################
+
+    #####################################
+    ### Class Constants
+    #####################################
+
+    ### The base for REST resources of this class
+    RSRC_BASE = "advancedusersearches"
+
+    ### 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
+    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]
+
+    ### 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]
+
+    #####################################
+    ### Attributes
+    #####################################
+
+    #####################################
+    ### Constructor
+    #####################################
+
+    #####################################
+    ### Public Instance Methods
+    #####################################
+
+    #####################################
+    ### Private Instance Methods
+    #####################################
+
+  end # class
+
+end # module

data/lib/jss/api_object/building.rb

@@ -0,0 +1,92 @@
+### Copyright 2016 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
+  #####################################
+
+  
+  #####################################
+  ### Classes
+  #####################################
+
+  ### 
+  ### 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
+    #####################################
+    include JSS::Creatable
+    include JSS::Updatable
+    
+    #####################################
+    ### Class Methods
+    #####################################
+         
+    #####################################
+    ### 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
+    RSRC_LIST_KEY = :buildings
+    
+    ### 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 
+    #####################################
+    
+
+    #####################################
+    ### Public Instance Methods
+    #####################################
+    
+    
+  end # class building
+  
+end # module

data/lib/jss/api_object/category.rb

@@ -0,0 +1,147 @@
+### Copyright 2016 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
+  #####################################
+  
+  
+  #####################################
+  ### Classes
+  #####################################
+  
+  ### 
+  ### A Category in the JSS.
+  ### 
+  ###
+  ### @see JSS::APIObject
+  ### 
+  class Category < JSS::APIObject
+    
+    #####################################
+    ### Mix-Ins
+    #####################################
+    include JSS::Creatable
+    include JSS::Updatable
+    
+    #####################################
+    ### Class Methods
+    #####################################
+    
+    #####################################
+    ### Class Constants
+    #####################################
+    
+    ### The base for REST resources of this class
+    RSRC_BASE = "categories"
+    
+    ### the hash key used for the JSON list output of all objects in the JSS
+    RSRC_LIST_KEY = :categories
+    
+    ### The hash key used for the JSON object output.
+    ### It's also used in various error messages
+    RSRC_OBJECT_KEY = :category
+    
+    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
+    VALID_DATA_KEYS = [:priority]
+    
+    ### The Default category
+    DEFAULT_CATEGORY = "Unknown"
+    
+    ### The range of possible priorities
+    POSSIBLE_PRIORITIES = 1..20
+    
+    ### The Default Priority
+    DEFAULT_PRIORITY = 5
+    
+    #####################################
+    ### Attributes
+    #####################################
+        
+    ### @return [Integer] the SelfService priority for this category
+    attr_reader :priority
+    
+    #####################################
+    ### Constructor 
+    #####################################
+    
+    ###
+    ### See JSS::APIObject#initialize
+    ###
+    def initialize(args = {})
+      super
+      @priority = @init_data[:priority] || DEFAULT_PRIORITY
+      
+    end
+    
+    
+    #####################################
+    ### Public Instance Methods
+    #####################################
+    
+    
+    ###
+    ### Change the Priority
+    ###
+    ### @param new_val[Integer] the new priority, must be in the range POSSIBLE_PRIORITIES
+    ###
+    ### @return [void]
+    ###
+    def priority= (new_val = @priority)
+      return nil if new_val == @priority
+      raise JSS::InvalidDataError, "priority must be an integer between #{POSSIBLE_PRIORITIES.first} and #{POSSIBLE_PRIORITIES.last} (inclusive)" unless POSSIBLE_PRIORITIES.include? new_val
+      @priority = new_val
+      @need_to_update = true
+    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
+    ###
+    ### Most classes will redefine this method.
+    ###
+    def rest_xml
+      doc = REXML::Document.new APIConnection::XML_HEADER
+      tmpl = doc.add_element self.class::RSRC_OBJECT_KEY.to_s
+      tmpl.add_element('name').text = @name
+      tmpl.add_element('priority').text = @priority
+      return doc.to_s
+    end
+  end # class category
+  
+end # module

data/lib/jss/api_object/computer.rb

@@ -0,0 +1,852 @@
+### Copyright 2016 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 Constants
+  #####################################
+
+  #####################################
+  ### Module Variables
+  #####################################
+
+  #####################################
+  ### Module Methods
+  #####################################
+
+
+  ###
+  ### This class represents a Computer in the JSS.
+  ###
+  ### ===Adding Computers to the JSS
+  ###
+  ### This class cannot be used to add new Computers to the JSS. Please use other
+  ### Casper methods (like the Recon App or QuickAdd package)
+  ###
+  ### ---
+  ### ===Editing values
+  ###
+  ### Any data that arrives in the JSS via an "inventory update"
+  ### (a.k.a. 'recon') cannot be modified through this class, or the API.
+  ###
+  ### Data that can be modified are:
+  ### * Management Account (see #set_management_to)
+  ### * asset_tag
+  ### * barcodes 1 and 2
+  ### * ip_address
+  ### * udid
+  ### * mac_addresses
+  ### * location data from the Locatable module
+  ### * purchasing data from the Purchasable module
+  ###
+  ### After making any changes, you must call #update to send those
+  ### changes to the server.
+  ###
+  ### ---
+  ### ===MDM Commands
+  ###
+  ### ==== MDM Commands are Not Yet Supported!
+  ### *Hopefully they will be soon*
+  ###
+  ### The following methods will be used to send an APNS command to the computer represented by an
+  ### instance of JSS::Computer, equivalent to clicking one of the buttons on
+  ### the Management Commands section of the Management tab of the Computer details page in the JSS UI.
+  ###
+  ### The methods supported will be:
+  ### - #blank_push  (aliases blank, noop, send_blank_push)
+  ### - #device_lock (aliases lock, lock_device)
+  ### - #erase_device (aliases wipe)
+  ###
+  ### To send an MDM command without making an instance, use the class method {.send_mdm_command}
+  ###
+  ### Each returns true if the command as sent.
+  ###
+  ### ---
+  ### ===Other Methods
+  ###
+  ### - {#set_management_to} change the management acct and passwd for this computer, aliased to #make_managed
+  ###   - requires calling #update to push changes to the server
+  ### - {#make_unmanaged} an shortcut method for {#set_management_to}(nil)
+  ###   - requires calling #update to push changes to the server
+  ### - {#apps} a shortcut to {#software} [:applications]
+  ### - {#licensed_sw} a shortcut to {#software} [:licensed_software]
+  ### - {#computer_groups} a shortcut to {#groups_accounts} [:computer_group_memberships]
+  ### - {#local_accounts} a shortcut to {#groups_accounts} [:local_accounts]
+  ### - {#drives} a shortcut to {#hardware} [:storage]
+  ### - {#printers} a shortcut to {#hardware} [:mapped_printers]
+  ###
+  ### @see APIObject
+  ### @see Locatable
+  ### @see Purchasable
+  ### @see Matchable
+  ### @see FileUpload
+  ###
+  class Computer  < JSS::APIObject
+
+    #####################################
+    ### MixIns
+    #####################################
+
+    include JSS::Updatable
+    include JSS::Locatable
+    include JSS::Purchasable
+    include JSS::Uploadable
+    include JSS::Extendable
+
+    extend JSS::Matchable
+
+    #####################################
+    ### Class Variables
+    #####################################
+
+    @@all_computers = nil
+
+    #####################################
+    ### Class Methods
+    #####################################
+
+    ### A larger set of info about the computers in the JSS.
+    ###
+    ### Casper 9.4 introduced the API Resource /computers/subset/basic
+    ### that returns an array of hashes with more data than just /computers/
+    ### (which was just :name and :id). Similar to /mobildevices/, this new
+    ### list includes :udid, :serial_number, and :mac_address, as well as :model,
+    ### :managed, :building, :department, :username, and :report_date
+    ###
+    ### Because this requires a different, unusual, resource path, we're completely re-defining
+    ### {APIObject.all} for JSS::Computer.  Hopefully some day the original /computers/
+    ### resource will be updated to return this data.
+    ###
+    ### @param refresh[Boolean] should the data be re-queried from the API?
+    ###
+    ### @return [Array<Hash{:name=>String, :id=> Integer}>]
+    ###
+    def self.all(refresh = false)
+      @@all_computers = nil if refresh
+      return @@all_computers if @@all_computers
+      @@all_computers = JSS::API.get_rsrc(self::LIST_RSRC)[self::RSRC_LIST_KEY]
+    end
+
+    ### @return [Array<String>] all computer serial numbers in the jss
+    def self.all_serial_numbers(refresh = false)
+      self.all(refresh).map{|i| i[:serial_number]}
+    end
+
+    ### @return [Array<String>] all computer mac_addresses in the jss
+    def self.all_mac_addresses(refresh = false)
+      self.all(refresh).map{|i| i[:mac_address]}
+    end
+
+    ### @return [Array<String>] all computer udids in the jss
+    def self.all_udids(refresh = false)
+      self.all(refresh).map{|i| i[:udid]}
+    end
+
+    ### @return [Array<Hash>] all managed computers in the jss
+    def self.all_managed(refresh = false)
+      self.all(refresh).select{|d| d[:managed] }
+    end
+
+    ### @return [Array<Hash>] all unmanaged computers in the jss
+    def self.all_unmanaged(refresh = false)
+      self.all(refresh).select{|d| not d[:managed] }
+    end
+
+    ### @return [Array<Hash>] all laptop computers in the jss
+    def self.all_laptops(refresh = false)
+      self.all(refresh).select{|d| d[:model] =~ /book/i }
+    end
+
+    ### @return [Array<Hash>] all macbooks in the jss
+    def self.all_macbooks(refresh = false)
+      self.all(refresh).select{|d| d[:model] =~ /^macbook\d/i  }
+    end
+
+    ### @return [Array<Hash>] all macbookpros in the jss
+    def self.all_macbookpros(refresh = false)
+      self.all(refresh).select{|d| d[:model] =~ /^macbookpro\d/i  }
+    end
+
+    ### @return [Array<Hash>] all macbookairs in the jss
+    def self.all_macbookairs(refresh = false)
+      self.all(refresh).select{|d| d[:model] =~ /^macbookair\d/i  }
+    end
+
+    ### @return [Array<Hash>] all xserves in the jss
+    def self.all_xserves(refresh = false)
+      self.all(refresh).select{|d| d[:model] =~ /serve/i  }
+    end
+
+    ### @return [Array<Hash>] all desktop macs in the jss
+    def self.all_desktops(refresh = false)
+      self.all(refresh).select{|d| d[:model] !~ /serve|book/i  }
+    end
+
+    ### @return [Array<Hash>] all imacs in the jss
+    def self.all_imacs(refresh = false)
+      self.all(refresh).select{|d| d[:model] =~ /^imac/i  }
+    end
+
+    ### @return [Array<Hash>] all mac minis in the jss
+    def self.all_minis(refresh = false)
+      self.all(refresh).select{|d| d[:model] =~ /^macmini/i  }
+    end
+
+    ### @return [Array<Hash>] all macpros in the jss
+    def self.all_macpros(refresh = false)
+      self.all(refresh).select{|d| d[:model] =~ /^macpro/i  }
+    end
+
+    ###
+    ### Send an MDM command to a managed computer by id or name
+    ###
+    ### @param computer[String,Integer] the name or id of the computer to recieve the command
+    ### @param command[Symbol] the command to send, one of the keys of COMPUTER_MDM_COMMANDS
+    ###
+    ### @return [true] if the command was sent
+    ###
+
+# Not functional until I get more docs from JAMF
+#
+#     def self.send_mdm_command(computer,command)
+#
+#       raise JSS::NoSuchItemError, "Unknown command '#{command}'" unless COMPUTER_MDM_COMMANDS.keys.include? command
+#
+#       command_xml ="#{JSS::APIConnection::XML_HEADER}<computer><command>#{COMPUTER_MDM_COMMANDS[command]}</command></computer>"
+#       the_id = nil
+#
+#       if computer.to_s =~ /^\d+$/
+#         the_id = computer
+#       else
+#         the_id = self.map_all_ids_to(:name).invert[computer]
+#       end
+#
+#       if the_id
+#         response = JSS::API.put_rsrc("#{RSRC_BASE}/id/#{the_id}", command_xml)
+#         response =~ %r{<notification_sent>(.+)</notification_sent>}
+#         return ($1 and $1 == "true")
+#       end
+#       raise JSS::UnmanagedError, "Cannot send command to unknown/unmanaged computer '#{computer}'"
+#     end
+
+
+    #####################################
+    ### Class Constants
+    #####################################
+
+
+    ### The base for REST resources of this class
+    RSRC_BASE = "computers"
+
+    ### The (temporary?) list-resource
+    LIST_RSRC = "#{RSRC_BASE}/subset/basic"
+
+    ### the hash key used for the JSON list output of all objects in the JSS
+    RSRC_LIST_KEY = :computers
+
+    ### The hash key used for the JSON object output.
+    ### It's also used in various error messages
+    RSRC_OBJECT_KEY = :computer
+
+    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
+    VALID_DATA_KEYS = [:sus, :distribution_point, :alt_mac_address ]
+
+    ### This class lets us seach for computers
+    SEARCH_CLASS = JSS::AdvancedComputerSearch
+
+    ### This is the class for relevant Extension Attributes
+    EXT_ATTRIB_CLASS = JSS::ComputerExtensionAttribute
+
+    ### Boot partitions are noted with the string "(Boot Partition)" at the end
+    BOOT_FLAG = " (Boot Partition)"
+
+    ### file uploads can send attachments to the JSS using :computers as the sub-resource.
+    UPLOAD_TYPES = { :attachment => :computers}
+
+    ### A mapping of Symbols available to the send_mdm_command class method, to
+    ### the String commands actuallly sent via the API.
+    COMPUTER_MDM_COMMANDS = {
+      :blank_push => "BlankPush",
+      :send_blank_push => "BlankPush",
+      :blank => "BlankPush",
+      :noop => "BlankPush",
+      :device_lock => "DeviceLock",
+      :lock => "DeviceLock",
+      :lock_device => "DeviceLock",
+      :erase_device => "EraseDevice",
+      :erase => "EraseDevice",
+      :wipe => "EraseDevice",
+      :unmanage_device => "UnmanageDevice",
+      :unmanage => "UnmanageDevice"
+    }
+
+    #####################################
+    ### 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
+
+    ### @return [String] the secondary mac address
+    attr_reader :alt_mac_address
+
+    ### @return [String] the asset tag
+    attr_reader :asset_tag
+
+    ### @return [String] the barcodes
+    attr_reader :barcode_1, :barcode_2
+    
+
+    ### @return [String] The name of the distribution point for this computer
+    attr_reader :distribution_point
+
+    ### @return [Time] when was it added to the JSS
+    attr_reader :initial_entry_date
+
+    ### @return [IPAddr] the last known IP address
+    attr_reader :ip_address
+
+    ### @return [String] the version of the jamf binary
+    attr_reader :jamf_version
+
+    ### @return [Time] the last contact time
+    attr_reader :last_contact_time
+
+    ### @return [String] the primary macaddress
+    attr_reader :mac_address
+
+    ### @return [Boolean] is this machine "managed" by Casper?
+    attr_reader :managed
+
+    ### @return [String] the name of the management account
+    attr_reader :management_username
+
+    ### @return [Boolean] doesit support MDM?
+    attr_reader :mdm_capable
+
+    ### @return [String] the name of the netboot server for this machine
+    attr_reader :netboot_server
+
+    ### @return [String] what kind of computer?
+    attr_reader :platform
+
+    ### @return [Time] the last recon time
+    attr_reader :report_date
+
+    ### @return [String] the serial number
+    attr_reader :serial_number
+    
+
+    ### @return [Hash] the :name and :id of the site for this machine
+    attr_reader :site
+
+    ### @return [String] the name of the Software Update Server assigned to this machine.
+    attr_reader :sus
+
+    ### @return [String] the UDID of the computer
+    attr_reader :udid
+
+
+    ############
+    ### The remaining subsets each go into an attribute of their own.
+    ###
+
+    ### @return [Array<Hash>]
+    ###
+    ### A Hash for each ConfigurationProfile on the computer
+    ###
+    ### The Hash keys are:
+    ### * :id => the ConfigurationProfile id in the JSS
+    ### * :name => the username to whom this user-level profile has been applied (if it's a user-level profile)
+    ### * :uuid => the ConfigurationProfile uuid
+    ###
+    attr_reader :configuration_profiles
+
+    ### @return [Hash]
+    ###
+    ### Info about the local accts and ComputerGroups to which this machine beloings
+    ###
+    ### The Hash keys are:
+    ### * :computer_group_memberships => An Array of names of ComputerGroups to which this computer belongs
+    ### * :local_accounts => An Array of Hashes for each local user acct on this computer. Each hash has these keys:
+    ###   *   :name => String, the login name of the acct
+    ###   *   :realname => the real name of the acct
+    ###   *   :uid => String, the uid of the acct
+    ###   *   :home => String, the path to the home folder
+    ###   *   :home_size => String,  the size of the homedir as a string like "53245MB"
+    ###   *   :home_size_mb => Integer,  the size of the homedir as an integer like 53245
+    ###   *   :administrator => Boolean
+    ###   *   :filevault_enabled => Boolean
+    ###
+    attr_reader :groups_accounts
+
+    ### @return [Hash]
+    ###
+    ### A Hash with info about the hardware of this cmoputer.
+    ###
+    ### These are the keys & sample data
+    ### * :number_processors=>2,
+    ### * :processor_speed_mhz=>2530,
+    ### * :make=>"Apple",
+    ### * :cache_size=>3072,
+    ### * :processor_type=>"Intel Core i5",
+    ### * :total_ram_mb=>8192,
+    ### * :model=>"15-inch MacBook Pro (Mid 2010)",
+    ### * :available_ram_slots=>0,
+    ### * :processor_architecture=>"i386",
+    ### * :bus_speed_mhz=>0,
+    ### * :total_ram=>8192,
+    ### * :os_name=>"Mac OS X",
+    ### * :optical_drive=>"HL-DT-ST DVDRW  GS23N",
+    ### * :model_identifier=>"MacBookPro6,2",
+    ### * :cache_size_kb=>3072,
+    ### * :boot_rom=>"MBP61.0057.B0F",
+    ### * :os_version=>"10.9.3",
+    ### * :mapped_printers=> An Array of Hashes, one per printer, with these keys
+    ###   *  :name => the name of the printer
+    ###   *  :location => the location of the printer
+    ###   *  :type => the printer model
+    ###   *  :uri => the uri to reach the printer on the network
+    ### * :nic_speed=>"10/100/1000",
+    ### * :processor_speed=>2530,
+    ### * :active_directory_status=>"Not Bound",
+    ### * :bus_speed=>0,
+    ### * :os_build=>"13D65",
+    ### * :smc_version=>"1.58f17",
+    ### * :service_pack=>"",
+    ### * :battery_capacity=>87
+    ### * :storage=> An Array of Hashes, one per Drive, with these keys
+    ###   * :smart_status=>"Verified",
+    ###   * :connection_type=>"NO",
+    ###   * :model=>"M4-CT256M4SSD2",
+    ###   * :revision=>"040H",
+    ###   * :serial_number=>"00000000130709JH7GhhC",
+    ###   * :size=>262205,
+    ###   * :disk=>"disk0",
+    ###   * :drive_capacity_mb=>262205}],
+    ###   * :partition=> A Hash with these keys
+    ###     * :filevault2_status=>"Encrypted",
+    ###     * :type=>"boot",
+    ###     * :filevault2_percent=>100,
+    ###     * :partition_capacity_mb=>38014,
+    ###     * :lvgUUID=>"C4883AF5-3E58-4F76-A56C-094D4CEC7E9F",
+    ###     * :percentage_full=>61,
+    ###     * :lvUUID=>"745A262E-AEA6-4608-8A3A-6CDC225B4DE6",
+    ###     * :filevault_status=>"Encrypted",
+    ###     * :size=>38014,
+    ###     * :pvUUID=>"C38051CF-5066-442F-A442-1035060ED462",
+    ###     * :name=>"KimDrive40 (Boot Partition)",
+    ###     * :filevault_percent=>100
+    ###
+    attr_reader :hardware
+
+    ### DEPRECATED
+    ### attr_reader :iphones
+
+    ### @return [Array<Hash>]
+    ###
+    ### A Hash per peripheral
+    ###
+    ### Each hash has these keys & sample data:
+    ### *  :id=>286,
+    ### *  :type=>"Display",
+    ### *  :field_0=>"HP",
+    ### *  :field_1=>"HP LP2480zx",
+    ### *  :field_2=>"DreamColor",
+    ### *  :field_3=>"3CM10800F4",
+    ### *  :field_4=>"",
+    ### *  :field_5=>""
+    ### *  :field_6=>"",
+    ### *  :bar_code_1=>"",
+    ### *  :bar_code_2=>"",
+    ### *  :purchasing=> A hash with these keys:
+    ###    * :warranty_expires_utc=>"",
+    ###    * :is_leased=>false,
+    ###    * :po_date=>"",
+    ###    * :lease_expires=>"",
+    ###    * :po_number=>"",
+    ###    * :po_date_epoch=>0,
+    ###    * :lease_expires_epoch=>0,
+    ###    * :vendor=>"",
+    ###    * :attachments=>[],
+    ###    * :po_date_utc=>"",
+    ###    * :lease_expires_utc=>"",
+    ###    * :applecare_id=>"",
+    ###    * :warranty_expires=>"",
+    ###    * :life_expectancy=>0,
+    ###    * :purchase_price=>"",
+    ###    * :warranty_expires_epoch=>0,
+    ###    * :is_purchased=>true,
+    ###    * :purchasing_contact=>"",
+    ###    * :purchasing_account=>""
+    ###
+    attr_reader :peripherals
+
+    ### @return [Hash]
+    ###
+    ### A Hash of software data
+    ###
+    ### The Hash has these keys:
+    ### * :running_services => An Array of services running on the computer (if gathered) TODO - is each item a hash?
+    ### * :installed_by_casper => An Array of Package names unstalled on this computer by Casper
+    ### * :fonts => An Array of fonts on this computer (if gathered) TODO - is each item a hash?
+    ### * :installed_by_installer_swu => An Array of pkg IDs for pkgs installed by SoftwareUpdate or the Apple Installer
+    ### * :applications => An Array of Hashes, one per Application on the computer, with these keys:
+    ###   *   :path => String, the path to the app
+    ###   *   :name => String, the name of the app, including the .app suffix
+    ###   *   :version => String, the version of the app at that path.
+    ### * :cached_by_casper => An Array of Casper Package names cached on the machine, awaiting installation
+    ### * :available_software_updates => An Array of available SoftwareUpdate (if gathered) TODO - is each item a hash?
+    ### * :plugins => An Array of plugins installed on the machine (if gathered) TODO - is each item a hash?
+    ### * :available_updates => A Hash - Deprecated?
+    ### * :licensed_software => An Array, the names of Licenced Software (as defined in Casper) on this machine
+    ### * :unix_executables => DEPRECATED
+    ###
+    attr_reader :software
+
+    #####################################
+    ### Instance Methods
+    #####################################
+
+    ###
+    ### @param (see APIObject#initialize)
+    ###
+    ### As well as :id and :name, computers can be queried using :udid, :serialnumber, and :mac_address
+    ###
+    def initialize (args = {})
+
+      super args, [:udid, :serialnumber, :mac_address]
+
+      ### now we have raw @init_data with something in it, so fill out the instance vars
+      @alt_mac_address = @init_data[:general][:alt_mac_address]
+      @asset_tag = @init_data[:general][:asset_tag]
+      @barcode_1 = @init_data[:general][:barcode_1]
+      @barcode_2 = @init_data[:general][:barcode_2]
+      @distribution_point = @init_data[:general][:distribution_point]
+      @initial_entry_date = JSS.epoch_to_time @init_data[:general][:initial_entry_date_epoch]
+      @ip_address = @init_data[:general][:ip_address]
+      @jamf_version = @init_data[:general][:jamf_version]
+      @last_contact_time = JSS.epoch_to_time @init_data[:general][:last_contact_time_epoch]
+      @mac_address = @init_data[:general][:mac_address]
+      @managed = @init_data[:general][:remote_management][:managed]
+      @management_username = @init_data[:general][:remote_management][:management_username]
+      @mdm_capable = @init_data[:general][:mdm_capable]
+      @netboot_server = @init_data[:general][:netboot_server]
+      @platform = @init_data[:general][:platform]
+      @report_date = JSS.epoch_to_time @init_data[:general][:report_date_epoch]
+      @serial_number = @init_data[:general][:serial_number]
+      @site =  JSS::APIObject.get_name( @init_data[:general][:site])
+      @sus = @init_data[:general][:sus]
+      @udid = @init_data[:general][:udid]
+
+      parse_location
+      parse_purchasing
+      parse_ext_attrs
+
+      @configuration_profiles = @init_data[:configuration_profiles]
+      @extension_attributes = @init_data[:extension_attributes]
+      @groups_accounts = @init_data[:groups_accounts]
+      @hardware = @init_data[:hardware]
+      @peripherals = @init_data[:peripherals]
+      @software = @init_data[:software]
+
+      @management_password = nil
+
+    end # initialize
+
+    ###
+    ### @return [Array] the JSS groups to which thismachine belongs (smart and static)
+    ###
+    def computer_groups
+      @groups_accounts[:computer_group_memberships]
+    end
+
+    ###
+    ### @return [Array<Hash>] all the local accts on the machine.
+    ###
+    ### Each item has keys :name, :realname, :uid, :home, :home_size, :administrator, :filevault_enabled
+    ###
+    def local_accounts
+      @groups_accounts[:local_accounts]
+    end
+    
+
+    ###
+    ### @return [Array<Hash>]  each storage device
+    ###
+    def drives
+      @hardware[:storage]
+    end
+
+    ###
+    ### @return [Array<Hash>]  each printer on this computer
+    ###   Keys are :name, :uri, :type, :location
+    ###
+    def printers
+      @hardware[:mapped_printers]
+    end
+
+    ###
+    ### @return [Array<Hash>]  all apps installed on this machine.
+    ###   Hash keys are :name, :path, and :version
+    ###
+    def apps ; @software[:applications] ; end
+
+    ###
+    ### @return [Array<String>] the JSS-defined "licensed software" titles
+    ###   installed on this machine.
+    ###
+    def licensed_sw ; @software[:licensed_software] ; end
+
+    ###
+    ### Set or unset management acct and password for this computer
+    ###
+    ### @param name[String] the name of the management acct.
+    ###
+    ### @param password[String] the password of the management acct
+    ###
+    ### @return [void]
+    ###
+    ### The changes will need to be pushed to the server with #update
+    ### before they take effect.
+    ###
+    ### CAUTION: this does nothing to confirm the name and password
+    ### will work on the machine!
+    ###
+    def set_management_to (name, password)
+      password = nil unless name
+      @management_username = name
+      @management_password = password
+      @managed = name ? true : false
+      @need_to_update = true
+    end
+
+    ###
+    ### Make the machine unmanaged.
+    ###
+    ### The same as
+    ###   #set_management_to nil, nil
+    ### followed by
+    ###   JSS::Computer.send_mdm_command @id, :unmanage_device
+    ### which currently isn't working
+    ###
+    ### @return [void]
+    ###
+    def make_unmanaged
+      return nil unless managed?
+      set_management_to(nil, nil)
+      begin
+        self.class.send_mdm_command(@id, :unmanage_device)
+      rescue
+      end
+    end
+
+    ###
+    def asset_tag= (new_val)
+      return nil if @asset_tag == new_val
+      new_val.strip!
+      @asset_tag = new_val
+      @need_to_update = true
+    end
+
+    ###
+    def barcode_1= (new_val)
+      return nil if @barcode_1 == new_val
+      new_val.strip!
+      @barcode_1 = new_val
+      @need_to_update = true
+    end
+
+    ###
+    def barcode_2= (new_val)
+      return nil if @barcode_2 == new_val
+      new_val.strip!
+      @barcode_2 = new_val
+      @need_to_update = true
+    end
+
+    ###
+    def ip_address= (new_val)
+      return nil if @ip_address == new_val
+      new_val.strip!
+      ### this raises an error if its an invalid IP address
+      IPAddr.new new_val
+      @ip_address = new_val
+      @need_to_update = true
+    end
+
+    ###
+    ### Send changes to the API
+    ###
+    ### @return [void]
+    ###
+    def update
+      id = super
+      @management_password = nil
+      id
+    end
+
+    ###
+    ### Delete this computer from the JSS
+    ###
+    ### @return [void]
+    ###
+    def delete
+      super
+      @alt_mac_address = nil
+      @asset_tag = nil
+      @barcode_1 = nil
+      @barcode_2 = nil
+      @distribution_point = nil
+      @initial_entry_date = nil
+      @ip_address = nil
+      @jamf_version = nil
+      @last_contact_time = nil
+      @macaddress = nil
+      @managed = nil
+      @management_username = nil
+      @mdm_capable = nil
+      @netboot_server = nil
+      @platform = nil
+      @report_date = nil
+      @serial_number = nil
+      @site = nil
+      @sus = nil
+      @udid = nil
+
+      @building = nil
+      @department = nil
+      @email_address = nil
+      @phone = nil
+      @position = nil
+      @real_name = nil
+      @room = nil
+      @username = nil
+
+      @configuration_profiles = nil
+      @extension_attributes = nil
+      @groups_accounts = nil
+      @hardware = nil
+      @peripherals = nil
+      @purchasing = nil
+      @software = nil
+    end #delete
+    
+    
+# Not Functional until I get more docs from JAMF
+#
+#     ###
+#     ### Send a blank_push MDM command
+#     ###
+#     def blank_push
+#       self.class.send_mdm_command @id, :blank_push
+#     end
+#     alias noop blank_push
+#     alias send_blank_push blank_push
+#
+#     ###
+#     ### Send a device_lock MDM command
+#     ###
+#     def device_lock
+#       self.class.send_mdm_command @id, :device_lock
+#     end
+#     alias lock device_lock
+#     alias lock_device device_lock
+#
+#     ###
+#     ### Send an erase_device MDM command
+#     ###
+#     def erase_device
+#       self.class.send_mdm_command @id, :erase_device
+#     end
+#     alias erase erase_device
+#     alias wipe erase_device
+
+    
+    ### aliases
+    alias alt_macaddress alt_mac_address
+    alias bar_code_1 barcode_1
+    alias bar_code_2 barcode_2
+    alias managed? managed
+    alias mdm? mdm_capable
+    alias last_recon report_date
+    alias sn serial_number
+    alias serialnumber serial_number
+    alias accounts local_accounts
+    alias accts local_accounts
+    alias make_managed set_management_to
+
+
+
+
+
+    ##############################
+     ### private methods
+    ##############################
+    private
+
+    ###
+    ### Return a String with the XML Resource
+    ### for submitting  changes to the JSS via
+    ### the API
+    ###
+    ### For Computers, only some items can be changed via the API
+    ### In particular, any data gatherd by a Recon cannot be changed
+    ###
+    def rest_xml
+      doc = REXML::Document.new APIConnection::XML_HEADER
+      computer = doc.add_element self.class::RSRC_OBJECT_KEY.to_s
+
+      general = computer.add_element('general')
+      general.add_element('name').text = @name
+      general.add_element('alt_mac_address').text = @alt_mac_address
+      general.add_element('asset_tag').text = @asset_tag
+      general.add_element('barcode_1').text = @barcode_1
+      general.add_element('barcode_2').text = @barcode_2
+      general.add_element('ip_address').text = @ip_address
+      general.add_element('mac_address').text = @mac_address
+      general.add_element('udid').text = @udid
+
+      rmgmt = general.add_element('remote_management')
+      rmgmt.add_element('managed').text = @managed
+      rmgmt.add_element('management_username').text = @management_username
+      rmgmt.add_element('management_password').text = @management_password if @management_password
+
+      computer << ext_attr_xml
+
+      if has_location?
+        computer << location_xml
+      end
+      if has_purchasing?
+        computer << purchasing_xml
+      end
+
+      return doc.to_s
+    end
+
+  end # class Computer
+end # module