Merge lp:~elachuni/ubuntu-webcatalog/exhibit-widget into lp:ubuntu-webcatalog

[Anthony Lenton]

Added a basic exhibit widget to the front page of the site

Overview
========
This branch adds an exhibit widget to the front page of the site, pulling in the data from software-center-agent's exhibit web API and storing them locally.

Details
=======
A local Exhibit model was added to store retrieved models. You can modify an Exhibit locally to override the data retrieved from sca, forcing an Exhibit to remain hidden or published, or slightly changing the data retrieved from sca.

The exhibits are displayed on the front page, cycling between each exhibit every 10 seconds. If Javascript is disabled a random exhibit will be (statically) displayed each time the page is loaded.

When the user clicks on an exhibit they're taken to the application details page for that application.

Still missing:

No javascript framework was used so the transitions are quite stark currently (suddenly jumping from showing one exhibit to the other), a bit of YUI love would be necessary to have smoother scrolled or blended transitions of some sort, and little dots or arrows to manually switch between exhibits.

[Michael Nelson (michael.nelson)]

On Thu, Mar 1, 2012 at 11:49 PM, Anthony Lenton
<email address hidden> wrote:
> Anthony Lenton has proposed merging lp:~elachuni/ubuntu-webcatalog/exhibit-widget into lp:ubuntu-webcatalog.
> Overview
> ========
> This branch adds an exhibit widget to the front page of the site, pulling in the data from software-center-agent's exhibit web API and storing them locally.
>

Hi Anthony, the code and tests look excellent, I've got some small
comments inline below, but I've got two bigger questions:

1) I don't understand generally why we'd want to store the imported
exhibits as models... I don't see any advantage? You mention the
ability to modify local exhibits via the admin, or unpublish them
etc., but why *should* we need to do that? If there was a problem with
them, wouldn't it be better to first update the actual source of the
exhibit and then re-import them so that we'd fix whatever the problem
was on all the clients also? It seems like we're trying to build in a
security buffer so that we don't have to trust our own api
infrastructure, even though the USC clients will have no choice? The
disadvantages without giving it much thought are (1) more code to
maintain, (2) more complexity - in that differences between clients
and website are not transparent, (3) changes/additions to the exhibits
api on sca will require schema changes for us too.

2) If you have good reason for storing the Exhibit model, why do you
need the published attribute? It seems to be set to True during the
import (as it's not part of the imported data - we only export
published exhibits I think?), and I don't see why you'd ever need to
set it to False, given that you've got the display attribute. What
does it allow you to do that you can't do with your display attribute?
(on its own, the display attribute could still give you the three
options of a) displayed, b) hidden but display after next import and
c) hidden and keep hidden after next import?

Let me know if I've missed something... and feel free to land if
you're happy and have reasons for the above 2 points (just ping me and
I'll make it an approve vote).

> Details
> =======
> A local Exhibit model was added to store retrieved models.  You can modify an Exhibit locally to override the data retrieved from sca, forcing an Exhibit to remain hidden or published, or slightly changing the data retrieved from sca.
>
> The exhibits are displayed on the front page, cycling between each exhibit every 10 seconds.  If Javascript is disabled a random exhibit will be (statically) displayed each time the page is loaded.
>
> When the user clicks on an exhibit they're taken to the application details page for that application.
>
> Still missing:
>
> No javascript framework was used so the transitions are quite stark currently (suddenly jumping from showing one exhibit to the other), a bit of YUI love would be necessary to have smoother scrolled or blended transitions of some sort, and little dots or arrows to manually switch between exhibits.
>
> --
> https://code.launchpad.net/~elachuni/ubuntu-webcatalog/exhibit-widget/+merge/95484
> You are subscribed to branch lp:ubuntu-webcatalog.
>
> === modified file 'django_project/co...

[Anthony Lenton (elachuni)]

> Hi Anthony, the code and tests look excellent, I've got some small
> comments inline below, but I've got two bigger questions:
>
> 1) I don't understand generally why we'd want to store the imported
> exhibits as models... I don't see any advantage? You mention the
> ability to modify local exhibits via the admin, or unpublish them
> etc., but why *should* we need to do that? If there was a problem with
> them, wouldn't it be better to first update the actual source of the
> exhibit and then re-import them so that we'd fix whatever the problem
> was on all the clients also? It seems like we're trying to build in a
> security buffer so that we don't have to trust our own api
> infrastructure, even though the USC clients will have no choice? The
> disadvantages without giving it much thought are (1) more code to
> maintain, (2) more complexity - in that differences between clients
> and website are not transparent, (3) changes/additions to the exhibits
> api on sca will require schema changes for us too.

