wishlists

Wishlists Team for Devops_2018_Spring

Prerequisite Installation using Vagrant

The first step is to install VirtualBox and Vagrant:

Download VirtualBox

Download Vagrant

Testing code

To test the code, it is easiest to use Vagrant.

Clone the project to your development folder and create your Vagrant vm

$ git clone https://github.com/Devops-Wishlists/wishlists.git
$ cd wishlists
$ vagrant up
$ vagrant ssh
$ cd /vagrant
$ nosetests

The test suite 'nosetests' tests the multiple functionalities offered by the service, which are listed below. For furthur information on the tests, type the following command

$ coverage report -m

The service can be started and used with the following command

$ python server.py

The service will be located on "http://localhost:5000"

When you are done, you can use Ctrl+C to stop the server and then exit and shut down the vm with:

$ exit
$ vagrant halt

Available calls

The following REST calls are supported by this service

• CREATE - Take the JSON and creates a wishlist
  • POST http://localhost:5000/wishlists
• CREATE - Add an item to a wishlist
  • POST http://localhost:5000/wishlists/{wishlist_id}/items
• GET - Retrieve the details of a specific wishlist
  • GET http://localhost:5000/wishlists/{wishlist_id}
• GET - Retrieve the details of an specific item
  • GET http://localhost:5000/items/{item_id}
• LIST - All wishlists in the system:
  • GET http://localhost:5000/wishlists
• LIST - Items from a specified wishlist:
  • GET http://localhost:5000/wishlists/{wishlist_id}/items
• DELETE - Delete a wishlist and its items:
  • DELETE http://localhost:5000/wishlists/{wishlist_id}
• DELETE - Delete an item from a wishlist
  • DELETE http://localhost:5000/wishlists/{wishlist_id}/items/{item_id}
• PUT - Update a wishlist:
  • PUT http://localhost:5000/wishlists/{wishlist_id}
• PUT - Update an item from a wishlist:
  • PUT http://localhost:5000/wishlists/{wishlist_id}/items/{item_id}
• GET - Read an item description:
  • GET http://localhost:5000/wishlists/{wishlist_id}/items/{item_id}/description
• ACTION - Clear all items from a wishlist:
  • PUT http://localhost:5000/wishlists/{wishlist_id}/clear
• QUERY - Query for a wishlist based on its name:
  • GET http://localhost:5000/wishlists?keyword=<value>
• QUERY - Query for a wishlist based on its customer_id:
  • GET http://localhost:5000/wishlists?customer_id=<value>