Job Seeker

Status

Technology Used

Node.js
- Application dependencies:
  - bcrypt
  - body-parser
  - cors
  - coveralls
  - debug
  - dotenv
  - express
  - http-errors
  - istanbul
  - jsonwebtoken
  - mongoose
  - morgan
- Developer dependencies:
  - eslint
  - faker
  - jest
  - superagent
Heroku
MongoDB & Mongoose
TravisCI
Coveralls

Schema

Routes

User

POST

Create new user with a username, email, and password.

POST /api/signup

From this POST request, user will receive the following:

{
  res.text: < token >
}

With no request body, the server will return a 400 error

GET

Log in as an existing user with a username and password.

GET /api/signin

From this GET request, user will receive the following:

{
  res.text: < token >
}

With an invalid request body, the server will return a 401 error
With an invalid username and/or password, the server will return a 500 error

Profile

POST
Create a new profile with a valid token, existing username and password, as well as the new user's name and email.

POST /api/profile

From this POST request, user will receive the following:

{
  name: 'Peter Parker',
  email: 'peter.parker@definitelynotspiderman.com',
  companies: [],
  userId: ' < userId >',
  _id: < new profileId >,
}

With no request body, the server will return a 400 error
With an invalid username and/or password, the server will return a 404 error
Without a valid token provided, the server will return a 401 error

GET

Fetch an existing user's profile with a valid token and the user's profileId.

GET /api/profile/:profileId

From this GET request, user will receive the following:

{
  name: 'Wanda Maximoff',
  email: 'wanda@avengers.com',
  companies: [],
  userId: < userId >,
  _id: < queried profileId >,
}

With an invalid profile ID, the server will return a 404 error
Without a valid token provided, the server will return a 401 error

PUT

Update an existing user's profile with a valid token and the user's profileId, as well as the user's new name and email.

PUT /api/profile/:profileId

From this PUT request, user will receive the following:

{ 
  name: 'Peter Parker',
  email: 'peter.parker@avengers.com',
  companies: [],
  userId: < userId >,
  _id: < queried profileId >,
}

With an invalid profile ID, the server will return a 404 error
Without a valid token provided, the server will return a 401 error
Without a request body, the server will return a 400 error

Company

POST

Create a new company with a valid token, profileId, companyName, and website. streetAddress, city, state, zip, phone, and companyNotes are optional.

POST /api/profile/:profileId/company

From this POST request, user will receive the following:

{
  companyName: 'Stark Industries',
  website: 'http://www.starkindustries.com',
  profileId: < profileId > ,
  userId: < userId >,
  contacts: [],
  jobPosting: [],
  events: [],
  created: '2018-03-15T17:11:41.552Z',
  _id: < companyId >,
}

With no request body, the server will return a 400 error
With an invalid request, the server will return a 404 error
Without a valid token provided, the server will return a 401 error

GET (single company)

Fetch an existing company with a valid token, the user's profileId, and a specific companyId.

GET /api/profile/:profileId/company/:companyId

From this GET request, user will receive the following:

{ 
  companyName: 'Stark Industries',
  website: 'http://www.starkindustries.com',
  profileId: < profileId > ,
  userId: < userId >,
  contacts: [],
  jobPosting: [],
  events: [],
  created: '2018-03-15T17:11:41.552Z',
  _id: < companyId >,
}

With an invalid company ID, the server will return a 404 error
Without a valid token provided, the server will return a 401 error

GET (all companies from profile)

Fetch all companies associated with a specific profile using a valid token and the user's profileId.

GET /api/profile/:profileId/company

From this GET request, user will receive the following:

{ 
  name: 'Scott Lang',
  email: 'scottlang@hotmail.com',
  companies: 
    [{ 
      companyName: 'Alias Investigations',
      website: 'http://www.aliasinvestigations.net',
      profileId: < profileId > ,
      userId: < userId >,
      contacts: [],
      jobPosting: [],
      events: [],
      created: '2018-03-15T17:34:57.866Z',
      _id: < companyId >,
    },
    {
      companyName: 'Hogarth, Chao, and Benowitz',
      website: 'https://www.hcb.com',
      profileId: < profileId > ,
      userId: < userId >,
      contacts: [],
      jobPosting: [],
      events: [],
      created: '2018-03-15T17:34:57.872Z',
      _id: < companyId >,
    }],
  userId: < userId>,
  _id: < profileId >,
}

With an invalid profile ID, the server will return a 404 error
Without a valid token provided, the server will return a 401 error

PUT

