ruby-jss 1.3.2 → 1.5.3

data/lib/jss/api_object/directory_binding_type/centrify.rb

@@ -106,7 +106,7 @@ module JSS
             # @return [void]
             def workstation_mode=(newvalue)
 
-                raise JSS::InvalidDataError, "workstation_mode must be true or false." unless newvalue.is_a? Bool
+                raise JSS::InvalidDataError, "workstation_mode must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
 
                 @workstation_mode = newvalue
 
@@ -125,7 +125,7 @@ module JSS
             # @return [void]
             def overwrite_existing=(newvalue)
 
-                raise JSS::InvalidDataError, "overwrite_existing must be true or false." unless newvalue.is_a? Bool
+                raise JSS::InvalidDataError, "overwrite_existing must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
 
                 @overwrite_existing = newvalue
 
@@ -144,7 +144,7 @@ module JSS
             # @return [void]
             def update_PAM=(newvalue)
 
-                raise JSS::InvalidDataError, "update_PAM must be true or false." unless newvalue.is_a? Bool
+                raise JSS::InvalidDataError, "update_PAM must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
 
                 @update_PAM = newvalue
 
@@ -163,9 +163,16 @@ module JSS
             # @return [void]
             def zone=(newvalue)
 
-                raise JSS::InvalidDataError, "zone must be a string." unless newvalue.is_a? String
+                new =
+                    if newvalue.to_s.empty?
+                        JSS::BLANK
+                    else
+                        # Data Check
+                        raise JSS::InvalidDataError, "zone must be a string." unless newvalue.is_a? String
+                        newvalue
+                    end
 
-                @zone = newvalue
+                @zone = new
 
                 self.container&.should_update
             end
@@ -182,9 +189,16 @@ module JSS
             # @return [void]
             def preferred_domain_server=(newvalue)
 
-                raise JSS::InvalidDataError, "preferred_domain_server must be a string." unless newvalue.is_a? String
+                new =
+                    if newvalue.to_s.empty?
+                        JSS::BLANK
+                    else
+                        # Data Check
+                        raise JSS::InvalidDataError, "preferred_domain_server must be a string." unless newvalue.is_a? String
+                        newvalue
+                    end
 
-                @preferred_domain_server = newvalue
+                @preferred_domain_server = new
 
                 self.container&.should_update
             end

data/lib/jss/api_object/directory_binding_type/open_directory.rb

@@ -93,7 +93,7 @@ module JSS
             # @return [void]
             def encrypt_using_ssl=(newvalue)
 
-                raise JSS::InvalidDataError, "encrypt_using_ssl must be true or false." unless newvalue.is_a? Bool
+                raise JSS::InvalidDataError, "encrypt_using_ssl must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
                 
                 @encrypt_using_ssl = newvalue
 
@@ -112,7 +112,7 @@ module JSS
             # @return [void]
             def perform_secure_bind=(newvalue)
 
-                raise JSS::InvalidDataError, "perform_secure_bind must be true or false." unless newvalue.is_a? Bool
+                raise JSS::InvalidDataError, "perform_secure_bind must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
 
                 @perform_secure_bind = newvalue
 
@@ -131,7 +131,7 @@ module JSS
             # @return [void]
             def use_for_authentication=(newvalue)
 
-                raise JSS::InvalidDataError, "use_for_authentication must be true or false." unless newvalue.is_a? Bool
+                raise JSS::InvalidDataError, "use_for_authentication must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
 
                 @use_for_authentication = newvalue
 
@@ -150,7 +150,7 @@ module JSS
             # @return [void]
             def use_for_contacts=(newvalue)
 
-                raise JSS::InvalidDataError, "use_for_contacts must be true or false." unless newvalue.is_a? Bool
+                raise JSS::InvalidDataError, "use_for_contacts must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
 
                 @use_for_contacts = newvalue
 

data/lib/jss/api_object/distribution_point.rb

@@ -407,9 +407,9 @@ module JSS
 
       begin
         mount pw, :rw
-        return :mountable
+        :mountable
       rescue
-        return false
+        false
       ensure
         unmount
       end

