* Major version bump to 2.0.0

* Convert to ESM (fixes tabletojson import error) * Update dependency versions * Remove broken functions due to API 404 so all tests pass (mbb getRankings, wbb getRankings, ncaa getTeamStats getScoringSummary) * Re-gen README and Markdown docs
sportsdataverse · Feb 14, 2024 · c627940 · c627940
1 parent 0230907
commit c627940
Show file tree

Hide file tree

Showing 36 changed files with 435 additions and 961 deletions.
diff --git a/README.md b/README.md
@@ -384,7 +384,6 @@ Operations for Men's College Basketball.
     * [.getBoxScore(id)](#mbb.getBoxScore) ⇒
     * [.getSummary(id)](#mbb.getSummary) ⇒
     * [.getPicks(id)](#mbb.getPicks) ⇒
-    * [.getRankings(year, week)](#mbb.getRankings) ⇒
     * [.getPlayerRankings(year, page, group)](#mbb.getPlayerRankings) ⇒
     * [.getSchoolRankings(year, page)](#mbb.getSchoolRankings) ⇒
     * [.getSchoolCommits(year, school)](#mbb.getSchoolCommits) ⇒
@@ -460,25 +459,6 @@ Gets the Men's College Basketball game PickCenter data for a specified game.
 ```js
 const result = await sdv.mbb.getPicks(401260281);
 ```
-<a name="mbb.getRankings"></a>
-
-### mbb.getRankings(year, week) ⇒
-Gets the Men's College Basketball rankings data for a specified year and week if available.
-
-**Kind**: static method of [<code>mbb</code>](#mbb)  
-**Returns**: json  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| year | <code>\*</code> | Year (YYYY) |
-| week | <code>\*</code> | Week |
-
-**Example**  
-```js
-const result = await sdv.mbb.getRankings(
-year = 2020, week = 15
-)
-```
 <a name="mbb.getPlayerRankings"></a>
 
 ### mbb.getPlayerRankings(year, page, group) ⇒
@@ -1042,8 +1022,6 @@ Operations for NCAA Sports.
     * [.getInfo(game)](#ncaa.getInfo) ⇒
     * [.getBoxScore(game)](#ncaa.getBoxScore) ⇒
     * [.getPlayByPlay(game)](#ncaa.getPlayByPlay) ⇒
-    * [.getTeamStats(game)](#ncaa.getTeamStats) ⇒
-    * [.getScoringSummary(game)](#ncaa.getScoringSummary) ⇒
     * [.getScoreboard(sport, division, year, month, day)](#ncaa.getScoreboard) ⇒
     * [.getSports()](#ncaa.getSports) ⇒
     * [.getSeasons(sport)](#ncaa.getSeasons) ⇒
@@ -1121,38 +1099,6 @@ Gets the play-by-play data for a specified game if available.
 ```js
 const result = await sdv.ncaa.getPlayByPlay(5764053);
 ```
-<a name="ncaa.getTeamStats"></a>
-
-### ncaa.getTeamStats(game) ⇒
-Gets the team stats data for a specified game if available.
-
-**Kind**: static method of [<code>ncaa</code>](#ncaa)  
-**Returns**: json  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| game | <code>number</code> | Game id. |
-
-**Example**  
-```js
-const result = await sdv.ncaa.getTeamStats(5764053);
-```
-<a name="ncaa.getScoringSummary"></a>
-
-### ncaa.getScoringSummary(game) ⇒
-Gets the scoring summary data for a specified game if available.
-
-**Kind**: static method of [<code>ncaa</code>](#ncaa)  
-**Returns**: json  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| game | <code>number</code> | Game id. |
-
-**Example**  
-```js
-const result = await sdv.ncaa.getScoringSummary(5764053);
-```
 <a name="ncaa.getScoreboard"></a>
 
 ### ncaa.getScoreboard(sport, division, year, month, day) ⇒
@@ -1682,7 +1628,6 @@ Operations for WBB.
     * [.getPlayByPlay(id)](#wbb.getPlayByPlay) ⇒
     * [.getBoxScore(id)](#wbb.getBoxScore) ⇒
     * [.getSummary(id)](#wbb.getSummary) ⇒
-    * [.getRankings(year, week)](#wbb.getRankings) ⇒
     * [.getSchedule(year, month, day, group, seasontype, limit)](#wbb.getSchedule) ⇒
     * [.getScoreboard(year, month, day, group, seasontype, limit)](#wbb.getScoreboard) ⇒
     * [.getConferences(year, group)](#wbb.getConferences) ⇒
@@ -1739,25 +1684,6 @@ Gets the Women's College Basketball game summary data for a specified game.
 ```js
 const result = await sdv.wbb.getSummary(401260565);
 ```
-<a name="wbb.getRankings"></a>
-
-### wbb.getRankings(year, week) ⇒
-Gets the WBB rankings data for a specified year and week if available.
-
-**Kind**: static method of [<code>wbb</code>](#wbb)  
-**Returns**: json  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| year | <code>\*</code> | Year (YYYY) |
-| week | <code>\*</code> | Week |
-
-**Example**  
-```js
-const result = await sdv.wbb.getRankings(
-year = 2021, week = 4
-)
-```
 <a name="wbb.getSchedule"></a>
 
 ### wbb.getSchedule(year, month, day, group, seasontype, limit) ⇒

diff --git a/app/app.js b/app/app.js
@@ -1,12 +1,23 @@
+import cfb from './services/cfb.service.js';
+import mbb from './services/mbb.service.js';
+import mlb from './services/mlb.service.js';
+import nba from './services/nba.service.js';
+import ncaa from './services/ncaa.service.js';
+import nfl from './services/nfl.service.js';
+import nhl from './services/nhl.service.js';
+import tennis from './services/tennis.service.js';
+import wbb from './services/wbb.service.js';
+import wnba from './services/wnba.service.js';
 
-module.exports.cfb = require('./services/cfb.service');
-module.exports.mbb = require('./services/mbb.service');
-module.exports.mlb = require('./services/mlb.service');
-module.exports.nba = require('./services/nba.service');
-module.exports.ncaa = require('./services/ncaa.service');
-module.exports.nfl = require('./services/nfl.service');
-module.exports.nhl = require('./services/nhl.service');
-module.exports.tennis = require('./services/tennis.service');
-module.exports.wbb = require('./services/wbb.service');
-module.exports.wnba = require('./services/wnba.service');
-
+export default {
+    cfb,
+    mbb,
+    mlb,
+    nba,
+    ncaa,
+    nfl,
+    nhl,
+    tennis,
+    wbb,
+    wnba
+};
diff --git a/app/services/cfb.service.js b/app/services/cfb.service.js
@@ -1,11 +1,11 @@
-const axios = require('axios');
-const cheerio = require('cheerio');
+import axios from 'axios';
+import cheerio from 'cheerio';
 /**
  * Operations for College Football.
  *
  * @namespace cfb
  */
-module.exports = {
+export default {
     /**
      * Gets the College Football game play-by-play data for a specified game.
      * @memberOf cfb

diff --git a/app/services/mbb.service.js b/app/services/mbb.service.js
@@ -1,11 +1,11 @@
-const axios = require('axios');
-const cheerio = require('cheerio');
+import axios from 'axios';
+import cheerio from 'cheerio';
 /**
  * Operations for Men's College Basketball.
  *
  * @namespace mbb
  */
-module.exports = {
+export default {
     /**
      * Gets the Men's College Basketball game play-by-play data for a specified game.
      * @memberOf mbb
@@ -132,38 +132,6 @@ module.exports = {
             standings: res.data.standings
         };
     },
-
-    /**
-     * Gets the Men's College Basketball rankings data for a specified year and week if available.
-     * @memberOf mbb
-     * @async
-     * @function
-     * @param {*} year - Year (YYYY)
-     * @param {*} week - Week
-     * @returns json
-     * @example
-     * const result = await sdv.mbb.getRankings(
-     * year = 2020, week = 15
-     * )
-     */
-    getRankings: async function ({ year, week }) {
-        const baseUrl = 'http://cdn.espn.com/core/mens-college-basketball/rankings';
-        const params = {};
-
-        if (year) {
-            params.year = year;
-        }
-
-        if (week) {
-            params.week = week;
-        }
-
-        const res = await axios.get(baseUrl, {
-            params
-        });
-
-        return res.data;
-    },
     /**
      * Gets the Men's College Basketball Player recruiting data for a specified year, page, position and institution type if available.
      * @memberOf mbb

diff --git a/app/services/mlb.service.js b/app/services/mlb.service.js
@@ -1,10 +1,10 @@
-const axios = require("axios");
+import axios from 'axios';
 /**
  * Operations for MLB.
  *
  * @namespace mlb
  */
-module.exports = {
+export default {
   /**
    * Gets the MLB game play-by-play data for a specified game.
    * @memberOf mlb

diff --git a/app/services/nba.service.js b/app/services/nba.service.js
@@ -1,10 +1,10 @@
-const axios = require('axios');
+import axios from 'axios';
 /**
  * Operations for NBA.
  *
  * @namespace nba
  */
-module.exports = {
+export default {
     /**
      * Gets the NBA game play-by-play data for a specified game.
      * @memberOf nba

diff --git a/app/services/ncaa.service.js b/app/services/ncaa.service.js
@@ -1,13 +1,13 @@
-const axios = require('axios');
-const cheerio = require('cheerio');
-const decode = require('decode-html');
-const tabletojson = require("tabletojson").Tabletojson;
+import axios from 'axios';
+import cheerio from 'cheerio';
+import decode from 'decode-html';
+import { Tabletojson as tabletojson } from 'tabletojson';
 /**
  * Operations for NCAA Sports.
  *
  * @namespace ncaa
  */
-module.exports = {
+export default {
     /**
      * Gets the gameId for older games whose url redirects to the current url pattern using the
      * game url fragment (relative to [https://ncaa.com](https://ncaa.com)) pulled from ncaaScoreboard
@@ -75,36 +75,6 @@ module.exports = {
         const res = await axios.get(baseUrl);
         return res.data;
     },
-    /**
-     * Gets the team stats data for a specified game if available.
-     * @memberOf ncaa
-     * @async
-     * @function
-     * @param {number} game - Game id.
-     * @returns json
-     * @example
-     * const result = await sdv.ncaa.getTeamStats(5764053);
-     */
-    getTeamStats: async function (game) {
-        const baseUrl = `https://data.ncaa.com/casablanca/game/${game}/teamStats.json`;
-        const res = await axios.get(baseUrl);
-        return res.data;
-    },
-    /**
-     * Gets the scoring summary data for a specified game if available.
-     * @memberOf ncaa
-     * @async
-     * @function
-     * @param {number} game - Game id.
-     * @returns json
-     * @example
-     * const result = await sdv.ncaa.getScoringSummary(5764053);
-     */
-    getScoringSummary: async function (game) {
-        const baseUrl = `https://data.ncaa.com/casablanca/game/${game}/scoringSummary.json`;
-        const res = await axios.get(baseUrl);
-        return res.data;
-    },
     /**
      * Gets the scoreboard data for a specified date and team sport if available.
      * @memberOf ncaa

diff --git a/app/services/nfl.service.js b/app/services/nfl.service.js
@@ -1,10 +1,10 @@
-const axios = require('axios');
+import axios from 'axios';
 /**
  * Operations for NFL.
  *
  * @namespace nfl
  */
-module.exports = {
+export default {
     /**
      * Gets the NFL game play-by-play data for a specified game.
      * @memberOf nfl

diff --git a/app/services/nhl.service.js b/app/services/nhl.service.js
@@ -1,10 +1,10 @@
-const axios = require('axios');
+import axios from 'axios';
 /**
  * Operations for NHL.
  *
  * @namespace nhl
  */
-module.exports = {
+export default {
     /**
      * Gets the NHL game play-by-play data for a specified game.
      * @memberOf nhl

diff --git a/app/services/tennis.service.js b/app/services/tennis.service.js
@@ -1,10 +1,10 @@
-const axios = require('axios');
+import axios from 'axios';
 /**
  * Operations for Tennis.
  *
  * @namespace tennis
  */
-module.exports = {
+export default {
     /**
      * Gets the scoreboard data for a specified date and league if available.
      * @memberOf tennis

diff --git a/app/services/wbb.service.js b/app/services/wbb.service.js
@@ -1,10 +1,10 @@
-const axios = require('axios');
+import axios from 'axios';
 /**
  * Operations for WBB.
  *
  * @namespace wbb
  */
-module.exports = {
+export default {
     /**
      * Gets the Women's College Basketball game play-by-play data for a specified game.
      * @memberOf wbb
@@ -97,41 +97,6 @@ module.exports = {
 
         };
     },
-    /**
-     * Gets the WBB rankings data for a specified year and week if available.
-     * @memberOf wbb
-     * @async
-     * @function
-     * @param {*} year - Year (YYYY)
-     * @param {*} week - Week
-     * @returns json
-     * @example
-     * const result = await sdv.wbb.getRankings(
-     * year = 2021, week = 4
-     * )
-     */
-    getRankings: async function ({
-        year,
-        week
-    }) {
-        const baseUrl = 'http://cdn.espn.com/core/womens-college-basketball/rankings';
-        const params = {};
-
-        if (year) {
-            params.year = year;
-        }
-
-        if (week) {
-            params.week = week;
-        }
-
-        const res = await axios.get(baseUrl, {
-            params
-        });
-
-        return res.data;
-    },
-
     /**
      * Gets the Women's College Basketball schedule data for a specified date if available.
      * @memberOf wbb