Class: SDM::RateLimitMetadata

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

Overview

RateLimitMetadata contains information about remaining requests avaialable to the user over some timeframe.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket: nil, limit: nil, remaining: nil, reset_at: nil) ⇒ RateLimitMetadata

Returns a new instance of RateLimitMetadata.



5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
 
# File 'lib/models/porcelain.rb', line 5125

def initialize(
  bucket: nil,
  limit: nil,
  remaining: nil,
  reset_at: nil
)
  @bucket = bucket == nil ? "" : bucket
  @limit = limit == nil ? 0 : limit
  @remaining = remaining == nil ? 0 : remaining
  @reset_at = reset_at == nil ? nil : reset_at
end

Instance Attribute Details

#bucket ⇒ Object

The bucket this user/token is associated with, which may be shared between multiple users/tokens.



5116
5117
5118
 
# File 'lib/models/porcelain.rb', line 5116

def bucket
  @bucket
end

#limit ⇒ Object

How many total requests the user/token is authorized to make before being rate limited.



5119
5120
5121
 
# File 'lib/models/porcelain.rb', line 5119

def limit
  @limit
end

#remaining ⇒ Object

How many remaining requests out of the limit are still avaialable.



5121
5122
5123
 
# File 'lib/models/porcelain.rb', line 5121

def remaining
  @remaining
end

#reset_at ⇒ Object

The time when remaining will be reset to limit.



5123
5124
5125
 
# File 'lib/models/porcelain.rb', line 5123

def reset_at
  @reset_at
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



5137
5138
5139
5140
5141
5142
5143
 
# File 'lib/models/porcelain.rb', line 5137

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