Module: JSS::ManagementHistory::ClassMethods

Defined in:
lib/jss/api_object/management_history.rb

Overview

See codereview.stackexchange.com/questions/23637/mixin-both-instance-and-class-methods-in-ruby for discussion of this technique for mixing in both Class and Instance methods when including a module.

Instance Method Summary collapse

Instance Method Details

#app_store_app_history(ident, status = nil, api: JSS.api) ⇒ Array Also known as: managed_app_history

Wrapper for app store history for both computers and mobile devices

Parameters:

  • ident (Type) —

    The identifier for the object - id, name, sn, udid, etc.

  • status (Symbol) (defaults to: nil) —

    Return only the :installed, :pending, or :failed apps

  • api (JSS::APIConnection) (defaults to: JSS.api) —

    The API connection to use for the query defaults to the currently active connection

Returns:

  • (Array) —

    An array of MacAppStoreApp or MobileDeviceApp


447
448
449
450
451
452
453
 
# File 'lib/jss/api_object/management_history.rb', line 447

def app_store_app_history(ident, status = nil, api: JSS.api)
  if self == JSS::MobileDevice
    mobile_device_app_history(ident, status, api: api)
  else
    mac_app_store_app_history(ident, status, api: api)
  end
end

#audit_history(ident, api: JSS.api) ⇒ Array<JSS::ManagementHistory::AuditEvent> Also known as: audits

The history of Audit events for a target

Parameters:

  • ident (Type) —

    The identifier for the object - id, name, sn, udid, etc.

  • api (JSS::APIConnection) (defaults to: JSS.api) —

    The API connection to use for the query defaults to the currently active connection

Returns:


222
223
224
225
 
# File 'lib/jss/api_object/management_history.rb', line 222

def audit_history(ident, api: JSS.api)
  hist = management_history(ident, :audits, api: api)
  hist.map! { |aud| JSS::ManagementHistory::AuditEvent.new aud }
end

#casper_imaging_logs(ident, api: JSS.api) ⇒ Array<JSS::ManagementHistory::CasperImagingLog>

The history of Casper Imaging events for a computer

Parameters:

  • ident (Type) —

    The identifier for the object - id, name, sn, udid, etc.

  • api (JSS::APIConnection) (defaults to: JSS.api) —

    The API connection to use for the query defaults to the currently active connection

Returns:

Raises:


492
493
494
495
496
 
# File 'lib/jss/api_object/management_history.rb', line 492

def casper_imaging_logs(ident, api: JSS.api)
  raise JSS::UnsupportedError, 'Only computers have casper imaging logs' unless self == JSS::Computer
  hist = management_history(ident, :casper_imaging_logs, api: api)
  hist.map! { |evt| JSS::ManagementHistory::CasperImagingLog.new evt }
end

#casper_remote_logs(ident, api: JSS.api) ⇒ Array<JSS::ManagementHistory::CasperRemoteLog>

The history of Casper Remote events for a computer

Parameters:

  • ident (Type) —

    The identifier for the object - id, name, sn, udid, etc.

  • api (JSS::APIConnection) (defaults to: JSS.api) —

    The API connection to use for the query defaults to the currently active connection

Returns:

Raises:


507
508
509
510
511
 
# File 'lib/jss/api_object/management_history.rb', line 507

def casper_remote_logs(ident, api: JSS.api)
  raise JSS::UnsupportedError, 'Only computers have casper remote logs' unless self == JSS::Computer
  hist = management_history(ident, :casper_remote_logs, api: api)
  hist.map! { |evt| JSS::ManagementHistory::CasperRemoteLog.new evt }
end

#completed_mdm_commands(ident, api: JSS.api) ⇒ Array<JSS::ManagementHistory::MDMCommand> Also known as: completed_commands

The history of completed mdm commands for a target

Parameters:

  • ident (Type) —

    The identifier for the object - id, name, sn, udid, etc.

  • api (JSS::APIConnection) (defaults to: JSS.api) —

    The API connection to use for the query defaults to the currently active connection

Returns:


291
292
293
 
# File 'lib/jss/api_object/management_history.rb', line 291

def completed_mdm_commands(ident, api: JSS.api)
  mdm_command_history(ident, :completed, api: api)
end

#completed_policies(ident, api: JSS.api) ⇒ Object

The array from .policy_logs, limited to status = :completed

