Class: TrophyApiClient::LeaderboardsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/trophy_api_client/leaderboards/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ TrophyApiClient::LeaderboardsClient

Parameters:



16
17
18
 
# File 'lib/trophy_api_client/leaderboards/client.rb', line 16

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ TrophyApiClient::RequestClient (readonly)

Returns:



12
13
14
 
# File 'lib/trophy_api_client/leaderboards/client.rb', line 12

def request_client
  @request_client
end

Instance Method Details

#all(include_finished: nil, request_options: nil) ⇒ Array<TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem>

Get all leaderboards for your organization. Finished leaderboards are excluded

by default.

Examples:

api = TrophyApiClient::Client.new(
  base_url: "https://api.example.com",
  environment: TrophyApiClient::Environment::PRODUCTION,
  api_key: "YOUR_API_KEY"
)
api.leaderboards.all(include_finished: true)

Parameters:

  • include_finished (Boolean) (defaults to: nil) —

    When set to ‘true’, leaderboards with status ‘finished’ will be included in the response. By default, finished leaderboards are excluded.

  • request_options (TrophyApiClient::RequestOptions) (defaults to: nil)

Returns:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/trophy_api_client/leaderboards/client.rb', line 34

def all(include_finished: nil, request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.params = {
      **(request_options&.additional_query_parameters || {}),
      "includeFinished": include_finished
    }.compact
    unless request_options.nil? || request_options&.additional_body_parameters.nil?
      req.body = { **(request_options&.additional_body_parameters || {}) }.compact
    end
    req.url "#{@request_client.get_url(environment: api, request_options: request_options)}/leaderboards"
  end
  parsed_json = JSON.parse(response.body)
  parsed_json&.map do |item|
    item = item.to_json
    TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem.from_json(json_object: item)
  end
end

#get(key:, offset: nil, limit: nil, run: nil, user_id: nil, user_attributes: nil, request_options: nil) ⇒ TrophyApiClient::LeaderboardResponseWithRankings

Get a specific leaderboard by its key.

Examples:

api = TrophyApiClient::Client.new(
  base_url: "https://api.example.com",
  environment: TrophyApiClient::Environment::PRODUCTION,
  api_key: "YOUR_API_KEY"
)
api.leaderboards.get(
  key: "weekly-words",
  offset: 1,
  limit: 1,
  run: "2025-01-15",
  user_id: "user-123",
  user_attributes: "city:London"
)

Parameters:

  • key (String) —

    Unique key of the leaderboard as set when created.

  • offset (Integer) (defaults to: nil) —

    Number of rankings to skip for pagination.

  • limit (Integer) (defaults to: nil) —

    Maximum number of rankings to return. Cannot be greater than the size of the leaderboard.

  • run (String) (defaults to: nil) —

    Specific run date in YYYY-MM-DD format. If not provided, returns the current run.

  • user_id (String) (defaults to: nil) —

    When provided, offset is relative to this user’s position on the leaderboard. If the user is not found in the leaderboard, returns empty rankings array.

  • user_attributes (String) (defaults to: nil) —

    Attribute key and value to filter the rankings by, separated by a colon. For example, city:London. This parameter is required, and only valid for leaderboards with a breakdown attribute.

  • request_options (TrophyApiClient::RequestOptions) (defaults to: nil)

Returns:



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/trophy_api_client/leaderboards/client.rb', line 88

def get(key:, offset: nil, limit: nil, run: nil, user_id: nil, user_attributes: nil, request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.params = {
      **(request_options&.additional_query_parameters || {}),
      "offset": offset,
      "limit": limit,
      "run": run,
      "userId": user_id,
      "userAttributes": user_attributes
    }.compact
    unless request_options.nil? || request_options&.additional_body_parameters.nil?
      req.body = { **(request_options&.additional_body_parameters || {}) }.compact
    end
    req.url "#{@request_client.get_url(environment: api, request_options: request_options)}/leaderboards/#{key}"
  end
  TrophyApiClient::LeaderboardResponseWithRankings.from_json(json_object: response.body)
end