Merge lp:~cjcurran/friends/facebook-contacts into lp:friends

[Conor Curran]

initial facebook contacts work plus tests

[Robert Bruce Park (robru)]

On 12-10-23 08:52 AM, Conor Curran wrote:
> === modified file 'README.rst'
> --- README.rst 2012-10-15 18:56:26 +0000
> +++ README.rst 2012-10-23 13:51:19 +0000
> @@ -17,6 +17,13 @@
> * python3 (>= 3.2, although 3.3 will soon be required)
> * python3-distutils-extra
> * python3-dbus
> + * gir1.2-ebook-1.2
> + * gir1.2-edataserver-1.2
> + * python (3.2)
> + * python-distutils-extra
> + * python-dbus (0.80.2)
> + * python-virtualenv
> + * python3-mock

Why did you add deps on python2 stuff? We already have python3 and
python3-distutils-extra and python3-dbus listed immediately above what
you've added here.

> + # Fetch the full contact info from facebook
> + # Not being used now - all we need for now is the id and name
> + def fetch_contact(self, contact_details):
> + access_token = self._get_access_token()
> + url = BASE_URL + '/' + details['id']
> + params = dict(access_token=access_token)
> + return get_json(url, params)

If this isn't being used, can you delete it? Or is the comment wrong?

> +class EDSBookClientMock:
> + """A Mocker object to simulate use of BookClient
> + """

Ok, these mocks are looking better.

> === added file 'test-eds-book-searching.py'
> --- test-eds-book-searching.py 1970-01-01 00:00:00 +0000
> +++ test-eds-book-searching.py 2012-10-23 13:51:19 +0000
> === added file 'test-eds-contact-creation.py'
> --- test-eds-contact-creation.py 1970-01-01 00:00:00 +0000
> +++ test-eds-contact-creation.py 2012-10-23 13:51:19 +0000
> === added file 'test-eds-create-book.py'
> --- test-eds-create-book.py 1970-01-01 00:00:00 +0000
> +++ test-eds-create-book.py 2012-10-23 13:51:19 +0000

We don't need these extra test files anymore, right? Did you write
enough unittests to make these redundant?

[Conor Curran (cjcurran)]

re deps not sure what happened there. I had a conflict on that file a while ago when I rebased maybe it happened then. Definitely don't remember adding python2 deps.

Yup, will remove that method and will delete those files.

[lp:~cjcurran/friends/facebook-contacts]

26. By Conor Curran on 2012-10-24

applying merge comments

27. By Conor Curran on 2012-10-24

bug fixes...

28. By Conor Curran on 2012-10-24

add logging to make contacts and the search method

29. By Conor Curran on 2012-10-24

make base search method parameters generic

=== modified file 'README.rst'
--- README.rst	2012-10-15 18:56:26 +0000
+++ README.rst	2012-10-24 13:59:19 +0000
@@ -17,6 +17,9 @@
     * python3 (>= 3.2, although 3.3 will soon be required)
     * python3-distutils-extra
     * python3-dbus
+    * gir1.2-ebook-1.2    
+    * gir1.2-edataserver-1.2    
+    * python3-mock
 
 
 Installation

=== modified file 'friends/protocols/facebook.py'
--- friends/protocols/facebook.py	2012-10-19 18:32:18 +0000
+++ friends/protocols/facebook.py	2012-10-24 13:59:19 +0000
@@ -19,7 +19,6 @@
     'Facebook',
     ]
 
-
 import logging
 
 from datetime import datetime, timedelta
@@ -27,7 +26,7 @@
 from friends.utils.base import Base, feature
 from friends.utils.download import get_json
 from friends.utils.time import parsetime, iso8601utc
-
+from gi.repository import EBook
 
 # 'id' can be the id of *any* Facebook object
 # https://developers.facebook.com/docs/reference/api/
@@ -35,11 +34,10 @@
 PERMALINK = URL_BASE.format(subdomain='www') + '{id}'
 API_BASE = URL_BASE.format(subdomain='graph') + '{id}'
 ME_URL = API_BASE.format(id='me')
-
-
+LIMIT = 100
+FACEBOOK_ADDRESS_BOOK = "friends-facebook-contacts"
 log = logging.getLogger(__name__)
 
-
 class Facebook(Base):
     def _whoami(self, authdata):
         """Identify the authenticating user."""
@@ -149,7 +147,7 @@
         # https://developers.facebook.com/docs/reference/api/post/
         for entry in entries:
             self._publish_entry(entry)
-
+        
     def _like(self, obj_id, method):
         url = API_BASE.format(id=obj_id) + '/likes'
         token = self._get_access_token()