See Also:

  • ManagementHistory::ClassMethods.policy_logs

562
563
564
 
# File 'lib/jss/api_object/management_history.rb', line 562

def completed_policies(ident, api: JSS.api)
  policy_logs(ident, api: api).select { |pl| pl.status == :completed }
end

#computer_usage_logs(ident, api: JSS.api) ⇒ Array<JSS::ManagementHistory::ComputerUsageLog> Also known as: usage_logs

The history of usage events for a computer

Parameters:

  • ident (Type) —

    The identifier for the object - id, name, sn, udid, etc.

  • api (JSS::APIConnection) (defaults to: JSS.api) —

    The API connection to use for the query defaults to the currently active connection

Returns:

Raises:


522
523
524
525
526
 
# File 'lib/jss/api_object/management_history.rb', line 522

def computer_usage_logs(ident, api: JSS.api)
  raise JSS::UnsupportedError, 'Only computers have usage logs' unless self == JSS::Computer
  hist = management_history(ident, :computer_usage_logs, api: api)
  hist.map! { |evt| JSS::ManagementHistory::ComputerUsageLog.new evt }
end

#ebook_history(ident, status = nil, api: JSS.api) ⇒ Array<JSS::ManagementHistory::EBook> Also known as: managed_ebook_history

The history of ebooks for a mobile device

Parameters:

  • ident (Type) —

    The identifier for the object - id, name, sn, udid, etc.

  • status (Symbol) (defaults to: nil) —

    Return only the :installed, :pending, or :failed apps

  • api (JSS::APIConnection) (defaults to: JSS.api) —

    The API connection to use for the query defaults to the currently active connection

Returns:

Raises:


584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'lib/jss/api_object/management_history.rb', line 584

def ebook_history(ident, status = nil, api: JSS.api)
  raise JSS::UnsupportedError, 'Only mobile devices have ebooks' unless self == JSS::MobileDevice

  hist = management_history(ident, :ebooks, api: api)
  if status
    raise JSS::InvalidDataError, 'status must be one of :installed, :pending, or :failed' unless HIST_APP_STATUSES.include? status
    statuses_to_do = [status]
  else
    statuses_to_do = HIST_APP_STATUSES
  end # if status

  result = []

  statuses_to_do.each do |a_status|
    # merge the sources of installed apps into their hashes
    books =
      if a_status == :installed
        instbooks = []
        hist[a_status].each do |src, books_from_src|
          real_src =
            case src
            when HIST_RAW_SOURCE_EBOOK_IN_HOUSE then HIST_SOURCE_IN_HOUSE
            when HIST_RAW_SOURCE_IBOOKSTORE then HIST_SOURCE_IBOOKSTORE
            else HIST_SOURCE_OTHER
            end # case src
          instbooks += books_from_src.map! { |book| book[:source] = real_src }
        end
        instbooks
      else
        hist[a_status]
      end
    # now 'books' is an array of hashes of books with the same status
    # and if they are :installed, their source is in the hash

    # merge the statuses of the books into their hashes
    result += books.map! do |book|
      # set the :status in the hash
      book[:status] = a_status
      JSS::ManagementHistory::EBook.new book
    end # map do |books|
  end # statuses_to_do.each do |a_status|

  result
end

#failed_app_store_apps(ident, api: JSS.api) ⇒ Object Also known as: failed_managed_apps

shortcut for app_store_app_history where status = :failed

See Also:


478
479
480
 
# File 'lib/jss/api_object/management_history.rb', line 478

def failed_app_store_apps(ident, api: JSS.api)
  app_store_app_history(ident, :failed, api: api)
end

#failed_ebooks(ident, api: JSS.api) ⇒ Object Also known as: failed_managed_ebooks

shortcut for ebook_history where status = :failed

See Also:


652
653
654
 
# File 'lib/jss/api_object/management_history.rb', line 652

def failed_ebooks(ident, api: JSS.api)
  ebook_history(ident, :failed, api: api)
end

#failed_mdm_commands(ident, api: JSS.api) ⇒ Array<JSS::ManagementHistory::MDMCommand> Also known as: failed_commands

The history of failed mdm commands for a target

Parameters:

  • ident (Type) —

    The identifier for the object - id, name, sn, udid, etc.

  • api (JSS::APIConnection) (defaults to: JSS.api) —

    The API connection to use for the query defaults to the currently active connection

