ruby-jss 1.0.4 → 1.1.0b1

data/lib/jss/api_object/extension_attribute.rb

@@ -66,12 +66,31 @@ module JSS
 
     # What kinds of data can be created by EAs?
     # Note, Dates must be in the format "YYYY-MM-DD hh:mm:ss"
-    DATA_TYPES = %w[String Date Integer].freeze
-    DEFAULT_DATA_TYPE = 'String'.freeze
+
+    DATA_TYPE_STRING = 'String'.freeze
+    DATA_TYPE_NUMBER = 'Number'.freeze
+    DATA_TYPE_INTEGER = 'Integer'.freeze
+    DATA_TYPE_DATE = 'Date'.freeze
+
+    DATA_TYPES = [DATA_TYPE_STRING, DATA_TYPE_DATE, DATA_TYPE_INTEGER].freeze
+
+    DEFAULT_DATA_TYPE = DATA_TYPE_STRING
+
+    # ExtensionAttributes refer to the numeric data type as "Integer"
+    # but the ext. attr values that come with extendable objects refer to
+    # that data type as "Number".  Here's an array with both, so we can
+    # work with ether more easily.
+    NUMERIC_TYPES = [DATA_TYPE_NUMBER, DATA_TYPE_INTEGER].freeze
 
     # Where does the data come from?
-    INPUT_TYPES = ['Text Field', 'Pop-up Menu', 'script', 'LDAP Attribute Mapping'].freeze
-    DEFAULT_INPUT_TYPE = 'Text Field'.freeze
+
+    INPUT_TYPE_FIELD = 'Text Field'.freeze
+    INPUT_TYPE_POPUP = 'Pop-up Menu'.freeze
+    INPUT_TYPE_SCRIPT = 'script'.freeze
+    INPUT_TYPE_LDAP = 'LDAP Attribute Mapping'.freeze
+
+    INPUT_TYPES = [INPUT_TYPE_FIELD, INPUT_TYPE_POPUP, INPUT_TYPE_SCRIPT, INPUT_TYPE_LDAP].freeze
+    DEFAULT_INPUT_TYPE = INPUT_TYPE_FIELD
 
     # Where can it be displayed in the WebApp?
     # subclasses can add to this list
@@ -142,15 +161,13 @@ module JSS
       @symbolized_name = @name.gsub(/-| /, '_').to_sym
     end # init
 
-
     # Public Instance Methods
     ###################################
 
-
     # @see JSS::Creatable#create
     #
     def create
-      if @input_type == 'Pop-up Menu'
+      if @input_type == INPUT_TYPE_POPUP
         raise MissingDataError, 'No popup_choices set for Pop-up Menu input_type.' unless @popup_choices.is_a?(Array) && !@popup_choices.empty?
       end
       super
@@ -159,7 +176,7 @@ module JSS
     # @see JSS::Updatable#update
     #
     def update
-      if @input_type == 'Pop-up Menu'
+      if @input_type == INPUT_TYPE_POPUP
         raise MissingDataError, 'No popup_choices set for Pop-up Menu input_type.' unless @popup_choices.is_a?(Array) && !@popup_choices.empty?
       end
       super
@@ -180,6 +197,22 @@ module JSS
       end
     end
 
+    def from_text_field?
+      @input_type == INPUT_TYPE_FIELD
+    end
+
+    def from_popup_menu?
+      @input_type == INPUT_TYPE_POPUP
+    end
+
+    def from_ldap?
+      @input_type == INPUT_TYPE_LDAP
+    end
+
+    def from_script?
+      @input_type == INPUT_TYPE_SCRIPT
+    end
+
     # Change the description of this EA
     #
     # @param new_val[String] the new value
@@ -228,7 +261,7 @@ module JSS
       return nil if @input_type == new_val
       raise JSS::InvalidDataError, "input_type must be a string, one of: #{INPUT_TYPES.join(', ')}" unless INPUT_TYPES.include? new_val
       @input_type = new_val
-      @popup_choices = nil if @input_type == 'Text Field'
+      @popup_choices = nil if @input_type == INPUT_TYPE_FIELD
       @need_to_update = true
     end #
 
@@ -253,14 +286,14 @@ module JSS
       new_val.map! do |v|
         v = v.to_s.strip
         case @data_type
-        when 'Date'
+        when DATA_TYPE_DATE
           raise JSS::InvalidDataError, "data_type is Date, but '#{v}' is not formatted 'YYYY-MM-DD hh:mm:ss'" unless v =~ /^\d{4}(-\d\d){2} (\d\d:){2}\d\d$/
         when 'Integer'
           raise JSS::InvalidDataError, "data_type is Integer, but '#{v}' is not one" unless v =~ /^\d+$/
         end
         v
       end
