2
0
mirror of https://github.com/tycrek/degoogle synced 2024-11-04 12:00:20 +00:00
degoogle/_wiki.js
2021-08-09 11:12:15 -07:00

108 lines
4.1 KiB
JavaScript

const fs = require('fs-extra'); // Reading README.md
const path = require('path'); // Get the correct path for README.md
const fetch = require('node-fetch'); // Make calls to Reddit from Node.js
const qs = require('qs'); // Properly build a query for node-fetch POST
const moment = require('moment'); // Time-related functions
//#region constants
// REDDIT_: For authentication with Reddit API. Oauth MUST be used. ID and Secret come from a "script" app type.
const REDDIT_USER = process.env.REDDIT_USER || 'username';
const REDDIT_PASS = process.env.REDDIT_PASS || 'password';
const REDDIT_CLIENT_ID = process.env.REDDIT_CLIENT_ID || 'clientid';
const REDDIT_CLIENT_SECRET = process.env.REDDIT_CLIENT_SECRET || 'clientsecret';
// Initial basic authorization for getting the Oauth token
const BASIC_AUTH = `Basic ${Buffer.from(REDDIT_CLIENT_ID + ':' + REDDIT_CLIENT_SECRET).toString('base64')}`;
// WIKI_: For the Reddit Wiki
const WIKI_SUBREDDIT = 'privacy';
const WIKI_PAGE = 'de-google';
const WIKI_REASON = 'Automated edit from GitHub repo: https://github.com/tycrek/degoogle';
// Endpoints for each of our fetches to Reddit
const ENDPOINTS = {
revisions: `https://old.reddit.com/r/${WIKI_SUBREDDIT}/wiki/revisions/${WIKI_PAGE}.json`,
token: 'https://www.reddit.com/api/v1/access_token',
edit: `https://oauth.reddit.com/r/${WIKI_SUBREDDIT}/api/wiki/edit`
};
// Helps POST data be submitted properly
const CONTENT_TYPE = 'application/x-www-form-urlencoded';
//#endregion
// Update the wiki
Promise.all([getLastRevision(), getToken()])
.then(([lastId, token]) => putWiki(lastId, token))
.catch((err) => (console.error(err), process.exit(1)));
//#region functions
/**
* Get the last revision ID on the Wiki. Required otherwise editing the wiki fails
*/
function getLastRevision() {
return new Promise((resolve, reject) =>
fetch(ENDPOINTS.revisions)
.then((response) => response.json())
.then((json) => json.data.children[0].id) // children[0] is the most recent edit
.then(resolve)
.catch(reject));
}
/**
* Gets an Oauth token used to edit the Wiki
*/
function getToken() {
return new Promise((resolve, reject) =>
fetch(ENDPOINTS.token, {
method: 'POST',
headers: { 'Authorization': BASIC_AUTH, 'Content-Type': CONTENT_TYPE },
body: qs.stringify({ grant_type: 'password', username: REDDIT_USER, password: REDDIT_PASS })
})
.then((response) => response.json())
.then(({ access_token }) => resolve(access_token))
.catch(reject));
}
/**
* Post the contents from the README into the wiki
* @param {String} lastId Revision ID for the Wiki
* @param {String} token Oauth token for authenticating with the Reddit API
*/
function putWiki(lastId, token) {
return new Promise((resolve, reject) =>
fetch(ENDPOINTS.edit, {
method: 'POST',
headers: { 'Authorization': `bearer ${token}`, 'Content-Type': CONTENT_TYPE },
body: qs.stringify({
content: fixContent(fs.readFileSync(path.join(__dirname, 'README.md')).toString()),
page: WIKI_PAGE,
reason: WIKI_REASON,
previous: lastId
})
})
.then((response) => response.json())
.then((json) => {
if (Object.keys(json).length === 0) resolve();
else throw Error(json);
})
.catch(reject));
}
/**
* Fixes certain images to only show text on the Reddit wiki
* @param {String} content The content in README.md
*/
function fixContent(content) {
// Fix updated timestamp
content = content.replace(/\!\[Updated\](.*?)square\)/g, `#### Updated: ${moment().format('MMMM Do YYYY')}`);
// Fix published timestamps
content = content.replace(/\!\[Published\]\(https\:\/\/img\.shields\.io\/badge\//g, '**');
content = content.replace(/-informational\?style=flat-square\)/g, '**');
return content;
} // * If this is highlighted weirdly, it's because of the 'updated timestamp' regex, don't worry about it
//#endregion