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
|
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
|
-
+
+
+
-
+
-
-
-
-
-
-
+
+
+
+
+
+
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-
-
-
+
+
+
+
-
-
-
+
+
+
-
-
-
-
-
+
+
+
+
+
-
-
-
-
+
+
+
+
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-
-
-
-
+
+
+
+
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
+
+
+
+
+
-
-
-
+
+
+
-
-
-
-
-
+
+
+
+
+
-
-
-
-
+
+
+
+
-
-
-
-
-
+
+
+
+
+
-
-
-
+
+
+
-
-
-
-
-
-
+
+
+
+
+
+
-
-
-
-
+
+
+
+
-
-
-
-
+
+
+
+
-
-
-
+
+
+
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-
-
-
-
+
+
+
+
+
-
-
-
-
+
+
+
+
-
-
-
-
-
-
+
+
+
+
+
+
-
-
-
-
+
+
+
+
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-
-
-
-
+
+
+
+
+
-
-
-
-
+
+
+
+
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-
-
-
-
+
+
+
+
+
-
-
-
-
+
+
+
+
-
-
-
-
-
-
+
+
+
+
+
+
-
-
-
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
|
#!/usr/bin/python
"""newsblur.py - An API wrapper library for newsblur.com"""
import simplejson
cookies = None
self.cookies = {}
def login(username,password):
'''
Login as an existing user.
If a user has no password set, you cannot just send any old password.
Required parameters, username and password, must be of string type.
'''
def login(self, username,password):
'''
Login as an existing user.
If a user has no password set, you cannot just send any old password.
Required parameters, username and password, must be of string type.
'''
url = nb_url + 'api/login'
results = requests.post(url, data={"username": username, "password": password})
global cookies
cookies = results.cookies
return simplejson.loads(results.content)
url = nb_url + 'api/login'
results = requests.post(url, data={"username": username, "password": password})
print "results.cookies =", results.cookies
print type(results.cookies)
self.cookies = results.cookies
results = simplejson.loads(results.content)
if results["authenticated"] is False:
raise Exception("The newsblur credentials you provided are invalid")
return results
def logout():
'''
Logout the currently logged in user.
'''
def logout(self, ):
'''
Logout the currently logged in user.
'''
url = nb_url + 'api/logout'
results = requests.get(url, cookies=cookies)
return simplejson.loads(results.content)
url = nb_url + 'api/logout'
results = requests.get(url, cookies=self.cookies)
return simplejson.loads(results.content)
def signup(username,password,email):
'''
Create a new user.
All three required parameters must be of type string.
'''
def signup(self, username,password,email):
'''
Create a new user.
All three required parameters must be of type string.
'''
url = nb_url + 'api/signup'
payload = {'signup_username':username,'signup_password':password,'signup_email':email}
results = requests.post(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
url = nb_url + 'api/signup'
payload = {'signup_username':username,'signup_password':password,'signup_email':email}
results = requests.post(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def search_feed(address,offset=1):
'''
Retrieve information about a feed from its website or RSS address.
Parameter address must be of type string while parameter offset must be an integer.
Will return a feed.
'''
def search_feed(self, address,offset=1):
'''
Retrieve information about a feed from its website or RSS address.
Parameter address must be of type string while parameter offset must be an integer.
Will return a feed.
'''
url = nb_url + 'rss_feeds/search_feed'
payload = {'address':address,'offset':offset}
results = results.get(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
url = nb_url + 'rss_feeds/search_feed'
payload = {'address':address,'offset':offset}
results = results.get(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def feeds(include_favicons=True,flat=False):
'''
Retrieve a list of feeds to which a user is actively subscribed.
Includes the 3 unread counts (positive, neutral, negative), as well as optional favicons.
'''
url = nb_url + 'reader/feeds'
payload = {'include_favicons':include_favicons,'flat':flat}
results = requests.get(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
def feeds(self, include_favicons=True,flat=False):
'''
Retrieve a list of feeds to which a user is actively subscribed.
Includes the 3 unread counts (positive, neutral, negative), as well as optional favicons.
'''
url = nb_url + 'reader/feeds'
payload = {'include_favicons':include_favicons,'flat':flat}
results = requests.get(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def favicons(feeds=[1,2,3]):
'''
Retrieve a list of favicons for a list of feeds.
Used when combined with /reader/feeds and include_favicons=false, so the feeds request contains far less data.
Useful for mobile devices, but requires a second request.
'''
url = nb_url + 'reader/favicons'
payload = {'feeds':feeds}
results = requests.get(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
def id(id_no):
'''
Retrieve the original page from a single feed.
'''
url = nb_url + 'reader/page/' % id_no
payload = {}
results = requests.get(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
def favicons(self, feeds=[1,2,3]):
'''
Retrieve a list of favicons for a list of feeds.
Used when combined with /reader/feeds and include_favicons=false, so the feeds request contains far less data.
Useful for mobile devices, but requires a second request.
'''
url = nb_url + 'reader/favicons'
payload = {'feeds':feeds}
results = requests.get(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def id(self, id_no):
'''
Retrieve the original page from a single feed.
'''
url = nb_url + 'reader/page/' % id_no
payload = {}
results = requests.get(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def refresh_feeds():
'''
Up-to-the-second unread counts for each active feed.
Poll for these counts no more than once a minute.
'''
def refresh_feeds(self, ):
'''
Up-to-the-second unread counts for each active feed.
Poll for these counts no more than once a minute.
'''
url = nb_url + 'reader/refresh_feeds'
results = requests.get(url, cookies=cookies)
return simplejson.loads(results.content)
url = nb_url + 'reader/refresh_feeds'
results = requests.get(url, cookies=self.cookies)
return simplejson.loads(results.content)
def feeds_trainer(feed_id):
'''
Retrieves all popular and known intelligence classifiers.
Also includes user's own classifiers.
'''
def feeds_trainer(self, feed_id):
'''
Retrieves all popular and known intelligence classifiers.
Also includes user's own classifiers.
'''
url = nb_url + 'reader/feeds_trainer'
payload = {'feed_id':feed_id}
results = requests.get(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
url = nb_url + 'reader/feeds_trainer'
payload = {'feed_id':feed_id}
results = requests.get(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def statistics(id_no):
'''
If you only want a user's classifiers, use /classifiers/:id.
Omit the feed_id to get all classifiers for all subscriptions.
'''
def statistics(self, id_no):
'''
If you only want a user's classifiers, use /classifiers/:id.
Omit the feed_id to get all classifiers for all subscriptions.
'''
url = nb_url + 'rss_feeds/statistics/%d' % id_no
results = requests.get(url, cookies=cookies)
return simplejson.loads(results.content)
url = nb_url + 'rss_feeds/statistics/%d' % id_no
results = requests.get(url, cookies=self.cookies)
return simplejson.loads(results.content)
def feed_autocomplete(term):
'''
Get a list of feeds that contain a search phrase.
Searches by feed address, feed url, and feed title, in that order.
Will only show sites with 2+ subscribers.
'''
def feed_autocomplete(self, term):
'''
Get a list of feeds that contain a search phrase.
Searches by feed address, feed url, and feed title, in that order.
Will only show sites with 2+ subscribers.
'''
url = nb_url + 'rss_feeds/feed_autocomplete?%'
payload = {'term':term}
results = requests.get(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
url = nb_url + 'rss_feeds/feed_autocomplete?%'
payload = {'term':term}
results = requests.get(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def feed(id):
'''
Retrieve stories from a single feed.
'''
def feed(self, id):
'''
Retrieve stories from a single feed.
'''
url = nb_url + 'reader/feed/%s' % id
results = requests.get(url, cookies=cookies)
return simplejson.loads(results.content)
url = nb_url + 'reader/feed/%s' % id
results = requests.get(url, cookies=self.cookies)
return simplejson.loads(results.content)
def starred_stories(page=1):
'''
Retrieve a user's starred stories.
'''
url = nb_url + 'reader/starred_stories'
payload = {'page':page}
results = requests.get(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
def starred_stories(self, page=1):
'''
Retrieve a user's starred stories.
'''
url = nb_url + 'reader/starred_stories'
payload = {'page':page}
results = requests.get(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def river_stories(feeds,page=1,read_stories_count=0):
'''
Retrieve stories from a collection of feeds. This is known as the River of News.
Stories are ordered in reverse chronological order.
'''
def river_stories(self, feeds,page=1,read_stories_count=0):
'''
Retrieve stories from a collection of feeds. This is known as the River of News.
Stories are ordered in reverse chronological order.
'''
url = nb_url + 'reader/river_stories'
payload = {'feeds':feeds,'page':page,'read_stories_count':read_stories_count}
results = urllib2.urlopen(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
url = nb_url + 'reader/river_stories'
payload = {'feeds':feeds,'page':page,'read_stories_count':read_stories_count}
results = urllib2.urlopen(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def mark_story_as_read(story_id,feed_id):
'''
Mark stories as read.
Multiple story ids can be sent at once.
Each story must be from the same feed.
'''
def mark_story_as_read(self, story_id,feed_id):
'''
Mark stories as read.
Multiple story ids can be sent at once.
Each story must be from the same feed.
'''
url = nb_url + 'reader/mark_story_as_read'
payload = {'story_id':story_id,'feed_id':feed_id}
results = requests.post(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
url = nb_url + 'reader/mark_story_as_read'
payload = {'story_id':story_id,'feed_id':feed_id}
results = requests.post(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def mark_story_as_starred(story_id,feed_id):
'''
Mark a story as starred (saved).
'''
url = nb_url + 'reader/mark_story_as_starred'
payload = {'story_id':story_id,'feed_id':feed_id}
results = requests.post(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
def mark_story_as_starred(self, story_id,feed_id):
'''
Mark a story as starred (saved).
'''
url = nb_url + 'reader/mark_story_as_starred'
payload = {'story_id':story_id,'feed_id':feed_id}
results = requests.post(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def mark_all_as_read(days=0):
'''
Mark all stories in *all* feeds read.
'''
url = nb_url + 'reader/mark_all_as_read'
payload = {'days':days}
results = requests.post(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
def mark_all_as_read(self, days=0):
'''
Mark all stories in *all* feeds read.
'''
url = nb_url + 'reader/mark_all_as_read'
payload = {'days':days}
results = requests.post(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def add_url(url,folder='[Top Level]'):
'''
Add a feed by its URL.
Can be either the RSS feed or the website itself.
'''
url = nb_url + 'reader/add_url'
payload = {'url':url,'folder':folder}
results = requests.post(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
def add_url(self, url,folder='[Top Level]'):
'''
Add a feed by its URL.
Can be either the RSS feed or the website itself.
'''
url = nb_url + 'reader/add_url'
payload = {'url':url,'folder':folder}
results = requests.post(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def add_folder(folder,parent_folder='[Top Level]'):
'''
Add a new folder.
'''
url = nb_url + 'reader/add_folder'
payload = {'folder':folder,'parent_folder':parent_folder}
results = requests.post(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
def add_folder(self, folder,parent_folder='[Top Level]'):
'''
Add a new folder.
'''
url = nb_url + 'reader/add_folder'
payload = {'folder':folder,'parent_folder':parent_folder}
results = requests.post(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def rename_feed(feed_title,feed_id):
'''
Rename a feed title. Only the current user will see the new title.
'''
url = nb_url + 'reader/rename_feed'
payload = {'feed_title':feed_title,'feed_id':feed_id}
results = requests.post(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
def rename_feed(self, feed_title,feed_id):
'''
Rename a feed title. Only the current user will see the new title.
'''
url = nb_url + 'reader/rename_feed'
payload = {'feed_title':feed_title,'feed_id':feed_id}
results = requests.post(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def delete_feed(feed_id,in_folder):
'''
Unsubscribe from a feed. Removes it from the folder.
Set the in_folder parameter to remove a feed from the correct folder, in case the user is subscribed to the feed in multiple folders.
'''
def delete_feed(self, feed_id,in_folder):
'''
Unsubscribe from a feed. Removes it from the folder.
Set the in_folder parameter to remove a feed from the correct folder, in case the user is subscribed to the feed in multiple folders.
'''
url = nb_url + 'reader/delete_feed'
payload = {'feed_id':feed_id,'in_folder':in_folder}
results = requests.post(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
url = nb_url + 'reader/delete_feed'
payload = {'feed_id':feed_id,'in_folder':in_folder}
results = requests.post(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def rename_folder(folder_to_rename,new_folder_name,in_folder):
'''
Rename a folder.
'''
url = nb_url + 'reader/rename_folder'
payload = {'folder_to_rename':folder_to_rename,'new_folder_name':new_folder_name,'in_folder':in_folder}
results = requests.post(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
def rename_folder(self, folder_to_rename,new_folder_name,in_folder):
'''
Rename a folder.
'''
url = nb_url + 'reader/rename_folder'
payload = {'folder_to_rename':folder_to_rename,'new_folder_name':new_folder_name,'in_folder':in_folder}
results = requests.post(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def delete_folder(folder_to_delete,in_folder,feed_id):
'''
Delete a folder and unsubscribe from all feeds inside.
'''
url = nb_url + 'reader/delete_folder'
payload = {'folder_to_delete':folder_to_delete,'in_folder':in_folder,'feed_id':feed_id}
results = requests.post(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
def delete_folder(self, folder_to_delete,in_folder,feed_id):
'''
Delete a folder and unsubscribe from all feeds inside.
'''
url = nb_url + 'reader/delete_folder'
payload = {'folder_to_delete':folder_to_delete,'in_folder':in_folder,'feed_id':feed_id}
results = requests.post(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def mark_feed_as_read(feed_id):
'''
Mark a list of feeds as read.
'''
url = nb_url + 'reader/mark_feed_as_read'
payload = {'feed_id':feed_id}
results = requests.post(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
def mark_feed_as_read(self, feed_id):
'''
Mark a list of feeds as read.
'''
url = nb_url + 'reader/mark_feed_as_read'
payload = {'feed_id':feed_id}
results = requests.post(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def save_feed_order(folders):
'''
Reorder feeds and move them around between folders.
The entire folder structure needs to be serialized.
'''
def save_feed_order(self, folders):
'''
Reorder feeds and move them around between folders.
The entire folder structure needs to be serialized.
'''
url = nb_url + 'reader/save_feed_order'
payload = {'folders':folders}
results = requests.post(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
url = nb_url + 'reader/save_feed_order'
payload = {'folders':folders}
results = requests.post(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def classifier(id_no):
'''
Get the intelligence classifiers for a user's site.
Only includes the user's own classifiers.
Use /reader/feeds_trainer for popular classifiers.
'''
def classifier(self, id_no):
'''
Get the intelligence classifiers for a user's site.
Only includes the user's own classifiers.
Use /reader/feeds_trainer for popular classifiers.
'''
url = nb_url + 'classifier/%d' % id_no
results = requests.get(url)
return simplejson.loads(results.content)
url = nb_url + 'classifier/%d' % id_no
results = requests.get(url)
return simplejson.loads(results.content)
def classifier_save(like_type,dislike_type,remove_like_type,remove_dislike_type):
'''
Save intelligence classifiers (tags, titles, authors, and the feed) for a feed.
'''
url = nb_url + 'classifier/save'
payload = {'like_[TYPE]':like_type,
'dislike_[TYPE]':dislike_type,
'remove_like_[TYPE]':remove_like_type,
'remove_dislike_[TYPE]':remove_dislike_type}
results = requests.post(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
def classifier_save(self, like_type,dislike_type,remove_like_type,remove_dislike_type):
'''
Save intelligence classifiers (tags, titles, authors, and the feed) for a feed.
'''
url = nb_url + 'classifier/save'
payload = {'like_[TYPE]':like_type,
'dislike_[TYPE]':dislike_type,
'remove_like_[TYPE]':remove_like_type,
'remove_dislike_[TYPE]':remove_dislike_type}
results = requests.post(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
def opml_export():
'''
Download a backup of feeds and folders as an OPML file.
Contains folders and feeds in XML; useful for importing in another RSS reader.
'''
url = nb_url + 'import/opml_export'
results = requests.get(url)
return simplejson.loads(results.content)
def opml_export(self, ):
'''
Download a backup of feeds and folders as an OPML file.
Contains folders and feeds in XML; useful for importing in another RSS reader.
'''
url = nb_url + 'import/opml_export'
results = requests.get(url)
return simplejson.loads(results.content)
def opml_upload(opml_file):
'''
Upload an OPML file.
'''
url = nb_url + 'import/opml_upload'
f = open(opml_file)
payload = {'file':f}
f.close()
results = requests.post(url, data=payload, cookies=cookies)
return simplejson.loads(results.content)
def opml_upload(self, opml_file):
'''
Upload an OPML file.
'''
url = nb_url + 'import/opml_upload'
f = open(opml_file)
payload = {'file':f}
f.close()
results = requests.post(url, data=payload, cookies=self.cookies)
return simplejson.loads(results.content)
|