-      self.input_type = 'Pop-up Menu'
+      self.input_type = INPUT_TYPE_POPUP
       @popup_choices = new_val
       @need_to_update = true
     end #
@@ -319,7 +352,7 @@ module JSS
     #   :id - the jss id
     #   :name - the object (computer, user, mobiledevice) name
     #   :value - the most recent ext attr value for the object.
-    #   :as_of - the timestamp of when the value was collected (nil for User EAs)
+    #   :as_of - the timestamp of when the value was collected (nil for User EAs, or for devices that have never collected inventory)
     #   :username - the username associated with the object
     #
     # This is done by creating a temporary {AdvancedSearch}
@@ -362,7 +395,7 @@ module JSS
                   else i[@symbolized_name]
           end # case
 
-          as_of = Time.parse(i[LAST_RECON_FIELD_SYM]) if i[LAST_RECON_FIELD_SYM]
+          as_of = Time.parse(i[LAST_RECON_FIELD_SYM]) if i[LAST_RECON_FIELD_SYM] != ''
 
           results << { id: i[:id], name: i[:name], username: i[USERNAME_FIELD_SYM], value: value, as_of: as_of }
         end # acs.search_results.each

data/lib/jss/api_object/extension_attribute/computer_extension_attribute.rb

@@ -76,9 +76,6 @@ module JSS
     ### It's also used in various error messages
     RSRC_OBJECT_KEY = :computer_extension_attribute
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:description, :inventory_display, :recon_display]
-
     ### these ext attribs are related to these kinds of objects
     TARGET_CLASS = JSS::Computer
 

data/lib/jss/api_object/extension_attribute/mobile_device_extension_attribute.rb

@@ -26,8 +26,6 @@
 ###
 module JSS
 
-
-
   #####################################
   ### Constants
   #####################################
@@ -44,7 +42,6 @@ module JSS
   ### Classes
   #####################################
 
-
   ###
   ### An extension attribute as defined in the JSS
   ###
@@ -67,7 +64,7 @@ module JSS
     #####################################
 
     ### The base for REST resources of this class
-    RSRC_BASE = "mobiledeviceextensionattributes"
+    RSRC_BASE = 'mobiledeviceextensionattributes'.freeze
 
     ### the hash key used for the JSON list output of all objects in the JSS
     RSRC_LIST_KEY = :mobile_device_extension_attributes
@@ -76,14 +73,11 @@ module JSS
     ### It's also used in various error messages
     RSRC_OBJECT_KEY = :mobile_device_extension_attribute
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:description, :inventory_display, :recon_display]
-
     ### these ext attribs are related to these kinds of objects
     TARGET_CLASS = JSS::MobileDevice
 
     ### A criterion that will return all members of the TARGET_CLASS
-    ALL_TARGETS_CRITERION = JSS::Criteriable::Criterion.new(:and_or => "and", :name => "Last Inventory Update", :search_type => "after (yyyy-mm-dd)", :value => "2003-01-01")
+    ALL_TARGETS_CRITERION = JSS::Criteriable::Criterion.new(and_or: 'and', name: 'Last Inventory Update', search_type: 'after (yyyy-mm-dd)', value: '2003-01-01')
 
     # the object type for this object in
     # the object history table.
@@ -97,7 +91,6 @@ module JSS
     ### @return [String] the name of the LDAP attribute to use when the @input Type is "LDAP Attribute Mapping"
     attr_reader :attribute_mapping
 
-
     #####################################
     ### Constructor
     #####################################
@@ -106,15 +99,10 @@ module JSS
     ### See JSS::APIObject.initialize
     ###
     def initialize(args = {})
-
       super args
-
-      if @init_data[:input_type]
-        @attribute_mapping = @init_data[:input_type][:attribute_mapping]
-      end
+      @attribute_mapping = @init_data[:input_type][:attribute_mapping] if @init_data[:input_type]
     end # init
 
-
     #####################################
     ### Public Instance Methods
     #####################################
@@ -129,14 +117,13 @@ module JSS
       super
     end
 
-
     ###
     ### @see JSS::ExtensionAttribute#web_display=
     ###
     def web_display= (new_val)
       raise JSS::InvalidDataError, "web_display cannot be 'Operating System' for Mobile Device Extension Attributes." if new_val == 'Operating System'
       super
-    end #
+    end # end web_display
 
 
     ###
