Class: StarkInfra::PixReversal::Log

Inherits:
StarkCore::Utils::Resource
  • Object
show all
Defined in:
lib/pixreversal/log.rb

Overview

# PixReversal::Log object

Every time a PixReversal entity is modified, a corresponding PixReversal::Log is generated for the entity. This log is never generated by the user.

## Attributes (return-only):

  • id [string]: unique id returned when the log is created. ex: ‘5656565656565656’

  • created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)

  • type [string]: type of the PixReversal event which triggered the log creation. ex: ‘processing’ or ‘success’

  • reversal [PixReversal]: PixReversal entity to which the log refers to.

  • errors [list of strings]: list of errors linked to this PixReversal event.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, created:, type:, errors:, reversal:) ⇒ Log

Returns a new instance of Log.



22
23
24
25
26
27
28
 
# File 'lib/pixreversal/log.rb', line 22

def initialize(id:, created:, type:, errors:, reversal:)
  super(id)
  @type = type
  @errors = errors
  @reversal = reversal
  @created = StarkCore::Utils::Checks.check_datetime(created)
end

Instance Attribute Details

#created ⇒ Object (readonly)

Returns the value of attribute created.



21
22
23
 
# File 'lib/pixreversal/log.rb', line 21

def created
  @created
end

#errors ⇒ Object (readonly)

Returns the value of attribute errors.



21
22
23
 
# File 'lib/pixreversal/log.rb', line 21

def errors
  @errors
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



21
22
23
 
# File 'lib/pixreversal/log.rb', line 21

def id
  @id
end

#reversal ⇒ Object (readonly)

Returns the value of attribute reversal.



21
22
23
 
# File 'lib/pixreversal/log.rb', line 21

def reversal
  @reversal
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



21
22
23
 
# File 'lib/pixreversal/log.rb', line 21

def type
  @type
end

Class Method Details

.get(id, user: nil) ⇒ Object

# Retrieve a specific Log

Receive a single Log object previously created by the Stark Infra API by passing its id

## Parameters (required):

  • id [string]: object unique id. ex: ‘5656565656565656’

## Parameters (optional):

  • user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call

## Return:

  • Log object with updated attributes



42
43
44
 
# File 'lib/pixreversal/log.rb', line 42

def self.get(id, user: nil)
  StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
end

.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, reversal_ids: nil, user: nil) ⇒ Object

# Retrieve paged Logs

Receive a list of up to 100 Log objects previously created in the Stark Infra API and the cursor to the next page. Use this function instead of query if you want to manually page your reversals.

## Parameters (optional):

  • cursor [string, default nil]: cursor returned on the previous page function call

  • limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35

  • after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)

  • before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)

  • types [list of strings, default nil]: filter retrieved objects by types. ex: ‘success’ or ‘failed’

  • reversal_ids [list of strings, default nil]: list of PixReversal ids to filter retrieved objects. ex: [‘5656565656565656’, ‘4545454545454545’]

  • user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call

## Return:

  • list of Log objects with updated attributes

  • cursor to retrieve the next page of Log objects



91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/pixreversal/log.rb', line 91

def self.page(cursor: nil, limit: nil, after: nil, before: nil, types: nil, reversal_ids: nil, user: nil)
  after = StarkCore::Utils::Checks.check_date(after)
  before = StarkCore::Utils::Checks.check_date(before)
  StarkInfra::Utils::Rest.get_page(
    cursor: cursor,
    limit: limit,
    after: after,
    before: before,
    types: types,
    reversal_ids: reversal_ids,
    user: user,
    **resource
  )
end

.query(limit: nil, after: nil, before: nil, types: nil, reversal_ids: nil, user: nil) ⇒ Object

# Retrieve Logs

Receive a generator of Log objects previously created in the Stark Infra API

## Parameters (optional):

  • limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35

  • after [Date or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)

  • before [Date or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)

  • types [list of strings, default nil]: filter retrieved objects by types. ex: ‘success’ or ‘failed’

  • reversal_ids [list of strings, default nil]: list of PixReversal ids to filter retrieved objects. ex: [‘5656565656565656’, ‘4545454545454545’]

  • user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call

## Return:

  • generator of Log objects with updated attributes



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/pixreversal/log.rb', line 60

def self.query(limit: nil, after: nil, before: nil, types: nil, reversal_ids: nil, user: nil)
  after = StarkCore::Utils::Checks.check_date(after)
  before = StarkCore::Utils::Checks.check_date(before)
  StarkInfra::Utils::Rest.get_stream(
    limit: limit,
    after: after,
    before: before,
    types: types,
    reversal_ids: reversal_ids,
    user: user,
    **resource
  )
end

.resource ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/pixreversal/log.rb', line 106

def self.resource
  reversal_maker = StarkInfra::PixReversal.resource[:resource_maker]
  {
    resource_name: 'PixReversalLog',
    resource_maker: proc { |json|
      Log.new(
        id: json['id'],
        created: json['created'],
        type: json['type'],
        errors: json['errors'],
        reversal: StarkCore::Utils::API.from_api_json(reversal_maker, json['reversal'])
      )
    }
  }
end