Merge pull request #5 from tnydwrds/fix-0.3.2-optional-realm-support

Fix 0.3.2 - optional realm support

Author: tnydwrds

History.md

@@ -1,3 +1,8 @@
+0.3.2 / 2013-10-09
+==================
+* Added: Optional realm support
+     * `Client.__init__`'s `realm` parameter is now optional (or named).
+
 0.3.1 / 2013-06-04
 ==================
  * Removed: Realm Support
@@ -10,15 +15,13 @@
  * Fixed: JSON support for Python 2.4 and 2.5
  * Fixed: OAuth support for Python 2.4
  * Fixed: Version number below (0.2.1)
- 
 
 0.2.1 / 2012-09-25
 ==================
   # Added: `upload_creative` to support uploading creative files.
 
 0.2.0 / 2012-08-29
 ==================
-
   * Fixed: JSON parse error when deleting objects with call to `Client.delete()`
   * Added: "Official" support for Python 2.4, 2.5, 2.6
   * Added: `logon` and `logoff` convenience methods.
@@ -27,5 +30,4 @@
 
 0.1.0 / 2012-08-26
 ==================
-
   * "Official release"

ox3apiclient/__init__.py

@@ -20,7 +20,7 @@
 if major_py_version == 2 and minor_py_version > 4:
     import oauth2 as oauth
 else:
-    import oauth2_version as oauth 
+    import oauth2_version as oauth
 
 import urllib
 import urllib2
@@ -33,7 +33,7 @@
 
 import urlparse
 
-__version__ = '0.3.1'
+__version__ = '0.3.2'
 
 REQUEST_TOKEN_URL = 'https://sso.openx.com/api/index/initiate'
 ACCESS_TOKEN_URL = 'https://sso.openx.com/api/index/token'
@@ -43,7 +43,8 @@
 
 class Client(object):
 
-    def __init__(self, domain, realm, consumer_key, consumer_secret,
+    def __init__(self, domain, consumer_key, consumer_secret,
+                    realm='',
                     callback_url='oob',
                     scheme='http',
                     request_token_url=REQUEST_TOKEN_URL,
@@ -57,9 +58,9 @@ def __init__(self, domain, realm, consumer_key, consumer_secret,
         """
 
         domain -- Your UI domain. The API is accessed off this domain.
-        realm -- This is no longer used. Just specify None.
         consumer_key -- Your consumer key.
         consumer_secret -- Your consumer secret.
+        realm -- Optional realm.
         callback_url -- Callback URL to redirect to on successful authorization.
             We default to 'oob' for headless login.
         request_token -- Only override for debugging.
@@ -68,12 +69,13 @@ def __init__(self, domain, realm, consumer_key, consumer_secret,
         api_path -- Only override for debugging.
         http_proxy -- Optional proxy to send HTTP requests through.
         """
-        
+
         self.domain = domain
         self.consumer_key = consumer_key
         self.consumer_secret = consumer_secret
+        self.realm = realm
         self.callback_url = callback_url
-        self.scheme=scheme
+        self.scheme = scheme
         self.request_token_url = request_token_url
         self.access_token_url = access_token_url
         self.authorization_url = authorization_url
@@ -130,8 +132,9 @@ def _sign_request(self, req):
             oauth.SignatureMethod_HMAC_SHA1(),
             self._consumer,
             self._token)
-        
-        req.headers.update(oauth_req.to_header())
+
+        req.headers.update(oauth_req.to_header(realm=self.realm))
+
         return \
             urllib2.Request(req.get_full_url(), headers=req.headers, data=data)
 
@@ -159,7 +162,7 @@ def request(self, url, method='GET', headers={}, data=None, sign=False):
             # Everything needs to be UTF-8 for urlencode:
             data_utf8 = req.get_data()
             for i in data_utf8:
-                data_utf8[i] = data_utf8[i].encode('utf-8') 
+                data_utf8[i] = data_utf8[i].encode('utf-8')
             req.add_data(urllib.urlencode(data_utf8))
 
         # In 2.4 and 2.5, urllib2 throws errors for all non 200 status codes.
@@ -392,6 +395,7 @@ def client_from_file(file_path='.ox3rc', env=None):
 
     # Load optional parameters.
     optional_params = [
+        'realm',
         'callback_url',
         'scheme',
         'request_token_url',