Update an existing company's information with a valid token and the user's profileId, as well as the companyId and relevant company information.

PUT /api/profile/:profileId/company/:companyId

From this PUT request, user will receive the following:

{ 
  companyName: 'Stark Industries',
  website: 'https://www.starkindustries.com/careers/',
  profileId: < profileId > ,
  userId: < userId >,
  contacts: [],
  jobPosting: [],
  events: [],
  created: '2018-03-15T17:11:41.552Z',
  _id: < companyId >,
}

With an invalid profile ID, the server will return a 404 error
Without a valid token provided, the server will return a 401 error
Without a valid request body provided, the server will return a 400 error

DELETE

Remove an existing company from the database with a valid token, the user's profileId, and the companyId.

DELETE /api/profile/:profileId/company/:companyId

User will not receive any data, but should expect a 204 status.

Job

POST

Create a new job with a valid token, profileId, companyId, title, link, status, and type. notes and tags are optional.

POST /api/profile/:profileId/company/:companyId/job

From this POST request, user will receive the following:

{ 
  title: 'Web Developer',
  link: 'http://www.nelsonandmurdoch.org',
  status: 'Submitted Application',
  type: 'Front-End',
  tags: [],
  userId: < userId >,
  profileId: < profileId >,
  companyId: < companyId >,
  created: '2018-03-15T17:59:17.369Z',
  _id: < jobId >,
}

With no request body, the server will return a 400 error
Without a valid token provided, the server will return a 401 error

GET (single job)

Fetch an existing job with a valid token, the user's profileId, a specific companyId, and a specific jobId.

GET /api/profile/:profileId/company/:companyId/job/:jobId

From this GET request, user will receive the following:

{ 
  title: 'Web Developer',
  link: 'http://www.nelsonandmurdoch.org',
  status: 'Submitted Application',
  type: 'Front-End',
  tags: [],
  userId: < userId >,
  profileId: < profileId >,
  companyId: < companyId >,
  created: '2018-03-15T17:59:17.369Z',
  _id: < jobId >,
}

With an invalid company ID, the server will return a 404 error
Without a valid token provided, the server will return a 401 error

GET (all jobs from profile)

Fetch all jobs associated with a specific profile using a valid token and the user's profileId.

GET /api/profile/:profileId/allProfileJobs

From this GET request, user will receive the following:

[{ 
    title: 'Web Developer',
    link: 'http://www.nelsonandmurdoch.org',
    status: 'Submitted Application',
    type: 'Front-End',
    tags: [],
    userId: < userId >,
    profileId: < profileId >,
    companyId: < companyId >,
    created: '2018-03-15T17:59:17.369Z',
    _id: < jobId >,
  },
  { 
    title: 'Back-End Developer',
    link: 'http://www.nelsonandmurdoch.org/careers/job1',
    status: 'Submitted Application',
    type: 'Back-End',
    tags: [],
    userId: < userId >,
    profileId: < profileId >,
    companyId: < companyId >,
    created: '2018-03-15T17:59:17.369Z',
    _id: < jobId >,
  },
  { 
    title: 'Software Engineer - React',
    link: 'http://www.nelsonandmurdoch.org/careers/job2',
    status: 'Submitted Application',
    type: 'Front-End',
    tags: [],
    userId: < userId >,
    profileId: < profileId >,
    companyId: < companyId >,
    created: '2018-03-15T17:59:17.369Z',
    _id: < jobId >,
  }]

With an invalid company ID, the server will return a 404 error
Without a valid token provided, the server will return a 401 error

GET (all jobs from single company)

Fetch all jobs associated with a specific profile and company using a valid token, the user's profileId, and the companyId.

GET: /api/profile/:profileId/company/:companyId/allCompanyJobs

From this GET request, user will receive the following:

[{ 
    title: 'Back-End Developer',
    link: 'http://www.nelsonandmurdoch.org/careers/job1',
    status: 'Submitted Application',
    type: 'Back-End',
    tags: [],
    userId: < userId >,
    profileId: < profileId >,
    companyId: < companyId >,
    created: '2018-03-15T17:59:17.369Z',
    _id: < jobId >,
  },
  { 
    title: 'Software Engineer - React',
    link: 'http://www.nelsonandmurdoch.org/careers/job2',
    status: 'Submitted Application',
    type: 'Front-End',
    tags: [],
    userId: < userId >,
    profileId: < profileId >,
    companyId: < companyId >,
    created: '2018-03-15T17:59:17.369Z',
    _id: < jobId >,
  }]

With an invalid company ID, the server will return a 404 error
Without a valid token provided, the server will return a 401 error

