openproject/lib/api/v3/activities/activity_representer.rb

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

require 'roar/decorator'
require 'roar/json/hal'

module API
  module V3
    module Activities
      class ActivityRepresenter < Roar::Decorator
        include Roar::JSON::HAL
        include Roar::Hypermedia
        include API::V3::Utilities::PathHelper
        include OpenProject::TextFormatting

        self.as_strategy = API::Utilities::CamelCasingStrategy.new

        def initialize(model, options = {})
          @current_user = options[:current_user]

          super(model)
        end

        property :_type, exec_context: :decorator

        link :self do
          {
            href: api_v3_paths.activity(represented.id),
            title: "#{represented.id}"
          }
        end

        link :workPackage do
          {
            href: api_v3_paths.work_package(represented.journable.id),
            title: "#{represented.journable.subject}"
          }
        end

        link :user do
          {
            href: api_v3_paths.user(represented.user.id),
            title: "#{represented.user.name} - #{represented.user.login}"
          }
        end

        link :update do
          {
            href: api_v3_paths.activity(represented.id),
            method: :patch,
            title: "#{represented.id}"
          } if current_user_allowed_to_edit?
        end

        property :id, render_nil: true
        property :notes, as: :comment, exec_context: :decorator, render_nil: true
        property :raw_notes,
                 as: :rawComment,
                 getter: -> (*) { notes },
                 setter: -> (value, *) { self.notes = value },
                 render_nil: true
        property :details, exec_context: :decorator, render_nil: true
        property :html_details, exec_context: :decorator, render_nil: true
        property :version, render_nil: true
        property :created_at, getter: -> (*) { created_at.utc.iso8601 }, render_nil: true

        def _type
          if represented.notes.blank?
            'Activity'
          else
            'Activity::Comment'
          end
        end

        def notes
          format_text(represented.notes, object: represented.journable)
        end

        def details
          render_details(represented, no_html: true)
        end

        def html_details
          render_details(represented)
        end

        private

        def current_user_allowed_to_edit?
          (current_user_allowed_to(:edit_own_work_package_notes, represented.journable) && represented.editable_by?(@current_user)) || current_user_allowed_to(:edit_work_package_notes, represented.journable)
        end

        def current_user_allowed_to(permission, work_package)
          @current_user && @current_user.allowed_to?(permission, work_package.project)
        end

        def render_details(journal, no_html: false)
          journal.details.map { |d| journal.render_detail(d, no_html: no_html) }
        end
      end
    end
  end
end