openproject/spec/requests/api/v3/relations/relations_api_spec.rb

#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2017 the OpenProject Foundation (OPF)
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2017 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
#
# See doc/COPYRIGHT.rdoc for more details.
#++

require 'spec_helper'

describe ::API::V3::Relations::RelationRepresenter, type: :request do
  let(:user) { FactoryGirl.create :admin }

  let!(:from) { FactoryGirl.create :work_package }
  let!(:to) { FactoryGirl.create :work_package }

  let(:type) { "precedes" }
  let(:description) { "This first" }
  let(:delay) { 3 }

  let(:params) do
    {
      _links: {
        from: {
          href: "/api/v3/work_packages/#{from.id}"
        },
        to: {
          href: "/api/v3/work_packages/#{to.id}"
        }
      },
      type: type,
      description: description,
      delay: delay
    }
  end

  before do
    login_as user
  end

  describe "creating a relation" do
    before do
      expect(Relation.count).to eq 0

      post "/api/v3/work_packages/#{from.id}/relations",
           params: params.to_json,
           headers: { "Content-Type": "application/json" }
    end

    it 'should return 201 (created)' do
      expect(response.status).to eq(201)
    end

    it 'should have created a new relation' do
      expect(Relation.count).to eq 1
    end

    it 'should have created the relation correctly' do
      rel = described_class.new(Relation.new, current_user: user).from_json response.body

      expect(rel.from).to eq from
      expect(rel.to).to eq to
      expect(rel.relation_type).to eq type
      expect(rel.description).to eq description
      expect(rel.delay).to eq delay
    end
  end

  describe "updating a relation" do
    let!(:relation) do
      FactoryGirl.create :relation,
                         from: from,
                         to: to,
                         relation_type: type,
                         description: description,
                         delay: delay
    end

    let(:new_description) { "This is another description" }
    let(:new_delay) { 42 }

    let(:update) do
      {
        description: new_description,
        delay: new_delay
      }
    end

    before do
      patch "/api/v3/relations/#{relation.id}",
            params: update.to_json,
            headers: { "Content-Type": "application/json" }
    end

    it "should return 200 (ok)" do
      expect(response.status).to eq 200
    end

    it "updates the relation's description" do
      expect(relation.reload.description).to eq new_description
    end

    it "updates the relation's delay" do
      expect(relation.reload.delay).to eq new_delay
    end

    it "should return the updated relation" do
      rel = described_class.new(Relation.new, current_user: user).from_json response.body

      expect(rel).to eq relation.reload
    end

    context "with invalid type" do
      let(:update) do
        {
          type: "foobar"
        }
      end

      it "should return 422" do
        expect(response.status).to eq 422
      end

      it "should indicate an error with the type attribute" do
        attr = JSON.parse(response.body).dig "_embedded", "details", "attribute"

        expect(attr).to eq "type"
      end
    end

    context "with trying to change an immutable attribute" do
      let(:other_wp) { FactoryGirl.create :work_package }

      let(:update) do
        {
          _links: {
            from: {
              href: "/api/v3/work_packages/#{other_wp.id}"
            }
          }
        }
      end

      it "should return 422" do
        expect(response.status).to eq 422
      end

      it "should indicate an error with the `from` attribute" do
        attr = JSON.parse(response.body).dig "_embedded", "details", "attribute"

        expect(attr).to eq "from"
      end

      it "should let the user know the attribute is read-only" do
        msg = JSON.parse(response.body)["message"]

        expect(msg).to include 'read-only'
      end
    end
  end

  describe "permissions" do
    let(:user) { FactoryGirl.create :user }

    let(:permissions) { %i(view_work_packages manage_work_package_relations) }

    let(:role) do
      FactoryGirl.create :existing_role, permissions: permissions
    end

    let(:project) { FactoryGirl.create :project }

    let!(:from) { FactoryGirl.create :work_package, project: project }
    let!(:to) { FactoryGirl.create :work_package, project: project }

    before do
      project.add_member! user, role

      post "/api/v3/work_packages/#{from.id}/relations",
           params: params.to_json,
           headers: { "Content-Type": "application/json" }
    end

    context "with the required permissions" do
      it "works" do
        expect(response.status).to eq 201
      end
    end

    context "without manage_work_package_relations" do
      let(:permissions) { [:view_work_packages] }

      it "is forbidden" do
        expect(response.status).to eq 403
      end
    end

    ##
    # This one is expected to fail (422) because the `to` work package
    # is in another project for which the user does not have permission to
    # view work packages.
    context "without manage_work_package_relations" do
      let!(:to) { FactoryGirl.create :work_package }

      it "should return 422" do
        expect(response.status).to eq 422
      end

      it "should indicate an error with the `to` attribute" do
        attr = JSON.parse(response.body).dig "_embedded", "details", "attribute"

        expect(attr).to eq "to"
      end

      it "should have a localized error message" do
        message = JSON.parse(response.body)["message"]

        expect(message).not_to include "translation missing"
      end
    end
  end

  describe "deleting a relation" do
    let!(:relation) do
      FactoryGirl.create :relation,
                         from: from,
                         to: to,
                         relation_type: type,
                         description: description,
                         delay: delay
    end

    before do
      delete "/api/v3/relations/#{relation.id}"
    end

    it "should return 204 and destroy the relation" do
      expect(response.status).to eq 204
      expect(Relation.exists?(relation.id)).to eq false
    end
  end
end