cypress-mailisk 2.2.1 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress-mailisk",
-  "version": "2.2.1",
+  "version": "3.0.0",
   "description": "Mailisk library for Cypress",
   "keywords": [
     "mailisk",
@@ -19,7 +19,7 @@
     "test:coverage": "jest --coverage"
   },
   "peerDependencies": {
-    "cypress": ">= 2.1.0"
+    "cypress": ">= 15.10.0"
   },
   "repository": {
     "type": "git",

package/src/mailiskCommands.js

@@ -14,20 +14,58 @@ class MailiskCommands {
   }
 
   constructor() {
-    const apiKey = Cypress.env('MAILISK_API_KEY');
-    this.mailiskSetApiKey(apiKey);
+    this.request = null;
+  }
+
+  _getEnv(keys) {
+    if (typeof cy !== 'undefined' && typeof cy.env === 'function') {
+      return cy.env(keys);
+    }
+    // fallback to Cypress.env for Cypress < 15.10.0
+    if (typeof Cypress !== 'undefined' && typeof Cypress.env === 'function') {
+      const values = {};
+      for (const key of keys) {
+        values[key] = Cypress.env(key);
+      }
+      if (typeof cy !== 'undefined' && typeof cy.wrap === 'function') {
+        return cy.wrap(values, { log: false });
+      }
+      return Promise.resolve(values);
+    }
+    const emptyValues = {};
+    for (const key of keys) {
+      emptyValues[key] = undefined;
+    }
+    return Promise.resolve(emptyValues);
   }
 
   mailiskSetApiKey(apiKey) {
-    this.request = new Request({ apiKey, apiUrl: Cypress.env('MAILISK_API_URL') });
+    return this._getEnv(['MAILISK_API_URL']).then(({ MAILISK_API_URL }) => {
+      this.request = new Request({ apiKey, apiUrl: MAILISK_API_URL });
+      return null;
+    });
+  }
+
+  _initRequestFromEnv() {
+    return this._getEnv(['MAILISK_API_KEY', 'MAILISK_API_URL']).then(({ MAILISK_API_KEY, MAILISK_API_URL }) => {
+      this.request = new Request({ apiKey: MAILISK_API_KEY, apiUrl: MAILISK_API_URL });
+      return this.request;
+    });
+  }
+
+  _withRequest(action) {
+    if (this.request) {
+      return action(this.request);
+    }
+    return this._initRequestFromEnv().then((request) => action(request));
   }
 
   mailiskListNamespaces() {
-    return this.request.get('api/namespaces');
+    return this._withRequest((request) => request.get('api/namespaces'));
   }
 
-  _mailiskSearchInboxAction(namespace, _options, urlParams, startTime, nextTimeout) {
-    return this.request
+  _mailiskSearchInboxAction(request, namespace, _options, urlParams, startTime, nextTimeout) {
+    return request
       .get(`api/emails/${namespace}/inbox?${urlParams.toString()}`, { ..._options, timeout: nextTimeout })
       .then((response) => {
         if (response.total_count !== 0) {
@@ -35,7 +73,7 @@ class MailiskCommands {
         }
         const timeout = Math.max(_options.timeout - (Date.now() - startTime), 1);
         cy.wait(Math.min(timeout, 9000), { log: false });
-        return this._mailiskSearchInboxAction(namespace, _options, urlParams, startTime, timeout);
+        return this._mailiskSearchInboxAction(request, namespace, _options, urlParams, startTime, timeout);
       });
   }
 
@@ -66,27 +104,30 @@ class MailiskCommands {
     }
 
     // temporary workaround due cypress not supporting overriding maxRedirects
-    if (_params.wait) {
-      urlParams.delete('wait');
-      const startTime = Date.now();
-      return this._mailiskSearchInboxAction(namespace, _options, urlParams, startTime, _options.timeout);
-    } else {
-      return this.request.get(`api/emails/${namespace}/inbox?${urlParams.toString()}`, _options);
-    }
+    return this._withRequest((request) => {
+      if (_params.wait) {
+        urlParams.delete('wait');
+        const startTime = Date.now();
+        return this._mailiskSearchInboxAction(request, namespace, _options, urlParams, startTime, _options.timeout);
+      }
+      return request.get(`api/emails/${namespace}/inbox?${urlParams.toString()}`, _options);
+    });
   }
 
   mailiskGetAttachment(attachmentId, options = {}) {
-    return this.request.get(`api/attachments/${attachmentId}`, options);
+    return this._withRequest((request) => request.get(`api/attachments/${attachmentId}`, options));
   }
 
   mailiskDownloadAttachment(attachmentId, options = {}) {
-    return this.mailiskGetAttachment(attachmentId, options).then((attachment) => {
-      return this.request.getBinary(attachment.data.download_url, options);
-    });
+    return this._withRequest((request) =>
+      request.get(`api/attachments/${attachmentId}`, options).then((attachment) => {
+        return request.getBinary(attachment.data.download_url, options);
+      }),
+    );
   }
 
-  _mailiskSearchSmsAction(phoneNumber, _options, urlParams, startTime, nextTimeout) {
-    return this.request
+  _mailiskSearchSmsAction(request, phoneNumber, _options, urlParams, startTime, nextTimeout) {
+    return request
       .get(`api/sms/${phoneNumber}/messages?${urlParams.toString()}`, { ..._options, timeout: nextTimeout })
       .then((response) => {
         if (response.total_count !== 0) {
@@ -94,7 +135,7 @@ class MailiskCommands {
         }
         const timeout = Math.max(_options.timeout - (Date.now() - startTime), 1);
         cy.wait(Math.min(timeout, 9000), { log: false });
-        return this._mailiskSearchSmsAction(phoneNumber, _options, urlParams, startTime, timeout);
+        return this._mailiskSearchSmsAction(request, phoneNumber, _options, urlParams, startTime, timeout);
       });
   }
 
@@ -132,17 +173,18 @@ class MailiskCommands {
     }
 
     // temporary workaround due cypress not supporting overriding maxRedirects
-    if (_params.wait) {
-      urlParams.delete('wait');
-      const startTime = Date.now();
-      return this._mailiskSearchSmsAction(phoneNumber, _options, urlParams, startTime, _options.timeout);
-    } else {
-      return this.request.get(`api/sms/${phoneNumber}/messages?${urlParams.toString()}`, _options);
-    }
+    return this._withRequest((request) => {
+      if (_params.wait) {
+        urlParams.delete('wait');
+        const startTime = Date.now();
+        return this._mailiskSearchSmsAction(request, phoneNumber, _options, urlParams, startTime, _options.timeout);
+      }
+      return request.get(`api/sms/${phoneNumber}/messages?${urlParams.toString()}`, _options);
+    });
   }
 
   mailiskListSmsNumbers(options = {}) {
-    return this.request.get(`api/sms/numbers`, options);
+    return this._withRequest((request) => request.get(`api/sms/numbers`, options));
   }
 }