Merge lp:~abentley/charmworld/related-updates into lp:~juju-jitsu/charmworld/trunk

[Aaron Bentley]

Add needed fields to 'related' charm format.

This branch adds fields to the "related" charm format: has_icon, downloads_in_past_30_days, commits_in_past_30_days, is_approved.

[Curtis Hovey (sinzui)]

Thank you. The changes_since method convinces me to wrap pretty_timedelta as a Charm method so that we don't need to pass the helper to the template.

review: Approve (code)

=== modified file 'charmworld/models.py'
--- charmworld/models.py	2013-06-13 21:23:38 +0000
+++ charmworld/models.py	2013-06-18 13:07:27 +0000
@@ -2,6 +2,7 @@
 # licensed under the GNU Affero General Public License version 3 (see
 # the file LICENSE).
 
+from calendar import timegm
 import errno
 import logging
 from mimetypes import guess_type
@@ -590,6 +591,11 @@
         """Is this charm featured in the interesting view?"""
         return self._representation['is_featured']
 
+    def changes_since(self, date):
+        """The changes that have been introduced since a given datetime."""
+        date = timegm(date.timetuple())
+        return [change for change in self.changes if change['created'] >= date]
+
 
 class QAData(object):
     """Build a usable object out of the QA questions and instance data."""

=== modified file 'charmworld/tests/test_models.py'
--- charmworld/tests/test_models.py	2013-06-13 21:22:17 +0000
+++ charmworld/tests/test_models.py	2013-06-18 13:07:27 +0000
@@ -3,6 +3,10 @@
 # the file LICENSE).
 
 """Unit tests for our application models."""
+from datetime import (
+    date,
+    datetime,
+)
 import logging
 import md5
 import os
@@ -514,6 +518,14 @@
         charm = Charm({})
         self.assertIs(False, charm.is_featured)
 
+    def test_changes_since(self):
+        changes = [factory.makeChange(created=date(2013, 6, num))
+                   for num in range(1, 31)]
+        charm = Charm(factory.get_charm_json(changes=changes))
+        self.assertEqual([], charm.changes_since(datetime(2013, 7, 1)))
+        self.assertEqual(30, len(charm.changes_since(datetime(2013, 5, 1))))
+        self.assertEqual(5, len(charm.changes_since(datetime(2013, 6, 26))))
+
 
 class TestUser(MongoTestBase):
     """Unit tests for our User object wrapping of the mongo dict."""

=== modified file 'charmworld/views/api.py'
--- charmworld/views/api.py	2013-06-17 14:12:26 +0000
+++ charmworld/views/api.py	2013-06-18 13:07:27 +0000
@@ -217,13 +217,21 @@
         return output
 
     @classmethod
-    def _format_related(cls, charm_data, weight):
+    def _format_related(cls, charm_data, weight, _now=None):
+        if _now is None:
+            now = datetime.utcnow()
+        else:
+            now = _now
         charm = Charm(charm_data)
         result = {
             'id': cls._get_api_id(charm),
             'name': charm.name,
+            'has_icon': 'icon.svg' in charm.files,
             'categories': charm.categories,
+            'downloads_in_past_30_days': charm.downloads_in_past_30_days,
+            'commits_in_past_30_days': len(charm.changes_since(now)),
             'weight': weight,
+            'is_approved': charm.promulgated,
         }
         return result
 

=== modified file 'charmworld/views/tests/test_api.py'
--- charmworld/views/tests/test_api.py	2013-06-17 14:12:26 +0000
+++ charmworld/views/tests/test_api.py	2013-06-18 13:07:27 +0000
@@ -3,7 +3,10 @@
 
 __metaclass__ = type
 
-from datetime import datetime
+from datetime import (
+    date,
+    datetime,
+)
 import hashlib
 
 from pyramid.httpexceptions import HTTPNotFound
@@ -1172,13 +1175,54 @@
         self.assertIn('charm', result)
 
     def test_format_related(self):
-        charm = factory.get_charm_json()
+        charm = factory.get_charm_json(downloads_in_past_30_days=57)
         formatted = self.api_class._format_related(charm, 0)
-        self.assertItemsEqual(['id', 'name', 'categories', 'weight'],
+        self.assertItemsEqual(['id', 'name', 'categories', 'weight',
+                               'has_icon', 'downloads_in_past_30_days',
+                               'commits_in_past_30_days', 'is_approved'],
                               formatted.keys())
         self.assertEqual(self.api_class._get_api_id(charm), formatted['id'])
         self.assertEqual(charm['name'], formatted['name'])
         self.assertEqual(charm['categories'], formatted['categories'])
+        self.assertEqual(charm['downloads_in_past_30_days'], 57)
+
+    def test_format_related_is_approved(self):
+        charm = factory.get_charm_json(promulgated=True)
+        formatted = self.api_class._format_related(charm, 0)
+        self.assertTrue(formatted['is_approved'])
+        charm = factory.get_charm_json(promulgated=False)
+        formatted = self.api_class._format_related(charm, 0)
+        self.assertFalse(formatted['is_approved'])
+
+    def test_format_related_downloads_in_past_30_days(self):
+        charm = factory.get_charm_json(downloads_in_past_30_days=42)
+        formatted = self.api_class._format_related(charm, 0)
+        self.assertEqual(42, formatted['downloads_in_past_30_days'])
+        charm = factory.get_charm_json(downloads_in_past_30_days=52)
+        formatted = self.api_class._format_related(charm, 0)
+        self.assertEqual(52, formatted['downloads_in_past_30_days'])
+
+    def test_format_related_commits_in_past_30_days(self):
+        now = datetime(2013, 06, 17)
+        charm = factory.get_charm_json(
+            changes=[factory.makeChange(created=now.date())
+                     for x in range(27)])
+        formatted = self.api_class._format_related(charm, 0, _now=now)
+        self.assertEqual(27, formatted['commits_in_past_30_days'])
+        charm = factory.get_charm_json(
+            changes=[factory.makeChange(created=now) for x in range(32)] +
+            [factory.makeChange(created=date(2013, 04, 17))])
+        formatted = self.api_class._format_related(
+            charm, 0, _now=now)
+        self.assertEqual(32, formatted['commits_in_past_30_days'])
+
+    def test_format_related_has_icon(self):
+        charm = factory.get_charm_json(files={})
+        formatted = self.api_class._format_related(charm, 0)
+        self.assertFalse(formatted['has_icon'])
+        charm = factory.get_charm_json(files={'icon.svg': {}})
+        formatted = self.api_class._format_related(charm, 0)
+        self.assertTrue(formatted['has_icon'])
 
     def test_format_related_no_categories(self):
         charm = factory.get_charm_json()

=== modified file 'docs/api.rst'
--- docs/api.rst	2013-06-03 15:02:38 +0000
+++ docs/api.rst	2013-06-18 13:07:27 +0000
@@ -251,6 +251,12 @@
     "has_icon": true,
     /* The categories associated with the charm. */
     "categories": [],
+    /* The number of downloads of this charm in the past 30 days */
+    "downloads_in_past_30_days": 41,
+    /* The number of commits to this charm in the past 30 days */
+    "commits_in_past_30_days": 5,
+    /* See Terminology_ */
+    "is_approved": true,
     /* The weight of this charm, for sorting purposes.
      * Weights are relative to other weights-- their
      * absolute value has no meaning. */