I don't really see what we'd do if we *don't* store them in the DB -- fetch them for each request? Cache them on the file system on each app server? Let the browser fetch them directly via Javascript? All these alternatives sound less attractive.

Beyond that, there could be several reasons to want locally modified exhibits:
 - If we want web-only exhibits, exhibits that don't make sense in USC
 - If SCA publishes some exhibits we don't want on the web, like exhibits for older distroseries or eventually specific regions or that for some reason shouldn't be displayed on the web site
 - Similar to the one above, if only a subset of the exhibits published by SCA want to be displayed via web to give extra promotion to certain apps
 - For if we need to edit the web version for some reason. If it's something that can be fixed in the exhibits on sca definitely we should do it there, but possibly it's something we should fix on the server(s, sca or uwc), in any case it'll be slow to fix (even more if the fix depends on a fix in the desktop client) and in some cases we might not want to touch the exhibit in sca at all. For instance, if an exhibit is linked to several packages, in uwc it will currently link to the first package in the list (because ubuntu-webcatalog doesn't provide a list view for *these* packages. We could add one eventually...), we might want to change that to a different one. Or we want to change the banner image for the exhibit a bit on the web because it works better there, but leave the desktop client version untouched.

> 2) If you have good reason for storing the Exhibit model, why do you
> need the published attribute? It seems to be set to True during the
> import (as it's not part of the imported data - we only export
> published exhibits I think?), and I don't see why you'd ever need to
> set it to False, given that you've got the display attribute. What
> does it allow you to do that you can't do with your display attribute?
> (on its own, the display attribute could still give you the three
> options of a) displayed, b) hidden but display after next import and
> c) hidden and keep hidden after next import?

Check ...

[Michael Nelson (michael.nelson)]

Thanks for the answers achuni. I understand now why both published and display are needed. I'm still not sold on the idea of replicated the implementation of exhibits in uwc..., but as you said, if we need to modify certain exhibits specifically for display on uwc, then we need the model with the extra display field so we can maintain those differences between imports.

review: Approve

=== modified file 'django_project/config/main.cfg'
--- django_project/config/main.cfg	2012-01-06 14:35:07 +0000
+++ django_project/config/main.cfg	2012-03-01 22:48:21 +0000
@@ -78,7 +78,7 @@
 openid_create_users = true
 openid_update_details_from_sreg = true
 openid_launchpad_teams_mapping = openid_team_mapping
-
+openid_launchpad_staff_teams = canonical-ca-hackers
 
 [openid_team_mapping]
 # Structure here is:   LP Team = Django Group

=== modified file 'src/webcatalog/admin.py'
--- src/webcatalog/admin.py	2012-01-06 17:54:47 +0000
+++ src/webcatalog/admin.py	2012-03-01 22:48:21 +0000
@@ -26,6 +26,7 @@
     Application,
     Department,
     DistroSeries,
+    Exhibit,
     Machine,
     )
 
@@ -47,7 +48,12 @@
     search_fields = ('owner__username', 'hostname', 'uuid')
     list_display = ('hostname', 'uuid', 'owner')
 
+
+class ExhibitAdmin(admin.ModelAdmin):
+    list_display = ('package_names', 'published', 'display')
+
 admin.site.register(Application, ApplicationAdmin)
 admin.site.register(Department)
 admin.site.register(DistroSeries)
+admin.site.register(Exhibit, ExhibitAdmin)
 admin.site.register(Machine, MachineAdmin)

