ruby-jss 1.0.3b2 → 1.0.3b3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35181174316ea72a856198f37dd2b18446f410fd010a35b54493d7f167d0ac56
-  data.tar.gz: 6348822a891239bb3b203b9e836a93ea700d82b8100f2f93cb75a611b4efab9a
+  metadata.gz: e023160e63bd4d2ae22316affa806e28ad38559d17c9cc8e2f6624f8a72e2c09
+  data.tar.gz: 24689091017132fb6a95e5fc6ea6ad36d771d660665df540bd82cd3856f05b3a
 SHA512:
-  metadata.gz: a58f64004baae260d475129a6fc549a17647e5447520785d791c51ef69486b48331b90acf6a22aa5db0e3dfe4cd1aa8716b68dc64dab72a3e3411e3cfd8a38ab
-  data.tar.gz: 0ca90f4abb2c58b5bd528e905ce10de32f668040d657ca1af7b49ac302faccbf6a37740bf3beb9cb262f2db9acc8689319e867d58a5f2a92fb7648efaf08ddf7
+  metadata.gz: 4200856d8cfdfa38e1dd3b6a4a86ea1aef995c9fd72e70bc5bf7205c86e817bc1edc9cc3cb06115b0b34ab5d117e73fac27dbc376152054dd9edb21649696a36
+  data.tar.gz: f9dc27ad6c8398b6743c2ea654331ab8efabf1a5ee22747ac555fc598d0276de955a94edbdc8d29802df68abad706e72902b33b47ba3c14e31f4fbd997bbd976

data/CHANGES.md

@@ -4,7 +4,7 @@ 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).
 
-## [Unreleased]
+## \[Unreleased]
 ### Added
 - LDAPServer.server_for_user and .server_for_group class methods, return the id of the first LDAP server containing the given user or group
 
@@ -37,6 +37,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - use new(er) API resources for LDAP lookups, don't go directly to LDAP via net/ldap
 
+- Scopable::Scope objects now accept any valid identifier, not just names, when adding or removing items from scope.
+  Also, item keys don't need to be plural (e.g. `:network_segment` works as well as `:network_segments`)
+  (Thanks to @cybertunnel for pointing out that this was still not modernized)
+
 ## [1.0.2] - 2018-10-16
 ### Added
 - Support for parentheses (opening_paren and closing_paren) in JSS::Criteriable::Criterion objects

data/README.md

@@ -99,7 +99,7 @@ ns.save
 
 Before you can work with JSS Objects via the API, you have to connect to it.
 
-The method `JSS.api` retruns the currently active connection to the API (an instance of a {JSS::APIConnection}, q.v.).
+The method `JSS.api` returns the currently active connection to the API (an instance of a {JSS::APIConnection}, q.v.).
 
 When the JSS Module is first loaded, that connection object isn't connected to anything. To remedy that, use `JSS.api.connect`, passing it values for the connection. In this example, those values are stored in the local variables jss_user, jss_user_pw, and jss_server_hostname, and others are left as default.
 
@@ -145,7 +145,7 @@ Some Classes provide other ways to list objects, depending on the data available
 
 #### Retrieving Objects
 
