Module: JSS::Extendable

Included in:
Computer, MobileDevice, User
Defined in:
lib/jss/api_object/extendable.rb,
lib/jss.rb

Overview

A mix-in module for handling extension attribute data for objects in the JSS.

This module provides standardized ways to deal with Extension Attribute data in objects that gather that data (Computers, MobileDevices, and Users). For working with the Extension Attributes themselves, see ExtensionAttribute and its subclasses.

API objects that have Extension Attribute data return it in an Array of Hashes, one for each defined ExtensionAttribute for the class; i.e. a Computer‘s Array has one Hash for each ComputerExtensionAttribute defined in the JSS.

The Hash keys are:

  • :id => the ExtAttr id

  • :name => the ExtAttr name

  • :type => the data type of the ExtAttr value

  • :value => the value for the ExtAttr for this object as of the last report.

Classes including this module must define the constant EXT_ATTRIB_CLASS specifying which ExtensionAttribute subclass defines the relevant extension attributes. For Example, Computer sets this:

EXT_ATTRIB_CLASS = JSS::ComputerExtensionAttribute

Parsing also populates @ext_attrs which is a Hash of name => value for each EA.

When updating or creating, those classes must add the REXML output of #ext_attr_xml to their rest_xml output.

Constant Summary collapse

EXTENDABLE =

Constants

true
INVALID_DATE = 
'-- INVALIDLY FORMATTED DATE --'.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#extension_attributes ⇒ Array<Hash> (readonly)

Returns The extension attribute values for the object.

Returns:

  • (Array<Hash>) —

    The extension attribute values for the object



74
75
76
 
# File 'lib/jss/api_object/extendable.rb', line 74

def extension_attributes
  @extension_attributes
end

Instance Method Details

#ea_names ⇒ Array<String>

Returns the names of all known EAs.

Returns:



97
98
99
 
# File 'lib/jss/api_object/extendable.rb', line 97

def ea_names
  ea_types.keys
end

#ea_types ⇒ Hash{String => String}

Returns EA names => data type (one of ‘String’, ‘Number’, or ‘Date’).

Returns:

  • (Hash{String => String}) —

    EA names => data type (one of ‘String’, ‘Number’, or ‘Date’)



103
104
105
106
107
108
109
 
# File 'lib/jss/api_object/extendable.rb', line 103

def ea_types
  return @ea_types if @ea_types

  @ea_types = {}
  extension_attributes.each { |ea| @ea_types[ea[:name]] = ea[:type] }
  @ea_types
end

#ext_attr_xml ⇒ REXML::Element

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

TODO: make this (and all XML amending) method take the in-progress XML doc and add (or not) the EA xml to it. See how Sitable#add_site_to_xml works, as called from Computer.rest_xml

Returns:

  • (REXML::Element) —

    An <extension_attribute> element to be included in the rest_xml of objects that mix-in this module.



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/jss/api_object/extendable.rb', line 229

def ext_attr_xml
  @changed_eas ||= []
  eaxml = REXML::Element.new('extension_attributes')
  @extension_attributes.each do |ea|
    next unless @changed_eas.include? ea[:name]
    ea_el = eaxml.add_element('extension_attribute')
    ea_el.add_element('name').text = ea[:name]

    if ea[:type] == 'Date'
      begin
        ea_el.add_element('value').text = ea[:value].to_jss_date
      rescue
        ea_el.add_element('value').text = ea[:value].to_s
      end
    else
      ea_el.add_element('value').text = ea[:value].to_s
    end # if
  end # each do ea

  eaxml
end

#ext_attrs ⇒ Object

An easier-to-use hash of EA name to EA value. This isn’t created until its needed, to speed up instantiation.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/jss/api_object/extendable.rb', line 114

def ext_attrs
  return @ext_attrs if @ext_attrs

  @ext_attrs = {}
  @extension_attributes.each do |ea|
    @ext_attrs[ea[:name]] =
      case ea[:type]

      when 'Date'
        begin # if there's random non-date data, the parse will fail
          JSS.parse_datetime ea[:value]
        rescue
          INVALID_DATE
        end

      when *JSS::ExtensionAttribute::NUMERIC_TYPES
        ea[:value].to_i unless ea[:value].to_s.empty?

      else # String
        ea[:value]
      end # case
  end # each do ea

  @ext_attrs
end

#parse_ext_attrs ⇒ void

This method returns an undefined value.

