ruby-jss 1.6.4 → 2.0.0b1

data/lib/{jss/api_object → jamf/api/classic/api_objects}/directory_binding_type/centrify.rb

@@ -23,7 +23,7 @@
 ###
 ###
 
-module JSS
+module Jamf
 
     # Module for containing the different types of DirectoryBindings stored within the JSS
     
@@ -72,8 +72,8 @@ module JSS
             # An initializer for the Centrify object.
             # 
             # @author Tyler Morgan
-            # @see JSS::DirectoryBinding
-            # @see JSS::DirectoryBindingType
+            # @see Jamf::DirectoryBinding
+            # @see Jamf::DirectoryBindingType
             #
             # @param [Hash] initialize data
             def initialize(init_data)
@@ -101,12 +101,12 @@ module JSS
             #
             # @param newvalue [Bool]
             #
-            # @raise [JSS::InvalidDataError] If the new value doesn't match a Bool value
+            # @raise [Jamf::InvalidDataError] If the new value doesn't match a Bool value
             #
             # @return [void]
             def workstation_mode=(newvalue)
 
-                raise JSS::InvalidDataError, "workstation_mode must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
+                raise Jamf::InvalidDataError, "workstation_mode must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
 
                 @workstation_mode = newvalue
 
@@ -120,12 +120,12 @@ module JSS
             #
             # @param newvalue [Bool]
             #
-            # @raise [JSS::InvalidDataError] If the new value doesn't match a Bool value
+            # @raise [Jamf::InvalidDataError] If the new value doesn't match a Bool value
             #
             # @return [void]
             def overwrite_existing=(newvalue)
 
-                raise JSS::InvalidDataError, "overwrite_existing must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
+                raise Jamf::InvalidDataError, "overwrite_existing must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
 
                 @overwrite_existing = newvalue
 
@@ -139,12 +139,12 @@ module JSS
             #
             # @param newvalue [Bool]
             #
-            # @raise [JSS::InvalidDataError] If the new value doesn't match a Bool value
+            # @raise [Jamf::InvalidDataError] If the new value doesn't match a Bool value
             #
             # @return [void]
             def update_PAM=(newvalue)
 
-                raise JSS::InvalidDataError, "update_PAM must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
+                raise Jamf::InvalidDataError, "update_PAM must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
 
                 @update_PAM = newvalue
 
@@ -158,17 +158,17 @@ module JSS
             #
             # @param newvalue [String] the new zone the computer is to be joined to
             #
-            # @raise [JSS::InvalidDataError] If the new value is not a string.
+            # @raise [Jamf::InvalidDataError] If the new value is not a string.
             #
             # @return [void]
             def zone=(newvalue)
 
                 new =
                     if newvalue.to_s.empty?
-                        JSS::BLANK
+                        Jamf::BLANK
                     else
                         # Data Check
-                        raise JSS::InvalidDataError, "zone must be a string." unless newvalue.is_a? String
+                        raise Jamf::InvalidDataError, "zone must be a string." unless newvalue.is_a? String
                         newvalue
                     end
 
@@ -184,17 +184,17 @@ module JSS
             #
             # @param newvalue [String] The domain server that would be prioritized.
             #
-            # @raise [JSS::InvalidDataError] If the new value is not a string.
+            # @raise [Jamf::InvalidDataError] If the new value is not a string.
             #
             # @return [void]
             def preferred_domain_server=(newvalue)
 
                 new =
                     if newvalue.to_s.empty?
-                        JSS::BLANK
+                        Jamf::BLANK
                     else
                         # Data Check
-                        raise JSS::InvalidDataError, "preferred_domain_server must be a string." unless newvalue.is_a? String
+                        raise Jamf::InvalidDataError, "preferred_domain_server must be a string." unless newvalue.is_a? String
                         newvalue
                     end
 

data/lib/{jss/api_object → jamf/api/classic/api_objects/directory_binding_type}/directory_binding_type.rb

@@ -23,25 +23,11 @@
 ###
 ###
 
-module JSS
+module Jamf
 
   # Module for containing the different types of DirectoryBindings stored within the JSS
   module DirectoryBindingType
 
-    # Module Variables
-    #####################################
-
-    # Module Methods
-    #####################################
-    def should_update
-      @need_to_update = true
-    end
-
-    def set_type_settings(settings)
-      @type_settings = settings
-      @type_settings.container = self
-    end
-
     # Classes
     #####################################
 
@@ -51,7 +37,6 @@ module JSS
     # @author Tyler Morgan
     class DirectoryBindingType
 
-
       # Mix-Ins
       #####################################
 
@@ -81,16 +66,8 @@ module JSS
       # This is used to properly handle updating the containing object.
       attr_accessor :container
 
