ruby-jss 1.6.0 → 2.0.0a11

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

@@ -1,4 +1,4 @@
-# Copyright 2020 Pixar
+# Copyright 2022 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -21,18 +21,18 @@
 #    KIND, either express or implied. See the Apache License for the specific
 #    language governing permissions and limitations under the Apache License.
 
-module JSS
+module Jamf
 
   # Classes
   #####################################
 
   # The definition of a Computer extension attribute in the JSS
   #
-  # @see JSS::ExtensionAttribute
+  # @see Jamf::ExtensionAttribute
   #
-  # @see JSS::APIObject
+  # @see Jamf::APIObject
   #
-  class ComputerExtensionAttribute < JSS::ExtensionAttribute
+  class ComputerExtensionAttribute < Jamf::ExtensionAttribute
 
     # Class Constants
     #####################################
@@ -48,10 +48,10 @@ module JSS
     RSRC_OBJECT_KEY = :computer_extension_attribute
 
     # these ext attribs are related to these kinds of objects
-    TARGET_CLASS = JSS::Computer
+    TARGET_CLASS = Jamf::Computer
 
     # A criterion that will return all members of the TARGET_CLASS
-    ALL_TARGETS_CRITERION = JSS::Criteriable::Criterion.new(and_or: 'and', name: 'Username', search_type: 'like', value: '')
+    ALL_TARGETS_CRITERION = Jamf::Criteriable::Criterion.new(and_or: 'and', name: 'Username', search_type: 'like', value: '')
 
     # When the intput type is script, what platforms can they run on?
     PLATFORM_MAC = 'Mac'.freeze
@@ -119,7 +119,7 @@ module JSS
     #
     def recon_display=(new_val)
       return if @recon_display == new_val
-      raise JSS::InvalidDataError, "recon_display must be a string, one of: #{RECON_DISPLAY_CHOICES.join(', ')}" unless RECON_DISPLAY_CHOICES.include? new_val
+      raise Jamf::InvalidDataError, "recon_display must be a string, one of: #{RECON_DISPLAY_CHOICES.join(', ')}" unless RECON_DISPLAY_CHOICES.include? new_val
 
       @recon_display = new_val
       @need_to_update = true
@@ -157,7 +157,7 @@ module JSS
     def script=(new_val)
       return if @script == new_val
 
-      JSS::Validate.non_empty_string new_val
+      Jamf::Validate.non_empty_string new_val
 
       self.input_type = INPUT_TYPE_SCRIPT
       @script = new_val
@@ -176,7 +176,7 @@ module JSS
     #
     def platform=(new_val)
       return if @platform == new_val
-      raise JSS::InvalidDataError, "platform must be a string, one of: #{PLATFORMS.join(', ')}" unless PLATFORMS.include? new_val
+      raise Jamf::InvalidDataError, "platform must be a string, one of: #{PLATFORMS.join(', ')}" unless PLATFORMS.include? new_val
 
       self.input_type = INPUT_TYPE_SCRIPT
       @platform = new_val
@@ -196,7 +196,7 @@ module JSS
     def scripting_language=(new_val)
       return if @scripting_language == new_val
       unless WINDOWS_SCRIPTING_LANGUAGES.include? new_val
-        raise JSS::InvalidDataError, "Scripting language must be a string, one of: #{WINDOWS_SCRIPTING_LANGUAGES.join(', ')}"
+        raise Jamf::InvalidDataError, "Scripting language must be a string, one of: #{WINDOWS_SCRIPTING_LANGUAGES.join(', ')}"
       end
 
       self.input_type = INPUT_TYPE_SCRIPT
@@ -211,20 +211,20 @@ module JSS
     # * :value - String, Integer, or Time, depending on @data_type
     # * :timestamp  - Time
     #
-    # This method requires a MySQL database connection established via JSS::DB_CNX.connect
+    # This method requires a MySQL database connection established via Jamf::DB_CNX.connect
     #
