epg-grabber 0.17.0 → 0.20.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)
 

package/bin/epg-grabber.js

@@ -79,28 +79,32 @@ 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
   let days = options.days || 1
   const total = channels.length * days
+  const utcDate = utils.getUTCDate()
+  const dates = Array.from({ length: config.days }, (_, i) => utcDate.add(i, 'd'))
   for (let channel of channels) {
-    await grabber
-      .grab(channel, config, (data, err) => {
-        logger.info(
-          `[${i}/${total}] ${config.site} - ${data.channel.xmltv_id} - ${data.date.format(
-            'MMM D, YYYY'
-          )} (${data.programs.length} programs)`
-        )
-
-        if (err) logger.error(err.message)
-
-        if (i < total) i++
-      })
-      .then(results => {
-        programs = programs.concat(results)
-      })
+    for (let date of dates) {
+      await grabber
+        .grab(channel, date, config, (data, err) => {
+          logger.info(
+            `[${i}/${total}] ${config.site} - ${data.channel.xmltv_id} - ${data.date.format(
+              'MMM D, YYYY'
+            )} (${data.programs.length} programs)`
+          )
+
+          if (err) logger.error(err.message)
+
+          if (i < total) i++
+        })
+        .then(results => {
+          programs = programs.concat(results)
+        })
+    }
   }
 
   const xml = utils.convertToXMLTV({ config, channels, programs })

package/package.json

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

package/src/index.js

@@ -1,41 +1,29 @@
 const utils = require('./utils')
 
 module.exports = {
-  grab: async function (channel, config, cb) {
+  grab: async function (channel, date, config, cb) {
+    date = typeof date === 'string' ? utils.getUTCDate(date) : date
     config = utils.loadConfig(config)
     channel.lang = channel.lang || config.lang || null
 
-    const utcDate = utils.getUTCDate()
-    const dates = Array.from({ length: config.days }, (_, i) => utcDate.add(i, 'd'))
-    const queue = []
-    dates.forEach(date => {
-      queue.push({ date, channel })
-    })
-
     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))
-        .then(response => utils.parseResponse(item, response, config))
-        .then(results => {
-          item.programs = results
-          cb(item, null)
-          programs = programs.concat(results)
-        })
-        .catch(err => {
-          item.programs = []
-          cb(item, err)
-        })
+    const item = { date, channel }
+    await utils
+      .buildRequest(item, config)
+      .then(request => utils.fetchData(request))
+      .then(response => utils.parseResponse(item, response, config))
+      .then(results => {
+        item.programs = results
+        cb(item, null)
+        programs = programs.concat(results)
+      })
+      .catch(err => {
+        item.programs = []
+        cb(item, err)
+      })
 
-      await utils.sleep(config.delay)
-    }
+    await utils.sleep(config.delay)
 
     return programs
   },

package/src/utils.js

@@ -65,7 +65,7 @@ utils.parseChannels = function (xml) {
       return channel
     })
 
-  return channels
+  return { site, channels }
 }
 
 utils.sleep = function (ms) {
@@ -259,7 +259,9 @@ utils.getRequestUrl = async function (item, config) {
   return config.url
 }
 
-utils.getUTCDate = function () {
+utils.getUTCDate = function (d = null) {
+  if (typeof d === 'string') return dayjs.utc(d).startOf('d')
+
   return dayjs.utc().startOf('d')
 }
 
@@ -295,6 +297,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

@@ -27,7 +27,7 @@ it('return "Connection timeout" error if server does not response', done => {
     lang: 'en',
     name: 'CNN'
   }
-  grabber.grab(channel, config, (data, err) => {
+  grabber.grab(channel, '2022-01-01', config, (data, err) => {
     expect(err.message).toBe('Connection timeout')
     done()
   })
@@ -54,7 +54,7 @@ it('can grab single channel programs', done => {
     name: '1TV'
   }
   grabber
-    .grab(channel, config, (data, err) => {
+    .grab(channel, '2022-01-01', config, (data, err) => {
       if (err) {
         console.log(`    Error: ${err.message}`)
         done()
@@ -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',
@@ -102,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',
@@ -198,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