find, add, profile commands

Author: victorzheng02

src/commandDetails/company/add.ts

@@ -0,0 +1,59 @@
+import { container } from '@sapphire/framework';
+import {
+  CodeyCommandDetails,
+  CodeyCommandOptionType,
+  SapphireMessageExecuteType,
+  SapphireMessageResponse,
+  getUserFromMessage,
+} from '../../codeyCommand';
+import { addUserToCompany, getCompanyInfo, insertCompany } from '../../components/company';
+
+const companyAddExecuteCommand: SapphireMessageExecuteType = async (
+  _client,
+  messageFromUser,
+  args,
+): Promise<SapphireMessageResponse> => {
+  const company_id = args['company_id'];
+  if (!company_id) {
+    throw new Error('please enter a valid user mention or ID for balance adjustment.');
+  }
+  const role = args['role'];
+  if (!role) {
+    throw new Error('please enter a role.');
+  }
+  const company = await getCompanyInfo(<string>company_id);
+  if (!company) {
+    await insertCompany(<string>company_id);
+  }
+  const userId = getUserFromMessage(messageFromUser).id;
+  await addUserToCompany(userId, <string>company_id, <string>role);
+  return 'Successfully added company to profile!';
+};
+
+export const companyAddCommandDetails: CodeyCommandDetails = {
+  name: 'add',
+  aliases: ['a'],
+  description: 'Add a company to your profile',
+  detailedDescription: `**Examples:**
+    \`${container.botPrefix}company add https://www.crunchbase.com/organization/microsoft\`
+    \`${container.botPrefix}company a microsoft \``,
+  messageWhenExecutingCommand: 'Adding...',
+  executeCommand: companyAddExecuteCommand,
+
+  options: [
+    {
+      name: 'company_id',
+      description: `The unique identifier for the company. This can be either a link to its crunchbarse url or the company's crunchbase id,
+        which is the last part of the crunchbase url (/organization/{crunchbase_id}).`,
+      type: CodeyCommandOptionType.STRING,
+      required: true,
+    },
+    {
+      name: 'role',
+      description: `Your role at the company. For example, "Software Engineering Intern" or "Data Science Intern".`,
+      type: CodeyCommandOptionType.STRING,
+      required: true,
+    },
+  ],
+  subcommandDetails: {},
+};

src/commandDetails/company/enroll.ts

@@ -6,27 +6,21 @@ import {
   SapphireMessageResponse,
 } from '../../codeyCommand';
 import { getCompanyInfo, insertCompany } from '../../components/company';
-import { getCrunchbaseCompanyDetails } from '../../utils/companyInfo';
 
-interface CrunchbaseCompanyProperties {
-  short_description: string;
-}
 const companyEnrollExecuteCommand: SapphireMessageExecuteType = async (
-  client,
-  messageFromUser,
+  _client,
+  _messageFromUser,
   args,
 ): Promise<SapphireMessageResponse> => {
   const company_id = args['company_id'];
   if (!company_id) {
-    throw new Error('please enter a valid user mention or ID for balance adjustment.');
+    throw new Error('please enter a valid company_id.');
   }
   const getExistingCompanyInfo = await getCompanyInfo(<string>company_id);
   if (getExistingCompanyInfo) {
     return 'Company already enrolled!.';
   }
-  const crunchbaseCompanyResponse = await getCrunchbaseCompanyDetails(<string>company_id);
-  const crunchbaseCompanyInfo = crunchbaseCompanyResponse.properties as CrunchbaseCompanyProperties;
-  await insertCompany(<string>company_id, crunchbaseCompanyInfo.short_description);
+  await insertCompany(<string>company_id);
   return 'Company succesfully enrolled!';
 };
 

src/commandDetails/company/find.ts

