ruby-jss 1.2.6 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46f6f03d9aa4d1ddbbabc446004921fd6efa14fb36dcd30ae30dd968bae11357
-  data.tar.gz: 70d78adc1afe510511e5b678d1e852c1e9f518e9afd1e4109938696ddf3cd1f2
+  metadata.gz: ef0484427943d39089bb11eb73af827c5137d79550c34ea5fdf7ca683c7c69f0
+  data.tar.gz: '09abd63abb133ee6c34aa2fcb9ae8ccc3e11b3248061ee410223bd8f25f5a7ae'
 SHA512:
-  metadata.gz: f631eade4108e9cd51022f417e775347bf1bd4467ab7567c5872d168d34f51908f80d164824571ead6e61ee8c4b8a9b5883db7537da0de66e7f6bc4298d2d4bc
-  data.tar.gz: d9d30e07a70cffa64f11facc41d4720f28a5ab081bf40af9bc3845fb7ed4e809e453ec1b4bad213e671a27191d3a5898c8b3861a6a98c102e80d9223a51df3de
+  metadata.gz: 962236f6ca861fbfa3f706df0d8d977f15fb1436238f7d9c061ae8043c4148b956fc187a9858f9444b8461cc7d707067278e6a9030c676af26febdc565b0cd0f
+  data.tar.gz: 7f7027d207de8ea3fd3d1c010483a9e261d4962857ec48ac6f4df0ba4d38526720ff3700078900e1df2182f191a0aaf7c3284ef3438714e1fbc9118f3aeb03ca

data/CHANGES.md