=== added file 'src/webcatalog/management/commands/import_exhibits.py'
--- src/webcatalog/management/commands/import_exhibits.py	1970-01-01 00:00:00 +0000
+++ src/webcatalog/management/commands/import_exhibits.py	2012-03-01 22:48:21 +0000
@@ -0,0 +1,82 @@
+#   -*- coding: utf-8 -*-
+#   This file is part of the Apps Directory
+#   Copyright (C) 2011 Canonical Ltd.
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU Affero General Public License as
+#   published by the Free Software Foundation, either version 3 of the
+#   License, or (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU Affero General Public License for more details.
+#
+#   You should have received a copy of the GNU Affero General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""Management command to import exhibits from Software Center Agent's API."""
+
+from __future__ import (
+    absolute_import,
+    )
+
+import json
+import urllib
+from urlparse import urlparse
+
+from django.conf import settings
+from django.core.management.base import BaseCommand
+
+from webcatalog.models import (
+    DistroSeries,
+    Exhibit,
+    )
+
+__metaclass__ = type
+__all__ = [
+    'Command',
+    ]
+
+
+class Command(BaseCommand):
+    help = "Import exhibits from Software Center Agent's API."
+    verbosity = 0
+
+    def handle(self, *args, **options):
+        url = '%sexhibits/en/' % settings.SCA_API_URL
+        # call api and get exhibits
+        response = urllib.urlopen(url)
+        if response.code != 200:
+            raise Exception("Couldn't connect to server at %s" % url)
+        exhibits = json.loads(response.read())
+
+        for exhibit in exhibits:
+            args = {'published': True}
+            for field in ['package_names', 'html', 'banner_url']:
+                args[field] = exhibit.get(field, '')
+
+            # Munge banner_url into html
+            banner_url = args['banner_url']
+            if banner_url:
+                parsed = urlparse(banner_url)
+                args['html'] = args['html'].replace(parsed.path, banner_url)
+
+            instance, created = Exhibit.objects.get_or_create(
+                sca_id=exhibit['id'], defaults=args)
+
+            if not created:
+                Exhibit.objects.filter(pk=instance.pk).update(**args)
+
+            distroseries = [DistroSeries.objects.get_or_create(**ds)[0]
+                for ds in exhibit.get('distroseries', [])]
+
+            to_remove = instance.distroseries.exclude(
+                pk__in=[x.id for x in distroseries])
+            instance.distroseries.remove(*to_remove)
+            instance.distroseries.add(*distroseries)
+
+        # Unpublish other exhibits
+        Exhibit.objects.filter(published=True).exclude(
+            sca_id__in=[xibit['id'] for xibit in exhibits]).update(
+            published=False)

