Merge pull request #238 from mkreiser/scoring-settings

Add scoring settings to League
mkreiser · Oct 29, 2023 · 8feaba3 · 8feaba3
2 parents 1a7ebf0 + 2e07f8a
commit 8feaba3
Show file tree

Hide file tree

Showing 8 changed files with 154 additions and 11 deletions.
diff --git a/integration-tests/2018-season/__snapshots__/integration.test.js.snap b/integration-tests/2018-season/__snapshots__/integration.test.js.snap
@@ -56424,6 +56424,50 @@ League {
     "playoffMatchupLength": 2,
     "regularSeasonMatchupLength": 1,
   },
+  "scoringSettings": {
+    "defensive0PointsAllowed": 5,
+    "defensive100To199YardsAllowed": 3,
+    "defensive14To17PointsAllowed": 1,
+    "defensive1To6PointsAllowed": 4,
+    "defensive200To299YardsAllowed": 2,
+    "defensive28To34PointsAllowed": -1,
+    "defensive350To399YardsAllowed": -1,
+    "defensive35To45PointsAllowed": -3,
+    "defensive400To449YardsAllowed": -3,
+    "defensive450To499YardsAllowed": -5,
+    "defensive500To549YardsAllowed": -6,
+    "defensive7To13PointsAllowed": 3,
+    "defensiveBlockedKickForTouchdowns": 6,
+    "defensiveBlockedKicks": 2,
+    "defensiveFumbles": 2,
+    "defensiveInterceptions": 2,
+    "defensiveLessThan100YardsAllowed": 5,
+    "defensiveOver45PointsAllowed": -5,
+    "defensiveOver550YardsAllowed": -7,
+    "defensiveSacks": 1,
+    "defensiveSafeties": 2,
+    "fumbleReturnTouchdown": 6,
+    "interceptionReturnTouchdown": 6,
+    "kickoffReturnTouchdown": 6,
+    "lostFumbles": -2,
+    "madeExtraPoints": 1,
+    "madeFieldGoalsFrom40To49": 4,
+    "madeFieldGoalsFrom50Plus": 5,
+    "madeFieldGoalsFromUnder40": 3,
+    "missedExtraPoints": -1,
+    "missedFieldGoals": -1,
+    "passing2PtConversions": 2,
+    "passingInterceptions": -2,
+    "passingTouchdowns": 4,
+    "passingYards": 0.04,
+    "puntReturnTouchdown": 6,
+    "receiving2PtConversions": 2,
+    "receivingTouchdowns": 6,
+    "receivingYards": 0.1,
+    "rushing2PtConversions": 2,
+    "rushingTouchdowns": 6,
+    "rushingYards": 0.1,
+  },
   "size": 8,
 }
 `;

diff --git a/integration-tests/2022-season/__snapshots__/integration.test.js.snap b/integration-tests/2022-season/__snapshots__/integration.test.js.snap
@@ -62478,6 +62478,51 @@ League {
     "playoffMatchupLength": 1,
     "regularSeasonMatchupLength": 1,
   },
+  "scoringSettings": {
+    "defensive0PointsAllowed": 5,
+    "defensive100To199YardsAllowed": 3,
+    "defensive14To17PointsAllowed": 1,
+    "defensive1To6PointsAllowed": 4,
+    "defensive200To299YardsAllowed": 2,
+    "defensive28To34PointsAllowed": -1,
+    "defensive350To399YardsAllowed": -1,
+    "defensive35To45PointsAllowed": -3,
+    "defensive400To449YardsAllowed": -3,
+    "defensive450To499YardsAllowed": -5,
+    "defensive500To549YardsAllowed": -6,
+    "defensive7To13PointsAllowed": 3,
+    "defensiveBlockedKickForTouchdowns": 6,
+    "defensiveBlockedKicks": 3,
+    "defensiveFumbles": 2,
+    "defensiveInterceptions": 2,
+    "defensiveLessThan100YardsAllowed": 5,
+    "defensiveOver45PointsAllowed": -5,
+    "defensiveOver550YardsAllowed": -7,
+    "defensiveSacks": 1,
+    "defensiveSafeties": 4,
+    "fumbleReturnTouchdown": 6,
+    "interceptionReturnTouchdown": 6,
+    "kickoffReturnTouchdown": 6,
+    "lostFumbles": -2,
+    "madeExtraPoints": 1,
+    "madeFieldGoalsFrom40To49": 4,
+    "madeFieldGoalsFrom60Plus": 5,
+    "madeFieldGoalsFromUnder40": 3,
+    "missedExtraPoints": -1,
+    "missedFieldGoals": -1,
+    "passing2PtConversions": 2,
+    "passingInterceptions": -2,
+    "passingTouchdowns": 4,
+    "passingYards": 0.04,
+    "puntReturnTouchdown": 6,
+    "receiving2PtConversions": 2,
+    "receivingReceptions": 0.5,
+    "receivingTouchdowns": 6,
+    "receivingYards": 0.1,
+    "rushing2PtConversions": 2,
+    "rushingTouchdowns": 6,
+    "rushingYards": 0.1,
+  },
   "size": 10,
 }
 `;

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "espn-fantasy-football-api",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "A Javascript API to connect to ESPN's fantasy football API",
   "main": "web.js",
   "files": [

diff --git a/src/client/client.test.js b/src/client/client.test.js
@@ -1087,20 +1087,21 @@ describe('Client', () => {
         client = new Client({ leagueId: 213213 });
 
         jest.spyOn(axios, 'get').mockImplementation();
+        axios.get.mockReturnValue(q({
+          scoringSettings: {
+            scoringItems: []
+          }
+        }));
       });
 
       describe('when the seasonId is prior to 2018', () => {
         test('throws an error', () => {
-          axios.get.mockReturnValue(q());
-
           expect(() => client.getLeagueInfo({ seasonId: 2017 })).toThrow();
         });
       });
 
       describe('when the seasonId is 2018 or after', () => {
         test('does not throw an error', () => {
-          axios.get.mockReturnValue(q());
-
           expect(() => client.getLeagueInfo({ seasonId: 2018 })).not.toThrow();
         });
 
@@ -1111,7 +1112,6 @@ describe('Client', () => {
 
           const config = {};
           jest.spyOn(client, '_buildAxiosConfig').mockReturnValue(config);
-          axios.get.mockReturnValue(q());
 
           client.getLeagueInfo({ seasonId });
           expect(axios.get).toBeCalledWith(route, config);
@@ -1120,7 +1120,6 @@ describe('Client', () => {
         describe('before the promise resolves', () => {
           test('does not invoke callback', () => {
             jest.spyOn(League, 'buildFromServer').mockImplementation();
-            axios.get.mockReturnValue(q());
 
             client.getLeagueInfo({ seasonId });
             expect(League.buildFromServer).not.toBeCalled();
@@ -1135,7 +1134,10 @@ describe('Client', () => {
                   name: 'some league',
                   draftSettings: {},
                   rosterSettings: {},
-                  scheduleSettings: {}
+                  scheduleSettings: {},
+                  scoringSettings: {
+                    scoringItems: []
+                  }
                 },
                 status: {
                   currentMatchupPeriod: 7,

diff --git a/src/league/league.js b/src/league/league.js
@@ -3,6 +3,7 @@ import _ from 'lodash';
 import BaseObject from '../base-classes/base-object/base-object';
 
 import { slotCategoryIdToPositionMap } from '../constants.js';
+import { statIdsToAttributes } from '../player-stats/player-stats';
 
 /* global DRAFT_TYPE, LINEUP_LOCK_TIMES */
 
@@ -59,6 +60,7 @@ class League extends BaseObject {
    * @property {DraftSettings} draftSettings The draft settings of the league.
    * @property {RosterSettings} rosterSettings The roster settings of the league.
    * @property {ScheduleSettings} scheduleSettings The schedule settings of the league.
+   * @property {object} scoringSettings The scoring settings of the league.
    */
 
   /**
@@ -114,6 +116,29 @@ class League extends BaseObject {
           numberOfPlayoffTeams: responseData.playoffTeamCount
         };
       }
+    },
+
+    scoringSettings: {
+      key: 'scoringSettings',
+      manualParse: (responseData) => _.reduce(
+        responseData.scoringItems,
+        (acc, { points, pointsOverrides, statId }) => {
+          const key = statIdsToAttributes[statId];
+
+          if (!key) {
+            return acc;
+          }
+
+          if (pointsOverrides) {
+            acc[key] = _.first(_.values(pointsOverrides));
+          } else {
+            acc[key] = points;
+          }
+
+          return acc;
+        },
+        {}
+      )
     }
   };
 }

diff --git a/src/league/league.test.js b/src/league/league.test.js
@@ -47,7 +47,18 @@ describe('League', () => {
       data = {
         draftSettings,
         rosterSettings,
-        scheduleSettings
+        scheduleSettings,
+        scoringSettings: {
+          scoringItems: [{
+            points: 1, statId: 0
+          }, {
+            points: 4, statId: 1
+          }, {
+            points: 6, pointsOverrides: { '16': 9 }, statId: 2 // eslint-disable-line quote-props
+          }, {
+            points: 75, statId: 999
+          }]
+        }
       };
     });
 
@@ -155,5 +166,16 @@ describe('League', () => {
         );
       });
     });
+
+    describe('scoringSettings', () => {
+      test('maps to object using constants', () => {
+        const league = League.buildFromServer(data);
+        expect(league.scoringSettings).toStrictEqual({
+          passingAttempts: 1,
+          passingIncompletions: 9,
+          passingCompletions: 4
+        });
+      });
+    });
   });
 });
diff --git a/src/player-stats/player-stats.js b/src/player-stats/player-stats.js
@@ -262,6 +262,11 @@ class PlayerStats extends BaseObject {
   };
 }
 
+export const statIdsToAttributes = _.reduce(PlayerStats.responseMap, (acc, value, key) => {
+  acc[value] = key;
+  return acc;
+}, {});
+
 export const parsePlayerStats = ({
   responseData, constructorParams, usesPoints, seasonId, statKey, statSourceId, statSplitTypeId
 }) => {