@@ -4,13 +4,200 @@ 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.4.1] - 2020-10-01
+
+### Added
+
+  - Support for JP API connections to https://tryitout.jamfcloud.com/, the open API test server provided by Jamf. It uses internal tokens, so the /auth endpoint is disabled. Now as with the Classic API, `Jamf::Connection.connect`  will accpt any name & password when connecting to that host.
+
+## \[1.4.0] - 2020-09-14
+
+### Added
+
+  - Class JSS::VPPAccount, implementing the 'vppacconts' endpoint.
+
+  - Constant JSS::APP_STORE_COUNTRY_CODES, a Hash with keys being the official country names used by the App Store, and values being the two-letter codes for those names. This static Hash is derived from a Jamf Pro API end point, and will be updated as needed. These codes are used by JSS::VPPAccount
+
+  - Module Method JSS.country_code_match(str) whic allows you to filter the JSS::APP_STORE_COUNTRY_CODES Hash to only those key-value pairs that include the given string.
+
+  - Mixin Class Method VPPable.all_vpp_device_assignable, returns a Hash of Hashes showing the total, used, and remaining licenses for all members of the target class that are VPP-assignable by device.
+
+  - Scopable::Scope#in_scope?(machine) Given a JSS::Computer or MobileDevice, or an identifier for one, it is in the scope? WARNING: For scopes that include Jamf Users or User Groups as targets or exclusions, this method may return an incorrect value. See the discussion in the comments/documentation for the Scopable::Scope class under `IMPORTANT - Users & User Groups in Targets and Exclusions`
+
+  - Scopable::Scope#scoped_machines returns a Hash of ids=>names for all machines in this scope. WARNING:  This must instantiate all machines in the target class. It will still be slow, at least the first time for each target class. On the upside, the instantiated machines will be cached, so generating this list for other scopes with the same target class will be much much faster. In tests, with 1600 Computers in the JSS, it took about 7 minutes the first time, but less than 1 second after caching.
+  See also the warning for #in_scope? above, which applies here as well.
+
+  - JSS::Policy objects support 'Policy Retry' via the getter/setter methods #retry_event, #retry_attempts, and #notify_failed_retries. You can only set these values if the #frequency is :once_per_computer. To turn off policy-retry, either set the retry_event to :none, or set the retry_attempts to 0
+
+### Changed
+
+  - Prettier XML for JSS::APIObject#ppx
+
+  - Improved JSS::Validate.boolean. Accepts: true, false, 'true', 'false', 'yes', 'no', 't','f', 'y', or 'n' as Strings or Symbols, case insensitive
+
+  - The JSS::MacApplication class is more fully implemented
+
+  - JSS::Scopable::Scope now uses the word 'targets' consistently to match the UI's 'Targets' tab.  The previous word 'inclusions' still works as before.
+
+  - When using the Jamf module to access the Jamf Pro API, the minumum JamfPro version is now 10.23.0. WARNING: Like the Jamf Pro API itself, the Jamf module that accesses it is in beta and may have breaking changes at any time.
+
+### Fixed
+
+  - JSS::ExtensionAttribute: when used as a display field in an AdvancedSearch, the name of the EA in the search result Hash comes from the API as a String (turned into a Symbol) that is the EA name with colons removed and spaces & dashes turned to underscores. Previously ruby-jss didn't remove the colons
+
+  - Used an XML workaround for the common classic API bug where an XML array comes as a single-item JSON hash. This time in the JSS::User class's user_groups method.
+
+  - The Jamf Pro API endpoints for /v1/device-enrollment changed to /v1/device-enrollments and /v1/device-enrollment/sync/<id> changed to /v1/device-enrollments/<id>/syncs.  /v1/devive-enrollments/syncs.
+
+  - The Jamf Pro API endpoint for bulk-deleting Departments changed from 'delete-departments' to 'delete-multiple'
+
+## \[1.3.3] - 2020-08-07
+
+### Fixed
+  - Regression where JSS::Package#required_processor= wouldn't take 'x86'
+
+## \[1.3.2] - 2020-07-31
+Many thanks to @cybertunnel for adding a huge amount of code to get JSS::Policy fully implimented, as well as other fixes and updates!
+
+### Added
+  - new class JSS::DockItem
+  - new classes JSS::DirectoryBinding and JSS::DirectoryBindingType
+  - new class JSS::Printer
+  - new class JSS::DiskEncryptionConfiguration
+  - JSS::Policy:
+    - getters and setters for `#user_message_start` and `#user_message_end`
+    - `#set_management_account` and `#verify_management_password`
+    - `#add_dock_item` and `#remove_dock_item`
+    - `#directory_bindings`, `#add_directory_binding` and `#remove_directory_binding`
+    - `#add_printer` and `#remove_printer`
+    - `#reissue_key`, `#apply_encryption_configuration`, and `#remove_encryption_configuration`
+
+
+### Changed
+  - JSS::Package:
+    - no longer issues a warning when changing the file_name of a package
+    - Updated the CPU type string from 'x86' to 'Intel/x86'
+    - Methods which used to always use the master distribution point now accept a parameter `dist_point: dp` where dp is the name or id of a fileshare distribution point. If not specified, it still defaults to the Master Distribution Point.  This is needed because if the Cloud Distribution Point is the master, there is no access to it via the Classic API, and any use of DistributionPoint.master_distribution_point will raise an error.
+
+## \[1.3.1] - 2020-06-21
+
+### Changed
+
+  - JSS::MobileDeviceApplication when using PrettyPrint (pp) in irb, no longer shows the base64 data for the ipa file.
+
+  - JSS::DistributionPoint.my_distribution_point and .master_distribution_point now have options for dealing with the Cloud Distribution Point (which is not available in the classic API) being the master.
+
+### Fixed
+
+  - JSS::NetworkSegment.distribution_point=  now takes nil or an empty string to unset the dist point.
+
+## \[1.3.0] - 2020-06-05
+
+### Added
+
+  - JSS::NetworkSegment.network_ranges_as_integers method, Similar to NetworkSegment.network_ranges, but the ranges are of Integers, not IPAddr instances. This makes for *MUCH* faster range calculations, needed to implement improvements to NetworkSegment.network_segment_for_ip
+
+  - JSS::Package.all_filenames_by, returns a Hash of all distribution point filenames for all packages, keyed by either the package id, or the package name. NOTE: as with JSS::Package.all_filenames, this method must instantiate all JSS::Package objects, so it will be slow.
+
+### Changed
+
+  - JSS.expand_min_os now expands to macOS 10.30.x, which should hold us for a while
+
+  - JSS::NetworkSegment.network_segment_for_ip and .my_network_segment are no longer deprecated, but now return an integer NetSeg id (or nil). The plural forms of those methods still return an Array of ids for all the matching network segments.
+
+  - The logic for JSS::NetworkSegment.network_segment_for_ip (and .my_network_segment) now matches how the Jamf server does it:  when you IP address is in more than one Network Segment, Jamf uses the smallest/narrowest one (the one containing fewest IP addresses). If more than one of your Network Segments are that same width, the one with the lowest starting IP address is used.
+
+  - In some networking situations (e.g. Split-tunnel VPN with multiple active network ports) the JSS::APIObject.delete method will raise a 404 NotFound error, seemingly because the object was already deleted but a second http DELETE is sent (I think). We now just rescue and ignore that error, since the fact that it's not found means it was indeed deleted.
+
+### Fixed
+
+  - A copy/paste bug in Jamf::Prestage.serials_for_prestage
+
+## \[1.2.15] - 2020-04-30
+
+### Fixed
+
+  - USER_CONF_FILE is always a pathname, never nil
+
+  - issues with Array#j_ci_* methods related to removing safe navigation
+
+## \[1.2.13] - 2020-04-29
+
+### Fixed
+
+  - Ruby 2.6 needs parens in more places than 2.3, apparently
+
+## \[1.2.12] - 2020-04-29
+
+### Added
+
+  - Backport of `#dig` for Arrays, Hashes and OpenStructs, for compatibiliy with older rubiesd (for a while longer anyway). Gratefully borrowed from https://github.com/Invoca/ruby_dig
+
+### Changed
+
+  - Removed all safe navigation operators (`&.`) for compatibility with older rubies (for a while longer anyway)
+
+
+## \[1.2.11] - 2020-04-26
+
+### Fixed
+
+  - Bug in Package#install that prevented installs from 'alt_download_url'.
+
+## \[1.2.10] - 2020-04-25
+
+### Added
+
+  - Computer#reported_ip_address. This value is collected in newer versions of Jamf Pro. While the #ip_address is the client's IP address from the Jamf Server's perspective, the #reported_ip_address is the IP from the client's perspective, which may be different on a NATted network like a home network.
+
+### Fixed
+
+  - MobileDevice#upload now works like Computer#upload
+
+### Changed
+
+  - Validation of Ext. Attribute values is improved, namely for EAs with integer values, integer-strings like "12" are accepted and converted to real integers as needed.
+
+## \[1.2.9] - 2020-04-13
+
+### Fixed
+
+  - Fixed a bug where passing a frozen string into some setters, e.g. `JSS::Computer.asset_tag=`, would cause an error when it tried to `#strip!` the string.
+
+## \[1.2.8] - 2020-04-12
+
+### Added
+
+  - MobileDevice#update now takes the `no_mdm_rename:` boolean parameter. Prevents an MDM rename command being sent when changing the name of a supervised device with enforced names. Useful when the MDM command fails, as when there's already a pending rename command.
+
+  - `String#jss_float?` and `String#j_float?` predicate methods.
+
+### Changed
+
+  - Jamf Pro API endpoints that have paging options have an undocumented max page size of 2000. The `CollectionResource#all*` methods now account for this.
+
+  - `String#jss_integer?` and `String#j_integer?` now recognize negative integers
+
+  - Ext. Attributes defined to have interger values will now accept integer strings, e.g. `'12345'`  as well as integers e.g. `12345`
+
+  - Ext. Attributes defined to have date values will once again accept blanks (i.e. empty strings)
+
+## \[1.2.7] - 2020-04-01
+
+### Changed
+
+  - Jamf Pro API endpoints that have paging options have an undocumented max page size of 2000. The `CollectionResource#all*` methods now account for this.
+
+
 ## \[1.2.6] - 2020-04-01
 
 ### Fixed
 
 - Classic API (JSS module)
   - Sitable objects now recognize the string "None" as meaning no site is assigned. Thanks @cybertunnel for this fix!
