ruby-jss 1.6.4 → 2.0.0b1

data/lib/{jss/api_object → jamf/api/classic/base_classes}/configuration_profile.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
   ###################################
@@ -33,18 +33,18 @@ module JSS
   # Note that the profile payloads and the profile UUID cannot be edited or updated with this via this class.
   # Use the web UI.
   #
-  # @see JSS::APIObject
+  # @see Jamf::APIObject
   #
-  class ConfigurationProfile < JSS::APIObject
+  class ConfigurationProfile < Jamf::APIObject
 
     # Mix-Ins
     ###################################
 
-    include JSS::Updatable
-    include JSS::Scopable
-    include JSS::SelfServable
-    include JSS::Categorizable
-    include JSS::Sitable
+    include Jamf::Updatable
+    include Jamf::Scopable
+    include Jamf::SelfServable
+    include Jamf::Categorizable
+    include Jamf::Sitable
 
     # Class Constants
     ###################################
@@ -94,9 +94,9 @@ module JSS
     # Constructor
     ###################################
 
-    # See JSS::APIObject#initialize
+    # See Jamf::APIObject#initialize
     #
-    def initialize(args = {})
+    def initialize(**args)
       super
       @description = @main_subset[:description]
       @uuid = @main_subset[:uuid]
@@ -174,11 +174,11 @@ module JSS
     # wrapper with param
     def save(redeploy_to_all: false)
       if @in_jss
-        raise JSS::UnsupportedError, 'Updating this object in the JSS is currently not supported by ruby-jss' unless updatable?
+        raise Jamf::UnsupportedError, 'Updating this object in the JSS is currently not supported by ruby-jss' unless updatable?
 
         update redeploy_to_all: redeploy_to_all
       else
-        raise JSS::UnsupportedError, 'Creating this object in the JSS is currently not supported by ruby-jss' unless creatable?
+        raise Jamf::UnsupportedError, 'Creating this object in the JSS is currently not supported by ruby-jss' unless creatable?
 
         create
       end
@@ -209,6 +209,3 @@ module JSS
   end # class OSXConfigurationProfile
 
 end # module
-
-require 'jss/api_object/configuration_profile/osx_configuration_profile'
-require 'jss/api_object/configuration_profile/mobile_device_configuration_profile'

data/lib/{jss/api_object → jamf/api/classic/base_classes}/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,7 +21,7 @@
 #    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
   ###################################
@@ -44,19 +44,19 @@ module JSS
   #
   # Subclasses of ExtensionAttribute must define these constants:
   # * TARGET_CLASS - the {APIObject} subclass to which the extention attribute applies.
-  #   e.g. {JSS::Computer}
+  #   e.g. {Jamf::Computer}
   #
-  # * ALL_TARGETS_CRITERION - a {JSS::Criteriable::Criterion} instance that will be used in
+  # * ALL_TARGETS_CRITERION - a {Jamf::Criteriable::Criterion} instance that will be used in
   #   an {AdvancedSearch} to find all of members of the TARGET_CLASS
   #
-  # @see JSS::APIObject
+  # @see Jamf::APIObject
   #
-  class ExtensionAttribute < JSS::APIObject
+  class ExtensionAttribute < Jamf::APIObject
 
     # Mix-Ins
     ###################################
-    include JSS::Creatable
-    include JSS::Updatable
+    include Jamf::Creatable
+    include Jamf::Updatable
 
     # Class Constants
     ###################################
@@ -123,7 +123,7 @@ module JSS
     # Attributes
     ####################
 
-    # :id, :name, :in_jss, :need_to_update, and :rest_rsrc come from JSS::APIObject
+    # :id, :name, :in_jss, :need_to_update, and :rest_rsrc come from Jamf::APIObject
 
     # @return [String] description of the ext attrib
     attr_reader :description
@@ -147,10 +147,10 @@ module JSS
     # Constructor
     ###################################
 
-    # @see JSS::APIObject#initialize
+    # @see Jamf::APIObject#initialize
     #
-    def initialize(args = {})
-      super args
+    def initialize(**args)
+      super
 
       # @init_data now has the raw data
       # so fill in our attributes or set defaults
