opf/openproject

#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2024 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 COPYRIGHT and LICENSE files for more details.
#++

require "roar/decorator"
require "roar/json"
require "roar/json/collection"
require "roar/json/hal"

module API
  module V3
    module Projects
      class ProjectCollectionRepresenter < ::API::Decorators::OffsetPaginatedCollection
        self.to_eager_load = ::API::V3::Projects::ProjectRepresenter.to_eager_load
        self.checked_permissions = ::API::V3::Projects::ProjectRepresenter.checked_permissions

        links :representations do
          [
            representation_format_csv,
            representation_format_xls
          ]
        end

        protected

        def representation_format(format, mime_type:)
          {
            href: url_for(controller: :projects, action: :index, format:, **query_params),
            identifier: format,
            type: mime_type,
            title: I18n.t("export.format.#{format}")
          }
        end

        def representation_format_xls
          representation_format "xls",
                                mime_type: "application/vnd.ms-excel"
        end

        def representation_format_csv
          representation_format "csv",
                                mime_type: "text/csv"
        end

        def paged_models(models)
          ::API::V3::Projects::ProjectEagerLoadingWrapper.wrap(super)
        end
      end
    end
  end
end