Merge pull request #109 from teamsnap/notify-team-of-events-import

Bulk create and notify events

Author: randy-girard

CHANGELOG.md

@@ -1,5 +1,10 @@
 # TeamSnap JavaScript SDK CHANGELOG
 
+### Feb 4, 2016 // Version 1.8.0
+- Adds `bulkCreateEvents` method.
+
+---
+
 ### Jan 26, 2016 // Version 1.7.6
 - Addresses bug where, When saving a `statistic`, its `statisticGroup` may be incorrectly unlinked.
 

docs/collections/events.md

@@ -8,6 +8,7 @@
 - [deleteEvent](#deleteEvent)
 - [sendAvailabilityReminders](#sendAvailabilityReminders)
 - [getEventSort](#getEventSort)
+- [bulkCreateEvents](#bulkCreateEvents)
 
 
 ---
@@ -163,3 +164,38 @@ _none_
 eventArray.sort(teamsnap.getEventSort());
 
 ```
+
+
+---
+<a id="bulkCreateEvents"></a>
+## `bulkCreateEvents(params, callback)`
+Creates multiple events.
+
+### Params
+* `params`: [object] - Object that contains additional data:
+  * `teamId`: [int] - Id of Team the events are for
+  * `events`: [array] - Array of event objects to create
+  * `sendingMemberId`: [int] - Id of member that notify email will come from (optional).
+  * `notifyTeam` - [bool] - Flag indictating if notify email should be sent to team.
+* `callback`: [function] - callback to be executed when the operation completes.
+
+### Examples
+```javascript
+// ~~~~~
+// Creates multiple events for `teamId: 1` and sends a notify email to team.
+teamsnap.bulkCreateEvents({
+  teamId: 1,
+  events: [{
+    teamId: 1,
+    locationId: 1,
+    opponentId: 1
+    isGame: true,
+    startDate: new Date()
+  },
+  sendingMemberId: 1,
+  notifyTeam: true
+});
+```
+
+
+---

lib/teamsnap.js

@@ -1063,6 +1063,23 @@ exports.getEventSort = function() {
   })(this);
 };
 
+exports.bulkCreateEvents = function(params, callback) {
+  var options;
+  if (!params.teamId) {
+    return this.reject('You must choose a team.', 'teamId', callback);
+  }
+  if (!Array.isArray(params.events)) {
+    throw new TSArgsError('teamsnap.bulkCreateEvents', "`events` must be an array of events");
+  }
+  options = {
+    templates: params.events,
+    teamId: params.teamId,
+    notifyTeamAsMemberId: params.sendingMemberId,
+    notifyTeam: params.notifyTeam
+  };
+  return this.collections.events.exec('bulkCreate', options, callback);
+};
+
 });
 
 require.register("collections/facebookPages", function(exports, require, module) {
@@ -5749,7 +5766,7 @@ ref = require('./model'), Collection = ref.Collection, Item = ref.Item;
 require('./errors');
 
 TeamSnap = (function() {
-  TeamSnap.prototype.version = '1.7.6';
+  TeamSnap.prototype.version = '1.8.0';
 
   TeamSnap.prototype.promises = promises;
 

lib/teamsnap.min.js

@@ -5282,13 +5282,60 @@ describe('Event Statistics', function() {
 
 require.register("test/events", function(exports, require, module) {
 describe('Events', function() {
-  return it('should be able to load all events for team', function(done) {
+  var location, member;
+  member = null;
+  location = null;
+  before(function(done) {
+    location = teamsnap.createLocation();
+    location.teamId = team.id;
+    location.name = "Location";
+    return teamsnap.saveLocation(location, function(err, result) {
+      return done();
+    });
+  });
+  before(function(done) {
+    member = teamsnap.createMember();
+    member.teamId = team.id;
+    member.firstName = 'Test';
+    return teamsnap.saveMember(member, function(err, result) {
+      return done();
+    });
+  });
+  after(function(done) {
+    return teamsnap.deleteMember(member, function(err, result) {
+      expect(err).to.be["null"];
+      return done();
+    });
+  });
+  it('should be able to load all events for team', function(done) {
     return teamsnap.loadEvents(team.id, function(err, result) {
       expect(err).to.be["null"];
       result.should.be.an('array');
       return done();
     });
   });
+  return it('should be able to bulk create events', function(done) {
+    var events, params;
+    events = [
+      {
+        startDate: "2012-01-01",
+        name: "Test",
+        teamId: team.id,
+        locationId: location.id
+      }
+    ];
+    params = {
+      events: events,
+      teamId: team.id,
+      sendingMemberId: member.id,
+      notifyTeam: false
+    };
+    return teamsnap.bulkCreateEvents(params, function(err, result) {
+      expect(err).to.be["null"];
+      result.should.be.an('array');
+      return done();
+    });
+  });
 });
 
 });

lib/test/js/test.js

@@ -1,6 +1,6 @@
 {
   "name": "teamsnap.js",
-  "version": "1.7.6",
+  "version": "1.8.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",

lib/test/js/test.min.js

@@ -121,3 +121,17 @@ exports.getEventSort = ->
     if valueA > valueB then 1
     else if valueA < valueB then -1
     else 0
+
+exports.bulkCreateEvents = (params, callback) ->
+  unless params.teamId
+    return @reject 'You must choose a team.', 'teamId', callback
+  unless Array.isArray(params.events)
+    throw new TSArgsError 'teamsnap.bulkCreateEvents', "`events` must
+      be an array of events"
+
+  options =
+    templates: params.events
+    teamId: params.teamId
+    notifyTeamAsMemberId: params.sendingMemberId
+    notifyTeam: params.notifyTeam
+  @collections.events.exec('bulkCreate', options, callback)

package.json

@@ -3,7 +3,7 @@ promises = require './promises'
 require './errors'
 
 class TeamSnap
-  version: '1.7.6'
+  version: '1.8.0'
   promises: promises
   when: promises.when
   TeamSnap: TeamSnap

src/collections/events.coffee

@@ -1,7 +1,51 @@
 describe 'Events', ->
 
+  member = null
+  location = null
+
+  before (done) ->
+    location = teamsnap.createLocation()
+    location.teamId = team.id
+    location.name = "Location"
+    teamsnap.saveLocation location, (err, result) ->
+      done()
+
+  before (done) ->
+    member = teamsnap.createMember()
+    member.teamId = team.id
+    member.firstName = 'Test'
+    teamsnap.saveMember member, (err, result) ->
+      done()
+
+  after (done) ->
+    teamsnap.deleteMember member, (err, result) ->
+      expect(err).to.be.null
+      done()
+
   it 'should be able to load all events for team', (done) ->
     teamsnap.loadEvents team.id, (err, result) ->
+      expect(err).to.be.null
+      result.should.be.an('array')
+      done()
+
+  it 'should be able to bulk create events', (done) ->
+    events = [
+      {
+        startDate: "2012-01-01",
+        name: "Test",
+        teamId: team.id,
+        locationId: location.id
+      }
+    ]
+
+    params = {
+      events: events,
+      teamId: team.id,
+      sendingMemberId: member.id,
+      notifyTeam: false
+    }
+
+    teamsnap.bulkCreateEvents params, (err, result) ->
       expect(err).to.be.null
       result.should.be.an('array')
       done()