Wishlists Microservice

The wishlists resource allows customers to create a collection of products that they wish they had the money to purchase. A customer might have multiple wishlists so they might want to name them for easy identification.

LIVE URL

(urls below do not currently work since we have revoked the ibm cloud membership)

• App         - https://nyu-wishlist-service-f20.us-south.cf.appdomain.cloud
• Dev          - https://nyu-wishlist-service-f20-dev.us-south.cf.appdomain.cloud
• Swagger docs prod - http://nyu-wishlist-service-f20.us-south.cf.appdomain.cloud/apidocs/index.html
• Swagger docs dev   - http://nyu-wishlist-service-f20-dev.us-south.cf.appdomain.cloud/apidocs/index.html

Prerequisite Installation using Vagrant VM

The easiest way to use this lab is with Vagrant and VirtualBox. if you don't have these software, then the first step is to download and install them.

Download VirtualBox

Download Vagrant

Then all you have to do is to clone this repo and invoke vagrant:

git clone https://github.com/wishlists/wishlists
cd wishlists
vagrant up
vagrant ssh
cd /vagrant

You can run the code to test it out in your browser with the following command:

honcho start

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

Features supported

GET /wishlists - Return all the wishlists

GET /wishlists/{wishlist_id} - Return the wishlists with the given id

POST /wishlists - Create a new wishlist record in the database

PUT /wishlists/{wishlist_id} - Update a wishlist record in the database

DELETE /wishlists/{wishlist_id} - Delete a wishlist record in the database

GET /wishlists?name=wishlist_1 - Query the database by the name of the wishlist

GET /wishlists?user_id=1 - Query the database by the user id of the wishlist

PUT /wishlists/{wishlist_id}/disabled - It disables the target wishlist

PUT /wishlists/{wishlist_id}/enabled - It enables the target wishlist

POST /wishlists/{wishlist_id}/items - Add item into target wishlist

GET /wishlists/{wishlist_id}/items/{item_id} - Get item by its id from target wishlist

PUT /wishlists/{wishlist_id} - Updates an existing wishlist

DELETE /wishlists/{wishlist_id}/items/{item_id} - Delete item by its id from target wishlist

Manually running the Tests

You can now run behave and nosetests to run the BDD and TDD tests respectively.

Run the tests using nose

    $ nosetests

Nose is configured via the included setup.cfg file to automatically include the flags --with-spec --spec-color so that red-green-refactor is meaningful. If you are in a command shell that supports colors, passing tests will be green while failing tests will be red.

Nose is also configured to automatically run the coverage tool and you should see a percentage of coverage report at the end of your tests. If you want to see what lines of code were not tested use:

    $ coverage report -m

This is particularly useful because it reports the line numbers for the code that is not covered so that you can write more test cases to get higher code coverage.

You can also manually run nosetests with coverage (but setup.cfg does this already)

    $ nosetests --with-coverage --cover-package=service

Run the tests using behave

    $ behave

Behave is configured in features directory.

Running Pylint to check PEP8

vagrant up
vagrant ssh
cd /vagrant
pylint --rcfile=pylint.conf service/*.py
pylint --rcfile=pylint.conf tests/*.py