ruby-jss 1.6.4 → 2.0.0b1

data/lib/jamf/api/{attribute_classes → jamf_pro/other_classes}/timestamp.rb

@@ -1,4 +1,4 @@
-# Copyright 2020 Pixar
+# Copyright 2022 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -25,16 +25,22 @@
 
 module Jamf
 
-  # A timestamp as used in the JAMF API JSON data
+  # A timestamp as used in the Jamf Pro API JSON data
   #
-  # Instantiate with a String in iso6801 format (used in the API JSON for
-  # all(?) time/date values), or with a Time or Jamf::Timestamp instance, or with
-  # an Integer unix epoch, which is treated Jamf-style if 1_000_000_000_000 or
-  # higher
+  # Instantiate with any of:
+  #   - A string parsable by Time.parse. Timestamps from the API are always
+  #     strings in iso6801 format
+  #   - a Time or Jamf::Timestamp instance
+  #   - an Integer, or Stringified Integer, a unix epoch value. If it is
+  #     1_000_000_000_000 or higher, it is treated as a Jamf-stype epoch,
+  #     meaning the last 3 digits are milliseconds.
+  #   - nil or an empty string, which will 'unset' a time value with an empty
+  #     string when sent back to the API
   #
-  # To unset a timestamp value, instantiate with nil or an empty string. The
-  # Time value will be '1970-01-01 00:00:00 -0000', the unix epoch,
-  # and the to_jamf method will return an empty string.
+  # To unset a timestamp value in the API, instantiate one of these with
+  # nil or an empty string. The Time value will be '1970-01-01 00:00:00 -0000',
+  # the unix epoch, and the to_jamf method will return an empty string, which
+  # is what will be sent to the API
   #
   # NOTE: Passing '1970-01-01 00:00:00 -0000' or the equivalent explicitly
   # will NOT be treated as an empty timestamp, but as that actual value.
@@ -48,7 +54,7 @@ module Jamf
   # - use .to_f for a unix epoch with fractions
   #
   # Use #to_jamf to get the formated string to use in JSON for sending to the
-  # API - it *should* always be in ISO8601 format
+  # API - it *should* always be in ISO8601 format, or an empty string.
   #
   class Timestamp < ::Time
 
@@ -70,9 +76,7 @@ module Jamf
 
     # @param tstamp[String,Integer,Time] A representation of a timestampe
     #
-    # @param _args [void] unused, but required for JSONObject init.
-    #
-    def initialize(tstamp, **_args)
+    def initialize(tstamp)
       # use a Time object to parse the input and generate our own
       # object
       time = parse_init_tstamp(tstamp)
@@ -83,7 +87,7 @@ module Jamf
         time.day,
         time.hour,
         time.min,
-        (time.sec + (time.usec/1_000_000.0)).round(3),
+        (time.sec + (time.usec / 1_000_000.0)).round(3),
         time.utc_offset
       )
     end

data/lib/jamf/{api/mixins/base_class.rb → base_class.rb}

@@ -1,4 +1,4 @@
-# Copyright 2020 Pixar
+# Copyright 2022 Pixar
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
 #    with the following modification; you may not use this file except in
@@ -54,16 +54,16 @@ module Jamf
       Jamf::BaseClass.base_classes.include? self
     end
 
-    # Can't allocate if base class
-    def allocate(*args, &block)
-      stop_if_base_class ALLOCATION_ACTION
-      super
-    end
+    # # Can't allocate if base class
+    # def allocate(*args, **kwargs, &block)
+    #   stop_if_base_class ALLOCATION_ACTION
+    #   super
+    # end
 
     # Can't instantiate if base_class
-    def new(*args, &block)
+    def new(*args, **kwargs, &block)
       stop_if_base_class INSTANTIATION_ACTION
-      super
+      super(*args, **kwargs, &block)
     end
 
     # raise an exception if this class is a base class

data/lib/jamf/client/jamf_binary.rb

@@ -1,4 +1,4 @@
-### Copyright 2020 Pixar
+### Copyright 2022 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -23,109 +23,114 @@
 ###
 ###
 
-###
-module JSS
+module Jamf
 
-  #
   class Client
 
