Merge lp:~michael.nelson/ubuntu-webcatalog/978000-recommended-apps-2 into lp:ubuntu-webcatalog

[Michael Nelson]

Add recommended apps to the details page side-bar.

Overview
========

Originally I'd planned to have the recommendations in a carousel like this:

https://bugs.launchpad.net/ubuntu-webcatalog/+bug/978000/+attachment/3094678/+files/978000-app-with-recommendations.png

(hence the work on dry-ing up the carousel templates), but after chatting, we decided to put them in the side bar like this:

https://bugs.launchpad.net/ubuntu-webcatalog/+bug/978000/+attachment/3094789/+files/978000-recommended-sidebar.png

which is what this branch now does.

I decided not to include a default link for non-js, as it would be ugly in the side-bar, and the functionality of adding the recommendations is a progressive enhancement anyway (and not required to use the page).

`fab test`

NOTE: I've modified the name of a context_processor below and updated main.cfg, but I've not yet checked if our settings for deploy inherit from this main.cfg, or whether we need to make the same change there.

NOTE2: I just realised we'll need to provide the recommender api (sreclient.py) in the deploy and afaik it's not yet packaged. The previous branch pulls it in via bzr. Let me know the best way forward and I'll do it in the morning.

[lp:~michael.nelson/ubuntu-webcatalog/978000-recommended-apps-2]

120. By Michael Nelson on 2012-04-19

Removed now unnecessary js import.

[Anthony Lenton (elachuni)]

Looks fine

review: Approve

=== modified file 'django_project/config/main.cfg'
--- django_project/config/main.cfg	2012-04-18 22:29:29 +0000
+++ django_project/config/main.cfg	2012-04-19 23:28:18 +0000
@@ -49,8 +49,8 @@
                               django.core.context_processors.media
                               django.core.context_processors.static
                               django.contrib.messages.context_processors.messages
-                              webcatalog.context_processors.google_analytics_id
                               webcatalog.context_processors.user_agent
+                              webcatalog.context_processors.settings_for_templates
 
 static_root = ./django_project/static/
 static_url = /assets/
 
=== modified file 'src/webcatalog/context_processors.py'
--- src/webcatalog/context_processors.py	2012-03-07 22:57:41 +0000
+++ src/webcatalog/context_processors.py	2012-04-19 23:28:18 +0000
@@ -20,15 +20,15 @@
 from django.conf import settings
 
 
-def google_analytics_id(request):
-    """Adds the google analytics id to the context if it's present."""
-    return {
-        'google_analytics_id': getattr(settings, 'GOOGLE_ANALYTICS_ID', None),
-        'secondary_google_analytics_id':
-            getattr(settings, 'SECONDARY_GOOGLE_ANALYTICS_ID', None),
-        }
-
-
 def user_agent(request):
     """Adds the browser user-agent string to the context if present."""
     return dict(user_agent=request.META.get('HTTP_USER_AGENT', ''))
+
+
+def settings_for_templates(request):
+    """Adds some settings used in templates so views can know less :)"""
+    return dict(
+        num_recommended_apps=settings.NUM_RECOMMENDED_APPS,
+        google_analytics_id=getattr(settings, 'GOOGLE_ANALYTICS_ID', None),
+        secondary_google_analytics_id=getattr(settings,
+            'SECONDARY_GOOGLE_ANALYTICS_ID', None))
 
=== modified file 'src/webcatalog/schema.py'
--- src/webcatalog/schema.py	2012-04-19 23:28:18 +0000
+++ src/webcatalog/schema.py	2012-04-19 23:28:18 +0000
@@ -92,3 +92,4 @@
     class recommender(schema.Section):
         rec_service_root = schema.StringOption(
             default="http://rec.ubuntu.com/api/1.0")
+        num_recommended_apps = schema.IntOption(default=4)
 
