ruby-jss 1.2.0 → 1.2.2

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

@@ -1,82 +1,56 @@
-### Copyright 2019 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
-
-  #####################################
-  ### Constants
-  #####################################
+# Copyright 2019 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 Variables
-  #####################################
+module JSS
 
-  #####################################
-  ### Module Methods
+  # Classes
   #####################################
 
-  ####################################
-  ### Classes
-  #####################################
 
-  ###
-  ### An extension attribute as defined in the JSS
-  ###
-  ### @see JSS::ExtensionAttribute
-  ###
-  ### @see JSS::APIObject
-  ###
+  # An extension attribute as defined in the JSS
+  #
+  # @see JSS::ExtensionAttribute
+  #
+  # @see JSS::APIObject
+  #
   class MobileDeviceExtensionAttribute < JSS::ExtensionAttribute
 
-    #####################################
-    ### Mix-Ins
-    #####################################
-
-    #####################################
-    ### Class Methods
-    #####################################
-
-    #####################################
-    ### Class Constants
+    # Class Constants
     #####################################
 
-    ### The base for REST resources of this class
+    # The base for REST resources of this class
     RSRC_BASE = 'mobiledeviceextensionattributes'.freeze
 
-    ### the hash key used for the JSON list output of all objects in the JSS
+    # the hash key used for the JSON list output of all objects in the JSS
     RSRC_LIST_KEY = :mobile_device_extension_attributes
 
-    ### The hash key used for the JSON object output.
-    ### It's also used in various error messages
+    # The hash key used for the JSON object output.
+    # It's also used in various error messages
     RSRC_OBJECT_KEY = :mobile_device_extension_attribute
 
-    ### these ext attribs are related to these kinds of objects
+    # 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
+    # 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')
 
     # the object type for this object in
@@ -84,101 +58,44 @@ module JSS
     # See {APIObject#add_object_history_entry}
     OBJECT_HISTORY_OBJECT_TYPE = 86
 
-    ######################
-    ### Attributes
-    ######################
-
-    ### @return [String] the name of the LDAP attribute to use when the @input Type is "LDAP Attribute Mapping"
-    attr_reader :attribute_mapping
-
-    #####################################
-    ### Constructor
-    #####################################
-
-    ###
-    ### See JSS::APIObject.initialize
-    ###
-    def initialize(args = {})
-      super args
-      @attribute_mapping = @init_data[:input_type][:attribute_mapping] if @init_data[:input_type]
-    end # init
-
-    #####################################
-    ### Public Instance Methods
+    # Public Instance Methods
     #####################################
 
-    ###
-    ### @see JSS::Creatable#create
-    ###
-    def create
-      if @input_type == 'LDAP Attribute Mapping'
-        raise MissingDataError, "No attribute_mapping defined for 'LDAP Attribute Mapping' input_type." unless @attribute_mapping
-      end
-      super
-    end
+    # @see JSS::ExtensionAttribute#web_display=
+    #
+    def web_display=(new_val)
+      raise JSS::InvalidDataError, "Mobile Device Extension Attributes web_display cannot be '#{WEB_DISPLAY_CHOICE_OS}'" if new_val == WEB_DISPLAY_CHOICE_OS
 
-    ###
-    ### @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 web_display
 
-
-    ###
-    ### @see JSS::ExtensionAttribute#input_type=
-    ###
-    def input_type= (new_val)
-      raise JSS::InvalidDataError, "Mobile Device Extension Attribute input_type cannot be 'script'" if new_val == 'script'
+    # @see JSS::ExtensionAttribute#input_type=
+    #
+    def input_type=(new_val)
+      raise JSS::InvalidDataError, "Mobile Device Extension Attribute input_type cannot be '#{INPUT_TYPE_SCRIPT}'" if new_val == INPUT_TYPE_SCRIPT
 
       super
-
-      if @input_type == 'LDAP Attribute Mapping'
-        @popup_choices = nil
-      else
-        @attribute_mapping = nil
-      end
     end # end input_type
 
-    ###
-    ### Set the ldap attribute to use for input_type 'LDAP Attribute Mapping'
-    ###
-    ### @param ldap_attrib[String] the attribute to use
-    ###
-    ### @return [void]
-    ###
-    def attribute_mapping= (ldap_attrib)
-      return nil if ldap_attrib == @attribute_mapping
-      @attribute_mapping = ldap_attrib
-      @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}>]
-    ###
+    # 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
-
+      mobile_device_id = JSS::MobileDevice.valid_id mobiledevice, api: @api
       raise JSS::NoSuchItemError, "No MobileDevice found matching '#{mobiledevice}'" unless mobile_device_id
 
       the_query = <<-END_Q
