Functional Requirements

Functional Requirements

Specification of what actions Flock will provide.

Table Of Contents

• Requirements Overview

Requirements Overview

• User
• Location
• Car
• Squad

TODO: Move permission information from specs to services

User Requirements

Fulfilled by the User Service.

• Profile
  • Create user: User Service#create
  • Get profile information: User Service#get
  • Search for users: User Service#search
  • Verify user owns provided email: User Service#sendverificationemail, User Service#verifyemail
  • Update profile information: User Service#update
  • Delete user: User Service#delete
• Login
  • Provide credentials to verify identity: User Service#auth
  • Reset credentials via email: User Service#emailpasswordresetcode, User Service#resetpassword
• Privileges
  • Internal use
    • Get user privileges
  • Admins
    • Update user privileges
    • Delete user privileges

Location Requirements

Fulfilled by the Location Service.

• Identify information
  • Anyone
    • Create location: Location Service#create
    • Get location information Location Service#get
  • Location owners
    • Update location information Location service#update
    • Delete location
• Features
  • Anyone
    • Get location feature
  • Admins
    • Allow privileged users to create & update location features
  • Location owners
    • Assign location features
    • Un-assign location features

Car Requirements

Fulfilled by the Car Service.

• Information
  • Anyone
    • Create car
    • Get information about car
  • Car owners
    • Delete car

Squad Requirements

Fulfilled by the Squad Service.

• Information
  • Anyone
    • Create squad
    • Get custom information about squad
  • Squad admins
    • Update custom information about squad
  • Squad owner
    • Delete squad
• Membership
  • Anyone
    • Get members of squad
  • Admins
    • Update members of squad
• Posts
  • Squad members
    • Create a post for a squad
    • Get information about post
  • Post owners & squad admins
    • Delete post
    • Update information about post
  • Squad members
    • Post text responses to post
• Events
  • Squad members
    • Create an event for a squad
    • Get information about event
  • Event owners & squad admins
    • Delete event
    • Update information about event
  • Help schedule an event
    • Time
      • Poll users about what times they are available
      • Compare poll results to determine a time everyone is available
    • Location
      • Poll users about what they would like to do
      • Match poll results with known locations and their capabilities
    • Rides
      • Poll users about if they need a ride or can offer a ride
      • Match users who need rides with users who offer rides based on proximity
  • Help run an event
    • Remind users when event will take place
    • Rides
      • Plot optimal route for driver to pickup passengers and arrive at event location
      • Publish car location to passengers
      • Notify passengers when they are about to be picked up
  • Squad members
    • Allow members to RSVP to events
    • Allow members to discuss an event