Company Info Helper

config/vars.template.json

@@ -6,5 +6,6 @@
   "OFFICE_STATUS_CHANNEL_ID": "CHANNEL_ID",
   "RESUME_CHANNEL_ID": "CHANNEL_ID",
   "IRC_USER_ID": "USER_ID",
-  "MOD_USER_ID_FOR_BAN_APPEAL": "USER_ID"
+  "MOD_USER_ID_FOR_BAN_APPEAL": "USER_ID",
+  "CRUNCHBASE_API_KEY": "CRUNCHBASE_KEY"
 }

docs/SETUP.md

@@ -33,8 +33,8 @@ Then, add your bot to the Discord testing server.
 - `OFFICE_STATUS_CHANNEL_ID`: the ID of the office hours channel.
 - `IRC_USER_ID`: the user ID of the irc-bridge bot.
 - `MOD_USER_ID_FOR_BAN_APPEAL`: the user ID of the mod tagged in the appeal messages for bans.
-
-Note that this file will not be pushed to the remote.
+- `CRUNCHBASE_API_KEY`: API key if you wish to use the upcoming enroll company feature. (Create an account here)[https://www.crunchbase.com/home]. NOTE: feature is still under construction.
+  Note that this file will not be pushed to the remote.
 
 6. Make an `.env` file in the root folder of the project, and put your Discord bot's token, which can be found in the Discord Developer Portal. The format of the `.env` file should be as follows.
 

src/utils/companyInfo.ts

@@ -0,0 +1,37 @@
+import { vars } from '../config';
+import { isValidUrl } from './validateUrl';
+import fetch from 'node-fetch';
+
+const CRUNCHBASE_ORGANIZATION_URL = 'crunchbase.com/organization/';
+const CRUNCHBASE_ORGANIZATION_API_URL = 'https://api.crunchbase.com/api/v4/entities/organizations/';
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const getCompanyInfo = async (companyCrunchbaseLink: string) => {
+  // check if url contains crunchbase.com/organization
+  // if not, throw error
+  if (
+    isValidUrl(companyCrunchbaseLink) &&
+    !companyCrunchbaseLink.includes(CRUNCHBASE_ORGANIZATION_URL)
+  ) {
+    throw new Error('Invalid URL');
+  }
+
+  let companyName;
+  if (companyCrunchbaseLink.includes(CRUNCHBASE_ORGANIZATION_URL)) {
+    // grab everything after the last / character
+    companyName = companyCrunchbaseLink.split('/').pop();
+  } else {
+    // assume they just supplied the id if we can't find the CRUNCHBASE_ORGANIZATION_URL
+    companyName = companyCrunchbaseLink;
+  }
+
+  const response = await fetch(
+    `${CRUNCHBASE_ORGANIZATION_API_URL}${companyName}?user_key=${vars.CRUNCHBASE_API_KEY}&field_ids=categories,short_description`,
+  );
+  const data = await response.json();
+  if (data.error) {
+    throw new Error(data.error);
+  }
+
+  return data;
+};

src/utils/validateUrl.ts

@@ -0,0 +1,12 @@
+export const isValidUrl = (url: string): boolean => {
+  const urlPattern = new RegExp(
+    '^(https?:\\/\\/)?' + // protocol
+      '((([a-z\\d]([a-z\\d-]*[a-z\\d])*)\\.)+[a-z]{2,}|' + // domain name
+      '((\\d{1,3}\\.){3}\\d{1,3}))' + // OR ip (v4) address
+      '(\\:\\d+)?(\\/[-a-z\\d%_.~+]*)*' + // port and path
+      '(\\?[;&a-z\\d%_.~+=-]*)?' + // query string
+      '(\\#[-a-z\\d_]*)?$',
+    'i',
+  ); // fragment locator
+  return urlPattern.test(url);
+};