remove uses of email field on User

Author: mugoh

migrations/20140924113530_dumped_migration_1/up.sql

@@ -3,4 +3,5 @@ CREATE TABLE users (
             email           VARCHAR NOT NULL UNIQUE,
             gh_access_token VARCHAR NOT NULL,
             api_token       VARCHAR NOT NULL
-        );
+        );
+

migrations/2019-11-11-162609_drop_email_from_user/down.sql

@@ -0,0 +1 @@
+-- Not reversible

migrations/2019-11-11-162609_drop_email_from_user/up.sql

@@ -0,0 +1,2 @@
+-- Your SQL goes here
+ALTER TABLE  users DROP COLUMN email CASCADE;

src/controllers/user/me.rs

@@ -38,10 +38,10 @@ pub fn me(req: &mut dyn Request) -> CargoResult<Response> {
 
     let verified = verified.unwrap_or(false);
     let verification_sent = verified || verification_sent;
-    let user = User { email, ..user };
+    let user = User { ..user };
 
     Ok(req.json(&EncodableMe {
-        user: user.encodable_private(verified, verification_sent),
+        user: user.encodable_private(email, verified, verification_sent)?,
     }))
 }
 
@@ -91,8 +91,7 @@ pub fn updates(req: &mut dyn Request) -> CargoResult<Response> {
 /// Handles the `PUT /user/:user_id` route.
 pub fn update_user(req: &mut dyn Request) -> CargoResult<Response> {
     use self::emails::user_id;
-    use self::users::dsl::{email, gh_login, users};
-    use diesel::{insert_into, update};
+    use diesel::insert_into;
 
     let mut body = String::new();
     req.body().read_to_string(&mut body)?;
@@ -130,10 +129,6 @@ pub fn update_user(req: &mut dyn Request) -> CargoResult<Response> {
     }
 
     conn.transaction::<_, Box<dyn CargoError>, _>(|| {
-        update(users.filter(gh_login.eq(&user.gh_login)))
-            .set(email.eq(user_email))
-            .execute(&*conn)?;
-
         let new_email = NewEmail {
             user_id: user.id,
             email: user_email,

src/controllers/user/session.rs

@@ -118,12 +118,11 @@ impl GithubUser {
         NewUser::new(
             self.id,
             &self.login,
-            self.email.as_ref().map(|s| &s[..]),
             self.name.as_ref().map(|s| &s[..]),
             self.avatar_url.as_ref().map(|s| &s[..]),
             access_token,
         )
-        .create_or_update(conn)
+        .create_or_update(self.email.as_ref().map(|s| &s[..]), conn)
         .map_err(Into::into)
         .or_else(|e: Box<dyn CargoError>| {
             // If we're in read only mode, we can't update their details

src/models/user.rs

@@ -13,20 +13,19 @@ use crate::views::{EncodablePrivateUser, EncodablePublicUser};
 #[derive(Clone, Debug, PartialEq, Eq, Queryable, Identifiable, AsChangeset, Associations)]
 pub struct User {
     pub id: i32,
-    pub email: Option<String>,
     pub gh_access_token: String,
     pub gh_login: String,
     pub name: Option<String>,
     pub gh_avatar: Option<String>,
     pub gh_id: i32,
 }
 
+/// Represents a new user record insertible to the `users` table
 #[derive(Insertable, Debug, Default)]
 #[table_name = "users"]
 pub struct NewUser<'a> {
     pub gh_id: i32,
     pub gh_login: &'a str,
-    pub email: Option<&'a str>,
     pub name: Option<&'a str>,
     pub gh_avatar: Option<&'a str>,
     pub gh_access_token: Cow<'a, str>,
@@ -36,23 +35,25 @@ impl<'a> NewUser<'a> {
     pub fn new(
         gh_id: i32,
         gh_login: &'a str,
-        email: Option<&'a str>,
         name: Option<&'a str>,
         gh_avatar: Option<&'a str>,
         gh_access_token: &'a str,
     ) -> Self {
         NewUser {
             gh_id,
             gh_login,
-            email,
             name,
             gh_avatar,
             gh_access_token: Cow::Borrowed(gh_access_token),
         }
     }
 
     /// Inserts the user into the database, or updates an existing one.
-    pub fn create_or_update(&self, conn: &PgConnection) -> QueryResult<User> {
+    pub fn create_or_update(
+        &self,
+        email: Option<&'a str>,
+        conn: &PgConnection,
+    ) -> QueryResult<User> {
         use crate::schema::users::dsl::*;
         use diesel::dsl::sql;
         use diesel::insert_into;
@@ -81,7 +82,7 @@ impl<'a> NewUser<'a> {
                 .get_result::<User>(conn)?;
 
             // To send the user an account verification email...
-            if let Some(user_email) = user.email.as_ref() {
+            if let Some(user_email) = email {
                 let new_email = NewEmail {
                     user_id: user.id,
                     email: user_email,
@@ -168,6 +169,8 @@ impl User {
         Ok(best)
     }
 
+    /// Queries the database for the verified emails
+    /// belonging to a given user
     pub fn verified_email(&self, conn: &PgConnection) -> CargoResult<Option<String>> {
         Ok(Email::belonging_to(self)
             .select(emails::email)
@@ -179,19 +182,21 @@ impl User {
     /// Converts this `User` model into an `EncodablePrivateUser` for JSON serialization.
     pub fn encodable_private(
         self,
+        email: Option<String>,
+
         email_verified: bool,
         email_verification_sent: bool,
-    ) -> EncodablePrivateUser {
+    ) -> CargoResult<EncodablePrivateUser> {
         let User {
             id,
-            email,
             name,
             gh_login,
             gh_avatar,
             ..
         } = self;
         let url = format!("https://github.com/{}", gh_login);
-        EncodablePrivateUser {
+
+        Ok(EncodablePrivateUser {
             id,
             email,
             email_verified,
@@ -200,7 +205,15 @@ impl User {
             login: gh_login,
             name,
             url: Some(url),
-        }
+        })
+    }
+
+    /// Queries for the email belonging to a particular user
+    pub fn email(&self, conn: &PgConnection) -> CargoResult<Option<String>> {
+        Ok(Email::belonging_to(self)
+            .select(emails::email)
+            .first::<String>(&*conn)
+            .optional()?)
     }
 
     /// Converts this`User` model into an `EncodablePublicUser` for JSON serialization.

src/schema.rs

@@ -745,12 +745,6 @@ table! {
         ///
         /// (Automatically generated by Diesel.)
         id -> Int4,
-        /// The `email` column of the `users` table.
-        ///
-        /// Its SQL type is `Nullable<Varchar>`.
-        ///
-        /// (Automatically generated by Diesel.)
-        email -> Nullable<Varchar>,
         /// The `gh_access_token` column of the `users` table.
         ///
         /// Its SQL type is `Varchar`.

src/views.rs

@@ -161,10 +161,10 @@ pub struct EncodableMe {
 pub struct EncodablePrivateUser {
     pub id: i32,
     pub login: String,
-    pub email: Option<String>,
     pub email_verified: bool,
     pub email_verification_sent: bool,
     pub name: Option<String>,
+    pub email: Option<String>,
     pub avatar: Option<String>,
     pub url: Option<String>,
 }