ruby-jss 1.6.4 → 2.0.0b1

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

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -24,7 +24,7 @@
 ###
 
 ###
-module JSS
+module Jamf
 
   # Module Variables
   #####################################
@@ -40,12 +40,12 @@ module JSS
   # TODO: Split this into 2 classes, with lots of custom code.
   # Thanks Jamf!
   #
-  # @see JSS::APIObject
+  # @see Jamf::APIObject
   #
-  class Account < JSS::APIObject
+  class Account < Jamf::APIObject
 
     # Note: This class is not fully extended and since the resource
-    # is different than the rest, methods like JSS::Account.all do not work
+    # is different than the rest, methods like Jamf::Account.all do not work
 
     # Mix-Ins
     #####################################
@@ -77,42 +77,48 @@ module JSS
 
     # override auto-defined method
     def self.all_ids(_refresh = false, **_bunk)
-      raise '.all_ids is not valid for JSS::Account, use .all_user_ids or .all_group_ids'
+      raise '.all_ids is not valid for Jamf::Account, use .all_user_ids or .all_group_ids'
     end
 
     # override auto-defined method
     def self.all_names(_refresh = false, **_bunk)
-      raise '.all_names is not valid for JSS::Account, use .all_user_names or .all_group_names'
+      raise '.all_names is not valid for Jamf::Account, use .all_user_names or .all_group_names'
     end
 
     # @return [Array<Hash>] all JSS account users
