epg-grabber 0.34.0 → 0.36.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "epg-grabber",
-  "version": "0.34.0",
+  "version": "0.36.0",
   "description": "Node.js CLI tool for grabbing EPG from different sites",
   "main": "src/index.js",
   "preferGlobal": true,
@@ -28,9 +28,8 @@
     "node": ">=10.0.0"
   },
   "dependencies": {
-    "axios": "^0.21.1",
+    "axios": "^1.6.1",
     "axios-cache-interceptor": "^0.10.3",
-    "axios-cookiejar-support": "^1.0.1",
     "axios-mock-adapter": "^1.20.0",
     "commander": "^7.1.0",
     "curl-generator": "^0.2.0",
@@ -39,9 +38,10 @@
     "epg-parser": "^0.1.6",
     "fs-extra": "^11.1.1",
     "glob": "^7.1.6",
+    "http-cookie-agent": "^5.0.4",
     "lodash": "^4.17.21",
     "node-gzip": "^1.1.2",
-    "tough-cookie": "^4.0.0",
+    "tough-cookie": "^4.1.3",
     "winston": "^3.3.3",
     "xml-js": "^1.6.11"
   },
@@ -50,7 +50,7 @@
     "@babel/preset-env": "^7.13.12",
     "babel-jest": "^26.6.3",
     "eslint": "^7.22.0",
