ruby-jss 2.0.0b3 → 2.0.0b5

data/lib/jamf/zeitwerk_config.rb

@@ -0,0 +1,217 @@
+# 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
+#    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.
+
+# Gems
+######
+
+require 'zeitwerk'
+
+# Jamf's Zeitwerk Config and processes
+module JamfZeitwerkConfig
+
+  # touch this file to make zeitwerk and mixins send text to stderr as things load
+  # or get mixed in
+  VERBOSE_LOADING_FILE = Pathname.new('/tmp/ruby-jss-verbose-loading')
+
+  # Or, set this ENV var to also make zeitverk and mixins send text to stderr
+  VERBOSE_LOADING_ENV = 'RUBY_JSS_VERBOSE_LOADING'
+
+  # touch this file to make zeitwek  eager-load everything when the gem is required.
+  EAGER_LOAD_FILE = Pathname.new('/tmp/ruby-jss-zeitwerk-eager-load')
+
+  # Only look at the filesystem once.
+  def self.verbose_loading?
+    return @verbose_loading unless @verbose_loading.nil?
+
+    @verbose_loading = VERBOSE_LOADING_FILE.file?
+    @verbose_loading ||= ENV.include? VERBOSE_LOADING_ENV
+    @verbose_loading
+  end
+  
+  # rubocop: disable Style/StderrPuts
+  def self.load_msg(msg)
+    $stderr.puts msg if verbose_loading?    
+  end
+  # rubocop: enable Style/StderrPuts
+        
+  # The loader object for Xolo
+  def self.loader
+    @loader
+  end
+    
+  # Configure the Zeitwerk loader, See https://github.com/fxn/zeitwerk
+  def self.setup_zeitwerk_loader(zloader)
+    @loader = zloader
+
+    # Ignore this file (more ignores below)
+    loader.ignore __FILE__
+
+    ##### Collaped Paths
+    
+    # these paths all define classes & modules directly below 'Jamf'
+    # If we didn't collapse them, then e.g.
+    #   /jamf/api/base_classes/classic/group.rb
+    # would be expected to define
+    #   Jamf::Api::BaseClasses::Classic::Group
+    # rather than what we want:
+    #  Jamf::Group
+    ###################################################
+
+    loader.collapse("#{__dir__}/api")
+
+    loader.collapse("#{__dir__}/api/classic")
+    loader.collapse("#{__dir__}/api/classic/api_objects")
+    loader.collapse("#{__dir__}/api/classic/base_classes")
+
+    loader.collapse("#{__dir__}/api/jamf_pro")
+    loader.collapse("#{__dir__}/api/jamf_pro/api_objects")
+    loader.collapse("#{__dir__}/api/jamf_pro/mixins")
+    loader.collapse("#{__dir__}/api/jamf_pro/base_classes")
+    loader.collapse("#{__dir__}/api/jamf_pro/other_classes")
+
+    loader.collapse("#{__dir__}/deprecations")
+
+    ##### Inflected Paths
+    
+    # filenames => Constants, which don't adhere to zeitwerk's parsing standards.
+    #
+    # Mostly because the a filename like 'oapi_object' would be
+    # loaded by zeitwerk expecting it to define 'OapiObject', but it really
+    # defines 'OAPIObject'
+    ###############################################
+
+    # Connections
+    loader.inflector.inflect 'classic_api' => 'ClassicAPI'
+    loader.inflector.inflect 'jamf_pro_api' => 'JamfProAPI'
+    loader.inflector.inflect 'jamf_pro_api_error' => 'JamfProAPIError'
+
+    # API objects, resources, and mixins
+    loader.inflector.inflect 'oapi_schemas' => 'OAPISchemas'
+    loader.inflector.inflect 'oapi_object' => 'OAPIObject'
+    loader.inflector.inflect 'oapi_validate' => 'OAPIValidate'
+
+    loader.inflector.inflect 'jpapi_resource' => 'JPAPIResource'
+
+    loader.inflector.inflect 'api_object' => 'APIObject'
+    loader.inflector.inflect 'xml_workaround' => 'XMLWorkaround'
+    loader.inflector.inflect 'json_object' => 'JSONObject'
+    loader.inflector.inflect 'vppable' => 'VPPable'
+    loader.inflector.inflect 'osx_configuration_profile' => 'OSXConfigurationProfile'
+    loader.inflector.inflect 'jp_extendable' => 'JPExtendable'
+    loader.inflector.inflect 'mdm' => 'MDM'
+    loader.inflector.inflect 'ibeacon' => 'IBeacon'
+    loader.inflector.inflect 'powerbroker_identity_services' => 'PowerBroker'
+    loader.inflector.inflect 'admitmac' => 'ADmitMac'
+    loader.inflector.inflect 'ip_address' => 'IPAddress'
+    loader.inflector.inflect 'netboot_server' => 'NetBootServer'
+    loader.inflector.inflect 'vpp_account' => 'VPPAccount'
+    loader.inflector.inflect 'removable_macaddr' => 'RemovableMacAddress'
+    loader.inflector.inflect 'md_prestage_name' => 'MobileDevicePrestageName'
+    loader.inflector.inflect 'md_prestage_names' => 'MobileDevicePrestageNames'
+    loader.inflector.inflect 'md_prestage_skip_setup_items' => 'MobileDevicePrestageSkipSetupItems'
+    loader.inflector.inflect 'macos_managed_updates' => 'MacOSManagedUpdates'
+
+    # deprecations, separated so they load only when used.
+    # When its time to get rid of them, delete the files from the 
+    # 'deprecations' directory, and the matching line here.
+    loader.inflector.inflect('deprecated_api_constant' => 'API')
+    loader.inflector.inflect('deprecated_config_constant' => 'CONFIG')
+    loader.inflector.inflect('deprecated_api_connection_class' => 'APIConnection')
+
+    ##### Ingored Paths
+    
+    # These should be ignored, some will be required directly
+    #####################################
+
+    loader.ignore "#{__dir__}/db_connection.rb"
+    loader.ignore "#{__dir__}/ruby_extensions.rb"
+    loader.ignore "#{__dir__}/ruby_extensions"
+    loader.ignore "#{__dir__}/exceptions.rb"
+
+    lib_dir = Pathname.new(__dir__).parent.to_s
+    loader.ignore "#{lib_dir}/ruby-jss.rb" 
+    loader.ignore "#{lib_dir}/jss.rb" 
+    loader.ignore "#{lib_dir}/jss-api.rb" 
+    
+    ##### Callbacks
+
+    # callback for when a specific file/constant loads
+    # duplicate and uncomment this if desired to react to 
+    # specific things loading 
+    #####################################
+    # loader.on_load('Jamf::SomeClass') do |klass, abspath|
+    #   Jamf.load_msg "I just loaded #{klass} from #{abspath}"
+    # end
+
+    # callback for when anything loads
+    #  - const_path is like "Jamf::SomeClass" or "Jamf::SomeClass::SOME_CONST_ARRY"
+    #  - value is the value that constant contains after loading,
+    #    e.g. the class Jamf::SomeClass for 'Jamf::SomeClass' or
+    #    an Array for the constant  "Jamf::SomeClass::SOME_CONST_ARRY"
+    #  - abspath is the full path to the file where the constant was loaded from.
+    #####################################
+    loader.on_load do |const_path, value, abspath|
+      load_msg "Zeitwerk just loaded #{value.class} '#{const_path}' from:\n  #{abspath}"
+
+      # Parse OAPI_PROPERTIES into getters and setters for subclasses of
+      # OAPIObject in the JPAPI.
+      #
+      # The class we just loaded must have this method and constant
+      # and the method must not have run already for the class or any superclass.
+      # This prevents running parse_oapi_properties again in subclasses that
+      # don't need to do that
+      if value.respond_to?(:oapi_properties_parsed?) && \
+         defined?(value::OAPI_PROPERTIES) && \
+         !value.oapi_properties_parsed?
+
+        parsed = value.parse_oapi_properties
+        load_msg "Parsed OAPI_PROPERTIES for #{value}" if parsed
+      end
+
+      # Generate the identifier list methods (.all_*) for subclasses of APIObject
+      # in the Classic API
+      if value.is_a?(Class) && value.superclass == Jamf::APIObject
+
+        done = value.define_identifier_list_methods
+        load_msg "Defined identifier list methods for #{value}" if done
+      end
+    end
+
+    loader.setup
+  end # setup_zeitwerk_loader
+
+  # For testing the Zeitwrk Loader.
+  # Normally we want autoloading on demand,
+  # eager loading loads everything so we can see it
+  #
+  # To make this happen touch the file defined in EAGER_LOAD_FILE
+  def self.eager_load_for_testing
+    return unless EAGER_LOAD_FILE.file?
+
+    loader.eager_load(force: true)
+    warn :loaded
+    # rescue Zeitwerk::NameError => e
+    #   warn e.message
+  end
+
+end # module JamfZeitwerkConfig

