TSE Feature Support

- Added support to TSE

Author: ipetresf

FuelSDK/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '1.0.1'
+__version__ = '1.1.1'
 
 # Runtime patch the suds library
 from FuelSDK.suds_patch import _PropertyAppender

FuelSDK/client.py

@@ -32,7 +32,9 @@ class ET_Client(object):
     authObj = None
     soap_client = None
     auth_url = None
-        
+    soap_endpoint = None
+    soap_cache_file = "soap_cache_file.json"
+
     ## get_server_wsdl - if True and a newer WSDL is on the server than the local filesystem retrieve it
     def __init__(self, get_server_wsdl = False, debug = False, params = None, tokenResponse=None):
         self.debug = debug
@@ -82,6 +84,15 @@ def __init__(self, get_server_wsdl = False, debug = False, params = None, tokenR
         else:
             wsdl_server_url = 'https://webservice.exacttarget.com/etframework.wsdl'
 
+        if params is not None and 'baseapiurl' in params:
+            self.base_api_url = params['baseapiurl']
+        elif config.has_option('Web Services', 'baseapiurl'):
+            self.base_api_url = config.get('Web Services', 'baseapiurl')
+        elif 'FUELSDK_BASE_API_URL' in os.environ:
+            self.base_api_url = os.environ['FUELSDK_BASE_API_URL']
+        else:
+            self.base_api_url = 'https://www.exacttargetapis.com'
+
         if params is not None and 'authenticationurl' in params:
             self.auth_url = params['authenticationurl']
         elif config.has_option('Web Services', 'authenticationurl'):
@@ -91,6 +102,13 @@ def __init__(self, get_server_wsdl = False, debug = False, params = None, tokenR
         else:
             self.auth_url = 'https://auth.exacttargetapis.com/v1/requestToken?legacy=1'
 
+        if params is not None and 'soapendpoint' in params:
+            self.soap_endpoint = params['soapendpoint']
+        elif config.has_option('Web Services', 'soapendpoint'):
+            self.soap_endpoint = config.get('Web Services', 'soapendpoint')
+        elif 'FUELSDK_SOAP_ENDPOINT' in os.environ:
+            self.soap_endpoint = os.environ['FUELSDK_SOAP_ENDPOINT']
+
         if params is not None and "wsdl_file_local_loc" in params:
             wsdl_file_local_location = params["wsdl_file_local_loc"]
         elif config.has_option("Web Services", "wsdl_file_local_loc"):
@@ -152,24 +170,22 @@ def retrieve_server_wsdl(self, wsdl_url, file_location):
 
 
     def build_soap_client(self):
-        if self.endpoint is None: 
-            self.endpoint = self.determineStack()
-        
-        self.authObj = {'oAuth' : {'oAuthToken' : self.internalAuthToken}}          
-        self.authObj['attributes'] = { 'oAuth' : { 'xmlns' : 'http://exacttarget.com' }}                        
+        if self.soap_endpoint is None or not self.soap_endpoint:
+            self.soap_endpoint = self.get_soap_endpoint()
 
         self.soap_client = suds.client.Client(self.wsdl_file_url, faults=False, cachingpolicy=1)
-        self.soap_client.set_options(location=self.endpoint)
+        self.soap_client.set_options(location=self.soap_endpoint)
+        self.soap_client.set_options(headers={'user-agent' : 'FuelSDK-Python-v1.1.1'})
 
         element_oAuth = Element('oAuth', ns=('etns', 'http://exacttarget.com'))
         element_oAuthToken = Element('oAuthToken').setText(self.internalAuthToken)
         element_oAuth.append(element_oAuthToken)
-        self.soap_client.set_options(soapheaders=(element_oAuth))               
-        
+        self.soap_client.set_options(soapheaders=(element_oAuth))
+
         security = suds.wsse.Security()
         token = suds.wsse.UsernameToken('*', '*')
         security.tokens.append(token)
-        self.soap_client.set_options(wsse=security)             
+        self.soap_client.set_options(wsse=security)
 
 
     def refresh_token(self, force_refresh = False):
@@ -178,14 +194,19 @@ def refresh_token(self, force_refresh = False):
         """
         #If we don't already have a token or the token expires within 5 min(300 seconds), get one
         if (force_refresh or self.authToken is None or (self.authTokenExpiration is not None and time.time() + 300 > self.authTokenExpiration)):
-            headers = {'content-type' : 'application/json', 'user-agent' : 'FuelSDK-Python'}
+            headers = {'content-type' : 'application/json', 'user-agent' : 'FuelSDK-Python-v1.1.1'}
             if (self.authToken is None):
                 payload = {'clientId' : self.client_id, 'clientSecret' : self.client_secret, 'accessType': 'offline'}
             else:
                 payload = {'clientId' : self.client_id, 'clientSecret' : self.client_secret, 'refreshToken' : self.refreshKey, 'accessType': 'offline'}
             if self.refreshKey:
                 payload['refreshToken'] = self.refreshKey
 
+            legacyString = "?legacy=1"
+            if legacyString not in self.auth_url:
+                self.auth_url = self.auth_url.strip()
+                self.auth_url = self.auth_url + legacyString
+
             r = requests.post(self.auth_url, data=json.dumps(payload), headers=headers)
             tokenResponse = r.json()
 
@@ -199,21 +220,53 @@ def refresh_token(self, force_refresh = False):
                 self.refreshKey = tokenResponse['refreshToken']
 
             self.build_soap_client()
-            
 
-    def determineStack(self):
+    def get_soap_cache_file(self):
+        json_data = {}
+        if os.path.isfile(self.soap_cache_file):
+            file = open(self.soap_cache_file, "r")
+            json_data = json.load(file)
+            file.close()
+
+        return json_data
+
+    def update_cache_file(self, url):
+        file = open(self.soap_cache_file, "w+")
+
+        data = {}
+        data['url'] = url
+        data['timestamp'] = time.time() + (10 * 60)
+        json.dump(data, file)
+        file.close()
+
+    def get_soap_endpoint(self):
+        default_endpoint = 'https://webservice.exacttarget.com/Service.asmx'
+
+        cache_file_data = self.get_soap_cache_file()
+
+        if 'url' in cache_file_data and 'timestamp' in cache_file_data \
+            and cache_file_data['timestamp'] > time.time():
+            return cache_file_data['url']
+
         """
         find the correct url that data request web calls should go against for the token we have.
         """
         try:
-            r = requests.get('https://www.exacttargetapis.com/platform/v1/endpoints/soap?access_token=' + self.authToken, {'user-agent' : 'FuelSDK-Python'})
+            r = requests.get(self.base_api_url + '/platform/v1/endpoints/soap', headers={
+                'user-agent': 'FuelSDK-Python-v1.1.1',
+                'authorization': 'Bearer ' + self.authToken
+            })
+
             contextResponse = r.json()
-            if('url' in contextResponse):
-                return str(contextResponse['url'])
+            if ('url' in contextResponse):
+                soap_url = str(contextResponse['url'])
+                self.update_cache_file(soap_url)
+                return soap_url
+            else:
+                return default_endpoint
 
         except Exception as e:
-            raise Exception('Unable to determine stack using /platform/v1/tokenContext: ' + e.message)  
-
+            return default_endpoint
 
     def AddSubscriberToList(self, emailAddress, listIDs, subscriberKey = None):
         """

FuelSDK/config.python.template

@@ -3,5 +3,7 @@ appsignature: none
 clientid: XXXXXXXXXXXXXXXXXXXXXXXX
 clientsecret: XXXXXXXXXXXXXXXXXXXXXXXX
 defaultwsdl: https://webservice.exacttarget.com/etframework.wsdl
+baseapiurl: https://www.exacttargetapis.com
 authenticationurl: https://auth.exacttargetapis.com/v1/requestToken?legacy=1
+soapendpoint: https://webservice.exacttarget.com/Service.asmx
 wsdl_file_local_loc: /tmp/ExactTargetWSDL.s6.xml

FuelSDK/objects.py

@@ -57,21 +57,21 @@ def __init__(self):
 class ET_Campaign(ET_CUDSupportRest):
     def __init__(self):
         super(ET_Campaign, self).__init__()
-        self.endpoint = 'https://www.exacttargetapis.com/hub/v1/campaigns/{id}'
+        self.path = '/hub/v1/campaigns/{id}'
         self.urlProps = ["id"]
         self.urlPropsRequired = []
 
     ##the patch rest service is not implemented for campaigns yet.  use post instead and remove this when patch is implemented on the back end
     def patch(self):
-        self.endpoint = 'https://www.exacttargetapis.com/hub/v1/campaigns'  #don't put the id on the url when patching via post
+        self.path = '/hub/v1/campaigns'  #don't put the id on the url when patching via post
         obj = super(ET_Campaign, self).post()
-        self.endpoint = 'https://www.exacttargetapis.com/hub/v1/campaigns/{id}' #but set it back to the url with id for other operations to continue working
+        self.path = '/hub/v1/campaigns/{id}' #but set it back to the url with id for other operations to continue working
         return obj
 
 class ET_Campaign_Asset(ET_CUDSupportRest):
     def __init__(self):
         super(ET_Campaign_Asset, self).__init__()
-        self.endpoint = 'https://www.exacttargetapis.com/hub/v1/campaigns/{id}/assets/{assetId}'
+        self.path = '/hub/v1/campaigns/{id}/assets/{assetId}'
         self.urlProps = ["id", "assetId"]
         self.urlPropsRequired = ["id"]
 

FuelSDK/rest.py

@@ -270,7 +270,7 @@ class ET_BaseObject(object):
     auth_stub = None
     obj = None
     last_request_id = None
-    endpoint = None
+    path = None
     props = None
     extProps = None
     search_filter = None
@@ -325,11 +325,14 @@ def getMoreResults(self):
 class ET_GetRest(ET_Constructor):
     def __init__(self, auth_stub, endpoint, qs = None):
         auth_stub.refresh_token()   
-        fullendpoint = endpoint + '?access_token=' + auth_stub.authToken
+        fullendpoint = endpoint
+        urlSeparator = '?'
         for qStringValue in qs:
-            fullendpoint += '&'+    qStringValue + '=' + str(qs[qStringValue])
+            fullendpoint += urlSeparator +    qStringValue + '=' + str(qs[qStringValue])
+            urlSeparator = '&'
 
-        r = requests.get(fullendpoint)
+        headers = {'authorization' : 'Bearer ' + auth_stub.authToken,  'user-agent' : 'FuelSDK-Python-v1.1.1'}
+        r = requests.get(fullendpoint, headers=headers)
 
 
         self.more_results = False
@@ -346,8 +349,8 @@ class ET_PostRest(ET_Constructor):
     def __init__(self, auth_stub, endpoint, payload):
         auth_stub.refresh_token()
 
-        headers = {'content-type' : 'application/json', 'user-agent' : 'FuelSDK-Python'}
-        r = requests.post(endpoint + '?access_token=' + auth_stub.authToken , data=json.dumps(payload), headers=headers)
+        headers = {'content-type' : 'application/json', 'user-agent' : 'FuelSDK-Python-v1.1.1', 'authorization' : 'Bearer ' + auth_stub.authToken}
+        r = requests.post(endpoint, data=json.dumps(payload), headers=headers)
 
         obj = super(ET_PostRest, self).__init__(r, True)
         return obj
@@ -361,8 +364,8 @@ class ET_PatchRest(ET_Constructor):
     def __init__(self, auth_stub, endpoint, payload):
         auth_stub.refresh_token()
 
-        headers = {'content-type' : 'application/json', 'user-agent' : 'FuelSDK-Python'}
-        r = requests.patch(endpoint + '?access_token=' + auth_stub.authToken , data=json.dumps(payload), headers=headers)
+        headers = {'content-type' : 'application/json', 'user-agent' : 'FuelSDK-Python-v1.1.1', 'authorization' : 'Bearer ' + auth_stub.authToken}
+        r = requests.patch(endpoint , data=json.dumps(payload), headers=headers)
 
         obj = super(ET_PatchRest, self).__init__(r, True)
         return obj
@@ -375,8 +378,9 @@ def __init__(self, auth_stub, endpoint, payload):
 class ET_DeleteRest(ET_Constructor):
     def __init__(self, auth_stub, endpoint):
         auth_stub.refresh_token()
-        
-        r = requests.delete(endpoint + '?access_token=' + auth_stub.authToken)
+
+        headers = {'authorization' : 'Bearer ' + auth_stub.authToken, 'user-agent' : 'FuelSDK-Python-v1.1.1'}
+        r = requests.delete(endpoint, headers=headers)
 
         obj = super(ET_DeleteRest, self).__init__(r, True)
         return obj
@@ -429,8 +433,8 @@ def __init__(self):
     def get(self, props = None):
         if props is not None and type(props) is dict:
             self.props = props
-            
-        completeURL = self.endpoint     
+
+        completeURL = self.auth_stub.base_api_url + self.path
         additionalQS = {}
 
         if self.props is not None and type(self.props) is dict:
@@ -497,15 +501,15 @@ def getMoreResults(self):
 ##
 ########            
 class ET_CUDSupportRest(ET_GetSupportRest):
-    endpoint = None
+    path = None
     urlProps = None
     urlPropsRequired = None
 
     def __init__(self):
         super
 
     def post(self):
-        completeURL = self.endpoint 
+        completeURL = self.auth_stub.base_api_url + self.path
 
         if self.props is not None and type(self.props) is dict:
             for k, v in self.props.items():
@@ -524,7 +528,7 @@ def post(self):
         return obj      
 
     def patch(self):
-        completeURL = self.endpoint
+        completeURL = self.auth_stub.base_api_url + self.path
         # All URL Props are required when doing Patch   
         for value in self.urlProps: 
             if self.props is None or value not in self.props:
@@ -539,7 +543,7 @@ def patch(self):
         return obj
 
     def delete(self):
-        completeURL = self.endpoint     
+        completeURL = self.auth_stub.base_api_url + self.path
         # All URL Props are required when doing Patch   
         for value in self.urlProps: 
             if self.props is None or value not in self.props:

README.md

@@ -1,11 +1,15 @@
-# FuelSDK-Python v1.0.1
+# FuelSDK-Python v1.1.1
 
 Salesforce Marketing Cloud Fuel SDK for Python
 
 ## Overview
 
 The Fuel SDK for Python provides easy access to Salesforce Marketing Cloud's Fuel API Family services, including a collection of REST APIs and a SOAP API. These APIs provide access to Salesforce Marketing Cloud functionality via common collection types such as array/hash.
 
+New Features in Version 1.1.1 
+------------
+* Added support for your tenant’s endpoints - [More Details](https://developer.salesforce.com/docs/atlas.en-us.mc-apis.meta/mc-apis/your-subdomain-tenant-specific-endpoints.htm)
+
 ## Installation
 
 The Fuel SDK for python can be easily installed from the [Python Package Index](https://pypi.python.org/pypi) using the [pip](https://pip.readthedocs.org) command. Pip is a tool for installing and managing Python packages.
@@ -26,12 +30,16 @@ You must configure your access tokens and details for the Fuel SDK in one of the
     * `FUELSDK_CLIENT_SECRET` (required)
     * `FUELSDK_APP_SIGNATURE`
     * `FUELSDK_DEFAULT_WSDL`
+    * `FUELSDK_BASE_API_URL`
     * `FUELSDK_AUTH_URL`
+    * `FUELSDK_SOAP_ENDPOINT`
     * `FUELSDK_WSDL_FILE_LOCAL_LOC`
 
 Edit `config.python` or declare environment variables so you can input the ClientID and Client Secret values provided when you registered your application. If you are building a HubExchange application for the Interactive Marketing Hub then, you must also provide the Application Signature (`appsignature` / `FUELSDK_APP_SIGNATURE`).
 The `defaultwsdl` / `FUELSDK_DEFAULT_WSDL` configuration must be [changed depending on the Salesforce marketing cloud service](https://code.exacttarget.com/question/there-any-cetificrate-install-our-server-access-et-api "Salesforce Marketing Cloud Forum").
-The `authenticationurl` / `FUELSDK_AUTH_URL` must also be [changed depending on service](https://code.exacttarget.com/question/not-able-create-accesstoken-when-clientidsecret-associated-preproduction-account "Salesforce Marketing Cloud Forum").
+The `baseapiurl` / `FUELSDK_BASE_API_URL` refers to the hostname where the API is hosted, if omitted it will default to [https://www.exacttargetapis.com](https://www.exacttargetapis.com).
+The `authenticationurl` / `FUELSDK_AUTH_URL` must also be [changed depending on service](https://code.exacttarget.com/question/not-able-create-accesstoken-when-clientidsecret-associated-preproduction-account "Salesforce Marketing Cloud Forum"). If omitted it will default to [https://auth.exacttargetapis.com/v1/requestToken?legacy=1](https://auth.exacttargetapis.com/v1/requestToken?legacy=1).
+The `soapendpoint` / `FUELSDK_SOAP_ENDPOINT` refers to the endpoint that will be used for doing SOAP calls. If omitted it will default to [https://webservice.exacttarget.com/Service.asmx](https://webservice.exacttarget.com/Service.asmx).
 The `wsdl_file_local_loc` / `FUELSDK_WSDL_FILE_LOCAL_LOC` allows you to specify the full path/filename where the WSDL file will be located on disk, if for instance you are connecting to different endpoints from the same server.
 
 If you have not registered your application or you need to lookup your Application Key or Application Signature values, please go to App Center at [Code@: Salesforce Marketing Cloud's Developer Community](https://developer.salesforce.com/docs/?filter_text=&service=Marketing%20Cloud "Code@ App Center").

setup.py

@@ -4,7 +4,7 @@
     readme = f.read()
 
 setup(
-    version='1.0.1',
+    version='1.1.1',
     name='Salesforce-FuelSDK',
     description='Salesforce Marketing Cloud Fuel SDK for Python',
     long_description=readme,