lewismorgan / malzahar Goto Github PK

Refactor out the RiotApi's core method getJsonResponseString into using a new method:

• request(path): Single<Pair<Response, Result<String, FuelError>>>

getJsonResponseString should still be used by higher level abstractions of the api (ex: Summoners), this format can allow usage of headers for RiotApi.

Perhaps even getJsonResponseString should even abstract out FuelError as this should already be intercepted.

Create a built in rate limiting system that follows Rito's Rate Limiting Guidelines at https://developer.riotgames.com/rate-limiting.html.

Lazily create a request. If rate limit is exceeded, the request will be queued to try again, and then emitted once successful.

In order to not spam the RiotApi, make the class use mocks. The core component of RiotApi class is intended to serve as a wrapper around the core URL methods for creating requests. There are also some cases that can't really be tested without mocking (or shouldn't) like rate limit testing.

Create enums representing game constants

https://developer.riotgames.com/game-constants.html

Core API's are considered as follows:

• https://developer.riotgames.com/api-methods/#champion-mastery-v3
• https://developer.riotgames.com/api-methods/#league-v3
• https://developer.riotgames.com/api-methods/#lol-static-data-v3
• https://developer.riotgames.com/api-methods/#lol-status-v3
• https://developer.riotgames.com/api-methods/#match-v3
• https://developer.riotgames.com/api-methods/#spectator-v3
• https://developer.riotgames.com/api-methods/#third-party-code-v3

The following are not going to be implemented (maybe a later date):

• https://developer.riotgames.com/api-methods/#tournament-v3 (and all tournament endpoints for other api methods)

This is to maintain consistency with the endpoints. Right now everything is stashed under the riot package.