@@ -220,3 +218,70 @@
             log.error('Failed to delete {} on Facebook'.format(obj_id))
         else:
             self._unpublish(obj_id)
+
+    def fetch_contacts(self):
+        """ Retrieve a list of Facebook friends
+            A maximum of 100 friends are requested.
+        """
+        access_token = self._get_access_token()
+        contacts = []
+        url = ME_URL + '/friends'
+        params = dict(access_token=access_token,
+                      limit=LIMIT)
+        # Now access Facebook and follow pagination until we have at least
+        # LIMIT number of entries, or we've reached the end of pages.
+        while True:
+            response = get_json(url, params)
+            if self._is_error(response):
+                # We'll just use what we have so far, if anything.
+                break
+            data = response.get('data')
+            if data is None:
+                # I guess we're done.
+                break
+            contacts.extend(data)
+            if len(contacts) >= LIMIT:
+                break
+            # We haven't gotten the requested number of entries.  Follow the
+            # next page if there is one to try to get more.
+            pages = response.get('paging')
+            if pages is None:
+                break
+            # The 'next' key has the full link to follow; no additional
+            # parameters are needed.  Specifically, this link will already
+            # include the access_token, and any since/limit values.
+            url = pages.get('next')
+            params = None
+            if url is None:
+                # I guess there are no more next pages.
+                break
+        return contacts
+
+    # This method can take the minimal contact information or full contact info
+    # For now we only cache ID and the name in the addressbook. 
+    # Using custom field for name because I can't figure out how econtact name works.
+    def create_contact(self, contact_json):
+        vcafid = EBook.VCardAttribute.new("social-networking-attributes", "facebook-id")      
+        vcafid.add_value(contact_json["id"])
+        vcafn = EBook.VCardAttribute.new("social-networking-attributes", "facebook-name")      
+        vcafn.add_value(contact_json["name"])
+        vcard = EBook.VCard.new()
+        vcard.add_attribute(vcafid)
+        vcard.add_attribute(vcafn)
+        c = EBook.Contact.new_from_vcard(vcard.to_string(EBook.VCardFormat(1)))
+        log.debug("Creating new contact for {}".format(contact_json['name']))
+        return c
+
+    def contacts(self):
+        contacts = self.fetch_contacts()
+        source = self._get_eds_source(FACEBOOK_ADDRESS_BOOK)
+        for contact in contacts:
+            if source != None and Base.previously_stored_contact(source, "facebook-id", contact['id']) == True:
+                continue
+            #Let's not query the full contact info for now
+            #Show some respect for facebook and the chances are we won't be blocked.
+            eds_contact = self.create_contact(contact)
+            if(self._push_to_eds(FACEBOOK_ADDRESS_BOOK, eds_contact) == False):
+                log.error("Warning: Unable to save facebook contact {}".format(contact["name"]))
+
+

=== modified file 'friends/testing/mocks.py'
--- friends/testing/mocks.py	2012-10-19 19:27:21 +0000
+++ friends/testing/mocks.py	2012-10-24 13:59:19 +0000
@@ -247,3 +247,73 @@
     def __exit__(self, *exception_info):
         self.stop()
         return False
+
+class EDSBookClientMock:
+    """A Mocker object to simulate use of BookClient
+    """
+    def __init__(self):
+        pass
+        
+    def open_sync(val1, val2, val3):
+        pass
+
+    def add_contact_sync(val1, contact, cancellable):
+        return True
+
+    def get_contacts_sync(val1, val2, val3):
+        if val1:
+            return [True, [{'name':'john doe', 'id': 11111}]]
+        else:
+            return [True, []]
+
+class EDSExtension:
+    """A Extension mocker object for testing create source"""
+    def __init__(self):
+        pass
+
+    def set_backend_name(self, name):
+        pass
+
+class EDSSource:
+    """A Mocker object to simulate use of a Source object to create address books in EDS
+    """
+    def __init__(self, val1, val2):
+        pass
+
+    def set_display_name(self,name):
+        self.name = name
+
+    def get_display_name(self):
+        return self.name
+
+    def set_parent(self,parent):
+        pass
+    
+    def get_uid(self):
+        return "test-source-uid"
+
+    def get_extension(self,extension_name):
+        return EDSExtension()
+
+class EDSRegistry:
+    """A Mocker object for the registry"""
+    def __init__(self):
+        pass
+
+    def commit_source_sync(self, source, val1):
+        return True
+
+    def list_sources(self, category):
+        res = []
+        s1 = EDSSource(None, None)
+        s1.set_display_name("test-facebook-contacts")
+        res.append(s1)
+        s2 = EDSSource(None, None)
+        s2.set_display_name("test-twitter-contacts")
+        res.append(s2)
+        return res
+    
+    def ref_source(self, src_uid):
+        s1 = EDSSource(None, None)
+        s1.set_display_name("test-facebook-contacts")
+        return s1
\ No newline at end of file

