Add cost object reference to API v3

pull/6827/head
Hagen Schink 10 years ago
parent a6b584a9a9
commit e24579d5b8
  1. 55
      lib/api/v3/cost_objects/cost_object_model.rb
  2. 69
      lib/api/v3/cost_objects/cost_object_representer.rb
  3. 11
      lib/open_project/costs/engine.rb

@ -0,0 +1,55 @@
#-- 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 'reform'
require 'reform/form/coercion'
module API
module V3
module CostObjects
class CostObjectModel < Reform::Form
include Coercion
include GravatarImageTag
property :project_id, type: Integer
property :author, type: String
property :subject, type: String
property :description, type: String
property :type, type: String
property :fixed_date, type: DateTime
property :created_on, type: DateTime
property :updated_on, type: DateTime
def author
::API::V3::Users::UserModel.new(model.author) unless model.author.nil?
end
end
end
end
end

@ -0,0 +1,69 @@
#-- 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/representer/json/hal'
module API
module V3
module CostObjects
class CostObjectRepresenter < Roar::Decorator
include Roar::Representer::JSON::HAL
include Roar::Representer::Feature::Hypermedia
include OpenProject::StaticRouting::UrlHelpers
self.as_strategy = API::Utilities::CamelCasingStrategy.new
def initialize(model, options = {}, *expand)
@expand = expand
super(model)
end
property :_type, exec_context: :decorator
property :id, render_nil: true
property :project_id
property :project_name, getter: -> (*) { model.project.try(:name) }
property :subject, render_nil: true
property :description, render_nil: true
property :type, render_nil: true
property :fixed_date, getter: -> (*) { model.created_on.utc.iso8601 }, render_nil: true
property :created_at, getter: -> (*) { model.created_on.utc.iso8601 }, render_nil: true
property :updated_at, getter: -> (*) { model.updated_on.utc.iso8601 }, render_nil: true
property :author, embedded: true, class: ::API::V3::Users::UserModel, decorator: ::API::V3::Users::UserRepresenter, if: -> (*) { !author.nil? }
def _type
'CostObject'
end
end
end
end
end

@ -105,10 +105,21 @@ module OpenProject::Costs
extend_api_response(:v3, :work_packages, :work_package) do
property :cost_object,
exec_context: :decorator,
embedded: true,
class: ::API::V3::CostObjects::CostObjectModel,
decorator: ::API::V3::CostObjects::CostObjectRepresenter,
if: -> (*) { !represented.work_package.cost_object.nil? }
property :spent_hours,
exec_context: :decorator,
if: -> (*) { current_user_allowed_to_view_spent_hours }
send(:define_method, :cost_object) do
::API::V3::CostObjects::CostObjectModel.new(represented.work_package.cost_object)
end
send(:define_method, :spent_hours) do
attributes_helper = OpenProject::Costs::AttributesHelper.new(represented.work_package)

Loading…
Cancel
Save