data/lib/jss/api_object/dock_item.rb

@@ -24,8 +24,9 @@
 ###
 
 module JSS
-        
-    # Module Variables
+
+
+  # Module Variables
   #####################################
 
   # Module Methods
@@ -40,98 +41,103 @@ module JSS
   # @see JSS::APIObject
   #
   class DockItem < JSS::APIObject
-    
-        # Mix-Ins
-        #####################################
-        include JSS::Creatable
-        include JSS::Updatable
-
-        # Class Methods
-        #####################################
-
-        # Class Constants
-        #####################################
-
-        # The Dock Item type
-        DOCK_ITEM_TYPE = [
-            "App",
-            "File",
-            "Folder"
-        ].freeze
-
-        # The base for REST resources of this class
-        RSRC_BASE = 'dockitems'.freeze
-
-        # the hash key used for the JSON list output of all objects in the JSS
-        RSRC_LIST_KEY = :dock_items
-
-        # The hash key used for the JSON object output.
-        # It's also used in various error messages
-        RSRC_OBJECT_KEY = :dock_item
-
-        # the object type for this object in
-        # the object history table.
-        # See {APIObject#add_object_history_entry}
-        #OBJECT_HISTORY_OBJECT_TYPE = 41
-
-        # Attributes
-        #####################################
-        attr_reader :id
-        attr_reader :name
-        attr_reader :type
-        attr_reader :path
-
-        # Constructor
-        # @see JSS::APIObject.initialize
-        #####################################
-        def initialize(args = {})
-            super args
-
-            @type = "App" unless !@init_data[:type].nil?
-            @type = @init_data[:type]
-            @path = @init_data[:path]
-        end
-
-        # Public Instance Methods
-        #####################################
-
-        # set the type
-        #
-        # @param newval[String] the new app type
-        #
-        # @return [void]
-        #
-        def type=(newval)
-            raise JSS::InvalidDataError, 'Type must be a string' unless message.is_a? String
-            raise JSS::InvalidDataError, "Type must be one of the following: #{DOCK_ITEM_TYPE.to_s}; not #{newval.to_s}" unless DOCK_ITEM_TYPE.include? newval.to_s
-            @type = newval
-            @need_to_update = true
-        end
-
-        # set the path
-        #
-        # @param newval[String] the new app path
-        def path=(newval)
-            raise JSS::InvalidDataError, 'Path must be a String' unless newval.is_a? String
-            @path = newval
-            @need_to_update = true
-        end
-
-        # private instance methods
-        ######################
-        private
-
-        # the xml formated data for adding or updating this in the JSS
-        #
-        def rest_xml
-            doc = REXML::Document.new APIConnection::XML_HEADER
-            ns = doc.add_element RSRC_OBJECT_KEY.to_s
-            ns.add_element('name').text = @name
-            ns.add_element('type').text = @type.to_s
-            ns.add_element('path').text = @path.to_s
-            doc.to_s
-        end # rest_xml
+
+
+    # Mix-Ins
+    #####################################
+    include JSS::Creatable
+    include JSS::Updatable
+
+    # Class Methods
+    #####################################
+
+    # Class Constants
+    #####################################
+
+    # The Dock Item type
+    DOCK_ITEM_TYPE = %w[
+      App
+      File
+      Folder
+    ].freeze
+
+    # The base for REST resources of this class
+    RSRC_BASE = 'dockitems'.freeze
+
+    # the hash key used for the JSON list output of all objects in the JSS
+    RSRC_LIST_KEY = :dock_items
+
+    # The hash key used for the JSON object output.
+    # It's also used in various error messages
+    RSRC_OBJECT_KEY = :dock_item
+
+    # the object type for this object in
+    # the object history table.
+    # See {APIObject#add_object_history_entry}
+    # OBJECT_HISTORY_OBJECT_TYPE = 41
+
+    # Attributes
+    #####################################
+    attr_reader :id
+    attr_reader :name
+    attr_reader :type
+    attr_reader :path
+
+    # Constructor
+    # @see JSS::APIObject.initialize
+    #####################################
+    def initialize(args = {})
+      super args
+
+      @type = 'App' if @init_data[:type].nil?
+      @type = @init_data[:type]
+      @path = @init_data[:path]
+    end
+
+    # Public Instance Methods
+    #####################################
+
+    # set the type
+    #
+    # @param newval[String] the new app type
+    #
+    # @return [void]
+    #
+    def type=(newval)
+      raise JSS::InvalidDataError, 'Type must be a string' unless newval.is_a? String
+      raise JSS::InvalidDataError, "Type must be one of the following: #{DOCK_ITEM_TYPE}; not #{newval}" unless DOCK_ITEM_TYPE.include? newval.to_s
+
+      @type = newval
+      @need_to_update = true
+    end
+
+    # set the path
+    #
+    # @param newval[String] the new app path
+    def path=(newval)
+      raise JSS::InvalidDataError, 'Path must be a String' unless newval.is_a? String
+
+      @path = newval
+      @need_to_update = true
     end
