ruby-jss 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c229fe64d5af063db9f075fd9345d34447160817a125fb147f72e4603d56d1c
-  data.tar.gz: a4642b384ae4bd853563928d6c399597404935c5cdce329a3f485e5ad2d92095
+  metadata.gz: 609ac9ae5ba3ddf1c4c8392acda8d1f1f0bba99e119da2781bd1e8d841a294f5
+  data.tar.gz: 28be9609494e02d11e863e5a64d80c82d866650efd599967400e434d157633ba
 SHA512:
-  metadata.gz: dbabf94f300745834e65c574cc1b9918b03540d81f9c54a004803913452147f63e7eb0df20694ea092c05b31c0700144a55df99bc57d4f9fbbaf3c67dab1d034
-  data.tar.gz: 6aa566e804422b49bdcd258ae08386a080a567e14b1cd47e936c8098a307ca6529ec2da4963f6f801d2586a04cd9edb570e6f101e865d19861213b93ea062128
+  metadata.gz: f57b6c5c4b127688a6b9fd190a7927e1d1c6332061d1126b23d03b2d39566898fd5a0876ac73e801f6f9824cb45e149d13d6a4e97154b5c08f199ac593e74cdc
+  data.tar.gz: 1086564724dd9398f1bf540df6a092c90045d9226a78ff1eeade1fc6af4442b566fca2fea896f3e0a25aa62a60d568cc43331c5adb89c5929d53a3bcdf063419

data/CHANGES.md

@@ -4,6 +4,32 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## \[1.5.2] - 2020-12-21
+
+### Added
+
+  - JSS::Policy#flush_logs can now be called as a class method JSS::Policy.flush_logs, passing in the policy names or ids, without instantiating the policy
+
+  - Both the class and instance 'flush_logs' methods for JSS::Policy take a named parameter 'computers:' which is an array of the computer identifiers for which the policy should be flushed.
+
+  - JSS::Computer instances now have a 'flush_policy_logs' method which is a wrapper for calling JSS::Policy.flush_logs for just that computer
+
+  - JSS::ConfigurationProfile: #update/#save now takes boolean param redeploy_to_all: which defaults to false. The default means redeploy only to newly assigned machines in scope. Setting this to true will push the profile out to all machines in scope, even if they already have the profile.
+
+### Changed
+
+  - JSS.expand_min_os, used to expand strings like '>=10.14.5' into comma-separated versions to be used in Package and Script os_limitations, has been updated to handle Big Sur being both 10.16 and 11.0, and for future OSes to be 12.x, 13.x etc.
+  NOTE: If you've used this feature in the past, you might want to look at your package and script seetings and update them, since they will refer to OSes 10.17 and higher.
+
+  - JSS::APIConnection: initialize @object_list_cache as an empty hash. This provides more useful error messages when forgetting to pass non-default connection objects, and the default one is unused.
+
+### Fixed
+
+  - JSS::Scopable::Scope#remove_target and #remove_limitation didn't always remove the item.
+
+  - JSS::Scopable::Scope: when calling the API for any reason, we now pass in the .api connection of the container. Not doing so when using a non-default connection object would cause problems.
+
+
 ## \[1.5.1] - 2020-11-16
 
 IMPORTANT: New minimum require ruby version is 2.3.0

data/lib/jamf.rb

@@ -86,19 +86,14 @@ module Jamf
   # AUTOLOADING
   ##################################
 
-  # Top-level API Abstract Classes
-  autoload :JSONObject, 'jamf/api/abstract_classes/json_object'
-  autoload :Resource, 'jamf/api/abstract_classes/resource'
-  autoload :SingletonResource, 'jamf/api/abstract_classes/singleton_resource'
-  autoload :CollectionResource, 'jamf/api/abstract_classes/collection_resource'
+  # Top-level API Base Classes
+  autoload :JSONObject, 'jamf/api/base_classes/json_object'
+  autoload :Resource, 'jamf/api/base_classes/resource'
+  autoload :SingletonResource, 'jamf/api/base_classes/singleton_resource'
+  autoload :CollectionResource, 'jamf/api/base_classes/collection_resource'
 