=== added file 'friends/tests/data/facebook-contacts.dat'
--- friends/tests/data/facebook-contacts.dat	1970-01-01 00:00:00 +0000
+++ friends/tests/data/facebook-contacts.dat	2012-10-24 13:59:19 +0000
@@ -0,0 +1,36 @@
+{
+   "data": [
+      {
+         "name": "Jane Doe",
+         "id": "123456"
+      },
+      {
+         "name": "John Doe",
+         "id": "654321"
+      },
+      {
+         "name": "Jim Doe",
+         "id": "987654"
+      },
+      {
+         "name": "Joe Doe",
+         "id": "876543"
+      },
+      {
+         "name": "Tim Tom",
+         "id": "765432"
+      },
+      {
+         "name": "Tom Dunne",
+         "id": "111111"
+      },
+      {
+         "name": "Pete Wilson",
+         "id": "222222"
+      },
+      {
+         "name": "John Smith",
+         "id": "444444"
+      }
+   ]
+}

=== modified file 'friends/tests/test_facebook.py'
--- friends/tests/test_facebook.py	2012-10-19 01:35:36 +0000
+++ friends/tests/test_facebook.py	2012-10-24 13:59:19 +0000
@@ -19,31 +19,28 @@
     'TestFacebook',
     ]
 
-
 import unittest
 
 from gi.repository import Dee
+from gi.repository import EBook, EDataServer, Gio, GLib
 
 from friends.protocols.facebook import Facebook
 from friends.testing.helpers import FakeAccount
-from friends.testing.mocks import FakeSoupMessage, LogMock
+from friends.testing.mocks import FakeSoupMessage, LogMock, EDSBookClientMock, EDSSource, EDSRegistry
 from friends.utils.base import Base
 from friends.utils.model import COLUMN_TYPES
 
-
 try:
     # Python 3.3
     from unittest import mock
 except ImportError:
     import mock
 
-
 # Create a test model that will not interfere with the user's environment.
 # We'll use this object as a mock of the real model.
 TestModel = Dee.SharedModel.new('com.canonical.Friends.TestSharedModel')
 TestModel.set_schema_full(COLUMN_TYPES)
 
-
 @mock.patch('friends.utils.download._soup', mock.Mock())
 class TestFacebook(unittest.TestCase):
     """Test the Facebook API."""
@@ -51,6 +48,7 @@
     def setUp(self):
         self.account = FakeAccount()
         self.protocol = Facebook(self.account)
+        self.protocol.source_registry = EDSRegistry()
         # Enable sub-thread synchronization, and mock out the loggers.
         Base._SYNCHRONIZE = True
 
@@ -314,3 +312,62 @@
             method='DELETE',
             params=dict(access_token='face'))
         unpublish.assert_called_once_with('post_id')
+
+
+
+    @mock.patch('friends.utils.download.Soup.Message',
+                FakeSoupMessage('friends.tests.data', 'facebook-contacts.dat'))
+    @mock.patch('friends.protocols.facebook.Facebook._login',
+                return_value=True)
+    def test_fetch_contacts(self, *mocks):
+        # Receive the users friends.
+        results = self.protocol.fetch_contacts() 
+        self.assertEqual(len(results), 8)
+        self.assertEqual(results[7]["name"], "John Smith")
+        self.assertEqual(results[7]["id"], "444444")
+
+    def test_create_contact(self, *mocks):
+        # Receive the users friends.
+        bare_contact = {"name": "Lucy Baron", "id": "555555555"}
+        eds_contact = self.protocol.create_contact(bare_contact) 
+        facebook_id_attr = eds_contact.get_attribute("facebook-id")
+        self.assertEqual(facebook_id_attr.get_value(), "555555555")
+        facebook_name_attr = eds_contact.get_attribute("facebook-name")
+        self.assertEqual(facebook_name_attr.get_value(), "Lucy Baron")
+
+    @mock.patch('friends.utils.base.Base._get_eds_source',
+                return_value=True)
+    @mock.patch('gi.repository.EBook.BookClient.new', return_value=EDSBookClientMock())
+    def test_successfull_push_to_eds(self, *mocks):
+        bare_contact = {"name": "Lucy Baron", "id": "555555555"}
+        eds_contact = self.protocol.create_contact(bare_contact) 
+        result = self.protocol._push_to_eds("test-address-book", eds_contact)
+        self.assertEqual(result, True)
+
+    @mock.patch('friends.utils.base.Base._get_eds_source',
+                return_value=None)
+    @mock.patch('friends.utils.base.Base._create_eds_source',
+                return_value=None)
+    def test_unsuccessfull_push_to_eds(self, *mocks):
+        bare_contact = {"name": "Lucy Baron", "id": "555555555"}
+        eds_contact = self.protocol.create_contact(bare_contact) 
+        result = self.protocol._push_to_eds("test-address-book", eds_contact)
+        self.assertEqual(result, False)
+
+    @mock.patch('gi.repository.EDataServer.Source.new', return_value=EDSSource("foo", "bar"))
+    def test_create_eds_source(self, *mocks):
+        res = self.protocol._create_eds_source('facebook-test-address')
+        self.assertEqual(res, "test-source-uid")
+
+    @mock.patch('gi.repository.EBook.BookClient.new', return_value=EDSBookClientMock())
+    def test_successful_previously_stored_contact(self, *mocks):
+        result = Facebook.previously_stored_contact(True, "facebook-id", "11111")
+        self.assertEqual(result, True)
+
+    def test_successful_get_eds_source(self, *mocks):
+        result = self.protocol._get_eds_source("test-facebook-contacts")
+        self.assertEqual(result.get_display_name(), "test-facebook-contacts")
+
+    def test_unsuccessful_get_eds_source(self, *mocks):
+        result = self.protocol._get_eds_source("test-incorrect-contacts")
+        self.assertEqual(result, None)        
\ No newline at end of file

