ruby-jss 1.2.4a3 → 1.3.2

data/lib/jamf/api/resources/collection_resources/site.rb

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

data/lib/jamf/api/resources/collection_resources/time_zone.rb

@@ -0,0 +1,119 @@
+# Copyright 2020 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.
+#
+#
+
+# The Module
+module Jamf
+
+  # Classes
+  #####################################
+
+  # A building defined in the JSS
+  class TimeZone < Jamf::CollectionResource
+
+    # Mix-Ins
+    #####################################
+
+    extend Jamf::Immutable
+    extend Jamf::UnCreatable
+    extend Jamf::UnDeletable
+
+    # Constants
+    #####################################
+
+    RSRC_VERSION = 'v1'.freeze
+
+    RSRC_PATH = 'time-zones'.freeze
+
+    # Object Model / Attributes
+    # See APIObject class documentation for details
+    # of how the OBJECT_MODEL hash works.
+    #####################################
+    OBJECT_MODEL = {
+
+      # @!attribute [r] zoneId
+      #   @return [String]
+      zoneId: {
+        class: :string,
+        identifier: :primary,
+        aliases: [:id]
+      },
+
+      # @!attribute displayName
+      #   @return [String]
+      displayName: {
+        class: :string,
+        identifier: true,
+        aliases: [:name]
+      },
+
+      # @!attribute [r] region
+      #   @return [String]
+      region: {
+        class: :string
+      }
+    }.freeze
+    parse_object_model
+
+    # The offset from UTC, as a string.
+    #
+    # This is as it would appear at the end of an ISO8601 formatted time,
+    # e.g. -0945 or +1200
+    #
+    # Note that ISO8601 accepts the formats: +/-hh:mm, +/-hhmm, or +/-hh
+    #
+    # @return [Integer] The offset from UTC, as a string
+    #
+    def utc_offset_str
+      return @utc_offset_str if @utc_offset_str
+
+      displayName =~ /\(([+-]\d{4})\)/
+      @utc_offset_str = Regexp.last_match[1]
+    end
+
+    # @return [Integer] The offset from UTC, in seconds
+    #
+    def utc_offset
+      return @utc_offset if @utc_offset
+
+      sign = utc_offset_str[0]
+      secs = utc_offset_str[1..2].to_i * 3600
+      secs += utc_offset_str[3..4].to_i * 60
+      # negate if needed
+      @utc_offset =  sign == '+' ? secs : -secs
+    end
+
+    # Give a Time object, whats the matching local time in this TimeZone?
+    #
+    # @param othertime[Time] a Time or Jamf::Timestamp object
+    #
+    # @return [Time] othertime, in the local time in this time zone
+    #
+    def localtime(othertime)
+      othertime.getlocal utc_offset
+    end
+
+  end # class
+
+end # module

data/lib/jamf/api/resources/singleton_resources/app_store_country_codes.rb

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

data/lib/jamf/api/resources/singleton_resources/authorization.rb

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

data/lib/jamf/api/resources/singleton_resources/client_checkin_settings.rb

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

data/lib/jamf/api/resources/singleton_resources/reenrollment_settings.rb

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

data/lib/jamf/client.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -24,7 +24,7 @@
 ###
 
 ###
-module JSS
+module Jamf
 
   # This class represents a Jamf/JSS Client computer, on which
   # this code is running.
@@ -78,10 +78,17 @@ module JSS
     # the path to a users byhost folder from home
     USER_PREFS_BYHOST_FOLDER = 'Library/Preferences/ByHost/'
 
-    # Class Methods
-    #####################################
+    # If some processs C has a parent process P whose command (via ps -o comm)
+    # matches this, then process C is being run by Jamf
+    POLICY_SCRIPT_CMD_RE = %r{sh -c PATH=\$PATH:/usr/local/jamf/bin; '/Library/Application Support/JAMF/tmp/.* >& '/Library/Application Support/JAMF/tmp/\d+.tmp}.freeze
 
