epg-grabber 0.31.0 → 0.32.0

package/README.md

@@ -75,7 +75,7 @@ Arguments:
 
 - `-c, --config`: path to config file
 - `-o, --output`: path to output file or path template (example: `guides/{site}.{lang}.xml`; default: `guide.xml`)
-- `--channels`: path to list of channels
+- `--channels`: path to list of channels; you can also use wildcard to specify the path to multiple files at once (example: `example.com_*.channels.xml`)
 - `--lang`: set default language for all programs (default: `en`)
 - `--days`: number of days for which to grab the program (default: `1`)
 - `--delay`: delay between requests in milliseconds (default: `3000`)
@@ -94,7 +94,7 @@ Arguments:
 module.exports = {
   site: 'example.com', // site domain name (required)
   output: 'example.com.guide.xml', // path to output file or path template (example: 'guides/{site}.{lang}.xml'; default: 'guide.xml')
-  channels: 'example.com.channels.xml', // path to channels.xml file (required)
+  channels: 'example.com.channels.xml', // path to list of channels; you can also use an array to specify the path to multiple files at once (example: ['channels1.xml', 'channels2.xml']; required)
   lang: 'fr', // default language for all programs (default: 'en')
   days: 3, // number of days for which to grab the program (default: 1)
   delay: 5000, // delay between requests (default: 3000)

package/bin/epg-grabber.js

@@ -22,7 +22,7 @@ program
   .description(description)
   .requiredOption('-c, --config <config>', 'Path to [site].config.js file')
   .option('-o, --output <output>', 'Path to output file')
-  .option('--channels <channels>', 'Path to channels.xml file')
+  .option('--channels <channels>', 'Path to list of channels')
   .option('--lang <lang>', 'Set default language for all programs')
   .option('--days <days>', 'Number of days for which to grab the program', parseNumber)
   .option('--delay <delay>', 'Delay between requests (in milliseconds)', parseNumber)
@@ -65,17 +65,31 @@ async function main() {
 
   if (options.timeout) config.request.timeout = options.timeout
   if (options.cacheTtl) config.request.cache.ttl = options.cacheTtl
+
   if (options.channels) config.channels = options.channels
-  else if (config.channels)
-    config.channels = file.join(file.dirname(options.config), config.channels)
-  else throw new Error("The required 'channels' property is missing")
 
-  if (!config.channels) return logger.error('Path to [site].channels.xml is missing')
-  logger.info(`Loading '${config.channels}'...`)
-  const grabber = new EPGGrabber(config)
+  let parsedChannels = []
+  if (config.channels) {
+    const dir = file.dirname(options.config)
+
+    let files = []
+    if (Array.isArray(config.channels)) {
+      files = config.channels.map(path => file.join(dir, path))
+    } else if (typeof config.channels === 'string') {
+      files = await file.list(config.channels)
+    } else {
+      throw new Error('The "channels" attribute must be of type array or string')
+    }
+
+    for (let filepath of files) {
+      logger.info(`Loading '${filepath}'...`)
+      const channelsXML = file.read(filepath)
+      const { channels } = parseChannels(channelsXML)
+      parsedChannels = parsedChannels.concat(channels)
+    }
+  } else throw new Error('Path to "channels" is missing')
 
-  const channelsXML = file.read(config.channels)
-  const { channels: parsedChannels } = parseChannels(channelsXML)
+  const grabber = new EPGGrabber(config)
 
   let template = options.output || config.output
   const variables = file.templateVariables(template)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "epg-grabber",
-  "version": "0.31.0",
+  "version": "0.32.0",
   "description": "Node.js CLI tool for grabbing EPG from different sites",
   "main": "src/index.js",
   "preferGlobal": true,

package/src/file.js

@@ -1,6 +1,8 @@
 const fs = require('fs')
 const path = require('path')
+const glob = require('glob')
 
+module.exports.list = list
 module.exports.read = read
 module.exports.write = write
 module.exports.resolve = resolve
@@ -9,6 +11,14 @@ module.exports.dirname = dirname
 module.exports.templateVariables = templateVariables
 module.exports.templateFormat = templateFormat
 
+function list(pattern) {
+  return new Promise(resolve => {
+    glob(pattern, function (err, files) {
+      resolve(files)
+    })
+  })
+}
+
 function read(filepath) {
   return fs.readFileSync(path.resolve(filepath), { encoding: 'utf-8' })
 }

package/tests/__data__/input/example_2.channels.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<site site="example2.com">
+  <channels>
+    <channel xmltv_id="3TV.com" site_id="3">3 TV</channel>
+    <channel xmltv_id="4TV.com" site_id="4">4 TV</channel>
+  </channels>
+</site>

package/tests/__data__/input/example_channels.config.js

@@ -0,0 +1,32 @@
+const dayjs = require('dayjs')
+const utc = require('dayjs/plugin/utc')
+
+dayjs.extend(utc)
+
+module.exports = {
+  site: 'example.com',
+  days: 2,
+  channels: ['example.channels.xml', 'example_2.channels.xml'],
+  output: 'tests/__data__/output/guide.xml',
+  url: () => 'http://example.com/20210319/1tv.json',
+  request: {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      Cookie: 'abc=123'
+    },
+    data() {
+      return { accountID: '123' }
+    }
+  },
+  parser: () => {
+    return [
+      {
+        title: 'Program1',
+        start: 1640995200000,
+        stop: 1640998800000
+      }
+    ]
+  },
+  logo: () => 'http://example.com/logos/1TV.png?x=шеллы&sid=777'
+}

package/tests/__data__/output/guide.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8" ?><tv date="20230709">
+<channel id="1TV.com"><display-name>1 TV</display-name><icon src="https://example.com/logos/1TV.png"/><url>https://example.com</url></channel>
+<channel id="2TV.com"><display-name>2 TV</display-name><icon src="http://example.com/logos/1TV.png?x=шеллы&amp;sid=777"/><url>https://example.com</url></channel>
+<channel id="3TV.com"><display-name>3 TV</display-name><icon src="http://example.com/logos/1TV.png?x=шеллы&amp;sid=777"/><url>https://example2.com</url></channel>
+<channel id="4TV.com"><display-name>4 TV</display-name><icon src="http://example.com/logos/1TV.png?x=шеллы&amp;sid=777"/><url>https://example2.com</url></channel>
+</tv>

package/tests/bin.test.js

@@ -105,3 +105,25 @@ it('removes duplicates of the program', () => {
 
   expect(output.programs).toEqual(expected.programs)
 })
+
+it('can load multiple "channels.xml" files at once', () => {
+  const stdout = execSync(
+    `node ${pwd}/bin/epg-grabber.js --config=tests/__data__/input/example.config.js --channels=tests/__data__/input/example*.channels.xml --timeout=1`,
+    {
+      encoding: 'utf8'
+    }
+  )
+
+  expect(stdoutResultTester(stdout)).toBe(true)
+})
+
+it('can parse list of "channels.xml" from array', () => {
+  const stdout = execSync(
+    `node ${pwd}/bin/epg-grabber.js --config=tests/__data__/input/example_channels.config.js --timeout=1`,
+    {
+      encoding: 'utf8'
+    }
+  )
+
+  expect(stdoutResultTester(stdout)).toBe(true)
+})

package/tests/__data__/output/duplicates.guide.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?><tv date="20230521">
-<channel id="1TV.com"><display-name>1 TV</display-name><icon src="https://example.com/logos/1TV.png"/><url>https://example.com</url></channel>
-<channel id="2TV.com"><display-name>2 TV</display-name><url>https://example.com</url></channel>
-<programme start="20220101000000 +0000" stop="20220101010000 +0000" channel="1TV.com"><title lang="fr">Program1</title></programme>
-<programme start="20220101000000 +0000" stop="20220101010000 +0000" channel="2TV.com"><title>Program1</title></programme>
-</tv>