+
   - Scopable::Scope now deals with some bugs in the API regarding Jamf & LDAP users & user groups in targets, limitations, & exclusions. Please see the documentation/comments for the class in the file or the online documentation. Thanks @cybertunnel again!
+
   - Criteriable::Criteria can now be empty - containing no criterion objects. When criteriable objects are created (such as Advanced Searches) the default JSS::Criteriable::Criteria object has no criteria.  To remove all criteria, use `criteria.clear`, `criteria = nil`, or `criteria = JSS::Criteriable::Criteria.new` and then save. Once again, thanks to @cybertunnel for finding this.
 
 - Jamf Pro API (Jamf module)
@@ -54,7 +241,8 @@ Note that the `last_inventory_update` value does NOT indicate such communication
 
 - All APIObject Subclasses (Policy, Computer, MobileDevice, ComputerGroup, etc..) now have `get_raw`, `post_raw` & `put_raw` class methods, which are simpler wrappers for APIConnection#get_rsrc, #post_rsrc, and #put_rsrc.
   - `get_raw`  takes an object's id, and returns the 'raw' JSON (parsed into a ruby Hash with symbolized keys) or a REXML::Document (from which you'll probably want to use the `root` element). If you pass `as_string: true` you'll get the un-parsed JSON or XML string directly from the API
-  This can be useful when you need to retrieve the full object, to get some data not available in the summary-list, but instantiating the full ruby class is too slow.
+  This can be useful when you need to retrieve the full object, to get some data not available in the summary-list, but instantiating the full ruby class is too slow
+
   - `post_raw` & `put_raw` can send raw XML to the API without instantiating objects. In some cases, where you're making simple changes to simple XML, this can be faster than fetching a full instance and the re-saving it.
   WARNING You must create or acquire the XML to be sent, and no validation will be performed on it. It must be a String of XML, or something that returns such a string with #to_s, such as a REXML::Document, or a REXML::Element.
 