@@ -0,0 +1,56 @@
+import { container } from '@sapphire/framework';
+import {
+  CodeyCommandDetails,
+  CodeyCommandOptionType,
+  SapphireMessageExecuteType,
+  SapphireMessageResponse,
+} from '../../codeyCommand';
+import { getEmployeesByCompanyId } from '../../components/company';
+
+const CRUNCHBASE_IMAGE_CDN =
+  'https://res.cloudinary.com/crunchbase-production/image/upload/c_lpad,h_170,w_170,f_auto,b_white,q_auto:eco,dpr_1';
+const companyFindExecuteCommand: SapphireMessageExecuteType = async (
+  client,
+  _messageFromUser,
+  args,
+): Promise<SapphireMessageResponse> => {
+  const company_id = args['company_id'];
+  if (!company_id) {
+    throw new Error('please enter a valid user mention or ID for balance adjustment.');
+  }
+  const companyUsers = await getEmployeesByCompanyId(<string>company_id);
+  if (!companyUsers) {
+    return 'No one works at this company in the server!';
+  }
+  const formattedUsers = await Promise.all(
+    companyUsers.map(async (user) => {
+      return {
+        ...user,
+        tag: (await client.users.fetch(user.user_id)).tag,
+      };
+    }),
+  );
+  return `employees are: ${JSON.stringify(formattedUsers)}`;
+};
+
+export const companyFindCommandDetails: CodeyCommandDetails = {
+  name: 'find',
+  aliases: ['f'],
+  description: 'Find all individuals that work at the company.',
+  detailedDescription: `**Examples:**
+    \`${container.botPrefix}company find https://www.crunchbase.com/organization/microsoft\`
+    \`${container.botPrefix}company f microsoft\``,
+  messageWhenExecutingCommand: 'Enrolling company...',
+  executeCommand: companyFindExecuteCommand,
+
+  options: [
+    {
+      name: 'company_id',
+      description: `The unique identifier for the company. This can be either a link to its crunchbarse url or the company's crunchbase id,
+        which is the last part of the crunchbase url (/organization/{crunchbase_id}).`,
+      type: CodeyCommandOptionType.STRING,
+      required: true,
+    },
+  ],
+  subcommandDetails: {},
+};

src/commandDetails/company/profile.ts

@@ -0,0 +1,33 @@
+import { container } from '@sapphire/framework';
+import {
+  CodeyCommandDetails,
+  CodeyCommandOptionType,
+  SapphireMessageExecuteType,
+  SapphireMessageResponse,
+  getUserFromMessage,
+} from '../../codeyCommand';
+import { getCompaniesByUserId, getEmployeesByCompanyId } from '../../components/company';
+
+const companyProfileExecuteCommand: SapphireMessageExecuteType = async (
+  client,
+  messageFromUser,
+  args,
+): Promise<SapphireMessageResponse> => {
+  const user = getUserFromMessage(messageFromUser);
+  const companies = await getCompaniesByUserId(user.id);
+  console.log(companies);
+  return `your companies are: ${JSON.stringify(companies)}`;
+};
+
+export const companyProfileCommandDetails: CodeyCommandDetails = {
+  name: 'profile',
+  aliases: ['p'],
+  description: 'List all the companies you are associated with',
+  detailedDescription: `**Examples:**
+    \`${container.botPrefix}company profile\`
+    \`${container.botPrefix}company p\``,
+  messageWhenExecutingCommand: 'Finding...',
+  executeCommand: companyProfileExecuteCommand,
+  options: [],
+  subcommandDetails: {},
+};

src/commands/company/company.ts

@@ -1,6 +1,9 @@
 import { Command, container } from '@sapphire/framework';
 import { CodeyCommand, CodeyCommandDetails } from '../../codeyCommand';
 import { companyEnrollCommandDetails } from '../../commandDetails/company/enroll';