-To retrieve a single object call the class's `.fetch` method and provide a name:,  id:, or other valid identfier.
+To retrieve a single object call the class's `.fetch` method and provide a name:,  id:, or other valid identifier.
 
 
 ```ruby
@@ -238,17 +238,24 @@ Here's what we've implemented so far. See each Class's [documentation(http://www
 * {JSS::AdvancedUserSearch}
 * {JSS::Building}
 * {JSS::Category}
+* {JSS::Computer}
 * {JSS::ComputerExtensionAttribute}
 * {JSS::ComputerGroup}
 * {JSS::Department}
 * {JSS::DistributionPoint}
+* {JSS::MobileDevice}
 * {JSS::MobileDeviceApplication}
 * {JSS::MobileDeviceExtensionAttribute}
 * {JSS::MobileDeviceGroup}
 * {JSS::NetworkSegment}
 * {JSS::Package}
+* {JSS::PatchTitle}
+* {JSS::PatchTitle::Version}
+* {JSS::PatchExternalSource}
+* {JSS::PatchPolicy}
 * {JSS::Peripheral}
 * {JSS::PeripheralType}
+* {JSS::Policy} (not fully implemented)
 * {JSS::RemovableMacAddress}
 * {JSS::RestrictedSoftware}
 * {JSS::Script}
@@ -257,19 +264,15 @@ Here's what we've implemented so far. See each Class's [documentation(http://www
 * {JSS::UserExtensionAttribute}
 * {JSS::UserGroup}
 * {JSS::WebHook}
-* {JSS::Computer}
-* {JSS::MobileDevice}
-* {JSS::Policy} (still not fully implemented)
-* {JSS::PatchInternalSource}
-* {JSS::PatchExternalSource}
-* {JSS::PatchTitle}
-* {JSS::PatchPolicy}
+
 
 **NOTE** Computer and Mobile Device data gathered by an Inventory Upate (a.k.a. 'recon') is not editable.
 
 ### Updatable, but must be created in the Web UI
 
 * {JSS::OSXConfigurationProfile}
+* {JSS::MobileDeviceConfigurationProfile}
+* {JSS::PatchInternalSource}
 
 ### Creatable only
 
@@ -288,7 +291,7 @@ These must be created and edited via the JSS WebApp
 
 All supported API Objects can be deleted
 
-Other useful classes & modules:
+#### Other useful classes & modules:
 
 * {JSS::APIConnection} - An object representing the connection to the REST API
 * {JSS::DBConnection} - An object representing the connection to MySQL database, if used.
@@ -298,6 +301,19 @@ Other useful classes & modules:
 * {JSS::Scopable} - a module that handles Scope for those objects that can be scoped. It defines the Scope class used in those objects.
 * {JSS::MDM} - a module that handles sending MDM commands to Computers and Mobile Devices
 
+## Object-related API endpoints
+
+The classic API provides many endpoints not just for objects stored in Jamd Pro, but also for accessing data *about* those  objects or interacting with the machines they represent. Ruby-jss embeds access to those endpoints into their related classes.
+
+For example:
+
+* /computerapplications, /computerapplicationusage, /computerhardwaresoftwarereports, /computerhistory, etc.
+  - The data provided by these endpoints are accessible via class and instance methods for {JSS::Computer}
+* /computercheckin, /computerinventorycollection
+  - These endpoints deal with server-wide settings regarding computer management, and are available via {JSS::Computer} class methods
+* /computercommands, /mobiledevicecommands, /commandflush, etc.
+  - These endpoints provide access to the MDM infrastructure, and can be used to send MDM commands. Ruby-jss provides these as class and instance methods in {JSS::Computer}, {JSS::ComputerGroup}, {JSS::MobileDevice}, and {JSS::MobileDeviceGroup}
+
 ## CONFIGURATION
 
 The {JSS::Configuration} singleton class is used to read, write, and use site-specific defaults for the JSS module. When ruby-jss is required, the single instance of {JSS::Configuration} is created and stored in the constant {JSS::CONFIG}. At that time the system-wide file /etc/ruby-jss.conf is examined if it exists, and the items in it are loaded into the attributes of {JSS::CONFIG}. The user-specific file ~/.ruby-hss.conf then is examined if it exists, and any items defined there will override those values from the system-wide file.
@@ -348,13 +364,13 @@ And here's an example of how to read a password from a web server and use it.
 
 ```ruby
 require 'open-uri'
