feat: add custom config capability (#11)

README.md

@@ -1 +1,5 @@
-# wow-lookup-fetcher
+# WOW Lookup Fetcher
+
+```bash
+npm login --scope=@wowlink --registry=https://npm.pkg.github.com
+```

package.json

@@ -32,7 +32,7 @@
   },
   "dependencies": {
     "@octokit/rest": "^18.5.3",
-    "@wowlink/wow-interface": "^1.3.2",
+    "@wowlink/wow-interface": "^1.4.0",
     "js-yaml": "^4.1.0"
   }
 }

src/builtin_fetchers/github_fetcher.test.ts

@@ -1,6 +1,10 @@
 import { WowLookupFetcherConfig, WowLookupFetchRequest, WowLookupFetchResponse } from "@wowlink/wow-interface";
 import { GitHubWowLookupFetcher } from "./github_fetcher";
 
+/**
+ * Note that some of the tests use https://github.com/wowlink/dev-config
+ * as the example configuration to fetch.
+ */
 describe("GitHub fetcher tests", () => {
     test("Initialize GitHub fetcher", () => {
         const config: WowLookupFetcherConfig = {
@@ -14,7 +18,7 @@ describe("GitHub fetcher tests", () => {
     test("Fetch repository config", async () => {
         const config: WowLookupFetcherConfig = {
             githubUser: "wowlink",
-            githubRepository: "default-profile",
+            githubRepository: "dev-config",
         };
         const fetcher: GitHubWowLookupFetcher = new GitHubWowLookupFetcher(config);
         const request: WowLookupFetchRequest = {};
@@ -23,4 +27,18 @@ describe("GitHub fetcher tests", () => {
         const mapping: Record<string, string> = response.wowMapping;
         expect(mapping["gh"]).toMatch("https://github.com");
     });
+
+    test("Custom configuration filename", async () => {
+        const config: WowLookupFetcherConfig = {
+            githubUser: "wowlink",
+            githubRepository: "dev-config",
+            githubConfigFilename: "alternative-config.yaml"
+        };
+        const fetcher: GitHubWowLookupFetcher = new GitHubWowLookupFetcher(config);
+        const request: WowLookupFetchRequest = {};
+        const response: WowLookupFetchResponse = await fetcher.fetch(request);
+        expect(response.wowMapping).toBeDefined();
+        const mapping: Record<string, string> = response.wowMapping;
+        expect(mapping["gh/me"]).toMatch("https://github.com/tianhaoz95");
+    });
 });

src/builtin_fetchers/github_fetcher.ts

@@ -17,10 +17,13 @@ class GitHubWowLookupFetcher implements WowLookupFetcher {
     async fetch(req: WowLookupFetchRequest): Promise<WowLookupFetchResponse> {
         if (this.config_.githubUser && this.config_.githubRepository) {
             const octokit = new Octokit();
+            const configFilename: string =
+                this.config_.githubConfigFilename
+                    ? this.config_.githubConfigFilename : "config.yaml";
             const configResponse = await octokit.rest.repos.getContent({
                 owner: this.config_.githubUser,
                 repo: this.config_.githubRepository,
-                path: "config.yaml",
+                path: configFilename,
             });
             const configStr = Buffer.from(
                 configResponse.data["content"], "base64").toString();