This project is the back end of a service-oriented app that allows users to see the current weather as well as the forecasted weather at the destination.
This back-end exposes an API that satisfies a hypothetical front-end team’s requirements.
About | Developer | Goals | Getting Started | Versions | Setup | Endpoints | Examples | Tests | Acknowledgements | Extensions |
- Expose an API that aggregates data from multiple external APIs
- Expose an API that requires an authentication token
- Expose an API for CRUD functionality
- Determine completion criteria based on the needs of other developers
- Research, select, and consume an API based on your needs as a developer
Visit the endpoints on Heroku or on Local Host 3000 after completing the setup steps below.
- Ruby 2.5.3
- Rails 5.2.5
If you are running this API locally, follow the steps below:
- Fork and clone this repo
- Install gem packages by running
bundle - Setup the database:
rails db:(create) - Obtain necessary API keys:
- OpenWeather
- MapquestAPI (Click on 'join the community' to sign up and receive a key)
- Unsplash API
- No key needed for OpenLibrary
- Protect your API keys by placing them in
config/application.yml. Save under the following variable names:- OpenWeather:
weather_api_key: - Maquest:
geocode_key: - Unsplash:
access_key: - Note: key strings must not be placed inside quotes
- OpenWeather:
- Run command
rails sand navigate to http://localhost:3000 to consume API endpoints below
If you are running the API via Heroku, simply consume endpoints below.
The following are all API endpoints. Note, some endpoints have optional or required query parameters.
- All endpoints run off base connector http://localhost:3000 on local or https://joe-mecha-whether-sweater.herokuapp.com/ on Heroku
| Method | URL | Description |
|---|---|---|
GET |
/api/v1/forecast?location=denver,co |
Retrieve specified weather data for a logged in user. |
| Method | URL | Description |
|---|---|---|
GET |
/api/v1/backgrounds?location=denver,co |
Retrieve a background image for the city in the weather call. |
| Method | URL | Description |
|---|---|---|
GET |
/api/v1/book-search?location=denver,co&quantity=7 |
Retrieve a list of books for a (well-known) city. |
| Method | URL | Description |
|---|---|---|
POST |
/api/v1/users |
To be utilized by front end. Successful request adds a new user to the database. Encrypts password and replies with unique api key. |
| Method | URL | Description |
|---|---|---|
POST |
/api/v1/sessions |
To be utilized by front end. Checks user credentials and responds with API key |
| Method | URL | Description |
|---|---|---|
POST |
/api/v1/road_trip |
To be utilized by front end. Provides travel time and weather forecast at destination at ETA. |
{
"data": {
"id": null,
"type": "forecast",
"attributes": {
"current_weather": {
"datetime": "2020-09-30 13:27:03 -0600",
"temperature": 79.4,
etc
},
"daily_weather": [
{
"date": "2020-10-01",
"sunrise": "2020-10-01 06:10:43 -0600",
etc
},
{...} etc
],
"hourly_weather": [
{
"time": "14:00:00",
"conditions": "cloudy with a chance of meatballs",
etc
},
{...} etc
]
}
}
}
status: 200
body:
{
"data": {
"id": null,
"type": "image",
"attributes": {
"image": {
"image_url": "https://images.unsplash.com/photo-1619856699906-09e1f58c98b1?crop=entropy&cs=srgb&fm=jpg&ixid=MnwyMzkzMTR8MHwxfHNlYXJjaHwxfHxkZW52ZXIlMkNjb3xlbnwwfDB8fHwxNjIzNjMzNTc0&ixlib=rb-1.2.1&q=85",
"description": "Night Time Downtown Denver",
"credits": {
"author": "Ryan De Hamer",
"source": "https://unsplash.com/@rdehamer"
}
}
}
}
}
{
"data": {
"id": null,
"type": "books",
"attributes": {
"destination": "denver,co",
"forecast": {
"summary": "clear sky",
"temperature": "95 F"
},
"total_books_found": 35992,
"books": [
{
"isbn": [
"9780762507849",
"0762507845"
],
"title": "Denver, Co",
"publisher": [
"Universal Map Enterprises"
]
},
{
"isbn": [
"1427401683",
"9781427401687"
],
"title": "University of Denver Co 2007",
"publisher": [
"College Prowler"
]
},
{
"isbn": [
"9780762557363",
"0762557362"
],
"title": "Denver Co Deluxe Flip Map",
"publisher": [
"Universal Map Enterprises"
]
},
{
"isbn": [
"9780883183663",
"0883183668"
],
"title": "Photovoltaic safety, Denver, CO, 1988",
"publisher": [
"American Institute of Physics"
]
},
{
"isbn": [
"9812582622",
"9789812582621"
],
"title": "Insight Fleximap Denver, CO (Insight Fleximaps)",
"publisher": [
"American Map Corporation"
]
},
{
"isbn": [
"0738518700",
"9780738518701"
],
"title": "Five Points Neighborhood of Denver (CO)",
"publisher": [
"Arcadia Publishing (SC)"
]
},
{
"isbn": [
"0762538627",
"9780762538621"
],
"title": "Denver, Co Vicinity (City Wall Maps)",
"publisher": [
"Universal Map Enterprises"
]
}
]
}
}
}
Request
POST /api/v1/users
Content-Type: application/json
Accept: application/json
{
"email": "[email protected]",
"password": "password",
"password_confirmation": "password"
}
Response
status: 201
body:
{
"data": {
"type": "users",
"id": "1",
"attributes": {
"email": "[email protected]",
"api_key": "jgn983hy48thw9begh98h4539h4"
}
}
}
Request
POST /api/v1/sessions
Content-Type: application/json
Accept: application/json
{
"email": "[email protected]",
"password": "password"
}
Response
status: 200
body:
{
"data": {
"type": "users",
"id": "1",
"attributes": {
"email": "[email protected]",
"api_key": "jgn983hy48thw9begh98h4539h4"
}
}
}
Request
POST /api/v1/road_trip
Content-Type: application/json
Accept: application/json
body:
{
"origin": "Denver,CO",
"destination": "Grand Canyon Village,AZ",
"api_key": "jgn983hy48thw9begh98h4539h4"
}
Response
{
"data": {
"id": null,
"type": "road_trip",
"attributes": {
"start_city": "Denver, CO",
"end_city": "Grand Canyon Village, AZ",
"travel_time": "12 hours and 6 minutes",
"weather_at_eta": {
"temperature": 87.82,
"conditions": "clear sky"
}
}
}
}
Run all tests in application with bundle exec rspec. When test is complete, run open coverage to see where tests are being run and where they are not.
- Implement Rubocop for strong Ruby code styling (complete)
- Implement Brakeman to identify and fix vulnerabilities (planned)
Thank you to OpenWeather, OpenLibrary, Unsplash, and MapQuest for allowing me to use your APIs. And thanks to you for reading through this project!