alanmaciel / punchout

README

Welcome to Punchout App

Problem background In your first day as developer you are consulting for a customer who owns a textile company named Textile.Co. The company has 1000 employees.

When a new employee joins Textile.Co, the employee receives a new BADGE card imprinted with a unique barcode, each employee has a different BADGE card.

Textile.Co bought a punch card machine that can send a HTTP’s JSON POST payloads to a server and wants to use it to track arrivals and departures of employees.

Working hours for employees are from 9 am to 6 pm, Monday to Friday.

## Installation instructions

• Clone the app run bundle etc. as usual.

• Run rake db:create to create the database as usual.

• Run rake db:migrate to create db tables and fields as usual.

• Run rake db:seed to seed some useful example data to the db.

• Get your server up and running using: rails s

• Open your browser in http://localhost:3000/

• To enter to the admin area the username is [e-mail] and password: 1234567890

• If you have any trouble feel free to contact me.

Features

1. Employees arriving Late

Be able to see which employees are arriving late.

Effort points: 3

Assumptions:

• This part (Employees Arriving Late) is only accessible to an registered user (admin).
• Assuming that the entries table is already loaded with data from the punchcard.
• The current period is calculated automatically using today date.
• There are not Holidays
• The workweek is from Monday to Friday

2. Employees absences

Know which employees are not coming to work at all.

Effort points: 2

Assumptions:

• This part (Employees Absences) is only accessible to an registered user (admin).
• Assuming that the entries table is already loaded with data from the punchcard.
• The current period is calculated automatically using today date.

3. Working hours report

Give each of his employees the opportunity to review their current period working hours report 3 days before the paycheck day.

Effort points: 1

Assumptions:

• The 'entries' table has the arrivals and departures in the same row.
• This report is only available the third day before the payday.

Schedules

• There is a table called 'Schedules' with the following fields:
  • 'work_starts_at' is '9:00'
  • 'works_ends_at' is '18:00'
  • 'arrival_tolerance' is '9:30'

Periods

• There is a table called 'Periods' with the following fields:
  • 'initial_date': Initial date of the period Eg: '2016-09-01'
  • 'final_date': Final date of the period Eg: '2016-09-15'
  • 'payday': Payday date Eg: '2016-09-15'
  • 'description': Descriptive text Eg: 'September first fortnight'

Entries

• There is a table called 'Entries' with the following fields:
  • 'barcode': Employee card number from his/her personal badge
  • 'arrival_at': Date and time when the employee arrived.
  • 'departure_at': Date and time when the employee leave.

Users

• There is a table called 'Users' with the following fields:
  • 'name': User full name Eg. 'Human Resources Administrator'
  • 'email': Email is used as username to make a log in Eg: '[e-mail]'
  • 'password_digest': User encrypted password