Class: NexusMods::Api::ApiLimits

Inherits:
Object
  • Object
show all
Defined in:
lib/nexus_mods/api/api_limits.rb

Overview

Object giving the NexusMods API limits

Instance Method Summary collapse

Constructor Details

#initialize(daily_limit:, daily_remaining:, daily_reset:, hourly_limit:, hourly_remaining:, hourly_reset:) ⇒ ApiLimits

Constructor

Parameters

  • daily_limit (Integer): The daily limit

  • daily_remaining (Integer): The daily remaining

  • daily_reset (Integer): The daily reset time

  • hourly_limit (Integer): The hourly limit

  • hourly_remaining (Integer): The hourly remaining

  • hourly_reset (Integer): The hourly reset time



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/nexus_mods/api/api_limits.rb', line 28

def initialize(
  daily_limit:,
  daily_remaining:,
  daily_reset:,
  hourly_limit:,
  hourly_remaining:,
  hourly_reset:
)
  @daily_limit = daily_limit
  @daily_remaining = daily_remaining
  @daily_reset = daily_reset
  @hourly_limit = hourly_limit
  @hourly_remaining = hourly_remaining
  @hourly_reset = hourly_reset
end

Instance Method Details

#==(other) ⇒ Object

Equality operator

Parameters

  • other (Object): Other object to compare with

Result

  • Boolean: Are objects equal?



50
51
52
53
54
55
56
57
58
 
# File 'lib/nexus_mods/api/api_limits.rb', line 50

def ==(other)
  other.is_a?(ApiLimits) &&
    @daily_limit == other.daily_limit &&
    @daily_remaining == other.daily_remaining &&
    @daily_reset == other.daily_reset &&
    @hourly_limit == other.hourly_limit &&
    @hourly_remaining == other.hourly_remaining &&
    @hourly_reset == other.hourly_reset
end