-    # @see JSS::DBConnection
+    # @see Jamf::DBConnection
     #
     # @param computer[Integer,String]  the id or name of the Computer.
     #
     # @return [Array<Hash{:timestamp=>Time,:value=>String,Integer,Time}>]
     #
     def history(computer)
-      raise JSS::NoSuchItemError, "EA Not In JSS! Use #create to create this #{RSRC_OBJECT_KEY}." unless @in_jss
-      raise JSS::InvalidConnectionError, "Database connection required for 'history' query." unless JSS::DB_CNX.connected?
+      raise Jamf::NoSuchItemError, "EA Not In JSS! Use #create to create this #{RSRC_OBJECT_KEY}." unless @in_jss
+      raise Jamf::InvalidConnectionError, "Database connection required for 'history' query." unless Jamf::DB_CNX.connected?
 
-      computer_id = JSS::Computer.valid_id computer, api: @api
-      raise JSS::NoSuchItemError, "No computer found matching '#{computer}'" unless computer_id
+      computer_id = Jamf::Computer.valid_id computer, cnx: @cnx
+      raise Jamf::NoSuchItemError, "No computer found matching '#{computer}'" unless computer_id
 
       the_query = <<-END_Q
       SELECT eav.value_on_client AS value, r.date_entered_epoch AS timestamp_epoch
@@ -234,7 +234,7 @@ module JSS
       ORDER BY timestamp_epoch
       END_Q
 
-      qrez = JSS::DB_CNX.db.query the_query
+      qrez = Jamf::DB_CNX.db.query the_query
       history = []
 
       qrez.each_hash do |entry|
@@ -242,7 +242,7 @@ module JSS
           case @data_type
           when 'String' then entry['value']
           when 'Integer' then entry['value'].to_i
-          when 'Date' then JSS.parse_datetime(entry['value'])
+          when 'Date' then Jamf.parse_time(entry['value'])
           end # case
         newhash = { value: value, timestamp: JSS.epoch_to_time(entry['timestamp_epoch']) }
         history << newhash

data/lib/{jss/api_object/group → jamf/api/classic/api_objects}/computer_group.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 Constants
@@ -45,18 +45,18 @@ module JSS
   ###
   ### A computer group in the JSS
   ###
-  ### See also the parent class JSS::Group
+  ### See also the parent class Jamf::Group
   ###
-  ### @see JSS::APIObject
+  ### @see Jamf::APIObject
   ###
-  ### @see JSS::Group
+  ### @see Jamf::Group
   ###
-  class ComputerGroup < JSS::Group
+  class ComputerGroup < Jamf::Group
 
     #####################################
     ### Mix-Ins
     #####################################
-    include JSS::MDM
+    include Jamf::MDM
 
     #####################################
     ### Class Methods
@@ -77,7 +77,7 @@ module JSS
     RSRC_OBJECT_KEY = :computer_group
 
     ### this allows the parent Group class to do things right
-    MEMBER_CLASS = JSS::Computer
+    MEMBER_CLASS = Jamf::Computer
 
     # the XML element for immediate member additions via PUT
     ADD_MEMBERS_ELEMENT = 'computer_additions'.freeze

data/lib/{jss/api_object → jamf/api/classic/api_objects}/computer_invitation.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 Constants
   #####################################
@@ -45,13 +45,13 @@ module JSS
   # @see APIObject
   # @see Creatable
   #
-  class ComputerInvitation < JSS::APIObject
+  class ComputerInvitation < Jamf::APIObject
 
     # MixIns
     #####################################
 
-    include JSS::Creatable
-    include JSS::Sitable
+    include Jamf::Creatable
+    include Jamf::Sitable
 
     # Class Constants
     #####################################
@@ -66,7 +66,7 @@ module JSS
     # It's also used in various error messages
     RSRC_OBJECT_KEY = :computer_invitation
 
-    # See JSS::APIObject
+    # See Jamf::APIObject
     OTHER_LOOKUP_KEYS = {
       invitation: { fetch_rsrc_key: :invitation }
     }.freeze
