216 lines
7.6 KiB
Python
216 lines
7.6 KiB
Python
""" User model wrapper for comment service"""
|
|
from six import text_type
|
|
|
|
import settings
|
|
import models
|
|
import utils
|
|
|
|
|
|
class User(models.Model):
|
|
|
|
accessible_fields = [
|
|
'username', 'follower_ids', 'upvoted_ids', 'downvoted_ids',
|
|
'id', 'external_id', 'subscribed_user_ids', 'children', 'course_id',
|
|
'group_id', 'subscribed_thread_ids', 'subscribed_commentable_ids',
|
|
'subscribed_course_ids', 'threads_count', 'comments_count',
|
|
'default_sort_key'
|
|
]
|
|
|
|
updatable_fields = ['username', 'external_id', 'default_sort_key']
|
|
initializable_fields = updatable_fields
|
|
|
|
metric_tag_fields = ['course_id']
|
|
|
|
base_url = "{prefix}/users".format(prefix=settings.PREFIX)
|
|
default_retrieve_params = {'complete': True}
|
|
type = 'user'
|
|
|
|
@classmethod
|
|
def from_django_user(cls, user):
|
|
return cls(id=str(user.id),
|
|
external_id=str(user.id),
|
|
username=user.username)
|
|
|
|
def read(self, source):
|
|
"""
|
|
Calls cs_comments_service to mark thread as read for the user
|
|
"""
|
|
params = {'source_type': source.type, 'source_id': source.id}
|
|
utils.perform_request(
|
|
'post',
|
|
_url_for_read(self.id),
|
|
params,
|
|
metric_action='user.read',
|
|
metric_tags=self._metric_tags + ['target.type:{}'.format(source.type)],
|
|
)
|
|
|
|
def follow(self, source):
|
|
params = {'source_type': source.type, 'source_id': source.id}
|
|
response = utils.perform_request(
|
|
'post',
|
|
_url_for_subscription(self.id),
|
|
params,
|
|
metric_action='user.follow',
|
|
metric_tags=self._metric_tags + ['target.type:{}'.format(source.type)],
|
|
)
|
|
|
|
def unfollow(self, source):
|
|
params = {'source_type': source.type, 'source_id': source.id}
|
|
response = utils.perform_request(
|
|
'delete',
|
|
_url_for_subscription(self.id),
|
|
params,
|
|
metric_action='user.unfollow',
|
|
metric_tags=self._metric_tags + ['target.type:{}'.format(source.type)],
|
|
)
|
|
|
|
def vote(self, voteable, value):
|
|
if voteable.type == 'thread':
|
|
url = _url_for_vote_thread(voteable.id)
|
|
elif voteable.type == 'comment':
|
|
url = _url_for_vote_comment(voteable.id)
|
|
else:
|
|
raise utils.CommentClientRequestError("Can only vote / unvote for threads or comments")
|
|
params = {'user_id': self.id, 'value': value}
|
|
response = utils.perform_request(
|
|
'put',
|
|
url,
|
|
params,
|
|
metric_action='user.vote',
|
|
metric_tags=self._metric_tags + ['target.type:{}'.format(voteable.type)],
|
|
)
|
|
voteable._update_from_response(response)
|
|
|
|
def unvote(self, voteable):
|
|
if voteable.type == 'thread':
|
|
url = _url_for_vote_thread(voteable.id)
|
|
elif voteable.type == 'comment':
|
|
url = _url_for_vote_comment(voteable.id)
|
|
else:
|
|
raise utils.CommentClientRequestError("Can only vote / unvote for threads or comments")
|
|
params = {'user_id': self.id}
|
|
response = utils.perform_request(
|
|
'delete',
|
|
url,
|
|
params,
|
|
metric_action='user.unvote',
|
|
metric_tags=self._metric_tags + ['target.type:{}'.format(voteable.type)],
|
|
)
|
|
voteable._update_from_response(response)
|
|
|
|
def active_threads(self, query_params={}):
|
|
if not self.course_id:
|
|
raise utils.CommentClientRequestError("Must provide course_id when retrieving active threads for the user")
|
|
url = _url_for_user_active_threads(self.id)
|
|
params = {'course_id': text_type(self.course_id)}
|
|
params.update(query_params)
|
|
response = utils.perform_request(
|
|
'get',
|
|
url,
|
|
params,
|
|
metric_action='user.active_threads',
|
|
metric_tags=self._metric_tags,
|
|
paged_results=True,
|
|
)
|
|
return response.get('collection', []), response.get('page', 1), response.get('num_pages', 1)
|
|
|
|
def subscribed_threads(self, query_params={}):
|
|
if not self.course_id:
|
|
raise utils.CommentClientRequestError("Must provide course_id when retrieving subscribed threads for the user")
|
|
url = _url_for_user_subscribed_threads(self.id)
|
|
params = {'course_id': text_type(self.course_id)}
|
|
params.update(query_params)
|
|
response = utils.perform_request(
|
|
'get',
|
|
url,
|
|
params,
|
|
metric_action='user.subscribed_threads',
|
|
metric_tags=self._metric_tags,
|
|
paged_results=True
|
|
)
|
|
return utils.CommentClientPaginatedResult(
|
|
collection=response.get('collection', []),
|
|
page=response.get('page', 1),
|
|
num_pages=response.get('num_pages', 1),
|
|
thread_count=response.get('thread_count', 0)
|
|
)
|
|
|
|
def _retrieve(self, *args, **kwargs):
|
|
url = self.url(action='get', params=self.attributes)
|
|
retrieve_params = self.default_retrieve_params.copy()
|
|
retrieve_params.update(kwargs)
|
|
if self.attributes.get('course_id'):
|
|
retrieve_params['course_id'] = text_type(self.course_id)
|
|
if self.attributes.get('group_id'):
|
|
retrieve_params['group_id'] = self.group_id
|
|
try:
|
|
response = utils.perform_request(
|
|
'get',
|
|
url,
|
|
retrieve_params,
|
|
metric_action='model.retrieve',
|
|
metric_tags=self._metric_tags,
|
|
)
|
|
except utils.CommentClientRequestError as e:
|
|
if e.status_code == 404:
|
|
# attempt to gracefully recover from a previous failure
|
|
# to sync this user to the comments service.
|
|
self.save()
|
|
response = utils.perform_request(
|
|
'get',
|
|
url,
|
|
retrieve_params,
|
|
metric_action='model.retrieve',
|
|
metric_tags=self._metric_tags,
|
|
)
|
|
else:
|
|
raise
|
|
self._update_from_response(response)
|
|
|
|
def retire(self, retired_username):
|
|
url = _url_for_retire(self.id)
|
|
params = {'retired_username': retired_username}
|
|
|
|
utils.perform_request(
|
|
'post',
|
|
url,
|
|
params,
|
|
raw=True,
|
|
metric_action='user.retire',
|
|
metric_tags=self._metric_tags
|
|
)
|
|
|
|
|
|
def _url_for_vote_comment(comment_id):
|
|
return "{prefix}/comments/{comment_id}/votes".format(prefix=settings.PREFIX, comment_id=comment_id)
|
|
|
|
|
|
def _url_for_vote_thread(thread_id):
|
|
return "{prefix}/threads/{thread_id}/votes".format(prefix=settings.PREFIX, thread_id=thread_id)
|
|
|
|
|
|
def _url_for_subscription(user_id):
|
|
return "{prefix}/users/{user_id}/subscriptions".format(prefix=settings.PREFIX, user_id=user_id)
|
|
|
|
|
|
def _url_for_user_active_threads(user_id):
|
|
return "{prefix}/users/{user_id}/active_threads".format(prefix=settings.PREFIX, user_id=user_id)
|
|
|
|
|
|
def _url_for_user_subscribed_threads(user_id):
|
|
return "{prefix}/users/{user_id}/subscribed_threads".format(prefix=settings.PREFIX, user_id=user_id)
|
|
|
|
|
|
def _url_for_read(user_id):
|
|
"""
|
|
Returns cs_comments_service url endpoint to mark thread as read for given user_id
|
|
"""
|
|
return "{prefix}/users/{user_id}/read".format(prefix=settings.PREFIX, user_id=user_id)
|
|
|
|
|
|
def _url_for_retire(user_id):
|
|
"""
|
|
Returns cs_comments_service url endpoint to retire a user (remove all post content, etc.)
|
|
"""
|
|
return "{prefix}/users/{user_id}/retire".format(prefix=settings.PREFIX, user_id=user_id)
|