=== modified file 'src/webcatalog/static/css/carousel.css'
--- src/webcatalog/static/css/carousel.css	2012-04-19 23:28:18 +0000
+++ src/webcatalog/static/css/carousel.css	2012-04-19 23:28:18 +0000
@@ -146,7 +146,7 @@
     border-right: 0;
 }
 
-#featured-carousel .pagination li a.active,
+.featured-widget .pagination li a.active,
 #top-rated-carousel .pagination li a.active {
     background-color: #333;
 }
@@ -213,7 +213,7 @@
     bottom: 0;
 }
 
-.top-rated-stars {
+.carousel-container .top-rated-stars {
     position: relative;
     left: -50px;
     top: -15px;
 
=== modified file 'src/webcatalog/static/css/webcatalog.css'
--- src/webcatalog/static/css/webcatalog.css	2012-04-05 01:09:37 +0000
+++ src/webcatalog/static/css/webcatalog.css	2012-04-19 23:28:18 +0000
@@ -365,9 +365,13 @@
     border-bottom: 1px dotted gray;
 }
 
-.emaillinkportlet .portletheader, .debtags .portletheader, .versions .portletheader {
+.emaillinkportlet .portletheader, .debtags .portletheader,
+.versions .portletheader, .recommendedportlet .portletheader {
     background: #bbb;
 }
+.portletactions .star-rating {
+    padding-top: 10px;
+}
 
 #emailForm {
     margin-top: 8px;
@@ -422,4 +426,4 @@
     font-size: 32px;
     margin: 32px;
     color: #888;
-}
 \ No newline at end of file
+}
 
=== modified file 'src/webcatalog/templates/webcatalog/application_detail.html'
--- src/webcatalog/templates/webcatalog/application_detail.html	2012-04-18 21:27:46 +0000
+++ src/webcatalog/templates/webcatalog/application_detail.html	2012-04-19 23:28:18 +0000
@@ -5,21 +5,34 @@
 {% block title %}Application {{ application.name }}{% endblock %}
 {% block header %}Details for {{ application.name }}{% endblock %}
 {% block head_extra %}
-{{ block.super }}
 <link rel="stylesheet" type="text/css" href="{% url wc-combo %}?light/css/reset.css&light/css/styles.css&css/webcatalog.css&light/css/forms.css&css/carousel.css"/>
 <script src="{% url wc-combo %}?yui/3.4.0/build/yui/yui-min.js&js/carousel.js"></script>
 <script>
 YUI({combine: true, comboBase: '{% url wc-combo %}?', root: 'yui/3.4.0/build/'}).use('io-base', 'node-base', function (Y) {
-    function complete(id, obj){
-        var reviews_html = obj.responseText;
-        var reviews_div = Y.one('#reviews_placeholder');
-        reviews_div.set("innerHTML", reviews_html);
-    };
-    Y.on('io:complete', complete, Y);
 
     // XXX michaeln 2011-09-16 bug=851660 Autoload further batches of results.
-    var uri = "{% url wc-package-reviews application.distroseries.code_name application.package_name %}";
-    Y.io(uri);
+    var reviews_uri = "{% url wc-package-reviews application.distroseries.code_name application.package_name %}";
+    Y.io(reviews_uri, {
+        on: {
+            complete: function(id, obj){
+                var reviews_html = obj.responseText;
+                var reviews_div = Y.one('#reviews_placeholder');
+                reviews_div.set("innerHTML", reviews_html);
+            }
+        }
+    });
+    var recommends_div = Y.one('.portlet.recommendedportlet');
+    if (recommends_div){
+        var recommendations_uri = "{% url wc-package-recommends application.package_name %}";
+        Y.io(recommendations_uri, {
+            on: {
+                complete: function(id, obj){
+                    var recommends_html = obj.responseText;
+                    recommends_div.set("innerHTML", recommends_html);
+                }
+            }
+        });
+    }
 });
 </script>
 <meta property="og:site_name" content="Ubuntu Apps Directory" />
@@ -67,6 +80,10 @@
             </ul>
         </div>
         {% endif %}
