maxasker / beavercoffee

Beavercoffee

Installation

Clone the project: git clone https://github.com/maxasker/Beavercoffee

Open the folder: cd Beavercoffee

Install dependencies: npm install

Start the preloaded server: gulp serve

Endpoints

• Stores
  • POST /store
  • GET /store
  • GET /store/{storeId}
• Employees
  • POST /{storeId}/employees
  • GET /employees
  • GET /employees/{employeeId}
  • PUT /employees/{employeeId}
  • POST /employees/{employeeId}/comments
  • GET /employees/{employeeId}/comments
• Customers
  • POST /customer
  • GET /customer
  • GET /customer/{customerId}
  • PUT /customer/{customerId}
  • PUT /customer/{customerId}/beverages
• Products
  • POST /{storeId}/products/
  • GET /products
  • GET /products/{productId}
  • PUT /products/{productId}
• Menu
  • POST /{storeId}/menu
  • GET /{storeId}/menu
• Orders
  • POST /{storeId}/orders
  • GET /orders/{orderId}
• Reports
  • POST /report/employees
  • POST /report/orders

POST /store

Create a new store

• URL params

  None

• Data params

  Required: name

  Request body:

   {
   	"name": String,
   	"location": {
   			"street": String,
   			"city": String,
   			"country": String,
   			"zipcode": Number
   	}	
   }	

GET /store

Return all stores

• URL params

  None

• Data params

  None

GET /store/{storeId}

Return one store

• URL params

  • storeid - ID of store

• Data params

  None

POST /{storeId}/employees

Adds a new employee

• URL params

  storeId - ID of store

• Data params

  Required: current_role

  Request body:

   {
   	"current_role": String,
   	"name": String,
   	"social_security": Number,
   	"address": {
   			"street_name": String,
   			"city": String,
   			"country": String,
   			"zipcode": Number
   	},
   	"perc_fulltime": Number	
   }	

GET /employees

Returs all employees

• URL params

  None

• Data params

  None

GET /employees/{employeeId}

Returns a single employee

• URL params

  employeeId - ID of employee

• Data params

  None

PUT /employees/{employeeId}

Updates an employee

• URL params

  employeeId - ID of employee

• Data params

  Body:

      {       
              "current_role": String,
              "name": String,
              "social_security": Number,
              "address": {
                      "street_name": String,
                      "city": String,
                      "country": String,
                      "zipcode": Number
              },
              "perc_fulltime": Number
      }
      ```	

POST /employees/comments/{employeeId}

Post a comment about an employee

• URL params

  employeeId - ID of employee

• Data params

  Required: text

  Body:

   {
   	"date": Date,
   	"text": String, 
   	"author": String (employeeId)
   }	

GET /employees/comments/{employeeId}

Returns all comments about an employee

• URL params

  employeeId - ID of employee

• Data params

  None

POST /customer

Creates a new customer

• URL params

  None

• Data params

  Required: None

  Body:

   {
   	"barcode": Number,
   	"name": String, 
   	"social_security": Number,
   	"occupation": String,
   	"is_employee": Boolean,
   	"country": String,
   	"beverages": Number,
   	"address": {
                       "street_name": String,
                       "city": String,
                       "country": String,
                       "zipcode": Number
               },
   	"member_since": Date
   }	

GET /customer

Returns all customers

• URL params

  None

• Data params

  None

GET /customer/{customerId}

Returns a single customer

• URL params

  customerId - ID of customer

• Data params

  None

PUT /customer/{customerId}

Updates a customer

• URL params

  customerId - ID of customer

• Data params

  Required: None

  Body:

   {
   	"barcode": Number,
   	"name": String, 
   	"social_security": Number,
   	"occupation": String,
   	"is_employee": Boolean,
   	"country": String,
   	"beverages": Number,
   	"address": {
                       "street_name": String,
                       "city": String,
                       "country": String,
                       "zipcode": Number
               },
   	"member_since": Date
   }	

PUT /customer/{customerId}/beverages

Add beverages to customer

• URL params

  customerId - ID of customer

• Data params

  Required: beverages

  Body:

   {
   	"beverages": Number
   }	

POST /{storeId}/products/

Creates a new product

• URL params

  storeId - ID of store

• Data params

  Required: None

  Body:

   {
   	"name": String, 
   	"quantity": {
                       "metric": String,
                       "total_amount": Number,
                       "pkg_amount": Number
               }
   }	

GET /products

Returns all products

• URL params

  None

• Data params

  None

GET /products/{productId}

Returns a single product

• URL params

  productId - ID of product

• Data params

  None

PUT /products/{productId}

Updates a product

• URL params

  productId - ID of product

• Data params

  Required: None

  Body:

   {
   	"name": String, 
   	"quantity": {
                       "metric": String,
                       "total_amount": Number,
                       "pkg_amount": Number
               }
   }	

POST /{storeId/menu

Creates a new menu item

• URL params

  storeId - ID of store

• Data params

  Required: None

  Body:

   {
   	"name": String,
   	"price": Number,
   	"ingredients": [{
   			"product": String, (productId)
   			"amount": Number,
   			"metric": String
   	}]
   }	

GET /{storeId}/menu

Returns all menu items in a store

• URL params

  storeId - ID of store

• Data params

  None

POST /{storeId}/orders

Creates a new order

• URL params

  storeId - ID of store

• Data params

  Required: None

  Body:

   {
   	"employeeId": String,
   	"customer_id": String,
   	"date": Date,
   	"items": [{
   		"_id": String, (menuItemId)
                      	"quantity": Number
               }]
   }	

GET /orders/{orderId}

Returns a single order

• URL params

  orderId - ID of order

• Data params

  None

POST /report/employees

Returns a list of all employees who've worked between the provided dates

• URL params

  None

• Data params

  Required: start_year, start_month, start_day, end_year, end_month, end_day

  Body:

   {
   	"start_year": Number,
   	"start_month": Number,
   	"start_day": Number,
   	"end_year": Number,
   	"end_month": Number,
   	"end_day": Number
   }	

POST /report/orders

Returns a list of all orders made between the provided dates. If an employee is provided in the request body only orders handled by that employee are returned. If one or more menu_items are provided only orders containing one or more of those items are returned. The request can not contain both menu_items and employee.

• URL params

  None

• Data params

  Required: start_year, start_month, start_day, end_year, end_month, end_day

  Body:

   {
   	"start_year": Number,
   	"start_month": Number,
   	"start_day": Number,
   	"end_year": Number,
   	"end_month": Number,
   	"end_day": Number,
   	"employee": String (employeeId),
   	"menu_items": [
   		String (menuItemId)
   	]
   }