+    end
 
   end
 
-
-    end
-
 end
-
-require 'jss/api_object/directory_binding_type/active_directory'
-require 'jss/api_object/directory_binding_type/open_directory'
-require 'jss/api_object/directory_binding_type/admitmac'
-require 'jss/api_object/directory_binding_type/centrify'
-require 'jss/api_object/directory_binding_type/powerbroker_identity_services'

data/lib/{jss/api_object → jamf/api/classic/api_objects}/directory_binding_type/open_directory.rb

@@ -23,10 +23,10 @@
 ###
 ###
 
-module JSS
+module Jamf
 
     # Module for containing the different types of DirectoryBindings stored within the JSS
-    
+
     module DirectoryBindingType
 
         # Module Variables
@@ -39,7 +39,7 @@ module JSS
         #####################################
 
         # Class for the specific OpenDirectory DirectoryBinding type stored within the JSS
-        # 
+        #
         # @author Tyler Morgan
         #
         # Attributes
@@ -77,24 +77,24 @@ module JSS
                 @use_for_contacts = init_data[:use_for_contacts]
             end
 
-                
+
 
             # Public Instance Methods
             #####################################
 
             # Encrypt the connection using SSL
-            # 
+            #
             # @author Tyler Morgan
             #
             # @param newvalue [Bool]
             #
-            # @raise [JSS::InvalidDataError] If the new value doesn't match a Bool value
+            # @raise [Jamf::InvalidDataError] If the new value doesn't match a Bool value
             #
             # @return [void]
             def encrypt_using_ssl=(newvalue)
 
-                raise JSS::InvalidDataError, "encrypt_using_ssl must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
-                
+                raise Jamf::InvalidDataError, "encrypt_using_ssl must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
+
                 @encrypt_using_ssl = newvalue
 
                 self.container&.should_update
@@ -102,17 +102,17 @@ module JSS
 
 
             # Attempt to perform a secure bind to the domain server
-            # 
+            #
             # @author Tyler Morgan
             #
             # @param newvalue [Bool]
             #
-            # @raise [JSS::InvalidDataError] If the new value doesn't match a Bool value
+            # @raise [Jamf::InvalidDataError] If the new value doesn't match a Bool value
             #
             # @return [void]
             def perform_secure_bind=(newvalue)
 
-                raise JSS::InvalidDataError, "perform_secure_bind must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
+                raise Jamf::InvalidDataError, "perform_secure_bind must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
 
                 @perform_secure_bind = newvalue
 
@@ -121,17 +121,17 @@ module JSS
 
 
             # Use this binding for authentication
-            # 
+            #
             # @author Tyler Morgan
             #
             # @param newvalue [Bool]
             #
-            # @raise [JSS::InvalidDataError] If the new value doesn't match a Bool value
+            # @raise [Jamf::InvalidDataError] If the new value doesn't match a Bool value
             #
             # @return [void]
             def use_for_authentication=(newvalue)
 
-                raise JSS::InvalidDataError, "use_for_authentication must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
+                raise Jamf::InvalidDataError, "use_for_authentication must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
 
                 @use_for_authentication = newvalue
 
@@ -140,17 +140,17 @@ module JSS
 
 
             # Use this binding for contact population
-            # 
+            #
             # @author Tyler Morgan
             #
             # @param newvalue [Bool]
             #
-            # @raise [JSS::InvalidDataError] If the new value doesn't match a Bool value
+            # @raise [Jamf::InvalidDataError] If the new value doesn't match a Bool value
             #
             # @return [void]
             def use_for_contacts=(newvalue)
 
-                raise JSS::InvalidDataError, "use_for_contacts must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
+                raise Jamf::InvalidDataError, "use_for_contacts must be true or false." unless newvalue.is_a?(TrueClass) || newvalue.is_a(FalseClass)
 
                 @use_for_contacts = newvalue
 
@@ -160,7 +160,7 @@ module JSS
 
             # Return a REXML Element containing the current state of the DirectoryBindingType
             # object for adding into the XML of the container.
-            # 
+            #
             # @author Tyler Morgan
             #
             # @return [REXML::Element]
@@ -175,4 +175,4 @@ module JSS
             end
         end
     end
-end
+end

data/lib/{jss/api_object → jamf/api/classic/api_objects}/directory_binding_type/powerbroker_identity_services.rb

@@ -23,7 +23,7 @@
 ###
 ###
 
-module JSS
+module Jamf
 
     # Module for containing the different types of DirectoryBindings stored within the JSS
     

data/lib/jamf/api/classic/api_objects/directory_binding_type.rb