data/lib/jamf.rb

@@ -54,49 +54,20 @@ require 'jamf/exceptions'
 require 'jamf/db_connection'
 
 # Configure the Zeitwerk loader, See https://github.com/fxn/zeitwerk
-require 'zeitwerk'
-require 'zeitwerk_config'
-
-# touch this file to make zeitwerk and mixins send text to stderr as things load
-# or get mixed in
-JAMF_VERBOSE_LOADING_FILE = Pathname.new('/tmp/ruby-jss-verbose-loading')
-
-# Or, set this ENV var to also make zeitverk and mixins send text to stderr
-JAMF_VERBOSE_LOADING_ENV = 'RUBY_JSS_VERBOSE_LOADING'.freeze
-
-# touch this file to make zeitwek  eager-load everything when the gem is required.
-JAMF_ZEITWERK_EAGER_LOAD_FILE = Pathname.new('/tmp/ruby-jss-zeitwerk-eager-load')
+require 'jamf/zeitwerk_config'
 
 # the `Zeitwerk::Loader.for_gem` creates the loader object, and must
 # happen in this file, so we pass it into a method defined in
 # zeitwerk_config
-setup_zeitwerk_loader Zeitwerk::Loader.for_gem
+JamfZeitwerkConfig.setup_zeitwerk_loader Zeitwerk::Loader.for_gem
 
 # Jamf, A Ruby module for interacting with the JAMF Pro Server via both of its REST APIs
 module Jamf
 
