randalhumphries / hr_app Goto Github PK

API Controllers

API controller for the benefits of an employee

The Emergency Contact model is for the attributes that describe a person's emergency contact details.

The Demographic model is for the attributes that describe a person (i.e. date of birth, race, ethnicity, social security number, home address, contact methods, etc).

The Remuneration Type is for the attributes of an employee's remuneration type (i.e. salary or hourly, hours per pay period, etc).

The Contact Type model is for the attributes of a person's contact methods (i.e. a contact method's name).

• Data should be associated with the currently logged in user's company
• Data should be appropriate for the currently logged in user's permission level ('Admin', 'Manager')
  • Admin: see/update data for all employees/people and access 'Admin' controllers
  • Manager: can only see/update the data for the employees/people in the manager's department
• No user can update their own data

Note: This will require companies and users to be associated with people.

The Certification Type model is for the attributes of a person's certifications, licenses, and the like (i.e. a license/certification's name, effective period, etc).

The Remuneration model is for the attributes of an employee's remuneration (i.e. remuneration type, pay amount, the date the pay amount was given, the person/manager that gave or changed the pay amount).

NOTE: This model would also keep every entry for a given employee's remuneration to provide a compensation history for review purposes.

• Add and configure rspec_api_documentation gem
• Write 'request' specs using 'rspec_api_documentation' DSL
• Generate documentation

The Certification model is for the attributes of an employee's licenses/certification (i.e. license number, last renewal date, expiration date, etc).

Configure the Doorkeeper gem and token-based access.

Change the Employee associations to Person in the models listed below.

• Contacts
• Demographics

Remove Employee association from the models listed below.

• Emergency Contacts

Authentication for API

The contact model is for the attributes for employee contact details (i.e. mailing address, phone number, email, etc).

Add and configure Webpacker

The Assignment Type is for the attributes of employee assignment types (i.e. name, etc).

Create join models for person and the race and ethnicity models.

The Company Unit model is for the attributes of the company units (i.e. company unit name, company unit manager, etc).

The Address model is for the attributes of a person's physical/mailing address (i.e. street address, city, state, zip, etc).

Add and configure Devise

The Benefit model is for the attributes of an employee's benefits (i.e. 401k, healthcare, etc).

The Assignment model is for all of the attributes of a employee's work assignment (i.e. job title, date assigned the position, company unit, etc).

NOTE: This model would keep each entry for an employee's work assignment in order to provide a history of work assignments.

The 'Ethnicity' model is for the attributes of an person's ethnicity (i.e. ethnicity name, etc).

The Benefit Type model is for the attributes of employee benefit types (i.e. a benefit's name, eligible date, etc).

• Update loofah gem to latest stable release

Add and configure Doorkeeper

The Relationship Type model is for the attributes of a person's relationships (i.e. emergency contact relationship, etc).

Base controller for the v1 of the API

API controller for the certifications and licenses of an person

Base controller for the API