xolo-admin 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bc16bfe452748613b4da96e31dab66119c8d3ff837a44f6baa9b2b6a187ffdf0
+  data.tar.gz: ec5718f47f8996497fa4076629fc9fb1d8f5f44beeb77fb6eb4ac7f04c9140e8
+SHA512:
+  metadata.gz: 5ea09e8594bfdfad550e5e1ad7ba0db2a9fe25bd5a06cfeaa46999485efa676353041bf671acd6e831224f6ba22cf810c4aa15b6717cff524d47672c7e5471e4
+  data.tar.gz: b3c676c62037ec95d69ac5ac411fdfd375163bfb980e003f09348af898bd08c57965853c0e94c1ac7acfa940ea82c81e608477173b7c19a325c4684affc45204

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,5 @@
+# Xolo - CLI and Automated Package and Patch Management for Jamf Pro
+
+The xolo-admin gem packages the code needed to run `xadm`, the admin tool for Xolo [link to come], a command-line based system for automation and standardization around software deployment and management via Jamf Pro and the Jamf Title Editor.
+
+More documentation coming soon. 

data/bin/xadm

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
+#
+
+# frozen_string_literal: true
+
+require 'xolo/admin'
+
+# The App
+#####################
+class XoloAdmin
+
+  # Mixins
+  #####################################
+  #####################################
+
+  include Xolo::Admin
+  include Xolo::Core::JSONWrappers
+  include Xolo::Core::Output
+  include Xolo::Admin::CommandLine
+  include Xolo::Admin::Connection
+  include Xolo::Admin::Processing
+  include Xolo::Admin::Credentials
+  include Xolo::Admin::Interactive
+  include Xolo::Admin::Options
+  include Xolo::Admin::Validate
+  include Xolo::Admin::JamfPro
+  include Xolo::Admin::TitleEditor
+  include Xolo::Admin::ProgressHistory
+
+  # Constructor
+  ###################
+  def initialize
+    # all bets are off during early testing
+    return if ARGV.include? '--test'
+
+    # This will log us in to the xolo server
+    # if the command needs it.
+    parse_cli
+  end
+
+  # Run
+  ########################
+  def run
+    # during early testing, this will return all kinds of things.
+    run_tests if ARGV.include? '--test'
+    return if @tests_run
+
+    # this line will actuall stay somewhere here in xadm!
+    do_walkthru if walkthru?
+    return if @walkthru_cancelled
+
+    process_method = cmd_details[:process_method]
+    return unless process_method
+
+    send process_method
+  end # run
+
+  # do some testing
+  ########################
+  def run_tests
+    # LOCAL TESTING
+    # uncomment to test local variables and such, see
+    # the do_local_testing method in processing.rb
+    # and adjust it as needed to test what needs testing
+    #
+    # do_local_testing
+
+    # SERVER TESTING
+    # uncomment to reach out to the server
+    # to test all kinds of things - the connection,
+    # or any values the server might return
+    #
+    # see the run_test_route method in processing.rb
+    # and the test_route method in the server
+    # and adjust them as needed to test what needs testing
+    #
+    # login test: true
+    # run_test_route
+
+    @tests_run = true
+  end # run_tests
+
+end # class XoloAdmin
+
+# MAIN
+#####################
+begin
+  # if --debug is given anywhere, move it to the front of ARGV
+  # which is where Optimist expects it
+  #
+  # -d must be given as a global opt (before the command)
+  # in order to mean --debug
+  #
+  debug = ARGV.delete '--debug'
+  ARGV.unshift debug if debug
+
+  app = XoloAdmin.new
+  debug ||= app.global_opts.debug
+
+  app.run
+  exit 0
+rescue => e
+  warn "Error: #{e.class.name.split('::').last}: #{e}"
+  if debug
+    warn 'Backtrace:'
+    e.backtrace.each { |l| warn "..#{l}" }
+  end
+  exit 1
+end