Merge branch 'firebase'

Add firebase version to GitHub Invite

Author: obumnwabude

README.md

@@ -7,7 +7,7 @@ To send an invitation three things must be provided:
 2. Personal access token of an admin in that organization (obtainable in GitHub account settings) that has at least, admin:org (full control of orgs and teams, read and write org projects) permission, when the token was created.
 3. Username of the GitHub user to be invited.
 
-The way this app requires the above mentioned three items, depends on your choice of version to use. Three versions are available and they require different ways of providing the above three items.
+The way this app requires the above mentioned three items, depends on your choice of version to use. Four versions are available and they require different ways of providing the above three items.
 
 
 
@@ -19,8 +19,16 @@ In this version, provide an `org.js` file in the root folder that exports a JSON
 
 ![Demo of Node Monolith Version of GitHub Organization Invitation](/demos/node-monolith.gif)
 
+2. ## [Firebase Version](/firebase) 
 
-2. ## [Static Web App](/docs)
+In this version, create a firebase project at https://console.firebase.google.com and set it up and deploy as in the [Firebase Version README](/firebase/README.md#setting-up). Your Github-Invite is at your `<project_id>`.web.app. Share this link with your invitees. It contains a frontend similar to that of the Node Monolith above, where the GitHub user can enter their username and get invited to your organization.
+
+#### Demo
+
+![Demo of Node Monolith Version of GitHub Organization Invitation](/demos/node-monolith.gif)
+
+
+3. ## [Static Web App](/docs)
 
 In this version, you enter your organization's name on GitHub, an admin's personal access token and the username of the GitHub user to be invited, directly in the static frontend of the website and JavaScript will do the invitation. Proper feedback is equally shown directly in the website whether the invitation was successful or not and possible reasons for that.
 
@@ -32,7 +40,7 @@ So, you can click on that link and perform as many invitations as you wish.
 ![Demo of Static Frontend Version of GitHub Organization Invitation](/demos/static-frontend.gif)
 
 
