3 Python library for Remember The Milk API
5 @note For help, see http://www.rememberthemilk.com/services/api/methods/
15 _use_simplejson = False
18 _use_simplejson = True
23 __author__ = 'Sridhar Ratnakumar <http://nearfar.org/>'
25 SERVICE_URL = 'http://api.rememberthemilk.com/services/rest/'
26 AUTH_SERVICE_URL = 'http://www.rememberthemilk.com/services/auth/'
29 class RTMError(StandardError):
33 class RTMAPIError(RTMError):
37 class RTMParseError(RTMError):
41 class AuthStateMachine(object):
42 """If the state is in those setup for the machine, then return
43 the datum sent. Along the way, it is an automatic call if the
47 class NoData(RTMError):
50 def __init__(self, states):
54 def dataReceived(self, state, datum):
55 if state not in self.states:
56 raise RTMError("Invalid state <%s>" % state)
57 self.data[state] = datum
60 if state in self.data:
61 return self.data[state]
63 raise AuthStateMachine.NoData('No data for <%s>' % state)
68 def __init__(self, userID, apiKey, secret, token=None):
72 self._authInfo = AuthStateMachine(['frob', 'token'])
74 # this enables one to do 'rtm.tasks.getList()', for example
75 for prefix, methods in API.items():
77 RTMAPICategory(self, prefix, methods))
80 self._authInfo.dataReceived('token', token)
82 def _sign(self, params):
83 "Sign the parameters with MD5 hash"
84 pairs = ''.join(['%s%s' % (k, v) for (k, v) in sortedItems(params)])
85 return hashlib.md5(self._secret+pairs).hexdigest()
88 def open_url(url, queryArgs=None):
90 url += '?' + urllib.urlencode(queryArgs)
91 warnings.warn("Performing download of %s" % url, stacklevel=5)
92 return urllib2.urlopen(url)
95 def read_by_length(connection, timeout):
96 # It appears that urllib uses the non-blocking variant of file objects
97 # which means reads might not always be complete, so grabbing as much
98 # of the data as possible with a sleep in between to give it more time
100 contentLengthField = "Content-Length"
101 assert contentLengthField in connection.info(), "Connection didn't provide content length info"
102 specifiedLength = int(connection.info()["Content-Length"])
107 chunk = connection.read()
108 actuallyRead += len(chunk)
110 while 0 < timeout and actuallyRead < specifiedLength:
113 chunk = connection.read()
114 actuallyRead += len(chunk)
117 json = "".join(chunks)
119 if "Content-Length" in connection.info():
120 assert len(json) == int(connection.info()["Content-Length"]), "The packet header promised %s of data but only was able to read %s of data" % (
121 connection.info()["Content-Length"],
128 def read_by_guess(connection, timeout):
129 # It appears that urllib uses the non-blocking variant of file objects
130 # which means reads might not always be complete, so grabbing as much
131 # of the data as possible with a sleep in between to give it more time
136 chunk = connection.read()
138 while chunk and 0 < timeout:
141 chunk = connection.read()
144 json = "".join(chunks)
146 if "Content-Length" in connection.info():
147 assert len(json) == int(connection.info()["Content-Length"]), "The packet header promised %s of data but only was able to read %s of data" % (
148 connection.info()["Content-Length"],
154 def get(self, **params):
155 "Get the XML response for the passed `params`."
156 params['api_key'] = self._apiKey
157 params['format'] = 'json'
158 params['api_sig'] = self._sign(params)
160 connection = self.open_url(SERVICE_URL, params)
161 json = self.read_by_guess(connection, 5)
162 # json = self.read_by_length(connection, 5)
164 data = DottedDict('ROOT', parse_json(json))
167 if rsp.stat == 'fail':
169 'API call failed - %s (%s)' % (
177 def getNewFrob(self):
178 rsp = self.get(method='rtm.auth.getFrob')
179 self._authInfo.dataReceived('frob', rsp.frob)
182 def getAuthURL(self):
184 frob = self._authInfo.get('frob')
185 except AuthStateMachine.NoData:
186 frob = self.getNewFrob()
189 'api_key': self._apiKey,
193 params['api_sig'] = self._sign(params)
194 return AUTH_SERVICE_URL + '?' + urllib.urlencode(params)
197 frob = self._authInfo.get('frob')
198 rsp = self.get(method='rtm.auth.getToken', frob=frob)
199 self._authInfo.dataReceived('token', rsp.auth.token)
200 return rsp.auth.token
203 class RTMAPICategory(object):
204 "See the `API` structure and `RTM.__init__`"
206 def __init__(self, rtm, prefix, methods):
207 self._rtm = weakref.ref(rtm)
208 self._prefix = prefix
209 self._methods = methods
211 def __getattr__(self, attr):
212 if attr not in self._methods:
213 raise AttributeError('No such attribute: %s' % attr)
215 rargs, oargs = self._methods[attr]
216 if self._prefix == 'tasksNotes':
217 aname = 'rtm.tasks.notes.%s' % attr
219 aname = 'rtm.%s.%s' % (self._prefix, attr)
220 return lambda **params: self.callMethod(
221 aname, rargs, oargs, **params
224 def callMethod(self, aname, rargs, oargs, **params):
226 for requiredArg in rargs:
227 if requiredArg not in params:
228 raise TypeError('Required parameter (%s) missing' % requiredArg)
231 if param not in rargs + oargs:
232 warnings.warn('Invalid parameter (%s)' % param)
234 return self._rtm().get(method=aname,
235 auth_token=self._rtm()._authInfo.get('token'),
239 def sortedItems(dictionary):
240 "Return a list of (key, value) sorted based on keys"
241 keys = dictionary.keys()
244 yield key, dictionary[key]
247 class DottedDict(object):
248 "Make dictionary items accessible via the object-dot notation."
250 def __init__(self, name, dictionary):
253 if isinstance(dictionary, dict):
254 for key, value in dictionary.items():
255 if isinstance(value, dict):
256 value = DottedDict(key, value)
257 elif isinstance(value, (list, tuple)):
258 value = [DottedDict('%s_%d' % (key, i), item)
259 for i, item in enumerate(value)]
260 setattr(self, key, value)
263 children = [c for c in dir(self) if not c.startswith('_')]
264 return '<dotted %s: %s>' % (
269 children = [(c, getattr(self, c)) for c in dir(self) if not c.startswith('_')]
270 return '{dotted %s: %s}' % (
273 ('%s: "%s"' % (k, str(v)))
274 for (k, v) in children)
278 def safer_eval(string):
280 return eval(string, {}, {})
281 except SyntaxError, e:
285 newE = RTMParseError("Error parseing json")
291 parse_json = simplejson.loads
293 parse_json = safer_eval
299 [('auth_token'), ()],
307 [('timeline', 'contact'), ()],
309 [('timeline', 'contact_id'), ()],
315 [('timeline', 'group'), ()],
317 [('timeline', 'group_id', 'contact_id'), ()],
319 [('timeline', 'group_id'), ()],
323 [('timeline', 'group_id', 'contact_id'), ()],
327 [('timeline', 'name'), ('filter'), ()],
329 [('timeline', 'list_id'), ()],
331 [('timeline', 'list_id'), ()],
335 [('timeline'), ('list_id'), ()],
337 [('timeline', 'list_id', 'name'), ()],
339 [('timeline', 'list_id'), ()],
347 [('methodName',), ()],
357 [('timeline', 'name',), ('list_id', 'parse',)],
359 [('timeline', 'list_id', 'taskseries_id', 'task_id', 'tags'),
362 [('timeline', 'list_id', 'taskseries_id', 'task_id',), ()],
364 [('timeline', 'list_id', 'taskseries_id', 'task_id'), ()],
367 ('list_id', 'filter', 'last_sync')],
369 [('timeline', 'list_id', 'taskseries_id', 'task_id', 'direction'),
372 [('timeline', 'from_list_id', 'to_list_id', 'taskseries_id', 'task_id'),
375 [('timeline', 'list_id', 'taskseries_id', 'task_id'),
378 [('timeline', 'list_id', 'taskseries_id', 'task_id', 'tags'),
381 [('timeline', 'list_id', 'taskseries_id', 'task_id'),
382 ('due', 'has_due_time', 'parse')],
384 [('timeline', 'list_id', 'taskseries_id', 'task_id'),
387 [('timeline', 'list_id', 'taskseries_id', 'task_id'),
390 [('timeline', 'list_id', 'taskseries_id', 'task_id', 'name'),
393 [('timeline', 'list_id', 'taskseries_id', 'task_id'),
396 [('timeline', 'list_id', 'taskseries_id', 'task_id'),
399 [('timeline', 'list_id', 'taskseries_id', 'task_id'),
402 [('timeline', 'list_id', 'taskseries_id', 'task_id'),
405 [('timeline', 'list_id', 'taskseries_id', 'task_id'),
410 [('timeline', 'list_id', 'taskseries_id', 'task_id', 'note_title', 'note_text'), ()],
412 [('timeline', 'note_id'), ()],
414 [('timeline', 'note_id', 'note_title', 'note_text'), ()],
424 [('to_timezone',), ('from_timezone', 'to_timezone', 'time')],
426 [('text',), ('timezone', 'dateformat')],
438 [('timeline', 'transaction_id'), ()],