Merge pull request #118 from teamsnap/payment-transaction-changes

memberPaymentTransaction, persistence, tests, and docs

Author: amw3bb

CHANGELOG.md

@@ -1,8 +1,15 @@
 # TeamSnap JavaScript SDK CHANGELOG
 
+### Feb 26, 2016 // Version 1.11.0
+- Adds `memberPaymentTransaction` method.
+- Adds persistence wrapper to `memberPaymentTransaction` to reload `teamFee` and `memberBalance`.
+
+---
+
 ### Feb 17, 2016 // Version 1.10.0
 - Adds `inviteMemberEmailAddresses` method.
 - Lock down dependencies while we investigate upgrading to latest and greatest.
+
 ---
 
 ### Feb 15, 2016 // Version 1.9.0

docs/collections/member_payments.md

@@ -4,6 +4,7 @@
 
 - [loadMemberPayments](#loadMemberPayments)
 - [saveMemberPayment](#saveMemberPayment)
+- [memberPaymentTransaction](#memberPaymentTransaction)
 
 
 ---
@@ -47,3 +48,24 @@ Saves a `memberPayment` item.
 // Saves memberPayment item.
 teamsnap.saveMemberPayment(memberPayment);
 ```
+
+
+---
+
+
+<a id="memberPaymentTransaction"></a>
+## `memberPaymentTransaction(memberPaymentId, amount, note, callback)`
+Creates a `memberPaymentTransaction`.
+
+### Params
+* `memberPaymentId`: [id, object] - `memberPaymentId` or `memberPayment` item to be saved.
+* `amount`: [int, float] - The transaction amount.
+* `note`: [string] - A note for the transaction (optional).
+* `callback`: [function] - callback to be executed when the operation completes.
+
+### Examples
+```javascript
+// ~~~~~
+// Creates memberPaymentTransaction.
+teamsnap.memberPaymentTransaction(1, 5.00, 'paid by check');
+```

lib/teamsnap.js

@@ -1532,6 +1532,28 @@ exports.saveMemberPayment = function(memberPayment, callback) {
   return this.saveItem(memberPayment, callback);
 };
 
+exports.memberPaymentTransaction = function(memberPaymentId, amount, note, callback) {
+  var params;
+  if (!this.isItem(memberPaymentId)) {
+    throw new TSArgsError('teamsnap.memberPaymentTransaction', "must provide a `memberPaymentId`");
+  }
+  if (this.isItem(memberPaymentId)) {
+    memberPaymentId = memberPaymentId.id;
+  }
+  if (!amount) {
+    throw new TSArgsError('teamsnap.memberPaymentTransaction', "must provide an `amount`");
+  }
+  if (typeof note === 'function') {
+    callback = note;
+  }
+  params = {
+    memberPaymentId: memberPaymentId,
+    amount: amount,
+    note: note
+  };
+  return this.collections.memberPayments.exec('transaction', params).pop().callback(callback);
+};
+
 });
 
 require.register("collections/memberPhoneNumbers", function(exports, require, module) {
@@ -4738,7 +4760,7 @@ modifySDK = function(sdk) {
       }).callback(callback);
     };
   });
-  return wrapMethod(sdk, 'invite', function(invite) {
+  wrapMethod(sdk, 'invite', function(invite) {
     return function(options, callback) {
       return invite.call(this, options).then(function(result) {
         var contactId, memberId;
@@ -4760,6 +4782,22 @@ modifySDK = function(sdk) {
       }).callback(callback);
     };
   });
+  return wrapMethod(sdk, 'memberPaymentTransaction', function(memberPaymentTransaction) {
+    return function(memberPaymentId, amount, note, callback) {
+      return memberPaymentTransaction.call(this, memberPaymentId, amount, note).then(function(result) {
+        var memberId, teamFeeId;
+        memberId = result.memberId;
+        teamFeeId = result.teamFeeId;
+        return promises.when(sdk.loadMemberBalances({
+          memberId: memberId
+        }), sdk.loadTeamFees({
+          id: teamFeeId
+        })).then(function() {
+          return result;
+        });
+      }).callback(callback);
+    };
+  });
 };
 
 revertSDK = function(sdk) {
@@ -5805,7 +5843,7 @@ ref = require('./model'), Collection = ref.Collection, Item = ref.Item;
 require('./errors');
 
 TeamSnap = (function() {
-  TeamSnap.prototype.version = '1.10.0';
+  TeamSnap.prototype.version = '1.11.0';
 
   TeamSnap.prototype.promises = promises;
 

lib/teamsnap.min.js

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

package.json

@@ -19,3 +19,19 @@ exports.saveMemberPayment = (memberPayment, callback) ->
     return @reject 'You must choose a member.', 'memberId', callback
 
   @saveItem memberPayment, callback
+
+exports.memberPaymentTransaction = (memberPaymentId, amount, note, callback) ->
+  unless @isItem memberPaymentId
+    throw new TSArgsError 'teamsnap.memberPaymentTransaction', "must provide
+     a `memberPaymentId`"
+  if @isItem memberPaymentId
+    memberPaymentId = memberPaymentId.id
+  unless amount
+    throw new TSArgsError 'teamsnap.memberPaymentTransaction', "must provide
+     an `amount`"
+  if typeof note is 'function'
+    callback = note
+  params = memberPaymentId: memberPaymentId, amount: amount, note: note
+
+  @collections.memberPayments.exec('transaction', params)
+    .pop().callback callback

src/collections/memberPayments.coffee

@@ -193,6 +193,8 @@ modifySDK = (sdk) ->
   # 8. deleteTrackedItem needs to remove trackedItemStatuses
   # 9. deleteTeam needs to remove all related data except plan and sport
   # 10. deleteForumTopic needs to delete all related posts
+  # 11. memberEmailAddresses need to reload when invite is sent
+  # 12. teamFee and memberBalance needs to reload after transaction
 
   # Load related records when a member is created
   wrapSave sdk, 'saveMember', (member) ->
@@ -683,6 +685,19 @@ modifySDK = (sdk) ->
     ).callback callback
 
 
+  wrapMethod sdk, 'memberPaymentTransaction', (memberPaymentTransaction) ->
+    (memberPaymentId, amount, note, callback) ->
+      memberPaymentTransaction.call(this, memberPaymentId, amount, note)
+      .then((result) ->
+        memberId = result.memberId
+        teamFeeId = result.teamFeeId
+        promises.when(
+          sdk.loadMemberBalances(memberId: memberId)
+          sdk.loadTeamFees(id: teamFeeId)
+        ).then -> result
+      ).callback callback
+
+
 revertSDK = (sdk) ->
   revertWrapMethod sdk, 'saveMember'
   revertWrapMethod sdk, 'deleteMember'

src/persistence.coffee

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

src/teamsnap.coffee

@@ -1,7 +1,44 @@
+memberPayment = {}
+
 describe 'Member Payments', ->
 
-  it 'should be able to load all member payments for team', (done) ->
-    teamsnap.loadMemberPayments team.id, (err, result) ->
-      expect(err).to.be.null
-      result.should.be.an('array')
-      done()
+  beforeEach (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]
+    done()
+
+  describe 'loadMemberPayments', ->
+    it 'should be able to load all member payments for team', ->
+      teamsnap.loadMemberPayments team.id, (err, result) ->
+        expect(err).to.be.null
+        result.should.be.an('array')
+
+  describe 'memberPaymentTransaction', ->
+    it 'should accept a memberPayment object', ->
+      teamsnap.memberPaymentTransaction memberPayment, 4, (err, result) ->
+        result.id.should.equal 222
+
+    it 'should accept a memberPaymentId', ->
+      teamsnap.memberPaymentTransaction memberPayment.id, 10.00, (err, result) ->
+       result.id.should.equal 222
+
+    it 'should adjust memberPayment.amoutPaid', ->
+      teamsnap.memberPaymentTransaction memberPayment.id, 10.00, (err, result) ->
+        result.amountPaid.should.equal 90.00