Sweater Weather is a Rails API for a fictional weather & trip planning web application. It uses data from Mapquest, Open Weather and the Unsplash external API services to aggregate multiple data points to provide images based on location, forecast information for a location determined by coordinates, and a road trip which provides an ETA and weather information upon arrival to your destination.
- Ruby 2.5.3
- Rails 5.2.4.3
- Postgres
- Fork and clone this repo into a new directory.
- CD into
sweater_weather - Run
bundle installto install gem packages. - Run
rails db:setupto setup the databases. - Run
bundle exec figaro install - Add your own API keys to the
config/application.ymlfile and name them accordingly:
MAPQUEST_API_KEY: <api_key>OPEN_WEATHER_API_KEY: <api_key>UNSPLASH_API_KEY: <api_key>
-
Run Unit tests:
bundle exec rspec -
Run through the different endpoints by running your server from the console:
rails s- You can then utilize Postman to delve into all of the endpoints created in this API
Gems
rspec-rails- testing suitefactory-bot- testing object generatorfaker- generates fake data for testingpry- runtime developer consolecapybara- aids in application testing and interactionsimplecov- tracks test coverageshoulda-matchers- simplifies testing syntaxlaunchy- helper class for launching cross-platform applicationsrubocop-rails- enforces Rails best practices and coding conventionsfastjson-api- Ruby object serializer
Forecast by Location
GET /api/v1/forecast?location=city,state
This endpoint retrieves weather forecast information based on a city/state combination. It references the MapQuest Geocoding API to find longitude and latitude coordinates which is passed to the OpenWeather One Call API to return a set of current, daily and hourly forecast information. The response is in JSON format.
Response Example:
{
"data": {
"id": "null",
"type": "forecast",
"attributes": {
"current_weather": {
"datetime": "2021-01-17T16:38:59-07:00",
"sunrise": "2021-01-17T07:18:07-07:00",
"sunset": "2021-01-17T17:01:48-07:00",
"temperature": 47.61,
"feels_like": 36.88,
"humidity": 25,
"uvi": 0,
"visibility": 10000,
"conditions": "broken clouds",
"icon": "04d"
},
"daily_weather": [
{
"date": "2021-01-17",
"sunrise": "2021-01-17T07:18:07-07:00",
"sunset": "2021-01-17T17:01:48-07:00",
"max_temp": 47.61,
"min_temp": 31.01,
"conditions": "overcast clouds",
"icon": "04d"
},
{
"date": "2021-01-18",
"sunrise": "2021-01-18T07:17:38-07:00",
"sunset": "2021-01-18T17:02:55-07:00",
"max_temp": 41.85,
"min_temp": 29.14,
"conditions": "clear sky",
"icon": "01d"
},
{
"date": "2021-01-19",
"sunrise": "2021-01-19T07:17:07-07:00",
"sunset": "2021-01-19T17:04:03-07:00",
"max_temp": 35.1,
"min_temp": 27.79,
"conditions": "scattered clouds",
"icon": "03d"
},
{
"date": "2021-01-20",
"sunrise": "2021-01-20T07:16:35-07:00",
"sunset": "2021-01-20T17:05:12-07:00",
"max_temp": 51.66,
"min_temp": 32.04,
"conditions": "clear sky",
"icon": "01d"
},
{
"date": "2021-01-21",
"sunrise": "2021-01-21T07:16:00-07:00",
"sunset": "2021-01-21T17:06:21-07:00",
"max_temp": 48.07,
"min_temp": 34.93,
"conditions": "clear sky",
"icon": "01d"
}
],
"hourly_weather": [
{
"time": "16:00",
"temperature": 47.61,
"wind_speed": "4.12 mph",
"wind_direction": "↖ NW",
"conditions": "broken clouds",
"icon": "04d"
},
{
"time": "17:00",
"temperature": 45.37,
"wind_speed": "3.85 mph",
"wind_direction": "↑ N",
"conditions": "broken clouds",
"icon": "04d"
},
{
"time": "18:00",
"temperature": 43.39,
"wind_speed": "2.68 mph",
"wind_direction": "↗ NE",
"conditions": "overcast clouds",
"icon": "04n"
},
{
"time": "19:00",
"temperature": 41.76,
"wind_speed": "1.57 mph",
"wind_direction": "↓ S",
"conditions": "overcast clouds",
"icon": "04n"
},
{
"time": "20:00",
"temperature": 40.59,
"wind_speed": "2.33 mph",
"wind_direction": "↘ SE",
"conditions": "overcast clouds",
"icon": "04n"
}
]
}
}
}
Background Image by Location
GET /api/v1/backgrounds?location=city,state
This endpoint retrieves an image from the Unsplash API for the location query given. The endpoint also includes credit information for the author of the image and their website url. The response is returned in JSON format.
Response Example:
{
"data": {
"id": "null",
"type": "background",
"attributes": {
"image": {
"image_url": "https://images.unsplash.com/photo-1584289537662-27851fd5ab5b?crop=entropy&cs=srgb&fm=jpg&ixid=MXwxOTkzMzN8MHwxfHNlYXJjaHwxfHxkZW52ZXIsY298ZW58MXwwfHw&ixlib=rb-1.2.1&q=85"
},
"credit": {
"author": "Sebastian Kurpiel",
"source": [
"unsplash.com",
"Sebastian Kurpiel"
],
"author_website": "https://unsplash.com/@sebbykurps"
}
}
}
}
Create User/User Registration
POST /api/v1/users
The User Registration endpoint takes in a JSON request in the body and creates a user unless that user already exists in the database. In addition, the User model generates a unique API Key for that user and saves it along with their email address and encrypted password. The endpoint sends back that user's email address and API key in the body of the response.
Response Example:
{
"data": {
"id": "38",
"type": "user",
"attributes": {
"email": "whatever1@example.com",
"api_key": "eb7ccd1c-c4db-4bf2-890d-a16249cdb654"
}
}
}
User Login
POST /api/v1/sessions
The login endpoint is able to receive a JSON body request with an email address and password, authenticate that user, and return that user's email address and API key in the body of the response.
Response Example:
{
"data": {
"id": "15",
"type": "user",
"attributes": {
"email": "whatever@example.com",
"api_key": "14de802c-be17-49ca-9d8f-27e0a8fae00b"
}
}
}
Road Trip
POST /api/v1/road_trip
This endpoint uses a origin and destination to provide an expected time of arrival (travel_time) and the weather forecast at the destination, including its condition and temperature. The JSON body request must include an authorized API key to return a response.
Request Example:
{
"origin": "Denver,CO",
"destination": "Pueblo,CO",
"api_key": "14de802c-be17-49ca-9d8f-27e0a8fae00b"
}
Response Example:
{
"data": {
"id": "null",
"type": "roadtrip",
"attributes": {
"start_city": "Denver,CO",
"end_city": "Pueblo,CO",
"travel_time": "01 hours, 44 minutes",
"weather_at_eta": {
"conditions": "scattered clouds",
"temperature": 35.06
}
}
}
}
- Shaunda Cunningham ++
++
This project was completed at the Turing School of Design & Engineering, Backend Engineering Program during Module 3. Checkout the project page and technical requirements.
This application utilizes the following free API datasets: