Merge lp:~mhall119/awstrial/marketing-user-export into lp:awstrial

[Michael Hall]

Adds an export function for passing user marketing data to other systems. This will be used first by the marketo_exporter, but is sufficiently independent that it could be used by any other system.

Adds an export function for passing user marketing data to other systems. This will be used first by the marketo_exporter, but is sufficiently independent that it could be used by any other system.

One related change, at some point in the past we had merged the marketing opt-in and usage agreement checkboxes into one, but on the back end we had stopped recording the opt-in against the UserProfile for the user. I have fixed this so that we will once again record the user's opt-in status.

[Matthew Nuzum (newz)]

Looks good. My only concern is the dual purpose checkbox but that is a user interface issue and is not really relevant to this code change. Approving.

review: Approve

=== modified file 'awstrial/templates/contacts.html'
--- awstrial/templates/contacts.html	2011-11-14 18:56:50 +0000
+++ awstrial/templates/contacts.html	2011-12-18 16:01:18 +0000
@@ -38,7 +38,7 @@
 			    2. Agree to the terms of Service
 			</p>
 			<p>
-			    <input class="checkbox"  type="checkbox" name="a" id="a" onClick="document.getElementById('launchbtn').disabled=(document.getElementById('launchbtn').disabled)? false : true"/>
+			    <input class="checkbox"  type="checkbox" name="opt_marketing" id="opt_marketing" onClick="document.getElementById('launchbtn').disabled=(document.getElementById('launchbtn').disabled)? false : true"/>
 			    <label for="a">I will use this instance in accordance with the <a href=http://aws.amazon.com/agreement/>Amazon Web Services Customer Agreement</a>,
 			    the <a href=http://www.ubuntu.com/community/conduct>Ubuntu Code of Conduct</a>,
 			    and that Canonical may occasionally mail me information about products and services in accordance with our <a href="http://www.canonical.com/privacy">privacy policy</a>.</label><br/>

=== added file 'awstrial/trial/export.py'
--- awstrial/trial/export.py	1970-01-01 00:00:00 +0000
+++ awstrial/trial/export.py	2011-12-18 16:01:18 +0000
@@ -0,0 +1,34 @@
+from trial.models import Instances
+from django.contrib.auth.models import User
+
+
+def get_marketing_opt_in_users(created_after=None):
+    """
+    Returns a list of user data dicts corresponding to users who have opted
+    into receiving marketing material
+    """
+    user_data = []
+    collected = []
+    # Since the user is only presented with the option to opt-in at the point
+    # of running a new instance, we have to check by instance
+    if created_after:
+        users = []
+        instances = Instances.objects.filter(reservation_time__gte=created_after)
+        for instance in instances:
+            users.append(instance.owner)
+    else:
+        users = User.objects.all()
+
+    for user in users:
+        if user.username not in collected and user.profile.opt_marketing:
+            user_data.append({
+                'id': user.id,
+                'email': user.email,
+                'first_name': user.first_name,
+                'last_name': user.last_name,
+                'username': user.username,
+                'created': user.date_joined,
+            })
+            collected.append(user.username)
+
+    return user_data

=== modified file 'awstrial/trial/tests.py'
--- awstrial/trial/tests.py	2011-10-24 19:10:19 +0000
+++ awstrial/trial/tests.py	2011-12-18 16:01:18 +0000
@@ -30,10 +30,97 @@
 from trial import ec2_helper
 from trial.models import Campaign, Instances, EmailBlacklist
 from trial.auth import blacklisted_email_domain, client_using_tor
+from trial import export
 import logging
 import socket
 
 