-    def self.all_users(refresh = false, api: JSS.api)
-      all(refresh, api: api)[:users]
+    def self.all_users(refresh = false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+      all(refresh, cnx: cnx)[:users]
     end
 
     # @return [Array<Hash>] all JSS account user ids
-    def self.all_user_ids(refresh = false, api: JSS.api)
-      all(refresh, api: api)[:users].map { |i| i[:id] }
+    def self.all_user_ids(refresh = false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+      all(refresh, cnx: cnx)[:users].map { |i| i[:id] }
     end
 
     # @return [Array<Hash>] all JSS account user names
-    def self.all_user_names(refresh = false, api: JSS.api)
-      all(refresh, api: api)[:users].map { |i| i[:name] }
+    def self.all_user_names(refresh = false, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+      all(refresh, cnx: cnx)[:users].map { |i| i[:name] }
     end
 
     # @return [Array<Hash>] all JSS account groups
-    def self.all_groups(refresh = false, api: JSS.api)
-      all(refresh, api: api)[:groups]
+    def self.all_groups(refresh = false,  api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+      all(refresh, cnx: cnx)[:groups]
     end
 
     # @return [Array<Hash>] all JSS account group ids
-    def self.all_group_ids(refresh = false, api: JSS.api)
-      all(refresh, api: api)[:groups].map { |i| i[:id] }
+    def self.all_group_ids(refresh = false,  api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+      all(refresh, cnx: cnx)[:groups].map { |i| i[:id] }
     end
 
     # @return [Array<Hash>] all JSS account group names
-    def self.all_group_names(refresh = false, api: JSS.api)
-      all(refresh, api: api)[:groups].map { |i| i[:name] }
+    def self.all_group_names(refresh = false,  api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+      all(refresh, cnx: cnx)[:groups].map { |i| i[:name] }
     end
 
     # Attributes
@@ -149,15 +155,16 @@ module JSS
     # Constructor
     #####################################
 
-    # See JSS::APIObject#initialize
+    # See Jamf::APIObject#initialize
     #
-    def initialize(args = {})
-      super args
+    def initialize(**args)
+      super
 
       # check to see if a user has been specified, haven't built groups yet
       is_user = [:userid, :username].any? { |key| args.keys.include? key }
 
       return unless is_user
+
       @user_name = @init_data[:name]
       @full_name = @init_data[:full_name]
       @email = @init_data[:email]

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

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -24,7 +24,7 @@
 ###
 
 ###
-module JSS
+module Jamf
 
 
   # Module Variables
@@ -41,11 +41,11 @@ module JSS
 
   # An AdvancedComputerSearch in the JSS
   #
-  # @see JSS::AdvancedSearch
+  # @see Jamf::AdvancedSearch
   #
-  # @see JSS::APIObject
+  # @see Jamf::APIObject
   #
-  class AdvancedComputerSearch < JSS::AdvancedSearch
+  class AdvancedComputerSearch < Jamf::AdvancedSearch
 
 
     # Mix-Ins
@@ -66,7 +66,7 @@ module JSS
     RSRC_OBJECT_KEY = :advanced_computer_search
 
     # what kind of thing is returned by this search?
-    RESULT_CLASS = JSS::Computer
+    RESULT_CLASS = Jamf::Computer
 
     # what data fields come back along with the display fields
     # for each computer?

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

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -24,7 +24,7 @@
 ###
 
 ###
-module JSS
+module Jamf
 
   # Module Variables
   #####################################
@@ -37,11 +37,11 @@ module JSS
 
   # An AdvancedComputerSearch in the JSS
   #
-  # @see JSS::AdvancedSearch
+  # @see Jamf::AdvancedSearch
   #
-  # @see JSS::APIObject
+  # @see Jamf::APIObject
   #
-  class AdvancedMobileDeviceSearch < JSS::AdvancedSearch
+  class AdvancedMobileDeviceSearch < Jamf::AdvancedSearch
 
     # Mix-Ins
     #####################################
@@ -60,7 +60,7 @@ module JSS
     RSRC_OBJECT_KEY = :advanced_mobile_device_search
 
     # what kind of thing is returned by this search?
-    RESULT_CLASS = JSS::MobileDevice
+    RESULT_CLASS = Jamf::MobileDevice
 
     # what data fields come back along with the display fields
     # for each mobiledevices?

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

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -24,7 +24,7 @@
 ###
 
 ###
-module JSS
+module Jamf
 
   # Module Variables
   #####################################
@@ -37,11 +37,11 @@ module JSS
 
   # An AdvancedUserSearch in the JSS
   #
-  # @see JSS::AdvancedSearch
+  # @see Jamf::AdvancedSearch
   #
-  # @see JSS::APIObject
+  # @see Jamf::APIObject
   #
-  class AdvancedUserSearch < JSS::AdvancedSearch
+  class AdvancedUserSearch < Jamf::AdvancedSearch
 
     # Mix-Ins
     #####################################
@@ -60,7 +60,7 @@ module JSS
     RSRC_OBJECT_KEY = :advanced_user_search
 
     # what kind of thing is returned by this search?
-    RESULT_CLASS = JSS::User
+    RESULT_CLASS = Jamf::User
 
     # what data fields come back along with the display fields
     # for each user?

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

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -24,7 +24,7 @@
 ###
 
 ###
-module JSS
+module Jamf
 
   # Module Variables
   #####################################
@@ -38,14 +38,14 @@ module JSS
   # A Building in the JSS.
   # These are simple, in that they only have an ID and a name.
   #
-  # @see JSS::APIObject
+  # @see Jamf::APIObject
   #
-  class Building < JSS::APIObject
+  class Building < Jamf::APIObject
 
     # Mix-Ins
     #####################################
-    include JSS::Creatable
-    include JSS::Updatable
+    include Jamf::Creatable
+    include Jamf::Updatable
 
     # Class Methods
     #####################################

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

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -24,7 +24,7 @@
 ###
 
 ###
-module JSS
+module Jamf
 
   # Module Variables
   #####################################
@@ -103,13 +103,13 @@ module JSS
       @category_id
     end # cat id
 
-    # The JSS::Category instance for this object's category
+    # The Jamf::Category instance for this object's category
     #
-    # @return [JSS::Category] The JSS::Category instance for this object's category
+    # @return [Jamf::Category] The Jamf::Category instance for this object's category
     #
     def category_object
       return nil unless category_assigned?
-      JSS::Category.fetch id: @category_id
+      Jamf::Category.fetch id: @category_id
     end # cat obj
 
     # Does this object have a category assigned?
@@ -143,7 +143,7 @@ module JSS
       # no change, go home.
       return nil if new_name == @category_name
 
-      raise JSS::NoSuchItemError, "Category '#{new_cat}' is not known to the JSS" unless JSS::Category.all_names(:ref, api: @api).include? new_name
+      raise Jamf::NoSuchItemError, "Category '#{new_cat}' is not known to the JSS" unless Jamf::Category.all_names(:ref, cnx: @cnx).include? new_name
 
       @category_name = new_name
       @category_id = new_id
@@ -160,10 +160,10 @@ module JSS
       # if we were given anything but a string, assume it was an id.
       if new_cat.is_a? String
         new_name = new_cat
-        new_id = JSS::Category.category_id_from_name new_cat, api: @api
+        new_id = Jamf::Category.category_id_from_name new_cat, cnx: @cnx
       else
         new_id = new_cat
-        new_name = JSS::Category.map_all_ids_to(:name, api: @api)[new_id]
+        new_name = Jamf::Category.map_all_ids_to(:name, cnx: @cnx)[new_id]
       end
       [new_name, new_id]
     end
@@ -198,7 +198,7 @@ module JSS
 
       if cat.is_a? String
         @category_name = cat
-        @category_id = JSS::Category.category_id_from_name @category_name, api: @api
+        @category_id = Jamf::Category.category_id_from_name @category_name, cnx: @cnx
       else
         @category_name = cat[:name]
         @category_id = cat[:id]
@@ -227,7 +227,7 @@ module JSS
       elsif self.class::CATEGORY_DATA_TYPE == Hash
         cat_elem.add_element('name').text = @category_name.to_s
       else
-        raise JSS::InvalidDataError, "Uknown CATEGORY_DATA_TYPE for class #{self.class}"
+        raise Jamf::InvalidDataError, "Uknown CATEGORY_DATA_TYPE for class #{self.class}"
       end
 
       root = xmldoc.root

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

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -24,7 +24,7 @@
 ###
 
 ###
-module JSS
+module Jamf
 
   # Module Variables
   #####################################
@@ -38,22 +38,24 @@ module JSS
   # A Category in the JSS.
   #
   #
-  # @see JSS::APIObject
+  # @see Jamf::APIObject
   #
-  class Category < JSS::APIObject
+  class Category < Jamf::APIObject
 
     # Mix-Ins
     #####################################
-    include JSS::Creatable
-    include JSS::Updatable
+    include Jamf::Creatable
+    include Jamf::Updatable
 
     # Class Methods
     #####################################
 
-    def self.category_id_from_name(name, api: JSS.api)
+    def self.category_id_from_name(name, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
       return nil if name.nil?
-      return nil if name.casecmp(JSS::Category::NO_CATEGORY_NAME).zero?
-      JSS::Category.map_all_ids_to(:name, api: api).invert[name]
+      return nil if name.casecmp(Jamf::Category::NO_CATEGORY_NAME).zero?
+
+      Jamf::Category.map_all_ids_to(:name, cnx: cnx).invert[name]
     end # self cat id from name
 
     # Class Constants
@@ -70,8 +72,8 @@ module JSS
     RSRC_OBJECT_KEY = :category
 
     # When no category has been assigned, this is the 'name' and id used
-    NO_CATEGORY_NAME = JSS::Categorizable::NO_CATEGORY_NAME
-    NO_CATEGORY_ID = JSS::Categorizable::NO_CATEGORY_ID
+    NO_CATEGORY_NAME = Jamf::Categorizable::NO_CATEGORY_NAME
+    NO_CATEGORY_ID = Jamf::Categorizable::NO_CATEGORY_ID
 
     # The Default category
     DEFAULT_CATEGORY = NO_CATEGORY_NAME
@@ -96,9 +98,9 @@ module JSS
     # Constructor
     #####################################
 
-    # See JSS::APIObject#initialize
+    # See Jamf::APIObject#initialize
     #
-    def initialize(args = {})
+    def initialize(**args)
       super
       @priority = @init_data[:priority] || DEFAULT_PRIORITY
     end
@@ -114,7 +116,7 @@ module JSS
     #
     def priority=(new_val = @priority)
       return nil if new_val == @priority
-      raise JSS::InvalidDataError, "priority must be an integer between #{POSSIBLE_PRIORITIES.first} and #{POSSIBLE_PRIORITIES.last} (inclusive)" unless POSSIBLE_PRIORITIES.include? new_val
+      raise Jamf::InvalidDataError, "priority must be an integer between #{POSSIBLE_PRIORITIES.first} and #{POSSIBLE_PRIORITIES.last} (inclusive)" unless POSSIBLE_PRIORITIES.include? new_val
       @priority = new_val
       @need_to_update = true
     end
@@ -130,7 +132,7 @@ module JSS
     # Most classes will redefine this method.
     #
     def rest_xml
-      doc = REXML::Document.new APIConnection::XML_HEADER
+      doc = REXML::Document.new Jamf::Connection::XML_HEADER
       tmpl = doc.add_element self.class::RSRC_OBJECT_KEY.to_s
       tmpl.add_element('name').text = @name
       tmpl.add_element('priority').text = @priority