-    "jest": "^26.6.3",
+    "jest": "^29.7.0",
     "jest-mock-axios": "^4.4.1"
   },
   "jest": {

package/src/client.js

@@ -1,10 +1,11 @@
 const { CurlGenerator } = require('curl-generator')
-const axios = require('axios').default
-const axiosCookieJarSupport = require('axios-cookiejar-support').default
+const { default: axios } = require('axios')
+const { CookieJar } = require('tough-cookie')
 const { setupCache } = require('axios-cache-interceptor')
 const { isObject, isPromise } = require('./utils')
+const { HttpCookieAgent, HttpsCookieAgent } = require('http-cookie-agent/http')
 
-axiosCookieJarSupport(axios)
+const jar = new CookieJar()
 
 module.exports.create = create
 module.exports.buildRequest = buildRequest
@@ -13,15 +14,20 @@ module.exports.parseResponse = parseResponse
 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'
-      }
-    })
-  )
+  const client = axios.defaults.cache
+    ? axios
+    : setupCookie(
+        setupCache(
+          axios.create({
+            jar,
+            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'
+            }
+          })
+        )
+      )
 
   client.interceptors.request.use(
     function (request) {
@@ -136,3 +142,44 @@ async function getRequestUrl({ channel, date, config }) {
   }
   return config.url
 }
+
+const AGENT_CREATED_BY_AXIOS_COOKIEJAR_SUPPORT = Symbol('AGENT_CREATED_BY_AXIOS_COOKIEJAR_SUPPORT')
+
+function requestInterceptor(config) {
+  if (!config.jar) {
+    return config
+  }
+
+  config.httpAgent = new HttpCookieAgent({ cookies: { jar: config.jar } })
+  Object.defineProperty(config.httpAgent, AGENT_CREATED_BY_AXIOS_COOKIEJAR_SUPPORT, {
+    configurable: false,
+    enumerable: false,
+    value: true,
+    writable: false
+  })
+
+  config.httpsAgent = new HttpsCookieAgent({ cookies: { jar: config.jar } })
+  Object.defineProperty(config.httpsAgent, AGENT_CREATED_BY_AXIOS_COOKIEJAR_SUPPORT, {
+    configurable: false,
+    enumerable: false,
+    value: true,
+    writable: false
+  })
+
+  return config
+}
+
+function setupCookie(axios) {
+  axios.interceptors.request.use(requestInterceptor)
+
+  if ('create' in axios) {
+    const create = axios.create
+    axios.create = (...args) => {
+      const instance = create.apply(axios, args)
+      instance.interceptors.request.use(requestInterceptor)
+      return instance
+    }
+  }
+
+  return axios
+}

package/src/config.js

@@ -1,34 +1,34 @@
 const tough = require('tough-cookie')
 const { merge } = require('lodash')
 
-module.exports.load = load
+module.exports.parse = parse
 
-function load(config) {
-	if (!config.site) throw new Error("The required 'site' property is missing")
-	if (!config.url) throw new Error("The required 'url' property is missing")
-	if (typeof config.url !== 'function' && typeof config.url !== 'string')
-		throw new Error("The 'url' property should return the function or string")
-	if (!config.parser) throw new Error("The required 'parser' function is missing")
-	if (typeof config.parser !== 'function')
-		throw new Error("The 'parser' property should return the function")
-	if (config.logo && typeof config.logo !== 'function')
-		throw new Error("The 'logo' property should return the function")
+function parse(config) {
+  if (!config.site) throw new Error("The required 'site' property is missing")
+  if (!config.url) throw new Error("The required 'url' property is missing")
+  if (typeof config.url !== 'function' && typeof config.url !== 'string')
+    throw new Error("The 'url' property should return the function or string")
+  if (!config.parser) throw new Error("The required 'parser' function is missing")
+  if (typeof config.parser !== 'function')
+    throw new Error("The 'parser' property should return the function")
+  if (config.logo && typeof config.logo !== 'function')
+    throw new Error("The 'logo' property should return the function")
 
-	const defaultConfig = {
-		days: 1,
-		lang: 'en',
-		delay: 3000,
-		output: 'guide.xml',
-		request: {
-			method: 'GET',
-			maxContentLength: 5 * 1024 * 1024,
-			timeout: 5000,
-			withCredentials: true,
-			jar: new tough.CookieJar(),
-			responseType: 'arraybuffer',
-			cache: false
-		}
-	}
+  const defaultConfig = {
+    days: 1,
+    lang: 'en',
+    delay: 3000,
+    output: 'guide.xml',
+    request: {
+      method: 'GET',
+      maxContentLength: 5 * 1024 * 1024,
+      timeout: 5000,
+      withCredentials: true,
+      jar: new tough.CookieJar(),
+      responseType: 'arraybuffer',
+      cache: false
+    }
+  }
 
-	return merge(defaultConfig, config)
+  return merge(defaultConfig, config)
 }

package/src/index.js

@@ -3,7 +3,7 @@ const { create: createClient, buildRequest, parseResponse } = require('./client'
 const { parseChannels, parsePrograms } = require('./parser')
 const { sleep, isPromise, getUTCDate } = require('./utils')
 const { generate: generateXMLTV } = require('./xmltv')
-const { load: loadConfig } = require('./config')
+const { parse: parseConfig } = require('./config')
 const Channel = require('./Channel')
 const Program = require('./Program')
 
@@ -14,7 +14,7 @@ module.exports.Program = Program
 
 class EPGGrabber {
   constructor(config = {}) {
-    this.config = loadConfig(config)
+    this.config = config
     this.client = createClient(config)
   }
 
@@ -26,18 +26,24 @@ class EPGGrabber {
     return logo
   }
 
-  async grab(channel, date, cb = () => {}) {
+  async grab(channel, date, config = {}, cb = () => {}) {
+    if (typeof config == 'function') {
+      cb = config
+      config = {}
+    }
+    config = merge(this.config, config)
+    config = parseConfig(config)
     if (!(channel instanceof Channel)) {
       throw new Error('The first argument must be the "Channel" class')
     }
 
-    await sleep(this.config.delay)
+    await sleep(config.delay)
 
     date = typeof date === 'string' ? getUTCDate(date) : date
-    return buildRequest({ channel, date, config: this.config })
+    return buildRequest({ channel, date, config })
       .then(this.client)
       .then(parseResponse)
-      .then(data => merge({ channel, date, config: this.config }, data))
+      .then(data => merge({ channel, date, config }, data))
       .then(parsePrograms)
       .then(programs => {
         cb({ channel, date, programs })
@@ -45,7 +51,7 @@ class EPGGrabber {
         return programs
       })
       .catch(err => {
-        if (this.config.debug) console.log('Error:', JSON.stringify(err, null, 2))
+        if (config.debug) console.log('Error:', JSON.stringify(err, null, 2))
         cb({ channel, date, programs: [] }, err)
 
         return []

package/tests/__data__/output/guide.xml

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="UTF-8" ?><tv date="20230930">
+<?xml version="1.0" encoding="UTF-8" ?><tv date="20231125">
 <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/config.test.js

@@ -1,9 +1,9 @@
-import { load as loadConfig } from '../src/config'
+import { parse as parseConfig } from '../src/config'
 import path from 'path'
 import fs from 'fs'
 
 it('can load config', () => {
-  const config = loadConfig(require(path.resolve('./tests/__data__/input/example.config.js')))
+  const config = parseConfig(require(path.resolve('./tests/__data__/input/example.config.js')))
   expect(config).toMatchObject({
     days: 2,
     delay: 3000,

package/tests/index.test.js

@@ -28,16 +28,18 @@ it('return "Connection timeout" error if server does not response', done => {
     name: 'CNN'
   })
   const grabber = new EPGGrabber(config)
-  grabber.grab(channel, '2022-01-01', (data, err) => {
-    expect(err.message).toBe('Connection timeout')
-    done()
-  })
+  grabber
+    .grab(channel, '2022-01-01', (data, err) => {
+      expect(err.message).toBe('Connection timeout')
+      done()
+    })
+    .catch(done)
 })
 
 it('can grab single channel programs', done => {
   const data = {
     data: {
-      toString: () => 'string'
+      toString: () => '[{"title":"Program1"}]'
     }
   }
   axios.mockImplementation(() => Promise.resolve(data))
@@ -45,7 +47,7 @@ it('can grab single channel programs', done => {
   const config = {
     site: 'example.com',
     url: 'http://example.com/20210319/1tv.json',
-    parser: () => []
+    parser: ({ content }) => JSON.parse(content)
   }
   const channel = new Channel({
     site: 'example.com',
@@ -56,13 +58,53 @@ it('can grab single channel programs', done => {
   })
   const grabber = new EPGGrabber(config)
   grabber
-    .grab(channel, '2022-01-01', (data, err) => {
+    .grab(channel, '2022-01-01')
+    .then(programs => {
+      expect(programs[0].titles).toMatchObject([
+        {
+          lang: 'fr',
+          value: 'Program1'
+        }
+      ])
+      done()
+    })
+    .catch(done)
+})
+
+it('can use a different config for different requests', done => {
+  const data = {
+    data: {
+      toString: () => '[{"title":"Program1"}]'
+    }
+  }
+  axios.mockImplementation(() => Promise.resolve(data))
+
+  const config = {
+    site: 'example.com',
+    url: 'http://example.com/20210319/1tv.json',
+    parser: ({ content }) => JSON.parse(content)
+  }
+  const channel = new Channel({
+    site: 'example.com',
+    site_id: '1',
+    xmltv_id: '1TV.fr',
+    lang: 'fr',
+    name: '1TV'
+  })
+  const grabber = new EPGGrabber()
+  grabber
+    .grab(channel, '2022-01-01', config, (data, err) => {
       if (err) {
-        done()
+        done(err)
       }
     })
     .then(programs => {
-      expect(programs.length).toBe(0)
+      expect(programs[0].titles).toMatchObject([
+        {
+          lang: 'fr',
+          value: 'Program1'
+        }
+      ])
       done()
     })
 })