+        {% if num_recommended_apps %}
+        <div class="portlet recommendedportlet">
+        </div>
+        {% endif %}
     </div>
 <div class="main-column">
     {% include "webcatalog/breadcrumbs_snippet.html" %}
 
=== modified file 'src/webcatalog/templates/webcatalog/recommended_apps.html'
--- src/webcatalog/templates/webcatalog/recommended_apps.html	2012-04-19 23:28:18 +0000
+++ src/webcatalog/templates/webcatalog/recommended_apps.html	2012-04-19 23:28:18 +0000
@@ -23,5 +23,17 @@
 <div class="featured-widget">
     {% include "webcatalog/recommended_apps_widget.html" %}
 </div>
+<script type="text/javascript">
+YUI({combine: true, comboBase: '{% url wc-combo %}?', root: 'yui/3.4.0/build/'}).use('uwc-carousel', function(Y) {
+    var caro = new Y.uwc.Carousel({
+        nodeContainer: ".featured-widget .carousel",
+        controlsContainer: ".featured-widget .carousel-controls",
+        containerHeight: 200,
+        containerWidth: 912,
+        autoPlay: false
+    });
+    Y.all('.slide').removeClass('disabled');
+});
+</script>
 {% endblock %}
 
 
=== modified file 'src/webcatalog/templates/webcatalog/recommended_apps_widget.html'
--- src/webcatalog/templates/webcatalog/recommended_apps_widget.html	2012-04-19 23:28:18 +0000
+++ src/webcatalog/templates/webcatalog/recommended_apps_widget.html	2012-04-19 23:28:18 +0000
@@ -1,20 +1,18 @@
-<div id="recommended-carousel">
-<div class="carousel-controls"></div>
-    <h3>Other people also downloaded...</h3>
-{% with ratings=1 apps=recommended_apps %}
-{% include "webcatalog/app_carousel_widget.html" %}
-{% endwith %}
-</div>
-<script type="text/javascript">
-YUI({combine: true, comboBase: '{% url wc-combo %}?', root: 'yui/3.4.0/build/'}).use('uwc-carousel', function(Y) {
-    var caro = new Y.uwc.Carousel({
-        nodeContainer: "#recommended-carousel .carousel",
-        controlsContainer: "#recommended-carousel .carousel-controls",
-        containerHeight: 200,
-        containerWidth: 912,
-        autoPlay: false
-    });
-    Y.all('.slide').removeClass('disabled');
-});
-</script>
-
+{% load webcatalog %}
+<div class="portletheader">Other people also downloaded...</div>
+<ul class="portletactions">
+{% for app in recommended_apps %}
+  <li>
+    <a href="{% url wc-package-detail package_name=app.package_name  %}">
+    <div class="top-rated-stars">
+    {% rating_summary app.ratings_average 'small' app.ratings_total %}
+    </div>
+    <img class="icon64" src="{{ app.icon_url_or_default }}"/>
+    <h4>{{ app.name }}</h4>
+    {% with dept=app.departments.all.0.name %}
+    <p>{% if dept %}{{ dept }} | {% endif %}<b>{% if app.price %}${{ app.price }}{% else %}FREE{% endif %}</b></p>
+    {% endwith %}
+</a>
+  </li>
+{% endfor %}
+</ul>
 
=== modified file 'src/webcatalog/tests/test_utilities.py'
--- src/webcatalog/tests/test_utilities.py	2012-04-19 23:28:18 +0000
+++ src/webcatalog/tests/test_utilities.py	2012-04-19 23:28:18 +0000
@@ -140,7 +140,7 @@
         self.mock_recommend_app = self.recommend_app_patcher.start()
         self.addCleanup(self.recommend_app_patcher.stop)
         self.eg_recommends = {
-            u'rid': u'defe066c7ad7c43f71bac58c3f23cc62', 
+            u'rid': u'defe066c7ad7c43f71bac58c3f23cc62',
             u'data': [
                 {u'rating': 4.0, u'package_name': u'nautilus-gksu'},
                 {u'rating': 4.0, u'package_name': u'tribaltrouble2'},
@@ -161,7 +161,7 @@
 
     def test_get_recommends_caches_result(self):
         self.assertIs(None, cache.get('get_recommends_for_package-firefox'))
-        
+
         result = WebServices().get_recommends_for_package('firefox')
 
         self.assertEqual(
 
=== modified file 'src/webcatalog/tests/test_views.py'
--- src/webcatalog/tests/test_views.py	2012-04-19 23:28:18 +0000
+++ src/webcatalog/tests/test_views.py	2012-04-19 23:28:18 +0000
@@ -143,6 +143,12 @@
                 app.package_name,
                 ])))
 
