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
|
(function (angular, $, _) {
function OptionGroup(values) {
this.get = function get(value) {
var r = _.where(values, {value: '' + value});
return r.length > 0 ? r[0] : null;
};
this.getByName = function get(name) {
var r = _.where(values, {name: '' + name});
return r.length > 0 ? r[0] : null;
};
this.getAll = function getAll() {
return values;
};
}
angular.module('crmMailingAB').factory('crmMailingABCriteria', function () {
// TODO Get data from server
var values = {
'1': {value: 'subject', name: 'subject', label: ts('Test different "Subject" lines')},
'2': {value: 'from', name: 'from', label: ts('Test different "From" lines')},
'3': {value: 'full_email', name: 'full_email', label: ts('Test entirely different emails')}
};
return new OptionGroup(values);
});
angular.module('crmMailingAB').factory('crmMailingABStatus', function () {
// TODO Get data from server
var values = {
'1': {value: '1', name: 'Draft', label: ts('Draft')},
'2': {value: '2', name: 'Testing', label: ts('Testing')},
'3': {value: '3', name: 'Final', label: ts('Final')}
};
return new OptionGroup(values);
});
// CrmMailingAB is a data-model which combines an AB test (APIv3 "MailingAB"), three mailings (APIv3 "Mailing"),
// and three sets of attachments (APIv3 "Attachment").
//
// example:
// var abtest = new CrmMailingAB(123);
// abtest.load().then(function(){
// alert("Mailing A is named "+abtest.mailings.a.name);
// });
angular.module('crmMailingAB').factory('CrmMailingAB', function (crmApi, crmMailingMgr, $q, CrmAttachments) {
function CrmMailingAB(id) {
this.id = id;
this.mailings = {};
this.attachments = {};
}
angular.extend(CrmMailingAB.prototype, {
getAutosaveSignature: function() {
return [
this.ab,
this.mailings,
this.attachments.a.getAutosaveSignature(),
this.attachments.b.getAutosaveSignature(),
this.attachments.c.getAutosaveSignature()
];
},
// @return Promise CrmMailingAB
load: function load() {
var crmMailingAB = this;
if (!crmMailingAB.id) {
crmMailingAB.ab = {
name: '',
status: 'Draft',
mailing_id_a: null,
mailing_id_b: null,
mailing_id_c: null,
domain_id: null,
testing_criteria: 'subject',
winner_criteria: null,
specific_url: '',
declare_winning_time: null,
group_percentage: 10
};
var mailingDefaults = {
// Most defaults provided by Mailing.create API, but we
// want to force-enable tracking.
open_tracking: "1",
url_tracking: "1",
mailing_type:"experiment"
};
crmMailingAB.mailings.a = crmMailingMgr.create(mailingDefaults);
crmMailingAB.mailings.b = crmMailingMgr.create(mailingDefaults);
mailingDefaults.mailing_type = 'winner';
crmMailingAB.mailings.c = crmMailingMgr.create(mailingDefaults);
crmMailingAB.attachments.a = new CrmAttachments(function () {
return {entity_table: 'civicrm_mailing', entity_id: crmMailingAB.ab.mailing_id_a};
});
crmMailingAB.attachments.b = new CrmAttachments(function () {
return {entity_table: 'civicrm_mailing', entity_id: crmMailingAB.ab.mailing_id_b};
});
crmMailingAB.attachments.c = new CrmAttachments(function () {
return {entity_table: 'civicrm_mailing', entity_id: crmMailingAB.ab.mailing_id_c};
});
var dfr = $q.defer();
dfr.resolve(crmMailingAB);
return dfr.promise;
}
else {
return crmApi('MailingAB', 'get', {id: crmMailingAB.id})
.then(function (abResult) {
if (abResult.count != 1) {
throw "Failed to load AB Test";
}
crmMailingAB.ab = abResult.values[abResult.id];
return crmMailingAB._loadMailings();
});
}
},
// @return Promise CrmMailingAB
save: function save() {
var crmMailingAB = this;
return crmMailingAB._saveMailings()
.then(function () {
return crmApi('MailingAB', 'create', crmMailingAB.ab)
.then(function (abResult) {
if (!crmMailingAB.id) {
crmMailingAB.id = crmMailingAB.ab.id = abResult.id;
}
});
})
.then(function () {
return crmMailingAB;
});
},
// Schedule the test
// @return Promise CrmMailingAB
// Note: Submission may cause the server state to change. Consider abtest.submit().then(...abtest.load()...)
submitTest: function submitTest() {
var crmMailingAB = this;
var params = {
id: this.ab.id,
status: 'Testing',
approval_date: 'now',
scheduled_date: this.mailings.a.scheduled_date ? this.mailings.a.scheduled_date : 'now'
};
return crmApi('MailingAB', 'submit', params)
.then(function () {
return crmMailingAB.load();
});
},
// Schedule the final mailing
// @return Promise CrmMailingAB
// Note: Submission may cause the server state to change. Consider abtest.submit().then(...abtest.load()...)
submitFinal: function submitFinal(winner_id) {
var crmMailingAB = this;
var params = {
id: this.ab.id,
status: 'Final',
winner_id: winner_id,
approval_date: 'now',
scheduled_date: this.mailings.c.scheduled_date ? this.mailings.c.scheduled_date : 'now'
};
return crmApi('MailingAB', 'submit', params)
.then(function () {
return crmMailingAB.load();
});
},
// @param mailing Object (per APIv3)
// @return Promise
'delete': function () {
if (this.id) {
return crmApi('MailingAB', 'delete', {id: this.id});
}
else {
var d = $q.defer();
d.resolve();
return d.promise;
}
},
// Load mailings A, B, and C (if available)
// @return Promise CrmMailingAB
_loadMailings: function _loadMailings() {
var crmMailingAB = this;
var todos = {};
_.each(['a', 'b', 'c'], function (mkey) {
if (crmMailingAB.ab['mailing_id_' + mkey]) {
todos[mkey] = crmMailingMgr.get(crmMailingAB.ab['mailing_id_' + mkey])
.then(function (mailing) {
crmMailingAB.mailings[mkey] = mailing;
crmMailingAB.attachments[mkey] = new CrmAttachments(function () {
return {entity_table: 'civicrm_mailing', entity_id: crmMailingAB.ab['mailing_id_' + mkey]};
});
return crmMailingAB.attachments[mkey].load();
});
}
else {
crmMailingAB.mailings[mkey] = crmMailingMgr.create();
crmMailingAB.attachments[mkey] = new CrmAttachments(function () {
return {entity_table: 'civicrm_mailing', entity_id: crmMailingAB.ab['mailing_id_' + mkey]};
});
}
});
return $q.all(todos).then(function () {
return crmMailingAB;
});
},
// Save mailings A, B, and C (if available)
// @return Promise CrmMailingAB
_saveMailings: function _saveMailings() {
var crmMailingAB = this;
var todos = {};
var p = $q.when(true);
_.each(['a', 'b', 'c'], function (mkey) {
if (!crmMailingAB.mailings[mkey]) {
return;
}
if (crmMailingAB.ab['mailing_id_' + mkey]) {
// paranoia: in case caller forgot to manage id on mailing
crmMailingAB.mailings[mkey].id = crmMailingAB.ab['mailing_id_' + mkey];
}
p = p.then(function(){
return crmMailingMgr.save(crmMailingAB.mailings[mkey])
.then(function () {
crmMailingAB.ab['mailing_id_' + mkey] = crmMailingAB.mailings[mkey].id;
return crmMailingAB.attachments[mkey].save();
});
});
});
return p.then(function () {
return crmMailingAB;
});
}
});
return CrmMailingAB;
});
})(angular, CRM.$, CRM._);
|