Populate @extension_attributes (the Array of Hashes that comes from the API) and @ext_attr_names, which is a Hash mapping the EA names to their values. This is called during initialization for all objects that mix in this module



86
87
88
89
90
91
92
93
 
# File 'lib/jss/api_object/extendable.rb', line 86

def parse_ext_attrs
  @extension_attributes = @init_data[:extension_attributes]
  @extension_attributes ||= []

  # remember changes as they happen so
  # we only send changes back to the server.
  @changed_eas = []
end

#set_ext_attr(name, value, validate_popup_choice: true, refresh: false) ⇒ void

This method returns an undefined value.

Set the value of an extension attribute

The new value is validated based on the data type of the Ext. Attrib:

  • If the ext. attrib. is defined with a data type of Integer/Number, the value must be an Integer.

  • If defined with a data type of Date, the value will be parsed as a timestamp, and parsing may raise an exception. Dates can’t be blank.

  • If defined wth data type of String, ‘to_s` will be called on the value.

By default, the full EA definition object is fetched to see if the EA’s input type is ‘popup menu’, and if so, the new value must be one of the defined popup choices, or blank.

The EA definitions used for popup validation are cached, so we don’t have to reach out to the server every time. If you expect the definition to have changed since it was cached, provide a truthy value to the refresh: parameter

To bypass popup validation complepletely, provide a falsey value to the validate_popup_choice: parameter. WARNING: beware that your value is the correct type and format, or you might get errors when saving back to the API.

Note that while the Jamf Pro Web interface does not allow editing the values of Extension Attributes populated by Scripts or LDAP, the API does allow it. Bear in mind however that those values will be reset again at the next recon.

Parameters:

  • name (String) —

    the name of the extension attribute to set

  • value (String, Time, Integer) —

    the new value for the extension attribute for this user

  • validate_popup_choice (Boolean) (defaults to: true) —

    validate the new value against the E.A. definition. Defaults to true.

  • refresh (Boolean) (defaults to: false) —

    Re-read the ext. attrib definition from the API, for popup validation.

Raises:

  • (ArgumentError) 


183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/jss/api_object/extendable.rb', line 183

def set_ext_attr(name, value, validate_popup_choice: true, refresh: false)
  raise ArgumentError, "Unknown Extension Attribute Name: '#{name}'" unless ea_types.key? name

  value ||= JSS::BLANK
  validate_popup_value(name, value, refresh) if validate_popup_choice

  case ea_types[name]
  when JSS::ExtensionAttribute::DATA_TYPE_DATE
    raise JSS::InvalidDataError, "The value for #{name} must be a date, cannot be blank" if value == JSS::BLANK

    value = JSS.parse_datetime value

  when *JSS::ExtensionAttribute::NUMERIC_TYPES
    raise JSS::InvalidDataError, "The value for #{name} must be an integer" unless value.is_a? Integer

  else # String
    value = value.to_s
  end # case

  # update this ea hash in the @extension_attributes array
  @extension_attributes.each { |ea| ea[:value] = value if ea[:name] == name }

  # update the shortcut hash too
  @ext_attrs[name] = value if @ext_attrs
  @changed_eas << name
  @need_to_update = true
end

#unsaved_eas? ⇒ Boolean

are there any changes in the EAs needing to be saved?

Returns:

  • (Boolean) 


215
216
217
 
# File 'lib/jss/api_object/extendable.rb', line 215

def unsaved_eas?
  @need_to_update && @changed_eas && !@changed_eas.empty?
end

#validate_popup_value(name, value, refresh) ⇒ Object

Used by set_ext_attr

Raises:



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/jss/api_object/extendable.rb', line 252

def validate_popup_value(name, value, refresh)
  # all popups can take blanks
  return if value == JSS::BLANK

  # get the ea def. instance from the api cache, or the api
  api.ext_attr_definition_cache[self.class] ||= {}
  api.ext_attr_definition_cache[self.class][name] = nil if refresh
  api.ext_attr_definition_cache[self.class][name] ||= self.class::EXT_ATTRIB_CLASS.fetch name: name, api: api

  ea_def = api.ext_attr_definition_cache[self.class][name]
  return unless ea_def.from_popup_menu?

  return if ea_def.popup_choices.include? value.to_s

  raise JSS::UnsupportedError, "The value for #{name} must be one of: '#{ea_def.popup_choices.join("' '")}'"
end