From 49a850733c8eef078fd6a0788e4477fc29ccb5cc Mon Sep 17 00:00:00 2001
From: Shane Tomlinson <stomlinson@mozilla.com>
Date: Tue, 11 Oct 2011 10:52:24 +0100
Subject: [PATCH] clarifying function names in user.js
Renaming: waitForUserRegistration->waitForUserValidation
emailRegistered->isEmailRegistered
waitForEmailRegistration->waitForEmailValidation
Updating calls in the controllers.
Adding a test for isEmailRegistered with a non-registered email.
---
.../controllers/authenticate_controller.js | 2 +-
.../dialog/controllers/dialog_controller.js | 4 +--
.../controllers/pickemail_controller.js | 2 +-
browserid/static/dialog/resources/user.js | 15 +++++---
.../dialog/test/qunit/user_unit_test.js | 34 +++++++++++++------
5 files changed, 38 insertions(+), 19 deletions(-)
diff --git a/browserid/static/dialog/controllers/authenticate_controller.js b/browserid/static/dialog/controllers/authenticate_controller.js
index c6ee45909..ee62a1988 100644
--- a/browserid/static/dialog/controllers/authenticate_controller.js
+++ b/browserid/static/dialog/controllers/authenticate_controller.js
@@ -52,7 +52,7 @@
return;
}
- user.emailRegistered(email, function onComplete(registered) {
+ user.isEmailRegistered(email, function onComplete(registered) {
if(registered) {
enterPasswordState.call(self);
}
diff --git a/browserid/static/dialog/controllers/dialog_controller.js b/browserid/static/dialog/controllers/dialog_controller.js
index 8f8e08e03..1d8224aec 100644
--- a/browserid/static/dialog/controllers/dialog_controller.js
+++ b/browserid/static/dialog/controllers/dialog_controller.js
@@ -135,7 +135,7 @@
this.element.checkregistration({
email: email,
- verifier: "waitForUserRegistration",
+ verifier: "waitForUserValidation",
verificationMessage: "user_confirmed"
});
},
@@ -166,7 +166,7 @@
this.element.checkregistration({
email: email,
- verifier: "waitForEmailRegistration",
+ verifier: "waitForEmailValidation",
verificationMessage: "email_confirmed"
});
},
diff --git a/browserid/static/dialog/controllers/pickemail_controller.js b/browserid/static/dialog/controllers/pickemail_controller.js
index 64e1b6fde..49e6a018c 100644
--- a/browserid/static/dialog/controllers/pickemail_controller.js
+++ b/browserid/static/dialog/controllers/pickemail_controller.js
@@ -127,7 +127,7 @@
return;
}
- user.emailRegistered(email, function onComplete(registered) {
+ user.isEmailRegistered(email, function onComplete(registered) {
if(registered) {
bid.Tooltip.showTooltip("#already_taken");
}
diff --git a/browserid/static/dialog/resources/user.js b/browserid/static/dialog/resources/user.js
index c42be0c21..8bf2da890 100644
--- a/browserid/static/dialog/resources/user.js
+++ b/browserid/static/dialog/resources/user.js
@@ -182,12 +182,12 @@ BrowserID.User = (function() {
/**
* Poll the server until user registration is complete.
- * @method waitForUserRegistration
+ * @method waitForUserValidation
* @param {string} email - email address to check.
* @param {function} [onSuccess] - Called to give status updates.
* @param {function} [onFailure] - Called on error.
*/
- waitForUserRegistration: function(email, onSuccess, onFailure) {
+ waitForUserValidation: function(email, onSuccess, onFailure) {
registrationPoll(network.checkUserRegistration, email, onSuccess, onFailure);
},
@@ -413,7 +413,7 @@ BrowserID.User = (function() {
* otw.
* @param {function} [onFailure] - Called on XHR failure.
*/
- emailRegistered: function(email, onSuccess, onFailure) {
+ isEmailRegistered: function(email, onSuccess, onFailure) {
network.emailRegistered(email, onSuccess, onFailure);
},
@@ -441,7 +441,14 @@ BrowserID.User = (function() {
}, onFailure);
},
- waitForEmailRegistration: function(email, onSuccess, onFailure) {
+ /**
+ * Wait for the email registration to complete
+ * @method waitForEmailValidation
+ * @param {string} email - email address to check.
+ * @param {function} [onSuccess] - Called to give status updates.
+ * @param {function} [onFailure] - Called on error.
+ */
+ waitForEmailValidation: function(email, onSuccess, onFailure) {
registrationPoll(network.checkEmailRegistration, email, onSuccess, onFailure);
},
diff --git a/browserid/static/dialog/test/qunit/user_unit_test.js b/browserid/static/dialog/test/qunit/user_unit_test.js
index 1b1fb1cbc..eeb4d71bb 100644
--- a/browserid/static/dialog/test/qunit/user_unit_test.js
+++ b/browserid/static/dialog/test/qunit/user_unit_test.js
@@ -210,22 +210,22 @@ steal.plugins("jquery", "funcunit/qunit").then("/dialog/resources/user", functio
stop();
});
- test("waitForUserRegistration with success response", function() {
- lib.waitForUserRegistration("testuser@testuser.com", function() {
+ test("waitForUserValidation with success response", function() {
+ lib.waitForUserValidation("testuser@testuser.com", function() {
ok(true);
start();
- }, failure("waitForUserRegistration failure"));
+ }, failure("waitForUserValidation failure"));
stop();
});
- test("waitForUserRegistration with mustAuth response", function() {
+ test("waitForUserValidation with mustAuth response", function() {
registrationResponse = "mustAuth";
- lib.waitForUserRegistration("testuser@testuser.com", function() {
+ lib.waitForUserValidation("testuser@testuser.com", function() {
ok(true);
start();
- }, failure("waitForUserRegistration failure"));
+ }, failure("waitForUserValidation failure"));
stop();
});
@@ -406,8 +406,8 @@ steal.plugins("jquery", "funcunit/qunit").then("/dialog/resources/user", functio
});
- test("emailRegistered with registered email", function() {
- lib.emailRegistered("registered", function(registered) {
+ test("isEmailRegistered with registered email", function() {
+ lib.isEmailRegistered("registered", function(registered) {
ok(registered);
start();
}, function onFailure() {
@@ -418,6 +418,18 @@ steal.plugins("jquery", "funcunit/qunit").then("/dialog/resources/user", functio
stop();
});
+ test("isEmailRegistered with non-registered email", function() {
+ lib.isEmailRegistered("nonregistered", function(registered) {
+ equal(registered, false);
+ start();
+ }, function onFailure() {
+ ok(false);
+ start();
+ });
+
+ stop();
+ });
+
test("addEmail", function() {
lib.addEmail("testemail@testemail.com", function(added) {
ok(added, "user was added");
@@ -432,11 +444,11 @@ steal.plugins("jquery", "funcunit/qunit").then("/dialog/resources/user", functio
});
- test("waitForEmailRegistration", function() {
- lib.waitForEmailRegistration("testuser@testuser.com", function() {
+ test("waitForEmailValidation", function() {
+ lib.waitForEmailValidation("testuser@testuser.com", function() {
ok(true);
start();
- }, failure("waitForEmailRegistration failure"));
+ }, failure("waitForEmailValidation failure"));
stop();
});
--
GitLab