Class: StarkInfra::IssuingStock::Log

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

Overview

# IssuingStock::Log object

Every time an IssuingStock entity is updated, a corresponding IssuingStock::Log is generated for the entity. This log is never generated by the user, but it can be retrieved to check additional information on the IssuingStock.

## Attributes (return-only):

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

  • stock [IssuingStock]: IssuingStock entity to which the log refers to.

  • type [string]: type of the IssuingStock event which triggered the log creation. ex: “created”, “spent”, “restocked”, “lost”

  • count [integer]: shift in stock balance. ex: 10

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: nil, stock: nil, type: nil, count: nil, created: nil) ⇒ Log

Returns a new instance of Log.



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

def initialize(id: nil, stock: nil, type: nil, count: nil, created: nil)
  super(id)
  @stock = stock
  @type = type
  @count = count
  @created = StarkCore::Utils::Checks.check_datetime(created)
end

Instance Attribute Details

#count ⇒ Object (readonly)

Returns the value of attribute count.



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

def count
  @count
end

#created ⇒ Object (readonly)

Returns the value of attribute created.



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

def created
  @created
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#stock ⇒ Object (readonly)

Returns the value of attribute stock.



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

def stock
  @stock
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



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

def type
  @type
end

Class Method Details

.get(id, user: nil) ⇒ Object

# Retrieve a specific IssuingStock::Log

Receive a single IssuingStock::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:

  • IssuingStock::Log object with updated attributes



42
43
44
 
# File 'lib/issuingstock/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, stock_ids: nil, ids: nil, user: nil) ⇒ Object

# Retrieve paged IssuingStock::Logs

Receive a list of up to 100 IssuingStock::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 logs.

## 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 for log event types. ex: [“created”, “spent”, “restocked”, “lost”]

  • stock_ids [list of strings, default nil]: list of IssuingStock ids to filter logs. ex: [‘5656565656565656’, ‘4545454545454545’]

  • ids [list of strings, default nil]: list of 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 IssuingStock::Log objects with updated attributes

  • Cursor to retrieve the next page of Log objects



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/issuingstock/log.rb', line 94

def self.page(
  cursor: nil, limit: nil, after: nil, before: nil, types: nil, stock_ids: nil, 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,
    stock_ids: stock_ids,
    ids: ids,
    user: user,
    **resource
  )
end

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

# Retrieve IssuingStock::Logs

Receive a generator of IssuingStock::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 for log event types. ex: [“created”, “spent”, “restocked”, “lost”]

  • stock_ids [list of strings, default nil]: list of IssuingStock ids to filter logs. ex: [‘5656565656565656’, ‘4545454545454545’]

  • ids [list of strings, default nil]: list of 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 IssuingStock::Log objects with updated attributes



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

def self.query(limit: nil, after: nil, before: nil, types: nil, stock_ids: nil, 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,
    stock_ids: stock_ids,
    ids: ids,
    user: user,
    **resource
  )
end

.resource ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/issuingstock/log.rb', line 112

def self.resource
  request_maker = StarkInfra::IssuingStock.resource[:resource_maker]
  {
    resource_name: 'IssuingStockLog',
    resource_maker: proc { |json|
      Log.new(
        id: json['id'],
        stock: StarkCore::Utils::API.from_api_json(request_maker, json['stock']),
        type: json['type'],
        count: json['count'],
        created: json['created']
      )
    }
  }
end