epg-grabber 0.32.0 → 0.34.0

package/README.md

@@ -43,11 +43,9 @@ module.exports = {
 
 ```xml
 <?xml version="1.0" ?>
-<site site="example.com">
-  <channels>
-    <channel site_id="cnn-23" xmltv_id="CNN.us">CNN</channel>
-  </channels>
-</site>
+<channels site="example.com">
+  <channel site_id="cnn-23" xmltv_id="CNN.us">CNN</channel>
+</channels>
 ```
 
 ## Example Output
@@ -218,18 +216,17 @@ From each function in `config.js` you can access a `context` object containing t
 
 ```xml
 <?xml version="1.0" ?>
-<site site="example.com">
-  <channels>
-    <channel site_id="cnn-23" xmltv_id="CNN.us">CNN</channel>
-    ...
-  </channels>
-</site>
+<channels site="example.com">
+  <channel site_id="cnn-23" xmltv_id="CNN.us">CNN</channel>
+  ...
+</channels>
 ```
 
-You can also specify the language and logo for each channel individually, like so:
+You can also specify the language, site and logo for each channel individually, like so:
 
 ```xml
 <channel
+  site="example.com"
   site_id="france-24"
   xmltv_id="France24.fr"
   lang="fr"

package/bin/epg-grabber.js

@@ -84,7 +84,7 @@ async function main() {
     for (let filepath of files) {
       logger.info(`Loading '${filepath}'...`)
       const channelsXML = file.read(filepath)
-      const { channels } = parseChannels(channelsXML)
+      const channels = parseChannels(channelsXML)
       parsedChannels = parsedChannels.concat(channels)
     }
   } else throw new Error('Path to "channels" is missing')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "epg-grabber",
-  "version": "0.32.0",
+  "version": "0.34.0",
   "description": "Node.js CLI tool for grabbing EPG from different sites",
   "main": "src/index.js",
   "preferGlobal": true,
@@ -8,7 +8,7 @@
     "epg-grabber": "bin/epg-grabber.js"
   },
   "scripts": {
-    "lint": "npx eslint ./src/**/*.js",
+    "lint": "npx eslint ./src/**/*.js ./tests/**/*.js",
     "test": "npx jest"
   },
   "publishConfig": {

package/src/client.js

@@ -15,6 +15,7 @@ let timeout
 function create(config) {
   const client = setupCache(
     axios.create({
+      ignoreCookieErrors: true,
       headers: {
         'User-Agent':
           'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.130 Safari/537.36 Edg/79.0.309.71'

package/src/index.d.ts

@@ -0,0 +1,119 @@
+import dayjs from 'dayjs'
+
+export declare class Channel {
+  xmltv_id?: string
+  name: string
+  site?: string
+  site_id: string
+  lang?: string
+  logo?: string
+}
+
+type TextObject = {
+  lang: string
+  value: string
+}
+
+type IconObject = {
+  src: string
+}
+
+type UrlObject = {
+  system: string
+  value: string
+}
+
+type RatingObject = {
+  system: string
+  icon: string
+  value: string
+}
+
+type ImageObject = {
+  type: string
+  size: string
+  orient: string
+  system: string
+  value: string
+}
+
+type PersonObject = {
+  value: string
+  url: UrlObject[]
+  image: ImageObject[]
+}
+
+export declare class Program {
+  site?: string
+  channel?: string
+  titles: TextObject[]
+  sub_titles?: TextObject[]
+  descriptions?: TextObject[]
+  icon?: IconObject
+  episodeNumbers?: string[]
+  date?: number
+  start: number
+  stop?: number
+  urls?: UrlObject[]
+  ratings?: RatingObject[]
+  categories?: TextObject[]
+  directors?: PersonObject[]
+  actors?: PersonObject[]
+  writers?: PersonObject[]
+  adapters?: PersonObject[]
+  producers?: PersonObject[]
+  composers?: PersonObject[]
+  editors?: PersonObject[]
+  presenters?: PersonObject[]
+  commentators?: PersonObject[]
+  guests?: PersonObject[]
+}
+
+export declare type SiteConfig = {
+  site: string
+  days?: number
+  output?: string
+  channels?: () => object[] | string | Promise<object[]>
+  delay?: number
+  maxConnections?: number
+  request?: object
+  url: () => string | string | Promise<string>
+  logo?: () => string | string | Promise<string>
+  parser: () => object[] | Promise<object[]>
+}
+
+export declare function generateXMLTV({
+  channels,
+  programs,
+  date
+}: {
+  channels: Channel[]
+  programs: Program[]
+  date?: string | null
+}): string
+
+export declare function parseChannels(xml: string): { site: string; channels: Channel[] }
+
+export type GrabCallbackData = {
+  channel: Channel
+  programs: Program[]
+  date: dayjs.Dayjs
+}
+
+export declare class EPGGrabber {
+  constructor(config: SiteConfig)
+  grab(
+    channel: Channel,
+    date: string | dayjs.Dayjs,
+    cb: (data: GrabCallbackData, err: Error | null) => void
+  ): Promise<Program[]>
+}
+
+export declare class EPGGrabberMock {
+  constructor(config: SiteConfig)
+  grab(
+    channel: Channel,
+    date: string | dayjs.Dayjs,
+    cb: (data: GrabCallbackData, err: Error | null) => void
+  ): Promise<Program[]>
+}

package/src/index.js

@@ -53,4 +53,26 @@ class EPGGrabber {
   }
 }
 
+class EPGGrabberMock {
+  constructor(config) {
+    this.config = config
+  }
+
+  async grab(channel, date, cb) {
+    let _date = getUTCDate(date)
+    let _programs = await this.config.parser({ channel, date: _date })
+    let programs = _programs.map(data => new Program(data, channel))
+
+    if (this.config.request?.timeout !== undefined && this.config.request.timeout < 1) {
+      cb({ programs: [], date: _date, channel }, new Error('Connection timeout'))
+      return []
+    }
+
+    cb({ programs, date: _date, channel }, null)
+
+    return programs
+  }
+}
+
 module.exports.EPGGrabber = EPGGrabber
+module.exports.EPGGrabberMock = EPGGrabberMock

package/src/parser.js

@@ -9,11 +9,19 @@ module.exports.parsePrograms = parsePrograms
 function parseChannels(xml) {
   const result = convert.xml2js(xml)
   const siteTag = result.elements.find(el => el.name === 'site') || {}
-  if (!siteTag.elements) return []
-  const rootSite = siteTag.attributes.site
 
-  const channelsTag = siteTag.elements.find(el => el.name === 'channels')
-  if (!channelsTag.elements) return []
+  const channelsTag =
+    siteTag && Array.isArray(siteTag.elements)
+      ? siteTag.elements.find(el => el.name === 'channels')
+      : result.elements.find(el => el.name === 'channels')
+  if (!channelsTag || !channelsTag.elements) return []
+
+  let rootSite = ''
+  if (siteTag && siteTag.attributes && siteTag.attributes.site) {
+    rootSite = siteTag.attributes.site
+  } else if (channelsTag && channelsTag.attributes && channelsTag.attributes.site) {
+    rootSite = channelsTag.attributes.site
+  }
 
   const channels = channelsTag.elements
     .filter(el => el.name === 'channel')
@@ -26,7 +34,7 @@ function parseChannels(xml) {
       return new Channel(c)
     })
 
-  return { site: rootSite, channels }
+  return channels
 }
 
 async function parsePrograms(data) {

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

@@ -1,7 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<site site="example.com">
-  <channels>
-    <channel xmltv_id="1TV.com" site_id="1" lang="fr" logo="https://example.com/logos/1TV.png">1 TV</channel>
-    <channel xmltv_id="2TV.com" site="example.com" site_id="2">2 TV</channel>
-  </channels>
-</site>
+<channels site="example.com">
+  <channel xmltv_id="1TV.com" site_id="1" lang="fr" logo="https://example.com/logos/1TV.png">1 TV</channel>
+  <channel xmltv_id="2TV.com" site_id="2">2 TV</channel>
+</channels>

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

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<channels>
+  <channel site="example.com" xmltv_id="1TV.com" site_id="1" lang="fr" logo="https://example.com/logos/1TV.png">1 TV</channel>
+  <channel site="example.com" xmltv_id="2TV.com" site_id="2">2 TV</channel>
+</channels>

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

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<site site="example.com">
+  <channels>
+    <channel xmltv_id="1TV.com" site_id="1" lang="fr" logo="https://example.com/logos/1TV.png">1 TV</channel>
+    <channel xmltv_id="2TV.com" site_id="2">2 TV</channel>
+  </channels>
+</site>

package/tests/__data__/output/guide.xml

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="UTF-8" ?><tv date="20230709">
+<?xml version="1.0" encoding="UTF-8" ?><tv date="20230930">
 <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>

package/tests/__mocks__/axios.js

@@ -1,2 +1,3 @@
-import mockAxios from 'jest-mock-axios'
-export default mockAxios
+const mockAxios = require('jest-mock-axios')
+
+module.exports = mockAxios

package/tests/bin.test.js

@@ -87,7 +87,7 @@ it('can produce multiple outputs', () => {
 })
 
 it('removes duplicates of the program', () => {
-  const stdout = execSync(
+  execSync(
     `node ${pwd}/bin/epg-grabber.js \
       --config=tests/__data__/input/duplicates.config.js \
       --channels=tests/__data__/input/example.channels.xml \

package/tests/index.test.js

@@ -2,7 +2,7 @@
  * @jest-environment node
  */
 
-import { EPGGrabber, Channel } from '../src/index'
+import { EPGGrabber, EPGGrabberMock, Channel } from '../src/index'
 import axios from 'axios'
 
 jest.mock('axios')
@@ -66,3 +66,58 @@ it('can grab single channel programs', done => {
       done()
     })
 })
