ruby-jss 1.2.6 → 1.4.1

data/lib/jss/api_object/disk_encryption_configurations.rb

@@ -0,0 +1,114 @@
+module JSS
+    ### Module Constants
+    #####################################
+    
+    ### Module Variables
+    #####################################
+    
+    ### Module Methods
+    #####################################
+    
+    ### Classes
+    #####################################
+    
+    ### Disk Encryption Configuration object inside JSS
+    ###
+    ### More Detailed Description if needed
+    class DiskEncryptionConfiguration < JSS::APIObject
+        ## Mix-Ins
+        #####################################
+        include JSS::Updatable
+
+        ## Class Constants
+        #####################################
+
+        # @note Currently "Individual and Institutional" configuration type is unsupported through the API
+        KEY_TYPE = {
+            individual: 'Individual',
+            institutional: 'Institutional',
+            individual_and_institutional: 'Individual and Institutional'
+        }.freeze
+
+        # @note as of 10.13 Management Account cannot be used due to the lack of a secure token.
+        ENABLED_USERS_TYPE = {
+            management: "Management Account",
+            current: "Current or Next User"
+        }.freeze
+        
+        ### The base for REST resources of this class
+        RSRC_BASE = 'diskencryptionconfigurations'.freeze
+
+        ### the hash key used for the JSON list output of all objects in the JSS
+        RSRC_LIST_KEY = :disk_encryption_configurations
+
+        ### The hash key used for the JSON object output
+        ### It's also used in various error messages
+        RSRC_OBJECT_KEY = :disk_encryption_configuration
+
+        ## Attributes
+        #####################################
+        attr_reader :key_type
+        attr_reader :file_vault_enabled_users
+        attr_reader :institutional_recovery_key
+
+        ## Constructor
+        #####################################
+        
+        ###
+        def initialize(args = {})
+            super
+
+            if self.in_jss?
+                @key_type = @init_data[:key_type]
+                @file_vault_enabled_users = @init_data[:file_vault_enabled_users]
+                @institutional_recovery_key = @init_data[:institutional_recovery_key]
+            else
+                raise JSS::InvalidDataError, "Currently the ability to create a Disk Encryption Configuration is not possible through ruby-jss."
+            end
+
+            
+
+        end
+
+        ## Class Methods
+        #####################################
+
+        # Sets what type of account is to be enabled using the new value
+        #
+        # @author Tyler Morgan
+        #
+        # @param newvalue[Symbol] One of ENABLED_USERS_TYPE
+        #
+        # @return [Void]
+        #
+        def file_vault_enabled_users=(newvalue)
+            raise JSS::InvalidDataError, "file_vault_enabled_users must be one of :#{ENABLED_USERS_TYPE.keys.join(',:')}." unless ENABLED_USERS_TYPE.keys.include? newvalue
+
+            @file_vault_enabled_users = ENABLED_USERS_TYPE[newvalue]
+
+            @need_to_update = true
+
+        end
+
+        ## Private Instance Methods
+        #####################################
+
+        private
+
+        def rest_xml
+            raise JSS::UnsupportedError, "Key type of \"Individual and Institutional\" is currently unsupported via. API. So changes are unable to be saved." if @key_type == KEY_TYPE[:individual_and_institutional]
+            doc = REXML::Document.new
+            disk_encryption_configuration = doc.add_element 'disk_encryption_configuration'
+
+            disk_encryption_configuration.add_element('id').text = @id
+            disk_encryption_configuration.add_element('name').text = @name
+            disk_encryption_configuration.add_element('key_type').text = @key_type
+            disk_encryption_configuration.add_element('file_vault_enabled_users').text = @file_vault_enabled_users
+
+            doc.to_s
+
+
+
+        end
+    end
+end

data/lib/jss/api_object/distribution_point.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -27,7 +27,7 @@ module JSS
   # Module Methods
   #####################################
 
-  # A Distribution Point in the JSS
+  # A FileShare Distribution Point in the JSS
   #
   # As well as the normal Class and Instance methods for {APIObject} subclasses, the
   # DistributionPoint class provides more interaction with other parts of the API.
@@ -43,6 +43,11 @@ module JSS
   # and unmount it with {#unmount}. The {JSS::Package} and possibly {JSS::Script} classes use this to upload
   # items to the master.
   #
+  # NOTE: This class only deals with FileShare Distribution Points.
+  # There is no access to the Cloud Distribution Point in the classic API.
+  # See the .master_distribution_point and .my_distribution_point class methods
+  # for how they handle things when the Cloud DP is the master.
+  #
   # @see JSS::APIObject
   #
   class DistributionPoint < JSS::APIObject
@@ -80,32 +85,92 @@ module JSS
     # Class Methods
     #####################################
 
-    # Get the DistributionPoint instance for the master
-    # distribution point in the JSS. If there's only one
-    # in the JSS, return it even if not marked as master.
+    # Get the DistributionPoint instance for the master distribution point.
+    #
+    # If the Cloud Dist Point is master, then the classic API has no way to
+    # know that or access it. In that case you can provide the 'default:' parameter.
+    # Give it the name or id of any dist. point to be used instead, or give it
+    # :random to randomly choose one.
+    #
+    # If there are no fileshare dist points defined (the cloud is the only one)
+    # then this whole class can't really be used.
     #
     # @param refresh[Boolean] should the distribution point be re-queried?
     #
+    # @param default[String, Integer, Symbol] Name or ID of a dist point to use
+    #   if no master is found, or :random to randomly choose one.
+    #
     # @param api[JSS::APIConnection] which API connection should we query?
     #
     # @return [JSS::DistributionPoint]
     #
