Merge pull request #442 from firebase/jw-login-v2

Updated authentication methods to login v2

Author: katowulf

.jshintrc

@@ -1,20 +1,18 @@
 {
   "predef": [
     "angular",
-    "Firebase",
-    "FirebaseSimpleLogin"
+    "Firebase"
   ],
   "bitwise": true,
   "browser": true,
   "curly": true,
   "forin": true,
   "indent": 2,
   "latedef": true,
-  "maxlen": 115,
   "noempty": true,
   "nonbsp": true,
   "strict": true,
   "trailing": true,
   "undef": true,
   "unused": true
-}
+}

README.md

@@ -96,6 +96,6 @@ tests, run `grunt test:unit`. To only run the end-to-end [Protractor](https://gi
 tests, run `grunt test:e2e`.
 
 In addition to the automated test suite, there is an additional manual test suite that ensures that
-the `$firebaseSimpleLogin` service is working properly with the authentication providers. These tests
-can be run with `grunt test:manual`. Note that you must click "Close this window", login to Twitter,
+the `$firebaseUser` service is working properly with the authentication providers. These tests can
+be run with `grunt test:manual`. Note that you must click "Close this window", login to Twitter,
 etc. when prompted in order for these tests to complete successfully.

bower.json

@@ -31,8 +31,7 @@
   ],
   "dependencies": {
     "angular": "1.2.x || 1.3.x",
-    "firebase": "1.0.x",
-    "firebase-simple-login": "1.6.x"
+    "firebase": "2.0.x"
   },
   "devDependencies": {
     "lodash": "~2.4.1",

package.json

@@ -31,7 +31,7 @@
     "package.json"
   ],
   "dependencies": {
-    "firebase": "1.0.x"
+    "firebase": "2.0.x"
   },
   "devDependencies": {
     "coveralls": "^2.11.1",

src/FirebaseAuth.js

@@ -0,0 +1,270 @@
+/* istanbul ignore next */
+(function() {
+  'use strict';
+  var FirebaseAuth;
+
+  // Define a service which provides user authentication and management.
+  angular.module('firebase').factory('$firebaseAuth', [
+    '$q', function($q) {
+      // This factory returns an object containing the current authentication state of the client.
+      // This service takes one argument:
+      //
+      //   * `ref`: A Firebase reference.
+      //
+      // The returned object contains methods for authenticating clients, retrieving authentication
+      // state, and managing users.
+      return function(ref) {
+        var auth = new FirebaseAuth($q, ref);
+        return auth.construct();
+      };
+    }
+  ]);
+
+  FirebaseAuth = function($q, ref) {
+    this._q = $q;
+
+    if (typeof ref === 'string') {
+      throw new Error('Please provide a Firebase reference instead of a URL when creating a `$firebaseAuth` object.');
+    }
+    this._ref = ref;
+  };
+
+  FirebaseAuth.prototype = {
+    construct: function() {
+      this._object = {
+        // Authentication methods
+        $authWithCustomToken: this.authWithCustomToken.bind(this),
+        $authAnonymously: this.authAnonymously.bind(this),
+        $authWithPassword: this.authWithPassword.bind(this),
+        $authWithOAuthPopup: this.authWithOAuthPopup.bind(this),
+        $authWithOAuthRedirect: this.authWithOAuthRedirect.bind(this),
+        $authWithOAuthToken: this.authWithOAuthToken.bind(this),
+        $unauth: this.unauth.bind(this),
+
+        // Authentication state methods
+        $onAuth: this.onAuth.bind(this),
+        $getAuth: this.getAuth.bind(this),
+        $requireAuth: this.requireAuth.bind(this),
+        $waitForAuth: this.waitForAuth.bind(this),
+
+        // User management methods
+        $createUser: this.createUser.bind(this),
+        $changePassword: this.changePassword.bind(this),
+        $removeUser: this.removeUser.bind(this),
+        $sendPasswordResetEmail: this.sendPasswordResetEmail.bind(this)
+      };
+
+      return this._object;
+    },
+
+
+    /********************/
+    /*  Authentication  */
+    /********************/
+    // Common login completion handler for all authentication methods.
+    _onLoginHandler: function(deferred, error, authData) {
+      if (error !== null) {
+        deferred.reject(error);
+      } else {
+        deferred.resolve(authData);
+      }
+    },
+
+    // Authenticates the Firebase reference with a custom authentication token.
+    authWithCustomToken: function(authToken) {
+      var deferred = this._q.defer();
+
+      this._ref.authWithCustomToken(authToken, this._onLoginHandler.bind(this, deferred));
+
+      return deferred.promise;
+    },
+
+    // Authenticates the Firebase reference anonymously.
+    authAnonymously: function(options) {
+      var deferred = this._q.defer();
+
+      this._ref.authAnonymously(this._onLoginHandler.bind(this, deferred), options);
+
+      return deferred.promise;
+    },
+
+    // Authenticates the Firebase reference with an email/password user.
+    authWithPassword: function(credentials, options) {
+      var deferred = this._q.defer();
+
+      this._ref.authWithPassword(credentials, this._onLoginHandler.bind(this, deferred), options);
+
+      return deferred.promise;
+    },
+
+    // Authenticates the Firebase reference with the OAuth popup flow.
+    authWithOAuthPopup: function(provider, options) {
+      var deferred = this._q.defer();
+
+      this._ref.authWithOAuthPopup(provider, this._onLoginHandler.bind(this, deferred), options);
+
+      return deferred.promise;
+    },
+
+    // Authenticates the Firebase reference with the OAuth redirect flow.
+    authWithOAuthRedirect: function(provider, options) {
+      var deferred = this._q.defer();
+
+      this._ref.authWithOAuthRedirect(provider, this._onLoginHandler.bind(this, deferred), options);
+
+      return deferred.promise;
+    },
+
+    // Authenticates the Firebase reference with an OAuth token.
+    authWithOAuthToken: function(provider, credentials, options) {
+      var deferred = this._q.defer();
+
+      this._ref.authWithOAuthToken(provider, credentials, this._onLoginHandler.bind(this, deferred), options);
+
+      return deferred.promise;
+    },
+
+    // Unauthenticates the Firebase reference.
+    unauth: function() {
+      if (this.getAuth() !== null) {
+        this._ref.unauth();
+      }
+    },
+
+
+    /**************************/
+    /*  Authentication State  */
+    /**************************/
+    // Asynchronously fires the provided callback with the current authentication data every time
+    // the authentication data changes. It also fires as soon as the authentication data is
+    // retrieved from the server.
+    onAuth: function(callback) {
+      var self = this;
+
+      this._ref.onAuth(callback);
+
+      // Return a method to detach the `onAuth()` callback.
+      return function() {
+        self._ref.offAuth(callback);
+      };
+    },
+
+    // Synchronously retrieves the current authentication data.
+    getAuth: function() {
+      return this._ref.getAuth();
+    },
+
+    // Helper onAuth() callback method for the two router-related methods.
+    _routerMethodOnAuthCallback: function(deferred, rejectIfAuthDataIsNull, authData) {
+      if (authData !== null) {
+        deferred.resolve(authData);
+      } else if (rejectIfAuthDataIsNull) {
+        deferred.reject("AUTH_REQUIRED");
+      } else {
+        deferred.resolve(null);
+      }
+
+      // Turn off this onAuth() callback since we just needed to get the authentication data once.
+      this._ref.offAuth(this._routerMethodOnAuthCallback);
+    },
+
+    // Returns a promise which is resolved if the client is authenticated and rejects otherwise.
+    // This can be used to require that a route has a logged in user.
+    requireAuth: function() {
+      var deferred = this._q.defer();
+
+      this._ref.onAuth(this._routerMethodOnAuthCallback.bind(this, deferred, /* rejectIfAuthDataIsNull */ true));
+
+      return deferred.promise;
+    },
+
+    // Returns a promise which is resolved with the client's current authenticated data. This can
+    // be used in a route's resolve() method to grab the current authentication data.
+    waitForAuth: function() {
+      var deferred = this._q.defer();
+
+      this._ref.onAuth(this._routerMethodOnAuthCallback.bind(this, deferred, /* rejectIfAuthDataIsNull */ false));
+
+      return deferred.promise;
+    },
+
+
+    /*********************/
+    /*  User Management  */
+    /*********************/
+    // Creates a new email/password user. Note that this function only creates the user, if you
+    // wish to log in as the newly created user, call $authWithPassword() after the promise for
+    // this method has been resolved.
+    createUser: function(email, password) {
+      var deferred = this._q.defer();
+
+      this._ref.createUser({
+        email: email,
+        password: password
+      }, function(error) {
+        if (error !== null) {
+          deferred.reject(error);
+        } else {
+          deferred.resolve();
+        }
+      });
+
+      return deferred.promise;
+    },
+
+    // Changes the password for an email/password user.
+    changePassword: function(email, oldPassword, newPassword) {
+      var deferred = this._q.defer();
+
+      this._ref.changePassword({
+        email: email,
+        oldPassword: oldPassword,
+        newPassword: newPassword
+      }, function(error) {
+          if (error !== null) {
+            deferred.reject(error);
+          } else {
+            deferred.resolve();
+          }
+        }
+      );
+
+      return deferred.promise;
+    },
+
+    // Removes an email/password user.
+    removeUser: function(email, password) {
+      var deferred = this._q.defer();
+
+      this._ref.removeUser({
+        email: email,
+        password: password
+      }, function(error) {
+        if (error !== null) {
+          deferred.reject(error);
+        } else {
+          deferred.resolve();
+        }
+      });
+
+      return deferred.promise;
+    },
+
+    // Sends a password reset email to an email/password user.
+    sendPasswordResetEmail: function(email) {
+      var deferred = this._q.defer();
+
+      this._ref.resetPassword({
+        email: email
+      }, function(error) {
+        if (error !== null) {
+          deferred.reject(error);
+        } else {
+          deferred.resolve();
+        }
+      });
+
+      return deferred.promise;
+    }
+  };
+})();