-3. ## [NPM Package](/npm-package)
+4. ## [NPM Package](/npm-package)
 
 [![npm version](https://badge.fury.io/js/github-invite.svg)](https://badge.fury.io/js/github-invite)
 
@@ -59,6 +67,9 @@ The `github-invite` CLI also outputs feedback properly as invitations are done,
 <br/>
 <br/>
 
+## Customizing
+Feel free to customize the frontends of the ![Node Monolith](/node-monolith) and ![Firebase](/firebase) versions to suit your brand's guidelines. However, avoid tampering with the parts of the code that give feedback and make the app work.
+
 ## Bugs? Features?
 If you have find any problems while using this software, or you come accross any bugs, or you want to add a feature, please feel free to create an issue or pull request. 
 Thank you!

firebase/.gitignore

@@ -0,0 +1,68 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+firebase-debug.log*
+
+# Firebase cache
+.firebase/
+
+# Firebase config
+
+# Uncomment this if you'd like others to create their own Firebase project.
+# For a team working on the same Firebase project(s), it is recommended to leave
+# it commented so all members can deploy to the same project(s) in .firebaserc.
+# .firebaserc
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# add .firebaserc to .gitignore so deployment can be from any firebase project
+.firebaserc

firebase/README.md

@@ -0,0 +1,35 @@
+# GitHub Organisation Invitation - Firebase Version
+
+A web app that can accept a GitHub username and send them an invitation to join a GitHub Organisation.
+
+You can deploy it with firebase and provide users with the frontend, in which they can enter their GitHub username and get invited to your GitHub organization.
+
+## On Firebase
+Firebase is a backend as a service from Google that combines authentication, database, file storage, machine learning, analytics and cloud functions in one place, so that you concentrate on building the app. Checkout https://firebase.google.com for more information. 
+
+This version of GitHub Invite uses Firebase to work. Fundamentally, the static files hosted from the [public folder](./public) makeup the frontend where users enter their `username`s get invited. The frontend submits to a cloud function that makes the invitation and responds with the proper feedback if invitation was successful or not via the URL parameters.
+
+## Get an admin token
+Only admin members of a GitHub organisation can send an invitation to other GitHub users, to join that organisation. The admin member must be authenticated before invitation can be sent. Go to settings in admin's GitHub account and get a new personal access token or use an existing token, if you already have one. Ensure that the token has at least, the admin:org (full control of orgs and teams, read and write org projects) permission (select that permission while creating or edit existing token permissions to include). Keep the token, it will be useful when setting up the Firebase Environment
+
+## Setting Up
+* Create a Firebase project at https://console.firebase.google.com. Take note of your project_id, it is globally unique across all firebase projects and can't be changed after your project is created. You can also enable Google Analytics (recommended).
+
+* After creating your project, create a new web app, enable firebase hosting and follow the terminal/command line steps.
+
+* Clone or Download this repo, and in the terminal/command line, be sure you are in this directory 
+
+* Run `firebase use --add` and select your project
+
+* Run `firebase functions:config:set org.name="ORG NAME ON GITHUB" org.token="GENERATED ADMIN TOKEN"`
+
+* Enable billing for your firebase project, in the firebase console, inorder to use cloud functions at https://console.firebase.google.com/project/_/usage/details. In other words, switch from the free (spark) plan to the pay as you go (blaze) plan. Checkout the cloud functions pricing at https://firebase.google.com/pricing#cloud-functions
+
+* Run `firebase deploy`, your Github-Invite is at your `<project_id>`.web.app 
+
+## Customizing
+Feel free to customize the frontend to suit your brand's guidelines. However, avoid tampering with the parts of the code that give feedback and make the app work.
+
+## Demo
+
+![Demo of Firebase Version of GitHub Organization Invitation](../demos/node-monolith.gif)

firebase/firebase.json

@@ -0,0 +1,29 @@
+{
+  "functions": {
+    "predeploy": [
+      "npm --prefix \"$RESOURCE_DIR\" run lint"
+    ]
+  },
+  "hosting": {
+    "public": "public",
+    "ignore": [
+      "firebase.json",
+      "**/.*",
+      "**/node_modules/**"
+    ],
+    "rewrites": [
+      {
+        "source": "/org",
+        "function": "app"
+      },
+      {
+        "source": "/invite",
+        "function": "app"
+      },
+      {
+        "source": "**",
+        "destination": "/index.html"
+      }
+    ]
+  }
+}

firebase/functions/.eslintrc.json

@@ -0,0 +1,123 @@
+{
+  "parserOptions": {
+    // Required for certain syntax usages
+    "ecmaVersion": 2017
+  },
+  "plugins": [
+    "promise"
+  ],
+  "extends": "eslint:recommended",
+  "rules": {
+    // Removed rule "disallow the use of console" from recommended eslint rules
+    "no-console": "off",
+
+    // Removed rule "disallow multiple spaces in regular expressions" from recommended eslint rules
+    "no-regex-spaces": "off",
+
+    // Removed rule "disallow the use of debugger" from recommended eslint rules
+    "no-debugger": "off",
+
+    // Removed rule "disallow unused variables" from recommended eslint rules
+    "no-unused-vars": "off",
+
+    // Removed rule "disallow mixed spaces and tabs for indentation" from recommended eslint rules
+    "no-mixed-spaces-and-tabs": "off",
+
+    // Removed rule "disallow the use of undeclared variables unless mentioned in /*global */ comments" from recommended eslint rules
+    "no-undef": "off",
+
+    // Warn against template literal placeholder syntax in regular strings
+    "no-template-curly-in-string": 1,
+
+    // Warn if return statements do not either always or never specify values
+    "consistent-return": 1,
+
+    // Warn if no return statements in callbacks of array methods
+    "array-callback-return": 1,
+
+    // Require the use of === and !==
+    "eqeqeq": 2,
+
+    // Disallow the use of alert, confirm, and prompt
+    "no-alert": 2,
+
+    // Disallow the use of arguments.caller or arguments.callee
+    "no-caller": 2,
+
+    // Disallow null comparisons without type-checking operators
+    "no-eq-null": 2,
+
+    // Disallow the use of eval()
+    "no-eval": 2,
+
+    // Warn against extending native types
+    "no-extend-native": 1,
+
+    // Warn against unnecessary calls to .bind()
+    "no-extra-bind": 1,
+
+    // Warn against unnecessary labels    
+    "no-extra-label": 1,
+
+    // Disallow leading or trailing decimal points in numeric literals
+    "no-floating-decimal": 2,
+
+    // Warn against shorthand type conversions
+    "no-implicit-coercion": 1,
+
+    // Warn against function declarations and expressions inside loop statements
+    "no-loop-func": 1,
+
+    // Disallow new operators with the Function object
+    "no-new-func": 2,
+
+    // Warn against new operators with the String, Number, and Boolean objects
+    "no-new-wrappers": 1,
+
+    // Disallow throwing literals as exceptions
+    "no-throw-literal": 2,
+
+    // Require using Error objects as Promise rejection reasons
+    "prefer-promise-reject-errors": 2,
+
+    // Enforce “for” loop update clause moving the counter in the right direction
+    "for-direction": 2,
+
+    // Enforce return statements in getters
+    "getter-return": 2,
+
+    // Disallow await inside of loops
+    "no-await-in-loop": 2,
+
+    // Disallow comparing against -0
+    "no-compare-neg-zero": 2,
+
+    // Warn against catch clause parameters from shadowing variables in the outer scope
+    "no-catch-shadow": 1,
+
+    // Disallow identifiers from shadowing restricted names
+    "no-shadow-restricted-names": 2,
+
+    // Enforce return statements in callbacks of array methods
+    "callback-return": 2,
+
+    // Require error handling in callbacks
+    "handle-callback-err": 2,
+
+    // Warn against string concatenation with __dirname and __filename
+    "no-path-concat": 1,
+
+    // Prefer using arrow functions for callbacks
+    "prefer-arrow-callback": 1,
+
+    // Return inside each then() to create readable and reusable Promise chains.
+    // Forces developers to return console logs and http calls in promises. 
+    "promise/always-return": 2,
+
+    //Enforces the use of catch() on un-returned promises
+    "promise/catch-or-return": 2,
+
+    // Warn against nested then() or catch() statements
+    "promise/no-nesting": 1
+  }
+}

firebase/functions/.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+.runtimeconfig.json

firebase/functions/index.js

@@ -0,0 +1,87 @@
+const functions = require('firebase-functions');
+const express = require('express');
+const app = express();
+const fetch = require('node-fetch');
+const host = 'https://api.github.com';
+
+app.get('/org', (req, res) => {
+  try {
+    res.status(200).send(functions.config().org.name);
+  } catch (error) {
+    res.status(500).end();
+  }
+});
+
+app.post('/invite', async (req, res) => {
+  try {
+    // check if github account exists with the given username, if no return that the username is invalid
+    const user = await fetch(
+      `${host}/users/${req.body.username}`
+    ).then((response) => response.json());
+
+    if (!user.id)
+      return res.status(401).json({
+        status: false,
+        message: 'Invalid Username',
+        body: `GitHub user with username: ${req.body.username} not found. Please check username's spelling or create GitHub account with that username. Thank you.`,
+      });
+
+    // ensure that GitHub organization exists else return
+    const organization = await fetch(
+      `${host}/orgs/${functions.config().org.name}`
+    ).then((response) => response.json());
+
+    if (!organization.id)
+      return res.status(401).json({
+        status: false,
+        message: 'Server Error',
+        body: `GitHub organization with name: ${functions.config().org.name} not found.`,
+      });
+
+    // invite user
+    return fetch(`${host}/orgs/${functions.config().org.name}/invitations`, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        Accept: 'application/json',
+        Authorization: `token ${functions.config().org.token}`,
+      },
+      body: `{"invitee_id":${user.id}}`,
+    }).then((response) => {
+      // respond apprioprately
+      if (response.status === 201) {
+        return res.status(201).json({
+          status: true,
+          message: 'Successfully Invited',
+          body: `Dear ${req.body.username},<br>Kindly check your inbox and accept the invitation that has been sent to you.<br>Thank you!`,
+        });
+      } else {
+        return response.json().then((data) => {
+          let messages = [data.message];
+          if (data.errors) {
+            for (let error of data.errors) {
+              messages.push(error.message);
+            }
+          }
+          return res.status(401).json({
+            status: false,
+            message: response.statusText,
+            body: messages.join('<br>'),
+          });
+        });
+      }
+    });
+  } catch (error) {
+    return res.status(500).json({
+      status: false,
+      message: 'An Error Occured',
+      body: error.toString(),
+    });
+  }
+});
+
+app.use('*', (req, res) => {
+  res.redirect('/');
+});
+
+exports.app = functions.https.onRequest(app);