Skip to content
This repository was archived by the owner on Mar 12, 2025. It is now read-only.

Commit 939fe51

Browse files
callmekatootiecallmekatootie
committed
Merge review resource methods
1 parent 90c4360 commit 939fe51

15 files changed

+1593
-143
lines changed

‎README.md

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
# Topcoder Submission API Review Types Wrapper
1+
# Topcoder Submission API Wrapper
22

3-
Wrapper library for Topcoder Submission API ReviewTypes endpoint
3+
Wrapper library for Topcoder Submission API
44

55
## How to use this Wrapper
66

77
1. Include the wrapper in package.json as follows
88

99
```bash
10-
"tc-submission-api-review-types-wrapper": "topcoder-platform/tc-submission-api-review-types-wrapper.git"
10+
"tc-submission-api-wrapper": "topcoder-platform/tc-submission-api-wrapper.git"
1111
```
1212

1313
2. Create an instance of this wrapper with the configuration variables listed below
1414

1515
```bash
16-
const reviewTypesApi = require('tc-submission-api-review-types-wrapper')
17-
const reviewTypesApiClient = reviewTypesApi(_.pick(config,
16+
const submissionApi = require('tc-submission-api-wrapper')
17+
const submissionApiClient = submissionApi(_.pick(config,
1818
['AUTH0_URL', 'AUTH0_AUDIENCE', 'TOKEN_CACHE_TIME',
1919
'AUTH0_CLIENT_ID', 'AUTH0_CLIENT_SECRET', 'SUBMISSION_API_URL',
2020
'AUTH0_PROXY_SERVER_URL']))
@@ -35,22 +35,26 @@ Wrapper library for Topcoder Submission API ReviewTypes endpoint
3535
E.g.
3636

3737
```bash
38-
let reviewTypeId = '8f4e8b6a-0ad2-4ff6-ab19-afeb102ff3b4'
38+
const reviewTypeId = '8f4e8b6a-0ad2-4ff6-ab19-afeb102ff3b4'
3939
40-
reviewTypesApiClient
40+
submissionApiClient
4141
.createReviewType({ name: 'test-for-create', isActive: true })
4242
.then(result => console.log(result.body, result.status))
4343
.catch(err => console.log(err))
4444
45-
await reviewTypesApiClient.deleteReviewType(reviewTypeId)
45+
await submissionApiClient.deleteReviewType(reviewTypeId)
46+
47+
const result = await submissionApiClient.searchReviews({ page: 2, perPage: 30 })
4648
```
4749

4850
Refer `index.js` for the list of available wrapper functions
4951

50-
## Documentation for Review Types wrapper methods
52+
## Documentation for wrapper methods
5153

5254
All URIs are relative to **SUBMISSION_API_URL** configuration variable.
5355

56+
### Review Types wrapper methods
57+
5458
Method | HTTP request | Description
5559
------------- | ------------- | -------------
5660
[**searchReviewTypes**](docs/ReviewTypesApi.md#searchReviewTypes) | **GET** /reviewTypes | Search review types.
@@ -62,9 +66,22 @@ Method | HTTP request | Description
6266
[**patchReviewType**](docs/ReviewTypesApi.md#patchReviewType) | **PATCH** /reviewTypes/{reviewTypeId} | Partially update review type.
6367
[**deleteReviewType**](docs/ReviewTypesApi.md#deleteReviewType) | **DELETE** /reviewTypes/{reviewTypeId} | Delete the review type.
6468

69+
### Reviews wrapper methods
70+
71+
Method | HTTP request | Description
72+
------------- | ------------- | -------------
73+
[**searchReviews**](docs/ReviewsApi.md#searchReviews) | **GET** /reviews | Search reviews.
74+
[**headReviews**](docs/ReviewsApi.md#headReviews) | **HEAD** /reviews | Same to search reviews, but only response status and headers information return.
75+
[**createReview**](docs/ReviewsApi.md#createReview) | **POST** /reviews | Create a review.
76+
[**getReview**](docs/ReviewsApi.md#getReview) | **GET** /reviews/{reviewId} | Get the review.
77+
[**headReview**](docs/ReviewsApi.md#headReview) | **HEAD** /reviews/{reviewId} | Same to get review, but only response status and headers information return.
78+
[**updateReview**](docs/ReviewsApi.md#updateReview) | **PUT** /reviews/{reviewId} | Fully update review.
79+
[**patchReview**](docs/ReviewsApi.md#patchReview) | **PATCH** /reviews/{reviewId} | Partially update review.
80+
[**deleteReview**](docs/ReviewsApi.md#deleteReview) | **DELETE** /reviews/{reviewId} | Delete the review.
81+
6582
## Authorization
6683

67-
Review Types wrapper internally generates a **JWT token using Auth0 credentials** and pass it in the `Authorization` header.
84+
The wrapper internally generates a **JWT token using Auth0 credentials** and pass it in the `Authorization` header.
6885

6986
## Running tests
7087

‎Verification.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Topcoder Submission API Review Types Wrapper
1+
# Topcoder Submission API Wrapper
22

33
## Step to run tests
44
1. run `source env.sh` to initialize process environment
@@ -7,14 +7,18 @@
77

88
## Test Coverage Report
99

10-
45 passing (2m)
10+
105 passing (2m)
11+
12+
-----------------------------------|----------|----------|----------|----------|-------------------|
13+
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s |
14+
-----------------------------------|----------|----------|----------|----------|-------------------|
15+
All files | 98.86 | 84.62 | 100 | 98.86 | |
16+
submission-api-wrapper | 100 | 100 | 100 | 100 | |
17+
index.js | 100 | 100 | 100 | 100 | |
18+
submission-api-wrapper/src | 100 | 100 | 100 | 100 | |
19+
ReviewTypesApi.js | 100 | 100 | 100 | 100 | |
20+
ReviewsApi.js | 100 | 100 | 100 | 100 | |
21+
submission-api-wrapper/src/common | 96 | 81.82 | 100 | 96 | |
22+
helper.js | 96 | 81.82 | 100 | 96 | 63 |
23+
-----------------------------------|----------|----------|----------|----------|-------------------|
1124

12-
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s |
13-
---------------------------------------------------|----------|----------|----------|----------|-------------------|
14-
All files | 98.33 | 84.62 | 100 | 98.33 | |
15-
tc-submission-api-review-types-wrapper | 100 | 100 | 100 | 100 | |
16-
index.js | 100 | 100 | 100 | 100 | |
17-
tc-submission-api-review-types-wrapper/src | 100 | 100 | 100 | 100 | |
18-
ReviewTypesApi.js | 100 | 100 | 100 | 100 | |
19-
tc-submission-api-review-types-wrapper/src/common | 96 | 81.82 | 100 | 96 | |
20-
helper.js | 96 | 81.82 | 100 | 96 | 63 |

‎docs/Review.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Review
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **String** | The review id. |
7+
**score** | **Number** | The review score. |
8+
**typeId** | **String** | The review type id. |
9+
**reviewerId** | **Integer or String** | The reviewer id. |
10+
**scoreCardId** | **Integer or String** | The review's scorecard id. |
11+
**submissionId** | **String** | The submission id. |
12+
**metadata** | **Object** | The review's metadata. |
13+
**created** | **String** | The ISO date string of created date. |
14+
**updated** | **String** | The ISO date string of updated date. |
15+
**createdBy** | **String** | The created by user. |
16+
**updatedBy** | **String** | The updated by user. |

‎docs/ReviewData.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# ReviewData
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**score** | **Number** | The review score. |
7+
**typeId** | **String** | The review type id. |
8+
**reviewerId** | **Integer or String** | The reviewer id. |
9+
**scoreCardId** | **Integer or String** | The review's scorecard id. |
10+
**submissionId** | **String** | The submission id. |
11+
**metadata** | **Object** | The review's metadata. |

‎docs/ReviewTypesApi.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ Search review types. Link headers are sent back and they have rel set to prev, n
2121

2222
### Example
2323
```javascript
24-
const reviewTypesApi = require('tc-submission-api-review-types-wrapper')
25-
const reviewTypesApiClient = reviewTypesApi(_.pick(config,
24+
const submissionApi = require('tc-submission-api-wrapper')
25+
const submissionApiClient = submissionApi(_.pick(config,
2626
['AUTH0_URL', 'AUTH0_AUDIENCE', 'TOKEN_CACHE_TIME',
2727
'AUTH0_CLIENT_ID', 'AUTH0_CLIENT_SECRET', 'SUBMISSION_API_URL',
2828
'AUTH0_PROXY_SERVER_URL']))
@@ -35,13 +35,13 @@ const reqQuery = {
3535
}
3636

3737
// Promise model
38-
reviewTypesApiClient
38+
submissionApiClient
3939
.searchReviewTypes(reqQuery)
4040
.then(result => console.log(result.body, result.status))
4141
.catch(err => console.log(err))
4242

4343
// Async / await model
44-
await reviewTypesApiClient.searchReviewTypes(reqQuery)
44+
await submissionApiClient.searchReviewTypes(reqQuery)
4545
```
4646

4747
### Parameters
@@ -71,8 +71,8 @@ Same to search review types, but only response status and headers information re
7171

7272
### Example
7373
```javascript
74-
const reviewTypesApi = require('tc-submission-api-review-types-wrapper')
75-
const reviewTypesApiClient = reviewTypesApi(_.pick(config,
74+
const submissionApi = require('tc-submission-api-wrapper')
75+
const submissionApiClient = submissionApi(_.pick(config,
7676
['AUTH0_URL', 'AUTH0_AUDIENCE', 'TOKEN_CACHE_TIME',
7777
'AUTH0_CLIENT_ID', 'AUTH0_CLIENT_SECRET', 'SUBMISSION_API_URL',
7878
'AUTH0_PROXY_SERVER_URL']))
@@ -85,13 +85,13 @@ const reqQuery = {
8585
}
8686

8787
// Promise model
88-
reviewTypesApiClient
88+
submissionApiClient
8989
.headReviewTypes(reqQuery)
9090
.then(result => console.log(result.status))
9191
.catch(err => console.log(err))
9292

9393
// Async / await model
94-
await reviewTypesApiClient.headReviewTypes(reqQuery)
94+
await submissionApiClient.headReviewTypes(reqQuery)
9595
```
9696

9797
### Parameters
@@ -121,8 +121,8 @@ Create a review type.
121121

122122
### Example
123123
```javascript
124-
const reviewTypesApi = require('tc-submission-api-review-types-wrapper')
125-
const reviewTypesApiClient = reviewTypesApi(_.pick(config,
124+
const submissionApi = require('tc-submission-api-wrapper')
125+
const submissionApiClient = submissionApi(_.pick(config,
126126
['AUTH0_URL', 'AUTH0_AUDIENCE', 'TOKEN_CACHE_TIME',
127127
'AUTH0_CLIENT_ID', 'AUTH0_CLIENT_SECRET', 'SUBMISSION_API_URL',
128128
'AUTH0_PROXY_SERVER_URL']))
@@ -133,13 +133,13 @@ const reqBody = {
133133
}
134134

135135
// Promise model
136-
reviewTypesApiClient
136+
submissionApiClient
137137
.createReviewType(reqBody)
138138
.then(result => console.log(result.body, result.status))
139139
.catch(err => console.log(err))
140140

141141
// Async / await model
142-
await reviewTypesApiClient.createReviewType(reqBody)
142+
await submissionApiClient.createReviewType(reqBody)
143143
```
144144

145145
### Parameters
@@ -169,22 +169,22 @@ Get the review type by id.
169169

170170
### Example
171171
```javascript
172-
const reviewTypesApi = require('tc-submission-api-review-types-wrapper')
173-
const reviewTypesApiClient = reviewTypesApi(_.pick(config,
172+
const submissionApi = require('tc-submission-api-wrapper')
173+
const submissionApiClient = submissionApi(_.pick(config,
174174
['AUTH0_URL', 'AUTH0_AUDIENCE', 'TOKEN_CACHE_TIME',
175175
'AUTH0_CLIENT_ID', 'AUTH0_CLIENT_SECRET', 'SUBMISSION_API_URL',
176176
'AUTH0_PROXY_SERVER_URL']))
177177

178-
let reviewTypeId = '8f4e8b6a-0ad2-4ff6-ab19-afeb102ff3b4'
178+
const reviewTypeId = '8f4e8b6a-0ad2-4ff6-ab19-afeb102ff3b4'
179179

180180
// Promise model
181-
reviewTypesApiClient
181+
submissionApiClient
182182
.getReviewType(reviewTypeId)
183183
.then(result => console.log(result.body, result.status))
184184
.catch(err => console.log(err))
185185

186186
// Async / await model
187-
await reviewTypesApiClient.getReviewType(reviewTypeId)
187+
await submissionApiClient.getReviewType(reviewTypeId)
188188
```
189189
### Parameters
190190

@@ -213,22 +213,22 @@ Same to get review type, but only response status and headers information return
213213

214214
### Example
215215
```javascript
216-
const reviewTypesApi = require('tc-submission-api-review-types-wrapper')
217-
const reviewTypesApiClient = reviewTypesApi(_.pick(config,
216+
const submissionApi = require('tc-submission-api-wrapper')
217+
const submissionApiClient = submissionApi(_.pick(config,
218218
['AUTH0_URL', 'AUTH0_AUDIENCE', 'TOKEN_CACHE_TIME',
219219
'AUTH0_CLIENT_ID', 'AUTH0_CLIENT_SECRET', 'SUBMISSION_API_URL',
220220
'AUTH0_PROXY_SERVER_URL']))
221221

222-
let reviewTypeId = '8f4e8b6a-0ad2-4ff6-ab19-afeb102ff3b4'
222+
const reviewTypeId = '8f4e8b6a-0ad2-4ff6-ab19-afeb102ff3b4'
223223

224224
// Promise model
225-
reviewTypesApiClient
225+
submissionApiClient
226226
.headReviewType(reviewTypeId)
227227
.then(result => console.log(result.status))
228228
.catch(err => console.log(err))
229229

230230
// Async / await model
231-
await reviewTypesApiClient.headReviewType(reviewTypeId)
231+
await submissionApiClient.headReviewType(reviewTypeId)
232232
```
233233

234234
### Parameters
@@ -258,26 +258,26 @@ Fully update review type.
258258

259259
### Example
260260
```javascript
261-
const reviewTypesApi = require('tc-submission-api-review-types-wrapper')
262-
const reviewTypesApiClient = reviewTypesApi(_.pick(config,
261+
const submissionApi = require('tc-submission-api-wrapper')
262+
const submissionApiClient = submissionApi(_.pick(config,
263263
['AUTH0_URL', 'AUTH0_AUDIENCE', 'TOKEN_CACHE_TIME',
264264
'AUTH0_CLIENT_ID', 'AUTH0_CLIENT_SECRET', 'SUBMISSION_API_URL',
265265
'AUTH0_PROXY_SERVER_URL']))
266266

267-
let reviewTypeId = '8f4e8b6a-0ad2-4ff6-ab19-afeb102ff3b4'
267+
const reviewTypeId = '8f4e8b6a-0ad2-4ff6-ab19-afeb102ff3b4'
268268
const reqBody = {
269269
name: 'Review',
270270
isActive: true
271271
}
272272

273273
// Promise model
274-
reviewTypesApiClient
274+
submissionApiClient
275275
.updateReviewType(reviewTypeId, reqBody)
276276
.then(result => console.log(result.body, result.status))
277277
.catch(err => console.log(err))
278278

279279
// Async / await model
280-
await reviewTypesApiClient.updateReviewType(reviewTypeId, reqBody)
280+
await submissionApiClient.updateReviewType(reviewTypeId, reqBody)
281281
```
282282

283283
### Parameters
@@ -308,26 +308,26 @@ Partially update review type.
308308

309309
### Example
310310
```javascript
311-
const reviewTypesApi = require('tc-submission-api-review-types-wrapper')
312-
const reviewTypesApiClient = reviewTypesApi(_.pick(config,
311+
const submissionApi = require('tc-submission-api-wrapper')
312+
const submissionApiClient = submissionApi(_.pick(config,
313313
['AUTH0_URL', 'AUTH0_AUDIENCE', 'TOKEN_CACHE_TIME',
314314
'AUTH0_CLIENT_ID', 'AUTH0_CLIENT_SECRET', 'SUBMISSION_API_URL',
315315
'AUTH0_PROXY_SERVER_URL']))
316316

317-
let reviewTypeId = '8f4e8b6a-0ad2-4ff6-ab19-afeb102ff3b4'
317+
const reviewTypeId = '8f4e8b6a-0ad2-4ff6-ab19-afeb102ff3b4'
318318
const reqBody = {
319319
name: 'Review',
320320
isActive: true
321321
}
322322

323323
// Promise model
324-
reviewTypesApiClient
324+
submissionApiClient
325325
.patchReviewType(reviewTypeId, reqBody)
326326
.then(result => console.log(result.body, result.status))
327327
.catch(err => console.log(err))
328328

329329
// Async / await model
330-
await reviewTypesApiClient.patchReviewType(reviewTypeId, reqBody)
330+
await submissionApiClient.patchReviewType(reviewTypeId, reqBody)
331331
```
332332

333333
### Parameters
@@ -358,22 +358,22 @@ Delete review type by id.
358358

359359
### Example
360360
```javascript
361-
const reviewTypesApi = require('tc-submission-api-review-types-wrapper')
362-
const reviewTypesApiClient = reviewTypesApi(_.pick(config,
361+
const submissionApi = require('tc-submission-api-wrapper')
362+
const submissionApiClient = submissionApi(_.pick(config,
363363
['AUTH0_URL', 'AUTH0_AUDIENCE', 'TOKEN_CACHE_TIME',
364364
'AUTH0_CLIENT_ID', 'AUTH0_CLIENT_SECRET', 'SUBMISSION_API_URL',
365365
'AUTH0_PROXY_SERVER_URL']))
366366

367-
let reviewTypeId = '8f4e8b6a-0ad2-4ff6-ab19-afeb102ff3b4'
367+
const reviewTypeId = '8f4e8b6a-0ad2-4ff6-ab19-afeb102ff3b4'
368368

369369
// Promise model
370-
reviewTypesApiClient
370+
submissionApiClient
371371
.deleteReviewType(reviewTypeId)
372372
.then(result => console.log(result.status))
373373
.catch(err => console.log(err))
374374

375375
// Async / await model
376-
await reviewTypesApiClient.deleteReviewType(reviewTypeId)
376+
await submissionApiClient.deleteReviewType(reviewTypeId)
377377
```
378378

379379
### Parameters

0 commit comments

Comments
 (0)