@@ -165,7 +165,7 @@ module JSS
         @attribute_mapping = @init_data[:input_type][:attribute_mapping]
         @popup_choices = @init_data[:input_type][:popup_choices]
         # popups can always contain blank
-        @popup_choices << JSS::BLANK if @popup_choices
+        @popup_choices << Jamf::BLANK if @popup_choices
 
         # These two are deprecated - windows won't be supported for long
         @platform = @init_data[:input_type][:platform]
@@ -188,35 +188,35 @@ module JSS
     # Public Instance Methods
     ###################################
 
-    # @see JSS::Creatable#create
+    # @see Jamf::Creatable#create
     #
     def create
       validate_for_save
       super
     end
 
-    # @see JSS::Updatable#update
+    # @see Jamf::Updatable#update
     #
     def update
       validate_for_save
       super
       # this flushes the cached EA itself, used for validating ea values.
-      @api.flushcache self.class
+      @cnx.flushcache self.class
     end
 
-    # @see JSS::APIObject#delete
+    # @see Jamf::APIObject#delete
     #
     def delete
-      orig_open_timeout = @api.cnx.options[:open_timeout]
-      orig_timeout = @api.cnx.options[:timeout]
-      @api.timeout = orig_timeout + 1800
-      @api.open_timeout = orig_open_timeout + 1800
+      orig_open_timeout = @cnx.open_timeout
+      orig_timeout = @cnx.timeout
+      @cnx.timeout = orig_timeout + 1800
+      @cnx.open_timeout = orig_open_timeout + 1800
       begin
         super
-        @api.flushcache self.class
+        @cnx.flushcache self.class
       ensure
-        @api.timeout = orig_timeout
-        @api.open_timeout = orig_open_timeout
+        @cnx.timeout = orig_timeout
+        @cnx.open_timeout = orig_open_timeout
       end
     end
 
@@ -258,7 +258,7 @@ module JSS
     #
     def data_type=(new_val)
       return if @data_type == new_val
-      raise JSS::InvalidDataError, "data_type must be a string, one of: '#{DATA_TYPES.join("', '")}'" unless DATA_TYPES.include? new_val
+      raise Jamf::InvalidDataError, "data_type must be a string, one of: '#{DATA_TYPES.join("', '")}'" unless DATA_TYPES.include? new_val
 
       @data_type = new_val
       @need_to_update = true
@@ -273,7 +273,7 @@ module JSS
     def web_display=(new_val)
       return if @web_display == new_val
       unless WEB_DISPLAY_CHOICES.include? new_val
-        raise JSS::InvalidDataError, "inventory_display must be a string, one of: #{WEB_DISPLAY_CHOICES.join(', ')}"
+        raise Jamf::InvalidDataError, "inventory_display must be a string, one of: #{WEB_DISPLAY_CHOICES.join(', ')}"
       end
 
       @web_display = new_val
@@ -288,7 +288,7 @@ module JSS
     #
     def input_type=(new_val)
       return if @input_type == new_val
-      raise JSS::InvalidDataError, "input_type must be a string, one of: #{INPUT_TYPES.join(', ')}" unless INPUT_TYPES.include? new_val
+      raise Jamf::InvalidDataError, "input_type must be a string, one of: #{INPUT_TYPES.join(', ')}" unless INPUT_TYPES.include? new_val
 
       @input_type = new_val
       case @input_type
@@ -330,7 +330,7 @@ module JSS
     #
     def popup_choices=(new_val)
       return if @popup_choices == new_val
-      raise JSS::InvalidDataError, 'popup_choices must be an Array' unless new_val.is_a?(Array)
+      raise Jamf::InvalidDataError, 'popup_choices must be an Array' unless new_val.is_a?(Array)
 
       # convert each one to a String,
       # and check that it matches the @data_type
@@ -338,9 +338,9 @@ module JSS
         v = v.to_s.strip
         case @data_type
         when DATA_TYPE_DATE
