feat: implement word-editor script (#18)

This Pull request implement the `word-editor` script; the primary
functionality of this script is to allowing adding new word, retrieve
and update existing word which are individual `.mdx` files residing in
the `src/pages/browse` directory of the project. This script avails us
of all the helper functions required to perform this operations.

### Changes Made

- Implemented the `writeNewWord` function - this function takes 3 params
namely the `userOctokit`, `forkedRepoDetails`, and the `word`; it
leverages the `userOctokit` instance to perform a write operation i.e.
writing a new file (newWord.mdx) to a fork of our project on the user's
account on behalf of the user through the `"PUT
/repos/{owner}/{repo}/contents/{path}"` endpoint
- Impelemented the `getExistingWord` function - this function helps
retrieve data of existing words in the fork of our project on the user's
account by calling the `"GET /repos/{owner}/{repo}/contents/{path}"`
endpoint; it returns an object which carries the following properties
that we are mostly interested in...
- `title` - title of the the existing word - this infact is a custom
appended data to the `response.data` from the call made to the endpoint
  - `path` - path to the existing word file
  - `sha` - unique SHA of the existing word
- Implemented the `editExistingWord` function - this function takes 3
params namely the `userOctokit`, `forkedRepoDetails`, and the `word`
(holds the properties: `path`, `sha`, `title` and `content`); it
leverages the `userOctokit` instance to perform a edit operation i.e.
updating the existing file on a fork of our project on the user's
account on behalf of the user through thesame `"PUT
/repos/{owner}/{repo}/contents/{path}"` endpoint
- Implemented `writeFileContent` helper function - this function help
write a content for our dictionary word file generating them from
another added constant in the `src/lib/template/word.md.js`

### Screencast/Screenshot

_too lazy to record a screencast for this one_ 😜, _but trust me_ 🤞 _the
shit works_ 😮‍💨

Author: babblebey

src/lib/template/word.md.js

@@ -0,0 +1,6 @@
+export default `---
+layout: ../../layouts/word.astro
+title: $title
+---
+
+$content`

src/lib/utils/index.js

@@ -21,4 +21,13 @@ export function getRepoParts(repoFullname) {
     repoOwner,
     repoName
   }
+}
+
+/**
+ * Normalize a string to something usable in url
+ * @param {string} string 
+ * @returns {string}
+ */
+export function normalizeAsUrl(string) {
+  return string.toLowerCase().replace(/\s+/g, "-");
 }

src/lib/word-editor.js

@@ -0,0 +1,101 @@
+import { getRepoParts, normalizeAsUrl } from "./utils/index.js";
+import wordFileTemplate from "./template/word.md.js";
+
+/**
+ * Write and add a new word to user's forked dictionary
+ * @param {import("octokit").Octokit} userOctokit 
+ * @param {{ repoFullname: string, repoBranchRef: string }} forkedRepoDetails 
+ * @param {{ title: string, content: string }} word 
+ */
+export async function writeNewWord(userOctokit, forkedRepoDetails, { title, content }) {
+  const { repoFullname, repoBranchRef } = forkedRepoDetails;
+  const { repoOwner, repoName } = getRepoParts(repoFullname);
+  const branch = repoBranchRef.split("/").slice(2).join("/");
+  const wordFileContent = writeWordFileContent(title, content);
+
+  try {
+    const response = await userOctokit.request("PUT /repos/{owner}/{repo}/contents/{path}", {
+      owner: repoOwner,
+      repo: repoName,
+      branch,
+      path: `src/pages/browse/${normalizeAsUrl(title)}.mdx`,
+      content: Buffer.from(wordFileContent).toString("base64"),
+      message: `word: commit to "${title}"`
+    });
+  
+    return response.data
+  } catch (error) {
+    throw new Error(`error committing new word ${title} to dictionary`, { cause: error.message })
+  }
+}
+
+/**
+ * Edit and update an existing word in user's forked dictionary
+ * @param {import("octokit").Octokit} userOctokit 
+ * @param {{ repoFullname: string, repoBranchRef: string }} forkedRepoDetails 
+ * @param {{ path: string, sha: string, title: string, content: string }} word  enter new content as value to `content` property
+ */
+export async function editExistingWord(userOctokit, forkedRepoDetails, { path, sha, title, content }) {
+  const { repoFullname, repoBranchRef } = forkedRepoDetails;
+  const { repoOwner, repoName } = getRepoParts(repoFullname);
+  const branch = repoBranchRef.split("/").slice(2).join("/");
+  const wordFileContent = writeWordFileContent(title, content);
+
+  try {
+    const response = await userOctokit.request("PUT /repos/{owner}/{repo}/contents/{path}", {
+      owner: repoOwner,
+      repo: repoName,
+      branch,
+      path,
+      content: Buffer.from(wordFileContent).toString("base64"),
+      message: `word: edit commit to "${title}"`,
+      sha
+    });
+  
+    return response.data;
+  } catch (error) {
+    throw new Error(`error committing edit to "${title}"`, { cause: error.message })
+  }
+}
+
+/**
+ * Retrieve data for already existing word
+ * @param {import("octokit").Octokit} userOctokit 
+ * @param {{ repoFullname: string, repoBranchRef: string }} forkedRepoDetails 
+ * @param {string} wordTitle 
+ */
+export async function getExistingWord(userOctokit, forkedRepoDetails, wordTitle) {
+  const { repoFullname, repoBranchRef } = forkedRepoDetails;
+  const { repoOwner, repoName } = getRepoParts(repoFullname);
+
+  try {
+    const response = await userOctokit.request("GET /repos/{owner}/{repo}/contents/{path}", {
+      owner: repoOwner,
+      repo: repoName,
+      ref: repoBranchRef,
+      path: `src/pages/browse/${normalizeAsUrl(wordTitle)}.mdx`,
+    });
+
+    const { content, ...responseData } = response.data;
+
+    return {
+      title: wordTitle,
+      content,
+      content_decoded: Buffer.from(content, "base64").toString("utf-8"),
+      ...responseData
+    };
+  } catch (error) {
+    throw new Error(`error getting "${wordTitle}" from dictionary`, { cause: error.message })
+  }
+}
+
+/**
+ * Write word file content using pre-defined template
+ * @param {string} title 
+ * @param {string} content 
+ * @returns {string}
+ */
+function writeWordFileContent(title, content) {
+  const file = wordFileTemplate;
+  return file.replace("$title", title).replace("$content", content);
+}