Class: OsuAPI::BaseClient

Inherits:

Object

• Object
• OsuAPI::BaseClient

Defined in:

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

Overview

Note:

Any inputs won't be validated. Please understand that any kind of input will be sent to the server. So please test your request on other application beforehand.

Direct Known Subclasses

V1Client, V2Client

Constant Summary

METHOD_PROCESS_MAP =

Process mapping. Extension developer can slap their extra function in this class as well as long as it follows the proper naming.

{
  faraday: :process_faraday_request,
}

Class Method Summary

• .base_url ⇒ String

  get class' base url.

• .create(data) ⇒ BaseClient
• .inherit(cls)

  clone required constants for subclass.

Instance Method Summary

• #base_url ⇒ String

  get class' base url.

• #initialize(mode: :faraday, **data) ⇒ BaseClient constructor

  Initialize base API client.

• #inspect ⇒ String

Constructor Details

#initialize(mode: :faraday, **data) ⇒ BaseClient

Initialize base API client

Class Method Details

.base_url ⇒ String

get class' base url

Returns:

• (String)

.create(data) ⇒ BaseClient

Returns:

• (BaseClient)

See Also:

• #initialize

.inherit(cls)

This method returns an undefined value.

clone required constants for subclass

Instance Method Details

#base_url ⇒ String

get class' base url

Returns:

• (String)

#inspect ⇒ String

Returns:

• (String)