Merge lp:~cjwatson/canonical-identity-provider/ssoclient-accounts-bulk into lp:~canonical-isd-hackers/canonical-identity-provider/ssoclient

[Colin Watson]

Add support for the accounts-bulk API.

This is the client side of https://code.launchpad.net/~cjwatson/canonical-identity-provider/api-accounts-bulk/+merge/335393.

[Natalia Bidart (nataliabidart)]

Looks great, thanks!

review: Approve

=== modified file 'ssoclient/tests/test_v2.py'
--- ssoclient/tests/test_v2.py	2016-07-29 15:19:25 +0000
+++ ssoclient/tests/test_v2.py	2018-01-24 13:48:34 +0000
@@ -267,6 +267,36 @@
             'token_secret': 'YcQgfuhpajCphDCnfNNceggfolHsXqdsXWSRufbzqeRJvEP',
         }
 
+    def unparsed_account_details_bulk(self, expand=False):
+        """Unparsed bulk account details as how parse_response returns them."""
+        # For brevity, don't bother including all the fields here.
+        result = {
+            'FeAQLWE': {
+                'email': '[e-mail]',
+                'emails': [
+                    {'href': '/api/v2/emails/[e-mail]', 'verified': False},
+                ],
+                'href': '/api/v2/accounts/FeAQLWE',
+            },
+            'fzlFGM0': {
+                'email': '[e-mail]',
+                'emails': [
+                    {'href': '/api/v2/emails/[e-mail]', 'verified': False},
+                ],
+                'href': '/api/v2/accounts/fzlFGM0',
+            },
+        }
+        if expand:
+            result['FeAQLWE']['emails'][0].update({
+                'email': '[e-mail]',
+                'date_created': '2013-09-12T18:23:51.019',
+            })
+            result['fzlFGM0']['emails'][0].update({
+                'email': '[e-mail]',
+                'date_created': '2014-09-12T18:23:51.019',
+            })
+        return result
+
     def assert_unicode_credentials(self, credentials):
         self.mock_oauth.assert_called_once_with(
             credentials['consumer_key'], credentials['consumer_secret'],
@@ -618,6 +648,47 @@
         )
         self.assertEqual(response, content)
 
+    def test_account_details_bulk(self):
+        content = self.unparsed_account_details_bulk()
+        self.mock_request.return_value = mock_response(
+            status_code=200, content=content)
+        response = self.client.account_details_bulk(
+            ['FeAQLWE', 'fzlFGM0'], self.credentials)
+        self.assert_unicode_credentials(self.credentials)
+
+        oauth1 = self.mock_oauth.return_value
+        self.assert_request_called_with(
+            'POST', 'http://foo.com/accounts-bulk',
+            auth=oauth1, headers={'Content-Type': 'application/json'},
+            data={'openids': ['FeAQLWE', 'fzlFGM0'], 'expand': False},
+        )
+
+        self.assertEqual(response, content)
+
+    def test_account_details_bulk_expanded(self):
+        content = self.unparsed_account_details_bulk(expand=True)
+        self.mock_request.return_value = mock_response(
+            status_code=200, content=content)
+        response = self.client.account_details_bulk(
+            ['FeAQLWE', 'fzlFGM0'], self.credentials, expand=True)
+        self.assert_unicode_credentials(self.credentials)
+
+        oauth1 = self.mock_oauth.return_value
+        self.assert_request_called_with(
+            'POST', 'http://foo.com/accounts-bulk',
+            auth=oauth1, headers={'Content-Type': 'application/json'},
+            data={'openids': ['FeAQLWE', 'fzlFGM0'], 'expand': True},
+        )
+
+        expected = content.copy()
+        # dates are parsed
+        e = expected['FeAQLWE']['emails'][0]
+        e['date_created'] = datetime(2013, 9, 12, 18, 23, 51, 19000)
+        e = expected['fzlFGM0']['emails'][0]
+        e['date_created'] = datetime(2014, 9, 12, 18, 23, 51, 19000)
+
+        self.assertEqual(response, expected)
+
 
 class EmailsV2ClientApiTestCase(V2ClientApiTestCase):
 

=== modified file 'ssoclient/v2/client.py'
--- ssoclient/v2/client.py	2016-07-29 15:19:25 +0000
+++ ssoclient/v2/client.py	2018-01-24 13:48:34 +0000
@@ -46,7 +46,7 @@
 
 
 class V2ApiClient(object):
-    """High-level client for theV2.0 API SSO resources."""
+    """High-level client for the V2.0 API SSO resources."""
 
     def __init__(self, endpoint):
         self.session = ApiSession(endpoint)
@@ -107,6 +107,17 @@
         result = parse_datetimes(response.content)
         return result
 
+    def account_details_bulk(self, openids, token, expand=False):
+        oauth = self._unicode_credentials(token)
+        data = {
+            'openids': [str(openid) for openid in openids],
+            'expand': expand,
+        }
+
+        response = self.session.post('/accounts-bulk', data=data, auth=oauth)
+        result = parse_datetimes(response.content)
+        return result
+
     def email_delete(self, email, credentials):
         oauth = self._unicode_credentials(credentials)
         response = self.session.delete('/emails/%s' % email, auth=oauth)