js-openstack-lib/src/util/abstract_service.js

84 lines
2.3 KiB
JavaScript

/*
* Copyright (c) 2016 Hewlett Packard Enterprise Development L.P.
*
* 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.
*/
import Http from './http';
export default class AbstractService {
/**
* This class provides an abstract implementation of our services, which includes logic common to
* all of our services.
*
* @param {string} endpointUrl The endpoint URL.
* @param {Array} supportedVersions The list of all supported versions.
*/
constructor (endpointUrl, supportedVersions) {
this._endpointUrl = endpointUrl;
this._supportedVersions = supportedVersions;
}
/**
* Our HTTP service instance.
*
* @returns {Http} Our HTTP service instance.
*/
get http () {
if (!this._http) {
this._http = new Http();
}
return this._http;
}
/**
* List of all supported versions.
*
* @returns {Array} The list of all supported versions, or empty array.
*/
get supportedVersions () {
return this._supportedVersions || [];
}
/**
* Retrieve all the API versions available.
*
* @returns {Promise.<T>} A promise that will resolve with the list of API versions.
*/
versions () {
return this.http
.httpGet(this._endpointUrl)
.then((response) => response.json())
.then((body) => body.versions);
}
/**
* Retrieve the API version declaration that is currently in use by this instance.
*
* @returns {Promise.<T>} A promise that will resolve with the specific API version.
*/
version () {
return this
.versions()
.then((versions) => {
for (let version of versions) {
if (this.supportedVersions.indexOf(version.id) > -1) {
return version;
}
}
throw new Error("No supported API version available.");
});
}
}