+import { companyAddCommandDetails } from '../../commandDetails/company/add';
+import { companyFindCommandDetails } from '../../commandDetails/company/find';
+import { companyProfileCommandDetails } from '../../commandDetails/company/profile';
 
 const companyCommandDetails: CodeyCommandDetails = {
   name: 'company',
@@ -12,6 +15,9 @@ const companyCommandDetails: CodeyCommandDetails = {
   options: [],
   subcommandDetails: {
     enroll: companyEnrollCommandDetails,
+    add: companyAddCommandDetails,
+    find: companyFindCommandDetails,
+    profile: companyProfileCommandDetails,
   },
 };
 

src/components/company.ts

@@ -1,32 +1,68 @@
 import _ from 'lodash';
 import { openDB } from './db';
+import { getCrunchbaseCompanyDetails } from '../utils/companyInfo';
 
 interface CompanyInfo {
   company_id: string;
   description: string;
 }
 
-export const insertCompany = async (companyId: string, description: string): Promise<void> => {
+interface CrunchbaseCompanyProperties {
+  name: string;
+  short_description: string;
+  image_id: string;
+}
+
+export const insertCompany = async (companyId: string): Promise<void> => {
+  const crunchbaseCompanyResponse = await getCrunchbaseCompanyDetails(<string>companyId);
+  const { name, short_description } = crunchbaseCompanyResponse;
+  const companyImageId = crunchbaseCompanyResponse.identifier?.image_id;
+  const crunchbaseCompanyInfo = {
+    name,
+    short_description,
+    image_id: <string>companyImageId,
+  };
+  await insertCompanyDetails(<string>companyId, crunchbaseCompanyInfo);
+};
+
+export const insertCompanyDetails = async (
+  companyId: string,
+  crunchbaseCompanyInfo: CrunchbaseCompanyProperties,
+): Promise<void> => {
   const db = await openDB();
-  const insertCompanyCommand = `INSERT INTO companies (company_id, description) VALUES (?,?)`;
-  await db.run(insertCompanyCommand, companyId, description);
+  const { name, image_id, short_description } = crunchbaseCompanyInfo;
+  const insertCompanyCommand = `INSERT INTO companies (company_id, name, image_id, description) VALUES (?,?,?)`;
+  await db.run(insertCompanyCommand, companyId, name, image_id, short_description);
+};
+
+export const addUserToCompany = async (
+  userId: string,
+  companyId: string,
+  role: string,
+): Promise<void> => {
+  const db = await openDB();
+  const insertCompanyCommand = `INSERT INTO companies_people (user_id, company_id, role) VALUES (?,?,?)`;
+  await db.run(insertCompanyCommand, userId, companyId, role);
 };
 
 export const getCompanyInfo = async (companyId: string): Promise<CompanyInfo> => {
   const db = await openDB();
   return (await db.get('SELECT * FROM companies WHERE company_id = ?', companyId)) as CompanyInfo;
 };
 
-export const getCompaniesByUserId = async (userId: string): Promise<string[]> => {
+export const getCompaniesByUserId = async (userId: string): Promise<CompanyPersonDetails[]> => {
   const db = await openDB();
-
-  const res = await db.all('SELECT company_id FROM people_companies WHERE user_id = ?', userId);
-  return res.map((row) => row.company_id);
+  return await db.all('SELECT * FROM companies_people WHERE user_id = ?', userId);
 };
 
-export const getUsersByCompanyId = async (companyId: string): Promise<string[]> => {
-  const db = await openDB();
+interface CompanyPersonDetails {
+  user_id: string;
+  role: string;
+}
 
-  const res = await db.all('SELECT user_id FROM people_companies WHERE company_id = ?', companyId);
-  return res.map((row) => row.user_id);
+export const getEmployeesByCompanyId = async (
+  companyId: string,
+): Promise<CompanyPersonDetails[]> => {
+  const db = await openDB();
+  return await db.all('SELECT * FROM companies_people WHERE company_id = ?', companyId);
 };

src/components/db.ts

@@ -188,20 +188,21 @@ const initCompaniesTable = async (db: Database): Promise<void> => {
     `
     CREATE TABLE IF NOT EXISTS companies (
       company_id VARCHAR(30) PRIMARY KEY NOT NULL,
+      name VARCHAR(64) NOT NULL,
+      image_id TEXT,
       description TEXT
       )`,
   );
 };
 
 const initPeopleCompaniesTable = async (db: Database): Promise<void> => {
-  await db.run(
-    `
+  await db.run(`
     CREATE TABLE IF NOT EXISTS companies_people (
       user_id VARCHAR(255) NOT NULL,
-      company_id VARCHAR(30) NOT NULL,
+      company_id VARCHAR(32) NOT NULL,
+      role VARCHAR(64) NOT NULL,
       FOREIGN KEY(company_id) REFERENCES companies(company_id)
-      )`,
-  );
+      )`);
 };
 
 const initTables = async (db: Database): Promise<void> => {

src/utils/companyInfo.ts

@@ -7,11 +7,18 @@ const CRUNCHBASE_ORGANIZATION_API_URL = 'https://api.crunchbase.com/api/v4/entit
 
 // fields to return from the API. See https://app.swaggerhub.com/apis-docs/Crunchbase/crunchbase-enterprise_api/1.0.3#/Entity/get_entities_organizations__entity_id_ for details
 // NOTE: was unable to add website and categories, seems like the api is a bit broken
-const fields = ['short_description'];
+const fields = ['name', 'short_description'];
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
+
+interface CrunchbaesCompanyDetails {
+  short_description: string;
+  name: string;
+  identifier: Record<string, unknown>;
+}
+
 export const getCrunchbaseCompanyDetails = async (
   companyCrunchbaseLink: string,
-): Promise<Record<string, unknown>> => {
+): Promise<CrunchbaesCompanyDetails> => {
   // check if url contains crunchbase.com/organization
   // if not, throw error
   if (
@@ -46,5 +53,5 @@ export const getCrunchbaseCompanyDetails = async (
     throw new CodeyUserError(undefined, data.error);
   }
 
-  return data;
+  return data.properties;
 };