CoffeShop Locations REST API service

This project is to create a REST API services for loading coffeeshop location CSV file (id, name, address, latitude, longitude) and support CRUD operations and find nearest coffee shop location given a valid address

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them Java 1.8+ Apache Maven 3.3.3 Rest API Client (example: Google Chrome Browser extention Postman) or curl utility installed

Download JDK from Oracle website http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html

Installing

Follow the instructions to download source code, compile and run

The packaged jar file is self executable jar file, with all dependencies

git clone 
mvn clean package or mvnw clean package
java  -jar target/coffeeshop-service-0.0.1-SNAPSHOT.jar --apikey=provide google geocode apikey  --csvfile=full path of locations.csv

The Tomcat webserver runs on port 8080.

Running the tests

To test the webserver is up and running, run the following test.

curl -XGET http://localhost:8080/hello

if you get a response, the installation is complete.

To read loadded coffee shop with id=1 use the command: curl -XGET http://localhost:8080/CoffeeShop/1

To create new coffee shop location use the command: curl -H "Content-Type: application/json" -X POST "http://localhost:8080/CoffeeShop/" -d '{ "name": "My favourite Coffee Shop", "address": "San Francisco, CA","latitude":37.7749295,"longitude":-122.4194155 }'

Note the response {"id":"57"} for next command.

To update the above coffee shop location name use the command: curl -H "Content-Type: application/json" -XPUT "http://localhost:8080/CoffeeShop/57" -d '{ "name": "The best Coffee Shop", "address": "San Francisco, CA","latitude":37.7749295,"longitude":-122.4194155 }'

Observe the te name attribue has been modified in the output.

To delete the above Coffe Shop use the command: curl -H "Content-Type: application/json" -XDELETE "http://localhost:8080/CoffeeShop/57"

Observe the response {"status":"success"}

To find the nearest Coffee Shop by providing address use the command: curl -G "http://localhost:8080/CoffeeShop/FindNearest" --data-urlencode "address=535 Mission St., San Francisco, CA"

Observe the output {"name":"Red Door Coffee"}

Built With

• Eclipse - The IDE used
• Maven - Dependency Management
• Google - Google Geo Coding Api

Authors

• ** Kishan Rao Verukonda** - Initial work

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• Inspiration
• etc