Giter VIP home page Giter VIP logo

fuber's Introduction

fuber

Backend APIs for on call cab service. API functionalities includes booking a cab, ending your trip, getting information about total amount earned until now and also information about which all cabs are free. While booking a cab you can also decide if you want to book a special pink cab or not. When pink cab is booked you are charged an extra 5.

Installation

Download from https://github.com/Aman1994/fuber.

Uberjar

lein ring uberjar

Running the application

lein ring server-headless

OR

java -jar target/uberjar/fuber-0.1.0-standalone.jar

The above will run the application at port 3000

Testing

lein test

API Docs

  1. For booking cabs -
Endpoint - /book-trip

Params   - It accepts params as query string. The params it accepts are - source and pink.
           source means your current location and pink means whether you want to book a pink cab or not.
           source must be a vector of latitute and longitude while pink must be a boolean.

Usage    - curl -i 'http://localhost:3000/book-trip?source=\[1,2\]&pink=true'
  1. For ending trips -
Endpoint - /end-trip

Params   - It accepts params as query string.The params it accepts are - license-num and destination.
           license-num means the license number of the cab and destination means location you want to end the trip on.
           license-num must be string while destination must be a vector of latitute and longitude.

Usage    - curl -i 'http://localhost:3000/end-trip?license-num=432abc&destination=\[1,2\]'
  1. Total amount earned by fuber -
Endpoint - /total-amount

Params   - It accepts no params

Usage    - curl -i 'http://localhost:3000/total-amount'
  1. Total available (free) cabs -
Endpoint - /available-cabs

Params   - It accepts no params

Usage    - curl -i 'http://localhost:3000/available-cabs'

License

Copyright © 2020 Aman Shah

This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version, with the GNU Classpath Exception which is available at https://www.gnu.org/software/classpath/license.html.

fuber's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.