-        
-    
-end
+
+      # private instance methods
+      ######################
+      private
+
+    # the xml formated data for adding or updating this in the JSS
+    #
+    def rest_xml
+      doc = REXML::Document.new APIConnection::XML_HEADER
+      ns = doc.add_element RSRC_OBJECT_KEY.to_s
+      ns.add_element('name').text = @name
+      ns.add_element('type').text = @type.to_s
+      ns.add_element('path').text = @path.to_s
+      doc.to_s
+    end # rest_xml
+
+    end
+
+
+
+end

data/lib/jss/api_object/ebook.rb

@@ -23,12 +23,11 @@
 ###
 ###
 
-# This is just a stub for now.
 
 #
 module JSS
 
-  #
+  # This is just a stub for now.
   class EBook < APIObject
 
     include Sitable

data/lib/jss/api_object/extendable.rb

@@ -23,7 +23,6 @@
 #
 #
 
-#
 module JSS
 
   # Sub-Modules
@@ -221,6 +220,7 @@ module JSS
       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]
 

data/lib/jss/api_object/extension_attribute.rb

@@ -179,9 +179,10 @@ module JSS
       # deprecated - no longer in the UI
       @recon_display = @init_data[:recon_display] || @web_display
 
-      # the name of the EA might have spaces and caps, which the will come to us as symbols with the spaces
-      # as underscores, like this.
-      @symbolized_name = @name.gsub(/-| /, '_').to_sym
+      # When used in Advanced Search results, the EA name
+      # has colons removed, spaces & dashes turned to underscores.
+      # and then ruby-jss symbolizes the name.
+      @symbolized_name = @name.gsub(':', '').gsub(/-| /, '_').to_sym
     end # init
 
     # Public Instance Methods

data/lib/jss/api_object/group.rb

@@ -241,7 +241,7 @@ module JSS
     #
     # @param retries [Integer] If calculate_members is true, refetching the
     #   group to re-read the membership can happen too fast, the JSS won't know
-    #   it exists yet and will throw a RestClient::NotFound error.  If that
+    #   it exists yet and will throw a NoSuchItem error.  If that
     #   happens, try again this many times with a 1 second pause between attempts.
     #
     def create(calculate_members: true, retries: 10)
@@ -256,7 +256,7 @@ module JSS
           begin
             refresh_members
             break
-          rescue RestClient::NotFound
+          rescue
             sleep 1
             tries += 1
           end # begin
@@ -311,6 +311,37 @@ module JSS
       super
     end
 
+    # Change static group to smart group
+    #
+    # @param args[Hash] the options and settings use for switching the computer group from static group to smart group
+    #
+    # @option args criteria[Array] The criterias to be user for the smart group
+    def set_smart(*params)
+      return if @is_smart
+
+      params[:criteria] = [] if params[:criteria].nil?
+
+      criteria = params[:criteria]
+
+      @is_smart = true
+      @need_to_update = true
+    end
+
+    # Change smart group to static group
+    #
+    # @param args[Hash] the options and settings use for switching the computer group from smart group to static group
+    #
+    # @option args preserve_members[Boolean] Should the smart group preserve it's current members?
+    def set_static(*params)
+      return unless @is_smart
+
+      preserve_members = params.include? :preserve_members
+
+      @is_smart = false
+
+      clear() unless preserve_members
+    end
+
     # How many members of the group?
     #
     # @return [Integer] the number of members of the group

