Add Project Folders API endpoints

app/controllers/api/v1/project_folders_controller.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Api
+  module V1
+    class ProjectFoldersController < BaseController
+      before_action :load_team
+      before_action :load_project_folder, only: %i(show update)
+      before_action :check_parent_folder, only: %i(create update)
+
+      def index
+        project_folders = @team.project_folders
+                               .page(params.dig(:page, :number))
+                               .per(params.dig(:page, :size))
+
+        render jsonapi: project_folders, each_serializer: ProjectFolderSerializer, status: :ok
+      end
+
+      def show
+        render jsonapi: @project_folder, serializer: ProjectFolderSerializer, status: :ok
+      end
+
+      def create
+        folder = @team.project_folders.create!(folder_params)
+
+        render jsonapi: folder, serializer: ProjectFolderSerializer, status: :created
+      end
+
+      def update
+        @project_folder.attributes = update_folder_params
+
+        if @project_folder.changed? && @project_folder.save!
+          render jsonapi: @project_folder, serializer: ProjectFolderSerializer, status: :ok
+        else
+          render jsonapi: nil, status: :no_content
+        end
+      end
+
+      private
+
+      def load_project_folder
+        @project_folder = @team.project_folders.find(params.require(:id))
+      end
+
+      def folder_params
+        raise TypeError unless params.require(:data).require(:type) == 'project_folders'
+
+        params.require(:data).require(:attributes)
+        params.permit(data: { attributes: %i(name parent_folder_id) })[:data][:attributes]
+      end
+
+      def update_folder_params
+        raise IDMismatchError unless params.require(:data).require(:id).to_i == params[:id].to_i
+
+        folder_params
+      end
+
+      def check_parent_folder
+        @team.project_folders.find(folder_params[:parent_folder_id]) if folder_params[:parent_folder_id]
+      end
+    end
+  end
+end

app/serializers/api/v1/project_folder_serializer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Api
+  module V1
+    class ProjectFolderSerializer < ActiveModel::Serializer
+      type :project_folders
+      attributes :id, :name
+
+      belongs_to :team, serializer: TeamSerializer
+      belongs_to :parent_folder, serializer: ProjectFolderSerializer
+    end
+  end
+end

config/routes.rb

@@ -701,6 +701,7 @@ Rails.application.routes.draw do
                 end
               end
             end
+            resources :project_folders, only: %i(index show create update)
           end
           resources :users, only: %i(show) do
             resources :user_identities,

