You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
158 lines
4.6 KiB
158 lines
4.6 KiB
const util = require('util');
|
|
|
|
module.exports = function(client) {
|
|
/* section: comment
|
|
*comment: create a new comment
|
|
*params:
|
|
* message: the message of the comment
|
|
* properties: |
|
|
* optional, an object containing any of the following
|
|
* * handle: the handle to associate the comment with (e.g. "user@domain.com")
|
|
* * related_event_id: the event to associate the comment with
|
|
* callback: function(err, res)
|
|
*example: |
|
|
* ```javascript
|
|
* var dogapi = require("dogapi");
|
|
* var options = {
|
|
* api_key: "api_key",
|
|
* app_key: "app_key"
|
|
* };
|
|
* dogapi.initialize(options);
|
|
* dogapi.comment.create("a comment message", function(err, res){
|
|
* console.dir(res);
|
|
* });
|
|
* ```
|
|
*/
|
|
function create(message, properties, callback) {
|
|
if (arguments.length < 3 && typeof arguments[1] === 'function') {
|
|
callback = properties;
|
|
properties = {};
|
|
}
|
|
|
|
const params = {
|
|
body: {
|
|
message
|
|
}
|
|
};
|
|
|
|
if (typeof properties === 'object') {
|
|
if (properties.handle) {
|
|
params.body.handle = properties.handle;
|
|
}
|
|
if (properties.related_event_id) {
|
|
params.body.related_event_id = properties.related_event_id;
|
|
}
|
|
}
|
|
|
|
client.request('POST', '/comments', params, callback);
|
|
}
|
|
|
|
/* section: comment
|
|
*comment: update an existing comment
|
|
*params:
|
|
* commentId: the id of the comment to update
|
|
* message: the message of the comment
|
|
* handle: optional, the handle to associate the comment with (e.g. "user@domain.com")
|
|
* callback: function(err, res)
|
|
*example: |
|
|
* ```javascript
|
|
* var dogapi = require("dogapi");
|
|
* var options = {
|
|
* api_key: "api_key",
|
|
* app_key: "app_key"
|
|
* };
|
|
* dogapi.initialize(options);
|
|
* dogapi.comment.update(1234, "new message", function(err, res){
|
|
* console.dir(res);
|
|
* });
|
|
* ```
|
|
*/
|
|
function update(commentId, message, handle, callback) {
|
|
if (arguments.length < 4 && typeof arguments[2] === 'function') {
|
|
callback = handle;
|
|
handle = undefined;
|
|
}
|
|
|
|
const params = {
|
|
body: {
|
|
message,
|
|
handle: handle || undefined
|
|
}
|
|
};
|
|
|
|
client.request('PUT', util.format('/comments/%s', commentId), params, callback);
|
|
}
|
|
|
|
/* section: comment
|
|
*comment: remove a comment
|
|
*params:
|
|
* commentId: the id of the comment to remove
|
|
* callback: function(err, res)
|
|
*example: |
|
|
* ```javascript
|
|
* var dogapi = require("dogapi");
|
|
* var options = {
|
|
* api_key: "api_key",
|
|
* app_key: "app_key"
|
|
* };
|
|
* dogapi.initialize(options);
|
|
* dogapi.comment.remove(1234, function(err, res){
|
|
* console.dir(res);
|
|
* });
|
|
* ```
|
|
*/
|
|
function remove(commentId, callback) {
|
|
client.request('DELETE', util.format('/comments/%s', commentId), callback);
|
|
}
|
|
|
|
return {
|
|
create,
|
|
update,
|
|
remove,
|
|
getUsage() {
|
|
return [
|
|
' dogapi comment create <message> [--handle <handle>] [--event <event-id>]',
|
|
' dogapi comment update <comment-id> <message> [--handle <handle>]',
|
|
' dogapi comment remove <comment-id>'
|
|
];
|
|
},
|
|
getHelp() {
|
|
return [
|
|
'Comment:',
|
|
' Subcommands:',
|
|
' create <message> add a new comment',
|
|
' update <comment-id> <message> update an existing comment',
|
|
' remove <comment-id> delete a comment',
|
|
'',
|
|
' Options:',
|
|
' --handle <handle> the handle to associate with the comment (e.g. "user@domain.com")',
|
|
' --event <event-id> related event id to associate the comment with'
|
|
];
|
|
},
|
|
handleCli(subcommand, args, callback) {
|
|
if (subcommand === 'create') {
|
|
const message = args._[4];
|
|
const properties = {};
|
|
if (args.handle) {
|
|
properties.handle = args.handle;
|
|
}
|
|
if (args.event) {
|
|
properties.related_event_id = parseInt(args.event);
|
|
}
|
|
create(message, properties, callback);
|
|
} else if (subcommand === 'update') {
|
|
const commentId = args._[4];
|
|
const message = args._[5];
|
|
update(commentId, message, args.handle, callback);
|
|
} else if (subcommand === 'remove') {
|
|
const commentId = args._[4];
|
|
remove(commentId, callback);
|
|
} else {
|
|
return callback(
|
|
'unknown subcommand or arguments try `dogapi comment --help` for help',
|
|
false
|
|
);
|
|
}
|
|
}
|
|
};
|
|
};
|