@@ -152,7 +139,7 @@ module JSS
       else
         @attribute_mapping = nil
       end
-    end #
+    end # end input_type
 
     ###
     ### Set the ldap attribute to use for input_type 'LDAP Attribute Mapping'
@@ -167,6 +154,56 @@ module JSS
       @need_to_update = true
     end
 
+    ### Return an Array of Hashes showing the history of reported values for this EA on one MobileDevice.
+    ###
+    ### Each hash contains these 2 keys:
+    ### * :value - String, Integer, or Time, depending on @data_type
+    ### * :timestamp - Time
+    ###
+    ### This method requires a MySQL database connection established via JSS::DB_CNX.connect
+    ###
+    ### @see JSS::DBConnection
+    ###
+    ### @param mobiledevice[Integer,String] the id or name of the MobileDevice.
+    ###
+    ### @return [Array<Hash{:timestamp=>Time,:value=>String,Integer,Time}>]
+    ###
+    def history(mobiledevice)
+      raise JSS::NoSuchItemError, "EA Not In JSS! Use #create to create this #{RSRC_OBJECT_KEY}." unless @in_jss
+      raise JSS::InvalidConnectionError, "Database connection required for 'history' query." unless JSS::DB_CNX.connected?
+
+      mobile_device_id = case mobiledevice
+                         when *JSS::MobileDevice.all_ids(api: @api)
+                           mobiledevice
+                         when *JSS::MobileDevice.all_names(api: @api)
+                           JSS::MobileDevice.map_all_ids_to(:name, api: @api).invert[mobiledevice]
+                         end # case
+
+      raise JSS::NoSuchItemError, "No MobileDevice found matching '#{mobiledevice}'" unless mobile_device_id
+
+      the_query = <<-END_Q
+      SELECT eav.value_on_client AS value, r.date_entered_epoch AS timestamp_epoch
+      FROM mobile_device_extension_attribute_values eav JOIN reports r ON eav.report_id = r.report_id
+      WHERE r.mobile_device_id = #{mobile_device_id}
+        AND eav.mobile_device_extension_attribute_id = #{@id}
+      ORDER BY timestamp_epoch
+      END_Q
+
+      qrez = JSS::DB_CNX.db.query the_query
+      history = []
+      qrez.each_hash do |entry|
+        value = case @data_type
+                when 'String' then entry['value']
+                when 'Integer' then entry['value'].to_i
+                when 'Date' then JSS.parse_datetime(entry['value'])
+                end # case
+        newhash = { value: value, timestamp: JSS.epoch_to_time(entry['timestamp_epoch']) }
+        history << newhash
+      end # each hash
+
+      history
+    end # history
+
     ######################
     ### Private Instance Methods
     #####################
@@ -187,7 +224,7 @@ module JSS
       doc = REXML::Document.new APIConnection::XML_HEADER
       doc << mdea
 
-      return doc.to_s
+      doc.to_s
     end # rest xml
 
   end # class ExtAttrib

data/lib/jss/api_object/extension_attribute/user_extension_attribute.rb

@@ -75,9 +75,6 @@ module JSS
     ### It's also used in various error messages
     RSRC_OBJECT_KEY = :user_extension_attribute
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:description, :data_type, :input_type]
-
     ### these ext attribs are related to these kinds of objects
     TARGET_CLASS = JSS::User
 

data/lib/jss/api_object/group/computer_group.rb

@@ -76,9 +76,6 @@ module JSS
     ### It's also used in various error messages
     RSRC_OBJECT_KEY = :computer_group
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:is_smart, :computers ]
-
     ### this allows the parent Group class to do things right
     MEMBER_CLASS = JSS::Computer
 

data/lib/jss/api_object/group/mobile_device_group.rb

@@ -72,9 +72,6 @@ module JSS
     ### It's also used in various error messages
     RSRC_OBJECT_KEY = :mobile_device_group
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:is_smart, :mobile_devices ]
-
     ### this allows the parent Group class to do things right
     MEMBER_CLASS = JSS::MobileDevice
 

data/lib/jss/api_object/group/user_group.rb

@@ -72,9 +72,6 @@ module JSS
     ### It's also used in various error messages
     RSRC_OBJECT_KEY = :user_group
 
-    ### these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:is_smart, :users ]
-
     ### this allows the parent Group class to do things right
     MEMBER_CLASS = JSS::User
 

data/lib/jss/api_object/ldap_server.rb

@@ -60,9 +60,6 @@ module JSS
     # It's also used in various error messages
     RSRC_OBJECT_KEY = :ldap_server
 
