ruby-jss 1.4.1 → 1.6.0

data/lib/jamf/api/{abstract_classes → base_classes}/resource.rb

@@ -180,13 +180,13 @@ module Jamf
   #
   class Resource < Jamf::JSONObject
 
-    extend Jamf::Abstract
+    extend Jamf::BaseClass
 
     # Constants
     #####################################
 
     # These methods are allowed to call .new
-    NEW_CALLERS = ['fetch', 'create', 'all', 'block in all'].freeze
+    NEW_CALLERS = ['fetch', 'create', 'all', 'cached_all', 'block in all', 'block in cached_all'].freeze
 
     # The resource version for previewing new features
     RSRC_PREVIEW_VERSION = 'preview'.freeze
@@ -197,7 +197,7 @@ module Jamf
     # the resource path for this resource
     # @return [String]
     def self.rsrc_path
-      "#{self::RSRC_VERSION}/#{self::RSRC_PATH}"
+      @rsrc_path ||= "#{self::RSRC_VERSION}/#{self::RSRC_PATH}"
     end
 
     def self.preview_path
@@ -205,18 +205,22 @@ module Jamf
     end
 
     # Disallow direct use of ruby's .new class method for creating instances.
-    # Require use of .fetch or .create.
+    # Require use of .fetch or .create, or 'all'
     #
     def self.new(data, cnx: Jamf.cnx)
+      stop_if_base_class
       calling_method = caller_locations(1..1).first.label
-      raise Jamf::UnsupportedError, "Use .fetch or .create to instantiate Jamf::Resource's" unless NEW_CALLERS.include? calling_method
-
+      raise Jamf::UnsupportedError, "Use .fetch, .create, or .all(instantiate:true) to instantiate Jamf::Resources" unless NEW_CALLERS.include? calling_method
       super
     end
 
     # Attributes
     #####################################
 
+    # @return [Jamf::Connection] the API connection thru which we deal with
+    #   this resource.
+    attr_reader :cnx
+
     # @return [String] the resouce path for this object
     attr_reader :rsrc_path
 

data/lib/jamf/api/{abstract_classes → base_classes}/singleton_resource.rb

@@ -37,7 +37,7 @@ module Jamf
   #
   class SingletonResource < Jamf::Resource
 
-    extend Jamf::Abstract
+    extend Jamf::BaseClass
 
     # Public Class Methods
     #####################################
@@ -56,16 +56,17 @@ module Jamf
     # @return [Jamf::SingletonResource] The ruby-instance of a Jamf resource
     #
     def self.fetch(reload = false, cnx: Jamf.cnx)
+      stop_if_base_class
       cnx.singleton_cache[self] = nil if reload
       cached = cnx.singleton_cache[self]
       return cached if cached
 
-      data = cnx.get "#{self::RSRC_VERSION}/#{self::RSRC_PATH}"
+      data = cnx.get rsrc_path
       cnx.singleton_cache[self] = new data, cnx: cnx
     end # fetch
 
     def self.flushcache(cnx: Jamf.cnx)
-      validate_not_abstract
+      stop_if_base_class
       cnx.singleton_cache[self] = nil
     end
 

data/lib/jamf/api/connection.rb

@@ -24,9 +24,6 @@
 require 'faraday' # >= 0.17.0
 require 'faraday_middleware' # >= 0.13.0
 
-require 'jamf/api/connection/token'
-require 'jamf/api/connection/api_error'
-
 # The module
 module Jamf
 
@@ -45,10 +42,10 @@ module Jamf
     #####################################
 
     # The start of the path for API resources
-    RSRC_BASE = 'uapi'.freeze
+    RSRC_BASE = 'api'.freeze
 
-    # The API version must be this or higher
-    MIN_JAMF_VERSION = Gem::Version.new('10.23.0')
+    # The JamfPro version must be this or higher
+    MIN_JAMF_VERSION = Gem::Version.new('10.25.0')
 
     HTTPS_SCHEME = 'https'.freeze
 
@@ -85,6 +82,7 @@ module Jamf
     TOKEN_REUSE_MIN_LIFE = 60
 
     HTTP_ACCEPT_HEADER = 'Accept'.freeze
+
     HTTP_CONTENT_TYPE_HEADER = 'Content-Type'.freeze
 
     MIME_JSON = 'application/json'.freeze
@@ -161,7 +159,6 @@ module Jamf
     #
     # SingletonResource.fetch will return the instance from here, if it exists,
     # unless the first parameter is truthy.
-
     attr_reader :singleton_cache
 
     # @return [Hash]
@@ -704,7 +701,11 @@ module Jamf
 
       @timeout = params[:timeout]
       @open_timeout = params[:open_timeout]
-      @base_url = URI.parse "https://#{@host}:#{@port}/#{RSRC_BASE}"
+
+      # TEMPORARY ? the tryitout host still uses `uapi` rather than the
+      # new `api` for regular servers
+      rsrc_base = @host == Token::JAMF_TRYITOUT_HOST ? 'uapi' : RSRC_BASE
+      @base_url = URI.parse "https://#{@host}:#{@port}/#{rsrc_base}"
 
       # ssl opts for faraday
       # TODO: implement all of faraday's options
