iobroker.ical 1.13.0 → 1.13.1

package/README.md

@@ -26,6 +26,9 @@ Siehe deutsche [Version hier](docs/de/README.md).
 	Placeholder for the next version (at the beginning of the line):
 	### **WORK IN PROGRESS**
 -->
+### 1.13.1 (2022-06-27)
+* (klein0r) Changed request library
+
 ### 1.13.0 (2022-06-17)
 * (klein0r) Added Admin 5 UI
 * (klein0r) Translated all object names
@@ -46,9 +49,6 @@ Siehe deutsche [Version hier](docs/de/README.md).
 * (Apollon77) Respect DST changes in some calculations to prevent strange effects
 * (Apollon77) Parse ics Files with different line endings again
 
-### 1.11.6 (2021-12-17)
-* (jens-maus) fixed incorrect recurrence event processing
-
 ## License
 
 The MIT License (MIT)

package/admin/jsonConfig.json

@@ -232,7 +232,9 @@
                             "default": false
                         },
                         {
-                            "type": "text",
+                            "type": "password",
+                            "repeat": false,
+                            "visible": false,
                             "attr": "pass",
                             "width": "10%",
                             "title": {
@@ -384,7 +386,7 @@
                             },
                             "filter": false,
                             "sort": false,
-                            "default": false
+                            "default": true
                         },
                         {
                             "type": "objectId",

package/io-package.json

@@ -1,8 +1,20 @@
 {
   "common": {
     "name": "ical",
-    "version": "1.13.0",
+    "version": "1.13.1",
     "news": {
+      "1.13.1": {
+        "en": "Changed request library",
+        "de": "Bibliothek der geänderten Anfrage",
+        "ru": "Измененная библиотека запросов",
+        "pt": "Biblioteca de solicitação alterada",
+        "nl": "Verandering van verzoek bibliotheek",
+        "fr": "Changed request library",
+        "it": "Libreria richiesta modificata",
+        "es": "Biblioteca de solicitud modificada",
+        "pl": "Zmiennikowa biblioteka",
+        "zh-cn": "更改要求图书馆"
+      },
       "1.13.0": {
         "en": "Added Admin 5 UI\nTranslated all object names",
         "de": "Admin 5 UI\nAlle Objektnamen übersetzt",
@@ -74,18 +86,6 @@
         "es": "actualizado node-ical a la última versión 0.14.1\nsolucionar otro problema en el que un evento ya finalizado todavía aparece en la lista",
         "pl": "zaktualizowano węzeł-ical do najnowszej wersji 0.14.1\nnapraw inny problem, w którym już zakończone wydarzenie jest nadal na liście",
         "zh-cn": "将 node-ical 更新为最新的 0.14.1\n修复另一个问题，即仍列出已结束的事件"
-      },
-      "1.11.4": {
-        "en": "fix cases where already ended entries where still listed\nfix reported sentry crash cases (IOBROKER-ICAL-S, IOBROKER-ICAL-N)",
-        "de": "Fälle beheben, in denen bereits beendete Einträge noch aufgelistet wurden\ngemeldete Sentry-Crash-Fälle beheben (IOBROKER-ICAL-S, IOBROKER-ICAL-N)",
-        "ru": "исправить случаи, когда уже законченные записи все еще перечислены\nисправить зарегистрированные случаи аварийного завершения работы часового (IOBROKER-ICAL-S, IOBROKER-ICAL-N)",
-        "pt": "corrigir casos em que entradas já encerradas e ainda listadas\ncorrigir casos relatados de acidentes de sentinela (IOBROKER-ICAL-S, IOBROKER-ICAL-N)",
-        "nl": "repareer gevallen waarin reeds beëindigde vermeldingen nog steeds worden vermeld\nrepareer gerapporteerde crashgevallen van schildwachten (IOBROKER-ICAL-S, IOBROKER-ICAL-N)",
-        "fr": "corriger les cas où les entrées déjà terminées étaient toujours répertoriées\ncorrection des cas de plantage de sentinelle signalés (IOBROKER-ICAL-S, IOBROKER-ICAL-N)",
-        "it": "correggere i casi in cui le voci già terminate erano ancora elencate\ncorreggere i casi di crash di sentinella segnalati (IOBROKER-ICAL-S, IOBROKER-ICAL-N)",
-        "es": "Corregir casos en los que las entradas ya finalizadas todavía estaban en la lista.\narreglar casos de accidentes de centinela notificados (IOBROKER-ICAL-S, IOBROKER-ICAL-N)",
-        "pl": "napraw przypadki, w których już zakończone wpisy były nadal wymienione\nnaprawiono zgłoszone przypadki awarii wartowników (IOBROKER-ICAL-S, IOBROKER-ICAL-N)",
-        "zh-cn": "修复已经结束的条目仍然列出的情况\n修复报告的哨兵崩溃案例（IOBROKER-ICAL-S、IOBROKER-ICAL-N）"
       }
     },
     "title": "iCal Calendar",

package/lib/adapter-config.d.ts

@@ -0,0 +1,19 @@
+// This file extends the AdapterConfig type from "@types/iobroker"
+// using the actual properties present in io-package.json
+// in order to provide typings for adapter.config properties
+
+import { native } from '../io-package.json';
+
+type _AdapterConfig = typeof native;
+
+// Augment the globally declared type ioBroker.AdapterConfig
+declare global {
+    namespace ioBroker {
+        interface AdapterConfig extends _AdapterConfig {
+            // Do not enter anything here!
+        }
+    }
+}
+
+// this is required so the above AdapterConfig is found by TypeScript / type checking
+export {};

package/main.js

@@ -22,7 +22,9 @@ const crypto      = require('crypto');
 const fs          = require('fs');
 const path        = require('path');
 const adapterName = require('./package.json').name.split('.').pop();
-const request     = require('request');
+const axios       = require('axios').default;
+const https       = require('https');
+
 let adapter;
 let stopped       = false;
 let killTimeout = null;
@@ -172,59 +174,73 @@ function getICal(urlOrFile, user, pass, sslignore, calName, cb) {
     } else {
         // Find out whether SSL certificate errors shall be ignored
         const options = {
-            uri: urlOrFile
+            method: 'get',
+            url: urlOrFile
         };
 
         if (sslignore === 'ignore' || sslignore === 'true' || sslignore === true) {
-            options.rejectUnauthorized = false;
+            options.httpsAgent = new https.Agent({
+                rejectUnauthorized: false
+            });
         }
 
         if (user) {
             options.auth = {
-                user: user,
-                pass: pass,
-                sendImmediately: true
+                username: user,
+                password: pass
             };
         }
 
-        // Call library function with the "auth object" and credentials provided
-        request(options, (err, r, _data) => {
-            const calHash = crypto.createHash('md5').update(user + pass + urlOrFile).digest('hex');
-            const cachedFilename = path.join(__dirname, calHash);
-            if (err || !_data || (r && r.statusCode !== 200)) {
-                let cachedContent;
-                let cachedDate;
-                try {
-                    if (fs.existsSync(cachedFilename)) {
-                        cachedContent = fs.readFileSync(cachedFilename, 'utf-8');
-                        const stat = fs.statSync(cachedFilename);
-                        cachedDate = stat.mtime;
-                    }
-                } catch (err) {
-                    adapter.log.info(`Cannot read cached calendar file for "${urlOrFile}": ${err.message}`);
-                }
-                if (err) {
-                    adapter.log.warn(`Error reading from URL "${urlOrFile}": ${(err && err.code === 'ENOTFOUND') ? 'address not found!' : err}`);
-                    if (!cachedContent) {
-                        return cb && cb(err || `Cannot read URL: "${urlOrFile}"`);
-                    }
-                } else if (r) {
-                    adapter.log.warn(`Error reading from URL "${urlOrFile}": Server responded HTTP-Statuscode=${r.statusCode}: ${_data}`);
-                    if (!cachedContent) {
-                        return cb && cb(`Cannot read URL: "${urlOrFile}" HTTP-Status ${r.statusCode}`);
-                    }
-                }
-                adapter.log.info(`Use cached File content for  for "${urlOrFile}" from ${cachedDate}`);
-                cb && cb(null, cachedContent);
-            } else {
+        const calHash = crypto.createHash('md5').update(user + pass + urlOrFile).digest('hex');
+        const cachedFilename = path.join(__dirname, calHash);
+
+        axios(options).then(function (response) {
+            if (response.data) {
                 try {
-                    fs.writeFileSync(cachedFilename, _data, 'utf-8');
+                    fs.writeFileSync(cachedFilename, response.data, 'utf-8');
                     adapter.log.debug(`Successfully cached content for calendar "${urlOrFile}" as ${cachedFilename}`);
                 } catch (err) {
                     // Ignore
                 }
-                cb && cb(null, _data);
+
+                cb && cb(null, response.data);
+            } else {
+                cb && cb(`Error reading from URL "${urlOrFile}": Received no data`);
+            }
+        }).catch(error => {
+            let cachedContent;
+            let cachedDate;
+
+            if (error.response) {
+                // The request was made and the server responded with a status code
+                // that falls out of the range of 2xx
+                adapter.log.warn(`Error reading from URL "${urlOrFile}": ${error.response.status}`);
+            } else if (error.request) {
+                // The request was made but no response was received
+                // `error.request` is an instance of XMLHttpRequest in the browser and an instance of
+                // http.ClientRequest in node.js
+                adapter.log.warn(`Error reading from URL "${urlOrFile}"`);
+            } else {
+                // Something happened in setting up the request that triggered an Error
+                adapter.log.warn(`Error reading from URL "${urlOrFile}": ${error.message}`);
             }
+
+            try {
+                if (fs.existsSync(cachedFilename)) {
+                    cachedContent = fs.readFileSync(cachedFilename, 'utf-8');
+                    const stat = fs.statSync(cachedFilename);
+                    cachedDate = stat.mtime;
+                }
+            } catch (err) {
+                adapter.log.info(`Cannot read cached calendar file for "${urlOrFile}": ${err.message}`);
+            }
+
+            if (!cachedContent) {
+                return cb && cb(`Cannot read URL: "${urlOrFile}"`);
+            }
+
+            adapter.log.info(`Use cached File content for "${urlOrFile}" from ${cachedDate}`);
+            cb && cb(null, cachedContent);
         });
     }
 }
@@ -1430,6 +1446,8 @@ async function displayDates() {
             }
         }
 
+        adapter.log.debug(`Dates array (data.table): ${JSON.stringify(datesArray)}`);
+
         await adapter.setStateAsync('data.table', {val: JSON.stringify(datesArray), ack: true});
         await adapter.setStateAsync('data.html',  {val: brSeparatedList(datesArray), ack: true});
         await adapter.setStateAsync('data.text',  {val: crlfSeparatedList(datesArray), ack: true});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.ical",
-  "version": "1.13.0",
+  "version": "1.13.1",
   "description": "Allows read information from google calender and from iCal.",
   "author": {
     "name": "bluefox",
@@ -37,24 +37,35 @@
   },
   "dependencies": {
     "@iobroker/adapter-core": "^2.6.0",
-    "node-ical": "^0.15.1",
+    "axios": "^0.27.2",
     "cloneextend": "^0.0.3",
-    "request": "^2.88.2",
     "json-schema": "^0.4.0",
+    "node-ical": "^0.15.1",
     "rrule": "2.6.9"
   },
   "devDependencies": {
     "@alcalzone/release-script": "^3.5.9",
     "@alcalzone/release-script-plugin-iobroker": "^3.5.9",
     "@alcalzone/release-script-plugin-license": "^3.5.9",
-    "@iobroker/testing": "^2.6.0",
     "@iobroker/adapter-dev": "^1.0.0",
+    "@iobroker/testing": "^3.0.2",
+    "@types/chai": "^4.3.1",
+    "@types/chai-as-promised": "^7.1.5",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^18.0.0",
+    "@types/proxyquire": "^1.3.28",
+    "@types/sinon": "^10.0.11",
+    "@types/sinon-chai": "^3.2.8",
     "chai": "^4.3.6",
+    "chai-as-promised": "^7.1.1",
     "chai-string": "^1.5.0",
-    "eslint": "^8.17.0",
+    "eslint": "^8.18.0",
+    "luxon": "^2.4.0",
     "mocha": "^10.0.0",
-    "set-value": "^4.1.0",
-    "ansi-regex": "^6.0.1"
+    "proxyquire": "^2.1.3",
+    "sinon": "^14.0.0",
+    "sinon-chai": "^3.7.0",
+    "typescript": "~4.7.4"
   },
   "bugs": {
     "url": "https://github.com/iobroker-community-adapters/ioBroker.ical/issues"
@@ -70,9 +81,8 @@
     "main.js"
   ],
   "scripts": {
-    "test:js": "mocha --opts test/mocha.custom.opts",
+    "test:js": "mocha --config test/mocharc.custom.json \"{!(node_modules|test)/**/*.test.js,*.test.js,test/**/test!(PackageFiles|Startup).js}\"",
     "test:package": "mocha test/package --exit",
-    "test:unit": "mocha test/unit --exit",
     "test:integration": "mocha test/integration --exit",
     "test": "npm run test:js && npm run test:package",
     "lint": "eslint",