PUT

Update an existing job's information with a valid token,the user's profileId, the companyId, the jobId, and relevant company information.

PUT /api/profile/:profileId/company/:companyId/job/:jobId

From this PUT request, user will receive the following:

{ 
  title: 'Web Developer - React',
  link: 'http://www.nelsonandmurdoch.org',
  status: 'Evaluating Offer',
  type: 'Front-End',
  tags: [],
  userId: < userId >,
  profileId: < profileId >,
  companyId: < companyId >,
  created: '2018-03-15T17:59:17.369Z',
  _id: < jobId >,
}

With an invalid company ID, the server will return a 404 error
Without a valid token provided, the server will return a 401 error
With no request body, the server will return a 400 error

DELETE

Remove an existing company from the database with a valid token, the user's profileId, the companyId, and the jobId.

DELETE /api/profile/:profileId/company/:companyId/job/:jobId

User will not receive any data, but should expect a 204 status.

Event

POST

Create a new event with a valid token, profileId, companyId, eventType, eventTitle, and eventDate. The eventNotes field is optional.

POST /api/profile/:profileId/company/:companyId/event

From this POST request, user will recieve the following response:

{ 
  eventType: 'Interview',
  eventTitle: 'Interview with Pepper',
  eventDate: '2018-03-22T01:51:17.262Z',
  userId: < userId >,
  profileId: < profileId >,
  companyId: < companyId >,
  created: '2018-03-15T17:32:26.292Z',
  _id: < eventId >,
}

With an invalid token, the server will return a 401 error
With an invalid body, the server will return a 400 error
With an invalid request, the server will return a 404 error

GET (single event)

Fetch an existing job with a valid token, the user's profileId, a specific companyId, and a specific eventId.

GET /api/profile/:profileId/company/:companyId/event/:eventId

From this GET request, user will recieve the following response:

{ 
  eventType: 'Interview',
  eventTitle: 'Interview with Jeri',
  eventDate: '2018-03-20T01:51:17.262Z',
  userId: < userId >,
  profileId: < profileId >,
  companyId: < companyId >,
  created: '2018-03-15T17:32:26.292Z',
  _id: < eventId >,
}

With an invalid token, the server will return a 401 error
With an invalid request, the server will return a 404 error

GET (all events from profile)

Fetch all events associated with a specific profile using a valid token and the user's profileId.

GET /api/profile/:profileId/allProfileEvents

From this GET request, user will recieve the following response:

[{ 
  eventType: 'Interview',
  eventTitle: 'Interview with Karen',
  eventDate: '2018-04-22T01:51:17.262Z',
  userId: < userId >,
  profileId: < profileId >,
  companyId: < companyId >,
  created: '2018-03-15T17:32:26.292Z',
  _id: < eventId >,
}]

With an invalid token, the server will return a 401 error
With an invalid request, the server will return a 404 error

GET (all events from single company)

Fetch all events associated with a specific profile and company using a valid token, the user's profileId, and the companyId.

GET: /api/profile/:profileId/company/:companyId/allCompanyEvents

From this GET request, user will recieve the following response:

[{ 
  eventType: 'Interview',
  eventTitle: 'Interview with Foggy',
  eventDate: '2018-04-22T01:51:17.262Z',
  userId: < userId >,
  profileId: < profileId >,
  companyId: < companyId >,
  created: '2018-03-15T17:32:26.292Z',
  _id: < eventId >,
},{
  eventType: 'Interview',
  eventTitle: 'Interview with Matt',
  eventDate: '2018-04-05T01:51:17.262Z',
  userId: < userId >,
  profileId: < profileId >,
  companyId: < companyId >,
  created: '2018-03-15T17:32:26.292Z',
  _id: < eventId >,
}]

With an invalid token, the server will return a 401 error
With an invalid request, the server will return a 404 error

PUT

Update an existing event's information with a valid token,the user's profileId, the companyId, the eventId, and relevant event information.

PUT /api/profile/:profileId/company/:companyId/event/:eventId

From this PUT request, user will recieve the following response:

{
  eventType: 'Phone Interview',
  eventTitle: 'Phone call with Matt',
  eventDate: '2018-04-05T01:51:17.262Z',
  userId: < userId >,
  profileId: < profileId >,
  companyId: < companyId >,
  created: '2018-03-15T17:32:26.292Z',
  _id: < eventId >,
}

With an invalid ID, the server will return a 404 error
With an invalid token, the server will return a 401 error
With an invalid body, the server will return a 400 error

DELETE

