ruby-jss 1.6.4 → 2.0.0a10

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

@@ -23,7 +23,7 @@
 ###
 ###
 
-module JSS
+module Jamf
 
 
   # Module Variables
@@ -38,15 +38,15 @@ module JSS
   # 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
+  # @see Jamf::APIObject
   #
-  class DockItem < JSS::APIObject
+  class DockItem < Jamf::APIObject
 
 
     # Mix-Ins
     #####################################
-    include JSS::Creatable
-    include JSS::Updatable
+    include Jamf::Creatable
+    include Jamf::Updatable
 
     # Class Methods
     #####################################
@@ -84,10 +84,10 @@ module JSS
     attr_reader :path
 
     # Constructor
-    # @see JSS::APIObject.initialize
+    # @see Jamf::APIObject.initialize
     #####################################
-    def initialize(args = {})
-      super args
+    def initialize(**args)
+      super
 
       @type = 'App' if @init_data[:type].nil?
       @type = @init_data[:type]
@@ -104,8 +104,8 @@ module JSS
     # @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
+      raise Jamf::InvalidDataError, 'Type must be a string' unless newval.is_a? String
+      raise Jamf::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
@@ -115,7 +115,7 @@ module JSS
     #
     # @param newval[String] the new app path
     def path=(newval)
-      raise JSS::InvalidDataError, 'Path must be a String' unless newval.is_a? String
+      raise Jamf::InvalidDataError, 'Path must be a String' unless newval.is_a? String
 
       @path = newval
       @need_to_update = true
@@ -128,7 +128,7 @@ module JSS
     # the xml formated data for adding or updating this in the JSS
     #
     def rest_xml
-      doc = REXML::Document.new APIConnection::XML_HEADER
+      doc = REXML::Document.new Jamf::Connection::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

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

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -25,10 +25,10 @@
 
 
 #
-module JSS
+module Jamf
 
   # This is just a stub for now.
-  class EBook < APIObject
+  class Ebook < APIObject
 
     include Sitable
 

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

@@ -1,4 +1,4 @@
-# Copyright 2020 Pixar
+# Copyright 2022 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -23,7 +23,7 @@
 #
 #
 
-module JSS
+module Jamf
 
   # Sub-Modules
   ###################################
@@ -31,13 +31,13 @@ module JSS
   # A mix-in module for handling extension attribute data for objects in the JSS.
   #
   # This module provides standardized ways to deal with Extension Attribute data
-  # in objects that gather that data  ({JSS::Computer}s, {JSS::MobileDevice}s,
-  # and {JSS::User}s). For working with the Extension Attributes themselves, see
-  # {JSS::ExtensionAttribute} and its subclasses.
+  # in objects that gather that data  ({Jamf::Computer}s, {Jamf::MobileDevice}s,
+  # and {Jamf::User}s). For working with the Extension Attributes themselves, see
+  # {Jamf::ExtensionAttribute} and its subclasses.
   #
   # API objects that have Extension Attribute data return it in an Array of Hashes,
   # one for each defined ExtensionAttribute for the class;
-  # i.e. a {JSS::Computer}'s Array has one Hash for each {JSS::ComputerExtensionAttribute}
+  # i.e. a {Jamf::Computer}'s Array has one Hash for each {Jamf::ComputerExtensionAttribute}
   # defined in the JSS.
   #
   # The Hash keys are:
@@ -47,9 +47,9 @@ module JSS
   # * :value => the value for the ExtAttr for this object as of the last report.
   #
   # Classes including this module must define the constant EXT_ATTRIB_CLASS
-  # specifying which {JSS::ExtensionAttribute} subclass defines the relevant extension attributes.
-  # For Example, {JSS::Computer} sets this:
-  #   EXT_ATTRIB_CLASS = JSS::ComputerExtensionAttribute
+  # specifying which {Jamf::ExtensionAttribute} subclass defines the relevant extension attributes.
+  # For Example, {Jamf::Computer} sets this:
+  #   EXT_ATTRIB_CLASS = Jamf::ComputerExtensionAttribute
   #
   #
   # Parsing also populates @ext_attrs which is a Hash of name => value for each EA.
@@ -120,12 +120,12 @@ module JSS
 
           when 'Date'
             begin # if there's random non-date data, the parse will fail
-              JSS.parse_datetime ea[:value]
+              Jamf.parse_time ea[:value]
             rescue
               INVALID_DATE
             end
 