=== added file 'src/webcatalog/migrations/0009_add_exhibit.py'
--- src/webcatalog/migrations/0009_add_exhibit.py	1970-01-01 00:00:00 +0000
+++ src/webcatalog/migrations/0009_add_exhibit.py	2012-03-01 22:48:21 +0000
@@ -0,0 +1,174 @@
+# encoding: utf-8
+import datetime
+from south.db import db
+from south.v2 import SchemaMigration
+from django.db import models
+
+class Migration(SchemaMigration):
+
+    def forwards(self, orm):
+        
+        # Adding model 'Exhibit'
+        db.create_table('webcatalog_exhibit', (
+            ('id', self.gf('django.db.models.fields.AutoField')(primary_key=True)),
+            ('sca_id', self.gf('django.db.models.fields.IntegerField')()),
+            ('package_names', self.gf('django.db.models.fields.CharField')(max_length=1024)),
+            ('banner_url', self.gf('django.db.models.fields.CharField')(max_length=1024)),
+            ('html', self.gf('django.db.models.fields.TextField')()),
+            ('date_created', self.gf('django.db.models.fields.DateTimeField')(auto_now_add=True, blank=True)),
+            ('published', self.gf('django.db.models.fields.BooleanField')(default=False)),
+            ('display', self.gf('django.db.models.fields.NullBooleanField')(null=True, blank=True)),
+        ))
+        db.send_create_signal('webcatalog', ['Exhibit'])
+
+        # Adding M2M table for field distroseries on 'Exhibit'
+        db.create_table('webcatalog_exhibit_distroseries', (
+            ('id', models.AutoField(verbose_name='ID', primary_key=True, auto_created=True)),
+            ('exhibit', models.ForeignKey(orm['webcatalog.exhibit'], null=False)),
+            ('distroseries', models.ForeignKey(orm['webcatalog.distroseries'], null=False))
+        ))
+        db.create_unique('webcatalog_exhibit_distroseries', ['exhibit_id', 'distroseries_id'])
+
+
+    def backwards(self, orm):
+        
+        # Deleting model 'Exhibit'
+        db.delete_table('webcatalog_exhibit')
+
+        # Removing M2M table for field distroseries on 'Exhibit'
+        db.delete_table('webcatalog_exhibit_distroseries')
+
+
+    models = {
+        'auth.group': {
+            'Meta': {'object_name': 'Group'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '80'}),
+            'permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'})
+        },
+        'auth.permission': {
+            'Meta': {'ordering': "('content_type__app_label', 'content_type__model', 'codename')", 'unique_together': "(('content_type', 'codename'),)", 'object_name': 'Permission'},
+            'codename': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'content_type': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['contenttypes.ContentType']"}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '50'})
+        },
+        'auth.user': {
+            'Meta': {'object_name': 'User'},
+            'date_joined': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+            'email': ('django.db.models.fields.EmailField', [], {'max_length': '75', 'blank': 'True'}),
+            'first_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
+            'groups': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Group']", 'symmetrical': 'False', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'is_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+            'is_staff': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'is_superuser': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'last_login': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+            'last_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
+            'password': ('django.db.models.fields.CharField', [], {'max_length': '128'}),
+            'user_permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'}),
+            'username': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '30'})
+        },
+        'contenttypes.contenttype': {
+            'Meta': {'ordering': "('name',)", 'unique_together': "(('app_label', 'model'),)", 'object_name': 'ContentType', 'db_table': "'django_content_type'"},
+            'app_label': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'model': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '100'})
+        },
+        'webcatalog.application': {
+            'Meta': {'unique_together': "(('distroseries', 'archive_id'),)", 'object_name': 'Application'},
+            'app_type': ('django.db.models.fields.CharField', [], {'max_length': '32', 'blank': 'True'}),
+            'architectures': ('django.db.models.fields.CharField', [], {'max_length': '255', 'blank': 'True'}),
+            'archive_id': ('django.db.models.fields.CharField', [], {'db_index': 'True', 'max_length': '64', 'null': 'True', 'blank': 'True'}),
+            'categories': ('django.db.models.fields.CharField', [], {'max_length': '255', 'blank': 'True'}),
+            'channel': ('django.db.models.fields.CharField', [], {'max_length': '255', 'blank': 'True'}),
+            'comment': ('django.db.models.fields.CharField', [], {'max_length': '255', 'blank': 'True'}),
+            'departments': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['webcatalog.Department']", 'symmetrical': 'False', 'blank': 'True'}),
+            'description': ('django.db.models.fields.TextField', [], {'blank': 'True'}),
+            'distroseries': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['webcatalog.DistroSeries']"}),
+            'for_purchase': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'icon': ('django.db.models.fields.files.ImageField', [], {'max_length': '200', 'null': 'True', 'blank': 'True'}),
+            'icon_name': ('django.db.models.fields.CharField', [], {'max_length': '255', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'keywords': ('django.db.models.fields.CharField', [], {'max_length': '255', 'blank': 'True'}),
+            'mimetype': ('django.db.models.fields.CharField', [], {'max_length': '2048', 'blank': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
+            'package_name': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'popcon': ('django.db.models.fields.IntegerField', [], {'null': 'True', 'blank': 'True'}),
+            'price': ('django.db.models.fields.DecimalField', [], {'null': 'True', 'max_digits': '7', 'decimal_places': '2', 'blank': 'True'}),
+            'ratings_average': ('django.db.models.fields.DecimalField', [], {'null': 'True', 'max_digits': '3', 'decimal_places': '2', 'blank': 'True'}),
+            'ratings_histogram': ('django.db.models.fields.CharField', [], {'max_length': '128', 'blank': 'True'}),
+            'ratings_total': ('django.db.models.fields.IntegerField', [], {'null': 'True', 'blank': 'True'}),
+            'screenshot_url': ('django.db.models.fields.URLField', [], {'max_length': '200', 'blank': 'True'}),
+            'section': ('django.db.models.fields.CharField', [], {'max_length': '32'})
+        },
+        'webcatalog.consumer': {
+            'Meta': {'object_name': 'Consumer'},
+            'created_at': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'key': ('django.db.models.fields.CharField', [], {'max_length': '64'}),
+            'secret': ('django.db.models.fields.CharField', [], {'default': "'tBQfPJnnuuGIiTleUFfYPcCapqovnK'", 'max_length': '255', 'blank': 'True'}),
+            'updated_at': ('django.db.models.fields.DateTimeField', [], {'auto_now': 'True', 'blank': 'True'}),
+            'user': ('django.db.models.fields.related.OneToOneField', [], {'related_name': "'oauth_consumer'", 'unique': 'True', 'to': "orm['auth.User']"})
+        },
+        'webcatalog.department': {
+            'Meta': {'object_name': 'Department'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '64'}),
+            'parent': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['webcatalog.Department']", 'null': 'True', 'blank': 'True'})
+        },
+        'webcatalog.distroseries': {
+            'Meta': {'object_name': 'DistroSeries'},
+            'code_name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '20', 'db_index': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'version': ('django.db.models.fields.CharField', [], {'max_length': '10', 'blank': 'True'})
+        },
+        'webcatalog.exhibit': {
+            'Meta': {'object_name': 'Exhibit'},
+            'banner_url': ('django.db.models.fields.CharField', [], {'max_length': '1024'}),
+            'date_created': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
+            'display': ('django.db.models.fields.NullBooleanField', [], {'null': 'True', 'blank': 'True'}),
+            'distroseries': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['webcatalog.DistroSeries']", 'symmetrical': 'False'}),
+            'html': ('django.db.models.fields.TextField', [], {}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'package_names': ('django.db.models.fields.CharField', [], {'max_length': '1024'}),
+            'published': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'sca_id': ('django.db.models.fields.IntegerField', [], {})
+        },
+        'webcatalog.machine': {
+            'Meta': {'unique_together': "(('owner', 'uuid'),)", 'object_name': 'Machine'},
+            'hostname': ('django.db.models.fields.CharField', [], {'max_length': '64'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'logo_checksum': ('django.db.models.fields.CharField', [], {'max_length': '56', 'blank': 'True'}),
+            'owner': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['auth.User']"}),
+            'package_list': ('django.db.models.fields.TextField', [], {}),
+            'packages_checksum': ('django.db.models.fields.CharField', [], {'max_length': '56'}),
+            'uuid': ('django.db.models.fields.CharField', [], {'max_length': '32', 'db_index': 'True'})
+        },
+        'webcatalog.nonce': {
+            'Meta': {'object_name': 'Nonce'},
+            'consumer': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['webcatalog.Consumer']"}),
+            'created_at': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'nonce': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '255'}),
+            'token': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['webcatalog.Token']"})
+        },
+        'webcatalog.reviewstatsimport': {
+            'Meta': {'object_name': 'ReviewStatsImport'},
+            'distroseries': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['webcatalog.DistroSeries']", 'unique': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'last_import': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.utcnow'})
+        },
+        'webcatalog.token': {
+            'Meta': {'object_name': 'Token'},
+            'consumer': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['webcatalog.Consumer']"}),
+            'created_at': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '255', 'blank': 'True'}),
+            'token': ('django.db.models.fields.CharField', [], {'default': "'zyRClKkfkDWLAzwbnPWVQvhLPDsKNFnfvsoikGwYaFHtrcKghE'", 'max_length': '50', 'primary_key': 'True'}),
+            'token_secret': ('django.db.models.fields.CharField', [], {'default': "'MPdwPvdsoPtibgEZbUQmMmtdkhuSlwjZLrmbvKcrccfTPBycXz'", 'max_length': '50'}),
+            'updated_at': ('django.db.models.fields.DateTimeField', [], {'auto_now': 'True', 'blank': 'True'})
+        }
+    }
+
+    complete_apps = ['webcatalog']

=== modified file 'src/webcatalog/models/__init__.py'
--- src/webcatalog/models/__init__.py	2011-09-12 13:37:24 +0000
+++ src/webcatalog/models/__init__.py	2012-03-01 22:48:21 +0000
@@ -26,6 +26,7 @@
     'DistroSeries',
     'Application',
     'Department',
+    'Exhibit',
     'ReviewStatsImport',
     'Machine',
 ]