-          raise JSS::InvalidDataError, "data_type is Date, but '#{v}' is not formatted 'YYYY-MM-DD hh:mm:ss'" unless v =~ /^\d{4}(-\d\d){2} (\d\d:){2}\d\d$/
+          raise Jamf::InvalidDataError, "data_type is Date, but '#{v}' is not formatted 'YYYY-MM-DD hh:mm:ss'" unless v =~ /^\d{4}(-\d\d){2} (\d\d:){2}\d\d$/
         when 'Integer'
-          raise JSS::InvalidDataError, "data_type is Integer, but '#{v}' is not one" unless v =~ /^\d+$/
+          raise Jamf::InvalidDataError, "data_type is Integer, but '#{v}' is not one" unless v =~ /^\d+$/
         end
         v
       end
@@ -360,7 +360,7 @@ module JSS
     # @return [void]
     #
     def attribute_mapping=(new_mapping)
-      new_mapping = JSS::Validate.non_empty_string new_mapping.to_s
+      new_mapping = Jamf::Validate.non_empty_string new_mapping.to_s
       return if new_mapping == @attribute_mapping
 
       self.input_type = INPUT_TYPE_LDAP
@@ -382,24 +382,24 @@ module JSS
     # The AdvancedSearch is then deleted.
     #
     # @param search_type[String] how are we comparing the stored value with the desired value.
-    # must be a member of JSS::Criterion::SEARCH_TYPES
+    # must be a member of Jamf::Criterion::SEARCH_TYPES
     #
     # @param desired_value[String] the value to compare with the stored value to determine a match.
     #
     # @return [Array<Hash{:id=>Integer,:name=>String,:value=>String,Integer,Time}>] the items that match the result.
     #
     def all_with_result(search_type, desired_value)
-      raise JSS::NoSuchItemError, "EA Not In JSS! Use #create to create this #{self.class::RSRC_OBJECT_KEY}." unless @in_jss
-      unless JSS::Criteriable::Criterion::SEARCH_TYPES.include? search_type.to_s
-        raise JSS::InvalidDataError, 'Invalid search_type, see JSS::Criteriable::Criterion::SEARCH_TYPES'
+      raise Jamf::NoSuchItemError, "EA Not In JSS! Use #create to create this #{self.class::RSRC_OBJECT_KEY}." unless @in_jss
+      unless Jamf::Criteriable::Criterion::SEARCH_TYPES.include? search_type.to_s
+        raise Jamf::InvalidDataError, 'Invalid search_type, see Jamf::Criteriable::Criterion::SEARCH_TYPES'
       end
 
       begin
         search_class = self.class::TARGET_CLASS::SEARCH_CLASS
-        acs = search_class.make api: @api, name: "ruby-jss-EA-result-search-#{Time.now.to_jss_epoch}"
+        acs = search_class.make cnx: @cnx, name: "ruby-jss-EA-result-search-#{Time.now.to_jss_epoch}"
         acs.display_fields = [@name]
-        crit_list = [JSS::Criteriable::Criterion.new(and_or: 'and', name: @name, search_type: search_type.to_s, value: desired_value)]
-        acs.criteria = JSS::Criteriable::Criteria.new crit_list
+        crit_list = [Jamf::Criteriable::Criterion.new(and_or: 'and', name: @name, search_type: search_type.to_s, value: desired_value)]
+        acs.criteria = Jamf::Criteriable::Criteria.new crit_list
 
         acs.create :get_results
 
@@ -408,7 +408,7 @@ module JSS
         acs.search_results.each do |i|
           value =
             case @data_type
-            when 'Date' then JSS.parse_datetime i[@symbolized_name]
+            when 'Date' then Jamf.parse_time i[@symbolized_name]
             when 'Integer' then i[@symbolized_name].to_i
             else i[@symbolized_name]
             end # case
@@ -437,28 +437,28 @@ module JSS
     #
     # @return [Array<Hash{:id=>Integer,:name=>String,:value=>String,Integer,Time,:as_of=>Time}>]
     #
-    # @see JSS::AdvancedSearch
+    # @see Jamf::AdvancedSearch
     #
-    # @see JSS::AdvancedComputerSearch
+    # @see Jamf::AdvancedComputerSearch
     #