@@ -0,0 +1,47 @@
+### 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 Jamf
+
+  # Module for containing the different types of DirectoryBindings stored within the JSS
+  module DirectoryBindingType
+
+    # Module Variables
+    #####################################
+
+    # Module Methods
+    #####################################
+    def should_update
+      @need_to_update = true
+    end
+
+    def set_type_settings(settings)
+      @type_settings = settings
+      @type_settings.container = self
+    end
+
+  end
+
+end

data/lib/{jss/api_object/disk_encryption_configurations.rb → jamf/api/classic/api_objects/disk_encryption_configuration.rb}

@@ -1,23 +1,23 @@
-module JSS
+module Jamf
     ### Module Constants
     #####################################
-    
+
     ### Module Variables
     #####################################
-    
+
     ### Module Methods
     #####################################
-    
+
     ### Classes
     #####################################
-    
+
     ### Disk Encryption Configuration object inside JSS
     ###
     ### More Detailed Description if needed
-    class DiskEncryptionConfiguration < JSS::APIObject
+    class DiskEncryptionConfiguration < Jamf::APIObject
         ## Mix-Ins
         #####################################
-        include JSS::Updatable
+        include Jamf::Updatable
 
         ## Class Constants
         #####################################
@@ -34,7 +34,7 @@ module JSS
             management: "Management Account",
             current: "Current or Next User"
         }.freeze
-        
+
         ### The base for REST resources of this class
         RSRC_BASE = 'diskencryptionconfigurations'.freeze
 
@@ -53,9 +53,9 @@ module JSS
 
         ## Constructor
         #####################################
-        
+
         ###
-        def initialize(args = {})
+        def initialize(**args)
             super
 
             if self.in_jss?
@@ -63,10 +63,10 @@ module JSS
                 @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."
+                raise Jamf::InvalidDataError, "Currently the ability to create a Disk Encryption Configuration is not possible through ruby-jss."
             end
 
-            
+
 
         end
 
@@ -82,7 +82,7 @@ module JSS
         # @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
+            raise Jamf::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]
 
@@ -96,7 +96,7 @@ module JSS
         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]
+            raise Jamf::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'
 

data/lib/{jss/api_object → jamf/api/classic/api_objects}/distribution_point.rb

@@ -1,4 +1,4 @@
-# Copyright 2020 Pixar
+# Copyright 2022 Pixar
 
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -22,7 +22,7 @@
 #
 #
 
-module JSS
+module Jamf
 
   # Module Methods
   #####################################
@@ -34,13 +34,13 @@ module JSS
   #
   # Beyond the standard listing methods DistributionPoint.all, .all_ids, etc, every JSS
   # has a single "master" distribution point.  The Class method {DistributionPoint.master_distribution_point} will
-  # return the JSS::DistributionPoint object for that master.
+  # return the Jamf::DistributionPoint object for that master.
   #
   # Also, some network segments have specific DistributionPoints assigned to them. Calling the Class method
-  # {DistributionPoint.my_distribution_point} will return a JSS::DistributionPoint object for your local IP address.
+  # {DistributionPoint.my_distribution_point} will return a Jamf::DistributionPoint object for your local IP address.
   #
-  # Once you have an instance of JSS::DistributionPoint, you can mount it (on a Mac) by calling its {#mount} method
-  # and unmount it with {#unmount}. The {JSS::Package} and possibly {JSS::Script} classes use this to upload
+  # Once you have an instance of Jamf::DistributionPoint, you can mount it (on a Mac) by calling its {#mount} method
+  # and unmount it with {#unmount}. The {Jamf::Package} and possibly {Jamf::Script} classes use this to upload
   # items to the master.
   #
   # NOTE: This class only deals with FileShare Distribution Points.
@@ -48,9 +48,9 @@ module JSS
   # 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
+  # @see Jamf::APIObject
   #
-  class DistributionPoint < JSS::APIObject
+  class DistributionPoint < Jamf::APIObject
 
     # Class Constants
     #####################################
@@ -100,16 +100,18 @@ module JSS
     # @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?
+    # @param cnx [Jamf::Connection] which API connection should we query?
     #
-    # @return [JSS::DistributionPoint]
+    # @return [Jamf::DistributionPoint]
     #
-    def self.master_distribution_point(refresh = false, default: nil, api: JSS.api)
+    def self.master_distribution_point(refresh = false, default: nil, api: nil, cnx: Jamf.cnx)
+      cnx = api if 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
+      all_ids(refresh, cnx: cnx).each do |dp_id|
+        dp = fetch id: dp_id, cnx: cnx
         if dp.master?
           @master_distribution_point = dp
           break
@@ -118,14 +120,14 @@ module JSS
 
       # 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