data/README.md

@@ -419,6 +419,6 @@ There's a [wiki on the github page](https://github.com/PixarAnimationStudios/rub
 
 ## LICENSE
 
-Copyright 2019 Pixar
+Copyright 2020 Pixar
 
 Licensed under the Apache License, Version 2.0 (the "Apache License") with modifications. See LICENSE.txt for details

data/bin/cgrouper

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby
 
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/bin/jamfHelperBackgrounder

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby
 
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/bin/netseg-update

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby
 
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/data/ruby-jss.conf.example

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jamf.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jamf/api/abstract_classes/advanced_search.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jamf/api/abstract_classes/collection_resource.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -106,13 +106,21 @@ module Jamf
         return cnx.collection_cache[self].map { |m| new m }
       end
 
-      raw = cnx.get rsrc_path
-      cnx.collection_cache[self] =
-        if raw.is_a?(Hash) && raw[:results]
-          raw[:results]
-        else
-          raw
-        end
+      # TODO:  make sure all collection resources use this format
+      # for paging. Also -ask Jamf about a  url that returns
+      # ALL objects in one query, regardless of number.
+      page = 0
+      raw = cnx.get "#{rsrc_path}?page=#{page}&size=1000000&sort=id%3Aasc"
+      results = raw[:results]
+
+      until results.size >= raw[:totalCount]
+        page += 1
+        raw = cnx.get "#{rsrc_path}?page=#{page}&size=1000000&sort=id%3Aasc"
+        results += raw[:results]
+      end
+
+
+      cnx.collection_cache[self] = results
 
       return cnx.collection_cache[self] unless instantiate
 
@@ -220,7 +228,7 @@ module Jamf
       val_is_str = value.is_a? String
 
       idents.each do |ident|
-        match = all(refresh: refresh, cnx: cnx).select do |m|
+        match = all(refresh, cnx: cnx).select do |m|
           val_is_str ? m[ident].to_s.casecmp?(value) : m[ident] == value
         end.first
         return match[:id] if match

data/lib/jamf/api/abstract_classes/generic_reference.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jamf/api/abstract_classes/json_object.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -524,7 +524,7 @@ module Jamf
     #
     def self.attr_key_for_alias(als)
       validate_not_abstract
-      self::OBJECT_MODEL.each { |k, deets| return k if k == als || deets[:aliases]&.include?(als) }
+      self::OBJECT_MODEL.each { |k, deets| return k if k == als || deets[:aliases].to_a.include?(als) }
       nil
     end
 

data/lib/jamf/api/abstract_classes/prestage.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -235,7 +235,7 @@ module Jamf
     #
     def self.serials_for_prestage(prestage_ident, refresh = false, cnx: Jamf.cnx)
       id = valid_id prestage_ident, cnx: cnx
-      raise Jamf::NoSuchItemError, "No #{self} matching '#{ident}'" unless id
+      raise Jamf::NoSuchItemError, "No #{self} matching '#{prestage_ident}'" unless id
 
       serials_by_prestage_id(refresh, cnx: cnx).select { |_sn, psid| id == psid }.keys
     end

data/lib/jamf/api/abstract_classes/prestage_skip_setup_items.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jamf/api/abstract_classes/resource.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jamf/api/abstract_classes/singleton_resource.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jamf/api/attribute_classes/ip_address.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jamf/api/attribute_classes/timestamp.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jamf/api/connection.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -48,7 +48,7 @@ module Jamf
     RSRC_BASE = 'uapi'.freeze
 
     # The API version must be this or higher
-    MIN_JAMF_VERSION = Gem::Version.new('10.15.0')
+    MIN_JAMF_VERSION = Gem::Version.new('10.23.0')
 
     HTTPS_SCHEME = 'https'.freeze
 
@@ -454,7 +454,9 @@ module Jamf
 
     # Are we keeping the connection alive?
     def keep_alive?
-      @keep_alive_thread&.alive? || false
+      return false unless @keep_alive_thread
+
+      @keep_alive_thread.alive?
     end
 
     # @return [Jamf::Timestamp, nil]
@@ -806,7 +808,9 @@ module Jamf
     # @return [void]
     #
     def stop_keep_alive
-      @keep_alive_thread&.kill
+      return unless @keep_alive_thread
+
+      @keep_alive_thread.kill if @keep_alive_thread.alive?
       @keep_alive_thread = nil
     end
 
@@ -853,7 +857,7 @@ module Jamf
   end
 
   def self.disconnect
-    @active_connection&.disconnect
+    @active_connection.disconnect if @active_connection
   end
 
 end # module Jamf

data/lib/jamf/api/connection/api_error.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/lib/jamf/api/connection/api_error_styleguide.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")