feat: replace refs of Classy with GoFundMe Pro

Author: rosborn-gfm

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Classy
+Copyright (c) 2024 GoFundMe Pro
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,11 +1,11 @@
 # Custom Progress Bar Sample App
 
-This is a sample application that demonstrates how to create a custom progress bar with your Classy data. It should be used purely as instructional material rather than a production-ready application.
+This is a sample application that demonstrates how to create a custom progress bar with your GoFundMe Pro data. It should be used purely as instructional material rather than a production-ready application.
 
-Please refer to Classy's [developer documentation](https://developers.classy.org/overview/welcome) for more information about how to work with our product.
+Please refer to GoFundMe Pro's [developer documentation](https://developers.classy.org/overview/welcome) for more information about how to work with our product.
 
 This application shell makes use of a
-[Node backend layer](https://nodejs.org/en) to handle requests between the application and Classy's API as well as a [React frontend](https://react.dev/) to create a Client for the data retrieved from the customer's Classy account.
+[Node backend layer](https://nodejs.org/en) to handle requests between the application and GoFundMe Pro's API as well as a [React frontend](https://react.dev/) to create a Client for the data retrieved from the customer's GoFundMe Pro account.
 
 You can find the backend layer in the `/backend` folder (and setup instructions [here](/backend/README.md)) and the frontend part of the application in the `/frontend` folder (and setup instructions [here](/frontend/README.md)).
 

backend/.env.template

@@ -1,7 +1,7 @@
 # Environment Configuration
-NODE_ENV="development"                          # Options: 'development', 'production'
-PORT="8080"                                     # The port your server will listen on
-HOST="localhost"                                # Hostname for the server
-CLASSY_API_BASE_URL="https://api.classy.org"    # Base URL for the Classy API
-CLASSY_CLIENT_ID=""                             # Your Classy app client ID
-CLASSY_CLIENT_SECRET=""                         # Your Classy app client Secret
+NODE_ENV="development"                                  # Options: 'development', 'production'
+PORT="8080"                                             # The port your server will listen on
+HOST="localhost"                                        # Hostname for the server
+GO_FUND_ME_PRO_API_BASE_URL="https://api.classy.org"    # Base URL for the GoFundMe Pro API
+GO_FUND_ME_PRO_CLIENT_ID=""                             # Your GoFundMe Pro app client ID
+GO_FUND_ME_PRO_CLIENT_SECRET=""                         # Your GoFundMe Pro app client Secret

backend/README.md

@@ -1,8 +1,8 @@
-# Classy Progress Bar Sample App
+# GoFundMe Pro Progress Bar Sample App
 
-Sample NodeJS/Express backend to provide a REST API to query the fundraising progress of a Classy campaign.
+Sample NodeJS/Express backend to provide a REST API to query the fundraising progress of a GoFundMe Pro campaign.
 
-This project is meant to be a simple example of how to connect to the Classy API, consume information about campaigns and expose it through a REST API. It is not meant to be a full-fledged application, nor to be used in production as-is.
+This project is meant to be a simple example of how to connect to the GoFundMe Pro API, consume information about campaigns and expose it through a REST API. It is not meant to be a full-fledged application, nor to be used in production as-is.
 
 ## Getting Started
 
@@ -14,13 +14,13 @@ This project is meant to be a simple example of how to connect to the Classy API
 
 1. Clone the repository
 2. Install dependencies: `npm install`
-3. Copy the `.env.template` file to `.env` and update environment variables as needed. In particular, ensure that `CLASSY_CLIENT_ID` and `CLASSY_CLIENT_SECRET` are set. You can obtain these by creating a new application in the [Classy Developer Portal](https://developer.classy.org/).
+3. Copy the `.env.template` file to `.env` and update environment variables as needed. In particular, ensure that `GO_FUND_ME_PRO_CLIENT_ID` and `GO_FUND_ME_PRO_CLIENT_SECRET` are set. You can obtain these by creating a new application in the [GoFundMe Pro Developer Portal](https://developers.classy.org/).
 4. Start the development server: `npm run dev`
 
 ## Project description
 
-This project is meant as an example of how to consume the Classy APIs.
-It provides a simple REST API with a single endpoint `/campaigns/:id` that returns the fundraising progress of a Classy campaign.
+This project is meant as an example of how to consume the GoFundMe Pro APIs.
+It provides a simple REST API with a single endpoint `/campaigns/:id` that returns the fundraising progress of a GoFundMe Pro campaign.
 
 This project can be consumed directly, via an API platform like [Postman](https://www.postman.com/) or through our sample [frontend](../frontend/README.md) project.
 
@@ -29,8 +29,8 @@ This project can be consumed directly, via an API platform like [Postman](https:
 This project uses [Express](https://expressjs.com/) to create a simple REST API with two routes defined in the `src/server.ts` file:
 
 - `GET /health-check`: A simple health check endpoint that returns a 200 status code if the server is running.
-- `GET /campaigns/:campaignId/progress`: An endpoint that returns the fundraising progress of a Classy campaign.
+- `GET /campaigns/:campaignId/progress`: An endpoint that returns the fundraising progress of a GoFundMe Pro campaign.
 
 Each route group is handled by a separate router file inside the `src/api` folder.
 
-Within the `src/common/utils/classyAuth.ts` file, you will find the logic to authenticate with the Classy API using the client id and secret.
+Within the `src/common/utils/auth.ts` file, you will find the logic to authenticate with the GoFundMe Pro API using the client id and secret.

backend/package-lock.json

@@ -1,7 +1,7 @@
 {
-  "name": "classy-progress-bar-backend",
+  "name": "go-fund-me-pro-progress-bar-backend",
   "version": "1.0.0",
-  "description": "An express backend for the Classy progress bar sample app",
+  "description": "An express backend for the GoFundMe Pro progress bar sample app",
   "main": "index.ts",
   "private": true,
   "scripts": {

backend/package.json

@@ -6,20 +6,20 @@ import request from 'supertest';
 import { env } from '@/common/utils/envConfig';
 import { app } from '@/server';
 
-import { ClassyCampaignOverview } from '../campaignModel';
+import { GoFundMeProCampaignOverview } from '../campaignModel';
 
 describe('Campaign API endpoints', () => {
   describe('GET /campaigns/:campaignId/progress endpoint', () => {
     const campaignId = 1234;
 
     it('success', async () => {
       const server = setupServer(
-        http.post(`${env.CLASSY_API_BASE_URL}/oauth2/auth`, () => {
+        http.post(`${env.GO_FUND_ME_PRO_API_BASE_URL}/oauth2/auth`, () => {
           return HttpResponse.json({
             access_token: '123token',
           });
         }),
-        http.get(`${env.CLASSY_API_BASE_URL}/2.0/campaigns/${campaignId}/overview`, () => {
+        http.get(`${env.GO_FUND_ME_PRO_API_BASE_URL}/2.0/campaigns/${campaignId}/overview`, () => {
           return HttpResponse.json({
             gross_amount: 120.4,
           });
@@ -29,7 +29,7 @@ describe('Campaign API endpoints', () => {
       server.listen();
 
       const response = await request(app).get(`/campaigns/${campaignId}/progress`);
-      const result: { success: true; payload: ClassyCampaignOverview } = response.body;
+      const result: { success: true; payload: GoFundMeProCampaignOverview } = response.body;
 
       expect(response.statusCode).toEqual(StatusCodes.OK);
       expect(result.success).toEqual(true);
@@ -39,11 +39,11 @@ describe('Campaign API endpoints', () => {
       server.close();
     });
 
-    it('Classy auth fails', async () => {
+    it('GoFundMe Pro auth fails', async () => {
       const server = setupServer(
-        http.post(`${env.CLASSY_API_BASE_URL}/oauth2/auth`, () => {
+        http.post(`${env.GO_FUND_ME_PRO_API_BASE_URL}/oauth2/auth`, () => {
           return HttpResponse.json({
-            error: 'Failed to connect to Classy',
+            error: 'Failed to connect to GoFundMe Pro',
           });
         })
       );
@@ -56,19 +56,19 @@ describe('Campaign API endpoints', () => {
       expect(response.statusCode).toEqual(StatusCodes.INTERNAL_SERVER_ERROR);
       expect(result.success).toEqual(false);
       expect(result.statusCode).toEqual(StatusCodes.INTERNAL_SERVER_ERROR);
-      expect(result.message).toEqual('The authentication with Classy failed.');
+      expect(result.message).toEqual('The authentication with GoFundMe Pro failed.');
 
       server.close();
     });
 
     it('Class campaign overview fetch fails', async () => {
       const server = setupServer(
-        http.post(`${env.CLASSY_API_BASE_URL}/oauth2/auth`, () => {
+        http.post(`${env.GO_FUND_ME_PRO_API_BASE_URL}/oauth2/auth`, () => {
           return HttpResponse.json({
             access_token: '123token',
           });
         }),
-        http.get(`${env.CLASSY_API_BASE_URL}/2.0/campaigns/${campaignId}/overview`, () => {
+        http.get(`${env.GO_FUND_ME_PRO_API_BASE_URL}/2.0/campaigns/${campaignId}/overview`, () => {
           return HttpResponse.json({
             error: 'Failed to retrieve aggregates',
           });

backend/src/api/campaign/__tests__/campaignRouter.test.ts

@@ -1,4 +1,4 @@
-export type ClassyCampaignOverview = {
+export type GoFundMeProCampaignOverview = {
   donation_net_amount: number;
   donations_amount: string;
   donors_count: number;

backend/src/api/campaign/campaignModel.ts

@@ -1,20 +1,20 @@
 import express, { Request, Response, Router } from 'express';
 import { StatusCodes } from 'http-status-codes';
 
-import { ClassyErrorResponse } from '@/common/types/auth';
-import { auth } from '@/common/utils/classyAuth';
+import { GoFundMeProErrorResponse } from '@/common/types/auth';
+import { auth } from '@/common/utils/auth';
 import { env } from '@/common/utils/envConfig';
 
-import { ClassyCampaignOverview } from './campaignModel';
+import { GoFundMeProCampaignOverview } from './campaignModel';
 
 const validateOverviewResponse = async (campaignId: number, response: globalThis.Response) => {
   const payload = await response.json();
 
-  if ((payload as ClassyErrorResponse)?.error) {
+  if ((payload as GoFundMeProErrorResponse)?.error) {
     throw new Error(`Failed to retrieve aggregates for campaign ${campaignId}`);
   }
 
-  return payload as ClassyCampaignOverview;
+  return payload as GoFundMeProCampaignOverview;
 };
 
 export const campaignRouter: Router = (() => {
@@ -27,12 +27,12 @@ export const campaignRouter: Router = (() => {
     try {
       const campaignId = parseInt(req.params.campaignId as string, 10);
 
-      // Get the auth token for the Classy app.
+      // Get the auth token for the GoFundMe Pro app.
       // This token should be cached in a fully fledged application, reusing it for subsequent requests while it's valid.
       const authResponse = await auth();
 
       // Get the aggregates for the campaign.
-      const overviewResponse = await fetch(`${env.CLASSY_API_BASE_URL}/2.0/campaigns/${campaignId}/overview`, {
+      const overviewResponse = await fetch(`${env.GO_FUND_ME_PRO_API_BASE_URL}/2.0/campaigns/${campaignId}/overview`, {
         method: 'GET',
         headers: {
           'Content-Type': 'application/json',

backend/src/api/campaign/campaignRouter.ts

@@ -1,8 +1,8 @@
-export type ClassyErrorResponse = {
+export type GoFundMeProErrorResponse = {
   error: string | Record<string, string[]>;
 };
 
-export type ClassyAuthResponse = {
+export type GoFundMeProAuthResponse = {
   access_token: string;
   expires_in: number;
   token_type: string;