-    # these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [].freeze
-
     # the default LDAP port
     DEFAULT_PORT = 389
 

data/lib/jss/api_object/mobile_device.rb

@@ -100,18 +100,34 @@ module JSS
     # Where is the Site data in the API JSON?
     SITE_SUBSET = :general
 
-    # these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = %i[device_name capacity tethered].freeze
-
-    # these keys,  as well as :id and :name, can be used to look up objects of this class in the JSS
+    # these keys,  as well as :id and :name, can be used to look up objects
+    # of this class in the JSS
+    # the wierd alises wifi_mac_addresse,  mac_addresse and macaddresse
+    # are for proper pluralization of 'mac_address' and such
     OTHER_LOOKUP_KEYS = {
-      udid: { rsrc_key: :udid, list: :all_udids },
-      serialnumber: { rsrc_key: :serialnumber, list: :all_serial_numbers },
-      serial_number: { rsrc_key: :serialnumber, list: :all_serial_numbers },
-      macaddress: { rsrc_key: :macaddress, list: :all_wifi_mac_addresses },
-      mac_address: { rsrc_key: :macaddress, list: :all_wifi_mac_addresses }
+      udid: {
+        aliases: [:uuid, :guid],
+        fetch_rsrc_key: :udid
+      },
+      serial_number: {
+        aliases: [:serialnumber, :sn],
+        fetch_rsrc_key: :serialnumber
+      },
+      wifi_mac_address: {
+        aliases: [
+          :wifi_mac_addresse,
+          :mac_address,
+          :mac_addresse,
+          :macaddress,
+          :macaddresse,
+          :macaddr
+        ],
+        fetch_rsrc_key: :macaddress
+      }
     }.freeze
 
+    NON_UNIQUE_NAMES = true
+
     # This class lets us seach for computers
     SEARCH_CLASS = JSS::AdvancedMobileDeviceSearch
 
@@ -129,31 +145,11 @@ module JSS
     # Class Methods
     #####################################
 
-    # @return [Array<String>] all mobiledevice serial_numbers
-    def self.all_serial_numbers(refresh = false, api: JSS.api)
-      all(refresh, api: api).map { |i| i[:serial_number] }
-    end
-
     # @return [Array<String>] all mobiledevice phone numbers
     def self.all_phone_numbers(refresh = false, api: JSS.api)
       all(refresh, api: api).map { |i| i[:phone_number] }.reject(&:empty?)
     end
 
-    # @return [Array<String>] all mobiledevice wifi mac addrs
-    def self.all_wifi_mac_addresses(refresh = false, api: JSS.api)
-      all(refresh, api: api).map { |i| i[:wifi_mac_address] }
-    end
-
-    # @return [Array<String>] all mobiledevice wifi mac addrs
-    def self.all_mac_addresses(refresh = false, api: JSS.api)
-      all_wifi_mac_addresses(refresh, api: api)
-    end
-
-    # @return [Array<String>] all mobiledevice udids
-    def self.all_udids(refresh = false, api: JSS.api)
-      all(refresh, api: api).map { |i| i[:udid] }
-    end
-
     # @return [Array<Hash>] the list of all managed mobile devices
     def self.all_managed(refresh = false, api: JSS.api)
       all(refresh, api: api).select { |d| d[:managed] }

data/lib/jss/api_object/mobile_device_application.rb

@@ -54,10 +54,6 @@ module JSS
     # Class Methods
     #####################################
 
-    def self.all_bundle_ids(refresh = false, api: JSS.api)
-      all(refresh, api: api).map { |mda| mda[:bundle_id] }
-    end
-
     # Class Constants
     #####################################
 
@@ -71,9 +67,6 @@ module JSS
     # It's also used in various error messages
     RSRC_OBJECT_KEY = :mobile_device_application
 
-    # these keys, as well as :id and :name,  are present in valid API JSON data for this class
-    VALID_DATA_KEYS = [:internal_app].freeze
-
     # See JSS::Scopable
     SCOPE_TARGET_KEY = :mobile_devices
 
@@ -86,8 +79,7 @@ module JSS
 
     # see JSS::APIObject
     OTHER_LOOKUP_KEYS = {
-      bundleid: {rsrc_id: :bundleid, list: :all_bundle_ids},
-      bundle_id: {rsrc_id: :bundleid, list: :all_bundle_ids}
+      bundle_id: { aliases: %i[bundleid], fetch_rsrc_key: :bundleid }
     }.freeze
 
     # the object type for this object in