Remove an existing event from the database with a valid token, the user's profileId, the companyId, and the eventId.

DELETE /api/profile/:profileId/company/:companyId/event/:eventId

User will not receive any data, but should expect a 204 status.

Contact

POST

Create a new contact with a valid token, profileId, companyId, name and jobTitle. email, phone, linkedIn, and notes fields are optional.

POST /api/profile/:profileId/company/:companyId/contact

From this POST request, user will recieve the following response:

{ 
  name: 'Jessica Jones',
  jobTitle: 'PI',
  email: 'jj@aliasinvestigations.net',
  userId: < userId >,
  profileId: < profileId >,
  companyId: < companyId >,
  created: '2018-03-15T17:11:19.793Z',
  _id: < contactId >,
}

With an invald token, the server will return a 401 error
Without sending a body, the server will return a 400 error
With an invalid request, the server will return a 404 error

GET (single contact)

Fetch an existing contact with a valid token, the user's profileId, a specific companyId, and a specific contactId.

GET /api/profile/:profileId/company/:companyId/contact/:contactId

From this GET request, user will recieve the following response:

{ 
  name: 'Shuri',
  jobTitle: 'Leader, Wakandan Design Group',
  email: 'shuri@wdg.com',
  userId: < userId >,
  profileId: < profileId >,
  companyId: < companyId >,
  created: '2018-03-15T17:11:19.793Z',
  _id: < contactId >,
}

With an invald token, the server will return a 401 error
With an invalid request, the server will return a 404 error

GET (all contacts from single company)

Fetch all contacts associated with a specific profile and company using a valid token, the user's profileId, and the companyId.

[{ 
  name: 'Trish Walker',
  jobTitle: 'Host, Trish Talk',
  email: 'trish@wnex.com',
  userId: < userId >,
  profileId: < profileId >,
  companyId: < companyId >,
  created: '2018-03-15T17:11:19.793Z',
  _id: < contactId >,
},
{ 
  name: 'Ricky Langtry',
  jobTitle: 'Host, The Ricky Langtry Show',
  email: 'ricky@wnex.com',
  userId: < userId >,
  profileId: < profileId >,
  companyId: < companyId >,
  created: '2018-03-15T17:11:19.793Z',
  _id: < contactId >,
}]

With an invald token, the server will return a 401 error
With an invalid request, the server will return a 404 error

PUT

Update an existing contact's information with a valid token,the user's profileId, the companyId, the contactId, and relevant contact information.

PUT /api/profile/:profileId/company/:companyId/contact/:contactId

From this PUT request, user will recieve the following response:

{ 
  name: 'Shuri',
  jobTitle: 'Leader, Wakandan Design Group',
  email: 'shuri@wdg.com',
  linkedIn: 'http://www.linkedin.com/user/1234',
  userId: < userId >,
  profileId: < profileId >,
  companyId: < companyId >,
  created: '2018-03-15T17:11:19.793Z',
  _id: < contactId >,
}

With an invald token, the server will return a 401 error
Without sending a body, the server will return a 400 error
With an invalid request, the server will return a 404 error

DELETE

Remove an existing contact from the database with a valid token, the user's profileId, the companyId, and the contactId.

DELETE /api/profile/:profileId/company/:companyId/contact/:contactId

User will not receive any data, but should expect a 204 status.

Wireframes

Contributors

Ahmed Ali

Alex Bowers __

Melanie Cohen

Christian Miller

Name		Name	Last commit message	Last commit date
Latest commit History 201 Commits
__test__		__test__
images		images
lib		lib
model		model
route		route
wireframes		wireframes
.coveralls.yml		.coveralls.yml
.eslintignore		.eslintignore
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
.travis.yml		.travis.yml
LICENSE		LICENSE
README.md		README.md
package-lock.json		package-lock.json
package.json		package.json
server.js		server.js

License

job-seeker/job-seeker-backend

Folders and files

Latest commit

History

Repository files navigation

Job Seeker

Status

Table of Contents

Technology Used

Schema

Routes

User

POST

GET

Profile

GET

PUT

Company

POST

GET (single company)

GET (all companies from profile)

PUT

DELETE

Job

POST

GET (single job)

GET (all jobs from profile)

GET (all jobs from single company)

PUT

DELETE

Event

POST

GET (single event)

GET (all events from profile)

GET (all events from single company)

PUT

DELETE

Contact

POST

GET (single contact)

GET (all contacts from single company)

PUT

DELETE

Wireframes

Contributors

About

Topics

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Contributors 3

Languages

Packages