-          when *JSS::ExtensionAttribute::NUMERIC_TYPES
+          when *Jamf::ExtensionAttribute::NUMERIC_TYPES
             ea[:value].to_i unless ea[:value].to_s.empty?
 
           else # String
@@ -187,7 +187,7 @@ module JSS
       # update this ea hash in the @extension_attributes array
       ea_hash = @extension_attributes.find { |ea| ea[:name] == ea_name }
 
-      raise JSS::NoSuchItemError, "#{self.class} '#{name}'(id #{id}) does not know about ExtAttr '#{ea_name}'. Please re-fetch and try again." unless ea_hash
+      raise Jamf::NoSuchItemError, "#{self.class} '#{name}'(id #{id}) does not know about ExtAttr '#{ea_name}'. Please re-fetch and try again." unless ea_hash
 
       ea_hash[:value] = value
 
@@ -260,13 +260,13 @@ module JSS
     # @return [Object] the possibly modified valid value
     #
     def validate_ea_value(ea_name, value, validate_popup_choice, refresh)
-      return JSS::BLANK if value.to_s == JSS::BLANK
+      return Jamf::BLANK if value.to_s == Jamf::BLANK
 
       value =
         case ea_types[ea_name]
-        when JSS::ExtensionAttribute::DATA_TYPE_DATE
-          JSS.parse_datetime(value).to_s
-        when *JSS::ExtensionAttribute::NUMERIC_TYPES
+        when Jamf::ExtensionAttribute::DATA_TYPE_DATE
+          Jamf.parse_time(value).to_s
+        when *Jamf::ExtensionAttribute::NUMERIC_TYPES
           validate_integer_ea_value ea_name, value
         else
           value.to_s
@@ -284,7 +284,7 @@ module JSS
       elsif value.to_s.jss_integer?
         value.to_s.to_i
       else
-        raise JSS::InvalidDataError, "The value for #{ea_name} must be an integer"
+        raise Jamf::InvalidDataError, "The value for #{ea_name} must be an integer"
       end # if
     end
 
@@ -293,18 +293,18 @@ module JSS
     #
     def validate_popup_value(ea_name, value, refresh)
       # get the ea def. instance from the api cache, or the api
-      api.ext_attr_definition_cache[self.class] ||= {}
-      api.ext_attr_definition_cache[self.class][ea_name] = nil if refresh
-      api.ext_attr_definition_cache[self.class][ea_name] ||= self.class::EXT_ATTRIB_CLASS.fetch name: ea_name, api: api
+      cnx.c_ext_attr_definition_cache[self.class] ||= {}
+      cnx.c_ext_attr_definition_cache[self.class][ea_name] = nil if refresh
+      cnx.c_ext_attr_definition_cache[self.class][ea_name] ||= self.class::EXT_ATTRIB_CLASS.fetch name: ea_name, cnx: cnx
 
-      ea_def = api.ext_attr_definition_cache[self.class][ea_name]
+      ea_def = cnx.c_ext_attr_definition_cache[self.class][ea_name]
       return unless ea_def.from_popup_menu?
 
       return if ea_def.popup_choices.include? value.to_s
 
-      raise JSS::UnsupportedError, "The value for #{ea_name} must be one of: '#{ea_def.popup_choices.join("' '")}'"
+      raise Jamf::UnsupportedError, "The value for #{ea_name} must be one of: '#{ea_def.popup_choices.join("' '")}'"
     end
 
   end # module extendable
 
-end # module JSS
+end # module Jamf

data/lib/{jss/api_object → jamf/api/classic/api_objects}/ibeacon.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
   #####################################
@@ -36,14 +36,14 @@ module JSS
   #####################################
 
   # An iBeacon in the JSS.
-  # @see JSS::APIObject
+  # @see Jamf::APIObject
   #
-  class IBeacon < JSS::APIObject
+  class IBeacon < Jamf::APIObject
 
     # Mix-Ins
     #####################################
-    include JSS::Creatable
-    include JSS::Updatable
+    include Jamf::Creatable
+    include Jamf::Updatable
 
     # Class Methods
     #####################################
@@ -87,10 +87,10 @@ module JSS
     attr_reader :minor
 
     # Constructor
-    # @see JSS::APIObject.initialize
+    # @see Jamf::APIObject.initialize
     #####################################
-    def initialize(args = {})
-      super args
+    def initialize(**args)
+      super
 
       @uuid = @init_data[:uuid]
       @major = @init_data[:major]
@@ -112,7 +112,7 @@ module JSS
     # @return [void]
     #
     def uuid=(newval)
