Merge pull request #10 from campaignmonitor/add-external-session-support

Added support for getting an external session login URL.

createsend/createsend.py

@@ -5,6 +5,10 @@
 import gzip
 from StringIO import StringIO
 from urlparse import urlparse
+try:
+  import json
+except ImportError:
+  import simplejson as json
 from utils import json_to_py, get_faker
 
 __version_info__ = ('3', '0', '0')
@@ -237,17 +241,46 @@ def timezones(self):
     return json_to_py(response)
 
   def administrators(self):
-  	"""gets administrators associated with the account"""
+  	"""Gets administrators associated with the account"""
   	response = self._get('/admins.json')
   	return json_to_py(response)
 
   def get_primary_contact(self):
-  	"""retrieves the primary contact for this account"""
+  	"""Retrieves the primary contact for this account"""
   	response = self._get('/primarycontact.json')
   	return json_to_py(response)
 
   def set_primary_contact(self, email):
-    """assigns the primary contact for this account"""
+    """Assigns the primary contact for this account"""
     params = { "email": email }
     response = self._put('/primarycontact.json', params = params)
     return json_to_py(response)
+
+  def external_session_url(self, email, chrome, url, integrator_id, client_id):
+    """
+    Get a URL which initiates a new external session for the user with the
+    given email.
+    Full details: http://www.campaignmonitor.com/api/account/#single_sign_on
+
+    :param email: String The representing the email address of the
+      Campaign Monitor user for whom the login session should be created.
+    :param chrome: String representing which 'chrome' to display - Must be
+      either "all", "tabs", or "none".
+    :param url: String representing the URL to display once logged in.
+      e.g. "/subscribers/"
+    :param integrator_id: String representing the Integrator ID. You need to
+      contact Campaign Monitor support to get an Integrator ID.
+    :param client_id: String representing the Client ID of the client which
+      should be active once logged in to the Campaign Monitor account.
+
+    :returns Object containing a single field SessionUrl which represents
+    the URL to initiate the external Campaign Monitor session.
+    """
+    body = {
+      "Email": email, 
+      "Chrome": chrome,
+      "Url": url,
+      "IntegratorID": integrator_id,
+      "ClientID": client_id }
+    response = self._put('/externalsession.json', json.dumps(body))
+    return json_to_py(response)

test/fixtures/external_session.json

@@ -0,0 +1,3 @@
+{
+  "SessionUrl": "https://external1.createsend.com/cd/create/ABCDEF12/DEADBEEF?url=FEEDDAD1"
+}

test/test_createsend.py

@@ -64,6 +64,16 @@ def test_set_primary_contact(self):
     result = self.cs.set_primary_contact(email)
     self.assertEquals(email, result.EmailAddress)
 
+  def test_external_session_url(self):
+    email = "exammple@example.com"
+    chrome = "None"
+    url = "/subscribers"
+    integrator_id = "qw989q8wud98qwyd"
+    client_id = "9q8uw9d8u9wud"
+    self.cs.stub_request('externalsession.json', 'external_session.json')
+    result = self.cs.external_session_url(email, chrome, url, integrator_id, client_id)
+    self.assertEquals("https://external1.createsend.com/cd/create/ABCDEF12/DEADBEEF?url=FEEDDAD1", result.SessionUrl)
+
   # Test fake web mode
   def test_make_request_fails_when_unexpected_request_url_is_faked(self):
     self.cs.stub_request("unexpected/url.json", "clients.json")