@@ -157,7 +157,7 @@ module JSS
 
     # Needed to support creation of new Computer Invitations to set their name.
     #
-    # @return [JSS::ComputerInvitation]
+    # @return [Jamf::ComputerInvitation]
     #
     def create
       new_invitation_id = super
@@ -180,7 +180,7 @@ module JSS
     # Sets invitation expiration 4 hours after request.
     #
     def rest_xml
-      doc = REXML::Document.new APIConnection::XML_HEADER
+      doc = REXML::Document.new Jamf::Connection::XML_HEADER
       obj = doc.add_element RSRC_OBJECT_KEY.to_s
       obj.add_element('invitation_type').text = invitation_type
       obj.add_element('create_account_if_does_not_exist').text = create_account_if_does_not_exist

data/lib/{jss/api_object → jamf/api/classic/api_objects}/creatable.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
 
   ### Sub-Modules
   #####################################
@@ -32,7 +32,7 @@ module JSS
   ### A mix-in module that allows objects to be created in the JSS
   ### via the API.
   ###
-  ### When a JSS::APIObject subclass includes this module, that subclass
+  ### When a Jamf::APIObject subclass includes this module, that subclass
   ### can be instantiated with :id => :new, and :name => "some_new_name".
   ###
   ###
@@ -64,19 +64,14 @@ module JSS
     ###  Mixed-in Instance Methods
     #####################################
 
-    # Create a new object in the JSS.
+    # Create a new object in the JSS
     #
-    # @param api[JSS::APIConnection] the API in which to create the object
-    #   Defaults to the API used to instantiate this object
+    # @return [Integer] the id of the new object
     #
-    # @return [Integer] the jss ID of the newly created object
-    #
-    def create
-      raise JSS::UnsupportedError, "Creating or editing #{self.class::RSRC_LIST_KEY} isn't yet supported. Please use other Casper workflows." unless creatable?
-
-      raise AlreadyExistsError, "This #{self.class::RSRC_OBJECT_KEY} already exists. Use #update to make changes." if @in_jss
+    def create_in_jamf
+      raise Jamf::UnsupportedError, "Creating or editing #{self.class::RSRC_LIST_KEY} isn't yet supported. Please use other Casper workflows." unless creatable?
 
-      @api.post_rsrc(rest_rsrc, rest_xml) =~ %r{><id>(\d+)</id><}
+      @cnx.c_post(rest_rsrc, rest_xml) =~ %r{><id>(\d+)</id><}
       @id = Regexp.last_match(1).to_i
       @in_jss = true
       @need_to_update = false
@@ -84,25 +79,28 @@ module JSS
 
       # clear any caches for this class
       # so they'll re-cache as needed
-      @api.flushcache self.class::RSRC_LIST_KEY
+      @cnx.flushcache self.class::RSRC_LIST_KEY
 
       @id
     end
+    private :create_in_jamf
 
     ### make a clone of this API object, with a new name. The class must be creatable
     ###
     ### @param name [String] the name for the new object
     ###
-    ### @param api[JSS::APIConnection] the API in which to create the object
+    ### @param cnx [Jamf::Connection] the API in which to create the object
     ###  Defaults to the API used to instantiate this object
     ###
-    ### @return [APIObject] An uncreated clone of this APIObject with the given name
+    ### @return [APIObject] An unsaved clone of this APIObject with the given name
     ###
-    def clone(new_name, api: nil)
-      api ||= @api
-      raise JSS::UnsupportedError, 'This class is not creatable in via ruby-jss' unless creatable?
-      raise JSS::AlreadyExistsError, "A #{self.class::RSRC_OBJECT_KEY} already exists with that name" if \
-        self.class.all_names(:refresh, api: api).include? new_name
+    def clone(new_name, api: nil, cnx: nil)
+      cnx = api if api
+      cnx ||= @cnx
+
+      raise Jamf::UnsupportedError, 'This class is not creatable in via ruby-jss' unless creatable?
+      raise Jamf::AlreadyExistsError, "A #{self.class::RSRC_OBJECT_KEY} already exists with that name" if \
+        self.class.all_names(:refresh, cnx: cnx).include? new_name
 
       orig_in_jss = @in_jss
       @in_jss = false