Returns:


340
341
342
 
# File 'lib/jss/api_object/management_history.rb', line 340

def failed_mdm_commands(ident, api: JSS.api)
  mdm_command_history(ident, :failed, api: api)
end

#failed_policies(ident, api: JSS.api) ⇒ Object

The array from .policy_logs, limited to status = :failed

See Also:

  • ManagementHistory::ClassMethods.policy_logs

569
570
571
 
# File 'lib/jss/api_object/management_history.rb', line 569

def failed_policies(ident, api: JSS.api)
  policy_logs(ident, api: api).select { |pl| pl.status == :failed }
end

#installed_app_store_apps(ident, api: JSS.api) ⇒ Object Also known as: installed_managed_apps

shortcut for app_store_app_history where status = :installed

See Also:


460
461
462
 
# File 'lib/jss/api_object/management_history.rb', line 460

def installed_app_store_apps(ident, api: JSS.api)
  app_store_app_history(ident, :installed, api: api)
end

#installed_ebooks(ident, api: JSS.api) ⇒ Object Also known as: installed_managed_ebooks

shortcut for ebook_history where status = :installed

See Also:


634
635
636
 
# File 'lib/jss/api_object/management_history.rb', line 634

def installed_ebooks(ident, api: JSS.api)
  ebook_history(ident, :installed, api: api)
end

#last_mdm_contact(ident, api: JSS.api) ⇒ Time?

The time of the most recently completed MDM command.

For Mobile Devices, this seems to be the best indicator of the real last-contact time, since the last_inventory_update is changed when changes are made via the API.

Parameters:

  • ident (Type) —

    The identifier for the object - id, name, sn, udid, etc.

  • api (JSS::APIConnection) (defaults to: JSS.api) —

    The API connection to use for the query defaults to the currently active connection

Returns:

  • (Time, nil) —

    An array of completed MDMCommands


309
310
311
312
313
314
 
# File 'lib/jss/api_object/management_history.rb', line 309

def last_mdm_contact(ident, api: JSS.api)
  cmds = completed_mdm_commands(ident, api: api)
  return nil if cmds.empty?

  JSS.epoch_to_time cmds.map{|cmd| cmd.completed_epoch }.max
end

#mac_app_store_app_history(ident, status = nil, api: JSS.api) ⇒ Array<JSS::ManagementHistory::MacAppStoreApp>

The history of app store apps for a computer

Parameters:

  • ident (Type) —

    The identifier for the object - id, name, sn, udid, etc.

  • status (Symbol) (defaults to: nil) —

    Return only the :installed, :pending, or :failed apps

  • api (JSS::APIConnection) (defaults to: JSS.api) —

    The API connection to use for the query defaults to the currently active connection

Returns:

Raises:


356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/jss/api_object/management_history.rb', line 356

def mac_app_store_app_history(ident, status = nil, api: JSS.api)
  raise JSS::UnsupportedError, 'Only computers have mac app store apps' unless self == JSS::Computer

  hist = management_history(ident, :mac_app_store_applications, api: api)
  if status
    raise JSS::InvalidDataError, 'status must be one of :installed, :pending, or :failed' unless HIST_APP_STATUSES.include? status
    statuses_to_do = [status]
  else
    statuses_to_do = HIST_APP_STATUSES
  end # if status

  result = []

  statuses_to_do.each do |a_status|
    result += hist[a_status].map! do |app|
      # set the :status
      app[:status] = a_status
      JSS::ManagementHistory::MacAppStoreApp.new app
    end # map do |cmd|
  end # statuses_to_do.each do |a_status|

  result
end

#management_history(ident, subset = nil, api: JSS.api) ⇒ Hash, Array Also known as: history

Return the raw management history for a Computer or Mobile Device

WARNING: It’s huge, better to use a subset.

NOTE: This returns the raw JSON data from the API, parsed into a ruby Hash. Use the subset-specific methods to retrieve more consistent arrays of ruby-jss objects for each kind of history event, e.g. JSS::Computer.audits(id) or JSS::MobileDevice.audits(id) to get an array of JSS::ManagementHistory::AuditEvent objects

Parameters:

  • ident (Integer, String) —

    An identifier (id, name, serialnumber, macadress or udid) of the computer or device for which to retrieve history

  • subset (Symbol) (defaults to: nil) —

    the subset to return, rather than full history.

  • api (JSS::APIConnection) (defaults to: JSS.api) —

    an API connection to use for the query. Defaults to the corrently active API. See APIConnection