-  def self.validate_ruby_version
-    return if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new(MINIMUM_RUBY_VERSION)
-
-    raise "Can't use ruby-jss #{Jamf::VERSION}, ruby itself must be version #{MINIMUM_RUBY_VERSION} or greater, this is ruby #{RUBY_VERSION}."
-  end
-
-  # Only look at the filesystem once.
-  def self.verbose_loading?
-    return @verbose_loading unless @verbose_loading.nil?
-
-    @verbose_loading = JAMF_VERBOSE_LOADING_FILE.file?
-    @verbose_loading ||= ENV.include? JAMF_VERBOSE_LOADING_ENV
-    @verbose_loading
-  end
-
-  # rubocop: disable Style/StderrPuts
+  # Use the load_msg method defined for Zeitwerk
   def self.load_msg(msg)
-    return unless verbose_loading?
-
-    $stderr.puts msg
-  end
-  # rubocop: enable Style/StderrPuts
+    JamfZeitwerkConfig.load_msg msg
+  end  
 
   # the single instance of our configuration object
   def self.config
@@ -113,11 +84,8 @@ module Jamf
 
 end # module Jamf
 
-# make sure we can run
-Jamf.validate_ruby_version
-
 # JSS module is now a synonym for Jamf module
 JSS = Jamf
 
-# testing zeitwerk loading
-eager_load_for_testing if JAMF_ZEITWERK_EAGER_LOAD_FILE.file?
+# testing zeitwerk loading, the the desired file is present
+JamfZeitwerkConfig.eager_load_for_testing 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-jss
 version: !ruby/object:Gem::Version
-  version: 2.0.0b3
+  version: 2.0.0b5
 platform: ruby
 authors:
 - Chris Lasell
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-31 00:00:00.000000000 Z
+date: 2022-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: CFPropertyList
@@ -149,7 +149,7 @@ description: |
   'Jamf Pro' API. Jamf Pro objects are implemented as classes and can interact
   with each other. Authentication tokens, data transfer using JSON or XML and other
   details are handled automatically under the hood to allow simpler, intuitive
