Merge pull request #43 from teamsnap/add-broadcast-email

Add broadcast email

Author: kristenboydstun

lib/teamsnap.js

@@ -465,6 +465,71 @@ exports.bulkMarkUnsetAvailabilities = function(memberId, statusCode, callback) {
 
 });
 
+require.register("collections/broadcastEmails", function(exports, require, module) {
+exports.loadBroadcastEmails = function(params, callback) {
+  if (this.isId(params)) {
+    params = {
+      id: params
+    };
+  } else if (!(params && typeof params === 'object')) {
+    throw new TSArgsError('teamsnap.loadBroadcastEmails', 'must provide an id or query parameters');
+  }
+  return this.loadItems('broadcastEmail', params, callback);
+};
+
+exports.createBroadcastEmail = function(data) {
+  return this.createItem(data, {
+    type: 'broadcastEmail'
+  });
+};
+
+exports.saveBroadcastEmail = function(broadcastEmail, callback) {
+  var _ref;
+  if (!broadcastEmail) {
+    throw new TSArgsError('teamsnap.saveBroadcastEmail', "`broadcastEmail` must be provided");
+  }
+  if (!this.isItem(broadcastEmail, 'broadcastEmail')) {
+    throw new TSArgsError('teamsnap.saveBroadcastEmail', "`type` must be 'broadcastEmail'");
+  }
+  if (!broadcastEmail.teamId) {
+    return this.reject('You must provide a team id.', 'teamId', callback);
+  }
+  if (!broadcastEmail.memberId) {
+    return this.reject('You must provide a member id.', 'memberId', callback);
+  }
+  if (!((_ref = broadcastEmail.body) != null ? _ref.trim() : void 0)) {
+    return this.reject('You must provide the text alert body.', 'body', callback);
+  }
+  return this.saveItem(broadcastEmail, callback);
+};
+
+exports.deleteBroadcastEmail = function(broadcastEmail, callback) {
+  if (!broadcastEmail) {
+    throw new TSArgsError('teamsnap.deleteBroadcastEmail', '`broadcastEmail` must be provided');
+  }
+  return this.deleteItem(broadcastEmail, callback);
+};
+
+exports.uploadAttachment = function(broadcastEmailId, file, callback) {
+  var params;
+  if (typeof FormData === 'undefined') {
+    this.reject('Your browser does not support the new file upload APIs.', 'file', callback);
+  }
+  if (!file) {
+    throw new TSArgsError('teamsnap.uploadAttachment', 'file is required');
+  }
+  if (!broadcastEmailId) {
+    throw new TSArgsError('teamsnap.uploadAttachment', 'broadcastEmailId is required');
+  }
+  params = {
+    broadcastEmailId: broadcastEmailId,
+    file: file
+  };
+  return this.collections.broadcastEmails.exec('uploadAttachment', params);
+};
+
+});
+
 require.register("collections/broadcastSms", function(exports, require, module) {
 exports.loadBroadcastSmses = function(params, callback) {
   if (this.isId(params)) {
@@ -4401,6 +4466,8 @@ add(require('./collections/assignments'));
 
 add(require('./collections/availabilities'));
 
+add(require('./collections/broadcastEmails'));
+
 add(require('./collections/broadcastSms'));
 
 add(require('./collections/contactEmailAddresses'));
@@ -4509,7 +4576,7 @@ _ref = require('./model'), Collection = _ref.Collection, Item = _ref.Item;
 require('./errors');
 
 TeamSnap = (function() {
-  TeamSnap.prototype.version = '1.2.1';
+  TeamSnap.prototype.version = '1.3.0';
 
   TeamSnap.prototype.promises = promises;
 
@@ -4549,7 +4616,7 @@ var plural, pluralLookup, singularLookup, teamTypes, teamsnap, type, typeLookup,
 
 teamsnap = exports;
 
-types = ['user', 'assignment', 'availability', 'broadcastSms', 'contact', 'contactEmailAddress', 'contactPhoneNumber', 'customDatum', 'customField', 'leagueCustomDatum', 'leagueCustomField', 'divisionLocation', 'divisionMember', 'divisionMemberPreferences', 'event', 'forumPost', 'forumSubscription', 'forumTopic', 'leagueRegistrantDocument', 'location', 'member', 'memberEmailAddress', 'memberFile', 'memberLink', 'memberPayment', 'memberPhoneNumber', 'memberPreferences', 'opponent', 'opponentResults', 'paymentNote', 'plan', 'smsGateway', 'sponsor', 'sport', 'team', 'teamFee', 'teamPaypalPreferences', 'teamPreferences', 'teamPublicSite', 'teamResults', 'timeZone', 'trackedItem', 'trackedItemStatus'];
+types = ['user', 'assignment', 'availability', 'broadcastEmail', 'broadcastSms', 'contact', 'contactEmailAddress', 'contactPhoneNumber', 'customDatum', 'customField', 'leagueCustomDatum', 'leagueCustomField', 'divisionLocation', 'divisionMember', 'divisionMemberPreferences', 'event', 'forumPost', 'forumSubscription', 'forumTopic', 'leagueRegistrantDocument', 'location', 'member', 'memberEmailAddress', 'memberFile', 'memberLink', 'memberPayment', 'memberPhoneNumber', 'memberPreferences', 'opponent', 'opponentResults', 'paymentNote', 'plan', 'smsGateway', 'sponsor', 'sport', 'team', 'teamFee', 'teamPaypalPreferences', 'teamPreferences', 'teamPublicSite', 'teamResults', 'timeZone', 'trackedItem', 'trackedItemStatus'];
 
 teamTypes = types.slice();
 

lib/teamsnap.min.js

@@ -135,6 +135,101 @@ describe('Availabilities', function() {
 
 });
 
+require.register("test/broadcastEmail", function(exports, require, module) {
+describe('Broadcast Emails', function() {
+  var email, recipient, sender;
+  email = null;
+  sender = null;
+  recipient = null;
+  before(function(done) {
+    sender = teamsnap.createMember();
+    sender.teamId = team.id;
+    sender.firstName = 'Test';
+    return teamsnap.saveMember(sender, function(err, result) {
+      var memberEmail;
+      expect(err).to.be["null"];
+      memberEmail = teamsnap.createMemberEmailAddress();
+      memberEmail.memberId = sender.id;
+      memberEmail.email = "[email protected]";
+      return teamsnap.saveMemberEmailAddress(memberEmail, function(err, result) {
+        expect(err).to.be["null"];
+        return done();
+      });
+    });
+  });
+  before(function(done) {
+    recipient = teamsnap.createMember();
+    recipient.teamId = team.id;
+    recipient.firstName = 'Test';
+    return teamsnap.saveMember(recipient, function(err, result) {
+      var memberEmail;
+      expect(err).to.be["null"];
+      memberEmail = teamsnap.createMemberEmailAddress();
+      memberEmail.memberId = recipient.id;
+      memberEmail.email = "[email protected]";
+      return teamsnap.saveMemberEmailAddress(memberEmail, function(err, result) {
+        expect(err).to.be["null"];
+        return done();
+      });
+    });
+  });
+  after(function(done) {
+    return teamsnap.deleteMember(sender, function(err, result) {
+      expect(err).to.be["null"];
+      return done();
+    });
+  });
+  after(function(done) {
+    return teamsnap.deleteMember(recipient, function(err, result) {
+      expect(err).to.be["null"];
+      return done();
+    });
+  });
+  it('should be able to create a broadcast email', function(done) {
+    email = teamsnap.createBroadcastEmail();
+    email.teamId = team.id;
+    email.memberId = sender.id;
+    email.body = "Hello world";
+    email.subject = "Subject!";
+    email.recipientIds = [recipient.id];
+    return teamsnap.saveBroadcastEmail(email, function(err, result) {
+      expect(err).to.be["null"];
+      result.should.have.property('type', 'broadcastEmail');
+      result.should.have.property('recipientCount', 1);
+      result.should.have.property('memberId', sender.id);
+      result.should.have.property('body', "Hello world");
+      return done();
+    });
+  });
+  it('should be able to load all broadcast emails for a team', function(done) {
+    return teamsnap.loadBroadcastEmails({
+      teamId: team.id
+    }, function(err, result) {
+      expect(err).to.be["null"];
+      result.should.be.an('array');
+      result.should.have.property('length', 1);
+      return done();
+    });
+  });
+  it('should be able to load a single broadcast email', function(done) {
+    return teamsnap.loadBroadcastEmails(email.id, function(err, result) {
+      expect(err).to.be["null"];
+      result.should.be.an('array');
+      result.should.have.property('length', 1);
+      result[0].should.have.property('id', email.id);
+      return done();
+    });
+  });
+  return it('should be able to delete a broadcast email', function(done) {
+    return teamsnap.deleteBroadcastEmail(email, function(err, result) {
+      expect(err).to.be["null"];
+      return done();
+    });
+  });
+});
+
+});
+
 require.register("test/broadcastSms", function(exports, require, module) {
 describe('Broadcast Smses', function() {
   var recipient, sender, sms;

lib/test/js/test.js

@@ -1,6 +1,6 @@
 {
   "name": "teamsnap.js",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "A JavaScript library for using the TeamSnap API.",
   "author": "Jacob Wright with TeamSnap (http://www.teamsnap.com)",
   "homepage": "https://github.com/teamsnap/teamsnap-javascript-sdk",
@@ -26,4 +26,4 @@
     "uglify-js-brunch": "latest",
     "coffeelint-brunch": "latest"
   }
-}
+}

lib/test/js/test.min.js

@@ -0,0 +1,51 @@
+exports.loadBroadcastEmails = (params, callback) ->
+  if @isId params
+    params = id: params
+  else unless params and typeof params is 'object'
+    throw new TSArgsError 'teamsnap.loadBroadcastEmails', 'must provide an id
+      or query parameters'
+
+  @loadItems 'broadcastEmail', params, callback
+
+exports.createBroadcastEmail = (data) ->
+  @createItem data,
+    type: 'broadcastEmail'
+
+exports.saveBroadcastEmail = (broadcastEmail, callback) ->
+  unless broadcastEmail
+    throw new TSArgsError 'teamsnap.saveBroadcastEmail', "`broadcastEmail` must
+      be provided"
+  unless @isItem broadcastEmail, 'broadcastEmail'
+    throw new TSArgsError 'teamsnap.saveBroadcastEmail', "`type` must
+      be 'broadcastEmail'"
+  unless broadcastEmail.teamId
+    return @reject 'You must provide a team id.', 'teamId', callback
+  unless broadcastEmail.memberId
+    return @reject 'You must provide a member id.', 'memberId', callback
+  unless broadcastEmail.body?.trim()
+    return @reject 'You must provide the text alert body.',
+      'body', callback
+
+  @saveItem broadcastEmail, callback
+
+exports.deleteBroadcastEmail = (broadcastEmail, callback) ->
+  unless broadcastEmail
+    throw new TSArgsError 'teamsnap.deleteBroadcastEmail', '`broadcastEmail`
+      must be provided'
+
+  @deleteItem broadcastEmail, callback
+
+exports.uploadAttachment = (broadcastEmailId, file, callback) ->
+  if typeof FormData is 'undefined'
+    @reject 'Your browser does not support the new file upload APIs.', 'file',
+      callback
+  unless file
+    throw new TSArgsError 'teamsnap.uploadAttachment',
+      'file is required'
+  unless broadcastEmailId
+    throw new TSArgsError 'teamsnap.uploadAttachment',
+      'broadcastEmailId is required'
+
+  params = broadcastEmailId: broadcastEmailId, file: file
+
+  @collections.broadcastEmails.exec('uploadAttachment', params)

package.json

@@ -159,6 +159,7 @@ add require './persistence'
 add require './collections/teams'
 add require './collections/assignments'
 add require './collections/availabilities'
+add require './collections/broadcastEmails'
 add require './collections/broadcastSms'
 add require './collections/contactEmailAddresses'
 add require './collections/contactPhoneNumbers'

src/collections/broadcastEmails.coffee

@@ -3,7 +3,7 @@ promises = require './promises'
 require './errors'
 
 class TeamSnap
-  version: '1.2.1'
+  version: '1.3.0'
   promises: promises
   when: promises.when
   TeamSnap: TeamSnap
@@ -20,4 +20,4 @@ require './sdk'
 
 
 unless String::trim
-  String::trim = -> @replace /^\s+|\s+$/g, ''
+  String::trim = -> @replace /^\s+|\s+$/g, ''

src/sdk.coffee

@@ -4,6 +4,7 @@ types = [
   'user'
   'assignment'
   'availability'
+  'broadcastEmail'
   'broadcastSms'
   'contact'
   'contactEmailAddress'

src/teamsnap.coffee

@@ -0,0 +1,78 @@
+describe 'Broadcast Emails', ->
+
+  email = null
+  sender = null
+  recipient = null
+
+  before (done) ->
+    sender = teamsnap.createMember()
+    sender.teamId = team.id
+    sender.firstName = 'Test'
+    teamsnap.saveMember sender, (err, result) ->
+      expect(err).to.be.null
+      memberEmail = teamsnap.createMemberEmailAddress()
+      memberEmail.memberId = sender.id
+      memberEmail.email = "[email protected]"
+      teamsnap.saveMemberEmailAddress memberEmail, (err, result) ->
+        expect(err).to.be.null
+        done()
+
+  before (done) ->
+    recipient = teamsnap.createMember()
+    recipient.teamId = team.id
+    recipient.firstName = 'Test'
+    teamsnap.saveMember recipient, (err, result) ->
+      expect(err).to.be.null
+      memberEmail = teamsnap.createMemberEmailAddress()
+      memberEmail.memberId = recipient.id
+      memberEmail.email = "[email protected]"
+      teamsnap.saveMemberEmailAddress memberEmail, (err, result) ->
+        expect(err).to.be.null
+        done()
+
+  after (done) ->
+    teamsnap.deleteMember sender, (err, result) ->
+      expect(err).to.be.null
+      done()
+
+  after (done) ->
+    teamsnap.deleteMember recipient, (err, result) ->
+      expect(err).to.be.null
+      done()
+
+  it 'should be able to create a broadcast email', (done) ->
+    email = teamsnap.createBroadcastEmail()
+    email.teamId = team.id
+    email.memberId = sender.id
+    email.body = "Hello world"
+    email.subject = "Subject!"
+    email.recipientIds = [recipient.id]
+    teamsnap.saveBroadcastEmail email, (err, result) ->
+      expect(err).to.be.null
+      result.should.have.property('type', 'broadcastEmail')
+      result.should.have.property('recipientCount', 1)
+      result.should.have.property('memberId', sender.id)
+      result.should.have.property('body', "Hello world")
+      done()
+
+  it 'should be able to load all broadcast emails for a team', (done) ->
+    teamsnap.loadBroadcastEmails {teamId: team.id}, (err, result) ->
+      expect(err).to.be.null
+      result.should.be.an('array')
+      result.should.have.property('length', 1)
+      done()
+
+  it 'should be able to load a single broadcast email', (done) ->
+    teamsnap.loadBroadcastEmails email.id, (err, result) ->
+      expect(err).to.be.null
+      result.should.be.an('array')
+      result.should.have.property('length', 1)
+      result[0].should.have.property('id', email.id)
+      done()
+
+
+  it 'should be able to delete a broadcast email', (done) ->
+    teamsnap.deleteBroadcastEmail email, (err, result) ->
+      expect(err).to.be.null
+      done()
+