@@ -35,6 +36,7 @@
     Application,
     Department,
     DistroSeries,
+    Exhibit,
     Machine,
     ReviewStatsImport,
 )

=== modified file 'src/webcatalog/models/applications.py'
--- src/webcatalog/models/applications.py	2012-01-06 17:54:47 +0000
+++ src/webcatalog/models/applications.py	2012-03-01 22:48:21 +0000
@@ -37,6 +37,7 @@
     'Application',
     'Department',
     'DistroSeries',
+    'Exhibit',
     'Machine',
     'ReviewStatsImport',
     ]
@@ -202,3 +203,25 @@
     class Meta:
         app_label = 'webcatalog'
         unique_together = ('owner', 'uuid')
+
+
+class Exhibit(models.Model):
+    sca_id = models.IntegerField()
+    package_names = models.CharField(max_length=1024)
+    banner_url = models.CharField(max_length=1024)
+    distroseries = models.ManyToManyField(DistroSeries)
+    html = models.TextField()
+    date_created = models.DateTimeField(auto_now_add=True)
+    published = models.BooleanField()
+    display = models.NullBooleanField(
+        help_text="Yes: Always display. No: Never display. "
+            "Unknown: Display if published")
+
+    class Meta:
+        app_label = 'webcatalog'
+
+    def destination_url(self):
+        package = self.package_names.split(',')[0]
+        if not package:
+            return ''
+        return reverse('wc-package-detail', kwargs={'package_name': package})

=== modified file 'src/webcatalog/static/css/webcatalog.css'
--- src/webcatalog/static/css/webcatalog.css	2011-09-19 21:20:57 +0000
+++ src/webcatalog/static/css/webcatalog.css	2012-03-01 22:48:21 +0000
@@ -316,3 +316,14 @@
 .paginator p, .paginator a {
     font-size: 14px;
 }
+
+.exhibit-container {
+    width: 912px;
+    display: none;
+    overflow: hidden;
+    height: 200px;
+}
+
+.exhibits-widget .enabled {
+    display: block;
+}

