openproject/lib/api/v3/principals/principals_api.rb

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

module API
  module V3
    module Principals
      class PrincipalsAPI < ::API::OpenProjectAPI
        helpers ::API::Utilities::PageSizeHelper

        resource :principals do
          get do
            query = ParamsToQueryService.new(Principal, current_user).call(params)

            if query.valid?
              principals = query
                           .results
                           .where(id: Principal.in_visible_project_or_me(current_user))
                           .includes(:preference)

              ::API::V3::Users::PaginatedUserCollectionRepresenter.new(principals,
                                                                       self_link: api_v3_paths.principals,
                                                                       page: to_i_or_nil(params[:offset]),
                                                                       per_page: resolve_page_size(params[:pageSize]),
                                                                       current_user: current_user)
            else
              raise ::API::Errors::InvalidQuery.new(query.errors.full_messages)
            end
          end
        end
      end
    end
  end
end