forked from jslang/responsys
-
Notifications
You must be signed in to change notification settings - Fork 0
/
client.py
453 lines (363 loc) · 15.7 KB
/
client.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
import logging
from ssl import SSLError
from time import time
from urllib.error import URLError
from suds.client import Client
from suds import WebFault
from .exceptions import (
ConnectError, ServiceError, AccountFault, ApiLimitError, TableFault, ListFault)
from .types import (
RecordData, RecipientResult, MergeResult, DeleteResult, LoginResult, ServerAuthResult,
TriggerResult)
log = logging.getLogger(__name__)
class InteractClient(object):
""" Interact Client Class
Provides access to the methods defined by the Responsys Interact API. Example setup:
>>> client = InteractClient(username, password, pod)
>>> client.connect()
>>> client.merge_list_members(interact_object, records, merge_rules)
>>> client.disconnect()
Using the client class as a context manager will automatically connect using the credentials
provided, and disconnect upon context exit:
>>> with InteractClient(username, password, pod) as client:
... client.merge_list_members(interact_object, records, merge_rules)
Since responsys limits the number of active sessions per account, this can help ensure you
don't leave unused connections open.
"""
DEFAULT_SESSION_LIFETIME = 60 * 10
WSDLS = {
'2': 'https://ws2.responsys.net/webservices/wsdl/ResponsysWS_Level1.wsdl',
'5': 'https://ws5.responsys.net/webservices/wsdl/ResponsysWS_Level1.wsdl',
'rtm4': 'https://rtm4.responsys.net/tmws/services/TriggeredMessageWS?wsdl',
'rtm4b': 'https://rtm4b.responsys.net/tmws/services/TriggeredMessageWS?wsdl',
}
ENDPOINTS = {
'2': 'https://ws2.responsys.net/webservices/services/ResponsysWSService',
'5': 'https://ws5.responsys.net/webservices/services/ResponsysWSService',
'rtm4': 'http://rtm4.responsys.net:80/tmws/services/TriggeredMessageWS',
'rtm4b': 'http://rtm4b.responsys.net:80/tmws/services/TriggeredMessageWS',
}
@property
def wsdl(self):
return self.WSDLS[self.pod]
@property
def endpoint(self):
return self.ENDPOINTS[self.pod]
@property
def client(self):
if self._client is None:
self._client = Client(self.wsdl, location=self.endpoint, timeout=self.timeout)
return self._client
@property
def connected(self):
return getattr(self, '_connected', False)
@connected.setter
def connected(self, value):
self._connected = value
@property
def session(self):
return getattr(self, '_session', None)
@session.setter
def session(self, session_id):
self._session = type(
'Session', (tuple,), {
'is_expired': property(lambda s: s[1] + self.session_lifetime <= time()),
})([session_id, time()])
session_header = self.client.factory.create('SessionHeader')
session_header.sessionId = session_id
self.client.set_options(soapheaders=session_header)
@session.deleter
def session(self):
self._session = None
self.client.set_options(soapheaders=())
def __init__(self, username, password, pod, client=None, session_lifetime=600, timeout=5):
self.username = username
self.password = password
self.pod = pod
self.session_lifetime = session_lifetime
self.timeout = timeout
self._client = client
def __enter__(self):
self.connect()
return self
def __exit__(self, type_, value, traceback):
self.disconnect()
def call(self, method, *args):
""" Calls the service method defined with the arguments provided """
try:
response = getattr(self.client.service, method)(*args)
except (URLError, SSLError) as e:
log.exception('Failed to connect to responsys service')
raise ConnectError("Request to service timed out")
except WebFault as web_fault:
fault_name = str(getattr(web_fault.fault, 'faultstring', '')).strip()
error = str(web_fault.fault.detail)
if fault_name == 'TableFault':
raise TableFault(error)
if fault_name == 'ListFault':
raise ListFault(error)
if fault_name == 'API_LIMIT_EXCEEDED':
raise ApiLimitError(error)
if fault_name == 'AccountFault':
raise AccountFault(error)
log.exception('ServiceError: method={} args={} error={}'.format(method, args, error))
raise ServiceError(web_fault.fault, web_fault.document)
return response
def connect(self):
""" Connects to the Responsys soap service
Uses the credentials passed to the client init to login and setup the session id returned.
Returns True on successful connection, otherwise False.
"""
if self.session and self.session.is_expired:
# Close the session to avoid max concurrent session errors
self.disconnect(abandon_session=True)
if not self.session:
try:
login_result = self.login(self.username, self.password)
except AccountFault:
log.error('Login failed, invalid username or password')
raise
else:
self.session = login_result.session_id
self.connected = time()
return self.connected
def disconnect(self, abandon_session=False):
""" Disconnects from the Responsys soap service
Calls the service logout method and destroys the client's session information. Returns
True on success, False otherwise.
"""
self.connected = False
if (self.session and self.session.is_expired) or abandon_session:
try:
self.logout()
except:
log.warning(
'Logout call to responsys failed, session may have not been terminated',
exc_info=True
)
del self.session
return True
# Session Management Methods
def login(self, username, password):
""" Responsys.login soap call
Accepts username and password for authentication, returns a LoginResult object.
"""
return LoginResult(self.call('login', username, password))
def logout(self):
""" Responsys.logout soap call
Returns True on success, False otherwise.
"""
return self.call('logout')
def login_with_certificate(self, encrypted_server_challenge):
""" Responsys.loginWithCertificate soap call
Accepts encrypted_server_challenge for login. Returns LoginResult.
"""
return LoginResult(self.call('loginWithCertificate', encrypted_server_challenge))
def authenticate_server(self, username, client_challenge):
""" Responsys.authenticateServer soap call
Accepts username and client_challenge to authenciate. Returns ServerAuthResult.
"""
return ServerAuthResult(self.call('authenticateServer', username, client_challenge))
# List Management Methods
def merge_list_members(self, list_, record_data, merge_rule):
""" Responsys.mergeListMembers call
Accepts:
InteractObject list_
RecordData record_data
ListMergeRule merge_rule
Returns a MergeResult
"""
list_ = list_.get_soap_object(self.client)
record_data = record_data.get_soap_object(self.client)
merge_rule = merge_rule.get_soap_object(self.client)
return MergeResult(self.call('mergeListMembers', list_, record_data, merge_rule))
def merge_list_members_RIID(self, list_, record_data, merge_rule):
""" Responsys.mergeListMembersRIID call
Accepts:
InteractObject list_
RecordData record_data
ListMergeRule merge_rule
Returns a RecipientResult
"""
list_ = list_.get_soap_object(self.client)
result = self.call('mergeListMembersRIID', list_, record_data, merge_rule)
return RecipientResult(result.recipientResult)
def delete_list_members(self, list_, query_column, ids_to_delete):
""" Responsys.deleteListMembers call
Accepts:
InteractObject list_
string query_column
possible values: 'RIID'|'EMAIL_ADDRESS'|'CUSTOMER_ID'|'MOBILE_NUMBER'
list ids_to_delete
Returns a list of DeleteResult instances
"""
list_ = list_.get_soap_object(self.client)
result = self.call('deleteListMembers', list_, query_column, ids_to_delete)
if hasattr(result, '__iter__'):
return [DeleteResult(delete_result) for delete_result in result]
return [DeleteResult(result)]
def retrieve_list_members(self, list_, query_column, field_list, ids_to_retrieve):
""" Responsys.retrieveListMembers call
Accepts:
InteractObject list_
string query_column
possible values: 'RIID'|'EMAIL_ADDRESS'|'CUSTOMER_ID'|'MOBILE_NUMBER'
list field_list
list ids_to_retrieve
Returns a RecordData instance
"""
list_ = list_.get_soap_object(self.client)
result = self.call('retrieveListMembers', list_, query_column, field_list, ids_to_retrieve)
return RecordData.from_soap_type(result.recordData)
# Table Management Methods
def create_table(self, table, fields):
""" Responsys.createTable call
Accepts:
InteractObject table
list fields
Returns True on success
"""
table = table.get_soap_object(self.client)
return self.call('createTable', table, fields)
def create_table_with_pk(self, table, fields, primary_keys):
""" Responsys.createTableWithPK call
Accepts:
InteractObject table
list fields
list primary_keys
Returns True on success
"""
table = table.get_soap_object(self.client)
return self.call('createTableWithPK', table, fields, primary_keys)
def delete_table(self, table):
""" Responsys.deleteTable call
Accepts:
InteractObject table
Returns True on success
"""
table = table.get_soap_object(self.client)
return self.call('deleteTable', table)
def delete_profile_extension_members(self, profile_extension, query_column, ids_to_delete):
""" Responsys.deleteProfileExtensionRecords call
Accepts:
InteractObject profile_extension
list field_list
list ids_to_retrieve
string query_column
default: 'RIID'
Returns list of DeleteResults
"""
profile_extension = profile_extension.get_soap_object(self.client)
result = self.call(
'deleteProfileExtensionMembers', profile_extension, query_column, ids_to_delete)
if hasattr(result, '__iter__'):
return [DeleteResult(delete_result) for delete_result in result]
return [DeleteResult(result)]
def retrieve_profile_extension_records(self, profile_extension, field_list, ids_to_retrieve,
query_column='RIID'):
""" Responsys.retrieveProfileExtensionRecords call
Accepts:
InteractObject profile_extension
list field_list
list ids_to_retrieve
string query_column
default: 'RIID'
Returns RecordData
"""
profile_extension = profile_extension.get_soap_object(self.client)
return RecordData.from_soap_type(
self.call('retrieveProfileExtensionRecords',
profile_extension, query_column, field_list, ids_to_retrieve))
def truncate_table(self, table):
""" Responsys.truncateTable call
Accepts:
InteractObject table
Returns True on success
"""
table = table.get_soap_object(self.client)
return self.call('truncateTable', table)
def delete_table_records(self, table, query_column, ids_to_delete):
""" Responsys.deleteTableRecords call
Accepts:
InteractObject table
string query_column
possible values: 'RIID'|'EMAIL_ADDRESS'|'CUSTOMER_ID'|'MOBILE_NUMBER'
list ids_to_delete
Returns a list of DeleteResult instances
"""
table = table.get_soap_object(self.client)
result = self.call('deleteTableRecords', table, query_column, ids_to_delete)
if hasattr(result, '__iter__'):
return [DeleteResult(delete_result) for delete_result in result]
return [DeleteResult(result)]
def merge_table_records(self, table, record_data, match_column_names):
""" Responsys.mergeTableRecords call
Accepts:
InteractObject table
RecordData record_data
list match_column_names
Returns a MergeResult
"""
table = table.get_soap_object(self.client)
record_data = record_data.get_soap_object(self.client)
return MergeResult(self.call(
'mergeTableRecords', table, record_data, match_column_names))
def merge_table_records_with_pk(self, table, record_data, insert_on_no_match, update_on_match):
""" Responsys.mergeTableRecordsWithPK call
Accepts:
InteractObject table
RecordData record_data
string insert_on_no_match
string update_on_match
Returns a MergeResult
"""
table = table.get_soap_object(self.client)
record_data = record_data.get_soap_object(self.client)
return MergeResult(self.call(
'mergeTableRecordsWithPK', table, record_data, insert_on_no_match, update_on_match))
def merge_into_profile_extension(self, profile_extension, record_data, match_column,
insert_on_no_match, update_on_match):
""" Responsys.mergeIntoProfileExtension call
Accepts:
InteractObject profile_extension
RecordData record_data
string match_column
string insert_on_no_match
string update_on_match
Returns a RecipientResult
"""
profile_extension = profile_extension.get_soap_object(self.client)
record_data = record_data.get_soap_object(self.client)
results = self.call(
'mergeIntoProfileExtension', profile_extension, record_data, match_column,
insert_on_no_match, update_on_match)
return [RecipientResult(result) for result in results]
def retrieve_table_records(self, table, query_column, field_list, ids_to_retrieve):
""" Responsys.retrieveTableRecords call
Accepts:
InteractObject table
string query_column
possible values: 'RIID'|'EMAIL_ADDRESS'|'CUSTOMER_ID'|'MOBILE_NUMBER'
list field_list
list ids_to_retrieve
Returns a RecordData
"""
table = table.get_soap_object(self.client)
return RecordData.from_soap_type(self.call(
'retrieveTableRecords', table, query_column, field_list, ids_to_retrieve))
# Campaign Management Methods
# TODO: implement
# GetLaunchStatus
# LaunchCampaign
# MergeTriggerEmail
# ScheduleCampaignLaunch
# TriggerCampaignMessage
def trigger_custom_event(self, custom_event, recipient_data=None):
custom_event = custom_event.get_soap_object(self.client)
recipient_data = [rdata.get_soap_object(self.client) for rdata in recipient_data]
results = self.call('triggerCustomEvent', custom_event, recipient_data)
return [TriggerResult(result) for result in results]
# TODO: Implement
#
# Content Management Methods
# Folder Management Methods