openproject/lib/api/v3/repositories/revision_representer.rb

#-- encoding: UTF-8
#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2018 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 docs/COPYRIGHT.rdoc for more details.
#++

module API
  module V3
    module Repositories
      class RevisionRepresenter < ::API::Decorators::Single
        include API::V3::Utilities
        include API::Decorators::DateProperty
        include API::Decorators::FormattableProperty

        self_link path: :revision,
                  title_getter: ->(*) { nil }

        link :project do
          {
            href: api_v3_paths.project(represented.project.id),
            title: represented.project.name
          }
        end

        link :author do
          next if represented.user.nil?

          {
            href: api_v3_paths.user(represented.user.id),
            title: represented.user.name
          }
        end

        link :showRevision do
          {
            href: api_v3_paths.show_revision(represented.project.identifier,
                                             represented.identifier)
          }
        end

        property :id
        property :identifier
        property :format_identifier, as: :formattedIdentifier
        property :author, as: :authorName

        formattable_property :comments,
                             as: :message,
                             plain: true,
                             uncacheable: true

        date_time_property :committed_on,
                           as: 'createdAt'

        def _type
          'Revision'
        end
      end
    end
  end
end