Skip to content

Commit

Permalink
added method descriptors
Browse files Browse the repository at this point in the history
  • Loading branch information
@mgrist
mgrist committed Jul 19, 2022
1 parent 771e7e3 commit 7fbf8a5
Showing 1 changed file with 84 additions and 50 deletions.
134 changes: 84 additions & 50 deletions index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ let Chapter = class {
/* */
/* Return Type: promise, error message or updated member list */
/****************************************************************************/
/**
* Log client into the ACM panel to access the student chapter roster.
* @param {string} username ACM panel username
* @param {string} password ACM panel password
* @returns {string} Success or error message
*/
async login(username, password) {
// create new form data needed to log into the admin panel
const form = new FormData();
Expand Down Expand Up @@ -77,6 +83,10 @@ let Chapter = class {
/* */
/* Return Type: prmoise, message on fail, updated member list on success. */
/****************************************************************************/
/**
* Refreshes the chapter roster with most recent data.
* @returns {object[]} Updated member list as an array of object(s).
*/
async reloadMembers() {
return new Promise((resolve, reject) => {
if (!this.#loggedIn) {
Expand All @@ -103,7 +113,7 @@ let Chapter = class {
})
.finally(() => {
// parses and loads members into memberList variables
// columns: true enables array of objects
// columns property enables array of objects
this.#memberList = parse(this.#memberList, { columns: [
"memberNumber",
"firstName",
Expand Down Expand Up @@ -138,6 +148,10 @@ let Chapter = class {
/* */
/* Return Type: promise, array of objects on success, error message on fail */
/****************************************************************************/
/**
* Retrieves all members within your student chapter.
* @returns {object[]} Array of member object(s)
*/
async getAllMembers() {
return new Promise((resolve, reject) => {
if (this.#loggedIn) {
Expand All @@ -158,6 +172,11 @@ let Chapter = class {
/* */
/* Return Type: promise, object with data on success, error message on fail */
/****************************************************************************/
/**
* Retrieves member information with a specified ACM ID.
* @param {string|number} acmID ACM member ID to search for.
* @returns {object} Member object
*/
async getMemberByID(acmID) {
return new Promise ((resolve, reject) => {
if (!this.#loggedIn) {
Expand All @@ -184,6 +203,11 @@ let Chapter = class {
/* */
/* Return Type: promise, object with data on success, error message on fail */
/****************************************************************************/
/**
* Retrieves member information associated with a specified email address.
* @param {string} email Email address to search for as a string
* @returns {object} Member object
*/
async getMemberByEmail(email) {
return new Promise ((resolve, reject) => {
if (!this.#loggedIn) {
Expand All @@ -210,6 +234,11 @@ let Chapter = class {
/* */
/* Return Type: promise, member obect on success, error message on fail. */
/****************************************************************************/
/**
* Retrieves all members with a specified first name.
* @param {string} firstName First name to search for as a string
* @returns {object[]} Array of member object(s)
*/
async getMembersByFirstName(firstName) {
return new Promise((resolve, reject) => {
if (!this.#loggedIn) {
Expand Down Expand Up @@ -243,6 +272,11 @@ let Chapter = class {
/* */
/* Return Type: promise, member obect on success, error message on fail. */
/****************************************************************************/
/**
* Retrieves all members with a specified last name.
* @param {string} lastName Last name to search for as a string
* @returns {object[]} Array of member object(s)
*/
async getMembersByLastName(lastName) {
return new Promise((resolve, reject) => {
if (!this.#loggedIn) {
Expand All @@ -267,39 +301,6 @@ let Chapter = class {
});
}

/****************************************************************************/
/* getMembersByAffiliation(affiliation) method */
/* */
/* The getMembersByAffiliation() method retrieves all chapter members with */
/* the affiliation that is specified in the function argument. Must pass a */
/* string as an argument and must be logged in. */
/* */
/* Return Type: promise, member obect on success, error message on fail. */
/****************************************************************************/
async getMembersByAffiliation(affiliation) {
return new Promise((resolve, reject) => {
if (!this.#loggedIn) {
reject("ERROR: Must be logged in to fetch member data");
}
else if(!affiliation) {
reject("ERROR: Must pass an affiliation to search for.");
}
else if(typeof(affiliation) !== "string") {
reject("ERROR: Invalid data type, must pass a string.");
}
else {
let result = this.#memberList.filter(member => member.affiliation === affiliation);

if (result.length === 0) {
reject("ERROR: No members with the affiliation, \"" + affiliation + "\", were found.");
return;
}

resolve(result);
}
});
}

/****************************************************************************/
/* getMembersByType(memberType) method */
/* */
Expand All @@ -310,6 +311,12 @@ let Chapter = class {
/* */
/* Return Type: promise, member obect on success, error message on fail. */
/****************************************************************************/
/**
* Retrieves all members by a specific membership type.
* @param {string} memberType Member type as string. E.g, Chapter Member, Chair,
* Vice Chair, Treasurer, Secretary, Faculty Sponsor.
* @returns {object[]} Array of member object(s)
*/
async getMembersByType(memberType) {
return new Promise((resolve, reject) => {
if (!this.#loggedIn) {
Expand Down Expand Up @@ -341,6 +348,10 @@ let Chapter = class {
/* */
/*Return Type: promise, member object(s) on success, error message on fail */
/****************************************************************************/
/**
* Retrieves all members with an ACM subscription.
* @returns {object[]} Array of member object(s)
*/
async getActiveMembers() {
return new Promise((resolve, reject) => {
if (!this.#loggedIn) {
Expand Down Expand Up @@ -369,6 +380,10 @@ let Chapter = class {
/* */
/*Return Type: promise, member object(s) on success, error message on fail */
/****************************************************************************/
/**
* Retrieves all members not subscibed to ACM.
* @returns {object[]} Array of member object(s)
*/
async getInactiveMembers() {
return new Promise((resolve, reject) => {
if (!this.#loggedIn) {
Expand All @@ -395,8 +410,14 @@ let Chapter = class {
/* */
/* Return Type: Boolean, true if they are a member, false otherwise */
/****************************************************************************/
/**
* Determines if a member is registered with your chapter.
* @param {(string|number|object)} id A member object or an ACM ID as string/number
* @returns {boolean} Boolean
*/
isMember(id) {
if (typeof id === "object") {
if (!id) return false;
else if (typeof id === "object") {
if (id == null) return false;
id = id.memberNumber;
}
Expand All @@ -420,8 +441,14 @@ let Chapter = class {
/* */
/* Return Type: Boolean, true if they are a member, false otherwise */
/****************************************************************************/
/**
* Determines if a member has an active ACM subscription.
* @param {(string|number|object)} id A member object or an ACM ID as string/number
* @returns {boolean} Boolean
*/
isActiveMember(id) {
if (typeof id === "object") {
if (!id) return false;
else if (typeof id === "object") {
if (id == null) return false;
id = id.memberNumber;
}
Expand All @@ -444,6 +471,11 @@ let Chapter = class {
/* */
/* Return Type: Boolean, true if they are a member, false otherwise */
/****************************************************************************/
/**
* Determines if member is an officer of the chapter.
* @param {(string|number|object)} id A member object or an ACM ID as string/number
* @returns {boolean} Boolean
*/
isOfficer(id) {
if (typeof id === "object") {
if (id == null) return false;
Expand All @@ -467,6 +499,10 @@ let Chapter = class {
/* */
/* Return Type: number */
/****************************************************************************/
/**
* Returns the total number of chapter members.
* @returns {number} number
*/
chapterSize() {
return this.#memberList.length;
}
Expand All @@ -479,6 +515,10 @@ let Chapter = class {
/* */
/* Return Type: number */
/****************************************************************************/
/**
* Returns the number of chapter members suscribed to ACM.
* @returns {number} number
*/
acmSubSize() {
// if acm subscriber list hasn't been generated already
if (this.#acmSubList.length === 0) {
Expand All @@ -498,13 +538,10 @@ let Chapter = class {
}
}

/****************************************************************************/
/* inactiveSize() method */
/* */
/* gets the number of chapter members that are inactive/expired */
/* */
/* Return Type: number */
/****************************************************************************/
/**
* Returns the number of inactive/expired chapter members.
* @returns {number} number
*/
inactiveSize() {
if (this.#inactiveList.length > 0) {
return this.#inactiveList.length;
Expand All @@ -525,13 +562,10 @@ let Chapter = class {
}
}

/****************************************************************************/
/* activeSize() method */
/* */
/* gets the number of chapter members that are active/not expired */
/* */
/* Return Type: number */
/****************************************************************************/
/**
* Returns the number of active/non-expired chapter members.
* @returns {number} number
*/
activeSize() {
if (this.#activeList.length > 0) {
return this.#activeList.length;
Expand Down

0 comments on commit 7fbf8a5

Please sign in to comment.