| 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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565 | 1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
10x
1x
27x
12x
1x
1x
15x
1x
6x
1x
2x
1x
4x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
2x
1x
1x
2x
1x
2x
1x
1x
2x
1x
2x
1x
1x
2x
1x
2x
1x
1x
2x
1x
2x
1x
1x
2x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
3x
| var request = require('nets')
var xtend = require('xtend')
module.exports.base = 'https://conduit.productionready.io/api'
module.exports = RealWorld
/**
* Realworld library for open API calls using JavaScript
* @param {Object} [opts] options for configuring API
* @param {string} [opts.token=null] authentication token from RealWorld
* @param {string} [opts.apiRoot=https://conduit.productionready.io/api] the url
* to Realworld API
* @example
* var client = new RealWorld()
* @example
* var client = new RealWorld({
* apiRoot: 'http://localhost:8000/api',
* token: 'my-secret-authentication-token'
* })
* @see [RealWorld API Spec](https://github.com/gothinkster/realworld/tree/master/api#realworld-api-spec)
*/
function RealWorld (opts) {
Iif (!(this instanceof RealWorld)) return new RealWorld(opts)
Iif (!opts) opts = {}
this.token = opts.token || null
this.apiRoot = opts.apiRoot || 'https://conduit.productionready.io/api'
}
var defaults = {
json: true
}
var limit = function (count, p) {
return `limit=${count}&offset=${p ? p * count : 0}`
}
RealWorld.prototype._useToken = function () {
if (this.token) {
return xtend(defaults, {
headers: {
Authorization: `Token ${this.token}`
}
})
}
}
var encode = encodeURIComponent
RealWorld.prototype._getRequest = function (url, cb) {
request(
xtend(defaults, this._useToken(), {
method: 'GET',
url: `${this.apiRoot}${url}`
}),
cb
)
}
RealWorld.prototype._postRequest = function (url, body, cb) {
request(
xtend(defaults, this._useToken(), {
method: 'POST',
url: `${this.apiRoot}${url}`,
body: body
}),
cb
)
}
RealWorld.prototype._putRequest = function (url, body, cb) {
request(
xtend(defaults, this._useToken(), {
method: 'PUT',
url: `${this.apiRoot}${url}`,
body: body
}),
cb
)
}
RealWorld.prototype._delRequest = function (url, cb) {
request(
xtend(defaults, this._useToken(), {
method: 'DELETE',
url: `${this.apiRoot}${url}`
}),
cb
)
}
/**
* Log in to the RealWorld API
* If successful, the `data` result will be type {User}
* @param {Object} opts
* @param {string} opts.email email address of user
* @param {string} opts.password password of user
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.login(
* {
* email: 'mike@example.com',
* password: 'secret'
* },
* handleResponse
* )
*/
RealWorld.prototype.login = function (opts, cb) {
Iif (typeof opts === 'function') {
cb = opts
opts = {}
}
Eif (opts.email && opts.password) {
this._postRequest(
`/users/login`,
{
user: {
email: opts.email,
password: opts.password
}
},
cb
)
} else {
cb(new Error('Must supply username and password'))
}
}
/**
* Register a new user with the RealWorld API
* @param {Object} opts
* @param {string} opts.username username of registering user
* @param {string} opts.email email address of registering user
* @param {string} opts.password password of registering user
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.register(
* {
* email: 'rick@example.com',
* password: 'shhhh',
* username: 'rick'
* },
* handleResponse
* )
*/
RealWorld.prototype.register = function (opts, cb) {
Iif (typeof opts === 'function') {
cb = opts
opts = {}
}
Eif (opts.username && opts.email && opts.password) {
this._postRequest(
`/users`,
{
user: {
username: opts.username,
email: opts.email,
password: opts.password
}
},
cb
)
} else {
cb(new Error('Must supply a username, email, and password'))
}
}
/**
* Get the logged in user
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.getUser(handleResponse)
*/
RealWorld.prototype.getUser = function (cb) {
this._getRequest(`/user`, cb)
}
/**
* Update the logged in user info
* @param {Object} opts
* @param {string} [opts.email=null] email address of user
* @param {string} [opts.username=null] username of user
* @param {string} [opts.bio=null] biography of user
* @param {string} [opts.password=null] password of user
* @param {string} [opts.image=null] url of user image
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.updateUser(
* {
* email: 'stacy@example.com',
* password: 'hush',
* username: 'stace',
* bio: 'riot grrl'
* },
* handleResponse
* )
*/
RealWorld.prototype.updateUser = function (opts, cb) {
Iif (typeof opts === 'function') {
cb = opts
opts = {}
}
this._putRequest(
`/user`,
{
user: opts
},
cb
)
}
/**
* Get profile of a user
* @param {string} username username of profile to retrieve
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.getProfile('rick', handleResponse)
*/
RealWorld.prototype.getProfile = function (username, cb) {
this._getRequest(`/profiles/${username}`, cb)
}
/**
* Follow a user (authentication required)
* @param {string} username username to follow
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.followUser('rick', handleResponse)
*/
RealWorld.prototype.followUser = function (username, cb) {
this._postRequest(`/profiles/${username}/follow`, {}, cb)
}
/**
* Unfollow a user (authentication required)
* @param {string} username username to unfollow
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.unFollowUser('rick', handleResponse)
*/
RealWorld.prototype.unFollowUser = function (username, cb) {
this._delRequest(`/profiles/${username}/follow`, cb)
}
/**
* Request a list of 20 articles sorted by most recent in descending order
* @param {Number} [page=0] page specify which page of articles to show
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.listAllArticles(handleResponse)
* @example
* client.listAllArticles(2, handleResponse)
*/
RealWorld.prototype.listAllArticles = function (page, cb) {
if (typeof page === 'function') {
cb = page
page = null
}
this._getRequest(`/articles?${limit(20, page)}`, cb)
}
/**
* Request a list of 10 articles filtered by a tag and sorted by most recent
* in descending order
* @param {string} tag tag name to filter by
* @param {Number} [page=0] specify which page of articles to show
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.listArticlesByTag('JavaScript', handleResponse)
* @example
* client.listArticlesByTag('JavaScript', 2, handleResponse)
*/
RealWorld.prototype.listArticlesByTag = function (tag, page, cb) {
if (typeof page === 'function') {
cb = page
page = null
}
this._getRequest(`/articles?tag=${encode(tag)}&${limit(10, page)}`, cb)
}
/**
* Request a list of five articles filtered by author and sorted by most recent
* in descending order
* @param {string} author username of author to filter by
* @param {Number} [page=0] specify which page of articles to show
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.listArticlesByAuthor('rick', handleResponse)
* @example
* client.listArticlesByAuthor('rick', 2, handleResponse)
*/
RealWorld.prototype.listArticlesByAuthor = function (author, page, cb) {
if (typeof page === 'function') {
cb = page
page = null
}
this._getRequest(`/articles?author=${encode(author)}&${limit(5, page)}`, cb)
}
/**
* Request a list of 20 articles filtered by author favorites and sorted by most
* recent in descending order
* @param {string} author username of author to filter favorite articles by
* @param {Number} [page=0] specify which page of articles to show
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.listArticlesByAuthorFavorites('rick', handleResponse)
* @example
* client.listArticlesByAuthorFavorites('rick', 1, handleResponse)
*/
RealWorld.prototype.listArticlesByAuthorFavorites = function (author, page, cb) {
if (typeof page === 'function') {
cb = page
page = null
}
this._getRequest(
`/articles?favorited=${encode(author)}&${limit(20, page)}`,
cb
)
}
/**
* Request a list of ten articles from the currently logged in users feed sorted
* by most recent in descending order (authentication required)
* @param {Number} [page=0] specify which page of articles to show
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.feedArticles(handleResponse)
* @example
* client.feedArticles(2, handleResponse)
*/
RealWorld.prototype.feedArticles = function (page, cb) {
if (typeof page === 'function') {
cb = page
page = null
}
this._getRequest(`/articles/feed?${limit(10, page)}`, cb)
}
/**
* Request contents from a single article with the specified slug
* @param {string} slug shortname (slug) of article
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.getArticle('angular-app-dev-e33mn9', handleResponse)
*/
RealWorld.prototype.getArticle = function (slug, cb) {
this._getRequest(`/articles/${slug}`, cb)
}
/**
* Create a new article (authentication required)
* @param {Object} opts
* @param {string} opts.title title of article
* @param {string} opts.description short description of article
* @param {string} opts.body content of article
* @param {[string]} [opts.tagList=null] array of tags to add to article
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.createArticle(
* {
* title: 'My awesome article',
* description: 'beep boop',
* body: 'wham bam thank you ma\'am',
* tagList: ['awesomeness', 'robots']
* },
* handleResponse
* )
*/
RealWorld.prototype.createArticle = function (opts, cb) {
Iif (typeof opts === 'function') {
cb = opts
opts = {}
}
this._postRequest(
`/articles`,
{
article: opts
},
cb
)
}
/**
* Update an existing article with given slug and options (authentication
* required)
* @param {string} slug shortname (slug) of article to update
* @param {Object} opts
* @param {string} [opts.title=null] title of article
* @param {string} [opts.description=null] short description of article
* @param {string} [opts.body=null] content of article
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.updateArticle('my-awesome-article-ew9439', {
* title: 'my awesome gender neutral article',
* description: 'boop beep',
* body: 'wham bam thank you friend'
* })
*/
RealWorld.prototype.updateArticle = function (slug, opts, cb) {
Iif (typeof opts === 'function') {
cb = opts
opts = {}
}
this._putRequest(
`/articles/${slug}`,
{
article: opts
},
cb
)
}
/**
* Delete an existing article with the given slug (authentication required)
* @param {string} slug shortname (slug) of article to delete
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.deleteArticle('my-awesome-article-ew9439', handleResponse)
*/
RealWorld.prototype.deleteArticle = function (slug, cb) {
this._delRequest(`/articles/${slug}`, cb)
}
/**
* Add a comment to an article with the given slug (authentication required)
* @param {string} slug shortname (slug) of article to add comment to
* @param {Object} opts
* @param {string} opts.body content of comment
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.addComment(
* 'my-awesome-article-ew9439',
* {
* body: 'this is a good article'
* },
* handleResponse
* )
*/
RealWorld.prototype.addComment = function (slug, opts, cb) {
Iif (typeof opts === 'function') {
cb = opts
opts = {}
}
this._postRequest(
`/articles/${slug}/comments`,
{
comment: opts
},
cb
)
}
/**
* Get comments from an article
* @param {string} slug shortname (slug) of article from which to retrieve
* comments
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.getComments('angular-app-dev-e33mn9', handleResponse)
*/
RealWorld.prototype.getComments = function (slug, cb) {
this._getRequest(`/articles/${slug}/comments`, cb)
}
/**
* Delete comment from an article (authentication required)
* @param {string} slug shortname (slug) of article
* @param {string} commentId unique id of comment to delete
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.deleteComment('angular-app-dev-e33mn9', 'e11dfeg', handleResponse)
*/
RealWorld.prototype.deleteComment = function (slug, commentId, cb) {
this._delRequest(`/articles/${slug}/comments/${commentId}`, cb)
}
/**
* Favorite an article (authentication required)
* @param {string} slug shortname (slug) of article to favorite
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.favoriteArticle('my-awesome-article-ew9439', handleResponse)
*/
RealWorld.prototype.favoriteArticle = function (slug, cb) {
this._postRequest(`/articles/${slug}/favorite`, {}, cb)
}
/**
* Unfavorite an article (authentication required)
* @param {string} slug shortname (slug) of article to unfavorite
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.unFavoriteArticle('my-awesome-article-ew9439', handleResponse)
*/
RealWorld.prototype.unFavoriteArticle = function (slug, cb) {
this._delRequest(`/articles/${slug}/favorite`, cb)
}
/**
* Get a list of tags
* @param {RealWorld~requestCallback} cb Callback function
* @example
* client.getTags(handleResponse)
*/
RealWorld.prototype.getTags = function (cb) {
this._getRequest(`/tags`, cb)
}
/**
* Set the authentication token
* @param {string} _token authentication token to set
* @example
* client.setToken('my-secret-authentication-token')
*/
RealWorld.prototype.setToken = function (_token) {
this.token = _token
}
/**
* This callback is displayed as part of the RealWorld class. The error should
* be null if the method was able to run. HTTP and API errors are not caught as
* errors so that you can catch them yourself. For example, a response code 500
* may return `(null, { res.statusCode: 500, res.statusMessage: 'Internal Server Error' }, null)`.
*
* API errors are returned with a 422 status code. Errors are included as JSON
* in the `data` result and are in the form of
*
* `{
* "errors":{
* "body": [
* "can't be empty"
* ]
* }
* }`
*
* where `body` may be any parameter such as `password`, `email`, etc.
*
* Successful API requests will return JSON data as seen in the
* {@link https://github.com/gothinkster/realworld/tree/master/api#realworld-api-spec RealWorld API Spec}
* @callback RealWorld~requestCallback
* @param {Error} err error if method was unable to run
* @param {Object} res response object from server
* @param {Object} data data result from the server as JSON
* @example
* function handleResponse (err, res, data) {
* if (err) return console.error(err)
* if (res.statusCode === 422 && data.errors) {
* Object.keys(data.errors).forEach(function (err) {
* var values = data.errors[err]
* values.forEach(function (v) {
* console.error(`${err} ${v}`)
* })
* })
* return
* }
* if (res.statusCode !== 200) {
* return console.log(`${res.statusCode}: ${res.statusMessage}`)
* }
* return console.log(data)
* }
*
*/
|