Browse Source
Feature/gh api deprecation (#42)
* Updated jquery version * Updated docker image to run basic node image, fixed GH deprecated authentication methodmaster
GitHub
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
15 changed files with 60 additions and 392 deletions
Split View
Diff Options
-
+28 -9.gitignore
-
+1 -11Dockerfile
-
+13 -9README.md
-
+4 -5docker-compose.yml
-
+1 -3server/public/FriendsGraph.html
-
+1 -3server/public/GraphGenerator.html
-
+1 -3server/public/GraphTest.html
-
+1 -3server/public/OrgRepoGraph.html
-
+1 -3server/public/TimeLineGraph.html
-
+1 -3server/public/about.html
-
+1 -3server/public/index.html
-
+5 -12server/routes/api/v1.js
-
+0 -310server/routes/api/v2.js
-
+0 -11server/routes/test/v2.js
-
+2 -4server/server.js
+ 28
- 9
.gitignore
View File
| @ -1,9 +1,28 @@ | |||
| ################################################################################ | |||
| # This .gitignore file was automatically created by Microsoft(R) Visual Studio. | |||
| ################################################################################ | |||
| */.vs | |||
| */node_modules/.bin | |||
| */node_modules | |||
| */package-lock.json | |||
| */.env | |||
| # Dependencies | |||
| node_modules/ | |||
| package-lock.json | |||
| # Environment variables | |||
| .env | |||
| server/.env | |||
| # Logs | |||
| logs/ | |||
| *.log | |||
| npm-debug.log* | |||
| # Runtime / OS | |||
| .DS_Store | |||
| Thumbs.db | |||
| # IDE / Editor | |||
| .vs/ | |||
| .vscode/ | |||
| .idea/ | |||
| # Test coverage | |||
| coverage/ | |||
| .nyc_output/ | |||
| # Docker volumes | |||
| volumes/ | |||
+ 1
- 11
Dockerfile
View File
+ 13
- 9
README.md
View File
+ 4
- 5
docker-compose.yml
View File
| @ -1,11 +1,10 @@ | |||
| version: '3.7' | |||
| services: | |||
| github-graphs: | |||
| build: | |||
| dockerfile: Dockerfile | |||
| image: graph-app:latest | |||
| image: graph-app | |||
| container_name: github-graphs | |||
| env_file: | |||
| - .env | |||
| ports: | |||
| - "8080:8000" | |||
| - "4002:4002" | |||
+ 1
- 3
server/public/FriendsGraph.html
View File
+ 1
- 3
server/public/GraphGenerator.html
View File
+ 1
- 3
server/public/GraphTest.html
View File
+ 1
- 3
server/public/OrgRepoGraph.html
View File
+ 1
- 3
server/public/TimeLineGraph.html
View File
+ 1
- 3
server/public/about.html
View File
+ 1
- 3
server/public/index.html
View File
+ 5
- 12
server/routes/api/v1.js
View File
+ 0
- 310
server/routes/api/v2.js
View File
| @ -1,310 +0,0 @@ | |||
| const routes = require('express').Router(); | |||
| const got = require("got"); | |||
| const cache = require('memory-cache'); | |||
| const dotenv = require("dotenv").config(); | |||
| const GITHUB_API = "https://api.github.com"; | |||
| const authenticate = `client_id=${process.env.CLIENT_ID}&client_secret=${process.env.CLIENT_SECRET}`; | |||
| const API_FOLLOWING = "/following"; | |||
| const API_FOLLOWERS = "/followers"; | |||
| const API_USER_PATH = "/users/"; | |||
| const API_ORGS_PATH = "/orgs/"; | |||
| const API_PAGINATION_SIZE = 100; // 100 is the max, 30 is the default | |||
| // if this is too large, it would be infeasible to make graphs for people following popular people | |||
| const API_MAX_PAGES = 2; | |||
| const API_PAGINATION = "&per_page=" + API_PAGINATION_SIZE; | |||
| const REPOS_PATH = "/repos"; | |||
| /** | |||
| * Queries data from the github APi server and returns it as | |||
| * a json object in a promise. | |||
| * | |||
| * This makes no attempt to cache | |||
| * | |||
| * @param {*} requestURL endpoint on githubapi: ex: /users/jrtechs/following | |||
| */ | |||
| const queryGithubAPIRaw = async requestURL => { | |||
| let queryURL = requestURL.includes("?page=") ? `${GITHUB_API}${requestURL}&${authenticate}` :`${GITHUB_API}${requestURL}?${authenticate}`; | |||
| console.log(queryURL); | |||
| try { | |||
| const req = await got(queryURL, { json: true }); | |||
| cache.put(requestURL, req); | |||
| return req; | |||
| } catch (error) { | |||
| console.log(error); | |||
| cache.put(requestURL, `${error.statusCode} - ${error.statusMessage}`); | |||
| } | |||
| } | |||
| /** | |||
| * Queries data from the github api server | |||
| * and caches the results locally. | |||
| * | |||
| * @param {*} requestURL | |||
| */ | |||
| const queryGitHubAPI = async requestURL => { | |||
| const apiData = cache.get(requestURL); | |||
| if (apiData) { | |||
| console.log("Fetched From Cache"); | |||
| return apiData | |||
| } | |||
| try { | |||
| return await queryGithubAPIRaw(requestURL); | |||
| } catch (error) { | |||
| console.log(error); | |||
| } | |||
| } | |||
| /** | |||
| * Fetches all content from a particular github api endpoint | |||
| * using their pagination schema. | |||
| * | |||
| * @param {*} username username of github client | |||
| * @param {*} apiPath following or followers | |||
| * @param {*} page current pagination page | |||
| * @param {*} lst list we are building on | |||
| */ | |||
| const fetchAllWithPagination = async (apiPath, page, lst) => { | |||
| try { | |||
| const req = await queryGithubAPIRaw(`${apiPath}?page=${page}${API_PAGINATION}`); | |||
| if (req.body.hasOwnProperty("length")) { | |||
| const list = lst.concat(req.body); | |||
| if(page < API_MAX_PAGES && req.length === API_PAGINATION_SIZE) { | |||
| const redo = await fetchAllWithPagination(apiPath, page + 1, list); | |||
| return redo; | |||
| } | |||
| return list; | |||
| } | |||
| } catch (error) { | |||
| console.log("Error with api request"); | |||
| } | |||
| } | |||
| /** | |||
| * Makes a copy of a JS object with certain properties | |||
| * | |||
| * @param {*} props | |||
| * @param {*} obj | |||
| */ | |||
| const copyWithProperties = (props, obj) => { | |||
| let newO = new Object(); | |||
| props.forEach(prop => { | |||
| newO[prop] = obj[prop]; | |||
| }) | |||
| return newO; | |||
| } | |||
| /** | |||
| * Combines the list of friends and followers ignoring duplicates | |||
| * that are already in the list. (person is both following and followed by someone) | |||
| * | |||
| * This also removes any unused properties like events_url and organizations_url | |||
| * | |||
| * @param {*} followingAndFollowers | |||
| */ | |||
| const minimizeFriends = people => { | |||
| let friendLst = []; | |||
| let ids = new Set(); | |||
| people.forEach(person => { | |||
| if(!ids.has(person.id)) { | |||
| ids.add(person.id); | |||
| friendLst.push({ | |||
| login: person.login, | |||
| avatar_url: person.avatar_url | |||
| }); | |||
| } | |||
| }); | |||
| return friendLst; | |||
| } | |||
| /** | |||
| * Fetches all the people that are either following or is followed | |||
| * by a person on github. This will cache the results to make simultaneous | |||
| * connections easier and less demanding on the github API. | |||
| * | |||
| * @param {*} user | |||
| */ | |||
| const queryFriends = async user => { | |||
| const cacheHit = cache.get("/friends/" + user); | |||
| if (cacheHit){ | |||
| console.log("Friends cache hit"); | |||
| return cacheHit; | |||
| } | |||
| try { | |||
| const followers = await fetchAllWithPagination(API_USER_PATH + user + API_FOLLOWERS, 1, []); | |||
| const following = await fetchAllWithPagination(API_USER_PATH + user + API_FOLLOWING, 1, []); | |||
| const fList = minimizeFriends(following.concat(followers)); | |||
| cache.put(`/friends/${user}`, fList); | |||
| return fList; | |||
| } catch (error) { | |||
| console.log("API Error", err); | |||
| } | |||
| } | |||
| /** | |||
| * | |||
| * Fetches all of the members of an organization from the | |||
| * API or cache | |||
| * | |||
| * /orgs/RITlug/members?page=1 | |||
| * | |||
| * @param {*} orgName | |||
| */ | |||
| const getOrganizationMembers = async orgName => { | |||
| const cacheHit = cache.get("/org/users/" + orgName); | |||
| if (cacheHit){ | |||
| console.log("Org members cache hit"); | |||
| return cacheHit; | |||
| } | |||
| try { | |||
| const members = await fetchAllWithPagination(API_ORGS_PATH + orgName + "/members", 1, []); | |||
| const membersMin = minimizeFriends(members); | |||
| cache.put("/org/users/" + orgName, membersMin); | |||
| return membersMin; | |||
| } catch (error) { | |||
| console.log(error); | |||
| } | |||
| } | |||
| /** | |||
| * Minimizes the JSON for a list of repositories | |||
| * | |||
| * @param {*} repositories | |||
| */ | |||
| const minimizeRepositories = repositories => { | |||
| let rList = []; | |||
| repositories.forEach(repo => { | |||
| rList.push(copyWithProperties(["name", "created_at", "homepage", | |||
| "description", "language", "forks", "watchers", | |||
| "open_issues_count", "license", "html_url"], | |||
| repo)); | |||
| }) | |||
| return rList; | |||
| } | |||
| /** | |||
| * Fetches all repositories from the API | |||
| * | |||
| * @param {*} user name of org/user | |||
| * @param {*} orgsOrUsers either /users/ or /orgs/ | |||
| */ | |||
| const queryRepositories = async (user, orgsOrUsers) => { | |||
| const cacheHit = cache.get(user + REPOS_PATH); | |||
| if (cacheHit) { | |||
| console.log("Repositories cache hit"); | |||
| return cacheHit; | |||
| } | |||
| try { | |||
| const repos = await fetchAllWithPagination(orgsOrUsers + user + REPOS_PATH, 1, []); | |||
| const minRepos = minimizeRepositories(repos); | |||
| cache.put(`${user}${REPOS_PATH}`, minRepos); | |||
| return minRepos; | |||
| } catch (error) { | |||
| console.log(error) | |||
| console.log("bad things went down"); | |||
| } | |||
| } | |||
| /** | |||
| * /users/name/following/followers | |||
| */ | |||
| routes.get("/friends/:name", async (req, res)=> { | |||
| try { | |||
| const query = await queryFriends(req.params.name); | |||
| res.json(query); | |||
| } catch (error) { | |||
| res.status(500).json({error: 'API error fetching friends'}); | |||
| } | |||
| }); | |||
| routes.get("/org/users/:name", async (request, res) => { | |||
| try { | |||
| const orgMembers = await getOrganizationMembers(request.params.name); | |||
| res.json(orgMembers).end(); | |||
| } catch (error) { | |||
| res.status(500).json({error: 'API error fetching friends'}).end(); | |||
| } | |||
| }); | |||
| routes.get("/repositories/:name", async (req, res) => { | |||
| try { | |||
| const repos = await queryRepositories(req.params.name, API_USER_PATH); | |||
| res.json(repos).end(); | |||
| } catch (error) { | |||
| res.status(500).json({error: 'API error fetching friends'}).end(); | |||
| } | |||
| }); | |||
| routes.get("/org/repositories/:name", async (req, res) => { | |||
| try { | |||
| const repos = await queryRepositories(req.params.name, API_ORGS_PATH); | |||
| res.json(repos).end(); | |||
| } catch (error) { | |||
| res.status(500).json({error: 'API error fetching friends'}).end(); | |||
| } | |||
| }); | |||
| routes.get('/*', (request, result) => | |||
| { | |||
| var gitHubAPIURL = request.url; | |||
| result.setHeader('Content-Type', 'application/json'); | |||
| queryGitHubAPI(gitHubAPIURL).then((data)=> | |||
| { | |||
| if(data.hasOwnProperty("id") || data[0].hasOwnProperty("id")) | |||
| { | |||
| result.write(JSON.stringify(data)); | |||
| } | |||
| else | |||
| { | |||
| result.write("[]"); | |||
| } | |||
| result.end(); | |||
| }).catch((error)=> | |||
| { | |||
| try | |||
| { | |||
| if(error.hasOwnProperty("id") || error[0].hasOwnProperty("id")) | |||
| { | |||
| result.write(JSON.stringify(error)); | |||
| } | |||
| else | |||
| { | |||
| result.write("[]"); | |||
| } | |||
| } | |||
| catch(error) | |||
| { | |||
| result.write("[]"); | |||
| }; | |||
| result.end(); | |||
| }); | |||
| if(cache.size() > 50000) | |||
| { | |||
| cache.clear(); | |||
| } | |||
| }); | |||
| module.exports = routes; | |||
+ 0
- 11
server/routes/test/v2.js
View File
| @ -1,11 +0,0 @@ | |||
| const assert = require('assert'); | |||
| const V2 = require('../api/v2'); | |||
| describe('github api v2', function() { | |||
| it('successfully queries friends', async function() { | |||
| var queryFriends = V2.queryFriends; | |||
| // it was this point that Eric realized he doesn't understand | |||
| // module.exports very well. | |||
| assert.strictEqual(typeof(queryFriends), typeof(queryFriends)); | |||
| }); | |||
| }); | |||