cbortz / vainglory-api-ruby Goto Github PK

Issue

TBD

TODO

TBD

My code looks something like this:

db = VaingloryAPI(api_key)
match_info = db.matches({"filter[playerIds]" => id, "page[limit]" => numMatches})

I'm looking for a full match response similar to the data that I get when I run the following curl command:

curl -g "https://api.dc01.gamelockerapp.com/shards/na/matches?filter[createdAt-start]=2017-04-20T13:00:30Z&sort=-createdAt" \
-H "Authorization: Bearer apikey"  \
-H "X-TITLE-ID: semc-vainglory" \
-H "Accept: application/vnd.api+json" | jq

Currently, my match_info from my code only returns the data array of the full match response and none of the included array. How can I get access to the included array?

The Vainglory API allows for requesting compressed responses if desired, so we should support that. The plan is to leave it disabled by default. When instantiating a new VaingloryAPI::Client a user should be able to pass in the option to enable it. For example:

VaingloryAPI.new("API_KEY", "na", gzip: true)

Additional information: https://developer.vainglorygame.com/docs#gzip

As a side note...

After looking at the previous example, I think I want to start accepting a single options parameter as a hash when instantiating new clients. The updated syntax might look like this:

VaingloryAPI.new("API_KEY", region: "na", gzip: true)

If I do implement this change, I should allow for backward compatibility because I am nowhere near ready to bump to v1.

Issue

VaingloryAPI::Client#players should allow a developer to paginate results as per the Vainglory API "Pagination" documentation.

TODO

• Implement fix
• Update specs
• Update YARD

Successfully fixing this should bring us to v0.1.0

The CHANGELOG should contain pertinent information about each release, including any major changes and bug fixes.