-    # Constants
-    #####################################
-
-    # The Pathname to the jamf binary executable
-    # Before SIP (macOS 10.10 and below)
-    ORIG_JAMF_BINARY = Pathname.new '/usr/sbin/jamf'
-
-    # The Pathname to the jamf binary executable
-    # After SIP (OS X 10.11 and above)
-    SIP_JAMF_BINARY = USR_LOCAL_BIN_FOLDER + 'jamf'
-
-    # The path to the jamf binary
-    JAMF_BINARY = SIP_JAMF_BINARY.executable? ? SIP_JAMF_BINARY : ORIG_JAMF_BINARY
-
-    # These jamf commands don't need root privs (most do)
-    ROOTLESS_JAMF_COMMANDS = %i[
-      about
-      checkJSSConnection
-      getARDFields
-      getComputerName
-      help
-      listUsers
-      version
-    ].freeze
-
-    # the option that makes the jamf binary verbose
-    JAMF_VERBOSE_OPT = ' -verbose'.freeze
-
-    # class Methods
-    #####################################
-
-    # Run an arbitrary jamf binary command.
-    #
-    # @note Most jamf commands require superuser/root privileges.
-    #
-    # @param command[String,Symbol] the jamf binary command to run
-    #   The command is the single jamf command that comes after the/usr/bin/jamf.
-    #
-    # @param args[String,Array] the arguments passed to the jamf command.
-    #   This is to be passed to Kernel.` (backtick), after being combined with the
-    #   jamf binary and the jamf command
-    #
-    # @param verbose[Boolean] Should the stdout & stderr of the jamf binary be sent to
-    #  the current stdout in realtime, as well as returned as a string?
-    #
-    # @return [String] the stdout & stderr of the jamf binary.
-    #
-    # @example
-    #   These two are equivalent:
-    #
-    #     JSS::Client.run_jamf "recon", "-assetTag 12345 -department 'IT Support'"
-    #
-    #     JSS::Client.run_jamf :recon, ['-assetTag', '12345', '-department', 'IT Support'"]
-    #
-    #
-    # The details of the Process::Status for the jamf binary process can be
-    # captured from $CHILD_STATUS immediately after calling. (See Process::Status)
-    #
-    def self.run_jamf(command, args = nil, verbose = false)
-      raise JSS::UnmanagedError, 'The jamf binary is not installed on this computer.' unless installed?
-      unless ROOTLESS_JAMF_COMMANDS.include?(command.to_sym) || JSS.superuser?
-        raise JSS::UnsupportedError, 'You must have root privileges to run that jamf binary command'
+    # Module for working with the Jamf Binary on a managed client mac
+    # This should be included into Jamf::Client
+    module JamfBinary
+
+      # The path to the jamf binary
+      JAMF_BINARY = Pathname.new '/usr/local/jamf/bin/jamf'
+
+      # These jamf commands don't need root privs (most do)
+      ROOTLESS_JAMF_COMMANDS = %i[
+        about
+        checkJSSConnection
+        getARDFields
+        getComputerName
+        help
+        listUsers
+        version
+      ].freeze
+
+      # the option that makes the jamf binary verbose
+      JAMF_VERBOSE_OPT = ' -verbose'.freeze
+
+      # when this module is included, also extend our Class Methods
+      def self.included(includer)
+        Jamf.load_msg "--> #{includer} is including Jamf::Client::JamfBinary"
+        includer.extend(ClassMethods)
       end
-      cmd = build_jamf_command command, args
-      cmd += " #{JAMF_VERBOSE_OPT}" if verbose && !cmd.include?(JAMF_VERBOSE_OPT)
-      execute_jamf cmd, verbose
-    end # run_jamf
-
-    private_class_method
-
-    def self.build_jamf_command(command, args)
-      case args
-      when nil
-        "#{JAMF_BINARY} #{command}"
-      when String
-        "#{JAMF_BINARY} #{command} #{args}"
-      when Array
-        ([JAMF_BINARY.to_s, command] + args).join(' ')
-      else
-        raise JSS::InvalidDataError, 'args must be a String or Array of Strings'
-      end # case
-    end
-
-    def self.execute_jamf(cmd, verbose)
-      puts "Running: #{cmd}" if verbose
-      output = ''
-      IO.popen("#{cmd} 2>&1") do |proc|
-        loop do
-          line = proc.gets
-          break unless line
-          output << line
-          puts line if verbose
+
+      # class Methods
+      #####################################
+
+      module ClassMethods
+
+        # Run an arbitrary jamf binary command.
+        #
+        # @note Most jamf commands require superuser/root privileges.
+        #
+        # @param command[String,Symbol] the jamf binary command to run
+        #   The command is the single jamf command that comes after the/usr/bin/jamf.
+        #
+        # @param args[String,Array] the arguments passed to the jamf command.
+        #   This is to be passed to Kernel.` (backtick), after being combined with the
+        #   jamf binary and the jamf command
+        #
+        # @param verbose[Boolean] Should the stdout & stderr of the jamf binary be sent to
+        #  the current stdout in realtime, as well as returned as a string?
+        #
+        # @return [String] the stdout & stderr of the jamf binary.
+        #
+        # @example
+        #   These two are equivalent:
+        #
+        #     Jamf::Client.run_jamf "recon", "-assetTag 12345 -department 'IT Support'"
+        #
+        #     Jamf::Client.run_jamf :recon, ['-assetTag', '12345', '-department', 'IT Support'"]
+        #
+        #
+        # The details of the Process::Status for the jamf binary process can be
+        # captured from $CHILD_STATUS immediately after calling. (See Process::Status)
+        #
+        def run_jamf(command, args = nil, verbose = false)
+          raise Jamf::UnmanagedError, 'The jamf binary is not installed on this computer.' unless installed?
+          unless ROOTLESS_JAMF_COMMANDS.include?(command.to_sym) || JSS.superuser?
+            raise Jamf::UnsupportedError, 'You must have root privileges to run that jamf binary command'
+          end
+
+          cmd = build_jamf_command command, args
+          cmd += " #{JAMF_VERBOSE_OPT}" if verbose && !cmd.include?(JAMF_VERBOSE_OPT)
+          execute_jamf cmd, verbose
+        end # run_jamf
+
+        #####
+        def build_jamf_command(command, args)
+          case args
+          when nil
+            "#{JAMF_BINARY} #{command}"
+          when String
+            "#{JAMF_BINARY} #{command} #{args}"
+          when Array
+            ([JAMF_BINARY.to_s, command] + args).join(' ')
+          else
+            raise Jamf::InvalidDataError, 'args must be a String or Array of Strings'
+          end # case
         end
-      end
-      output.force_encoding('UTF-8')
-      output
-    end
+
+        ######
+        def execute_jamf(cmd, verbose)
+          puts "Running: #{cmd}" if verbose
+          output = ''
+          IO.popen("#{cmd} 2>&1") do |proc|
+            loop do
+              line = proc.gets
+              break unless line
+
+              output << line
+              puts line if verbose
+            end
+          end
+          output.force_encoding('UTF-8')
+          output
+        end
+
+      end # ClassMethods
+
+    end # module
 
   end # class Client