Returns:

  • (Hash, Array) —

    The raw full history or subset requested

Raises:


189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/jss/api_object/management_history.rb', line 189

def management_history(ident, subset = nil, api: JSS.api)
  id = valid_id ident, api: api
  raise JSS::NoSuchItemError, "No #{self::RSRC_OBJECT_KEY} matches identifier: #{ident}" unless id

  if self == JSS::Computer
    @hist_subsets ||= HIST_COMPUTER_SUBSETS
    @hist_rsrc ||= HIST_COMPUTER_RSRC
    @hist_key ||= HIST_COMPUTER_KEY
  else
    @hist_subsets ||= HIST_DEVICE_SUBSETS
    @hist_rsrc ||= HIST_DEVICE_RSRC
    @hist_key ||= HIST_DEVICE_KEY
  end

  if subset
    raise "Subset must be one of :#{@hist_subsets.join ', :'}" unless @hist_subsets.include? subset
    subset_rsrc = @hist_rsrc + "/id/#{id}/subset/#{subset}"
    api.get_rsrc(subset_rsrc)[@hist_key][subset]
  else
    api.get_rsrc(@hist_rsrc + "/id/#{id}")[@hist_key]
  end
end

#mdm_command_history(ident, status = nil, api: JSS.api) ⇒ Array<JSS::ManagementHistory::MDMCommand> Also known as: commands, management_command_history

The history of mdm commands for a target

Parameters:

  • ident (Type) —

    The identifier for the object - id, name, sn, udid, etc.

  • status (Symbol) (defaults to: nil) —

    Return only the :completed, :pending, or :failed commands

  • api (JSS::APIConnection) (defaults to: JSS.api) —

    The API connection to use for the query defaults to the currently active connection

Returns:


253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/jss/api_object/management_history.rb', line 253

def mdm_command_history(ident, status = nil, api: JSS.api)
  subset = self == JSS::Computer ? :commands : :management_commands
  hist = management_history(ident, subset, api: api)
  if status
    raise JSS::InvalidDataError, 'status must be one of :completed, :pending, or :failed' unless HIST_MDM_STATUSES.include? status
    statuses_to_do = [status]
  else
    statuses_to_do = HIST_MDM_STATUSES
  end # if status

  result = []

  statuses_to_do.each do |a_status|
    result += hist[a_status].map! do |cmd|
      # failed computer cmds have the error message in cmd[:status]
      # failed mdm commands have them in cmd[:error], where they should be
      cmd[:error] ||= cmd[:status] if a_status == :failed

      # but we always set the :status
      cmd[:status] = a_status

      JSS::ManagementHistory::MDMCommand.new cmd
    end # map do |cmd|
  end # statuses_to_do.each do |a_status|
  result
end

#mobile_device_app_history(ident, status = nil, api: JSS.api) ⇒ Array<JSS::ManagementHistory::MobileDeviceApp>

The history of apps for a mobile device

Parameters:

  • ident (Type) —

    The identifier for the object - id, name, sn, udid, etc.

  • status (Symbol) (defaults to: nil) —

    Return only the :installed, :pending, or :failed apps

  • api (JSS::APIConnection) (defaults to: JSS.api) —

    The API connection to use for the query defaults to the currently active connection

Returns:

Raises:


391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/jss/api_object/management_history.rb', line 391

def mobile_device_app_history(ident, status = nil, api: JSS.api)
  raise JSS::UnsupportedError, 'Only mobile devices have mobile device apps' unless self == JSS::MobileDevice

  hist = management_history(ident, :applications, api: api)
  if status
    raise JSS::InvalidDataError, 'status must be one of :installed, :pending, or :failed' unless HIST_APP_STATUSES.include? status
    statuses_to_do = [status]
  else
    statuses_to_do = HIST_APP_STATUSES
  end # if status

  result = []

  statuses_to_do.each do |a_status|
    # merge the sources of installed apps into their hashes
    apps =
      if a_status == :installed
        instapps = []
        hist[a_status].each do |src, apps_from_src|
          real_src =
            case src
            when HIST_RAW_SOURCE_APP_IN_HOUSE then HIST_SOURCE_IN_HOUSE
            when HIST_RAW_SOURCE_APP_STORE then HIST_SOURCE_APP_STORE
            else HIST_SOURCE_OTHER
            end # case src
          instapps += apps_from_src.map! { |iapp| iapp[:source] = real_src }
        end
        instapps
      else
        hist[a_status]
      end
    # now 'apps' is an array of hashes of apps with the same status
    # and if they are :installed, their source is in the hash

    # merge the statuses of the apps into their hashes
    result += apps.map! do |app|
      # set the :status in the hash
      app[:status] = a_status
      JSS::ManagementHistory::MobileDeviceApp.new app
    end # map do |cmd|
  end # statuses_to_do.each do |a_status|

  result
