https://github.com/mdsrosa/routes_api

API to calculate the shortest path and the cost to a given route (origin point and destination point), based on fuel price and vehicle's autonomy.
https://github.com/mdsrosa/routes_api

Last synced: 5 days ago
JSON representation

API to calculate the shortest path and the cost to a given route (origin point and destination point), based on fuel price and vehicle's autonomy.

• Host: GitHub
• URL: https://github.com/mdsrosa/routes_api
• Owner: mdsrosa
• Created: 2015-08-02T20:29:54.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-11-23T22:09:17.000Z (about 9 years ago)
• Last Synced: 2024-11-21T00:44:33.752Z (2 months ago)
• Language: Ruby
• Homepage:
• Size: 30.3 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Routes API

[![Build Status](https://travis-ci.org/mdsrosa/routes_api.svg?branch=master)](https://travis-ci.org/mdsrosa/routes_api)

API to calculate the shortest path and the cost to a given route (origin point and destination point), based on fuel price and vehicle's autonomy.

# Installation

###### **Considering you already have a ruby development environment setup.**

```bash

git clone https://bitbucket.org/mdsrosa/routes_api.git

cd routes_api

bundle install

```

### Running Locally

```bash

rackup -p 4567 -s puma

```

# Endpoints

#### GET /routes

This endpoint lists all routes in the database.

#### cURL Example

```bash

$ curl http://routes-api.herokuapp.com/routes

```

#### Response Example

```bash

[{"id":1,"origin_point":"A","destination_point":"B","distance":10},

 {"id":2,"origin_point":"A","destination_point":"C","distance":20},

 {"id":3,"origin_point":"B","destination_point":"D","distance":15},

 {"id":4,"origin_point":"C","destination_point":"D","distance":30},

 {"id":5,"origin_point":"B","destination_point":"E","distance":50},

 {"id":6,"origin_point":"D","destination_point":"E","distance":30}]

```

#### POST /routes

This endpoint creates a new route.

#### Attributes

Name            | Type | Description | Example

----------------|------|------------ |--------

**origin_point**| _string_ | The point of origin| `"A"`

**destination_point**| _string_ | The point of destination| `"D"`

**distance**| _integer_ |The vehicle's autonomy| `10`

##### cURL Example

```bash

$ curl -X POST http://routes-api.herokuapp.com/routes \

-H "Content-Type: application/json" \

-d '{"origin_point": "A", "destination_point": "D", "distance": 10}'

```

##### Response Example

```bash

{"id":1,"origin_point":"A","destination_point":"D","distance":10}

```

#### POST /routes/calculate-cost

This endpoint calculates the cost.

#### Attributes

Name            | Type | Description | Example

----------------|------|------------ |--------

**origin_point**| _string_ | The point of origin| `"A"`

**destination_point**| _string_ | The point of destination| `"D"`

**autonomy**| _integer_ |The vehicle's autonomy| `10`

**fuel_price**| _float_ |The fuel price|`2.5`

##### cURL Example

```bash

$ curl -X POST http://routes-api.herokuapp.com/routes/calculate-cost \

-H "Content-Type: application/json" \

-d '{"origin_point": "A", "destination_point": "D", "autonomy": 10, "fuel_price": 2.5}'

```

##### Response Example

```json

{"cost":6.25,"route":"A B D"}

```

# Testing

```bash

rake test

```