@@ -110,15 +108,15 @@ module JSS
       @id = nil
       orig_rsrc = @rest_rsrc
       @rest_rsrc = "#{self.class::RSRC_BASE}/name/#{CGI.escape new_name.to_s}"
-      orig_api = @api
-      @api = api
+      orig_cnx = @cnx
+      @cnx = cnx
 
       new_obj = dup
 
       @in_jss = orig_in_jss
       @id = orig_id
       @rest_rsrc = orig_rsrc
-      @api = orig_api
+      @cnx = orig_cnx
       new_obj.name = new_name
 
       new_obj

data/lib/{jss/api_object → jamf/api/classic/api_objects}/criteriable/criteria.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 Criteriable
 
@@ -40,20 +40,20 @@ module JSS
     ### Classes
     #####################################
 
-    ### This class stores an array of {JSS::Criteriable::Criterion} instances
+    ### This class stores an array of {Jamf::Criteriable::Criterion} instances
     ### and provides methods for working with them as a group.
     ###
-    ### {JSS::APIObject} subclasses that include {JSS::Criteriable} have a :criteria attribute
+    ### {Jamf::APIObject} subclasses that include {Jamf::Criteriable} have a :criteria attribute
     ### which holds one Criteria object.
     ###
     ### Objects that contain Criteria objects need to
     ### - call '#container = self' on their Criteria object when its created.
     ### - implement #should_update, which the Criteria object calls when it changes.
     ###
-    ### Both of those tasks are handled by the {JSS::Criteriable} module and are mixed in when
+    ### Both of those tasks are handled by the {Jamf::Criteriable} module and are mixed in when
     ### it's included.
     ###
-    ### See {JSS::Criteriable} for examples
+    ### See {Jamf::Criteriable} for examples
     ###
     class Criteria
 
@@ -68,14 +68,14 @@ module JSS
       ### Attributes
       #####################################
 
-      ### @return [Array] the group of JSS::Criteriable::Criterion instances making up these Criteria
+      ### @return [Array] the group of Jamf::Criteriable::Criterion instances making up these Criteria
       attr_reader :criteria
 
-      ### @return [JSS::APIObject subclass] a reference to the object containing these Criteria
+      ### @return [Jamf::APIObject subclass] a reference to the object containing these Criteria
       attr_writer :container
 
       ###
-      ### @param new_criteria[Array<JSS::Criteriable::Criterion>]
+      ### @param new_criteria[Array<Jamf::Criteriable::Criterion>]
       ###
       def initialize(new_criteria = [])
         @criteria = []
@@ -85,15 +85,15 @@ module JSS
       end # init
 
       ###
-      ### Provide a whole new array of JSS::Criteriable::Criterion instances for this Criteria
+      ### Provide a whole new array of Jamf::Criteriable::Criterion instances for this Criteria
       ###
-      ### @param new_criteria[Array<JSS::Criteriable::Criterion>]
+      ### @param new_criteria[Array<Jamf::Criteriable::Criterion>]
       ###
       ### @return [void]
       ###
       def criteria=(new_criteria)
-        unless new_criteria.is_a?(Array) && new_criteria.reject { |c| c.is_a?(JSS::Criteriable::Criterion) }.empty?
-          raise JSS::InvalidDataError, 'Argument must be an Array of JSS::Criteriable::Criterion instances.'
+        unless new_criteria.is_a?(Array) && new_criteria.reject { |c| c.is_a?(Jamf::Criteriable::Criterion) }.empty?
+          raise Jamf::InvalidDataError, 'Argument must be an Array of Jamf::Criteriable::Criterion instances.'
         end
         new_criteria.each { |nc| criterion_ok? nc }
         @criteria = new_criteria
