feat(Status): Follower/Followee support attributes (#485)

Author: leeyeh

src/user.js

@@ -376,44 +376,56 @@ module.exports = function(AV) {
     /**
      * Follow a user
      * @since 0.3.0
-     * @param {AV.User | String} target The target user or user's objectId to follow.
-     * @param {AuthOptions} options
+     * @param {Object | AV.User | String} options if an AV.User or string is given, it will be used as the target user.
+     * @param {AV.User | String} options.user The target user or user's objectId to follow.
+     * @param {Object} [options.attributes] key-value attributes dictionary to be used as
+     *  conditions of followerQuery/followeeQuery.
+     * @param {AuthOptions} [authOptions]
      */
-    follow: function(target, options){
+    follow: function(options, authOptions){
       if(!this.id){
           throw new Error('Please signin.');
       }
-      if(!target){
-          throw new Error('Invalid target user.');
+      let user;
+      let attributes;
+      if (options.user) {
+        user = options.user;
+        attributes = options.attributes;
+      } else {
+        user = options;
       }
-      var userObjectId = _.isString(target) ? target: target.id;
+      var userObjectId = _.isString(user) ? user: user.id;
       if(!userObjectId){
           throw new Error('Invalid target user.');
       }
       var route = 'users/' + this.id + '/friendship/' + userObjectId;
-      var request = AVRequest(route, null, null, 'POST', null, options);
+      var request = AVRequest(route, null, null, 'POST', AV._encode(attributes), authOptions);
       return request;
     },
 
     /**
      * Unfollow a user.
      * @since 0.3.0
-     * @param {AV.User | String} target The target user or user's objectId to unfollow.
-     * @param {AuthOptions} options
+     * @param {Object | AV.User | String} options if an AV.User or string is given, it will be used as the target user.
+     * @param {AV.User | String} options.user The target user or user's objectId to unfollow.
+     * @param {AuthOptions} [authOptions]
      */
-    unfollow: function(target, options){
+    unfollow: function(options, authOptions){
       if(!this.id){
           throw new Error('Please signin.');
       }
-      if(!target){
-          throw new Error('Invalid target user.');
+      let user;
+      if (options.user) {
+        user = options.user;
+      } else {
+        user = options;
       }
-      var userObjectId = _.isString(target) ? target: target.id;
+      var userObjectId = _.isString(user) ? user : user.id;
       if(!userObjectId){
           throw new Error('Invalid target user.');
       }
       var route = 'users/' + this.id + '/friendship/' + userObjectId;
-      var request = AVRequest(route, null, null, 'DELETE', null, options);
+      var request = AVRequest(route, null, null, 'DELETE', null, authOptions);
       return request;
     },
 

storage.d.ts

@@ -491,6 +491,8 @@ declare namespace AV {
         interface GetOptions extends AuthOptions { }
     }
 
+    class FriendShipQuery extends Query {}
+
     /**
      * Represents a Role on the AV server. Roles represent groupings of
      * Users for the purposes of granting permissions (e.g. specifying an ACL
@@ -526,28 +528,32 @@ declare namespace AV {
     export class User extends Object {
 
         static current(): User;
-        static signUp<T>(username: string, password: string, attrs: any, options?: AuthOptions): Promise<T>;
-        static logIn<T>(username: string, password: string, options?: AuthOptions): Promise<T>;
-        static logOut<T>(): Promise<T>;
-        static become<T>(sessionToken: string, options?: AuthOptions): Promise<T>;
-
-        static loginWithWeapp<T>(): Promise<T>;
-        static logInWithMobilePhone<T>(mobilePhone: string, password: string, options?: AuthOptions): Promise<T>;
-        static logInWithMobilePhoneSmsCode<T>(mobilePhone: string, smsCode: string, options?: AuthOptions): Promise<T>;
-        static signUpOrlogInWithAuthData<T>(data: any, platform: string, options?: AuthOptions): Promise<T>;
-        static signUpOrlogInWithMobilePhone<T>(mobilePhoneNumber: string, smsCode: string, attributes?: any, options?: AuthOptions): Promise<T>;
-        static requestEmailVerify<T>(email: string, options?: AuthOptions): Promise<T>;
+        static signUp(username: string, password: string, attrs: any, options?: AuthOptions): Promise<User>;
+        static logIn(username: string, password: string, options?: AuthOptions): Promise<User>;
+        static logOut(): Promise<User>;
+        static become(sessionToken: string, options?: AuthOptions): Promise<User>;
+
+        static loginWithWeapp(): Promise<User>;
+        static logInWithMobilePhone(mobilePhone: string, password: string, options?: AuthOptions): Promise<User>;
+        static logInWithMobilePhoneSmsCode(mobilePhone: string, smsCode: string, options?: AuthOptions): Promise<User>;
+        static signUpOrlogInWithAuthData(data: any, platform: string, options?: AuthOptions): Promise<User>;
+        static signUpOrlogInWithMobilePhone(mobilePhoneNumber: string, smsCode: string, attributes?: any, options?: AuthOptions): Promise<User>;
+        static requestEmailVerify(email: string, options?: AuthOptions): Promise<User>;
         static requestLoginSmsCode(mobilePhoneNumber: string, options?: SMSAuthOptions): Promise<void>;
         static requestMobilePhoneVerify(mobilePhoneNumber: string, options?: SMSAuthOptions): Promise<void>;
-        static requestPasswordReset<T>(email: string, options?: AuthOptions): Promise<T>;
+        static requestPasswordReset(email: string, options?: AuthOptions): Promise<User>;
         static requestPasswordResetBySmsCode(mobilePhoneNumber: string, options?: SMSAuthOptions): Promise<void>;
-        static resetPasswordBySmsCode<T>(code: string, password: string, options?: AuthOptions): Promise<T>;
-        static verifyMobilePhone<T>(code: string, options?: AuthOptions): Promise<T>;
-        signUp<T>(attrs?: any, options?: AuthOptions): Promise<T>;
-        logIn<T>(options?: AuthOptions): Promise<T>;
-        linkWithWeapp<T>(): Promise<T>;
-        fetch<T>(options?: AuthOptions): Promise<T>;
-        save<T>(arg1?: any, arg2?: any, arg3?: any): Promise<T>;
+        static resetPasswordBySmsCode(code: string, password: string, options?: AuthOptions): Promise<User>;
+        static verifyMobilePhone(code: string, options?: AuthOptions): Promise<User>;
+
+        static followerQuery(userObjectId: string): FriendShipQuery;
+        static followeeQuery(userObjectId: string): FriendShipQuery;
+
+        signUp(attrs?: any, options?: AuthOptions): Promise<User>;
+        logIn(options?: AuthOptions): Promise<User>;
+        linkWithWeapp(): Promise<User>;
+        fetch(options?: AuthOptions): Promise<User>;
+        save(arg1?: any, arg2?: any, arg3?: any): Promise<User>;
         isAuthenticated(): Promise<boolean>;
         isCurrent(): boolean;
 
@@ -566,7 +572,13 @@ declare namespace AV {
         refreshSessionToken(options?: AuthOptions): Promise<User>;
 
         getRoles(options?: AuthOptions): Promise<Role>;
-    
+        
+        follow(user: User|string, authOptions?: AuthOptions): Promise<void>;
+        follow(options: { user: User|string, attributes?: Object}, authOptions?: AuthOptions): Promise<void>;
+        unfollow(user: User|string, authOptions?: AuthOptions): Promise<void>;
+        unfollow(options: { user: User|string }, authOptions?: AuthOptions): Promise<void>;
+        followerQuery(): FriendShipQuery;
+        followeeQuery(): FriendShipQuery;
   }
 
     export class Captcha {

test/status.js

@@ -64,15 +64,27 @@ describe("AV.Status",function(){
 
   describe("Status guide test.", function(){
     it("should follow/unfollow successfully.", function(){
-      return AV.User.current().follow(targetUser).then(function(){
+      return AV.User.current().follow({
+        user: targetUser,
+        attributes: {
+          group: 1,
+          position: new AV.GeoPoint(0,0),
+        },
+      }).then(function(){
         var query = AV.User.current().followeeQuery();
+        query.equalTo('group', 1);
         query.include('followee');
         return query.find();
       }).then(function(followees){
         debug(followees);
         expect(followees.length).to.be(1);
         expect(followees[0].id).to.be(targetUser);
         expect(followees[0].get('username')).to.be('leeyeh');
+        var query = AV.User.current().followeeQuery();
+        query.equalTo('group', 0);
+        return query.find();
+      }).then(function(followees){
+        expect(followees.length).to.be(0);
         return AV.User.current().unfollow(targetUser);
       }).then(function(){
         var query = AV.User.current().followeeQuery();