Merge from demo branch

.gitignore

@@ -22,4 +22,7 @@ build
 copy-test
 deploy-test
 deploy2coppa
+dbupdate.sh
 /CloudSession-Templates.tar.gz
+/copy-test
+/deploy2coppa

app/Email/services.py

@@ -40,7 +40,7 @@ def send_email_template_for_user(id_user, template, server, **kwargs):
     params['sponsoremail'] = user.parent_email
     params['blocklyprop-host'] = app.config['CLOUD_SESSION_PROPERTIES']['response.host']
 
-    #Default the recipient email address
+    # Default the recipient email address
     user_email = user.email
     coppa = Coppa()
 
@@ -70,7 +70,13 @@ def send_email_template_for_user(id_user, template, server, **kwargs):
         send_email_template_to_address(user.parent_email, 'reset-coppa', server, user.locale, params)
         return
     else:
-        # Registration not subject to COPPA regulations
+        # Registration not subject to COPPA regulations.
+        #
+        # Evaluate user wanting to use an alternate email address to register
+        # the account.
+        if user.parent_email_source == SponsorType.INDIVIDUAL or user.parent_email:
+            user_email = user.parent_email
+
         send_email_template_to_address(user_email, template, server, user.locale, params)
 
     return
@@ -96,15 +102,26 @@ def send_email_template_to_address(recipient, template, server, locale, params=N
 
 
 def send_email(recipient, subject, email_text, rich_email_text=None):
-
+    logging.info('Creating email message package')
     msg = Message(
         recipients=[recipient],
         subject=subject.rstrip(),
         body=email_text,
         html=rich_email_text,
         sender=app.config['DEFAULT_MAIL_SENDER']
     )
-    mail.send(msg)
+
+    # Attempt to send the email
+    try:
+        logging.info('Sending email message to server')
+        mail.send(msg)
+    except Exception as ex:
+        logging.error('Unable to send email')
+        logging.error('Error message: %s', ex.message)
+        return 1
+
+    logging.info('Email message was delivered to server')
+    return 0
 
 
 def _read_templates(template, server, locale, params):

app/LocalUser/controllers.py

@@ -18,11 +18,26 @@
 
 
 class DoConfirm(Resource):
+    """
+    Confirm and activate a user account.
+
+    Args:
+        None
+
+    Returns:
+        A JSON document with the key 'success' set to True if the operation
+        is successful. Otherwise the key 'success' is set to False and the
+        field 'code' is set to the HTTP error code that represents a specific
+        reason when the account confirmation was rejected.
+
+    Raises:
+        None
+    """
 
     def post(self):
         # Get values
-        email = request.form.get('email')
-        token = request.form.get('token')
+        email = request.form.get('email')   # User account email address
+        token = request.form.get('token')   # Token assigned to account during account registration
 
         # Validate required fields
         validation = Validation()
@@ -52,9 +67,13 @@ def post(self):
             # Token is not for this user
             return {'success': False, 'code': 510}
 
+        # Set user account status to 'Confirmed'
         user.confirmed = True
 
+        # Delete the account confirmation token; it is no longer required
         db.session.delete(confirm_token)
+
+        # Commit the user account changes
         db.session.commit()
 
         logging.info('LocalUser-controller: DoConfirm: success: %s', user.id)
@@ -63,6 +82,15 @@ def post(self):
 
 
 class RequestConfirm(Resource):
+    """
+    Send account confirmation request email to user
+
+    Args:
+        param1: User account email address
+
+    Returns:
+        JSON document detailing the success or failure of the request.
+    """
 
     def get(self, email):
         # Get server URL

app/__init__.py

@@ -25,7 +25,15 @@
 app = Flask(__name__)
 
 # Application version (major,minor,patch-level)
-version = "1.1.2"
+version = "1.1.3"
+
+"""
+Change Log
+
+1.1.3       Added documentation around the user account registration process.
+
+"""
+
 db = None
 
 # Load basic configurations

database/create_cloudsession_database.sql

@@ -0,0 +1,7 @@
+/*
+ * Create the cloudsession database
+ */
+
+CREATE DATABASE IF NOT EXISTS `cloudsession`
+  CHARACTER SET = utf8
+  COLLATE = utf8_general_ci;

cloudsession-schema.sql → database/create_cloudsession_tables.sql

@@ -1,26 +1,36 @@
--- MySQL dump 10.13  Distrib 5.6.24, for Win64 (x86_64)
+/*
+ * Base Cloud Session database schema.
+ */
+
+USE cloudsession;
+
+
+--
+-- Table structure for table `user`
 --
--- Host: localhost    Database: cloudsession
--- ------------------------------------------------------
--- Server version	5.7.7-rc-log
 
-/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
-/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
-/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
-/*!40101 SET NAMES utf8 */;
-/*!40103 SET @OLD_TIME_ZONE=@@TIME_ZONE */;
-/*!40103 SET TIME_ZONE='+00:00' */;
-/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;
-/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;
-/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
-/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;
+DROP TABLE IF EXISTS `user`;
+CREATE TABLE `user` (
+  `id` bigint(20) NOT NULL AUTO_INCREMENT,
+  `email` varchar(250) DEFAULT NULL,
+  `password` varchar(100) DEFAULT NULL,
+  `salt` varchar(50) DEFAULT NULL,
+  `auth_source` varchar(250) DEFAULT NULL,
+  `locale` varchar(50) DEFAULT NULL,
+  `blocked` tinyint(1) DEFAULT NULL,
+  `confirmed` tinyint(1) DEFAULT NULL,
+  `screen_name` varchar(250) DEFAULT NULL,
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `email` (`email`)
+) ENGINE=InnoDB
+  AUTO_INCREMENT=0
+  DEFAULT CHARSET=utf8;
+
 
 --
 -- Table structure for table `authentication_token`
 --
 DROP TABLE IF EXISTS `authentication_token`;
-/*!40101 SET @saved_cs_client     = @@character_set_client */;
-/*!40101 SET character_set_client = utf8 */;
 CREATE TABLE `authentication_token` (
   `id` bigint(20) NOT NULL AUTO_INCREMENT,
   `id_user` bigint(20) DEFAULT NULL,
@@ -33,16 +43,15 @@ CREATE TABLE `authentication_token` (
   UNIQUE KEY `token` (`token`),
   KEY `id_user` (`id_user`),
   CONSTRAINT `authentication_token_ibfk_1` FOREIGN KEY (`id_user`) REFERENCES `user` (`id`)
-) ENGINE=InnoDB AUTO_INCREMENT=0 DEFAULT CHARSET=latin1;
-/*!40101 SET character_set_client = @saved_cs_client */;
+) ENGINE=InnoDB
+  AUTO_INCREMENT=0
+  DEFAULT CHARSET=utf8;
 
 --
 -- Table structure for table `bucket`
 --
 
 DROP TABLE IF EXISTS `bucket`;
-/*!40101 SET @saved_cs_client     = @@character_set_client */;
-/*!40101 SET character_set_client = utf8 */;
 CREATE TABLE `bucket` (
   `id` bigint(20) NOT NULL AUTO_INCREMENT,
   `id_user` bigint(20) DEFAULT NULL,
@@ -52,17 +61,15 @@ CREATE TABLE `bucket` (
   PRIMARY KEY (`id`),
   UNIQUE KEY `user_type_unique` (`id_user`,`type`),
   CONSTRAINT `bucket_ibfk_1` FOREIGN KEY (`id_user`) REFERENCES `user` (`id`)
-) ENGINE=InnoDB AUTO_INCREMENT=0 DEFAULT CHARSET=latin1;
-/*!40101 SET character_set_client = @saved_cs_client */;
+) ENGINE=InnoDB
+  AUTO_INCREMENT=0
+  DEFAULT CHARSET=utf8;
 
 --
 -- Table structure for table `confirmtoken`
 --
 
-
 DROP TABLE IF EXISTS `confirm_token`;
-/*!40101 SET @saved_cs_client     = @@character_set_client */;
-/*!40101 SET character_set_client = utf8 */;
 CREATE TABLE `confirm_token` (
   `id` bigint(20) NOT NULL AUTO_INCREMENT,
   `id_user` bigint(20) DEFAULT NULL,
@@ -72,16 +79,16 @@ CREATE TABLE `confirm_token` (
   UNIQUE KEY `id_user` (`id_user`),
   UNIQUE KEY `token` (`token`),
   CONSTRAINT `confirm_token_ibfk_1` FOREIGN KEY (`id_user`) REFERENCES `user` (`id`)
-) ENGINE=InnoDB AUTO_INCREMENT=0 DEFAULT CHARSET=latin1;
-/*!40101 SET character_set_client = @saved_cs_client */;
+) ENGINE=InnoDB
+  AUTO_INCREMENT=0
+  DEFAULT CHARSET=utf8;
+
 
 --
 -- Table structure for table `resettoken`
 --
 
 DROP TABLE IF EXISTS `reset_token`;
-/*!40101 SET @saved_cs_client     = @@character_set_client */;
-/*!40101 SET character_set_client = utf8 */;
 CREATE TABLE `reset_token` (
   `id` bigint(20) NOT NULL AUTO_INCREMENT,
   `id_user` bigint(20) DEFAULT NULL,
@@ -91,38 +98,6 @@ CREATE TABLE `reset_token` (
   UNIQUE KEY `id_user` (`id_user`),
   UNIQUE KEY `token` (`token`),
   CONSTRAINT `reset_token_ibfk_1` FOREIGN KEY (`id_user`) REFERENCES `user` (`id`)
-) ENGINE=InnoDB AUTO_INCREMENT=0 DEFAULT CHARSET=latin1;
-/*!40101 SET character_set_client = @saved_cs_client */;
-
---
--- Table structure for table `user`
---
-
-DROP TABLE IF EXISTS `user`;
-/*!40101 SET @saved_cs_client     = @@character_set_client */;
-/*!40101 SET character_set_client = utf8 */;
-CREATE TABLE `user` (
-  `id` bigint(20) NOT NULL AUTO_INCREMENT,
-  `email` varchar(250) DEFAULT NULL,
-  `password` varchar(100) DEFAULT NULL,
-  `salt` varchar(50) DEFAULT NULL,
-  `auth_source` varchar(250) DEFAULT NULL,
-  `locale` varchar(50) DEFAULT NULL,
-  `blocked` tinyint(1) DEFAULT NULL,
-  `confirmed` tinyint(1) DEFAULT NULL,
-  `screen_name` varchar(250) DEFAULT NULL,
-  PRIMARY KEY (`id`),
-  UNIQUE KEY `email` (`email`)
-) ENGINE=InnoDB AUTO_INCREMENT=0 DEFAULT CHARSET=latin1;
-/*!40101 SET character_set_client = @saved_cs_client */;
-/*!40103 SET TIME_ZONE=@OLD_TIME_ZONE */;
-
-/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;
-/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;
-/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;
-/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
-/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
-/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;
-/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;
-
--- Dump completed on 2015-08-18 20:24:57
+) ENGINE=InnoDB
+  AUTO_INCREMENT=0
+  DEFAULT CHARSET=latin1;

database/patches/0001-add-user-coach.sql

@@ -1,4 +1,5 @@
 /*
  * Add coach email address field to support email cc option.
  */
-ALTER TABLE user ADD COLUMN coach_email VARCHAR(250) AFTER screen_name;
+USE cloudsession;
+ALTER TABLE cloudsession.user ADD COLUMN coach_email VARCHAR(250) AFTER screen_name;

database/patches/0004-update-cs-default-char-col.sql

@@ -0,0 +1,82 @@
+/*
+Script:  0004-update-cs-default-char-col.sql
+
+This script corrects an issue in the cloud session database
+where the default character set and collation were set to
+'latin1' and 'latin1_swedish_ci'. These settings should be
+'utf8' and 'utf8_general_ci'.
+
+This script updates the character set and collation settings
+on the cloudsession database, all cloudsession tables and
+affected columns within each of these tables.
+ */
+
+# Select the target database
+USE cloudsession;
+
+# Set the database defaults
+# This also sets the collation for individual table columns
+ALTER DATABASE cloudsession CHARACTER SET utf8 COLLATE utf8_general_ci;
+
+# latin1_general_ci
+# ALTER DATABASE cloudsession CHARACTER SET latin1 COLLATE latin1_general_ci;
+
+# Update the authentication_token table
+SET foreign_key_checks = 0;
+# Default table settings
+ALTER TABLE cloudsession.authentication_token DEFAULT CHARACTER SET utf8;
+
+# Column settings
+ALTER TABLE cloudsession.authentication_token MODIFY browser VARCHAR(200) CHARACTER SET utf8;
+ALTER TABLE cloudsession.authentication_token MODIFY server VARCHAR(1000) CHARACTER SET utf8;
+ALTER TABLE cloudsession.authentication_token MODIFY ip_address VARCHAR(200) CHARACTER SET utf8;
+ALTER TABLE cloudsession.authentication_token MODIFY token VARCHAR(200) CHARACTER SET utf8;
+
+SET foreign_key_checks = 1;
+
+
+# Update the bucket table
+SET foreign_key_checks = 0;
+ALTER TABLE cloudsession.bucket DEFAULT CHARACTER SET utf8;
+
+# Reset fields
+ALTER TABLE cloudsession.bucket MODIFY type VARCHAR(200) CHARACTER SET utf8;
+
+SET foreign_key_checks = 1;
+
+
+# Update the confirm_token table
+SET foreign_key_checks = 0;
+ALTER TABLE cloudsession.confirm_token DEFAULT CHARACTER SET utf8;
+
+# Reset fields
+ALTER TABLE cloudsession.confirm_token MODIFY token VARCHAR(200) CHARACTER SET utf8;
+
+SET foreign_key_checks = 1;
+
+
+# Update the reset_token table
+SET foreign_key_checks = 0;
+ALTER TABLE cloudsession.reset_token DEFAULT CHARACTER SET utf8;
+
+# Reset fields
+ALTER TABLE cloudsession.reset_token MODIFY token VARCHAR(200) CHARACTER SET utf8;
+
+SET foreign_key_checks = 1;
+
+
+# Update the user table
+SET foreign_key_checks = 0;
+ALTER TABLE cloudsession.user DEFAULT CHARACTER SET utf8;
+
+# Reset fields
+ALTER TABLE cloudsession.user MODIFY email VARCHAR(250) CHARACTER SET utf8;
+ALTER TABLE cloudsession.user MODIFY password VARCHAR(100) CHARACTER SET utf8;
+ALTER TABLE cloudsession.user MODIFY salt VARCHAR(50) CHARACTER SET utf8;
+ALTER TABLE cloudsession.user MODIFY auth_source VARCHAR(250) CHARACTER SET utf8;
+ALTER TABLE cloudsession.user MODIFY locale VARCHAR(50) CHARACTER SET utf8;
+ALTER TABLE cloudsession.user MODIFY screen_name VARCHAR(250) CHARACTER SET utf8;
+ALTER TABLE cloudsession.user MODIFY parent_email VARCHAR(250) CHARACTER SET utf8;
+
+SET foreign_key_checks = 1;
+