=== modified file 'friends/utils/base.py'
--- friends/utils/base.py	2012-10-23 21:54:58 +0000
+++ friends/utils/base.py	2012-10-24 13:59:19 +0000
@@ -27,12 +27,17 @@
 import string
 import logging
 import threading
+import time
 
 from datetime import datetime
 
 from friends.utils.authentication import Authentication
 from friends.utils.model import COLUMN_INDICES, SCHEMA, DEFAULTS, Model
+<<<<<<< TREE
 from friends.utils.time import ISO8601_FORMAT
+=======
+from gi.repository import EDataServer, EBook, Gio
+>>>>>>> MERGE-SOURCE
 
 
 IGNORED = string.punctuation + string.whitespace
@@ -175,6 +180,7 @@
     _SYNCHRONIZE = False
 
     def __init__(self, account):
+        self.source_registry = EDataServer.SourceRegistry.new_sync(None)
         self._account = account
 
     def __call__(self, operation, *args, **kwargs):
@@ -365,6 +371,51 @@
             self._whoami(result)
             log.debug('{} UID: {}'.format(protocol, self._account.user_id))
 
+    def _push_to_eds(self, online_service, contact):
+        source_match = self._get_eds_source(online_service)
+        if source_match == None:
+            new_source_uid = self._create_eds_source(online_service)
+            if new_source_uid == None:
+                log.error('Could not create a new source for {}'.format(online_service))
+                return False
+            else:
+                #Potential race condition - need to sleep for a couple of cycles
+                #to ensure the registry will return a valid source object after commiting
+                #Evolution fix on the way but for now we need to have this in place.
+                #https://bugzilla.gnome.org/show_bug.cgi?id=685986                
+                time.sleep(1)
+                source_match = self.source_registry.ref_source(new_source_uid)
+        client = EBook.BookClient.new(source_match)
+        client.open_sync(False, None)
+        return client.add_contact_sync(contact, Gio.Cancellable());
+
+    def _create_eds_source(self, online_service):
+        source = EDataServer.Source.new(None, None)
+        source.set_display_name(online_service)
+        source.set_parent("local-stub")    
+        extension = source.get_extension(EDataServer.SOURCE_EXTENSION_ADDRESS_BOOK)
+        extension.set_backend_name("local")
+        if (self.source_registry.commit_source_sync(source, Gio.Cancellable())):
+            return source.get_uid()
+        return None
+
+    def _get_eds_source(self, online_service):
+        for previous_source in self.source_registry.list_sources(None):
+            if previous_source.get_display_name() == online_service:
+                return self.source_registry.ref_source(previous_source.get_uid())
+        return None
+
+    @classmethod
+    def previously_stored_contact(cls, source, field, search_term):
+        client = EBook.BookClient.new(source)
+        client.open_sync(False, None)
+        q = EBook.book_query_vcard_field_test(field, EBook.BookQueryTest(0), search_term)        
+        cs = client.get_contacts_sync(q.to_string(), Gio.Cancellable())
+        log.debug("search string %s", q.to_string())
+        if cs[0] == False:
+           return False # is this right ...
+        return len(cs[1]) > 0                        
+
     @classmethod
     def get_features(cls):
         """Report what public operations we expose over DBus."""