-
Notifications
You must be signed in to change notification settings - Fork 4
/
index.js
544 lines (474 loc) · 17.8 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
(function () {
'use strict';
var _ = require('lodash');
var requestPromise = require('request-promise');
var bluebird = require('bluebird');
var Campaigns;
var Contacts;
var Lists;
var Reports;
var User;
exports.EmailOctopus = (function () {
/**
* EmailOctopus API wrapper constructor
* @param {string} apiKey - Your EmailOctopus API key
* @param {string} [username] - Your EmailOctopus username (only needed if you want to create campaigns)
* @param {string} [password] - Your EmailOctopus password (only needed if you want to create campaigns)
* @constructor
*/
function EmailOctopus(apiKey, username, password) {
this.apiKey = apiKey || process.env.EMAILOCTOPUS_APIKEY;
this.username = username || process.env.EMAILOCTOPUS_USERNAME;
this.password = password || process.env.EMAILOCTOPUS_PASSWORD;
this.cookieJar = {};
this.apiRoot = 'https://emailoctopus.com/api/1.1';
this.websiteRoot = 'https://emailoctopus.com';
this.campaigns = new Campaigns(this);
this.lists = new Lists(this);
this.user = new User(this);
}
/**
* Sends request to EmailOctopus API
* @param {string} path
* @param {string} method
* @param {Object} [options]
* @returns {Promise}
* @private
*/
EmailOctopus.prototype._apiRequest = function (path, method, options) {
var _this = this;
options = _.extend({api_key: _this.apiKey}, options || {});
return requestPromise({
uri: _this.apiRoot + path,
method: method,
json: true,
qs: method === 'GET' ? options : undefined,
formData: method !== 'GET' ? options : undefined
});
};
/**
* Sends request to EmailOctopus Website
* @param {string} path
* @param {string} method
* @param {Object} [options] - The html form to submit
* @param {string} [tokenInputName] - Name of hidden input to retrieve & append before submitting form
* @param {Object} [requestOptions] - Custom options to pass to request
* @returns {*}
* @private
*/
EmailOctopus.prototype._websiteRequest = function (path, method, options, tokenInputName, requestOptions) {
var _this = this;
// Optionally first run a GET request on the path to retrieve the token from a hidden input
var appendToken = tokenInputName ? _this._getPageToken(path, tokenInputName).then(function (token) {
options[tokenInputName] = token;
}) : bluebird.resolve();
return appendToken.then(function () {
return requestPromise(_.extend({
method: method,
uri: _this.websiteRoot + path,
jar: _this.cookieJar,
qs: method === 'GET' ? options : undefined,
formData: method !== 'GET' ? options : undefined
}, requestOptions || {}));
});
};
/**
* Fetch the token hidden input value on an Email Octopus html form
* @param {string} path - The path of the Email Octopus form
* @param {string} tokenInputName - The name of the hidden input containing the token
* @returns {Promise}
* @private
*/
EmailOctopus.prototype._getPageToken = function (path, tokenInputName) {
var _this = this;
return _this._websiteRequest(path, 'GET').then(function (response) {
var tokenRegex = new RegExp('name="' + tokenInputName.replace('[', '\\[') + '"\\svalue="(.*)"');
var match = response.match(tokenRegex);
return match[1];
});
};
return EmailOctopus;
})();
Campaigns = (function () {
function Campaigns(master) {
this.master = master;
this.reports = new Reports(master);
}
/**
* https://emailoctopus.com/api-documentation/campaigns/get or
* https://emailoctopus.com/api-documentation/campaigns/get-all
* @param {string|undefined} [campaignId]
* @param {Object} [options]
* @param {number} [options.limit=100]
* @param {number} [options.page=1]
* @returns {Promise}
*/
Campaigns.prototype.get = function (campaignId, options) {
var _this = this;
var path = '/campaigns' + (campaignId ? '/' + campaignId : '');
return _this.master._apiRequest(path, 'GET', options);
};
/**
* WARNING: Unofficial API add-on. Creates a campaign by mimicking the website's campaign creation flow
* @param {Object} [options] - The options associated with the campaign
* @param {string} [options.name] - The name of the campaign
* @param {string} [options.subject] - The subject of the campaign
* @param {string} [options.fromName] - The from name of the campaign
* @param {string} [options.fromEmailAddress] - The from email address (will need to be validated in AWS)
* @param {bool} [options.openTrackingEnabled] - Whether to track opens
* @param {bool} [options.linkClickTrackingEnabled] - Whether to track link clicks
* @param {bool} [options.toPersonalisationEnabled] - Whether to enable personalisation
* @param {string} bodyHtml - The entire html of the email
* @returns {Promise}
*/
Campaigns.prototype.create = function (options, bodyHtml) {
var _this = this;
return _this.master.user.signIn()
.then(function () {
return _this._setup(options);
})
.then(function (campaignId) {
return _this._selectTemplate(campaignId).then(function () {
return _this._design(campaignId, bodyHtml);
});
})
.finally(function () {
_this.master.user.signOut();
});
};
/**
* Mimic the first step of creating a campaign (https://emailoctopus.com/campaigns/setup)
* @param {Object} [options] - The options associated with the campaign
* @returns {Promise}
* @private
*/
Campaigns.prototype._setup = function (options) {
var _this = this;
var formData = {};
var path = '/campaigns/setup';
var requestOptions = {
resolveWithFullResponse: true,
followAllRedirects: true
};
var tokenInputName = 'campaign_setup[_token]';
// Extend defaults with user-defined options
var campaignSetup = _.extend({
name: 'Campaign Name',
subject: 'Campaign Subject',
fromName: 'From Name',
fromEmailAddress: 'fromemail@domain.com',
openTrackingEnabled: 1,
linkClickTrackingEnabled: 1,
toPersonalisationEnabled: 1
}, options || {});
// Replace booleans with integers
_.each(campaignSetup, function (value, key) {
if (typeof value === 'boolean') {
campaignSetup[key] = value | 0;
}
});
_.each(campaignSetup, function (val, key) {
formData['campaign_setup[' + key + ']'] = val;
});
return _this.master._websiteRequest(path, 'POST', formData, tokenInputName, requestOptions)
.then(function (response) {
var finalUri = response.request.uri.href;
var campaignIdMatch = finalUri.match(/\/campaigns\/([0-9a-z-]+)\//);
var campaignId = campaignIdMatch ? campaignIdMatch[1] : null;
return campaignId || bluebird.reject(new Error('Unable to locate newly created campaign ID.'));
}, function () {
return bluebird.reject(new Error('Unable to setup campaign.'));
});
};
/**
* Mimic campaign template selection (https://emailoctopus.com/campaigns/CAMPAIGN_ID/template)
* @param {string} campaignId
* @returns {Promise}
* @private
*/
Campaigns.prototype._selectTemplate = function (campaignId) {
var _this = this;
var path = '/campaigns/' + campaignId + '/template';
var formData = {'campaign_template[template]': '3c3b6ab9-a0f7-11e6-b38e-080027632938'}; // "Totally Plain"
var tokenInputName = 'campaign_template[_token]';
return _this.master._websiteRequest(path, 'POST', formData, tokenInputName, {followAllRedirects: true});
};
/**
* Mimic campaign design (https://emailoctopus.com/campaigns/CAMPAIGN_ID/design)
* @param {string} campaignId
* @param {string} bodyHtml
* @returns {Promise}
* @private
*/
Campaigns.prototype._design = function (campaignId, bodyHtml) {
var _this = this;
var path = '/campaigns/' + campaignId + '/design';
var formData = {'campaign_design[bodyHtml]': bodyHtml};
var tokenInputName = 'campaign_design[_token]';
return _this.master._websiteRequest(path, 'POST', formData, tokenInputName, {followAllRedirects: true});
};
/**
* Finds and returns the first matching campaign from a given list
* @param {Object} campaign - An object representing the campaign to search for
* @param {string} [campaign.name]
* @param {string} [campaign.subject]
* @param {number} [_page=1] - The page to start searching on
* @returns {Promise}
* @resolves {null|Object} - A nullable object containing the campaign (if found)
*/
Campaigns.prototype.find = function (campaign, _page) {
var _this = this;
var page = _page || 1;
var options = {
limit: 100,
page: page
};
return _this.get(undefined, options).then(function (response) {
var campaigns = response.data;
var foundCampaign = _.find(campaigns, campaign);
return foundCampaign ? foundCampaign :
_.get(response, 'paging.next') ? _this.find(undefined, page + 1) :
null;
});
};
return Campaigns;
})();
Contacts = (function () {
function Contacts(master) {
this.master = master;
}
/**
* https://emailoctopus.com/api-documentation/lists/get-contact or
* https://emailoctopus.com/api-documentation/lists/get-all-contacts
* @param {string} listId
* @param {string|undefined} [contactId]
* @param {Object} [options]
* @param {number} [options.limit=100]
* @param {number} [options.page=1]
* @returns {Promise}
*/
Contacts.prototype.get = function (listId, contactId, options) {
var _this = this;
var path = '/lists/' + listId + '/contacts' + (contactId ? '/' + contactId : '');
return _this.master._apiRequest(path, 'GET', options);
};
/**
* https://emailoctopus.com/api-documentation/lists/create-contact
* @param {string} listId - The id of the list to add the contact to
* @param {Object} options
* @param {string} options.email_address - The email address of the contact
* @param {string} [options.first_name] - The first name of the contact
* @param {string} [options.last_name] - The last name of the contact
* @param {bool} [options.subscribed=true] - The initial subscribed status of the contact
* @returns {Promise}
*/
Contacts.prototype.create = function (listId, options) {
var _this = this;
var path = '/lists/' + listId + '/contacts';
return _this.master._apiRequest(path, 'POST', options);
};
/**
* https://emailoctopus.com/api-documentation/lists/update-contact
* @param {string} listId
* @param {string} contactId
* @param {Object} options
* @param {string} [options.email_address] - The new email address for the contact
* @param {string} [options.first_name] - The new first name for the contact
* @param {string} [options.last_name] - The new last name for the contact
* @param {bool} [options.subscribed] - The new subscribed status for the contact
* @returns {Promise}
*/
Contacts.prototype.update = function (listId, contactId, options) {
var _this = this;
var path = '/lists/' + listId + '/contacts/' + contactId;
return _this.master._apiRequest(path, 'PUT', options);
};
/**
* https://emailoctopus.com/api-documentation/lists/delete-contact
* @param {string} listId
* @param {string} contactId
* @returns {Promise}
*/
Contacts.prototype['delete'] = function (listId, contactId) {
var _this = this;
var path = '/lists/' + listId + '/contacts' + contactId;
return _this.master._apiRequest(path, 'DELETE');
};
/**
* Finds and returns the first matching contact from a given list
* @param {string} listId
* @param {Object} contact - An object representing the contact to search for
* @param {string} [contact.email_address]
* @param {string} [contact.first_name]
* @param {string} [contact.last_name]
* @param {number} [_page=1] - The page to start searching on
* @returns {Promise}
* @resolves {null|Object} - A nullable object containing the contact (if found)
*/
Contacts.prototype.find = function (listId, contact, _page) {
var _this = this;
var page = _page || 1;
var options = {
limit: 100,
page: page
};
return _this.get(listId, undefined, options).then(function (response) {
var contacts = response.data;
var foundContact = _.find(contacts, contact);
return foundContact ? foundContact :
_.get(response, 'paging.next') ? _this.find(listId, contact, page + 1) :
null;
});
};
return Contacts;
})();
Lists = (function () {
function Lists(master) {
this.master = master;
this.contacts = new Contacts(master);
}
/**
* https://emailoctopus.com/api-documentation/lists/get or
* https://emailoctopus.com/api-documentation/lists/get-all
* @param {string|undefined} [listId]
* @param {Object} [options]
* @param {number} [options.limit=100] - Number of lists to return
* @param {number} [options.page=1] - Page to return records from
* @returns {Promise}
*/
Lists.prototype.get = function (listId, options) {
var _this = this;
var path = '/lists' + (listId ? '/' + listId : '');
return _this.master._apiRequest(path, 'GET', options);
};
/**
* https://emailoctopus.com/api-documentation/lists/create
* @param {Object} options
* @param {string} options.name - The name of the new list
* @returns {Promise}
*/
Lists.prototype.create = function (options) {
var _this = this;
var path = '/lists';
return _this.master._apiRequest(path, 'POST', options);
};
/**
* https://emailoctopus.com/api-documentation/lists/update
* @param {string} listId
* @param {Object} options
* @param {Object} options.name - The new name for the list
* @returns {Promise}
*/
Lists.prototype.update = function (listId, options) {
var _this = this;
var path = '/lists/' + listId;
return _this.master._apiRequest(path, 'PUT', options);
};
/**
* https://emailoctopus.com/api-documentation/lists/delete
* @param {string} listId - The id of the list to delete
* @returns {Promise}
*/
Lists.prototype['delete'] = function (listId) {
var _this = this;
var path = '/lists/' + listId;
return _this.master._apiRequest(path, 'DELETE');
};
/**
* Finds and returns the first matching contact from a given list
* @param {Object} list - An object representing the list to search for
* @param {string} [list.name] - The name of the list to find
* @param {number} [_page=1] - The page to start searching on
* @returns {Promise}
* @resolves {null|Object} - A nullable object containing the list (if found)
*/
Lists.prototype.find = function (list, _page) {
var _this = this;
var page = _page || 1;
var options = {
limit: 100,
page: page
};
return _this.get(undefined, options).then(function (response) {
var lists = response.data;
var foundList = _.find(lists, list);
return foundList ? foundList :
_.get(response, 'paging.next') ? _this.find(undefined, page + 1) :
null;
});
};
return Lists;
})();
Reports = (function () {
function Reports(master) {
this.master = master;
}
var reportTypes = [
'summary',
'bounced',
'clicked',
'complained',
'opened',
'sent',
'unsubscribed',
'not-bounced',
'not-clicked',
'not-complained',
'not-opened',
'not-unsubscribed'
];
// Batch generate methods for the various report endpoints
_.each(reportTypes, function (reportType) {
/**
* Retrieve a campaign report for a
* @param {string} campaignId
* @param {Object} [options]
* @param {number} [options.limit=100]
* @param {number} [options.page=1]
* @returns {Promise}
*/
Reports.prototype[_.camelCase(reportType)] = function (campaignId, options) {
var _this = this;
var path = '/campaigns/' + campaignId + '/reports/' + reportType;
return _this.master._apiRequest(path, 'GET', options);
};
});
return Reports;
})();
User = (function () {
function User(master) {
this.master = master;
}
/**
* Mimic sign-in process on Email Octopus website
* @returns {Promise}
*/
User.prototype.signIn = function () {
var _this = this;
var path = '/account/sign-in';
var formData = {
'_username': _this.master.username,
'_password': _this.master.password,
'_remember_me': '1'
};
var requestOptions = {
followAllRedirects: true,
headers: {
'Content-Type': 'application/x-www-form-urlencoded'
}
};
// Reset cookie jar
_this.master.cookieJar = requestPromise.jar();
return _this.master._websiteRequest(path, 'POST', formData, '_token', requestOptions);
};
/**
* Mimic sign-out process on Email Octopus website
* @returns {Promise}
*/
User.prototype.signOut = function () {
var _this = this;
return _this.master._websiteRequest('/account/sign-out', 'GET');
};
return User;
})();
}).call(this);