+      raise Jamf::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)
+        @master_distribution_point = fetch(id: all_ids.sample, cnx: cnx)
       else
-        @master_distribution_point = fetch(default, api: api)
+        @master_distribution_point = fetch(default, cnx: cnx)
       end
     end
 
@@ -142,20 +144,22 @@ module JSS
     #   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?
+    # @param cnx [Jamf::Connection] which API connection should we query?
     #
-    # @return [JSS::DistributionPoint]
+    # @return [Jamf::DistributionPoint]
     #
-    def self.my_distribution_point(refresh = false, default: :master, api: JSS.api)
+    def self.my_distribution_point(refresh = false, default: :master, api: nil, cnx: Jamf.cnx)
+      cnx = api if 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
+      my_net_seg_id = Jamf::NetworkSegment.my_network_segment refresh, cnx: cnx
 
       if my_net_seg_id
-        my_net_seg = JSS::NetworkSegment.fetch id: my_net_seg_id, api: api
+        my_net_seg = Jamf::NetworkSegment.fetch id: my_net_seg_id, cnx: cnx
         my_dp_name = my_net_seg.distribution_point
-        @my_distribution_point = fetch name: my_dp_name, api: api if my_dp_name
+        @my_distribution_point = fetch name: my_dp_name, cnx: cnx if my_dp_name
       end # if my_net_seg_id
 
       return @my_distribution_point if @my_distribution_point
@@ -163,13 +167,13 @@ module JSS
       @my_distribution_point =
         case default
         when String
-          fetch name: default, api: api
+          fetch name: default, cnx: cnx
         when Integer
-          fetch id: default, api: api
+          fetch id: default, cnx: cnx
         when :master
-          master_distribution_point refresh, default: :random, api: api
+          master_distribution_point refresh, default: :random, cnx: cnx
         when :random
-          fetch id: all_ids(refresh).sample, api: api
+          fetch id: all_ids(refresh).sample, cnx: cnx
         end
     end
 
@@ -270,18 +274,20 @@ module JSS
     #
     # You can also do this more easily by calling JSS.master_distribution_point
     #
-    def initialize(args = {})
+    def initialize(**args)
       # TODO: this looks redundant with super....
-      args[:api] ||= JSS.api
-      @api = args[:api]
+      args[:cnx] ||= args[:api]
+      args[:cnx] ||= Jamf.cnx
+
+      @cnx = args[:cnx]
 
       @init_data = nil
 
       # looking for master?
       if args[:id] == :master
 
-        self.class.all_ids(api: @api).each do |id|
-          @init_data = @api.get_rsrc("#{RSRC_BASE}/id/#{id}")[RSRC_OBJECT_KEY]
+        self.class.all_ids(cnx: @cnx).each do |id|
+          @init_data = @cnx.c_get("#{RSRC_BASE}/id/#{id}")[RSRC_OBJECT_KEY]
           if @init_data[:is_master]
             @id = @init_data[:id]
             @name = @init_data[:name]
@@ -352,7 +358,7 @@ module JSS
     #   nil is returned if there is no password set in the JSS.
     #
     def check_pw(user, pw)
-      raise JSS::InvalidDataError, 'The first parameter must be one of :ro, :rw, :ssh, :http' unless %i[ro rw ssh http].include? user
+      raise Jamf::InvalidDataError, 'The first parameter must be one of :ro, :rw, :ssh, :http' unless %i[ro rw ssh http].include? user
 
       sha256 = case user
                when :rw then @read_write_password_sha256
@@ -448,7 +454,7 @@ module JSS
       pwok = check_pw(access, password)
       unless pwok
         msg = pwok.nil? ? "No #{access} password set in the JSS" : "Incorrect password for #{access} account"
-        raise JSS::InvalidDataError, msg
+        raise Jamf::InvalidDataError, msg
       end
 
       username = access == :ro ? @read_only_username : @read_write_username
@@ -471,7 +477,7 @@ module JSS
       else
         @mountpoint.rmdir if @mountpoint.directory?
         @mounted = nil
-        raise JSS::FileServiceError, "Can't mount #{@ip_address}: #{mount_out}"
+        raise Jamf::FileServiceError, "Can't mount #{@ip_address}: #{mount_out}"
       end
       @mountpoint
     end # mount
@@ -490,7 +496,7 @@ module JSS
         @mountpoint.rmdir if @mountpoint.directory? && !@mountpoint.mountpoint?
         @mounted = false
       else
-        raise JSS::FileServiceError, "There was a problem unmounting #{@mountpoint}"
+        raise Jamf::FileServiceError, "There was a problem unmounting #{@mountpoint}"
       end
       nil
     end # unmount