@devtion/actions 0.0.0-7e983e3 → 0.0.0-eb3bb7d

package/dist/index.mjs

@@ -244,6 +244,12 @@ const commonTerms = {
                 verificationStartedAt: "verificationStartedAt"
             }
         },
+        avatars: {
+            name: "avatars",
+            fields: {
+                avatarUrl: "avatarUrl"
+            }
+        },
         ceremonies: {
             name: "ceremonies",
             fields: {
@@ -2079,55 +2085,27 @@ const verifyCeremony = async (functions, firestore, ceremonyPrefix, outputDirect
 };
 
 /**
- * This function will return the number of public repos of a user
- * @param user <string> The username of the user
- * @returns <number> The number of public repos
+ * This function queries the GitHub API to fetch users statistics
+ * @param user {string} the user uid
+ * @returns {any} the stats from the GitHub API
  */
-const getNumberOfPublicReposGitHub = async (user) => {
-    const response = await fetch(`https://api.github.com/user/${user}/repos`, {
+const getGitHubStats = async (user) => {
+    const response = await fetch(`https://api.github.com/user/${user}`, {
         method: "GET",
         headers: {
             Authorization: `token ${process.env.GITHUB_ACCESS_TOKEN}`
         }
     });
     if (response.status !== 200)
-        throw new Error("It was not possible to retrieve the number of public repositories. Please try again.");
+        throw new Error("It was not possible to retrieve the user's statistic. Please try again.");
     const jsonData = await response.json();
-    return jsonData.length;
-};
-/**
- * This function will return the number of followers of a user
- * @param user <string> The username of the user
- * @returns <number> The number of followers
- */
-const getNumberOfFollowersGitHub = async (user) => {
-    const response = await fetch(`https://api.github.com/user/${user}/followers`, {
-        method: "GET",
-        headers: {
-            Authorization: `token ${process.env.GITHUB_ACCESS_TOKEN}`
-        }
-    });
-    if (response.status !== 200)
-        throw new Error("It was not possible to retrieve the number of followers. Please try again.");
-    const jsonData = await response.json();
-    return jsonData.length;
-};
-/**
- * This function will return the number of following of a user
- * @param user <string> The username of the user
- * @returns <number> The number of following users
- */
-const getNumberOfFollowingGitHub = async (user) => {
-    const response = await fetch(`https://api.github.com/user/${user}/following`, {
-        method: "GET",
-        headers: {
-            Authorization: `token ${process.env.GITHUB_ACCESS_TOKEN}`
-        }
-    });
-    if (response.status !== 200)
-        throw new Error("It was not possible to retrieve the number of following. Please try again.");
-    const jsonData = await response.json();
-    return jsonData.length;
+    const data = {
+        following: jsonData.following,
+        followers: jsonData.followers,
+        publicRepos: jsonData.public_repos,
+        avatarUrl: jsonData.avatar_url
+    };
+    return data;
 };
 /**
  * This function will check if the user is reputable enough to be able to use the app
@@ -2135,19 +2113,23 @@ const getNumberOfFollowingGitHub = async (user) => {
  * @param minimumAmountOfFollowing <number> The minimum amount of following the user should have
  * @param minimumAmountOfFollowers <number> The minimum amount of followers the user should have
  * @param minimumAmountOfPublicRepos <number> The minimum amount of public repos the user should have
- * @returns <boolean> True if the user is reputable enough, false otherwise
+ * @returns <any> Return the avatar URL of the user if the user is reputable, false otherwise
  */
 const githubReputation = async (userLogin, minimumAmountOfFollowing, minimumAmountOfFollowers, minimumAmountOfPublicRepos) => {
     if (!process.env.GITHUB_ACCESS_TOKEN)
         throw new Error("The GitHub access token is missing. Please insert a valid token to be used for anti-sybil checks on user registation, and then try again.");
-    const following = await getNumberOfFollowingGitHub(userLogin);
-    const repos = await getNumberOfPublicReposGitHub(userLogin);
-    const followers = await getNumberOfFollowersGitHub(userLogin);
+    const { following, followers, publicRepos, avatarUrl } = await getGitHubStats(userLogin);
     if (following < minimumAmountOfFollowing ||
-        repos < minimumAmountOfPublicRepos ||
+        publicRepos < minimumAmountOfPublicRepos ||
         followers < minimumAmountOfFollowers)
-        return false;
-    return true;
+        return {
+            reputable: false,
+            avatarUrl: ""
+        };
+    return {
+        reputable: true,
+        avatarUrl: avatarUrl
+    };
 };
 
 /**

package/dist/index.node.js

@@ -246,6 +246,12 @@ const commonTerms = {
                 verificationStartedAt: "verificationStartedAt"
             }
         },
+        avatars: {
+            name: "avatars",
+            fields: {
+                avatarUrl: "avatarUrl"
+            }
+        },
         ceremonies: {
             name: "ceremonies",
             fields: {
@@ -2081,55 +2087,27 @@ const verifyCeremony = async (functions, firestore$1, ceremonyPrefix, outputDire
 };
 
 /**
- * This function will return the number of public repos of a user
- * @param user <string> The username of the user
- * @returns <number> The number of public repos
+ * This function queries the GitHub API to fetch users statistics
+ * @param user {string} the user uid
+ * @returns {any} the stats from the GitHub API
  */
-const getNumberOfPublicReposGitHub = async (user) => {
-    const response = await fetch(`https://api.github.com/user/${user}/repos`, {
+const getGitHubStats = async (user) => {
+    const response = await fetch(`https://api.github.com/user/${user}`, {
         method: "GET",
         headers: {
             Authorization: `token ${process.env.GITHUB_ACCESS_TOKEN}`
         }
     });
     if (response.status !== 200)
-        throw new Error("It was not possible to retrieve the number of public repositories. Please try again.");
+        throw new Error("It was not possible to retrieve the user's statistic. Please try again.");
     const jsonData = await response.json();
-    return jsonData.length;
-};
-/**
- * This function will return the number of followers of a user
- * @param user <string> The username of the user
- * @returns <number> The number of followers
- */
-const getNumberOfFollowersGitHub = async (user) => {
-    const response = await fetch(`https://api.github.com/user/${user}/followers`, {
-        method: "GET",
-        headers: {
-            Authorization: `token ${process.env.GITHUB_ACCESS_TOKEN}`
-        }
-    });
-    if (response.status !== 200)
-        throw new Error("It was not possible to retrieve the number of followers. Please try again.");
-    const jsonData = await response.json();
-    return jsonData.length;
-};
-/**
- * This function will return the number of following of a user
- * @param user <string> The username of the user
- * @returns <number> The number of following users
- */
-const getNumberOfFollowingGitHub = async (user) => {
-    const response = await fetch(`https://api.github.com/user/${user}/following`, {
-        method: "GET",
-        headers: {
-            Authorization: `token ${process.env.GITHUB_ACCESS_TOKEN}`
-        }
-    });
-    if (response.status !== 200)
-        throw new Error("It was not possible to retrieve the number of following. Please try again.");
-    const jsonData = await response.json();
-    return jsonData.length;
+    const data = {
+        following: jsonData.following,
+        followers: jsonData.followers,
+        publicRepos: jsonData.public_repos,
+        avatarUrl: jsonData.avatar_url
+    };
+    return data;
 };
 /**
  * This function will check if the user is reputable enough to be able to use the app
@@ -2137,19 +2115,23 @@ const getNumberOfFollowingGitHub = async (user) => {
  * @param minimumAmountOfFollowing <number> The minimum amount of following the user should have
  * @param minimumAmountOfFollowers <number> The minimum amount of followers the user should have
  * @param minimumAmountOfPublicRepos <number> The minimum amount of public repos the user should have
- * @returns <boolean> True if the user is reputable enough, false otherwise
+ * @returns <any> Return the avatar URL of the user if the user is reputable, false otherwise
  */
 const githubReputation = async (userLogin, minimumAmountOfFollowing, minimumAmountOfFollowers, minimumAmountOfPublicRepos) => {
     if (!process.env.GITHUB_ACCESS_TOKEN)
         throw new Error("The GitHub access token is missing. Please insert a valid token to be used for anti-sybil checks on user registation, and then try again.");
-    const following = await getNumberOfFollowingGitHub(userLogin);
-    const repos = await getNumberOfPublicReposGitHub(userLogin);
-    const followers = await getNumberOfFollowersGitHub(userLogin);
+    const { following, followers, publicRepos, avatarUrl } = await getGitHubStats(userLogin);
     if (following < minimumAmountOfFollowing ||
-        repos < minimumAmountOfPublicRepos ||
+        publicRepos < minimumAmountOfPublicRepos ||
         followers < minimumAmountOfFollowers)
-        return false;
-    return true;
+        return {
+            reputable: false,
+            avatarUrl: ""
+        };
+    return {
+        reputable: true,
+        avatarUrl: avatarUrl
+    };
 };
 
 /**

package/dist/types/src/helpers/constants.d.ts

@@ -98,6 +98,12 @@ export declare const commonTerms: {
                 verificationStartedAt: string;
             };
         };
+        avatars: {
+            name: string;
+            fields: {
+                avatarUrl: string;
+            };
+        };
         ceremonies: {
             name: string;
             fields: {

package/dist/types/src/helpers/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/helpers/constants.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,sBAAsB,+CAA+C,CAAA;AAElF,eAAO,MAAM,mBAAmB,6BAA6B,CAAA;AAE7D,eAAO,MAAM,gBAAgB,UAAU,CAAA;AAEvC,eAAO,MAAM,gBAAgB,KAAK,CAAA;AAElC,eAAO,MAAM,eAAe,UAAU,CAAA;AAEtC,eAAO,MAAM,sBAAsB,UAAU,CAAA;AAE7C,eAAO,MAAM,sBAAsB,SAAS,CAAA;AAE5C,eAAO,MAAM,4BAA4B,aAAa,CAAA;AAEtD,eAAO,MAAM,cAAc,sBAAsB,CAAA;AAEjD,eAAO,MAAM,yBAAyB,iBAAiB,CAAA;AAEvD;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2ChC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB;;;GA6G5B,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuHvB,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../src/helpers/constants.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,sBAAsB,+CAA+C,CAAA;AAElF,eAAO,MAAM,mBAAmB,6BAA6B,CAAA;AAE7D,eAAO,MAAM,gBAAgB,UAAU,CAAA;AAEvC,eAAO,MAAM,gBAAgB,KAAK,CAAA;AAElC,eAAO,MAAM,eAAe,UAAU,CAAA;AAEtC,eAAO,MAAM,sBAAsB,UAAU,CAAA;AAE7C,eAAO,MAAM,sBAAsB,SAAS,CAAA;AAE5C,eAAO,MAAM,4BAA4B,aAAa,CAAA;AAEtD,eAAO,MAAM,cAAc,sBAAsB,CAAA;AAEjD,eAAO,MAAM,yBAAyB,iBAAiB,CAAA;AAEvD;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2ChC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB;;;GA6G5B,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6HvB,CAAA"}

package/dist/types/src/helpers/security.d.ts

@@ -4,7 +4,7 @@
  * @param minimumAmountOfFollowing <number> The minimum amount of following the user should have
  * @param minimumAmountOfFollowers <number> The minimum amount of followers the user should have
  * @param minimumAmountOfPublicRepos <number> The minimum amount of public repos the user should have
- * @returns <boolean> True if the user is reputable enough, false otherwise
+ * @returns <any> Return the avatar URL of the user if the user is reputable, false otherwise
  */
-export declare const githubReputation: (userLogin: string, minimumAmountOfFollowing: number, minimumAmountOfFollowers: number, minimumAmountOfPublicRepos: number) => Promise<boolean>;
+export declare const githubReputation: (userLogin: string, minimumAmountOfFollowing: number, minimumAmountOfFollowers: number, minimumAmountOfPublicRepos: number) => Promise<any>;
 //# sourceMappingURL=security.d.ts.map

package/dist/types/src/helpers/security.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"security.d.ts","sourceRoot":"","sources":["../../../../src/helpers/security.ts"],"names":[],"mappings":"AAwDA;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,cACd,MAAM,4BACS,MAAM,4BACN,MAAM,8BACJ,MAAM,KACnC,QAAQ,OAAO,CAgBjB,CAAA"}
+{"version":3,"file":"security.d.ts","sourceRoot":"","sources":["../../../../src/helpers/security.ts"],"names":[],"mappings":"AA8BA;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,cACd,MAAM,4BACS,MAAM,4BACN,MAAM,8BACJ,MAAM,KACnC,QAAQ,GAAG,CAsBb,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devtion/actions",
-  "version": "0.0.0-7e983e3",
+  "version": "0.0.0-eb3bb7d",
   "description": "A set of actions and helpers for CLI commands",
   "repository": "git@github.com:privacy-scaling-explorations/p0tion.git",
   "homepage": "https://github.com/privacy-scaling-explorations/p0tion",
@@ -83,5 +83,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "afae72061a3b366b05508de53fe91e9b254cc3d5"
+  "gitHead": "d21d2002b8d020289595aaea83be0202d28486cb"
 }

package/src/helpers/constants.ts

@@ -217,6 +217,12 @@ export const commonTerms = {
                 verificationStartedAt: "verificationStartedAt"
             }
         },
+        avatars: {
+            name: "avatars",
+            fields: {
+                avatarUrl: "avatarUrl"
+            }
+        },
         ceremonies: {
             name: "ceremonies",
             fields: {

package/src/helpers/security.ts

@@ -1,45 +1,12 @@
 import fetch from "@adobe/node-fetch-retry"
+
 /**
- * This function will return the number of public repos of a user
- * @param user <string> The username of the user
- * @returns <number> The number of public repos
- */
-const getNumberOfPublicReposGitHub = async (user: string): Promise<number> => {
-    const response = await fetch(`https://api.github.com/user/${user}/repos`, {
-        method: "GET",
-        headers: {
-            Authorization: `token ${process.env.GITHUB_ACCESS_TOKEN!}`
-        }
-    })
-    if (response.status !== 200)
-        throw new Error("It was not possible to retrieve the number of public repositories. Please try again.")
-    const jsonData: any = await response.json()
-    return jsonData.length
-}
-/**
- * This function will return the number of followers of a user
- * @param user <string> The username of the user
- * @returns <number> The number of followers
- */
-const getNumberOfFollowersGitHub = async (user: string): Promise<number> => {
-    const response = await fetch(`https://api.github.com/user/${user}/followers`, {
-        method: "GET",
-        headers: {
-            Authorization: `token ${process.env.GITHUB_ACCESS_TOKEN!}`
-        }
-    })
-    if (response.status !== 200)
-        throw new Error("It was not possible to retrieve the number of followers. Please try again.")
-    const jsonData: any = await response.json()
-    return jsonData.length
-}
-/**
- * This function will return the number of following of a user
- * @param user <string> The username of the user
- * @returns <number> The number of following users
+ * This function queries the GitHub API to fetch users statistics
+ * @param user {string} the user uid
+ * @returns {any} the stats from the GitHub API
  */
-const getNumberOfFollowingGitHub = async (user: string): Promise<number> => {
-    const response = await fetch(`https://api.github.com/user/${user}/following`, {
+const getGitHubStats = async (user: string): Promise<any> => {
+    const response = await fetch(`https://api.github.com/user/${user}`, {
         method: "GET",
         headers: {
             Authorization: `token ${process.env.GITHUB_ACCESS_TOKEN!}`
@@ -47,11 +14,18 @@ const getNumberOfFollowingGitHub = async (user: string): Promise<number> => {
     })
 
     if (response.status !== 200)
-        throw new Error("It was not possible to retrieve the number of following. Please try again.")
+        throw new Error("It was not possible to retrieve the user's statistic. Please try again.")
 
     const jsonData: any = await response.json()
 
-    return jsonData.length
+    const data  = {
+        following: jsonData.following,
+        followers: jsonData.followers,
+        publicRepos: jsonData.public_repos,
+        avatarUrl: jsonData.avatar_url
+    }
+
+    return data 
 }
 
 /**
@@ -60,27 +34,33 @@ const getNumberOfFollowingGitHub = async (user: string): Promise<number> => {
  * @param minimumAmountOfFollowing <number> The minimum amount of following the user should have
  * @param minimumAmountOfFollowers <number> The minimum amount of followers the user should have
  * @param minimumAmountOfPublicRepos <number> The minimum amount of public repos the user should have
- * @returns <boolean> True if the user is reputable enough, false otherwise
+ * @returns <any> Return the avatar URL of the user if the user is reputable, false otherwise
  */
 export const githubReputation = async (
     userLogin: string,
     minimumAmountOfFollowing: number,
     minimumAmountOfFollowers: number,
     minimumAmountOfPublicRepos: number
-): Promise<boolean> => {
+): Promise<any> => {
     if (!process.env.GITHUB_ACCESS_TOKEN)
         throw new Error(
             "The GitHub access token is missing. Please insert a valid token to be used for anti-sybil checks on user registation, and then try again."
         )
-    const following = await getNumberOfFollowingGitHub(userLogin)
-    const repos = await getNumberOfPublicReposGitHub(userLogin)
-    const followers = await getNumberOfFollowersGitHub(userLogin)
+
+    const { following, followers, publicRepos, avatarUrl } = await getGitHubStats(userLogin)
 
     if (
         following < minimumAmountOfFollowing ||
-        repos < minimumAmountOfPublicRepos ||
+        publicRepos < minimumAmountOfPublicRepos ||
         followers < minimumAmountOfFollowers
     )
-        return false
-    return true
+        return {
+            reputable: false,
+            avatarUrl: ""
+        }
+        
+    return {
+        reputable: true,
+        avatarUrl: avatarUrl
+    }
 }