Class: OsuAPI::V1Client

Inherits:

BaseClient

• Object
• BaseClient
• OsuAPI::V1Client

Defined in:

(osu-api 0.1.0) osu-api/client.rb

Overview

osu! V1 API client

a simple wrapping of standard osu! old API client.

Constant Summary

Constants inherited from BaseClient

BaseClient::METHOD_PROCESS_MAP

Class Method Summary

• .base_url ⇒ String

  /api appended from BASE_URI.

Instance Method Summary

• #get_beatmaps(body = nil, **data) ⇒ Response::Base

  Response data from /get_beatmaps.

• #get_multiplayer(body = nil, mp:) ⇒ Response::Base

  Response data from /get_match.

• #get_replay(body = nil, **data) ⇒ Response::Base

  Response data from /get_replay.

• #get_replay_id(body = nil, s:, **data) ⇒ Response::Base

  Response data from /get_replay.

• #get_replay_user(body = nil, b:, u:, **data) ⇒ Response::Base

  Response data from /get_replay.

• #get_scores(body = nil, b:, **data) ⇒ Response::Base

  Response data from /get_scores.

• #get_user(body = nil, u:, **data) ⇒ Response::Base

  Response data from /get_user.

• #get_user_best_scores(body = nil, u:, **data) ⇒ Response::Base

  Response data from /get_user_best.

• #get_user_recent_play(body = nil, u:, **data) ⇒ Response::Base

  Response data from /get_user_recent.

• #initialize(mode: :faraday, key:) ⇒ V1Client constructor

  A new instance of V1Client.

• #version ⇒ Integer

  API version (v1).

Methods inherited from BaseClient

#base_url, create, inherit, #inspect

Constructor Details

#initialize(mode: :faraday, key:) ⇒ V1Client

Returns a new instance of V1Client.

Class Method Details

.base_url ⇒ String

Returns /api appended from BASE_URI.

Returns:

• (String) —

  /api appended from BASE_URI

Instance Method Details

#get_beatmaps(body = nil, **data) ⇒ Response::Base

Returns response data from /get_beatmaps.

Parameters:

• data (Hash) —

  additional keys accepted for /get_beatmaps

Options Hash (**data):

• since (String)
• s (String)
• b (String)
• u (String)
• type (String)
• m (String)
• a (String)
• h (String)
• limit (String)
• mods (String)

Returns:

• (Response::Base) —

  response data from /get_beatmaps

#get_multiplayer(body = nil, mp:) ⇒ Response::Base

Returns response data from /get_match.

Parameters:

• mp (String) —

  Required

• data (Hash) —

  additional keys accepted for /get_match

Returns:

• (Response::Base) —

  response data from /get_match

#get_replay(body = nil, **data) ⇒ Response::Base

Returns response data from /get_replay.

Parameters:

• data (Hash) —

  additional keys accepted for /get_replay

Options Hash (**data):

• b (String)
• u (String)
• type (String)
• m (String)
• s (String)
• mods (String)

Returns:

• (Response::Base) —

  response data from /get_replay

#get_replay_id(body = nil, s:, **data) ⇒ Response::Base

Note:

Please match the s (score_id) and m (mode) properly. Replay not available error may hit you if it happens.

Returns response data from /get_replay.

Parameters:

• s (String) —

  Required

• data (Hash) —

  additional keys accepted for /get_replay

Options Hash (**data):

• m (String)
• mods (String)

Returns:

• (Response::Base) —

  response data from /get_replay

#get_replay_user(body = nil, b:, u:, **data) ⇒ Response::Base

Returns response data from /get_replay.

Parameters:

• b (String) —

  Required

• u (String) —

  Required

• data (Hash) —

  additional keys accepted for /get_replay

Options Hash (**data):

• type (String)
• m (String)
• mods (String)

Returns:

• (Response::Base) —

  response data from /get_replay

#get_scores(body = nil, b:, **data) ⇒ Response::Base

Returns response data from /get_scores.

Parameters:

• b (String) —

  Required

• data (Hash) —

  additional keys accepted for /get_scores

Options Hash (**data):

• u (String)
• type (String)
• m (String)
• limit (String)

Returns:

• (Response::Base) —

  response data from /get_scores

#get_user(body = nil, u:, **data) ⇒ Response::Base

Returns response data from /get_user.

Parameters:

• u (String) —

  Required

• data (Hash) —

  additional keys accepted for /get_user

Options Hash (**data):

• type (String)
• m (String)
• event_days (String)

Returns:

• (Response::Base) —

  response data from /get_user

#get_user_best_scores(body = nil, u:, **data) ⇒ Response::Base

Returns response data from /get_user_best.

Parameters:

• u (String) —

  Required

• data (Hash) —

  additional keys accepted for /get_user_best

Options Hash (**data):

• type (String)
• m (String)
• limit (String)

Returns:

• (Response::Base) —

  response data from /get_user_best

#get_user_recent_play(body = nil, u:, **data) ⇒ Response::Base

Returns response data from /get_user_recent.

Parameters:

• u (String) —

  Required

• data (Hash) —

  additional keys accepted for /get_user_recent

Options Hash (**data):

• type (String)
• m (String)
• limit (String)

Returns:

• (Response::Base) —

  response data from /get_user_recent

#version ⇒ Integer

Returns API version (v1).

Returns:

• (Integer) —

  API version (v1)