class Strava::Usage

Provides data on Strava API limits and usage.

Usage:

ca = Strava::Athlete.current_athlete
usage = ca.client.usage
usage.recent_usage  # => 254
usage.daily_usage   # => 12536
usage.recent_pct    # => 0.423
usage.daily_pct     # => 0.417

@see strava.github.io/api/#rate-limiting Strava Docs - Rate Limiting

Attributes

daily_limit[R]
daily_usage[R]
recent_limit[R]
recent_usage[R]

Public Class Methods

new(limit_str, usage_str) click to toggle source
# File lib/strava/usage.rb, line 17
def initialize(limit_str, usage_str)
  @recent_limit, @daily_limit = limit_str.to_s.split(',').map(&:to_i)
  @recent_usage, @daily_usage = usage_str.to_s.split(',').map(&:to_i)
end

Public Instance Methods

daily_pct() click to toggle source

Percentage of daily limit used.

@return [Float] Between 0.0 and 1.0

# File lib/strava/usage.rb, line 32
def daily_pct
  @daily_usage.fdiv(@daily_limit)
end
recent_pct() click to toggle source

Percentage of recent limit used.

@return [Float] Between 0.0 and 1.0

# File lib/strava/usage.rb, line 25
def recent_pct
  @recent_usage.fdiv(@recent_limit)
end