d.weather API

A weather report and weather control API.

Stack

• PostgreSQL
• Redis
• Rails 6
• Sidekiq for background processing, uses sidekiq-scheduler for recurring fetching of weather reports. As a separate container.

Local Install

• Create Dockerfile and build image.
• Create docker-compose file with container configuration.
• initialize the project (create database, run migrations and seed the database)
• Run the application (http://localhost:3000)
• Add Sidekiq container for bacground jobs

After setup, don't forget to run the seeds. (rake db:seed)

AWS EC2 Setup (just for junior positions)

• Use prebuilt AMI in ireland region (ami-02a236ee2a2c5903a)
• Deploy EC2 instance
• Run special command to start application server inside application repository (unicorn_rails -D -c config/unicorn.rb) - application server is running on localhost:8080
• Fix nginx configuration so you see the application with should be running on: http://<server-ip>/weather_reports?location=Ljubljana
• (optional) Setup https wtih rewrite on the server

External API

Uses the OpenWeatherMap API https://openweathermap.org/api

You will need to set the OPEN_WEATHER_API_KEY environment variable for it to work.

Endpoints

Fetch reports: GET /weather_reports?location=Ljubljana

[
  {
    "id": 1,
    "day": "2020-06-15",
    "hour": 9,
    "location_id": 1,
    "temperature": 16.31,
    "description": "moderate rain",
    "modification_count": 0,
    "created_at": "2020-06-15T08:31:00.636Z",
    "updated_at": "2020-06-15T08:31:00.636Z"
  },
  {
    "id": 2,
    "day": "2020-06-15",
    "hour": 12,
    "location_id": 1,
    "temperature": 16.76,
    "description": "light rain",
    "modification_count": 0,
    "created_at": "2020-06-15T08:31:00.641Z",
    "updated_at": "2020-06-15T08:31:00.641Z"
  },
  ...
  ]

Modify weather: PATCH /weather_reports/:id JSON Payload:

{
"weather_report": {
  "temperature": -13.0,
  "description": "tornados"
}

}

Response:

{
  "modification_count": 1,
  "id": 1,
  "temperature": -13.0,
  "description": "tornados",
  "location_id": 1,
  "day": "2020-06-15",
  "hour": 9,
  "created_at": "2020-06-15T08:31:00.636Z",
  "updated_at": "2020-06-15T08:35:56.792Z",
}

Hints

• Run bundle install to setup application dependencies.
• Find all rake commands with rake --tasks (rake commands will help you initialize the application)
• Find api endpoints with rake routes
• Find database configuraton in config/database.yml
• Find redis host in sidekiq initializers file
• Start rails application with bash -c bundle exec rails server -p 3000 -b '0.0.0.0'
• Start sidekiq with bash -c "bundle exec sidekiq -C config/sidekiq.yml
• If you can't deploy sidekiq container you can use rails console and run OpenWeatherService.new.fetch_reports!
• If you have any questions ping me on [email protected] or [email protected]