Skip to content

Add support for query parameters for POST, PATCH, and PUT requests #375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add support for query parameters for POST, PATCH, and PUT requests #375

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
186d76a
Add tests to check if requests are using query parameters properly
ajuanjojjj Jul 5, 2024
2f1fb94
Pass queryParams to POST, PUT, and PATCH requests
ajuanjojjj Jul 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions lib/RestClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ export class RestClient {
resources: any,
options?: IRequestOptions): Promise<IRestResponse<T>> {

let url: string = util.getUrl(resource, this._baseUrl);
let url: string = util.getUrl(resource, this._baseUrl, (options || {}).queryParameters);
let headers: ifm.IHeaders = this._headersFromOptions(options, true);

let data: string = JSON.stringify(resources, null, 2);
Expand All @@ -123,7 +123,7 @@ export class RestClient {
resources: any,
options?: IRequestOptions): Promise<IRestResponse<T>> {

let url: string = util.getUrl(resource, this._baseUrl);
let url: string = util.getUrl(resource, this._baseUrl, (options || {}).queryParameters);
let headers: ifm.IHeaders = this._headersFromOptions(options, true);

let data: string = JSON.stringify(resources, null, 2);
Expand All @@ -142,7 +142,7 @@ export class RestClient {
resources: any,
options?: IRequestOptions): Promise<IRestResponse<T>> {

let url: string = util.getUrl(resource, this._baseUrl);
let url: string = util.getUrl(resource, this._baseUrl, (options || {}).queryParameters);
let headers: ifm.IHeaders = this._headersFromOptions(options, true);

let data: string = JSON.stringify(resources, null, 2);
Expand Down
96 changes: 94 additions & 2 deletions test/tests/resttests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,36 @@ describe('Rest Tests', function () {
assert(restRes.result && restRes.result.json.name === 'foo');
});

it('creates a resource passing Query Parameters', async () => {
let res: any = { name: 'foo' };
let restRes: restm.IRestResponse<HttpBinData> = await _rest.create<HttpBinData>('https://httpbin.org/post', res, _options);
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result.url === 'https://httpbin.org/post?id=1&type=compact');
assert(restRes.result && restRes.result.json.name === 'foo');

Object.keys(_options.queryParameters.params).forEach(key => {
const actual = restRes.result.args[key];
const expected = _options.queryParameters.params[key];

assert(expected == actual);
})
});

it('creates a resource with baseUrl passing Query Parameters', async () => {
let res: any = { name: 'foo' };
let restRes: restm.IRestResponse<HttpBinData> = await _restBin.create<HttpBinData>('post', res, _options);
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'https://httpbin.org/post?id=1&type=compact');
assert(restRes.result && restRes.result.json.name === 'foo');

Object.keys(_options.queryParameters.params).forEach(key => {
const actual = restRes.result.args[key];
const expected = _options.queryParameters.params[key];

assert(expected == actual);
})
});

it('replaces a resource', async() => {
this.timeout(3000);

Expand All @@ -119,6 +149,40 @@ describe('Rest Tests', function () {
assert(restRes.result && restRes.result.json.name === 'foo');
});

it('puts a resource passing Query Parameters', async () => {
this.timeout(3000);

let res: any = { name: 'foo' };
let restRes: restm.IRestResponse<HttpBinData> = await _rest.replace<HttpBinData>('https://httpbin.org/put', res, _options);
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'https://httpbin.org/put?id=1&type=compact');
assert(restRes.result && restRes.result.json.name === 'foo');

Object.keys(_options.queryParameters.params).forEach(key => {
const actual = restRes.result.args[key];
const expected = _options.queryParameters.params[key];

assert(expected == actual);
})
});

it('puts a resource with baseUrl passing Query Parameters', async () => {
this.timeout(3000);

let res: any = { name: 'foo' };
let restRes: restm.IRestResponse<HttpBinData> = await _restBin.replace<HttpBinData>('put', res, _options);
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'https://httpbin.org/put?id=1&type=compact');
assert(restRes.result && restRes.result.json.name === 'foo');

Object.keys(_options.queryParameters.params).forEach(key => {
const actual = restRes.result.args[key];
const expected = _options.queryParameters.params[key];

assert(expected == actual);
})
});

it('updates a resource', async() => {
let res: any = { name: 'foo' };
let restRes: restm.IRestResponse<HttpBinData> = await _rest.update<HttpBinData>('https://httpbin.org/patch', res);
Expand All @@ -135,6 +199,36 @@ describe('Rest Tests', function () {
assert(restRes.result && restRes.result.json.name === 'foo');
});

it('updates a resource passing Query Parameters', async () => {
let res: any = { name: 'foo' };
let restRes: restm.IRestResponse<HttpBinData> = await _rest.update<HttpBinData>('https://httpbin.org/patch', res, _options);
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'https://httpbin.org/patch?id=1&type=compact');
assert(restRes.result && restRes.result.json.name === 'foo');

Object.keys(_options.queryParameters.params).forEach(key => {
const actual = restRes.result.args[key];
const expected = _options.queryParameters.params[key];

assert(expected == actual);
})
});

it('updates a resource with baseUrl passing Query Parameters', async () => {
let res: any = { name: 'foo' };
let restRes: restm.IRestResponse<HttpBinData> = await _restBin.update<HttpBinData>('patch', res, _options);
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'https://httpbin.org/patch?id=1&type=compact');
assert(restRes.result && restRes.result.json.name === 'foo');

Object.keys(_options.queryParameters.params).forEach(key => {
const actual = restRes.result.args[key];
const expected = _options.queryParameters.params[key];

assert(expected == actual);
})
});

it('deletes a resource', async() => {
let restRes: restm.IRestResponse<HttpBinData> = await _rest.del<HttpBinData>('https://httpbin.org/delete');
assert(restRes.statusCode == 200, "statusCode should be 200");
Expand Down Expand Up @@ -221,7 +315,6 @@ describe('Rest Tests', function () {
catch(err) {
assert(err['statusCode'] == 401, "statusCode should be 401");
assert(err.message && err.message.length > 0, "should have error message");
assert(err['responseHeaders'], "err must contain responseHeaders");
}
});

Expand All @@ -238,7 +331,6 @@ describe('Rest Tests', function () {
catch(err) {
assert(err['statusCode'] == 500, "statusCode should be 500");
assert(err.message && err.message.length > 0, "should have error message");
assert(err['responseHeaders'], "err must contain responseHeaders");
}
});

Expand Down