=== added file 'src/webcatalog/templates/webcatalog/exhibits_widget.html'
--- src/webcatalog/templates/webcatalog/exhibits_widget.html	1970-01-01 00:00:00 +0000
+++ src/webcatalog/templates/webcatalog/exhibits_widget.html	2012-03-01 22:48:21 +0000
@@ -0,0 +1,41 @@
+<script type="text/javascript">
+    var activeExhibit = {{ active }};
+    var images = new Array();
+
+    function switchExhibit() {
+        var tags = document.getElementsByClassName('exhibit-container');
+        var nExhibits = tags.length;
+        activeExhibit = (activeExhibit + 1) % nExhibits;
+        for (var i in tags) {
+            if (i == activeExhibit) {
+                tags[i].classList.add('enabled');
+            }
+            else {
+                tags[i].classList.remove('enabled');
+            }
+        }
+        setTimeout(switchExhibit, 10000);
+    };
+
+    function preLoadBanners() {
+        for (var i = 0; i < preLoadBanners.arguments.length; i++) {
+            images[i] = new Image()
+            images[i].src = preLoadBanners.arguments[i]
+        }
+    }
+
+    window.onload = function() {
+        preLoadBanners({% for exhibit in exhibits %}"{{ exhibit.banner_url }}"{% if not forloop.last %}, {% endif %}{% endfor %});
+        setTimeout(switchExhibit, 10000);
+    }
+</script>
+
+{% autoescape off %}
+{% for exhibit in exhibits %}
+<div class="exhibit-container{% ifequal forloop.counter0 active %} enabled{% endifequal %}">
+    <a href="{{ exhibit.destination_url }}">
+{{ exhibit.html }}
+    </a>
+</div>
+{% endfor %}
+{% endautoescape %}
\ No newline at end of file

=== modified file 'src/webcatalog/templates/webcatalog/index.html'
--- src/webcatalog/templates/webcatalog/index.html	2011-09-12 18:37:16 +0000
+++ src/webcatalog/templates/webcatalog/index.html	2012-03-01 22:48:21 +0000
@@ -7,6 +7,12 @@
 
 {% block content %}
 
+{% if exhibits %}
+<div class="exhibits-widget">
+    {% include "webcatalog/exhibits_widget.html" %}
+</div>
+{% endif %}
+
 <h3>{% trans "Browse application departments" %}:</h3>
 
 {% for dept in depts %}

=== modified file 'src/webcatalog/templatetags/webcatalog.py'
--- src/webcatalog/templatetags/webcatalog.py	2012-01-06 17:54:47 +0000
+++ src/webcatalog/templatetags/webcatalog.py	2012-03-01 22:48:21 +0000
@@ -27,7 +27,6 @@
     'install_options',
     ]
 
-import math
 import string
 
 from django import template

=== modified file 'src/webcatalog/tests/factory.py'
--- src/webcatalog/tests/factory.py	2011-09-12 13:37:24 +0000
+++ src/webcatalog/tests/factory.py	2012-03-01 22:48:21 +0000
@@ -33,6 +33,7 @@
     Consumer,
     Department,
     DistroSeries,
+    Exhibit,
     Machine,
     Token,
     )
@@ -114,6 +115,21 @@
     def make_department(self, name, parent=None):
         return Department.objects.create(name=name, parent=parent)
 
+    def make_exhibit(self, package_names=None, published=True, display=None,
+        distroseries=None):
+        sca_id = self.get_unique_integer()
+        if package_names is None:
+            package_names = self.get_unique_string(prefix='package-')
+        banner_url = self.get_unique_string(prefix='http://example/url')
+        html = self.get_unique_string(prefix='html-')
+        if distroseries is None:
+            distroseries = self.make_distroseries()
+        xibit = Exhibit.objects.create(sca_id=sca_id,
+            package_names=package_names, banner_url=banner_url, html=html,
+            published=published, display=display)
+        xibit.distroseries.add(distroseries)
+        return xibit
+
     def make_distroseries(self, code_name=None, version=None):
         if code_name is None:
             code_name = self.get_unique_string(prefix='series-')

=== modified file 'src/webcatalog/tests/test_commands.py'
--- src/webcatalog/tests/test_commands.py	2012-01-06 17:54:47 +0000
+++ src/webcatalog/tests/test_commands.py	2012-03-01 22:48:21 +0000
@@ -22,6 +22,7 @@
     with_statement,
     )
 import apt
+import json
 import os
 import shutil
 import tempfile