-      JSS::Validate.uuid newval
+      Jamf::Validate.uuid newval
       @uuid = newval
       @need_to_update = true
     end
@@ -128,7 +128,7 @@ module JSS
       if newval.nil? || newval == MAJOR_MINOR_UNUSED
         newval ||= MAJOR_MINOR_UNUSED
       else
-        JSS::Validate.ibeacon_major_minor newval
+        Jamf::Validate.ibeacon_major_minor newval
       end
       @major = newval
       @need_to_update = true
@@ -145,7 +145,7 @@ module JSS
       if newval.nil? || newval == MAJOR_MINOR_UNUSED
         newval ||= MAJOR_MINOR_UNUSED
       else
-        JSS::Validate.ibeacon_major_minor newval
+        Jamf::Validate.ibeacon_major_minor newval
       end
 
       @minor = newval
@@ -164,14 +164,14 @@ module JSS
 
     # @see Creatable.create
     def create
-      raise JSS::MissingDataError, 'uuid may not be empty' if @uuid.to_s.empty?
+      raise Jamf::MissingDataError, 'uuid may not be empty' if @uuid.to_s.empty?
 
       super
     end
 
     # @see Updatable.update
     def update
-      raise JSS::MissingDataError, 'uuid may not be empty' if @uuid.to_s.empty?
+      raise Jamf::MissingDataError, 'uuid may not be empty' if @uuid.to_s.empty?
 
       super
     end
@@ -183,7 +183,7 @@ module JSS
     # the xml formated data for adding or updating this in the JSS
     #
     def rest_xml
-      doc = REXML::Document.new APIConnection::XML_HEADER
+      doc = REXML::Document.new Jamf::Connection::XML_HEADER
       ns = doc.add_element RSRC_OBJECT_KEY.to_s
       ns.add_element('name').text = @name
       ns.add_element('uuid').text = @uuid

data/lib/{jss/api_object/self_servable → jamf/api/classic/api_objects}/icon.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
 
     # An Icon in the JSS, used in Self Service.
     #
@@ -43,8 +43,8 @@ module JSS
     # see {SelfServable#icon=}.
     #
     # NOTE: Since icons are not APIObjects, there's no way to see a list of them
-    # via the API. The JSS::Icon class methods .all, .all_ids, and .all_names
-    # require MySQL database access. See {JSS::DBConnection}.
+    # via the API. The Jamf::Icon class methods .all, .all_ids, and .all_names
+    # require MySQL database access. See {Jamf::DBConnection}.
     #
     # This also means, if you use multiple API connections, you'll have to
     # make sure to connect to the correct MySQL server for the
@@ -69,7 +69,7 @@ module JSS
         return @all_icons if @all_icons
         @all_icons = []
         qry = 'SELECT icon_id, filename FROM icons'
-        res = JSS::DB_CNX.db.query qry
+        res = Jamf::DB_CNX.db.query qry
         res.each_hash { |icon| @all_icons << { id: icon['icon_id'].to_i, name: icon['filename'] } }
         @all_icons
       end
@@ -118,12 +118,12 @@ module JSS
       #  Constructor
       #####################################
 
-      # Set up a new JSS::Icon instance
+      # Set up a new Jamf::Icon instance
       #
       # @param icon_data[Hash] The :self_service_icon Hash from the :self_service
       #   Hash of an object's API @init_data
       #
-      # @return [JSS::Icon] The new object
+      # @return [Jamf::Icon] The new object
       #
       def initialize(icon_data)
         return unless icon_data.is_a? Hash
@@ -178,7 +178,7 @@ module JSS
         path = Pathname.new path
         path = path + @name if path.directory? && @name
 
-        raise JSS::AlreadyExistsError, "The file #{path} already exists" if path.exist? unless overwrite
+        raise Jamf::AlreadyExistsError, "The file #{path} already exists" if path.exist? unless overwrite
         path.delete if path.exist?
         path.jss_save @data
       end

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

@@ -1,4 +1,4 @@
-# Copyright 2020 Pixar
+# Copyright 2022 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -23,7 +23,7 @@
 #
 #
 
-module JSS
+module Jamf
 
   # Classes
   #####################################
@@ -36,16 +36,16 @@ module JSS
   # However, it does provide methods for querying users and usergroups from
   # LDAP servers, and checking group membership.
   #
