epg-grabber 0.33.0 → 0.35.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "epg-grabber",
-  "version": "0.33.0",
+  "version": "0.35.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,14 +14,17 @@ 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 = 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(
@@ -136,3 +140,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/index.d.ts

@@ -101,10 +101,19 @@ export type GrabCallbackData = {
 }
 
 export declare class EPGGrabber {
-  constructor(config: object)
+  constructor(config: SiteConfig)
   grab(
     channel: Channel,
     date: string | dayjs.Dayjs,
-    cb: (data: GrabCallbackData, err: Error) => void
+    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/tests/__data__/output/guide.xml

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="UTF-8" ?><tv date="20230927">
+<?xml version="1.0" encoding="UTF-8" ?><tv date="20231116">
 <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/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()
+    })
+})