epg-grabber 0.16.0 → 0.19.0

package/README.md

@@ -94,7 +94,6 @@ module.exports = {
   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)
-  ignore: true, // skip all channels during request (default: false)
 
   request: { // request options (details: https://github.com/axios/axios#request-config)
 
@@ -159,12 +158,14 @@ module.exports = {
     return [
       {
         title, // program title (required)
-        start, // program start time (required)
-        stop, // program end time (optional)
-        description, // program description (optional)
-        category, // program category (optional)
-        icon, // program icon (optional)
-        lang // program language (default: 'en')
+        start, // start time of the program (required)
+        stop, // end time of the program (required)
+        description, // description of the program (optional)
+        category, // program type (optional)
+        season, // season number (optional)
+        episode, // episode number (optional)
+        icon, // image associated with the program (optional)
+        lang // language of the description (default: 'en')
       },
       ...
     ]

package/bin/epg-grabber.js

@@ -7,7 +7,7 @@ const path = require('path')
 const grabber = require('../src/index')
 const utils = require('../src/utils')
 const { name, version, description } = require('../package.json')
-const merge = require('lodash.merge')
+const { merge } = require('lodash')
 const { createLogger, format, transports } = require('winston')
 const { combine, timestamp, printf } = format
 
@@ -79,7 +79,7 @@ async function main() {
   if (!config.channels) return logger.error('Path to [site].channels.xml is missing')
   logger.info(`Loading '${config.channels}'...`)
   const channelsXML = fs.readFileSync(path.resolve(config.channels), { encoding: 'utf-8' })
-  const channels = utils.parseChannels(channelsXML)
+  const { channels } = utils.parseChannels(channelsXML)
 
   let programs = []
   let i = 1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "epg-grabber",
-  "version": "0.16.0",
+  "version": "0.19.0",
   "description": "Node.js CLI tool for grabbing EPG from different sites",
   "main": "src/index.js",
   "preferGlobal": true,
@@ -34,7 +34,7 @@
     "commander": "^7.1.0",
     "dayjs": "^1.10.4",
     "glob": "^7.1.6",
-    "lodash.merge": "^4.6.2",
+    "lodash": "^4.17.21",
     "tough-cookie": "^4.0.0",
     "winston": "^3.3.3",
     "xml-js": "^1.6.11"

package/src/index.js

@@ -14,12 +14,6 @@ module.exports = {
 
     let programs = []
     for (let item of queue) {
-      if (config.ignore) {
-        item.programs = []
-        cb(item, new Error('Skipped'))
-        continue
-      }
-
       await utils
         .buildRequest(item, config)
         .then(request => utils.fetchData(request))

package/src/utils.js

@@ -1,10 +1,11 @@
 const fs = require('fs')
+const { padStart } = require('lodash')
 const path = require('path')
 const axios = require('axios').default
 const axiosCookieJarSupport = require('axios-cookiejar-support').default
 const tough = require('tough-cookie')
 const convert = require('xml-js')
-const merge = require('lodash.merge')
+const { merge } = require('lodash')
 const dayjs = require('dayjs')
 const utc = require('dayjs/plugin/utc')
 dayjs.extend(utc)
@@ -64,7 +65,7 @@ utils.parseChannels = function (xml) {
       return channel
     })
 
-  return channels
+  return { site, channels }
 }
 
 utils.sleep = function (ms) {
@@ -126,6 +127,8 @@ utils.convertToXMLTV = function ({ channels, programs }) {
     const start = program.start ? dayjs.unix(program.start).utc().format('YYYYMMDDHHmmss ZZ') : ''
     const stop = program.stop ? dayjs.unix(program.stop).utc().format('YYYYMMDDHHmmss ZZ') : ''
     const lang = program.lang || 'en'
+    const xmltv_ns = createXMLTVNS(program.season, program.episode)
+    const onscreen = createOnScreen(program.season, program.episode)
     const icon = utils.escapeString(program.icon)
 
     if (start && stop && title) {
@@ -143,6 +146,14 @@ utils.convertToXMLTV = function ({ channels, programs }) {
         })
       }
 
+      if (xmltv_ns) {
+        output += `<episode-num system="xmltv_ns">${xmltv_ns}</episode-num>`
+      }
+
+      if (onscreen) {
+        output += `<episode-num system="onscreen">${onscreen}</episode-num>`
+      }
+
       if (icon) {
         output += `<icon src="${icon}"/>`
       }
@@ -153,6 +164,21 @@ utils.convertToXMLTV = function ({ channels, programs }) {
 
   output += '</tv>'
 
+  function createXMLTVNS(s, e) {
+    if (!s || !e) return null
+
+    return `${s - 1}.${e - 1}.0/1`
+  }
+
+  function createOnScreen(s, e) {
+    if (!s || !e) return null
+
+    s = padStart(s, 2, '0')
+    e = padStart(e, 2, '0')
+
+    return `S${s}E${e}`
+  }
+
   return output
 }
 
@@ -269,6 +295,8 @@ utils.parsePrograms = async function (data, config) {
         title: program.title,
         description: program.description || null,
         category: program.category || null,
+        season: program.season || null,
+        episode: program.episode || null,
         icon: program.icon || null,
         channel: channel.xmltv_id,
         lang: program.lang || channel.lang || config.lang || 'en',

package/tests/index.test.js

@@ -71,23 +71,3 @@ it('can grab single channel programs', done => {
       done()
     })
 })
-
-it('return "Skipped" error if ignore option in config is true', done => {
-  const config = {
-    site: 'example.com',
-    ignore: true,
-    url: `http://example.com/20210319/1tv.json`,
-    parser: () => []
-  }
-  const channel = {
-    site: 'example.com',
-    site_id: 'cnn',
-    xmltv_id: 'CNN.us',
-    lang: 'en',
-    name: 'CNN'
-  }
-  grabber.grab(channel, config, (data, err) => {
-    expect(err.message).toBe('Skipped')
-    done()
-  })
-})

package/tests/input/example.com.config.js

@@ -1,6 +1,10 @@
+const dayjs = require('dayjs')
+const utc = require('dayjs/plugin/utc')
+
+dayjs.extend(utc)
+
 module.exports = {
   site: 'example.com',
-  ignore: true,
   channels: 'example.com.channels.xml',
   output: 'tests/output/guide.xml',
   url: () => 'http://example.com/20210319/1tv.json',
@@ -14,6 +18,20 @@ module.exports = {
       return { accountID: '123' }
     }
   },
-  parser: () => [],
+  parser: () => {
+    return [
+      {
+        title: 'Title',
+        description: 'Description',
+        lang: 'en',
+        category: ['Category1', 'Category2'],
+        icon: 'https://example.com/image.jpg',
+        season: 9,
+        episode: 238,
+        start: dayjs.utc('2022-01-01 00:00:00'),
+        stop: dayjs.utc('2022-01-01 01:00:00')
+      }
+    ]
+  },
   logo: () => 'http://example.com/logos/1TV.png?x=шеллы&sid=777'
 }

package/tests/input/mini.config.js

@@ -1,6 +1,5 @@
 module.exports = {
   site: 'example.com',
-  ignore: true,
   url: 'http://example.com/20210319/1tv.json',
   parser: () => []
 }

package/tests/utils.test.js

@@ -7,7 +7,6 @@ it('can load valid config.js', () => {
   const config = utils.loadConfig(require(path.resolve('./tests/input/example.com.config.js')))
   expect(config).toMatchObject({
     days: 1,
-    ignore: true,
     delay: 3000,
     lang: 'en',
     site: 'example.com'
@@ -29,7 +28,7 @@ it('can load valid config.js', () => {
 
 it('can parse valid channels.xml', () => {
   const file = fs.readFileSync('./tests/input/example.com.channels.xml', { encoding: 'utf-8' })
-  const channels = utils.parseChannels(file)
+  const { channels } = utils.parseChannels(file)
   expect(channels).toEqual([
     {
       name: '1 TV',
@@ -52,7 +51,7 @@ it('can parse valid channels.xml', () => {
 
 it('can convert object to xmltv string', () => {
   const file = fs.readFileSync('./tests/input/example.com.channels.xml', { encoding: 'utf-8' })
-  const channels = utils.parseChannels(file)
+  const { channels } = utils.parseChannels(file)
   const programs = [
     {
       title: 'Program 1',
@@ -60,6 +59,8 @@ it('can convert object to xmltv string', () => {
       start: 1616133600,
       stop: 1616135400,
       category: 'Test',
+      season: 9,
+      episode: 239,
       icon: 'https://example.com/images/Program1.png?x=шеллы&sid=777',
       channel: '1TV.com',
       lang: 'it'
@@ -67,7 +68,7 @@ it('can convert object to xmltv string', () => {
   ]
   const output = utils.convertToXMLTV({ channels, programs })
   expect(output).toBe(
-    '<?xml version="1.0" encoding="UTF-8" ?><tv>\r\n<channel id="1TV.com"><display-name>1 TV</display-name><icon src="https://example.com/logos/1TV.png"/><url>https://example.com</url></channel>\r\n<channel id="2TV.com"><display-name>2 TV</display-name><url>https://example.com</url></channel>\r\n<programme start="20210319060000 +0000" stop="20210319063000 +0000" channel="1TV.com"><title lang="it">Program 1</title><desc lang="it">Description for Program 1</desc><category lang="it">Test</category><icon src="https://example.com/images/Program1.png?x=шеллы&amp;sid=777"/></programme>\r\n</tv>'
+    '<?xml version="1.0" encoding="UTF-8" ?><tv>\r\n<channel id="1TV.com"><display-name>1 TV</display-name><icon src="https://example.com/logos/1TV.png"/><url>https://example.com</url></channel>\r\n<channel id="2TV.com"><display-name>2 TV</display-name><url>https://example.com</url></channel>\r\n<programme start="20210319060000 +0000" stop="20210319063000 +0000" channel="1TV.com"><title lang="it">Program 1</title><desc lang="it">Description for Program 1</desc><category lang="it">Test</category><episode-num system="xmltv_ns">8.238.0/1</episode-num><episode-num system="onscreen">S09E239</episode-num><icon src="https://example.com/images/Program1.png?x=шеллы&amp;sid=777"/></programme>\r\n</tv>'
   )
 })
 
@@ -100,7 +101,7 @@ it('can convert object to xmltv string without categories', () => {
 
 it('can convert object to xmltv string with multiple categories', () => {
   const file = fs.readFileSync('./tests/input/example.com.channels.xml', { encoding: 'utf-8' })
-  const channels = utils.parseChannels(file)
+  const { channels } = utils.parseChannels(file)
   const programs = [
     {
       title: 'Program 1',
@@ -196,6 +197,28 @@ it('can load logo async', done => {
   })
 })
 
+it('can parse programs', done => {
+  const config = utils.loadConfig(require(path.resolve('./tests/input/example.com.config.js')))
+  return utils
+    .parsePrograms({ channel: { xmltv_id: '1tv', lang: 'en' } }, config)
+    .then(programs => {
+      expect(programs).toMatchObject([
+        {
+          title: 'Title',
+          description: 'Description',
+          lang: 'en',
+          category: ['Category1', 'Category2'],
+          icon: 'https://example.com/image.jpg',
+          season: 9,
+          episode: 238,
+          start: 1640995200,
+          stop: 1640998800
+        }
+      ])
+      done()
+    })
+})
+
 it('can parse programs async', done => {
   const config = utils.loadConfig(require(path.resolve('./tests/input/async.config.js')))
   return utils