mtg-playerinfo 1.1.0 → 1.2.2

package/.github/workflows/ci.yml

@@ -7,11 +7,12 @@ on:
     branches: [ main ]
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
+  test:
+    runs-on: ${{ matrix.os }}
 
     strategy:
       matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
         node-version: [20, 22, 24]
 
     steps:
@@ -27,4 +28,29 @@ jobs:
       run: npm install
 
     - name: Run tests
-      run: npm test
+      run: npm run test:coverage
+
+    - name: Upload test coverage data
+      if: github.repository == 'bkimminich/mtg-playerinfo' && github.event_name == 'push' && matrix.os == 'ubuntu-latest' && matrix.node-version == '24'
+      uses: actions/upload-artifact@v6
+      with:
+        name: test-lcov
+        path: |
+          coverage/lcov.info
+
+  coverage-report:
+    needs: [test]
+    runs-on: ubuntu-latest
+    if: github.repository == 'bkimminich/mtg-playerinfo' && github.event_name == 'push'
+    steps:
+      - name: "Check out Git repository"
+        uses: actions/checkout@v4
+      - name: "Download test coverage data"
+        uses: actions/download-artifact@v7
+        with:
+          name: test-lcov
+      - name: "Publish coverage to Coveralls"
+        uses: coverallsapp/github-action@v2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          files: lcov.info

package/.github/workflows/update-test-data.yml

@@ -0,0 +1,33 @@
+name: Update Test Data
+
+on:
+  schedule:
+    - cron: '0 2 * * 0' # Sundays 2:00 AM
+  workflow_dispatch: # Allow manual run
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 24
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Fetch new test data
+        run: node scripts/update-test-data.js
+
+      - name: Commit and push changes
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "🤖 Update test data HTML files"
+          file_pattern: 'test/data/*.html'

package/README.md

