Sweater Weather

About

Project Description You are a back-end developer working on a team that is building an application to plan road trips. This app will allow users to see the current weather as well as the forecasted weather at the destination.

Your team is working in a service-oriented architecture. The front-end will communicate with your back-end through an API. Your job is to expose that API that satisfies the front-end team’s requirements

Initial Setup

1. Fork and Clone the repo
2. Install gem packages: bundle install
3. Setup the database: rails db:create
4. Run migrations: rails db:migrate
5. Install the Figaro gem: bundle exec figaro install
6. Create an account with Open Weather Map and request an API key
7. Create an account with Map Quest API
8. Create an account with Unsplash API
9. Add your API key to the application.yml created by Figaro:

mapquest_key: your_api_key
openweather_key: your_api_key
unsplash_key: your_api_key

Important Gems

Testing

• rspec-rails
• capybara
• shoulda-matchers
• simplecov
• webmock
• vcr

API Consumption

• faraday
• figaro

Running the tests

Run bundle exec rspec to run the test suite

End Points

Forecast

• GET /api/v1/forecast

Get forcast for location PATH PARAMETERS- :location(string)- REQUIRED

Example request:

GET /api/v1/forecast?location=denver,co
Content-Type: application/json
Accept: application/json

Example response:

{
  "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
      ]
    }
  }
}

Backgrounds

• GET /api/v1/backgrounds

Get a background PATH PARAMETERS- :location(string)- REQUIRED

Example request:

GET /api/v1/backgrounds?location=denver,co
Content-Type: application/json
Accept: application/json

Example response:

{
    "data": {
        "id": null,
        "type": "background",
        "attributes": {
            "id": null,
            "location": "denver,co",
            "image_url": "https://images.unsplash.com/photo-1619856699906-09e1f58c98b1?crop=entropy&cs=tinysrgb&fit=max&fm=jpg&ixid=MnwyNTI1ODV8MHwxfHNlYXJjaHwxfHxkZW52ZXIlMkNjb3xlbnwxfHx8fDE2Mjg2NTE2MTg&ixlib=rb-1.2.1&q=80&w=1080",
            "credit": {
                "source": "unsplash.com",
                "author": "rdehamer",
                "logo": "https://images.unsplash.com/profile-1577912636161-6a3ada136470image?ixlib=rb-1.2.1&q=80&fm=jpg&crop=faces&cs=tinysrgb&fit=crop&h=64&w=64"
            }
        }
    }
}

Users

• POST /api/v1/users

Create a user

Example request:

POST /api/v1/users
Content-Type: application/json
Accept: application/json

{
  "email": "whatever@example.com",
  "password": "password",
  "password_confirmation": "password"
}

Example response:

{
  "data": {
    "type": "users",
    "id": "1",
    "attributes": {
      "email": "whatever@example.com",
      "api_key": "jgn983hy48thw9begh98h4539h4"
    }
  }
}

Sessions

• POST /api/v1/sessions

Creates a session

Example request:

POST /api/v1/sessions
Content-Type: application/json
Accept: application/json

{
  "email": "whatever@example.com",
  "password": "password"
}

Example response:

{
  "data": {
    "type": "users",
    "id": "1",
    "attributes": {
      "email": "whatever@example.com",
      "api_key": "jgn983hy48thw9begh98h4539h4"
    }
  }
}

Road Trips

• POST /api/v1/road_trip

Get a route given two locations PATH PARAMETERS- :origin(string)- REQUIRED, :destination(string)- REQUIRED

Example request:

POST /api/v1/road_trip
Content-Type: application/json
Accept: application/json

body:

{
  "origin": "Denver,CO",
  "destination": "Pueblo,CO",
  "api_key": "jgn983hy48thw9begh98h4539h4"
}

Example response:

{
  "data": {
    "id": null,
    "type": "roadtrip",
    "attributes": {
      "start_city": "Denver, CO",
      "end_city": "Estes Park, CO",
      "travel_time": "2 hours, 13 minutes"
      "weather_at_eta": {
        "temperature": 59.4,
        "conditions": "partly cloudy with a chance of meatballs"
      }
    }
  }
}

Versions

• Ruby 2.7.2

• Rails 5.2.6

Authors

• Emmy Morris - emmymorris