@@ -43,6 +44,7 @@
 from webcatalog.models import (
     Application,
     DistroSeries,
+    Exhibit,
     ReviewStatsImport,
     )
 from webcatalog.management.commands.import_app_install_data import (
@@ -57,6 +59,7 @@
 __metaclass__ = type
 __all__ = [
     'ImportAppInstallTestCase',
+    'ImportExhibitsTestCase',
     'ImportForPurchaseAppsTestCase',
     'ImportRatingsTestCase',
     ]
@@ -384,7 +387,6 @@
             self.response_content = content.read()
         mock_response = Mock()
         mock_response.code = 200
-        mock_response.read = Mock()
         mock_response.read.return_value = self.response_content
         self.mock_response = mock_response
 
@@ -541,3 +543,99 @@
 
         # update_apps_with_stats returns None on success:
         self.assertIsNone(command.update_apps_with_stats(natty, stats))
+
+
+class ImportExhibitsTestCase(TestCaseWithFactory):
+    def mock_response(self, exhibits, changes=None):
+        response = Mock()
+        response.code = 200
+        data = []
+        for exhibit in exhibits:
+            ds = exhibit.distroseries.get()
+            data.append({'package_names': exhibit.package_names,
+                'banner_url': exhibit.banner_url,
+                'version': ds.version,
+                'code_name': ds.code_name,
+                'html': exhibit.html,
+                'date_created': str(exhibit.date_created),
+                'id': exhibit.sca_id})
+        if changes:
+            for atts, change in zip(data, changes):
+                atts.update(change)
+        for xibit in data:
+            xibit['distroseries'] = [{'code_name': xibit.pop('code_name'),
+                'version': xibit.pop('version')}]
+        return_value = json.dumps(data)
+        response.read.return_value = return_value
+        return response
+
+    @patch('urllib.urlopen')
+    def test_disables_current_exhibits(self, mock_urlopen):
+        self.factory.make_exhibit(published=True)
+        mock_urlopen.return_value = self.mock_response([])
+
+        call_command('import_exhibits')
+
+        retrieved = Exhibit.objects.get()
+        self.assertFalse(retrieved.published)
+
+    @patch('urllib.urlopen')
+    def test_updates_and_enables_current_exhibits(self, mock_urlopen):
+        xibit = self.factory.make_exhibit(published=False)
+        new_package_names = self.factory.get_unique_string(prefix='new-')
+        new_banner_url = self.factory.get_unique_string(prefix='new-')
+        new_html = self.factory.get_unique_string(prefix='new-')
+        mock_urlopen.return_value = self.mock_response([xibit], changes=[
+            {'package_names': new_package_names, 'banner_url': new_banner_url,
+            'html': new_html}])
+
+        call_command('import_exhibits')
+
+        retrieved = Exhibit.objects.get()
+        self.assertTrue(retrieved.published)
+        self.assertEqual(new_package_names, retrieved.package_names)
+        self.assertEqual(new_banner_url, retrieved.banner_url)
+        self.assertEqual(new_html, retrieved.html)
+
+    @patch('urllib.urlopen')
+    def test_creates_exhibit_if_scaid_does_not_match(self, mock_urlopen):
+        xibit = self.factory.make_exhibit(published=False)
+        new_id = xibit.sca_id + 20
+        mock_urlopen.return_value = self.mock_response([xibit], changes=[
+            {'id': new_id}])
+
+        call_command('import_exhibits')
+
+        self.assertEqual(2, Exhibit.objects.all().count())
+        self.assertFalse(Exhibit.objects.get(sca_id=xibit.sca_id).published)
+        self.assertTrue(Exhibit.objects.get(sca_id=new_id).published)
+
+    @patch('urllib.urlopen')
+    def test_display_is_left_untouched(self, mock_urlopen):
+        xibits = [self.factory.make_exhibit(display=d)
+            for d in [False, True, None]]
+
+        mock_urlopen.return_value = self.mock_response(xibits)
+
+        call_command('import_exhibits')
+
+        retrieved = Exhibit.objects.all()
+        self.assertEqual(3, len(retrieved))
+        self.assertIs(False, retrieved.get(pk=xibits[0].pk).display)
+        self.assertIs(True, retrieved.get(pk=xibits[1].pk).display)
+        self.assertIs(None, retrieved.get(pk=xibits[2].pk).display)
+
+    @patch('urllib.urlopen')
+    def test_banner_url_is_correctly_munged(self, mock_urlopen):
+        xibit = self.factory.make_exhibit()
+        html = '<img src="/foo/bar/baz.png">'
+        banner_url = 'http://example.com/foo/bar/baz.png'
+        expected = '<img src="http://example.com/foo/bar/baz.png">'
+
+        mock_urlopen.return_value = self.mock_response([xibit],
+            changes=[{'banner_url': banner_url, 'html': html}])
+
+        call_command('import_exhibits')
+
+        retrieved = Exhibit.objects.get()
+        self.assertEqual(expected, retrieved.html)

=== modified file 'src/webcatalog/tests/test_models.py'
--- src/webcatalog/tests/test_models.py	2012-01-06 17:54:47 +0000
+++ src/webcatalog/tests/test_models.py	2012-03-01 22:48:21 +0000
@@ -30,6 +30,8 @@
 __metaclass__ = type
 __all__ = [
     'ApplicationTestCase',
+    'DepartmentTestCase',
+    'ExhibitTestCase',
     ]
 
 
@@ -140,3 +142,19 @@
                 args=['frobbly', dept.id])}]
 
         self.assertEquals(expected, dept.crumbs(distro='frobbly'))