-  automation of Jamf-related Tasks.
+  automation of Jamf-related tasks.
 email: ruby-jss@pixar.com
 executables:
 - cgrouper
@@ -775,10 +775,10 @@ files:
 - lib/jamf/utility.rb
 - lib/jamf/validate.rb
 - lib/jamf/version.rb
+- lib/jamf/zeitwerk_config.rb
 - lib/jss-api.rb
 - lib/jss.rb
 - lib/ruby-jss.rb
-- lib/zeitwerk_config.rb
 - test/README-TEST.md
 - test/bin/runtests
 - test/lib/jamf_test.rb

data/lib/zeitwerk_config.rb

@@ -1,168 +0,0 @@
-# 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
-#    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.
-
-# Configure the Zeitwerk loader, See https://github.com/fxn/zeitwerk
-def setup_zeitwerk_loader(loader)
-  @loader = loader
-
-  # Ignore this file (more ignores below)
-  loader.ignore __FILE__
-
-  # these paths all define classes & modules directly below 'Jamf'
-  # If we didn't collapse them, then e.g.
-  #   /jamf/api/base_classes/classic/group.rb
-  # would be expected to define
-  #   Jamf::Api::BaseClasses::Classic::Group
-  # rather than what we want:
-  #  Jamf::Group
-  ###################################################
-
-  loader.collapse("#{__dir__}/jamf/api")
-
-  loader.collapse("#{__dir__}/jamf/api/classic")
-  loader.collapse("#{__dir__}/jamf/api/classic/api_objects")
-  loader.collapse("#{__dir__}/jamf/api/classic/base_classes")
-
-  loader.collapse("#{__dir__}/jamf/api/jamf_pro")
-  loader.collapse("#{__dir__}/jamf/api/jamf_pro/api_objects")
-  loader.collapse("#{__dir__}/jamf/api/jamf_pro/mixins")
-  loader.collapse("#{__dir__}/jamf/api/jamf_pro/base_classes")
-  loader.collapse("#{__dir__}/jamf/api/jamf_pro/other_classes")
-
-  loader.collapse("#{__dir__}/jamf/deprecations")
-
-  # filenames => Constants, which don't adhere to zeitwerk's parsing standards.
-  #
-  # Mostly because the a filename like 'oapi_object' would be
-  # loaded by zeitwerk expecting it to define 'OapiObject', but it really
-  # defines 'OAPIObject'
-  ###############################################
-
-  # Connections
-  loader.inflector.inflect 'classic_api' => 'ClassicAPI'
-  loader.inflector.inflect 'jamf_pro_api' => 'JamfProAPI'
-  loader.inflector.inflect 'jamf_pro_api_error' => 'JamfProAPIError'
-
-  # API objects, resources, and mixins
-  loader.inflector.inflect 'oapi_schemas' => 'OAPISchemas'
-  loader.inflector.inflect 'oapi_object' => 'OAPIObject'
-  loader.inflector.inflect 'oapi_validate' => 'OAPIValidate'
-
-  loader.inflector.inflect 'jpapi_resource' => 'JPAPIResource'
-
-  loader.inflector.inflect 'api_object' => 'APIObject'
-  loader.inflector.inflect 'xml_workaround' => 'XMLWorkaround'
-  loader.inflector.inflect 'json_object' => 'JSONObject'
-  loader.inflector.inflect 'vppable' => 'VPPable'
-  loader.inflector.inflect 'osx_configuration_profile' => 'OSXConfigurationProfile'
-  loader.inflector.inflect 'jp_extendable' => 'JPExtendable'
-  loader.inflector.inflect 'mdm' => 'MDM'
-  loader.inflector.inflect 'ibeacon' => 'IBeacon'
-  loader.inflector.inflect 'powerbroker_identity_services' => 'PowerBroker'
-  loader.inflector.inflect 'admitmac' => 'ADmitMac'
-  loader.inflector.inflect 'ip_address' => 'IPAddress'
-  loader.inflector.inflect 'netboot_server' => 'NetBootServer'
-  loader.inflector.inflect 'vpp_account' => 'VPPAccount'
-  loader.inflector.inflect 'removable_macaddr' => 'RemovableMacAddress'
-  loader.inflector.inflect 'md_prestage_name' => 'MobileDevicePrestageName'
-  loader.inflector.inflect 'md_prestage_names' => 'MobileDevicePrestageNames'
-  loader.inflector.inflect 'md_prestage_skip_setup_items' => 'MobileDevicePrestageSkipSetupItems'
-  loader.inflector.inflect 'macos_managed_updates' => 'MacOSManagedUpdates'
-
-  # deprecations, separated so they load only when used.
-  # When its time to get rid of them, delete the files from the 
-  # 'deprecations' directory, and the matching line here.
-  loader.inflector.inflect('deprecated_api_constant' => 'API')
-  loader.inflector.inflect('deprecated_config_constant' => 'CONFIG')
-  loader.inflector.inflect('deprecated_api_connection_class' => 'APIConnection')
-
-  # These should be ignored, some will be required directly
-  #####################################
-
-  loader.ignore "#{__dir__}/jamf/db_connection.rb"
-  loader.ignore "#{__dir__}/jamf/ruby_extensions.rb"
-  loader.ignore "#{__dir__}/jamf/ruby_extensions"
-  loader.ignore "#{__dir__}/jamf/exceptions.rb"
-  loader.ignore "#{__dir__}/jss-api.rb"
-  loader.ignore "#{__dir__}/jss.rb"
-  loader.ignore "#{__dir__}/ruby-jss.rb"
-
-  # callback for when a specific file/constant loads
-  # duplicate and uncomment this if desired to react to 
-  # specific things loading 
-  #####################################
-  # loader.on_load('Jamf::SomeClass') do |klass, abspath|
-  #   Jamf.load_msg "I just loaded #{klass} from #{abspath}"
-  # end
-
-  # callback for when anything loads
-  #  - const_path is like "Jamf::SomeClass" or "Jamf::SomeClass::SOME_CONST_ARRY"
-  #  - value is the value that constant contains after loading,
-  #    e.g. the class Jamf::SomeClass for 'Jamf::SomeClass' or
-  #    an Array for the constant  "Jamf::SomeClass::SOME_CONST_ARRY"
-  #  - abspath is the full path to the file where the constant was loaded from.
-  #####################################
-  loader.on_load do |const_path, value, abspath|
-    Jamf.load_msg "Zeitwerk just loaded #{value.class} '#{const_path}' from:\n  #{abspath}"
-
-    # Parse OAPI_PROPERTIES into getters and setters for subclasses of
-    # OAPIObject in the JPAPI.
-    #
-    # The class we just loaded must have this method and constant
-    # and the method must not have run already for the class or any superclass.
-    # This prevents running parse_oapi_properties again in subclasses that
-    # don't need to do that
-    if value.respond_to?(:oapi_properties_parsed?) && \
-       defined?(value::OAPI_PROPERTIES) && \
-       !value.oapi_properties_parsed?
-
-      parsed = value.parse_oapi_properties
-      Jamf.load_msg "Parsed OAPI_PROPERTIES for #{value}" if parsed
-    end
-
-    # Generate the identifier list methods (.all_*) for subclasses of APIObject
-    # in the Classic API
-    if value.is_a?(Class) && value.superclass == Jamf::APIObject
-
-      done = value.define_identifier_list_methods
-      Jamf.load_msg "Defined identifier list methods for #{value}" if done
-    end
-  end
-
-  loader.setup
-end # setup_zeitwerk_loader
-
-# For testing the Zeitwrk Loader.
-# Normally we want autoloading on demand,
-# eager loading loads everything so we can see it
-#
-# To make this happen touch the file defined in JAMF_ZEITWERK_EAGER_LOAD_FILE
-# in jamf.rb
-def eager_load_for_testing
-  return unless JAMF_ZEITWERK_EAGER_LOAD_FILE.file?
-
-  @loader.eager_load(force: true)
-  warn :loaded
-  # rescue Zeitwerk::NameError => e
-  #   warn e.message
-end