e5a2f5c5cd
Implement REST-related methods on Gerrit (get, post, etc).
REST-related methods on plugin now take plugin URL space into account,
to match GWT UI plugin JS API.
Example:
``` js
Gerrit.install(plugin => {
// deprecated:
plugin.get('/foo', json => {
// work work
});
Gerrit.post('/bar', {bar: 'space'}, json => {
// post succeeds
});
// recommended:
const pluginRestApi = plugin.restApi(plugin.url());
plugin.get('/foo').then(json => {
// work work
});
plugin.restApi().post('/bar', {bar: 'space'}).then(json => {
// post succeeds
});
});
```
Change-Id: I6f537507d76bddec1cac9159cebe1b720ab5caf8
105 lines
3.4 KiB
JavaScript
105 lines
3.4 KiB
JavaScript
// Copyright (C) 2017 The Android Open Source Project
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
(function(window) {
|
|
'use strict';
|
|
|
|
function GrPluginRestApi(opt_prefix) {
|
|
this.opt_prefix = opt_prefix || '';
|
|
this._restApi = document.createElement('gr-rest-api-interface');
|
|
}
|
|
|
|
GrPluginRestApi.prototype.getLoggedIn = function() {
|
|
return this._restApi.getLoggedIn();
|
|
};
|
|
|
|
/**
|
|
* Fetch and return native browser REST API Response.
|
|
* @param {string} method HTTP Method (GET, POST, etc)
|
|
* @param {string} url URL without base path or plugin prefix
|
|
* @param {Object=} payload Respected for POST and PUT only.
|
|
* @return {!Promise}
|
|
*/
|
|
GrPluginRestApi.prototype.fetch = function(method, url, opt_payload) {
|
|
return this._restApi.send(method, this.opt_prefix + url, opt_payload);
|
|
};
|
|
|
|
/**
|
|
* Fetch and parse REST API response, if request succeeds.
|
|
* @param {string} method HTTP Method (GET, POST, etc)
|
|
* @param {string} url URL without base path or plugin prefix
|
|
* @param {Object=} payload Respected for POST and PUT only.
|
|
* @return {!Promise} resolves on success, rejects on error.
|
|
*/
|
|
GrPluginRestApi.prototype.send = function(method, url, opt_payload) {
|
|
return this.fetch(method, url, opt_payload).then(response => {
|
|
if (response.status < 200 || response.status >= 300) {
|
|
return response.text().then(text => {
|
|
if (text) {
|
|
return Promise.reject(text);
|
|
} else {
|
|
return Promise.reject(response.status);
|
|
}
|
|
});
|
|
} else {
|
|
return this._restApi.getResponseObject(response);
|
|
}
|
|
});
|
|
};
|
|
|
|
/**
|
|
* @param {string} url URL without base path or plugin prefix
|
|
* @return {!Promise} resolves on success, rejects on error.
|
|
*/
|
|
GrPluginRestApi.prototype.get = function(url) {
|
|
return this.send('GET', url);
|
|
};
|
|
|
|
/**
|
|
* @param {string} url URL without base path or plugin prefix
|
|
* @return {!Promise} resolves on success, rejects on error.
|
|
*/
|
|
GrPluginRestApi.prototype.post = function(url, opt_payload) {
|
|
return this.send('POST', url, opt_payload);
|
|
};
|
|
|
|
/**
|
|
* @param {string} url URL without base path or plugin prefix
|
|
* @return {!Promise} resolves on success, rejects on error.
|
|
*/
|
|
GrPluginRestApi.prototype.put = function(url, opt_payload) {
|
|
return this.send('PUT', url, opt_payload);
|
|
};
|
|
|
|
/**
|
|
* @param {string} url URL without base path or plugin prefix
|
|
* @return {!Promise} resolves on 204, rejects on error.
|
|
*/
|
|
GrPluginRestApi.prototype.delete = function(url) {
|
|
return this.fetch('DELETE', url).then(response => {
|
|
if (response.status !== 204) {
|
|
return response.text().then(text => {
|
|
if (text) {
|
|
return Promise.reject(text);
|
|
} else {
|
|
return Promise.reject(response.status);
|
|
}
|
|
});
|
|
}
|
|
return response;
|
|
});
|
|
};
|
|
|
|
window.GrPluginRestApi = GrPluginRestApi;
|
|
})(window);
|