data/lib/jss/api_object/mac_application.rb

@@ -22,15 +22,19 @@
 ###    language governing permissions and limitations under the Apache License.
 ###
 
-# This is just a stub for now.
-
-#
 module JSS
 
-  #
-  class MacApplication < APIObject
+  # This is just a stub for now.
+  class MacApplication < JSS::APIObject
 
-    include Sitable
+    # Mix-Ins
+    #####################################
+    include JSS::Updatable
+    include JSS::Scopable
+    include JSS::SelfServable
+    include JSS::Categorizable
+    include JSS::VPPable
+    include JSS::Sitable
 
     ### The base for REST resources of this class
     RSRC_BASE = 'macapplications'.freeze
@@ -47,9 +51,104 @@ module JSS
     # See {APIObject#add_object_history_entry}
     OBJECT_HISTORY_OBJECT_TYPE = 350
 
+    # See JSS::Scopable
+    SCOPE_TARGET_KEY = :computers
+
+    # Where is the Category in the API JSON?
+    CATEGORY_SUBSET = :general
+
+    # How is the category stored in the API data?
+    CATEGORY_DATA_TYPE = Hash
+
     # Where is the Site data in the API JSON?
     SITE_SUBSET = :general
 
-  end
+    # Attributes
+    #############################################
+
+    # @return [String]
+    attr_reader :version
+
+    # @return [Boolean]
+    attr_reader :is_free
+    alias free? is_free
+
+    # @return [String]
+    attr_reader :bundle_id
+
+    # @return [String]
+    attr_reader :url
+
+    ## Constructor
+    #####################################
+
+    def initialize(args = {})
+      super
+      general = @init_data[:general]
+      @version = general[:version]
+      @is_free = general[:is_free]
+      @bundle_id = general[:bundle_id]
+      @url = general[:url]
+    end
+
+    # Overrides, because consistency isn't alway a thing in the
+    # classic API
+    #############################################
+
+    # Override self_service_display_name getter
+    def self_service_display_name
+      raise JSS::UnsupportedError, 'MacApplications do not have separate display names. Please use the object name.'
+    end
+
+    # Override self_service_display_name setter
+    def self_service_display_name=(_newname)
+      raise JSS::UnsupportedError, 'MacApplications do not have separate display names. Please use the object name.'
+    end
+
+    # Override reinstall_button_text getter
+    def reinstall_button_text
+      raise JSS::UnsupportedError, 'MacApplications do not have separate text for reinstall buttons. Please use install_button_text.'
+    end
+
+    # Override reinstall_button_text setter
+    def reinstall_button_text=(_new)
+      raise JSS::UnsupportedError, 'MacApplications do not have separate text for reinstall buttons. Please use install_button_text.'
+    end
+
+    # Alas, SSvc icons are not uploadable via the API for
+    # mac apps
+    def upload(_type, _local_file)
+      raise JSS::UnsupportedError, 'The Classic API does not support uploading icons for MacApplications. Please use the Web UI'
+    end
+
+    ## Private Instance Methods
+    #####################################
+    private
+
+    ### Return the xml for creating or updating this script in the JSS
+    ###
+    def rest_xml
+      doc = REXML::Document.new APIConnection::XML_HEADER
+      obj = doc.add_element RSRC_OBJECT_KEY.to_s
+
+      general = obj.add_element('general')
+
+      general.add_element('version').text = @version
+      general.add_element('is_free').text = @is_free.to_s
+      general.add_element('bundle_id').text = @bundle_id
+      general.add_element('url').text = @url
+
+      obj << @scope.scope_xml
+
+      add_self_service_xml doc
+      add_category_to_xml doc
+      add_site_to_xml doc
+      add_vpp_xml doc
+
+      doc.to_s
+
+    end
+
+  end # class MacApplication
 
-end
+end # Module JSS