node-ovh-objectstorage
Version:
Simple library to use OVH Public Cloud Object Storage.
415 lines (344 loc) • 19.7 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
AccountMeta.js - Documentation
</title>
<link href="https://www.braintreepayments.com/images/favicon-ccda0b14.png" rel="icon" type="image/png">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.7.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.0/jquery.min.js"></script>
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
<link type="text/css" rel="stylesheet" href="styles/collapse.css">
<!-- start Mixpanel -->
<script type="text/javascript">(function(e,a){if(!a.__SV){var b=window;try{var c,l,i,j=b.location,g=j.hash;c=function(a,b){return(l=a.match(RegExp(b+"=([^&]*)")))?l[1]:null};g&&c(g,"state")&&(i=JSON.parse(decodeURIComponent(c(g,"state"))),"mpeditor"===i.action&&(b.sessionStorage.setItem("_mpcehash",g),history.replaceState(i.desiredHash||"",e.title,j.pathname+j.search)))}catch(m){}var k,h;window.mixpanel=a;a._i=[];a.init=function(b,c,f){function e(b,a){var c=a.split(".");2==c.length&&(b=b[c[0]],a=c[1]);b[a]=function(){b.push([a].concat(Array.prototype.slice.call(arguments,
0)))}}var d=a;"undefined"!==typeof f?d=a[f]=[]:f="mixpanel";d.people=d.people||[];d.toString=function(b){var a="mixpanel";"mixpanel"!==f&&(a+="."+f);b||(a+=" (stub)");return a};d.people.toString=function(){return d.toString(1)+".people (stub)"};k="disable time_event track track_pageview track_links track_forms register register_once alias unregister identify name_tag set_config reset people.set people.set_once people.increment people.append people.union people.track_charge people.clear_charges people.delete_user".split(" ");
for(h=0;h<k.length;h++)e(d,k[h]);a._i.push([b,c,f])};a.__SV=1.2;b=e.createElement("script");b.type="text/javascript";b.async=!0;b.src="undefined"!==typeof MIXPANEL_CUSTOM_LIB_URL?MIXPANEL_CUSTOM_LIB_URL:"file:"===e.location.protocol&&"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js".match(/^\/\//)?"https://cdn.mxpnl.com/libs/mixpanel-2-latest.min.js":"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js";c=e.getElementsByTagName("script")[0];c.parentNode.insertBefore(b,c)}})(document,window.mixpanel||[]);
mixpanel.init("1919205b2da72e4da3b9b6639b444d59");</script>
<!-- end Mixpanel -->
</head>
<body>
<svg style="display: none;">
<defs>
<symbol id="linkIcon" fill="#706d77" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M0 0h24v24H0z" fill="none"/>
<path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"/>
</symbol>
</defs>
</svg>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<div class="top-nav-wrapper">
<ul>
<li >
<a href="index.html">
<svg fill="#6D6D6D" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z"/>
<path d="M0 0h24v24H0z" fill="none"/>
</svg>
</a>
</li>
</ul>
</div>
<nav>
<h3 class="reference-title">
OVH Object Storage
</h3>
<h3>Classes</h3><ul><li id="Account-nav"><a href="Account.html">Account</a><ul class='methods'><li data-type="method" id="Account-all-nav"><a href="Account.html#all">all</a></li><li data-type="method" id="Account-containers-nav"><a href="Account.html#containers">containers</a></li><li data-type="method" id="Account-details-nav"><a href="Account.html#details">details</a></li><li data-type="method" id="Account-generateKey-nav"><a href="Account.html#generateKey">generateKey</a></li><li data-type="method" id="Account-metas-nav"><a href="Account.html#metas">metas</a></li></ul></li><li id="AccountMeta-nav"><a href="AccountMeta.html">AccountMeta</a><ul class='methods'><li data-type="method" id="AccountMeta-all-nav"><a href="AccountMeta.html#all">all</a></li><li data-type="method" id="AccountMeta-create-nav"><a href="AccountMeta.html#create">create</a></li><li data-type="method" id="AccountMeta-create_with_result-nav"><a href="AccountMeta.html#create_with_result">create_with_result</a></li><li data-type="method" id="AccountMeta-delete-nav"><a href="AccountMeta.html#delete">delete</a></li><li data-type="method" id="AccountMeta-delete_with_result-nav"><a href="AccountMeta.html#delete_with_result">delete_with_result</a></li><li data-type="method" id="AccountMeta-get-nav"><a href="AccountMeta.html#get">get</a></li><li data-type="method" id="AccountMeta-has-nav"><a href="AccountMeta.html#has">has</a></li><li data-type="method" id="AccountMeta-update-nav"><a href="AccountMeta.html#update">update</a></li><li data-type="method" id="AccountMeta-update_with_result-nav"><a href="AccountMeta.html#update_with_result">update_with_result</a></li></ul></li><li id="Containers-nav"><a href="Containers.html">Containers</a><ul class='methods'><li data-type="method" id="Containers-create-nav"><a href="Containers.html#create">create</a></li><li data-type="method" id="Containers-create_with_result-nav"><a href="Containers.html#create_with_result">create_with_result</a></li><li data-type="method" id="Containers-delete-nav"><a href="Containers.html#delete">delete</a></li><li data-type="method" id="Containers-delete_objects-nav"><a href="Containers.html#delete_objects">delete_objects</a></li><li data-type="method" id="Containers-delete_objects_with_result-nav"><a href="Containers.html#delete_objects_with_result">delete_objects_with_result</a></li><li data-type="method" id="Containers-delete_with_result-nav"><a href="Containers.html#delete_with_result">delete_with_result</a></li><li data-type="method" id="Containers-exist-nav"><a href="Containers.html#exist">exist</a></li><li data-type="method" id="Containers-info-nav"><a href="Containers.html#info">info</a></li><li data-type="method" id="Containers-list-nav"><a href="Containers.html#list">list</a></li><li data-type="method" id="Containers-metas-nav"><a href="Containers.html#metas">metas</a></li></ul></li><li id="ContainersMeta-nav"><a href="ContainersMeta.html">ContainersMeta</a><ul class='methods'><li data-type="method" id="ContainersMeta-all-nav"><a href="ContainersMeta.html#all">all</a></li><li data-type="method" id="ContainersMeta-create-nav"><a href="ContainersMeta.html#create">create</a></li><li data-type="method" id="ContainersMeta-create_with_result-nav"><a href="ContainersMeta.html#create_with_result">create_with_result</a></li><li data-type="method" id="ContainersMeta-delete-nav"><a href="ContainersMeta.html#delete">delete</a></li><li data-type="method" id="ContainersMeta-delete_with_result-nav"><a href="ContainersMeta.html#delete_with_result">delete_with_result</a></li><li data-type="method" id="ContainersMeta-get-nav"><a href="ContainersMeta.html#get">get</a></li><li data-type="method" id="ContainersMeta-has-nav"><a href="ContainersMeta.html#has">has</a></li><li data-type="method" id="ContainersMeta-update-nav"><a href="ContainersMeta.html#update">update</a></li><li data-type="method" id="ContainersMeta-update_with_result-nav"><a href="ContainersMeta.html#update_with_result">update_with_result</a></li></ul></li><li id="Objects-nav"><a href="Objects.html">Objects</a><ul class='methods'><li data-type="method" id="Objects-copy-nav"><a href="Objects.html#copy">copy</a></li><li data-type="method" id="Objects-copy_with_result-nav"><a href="Objects.html#copy_with_result">copy_with_result</a></li><li data-type="method" id="Objects-delete-nav"><a href="Objects.html#delete">delete</a></li><li data-type="method" id="Objects-delete_with_result-nav"><a href="Objects.html#delete_with_result">delete_with_result</a></li><li data-type="method" id="Objects-deletes-nav"><a href="Objects.html#deletes">deletes</a></li><li data-type="method" id="Objects-deletes_with_result-nav"><a href="Objects.html#deletes_with_result">deletes_with_result</a></li><li data-type="method" id="Objects-download-nav"><a href="Objects.html#download">download</a></li><li data-type="method" id="Objects-exist-nav"><a href="Objects.html#exist">exist</a></li><li data-type="method" id="Objects-expire_after-nav"><a href="Objects.html#expire_after">expire_after</a></li><li data-type="method" id="Objects-expire_after_with_result-nav"><a href="Objects.html#expire_after_with_result">expire_after_with_result</a></li><li data-type="method" id="Objects-expire_at-nav"><a href="Objects.html#expire_at">expire_at</a></li><li data-type="method" id="Objects-expire_at_with_result-nav"><a href="Objects.html#expire_at_with_result">expire_at_with_result</a></li><li data-type="method" id="Objects-get-nav"><a href="Objects.html#get">get</a></li><li data-type="method" id="Objects-getTempLink-nav"><a href="Objects.html#getTempLink">getTempLink</a></li><li data-type="method" id="Objects-info-nav"><a href="Objects.html#info">info</a></li><li data-type="method" id="Objects-metas-nav"><a href="Objects.html#metas">metas</a></li><li data-type="method" id="Objects-save-nav"><a href="Objects.html#save">save</a></li><li data-type="method" id="Objects-save_with_result-nav"><a href="Objects.html#save_with_result">save_with_result</a></li><li data-type="method" id="Objects-saveData-nav"><a href="Objects.html#saveData">saveData</a></li><li data-type="method" id="Objects-saveFile-nav"><a href="Objects.html#saveFile">saveFile</a></li><li data-type="method" id="Objects-set-nav"><a href="Objects.html#set">set</a></li><li data-type="method" id="Objects-set_with_result-nav"><a href="Objects.html#set_with_result">set_with_result</a></li></ul></li><li id="ObjectsMeta-nav"><a href="ObjectsMeta.html">ObjectsMeta</a><ul class='methods'><li data-type="method" id="ObjectsMeta-all-nav"><a href="ObjectsMeta.html#all">all</a></li><li data-type="method" id="ObjectsMeta-create-nav"><a href="ObjectsMeta.html#create">create</a></li><li data-type="method" id="ObjectsMeta-create_with_result-nav"><a href="ObjectsMeta.html#create_with_result">create_with_result</a></li><li data-type="method" id="ObjectsMeta-delete-nav"><a href="ObjectsMeta.html#delete">delete</a></li><li data-type="method" id="ObjectsMeta-delete_with_result-nav"><a href="ObjectsMeta.html#delete_with_result">delete_with_result</a></li><li data-type="method" id="ObjectsMeta-get-nav"><a href="ObjectsMeta.html#get">get</a></li><li data-type="method" id="ObjectsMeta-has-nav"><a href="ObjectsMeta.html#has">has</a></li><li data-type="method" id="ObjectsMeta-update-nav"><a href="ObjectsMeta.html#update">update</a></li><li data-type="method" id="ObjectsMeta-update_with_result-nav"><a href="ObjectsMeta.html#update_with_result">update_with_result</a></li></ul></li><li id="OVHStorage-nav"><a href="OVHStorage.html">OVHStorage</a><ul class='methods'><li data-type="method" id="OVHStorage-account-nav"><a href="OVHStorage.html#account">account</a></li><li data-type="method" id="OVHStorage-connection-nav"><a href="OVHStorage.html#connection">connection</a></li><li data-type="method" id="OVHStorage-containers-nav"><a href="OVHStorage.html#containers">containers</a></li><li data-type="method" id="OVHStorage-getConnectionDetails-nav"><a href="OVHStorage.html#getConnectionDetails">getConnectionDetails</a></li><li data-type="method" id="OVHStorage-objects-nav"><a href="OVHStorage.html#objects">objects</a></li></ul></li></ul><h3 id="global-nav"><a href="global.html">Global</a></h3>
</nav>
<div id="main">
<h1 class="page-title">
AccountMeta.js
</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>const _ = require("../tools/lodash");
const request = require('../tools/request');
/**
* Define and access to all metas of account
*
* __Available methods :__ *create()*, *create_with_result()*, *update()*, *update_with_result()*, *delete()*, *delete_with_result()*, *all()*, *has()*, *get()*
*/
class AccountMeta {
/**
* Account Meta constructor
*
* @param {OVHStorage} context OVHObjectStorage context
*/
constructor(context) {
this.context = context;
}
/**
* Create a new account meta
*
* @param {String} key Name of meta
* @param {String} value Value of meta
*
* @async
* @return {Promise<Object>}
*/
create(key, value) {
return new Promise((resolve, reject) => {
try {
// checks
if (_.isUndefined(key)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Key parameter is expected.");
if (!_.isString(key)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Key parameter is not a string.");
if (_.includes(key, "/") || _.includes(key, ' ')) // noinspection ExceptionCaughtLocallyJS
throw new Error("Key parameter contains special chars.");
if (_.isUndefined(value)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Value parameter is expected.");
if (!_.isString(value)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Value parameter is not a string.");
// header
let header = {};
header["X-Account-Meta-" + _.toSlug(_.replace(_.toLower(key), /_/g, '-'))] = value;
// call
request({
method: 'POST',
uri: encodeURI(this.context.endpoint.url),
headers: Object.assign(
{
"X-Auth-Token": this.context.token,
"Accept": "application/json"
},
header)
}, (err, res, body) => {
err = err || request.checkIfResponseIsError(res);
if (err) // noinspection ExceptionCaughtLocallyJS
throw new Error(err);
return resolve(res.headers);
});
} catch (e) {
return reject(e);
}
});
}
/**
* Create a new account meta and return boolean as result
*
* @param {String} key Name of meta
* @param {String} value Value of meta
*
* @async
* @return {Promise<Boolean>}
*/
async create_with_result(key, value) {
try {
await this.context.account().metas().create(key, value);
return true;
} catch (e) {
return false;
}
}
/**
* Update existing account meta
*
* @param {String} key Name of meta
* @param {String} value Value of meta
*
* @async
* @return {Promise<Object>}
*/
update(key, value) {
return this.context.account().metas().create(key, value);
}
/**
* Update existing account meta and return boolean as result
*
* @param {String} key Name of meta
* @param {String} value Value of meta
*
* @async
* @return {Promise<Boolean>}
*/
async update_with_result(key, value) {
try {
await this.context.account().metas().update(key, value);
return true;
} catch (e) {
return false;
}
}
/**
* Delete account meta
*
* @param {String} key Name of meta
*
* @async
* @return {Promise<Object>}
*/
delete(key) {
return new Promise((resolve, reject) => {
try {
// checks
if (_.isUndefined(key)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Key parameter is expected.");
if (!_.isString(key)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Key parameter is not a string.");
if (_.includes(key, "/") || _.includes(key, ' ')) // noinspection ExceptionCaughtLocallyJS
throw new Error("Key parameter contains special chars.");
// headers
let header = {};
header["X-Remove-Account-Meta-" + _.toSlug(_.toLower(key))] = "x";
// call
request({
method: 'POST',
uri: encodeURI(this.context.endpoint.url),
headers: Object.assign(
{
"X-Auth-Token": this.context.token,
"Accept": "application/json"
},
header)
}, (err, res, body) => {
err = err || request.checkIfResponseIsError(res);
if (err) // noinspection ExceptionCaughtLocallyJS
throw new Error(err);
return resolve(res.headers);
});
} catch (e) {
return reject(e);
}
});
}
/**
* Delete account meta and return boolean as result
*
* @param {String} key Name of meta
*
* @async
* @return {Promise<Boolean>}
*/
async delete_with_result(key) {
try {
await this.context.account().metas().delete(key);
return true;
} catch (e) {
return false;
}
}
/**
* Get account meta
*
* @param {String} key Name of meta
*
* @async
* @return {Promise<string>}
*/
get(key) {
return new Promise((resolve, reject) => {
try {
// checks
if (_.isUndefined(key)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Key parameter is expected.");
if (!_.isString(key)) // noinspection ExceptionCaughtLocallyJS
throw new Error("Key parameter is not a string.");
if (_.includes(key, "/") || _.includes(key, ' ')) // noinspection ExceptionCaughtLocallyJS
throw new Error("Key parameter contains special chars.");
// call
request({
method: 'HEAD',
uri: encodeURI(this.context.endpoint.url),
headers: {
"X-Auth-Token": this.context.token,
"Accept": "application/json"
}
}, (err, res, body) => {
err = err || request.checkIfResponseIsError(res);
if (err) // noinspection ExceptionCaughtLocallyJS
throw new Error(err);
let value = _.filter(res.headers, (value, header) => {
return (_.toLower(header) === _.toLower("X-Account-Meta-" + _.toSlug(_.replace(_.toLower(key), /_/g, '-'))));
})
value = ((_.count(value) <= 0) ? null : value[0]);
return resolve(value);
});
} catch (e) {
return reject(e);
}
});
}
/**
* Has account meta
*
* @param {String} key Name of meta
*
* @async
* @return {Promise<Boolean>}
*/
has(key) {
return new Promise(async (resolve, reject) => {
try {
resolve(!_.isNull(await this.context.account().metas().get(key)));
} catch (e) {
return reject(e);
}
});
}
/**
* Get all account metas
*
* @async
* @return {Promise<array>}
*/
all() {
return new Promise((resolve, reject) => {
try {
// call
request({
method: 'HEAD',
uri: encodeURI(this.context.endpoint.url),
headers: {
"X-Auth-Token": this.context.token,
"Accept": "application/json"
}
}, (err, res, body) => {
err = err || request.checkIfResponseIsError(res);
if (err) // noinspection ExceptionCaughtLocallyJS
throw new Error(err);
let values = _.map(res.headers, (value, header) => {
if (_.includes(_.toLower(header), _.toLower("X-Account-Meta-"))) {
let a = {}
a[_.replace(_.toLower(header), _.toLower("X-Account-Meta-"), '')] = value;
return a;
}
});
values = _.filter(values, (v) => {
return (!_.isUndefined(v));
})
values = (() => {
let as = {}
_.map(values, (v) => {
return _.merge(as, v)
});
return as;
})();
return resolve(values);
});
} catch (e) {
return reject(e);
}
});
}
}
module.exports = AccountMeta;
</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a>
</footer>
<script src="scripts/linenumber.js"></script>
<script src="scripts/pagelocation.js"></script>
</body>
</html>