epg-grabber 0.25.2 → 0.26.0

package/README.md

@@ -80,7 +80,7 @@ Arguments:
 - `--days`: number of days for which to grab the program (default: 1)
 - `--delay`: delay between requests (default: 3000)
 - `--timeout`: set a timeout for each request (default: 5000)
-- `--cache-max-age`: maximum time for storing each request in milliseconds (default: 0)
+- `--cache-ttl`: maximum time for storing each request in milliseconds (default: 0)
 - `--gzip`: compress the output (default: false)
 - `--debug`: enable debug mode (default: false)
 - `--curl`: display current request as CURL (default: false)
@@ -102,12 +102,8 @@ module.exports = {
 
     method: 'GET',
     timeout: 5000,
-    cache: { // cache options (details: https://github.com/RasCarlito/axios-cache-adapter#options)
-      maxAge: 0,
-      readHeaders: false,
-      exclude: {
-        query: false
-      }
+    cache: { // cache options (details: https://axios-cache-interceptor.js.org/#/pages/per-request-configuration)
+      ttl: 60 * 1000 // 60s
     },
 
     /**
@@ -192,6 +188,8 @@ From each function in `config.js` you can access a `context` object containing t
 - `content`: The response data as a String
 - `buffer`: The response data as an ArrayBuffer
 - `headers`: The response headers
+- `request`: The request config
+- `cached`: A boolean to check whether this request was cached or not
 
 ## Channels List
 

package/bin/epg-grabber.js

@@ -24,7 +24,7 @@ program
   .option('--delay <delay>', 'Delay between requests (in mileseconds)', parseInteger)
   .option('--timeout <timeout>', 'Set a timeout for each request (in mileseconds)', parseInteger)
   .option(
-    '--cache-max-age <cacheMaxAge>',
+    '--cache-ttl <cacheTtl>',
     'Maximum time for storing each request (in milliseconds)',
     parseInteger
   )
@@ -76,14 +76,11 @@ async function main() {
     curl: options.curl,
     lang: options.lang,
     delay: options.delay,
-    request: {
-      timeout: options.timeout,
-      cache: {
-        maxAge: options.cacheMaxAge
-      }
-    }
+    request: {}
   })
 
+  if (options.timeout) config.request.timeout = options.timeout
+  if (options.cacheTtl) config.request.cache.ttl = options.cacheTtl
   if (options.channels) config.channels = options.channels
   else if (config.channels)
     config.channels = path.join(path.dirname(options.config), config.channels)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "epg-grabber",
-  "version": "0.25.2",
+  "version": "0.26.0",
   "description": "Node.js CLI tool for grabbing EPG from different sites",
   "main": "src/index.js",
   "preferGlobal": true,
@@ -29,7 +29,7 @@
   },
   "dependencies": {
     "axios": "^0.21.1",
-    "axios-cache-adapter": "^2.7.3",
+    "axios-cache-interceptor": "^0.10.3",
     "axios-cookiejar-support": "^1.0.1",
     "axios-mock-adapter": "^1.20.0",
     "commander": "^7.1.0",

package/src/utils.js

@@ -3,7 +3,7 @@ const { padStart } = require('lodash')
 const path = require('path')
 const axios = require('axios').default
 const axiosCookieJarSupport = require('axios-cookiejar-support').default
-const axiosCacheAdapter = require('axios-cache-adapter')
+const { setupCache } = require('axios-cache-interceptor')
 const tough = require('tough-cookie')
 const convert = require('xml-js')
 const { merge } = require('lodash')
@@ -41,13 +41,7 @@ utils.loadConfig = function (config) {
       withCredentials: true,
       jar: new tough.CookieJar(),
       responseType: 'arraybuffer',
-      cache: {
-        readHeaders: false,
-        exclude: {
-          query: false
-        },
-        maxAge: 0
-      }
+      cache: false
     }
   }
 
@@ -55,7 +49,7 @@ utils.loadConfig = function (config) {
 }
 
 utils.createClient = function (config) {
-  const client = axiosCacheAdapter.setup()
+  const client = setupCache(axios.create())
   client.interceptors.request.use(
     function (request) {
       if (config.debug) {
@@ -80,7 +74,7 @@ utils.createClient = function (config) {
             {
               headers: response.headers,
               data,
-              fromCache: response.request.fromCache === true
+              cached: response.cached
             },
             null,
             2
@@ -220,13 +214,15 @@ utils.convertToXMLTV = function ({ channels, programs }) {
   output += '</tv>'
 
   function createXMLTVNS(s, e) {
-    if (!s || !e) return null
+    if (!e) return null
+    s = s || 1
 
     return `${s - 1}.${e - 1}.0/1`
   }
 
   function createOnScreen(s, e) {
-    if (!s || !e) return null
+    if (!e) return null
+    s = s || 1
 
     s = padStart(s, 2, '0')
     e = padStart(e, 2, '0')
@@ -316,20 +312,12 @@ utils.getUTCDate = function (d = null) {
 }
 
 utils.parseResponse = async (item, response, config) => {
-  let buffer
-  let content
-  if (utils.isObject(response.data) || Array.isArray(response.data)) {
-    content = JSON.stringify(response.data)
-    buffer = Buffer.from(content, 'utf8')
-  } else {
-    content = response.data.toString()
-    buffer = response.data
-  }
   const data = merge(item, config, {
-    content,
-    buffer,
+    content: response.data.toString(),
+    buffer: response.data,
     headers: response.headers,
-    request: response.request
+    request: response.request,
+    cached: response.cached
   })
 
   if (!item.channel.logo && config.logo) {

package/tests/utils.test.js

@@ -73,6 +73,50 @@ it('can convert object to xmltv string', () => {
   )
 })
 
+it('can convert object to xmltv string without season number', () => {
+  const file = fs.readFileSync('./tests/input/example.com.channels.xml', { encoding: 'utf-8' })
+  const { channels } = utils.parseChannels(file)
+  const programs = [
+    {
+      title: 'Program 1',
+      description: 'Description for Program 1',
+      start: 1616133600,
+      stop: 1616135400,
+      category: 'Test',
+      episode: 239,
+      icon: 'https://example.com/images/Program1.png?x=шеллы&sid=777',
+      channel: '1TV.com',
+      lang: 'it'
+    }
+  ]
+  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><episode-num system="xmltv_ns">0.238.0/1</episode-num><episode-num system="onscreen">S01E239</episode-num><icon src="https://example.com/images/Program1.png?x=шеллы&amp;sid=777"/></programme>\r\n</tv>'
+  )
+})
+
+it('can convert object to xmltv string without episode number', () => {
+  const file = fs.readFileSync('./tests/input/example.com.channels.xml', { encoding: 'utf-8' })
+  const { channels } = utils.parseChannels(file)
+  const programs = [
+    {
+      title: 'Program 1',
+      description: 'Description for Program 1',
+      start: 1616133600,
+      stop: 1616135400,
+      category: 'Test',
+      season: 1,
+      icon: 'https://example.com/images/Program1.png?x=шеллы&sid=777',
+      channel: '1TV.com',
+      lang: 'it'
+    }
+  ]
+  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>'
+  )
+})
+
 it('can convert object to xmltv string without categories', () => {
   const channels = [
     {
@@ -149,7 +193,7 @@ it('can fetch data', () => {
     url: 'http://example.com/20210319/1tv.json',
     withCredentials: true
   }
-  utils.fetchData(axios, request).then(jest.fn).catch(jest.fn)
+  utils.fetchData(mockAxios, request).then(jest.fn).catch(jest.fn)
   expect(mockAxios).toHaveBeenCalledWith(
     expect.objectContaining({
       data: { accountID: '123' },
@@ -170,37 +214,46 @@ it('can fetch data', () => {
 
 it('can build request async', done => {
   const config = utils.loadConfig(require(path.resolve('./tests/input/async.config.js')))
-  return utils.buildRequest({}, config).then(request => {
-    expect(request).toMatchObject({
-      data: { accountID: '123' },
-      headers: {
-        'Content-Type': 'application/json',
-        Cookie: 'abc=123',
-        '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'
-      },
-      maxContentLength: 5242880,
-      method: 'POST',
-      responseType: 'arraybuffer',
-      timeout: 5000,
-      url: 'http://example.com/20210319/1tv.json',
-      withCredentials: true
+
+  utils
+    .buildRequest({}, config)
+    .then(request => {
+      expect(request).toMatchObject({
+        data: { accountID: '123' },
+        headers: {
+          'Content-Type': 'application/json',
+          Cookie: 'abc=123',
+          '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'
+        },
+        maxContentLength: 5242880,
+        method: 'POST',
+        responseType: 'arraybuffer',
+        timeout: 5000,
+        url: 'http://example.com/20210319/1tv.json',
+        withCredentials: true
+      })
+      done()
     })
-    done()
-  })
+    .catch(done)
 })
 
 it('can load logo async', done => {
   const config = utils.loadConfig(require(path.resolve('./tests/input/async.config.js')))
-  return utils.loadLogo({}, config).then(logo => {
-    expect(logo).toBe('http://example.com/logos/1TV.png?x=шеллы&sid=777')
-    done()
-  })
+
+  utils
+    .loadLogo({}, config)
+    .then(logo => {
+      expect(logo).toBe('http://example.com/logos/1TV.png?x=шеллы&sid=777')
+      done()
+    })
+    .catch(done)
 })
 
 it('can parse programs', done => {
   const config = utils.loadConfig(require(path.resolve('./tests/input/example.com.config.js')))
-  return utils
+
+  utils
     .parsePrograms({ channel: { xmltv_id: '1tv', lang: 'en' } }, config)
     .then(programs => {
       expect(programs).toMatchObject([
@@ -218,14 +271,17 @@ it('can parse programs', done => {
       ])
       done()
     })
+    .catch(done)
 })
 
 it('can parse programs async', done => {
   const config = utils.loadConfig(require(path.resolve('./tests/input/async.config.js')))
-  return utils
+
+  utils
     .parsePrograms({ channel: { xmltv_id: '1tv', lang: 'en' } }, config)
     .then(programs => {
       expect(programs.length).toBe(0)
       done()
     })
+    .catch(done)
 })