Implemented $firebaseAuth.$changeEmail()

Author: Jacob Wenger

changelog.txt

@@ -1,2 +1,3 @@
+feature - Added `$firebaseAuth.$changeEmail()` to change the email address associated with an existing account.
 deprecated - Passing in credentials to the user management methods of `$firebaseAuth` as individual arguments has been deprecated in favor of a single credentials argument.
 deprecated - Deprecated `$firebaseAuth.$sendPasswordResetEmail()` in favor of the functionally equivalent `$firebaseAuth.$resetPassword()`.

src/FirebaseAuth.js

@@ -51,6 +51,7 @@
         // User management methods
         $createUser: this.createUser.bind(this),
         $changePassword: this.changePassword.bind(this),
+        $changeEmail: this.changeEmail.bind(this),
         $removeUser: this.removeUser.bind(this),
         $resetPassword: this.resetPassword.bind(this),
         $sendPasswordResetEmail: this.sendPasswordResetEmail.bind(this)
@@ -303,7 +304,7 @@
      * Changes the password for an email/password user.
      *
      * @param {Object|string} emailOrCredentials The email of the user whose password is to change
-     * or an objet containing the email, old password, and new password of the user whose password
+     * or an object containing the email, old password, and new password of the user whose password
      * is to change.
      * @param {string} [oldPassword] The current password for the user.
      * @param {string} [newPassword] The new password for the user.
@@ -329,6 +330,21 @@
       return deferred.promise;
     },
 