+
+it('can mock epg grabber', done => {
+  const config = {
+    site: 'example.com',
+    url: 'http://example.com/20210319/1tv.json',
+    parser: ({ channel, date }) => [
+      { title: `Test (${channel.name})`, start: '2021-03-19T04:30:00.000Z' }
+    ]
+  }
+  const channel = new Channel({
+    site: 'example.com',
+    site_id: '1',
+    xmltv_id: '1TV.fr',
+    lang: 'fr',
+    name: '1TV'
+  })
+  const grabber = new EPGGrabberMock(config)
+  grabber
+    .grab(channel, '2022-01-01', (data, err) => {
+      if (err) {
+        done()
+      }
+    })
+    .then(programs => {
+      expect(programs.length).toBe(1)
+      expect(programs).toEqual([
+        {
+          site: 'example.com',
+          channel: '1TV.fr',
+          titles: [{ value: 'Test (1TV)', lang: 'fr' }],
+          sub_titles: [],
+          descriptions: [],
+          icon: { src: '' },
+          episodeNumbers: [],
+          date: null,
+          start: 1616128200000,
+          stop: null,
+          urls: [],
+          ratings: [],
+          categories: [],
+          directors: [],
+          actors: [],
+          writers: [],
+          adapters: [],
+          producers: [],
+          composers: [],
+          editors: [],
+          presenters: [],
+          commentators: [],
+          guests: []
+        }
+      ])
+      done()
+    })
+})

