OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
openproject/lib/api/v3/time_entries/time_entries_api.rb

126 lines
4.4 KiB

#-- 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 TimeEntries
class TimeEntriesAPI < ::API::OpenProjectAPI
helpers ::API::Utilities::PageSizeHelper
resources :time_entries do
get do
query = ParamsToQueryService
.new(TimeEntry, current_user)
.call(params)
if query.valid?
TimeEntryCollectionRepresenter.new(query.results,
api_v3_paths.time_entries,
page: to_i_or_nil(params[:offset]),
User mentions feature (#5897) * Extend syntax for linking users via their ID * Allow login names for linking user profiles. * User require_relative for legacy tests * Add specs for login name based user links; Fixes other specs, too. * Notify mentioned users * Notify linked users; - require quotes for login names in user links as login names can contain spaces, dots that are typical word boundaries - Adding specs * For the decision who gets notified due to mentions only the visibility permissions of the recipient are relevant. * Rubucop satisfaction * Add autocomplete for user names to work pack package descriptions and activity - Uses API V3 Principals endpoint. - Extends API endpoint with name filter and name order. - Make it activate when user types an "@" or a "user#" - Still for work packages only. * Directly show a list of users after typing '@' and allow navigating list with cursor keys * Add an '@' before the rendered user link * Adopting spec as WP autocompleter now expects whitespace before hash sign * Adding spec for using user autocompleter * Introduce magic pageSize of 0 for maximum length * Add id filter for principals * Allow pagination for principals and protect from falling back to a too low default value * Fixing specs * fixing typo in spec * Add magic number 0 for user custom fields * Add a toParams method for ApiV3FilterBuilder * User ApiV3FilterBuilder in path helper service * Add test for mentions principals to path helper * WIP * Convert auto complete helper to TS [ci skip]
7 years ago
per_page: resolve_page_size(params[:pageSize]),
current_user: current_user)
else
raise ::API::Errors::InvalidQuery.new(query.errors.full_messages)
end
end
post do
params = API::V3::ParseResourceParamsService
.new(current_user, model: TimeEntry)
.call(request_body)
.result
result = ::TimeEntries::CreateService
.new(user: current_user)
.call(params)
if result.success?
new_entry = result.result
TimeEntryRepresenter.create(new_entry,
current_user: current_user,
embed_links: true)
else
fail ::API::Errors::ErrorBase.create_and_merge_errors(result.errors)
end
end
params do
requires :id, desc: 'Time entry\'s id'
end
route_param :id do
before do
@time_entry = TimeEntry
.visible
.find(params[:id])
end
get do
TimeEntryRepresenter.create(@time_entry,
current_user: current_user,
embed_links: true)
end
patch do
params = API::V3::ParseResourceParamsService
.new(current_user, model: TimeEntry)
.call(request_body)
.result
result = ::TimeEntries::UpdateService
.new(time_entry: @time_entry, user: current_user)
.call(attributes: params)
if result.success?
updated_entry = result.result
TimeEntryRepresenter.create(updated_entry,
current_user: current_user,
embed_links: true)
else
fail ::API::Errors::ErrorBase.create_and_merge_errors(result.errors)
end
end
delete do
call = ::TimeEntries::DeleteService.new(time_entry: @time_entry, user: current_user).call
if call.success?
status 204
else
fail ::API::Errors::ErrorBase.create_and_merge_errors(call.errors)
end
end
end
mount ::API::V3::TimeEntries::TimeEntriesActivityAPI
end
end
end
end
end