ruby-jss 3.0.0b1 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGES.md +3 -2
- data/README.md +14 -23
- data/lib/jamf/api/jamf_pro/mixins/macos_managed_updates.rb +1 -2
- data/lib/jamf/version.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ed31b6de65dd9f753522997db8bee3030036d7b7f3064c9a1586ecda06c2e593
|
4
|
+
data.tar.gz: 7c6e77eb322d52934729b7f5a26283a46921f0b52c8f6046d8bee57f0dd8cc5b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 82fbcfb1a88e333ed07d04e37878ec3f9c4fa9c5aa6705a5860285222e52d9b9adeb5ad329520868ce223e68338eac576888eb387774abe4b066804ee9c5b921
|
7
|
+
data.tar.gz: 65095fd093104fd752a9c4294ff1cd0e41e570f9b928a1c8497cada0c56b2990a87f432f84f6a4332d400e3ac90cbd4852776d0ba9e9a85198580816e5dac731
|
data/CHANGES.md
CHANGED
@@ -16,7 +16,8 @@ Many many thanks to actae0n of Blacksun Hackers Club for reporting this issue an
|
|
16
16
|
|
17
17
|
--------
|
18
18
|
|
19
|
-
## \[
|
19
|
+
## \[3.0.0] - 2023-05-22
|
20
|
+
Major version bump because changes to policy log flushing are not backward compatible.
|
20
21
|
|
21
22
|
### Added
|
22
23
|
- Jamf::Policy.flush_logs_for_computers: formerly private class method, now public and used for flushing policy logs for specific computers.
|
@@ -29,7 +30,7 @@ Many many thanks to actae0n of Blacksun Hackers Club for reporting this issue an
|
|
29
30
|
- A validation method wasn't passing cnx param correctly.
|
30
31
|
|
31
32
|
### Changed
|
32
|
-
- MacOSManagedUpdates.send_managed_os_update takes symbols as the updateAction
|
33
|
+
- MacOSManagedUpdates.send_managed_os_update takes symbols or strings as the updateAction, a key or a value from the UPDATE_ACTIONS constant
|
33
34
|
|
34
35
|
## \[2.1.1] - 2022-11-07
|
35
36
|
|
data/README.md
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
Version 2.0.0 has major changes! While we've strived for _mostly_ being backward compatible, and have done lots of testing, YMMV. Please report any issues.
|
7
7
|
|
8
8
|
_NOTE_: ruby-jss 2.0 is not completely backward compatible, please see [README-2.0.0.md](README-2.0.0.md) for more info
|
9
|
-
|
9
|
+
|
10
10
|
### Highlights
|
11
11
|
|
12
12
|
- Support for Ruby 3.x
|
@@ -57,7 +57,6 @@ Many many thanks to actae0n of Blacksun Hackers Club for reporting this issue an
|
|
57
57
|
- [BEYOND THE API](#beyond-the-api)
|
58
58
|
- [INSTALL](#install)
|
59
59
|
- [REQUIREMENTS](#requirements)
|
60
|
-
- [Contact](#contact)
|
61
60
|
- [HELP & CONTACT INFO](#help--contact-info)
|
62
61
|
- [LICENSE](#license)
|
63
62
|
|
@@ -65,13 +64,13 @@ Many many thanks to actae0n of Blacksun Hackers Club for reporting this issue an
|
|
65
64
|
|
66
65
|
## DESCRIPTION
|
67
66
|
|
68
|
-
ruby-jss defines a Ruby module called `Jamf`, which is used for accessing the 'Classic' and
|
67
|
+
ruby-jss defines a Ruby module called `Jamf`, which is used for accessing the 'Classic' and
|
69
68
|
'Jamf Pro' APIs of a Jamf Pro server. Jamf Pro is an enterprise-level management tool for Apple
|
70
69
|
devices from [Jamf.com](http://www.jamf.com/). It is available as a[ruby gem](https://rubygems.org/gems/ruby-jss), and the
|
71
70
|
[source is on github](https://github.com/PixarAnimationStudios/ruby-jss).
|
72
71
|
|
73
72
|
The Jamf module maintains connections to both APIs simultaneously, and uses which ever is appropriate as needed.
|
74
|
-
Details like authentication tokens, token refreshing, JSON and XML parsing, and even knowing which resources use
|
73
|
+
Details like authentication tokens, token refreshing, JSON and XML parsing, and even knowing which resources use
|
75
74
|
which API are all handled under-the-hood.
|
76
75
|
|
77
76
|
The Jamf module abstracts many API resources as Ruby objects, and provides methods for interacting with those
|
@@ -79,8 +78,8 @@ resources. It also provides some features that aren't a part of the API itself,
|
|
79
78
|
Jamf-related tools, such as uploading {Jamf::Package} files to the master distribution
|
80
79
|
point, and the installation of those objects on client machines. (See [BEYOND THE API](#beyond-the-api))
|
81
80
|
|
82
|
-
The Jamf module is not a complete implementation of the Jamf Pro APIs. Only some objects are modeled,
|
83
|
-
some only minimally. Of those, some are read-only, some partially writable, some fully read-write.
|
81
|
+
The Jamf module is not a complete implementation of the Jamf Pro APIs. Only some objects are modeled,
|
82
|
+
some only minimally. Of those, some are read-only, some partially writable, some fully read-write.
|
84
83
|
We've implemented the things we need in our environment, and as our needs grow, we'll add more.
|
85
84
|
Hopefully others will find it useful, and add more to it as well.
|
86
85
|
|
@@ -138,14 +137,14 @@ ns.save
|
|
138
137
|
|
139
138
|
Before you can work with Jamf Pros Objects via the APIs, you have to connect to the server.
|
140
139
|
|
141
|
-
The method `Jamf.cnx` returns the 'default' connection object (an instance of a {Jamf::APIConnection}, q.v.).
|
140
|
+
The method `Jamf.cnx` returns the 'default' connection object (an instance of a {Jamf::APIConnection}, q.v.).
|
142
141
|
A connection object holds all the data needed to communicate with the server to which it's connected, as well as
|
143
|
-
any data cached from that server.
|
142
|
+
any data cached from that server.
|
144
143
|
The default connection object is used for all communication unless a different one is explicitly passed to methods
|
145
144
|
that can accept one. See 'Using multiple connections' below.
|
146
145
|
|
147
146
|
When the Jamf Module is first loaded, the default connection isn't connected a server. To remedy that, use `Jamf.cnx.connect`,
|
148
|
-
passing it parameters for the connection. In this example, those parameters are stored in the local variables jss_user,
|
147
|
+
passing it parameters for the connection. In this example, those parameters are stored in the local variables jss_user,
|
149
148
|
jss_user_pw, and jss_server_hostname, and others are left as default.
|
150
149
|
|
151
150
|
```ruby
|
@@ -170,8 +169,8 @@ server connection parameters in a simple config file.
|
|
170
169
|
|
171
170
|
#### Using multiple connections
|
172
171
|
|
173
|
-
Most of the time, you'll only need a single connection to a single server, and the default connection will be sufficient. However
|
174
|
-
you can also create multiple Connection objects, to different servers, or perhaps the same server with different credentials and
|
172
|
+
Most of the time, you'll only need a single connection to a single server, and the default connection will be sufficient. However
|
173
|
+
you can also create multiple Connection objects, to different servers, or perhaps the same server with different credentials and
|
175
174
|
access, and pass those connection objects into methods using the `cnx:` parameter as appropriate.
|
176
175
|
|
177
176
|
```ruby
|
@@ -194,13 +193,13 @@ common_ipr_sns = ipr_sns_1 & ipr_sns_2
|
|
194
193
|
|
195
194
|
### Working with Jamf Objects
|
196
195
|
|
197
|
-
All of the ruby classes representing objects in Jamf Pro have common methods for creating, listing, retrieving, updating, and deleting via the API.
|
196
|
+
All of the ruby classes representing objects in Jamf Pro have common methods for creating, listing, retrieving, updating, and deleting via the API.
|
198
197
|
All supported objects can be listed, retrieved and deleted, but only some can be updated or created, mostly becase we haven't needed to do that ourselves
|
199
198
|
yet and haven't implemented that functionality. If you need additional features implemented, please get in touch (see 'Contact' above) or feel free to
|
200
199
|
try implementing it yourself and send us a merge request.
|
201
200
|
|
202
|
-
Some of the implemented objects also provide access to more 'functional' API resources. For example, the API resources for
|
203
|
-
sending MDM commands to computers and mobile devices are available as class and instance methods of Jamf::Computer and Jamf::MobileDevice,
|
201
|
+
Some of the implemented objects also provide access to more 'functional' API resources. For example, the API resources for
|
202
|
+
sending MDM commands to computers and mobile devices are available as class and instance methods of Jamf::Computer and Jamf::MobileDevice,
|
204
203
|
as are the API resources for accessing management history.
|
205
204
|
|
206
205
|
--------
|
@@ -474,21 +473,13 @@ It also requires other ruby gems, which will be installed automatically if you i
|
|
474
473
|
See the .gemspec file for details
|
475
474
|
|
476
475
|
|
477
|
-
### Contact
|
478
|
-
|
479
|
-
If you have questions or feedback about ruby-jss, please reach out to us via:
|
480
|
-
- The [#ruby-jss channel of Macadmins Slack](https://macadmins.slack.com/archives/C03C7F563MK)
|
481
|
-
- Open an issue on GitHub
|
482
|
-
- Email ruby-jss@pixar.com
|
483
|
-
|
484
|
-
|
485
476
|
## HELP & CONTACT INFO
|
486
477
|
|
487
478
|
Full documentation is available at [rubydoc.info](http://www.rubydoc.info/gems/ruby-jss/).
|
488
479
|
|
489
480
|
There's a [wiki on the github page](https://github.com/PixarAnimationStudios/ruby-jss/wiki), feel free to contribute examples and tidbits.
|
490
481
|
|
491
|
-
|
482
|
+
If you have questions or feedback about ruby-jss, please reach out to us via:
|
492
483
|
- [Open an issue on github](https://github.com/PixarAnimationStudios/ruby-jss/issues)
|
493
484
|
- [Email the developers at ruby-jss@pixar.com](mailto:ruby-jss@pixar.com)
|
494
485
|
- Join the conversation in the [#ruby-jss Macadmins Slack Channel](https://macadmins.slack.com/archives/C03C7F563MK)
|
@@ -79,8 +79,7 @@ module Jamf
|
|
79
79
|
|
80
80
|
# Send the os update command to target Computers or a ComputerGroup
|
81
81
|
#
|
82
|
-
# @param updateAction [Symbol] Required.
|
83
|
-
# DOWNLOAD_AND_INSTALL action, or :download to send DOWNLOAD_ONLY
|
82
|
+
# @param updateAction [Symbol, Symbol] Required. One of the keys or values from UPDATE_ACTIONS
|
84
83
|
#
|
85
84
|
# @param deviceIds [String, Integer, Array<String, Integer>] Identifiers for the
|
86
85
|
# computer targets. Required if no groupId is given.
|
data/lib/jamf/version.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: ruby-jss
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.0.
|
4
|
+
version: 3.0.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Chris Lasell
|
@@ -10,7 +10,7 @@ authors:
|
|
10
10
|
autorequire:
|
11
11
|
bindir: bin
|
12
12
|
cert_chain: []
|
13
|
-
date: 2023-
|
13
|
+
date: 2023-05-22 00:00:00.000000000 Z
|
14
14
|
dependencies:
|
15
15
|
- !ruby/object:Gem::Dependency
|
16
16
|
name: CFPropertyList
|
@@ -824,9 +824,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
824
824
|
version: 2.6.3
|
825
825
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
826
826
|
requirements:
|
827
|
-
- - "
|
827
|
+
- - ">="
|
828
828
|
- !ruby/object:Gem::Version
|
829
|
-
version:
|
829
|
+
version: '0'
|
830
830
|
requirements: []
|
831
831
|
rubygems_version: 3.0.3.1
|
832
832
|
signing_key:
|