+    # If some processs C has a parent process P whose command (via ps -o comm)
+    # matching POLICY_SCRIPT_CMD_RE, and process P has a parent process G that
+    # matches this (C is grandchild of G), then process C is being run by a Jamf policy
+    POLICY_CMD_RE = %r{/bin/jamf policy }.freeze
 
+    # Class Methods
+    #####################################
 
     # Get the current IP address as a String.
     #
@@ -292,6 +299,54 @@ module JSS
       dir ? Pathname.new(dir) : nil
     end
 
+    # Search up the process lineage to see if any ancestor processes indicate
+    # that the current process is being run by a Jamf Policy.
+    #
+    # @return [Boolean] Is the current process being run as a script by a Jamf Policy?
+    #
+    def self.script_running_via_policy?
+      root_ps_lines = `ps -u root -x -o pid -o ppid -o user -o command`.lines
+
+      parent_pid, _parent_user, parent_command = parent_pid_user_and_cmd Process.pid, root_ps_lines
+      return false unless parent_pid
+
+      until parent_command =~ POLICY_SCRIPT_CMD_RE || parent_pid.nil?
+        parent_pid, _parent_user, parent_command = parent_pid_user_and_cmd parent_pid, root_ps_lines
+        return false if parent_pid.zero?
+      end
+      return false if parent_pid.nil?
+
+      # if we're here, our parent is a jamf process, lets confirm that its
+      # a jamf policy
+      until parent_command =~ POLICY_CMD_RE || parent_pid.nil?
+        parent_pid, _parent_user, parent_command = parent_pid_user_and_cmd parent_pid, root_ps_lines
+        return false if parent_pid.zero?
+      end
+      !parent_pid.nil?
+    end
+
+    # given a pid and optionally the output of `ps -o pid -o ppid -o user -o command`
+    # return an array with the pid, user, and command of the pid's parent process
+    #
+    # @param pid [Integer, String] the process id for which we want parent info
+    #
+    # @param ps_lines [Array<String>] the lines of output from
+    #   `ps -o pid -o ppid -o user -o command` possibly with other options.
+    #    If omitted, `ps -a -x -o pid -o ppid -o user -o command` will be used
+    #
+    # @return [Array<Integer, String, String>] the pid, user, and commandline
+    #  of the parent process of the given pid. All will be nil if not found
+    #
+    def self.parent_pid_user_and_cmd(pid, ps_lines = nil)
+      ps_lines ||= `ps -a -x -o pid -o ppid -o user -o command`.lines
+
+      parent_ps_line = ps_lines.select { |l| l =~ /^\s*#{pid}\s/ }.first
+      return [nil, nil, nil] unless parent_ps_line
+
+      parent_ps_line =~ /^\s*\d+\s+(\d+)\s+(\S+)\s+(.*)$/
+      [Regexp.last_match(1).to_i, Regexp.last_match(2), Regexp.last_match(3)]
+    end
+
   end # class Client
 
 end # module

data/lib/jamf/client/jamf_binary.rb

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

data/lib/jamf/client/jamf_helper.rb

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

data/lib/jamf/client/management_action.rb

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

data/lib/jamf/compatibility.rb

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

data/lib/jamf/composer.rb

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

data/lib/jamf/configuration.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -103,8 +103,8 @@ module Jamf
     # The Pathname to the machine-wide preferences
     GLOBAL_CONF_FILE = Pathname.new "/etc/#{CONF_FILENAME}"
 
-    # The Pathname to the user-specific preferences plist
-    USER_CONF_FILE = ENV['HOME'] ? Pathname.new("~/.#{CONF_FILENAME}").expand_path : nil
+    # The Pathname to the user-specific preferences plist if there is one
+    USER_CONF_FILE = Pathname.new("#{ENV['HOME']}/.#{CONF_FILENAME}")
 
     # The attribute keys we maintain, and the type they should be stored as
     CONF_KEYS = {
@@ -134,7 +134,6 @@ module Jamf
     # Constructor
     #####################################
 
-
     # Initialize!
     #
     def initialize
@@ -145,7 +144,6 @@ module Jamf
     # Public Instance Methods
     #####################################
 
-
     # Clear all values
     #
     # @return [void]
@@ -196,9 +194,9 @@ module Jamf
     def save(file)
       path =
         case file
-          when :global then GLOBAL_CONF_FILE
-          when :user then USER_CONF_FILE
-          else Pathname.new(file)
+        when :global then GLOBAL_CONF_FILE
+        when :user then USER_CONF_FILE
+        else Pathname.new(file)
         end
 
       raise Jamf::MissingDataError, "No HOME environment variable, can't write to user conf file." if path.nil?

data/lib/jamf/exceptions.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -82,6 +82,11 @@ module Jamf
   #
   class AuthenticationError < RuntimeError; end
 
+  # InvalidTokenError - raise this when a connection token is
+  # expired or otherwise invalid
+  #
+  class InvalidTokenError < RuntimeError; end
+
   # ConflictError - raise this when
   # attempts to PUT or PUSH to the API
   # result in a 409 Conflict http error.

data/lib/jamf/ruby_extensions.rb

@@ -1,4 +1,4 @@
-### Copyright 2019 Pixar
+### Copyright 2020 Pixar
 
 ###
 ###    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -34,3 +34,4 @@ require 'jamf/ruby_extensions/object.rb'
 require 'jamf/ruby_extensions/pathname.rb'
 require 'jamf/ruby_extensions/string.rb'
 require 'jamf/ruby_extensions/array.rb'
+require 'jamf/ruby_extensions/dig.rb'

data/lib/jamf/ruby_extensions/array.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -26,7 +26,7 @@
 require 'jamf/ruby_extensions/array/predicates'
 require 'jamf/ruby_extensions/array/utils'
 
-#
+# an array
 class Array
 
   include JamfRubyExtensions::Array::Predicates

data/lib/jamf/ruby_extensions/array/predicates.rb

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

data/lib/jamf/ruby_extensions/array/utils.rb

@@ -1,4 +1,4 @@
-# Copyright 2019 Pixar
+# Copyright 2020 Pixar
 
 #
 #    Licensed under the Apache License, Version 2.0 (the "Apache License")
@@ -25,6 +25,7 @@ module JamfRubyExtensions
 
   module Array
 
+    # Useful monkey patches for Array
     module Utils
 
       # Fetch a string from an Array case-insensitively,
@@ -40,7 +41,7 @@ module JamfRubyExtensions
       #   nil if it doesn't exist
       #
       def j_ci_fetch(somestring)
-        each { |s| return s if s.is_a?(String) && s.casecmp?(somestring) }
+        each { |s| return s if s.respond_to?(:casecmp?) && s.casecmp?(somestring) }
         nil
       end
 
@@ -51,7 +52,7 @@ module JamfRubyExtensions
       # @return [Boolean]
       #
       def j_ci_include?(somestring)
-        any? { |s| s.casecmp? somestring if s.is_a? String }
+        any? { |s| s.respond_to?(:casecmp?) && s.casecmp?(somestring) }
       end
 
     end # module

data/lib/jamf/ruby_extensions/dig.rb

@@ -0,0 +1,52 @@
+# Copyright 2020 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.
+
+# Gratefully borrowed from https://github.com/Invoca/ruby_dig
+
+# modulize monkey patches
+module RubyDig
+
+  def dig(key, *rest)
+    value = self[key]
+    if value.nil? || rest.empty?
+      value
+    elsif value.respond_to?(:dig)
+      value.dig(*rest)
+    else
+      raise TypeError, "#{value.class} does not have #dig method"
+    end
+  end
+
+end
+
+if RUBY_VERSION < '2.3'
+
+  # arrays
+  class Array; include RubyDig; end
+
+  # hashes
+  class Hash; include RubyDig; end
+
+  # ostructs
+  class OpenStruct; include RubyDig; end
+end