-  # Abstract Classes used for JSONObject subclasses
-  autoload :AdvancedSearch, 'jamf/api/abstract_classes/advanced_search'
-  autoload :Prestage, 'jamf/api/abstract_classes/prestage'
-  autoload :PrestageSkipSetupItems, 'jamf/api/abstract_classes/prestage_skip_setup_items'
-
-  # Abstract Classes not used for JSONObject subclasses
-  autoload :GenericReference, 'jamf/api/abstract_classes/generic_reference'
+  # Base Classes used for JSONObject subclasses
+  autoload :Prestage, 'jamf/api/base_classes/prestage'
 
   # MixIn Modules
   autoload :ChangeLog, 'jamf/api/mixins/change_log'
@@ -110,7 +105,7 @@ module Jamf
   autoload :UnCreatable, 'jamf/api/mixins/uncreatable'
   autoload :Immutable, 'jamf/api/mixins/immutable'
   autoload :UnDeletable, 'jamf/api/mixins/undeletable'
-  autoload :Abstract, 'jamf/api/mixins/abstract'
+  autoload :BaseClass, 'jamf/api/mixins/base_class'
   autoload :Pageable, 'jamf/api/mixins/pageable'
   autoload :Filterable, 'jamf/api/mixins/filterable'
   autoload :Sortable, 'jamf/api/mixins/sortable'

data/lib/jamf/api/{abstract_classes → base_classes}/collection_resource.rb

@@ -63,7 +63,7 @@ module Jamf
   #
   class CollectionResource < Jamf::Resource
 
-    extend Jamf::Abstract
+    extend Jamf::BaseClass
     extend Jamf::Pageable
     extend Jamf::Sortable
     extend Jamf::Filterable
@@ -214,7 +214,7 @@ module Jamf
     # @return [Array<Hash, Jamf::CollectionResource>] The objects in the collection
     #
     def self.all(sort: nil, filter: nil, paged: nil, page_size: nil, refresh: false, instantiate: false, cnx: Jamf.cnx)
-      validate_not_abstract
+      stop_if_base_class
 
       # use the cache if not paging, filtering or sorting
       return cached_all(refresh, instantiate, cnx) if !paged && !sort && !filter
@@ -351,7 +351,7 @@ module Jamf
     #   or nil if it doesn't exist
     #
     def self.raw_data(value = nil, cnx: Jamf.cnx, **ident_and_val)
-      validate_not_abstract
+      stop_if_base_class
 
       # given a value with no ident key
       return raw_data_by_value_only(value, cnx: Jamf.cnx) if value
@@ -460,7 +460,8 @@ module Jamf
 
     # Make a new thing to be added to the API
     def self.create(**params)
-      validate_not_abstract
+      stop_if_base_class
+
       raise Jamf::UnsupportedError, "#{self}'s are not currently creatable via the API" unless creatable?
 
       # Which connection to use
@@ -498,7 +499,7 @@ module Jamf
     # @return [CollectionResource] The ruby-instance of a Jamf object
     #
     def self.fetch(random = nil, cnx: Jamf.cnx, **ident_and_val)
-      validate_not_abstract
+      stop_if_base_class
       ident, value = ident_and_val.first
       data =
         if random

data/lib/jamf/api/{abstract_classes → base_classes}/json_object.rb

@@ -40,7 +40,7 @@ module Jamf
   # objects (Hashes) used anywhere in the Jamf Pro API have a matching Class in
   # ruby-jss which is a subclass of Jamf::JSONObject
   #
-  # The Jamf::JSONObject class is abstract, and cannot be instantiated or used
+  # The Jamf::JSONObject class is a base class, and cannot be instantiated or used
   # directly. It merely provides the common functionality needed for dealing
   # with all JSON objects in the API.
   #
@@ -51,7 +51,7 @@ module Jamf
   # you will make a subclass of either Jamf::JSONObject, Jamf::SingletonResource
   # or Jamf::CollectionResource.
   #
-  # Here's the relationship between these abstract classes:
+  # Here's the relationship between these base classes:
   #
   #                      Jamf::JSONObject
   #                         (abstract)
