loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

JavaScript client: Add authentications support

Browse Source 
Closes #1952
This commit is contained in:
xhh
2016-02-06 16:24:59 +08:00
parent c80df9ee4d
commit d52ebdf684
10 changed files with 357 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

215
samples/client/petstore/javascript/test/ApiClientTest.js
View File

@@ -1,6 +1,7 @@
if (typeof module === 'object' && module.exports) {
var expect = require('expect.js');
var SwaggerPetstore = require('../src/index');
var sinon = require('sinon');
}
var apiClient = SwaggerPetstore.ApiClient.default;
@@ -10,6 +11,10 @@ describe('ApiClient', function() {
it('should have correct default values with the default API client', function() {
expect(apiClient).to.be.ok();
expect(apiClient.basePath).to.be('http://petstore.swagger.io/v2');
expect(apiClient.authentications).to.eql({
'petstore_auth': {type: 'oauth2'},
'api_key': {type: 'apiKey', in: 'header', name: 'api_key'}
});
});
it('should have correct default values with new API client and can customize it', function() {
@@ -99,6 +104,212 @@ describe('ApiClient', function() {
});
});
describe('#applyAuthToRequest', function() {
var req, newClient;
beforeEach(function() {
req = {
auth: function() {},
set: function() {},
query: function() {}
};
sinon.stub(req, 'auth');
sinon.stub(req, 'set');
sinon.stub(req, 'query');
newClient = new SwaggerPetstore.ApiClient();
});
describe('basic', function() {
var authName = 'testBasicAuth';
var authNames = [authName];
var auth;
beforeEach(function() {
newClient.authentications[authName] = {type: 'basic'};
auth = newClient.authentications[authName];
});
it('sets auth header with username and password set', function() {
auth.username = 'user';
auth.password = 'pass';
newClient.applyAuthToRequest(req, authNames);
sinon.assert.calledOnce(req.auth);
// 'dXNlcjpwYXNz' is base64-encoded string of 'user:pass'
sinon.assert.calledWithMatch(req.auth, 'user', 'pass');
sinon.assert.notCalled(req.set);
sinon.assert.notCalled(req.query);
});
it('sets header with only username set', function() {
auth.username = 'user';
newClient.applyAuthToRequest(req, authNames);
sinon.assert.calledOnce(req.auth);
// 'dXNlcjo=' is base64-encoded string of 'user:'
sinon.assert.calledWithMatch(req.auth, 'user', '');
sinon.assert.notCalled(req.set);
sinon.assert.notCalled(req.query);
});
it('sets header with only password set', function() {
auth.password = 'pass';
newClient.applyAuthToRequest(req, authNames);
sinon.assert.calledOnce(req.auth);
// 'OnBhc3M=' is base64-encoded string of ':pass'
sinon.assert.calledWithMatch(req.auth, '', 'pass');
sinon.assert.notCalled(req.set);
sinon.assert.notCalled(req.query);
});
it('does not set header when username and password are not set', function() {
newClient.applyAuthToRequest(req, authNames);
sinon.assert.notCalled(req.auth);
sinon.assert.notCalled(req.set);
sinon.assert.notCalled(req.query);
});
});
describe('apiKey', function() {
var authName = 'testApiKey';
var authNames = [authName];
var auth;
beforeEach(function() {
newClient.authentications[authName] = {type: 'apiKey', name: 'api_key'};
auth = newClient.authentications[authName];
});
it('sets api key in header', function() {
auth.in = 'header';
auth.apiKey = 'my-api-key';
newClient.applyAuthToRequest(req, authNames);
sinon.assert.calledOnce(req.set);
sinon.assert.calledWithMatch(req.set, {'api_key': 'my-api-key'});
sinon.assert.notCalled(req.auth);
sinon.assert.notCalled(req.query);
});
it('sets api key in query', function() {
auth.in = 'query';
auth.apiKey = 'my-api-key';
newClient.applyAuthToRequest(req, authNames);
sinon.assert.calledOnce(req.query);
sinon.assert.calledWithMatch(req.query, {'api_key': 'my-api-key'});
sinon.assert.notCalled(req.auth);
sinon.assert.notCalled(req.set);
});
it('sets api key in header with prefix', function() {
auth.in = 'header';
auth.apiKey = 'my-api-key';
auth.apiKeyPrefix = 'Key';
newClient.applyAuthToRequest(req, authNames);
sinon.assert.calledOnce(req.set);
sinon.assert.calledWithMatch(req.set, {'api_key': 'Key my-api-key'});
sinon.assert.notCalled(req.auth);
sinon.assert.notCalled(req.query);
});
it('works when api key is not set', function() {
auth.in = 'query';
auth.apiKey = null;
newClient.applyAuthToRequest(req, authNames);
sinon.assert.notCalled(req.query);
sinon.assert.notCalled(req.auth);
sinon.assert.notCalled(req.set);
});
});
describe('oauth2', function() {
var authName = 'testOAuth2';
var authNames = [authName];
var auth;
beforeEach(function() {
newClient.authentications[authName] = {type: 'oauth2'};
auth = newClient.authentications[authName];
});
it('sets access token in header', function() {
auth.accessToken = 'my-access-token';
newClient.applyAuthToRequest(req, authNames);
sinon.assert.calledOnce(req.set);
sinon.assert.calledWithMatch(req.set, {'Authorization': 'Bearer my-access-token'});
sinon.assert.notCalled(req.auth);
sinon.assert.notCalled(req.query);
});
it('works when access token is not set', function() {
auth.accessToken = null;
newClient.applyAuthToRequest(req, authNames);
sinon.assert.notCalled(req.query);
sinon.assert.notCalled(req.auth);
sinon.assert.notCalled(req.set);
});
});
describe('apiKey and oauth2', function() {
var apiKeyAuthName = 'testApiKey';
var oauth2Name = 'testOAuth2';
var authNames = [apiKeyAuthName, oauth2Name];
var apiKeyAuth, oauth2;
beforeEach(function() {
newClient.authentications[apiKeyAuthName] = {type: 'apiKey', name: 'api_key', in: 'query'};
newClient.authentications[oauth2Name] = {type: 'oauth2'};
apiKeyAuth = newClient.authentications[apiKeyAuthName];
oauth2 = newClient.authentications[oauth2Name];
});
it('works when setting both api key and access token', function() {
apiKeyAuth.apiKey = 'my-api-key';
oauth2.accessToken = 'my-access-token';
newClient.applyAuthToRequest(req, authNames);
sinon.assert.calledOnce(req.query);
sinon.assert.calledWithMatch(req.query, {'api_key': 'my-api-key'});
sinon.assert.calledOnce(req.set);
sinon.assert.calledWithMatch(req.set, {'Authorization': 'Bearer my-access-token'});
sinon.assert.notCalled(req.auth);
});
it('works when setting only api key', function() {
apiKeyAuth.apiKey = 'my-api-key';
oauth2.accessToken = null;
newClient.applyAuthToRequest(req, authNames);
sinon.assert.calledOnce(req.query);
sinon.assert.calledWithMatch(req.query, {'api_key': 'my-api-key'});
sinon.assert.notCalled(req.set);
sinon.assert.notCalled(req.auth);
});
it('works when neither api key nor access token is set', function() {
apiKeyAuth.apiKey = null;
oauth2.accessToken = null;
newClient.applyAuthToRequest(req, authNames);
sinon.assert.notCalled(req.query);
sinon.assert.notCalled(req.auth);
sinon.assert.notCalled(req.set);
});
});
describe('unknown type', function() {
var authName = 'unknown';
var authNames = [authName];
beforeEach(function() {
newClient.authentications[authName] = {type: 'UNKNOWN'};
});
it('throws error for unknown auth type', function() {
expect(function() {
newClient.applyAuthToRequest(req, authNames);
}).to.throwError();
sinon.assert.notCalled(req.set);
sinon.assert.notCalled(req.auth);
sinon.assert.notCalled(req.query);
});
});
});
describe('#defaultHeaders', function() {
it('should initialize default headers to be an empty object', function() {
expect(apiClient.defaultHeaders).to.eql({});
@@ -143,10 +354,12 @@ function makeDumbRequest(apiClient, opts) {
var headerParams = opts.headerParams || {};
var formParams = opts.formParams || {};
var bodyParam = opts.bodyParam;
var authNames = [];
var contentTypes = opts.contentTypes || [];
var accepts = opts.accepts || [];
var callback = opts.callback;
return apiClient.callApi(path, httpMethod, pathParams, queryParams,
headerParams, formParams, bodyParam, contentTypes, accepts, callback
headerParams, formParams, bodyParam, authNames, contentTypes, accepts,
callback
);
}