Merge lp:~alecu/ubuntuone-client/delivery-call-api into lp:ubuntuone-client

[Alejandro J. Cura]

- Add call to newest-purchases web api (LP: #1103688).

Unmerged revisions

1379. By Alejandro J. Cura on 2013-01-25

Add call to newest-purchases web api

=== modified file 'tests/syncdaemon/test_action_queue.py'
--- tests/syncdaemon/test_action_queue.py	2013-01-17 19:16:53 +0000
+++ tests/syncdaemon/test_action_queue.py	2013-01-25 14:59:21 +0000
@@ -1,6 +1,6 @@
 #-*- coding: utf-8 -*-
 #
-# Copyright 2009-2012 Canonical Ltd.
+# Copyright 2009-2013 Canonical Ltd.
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU General Public License version 3, as published
@@ -487,6 +487,112 @@
         yield self.action_queue.get_webclient(self.fake_iri)
         self.assertEqual(calls[1]["context_factory"], fake_context)
 
+    def test_queue_music_delivery_results(self):
+        """The music delivery results are queued."""
+        albums = ["fake", "list", "of", "albums"]
+        self.action_queue.music_delivery_results(albums)
+        expected = ('AQ_MUSIC_DELIVERY_RESULTS', {'purchased_albums': albums})
+        self.assertEqual([expected], self.action_queue.event_queue.events)
+
+
+class MusicDeliveryLifeCycleTestCase(BasicTestCase):
+    """Tests to check the lifecycle of the music delivery checks."""
+
+    def test_delivery_checker_initialization(self):
+        """Check the initialization of the checker."""
+        self.assertEqual(self.action_queue.delivery_checker.action_queue,
+                         self.action_queue)
+
+    def test_delivery_checker_started(self):
+        """Check that the delivery checker is started on connection."""
+        called = []
+        self.patch(self.action_queue, "_lookup_srv", lambda: defer.Deferred())
+        self.patch(self.action_queue.delivery_checker, "start",
+            lambda: called.append(True))
+        self.action_queue.connect()
+        self.assertEqual(len(called), 1)
+
+    def test_delivery_checker_stopped(self):
+        """Check that the delivery checker is stopped on disconnection."""
+        called = []
+        self.patch(self.action_queue.delivery_checker, "stop",
+            lambda: called.append(True))
+        self.action_queue._cleanup_connection_state()
+        self.assertEqual(len(called), 1)
+
+
+FAKE_DELIVERY_RESPONSE = """{
+  "server_timestamp": 1234,
+  "purchased_albums": [{
+    "album_name": "7digital Essential: 50s Rock",
+    "cloud_delivery_status": "COMPLETED",
+    "timestamp_purchased": 1230,
+    "open_url": "http://one.ubuntu.com/......",
+    "tracks_udf_paths": [
+      "Bill Haley/7digital Essential: 50s Rock/Rock Around the Clock.mp3",
+      "Bo Diddley/7digital Essential: 50s Rock/I'm a Man.mp3",
+      "Buddy Holly/7digital Essential: 50s Rock/Little Baby.mp3",
+      "Chuck Berry/7digital Essential: 50s Rock/Johnny Be Good.mp3",
+      "Chuck Berry/7digital Essential: 50s Rock/Roll Over Beethoven.mp3",
+      "Chuck Berry/7digital Essential: 50s Rock/Sweet Little Rock&Roll.mp3",
+      "Eddie Cochran/7digital Essential: 50s Rock/Let's Get Together.mp3",
+      "Eddie Cochran/7digital Essential: 50s Rock/My Way.mp3",
+      "Elvis Presley/7digital Essential: 50s Rock/Blue Suede Shoes.mp3",
+      "Elvis Presley/7digital Essential: 50s Rock/Don't Be Cruel.mp3",
+      "Elvis Presley/7digital Essential: 50s Rock/Shake, Rattle and Roll.mp3"
+    ]}
+  ]
+}"""
+
+
+class FakeAQ(object):
+    """A fake action queue."""
+
+    def __init__(self, result=FAKE_DELIVERY_RESPONSE):
+        self.result = result
+        self.called = []
+        self.delivery_results = None
+
+    def webcall(self, *args, **kwargs):
+        """A fake web call."""
+        self.called.append((args, kwargs))
+        response = action_queue.txweb.Response(self.result)
+        return defer.succeed(response)
+
+    def music_delivery_results(self, albums):
+        """The music results are sent to the event queue."""
+        self.delivery_results = albums
+
+
+class MusicDeliveryCheckerTestCase(TwistedTestCase):
+    """Tests for the MusicDeliveryChecker."""
+
+    @defer.inlineCallbacks
+    def test_webservice_called_with_timestamp(self):
+        """The webservice is called with the last server timestamp."""
+        fakeaq = FakeAQ()
+        checker = action_queue.MusicDeliveryChecker(fakeaq)
+        expected = ((action_queue.MusicDeliveryChecker.ALBUM_DELIVERY_IRI %
+            checker.last_server_timestamp,), {'method': 'GET'})
+        yield checker.check_api()
+        self.assertEqual(fakeaq.called, [expected])
+
+    @defer.inlineCallbacks
+    def test_new_server_timestamp_is_stored(self):
+        """The webservice response is json parsed and the timestamp stored."""
+        fakeaq = FakeAQ()
+        checker = action_queue.MusicDeliveryChecker(fakeaq)
+        yield checker.check_api()
+        self.assertEqual(checker.last_server_timestamp, 1234)
+
+    @defer.inlineCallbacks
+    def test_event_queue_is_pushed(self):
+        """The webservice response is pushed into the event queue."""
+        fakeaq = FakeAQ()
+        checker = action_queue.MusicDeliveryChecker(fakeaq)
+        yield checker.check_api()
+        self.assertEqual(len(fakeaq.delivery_results), 1)
+
 
 class TestLoggingStorageClient(TwistedTestCase):
     """Tests for ensuring magic hash dont show in logs."""
 
=== modified file 'ubuntuone/syncdaemon/action_queue.py'
--- ubuntuone/syncdaemon/action_queue.py	2013-01-11 20:05:24 +0000
+++ ubuntuone/syncdaemon/action_queue.py	2013-01-25 14:59:21 +0000
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2009-2012 Canonical Ltd.
+# Copyright 2009-2013 Canonical Ltd.
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU General Public License version 3, as published
@@ -761,6 +761,43 @@
         return getattr(self.fd, attr)
 
 
+class MusicDeliveryChecker(object):
+    """Checks the api for new albums delivered to the cloud."""
+
+    ALBUM_DELIVERY_IRI = (u"https://edge.one.ubuntu.com/" +
+        u"music-store/api/1/user/newest-purchases?last_server_timestamp=%d")
+
+    def __init__(self, action_queue):
+        self.action_queue = action_queue
+        self.last_server_timestamp = 0
+
+    def start(self):
+        """Start calling the api periodically."""
+        # TODO: coming in following branches. See pad.lv/1103690
+        # reactor.callLater(0, self.check_and_schedule_next_check)
+
+    def stop(self):
+        """Stop calling the api."""
+
+    @defer.inlineCallbacks
+    def check_and_schedule_next_check(self):
+        """Check the api, and schedule the next check."""
+        # TODO: coming in following branches. See pad.lv/1103690
+        # on any error, wait 10 minutes
+        # on success, wait 60 minutes
+
+    @defer.inlineCallbacks
+    def check_api(self):
+        """Do the actual checking."""
+        iri = self.ALBUM_DELIVERY_IRI % self.last_server_timestamp
+        logger.debug("Checking music delivery: %d", self.last_server_timestamp)
+        response = yield self.action_queue.webcall(iri, method="GET")
+        logger.debug("Music delivery returned %d bytes", len(response.content))
+        parsed = json.loads(response.content)
+        self.last_server_timestamp = int(parsed["server_timestamp"])
+        self.action_queue.music_delivery_results(parsed["purchased_albums"])
+
+
 class ActionQueue(ThrottlingStorageClientFactory, object):
     """The ActionQueue itself."""
 
@@ -813,6 +850,7 @@
         self.commands = dict((x, y) for x, y in globals().iteritems()
                              if inspect.isclass(y) and
                                             issubclass(y, ActionQueueCommand))
+        self.delivery_checker = MusicDeliveryChecker(self)
 
     def check_conditions(self):
         """Check conditions in the locker, to release all the waiting ops."""
@@ -843,6 +881,7 @@
         self.client = None
         self.connector = None
         self.connect_in_progress = False
+        self.delivery_checker.stop()
 
     def _share_change_callback(self, info):
         """Called by the client when notified that a share changed."""
@@ -921,6 +960,10 @@
         else:
             return defer.succeed((self.host, self.port))
 
+    def music_delivery_results(self, results):
+        """Push the music delivery results into the event queue."""
+        self.event_queue.push('AQ_MUSIC_DELIVERY_RESULTS',
+                              purchased_albums=results)
 
     @defer.inlineCallbacks
     def webcall(self, iri, **kwargs):
@@ -968,6 +1011,7 @@
         d = self._lookup_srv()
         # DNS lookup always succeeds, proceed to actually connect
         d.addCallback(self._make_connection)
+        self.delivery_checker.start()
 
     def buildProtocol(self, addr):
         """Build the client and store it. Connect callbacks."""
 
=== modified file 'ubuntuone/syncdaemon/event_queue.py'
--- ubuntuone/syncdaemon/event_queue.py	2012-08-08 13:21:13 +0000
+++ ubuntuone/syncdaemon/event_queue.py	2013-01-25 14:59:21 +0000
@@ -1,9 +1,6 @@
 # ubuntuone.syncdaemon.event_queue - Event queuing
 #
-# Authors: Facundo Batista <[e-mail]>
-#          Manuel de la Pena <[e-mail]>
-#
-# Copyright 2009-2012 Canonical Ltd.
+# Copyright 2009-2013 Canonical Ltd.
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU General Public License version 3, as published
@@ -100,6 +97,7 @@
     'AQ_CHANGE_PUBLIC_ACCESS_ERROR': ('share_id', 'node_id', 'error'),
     'AQ_PUBLIC_FILES_LIST_OK': ('public_files',),
     'AQ_PUBLIC_FILES_LIST_ERROR': ('error',),
+    'AQ_MUSIC_DELIVERY_RESULTS': ('purchased_albums',),
     'AQ_DELTA_OK': ('volume_id', 'delta_content', 'end_generation',
                     'full', 'free_bytes'),
     'AQ_DELTA_ERROR': ('volume_id', 'error'),