4 """This module is only imported in other diaspy modules and
5 MUST NOT import anything.
12 from diaspy
import errors
16 """This class represents an aspect.
18 Class can be initialized by passing either an id and/or name as
20 If both are missing, an exception will be raised.
22 def __init__(self
, connection
, id=None, name
=None):
23 self
._connection
= connection
24 self
.id, self
.name
= id, name
26 self
.name
= self
._findname
()
28 self
.id = self
._findid
()
29 elif not id and not name
:
30 raise Exception('Aspect must be initialized with either an id or name')
33 """Finds name for aspect.
36 aspects
= self
._connection
.getUserInfo()['aspects']
38 if a
['id'] == self
.id:
44 """Finds id for aspect.
47 aspects
= self
._connection
.getUserInfo()['aspects']
49 if a
['name'] == self
.name
:
55 """Returns HTML returned when editing aspects via web UI.
57 start_regexp
= re
.compile('<ul +class=["\']contacts["\'] *>')
58 ajax
= self
._connection
.get('aspects/{0}/edit'.format(self
.id)).text
60 begin
= ajax
.find(start_regexp
.search(ajax
).group(0))
61 end
= ajax
.find('</ul>')
62 return ajax
[begin
:end
]
64 def _extractusernames(self
, ajax
):
65 """Extracts usernames and GUIDs from ajax returned by Diaspora*.
66 Returns list of two-tuples: (guid, diaspora_name).
68 userline_regexp
= re
.compile('<a href=["\']/people/[a-z0-9]{16,16}["\']>[\w()*@. -]+</a>')
69 return [(line
[17:33], re
.escape(line
[35:-4])) for line
in userline_regexp
.findall(ajax
)]
71 def _extractpersonids(self
, ajax
, usernames
):
72 """Extracts `person_id`s and usernames from ajax and list of usernames.
73 Returns list of two-tuples: (username, id)
75 personid_regexp
= 'alt=["\']{0}["\'] class=["\']avatar["\'] data-person_id=["\'][0-9]+["\']'
76 personids
= [re
.compile(personid_regexp
.format(name
)).search(ajax
).group(0) for guid
, name
in usernames
]
77 for n
, line
in enumerate(personids
):
79 while line
[i
].isdigit():
82 personids
[n
] = (usernames
[n
][1], id)
85 def _defineusers(self
, ajax
, personids
):
86 """Gets users contained in this aspect by getting users who have `delete` method.
88 method_regexp
= 'data-method="delete" data-person_id="{0}"'
90 for name
, id in personids
:
91 if re
.compile(method_regexp
.format(id)).search(ajax
): users
.append(name
)
94 def _getguids(self
, users_in_aspect
, usernames
):
95 """Defines users contained in this aspect.
98 for guid
, name
in usernames
:
99 if name
in users_in_aspect
: guids
.append(guid
)
103 """Returns list of GUIDs of users who are listed in this aspect.
105 ajax
= self
._getajax
()
106 usernames
= self
._extractusernames
(ajax
)
107 personids
= self
._extractpersonids
(ajax
, usernames
)
108 users_in_aspect
= self
._defineusers
(ajax
, personids
)
109 return self
._getguids
(users_in_aspect
, usernames
)
111 def addUser(self
, user_id
):
112 """Add user to current aspect.
114 :param user_id: user to add to aspect
116 :returns: JSON from request
118 data
= {'authenticity_token': repr(self
._connection
),
119 'aspect_id': self
.id,
120 'person_id': user_id
}
122 request
= self
._connection
.post('aspect_memberships.json', data
=data
)
124 if request
.status_code
== 400:
125 raise errors
.AspectError('duplicate record, user already exists in aspect: {0}'.format(request
.status_code
))
126 elif request
.status_code
== 404:
127 raise errors
.AspectError('user not found from this pod: {0}'.format(request
.status_code
))
128 elif request
.status_code
!= 200:
129 raise errors
.AspectError('wrong status code: {0}'.format(request
.status_code
))
130 return request
.json()
132 def removeUser(self
, user_id
):
133 """Remove user from current aspect.
135 :param user_id: user to remove from aspect
138 data
= {'authenticity_token': self
._connection
.get_token(),
139 'aspect_id': self
.id,
140 'person_id': user_id
}
141 request
= self
.connection
.delete('aspect_memberships/{0}.json'.format(self
.id), data
=data
)
143 if request
.status_code
!= 200:
144 raise errors
.AspectError('cannot remove user from aspect: {0}'.format(request
.status_code
))
145 return request
.json()
148 class Notification():
149 """This class represents single notification.
151 _who_regexp
= re
.compile(r
'/people/[0-9a-z]+" class=\'hovercardable
')
152 _when_regexp = re.compile(r'[0-9]{4,4}(-[0-9]{2,2}){2,2} [0-9]{2,2}(:[0-9]{2,2}){2,2} UTC
')
153 _aboutid_regexp = re.compile(r'/posts
/[0-9]+')
155 def __init__(self, connection, data):
156 self._connection = connection
157 self.type = list(data.keys())[0]
158 self.data = data[self.type]
159 self.id = self.data['id']
160 self.unread = self.data['unread
']
162 def __getitem__(self, key):
163 """Returns a key from notification data.
165 return self.data[key]
168 """Returns notification note.
170 string = re.sub('</?
[a
-z
]+( *[a
-z_
-]+=["\'][\w():.,!?#@=/\- ]*["\'])* */?
>', '', self.data['note_html
'])
171 string = string.strip().split('\n')[0]
172 while ' ' in string: string = string.replace(' ', ' ')
176 """Returns notification note with more details.
178 return '{0}
: {1}
'.format(self.when(), str(self))
181 """Returns id of post about which the notification is informing.
183 about = self._aboutid_regexp.search(self.data['note_html
'])
184 if about is None: about = self.who()
185 else: about = int(about.group(0)[7:])
189 """Returns list of guids of the users who caused you to get the notification.
191 return [who[8:24] for who in self._who_regexp.findall(self.data['note_html
'])]
194 """Returns UTC time as found in note_html.
196 return self._when_regexp.search(self.data['note_html
']).group(0)
198 def mark(self, unread=False):
199 """Marks notification to read/unread.
200 Marks notification to read if `unread` is False.
201 Marks notification to unread if `unread` is True.
203 :param unread: which state set for notification
206 headers = {'x
-csrf
-token
': repr(self._connection)}
207 params = {'set_unread
': json.dumps(unread)}
208 self._connection.put('notifications
/{0}
'.format(self['id']), params=params, headers=headers)
209 self.data['unread
'] = unread
213 """Represents comment on post.
215 Does not require Connection() object. Note that you should not manually
216 create `Comment()` objects -- they are designed to be created automatically
219 def __init__(self, data):
223 """Returns comment's text
.
225 return self.data['text']
228 """Returns comments text
and author
.
229 Format
: AUTHOR (AUTHOR
'S GUID): COMMENT
231 return '{0}
({1}
): {2}
'.format(self.author(), self.author('guid
'), str(self))
234 """Returns time when the comment had been created.
236 return self.data['created_at
']
238 def author(self, key='name
'):
239 """Returns author of the comment.
241 return self.data['author
'][key]
245 """This class represents a post.
248 Remember that you need to have access to the post.
250 def __init__(self, connection, id, fetch=True, comments=True):
252 :param id: id or guid of the post
254 :param connection: connection object used to authenticate
255 :type connection: connection.Connection
256 :param fetch: defines whether to fetch post's data
or not
258 :param comments
: defines whether to fetch post
's comments or not
261 self._connection = connection
265 if fetch: self._fetchdata()
266 if comments: self._fetchcomments()
269 """Returns string containing more information then str().
271 return '{0}
({1}
): {2}
'.format(self.data['author
']['name
'], self.data['author
']['guid
'], self.data['text
'])
274 """Returns text of a post.
276 return self.data['text
']
278 def _fetchdata(self):
279 """This function retrieves data of the post.
281 request = self._connection.get('posts
/{0}
.json
'.format(self.id))
282 if request.status_code != 200:
283 raise errors.PostError('{0}
: could
not fetch data
for post
: {1}
'.format(request.status_code, self.id))
285 self.data = request.json()
287 def _fetchcomments(self):
288 """Retireves comments for this post.
290 request = self._connection.get('posts
/{0}
/comments
.json
'.format(self.id))
291 if request.status_code != 200:
292 raise errors.PostError('{0}
: could
not fetch comments
for post
: {1}
'.format(request.status_code, self.id))
294 self.comments = [Comment(c) for c in request.json()]
297 """Updates post data.
300 self._fetchcomments()
303 """This function likes a post.
304 It abstracts the 'Like
' functionality.
306 :returns: dict -- json formatted like object.
308 data = {'authenticity_token
': repr(self._connection)}
310 request = self._connection.post('posts
/{0}
/likes
'.format(self.id),
312 headers={'accept
': 'application
/json
'})
314 if request.status_code != 201:
315 raise errors.PostError('{0}
: Post could
not be liked
.'
316 .format(request.status_code))
317 return request.json()
320 """This function reshares a post
322 data = {'root_guid
': self.data['guid
'],
323 'authenticity_token
': repr(self._connection)}
325 request = self._connection.post('reshares
',
327 headers={'accept
': 'application
/json
'})
328 if request.status_code != 201:
329 raise Exception('{0}
: Post could
not be reshared
'.format(request.status_code))
330 return request.json()
332 def comment(self, text):
333 """This function comments on a post
335 :param text: text to comment.
338 data = {'text
': text,
339 'authenticity_token
': repr(self._connection)}
340 request = self._connection.post('posts
/{0}
/comments
'.format(self.id),
342 headers={'accept
': 'application
/json
'})
344 if request.status_code != 201:
345 raise Exception('{0}
: Comment could
not be posted
.'
346 .format(request.status_code))
347 return request.json()
350 """ This function deletes this post
352 data = {'authenticity_token
': repr(self._connection)}
353 request = self._connection.delete('posts
/{0}
'.format(self.id),
355 headers={'accept
': 'application
/json
'})
356 if request.status_code != 204:
357 raise errors.PostError('{0}
: Post could
not be deleted
'.format(request.status_code))
359 def delete_comment(self, comment_id):
360 """This function removes a comment from a post
362 :param comment_id: id of the comment to remove.
363 :type comment_id: str
365 data = {'authenticity_token
': repr(self._connection)}
366 request = self._connection.delete('posts
/{0}
/comments
/{1}
'
370 headers={'accept
': 'application
/json
'})
372 if request.status_code != 204:
373 raise errors.PostError('{0}
: Comment could
not be deleted
'
374 .format(request.status_code))
376 def delete_like(self):
377 """This function removes a like from a post
379 data = {'authenticity_token
': self._connection.get_token()}
381 request = self._connection.delete('posts
/{0}
/likes
/{1}
'
383 self.data['interactions
']
386 if request.status_code != 204:
387 raise errors.PostError('{0}
: Like could
not be removed
.'
388 .format(request.status_code))
390 def author(self, key='name
'):
391 """Returns author of the post.
392 :param key: all keys available in data['author
']
394 return self.data['author
'][key]