photo-python/trovebox/api/api_activity.py
2013-09-05 22:51:32 +01:00

35 lines
1.3 KiB
Python

"""
api_activity.py : Trovebox Activity API Classes
"""
from trovebox import http
from trovebox.errors import TroveboxError
from trovebox.objects.activity import Activity
from .api_base import ApiBase
class ApiActivities(ApiBase):
""" Definitions of /activities/ API endpoints """
def list(self, filters={}, **kwds):
""" Returns a list of Activity objects """
filter_string = self._build_filter_string(filters)
activities = self._client.get("/activities/%slist.json" % filter_string,
**kwds)["result"]
activities = http.result_to_list(activities)
return [Activity(self._client, activity) for activity in activities]
def purge(self, **kwds):
""" Purge all activities """
if not self._client.post("/activities/purge.json", **kwds)["result"]:
raise TroveboxError("Purge response returned False")
return True
class ApiActivity(ApiBase):
""" Definitions of /activity/ API endpoints """
def view(self, activity, **kwds):
"""
View an activity's contents.
Returns the requested activity object.
"""
if not isinstance(activity, Activity):
activity = Activity(self._client, {"id": activity})
activity.view(**kwds)
return activity