js/angular-crmMailingAB/services.js

   1 (function (angular, $, _) {
   2
   3   function OptionGroup(values) {
   4     this.get = function get(value) {
   5       var r = _.where(values, {value: '' + value});
   6       return r.length > 0 ? r[0] : null;
   7     };
   8     this.getByName = function get(name) {
   9       var r = _.where(values, {name: '' + name});
  10       return r.length > 0 ? r[0] : null;
  11     };
  12     this.getAll = function getAll() {
  13       return values;
  14     };
  15   }
  16
  17   angular.module('crmMailingAB').factory('crmMailingABCriteria', function () {
  18     // TODO Get data from server
  19     var values = {
  20       '1': {value: 'subject', name: 'subject', label: ts('Test different "Subject" lines')},
  21       '2': {value: 'from', name: 'from', label: ts('Test different "From" lines')},
  22       '3': {value: 'full_email', name: 'full_email', label: ts('Test entirely different emails')}
  23     };
  24     return new OptionGroup(values);
  25   });
  26
  27   angular.module('crmMailingAB').factory('crmMailingABStatus', function () {
  28     // TODO Get data from server
  29     var values = {
  30       '1': {value: '1', name: 'Draft', label: ts('Draft')},
  31       '2': {value: '2', name: 'Testing', label: ts('Testing')},
  32       '3': {value: '3', name: 'Final', label: ts('Final')}
  33     };
  34     return new OptionGroup(values);
  35   });
  36
  37   // CrmMailingAB is a data-model which combines an AB test (APIv3 "MailingAB"), three mailings (APIv3 "Mailing"),
  38   // and three sets of attachments (APIv3 "Attachment").
  39   //
  40   // example:
  41   //   var abtest = new CrmMailingAB(123);
  42   //   abtest.load().then(function(){
  43   //     alert("Mailing A is named "+abtest.mailings.a.name);
  44   //   });
  45   angular.module('crmMailingAB').factory('CrmMailingAB', function (crmApi, crmMailingMgr, $q, CrmAttachments, crmNow) {
  46     function CrmMailingAB(id) {
  47       this.id = id;
  48       this.mailings = {};
  49       this.attachments = {};
  50     }
  51
  52     angular.extend(CrmMailingAB.prototype, {
  53       getAutosaveSignature: function() {
  54         return [
  55           this.ab,
  56           this.mailings,
  57           this.attachments.a.getAutosaveSignature(),
  58           this.attachments.b.getAutosaveSignature(),
  59           this.attachments.c.getAutosaveSignature()
  60         ];
  61       },
  62       // @return Promise CrmMailingAB
  63       load: function load() {
  64         var crmMailingAB = this;
  65         if (!crmMailingAB.id) {
  66           crmMailingAB.ab = {
  67             name: '',
  68             status: 'Draft',
  69             mailing_id_a: null,
  70             mailing_id_b: null,
  71             mailing_id_c: null,
  72             domain_id: null,
  73             testing_criteria: 'subject',
  74             winner_criteria: null,
  75             specific_url: '',
  76             declare_winning_time: null,
  77             group_percentage: 10
  78           };
  79           var mailingDefaults = {
  80             // Most defaults provided by Mailing.create API, but we
  81             // want to force-enable tracking.
  82             open_tracking: "1",
  83             url_tracking: "1"
  84           };
  85           crmMailingAB.mailings.a = crmMailingMgr.create(mailingDefaults);
  86           crmMailingAB.mailings.b = crmMailingMgr.create(mailingDefaults);
  87           crmMailingAB.mailings.c = crmMailingMgr.create(mailingDefaults);
  88           crmMailingAB.attachments.a = new CrmAttachments(function () {
  89             return {entity_table: 'civicrm_mailing', entity_id: crmMailingAB.ab.mailing_id_a};
  90           });
  91           crmMailingAB.attachments.b = new CrmAttachments(function () {
  92             return {entity_table: 'civicrm_mailing', entity_id: crmMailingAB.ab.mailing_id_b};
  93           });
  94           crmMailingAB.attachments.c = new CrmAttachments(function () {
  95             return {entity_table: 'civicrm_mailing', entity_id: crmMailingAB.ab.mailing_id_c};
  96           });
  97
  98           var dfr = $q.defer();
  99           dfr.resolve(crmMailingAB);
 100           return dfr.promise;
 101         }
 102         else {
 103           return crmApi('MailingAB', 'get', {id: crmMailingAB.id})
 104             .then(function (abResult) {
 105               if (abResult.count != 1) {
 106                 throw "Failed to load AB Test";
 107               }
 108               crmMailingAB.ab = abResult.values[abResult.id];
 109               return crmMailingAB._loadMailings();
 110             });
 111         }
 112       },
 113       // @return Promise CrmMailingAB
 114       save: function save() {
 115         var crmMailingAB = this;
 116         return crmMailingAB._saveMailings()
 117           .then(function () {
 118             return crmApi('MailingAB', 'create', crmMailingAB.ab)
 119               .then(function (abResult) {
 120                 if (!crmMailingAB.id) {
 121                   crmMailingAB.id = crmMailingAB.ab.id = abResult.id;
 122                 }
 123               });
 124           })
 125           .then(function () {
 126             return crmMailingAB;
 127           });
 128       },
 129       // Schedule the test
 130       // @return Promise CrmMailingAB
 131       // Note: Submission may cause the server state to change. Consider abtest.submit().then(...abtest.load()...)
 132       submitTest: function submitTest() {
 133         var crmMailingAB = this;
 134         var params = {
 135           id: this.ab.id,
 136           status: 'Testing',
 137           approval_date: crmNow(),
 138           scheduled_date: this.mailings.a.scheduled_date ? this.mailings.a.scheduled_date : crmNow()
 139         };
 140         return crmApi('MailingAB', 'submit', params)
 141           .then(function () {
 142             return crmMailingAB.load();
 143           });
 144       },
 145       // Schedule the final mailing
 146       // @return Promise CrmMailingAB
 147       // Note: Submission may cause the server state to change. Consider abtest.submit().then(...abtest.load()...)
 148       submitFinal: function submitFinal() {
 149         var crmMailingAB = this;
 150         var params = {
 151           id: this.ab.id,
 152           status: 'Final',
 153           approval_date: crmNow(),
 154           scheduled_date: this.mailings.c.scheduled_date ? this.mailings.c.scheduled_date : crmNow()
 155         };
 156         return crmApi('MailingAB', 'submit', params)
 157           .then(function () {
 158             return crmMailingAB;
 159           });
 160       },
 161       // @param mailing Object (per APIv3)
 162       // @return Promise
 163       'delete': function () {
 164         if (this.id) {
 165           return crmApi('MailingAB', 'delete', {id: this.id});
 166         }
 167         else {
 168           var d = $q.defer();
 169           d.resolve();
 170           return d.promise;
 171         }
 172       },
 173       // Load mailings A, B, and C (if available)
 174       // @return Promise CrmMailingAB
 175       _loadMailings: function _loadMailings() {
 176         var crmMailingAB = this;
 177         var todos = {};
 178         _.each(['a', 'b', 'c'], function (mkey) {
 179           if (crmMailingAB.ab['mailing_id_' + mkey]) {
 180             todos[mkey] = crmMailingMgr.get(crmMailingAB.ab['mailing_id_' + mkey])
 181               .then(function (mailing) {
 182                 crmMailingAB.mailings[mkey] = mailing;
 183                 crmMailingAB.attachments[mkey] = new CrmAttachments(function () {
 184                   return {entity_table: 'civicrm_mailing', entity_id: crmMailingAB.ab['mailing_id_' + mkey]};
 185                 });
 186                 return crmMailingAB.attachments[mkey].load();
 187               });
 188           }
 189           else {
 190             crmMailingAB.mailings[mkey] = crmMailingMgr.create();
 191             crmMailingAB.attachments[mkey] = new CrmAttachments(function () {
 192               return {entity_table: 'civicrm_mailing', entity_id: crmMailingAB.ab['mailing_id_' + mkey]};
 193             });
 194           }
 195         });
 196         return $q.all(todos).then(function () {
 197           return crmMailingAB;
 198         });
 199       },
 200       // Save mailings A, B, and C (if available)
 201       // @return Promise CrmMailingAB
 202       _saveMailings: function _saveMailings() {
 203         var crmMailingAB = this;
 204         var todos = {};
 205         var p = $q.when(true);
 206         _.each(['a', 'b', 'c'], function (mkey) {
 207           if (!crmMailingAB.mailings[mkey]) {
 208             return;
 209           }
 210           if (crmMailingAB.ab['mailing_id_' + mkey]) {
 211             // paranoia: in case caller forgot to manage id on mailing
 212             crmMailingAB.mailings[mkey].id = crmMailingAB.ab['mailing_id_' + mkey];
 213           }
 214           p = p.then(function(){
 215             return crmMailingMgr.save(crmMailingAB.mailings[mkey])
 216               .then(function () {
 217                 crmMailingAB.ab['mailing_id_' + mkey] = crmMailingAB.mailings[mkey].id;
 218                 return crmMailingAB.attachments[mkey].save();
 219               });
 220           });
 221         });
 222         return p.then(function () {
 223           return crmMailingAB;
 224         });
 225       }
 226
 227     });
 228     return CrmMailingAB;
 229   });
 230
 231 })(angular, CRM.$, CRM._);