@@ -766,7 +767,7 @@ module Jamf
         cnx.response :json, parser_options: { symbolize_names: true } if parse_json
         cnx.options[:timeout] = @timeout
         cnx.options[:open_timeout] = @open_timeout
-        cnx.use Faraday::Adapter::NetHttp
+        cnx.adapter Faraday::Adapter::NetHttp
       end
     end
 
@@ -861,3 +862,6 @@ module Jamf
   end
 
 end # module Jamf
+
+require 'jamf/api/connection/token'
+require 'jamf/api/connection/api_error'

data/lib/jamf/api/connection/api_error.rb

@@ -83,18 +83,18 @@ module Jamf
       def initialize(http_response)
         @http_response = http_response
         @httpStatus = http_response.status
-
         @errors =
-          if @http_response.body.dig :errors
-            @http_response.body[:errors].map { |e| ErrorInfo.new e }
-          else
-            []
+          if @http_response.body.is_a? String
+            JSON.parse(@http_response.body)[:errors]
+          elsif @http_response.body.is_a?(Hash)
+            @http_response.body[:errors]
           end
+        @errors &&= @errors.map { |e| ErrorInfo.new e }
 
-        if @errors.empty?
+        unless @errors
           code = @httpStatus
-          desc = @httpStatus == 404 ? RSRC_NOT_FOUND : @http_response.reason_phrase
-          @errors << ErrorInfo.new(code: code, field: nil, description: desc, id: nil)
+          desc = code == 404 ? RSRC_NOT_FOUND : @http_response.reason_phrase
+          @errors = [ErrorInfo.new(code: code, field: nil, description: desc, id: nil)]
         end
 
         super

data/lib/jamf/api/connection/token.rb

@@ -32,13 +32,15 @@ module Jamf
 
       JAMF_VERSION_RSRC = 'v1/jamf-pro-version'.freeze
 
+      AUTH_RSRC_VERSION = 'v1'.freeze
+
       AUTH_RSRC = 'auth'.freeze
 
-      NEW_TOKEN_RSRC = "#{AUTH_RSRC}/tokens".freeze
+      NEW_TOKEN_RSRC = "#{AUTH_RSRC_VERSION}/#{AUTH_RSRC}/token".freeze
 
-      KEEP_ALIVE_RSRC = "#{AUTH_RSRC}/keepAlive".freeze
+      KEEP_ALIVE_RSRC = "#{AUTH_RSRC_VERSION}/#{AUTH_RSRC}/keep-alive".freeze
 
-      INVALIDATE_RSRC = "#{AUTH_RSRC}/invalidateToken".freeze
+      INVALIDATE_RSRC = "#{AUTH_RSRC_VERSION}/#{AUTH_RSRC}/invalidate-token".freeze
 
       # this string is prepended to the token data when used for
       # transaction authorization.
@@ -50,7 +52,7 @@ module Jamf
 
       JAMF_TRYITOUT_TOKEN_BODY = {
         token: 'This is a fake token, tryitout.jamfcloud.com uses internal tokens',
-        expires: 2000000000000
+        expires: 2_000_000_000_000
       }.freeze
 
       # @return [String] The user who generated this token
@@ -154,12 +156,14 @@ module Jamf
 
       # @return [String]
       def jamf_version
-        raw_jamf_version.split('-').first
+        fetch_jamf_version unless @jamf_version
+        @jamf_version
       end
 
       # @return [String]
       def jamf_build
-        raw_jamf_version.split('-').last
+        fetch_jamf_version unless @jamf_build
+        @jamf_build
       end
 
       # @return [Boolean]
@@ -264,15 +268,12 @@ module Jamf
       end
 
       # @return [String]
-      def raw_jamf_version
-        # TODO: Remove this once we require Jamf Pro 10.19 and up
-        # the rsrc for getting the version used to be nothing (the
-        # base url itself returnedit) but now its JAMF_VERSION_RSRC
-        resp = token_connection(Jamf::BLANK, token: @auth_token).get # .body # [:version]
-        return resp.body[:version] if resp.success?
-
+      def fetch_jamf_version
         resp = token_connection(JAMF_VERSION_RSRC, token: @auth_token).get
-        return resp.body[:version] if resp.success?
+        if resp.success?
+          @jamf_version, @jamf_build = resp.body[:version].split('-')
+          return
+        end
 
         raise Jamf::InvalidConnectionError, 'Unable to read Jamf version from the API'
       end
@@ -291,7 +292,7 @@ module Jamf
           else
             con.basic_auth @user, pw
           end
-          con.use Faraday::Adapter::NetHttp
+          con.adapter Faraday::Adapter::NetHttp
         end # Faraday.new
       end # token_connection
 

data/lib/jamf/api/json_objects/device_enrollment_device.rb