+    /**
+     * Changes the email for an email/password user.
+     *
+     * @param {Object} credentials An object containing the old email, new email, and password of
+     * the user whose email is to change.
+     * @return {Promise<>} An empty promise fulfilled once the email change is complete.
+     */
+    changeEmail: function(credentials) {
+      var deferred = this._q.defer();
+
+      this._ref.changeEmail(credentials, this._utils.makeNodeResolver(deferred));
+
+      return deferred.promise;
+    },
+
     /**
      * Removes an email/password user.
      *

tests/unit/FirebaseAuth.spec.js

@@ -27,7 +27,7 @@ describe('FirebaseAuth',function(){
       ['authWithCustomToken','authAnonymously','authWithPassword',
         'authWithOAuthPopup','authWithOAuthRedirect','authWithOAuthToken',
         'unauth','getAuth','onAuth','offAuth',
-        'createUser','changePassword','removeUser','resetPassword'
+        'createUser','changePassword','changeEmail','removeUser','resetPassword'
       ]);
 
     inject(function(_$firebaseAuth_,_$timeout_){
@@ -197,7 +197,7 @@ describe('FirebaseAuth',function(){
       expect(result).toEqual('myResult');
     });
   });
-  
+
   describe('$authWithOAuthToken',function(){
     it('passes provider, token, and options object to underlying method',function(){
       var provider = 'facebook';
@@ -361,42 +361,95 @@ describe('FirebaseAuth',function(){
       expect(result).toEqual({uid:'1234'});
     });
   });
-  
-  describe('$changePassword()',function(){
-    it('passes email/password to method on backing ref (string args)',function(){
-      auth.$changePassword('[email protected]','54321','12345');
-      expect(ref.changePassword).toHaveBeenCalledWith(
-        {email:'[email protected]',oldPassword:'54321',newPassword:'12345'},
-        jasmine.any(Function));
-    });
 
-    it('passes email/password to method on backing ref (object arg)',function(){
-      auth.$changePassword({email:'[email protected]',oldPassword:'54321',newPassword:'12345'});
-      expect(ref.changePassword).toHaveBeenCalledWith(
-        {email:'[email protected]',oldPassword:'54321',newPassword:'12345'},
-        jasmine.any(Function));
-    });
-
-    it('will log a warning if deprecated string args are used',function(){
+  describe('$changePassword()',function() {
+    it('passes credentials to method on backing ref (string args)',function() {
+      auth.$changePassword('[email protected]','54321','12345');
+      expect(ref.changePassword).toHaveBeenCalledWith({
+        email: '[email protected]',
+        oldPassword: '54321',
+        newPassword: '12345'
+      }, jasmine.any(Function));
+    });
+
+    it('passes credentials to method on backing ref (object arg)',function() {
+      auth.$changePassword({
+        email: '[email protected]',
+        oldPassword: '54321',
+        newPassword: '12345'
+      });
+      expect(ref.changePassword).toHaveBeenCalledWith({
+        email:'[email protected]',
+        oldPassword: '54321',
+        newPassword: '12345'
+      }, jasmine.any(Function));
+    });
+
+    it('will log a warning if deprecated string args are used',function() {
       auth.$changePassword('[email protected]','54321','12345');
       expect(log.warn).toHaveLength(1);
     });
 
-    it('will reject the promise if authentication fails',function(){
-      wrapPromise(auth.$changePassword({email:'[email protected]',oldPassword:'54321',newPassword:'12345'}));
+    it('will reject the promise if authentication fails',function() {
+      wrapPromise(auth.$changePassword({
+        email:'[email protected]',
+        oldPassword: '54321',
+        newPassword: '12345'
+      }));
       callback('changePassword')("bad password");
       $timeout.flush();
       expect(failure).toEqual("bad password");
     });
 
-    it('will resolve the promise upon authentication',function(){
-      wrapPromise(auth.$changePassword('[email protected]','54321','12345'));
+    it('will resolve the promise upon authentication',function() {
+      wrapPromise(auth.$changePassword({
+        email: '[email protected]',
+        oldPassword: '54321',
+        newPassword: '12345'
+      }));
       callback('changePassword')(null);
       $timeout.flush();
       expect(status).toEqual('resolved');
     });
   });
-  
+
+  describe('$changeEmail()',function() {
+    it('passes credentials to method on backing reference', function() {
+      auth.$changeEmail({
+        oldEmail: '[email protected]',
+        newEmail: '[email protected]',
+        password: '12345'
+      });
+      expect(ref.changeEmail).toHaveBeenCalledWith({
+        oldEmail: '[email protected]',
+        newEmail: '[email protected]',
+        password: '12345'
+      }, jasmine.any(Function));
+    });
+
+    it('will reject the promise if authentication fails',function() {
+      wrapPromise(auth.$changeEmail({
+        oldEmail: '[email protected]',
+        newEmail: '[email protected]',
+        password: '12345'
+      }));
+      callback('changeEmail')("bad password");
+      $timeout.flush();
+      expect(failure).toEqual("bad password");
+    });
+
+    it('will resolve the promise upon authentication',function() {
+      wrapPromise(auth.$changeEmail({
+        oldEmail: '[email protected]',
+        newEmail: '[email protected]',
+        password: '12345'
+      }));
+      callback('changeEmail')(null);
+      $timeout.flush();
+      expect(status).toEqual('resolved');
+    });
+  });
+
   describe('$removeUser()',function(){
     it('passes email/password to method on backing ref (string args)',function(){
       auth.$removeUser('[email protected]','12345');
@@ -431,7 +484,7 @@ describe('FirebaseAuth',function(){
       expect(status).toEqual('resolved');
     });
   });
-  
+
   describe('$sendPasswordResetEmail()',function(){
     it('passes email to method on backing ref (string args)',function(){
       auth.$sendPasswordResetEmail('[email protected]');
@@ -451,7 +504,7 @@ describe('FirebaseAuth',function(){
       auth.$sendPasswordResetEmail({email:'[email protected]'});
       expect(log.warn).toHaveLength(1);
     });
-    
+
     it('will log two deprecation warnings if string arg is used',function(){
       auth.$sendPasswordResetEmail('[email protected]');
       expect(log.warn).toHaveLength(2);
@@ -471,7 +524,7 @@ describe('FirebaseAuth',function(){
       expect(status).toEqual('resolved');
     });
   });
-  
+
   describe('$resetPassword()',function(){
     it('passes email to method on backing ref (string args)',function(){
       auth.$resetPassword('[email protected]');
@@ -506,4 +559,4 @@ describe('FirebaseAuth',function(){
       expect(status).toEqual('resolved');
     });
   });
-});
+});