+
+
+class ExhibitTestCase(TestCaseWithFactory):
+    def test_destination_url(self):
+        exhibit = self.factory.make_exhibit(package_names='foobar')
+        expected = reverse('wc-package-detail', args=['foobar'])
+        self.assertEqual(expected, exhibit.destination_url())
+
+    def test_destination_url_multiple_packages(self):
+        exhibit = self.factory.make_exhibit(package_names='foobar,baz')
+        expected = reverse('wc-package-detail', args=['foobar'])
+        self.assertEqual(expected, exhibit.destination_url())
+
+    def test_destination_url_blank_packages(self):
+        exhibit = self.factory.make_exhibit(package_names='')
+        self.assertEqual('', exhibit.destination_url())

=== modified file 'src/webcatalog/tests/test_views.py'
--- src/webcatalog/tests/test_views.py	2011-09-19 21:20:57 +0000
+++ src/webcatalog/tests/test_views.py	2012-03-01 22:48:21 +0000
@@ -39,6 +39,7 @@
     'ApplicationDetailNoSeriesTestCase',
     'ApplicationDetailTestCase',
     'ApplicationReviewsTestCase',
+    'IndexTestCase',
     'OverviewTestCase',
     'SearchTestCase',
     ]
@@ -384,7 +385,7 @@
         self.assertEqual(404, response.status_code)
 
 
-class OverviewTestCase(TestCaseWithFactory):
+class IndexTestCase(TestCaseWithFactory):
     def test_index_contains_links_to_departments(self):
         dept = self.factory.make_department('foo')
 
@@ -393,6 +394,43 @@
         self.assertContains(response, reverse('wc-department',
             args=[dept.id]))
 
+    def test_exhibits_widget_doesnt_display_if_no_exhibits_published(self):
+        self.factory.make_exhibit(published=False)
+        self.factory.make_exhibit(published=True, display=False)
+
+        response = self.client.get(reverse('wc-index'))
+
+        self.assertNotContains(response, '<div class="exhibits-widget">')
+
+    def test_exhibits_display_trumps_published(self):
+        """If an exhibit has display=True it's shown even if published=False"""
+        self.factory.make_exhibit(published=False, display=True)
+
+        response = self.client.get(reverse('wc-index'))
+
+        self.assertContains(response, '<div class="exhibits-widget">')
+
+    def test_exhibits_falls_back_to_published(self):
+        """If an exhibit has display=None, do what published says"""
+        self.factory.make_exhibit(published=False, display=None)
+        self.factory.make_exhibit(published=True, display=None)
+
+        response = self.client.get(reverse('wc-index'))
+
+        self.assertContains(response, '<div class="exhibit-container',
+            count=1)
+
+    def test_only_one_exhibit_enabled(self):
+        for i in range(3):
+            self.factory.make_exhibit(published=True)
+
+        response = self.client.get(reverse('wc-index'))
+
+        self.assertContains(response,
+            '<div class="exhibit-container enabled">', count=1)
+
+
+class OverviewTestCase(TestCaseWithFactory):
     def test_department_contains_links_to_subdepartments(self):
         dept = self.factory.make_department('foo')
         subdept = self.factory.make_department('bar', parent=dept)

=== modified file 'src/webcatalog/views.py'
--- src/webcatalog/views.py	2012-01-06 17:54:47 +0000
+++ src/webcatalog/views.py	2012-03-01 22:48:21 +0000
@@ -23,6 +23,7 @@
     )
 
 import operator
+from random import randint
 from urllib import urlencode
 
 from django.conf import settings
@@ -40,6 +41,7 @@
     Application,
     Department,
     DistroSeries,
+    Exhibit,
     )
 from webcatalog.utilities import (
     UserAgentString,
@@ -110,7 +112,14 @@
 def index(request):
     depts = Department.objects.filter(parent=None).order_by('name')
     depts = depts.order_by('name')
-    context = RequestContext(request, dict={'depts': depts})
+    exhibits = Exhibit.objects.filter(Q(display=True) |
+        Q(display=None, published=True,))
+
+    context = RequestContext(request, dict={
+        'depts': depts,
+        'exhibits': exhibits,
+        'active': randint(0, max(exhibits.count() - 1, 1)),
+    })
     return render_to_response('webcatalog/index.html',
         context_instance=context)