-    # @see JSS::AdvancedMobileDeviceSearch
+    # @see Jamf::AdvancedMobileDeviceSearch
     #
-    # @see JSS::AdvancedUserSearch
+    # @see Jamf::AdvancedUserSearch
     #
     def latest_values
-      raise JSS::NoSuchItemError, "EA Not In JSS! Use #create to create this #{self.class::RSRC_OBJECT_KEY}." unless @in_jss
+      raise Jamf::NoSuchItemError, "EA Not In JSS! Use #create to create this #{self.class::RSRC_OBJECT_KEY}." unless @in_jss
 
       tmp_advsrch = "ruby-jss-EA-latest-search-#{Time.now.to_jss_epoch}"
 
       begin
         search_class = self.class::TARGET_CLASS::SEARCH_CLASS
-        acs = search_class.make name: tmp_advsrch, api: @api
-        acs.display_fields = self.class::TARGET_CLASS == JSS::User ? [@name, USERNAME_FIELD] : [@name, USERNAME_FIELD, LAST_RECON_FIELD]
+        acs = search_class.make name: tmp_advsrch, cnx: @cnx
+        acs.display_fields = self.class::TARGET_CLASS == Jamf::User ? [@name, USERNAME_FIELD] : [@name, USERNAME_FIELD, LAST_RECON_FIELD]
 
         # search for 'Username like "" ' because all searchable object classes have a "Username" value
-        crit = JSS::Criteriable::Criterion.new(and_or: 'and', name: 'Username', search_type: 'like', value: '')
+        crit = Jamf::Criteriable::Criterion.new(and_or: 'and', name: 'Username', search_type: 'like', value: '')
         # crit = self.class::ALL_TARGETS_CRITERION
-        acs.criteria = JSS::Criteriable::Criteria.new [crit]
+        acs.criteria = Jamf::Criteriable::Criteria.new [crit]
         acs.create :get_results
 
         results = []
@@ -466,20 +466,20 @@ module JSS
         acs.search_results.each do |i|
           value =
             case @data_type
-            when 'Date' then JSS.parse_datetime i[@symbolized_name]
+            when 'Date' then Jamf.parse_time i[@symbolized_name]
             when 'Integer' then i[@symbolized_name].to_i
             else i[@symbolized_name]
             end # case
 
-          as_of = Time.parse(i[LAST_RECON_FIELD_SYM]) if i[LAST_RECON_FIELD_SYM] != ''
+          as_of = Jamf.parse_time(i[LAST_RECON_FIELD_SYM])
 
           results << { id: i[:id], name: i[:name], username: i[USERNAME_FIELD_SYM], value: value, as_of: as_of }
         end # acs.search_results.each
       ensure
         if defined? acs
           acs.delete if acs
-        elsif search_class.all_names(:refresh, api: @api).include? tmp_advsrch
-          search_class.fetch(name: tmp_advsrch, api: @api).delete
+        elsif search_class.all_names(:refresh, cnx: @cnx).include? tmp_advsrch
+          search_class.fetch(name: tmp_advsrch, cnx: @cnx).delete
         end
       end
 
@@ -514,7 +514,7 @@ module JSS
       ea.add_element('description').text = @description if @description
       ea.add_element('data_type').text = @data_type
 
-      unless self.class == JSS::UserExtensionAttribute
+      unless self.class == Jamf::UserExtensionAttribute
         ea.add_element('inventory_display').text = @web_display if @web_display
         ea.add_element('recon_display').text = @recon_display if @recon_display
       end
@@ -535,15 +535,11 @@ module JSS
         it.add_element('scripting_language').text = @scripting_language if @scripting_language
       end
 
-      doc = REXML::Document.new APIConnection::XML_HEADER
+      doc = REXML::Document.new Jamf::Connection::XML_HEADER
       doc << ea
       doc.to_s
     end # rest xml
 
   end # class ExtAttrib
 
-end # module JSS
-
-require 'jss/api_object/extension_attribute/computer_extension_attribute'
-require 'jss/api_object/extension_attribute/mobile_device_extension_attribute'
-require 'jss/api_object/extension_attribute/user_extension_attribute'
+end # module Jamf