• ruby 3.1.3
• bundler
• docker-compose(To run mysql container)

We use main branch as demo.

$ git switch main

$ sudo apt install rbenv(for ubuntu)
$ brew install rbenv ruby-build(for MacOS)
$ echo 'eval "$(rbenv init -)"' >> ~/.bashrc #depend on which sh you choose
$ source ~/.bashrc
$ rbenv install 3.1.3

$ RBENV_VERSION=3.1.3 gem install bundler

In this project we provide docker-compose.yml to install mysql.

$ sudo apt install docker-compose
$ docker-compose up -d
$ docker ps #to check if mysql is running successfully

$ bundle install

If docker-compose runs well, the database.yml settings fit mysql, no need to change.

$ bundle exec rake db:create
$ bundle exec rake db:migrate

# You need to set binding if you connect from other machine
$ bundle exec rails s

To run the RSpec locally, follow the steps below:

$ RAILS_ENV=test bundle exec rake db:create
$ RAILS_ENV=test bundle exec rake db:migrate

$ bundle exec rspec spec

• URL: {base_url}/users/:user_id/follow

• Method: POST

• Body:

  • follower_id: user id that you want to follow.

• Response:

  {
      "followed_users": [
          {
              "id": 1,
              "name": "Columbus Zulauf Esq.",
              "created_at": "2023-08-03T11:32:24.638Z",
              "updated_at": "2023-08-03T11:32:24.638Z"
          }
      ]
  }

• Error:

  { "error_code": "FOLLOWER_NOT_FOUND" }

  http status	error_code	description
  404	FOLLOWER_NOT_FOUND	The follower_id is not a valid user id
  409	FOLLOWER_ALREADY_EXISTS	This user is already followed the follower

• URL: {base_url}/users/:user_id/unfollow

• Method: POST

• Body:

  • follower_id: user id that you want to unfollow.

• Response:

  {
      "followed_users": [
          {
              "id": 1,
              "name": "Columbus Zulauf Esq.",
              "created_at": "2023-08-03T11:32:24.638Z",
              "updated_at": "2023-08-03T11:32:24.638Z"
          }
      ]
  }

• Error:

  { "error_code": "USER_NOT_FOLLOWED" }

  http status	error_code	description
  404	USER_NOT_FOLLOWED	The follower is not followed yet

• URL: {base_url}/users/:user_id/clock_in

• Method: POST

• Body: N/A

• Response:

  {
      "clocks": [
          {
              "id": 5,
              "user_id": 1,
              "clock_in": "2023-08-03T19:14:40.000Z",
              "clock_out": null,
              "duration": null
          },
          {
              "id": 4,
              "user_id": 1,
              "clock_in": "2023-08-03T18:59:28.000Z",
              "clock_out": "2023-08-03T19:14:28.000Z",
              "duration": 900
          },
          {
              "id": 3,
              "user_id": 1,
              "clock_in": "2023-08-03T18:46:44.000Z",
              "clock_out": "2023-08-03T18:47:08.000Z",
              "duration": 24
          }
      ]
  }

• Error:

  { "error_code": "ACTIVE_CLOCK_EXISTS" }

  http status	error_code	description
  400	ACTIVE_CLOCK_EXISTS	User has a active clock not clock out yet

• URL: {base_url}/users/:user_id/clock_out

• Method: PUT

• Body: N/A

• Response:

  {
      "clocks": [
          {
              "id": 5,
              "user_id": 1,
              "clock_in": "2023-08-03T19:14:40.000Z",
              "clock_out": "2023-08-03T19:16:43.000Z",
              "duration": 123
          },
          {
              "id": 4,
              "user_id": 1,
              "clock_in": "2023-08-03T18:59:28.000Z",
              "clock_out": "2023-08-03T19:14:28.000Z",
              "duration": 900
          },
          {
              "id": 3,
              "user_id": 1,
              "clock_in": "2023-08-03T18:46:44.000Z",
              "clock_out": "2023-08-03T18:47:08.000Z",
              "duration": 24
          }
      ]
  }

• Error:

  { "error_code": "NO_ACTIVE_CLOCK" }

  http status	error_code	description
  400	NO_ACTIVE_CLOCK	User has not clocked in yet

• URL: {base_url}/users/:user_id/followers_records
• Method: GET
• Parameters: N/A
• Response:

  {
      "followers_records": [
          {
              "user_id": 1,
              "user_name": "Columbus Zulauf Esq.",
              "clock_in": "2023-08-03T18:59:28.000Z",
              "clock_out": "2023-08-03T19:14:28.000Z",
              "duration": 900
          },
          {
              "user_id": 1,
              "user_name": "Columbus Zulauf Esq.",
              "clock_in": "2023-08-03T18:42:03.000Z",
              "clock_out": "2023-08-03T18:46:23.000Z",
              "duration": 260
          },
          {
              "user_id": 1,
              "user_name": "Columbus Zulauf Esq.",
              "clock_in": "2023-08-03T19:14:40.000Z",
              "clock_out": "2023-08-03T19:16:43.000Z",
              "duration": 123
          },
          {
              "user_id": 1,
              "user_name": "Columbus Zulauf Esq.",
              "clock_in": "2023-08-03T18:46:44.000Z",
              "clock_out": "2023-08-03T18:47:08.000Z",
              "duration": 24
          },
          {
              "user_id": 1,
              "user_name": "Columbus Zulauf Esq.",
              "clock_in": "2023-08-03T17:07:11.000Z",
              "clock_out": "2023-08-03T17:07:33.000Z",
              "duration": 22
          }
      ]
  }

• Error: N/A