end

#pending_app_store_apps(ident, api: JSS.api) ⇒ Object Also known as: pending_managed_apps

shortcut for app_store_app_history where status = :pending

See Also:


469
470
471
 
# File 'lib/jss/api_object/management_history.rb', line 469

def pending_app_store_apps(ident, api: JSS.api)
  app_store_app_history(ident, :pending, api: api)
end

#pending_ebooks(ident, api: JSS.api) ⇒ Object Also known as: pending_managed_ebooks

shortcut for ebook_history where status = :pending

See Also:


643
644
645
 
# File 'lib/jss/api_object/management_history.rb', line 643

def pending_ebooks(ident, api: JSS.api)
  ebook_history(ident, :pending, api: api)
end

#pending_mdm_commands(ident, api: JSS.api) ⇒ Array<JSS::ManagementHistory::MDMCommand> Also known as: pending_commands

The history of pending mdm commands for a target

Parameters:

  • ident (Type) —

    The identifier for the object - id, name, sn, udid, etc.

  • api (JSS::APIConnection) (defaults to: JSS.api) —

    The API connection to use for the query defaults to the currently active connection

Returns:


326
327
328
 
# File 'lib/jss/api_object/management_history.rb', line 326

def pending_mdm_commands(ident, api: JSS.api)
  mdm_command_history(ident, :pending, api: api)
end

#policy_logs(ident, api: JSS.api) ⇒ Array<JSS::ManagementHistory::PolicyLog>

The history of policy execution for a computer

Parameters:

  • ident (Type) —

    The identifier for the object - id, name, sn, udid, etc.

  • api (JSS::APIConnection) (defaults to: JSS.api) —

    The API connection to use for the query defaults to the currently active connection

Returns:

Raises:


553
554
555
556
557
 
# File 'lib/jss/api_object/management_history.rb', line 553

def policy_logs(ident, api: JSS.api)
  raise JSS::UnsupportedError, 'Only computers have policy logs' unless self == JSS::Computer
  hist = management_history(ident, :policy_logs, api: api)
  hist.map! { |evt| JSS::ManagementHistory::PolicyLog.new evt }
end

#screen_sharing_logs(ident, api: JSS.api) ⇒ Array<JSS::ManagementHistory::ScreenSharingLog>

The history of screen sharing events for a computer

Parameters:

  • ident (Type) —

    The identifier for the object - id, name, sn, udid, etc.

  • api (JSS::APIConnection) (defaults to: JSS.api) —

    The API connection to use for the query defaults to the currently active connection

Returns:

Raises:


538
539
540
541
542
 
# File 'lib/jss/api_object/management_history.rb', line 538

def screen_sharing_logs(ident, api: JSS.api)
  raise JSS::UnsupportedError, 'Only computers have screen sharing logs' unless self == JSS::Computer
  hist = management_history(ident, :screen_sharing_logs, api: api)
  hist.map! { |evt| JSS::ManagementHistory::ScreenSharingLog.new evt }
end

#user_location_history(ident, api: JSS.api) ⇒ Array<JSS::ManagementHistory::UserLocationChange>

The history of User/Location changes for a target

Parameters:

  • ident (Type) —

    The identifier for the object - id, name, sn, udid, etc.

  • api (JSS::APIConnection) (defaults to: JSS.api) —

    The API connection to use for the query defaults to the currently active connection

Returns:


237
238
239
240
 
# File 'lib/jss/api_object/management_history.rb', line 237

def user_location_history(ident, api: JSS.api)
  hist = management_history(ident, :user_location, api: api)
  hist.map! { |evt| JSS::ManagementHistory::UserLocationChange.new evt }
end