Class: SDM::Activity

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Overview

An Activity is a record of an action taken against a strongDM deployment, e.g. a user creation, resource deletion, sso configuration change, etc.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(actor: nil, completed_at: nil, description: nil, entities: nil, id: nil, ip_address: nil, verb: nil) ⇒ Activity

Returns a new instance of Activity.



1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
 
# File 'lib/models/porcelain.rb', line 1247

def initialize(
  actor: nil,
  completed_at: nil,
  description: nil,
  entities: nil,
  id: nil,
  ip_address: nil,
  verb: nil
)
  @actor = actor == nil ? nil : actor
  @completed_at = completed_at == nil ? nil : completed_at
  @description = description == nil ? "" : description
  @entities = entities == nil ? [] : entities
  @id = id == nil ? "" : id
  @ip_address = ip_address == nil ? "" : ip_address
  @verb = verb == nil ? "" : verb
end

Instance Attribute Details

#actor ⇒ Object

The account who executed this activity. If the actor later has a name or email change, that change is not reflected here. Actor is a snapshot of the executing account at the time an activity took place.



1231
1232
1233
 
# File 'lib/models/porcelain.rb', line 1231

def actor
  @actor
end

#completed_at ⇒ Object

The time this activity took effect.



1233
1234
1235
 
# File 'lib/models/porcelain.rb', line 1233

def completed_at
  @completed_at
end

#description ⇒ Object

A humanized description of the activity.



1235
1236
1237
 
# File 'lib/models/porcelain.rb', line 1235

def description
  @description
end

#entities ⇒ Object

The entities involved in this activity. These entities can be any first class entity in the strongDM system, eg. a user, a role, a node, an account grant. Not every activity affects explicit entities.



1239
1240
1241
 
# File 'lib/models/porcelain.rb', line 1239

def entities
  @entities
end

#id ⇒ Object

Unique identifier of the Activity.



1241
1242
1243
 
# File 'lib/models/porcelain.rb', line 1241

def id
  @id
end

#ip_address ⇒ Object

The IP from which this action was taken.



1243
1244
1245
 
# File 'lib/models/porcelain.rb', line 1243

def ip_address
  @ip_address
end

#verb ⇒ Object

The kind of activity which has taken place.



1245
1246
1247
 
# File 'lib/models/porcelain.rb', line 1245

def verb
  @verb
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



1265
1266
1267
1268
1269
1270
1271
 
# File 'lib/models/porcelain.rb', line 1265

def to_json(options = {})
  hash = {}
  self.instance_variables.each do |var|
    hash[var.id2name.delete_prefix("@")] = self.instance_variable_get var
  end
  hash.to_json
end