-    def self.master_distribution_point(refresh = false, api: JSS.api)
-      api.master_distribution_point refresh
+    def self.master_distribution_point(refresh = false, default: nil, api: JSS.api)
+      @master_distribution_point = nil if refresh
+      return @master_distribution_point if @master_distribution_point
+
+      all_ids(refresh, api: api).each do |dp_id|
+        dp = fetch id: dp_id, api: api
+        if dp.master?
+          @master_distribution_point = dp
+          break
+        end
+      end
+
+      # If we're here, the Cloud DP might be master, but there's no
+      # access to it in the API :/
+      raise JSS::NoSuchItemError, 'No Master FileShare Distribtion Point. Use the default: parameter if needed.' unless @master_distribution_point || default
+
+      if @master_distribution_point
+        @master_distribution_point
+      elsif default == :random
+        @master_distribution_point = fetch(id: all_ids.sample, api: api)
+      else
+        @master_distribution_point = fetch(default, api: api)
+      end
     end
 
     # Get the DistributionPoint instance for the machine running
     # this code, based on its IP address. If none is defined for this IP address,
-    # use the result of master_distribution_point
+    # use the name or id provided as default. If no default: is provided,
+    # the master dp is used. If no master dp available (meaning its the
+    # cloud dp) then use a randomly chosen dp.
     #
     # @param refresh[Boolean] should the distribution point be re-queried?
     #
+    # @param default[String, Integer, Symbol] the name or id of a Dist Point
+    #   to use if none is specified for this IP addr. Or :master, to use the
+    #   master DP, or :random to use a randomly chosen one. If :master is
+    #   specified and there is no master (master is cloud) then a random one is used.
+    #
     # @param api[JSS::APIConnection] which API connection should we query?
     #
     # @return [JSS::DistributionPoint]
     #
-    def self.my_distribution_point(refresh = false, api: JSS.api)
-      api.my_distribution_point refresh
+    def self.my_distribution_point(refresh = false, default: :master, api: JSS.api)
+      @my_distribution_point = nil if refresh
+      return @my_distribution_point if @my_distribution_point
+
+      my_net_seg_id = JSS::NetworkSegment.my_network_segment refresh, api: api
+
+      if my_net_seg_id
+        my_net_seg = JSS::NetworkSegment.fetch id: my_net_seg_id, api: api
+        my_dp_name = my_net_seg.distribution_point
+        @my_distribution_point = fetch name: my_dp_name, api: api if my_dp_name
+      end # if my_net_seg_id
+
+      return @my_distribution_point if @my_distribution_point
+
+      @my_distribution_point =
+        case default
+        when String
+          fetch name: default, api: api
+        when Integer
+          fetch id: default, api: api
+        when :master
+          master_distribution_point refresh, default: :random, api: api
+        when :random
+          fetch id: all_ids(refresh).sample, api: api
+        end
     end
 
     # Class Attributes
@@ -274,7 +339,7 @@ module JSS
       # Seemms the read-only pw isn't available in the API
 
       # if we mount for fileservice, where's the mountpoint?
-      @mountpoint = Pathname.new "/#{DEFAULT_MOUNTPOINT_DIR}/#{DEFAULT_MOUNTPOINT_PREFIX}#{@id}"
+      @mountpoint = DEFAULT_MOUNTPOINT_DIR + "#{DEFAULT_MOUNTPOINT_PREFIX}#{@id}"
     end # init
 
     # Check the validity of a password.
@@ -315,37 +380,15 @@ module JSS
     # @return [FalseClass, Symbol] false if not reachable, otherwise :http or :mountable
     #
     def reachable_for_download?(pw = '', check_http = true)
-      pw ||= ''
-      http_checked = ''
-      if check_http && http_downloads_enabled
-        if @username_password_required
-          # we don't check the pw here, because if the connection fails, we'll
-          # drop down below to try the password for mounting.
-          # we'll escape all the chars that aren't unreserved
-          # reserved_chars = Regexp.new("[^#{URI::REGEXP::PATTERN::UNRESERVED}]")
-          user_pass = "#{CGI.escape @http_username.to_s}:#{CGI.escape ro_pw.to_s}@"
-          url = @http_url.sub "://#{@ip_address}", "://#{user_pass}#{@ip_address}"
-        else
-          url = @http_url
-        end
-
-        begin
-          open(url).read
-          return :http
-        rescue
-          http_checked = 'http and '
-        end
-      end # if  check_http && http_downloads_enabled
-
+      return :http if check_http && http_reachable?(pw)
       return :mountable if mounted?
-
       return false unless check_pw :ro, pw
 
       begin
         mount pw, :ro
-        return :mountable
+        :mountable
       rescue
-        return false
+        false
       ensure
         unmount
       end
@@ -469,6 +512,23 @@ module JSS
     ######################################
     private
 
+    # can the dp be reached for http downloads?
+    def http_reachable?(pw)
+      return false unless http_downloads_enabled
+
+      url =
+        if @username_password_required
+          user_pass = "#{CGI.escape @http_username.to_s}:#{CGI.escape pw.to_s}@"
+          @http_url.sub "://#{@ip_address}", "://#{user_pass}#{@ip_address}"
+        else
+          @http_url
+        end
+      URI.parse(url).read
+      true
+    rescue
+      false
+    end
+
     # Unused - until I get around to making DP's updatable
     #
     # the XML representation of the current state of this object,

data/lib/jss/api_object/dock_item.rb

@@ -0,0 +1,137 @@
+### Copyright 2019 Rixar
+
+###
+###    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 Dock Item in the JSS.
+  # These are rather simple. They have an ID, name, path, type, and contents which is read-only
+  #
+  # @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
+    end
+        
+    
+end