This repository was archived by the owner on Nov 13, 2025. It is now read-only.
Repository navigation
Expand file tree
/
Copy pathuser.py
More file actions
559 lines (449 loc) · 15.3 KB
/
Copy pathuser.py
File metadata and controls
559 lines (449 loc) · 15.3 KB
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
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
# coding=utf-8
#
# Copyright 2012 keyes.ie
#
# License: http://jkeyes.mit-license.org/
#
""" User module.
>>> from intercom import Intercom
>>> from intercom import User
"""
from . import Intercom
from . import from_timestamp_property
from . import to_timestamp_property
import numbers
class UserId(dict):
""" Base class for objects that required user_id and email properties. """
@property
def user_id(self):
""" Returns the user_id. """
return dict.get(self, 'user_id', None)
@user_id.setter
def user_id(self, user_id):
""" Sets the user_id. """
self['user_id'] = user_id
@property
def email(self):
""" Returns the email address. """
return dict.get(self, 'email', None)
@email.setter
def email(self, email):
""" Sets the email address. """
self['email'] = email
class User(UserId):
""" Object representing http://docs.intercom.io/#UserData). """
attributes = (
'user_id', 'email', 'name', 'created_at', 'custom_data',
'last_seen_ip', 'last_seen_user_agent', 'companies',
'last_impression_at', 'last_request_at', 'unsubscribed_from_emails')
@classmethod
def find(cls, user_id=None, email=None):
""" Find a user by email or user_id.
>>> user = User.find(email="somebody@example.com")
>>> user.user_id
u'123'
>>> user.name
u'Somebody'
>>> user = User.find(user_id=123)
>>> user.email
u'somebody@example.com'
>>> user.name
u'Somebody'
"""
resp = Intercom.get_user(user_id=user_id, email=email)
return cls(resp)
@classmethod
def find_by_email(cls, email):
""" Find a user by email.
>>> user = User.find_by_email("somebody@example.com")
>>> user.user_id
u'123'
>>> user.name
u'Somebody'
"""
resp = Intercom.get_user(email=email)
return cls(resp)
@classmethod
def find_by_user_id(cls, user_id):
""" Find a user by user_id.
>>> user = User.find(user_id=123)
>>> user.email
u'somebody@example.com'
>>> user.name
u'Somebody'
"""
resp = Intercom.get_user(user_id=user_id)
return cls(resp)
@classmethod
def create(cls, **kwargs):
""" Create or update a user.
>>> user = User.create(email="somebody@example.com",last_impression_at=1400000000)
>>> user.name
u'Somebody'
>>> user.last_impression_at.year
2011
"""
resp = Intercom.create_user(**kwargs)
return cls(resp)
@classmethod
def delete(cls, user_id=None, email=None):
""" Deletes a user.
>>> user = User.delete(email="somebody@example.com")
>>> user.user_id
u'123'
>>> user = User.delete(user_id="123")
>>> user.email
u'somebody@example.com'
"""
resp = Intercom.delete_user(user_id=user_id, email=email)
return cls(resp)
@classmethod
def all(cls):
""" Return all of the Users.
>>> users = User.all()
>>> len(users)
3
>>> users[0].email
u'first.user@example.com'
"""
page = 1
total_pages = 1
users = []
while page <= total_pages:
resp = Intercom.get_users(page=page)
page += 1
total_pages = resp.get('total_pages', 0)
users.extend([cls(u) for u in resp['users']])
return users
def save(self):
""" Creates or updates a User.
>>> user = User()
>>> user.email = "somebody@example.com"
>>> user.save()
>>> user.name
u'Somebody'
"""
attrs = {}
for key in User.attributes:
value = dict.get(self, key)
if value is not None:
attrs[key] = value
resp = Intercom.update_user(**attrs)
self.update(resp)
@property
def name(self):
""" Returns the name e.g. Joe Bloggs. """
return dict.get(self, 'name', None)
@name.setter
def name(self, name):
""" Sets the name. """
self['name'] = name
@property
def last_seen_ip(self):
""" Returns the last seen IP address. """
return dict.get(self, 'last_seen_ip', None)
@last_seen_ip.setter
def last_seen_ip(self, last_seen_ip):
""" Sets the last seen IP address. """
self['last_seen_ip'] = last_seen_ip
@property
def last_seen_user_agent(self):
""" Returns the last seen User Agent. """
return dict.get(self, 'last_seen_user_agent', None)
@last_seen_user_agent.setter
def last_seen_user_agent(self, last_seen_user_agent):
""" Sets the last seen User Agent. """
self['last_seen_user_agent'] = last_seen_user_agent
@property
@from_timestamp_property
def last_request_at(self):
""" Get last time this User interacted with your application. """
return dict.get(self, 'last_request_at', None)
@last_request_at.setter
@to_timestamp_property
def last_request_at(self, last_request_at):
""" Set time at which this User last made a request your application.
"""
self['last_request_at'] = last_request_at
@property
def relationship_score(self):
""" Returns the relationship score. """
return dict.get(self, 'relationship_score', None)
@property
def session_count(self):
""" Returns how many sessions this User has used on your
application. """
return dict.get(self, 'session_count', 0)
@property
@from_timestamp_property
def last_impression_at(self):
""" Returns the datetime this User last used your application. """
return dict.get(self, 'last_impression_at', None)
@last_impression_at.setter
@to_timestamp_property
def last_impression_at(self, last_impression_at):
""" Set time at which this User last made a request your application.
"""
self['last_impression_at'] = last_impression_at
@property
@from_timestamp_property
def created_at(self):
""" Returns the datetime this User started using your application. """
return dict.get(self, 'created_at', None)
@created_at.setter
@to_timestamp_property
def created_at(self, value):
""" Sets the timestamp when this User started using your
application. """
self['created_at'] = value
@property
def social_profiles(self):
""" Returns a list of SocialProfile objects for this User.
>>> users = User.all()
>>> social_profiles = users[0].social_profiles
>>> len(social_profiles)
2
>>> type(social_profiles[0])
<class 'intercom.user.SocialProfile'>
>>> social_profiles[0].type
u'twitter'
>>> social_profiles[0].url
u'http://twitter.com/abc'
"""
profiles = dict.get(self, 'social_profiles', None)
if profiles:
return [SocialProfile(**p) for p in profiles]
@property
def location_data(self):
""" Returns a LocationData object for this User.
>>> users = User.all()
>>> location_data = users[0].location_data
>>> type(location_data)
<class 'intercom.user.LocationData'>
>>> location_data.country_name
u'Chile'
>>> location_data.city_name
u'Santiago'
"""
data = dict.get(self, 'location_data', None)
if not isinstance(data, LocationData):
data = LocationData(data)
dict.__setitem__(self, 'location_data', data)
return data
@property
def unsubscribed_from_emails(self):
""" Returns whether or not the user has unsubscribed from emails """
return dict.get(self, 'unsubscribed_from_emails', None)
@unsubscribed_from_emails.setter
def unsubscribed_from_emails(self, unsubscribed_from_emails):
""" Sets whether or not the user has unsubscribed from email """
self['unsubscribed_from_emails'] = unsubscribed_from_emails
@property
def company(self):
""" Get the company of a user. Currently unsupported by the Intercom
API so an AttributeError is raised.
>>> user = User(email="somebody@example.com")
>>> user.company
Traceback (most recent call last):
...
AttributeError: company is a write-only property
"""
raise AttributeError("company is a write-only property")
@company.setter
def company(self, company):
""" Sets the company for a user.
>>> user = User(email="somebody@example.com")
>>> user.company = {'id':6, 'name': 'Intercom', 'created_at': 103201}
"""
if isinstance(company, Company):
self['companies'] = [company]
elif isinstance(company, dict):
self['companies'] = [Company(**company)]
else:
raise ValueError("company must be set as a dict or Company object")
@property
def companies(self):
""" Get the companies of a user. Currently unsupported by the Intercom
API so an AttributeError is raised.
>>> user = User(email="somebody@example.com")
>>> user.companies
Traceback (most recent call last):
...
AttributeError: companies is a write-only property
"""
raise AttributeError("companies is a write-only property")
@companies.setter
def companies(self, companies):
""" Sets the companies for the user
>>> user = User(email="somebody@example.com")
>>> user.companies = [{'id': 6, 'name': 'Intercom', 'created_at': 103201}]
"""
#Ensure a companies is set as a list.
if isinstance(companies, list):
self['companies'] = [Company(**c) for c in companies]
else:
raise ValueError("companies must be set as a list")
@property
def custom_data(self):
""" Returns a CustomData object for this User.
>>> users = User.all()
>>> custom_data = users[0].custom_data
>>> type(custom_data)
<class 'intercom.user.CustomData'>
>>> custom_data['monthly_spend']
155.5
"""
data = dict.get(self, 'custom_data', None)
if not isinstance(data, CustomData):
data = CustomData(data)
dict.__setitem__(self, 'custom_data', data)
return data
@custom_data.setter
def custom_data(self, custom_data):
""" Sets the CustomData for this User.
>>> user = User(email="somebody@example.com")
>>> user.custom_data = { 'max_monthly_spend': 200 }
>>> type(user.custom_data)
<class 'intercom.user.CustomData'>
>>> user.save()
>>> len(user.custom_data)
3
"""
if not isinstance(custom_data, CustomData):
custom_data = CustomData(custom_data)
self['custom_data'] = custom_data
class CustomData(dict):
""" A dict that limits keys to strings, and values to real numbers
and strings.
>>> from intercom.user import CustomData
>>> data = CustomData()
>>> data['a_dict'] = {}
Traceback (most recent call last):
...
ValueError: custom data only allows string and real number values
>>> data[1] = "a string"
Traceback (most recent call last):
...
ValueError: custom data only allows string keys
"""
def __setitem__(self, key, value):
""" Limits the keys and values. """
if not (
isinstance(value, numbers.Real) or
isinstance(value, basestring)
):
raise ValueError(
"custom data only allows string and real number values")
if not isinstance(key, basestring):
raise ValueError("custom data only allows string keys")
super(CustomData, self).__setitem__(key, value)
class SocialProfile(dict):
""" Object representing http://docs.intercom.io/#SocialProfiles)
This object is read-only, and to hint at this __setitem__ is disabled.
>>> from intercom.user import SocialProfile
>>> profile = SocialProfile(type=u'twitter')
>>> profile.type
u'twitter'
>>> profile['type'] = 'facebook'
Traceback (most recent call last):
...
NotImplementedError
"""
@property
def type(self):
""" The type e.g. twitter, facebook, flickr, etc. """
return self.get('type', None)
@property
def id(self):
""" The id """
return self.get('id', None)
@property
def url(self):
""" The profile url e.g. http://twitter.com/somebody """
return self.get('url', None)
@property
def username(self):
""" The profile username e.g. somebody """
return self.get('username', None)
def __setitem__(self, key, value):
""" Do not allow items to be set. """
raise NotImplementedError
class Company(dict):
""" Object represents an Intercom Company """
@property
def id(self):
""" Returns the company's id. """
return dict.get(self, 'id', None)
@id.setter
def id(self, company_id):
""" Sets thecompany's id. """
self['id'] = company_id
@property
def name(self):
""" Returns the company name e.g. Intercom. """
return dict.get(self, 'name', None)
@name.setter
def name(self, name):
""" Sets the company name. """
self['name'] = name
@property
@from_timestamp_property
def created_at(self):
""" Returns the datetime this Company was created. """
return dict.get(self, 'created_at', None)
@created_at.setter
@to_timestamp_property
def created_at(self, value):
""" Sets the timestamp when this Company was created. """
self['created_at'] = value
class LocationData(dict):
""" Object representing a user's location data
This object is read-only, and to hint at this __setitem__ is disabled.
>>> from intercom.user import SocialProfile
>>> profile = SocialProfile(type=u'twitter')
>>> profile.type
u'twitter'
>>> profile['type'] = 'facebook'
Traceback (most recent call last):
...
NotImplementedError
"""
@property
def city_name(self):
""" The city name. """
return self.get('city_name', None)
@property
def continent_code(self):
""" The continent code. """
return self.get('continent_code', None)
@property
def country_name(self):
""" The country name. """
return self.get('country_name', None)
@property
def latitude(self):
""" Latitude. """
return self.get('latitude', None)
@property
def longitude(self):
""" Longitude. """
return self.get('longitude', None)
@property
def postal_code(self):
""" The postal code. """
return self.get('postal_code', None)
@property
def region_name(self):
""" The region name. """
return self.get('region_name', None)
@property
def timezone(self):
""" The timezone. """
return self.get('timezone', None)
@property
def country_code(self):
""" The country code. """
return self.get('country_code', None)
def __setitem__(self, key, value):
""" Do not allow items to be set. """
raise NotImplementedError