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.



4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
 
# File 'lib/models/porcelain.rb', line 4957

def initialize(
  bucket: nil,
  limit: nil,
  remaining: nil,
  reset_at: nil
)
  if bucket != nil
    @bucket = bucket
  end
  if limit != nil
    @limit = limit
  end
  if remaining != nil
    @remaining = remaining
  end
  if reset_at != nil
    @reset_at = reset_at
  end
end

Instance Attribute Details

#bucket ⇒ Object

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



4948
4949
4950
 
# File 'lib/models/porcelain.rb', line 4948

def bucket
  @bucket
end

#limit ⇒ Object

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



4951
4952
4953
 
# File 'lib/models/porcelain.rb', line 4951

def limit
  @limit
end

#remaining ⇒ Object

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



4953
4954
4955
 
# File 'lib/models/porcelain.rb', line 4953

def remaining
  @remaining
end

#reset_at ⇒ Object

The time when remaining will be reset to limit.



4955
4956
4957
 
# File 'lib/models/porcelain.rb', line 4955

def reset_at
  @reset_at
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



4977
4978
4979
4980
4981
4982
4983
 
# File 'lib/models/porcelain.rb', line 4977

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