@@ -68,25 +68,25 @@ module Jamf
     OBJECT_MODEL = {
 
       # @!attribute id
-      #   @return [Integer]
+      #   @return [String]
       id: {
-        class: :integer,
+        class: :j_id,
         identifier: true
       },
 
       # @!attribute deviceEnrollmentProgramInstanceId
-      #   @return [Integer]
+      #   @return [String]
       deviceEnrollmentProgramInstanceId: {
-        class: :integer,
+        class: :j_id,
         aliases: %i[instanceId]
       },
 
       # @!attribute prestageId
       #   The most recent prestage this device was assigned to, even if
       #   currently unassigned to any prestage.
-      #   @return [Integer]
+      #   @return [String]
       prestageId: {
-        class: :integer
+        class: :j_id
       },
 
       # @!attribute serialNumber
@@ -122,7 +122,14 @@ module Jamf
       # @!attribute profileStatus
       #   @return [String]
       profileStatus: {
-        class: :string
+        class: :string,
+        enum: PROFILE_STATUSES
+      },
+
+      # @!attribute syncState
+      #   @return [DeviceEnrollmentDeviceSyncState]
+      syncState: {
+        class: Jamf::DeviceEnrollmentDeviceSyncState
       },
 
       # @!attribute profileAssignTime

data/lib/jamf/api/json_objects/{location.rb → device_enrollment_device_sync_state.rb}

@@ -26,70 +26,56 @@
 # The module
 module Jamf
 
-  # A 'location' for a managed object in Jamf Pro
-  class Location < Jamf::JSONObject
+  # The status of a device from Apple's POV, regarding its
+  # assignment or removal from ADE. Such assignment is done via
+  # a profile from apple, this data is the state of that profile.
+  class DeviceEnrollmentDeviceSyncState < Jamf::JSONObject
+
+    extend Jamf::Immutable
 
     OBJECT_MODEL = {
 
-      # @!attribute username
-      #   @param [String]
-      #   @return [String]
-      username: {
-        class: :string
+      # @!attribute id
+      #   NOTE: this is not a jamf object id, it comes from Apple, therefore
+      #   it is an Integer, not a :j_id
+      #   @return [Integer]
+      id: {
+        class: :integer
       },
 
-      # @!attribute realName
-      #   @param [String]
+      # @!attribute serialNumber
       #   @return [String]
-      realName: {
+      serialNumber: {
         class: :string
       },
 
-      # @!attribute emailAddress
-      #   @param [String]
+      # @!attribute profileUUID
       #   @return [String]
-      emailAddress: {
+      profileUUID: {
         class: :string
       },
 
-      # @!attribute position
-      #   @param [String]
+      # @!attribute syncStatus
       #   @return [String]
-      position: {
+      syncStatus: {
         class: :string
       },
 
-      # @!attribute phoneNumber
-      #   @param [String]
-      #   @return [String]
-      phoneNumber: {
-        class: :string
+      # @!attribute failureCount
+      #   @return [Integer]
+      failureCount: {
+        class: :integer
       },
 
-      # @!attribute department
-      #   @param [String]
-      #   @return [String]
-      department: {
-        class: Jamf::Department::Reference
-      },
-
-      # @!attribute building
-      #   @param [String]
-      #   @return [String]
-      building: {
-        class: Jamf::Building::Reference
-      },
-
-      # @!attribute room
-      #   @param [String]
-      #   @return [String]
-      room: {
-        class: :string
+      # @!attribute timestamp
+      #   @return [Jamf::Timestamp]
+      timestamp: {
+        class: Jamf::Timestamp
       }
     }.freeze
 
     parse_object_model
 
-  end # class location
+  end # class Country
 
 end # module

data/lib/jamf/api/json_objects/device_enrollment_sync_status.rb

@@ -42,7 +42,7 @@ module Jamf
       # @!attribute instanceId
       #   @return [Integer]
       instanceId: {
-        class: :integer
+        class: :j_id
       },
 
       # @!attribute timestamp

data/lib/jamf/api/json_objects/{attachment.rb → locale.rb}

@@ -23,22 +23,11 @@
 #
 #
 
-# The Module
+# The module
 module Jamf
 
-  # Classes
-  #####################################
-
-  # An attachment to an object in the JSS
-  class Attachment < Jamf::JSONObject
-
-    # Mix-Ins
-    #####################################
-
-    include Jamf::Referable
-
-    # Constants
-    #####################################
+  # A Time Zone known to Jamf Pro
+  class Locale < Jamf::JSONObject
 
     # Object Model / Attributes
     # See APIObject class documentation for details
@@ -46,23 +35,25 @@ module Jamf
     #####################################
     OBJECT_MODEL = {
 
-      # @!attribute [r] id
-      #   @return [Integer]
-      id: {
-        class: :integer,
+      # @!attribute [r] zoneId
+      #   @return [String]
+      identifier: {
+        class: :string,
         identifier: :primary,
-        readonly: true
+        read_only: true,
+        aliases: [:id]
       },
 
-      # @!attribute name
+      # @!attribute displayName
       #   @return [String]
-      name: {
+      description: {
         class: :string,
-        readonly: true
+        read_only: true,
+        aliases: %i[name desc]
       }
     }.freeze
     parse_object_model
 
-  end # class
+  end # class Locale
 
 end # module