n8n/packages/nodes-base/nodes/Github/GenericFunctions.ts

88 lines
2.4 KiB
TypeScript
Raw Normal View History

2019-06-23 03:35:23 -07:00
import {
IExecuteFunctions,
IHookFunctions,
} from 'n8n-core';
import {
IDataObject,
} from 'n8n-workflow';
/**
* Make an API request to Github
*
* @param {IHookFunctions} this
* @param {string} method
* @param {string} url
* @param {object} body
* @returns {Promise<any>}
*/
export async function githubApiRequest(this: IHookFunctions | IExecuteFunctions, method: string, endpoint: string, body: object, query?: object): Promise<any> { // tslint:disable-line:no-any
2020-02-09 07:11:15 -08:00
const githubApiCredentials = this.getCredentials('githubApi');
const oAuth2ApiCrendetials = this.getCredentials('oAuth2Api');
let headers = {}
if (githubApiCredentials !== undefined) {
headers = {
Authorization: `token ${githubApiCredentials.accessToken}`,
'User-Agent': githubApiCredentials.user,
};
} else {
const { access_token } = oAuth2ApiCrendetials!.oauthTokenData as IDataObject;
headers = {
Authorization: `token ${access_token}`,
'User-Agent': 'Node js',
};
2019-06-23 03:35:23 -07:00
}
const options = {
method,
2020-02-09 07:11:15 -08:00
headers,
2019-06-23 03:35:23 -07:00
body,
qs: query,
uri: `https://api.github.com${endpoint}`,
json: true
};
try {
return await this.helpers.request(options);
} catch (error) {
if (error.statusCode === 401) {
// Return a clear error
throw new Error('The Github credentials are not valid!');
}
if (error.response && error.response.body && error.response.body.message) {
// Try to return the error prettier
throw new Error(`Github error response [${error.statusCode}]: ${error.response.body.message}`);
}
// If that data does not exist for some reason return the actual error
throw error;
}
}
/**
* Returns the SHA of the given file
*
* @export
* @param {(IHookFunctions | IExecuteFunctions)} this
* @param {string} owner
* @param {string} repository
* @param {string} filePath
* @param {string} [branch]
* @returns {Promise<any>}
*/
export async function getFileSha(this: IHookFunctions | IExecuteFunctions, owner: string, repository: string, filePath: string, branch?: string): Promise<any> { // tslint:disable-line:no-any
const getBody: IDataObject = {};
if (branch !== undefined) {
getBody.branch = branch;
}
const getEndpoint = `/repos/${owner}/${repository}/contents/${encodeURI(filePath)}`;
const responseData = await githubApiRequest.call(this, 'GET', getEndpoint, getBody, {});
if (responseData.sha === undefined) {
throw new Error('Could not get the SHA of the file.');
}
return responseData.sha;
}