@@ -112,7 +112,7 @@ module JSS
       ###
       ### Add a new criterion to the end of the criteria
       ###
-      ### @param criterion[JSS::Criteriable::Criterion] the new Criterion to store
+      ### @param criterion[Jamf::Criteriable::Criterion] the new Criterion to store
       ###
       ### @return [void]
       ###
@@ -126,7 +126,7 @@ module JSS
       ###
       ### Add a new criterion to the beginning of the criteria
       ###
-      ### @param criterion[JSS::Criteriable::Criterion] the new Criterion to store
+      ### @param criterion[Jamf::Criteriable::Criterion] the new Criterion to store
       ###
       ### @return [void]
       ###
@@ -142,7 +142,7 @@ module JSS
       ###
       ### @param priority[Integer] the priority/index before which to insert the new one.
       ###
-      ### @param criterion[JSS::Criteriable::Criterion] the new Criterion to store at that index
+      ### @param criterion[Jamf::Criteriable::Criterion] the new Criterion to store at that index
       ###
       ### @return [void]
       ###
@@ -162,7 +162,7 @@ module JSS
       ###
       def delete_criterion(priority)
         if @criteria[priority]
-          raise JSS::MissingDataError, "Criteria can't be empty" if @criteria.count == 1
+          raise Jamf::MissingDataError, "Criteria can't be empty" if @criteria.count == 1
           @criteria.delete_at priority
           set_priorities
         end
@@ -176,12 +176,12 @@ module JSS
       ###   The index must already exist. Otherwise use
       ###   #append_criterion, #prepend_criterion, or #insert_criterion
       ###
-      ### @param criterion[JSS::Criteriable::Criterion] the new Criterion to store at that index
+      ### @param criterion[Jamf::Criteriable::Criterion] the new Criterion to store at that index
       ###
       ### @return [void]
       ###
       def set_criterion(priority, criterion)
-        raise JSS::NoSuchItemError, "No current criterion with priority '#{priority}'" unless @criteria[priority]
+        raise Jamf::NoSuchItemError, "No current criterion with priority '#{priority}'" unless @criteria[priority]
         criterion_ok? criterion
         @criteria[priority] = criterion
         set_priorities
@@ -235,11 +235,11 @@ module JSS
       ### Return true or raise an error about the problem
       ###
       def criterion_ok?(criterion)
-        raise JSS::InvalidDataError, "Duplicate criterion: #{criterion.signature}" if @criteria.select { |c| c == criterion }.count > 1
-        raise JSS::InvalidDataError, "Missing :and_or for criterion: #{criterion.signature}" unless criterion.and_or
-        raise JSS::InvalidDataError, "Missing :name for criterion: #{criterion.signature}" unless criterion.name
-        raise JSS::InvalidDataError, "Missing :search_type for criterion: #{criterion.signature}" unless criterion.search_type
-        raise JSS::InvalidDataError, "Missing :value for criterion: #{criterion.signature}" unless criterion.value
+        raise Jamf::InvalidDataError, "Duplicate criterion: #{criterion.signature}" if @criteria.select { |c| c == criterion }.count > 1
+        raise Jamf::InvalidDataError, "Missing :and_or for criterion: #{criterion.signature}" unless criterion.and_or
+        raise Jamf::InvalidDataError, "Missing :name for criterion: #{criterion.signature}" unless criterion.name
+        raise Jamf::InvalidDataError, "Missing :search_type for criterion: #{criterion.signature}" unless criterion.search_type
+        raise Jamf::InvalidDataError, "Missing :value for criterion: #{criterion.signature}" unless criterion.value
         true
       end
 

data/lib/{jss/api_object → jamf/api/classic/api_objects}/criteriable/criterion.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
 
   module Criteriable
 
@@ -39,13 +39,13 @@ module JSS
     # This class defines a single criterion used in advanced searches and
     # smart groups throughout the JSS module.
     #
