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 | 1x
1x
33x
11x
11x
1x
12x
| import fetch from 'isomorphic-fetch';
import serialize from 'tm-serialize';
/**
* Reviews API JS client.
*
* In order to use Reviews API you should create an instance of this class.
* ~~~~
* import Reviews from "tm-reviews-api-client-js";
* const reviews = new Reviews ('http://api.templatemonster.com/reviews/v1', 'en');
* const list = reviews.getReviews ([12345, 55555]);
* ~~~~
* @constructor Reviews
*/
export default class Reviews {
locale = null;
url = null;
constructor (url, locale = 'en') {
this.locale = locale;
this.url = url;
}
/**
* Return review information for given identifiers.
* @param params {Object} Reviews parameters
* @returns {Object} <pre>{
* "currentPageIndex":1,
* "totalCount":11,
* "lastPageIndex":6,
* "items": [
* {
* "id":23,
* "status":4,
* "user_id":21543,
* "user_name":"mice mice",
* "title":"review title",
* "content":"review content",
* "score":5,
* "template_id":58444,
* "vote_up":0,
* "vote_down":0,
* "_links":{"self":{"href":"http://service-reviews.dev/api/v1/reviews/23"}}
* }, ...]
* }</pre>
* @method Reviews#getReviews
*/
async getReviews(params = {}) {
params = {...params, ...{locale: this.locale}};
const response = await fetch(`${this.url}/reviews?${serialize(params)}`);
if (response.status >= 400) {
throw new Error('Bad server response');
}
const paginationData = {
currentPageIndex: parseInt(response.headers.get('x-pagination-current-page')),
totalCount: parseInt(response.headers.get('x-pagination-total-count')),
lastPageIndex: parseInt(response.headers.get('x-pagination-page-count'))
};
return {
...paginationData,
items: await response.json()
};
};
/**
* Return approve review information for given identifiers.
* @param token {String} Access token
* @param id {Number} Review id
* @returns {Object} <pre>{
* "canModerate": 1,
* "item":
* {
* "id": 1,
* "title": "Really good. Html is better than cms",
* "content": "I had font problem with flash cms. Now I have no problem with html",
* "score": 5,
* "created_at": 1469607948519,
* "user_id": 123,
* "template_id": 12345,
* "status": "initial",
* "vote_up": 1,
* "vote_down": 0,
* "_links": {"self":{"href":"http://service-reviews.dev/api/v1/reviews/1"}}
* }
* }</pre>
* @method Reviews#approveReview
*/
async approveReview (token, id) {
if (!token.length) {
throw new Error('Token not found');
}
if (!this._idExist(id)) {
throw new Error('Id is not correct');
}
const response = await fetch(`${this.url}/reviews/approve/${id}`, {
method : 'POST',
headers: new Headers({
'content-type' : 'application/x-www-form-urlencoded',
'Authorization' : token
})
});
if (response.status >= 400) {
throw new Error('Bad server response');
}
const headersData = {
canModerate: parseInt(response.headers.get('X-CAN-MODERATE'))
};
return {
...headersData,
item: await response.json()
};
}
/**
* Return complete review information for given identifiers.
* @param token {String} Access token
* @param id {Number} Review id
* @returns {Object} <pre>{
* "canModerate": 1,
* "item":
* {
* "id": 1,
* "title": "Really good. Html is better than cms",
* "content": "I had font problem with flash cms. Now I have no problem with html",
* "score": 5,
* "created_at": 1469607948519,
* "user_id": 123,
* "template_id": 12345,
* "status": "initial",
* "vote_up": 1,
* "vote_down": 0,
* "_links": {"self":{"href":"http://service-reviews.dev/api/v1/reviews/1"}}
* }
* }</pre>
* @method Reviews#completeReview
*/
async completeReview (token, id) {
if (!token.length) {
throw new Error('Token not found');
}
if (!this._idExist(id)) {
throw new Error('Id is not correct');
}
const response = await fetch(`${this.url}/reviews/${id}`, {
method : 'POST',
headers: new Headers({
'content-type' : 'application/x-www-form-urlencoded',
'Authorization' : token
})
});
if (response.status >= 400) {
throw new Error('Bad server response');
}
const headersData = {
canModerate: parseInt(response.headers.get('X-CAN-MODERATE'))
};
return {
...headersData,
item: await response.json()
};
}
/**
* Return decline review information for given identifiers.
* @param token {String} Access token
* @param id {Number} Review id
* @returns {Object} <pre>{
* "canModerate": 1,
* "item":
* {
* "id": 1,
* "title": "Really good. Html is better than cms",
* "content": "I had font problem with flash cms. Now I have no problem with html",
* "score": 5,
* "created_at": 1469607948519,
* "user_id": 123,
* "template_id": 12345,
* "status": "initial",
* "vote_up": 1,
* "vote_down": 0,
* "_links": {"self":{"href":"http://service-reviews.dev/api/v1/reviews/1"}}
* }
* }</pre>
* @method Reviews#declineReview
*/
async declineReview (token, id) {
if (!token.length) {
throw new Error('Token not found');
}
if (!this._idExist(id)) {
throw new Error('Id is not correct');
}
const response = await fetch(`${this.url}/reviews/decline/${id}`, {
method : 'POST',
headers: new Headers({
'content-type' : 'application/x-www-form-urlencoded',
'Authorization' : token
})
});
if (response.status >= 400) {
throw new Error('Bad server response');
}
const headersData = {
canModerate: parseInt(response.headers.get('X-CAN-MODERATE'))
};
return {
...headersData,
item: await response.json()
};
}
/**
* Return add the review vote: increment vote_up or vote_down field.
* @param token {String} Access token
* @param id {Number} Review id
* @returns {Object} <pre>{
* "canModerate": 1,
* "item":
* {
* "id": 1,
* "title": "Really good. Html is better than cms",
* "content": "I had font problem with flash cms. Now I have no problem with html",
* "score": 5,
* "created_at": 1469607948519,
* "user_id": 123,
* "template_id": 12345,
* "status": "initial",
* "vote_up": 1,
* "vote_down": 0,
* "_links": {"self":{"href":"http://service-reviews.dev/api/v1/reviews/1"}}
* }
* }</pre>
* @method Reviews#addReviewVote
*/
async addReviewVote (token, id) {
if (!token.length) {
throw new Error('Token not found');
}
if (!this._idExist(id)) {
throw new Error('Id is not correct');
}
const response = await fetch(`${this.url}/reviews/${id}`, {
method : 'POST',
headers: new Headers({
'content-type' : 'application/x-www-form-urlencoded',
'Authorization' : token
})
});
if (response.status >= 400) {
throw new Error('Bad server response');
}
const headersData = {
canModerate: parseInt(response.headers.get('X-CAN-MODERATE'))
};
return {
...headersData,
item: await response.json()
};
}
/**
* Return reply the review information for given identifiers.
* @param token {String} Access token
* @param review_id {Number} ID of the parent review
* @returns {Object} <pre>{
* "canModerate": 1,
* "item":
* {
* "id": 1,
* "review_id": 1,
* "content": "I had font problem with flash cms. Now I have no problem with html",
* "created_at": 1469607948519,
* "user_id": 123,
* "vote_up": 0,
* "vote_down": 0,
* "_links": {"self":{"href":"http://service-reviews.dev/api/v1/reviews/1/comment/1"}}
* }
* }</pre>
* @method Reviews#replayTheReview
*/
async replayTheReview (token, review_id) {
if (!token.length) {
throw new Error('Token not found');
}
if (!this._idExist(review_id)) {
throw new Error('Review id is not correct');
}
const response = await fetch(`${this.url}/reviews/${review_id}/comments`, {
method : 'POST',
headers: new Headers({
'content-type' : 'application/x-www-form-urlencoded',
'Authorization' : token
})
});
if (response.status >= 400) {
throw new Error('Bad server response');
}
const headersData = {
canModerate: parseInt(response.headers.get('X-CAN-MODERATE'))
};
return {
...headersData,
item: await response.json()
};
}
/**
* Return request review comments list.
* @param review_id {Number} ID of the parent review
* @returns {Object} <pre>{
* "canModerate": 1,
* "item":
* {
* "id": 1,
* "review_id": 1,
* "content": "I had font problem with flash cms. Now I have no problem with html",
* "created_at": 1469607948519,
* "user_id": 123,
* "vote_up": 0,
* "vote_down": 0,
* "_links": {"self":{"href":"http://service-reviews.dev/api/v1/reviews/1/comment/1"}}
* }
* }</pre>
* @method Reviews#requestReviewComments
*/
async requestReviewComments(review_id) {
if (!this._idExist(review_id)) {
throw new Error('Review id is not correct');
}
const response = await fetch(`${this.url}/reviews/${review_id}/comments`);
if (response.status >= 400) {
throw new Error('Bad server response');
}
const headersData = {
canModerate: parseInt(response.headers.get('X-CAN-MODERATE'))
};
return {
...headersData,
item: await response.json()
};
}
/**
* Return vote the review comment.
* @param token {String} Access token
* @param id {Number} ID of the comment
* @param review_id {Number} ID of the parent review
* @returns {Object} <pre>{
* "canModerate": 1,
* "item":
* {
*
* "id": 1,
* "review_id": 1,
* "content": "I had font problem with flash cms. Now I have no problem with html",
* "created_at": 1469607948519,
* "user_id": 123,
* "vote_up": 0,
* "vote_down": 0,
* "_links": {"self":{"href":"http://service-reviews.dev/api/v1/reviews/1/comment/1"}}
* }
* }</pre>
* @method Reviews#voteComments
*/
async voteComments(token, id, review_id) {
if (!token.length) {
throw new Error('Token not found');
}
if (!this._idExist(id)) {
throw new Error('Id is not correct');
}
if (!this._idExist(review_id)) {
throw new Error('Review id is not correct');
}
const response = await fetch(`${this.url}/reviews/${review_id}/comments/${id}`, {
method : 'POST',
headers: new Headers({
'content-type' : 'application/x-www-form-urlencoded',
'Authorization' : token
})
});
if (response.status >= 400) {
throw new Error('Bad server response');
}
const headersData = {
canModerate: parseInt(response.headers.get('X-CAN-MODERATE'))
};
return {
...headersData,
item: await response.json()
};
}
/**
* Check for correct id
* @param id {Number}
* @returns {boolean}
* @private
*/
_idExist (id) {
return !(isNaN(id)) && (id !== null) && (id > 0);
}
} |