@@ -506,7 +506,7 @@ module Jamf
   #
   class JSONObject
 
-    extend Jamf::Abstract
+    extend Jamf::BaseClass
 
     # Constants
     #####################################
@@ -553,7 +553,7 @@ module Jamf
     # @return [Symbol, nil] The real object model key for the alias
     #
     def self.attr_key_for_alias(als)
-      validate_not_abstract
+      stop_if_base_class
       self::OBJECT_MODEL.each { |k, deets| return k if k == als || deets[:aliases].to_a.include?(als) }
       nil
     end
@@ -771,15 +771,6 @@ module Jamf
     end # create_insert_setters
     private_class_method :create_delete_if_setters
 
-    # Raise an exception if this is an abstract class
-    # Used in class methods that are defined in abstract classes.
-    # Instantiation is already prevented by the Abstract mixin
-    ##############################
-    def self.validate_not_abstract
-      raise Jamf::UnsupportedError, "Unsupported: #{self} is an abstract class, ." if Jamf::Abstract.abstract_classes.include? self
-    end
-    private_class_method :validate_not_abstract
-
     # Used by auto-generated setters and .create to validate new values.
     #
     # returns a valid value or raises an exception
@@ -848,13 +839,6 @@ module Jamf
     end
     private_class_method :validate_attr_value
 
-    # Attributes
-    #####################################
-
-    # @return [Jamf::Connection] the API connection thru which we deal with
-    #   this objcet.
-    attr_reader :cnx
-
     # Constructor
     #####################################
 

data/lib/jamf/api/{abstract_classes → base_classes}/prestage.rb

@@ -33,7 +33,7 @@ module Jamf
   # holding common code.
   class Prestage < Jamf::CollectionResource
 
-    extend Jamf::Abstract
+    extend Jamf::BaseClass
     include Jamf::Lockable
 
     # Constants

data/lib/jamf/api/{abstract_classes → base_classes}/resource.rb

@@ -180,7 +180,7 @@ module Jamf
   #
   class Resource < Jamf::JSONObject
 
-    extend Jamf::Abstract
+    extend Jamf::BaseClass
 
     # Constants
     #####################################
@@ -208,15 +208,19 @@ module Jamf
     # Require use of .fetch or .create, or 'all'
     #
     def self.new(data, cnx: Jamf.cnx)
+      stop_if_base_class
       calling_method = caller_locations(1..1).first.label
       raise Jamf::UnsupportedError, "Use .fetch, .create, or .all(instantiate:true) to instantiate Jamf::Resources" unless NEW_CALLERS.include? calling_method
-
       super
     end
 
     # Attributes
     #####################################
 
+    # @return [Jamf::Connection] the API connection thru which we deal with
+    #   this resource.
+    attr_reader :cnx
+
     # @return [String] the resouce path for this object
     attr_reader :rsrc_path
 

data/lib/jamf/api/{abstract_classes → base_classes}/singleton_resource.rb

@@ -37,7 +37,7 @@ module Jamf
   #
   class SingletonResource < Jamf::Resource
 
-    extend Jamf::Abstract
+    extend Jamf::BaseClass
 
     # Public Class Methods
     #####################################
@@ -56,6 +56,7 @@ module Jamf
     # @return [Jamf::SingletonResource] The ruby-instance of a Jamf resource
     #
     def self.fetch(reload = false, cnx: Jamf.cnx)
+      stop_if_base_class
       cnx.singleton_cache[self] = nil if reload
       cached = cnx.singleton_cache[self]
       return cached if cached
@@ -65,7 +66,7 @@ module Jamf
     end # fetch
 
     def self.flushcache(cnx: Jamf.cnx)
-      validate_not_abstract
+      stop_if_base_class
       cnx.singleton_cache[self] = nil
     end
 

data/lib/jamf/api/json_objects/device_enrollment_sync_status.rb

@@ -42,7 +42,7 @@ module Jamf
       # @!attribute instanceId
       #   @return [Integer]
       instanceId: {
-        class: :integer
+        class: :j_id
       },
 
       # @!attribute timestamp

data/lib/jamf/api/json_objects/md_prestage_name.rb