-    # They are used within {JSS::Criteriable::Criteria} instances which store an
+    # They are used within {Jamf::Criteriable::Criteria} instances which store an
     # array of these objects and provides methods for working with them as a group.
     #
-    # The classes that mix-in {JSS::Criteriable} each have a :criteria attribute which
-    # holds one {JSS::Criteriable::Criteria}
+    # The classes that mix-in {Jamf::Criteriable} each have a :criteria attribute which
+    # holds one {Jamf::Criteriable::Criteria}
     #
-    # See {JSS::Criteriable} for examples
+    # See {Jamf::Criteriable} for examples
     #
     class Criterion
 
@@ -120,18 +120,18 @@ module JSS
       # @option args :search_type [String] one of SEARCH_TYPES, the comparison between the stored value and :value
       # @option args :value [String] the value to compare with that stored for :name
       #
-      # @note :priority is maintained by the JSS::Criteriable::Criteria object holding this instance
+      # @note :priority is maintained by the Jamf::Criteriable::Criteria object holding this instance
       #
-      def initialize(args = {})
+      def initialize(**args)
         @priority = args[:priority]
 
         @and_or = (args[:and_or].downcase.to_sym if args[:and_or]) || :and
-        raise JSS::InvalidDataError, ":and_or must be 'and' or 'or'." unless AND_OR.include? @and_or
+        raise Jamf::InvalidDataError, ":and_or must be 'and' or 'or'." unless AND_OR.include? @and_or
 
         @name = args[:name]
 
         if args[:search_type]
-          raise JSS::InvalidDataError, 'Invalid :search_type' unless SEARCH_TYPES.include? args[:search_type]
+          raise Jamf::InvalidDataError, 'Invalid :search_type' unless SEARCH_TYPES.include? args[:search_type]
           @search_type = args[:search_type]
         end
 
@@ -158,7 +158,7 @@ module JSS
       #
       def and_or=(new_val)
         @and_or = new_val.to_sym
-        raise JSS::InvalidDataError, ":and_or must be 'and' or 'or'." unless AND_OR.include? @and_or.to_sym
+        raise Jamf::InvalidDataError, ":and_or must be 'and' or 'or'." unless AND_OR.include? @and_or.to_sym
       end
 
       # set the parenthesis for the criteria
@@ -178,7 +178,7 @@ module JSS
           @opening_paren = false
           @closing_paren = false
         else
-          raise JSS::InvalidDataError, 'paren must be :opening, :closing, or nil.'
+          raise Jamf::InvalidDataError, 'paren must be :opening, :closing, or nil.'
         end
       end
 
@@ -189,7 +189,7 @@ module JSS
       # @return [void]
       #
       def search_type=(new_val)
-        raise JSS::InvalidDataError, 'Invalid :search_type' unless SEARCH_TYPES.include? new_val
+        raise Jamf::InvalidDataError, 'Invalid :search_type' unless SEARCH_TYPES.include? new_val
         @search_type = new_val
       end
 
@@ -203,10 +203,10 @@ module JSS
         case @search_type
 
         when 'more than', 'less than', 'more than x days ago', 'less than x days ago'
-          raise JSS::InvalidDataError, "Value must be an integer for search type '#{new_val}'" unless new_val =~ /^\d+$/
+          raise Jamf::InvalidDataError, "Value must be an integer for search type '#{new_val}'" unless new_val =~ /^\d+$/
 
         when 'before (yyyy-mm-dd)', 'after (yyyy-mm-dd)'
-          raise JSS::InvalidDataError, "Value must be a a date in the format yyyy-mm-dd for search type '#{new_val}'" unless new_val =~ /^\d\d\d\d-\d\d-\d\d$/
+          raise Jamf::InvalidDataError, "Value must be a a date in the format yyyy-mm-dd for search type '#{new_val}'" unless new_val =~ /^\d\d\d\d-\d\d-\d\d$/
 
         end # case