@@ -192,11 +109,12 @@ module JSS
       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
+        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
@@ -204,29 +122,6 @@ module JSS
       history
     end # history
 
-    ######################
-    ### Private Instance Methods
-    #####################
-
-    private
-
-    ###
-    ### Return the REST XML for this item, with the current values,
-    ### for saving or updating
-    ###
-    def rest_xml
-      mdea = rest_rexml
-      if @input_type == 'LDAP Attribute Mapping'
-        it = mdea.elements["input_type"]
-        it.add_element('attribute_mapping').text = @attribute_mapping
-      end
-
-      doc = REXML::Document.new APIConnection::XML_HEADER
-      doc << mdea
-
-      doc.to_s
-    end # rest xml
-
   end # class ExtAttrib
 
 end # module

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

@@ -1,120 +1,79 @@
-### Copyright 2019 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
-
+# Copyright 2019 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
 
+  # Classes
   #####################################
-  ### Constants
-  #####################################
-
-  #####################################
-  ### Module Variables
-  #####################################
-
-  #####################################
-  ### Module Methods
-  #####################################
-
-  ####################################
-  ### Classes
-  #####################################
-
 
-  ###
-  ### A User extension attribute as defined in the JSS
-  ###
-  ### @see JSS::ExtensionAttribute
-  ### @see JSS::APIObject
-  ###
+  # A User extension attribute as defined in the JSS
+  #
+  # @see JSS::ExtensionAttribute
+  # @see JSS::APIObject
+  #
   class UserExtensionAttribute < JSS::ExtensionAttribute
 
-    #####################################
-    ### Mix-Ins
-    #####################################
-
-    #####################################
-    ### Class Methods
-    #####################################
-
-    #####################################
-    ### Class Constants
+    # Class Constants
     #####################################
 
-    ### The base for REST resources of this class
-    RSRC_BASE = "userextensionattributes"
+    # The base for REST resources of this class
+    RSRC_BASE = 'userextensionattributes'.freeze
 
-    ### the hash key used for the JSON list output of all objects in the JSS
+    # the hash key used for the JSON list output of all objects in the JSS
     RSRC_LIST_KEY = :user_extension_attributes
 
-    ### The hash key used for the JSON object output.
-    ### It's also used in various error messages
+    # The hash key used for the JSON object output.
+    # It's also used in various error messages
     RSRC_OBJECT_KEY = :user_extension_attribute
 
-    ### these ext attribs are related to these kinds of objects
+    # these ext attribs are related to these kinds of objects
     TARGET_CLASS = JSS::User
 
-    ### A criterion that will return all members of the TARGET_CLASS
-    ALL_TARGETS_CRITERION = JSS::Criteriable::Criterion.new(:and_or => "and", :name => "Username", :search_type => "like", :value => '')
+    # A criterion that will return all members of the TARGET_CLASS
+    ALL_TARGETS_CRITERION = JSS::Criteriable::Criterion.new(and_or: 'and', name: 'Username', search_type: 'like', value: '')
 
     # the object type for this object in
     # the object history table.
     # See {APIObject#add_object_history_entry}
     OBJECT_HISTORY_OBJECT_TYPE = 87
 
-    ######################
-    ### Attributes
-    ######################
-
-    #####################################
-    ### Constructor
+    # Public Instance Methods
     #####################################
 
-    #####################################
-    ### Public Instance Methods
-    #####################################
+    # @see JSS::ExtensionAttribute#input_type=
+    #
+    def input_type=(new_val)
+      raise JSS::InvalidDataError, "User Extension Attribute input_type cannot be '#{INPUT_TYPE_SCRIPT}'" if new_val == INPUT_TYPE_SCRIPT
+      raise JSS::InvalidDataError, "User Extension Attribute input_type cannot be '#{INPUT_TYPE_LDAP}'" if new_val == INPUT_TYPE_LDAP
 
-    ######################
-    ### Private Instance Methods
-    #####################
-    private
-
-    ###
-    ### Return the REST XML for this item, with the current values,
-    ### for saving or updating
-    ###
-    def rest_xml
-      uea = rest_rexml
-      doc = REXML::Document.new APIConnection::XML_HEADER
-      doc << uea
-      return doc.to_s
-    end # rest xml
+      super
+    end # end input_type
 
-  end # class ExtAttrib
+    # @see JSS::ExtensionAttribute#web_display=
+    #
+    def web_display=(_new_val)
+      raise JSS::UnsupportedError, 'User Extension Attributes web_display cannot be set'
+    end
 
+  end # class ExtAttrib
 
 end # module