-  # The class methods {LDAPServer.user_in_ldap?} and {LDAPServer.group_in_ldap?} can be
+  # The class methods {LdapServer.user_in_ldap?} and {LdapServer.group_in_ldap?} can be
   # used to check all defined LDAP servers for a user or group. They are used by
-  # {JSS::Scopable::Scope} when adding user and groups to scope limitations and exceptions.
+  # {Jamf::Scopable::Scope} when adding user and groups to scope limitations and exceptions.
   #
-  # Within an LDAPServer instance, the methods {#find_user} and {#find_group} will return
+  # Within an LdapServer instance, the methods {#find_user} and {#find_group} will return
   # all matches in the server for a given search term.
   #
-  # @see JSS::APIObject
+  # @see Jamf::APIObject
   #
-  class LDAPServer < JSS::APIObject
+  class LdapServer < Jamf::APIObject
 
     # Constants
     #####################################
@@ -87,13 +87,15 @@ module JSS
     #
     # @param user[String] a username to search for in all LDAP servers
     #
-    # @param api[JSS::APIConnection] the API connection to use for the search#
+    # @param cnx [Jamf::Connection] the API connection to use for the search#
 
     # @return [Integer, nil] the id of the first LDAP server with the user,
     #  nil if not found
     #
-    def self.server_for_user(user, api: JSS.api)
-      all_objects(:refresh, api: api).each do |ldap|
+    def self.server_for_user(user, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
+      all_objects(:refresh, cnx: cnx).each do |ldap|
         next if ldap.find_user(user, :exact).empty?
         return ldap.id
       end
@@ -104,25 +106,29 @@ module JSS
     #
     # @param user[String] a username to search for in all LDAP servers
     #
-    # @param api[JSS::APIConnection] the API connection to use for the search
+    # @param cnx [Jamf::Connection] the API connection to use for the search
     #
     # @return [Boolean] Does the user exist in any LDAP server?
     #
-    def self.user_in_ldap?(user, api: JSS.api)
-      server_for_user(user, api: api) ? true : false
+    def self.user_in_ldap?(user, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
+      server_for_user(user, cnx: cnx) ? true : false
     end
 
     # Does a group exist in any ldap server?
     #
     # @param group[String] a group to search for in all LDAP servers
     #
-    # @param api[JSS::APIConnection] the API connection to use for the search
+    # @param cnx [Jamf::Connection] the API connection to use for the search
     #
     # @return [Integer, nil] the id of the first LDAP server with the group,
     #  nil if not found
     #
-    def self.server_for_group(group, api: JSS.api)
-      all_objects(:refresh, api: api).each do |ldap|
+    def self.server_for_group(group, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
+      all_objects(:refresh, cnx: cnx).each do |ldap|
         next if ldap.find_group(group, :exact).empty?
         return ldap.id
       end
@@ -133,18 +139,20 @@ module JSS
     #
     # @param user[String] a group name to search for in all LDAP servers
     #
-    # @param api[JSS::APIConnection] the API connection to use for the search
+    # @param cnx [Jamf::Connection] the API connection to use for the search
     #
     # @return [Boolean] Does the group exist in any LDAP server?
     #
-    def self.group_in_ldap?(group, api: JSS.api)
-      server_for_group(group, api: api) ? true : false
+    def self.group_in_ldap?(group, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
+      server_for_group(group, cnx: cnx) ? true : false
     end
 
     # On a given server, does a given group contain a given user?
     #
     # This class method allows the check to happen without instanting
-    # the LDAPServer.
+    # the LdapServer.
     #
     # @param server[String, Integer] The name or id of the LDAP server to use
     #
@@ -152,17 +160,20 @@ module JSS
     #
     # @param group[String] the group name to see if the user is a member
     #
-    # @param api[JSS::APIConnection] the API connection to use for the search
+    # @param cnx [Jamf::Connection] the API connection to use for the search
     #
     # @return [Boolean] is the user a member of the group?
     #
-    def self.check_membership(ldap_server, user, group, api: JSS.api)
+    def self.check_membership(ldap_server, user, group, api: nil, cnx: Jamf.cnx)
+      cnx = api if api
+
       ldap_server_id = valid_id ldap_server
-      raise JSS::NoSuchItemError, "No LDAPServer matching #{ldap_server}" unless ldap_server_id
+      raise Jamf::NoSuchItemError, "No LdapServer matching #{ldap_server}" unless ldap_server_id
+
       rsrc = "#{RSRC_BASE}/id/#{ldap_server_id}/group/#{CGI.escape group.to_s}/user/#{CGI.escape user.to_s}"
-      member_check = api.get_rsrc rsrc
-      return false if member_check[:ldap_users].empty?
-      true
+      member_check = cnx.c_get rsrc
+
+      !member_check[:ldap_users].empty?
     end
 
     # Attributes
@@ -264,9 +275,9 @@ module JSS
     #####################################
 
     #
-    # See JSS::APIObject#initialize
+    # See Jamf::APIObject#initialize
     #
-    def initialize(args = {})
+    def initialize(**args)
       super
 
       @hostname = @init_data[:connection][:hostname]
@@ -301,8 +312,8 @@ module JSS
     # @return [Array<Hash>] The mapped LDAP data for all usernames matching the query
     #
     def find_user(user, exact = false)
-      raise JSS::NoSuchItemError, 'LDAPServer not yet saved in the JSS' unless @in_jss
-      raw = api.get_rsrc("#{RSRC_BASE}/id/#{@id}/user/#{CGI.escape user.to_s}")[:ldap_users]
+      raise Jamf::NoSuchItemError, 'LdapServer not yet saved in the JSS' unless @in_jss
+      raw = cnx.c_get("#{RSRC_BASE}/id/#{@id}/user/#{CGI.escape user.to_s}")[:ldap_users]
       exact ? raw.select { |u| u[:username] == user } : raw
     end
 
@@ -313,8 +324,8 @@ module JSS
     # @return [Array<Hash>] The groupname and uid for all groups matching the query
     #
     def find_group(group, exact = false)
-      raise JSS::NoSuchItemError, 'LDAPServer not yet saved in the JSS' unless @in_jss
-      raw = api.get_rsrc("#{RSRC_BASE}/id/#{@id}/group/#{CGI.escape group.to_s}")[:ldap_groups]
+      raise Jamf::NoSuchItemError, 'LdapServer not yet saved in the JSS' unless @in_jss
+      raw = cnx.c_get("#{RSRC_BASE}/id/#{@id}/group/#{CGI.escape group.to_s}")[:ldap_groups]
       exact ? raw.select { |u| u[:groupname] == group } : raw
     end
 
@@ -325,8 +336,8 @@ module JSS
     # @return [Boolean, nil] is the user a member? Nil if unable to check
     #
     def check_membership(user, group)
-      raise JSS::NoSuchItemError, 'LDAPServer not yet saved in the JSS' unless @in_jss
-      self.class.check_membership @id, user, group, api: @api
+      raise Jamf::NoSuchItemError, 'LdapServer not yet saved in the JSS' unless @in_jss
+      self.class.check_membership @id, user, group, cnx: @cnx
     end
 
   end # class ldap server

data/lib/{jss/api_object → jamf/api/classic/api_objects}/locatable.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
@@ -160,7 +160,7 @@ module JSS
     def building= (new_val)
       return nil if @building == new_val
       new_val = new_val.to_s.strip
-      raise JSS::NoSuchItemError, "No building named #{new_val} exists in the JSS" unless new_val.empty? or JSS::Building.all_names(api: @api).include? new_val
+      raise Jamf::NoSuchItemError, "No building named #{new_val} exists in the JSS" unless new_val.empty? or Jamf::Building.all_names(cnx: @cnx).include? new_val
       @building = new_val
       @need_to_update = true
     end
@@ -169,7 +169,7 @@ module JSS
     def department= (new_val)
       return nil if @department == new_val
       new_val = new_val.to_s.strip
-      raise JSS::NoSuchItemError, "No department named #{new_val} exists in the JSS" unless new_val.empty? or JSS::Department.all_names(api: @api).include? new_val
+      raise Jamf::NoSuchItemError, "No department named #{new_val} exists in the JSS" unless new_val.empty? or Jamf::Department.all_names(cnx: @cnx).include? new_val
       @department = new_val
       @need_to_update = true
     end
@@ -178,7 +178,7 @@ module JSS
     def email_address= (new_val)
       return nil if @email_address == new_val
       new_val = new_val.to_s.strip
-      raise JSS::InvalidDataError, "Invalid Email Address" unless new_val.empty? or  new_val =~ /^[^\s@]+@[^\s@]+$/
+      raise Jamf::InvalidDataError, "Invalid Email Address" unless new_val.empty? or  new_val =~ /^[^\s@]+@[^\s@]+$/
       @email_address = new_val
       @need_to_update = true
     end
@@ -283,4 +283,4 @@ module JSS
 
   end # module Locatable
 
-end # module JSS
+end # module Jamf