@@ -45,7 +45,7 @@ module Jamf
 
       # @!attribute isUsed [r]
       #   @return [Boolean]
-      isUsed: {
+      used: {
         class: :boolean
       }
     }.freeze

data/lib/jamf/api/json_objects/md_prestage_names.rb

@@ -64,13 +64,13 @@ module Jamf
 
       # @!attribute isManageNames
       #   @return [Boolean]
-      isManageNames: {
+      manageNames: {
         class: :boolean
       },
 
       # @!attribute isDeviceNamingConfigured
       #   @return [Boolean]
-      isDeviceNamingConfigured: {
+      deviceNamingConfigured: {
         class: :boolean
       }
     }.freeze

data/lib/jamf/api/json_objects/prestage_assignment.rb

@@ -42,8 +42,8 @@ module Jamf
 
       # @!attribute assignmentEpoch
       #   @return [Integer]
-      assignmentEpoch: {
-        class: :integer
+      assignmentDate: {
+        class: Jamf::Timestamp
       },
 
       # @!attribute userAssigned

data/lib/jamf/api/mixins/{abstract.rb → base_class.rb}

@@ -24,35 +24,53 @@
 
 module Jamf
 
-  # This mixin should be extended in abstract class definitions
-  # it will raise an error if those classes are instantiated.
+  # This mixin should be extended in base class definitions
+  # it will raise an error if those classes are instantiated or allocated
   # It also maintains an array of classes that extend themselves this way
-  # and are abstract.
-  module Abstract
+  #
+  module BaseClass
+
+    DEFAULT_ACTION =  'access the API'.freeze
+    ALLOCATION_ACTION = 'be allocated'.freeze
+    INSTANTIATION_ACTION = 'be instantiated'.freeze
 
     # when a class is extended by this module, it
-    # gets added to the array of known abstract classes
+    # gets added to the array of known base classes
     def self.extended(by_class)
-      abstract_classes << by_class
+      base_classes << by_class
     end
 
-    # Classes will be added to this array as they are exteded by Abstract
-    def self.abstract_classes
-      @abstract_classes ||= []
+    # Classes will be added to this array as they are exteded by BaseClass
+    def self.base_classes
+      @base_classes ||= []
     end
 
-    def self.abstract?
-      abstract_classes.include? self
+    # raise an exception if a given class is a base class
+    def self.stop_if_base_class(klass, action = DEFAULT_ACTION)
+      raise Jamf::UnsupportedError, "#{klass} is a base class and cannot #{action}." if base_classes.include? klass
     end
 
-    # when any extended class or subclass of an extended class is instntiated
-    # check that it isn't in the abstract list.
-    def new(*args, &block)
-      raise Jamf::UnsupportedError, "Unsupported: #{self} is an abstract class, cannot be instantiated." if Jamf::Abstract.abstract_classes.include? self
+    def base_class?
+      Jamf::BaseClass.base_classes.include? self
+    end
 
+    # Can't allocate if base class
+    def allocate(*args, &block)
+      stop_if_base_class ALLOCATION_ACTION
       super
     end
 
-  end # module Abstract
+    # Can't instantiate if base_class
+    def new(*args, &block)
+      stop_if_base_class INSTANTIATION_ACTION
+      super
+    end
+
+    # raise an exception if this class is a base class
+    def stop_if_base_class(action = DEFAULT_ACTION)
+      Jamf::BaseClass.stop_if_base_class self, action
+    end
+
+  end # module BaseClass
 
 end # Jamf

data/lib/jamf/api/resources/collection_resources/building.rb

@@ -37,10 +37,6 @@ module Jamf
 
     extend Jamf::BulkDeletable
     include Jamf::ChangeLog
-    # TODO: this prob isn't needed anymore
-    # or should be updated - according to the specs, all
-    # references are just ids - integers-in-strings.
-    include Jamf::Referable
 
     # Constants
     #####################################

data/lib/jamf/api/resources/collection_resources/category.rb

@@ -36,7 +36,6 @@ module Jamf
     #####################################
 
     include Jamf::ChangeLog
-    include Jamf::Referable
 
     # Constants
     #####################################

data/lib/jamf/api/resources/collection_resources/computer_prestage.rb

@@ -48,7 +48,7 @@ module Jamf
       # @!attribute skipSetupItems
       #   @return [Jamf::ComputerPrestageSkipSetupItems]
       skipSetupItems: {
-        class: Jamf::ComputerPrestageSkipSetupItems
+        class: :hash
       },
 
       # @!attribute isInstallProfilesDuringSetup

data/lib/jamf/api/resources/collection_resources/department.rb

@@ -36,7 +36,6 @@ module Jamf
     #####################################
 
     include Jamf::ChangeLog
-    include Jamf::Referable
 
     # Constants
     #####################################
@@ -74,7 +73,6 @@ module Jamf
 
     parse_object_model
 
-
   end # class
 
 end # module

data/lib/jamf/api/resources/collection_resources/mobile_device_prestage.rb

@@ -50,7 +50,7 @@ module Jamf
       # @!attribute skipSetupItems
       #   @return [Jamf::ComputerPrestageSkipSetupItems]
       skipSetupItems: {
-        class: Jamf::MobileDevicePrestageSkipSetupItems
+        class: :hash
       },
 
       # @!attribute allowPairing

data/lib/jamf/version.rb

@@ -27,6 +27,6 @@
 module Jamf
 
   ### The version of the Jamf module
-  VERSION = '0.0.5'.freeze
+  VERSION = '0.0.6a1'.freeze
 
 end # module

data/lib/jss/api_connection.rb

@@ -215,42 +215,6 @@ module JSS
   #   # the variable 'prod2_victim_md' now contains a JSS::MobileDevice queried
   #   # through the connection 'production_api2'.
   #
-  # == Using the APIConnection itself to make API calls.
-  #
-  # Rather than passing an APIConnection into another method, you can call
-  # similar methods on the connection itself. For example, these two calls
-  # have the same result as the two examples above:
-  #
-  #   prod2_computer_sns = production_api2.all :Computer, only: :serial_numbers
-  #   prod2_victim_md = production_api2.fetch :MobileDevice, id: 832
-  #
-  # Here are the API calls you can make directly from an APIConnection object.
-  # They behave practically identically to the same methods in the APIObject
-  # subclasses, since they just call those methods, passing themselves in as the
-  # APIConnection to use.
-  #
-  # - {#all}  The 'list' methods of the various APIObject classes. Use the 'only:'
-  #   parameter to specify one of the sub-list-methods, like #all_ids or
-  #   #all_laptops, e.g. `my_connection.all :computers, only: :id`
-  # - {#map_all_ids} the equivalent of #map_all_ids_to in the APIObject classes
-  # - {#valid_id} given a class and an identifier (like macaddress or udid)
-  #   return a valid id or nil
-  # - {#exist?} given a class and an identifier (like macaddress or udid) does
-  #   the identifier exist for the class in the JSS
-  # - {#match} list items in the JSS matching a query
-  #   (if the object is {Matchable})
-  # - {#fetch} retrieve an object from the JSS
-  # - {#make} instantiate an object to be created in the JSS
-  # - {#computer_checkin_settings} same as {Computer.checkin_settings}
-  # - {#computer_inventory_collection_settings} same as {Computer.inventory_collection_settings}
-  # - {#computer_application_usage} same as {Computer.application_usage}
-  # - {#computer_management_data} same as {Computer.management_data}
-  # - {#master_distribution_point} same as {DistributionPoint.master_distribution_point}
-  # - {#my_distribution_point} same as {DistributionPoint.my_distribution_point}
-  # - {#network_ranges} same as {NetworkSegment.network_ranges}
-  # - {#network_segments_for_ip} same as {NetworkSegment.segments_for_ip}
-  # - {#my_network_segments} same as {NetworkSegment.my_network_segments}
-  #
   # == Low-level use of APIConnection instances.
   #
   # For most cases, using APIConnection instances as mentioned above
@@ -422,6 +386,7 @@ module JSS
       @name = args.delete :name
       @name ||= :unknown
       @connected = false
+      @object_list_cache = {}
       connect args unless args.empty?
     end # init