+    def test_link_to_recommended_apps_not_present(self):
+        with patch_settings(NUM_RECOMMENDED_APPS=0):
+            response, app = self.get_app_and_response()
+
+        self.assertNotContains(response, '<div class="recommendations">')
+
     def test_button_for_non_puchase_app(self):
         response, app = self.get_app_and_response()
 
@@ -334,7 +340,7 @@
 
         response = self.client.get(self.get_app_details_url(app))
 
-        self.assertContains(response, 'id="screenshots-carousel"')
+        self.assertContains(response, 'Y.uwc.Carousel', 1)
 
     def test_debtags_displayed(self):
         app = self.factory.make_application(debtags='["joystick"]')
@@ -1085,8 +1091,7 @@
 
     def test_renders_recommendations(self):
         app = self.factory.make_application(package_name='firefox')
-        pkgnames = ['nautilus-gksu', 'tribaltrouble2', 'acm', 'zgv',
-                    'nautilus-wallpaper']
+        pkgnames = ['nautilus-gksu', 'tribaltrouble2', 'acm']
         for pkgname in pkgnames:
             self.factory.make_application(package_name=pkgname)
 
@@ -1096,19 +1101,9 @@
         self.assertEqual(200, response.status_code)
         self.assertTemplateUsed(
             response, 'webcatalog/recommended_apps.html')
-        self.assertContains(response, '<div class="top-rated-stars">', 5)
-
-    def test_excludes_non_existing_recommendations(self):
-        app = self.factory.make_application(package_name='firefox')
-        pkgnames = ['nautilus-gksu', 'tribaltrouble2', 'acm', 'zgv']
-        for pkgname in pkgnames:
-            self.factory.make_application(package_name=pkgname)
-
-        response = self.client.get(
-            reverse('wc-package-recommends', args=['firefox']))
-
-        self.assertEqual(200, response.status_code)
-        self.assertContains(response, '<div class="top-rated-stars">', 4)
+        # Only recommendations for apps that exist in the database are
+        # included.
+        self.assertContains(response, '<div class="top-rated-stars">', 3)
 
     def test_renders_widget_only_for_json_requests(self):
         app = self.factory.make_application(package_name='firefox')
 
=== modified file 'src/webcatalog/utilities.py'
--- src/webcatalog/utilities.py	2012-04-19 23:28:18 +0000
+++ src/webcatalog/utilities.py	2012-04-19 23:28:18 +0000
@@ -166,7 +166,8 @@
 
     @property
     def recommender_api(self):
-        return SoftwareCenterRecommenderAPI(service_root=settings.REC_SERVICE_ROOT)
+        return SoftwareCenterRecommenderAPI(
+            service_root=settings.REC_SERVICE_ROOT)
 
 
 def full_claimed_id(consumer_key):
 
=== modified file 'src/webcatalog/views.py'
--- src/webcatalog/views.py	2012-04-19 23:28:18 +0000
+++ src/webcatalog/views.py	2012-04-19 23:28:18 +0000
@@ -227,7 +227,7 @@
         if recommended_app:
             recommended_apps.append(recommended_app)
             num_recommends += 1
-            if num_recommends > 5:
+            if num_recommends == settings.NUM_RECOMMENDED_APPS:
                 break
 
     context = dict(application=app, recommended_apps=recommended_apps)