From here onwards I'll try to adhere to [Semantic Versioning](http://semver.org). I kinda messed up early, and so it ended up as 2.0 (lol). Sorry guys! Treat my versioning as if it is 0.x.y. **Upgrading versions should NEVER break your project, so update to the latest every now and then. :P** [TODO](https://github.com/ChauTNguyen/kindred-api/blob/master/TODO.md) to view future changes. ## [2.0.77](https://github.com/ChauTNguyen/kindred-api/commit/e41acf1179da08731622bcd23f2e5d61eafff97c) - Add forAccountId and forPlatformId to getMatch and Match.by.id. The branch for this is [2.0.76](https://github.com/ChauTNguyen/kindred-api/tree/rel/2.0.76) due to a mistake. The real rel/2.0.76 was a hotfix instead of a rel branch. [Get match endpoint docs & examples](https://github.com/ChauTNguyen/kindred-api/wiki/MATCH-V3) have been updated. ``` RiotSchmick - 07/19/2017 We now have a solution for the participant mirror match issue in match details. When you query the match details via /lol/match/v3/matches/{matchId}, you can now specify an optional query parameter 'forAccountId'. If specified, the participant that maps to the given accountId will be non-obfuscated. For example: https://oc1.api.riotgames.com/lol/match/v3/matches/180100577?forAccountId=200009481 Returns the participant detail: { "participantId": 9, "player": { "platformId": "NA", "accountId": 32681423, "summonerName": "eQuinoXX", "summonerId": 224478, "currentPlatformId": "OC1", "currentAccountId": 200009481, "matchHistoryUri": "/v1/stats/player_history/NA/32681423", "profileIcon": 1667 } }(edited) ``` ## [2.0.76](https://github.com/ChauTNguyen/kindred-api/commit/62cd2a5063d821291090427610b3a3d1333d1193) - Remove static method rate limiting per 10s. Riot decided to remove the 1 request per 10 seconds limit after community backlash. The static method example below no longer works. It only takes a number. Furthermore, there is a bug as well: I have a hardcoded per 10s value. The code assumes that the method limit is per 10 seconds (because everything else is). Unfortunately, static data endpoints do not follow this rule. Avoid setting static data values -- I'll update the lib as Riot updates things. ## [2.0.75](https://github.com/ChauTNguyen/kindred-api/commit/5e58e2639fbb0d8aa254cc47ccb1c19d720eaf14) - Add static method rate limiting. Defaults are 1 req/10s 60 reqs/60minutes Note that method limits are changable. The static methods take in two rate limits (so we use an array), while the other methods simply just takes in one rate limit because they don't have an hourly limit (they only have per 10s limit). In case if Riot changes their limits again, you can always configure the method rate limits like below (as long as it fits the format at least, if Riot adds more limits to get summoner by name for example, it would need to be an array. however, the code itself only supports [per 10, per 60m]. Better for me to just hotfix tbh.) ```javascript var k = new _kindredApi.Kindred({ key: PROD_KEY, limits: _kindredApi.LIMITS.PROD, spread: true, timeout: 5000, debug: debug, showHeaders: true, methodLimits: { [_kindredApi.METHOD_TYPES.RETRIEVE_CHAMPION_BY_ID]: [0.5, 10], // array, [0] = per 10s, [1] = per hour [_kindredApi.METHOD_TYPES.GET_SUMMONER_BY_NAME]: 1 // constant } }); ``` In a way, the configurations above allow you to adjust the spreading of the rate limiter by increasing it or decreasing it to your liking. ## [2.0.74](https://github.com/ChauTNguyen/kindred-api/issues/22) - Fix impossible to set Redis config. Forgot about this! ## [2.0.73](https://github.com/ChauTNguyen/kindred-api/tree/feature/add-js-date-handling) - Add JS date handling for beginTime and endTime. ```javascript // passing in date string const opts1 = { beginTime: 'Tue June 4 2017 19:34:33 GMT-0800 (PST)' } // passing in date object const opts2 = { endTime: new Date(1493955273000) } // passing in unix const opts3 = { beginTime: 1493955273000 } const opts = opts1 // change this to test k.Matchlist.by.name('god tupo', opts, print) ``` ## [2.0.72](https://github.com/ChauTNguyen/kindred-api/tree/feature/remove-riot-official-deprecated) - Remove deprecated stuffs for July 24 deprecation. ## [2.0.71](https://github.com/ChauTNguyen/kindred-api/commit/ab0bff509168607c171af27ea3c63abd90b1ed55) - Fix spread/retryOptions/timeout initialization (doesn't need limits). ## [2.0.70](https://github.com/ChauTNguyen/kindred-api/commits/feature/fix-method-rate-limiting-per-region) - Fix method rate-limiting to be per-region. [for more info!](https://github.com/ChauTNguyen/kindred-api/wiki/Rate-Limiter) ## [2.0.69](https://github.com/ChauTNguyen/kindred-api/commit/c3b3a794ff912b389d3ff535a4ef1b96f3c22a58) - Add method rate-limiting (also customizable). [Riot Method Limits](https://developer.riotgames.com/rate-limiting.html) kindred-api now respects method the above rate-limits. It's set by default. However, users can set their own method rate limits if they want. This is useful in the case that Riot updates the rate limits, and that I'm MIA. ```javascript const methodTypes = KindredAPI.METHOD_TYPES const k = new KindredAPI.Kindred({ key: 'fakeKey', defaultRegion: KindredAPI.REGIONS.NORTH_AMERICA, limits: [[500, 10], [30000, 600]], // basic prod key debug: true, // showKey: true, //showDebug: true, retryOptions: { auto: false, // true by default numberOfRetriesBeforeBreak: 3 // infinite by default }, timeout: 1000, showHeaders: true, cache: new KindredAPI.InMemoryCache(), // cacheTTL default if not passed in and cache is passed in methodLimits: { [methodTypes.GET_SUMMONER_BY_NAME]: 3, // limits this endpoint to 3 requests per 10s [methodTypes.GET_MATCH]: 1000 // limits this endpoint to 1000 requests per 10s } }) ``` ## [2.0.68](https://github.com/ChauTNguyen/kindred-api/commit/9cc9bf6123f0622126391901be48366d2ff64c1f) - Add a new dev rate limit and more response header information is now printed. LIMITS.DEV = 20req/1s, 100req/120s LIMITS.OLD_DEV = 10req/10s, 500req/60s ## [2.0.67](https://github.com/ChauTNguyen/kindred-api/commit/9cc9bf6123f0622126391901be48366d2ff64c1f) - Changed static data options to "tags". All static data tag options (ex: runeListData, runeData) will all be renamed to `tags`. The old labels will become deprecated so I'm releasing this early. [source](https://discussion.developer.riotgames.com/articles/1736/updates-to-lol-static-data-v3.html) ``` For each endpoint that provides tags on which the response can be filtered, we have renamed that parameter to 'tags', to be consistent and more clear. The old parameter names (e.g., champData, itemListData, etc.) will be supported for the V3 endpoints until the end of the deprecation period, to give those of you that have already swapped over time to update to the new 'tags' parameter name. ``` ## [2.0.66](https://github.com/ChauTNguyen/kindred-api/commit/02fc262fd0f89e1253b501cc9199042af9c7f2f0) - Allow users to set timeout. ```javascript const k = new KindredAPI.Kindred({ key: 'fakeKey', defaultRegion: KindredAPI.REGIONS.NORTH_AMERICA, limits: KindredAPI.LIMITS.DEV, debug: true, // showKey: true, //showDebug: true, retryOptions: { auto: false, // true by default numberOfRetriesBeforeBreak: 3 // infinite by default }, timeout: 1000, showHeaders: true, cache: new KindredAPI.InMemoryCache() // cacheTTL default if not passed in and cache is passed in }) ``` ## [2.0.65](https://github.com/ChauTNguyen/kindred-api/commit/4f0203cc5b37c507158f5884a5790662cf8b7734) - Added configuration for number of retries. ```javascript const k = new KindredAPI.Kindred({ key: 'fakeKey', defaultRegion: KindredAPI.REGIONS.NORTH_AMERICA, limits: KindredAPI.LIMITS.DEV, debug: true, // showKey: true, //showDebug: true, retryOptions: { auto: false, // true by default numberOfRetriesBeforeBreak: 3 // infinite by default }, showHeaders: true, cache: new KindredAPI.InMemoryCache() // cacheTTL default if not passed in and cache is passed in }) ``` ## [2.0.64](https://github.com/ChauTNguyen/kindred-api/commit/fdda733bbb3c9c43e84006058def99e52af1d4f2) - Added defaults back for getMasters / getChallengers. Last patch I hastily removed the queue defaults from getChallengers/getMasters. Adding that back in because in hindsight the only default that should be removed is the queue default from getMatchlist. ## [2.0.63](https://github.com/ChauTNguyen/kindred-api/commit/90e2fb75b91da66b641cdc5313f96b25aff9c461) - Removed defaults for queue. getMatchlist queue previously defaulted to `420 (TEAM_BUILDER_RANKED_SOLO)`. getChallengers/getMasters queue previously defaulted to `RANKED_SOLO_5x5`. ## [2.0.62](https://github.com/ChauTNguyen/kindred-api/commit/61b77b91a0e89952e7d092fddf569242533c09a3) - Allow disabling of automatic retries. ```javascript const k = new KindredAPI.Kindred({ key: 'fakeKey', defaultRegion: KindredAPI.REGIONS.NORTH_AMERICA, limits: KindredAPI.LIMITS.DEV, debug: true, // showKey: true, //showDebug: true, retryOptions: { auto: false // NEW }, showHeaders: true, cache: new KindredAPI.InMemoryCache() // cacheTTL default if not passed in and cache is passed in }) ``` ## [2.0.61](https://github.com/ChauTNguyen/kindred-api/commit/00ba2892b8f737ba63fc8e4737dca33ccaf5fb49) - Clean up cache initialization. The old way is ugly and not how libraries should do it. Now, the library now exports the InMemoryCache and RedisCache classes so the user can now do something like this: ```javascript const k = new KindredAPI.Kindred({ key: 'fakeKey', defaultRegion: KindredAPI.REGIONS.NORTH_AMERICA, limits: KindredAPI.LIMITS.DEV, debug: true, // showKey: true, //showDebug: true, showHeaders: true, cache: new KindredAPI.InMemoryCache() // cacheTTL default if not passed in and cache is passed in }) ``` ## [2.0.60](https://github.com/ChauTNguyen/kindred-api/commit/c547132784829de0af506ea7d5dd3fc2d6863ab0) Add showHeaders, add `api_key=` to URL for developer convenience. ### showHeaders *showHeaders on (old behavior) & showKey off & debug on* ![Imgur](http://i.imgur.com/JsamNSn.png) ```javascript /* 200 https://na1.api.riotgames.com/lol/summoner/v3/summoners/by-name/contractz?api_key= { 'x-app-rate-limit-count': '1:10,1:600', 'x-method-rate-limit-count': '1:10,2:600', 'x-rate-limit-count': '1:10,1:600', 'retry-after': undefined } */ ``` *showHeaders off & showKey off & debug on* ![Imgur](http://i.imgur.com/w6BzkDz.png) ```javascript /* 200 https://na1.api.riotgames.com/lol/summoner/v3/summoners/by-name/contractz?api_key= */ ``` ### `api_key=` *new behavior with appended `api_key` & showKey off & debug on* ```javascript // https://na1.api.riotgames.com/lol/static-data/v3/champions?champListData=all&api_key= ``` *old behavior & showKey off & debug on* ```javascript // https://na1.api.riotgames.com/lol/static-data/v3/champions?champListData=all ``` ## [2.0.59](https://github.com/ChauTNguyen/kindred-api/commit/5543ee9c62d455ba5c2c9f8855556444a0997357) - Cache hits shouldn't have api keys in urls as well. ## [2.0.58](https://github.com/ChauTNguyen/kindred-api/commit/6a9a50460e99055c690e8b146ee250098cb3e586) - Fixed initialization bug I made in 2.0.57. Default cache timers weren't set up when cache ttl was not passed in. Fixed. ## [2.0.57]() - Added query params handling, added, showKey option for initialization, and removed Tournament requests. ### query params handling The `query-params.js` file maps endpoints to hard-coded string constants and `Kindred` now has a `_verifyOptions` method. These are used together to verify that the user is passing in the options they desire. API endpoints do not throw errors when extra query parameters or misspelled parameters are passed in. Typos or the wrong type of options are common mistakes, so this should help a lot. eg: runeListData instead of runeData for grabbing a single rune. Option errors will now always throw errors. ### showKey Although this is useful for debugging Riot's API, I'm allowing users to decide if they want to show their API key as a precaution. This also allows me to not show my API key in my tests (I don't want to use other loggers for now). ### tournament requests Removed this mostly because I wanted higher test coverage and because I don't want to support it at the moment. ### dev/prod string (limit) initialization Removed initialization through 'dev' and 'prod' strings. ### Fix validTTL checker validTTL -> validTTL(ttl) ## [2.0.56](https://github.com/ChauTNguyen/kindred-api/commit/387a568fab15af420510a5e300aed01fe620f78a) - Removed redis client quit handler. ## [2.0.55](https://github.com/ChauTNguyen/kindred-api/commit/49ddb3ef1a7789c2d36556a0b3e2c7404d30cf7a) - Fixed getMatchlistByAccId & getMatchlistById. Options weren't being passed into the request functions. ## [2.0.54](https://github.com/ChauTNguyen/kindred-api/commit/ae680079d486d55e34e3c6d1e87088142bf73b4f) - (minor) Removed some old examples. ## [2.0.53](https://github.com/ChauTNguyen/kindred-api/commit/7a8df99de3c03a4c3c614cf1308c8dd2abbb1dd4) - getProfileIcons()/Static.profileIcons now works on empty. ## [2.0.52](https://github.com/ChauTNguyen/kindred-api/commit/1f6bd3ea9de0ef082e9e0db9e4a9cb76be6aaa4e) - Removed Status.get() and Match.get() standard functions. I decided that this wasn't a good idea due to many reasons (gotta do a lot of parameter handling which is annoying). 2.0.48's Match change is reverted basically. ## [2.0.51](https://github.com/ChauTNguyen/kindred-api/commit/a30e3644cdcb6c3cf3158b70a418ff18760d4e8e) - More tinkering with buffers to increase Rate Limiter efficiency! ## [2.0.50](https://github.com/ChauTNguyen/kindred-api/commit/655ba1497352c83edd62c5178725e146d6925fd2) - Champion.list() bug is now fixed. ## [2.0.49](https://github.com/ChauTNguyen/kindred-api/commit/bf1ea95828ccfcd615e71671de6f8726ea85ad8a) - Rate limit logs now prints out `x-rate-limit-type` header as well. ## [2.0.48](https://github.com/ChauTNguyen/kindred-api/commit/f721f0790889ca4f4714066525cf1b4819b10b4b) - Matchlist is now cachable. When I updated my methods to use the v3 endpoints, I forgot to update and include Matchlist methods for Matchlist requests and so the CACHE_TIMER for MATCHLIST would not be used. Match and matchlist requests use the same endpoints now, but they should be cached for different times as matches are nonchanging while matchlists are updating every 30 minutes to an hour or so. Also, the cache timer for Matchlist is now fixed (I had ONE_HOUR instead of HOUR). **Match.get now is overloaded, and works with just an integer being passed in as well.** So you can now do stuffs like this: ```javascript k.Match .get(2501758619) .then(data => console.log(data)) .catch(error => console.error(error)) ``` ## [2.0.46](https://github.com/ChauTNguyen/kindred-api/commit/4e7bb5e7510761ca9e00f5963b16b299d14ff415) - API errors are now returned as status codes instead of strings. When catching errors, users now just get the raw status code instead of some colorized string. This was mostly a patch to do a lot of code refactoring. :P ## [2.0.45](https://github.com/ChauTNguyen/kindred-api/commit/25dba4e5870e2e8df808c9dd761b2b0939e3b074) - Fixed a few bugs and things that could cause bugs in rare situations. ## [2.0.44](https://github.com/ChauTNguyen/kindred-api/commit/3fd4ac7ac04aa3a992098b22e987807f170efcc6) - Promises no longer retry on 404's. ## [2.0.43](https://github.com/ChauTNguyen/kindred-api/commit/e58830b1b64fa967d45c2a0bbc62118b82da69af) - Production rate limits are now correct. ## [2.0.42](https://github.com/ChauTNguyen/kindred-api/commit/a65adc4bd609b0f7860a5ee55a2fb701c1e73f8f) - (non-bugfix) Added MatchTimelineById function. ## [2.0.41](https://github.com/ChauTNguyen/kindred-api/commit/37f5a50b691d66886a4fff29f3ad21fbf2a8aa45) - (non-bugfix) Added Status endpoint tests. ## [2.0.40](https://github.com/ChauTNguyen/kindred-api/commit/6c22b55a19306f501200325618ff02dda5d25ea9) - Fixed _statusRequest (now passes in region). ## [2.0.39](https://github.com/ChauTNguyen/kindred-api/commit/8089717995d42ae2b222b18c57f79c0fb8e11a27) - Added [spread rate limiting](https://github.com/ChauTNguyen/kindred-api/wiki/Rate-Limiter). * ^ * Added QUEUE_STRINGS constant for Challenger/Master endpoints. * Fixed Challenger/Master parameters. ```.list()``` should be callable with region + callback now. ## [2.0.38](https://github.com/ChauTNguyen/kindred-api/commit/d2f63a58a73e5b8c2c8d811f7ca40da9394afdc1) - Simplified [.env](https://github.com/ChauTNguyen/kindred-api/wiki/Tests) setup. ## [2.0.37](https://github.com/ChauTNguyen/kindred-api/commit/f624869c9549a3ec59b468ceba3cb83555d82124) - Set of core, core-utils, in-memory-cache, summoner, runes, masteries tests complete. ## [2.0.36](https://github.com/ChauTNguyen/kindred-api/commit/f5a530bdeaa7d4329e033f1ff36bcbbbdd2f3d79) - Constructor needs API key. Added basic check for initialization. Constructors must be called with a key parameter. ## [2.0.35](https://github.com/ChauTNguyen/kindred-api/commit/f49fe96e6b54bcdea4f14c73f4ff24720ca00553) - setRegion doesn't break your program! Tests introduced. * Fixed setRegion. It had a guaranteed exit function previously (brainfart). * Converted process.exit(1)'s into throws for testing purposes. * Added basic tests! Will be adding more as I have more time. ## [2.0.34](https://github.com/ChauTNguyen/kindred-api/commit/1eeb044b5c90e454a9924b8c22dfe4d0826bd192) - Multi-valued params in urls now work again! v3 API endpoints are back to accepting param=x¶m=y style strings, and so I reverted how baseRequest works. v3 urls are now in the following form: ``` https://na1.api.riotgames.com/lol/match/v3/matchlists/by-account/47776491?queue=420&queue=440&champion=81&api_key= ``` instead of: ``` https://na1.api.riotgames.com/lol/match/v3/matchlists/by-account/47776491?queue=420,440&champion=81&api_key= ``` ## [2.0.33](https://github.com/ChauTNguyen/kindred-api/commit/344cb5c918f5a771b5b3848c4f2bed144894e886) - Rate Limiter bursts earlier now. Improved Rate Limit class. This reduces execution time to the expected time.. ```javascript var num = 45 // # of requests function count(err, data) { if (data) --num if (err) console.error(err) if (num == 0) console.timeEnd('api') } console.time('api') for (var i = 0; i < 15; ++i) { k.Champion.list('na', count) k.Champion.list('kr', count) k.Champion.list('euw', count) } ``` This should output something like ```api: 11820.972ms```. Before this change, it was ```20789~ms``` which is not what it should be. The execution time when outside requests are sent is reduced too (it used to be ```40000~ms``` in this case; now it is around ```23741~ms``` if you send < 10 outside requests while this is running). ## [2.0.32](https://github.com/ChauTNguyen/kindred-api/commit/c798dfea68796f3b68d3256e60c972f921c56a90) - Calling static calls with just an object is fixed. Many of my static calls that used object parameters bugged out when I tried doing something like this: ```javascript k.Champion.all({ champListData: 'all' }) .then(data => console.log(data)) .catch(error => console.error(error)) ``` The calls had old code where it only worked for when you only passed in a callback OR both an object and a callback. All these parameter-related issues are now fixed.