114 lines
4.6 KiB
JavaScript
114 lines
4.6 KiB
JavaScript
/**
|
|
* mixin markdown
|
|
*
|
|
* Copyright 2012 Cloud9 IDE, Inc.
|
|
*
|
|
* This product includes software developed by
|
|
* Cloud9 IDE, Inc (http://c9.io).
|
|
*
|
|
* Author: Mike de Boer <info@mikedeboer.nl>
|
|
**/
|
|
|
|
"use strict";
|
|
|
|
var error = require("./../../error");
|
|
var Util = require("./../../util");
|
|
|
|
var markdown = module.exports = {
|
|
markdown: {}
|
|
};
|
|
|
|
(function() {
|
|
/** section: github
|
|
* markdown#render(msg, callback) -> null
|
|
* - msg (Object): Object that contains the parameters and their values to be sent to the server.
|
|
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
|
|
*
|
|
* ##### Params on the `msg` object:
|
|
*
|
|
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
|
|
* - text (String): Required. The Markdown text to render
|
|
* - mode (String): Optional. The rendering mode, `markdown` to render a document as plain Markdown, just like README files are rendered. `gfm` to render a document as user-content, e.g. like user comments or issues are rendered. In GFM mode, hard line breaks are always taken into account, and issue and user mentions are linked accordingly. Validation rule: ` ^(markdown|gfm)$ `.
|
|
* - context (String): Optional. The repository context, only taken into account when rendering as `gfm`
|
|
**/
|
|
this.render = function(msg, block, callback) {
|
|
var self = this;
|
|
this.client.httpSend(msg, block, function(err, res) {
|
|
if (err)
|
|
return self.sendError(err, null, msg, callback);
|
|
|
|
var ret;
|
|
try {
|
|
ret = res.data;
|
|
var contentType = res.headers["content-type"];
|
|
if (contentType && contentType.indexOf("application/json") !== -1)
|
|
ret = JSON.parse(ret);
|
|
}
|
|
catch (ex) {
|
|
if (callback)
|
|
callback(new error.InternalServerError(ex.message), res);
|
|
return;
|
|
}
|
|
|
|
if (!ret)
|
|
ret = {};
|
|
if (typeof ret == "object") {
|
|
if (!ret.meta)
|
|
ret.meta = {};
|
|
["x-ratelimit-limit", "x-ratelimit-remaining", "x-ratelimit-reset", "x-oauth-scopes", "link", "location", "last-modified", "etag", "status"].forEach(function(header) {
|
|
if (res.headers[header])
|
|
ret.meta[header] = res.headers[header];
|
|
});
|
|
}
|
|
|
|
if (callback)
|
|
callback(null, ret);
|
|
});
|
|
};
|
|
|
|
/** section: github
|
|
* markdown#renderRaw(msg, callback) -> null
|
|
* - msg (Object): Object that contains the parameters and their values to be sent to the server.
|
|
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument.
|
|
*
|
|
* ##### Params on the `msg` object:
|
|
*
|
|
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
|
|
* - data (String): Required. Raw data to send as the body of the request
|
|
**/
|
|
this.renderRaw = function(msg, block, callback) {
|
|
var self = this;
|
|
this.client.httpSend(msg, block, function(err, res) {
|
|
if (err)
|
|
return self.sendError(err, null, msg, callback);
|
|
|
|
var ret;
|
|
try {
|
|
ret = res.data;
|
|
var contentType = res.headers["content-type"];
|
|
if (contentType && contentType.indexOf("application/json") !== -1)
|
|
ret = JSON.parse(ret);
|
|
}
|
|
catch (ex) {
|
|
if (callback)
|
|
callback(new error.InternalServerError(ex.message), res);
|
|
return;
|
|
}
|
|
|
|
if (!ret)
|
|
ret = {};
|
|
if (typeof ret == "object") {
|
|
if (!ret.meta)
|
|
ret.meta = {};
|
|
["x-ratelimit-limit", "x-ratelimit-remaining", "x-ratelimit-reset", "x-oauth-scopes", "link", "location", "last-modified", "etag", "status"].forEach(function(header) {
|
|
if (res.headers[header])
|
|
ret.meta[header] = res.headers[header];
|
|
});
|
|
}
|
|
|
|
if (callback)
|
|
callback(null, ret);
|
|
});
|
|
};
|
|
|
|
}).call(markdown.markdown);
|