Android Application Development: Mandatory assignment

This text is preliminary: I might add more requirements, hints, etc.

This is the mandatory assignment for the 4th semester elective course Android Application Development.

Your solutions to this assignment must be "passed" before you can attend the 4th semester elective exam.

The case: Canteen App

Currently EASJ has 3 locations in Roskilde: Elisagårdsvej 5, Bakkesvinget 67 and Maglegårdsvej 8.

Early 2018 all programmes will be relocated to a new campus at Maglegårdsvej 2. The new campus includes an canteen.

In this assignment you must program a prototype of a canteen app.

Some user stories

The canteen app should be used by the customers (students and staff) to

• See what's on the menu
• Rate the dishes
• Order take-away (busy students and staff can order take-away for dinner)
• Login
  Customers must login before they can rate dishes or order take-away.
• Calculate your intake of energy (fat, protein and carbohydrates), minerals, vitamins, etc.
  For every dish in the canteen all these numbers have already been calculated. Your job is do add them together based on the dishes the customer ate.
• etc.

Apps for your inspiration

• Toma Kantine, for iOS, Norwegian language

The back-end: REST API

I have created a simple REST API for you application.

If you want more more methods in the REST API, please tell me - maybe I will implement the methods

REST API objects

The API currently has 4 objects

• Customer
• Dish
• Rating
• TakeAway, not implented yet

REST API methods: Customer

• GET http://anbo-canteen.azurewebsites.net/Service1.svc/customers
  returns all customers
  Password is send in clear text - not good!
• GET http://anbo-canteen.azurewebsites.net/Service1.svc/customers/2
  returns the customer with the specified id (2 in this case)
• GET http://anbo-canteen.azurewebsites.net/Service1.svc/customers/anbo@easj.dk/Secret12
  returns the customer with the specified email and password (anbo@easj.dk + Secret12 in this case)
  email is used to identify the user
• POST http://anbo-canteen.azurewebsites.net/Service1.svc/customers
  adds a new customer to the back-end.
  Example data format:
  {
  "Email": "anbo3@easj.dk",
  "Firstname": "Anders",
  "Lastname": "Borjesson",
  "Password": "secret12",
  "PictureUrl": "http://anbo-easj.dk/cv/andersBorjesson.jpg"
  }
  id is assigned by the back-end
  email must be unique

REST API Dishes

• GET http://anbo-canteen.azurewebsites.net/Service1.svc/dishes
  returns all the dishes
• GET http://anbo-canteen.azurewebsites.net/Service1.svc/dishes/2
  returns the dish with the specified id (2 in this case)

REST API Ratings

• GET http://anbo-canteen.azurewebsites.net/Service1.svc/ratings
  returns all the ratings
• GET http://anbo-canteen.azurewebsites.net/Service1.svc/ratings/customer/2
  returns the ratings by the customer with the specified id (2 in this case)
• GET http://anbo-canteen.azurewebsites.net/Service1.svc/ratings/dish/2
  return the ratings on the dish with the specified id (2 in this case)
• POST http://anbo-canteen.azurewebsites.net/Service1.svc/ratings
  add a new rating to the back-end
  Example data format
  {
  "CustomerId": 2,
  "DishId": 2,
  "Rate": 4
  }
  id and datum is assigned by the back-end.
  A customer can rate a dish at most one time per day.

REST API TakeAway

• GET http://anbo-canteen.azurewebsites.net/Service1.svc/takeaways
  returns all the TakeAway orders
• GET http://anbo-canteen.azurewebsites.net/Service1.svc/takeaways/customer/2
  returns the TakeAway orders by the specied customer (2 in this case)
• GET http://anbo-canteen.azurewebsites.net/Service1.svc/takeaways/dish/1
  returns the TakeAway orders with the specified dishId (1 in this case)
• POST http://anbo-canteen.azurewebsites.net/Service1.svc/takeaways
  add a new TakeAway to the back-end
  Example data format
  {
  "CustomerId": 1,
  "DishId": 3,
  "Howmany": 4,
  "Id": 1,
  "OrderDate": "/Date(1490100956507+0000)/",
  "PickupDateTime": "/Date(1490198400000+0000)/"
  }
  TODO: Right now the Dates are in miliseconds since January 1, 1970 [Unix birthday]. I should work out another format ...

Technical requirements

Activities

• The application must at least two (probably more) Activities
• Activities must be connected using Intents.

Screen size and density

• The application must look OK on screens of different sizes (phones and tablets) and densities.

Screen orientation

• The application must look OK in landscape and portrait orientation.
• No data is lost during change of screen orientation.

Lists

• The application must use list: ListActivity and/or ListView

Rest

• The application must use the REST API provided

Gestures

• The application must use swipe or other gestures.

SharedPreferences

• The application must use SharedPreferences to hold the users username (and password), and maybe other preferences.

Firebase

• The application must use at least one feature from Googl Firebase.

Error handling

• The application must inform the user about communication errors (exceptions), etc.
  Just ignoring exceptions is not acceptable
• The application must use logging, specially for error conditions Log.e(..., ...)

Extras

• Showing pictures
  The REST API returns some pictureUrls - references to files containing pictures.
  You can show the pictures using the Picasso API
• Fragments: Are they useful?
• MapFragment: Useful?
• Use POP 2.0 Protototyping on Paper to help you design the user interface of you application.
• Language: EASJ Roskilde has students from many contries. The app should be available in many languages.
  Supporting Different Languages
  Localizing with Resources
• more ....