-password =  open('https://server.org.org/path/to/password').read
+password =  URI.parse('https://server.org.org/path/to/password').read
 JSS.api.connect pw: password   # other arguments used from the config settings
 ```
 
 ## BEYOND THE API
 
-While the Jamf Pro Classic API provides access to object data in the JSS, this gem tries to use that data to provide more than just information exchange. Here are some examples of how we use the API data to provide functionality found in various Casper tools:
+While the Jamf Pro Classic API provides access to object data in the JSS, ruby-jss tries to use that data to provide more than just information exchange. Here are some examples of how ruby-jss use the API to provide functionality found in various Casper tools:
 
 * Client Machine Access
   * The {JSS::Client} module provides the ability to run jamf binary commands, and access the local cache of package receipts
@@ -367,8 +383,6 @@ While the Jamf Pro Classic API provides access to object data in the JSS, this g
   * {JSS::Package} objects can upload their .pkg or .dmg files to the master distribution point ({JSS::Script} objects can also if you store them there.)
 * Reporting/AdvancedSearch exporting
   * {JSS::AdvancedSearch} subclasses can export their results to csv, tab, and xml files.
-* LDAP Access
-  * {JSS::LDAPServer} objects can query the LDAP servers for user, group, and membership data.
 * MDM Commands
   * {JSS::MobileDevice}s (and eventually {JSS::Computer}s) can be sent MDM commands
 * Extension Attributes
@@ -376,7 +390,7 @@ While the Jamf Pro Classic API provides access to object data in the JSS, this g
 
 ## INSTALL
 
-NOTE: You may need to install XCode, and it's CLI tools, in order to install the required gems.
+NOTE: You may need to install XCode, or it's CLI tools, in order to install the required gems.
 
 In general, you can install ruby-jss with this command:
 
@@ -406,7 +420,6 @@ There's a [wiki on the github page](https://github.com/PixarAnimationStudios/rub
 
 ## LICENSE
 
-Copyright 2018 Pixar
+Copyright 2019 Pixar
 
-Licensed under the Apache License, Version 2.0 (the "Apache License") with
-modifications. See LICENSE.txt for details
+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 2018 Pixar
+### Copyright 2019 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")

data/bin/jamfHelperBackgrounder

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

data/bin/netseg-update

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

data/data/ruby-jss.conf.example

@@ -1,3 +1,27 @@
+### Copyright 2019 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.
+###
+
 #####################
 #
 #     ruby-jss configuration.

data/lib/jss-api.rb

@@ -1,2 +1,26 @@
+### Copyright 2019 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.
+###
+
 # backward compatility for 'require "jss-api"'
 require 'jss'

data/lib/jss.rb

@@ -1,4 +1,4 @@
-### Copyright 2018 Pixar
+### Copyright 2019 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -162,7 +162,6 @@ module JSS
   class NetBootServer < JSS::APIObject; end
   class NetworkSegment < JSS::APIObject; end
   class Package < JSS::APIObject; end
-  class Patch < JSS::APIObject; end
   class PatchPolicy < JSS::APIObject; end
   class PeripheralType < JSS::APIObject; end
   class Peripheral < JSS::APIObject; end

data/lib/jss/api_connection.rb

@@ -1,4 +1,4 @@
-### Copyright 2018 Pixar
+### Copyright 2019 Pixar
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
 ###    with the following modification; you may not use this file except in
@@ -439,6 +439,9 @@ module JSS
       args[:no_port_specified] = args[:port].to_s.empty?
       args = apply_connection_defaults args
 
+      # ensure an integer
+      args[:port] &&= args[:port].to_i
+
       # confirm we know basics
       verify_basic_args args
 
@@ -1113,17 +1116,12 @@ module JSS
     # @return [Type] description_of_returned_object
     #
     def verify_ssl(args)
-      # use SSL for those ports unless specifically told not to
+      # use SSL for SSL ports unless specifically told not to
       if SSL_PORTS.include? args[:port]
-        args[:use_ssl] = true if args[:use_ssl].nil?
+        args[:use_ssl] = true unless args[:use_ssl] == false
       end
       # if verify_cert is anything but false, we will verify
-      args[:verify_ssl] =
-        if args[:verify_cert] == false
-          OpenSSL::SSL::VERIFY_NONE
-        else
-          OpenSSL::SSL::VERIFY_PEER
-        end
+      args[:verify_ssl] = args[:verify_cert] == false ? OpenSSL::SSL::VERIFY_NONE : OpenSSL::SSL::VERIFY_PEER
     end
 
     # Parses the HTTP body of a RestClient::ExceptionWithResponse

data/lib/jss/api_object.rb

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

data/lib/jss/api_object/account.rb

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

data/lib/jss/api_object/advanced_search.rb

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

data/lib/jss/api_object/advanced_search/advanced_computer_search.rb

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

data/lib/jss/api_object/advanced_search/advanced_mobile_device_search.rb

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

data/lib/jss/api_object/advanced_search/advanced_user_search.rb

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

data/lib/jss/api_object/building.rb

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

data/lib/jss/api_object/categorizable.rb

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

data/lib/jss/api_object/category.rb

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

data/lib/jss/api_object/computer.rb

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

data/lib/jss/api_object/computer/application_installs.rb

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

data/lib/jss/api_object/computer_invitation.rb

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

data/lib/jss/api_object/configuration_profile.rb

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

data/lib/jss/api_object/configuration_profile/mobile_device_configuration_profile.rb

@@ -1,3 +1,27 @@
+### Copyright 2019 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.
+###
+
 # This is just a stub for now.
 
 #

data/lib/jss/api_object/configuration_profile/osx_configuration_profile.rb

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

data/lib/jss/api_object/creatable.rb

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

data/lib/jss/api_object/criteriable.rb

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