node-dota-api - npm Package Compare versions

Comparing version 4.0.1 to 5.0.0

CHANGELOG.md

@@ -0,0 +0,0 @@ # v4.0.1

dotaPlayerApi.js

 /**
  * node-dota-api
  * A node-based API to get Dota stats for players, heroes, matches, and more!
- * @version 0.2.4
- * @author Alex Muench
+ * @version 5.0.0
+ * @author Alex Muench, Arthur Lunn, Michael Magnoli
  */
 
-var moment = require('moment');
+const moment = require('moment');
 
 //define requirements
-var request = require('request');
-var cheerio = require('cheerio');
+const request = require('request');
 
-module.exports = {
+module.exports = playerStats;
 
-	/**
-	 * [playerStats description]
-	 * @param  {string|integer}	playerID							Player's Dota ID Number
-	 * @property {object}		playerInfoJson						JSON object containing player stats and info
-	 * @property {string}		playerInfoJson.status				Status of request call.  See status reports section in README.md
-	 * @property {float}		playerInfoJson.daysSinceLastMatch	Number of days since last match was played && parsed
-	 * @property {string}		playerInfoJson.soloMMR				Solo MMR Value
-	 * @property {string}		playerInfoJson.partyMMR				Party MMR Value
-	 * @property {string}		playerInfoJson.estMMR				OpenDota Estimated MMR Value
-	 * @property {string}		playerInfoJson.name					User's current Profile Name
-	 * @property {object}		playerInfoJson.winLoss				Object of Win-Loss values
-	 * @property {string}		playerInfoJson.winLoss.wins			Number of wins (returned as string)
-	 * @property {string}		playerInfoJson.winLoss.losses		Number of losses (returned as string)
-	 * @property {string}		playerInfoJson.winLoss.winrate		Winrate percentage
-	 * @property {string}		playerInfoJson.winLoss.totalGames	Number of total games played & parsed
-	 * @property {array}		playerInfoJson.mostPlayed			Array of User's 5 most played heroes, with games played and winrate
-	 * @property {array}		playerInfoJson.recentGames			Array of User's 20 most recent games, with matchID, hero, result, time played, and skill level
-	 * @property {string}		playerInfoJson.profileUrl			URL to user's proflie on OpenDota.com
-	 */
-	playerStats: function (playerID, apiKey) {
-		var apiBase = 'https://api.opendota.com/api/players/' + playerID;
+/**
+ * [playerStats description]
+ * @param  {string|integer}  playerID              Player's Dota ID Number
+ * @property {object}    playerInfoJson            JSON object containing player stats and info
+ * @property {string}    playerInfoJson.status        Status of request call.  See status reports section in README.md
+ * @property {float}    playerInfoJson.daysSinceLastMatch  Number of days since last match was played && parsed
+ * @property {string}    playerInfoJson.soloMMR        Solo MMR Value
+ * @property {string}    playerInfoJson.partyMMR        Party MMR Value
+ * @property {string}    playerInfoJson.estMMR        OpenDota Estimated MMR Value
+ * @property {string}    playerInfoJson.name          User's current Profile Name
+ * @property {object}    playerInfoJson.winLoss        Object of Win-Loss values
+ * @property {string}    playerInfoJson.winLoss.wins      Number of wins (returned as string)
+ * @property {string}    playerInfoJson.winLoss.losses    Number of losses (returned as string)
+ * @property {string}    playerInfoJson.winLoss.winrate    Winrate percentage
+ * @property {string}    playerInfoJson.winLoss.totalGames  Number of total games played & parsed
+ * @property {array}    playerInfoJson.mostPlayed      Array of User's 5 most played heroes, with games played and winrate
+ * @property {array}    playerInfoJson.recentGames      Array of User's 20 most recent games, with matchID, hero, result, time played, and skill level
+ * @property {string}    playerInfoJson.profileUrl      URL to user's proflie on OpenDota.com
+ */
+function playerStats(playerID) {
+	const apiBase = 'https://api.opendota.com/api/players/' + playerID;
 
-		var playerInfoJson = {
-			status: '',
-			daysSinceLastMatch: '',
-			soloMMR: '',
-			partyMMR: '',
-			estMMR: '',
-			name: '',
-			winLoss: {
-				wins: '',
-				losses: '',
-				winrate: '',
-				totalGames: ''
-			},
-			mostPlayed: [],
-			recentGames: [],
-			profileURL: 'https://opendota.com/players/' + playerID,
-			profileImage: '',
-			isPrime: ''
-		};
-		return new Promise(function (resolve, reject) {
-			request(apiBase, function (err, res) {
-				if (err) {
-					playerInfoJson.status = 'Error';
-					reject("error with initial request");
+	const playerInfoJson = {
+		status: '',
+		daysSinceLastMatch: '',
+		soloMMR: '',
+		partyMMR: '',
+		estMMR: '',
+		name: '',
+		winLoss: {
+			wins: '',
+			losses: '',
+			winrate: '',
+			totalGames: ''
+		},
+		mostPlayed: [],
+		recentGames: [],
+		profileURL: 'https://opendota.com/players/' + playerID,
+		profileImage: '',
+		isPrime: ''
+	};
+	return new Promise(function (resolve, reject) {
+		request(apiBase, function (err, res) {
+			if (err) {
+				playerInfoJson.status = 'Error';
+				reject("error with initial request");
+			} else {
+				const data = JSON.parse(res.body);
+				if (data.error) {
+					playerInfoJson.status = 'Invalid';
+					resolve(playerInfoJson);
 				} else {
-					const data = JSON.parse(res.body);
-					if (data.error) {
-						playerInfoJson.status = 'Invalid';
-						resolve(playerInfoJson);
-					} else {
-						playerInfoJson.status = 'Valid Account';
-						playerInfoJson.soloMMR = data.solo_competitive_rank;
-						playerInfoJson.partyMMR = data.competitive_rank;
-						playerInfoJson.estMMR = data.mmr_estimate.estimate;
-						playerInfoJson.name = data.profile.personaname;
-						playerInfoJson.profileImage = data.profile.avatarfull;
+					playerInfoJson.status = 'Valid Account';
+					playerInfoJson.soloMMR = data.solo_competitive_rank;
+					playerInfoJson.partyMMR = data.competitive_rank;
+					playerInfoJson.estMMR = data.mmr_estimate.estimate;
+					playerInfoJson.name = data.profile.personaname;
+					playerInfoJson.profileImage = data.profile.avatarfull;
 
-						request(apiBase + '/wl', function (err, res) {
+					request(apiBase + '/wl', function (err, res) {
+						if (err) {
+							playerInfoJson.status = 'Error';
+							reject("error with wl request");
+						}
+						const data = JSON.parse(res.body);
+						if (data.lose === null || data.win === null) {
+							reject("error fetching win loss data");
+						}
+						playerInfoJson.winLoss.losses = data.lose;
+						playerInfoJson.winLoss.wins = data.win;
+						playerInfoJson.winLoss.totalGames = data.lose + data.win;
+						playerInfoJson.winLoss.winrate = (data.win / (data.lose + data.win));
+
+						request(apiBase + '/matches?limit=1', function (err, res) {
 							if (err) {
@@ -80,64 +93,33 @@ playerInfoJson.status = 'Error';
 							}
-							const data = JSON.parse(res.body);
-							if(data.lose == null || data.win == null){
-								reject("error fetching win loss data");
+							const match = JSON.parse(res.body)[0];
+							if (match.start_time === null) {
+								reject("Error fetching start time of last ranked match");
 							}
-							playerInfoJson.winLoss.losses = data.lose;
-							playerInfoJson.winLoss.wins = data.win;
-							playerInfoJson.winLoss.totalGames = data.lose + data.win;
-							playerInfoJson.winLoss.winrate = (data.win / (data.lose + data.win));
+							const now = moment(new Date());
+							const lastGame = moment.unix(data.start_time)
+							const duration = moment.duration(now.diff(lastGame)).asDays();
+							playerInfoJson.daysSinceLastMatch = duration;
+							if (duration > 14) {
+								playerInfoJson.status = 'Outdated Match History'
+							}
 
-							request(apiBase + '/matches?limit=1', function (err, res) {
+							request(apiBase + '/matches?lobby_type=7&limit=1', function (err, res) {
 								if (err) {
 									playerInfoJson.status = 'Error';
-									reject("error with wl request");
+									reject("error with matches request");
 								}
 								const data = JSON.parse(res.body)[0];
-								var now = moment(new Date());
-								//temp fix while the data returned is off by one month
-								if(data.start_time == null){
-									reject("Error fetching start time of last match");
+								if (data.start_time === null) {
+									reject("Error fetching start time of last ranked match");
 								}
-								var lastGame = moment.unix(data.start_time)
-								var duration = moment.duration(now.diff(lastGame)).asDays();
-								playerInfoJson.daysSinceLastMatch = duration;
-								if (duration > 14) {
-									playerInfoJson.status = 'Outdated Match History'
-								}
-
-								if (!apiKey) {
-									playerInfoJson.isPrime = 'No apiKey provided';
-									resolve(playerInfoJson);
-								} else {
-									const steamwebapi = `https://api.steampowered.com/IDOTA2Match_570/GetMatchHistory/v1/?key=${apiKey}&matches_requested=30&account_id=${playerID}&game_mode=7&format=JSON`;
-									let isPrime = false;
-									request(steamwebapi, function (err, res) {
-										if (err) {
-											playerInfoJson.status = 'Error';
-											reject("error with wl request");
-										}
-										const matches = JSON.parse(res.body).result.matches;
-										if(matches == null){
-											reject("error fetching matchs");
-										}
-										for (let match of matches) {
-											if (match.lobby_type === 7) {
-												isPrime = (match.start_time > 1493948227);
-												break;
-											}
-										}
-										playerInfoJson.isPrime = isPrime;
-										resolve(playerInfoJson);
-									});
-								}
-
-							})
-
+								// Approximate date of prime matchmaking
+								playerInfoJson.isPrime = data.start_time > 1493948227;
+								resolve(playerInfoJson);
+							});
 						})
-					}
+					})
 				}
-			});
+			}
 		});
-	}
-
-};
+	});
+}

package.json

 {
   "name": "node-dota-api",
-  "version": "4.0.1",
+  "version": "5.0.0",
   "description": "A wrapper for the OpenDota API",
@@ -5,0 +5,0 @@ "main": "./dotaPlayerApi.js",

README.md

@@ -8,4 +8,8 @@ # node-dota-api
 
-## v4.0.1
+## v5.0.0
 
+- Switch to opendota instead of steam web api for Prime Account Check (thanks [Mags](https://github.com/ammuench/node-dota-api/pull/5))
+
+### v4.0.1
+
 - Minor bugfix for mistyped conditoinal check (thanks [Quazia](https://github.com/ammuench/node-dota-api/pull/4))
@@ -92,3 +96,3 @@
 
-Thanks to [Arthur](https://github.com/quazia) for his contributions to the project
+Thanks to [Arthur](https://github.com/quazia) & [Mags](https://github.com/MichaelMagnoli) for their contributions to the project
 
@@ -95,0 +99,0 @@ Many thanks to Carney for answer myriads of questions when I'm having issues

No alert changes

Improved metrics

Total package byte prevSize

11958

increased by0.19%

Number of package files

7

increased by16.67%

Number of lines in readme file

101

increased by4.12%

Worsened metrics

Lines of code

115

decreased by-12.21%

No dependency changes