Draft: Add sponsorability feature

README.md

@@ -210,7 +210,9 @@ Please note that only the first 100 labels per issue will be fetched. If a singl
 
 ## Token
 
-To run Mariner, you must create a token. The GitHub token must be a valid personal access token.
+To run Mariner, you must create a token. The GitHub token must be a valid personal access token. 
+It requires one of the following scopes: ['user:email', 'read:user', 'read:org'] scopes.
+Please modify your token's scopes at: https://github.com/settings/tokens."
 It does not require any permissions beyond the default, so when you create it you can leave all
 the boxes unchecked. Be careful not to share your token with anyone. If it gets exposed, revoke
 it and create a replacement.
@@ -258,7 +260,7 @@ Run `nvm use` to use the appropiate version of Node specified in the .nvmrc file
 
 Run `npm run build` to compile the code to Javascript.
 
-Run `node dist/examples/runExample.js` (to use GraphQL) or `node dist/examples/runOldCode.ts` (to use REST calls), to run the example program. It requires internet access, since it calls the GitHub API. It will take a couple minutes to complete. Some of the output includes the word "ERROR", so don't panic.
+Run `npm start` (to use GraphQL) or `node dist/examples/runOldCode.ts` (to use REST calls), to run the example program. It requires internet access, since it calls the GitHub API. It will take a couple minutes to complete. Some of the output includes the word "ERROR", so don't panic.
 
 Ensure to lint your code by running `npm run lint` before submitting any code for review. Either manually fix the errors or run `npm run lint:fix` to automatically fix any errors.
 

examples/config.json

@@ -6,6 +6,7 @@
     ],
     "inputFilePath": "examples/exampleData.json",
     "outputFilePath": "examples/output.json",
+    "outputSponsorableFilePath": "examples/sponsorableOutput.tsv",
     "daysAgoCreated": 90,
     "numberOfReposPerCall": 1000
 }

examples/runExample.ts

@@ -6,7 +6,7 @@
     Optionally, you can have environment variables for INPUT_FILE_PATH and OUTPUT_FILE_PATH,
         but they have defaults that will work with the standard development environment.
     Then, run `npm run build`
-    Finally, run `node dist/examples/runExample.js`
+    Finally, run `npm start` or `node dist/examples/runExample.js`
 
     You'll know it's run correctly if you have a new file
         examples/output.json with some GitHub issues in it.
@@ -49,6 +49,7 @@ mariner.setLogger(logger);
 
 logger.info(`Input:  ${path.resolve(config.inputFilePath)}`);
 logger.info(`Output: ${path.resolve(config.outputFilePath)}`);
+logger.info(`Sponsorable Output: ${path.resolve(config.outputSponsorableFilePath)}`);
 logger.info(`Fetching issues from the last ${config.daysAgoCreated} days`);
 
 const contents = fs.readFileSync(config.inputFilePath, {
@@ -60,13 +61,14 @@ const repositoryIdentifiers = Object.keys(countsByLibrary);
 const prefix = 'https://api.github.com/repos/';
 const repositoryLookupName = repositoryIdentifiers.map((identifier) => {
     if (identifier.startsWith(prefix)) {
-        return identifier.substr(prefix.length);
+        return identifier.substring(prefix.length);
     } else {
         return identifier;
     }
 });
 
 const finder = new mariner.IssueFinder(config);
+const fetchSponsorables = new mariner.SponsorabilityFetcher(config);
 
 function convertToRecord(issues: Map<string, mariner.Issue[]>): Record<string, mariner.Issue[]> {
     const record: Record<string, mariner.Issue[]> = {};
@@ -84,6 +86,42 @@ function outputToJson(record: Record<string, mariner.Issue[]>): void {
     fs.writeFileSync(config.outputFilePath, jsonResults);
 }
 
+fetchSponsorables
+    .fetchSponsorabilityInformation(token, repositoryLookupName)
+    .then((results) => {
+        console.log(results.length);
+        console.log(results, 'line 98 in runExample file');
+
+        /* output 2
+[
+  {
+    type: 'User',
+    email: 'mvdan@mvdan.cc',
+    login: 'mvdan',
+    url: 'https://github.com/mvdan',
+    sponsorListingName: 'sponsors-mvdan'
+  },
+  {
+    type: 'User',
+    email: 'kzm@zkat.tech',
+    login: 'zkat',
+    url: 'https://github.com/zkat',
+    sponsorListingName: 'sponsors-zkat'
+  }
+] line 98 in runExample file*/
+
+        fs.writeFileSync(
+            config.outputSponsorableFilePath,
+            `${JSON.stringify(results, undefined, 2)}`
+        );
+
+        // logger.info(`Saved User results to: ${config.outputSponsorableFilePath}`);
+    })
+    .catch((err: { message: string }) => {
+        logger.error(err.message);
+        console.log(err);
+    });
+
 finder
     .findIssues(token, repositoryLookupName)
     .then((issues) => {

examples/sponsorableOutput.tsv

@@ -0,0 +1 @@
+{}