Merge pull request #124 from teamsnap/message-mark-as-read

Adds ability to query messages and execute mark as read functionality.

Author: randy-girard

CHANGELOG.md

@@ -1,5 +1,12 @@
 # TeamSnap JavaScript SDK CHANGELOG
 
+### March 22, 2016 // Version 1.13.0
+- Adds `loadMessages` method.
+- Adds `markMessageAsRead` method.
+- Adds `loadMessageData` method.
+
+---
+
 ### March 21, 2016 // Version 1.12.1
 - Reloads `memberEmailAddresses` and `contactEmailAddresses` in `importMembersFromTeam` method
   in persistence wrapper.

docs/collections/message_data.md

@@ -0,0 +1,29 @@
+# Message Data
+
+## Methods
+
+- [loadMessageData](#loadMessageData)
+
+
+---
+<a id="loadMessageData"></a>
+## `loadMessageData(params, callback)`
+Loads items from the `messageData` collection based on given params.
+
+### Params
+* `params`: [int, object] - can be either a `teamId` or an object with query parameters.
+* `callback`: [function] - callback to be executed when the operation completes.
+
+To see a list of all available search params you can run:
+`teamsnap.collections.messageData.queries.search.params`
+
+### Examples
+```javascript
+// ~~~~~
+// Loads all messageData for `teamId: 1`.
+teamsnap.loadMessageData(1);
+
+// ~~~~~
+// Loads all messageData for `userId: 1`.
+teamsnap.loadMessageData({userId: 1});
+```

docs/collections/messages.md

@@ -0,0 +1,52 @@
+# Messages
+
+## Methods
+
+- [loadMessages](#loadMessages)
+- [markMessageAsRead](#markMessageAsRead)
+
+
+---
+<a id="loadMessages"></a>
+## `loadMessages(params, callback)`
+Loads items from the `messages` collection based on given params.
+
+### Params
+* `params`: [int, object] - can be either a `teamId` or an object with query parameters.
+* `callback`: [function] - callback to be executed when the operation completes.
+
+To see a list of all available search params you can run:
+`teamsnap.collections.messages.queries.search.params`
+
+### Examples
+```javascript
+// ~~~~~
+// Loads all messages for `teamId: 1`.
+teamsnap.loadMessages(1);
+
+// ~~~~~
+// Loads messages for `userId: 1`.
+teamsnap.loadMessages({userId: 1});
+```
+
+
+---
+
+
+<a id="markMessageAsRead"></a>
+## `markMessageAsRead(params)`
+Marks a `message` item as read.
+
+### Params
+* `params`: [int, object] - ID of the message, or the message object to mark as read.
+
+### Examples
+```javascript
+// ~~~~~
+// Marks a message as read.
+var message = teamsnap.markMessageAsRead(1);
+
+// ~~~~~
+// Marks a message as read.
+var message = teamsnap.markMessageAsRead(messageToMarkAsUnread);
+```

lib/teamsnap.js

@@ -1872,6 +1872,49 @@ exports.saveMemberPreferences = function(memberPreferences, callback) {
 
 });
 
+require.register("collections/messageData", function(exports, require, module) {
+exports.loadMessageData = function(params, callback) {
+  if (this.isId(params)) {
+    params = {
+      teamId: params
+    };
+  } else if (!(params && typeof params === 'object')) {
+    throw new TSArgsError('teamsnap.loadMessageData', 'must provide a teamId or query parameters');
+  }
+  return this.loadItems('messageDatum', params, callback);
+};
+
+});
+
+require.register("collections/messages", function(exports, require, module) {
+exports.loadMessages = function(params, callback) {
+  if (this.isId(params)) {
+    params = {
+      teamId: params
+    };
+  } else if (!(params && typeof params === 'object')) {
+    throw new TSArgsError('teamsnap.loadMessages', 'must provide a teamId or query parameters');
+  }
+  return this.loadItems('message', params, callback);
+};
+
+exports.markMessageAsRead = function(params, callback) {
+  if (typeof params === 'object') {
+    params = {
+      id: params.id
+    };
+  } else if (this.isId(params)) {
+    params = {
+      id: params
+    };
+  } else {
+    throw new TSArgsError('teamsnap.markMessageAsRead', 'a message `id` or `message` object must be provided');
+  }
+  return this.collections.messages.exec('markMessageAsRead', params).pop().callback(callback);
+};
+
+});
+
 require.register("collections/opponents", function(exports, require, module) {
 exports.loadOpponents = function(params, callback) {
   if (this.isId(params)) {
@@ -5820,6 +5863,10 @@ add(require('./collections/memberStatistics'));
 
 add(require('./collections/members'));
 
+add(require('./collections/messageData'));
+
+add(require('./collections/messages'));
+
 add(require('./collections/opponents'));
 
 add(require('./collections/opponentsResults'));
@@ -5896,7 +5943,7 @@ ref = require('./model'), Collection = ref.Collection, Item = ref.Item;
 require('./errors');
 
 TeamSnap = (function() {
-  TeamSnap.prototype.version = '1.12.1';
+  TeamSnap.prototype.version = '1.13.0';
 
   TeamSnap.prototype.promises = promises;
 
@@ -5936,7 +5983,7 @@ var i, len, plural, pluralLookup, singularLookup, teamTypes, teamsnap, type, typ
 
 teamsnap = exports;
 
-types = ['user', 'assignment', 'availability', 'broadcastAlert', 'broadcastEmail', 'broadcastEmailAttachment', 'contact', 'contactEmailAddress', 'contactPhoneNumber', 'customDatum', 'customField', 'leagueCustomDatum', 'leagueCustomField', 'divisionContact', 'divisionContactEmailAddress', 'divisionContactPhoneNumber', 'divisionLocation', 'divisionMember', 'divisionMemberEmailAddress', 'divisionMemberPhoneNumber', 'divisionMemberPreferences', 'divisionTeamStanding', 'event', 'eventStatistic', 'facebookPage', 'forumPost', 'forumSubscription', 'forumTopic', 'leagueRegistrantDocument', 'location', 'member', 'memberBalance', 'memberEmailAddress', 'memberFile', 'memberLink', 'memberPayment', 'memberPhoneNumber', 'memberPreferences', 'memberStatistic', 'opponent', 'opponentResults', 'paymentNote', 'plan', 'smsGateway', 'sponsor', 'statistic', 'statisticAggregate', 'statisticDatum', 'statisticGroup', 'sport', 'team', 'teamFee', 'teamMedium', 'teamMediumComment', 'teamMediaGroup', 'teamPaypalPreferences', 'teamPreferences', 'teamPublicSite', 'teamResults', 'teamStatistic', 'timeZone', 'trackedItem', 'trackedItemStatus'];
+types = ['user', 'assignment', 'availability', 'broadcastAlert', 'broadcastEmail', 'broadcastEmailAttachment', 'contact', 'contactEmailAddress', 'contactPhoneNumber', 'customDatum', 'customField', 'leagueCustomDatum', 'leagueCustomField', 'divisionContact', 'divisionContactEmailAddress', 'divisionContactPhoneNumber', 'divisionLocation', 'divisionMember', 'divisionMemberEmailAddress', 'divisionMemberPhoneNumber', 'divisionMemberPreferences', 'divisionTeamStanding', 'event', 'eventStatistic', 'facebookPage', 'forumPost', 'forumSubscription', 'forumTopic', 'leagueRegistrantDocument', 'location', 'member', 'memberBalance', 'memberEmailAddress', 'memberFile', 'memberLink', 'memberPayment', 'memberPhoneNumber', 'memberPreferences', 'memberStatistic', 'message', 'messageDatum', 'opponent', 'opponentResults', 'paymentNote', 'plan', 'smsGateway', 'sponsor', 'statistic', 'statisticAggregate', 'statisticDatum', 'statisticGroup', 'sport', 'team', 'teamFee', 'teamMedium', 'teamMediumComment', 'teamMediaGroup', 'teamPaypalPreferences', 'teamPreferences', 'teamPublicSite', 'teamResults', 'teamStatistic', 'timeZone', 'trackedItem', 'trackedItemStatus'];
 
 teamTypes = types.slice();
 
@@ -5960,6 +6007,7 @@ pluralLookup = {
   divisionMemberPreferences: 'divisionMembersPreferences',
   opponentResults: 'opponentsResults',
   statisticDatum: 'statisticData',
+  messageDatum: 'messageData',
   teamMedium: 'teamMedia',
   teamPaypalPreferences: 'teamsPaypalPreferences',
   teamPreferences: 'teamsPreferences',

lib/test/js/test.js

@@ -5812,12 +5812,55 @@ describe('Member Links', function() {
 });
 
 require.register("test/memberPayments", function(exports, require, module) {
+var memberPayment;
+
+memberPayment = {};
+
 describe('Member Payments', function() {
-  return it('should be able to load all member payments for team', function(done) {
-    return teamsnap.loadMemberPayments(team.id, function(err, result) {
-      expect(err).to.be["null"];
-      result.should.be.an('array');
-      return done();
+  beforeEach(function(done) {
+    team.members = [
+      {
+        id: 1,
+        firstName: 'Ownie',
+        lastName: 'Owner',
+        memberPayments: [
+          {
+            type: 'memberPayment',
+            id: 222,
+            amountDue: 100.00,
+            amountPaid: 50.00,
+            memberId: 1,
+            teamId: team.id
+          }
+        ]
+      }
+    ];
+    memberPayment = team.members[0].memberPayments[0];
+    return done();
+  });
+  describe('loadMemberPayments', function() {
+    return it('should be able to load all member payments for team', function() {
+      return teamsnap.loadMemberPayments(team.id, function(err, result) {
+        expect(err).to.be["null"];
+        return result.should.be.an('array');
+      });
+    });
+  });
+  return describe('memberPaymentTransaction', function() {
+    it('should accept a memberPayment object', function() {
+      return teamsnap.memberPaymentTransaction(memberPayment, 4, function(err, result) {
+        return result.id.should.equal(222);
+      });
+    });
+    it('should accept a memberPaymentId', function() {
+      return teamsnap.memberPaymentTransaction(memberPayment.id, 10.00, function(err, result) {
+        return result.id.should.equal(222);
+      });
+    });
+    return it('should adjust memberPayment.amoutPaid', function() {
+      return teamsnap.memberPaymentTransaction(memberPayment.id, 10.00, function(err, result) {
+        return result.amountPaid.should.equal(90.00);
+      });
     });
   });
 });
@@ -5967,6 +6010,101 @@ describe('Member Preferences', function() {
 
 });
 
+require.register("test/messageData", function(exports, require, module) {
+describe('Message Data', function() {
+  return it('should be able to load message data for team', function(done) {
+    return teamsnap.loadMessageData({
+      teamId: team.id
+    }, function(err, result) {
+      expect(err).to.be["null"];
+      result.should.be.an('array');
+      return done();
+    });
+  });
+});
+
+});
+
+require.register("test/messages", function(exports, require, module) {
+describe('Messages', function() {
+  var recipient, sender;
+  sender = null;
+  recipient = null;
+  before(function(done) {
+    return teamsnap.loadMe().then(function(me) {
+      return teamsnap.loadMembers({
+        userId: me.id
+      }, function(err, result) {
+        expect(err).to.be["null"];
+        expect(result.length).to.be.above(0);
+        sender = result[0];
+        return done();
+      });
+    });
+  });
+  it('should be able to load all messages for team', function(done) {
+    return teamsnap.loadMessages(team.id, function(err, result) {
+      expect(err).to.be["null"];
+      result.should.be.an('array');
+      return done();
+    });
+  });
+  it('should be able to mark message as read by ID', function(done) {
+    var alert;
+    alert = teamsnap.createBroadcastAlert();
+    alert.teamId = team.id;
+    alert.memberId = sender.id;
+    alert.body = "Hello again world";
+    alert.recipientIds = [sender.id];
+    return teamsnap.saveBroadcastAlert(alert, function(err, result) {
+      expect(err).to.be["null"];
+      return teamsnap.loadMessages(team.id, function(err, result) {
+        var messages;
+        expect(err).to.be["null"];
+        result.should.be.an('array');
+        messages = result.filter(function(i) {
+          return i.messageId === alert.id && i.status === 'received';
+        });
+        expect(messages[0].readAt).to.be["null"];
+        return teamsnap.markMessageAsRead(messages[0].id, function(err, result) {
+          console.log(err);
+          expect(err).to.be["null"];
+          expect(result.readAt).to.not.be["null"];
+          return done();
+        });
+      });
+    });
+  });
+  return it('should be able to mark message as read by object', function(done) {
+    var alert;
+    alert = teamsnap.createBroadcastAlert();
+    alert.teamId = team.id;
+    alert.memberId = sender.id;
+    alert.body = "Hello again world";
+    alert.recipientIds = [sender.id];
+    return teamsnap.saveBroadcastAlert(alert, function(err, result) {
+      return teamsnap.loadMessages(team.id, function(err, result) {
+        var messages;
+        expect(err).to.be["null"];
+        result.should.be.an('array');
+        console.log(result);
+        messages = result.filter(function(i) {
+          return i.messageId === alert.id && i.status === 'received';
+        });
+        expect(messages[0].readAt).to.be["null"];
+        return teamsnap.markMessageAsRead(messages[0], function(err, result) {
+          console.log(err);
+          expect(err).to.be["null"];
+          expect(result.readAt).to.not.be["null"];
+          return done();
+        });
+      });
+    });
+  });
+});
+
+});
+
 require.register("test/opponentResults", function(exports, require, module) {
 describe('Opponent Results', function() {
   var opponent1, opponent2;

package.json

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

src/collections/messageData.coffee

@@ -0,0 +1,8 @@
+exports.loadMessageData = (params, callback) ->
+  if @isId params
+    params = teamId: params
+  else unless params and typeof params is 'object'
+    throw new TSArgsError 'teamsnap.loadMessageData', 'must provide a
+    teamId or query parameters'
+
+  @loadItems 'messageDatum', params, callback

src/collections/messages.coffee

@@ -0,0 +1,19 @@
+exports.loadMessages = (params, callback) ->
+  if @isId params
+    params = teamId: params
+  else unless params and typeof params is 'object'
+    throw new TSArgsError 'teamsnap.loadMessages', 'must provide a
+      teamId or query parameters'
+
+  @loadItems 'message', params, callback
+
+exports.markMessageAsRead = (params, callback) ->
+  if typeof params is 'object'
+    params = id: params.id
+  else if @isId params
+    params = id: params
+  else
+    throw new TSArgsError 'teamsnap.markMessageAsRead', 'a message `id` or `message` object must be provided'
+
+  @collections.messages.exec('markMessageAsRead', params)
+    .pop().callback callback

src/sdk.coffee

@@ -199,6 +199,8 @@ add require './collections/memberPhoneNumbers'
 add require './collections/membersPreferences'
 add require './collections/memberStatistics'
 add require './collections/members'
+add require './collections/messageData'
+add require './collections/messages'
 add require './collections/opponents'
 add require './collections/opponentsResults'
 add require './collections/paymentNotes'