windoo 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 412deb5f7a47fb7691614ba59c591e26af98a8c1ad9c56435e0e51c11641d00f
+  data.tar.gz: 046c5845e667906f3826a386975063c7d95ee460e9afb8fb1ce3d135429fe251
+SHA512:
+  metadata.gz: b2d45e41777ddad578b9ee371f633f0bd76bbc023188005a7a333b782b0a0ef78c0ea17dc8b85dfbe4ef8c3fbff0e9dffa95d697647814c5261e012c7d57b4d7
+  data.tar.gz: ff3c727c4bfda205c7abda044ee06344098274ff6a29bf6aeea9eb3c17e48092e299ecc4a2fa76d649b1d09282dc22f67c8646f35c21639ef3a7e4a9edb181b3

data/CHANGES.md

@@ -0,0 +1,9 @@
+# Windoo Changelog
+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/).
+
+
+## \[1.0.1] - 2025-09-28
+
+Initial public release.

data/LICENSE.txt

@@ -0,0 +1,177 @@
+
+TOMORROW OPEN SOURCE TECHNOLOGY LICENSE 1.0
+
+The Tomorrow Open Source Technology License 1.0 differs from the original Apache License 2.0 in the following manner.  The scope of the trademark grant in section 6 is different.
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   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.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,222 @@
+# Windoo - a colleague of Kinobi
+
+Windoo provides a Ruby interface to the REST API of the [Jamf Title Editor](https://docs.jamf.com/title-editor/documentation/About_Title_Editor.html), formerly known as 'Kinobi'.
+
+It works very much like [ruby-jss](http://pixaranimationstudios.github.io/ruby-jss/index.html), with a huge, important difference:
+
+**Changes made to Ruby objects happen immediately on the server** There is no need to '.save' anything, but be very careful as you make changes!
+
+As with ruby-jss, the entire API is not implemented here, only the objects necessary to maintain Software Titles. For other purposes (Acct management, overall settings, etc) please use the Title Editor Web UI.
+
+See also:
+- [Documentation about using the Title Editor via its GUI WebApp](https://docs.jamf.com/title-editor/documentation/index.html)
+- [Documentation about the underlying REST API used by Windoo](https://developer.jamf.com/title-editor/reference)
+
+Usage:
+
+```ruby
+require 'windoo'
+
+#### CONNECT
+#####################################
+
+url = 'https://mylogin@a1b2c3d4.appcatalog.jamfcloud.com'
+
+# Connect the default connection.
+Windoo.connect url, pw: :prompt
+
+#### SOFTWARE TITLES
+#####################################
+# All access to API objects happens through the SoftewareTitle that contains them.
+# So to work with Requirements, Patches, KillApps, ExtensionAttributes, etc... you must
+# fetch or create the SoftwareTitle that they are a part of.
+
+# Get an Array of Hashes with summary data about all existing SoftwareTitles
+all_titles = Windoo::SoftwareTitle.all
+
+# Create a SoftwareTitle. This happens immediately on the server
+test_title = Windoo::SoftwareTitle.create(
+  id: 'com.mycompany.windoo.test-0-rama',
+  name: 'Windoo Test Oh Rama',
+  publisher: 'My Company',
+  currentVersion: '0.0.1b1'
+)
+
+# or fetch an existing one by softwareTitleId or 'id'
+title = Windoo::SoftwareTitle.fetch softwareTitleId: test_title.softwareTitleId
+title = Windoo::SoftwareTitle.fetch id: test_title.id
+
+# update title attributes, these are immediately changed on the server
+title.id = 'com.mycompany.windootest'
+title.name = 'Windoo Test'
+title.publisher = 'My Company, Inc.'
+title.currentVersion = '0.0.1a1'
+
+# To delete the title, use 'title.delete'
+
+#### EXTENSION ATTRIBUTES
+#####################################
+
+# add an extension attribute to the title, there can only be one per title
+title.add_extensionAttribute(
+  key: 'can-run-windoo-test1',
+  displayName: 'Can Run Windoo Test1',
+  script: "#!/bin/bash\necho <result>UBETCHA!</result>"
+)
+
+# update EA attributes
+title.extensionAttribute.key = 'can-run-windoo-test'
+title.extensionAttribute.displayName = 'Can Run Windoo Test'
+title.extensionAttribute.script = "#!/bin/bash\necho <result>yes</result>"
+
+# delete the EA with: title.delete_extensionAttribute
+
+#### REQUIREMENTS - criteria identifying macs that have any version of this Title installed
+#####################################
+
+# add two requirements
+title.requirements.add_criterion(
+  name: 'Application Title',
+  operator: 'is',
+  value: 'WindooTest.app'
+)
+
+title.requirements.add_criterion(
+  name: 'Application Bundle ID',
+  operator: 'is',
+  value: 'com.mycompany.windootest1',
+  and_or: :or
+)
+
+# Criteria like these are used in requirements, patch capabilities, and patch component criteria
+# Criteria are immutable, if you need to change one, you can replace it with a new one
+# like this:
+
+req_id = title.requirements.find_by_attr(:name, 'Application Bundle ID').requirementId
+
+title.requirements.replace_criterion(
+  req_id,
+  name: 'Application Bundle ID',
+  operator: 'is',
+  value: 'com.mycompany.windootest',
+  and_or: :or
+)
+
+# To delete a requirement: title.requirements.delete_criterion requirementId
+
+#### PATCHES
+#####################################
+
+# add a patch
+new_patch_id = title.patches.add_patch(
+  version: '0.0.1a1',
+  minimumOperatingSystem: '10.14.0',
+  releaseDate: Time.now,
+  reboot: false,
+  standalone: true
+)
+
+# update attributes of a patch
+title.patches.update_patch new_patch_id, version: '0.0.1a2', releaseDate: Time.now
+
+# add another.  New patches are added to the front of the list by default, with the
+# assumption that they are newer versions than the patches that already exist.
+title.patches.add_patch(
+  version: '0.0.1a3',
+  minimumOperatingSystem: '10.14.4',
+  releaseDate: Time.now
+)
+
+#### KILLAPPS
+#####################################
+
+# add a killApp to a patch
+patch = title.patches.first
+
+kaid = patch.killApps.add_killApp(
+  appName: 'WindooTest.app',
+  bundleId: 'com.mycompany.windootest1'
+)
+
+# Update a killApp attribute
+patch.killApps.update_killApp  kaid, bundleId: 'com.mycompany.windootest'
+
+# delete a killApp
+patch.killApps.delete_killApp kaid
+
+##### CAPABILITIES - criteria identifying macs that can install/run this patch
+#####################################
+
+# Add some criteria...
+
+patch.capabilities.add_criterion(
+  name: 'Total RAM MB',
+  operator: 'more than',
+  value: 16_374
+)
+
+patch.capabilities.add_criterion(
+  name: 'Computer Group',
+  operator: 'member of',
+  value: 'someGroupName'
+)
+
+patch.capabilities.add_criterion(
+  name: 'Operating System Version',
+  operator: 'greater than or equal',
+  value: patch.minimumOperatingSystem
+)
+
+# To make a criterion that uses the value returned by the extension
+# attribute for this title, you must use its 'key' as the 'name', and
+# the 'type' must be 'extensionAttribute'
+# (by default the 'type' is 'recon')
+patch.capabilities.add_criterion(
+  name: title.extensionAttribute.key,
+  operator: 'is',
+  value: 'yes',
+  type: 'extensionAttribute'
+)
+
+##### COMPONENT - including criteria identifying macs that have this patch installed
+#####################################
+
+# add one
+patch.add_component(
+  name: 'Windoo SoftwareTitle Test',
+  version: '0.0.1a5a'
+)
+
+# edit it to fix those values
+patch.component.name =  title.name
+patch.component.version = patch.version
+
+# add criteria
+patch.component.criteria.add_criterion(
+  name: 'Application Title',
+  operator: 'is',
+  value: 'WindooTest.app'
+)
+
+patch.component.criteria.add_criterion(
+  name: 'Application Bundle ID',
+  operator: 'is',
+  value: title.id
+)
+
+patch.component.criteria.add_criterion(
+  name: 'Application Version',
+  operator: 'is',
+  value: patch.version
+)
+
+# Once the patch as at least one Capability, and its Component has at least on criterion,
+# you can enable it
+patch.enable
+
+# Once your software title has at least one Requirement, and one enabled Patch, you can
+# enable it too!
+title.enable
+```
+
+More documentation is on the way