@@ -1,84 +1,109 @@
 # MTG Player Info
 
 ![GitHub stars](https://img.shields.io/github/stars/bkimminich/mtg-playerinfo.svg?label=GitHub%20%E2%98%85&style=flat)
-![node](https://img.shields.io/node/v/mtg-playerinfo.svg) [![npm](https://img.shields.io/npm/dm/mtg-playerinfo.svg)](https://www.npmjs.com/package/mtg-playerinfo) [![npm](https://img.shields.io/npm/dt/mtg-playerinfo.svg)](https://www.npmjs.com/package/mtg-playerinfo)
+![node](https://img.shields.io/node/v/mtg-playerinfo.svg)
+[![npm](https://img.shields.io/npm/dm/mtg-playerinfo.svg)](https://www.npmjs.com/package/mtg-playerinfo)
+[![npm](https://img.shields.io/npm/dt/mtg-playerinfo.svg)](https://www.npmjs.com/package/mtg-playerinfo)
+[![Coverage Status](https://coveralls.io/repos/github/bkimminich/mtg-playerinfo/badge.svg?branch=main)](https://coveralls.io/github/bkimminich/mtg-playerinfo?branch=main)
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
 A simple NPM module and CLI tool to pull Magic: The Gathering player data from various sources (Unity League, MTG Elo Project, Melee, and Topdeck).
 
 ## Installation
 
 ```bash
-npm i -g mtg-player-info
+npm i -g mtg-playerinfo
 ```
 
 ## CLI Usage
 
 ```bash
-mtg-player-info --unity-id 16215 --mtgelo-id 3irvwtmk --melee-user k0shiii --topdeck-handle k0shiii
+mtg-playerinfo --unity-id 16215 --mtgelo-id 3irvwtmk --melee-user k0shiii --topdeck-handle k0shiii
 ```
 
 or without previous installation
 
 ```bash
-npx mtg-player-info --unity-id 16215 --mtgelo-id 3irvwtmk --melee-user k0shiii --topdeck-handle k0shiii
+npx mtg-playerinfo --unity-id 16215 --mtgelo-id 3irvwtmk --melee-user k0shiii --topdeck-handle k0shiii
 ```
 
 ## Output Format
 
-The tool returns a JSON object representing the player and their combined metadata. Redundant information like Name, Photo, Country, Age, and Hometown is merged into a `general` section, while source-specific data is kept in the `sources` section.
+The tool returns a JSON object representing the player and their combined metadata. Redundant information like name, photo, country, age, and hometown is merged into a `general` section, while source-specific data is kept in the `sources` section.
 
-### Deduplication and Merging Logic
+### General meta-data and merging priority
 
-- **Priority**: Merging follows a "first-come, first-served" approach based on the order of sources provided in the command line or processed by the manager. For instance, the first `name` and first valid `photo` URL found will be used as the primary name and photo for the player.
-- **Deduplication**: If multiple IDs point to the exact same profile URL, the profile is only processed once to avoid redundant data in the `sources` section.
-- **General Metadata**: Fields like `Age`, `Country`, and `Hometown` are extracted from the first source that provides them and placed in the `general` section.
+General meta-data fields like `name`, `photo`, `age`, `country`, and `hometown` are extracted from the first source that provides them and placed in the `general` section. Merging follows a "first-come, first-served" approach based on the order of sources provided in the command line or processed by the manager. In the [CLI usage example](#cli-usage) above, the source priority is `Unity League` > `MTG Elo Project` > `Melee` > `Topdeck`.
 
-Example output:
+> If you notice any inconsistencies or unexpected fields values, you can run the tool with the `-v` or `--verbose` flag to see the full list of extracted fields and if they were promoted to the `general` section or deviated from a previous source.
+
+### Example output
 
 ```json
 {
-  "name": "Björn Kimminich",
-  "photo": "https://unityleague.gg/media/player_profile/1000023225.jpg",
   "general": {
-    "Age": "45",
-    "Bio": "Smugly held back on an Untimely Malfunction against a Storm player going off, being totally sure that you can redirect the summed-up damage of their Grapeshots back to their face with its \"Change the target of target spell or ability with a single target\" mode.",
-    "Team": "Mull to Five",
-    "Country": "de",
-    "Hometown": "Hamburg",
-    "Win Rate": "42.09%"
+    "name": "Björn Kimminich",
+    "photo": "https://unityleague.gg/media/player_profile/1000023225.jpg",
+    "age": "45",
+    "bio": "Smugly held back on an Untimely Malfunction against a Storm player going off, being totally sure that you can redirect the summed-up damage of their Grapeshots back to their face with its \"Change the target of target spell or ability with a single target\" mode.",
+    "team": "Mull to Five",
+    "country": "de",
+    "hometown": "Hamburg",
+    "pronouns": "He/Him",
+    "facebook": "bjoern.kimminich",
+    "twitch": "koshiii",
+    "youtube": "@BjörnKimminich",
+    "win rate": "42.49%"
   },
   "sources": {
     "Unity League": {
       "url": "https://unityleague.gg/player/16215/",
       "data": {
-        "Local organizer": "Mulligan TCG Shop",
-        "Rank Germany": "58",
-        "Rank Europe": "584",
-        "Rank Points": "274",
-        "Record": "38-38-5",
-        "Win Rate": "49.0%"
+        "name": "Björn Kimminich",
+        "photo": "https://unityleague.gg/media/player_profile/1000023225.jpg",
+        "country": "de",
+        "age": "45",
+        "hometown": "Hamburg",
+        "local organizer": "Mulligan TCG Shop",
+        "team": "Mull to Five",
+        "bio": "Smugly held back on an Untimely Malfunction against a Storm player going off, being totally sure that you can redirect the summed-up damage of their Grapeshots back to their face with its \"Change the target of target spell or ability with a single target\" mode.",
+        "rank germany": "63",
+        "rank europe": "547",
+        "rank points": "304",
+        "record": "45-43-5",
+        "win rate": "50.2%"
       }
     },
     "MTG Elo Project": {
       "url": "https://mtgeloproject.net/profile/3irvwtmk",
       "data": {
+        "name": "Bjoern Kimminich",
         "player_id": "3irvwtmk",
         "current_rating": "1466",
         "record": "9-12-1",
-        "Win Rate": "40.91%"
+        "win rate": "40.91%"
       }
     },
     "Melee": {
       "url": "https://melee.gg/Profile/Index/k0shiii",
-      "data": {}
+      "data": {
+        "name": "Björn Kimminich",
+        "pronouns": "He/Him",
+        "bio": "Smugly held back on an Untimely Malfunction against a Storm player going off, being totally sure that you can redirect the summed-up damage of their Grapeshots back to their face.",
+        "facebook": "bjoern.kimminich",
+        "twitch": "koshiii",
+        "youtube": "@BjörnKimminich"
+      }
     },
     "Topdeck": {
       "url": "https://topdeck.gg/profile/@k0shiii",
       "data": {
-        "Tournaments": "2",
-        "Record": "4-6-1",
-        "Win Rate": "36.36%",
-        "Conversion": "0%"
+        "name": "Björn Kimminich",
+        "photo": "https://imagedelivery.net/kN_u_RUfFF6xsGMKYWhO1g/2a7b8d12-5924-4a58-5f9c-c0bf55766800/square",
+        "tournaments": "2",
+        "record": "4-6-1",
+        "win rate": "36.36%",
+        "conversion": "0%"
       }
     }
   }
@@ -89,12 +114,12 @@ Example output:
 
 The following sites are currently supported based on HTML scraping and/or API calls. In general, API calls are preferred over scraping due to their higher reliability and independence from site structure changes.
 
-| Site            | Method                                                                       |
-|-----------------|------------------------------------------------------------------------------|
-| Unity League    | ✅Scraping                                                                    |
-| MTG Elo Project | ✅Scraping                                                                    |
-| Topdeck         | ✅Scraping                                                                    |
-| Melee           | 🚧Scraping/API ([#1](https://github.com/bkimminich/mtg-playerinfo/issues/1)) |
+| Site            | Method                                                                          |
+|-----------------|---------------------------------------------------------------------------------|
+| Unity League    | ✅Scraping                                                                       |
+| MTG Elo Project | ✅Scraping                                                                       |
+| Topdeck         | ✅Scraping / ✅API                                                                |
+| Melee           | ✅Scraping / 🚧API ([#1](https://github.com/bkimminich/mtg-playerinfo/issues/1)) |
 
 _Note: Some sites may have anti-bot protections that can lead to "Maximum number of redirects exceeded" or "403 Forbidden" errors depending on the execution environment._
 

package/cli.js

@@ -1,31 +1,47 @@
 #!/usr/bin/env node
-const { program } = require('commander');
-const PlayerInfoManager = require('./src/index');
+const { program } = require('commander')
+const PlayerInfoManager = require('./src/index')
 
 program
   .name('mtg-playerinfo')
   .description('CLI to pull MTG player data from various sources')
-  .version('1.0.0');
+  .version('1.0.0')
 
 program
   .option('--unity-id <id>', 'Unity League Player ID')
   .option('--mtgelo-id <id>', 'MTG Elo Project Player ID')
   .option('--melee-user <username>', 'Melee Username')
   .option('--topdeck-handle <handle>', 'Topdeck Handle')
+  .option('-v, --verbose', 'Print consistency check information to console')
   .action(async (options) => {
     if (!options.unityId && !options.mtgeloId && !options.meleeUser && !options.topdeckHandle) {
-      console.error('Error: Please provide at least one search option (unity-id, mtgelo-id, melee-user, or topdeck-handle).');
-      process.exit(1);
+      console.error('Error: Please provide at least one search option (unity-id, mtgelo-id, melee-user, or topdeck-handle).')
+      process.exit(1)
     }
 
-    const manager = new PlayerInfoManager();
+    // Determine priority order based on CLI argument order
+    const argOrder = []
+    const optionMap = {
+      '--unity-id': 'unity',
+      '--mtgelo-id': 'mtgelo',
+      '--melee-user': 'melee',
+      '--topdeck-handle': 'topdeck'
+    }
+
+    process.argv.forEach(arg => {
+      if (optionMap[arg]) {
+        argOrder.push(optionMap[arg])
+      }
+    })
+
+    const manager = new PlayerInfoManager()
     try {
-      const playerInfo = await manager.getPlayerInfo(options);
-      console.log(JSON.stringify(playerInfo, null, 2));
+      const playerInfo = await manager.getPlayerInfo(options, argOrder)
+      console.log(JSON.stringify(playerInfo, null, 2))
     } catch (error) {
-      console.error('An error occurred:', error.message);
-      process.exit(1);
+      console.error('An error occurred:', error.message)
+      process.exit(1)
     }
-  });
+  })
 
-program.parse(process.argv);
+program.parse(process.argv)

package/package.json

@@ -1,13 +1,28 @@
 {
   "name": "mtg-playerinfo",
-  "version": "1.1.0",
+  "version": "1.2.2",
   "description": "A simple NPM module and CLI tool to pull Magic: The Gathering player data from various sources",
   "main": "src/index.js",
   "bin": {
     "mtg-playerinfo": "./cli.js"
   },
   "scripts": {
-    "test": "node --test"
+    "test": "node --test",
+    "test:coverage": "nyc --reporter=lcov --produce-source-map node --test",
+    "lint": "standard",
+    "lint:fix": "standard --fix"
+  },
+  "nyc": {
+    "extension": [
+      ".js"
+    ],
+    "include": [
+      "src/fetchers/*.js",
+      "src/index.js",
+      "cli.js"
+    ],
+    "sourceMap": true,
+    "instrument": true
   },
   "keywords": [],
   "author": "Björn Kimminich",
@@ -16,6 +31,10 @@
     "cheerio": "^1.2.0",
     "commander": "^14.0.3"
   },
+  "devDependencies": {
+    "nyc": "^17.1.0",
+    "standard": "^17.1.2"
+  },
   "engines": {
     "node": "20 - 24"
   }

package/scripts/update-test-data.js

@@ -0,0 +1,28 @@
+const fs = require('fs')
+const path = require('path')
+const { request } = require('../src/utils/httpClient')
+
+const targets = [
+  { id: '16215', url: 'https://unityleague.gg/player/16215/', file: 'unityLeague.html' },
+  { id: '3irvwtmk', url: 'https://mtgeloproject.net/profile/3irvwtmk', file: 'mtgElo.html' },
+  { id: 'k0shiii', url: 'https://melee.gg/Profile/Index/k0shiii', file: 'melee.html' },
+  { id: 'k0shiii', url: 'https://topdeck.gg/profile/@k0shiii', file: 'topdeck.html' },
+  { id: 'm4VSTJShiXR1PCSCWaM9TBY0rcg1', url: 'https://topdeck.gg/profile/m4VSTJShiXR1PCSCWaM9TBY0rcg1/stats', file: 'topdeck.json' }
+]
+
+async function updateTestData () {
+  for (const target of targets) {
+    console.log(`Fetching ${target.url}...`)
+    try {
+      const { data } = await request(target.url, { maxRedirects: 10 })
+      const filePath = path.join(__dirname, '..', 'test', 'data', target.file)
+      fs.writeFileSync(filePath, data)
+      console.log(`Updated ${filePath}`)
+    } catch (error) {
+      console.error(`Error updating ${target.file}:`, error.message)
+      process.exit(1)
+    }
+  }
+}
+
+updateTestData()

package/src/fetchers/melee.js

@@ -1,23 +1,23 @@
-const { request } = require('../utils/httpClient');
-const cheerio = require('cheerio');
+const { request } = require('../utils/httpClient')
+const cheerio = require('cheerio')
 
 class MeleeFetcher {
-  async fetchById(username) {
-    const url = `https://melee.gg/Profile/Index/${username}`;
+  async fetchById (username) {
+    const url = `https://melee.gg/Profile/Index/${username}`
     try {
-      const { data } = await request(url);
-      return this.parseHtml(data, url, username);
+      const { data } = await request(url)
+      return this.parseHtml(data, url, username)
     } catch (error) {
-      console.error(`Error fetching Melee profile ${username}:`, error.message);
-      return null;
+      console.error(`Error fetching Melee profile ${username}:`, error.message)
+      return null
     }
   }
 
-  parseHtml(html, url, username) {
-    const $ = cheerio.load(html);
-    const name = $('span[style*="font-size: xx-large"]').first().text().trim() || username;
-    const pronouns = $('.profile-details span.text-muted.mr-2').filter((i, el) => $(el).text().includes('/')).first().text().trim();
-    const bio = $('.profile-details div[style*="max-width: 75%"]').first().text().trim();
+  parseHtml (html, url, username) {
+    const $ = cheerio.load(html)
+    const name = $('span[style*="font-size: xx-large"]').first().text().trim() || username
+    const pronouns = $('.profile-details span.text-muted.mr-2').filter((i, el) => $(el).text().includes('/')).first().text().trim()
+    const bio = $('.profile-details div[style*="max-width: 75%"]').first().text().trim()
     // FIXME Photos cannot be loaded with unauthenticated requests from Melee.gg
     // const photo = $('.profile-button-column img').first().attr('src') || $('img.m-auto').attr('src');
 
@@ -26,39 +26,30 @@ class MeleeFetcher {
       url,
       name,
       pronouns: pronouns || null,
-      bio: bio || null,
+      bio: bio || null
       // photo: photo ? (photo.startsWith('http') ? photo : `https://melee.gg${photo}`) : null
-    };
+    }
 
     $('.social-link').each((i, el) => {
-      const href = $(el).attr('href');
+      const href = $(el).attr('href')
       if (href) {
         try {
-          const urlObj = new URL(href);
-          const platform = urlObj.hostname.replace('www.', '').split('.')[0];
-          let handle = urlObj.pathname.split('/').filter(Boolean).pop();
-          if (handle) {
-            handle = decodeURIComponent(handle);
-          }
-          if (platform === 'youtube' && handle.startsWith('@')) {
-            // keep @ for youtube
-          } else if (platform === 'facebook') {
-            // handle is correct
-          } else if (platform === 'twitch') {
-            // handle is correct
-          }
+          const urlObj = new URL(href)
+          const platform = urlObj.hostname.replace('www.', '').split('.')[0]
+          let handle = urlObj.pathname.split('/').filter(Boolean).pop()
           if (handle) {
-            const label = platform.charAt(0).toLowerCase() + platform.slice(1);
-            data[label] = handle;
+            handle = decodeURIComponent(handle)
+            const label = platform.charAt(0).toLowerCase() + platform.slice(1)
+            data[label] = handle
           }
         } catch (e) {
-          // ignore invalid URLs
+          console.log('Invalid URL in social link ' + href + ': ' + e.message)
         }
       }
-    });
+    })
 
-    return data;
+    return data
   }
 }
 
-module.exports = MeleeFetcher;
+module.exports = MeleeFetcher

package/src/fetchers/mtgElo.js

@@ -1,85 +1,85 @@
-const { request } = require('../utils/httpClient');
+const { request } = require('../utils/httpClient')
 
 class MtgEloFetcher {
-  async fetchById(id) {
-    const url = `https://mtgeloproject.net/profile/${id}`;
+  async fetchById (id) {
+    const url = `https://mtgeloproject.net/profile/${id}`
     try {
       const { data: html } = await request(url, {
         maxRedirects: 10
-      });
+      })
 
-      return this.parseHtml(html, url, id);
+      return this.parseHtml(html, url, id)
     } catch (error) {
-      console.error(`Error fetching MTG Elo Project profile ${id}:`, error.message);
-      return null;
+      console.error(`Error fetching MTG Elo Project profile ${id}:`, error.message)
+      return null
     }
   }
 
-  parseHtml(html, url, id) {
-    const cheerio = require('cheerio');
-    const $ = cheerio.load(html);
+  parseHtml (html, url, id) {
+    const cheerio = require('cheerio')
+    const $ = cheerio.load(html)
 
-    let name = '';
-    let currentRating = '';
-    let record = '';
+    let name = ''
+    let currentRating = ''
+    let record = ''
 
-    const astroIsland = $('astro-island[component-url*="Profile"]');
+    const astroIsland = $('astro-island[component-url*="Profile"]')
     if (astroIsland.length > 0) {
       try {
-        const props = JSON.parse(astroIsland.attr('props'));
-        const info = props.info[1];
-        name = `${info.first_name[1]} ${info.last_name[1]}`;
-        currentRating = Math.round(info.current_rating[1]).toString();
-        const r = info.record[1];
-        record = `${r[0][1]}-${r[1][1]}-${r[2][1]}`;
+        const props = JSON.parse(astroIsland.attr('props'))
+        const info = props.info[1]
+        name = `${info.first_name[1]} ${info.last_name[1]}`
+        currentRating = Math.round(info.current_rating[1]).toString()
+        const r = info.record[1]
+        record = `${r[0][1]}-${r[1][1]}-${r[2][1]}`
       } catch (e) {
-        console.error('Error parsing MTG Elo props:', e.message);
+        console.error('Error parsing MTG Elo props:', e.message)
       }
     }
 
     if (!name) {
-      name = $('.text-\\[22pt\\]').text().trim();
+      name = $('.text-\\[22pt\\]').text().trim()
       if (name.includes(',')) {
-        const parts = name.split(',').map(s => s.trim());
-        name = `${parts[1]} ${parts[0]}`;
+        const parts = name.split(',').map(s => s.trim())
+        name = `${parts[1]} ${parts[0]}`
       }
     }
 
     if (!currentRating) {
-      currentRating = $('.text-\\[18pt\\]:contains("Current rating")').find('.font-bold').text().trim();
+      currentRating = $('.text-\\[18pt\\]:contains("Current rating")').find('.font-bold').text().trim()
     }
 
     if (!record) {
-      const recordText = $('.text-\\[18pt\\]:contains("Record")').text();
-      record = recordText.replace('Record:', '').trim();
+      const recordText = $('.text-\\[18pt\\]:contains("Record")').text()
+      record = recordText.replace('Record:', '').trim()
     }
 
-    if (!name) return null;
+    if (!name) return null
 
     const data = {
       source: 'MTG Elo Project',
-      url: url,
-      name: name,
+      url,
+      name,
       player_id: id,
       current_rating: currentRating,
-      record: record
-    };
+      record
+    }
 
     if (record && record.includes('-')) {
-      const [w, l, d] = record.split('-').map(Number);
+      const [w, l, d] = record.split('-').map(Number)
       if (!isNaN(w) && !isNaN(l)) {
-        const wins = w;
-        const losses = l;
-        const draws = isNaN(d) ? 0 : d;
-        const total = wins + losses + draws;
+        const wins = w
+        const losses = l
+        const draws = isNaN(d) ? 0 : d
+        const total = wins + losses + draws
         if (total > 0) {
-          data['win rate'] = ((wins / total) * 100).toFixed(2) + '%';
+          data['win rate'] = ((wins / total) * 100).toFixed(2) + '%'
         }
       }
     }
 
-    return data;
+    return data
   }
 }
 
-module.exports = MtgEloFetcher;
+module.exports = MtgEloFetcher