+class TestExporter(DjangoTestCase):
+    """
+    Tests the export APIs
+    """
+
+    def setUp(self):
+        self.create_date = datetime.datetime.now()
+        self.user = User.objects.create(
+            username='testuser',
+            first_name='Test',
+            last_name='User',
+            email='[e-mail]',
+            date_joined=self.create_date
+        )
+        self.profile = self.user.profile
+        self.profile.opt_marketing=True
+        self.profile.save()
+
+        self.campaign = Campaign.objects.create(
+            name='test-campaign',
+            verbose_name='Test Campaign',
+            max_instances=5,
+            active=True,
+        )
+
+        self.instance = Instances.objects.create(
+            instance_id='i-00000001',
+            campaign=self.campaign,
+            owner=self.user,
+            reservation_time=self.create_date,
+        )
+        
+    def test_full_export(self):
+        users = export.get_marketing_opt_in_users()
+        self.assertEquals(1, len(users))
+        self.assertEquals(self.user.id, users[0]['id'])
+        self.assertEquals(self.user.username, users[0]['username'])
+        self.assertEquals(self.user.first_name, users[0]['first_name'])
+        self.assertEquals(self.user.last_name, users[0]['last_name'])
+        self.assertEquals(self.user.email, users[0]['email'])
+        self.assertEquals(self.user.date_joined, users[0]['created'])
+        
+    def test_partial_export_prev(self):
+        prev_day = self.create_date - datetime.timedelta(days=1)
+        users = export.get_marketing_opt_in_users(created_after=prev_day)
+        self.assertEquals(1, len(users))
+        
+    def test_partial_export_after(self):
+        next_day = self.create_date + datetime.timedelta(days=1)
+        users = export.get_marketing_opt_in_users(created_after=next_day)
+        self.assertEquals(0, len(users))
+
+    def test_opt_out(self):
+        self.profile.opt_marketing=False
+        self.profile.save()
+        users = export.get_marketing_opt_in_users()
+        self.assertEquals(0, len(users))
+
+    def test_opt_in_after_user_joined(self):
+        prev_day = self.create_date - datetime.timedelta(days=1)
+        self.instance.reservation_time = prev_day
+        self.instance.save()
+
+        users = export.get_marketing_opt_in_users(created_after=self.create_date)
+        self.assertEquals(0, len(users))
+
+        next_day = self.create_date + datetime.timedelta(days=1)
+        self.instance.reservation_time = next_day
+        self.instance.save()
+        
+        users = export.get_marketing_opt_in_users(created_after=prev_day)
+        self.assertEquals(1, len(users))
+
+    def test_user_without_instance(self):
+        prev_day = self.create_date - datetime.timedelta(days=1)
+        self.instance.delete()
+        self.profile.opt_marketing=False
+        self.profile.save()
+
+        users = export.get_marketing_opt_in_users(created_after=prev_day)
+        self.assertEquals(0, len(users))
+
+        users = export.get_marketing_opt_in_users()
+        self.assertEquals(0, len(users))
+
+        
 class TestEc2Helper(UnitTestCase):
     """
     Tests the calls to functions in the ec2_helper module
@@ -114,7 +201,7 @@
     def call_run_instance(self, campaign):
         post_data = {
             'config': 'default',
-            'a': 1,
+            'opt_marketing': 1,
             'launchbtn': 'Launch',
         }
         return self.client.post('/%s/run/' % campaign.name, post_data)

=== modified file 'awstrial/trial/views.py'
--- awstrial/trial/views.py	2011-10-20 14:01:31 +0000
+++ awstrial/trial/views.py	2011-12-18 16:01:18 +0000
@@ -71,14 +71,14 @@
         # Now Check the campaign is running and has avaliability left.
         if current_campaign.remaining() and (current_campaign.active):
             if request.method == "POST":
-                # opt_marketing = opt in for marketing mail, bool
-                user = request.user.profile
-                user.opt_marketing = request.POST.get('opt_marketing', '')
-                user.save()
-
-                # a = disclaimer box
-                a = request.POST.get('a', '')
-                if a:
+
+                # This is both the disclaiming and marketing opt-in checkbox
+                opt_marketing = request.POST.get('opt_marketing', '')
+                if opt_marketing:
+                    user = request.user.profile
+                    user.opt_marketing = opt_marketing
+                    user.save()
+
                     #try:
                     region = request.POST.get('region',None)
                     if region is not None: