openproject/spec/requests/api/v3/root_resource_spec.rb

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2021 the OpenProject GmbH
#
# 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-2013 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 docs/COPYRIGHT.rdoc for more details.
#++

require 'spec_helper'
require 'rack/test'

describe 'API v3 Root resource' do
  include Rack::Test::Methods
  include API::V3::Utilities::PathHelper

  let(:current_user) {
    FactoryBot.create(:user, member_in_project: project, member_through_role: role)
  }
  let(:role) { FactoryBot.create(:role, permissions: []) }
  let(:project) { FactoryBot.create(:project, public: false) }

  describe '#get' do
    let(:response) { last_response }
    subject { response.body }
    let(:get_path) { api_v3_paths.root }

    context 'anonymous user' do
      before do
        get get_path
      end

      it 'should respond with 200' do
        expect(response.status).to eq(200)
      end

      it 'should respond with a root representer' do
        expect(subject).to have_json_path('instanceName')
      end
    end

    context 'logged in user' do
      before do
        allow(User).to receive(:current).and_return current_user

        get get_path
      end

      it 'should respond with 200' do
        expect(response.status).to eq(200)
      end

      it 'should respond with a root representer' do
        expect(subject).to have_json_path('instanceName')
      end

      context 'without the X-requested-with header', skip_xhr_header: true do
        it 'returns OK because GET requests are allowed' do
          expect(response.status).to eq(200)
          expect(subject).to have_json_path('instanceName')
        end
      end
    end
  end
end