Class: Aikido::Zen::RuntimeSettings::RateLimitSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/aikido/zen/runtime_settings/rate_limit_settings.rb

Overview

Simple data object that holds the configuration for rate limiting a given endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(enabled: false, max_requests: 1000, period: 60) ⇒ RateLimitSettings

Returns a new instance of RateLimitSettings.



40
41
42
43
44
 
# File 'lib/aikido/zen/runtime_settings/rate_limit_settings.rb', line 40

def initialize(enabled: false, max_requests: 1000, period: 60)
  @enabled = enabled
  @period = period
  @max_requests = max_requests
end

Instance Attribute Details

#enabled ⇒ Boolean (readonly)

Returns:

  • (Boolean) 


32
33
34
 
# File 'lib/aikido/zen/runtime_settings/rate_limit_settings.rb', line 32

def enabled
  @enabled
end

#max_requests ⇒ Integer (readonly)

Returns:

  • (Integer) 


38
39
40
 
# File 'lib/aikido/zen/runtime_settings/rate_limit_settings.rb', line 38

def max_requests
  @max_requests
end

#period ⇒ Integer (readonly)

Returns the fixed window to bucket requests in, in seconds.

Returns:

  • (Integer) —

    the fixed window to bucket requests in, in seconds.



35
36
37
 
# File 'lib/aikido/zen/runtime_settings/rate_limit_settings.rb', line 35

def period
  @period
end

Class Method Details

.disabled ⇒ Aikido::Zen::RuntimeSettings::RateLimitSettings

Initializes a disabled object that we can use as a default value for endpoints that have not configured rate limiting.

Returns:



27
28
29
 
# File 'lib/aikido/zen/runtime_settings/rate_limit_settings.rb', line 27

def self.disabled
  new(enabled: false)
end

.from_json(data) ⇒ Aikido::Zen::RateLimitSettings

Initialize the settings from an API response.

Parameters:

  • data (Hash) —

    the deserialized JSON data.

Options Hash (data):

  • "enabled" (Boolean)
  • "maxRequests" (Integer)
  • "windowSizeInMS" (Integer)

Returns:

  • (Aikido::Zen::RateLimitSettings) 


15
16
17
18
19
20
21
 
# File 'lib/aikido/zen/runtime_settings/rate_limit_settings.rb', line 15

def self.from_json(data)
  new(
    enabled: !!data["enabled"],
    max_requests: Integer(data["maxRequests"]),
    period: Integer(data["windowSizeInMS"]) / 1000
  )
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql? 



50
51
52
53
54
55
 
# File 'lib/aikido/zen/runtime_settings/rate_limit_settings.rb', line 50

def ==(other)
  other.is_a?(self.class) &&
    other.enabled == enabled &&
    other.period == period &&
    other.max_requests == max_requests
end

#enabled? ⇒ Boolean

Returns:

  • (Boolean) 


46
47
48
 
# File 'lib/aikido/zen/runtime_settings/rate_limit_settings.rb', line 46

def enabled?
  @enabled
end