Sweater Weather is a Rails API that provides weather forecast data, images, and estimated travel time. It consumes data from 3 external APIs (Open Weather, MapQuest, Pexels) and exposes 5 endpoints. This was a solo project from the Turing School of Software and Design.
Fork the Postman collection here to run pre-built requests and tests locally.
-
Get api keys from the folllowing providers:
-
git clone -
cd sweater_weather -
bundle -
rails db:{create, migrate} -
bundle exec figaro install -
cd configopen the application.yml file and add your API keys as environment variables:-
mapquest_api_key: 'your_key_here' -
open_weather_api: 'your_key_here' -
pexel_api_key: 'your_key_here'
-
-
rails sto start the server on localhost:3000
GET http://localhost:3000/api/v1/forecast?location=denver,co
- Get the current forecast based on a search with query parameter
location - Example response:
{
"data": {
"id": null,
"type": "forecast",
"attributes": {
"current_weather": {
"datetime": "2022-06-25T09:40:57-06:00",
"sunrise": "2022-06-25T05:33:12-06:00",
"sunset": "2022-06-25T20:31:51-06:00",
"temperature": 54.95,
"feels_like": 53.58,
"humidity": 73.0,
"uvi": 2.14,
"visibility": 10000.0,
"conditions": "overcast clouds",
"icon": "04d"
},
"daily_weather": [
{
"date": "2022-06-25T13:00:00-06:00",
"sunrise": "2022-06-25T13:00:00-06:00",
"sunset": "2022-06-25T13:00:00-06:00",
"max_temp": 72.68,
"min_temp": 54.95,
"conditions": "moderate rain",
"icon": "10d"
},
{
"date": "2022-06-26T13:00:00-06:00",
"sunrise": "2022-06-26T13:00:00-06:00",
"sunset": "2022-06-26T13:00:00-06:00",
"max_temp": 66.2,
"min_temp": 55.31,
"conditions": "light rain",
"icon": "10d"
},
{
"date": "2022-06-27T13:00:00-06:00",
"sunrise": "2022-06-27T13:00:00-06:00",
"sunset": "2022-06-27T13:00:00-06:00",
"max_temp": 86.58,
"min_temp": 58.24,
"conditions": "light rain",
"icon": "10d"
},
{
"date": "2022-06-28T13:00:00-06:00",
"sunrise": "2022-06-28T13:00:00-06:00",
"sunset": "2022-06-28T13:00:00-06:00",
"max_temp": 91.78,
"min_temp": 63.45,
"conditions": "light rain",
"icon": "10d"
},
{
"date": "2022-06-29T13:00:00-06:00",
"sunrise": "2022-06-29T13:00:00-06:00",
"sunset": "2022-06-29T13:00:00-06:00",
"max_temp": 93.42,
"min_temp": 67.84,
"conditions": "light rain",
"icon": "10d"
}
],
"hourly_weather": [
{
"time": "2022-06-25T09:00:00-06:00",
"temperature": 55.58,
"conditions": "overcast clouds",
"icon": "04d"
},
{
"time": "2022-06-25T10:00:00-06:00",
"temperature": 54.95,
"conditions": "overcast clouds",
"icon": "04d"
},
{
"time": "2022-06-25T11:00:00-06:00",
"temperature": 56.05,
"conditions": "overcast clouds",
"icon": "04d"
},
{
"time": "2022-06-25T12:00:00-06:00",
"temperature": 59.38,
"conditions": "overcast clouds",
"icon": "04d"
},
{
"time": "2022-06-25T13:00:00-06:00",
"temperature": 63.27,
"conditions": "overcast clouds",
"icon": "04d"
},
{
"time": "2022-06-25T14:00:00-06:00",
"temperature": 68.63,
"conditions": "overcast clouds",
"icon": "04d"
},
{
"time": "2022-06-25T15:00:00-06:00",
"temperature": 72.68,
"conditions": "overcast clouds",
"icon": "04d"
},
{
"time": "2022-06-25T16:00:00-06:00",
"temperature": 66.25,
"conditions": "moderate rain",
"icon": "10d"
}
]
}
}
}GET http://localhost:3000/api/v1/backgrounds?location=denver
- Get an image based on a search with query parameter
location - Example response:
{
"data": {
"type": "image",
"id": null,
"attributes": {
"image": {
"image_url": "https://images.pexels.com/photos/2706750/pexels-photo-2706750.jpeg",
"photographer": "Thomas Ward",
"photographer_url": "https://www.pexels.com/@thomasleeward"
}
}
}
}POST http://localhost:3000/api/v1/users
- Create a user and get an API key in the response. Include email, password and password_confirmation in the request body
{
"email": "[email protected]",
"password": "123",
"password_confirmation": "123"
}- Example response:
{
"data": {
"type": "users",
"id": "3",
"attributes": {
"email": "[email protected]",
"api_key": "iZUVR5WjwFZYh9lE1rl07w"
}
}
}POST http://localhost:3000/api/v1/sessions
- Log a user in and get their API key. Include email and password in the request body
{
"email": "[email protected]",
"password": "123"
}- Example response:
{
"data": {
"type": "users",
"id": "3",
"attributes": {
"email": "[email protected]",
"api_key": "iZUVR5WjwFZYh9lE1rl07w"
}
}
}POST http://localhost:3000/api/v1/road_trip
- Create a "road trip" with an origin and desitination. Include origin, destination and api_key in the request body
{
"api_key": "iZUVR5WjwFZYh9lE1rl07w",
"origin": "denver,co",
"destination": "austin,tx"
}- Example response:
{
"data": {
"id": null,
"type": "roadtrip",
"attributes": {
"start_city": "denver,co",
"end_city": "austin,tx",
"travel_time": "15:23:42",
"weather_at_eta": {
"temperature": 88.9,
"conditions": "clear sky"
}
}
}
}