package/tests/parser.test.js

@@ -3,14 +3,83 @@ import Channel from '../src/Channel'
 import Program from '../src/Program'
 import fs from 'fs'
 
-it('can parse valid channels.xml', () => {
-  const file = fs.readFileSync('./tests/__data__/input/example.channels.xml', { encoding: 'utf-8' })
-  const { channels, site } = parseChannels(file)
+it('can parse channels.xml', () => {
+  const file = fs.readFileSync('./tests/__data__/input/example.channels.xml', {
+    encoding: 'utf-8'
+  })
+  const channels = parseChannels(file)
 
-  expect(typeof site).toBe('string')
   expect(channels.length).toBe(2)
   expect(channels[0]).toBeInstanceOf(Channel)
   expect(channels[1]).toBeInstanceOf(Channel)
+  expect(channels[0]).toMatchObject({
+    site: 'example.com',
+    site_id: '1',
+    xmltv_id: '1TV.com',
+    lang: 'fr',
+    logo: 'https://example.com/logos/1TV.png',
+    name: '1 TV'
+  })
+  expect(channels[1]).toMatchObject({
+    site: 'example.com',
+    site_id: '2',
+    lang: '',
+    logo: '',
+    xmltv_id: '2TV.com',
+    name: '2 TV'
+  })
+})
+
+it('can parse channels.xml with inline site attribute', () => {
+  const file = fs.readFileSync('./tests/__data__/input/example_3.channels.xml', {
+    encoding: 'utf-8'
+  })
+  const channels = parseChannels(file)
+
+  expect(channels.length).toBe(2)
+  expect(channels[0]).toBeInstanceOf(Channel)
+  expect(channels[1]).toBeInstanceOf(Channel)
+  expect(channels[0]).toMatchObject({
+    site: 'example.com',
+    site_id: '1',
+    xmltv_id: '1TV.com',
+    lang: 'fr',
+    logo: 'https://example.com/logos/1TV.png',
+    name: '1 TV'
+  })
+  expect(channels[1]).toMatchObject({
+    site: 'example.com',
+    site_id: '2',
+    lang: '',
+    logo: '',
+    xmltv_id: '2TV.com',
+    name: '2 TV'
+  })
+})
+
+it('can parse legacy channels.xml', () => {
+  const file = fs.readFileSync('./tests/__data__/input/legacy.channels.xml', { encoding: 'utf-8' })
+  const channels = parseChannels(file)
+
+  expect(channels.length).toBe(2)
+  expect(channels[0]).toBeInstanceOf(Channel)
+  expect(channels[1]).toBeInstanceOf(Channel)
+  expect(channels[0]).toMatchObject({
+    site: 'example.com',
+    site_id: '1',
+    xmltv_id: '1TV.com',
+    lang: 'fr',
+    logo: 'https://example.com/logos/1TV.png',
+    name: '1 TV'
+  })
+  expect(channels[1]).toMatchObject({
+    site: 'example.com',
+    site_id: '2',
+    lang: '',
+    logo: '',
+    xmltv_id: '2TV.com',
+    name: '2 TV'
+  })
 })
 
 it('can parse programs', done => {