spec/requests/api/v1/project_folders_controller_spec.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe 'Api::V1::ProjectFoldersController', type: :request do
+  let(:user) { create :user }
+  let(:valid_headers) { { 'Authorization': 'Bearer ' + generate_token(user.id) } }
+  let(:team) { create :team, created_by: user }
+  let!(:user_team) { create :user_team, team: team, user: user }
+  let(:folder) do
+    create :project_folder, team: team
+  end
+
+  describe 'GET index' do
+    let(:params) { { team_id: team.id } }
+    let(:action) { get(api_v1_team_project_folders_path(params), headers: valid_headers) }
+
+    context 'when has valid params' do
+      it 'renders 200' do
+        action
+
+        expect(response).to have_http_status(200)
+        expect(response).to match_json_schema('project_folders/collection')
+      end
+    end
+
+    context 'when user is not part of the team' do
+      let(:second_team) { create :team }
+      let(:params) { { team_id: second_team.id } }
+
+      it 'renders 403' do
+        action
+
+        expect(response).to have_http_status(403)
+      end
+    end
+  end
+
+  describe 'GET show' do
+    let(:params) { { team_id: team.id, id: folder_id } }
+    let(:action) { get(api_v1_team_project_folder_path(params), headers: valid_headers) }
+    let(:folder_id) { folder.id }
+
+    context 'when project_folder found' do
+      it do
+        action
+
+        expect(response).to have_http_status(200)
+        expect(response).to match_json_schema('project_folders/resource')
+      end
+    end
+
+    context 'when project_folder does not exists' do
+      let(:folder_id) { -1 }
+
+      it do
+        action
+
+        expect(response).to have_http_status 404
+      end
+    end
+  end
+
+  describe 'POST create' do
+    let(:params) do
+      {
+        data: {
+          type: 'project_folders',
+          attributes: {
+            name: folder_name,
+            parent_folder_id: parent_folder_id
+          }
+        }
+      }
+    end
+    let(:action) { post(api_v1_team_project_folders_path(team_id: team.id), params: params, headers: valid_headers) }
+    let(:folder_name) { 'MyNewFolder' }
+    let(:parent_folder_id) { nil }
+
+    context 'when folder can be created' do
+      context 'when root folder' do
+        it 'creates new folder' do
+          action
+
+          expect(response).to have_http_status(201)
+          expect(response).to match_json_schema('project_folders/resource')
+        end
+      end
+
+      context 'when nested folder' do
+        let(:parent_folder_id) { create(:project_folder, team: team).id }
+
+        it 'creates new folder inside existing folder' do
+          action
+
+          expect(response).to have_http_status(201)
+          expect(response).to match_json_schema('project_folders/resource')
+        end
+      end
+    end
+
+    context 'when folder cannot be created' do
+      context 'when validation error' do
+        let(:folder_name) { '' }
+
+        it 'should returns validation error' do
+          action
+
+          expect(response).to have_http_status 400
+          expect(JSON.parse(response.body)['errors'].first['title']).to be_eql 'Validation error'
+        end
+      end
+
+      context 'when parent_folder not found' do
+        let(:parent_folder_id) { -1 }
+
+        it do
+          action
+
+          expect(response).to have_http_status 404
+        end
+      end
+    end
+  end
+
+  describe 'PATCH update' do
+    let(:params) do
+      {
+        data: {
+          id: folder.id,
+          type: 'project_folders',
+          attributes: {
+            name: folder_name,
+            parent_folder_id: parent_folder_id
+          }
+        }
+      }
+    end
+    let(:action) do
+      patch(api_v1_team_project_folder_path(team_id: team.id, id: folder_id), params: params, headers: valid_headers)
+    end
+    let(:folder_name) { 'MyUpdatedFolder' }
+    let(:folder_id) { folder.id }
+    let(:parent_folder_id) { nil }
+
+    context 'when folder can be updated' do
+      context 'when root folder' do
+        it 'updates folder' do
+          action
+
+          expect(response).to have_http_status(200)
+          expect(response).to match_json_schema('project_folders/resource')
+        end
+      end
+
+      context 'when update parent folder' do
+        let(:parent_folder_id) { create(:project_folder, team: team).id }
+
+        it 'updates folder\'s parent with existing folder' do
+          action
+
+          expect(response).to have_http_status(200)
+        end
+      end
+
+      context 'when nothing to update' do
+        let(:folder_name) { folder.name }
+
+        it 'do not update folder, returns 204' do
+          action
+
+          expect(response).to have_http_status(204)
+        end
+      end
+    end
+
+    context 'when folder cannot be updated' do
+      context 'when validation error' do
+        let(:folder_name) { '' }
+
+        it 'returns validation error, returns 400' do
+          action
+
+          expect(response).to have_http_status(400)
+          expect(JSON.parse(response.body)['errors'].first['title']).to be_eql 'Validation error'
+        end
+      end
+
+      context 'when parent_folder not found' do
+        let(:parent_folder_id) { -1 }
+
+        it do
+          action
+
+          expect(response).to have_http_status(404)
+        end
+      end
+
+      context 'when mismatch IDs' do
+        let(:folder_id) { create(:project_folder, team: team).id }
+
+        it '' do
+          action
+
+          expect(response).to have_http_status(400)
+          expect(JSON.parse(response.body)['errors'].first['title']).to be_eql 'Object ID mismatch'
+        end
+      end
+    end
+  end
+end

spec/support/api/schemas/project_folders/collection.json

@@ -0,0 +1,13 @@
+{
+  "id": "file:/collection.json#",
+  "type": "object",
+  "properties": {
+    "data": {
+      "type": "array",
+      "items": {
+        "$ref": "file:/item.json#"
+      }
+    }
+  },
+  "required": ["data", "links"]
+}

spec/support/api/schemas/project_folders/item.json

@@ -0,0 +1,43 @@
+{
+  "id": "file:/item.json#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "type": {
+      "type": "string"
+    },
+    "attributes": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "name"
+      ]
+    },
+    "relationships": {
+      "type": "object",
+      "properties": {
+        "team": {
+          "type": "object"
+        },
+        "parent_folder": {
+          "type": "object"
+        }
+      },
+      "additionalProperties": false,
+      "required": ["team"]
+    }
+  },
+  "additionalProperties": false,
+  "required": ["id", "type", "attributes"]
+}
+
+
+
+

spec/support/api/schemas/project_folders/resource.json

@@ -0,0 +1,14 @@
+{
+  "id": "file:/resource.json#",
+  "type": "object",
+  "properties":{
+    "data": {
+      "$ref": "file:/item.json#"
+    }
+  },
+  "required": ["data"]
+}
+
+
+
+