REST API: custom fields definition (#11159).

git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@12165 e93f8b46-1217-0410-a6f0-8f06a7374b81
This commit is contained in:
Jean-Philippe Lang 2013-09-29 10:08:30 +00:00
parent 4a36e09d49
commit 886284b33f
5 changed files with 106 additions and 4 deletions

View File

@ -21,10 +21,18 @@ class CustomFieldsController < ApplicationController
before_filter :require_admin before_filter :require_admin
before_filter :build_new_custom_field, :only => [:new, :create] before_filter :build_new_custom_field, :only => [:new, :create]
before_filter :find_custom_field, :only => [:edit, :update, :destroy] before_filter :find_custom_field, :only => [:edit, :update, :destroy]
accept_api_auth :index
def index def index
@custom_fields_by_type = CustomField.all.group_by {|f| f.class.name } respond_to do |format|
@tab = params[:tab] || 'IssueCustomField' format.html {
@custom_fields_by_type = CustomField.all.group_by {|f| f.class.name }
@tab = params[:tab] || 'IssueCustomField'
}
format.api {
@custom_fields = CustomField.all
}
end
end end
def new def new

View File

@ -123,8 +123,10 @@ class CustomField < ActiveRecord::Base
values.each do |value| values.each do |value|
value.force_encoding('UTF-8') if value.respond_to?(:force_encoding) value.force_encoding('UTF-8') if value.respond_to?(:force_encoding)
end end
values
else
[]
end end
values || []
end end
end end
@ -301,7 +303,7 @@ class CustomField < ActiveRecord::Base
def self.customized_class def self.customized_class
self.name =~ /^(.+)CustomField$/ self.name =~ /^(.+)CustomField$/
begin; $1.constantize; rescue nil; end $1.constantize rescue nil
end end
# to move in project_custom_field # to move in project_custom_field

View File

@ -0,0 +1,42 @@
api.array :custom_fields do
@custom_fields.each do |field|
api.custom_field do
api.id field.id
api.name field.name
api.customized_type field.class.customized_class.name.underscore if field.class.customized_class
api.field_format field.field_format
api.regexp field.regexp
api.min_length (field.min_length == 0 ? nil : field.min_length)
api.max_length (field.max_length == 0 ? nil : field.max_length)
api.is_required field.is_required?
api.is_filter field.is_filter?
api.searchable field.searchable
api.multiple field.multiple?
api.default_value field.default_value
api.visible field.visible?
if field.field_format == 'list'
api.array :possible_values do
field.possible_values.each do |v|
api.possible_value do
api.value v
end
end
end
end
if field.is_a?(IssueCustomField)
api.trackers do
field.trackers.each do |tracker|
api.tracker :id => tracker.id, :name => tracker.name
end
end
api.roles do
field.roles.each do |role|
api.role :id => role.id, :name => role.name
end
end
end
end
end
end

View File

@ -0,0 +1,43 @@
# Redmine - project management software
# Copyright (C) 2006-2013 Jean-Philippe Lang
#
# 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.
require File.expand_path('../../../test_helper', __FILE__)
class Redmine::ApiTest::CustomFieldsTest < Redmine::ApiTest::Base
fixtures :users, :custom_fields
def setup
Setting.rest_api_enabled = '1'
end
test "GET /custom_fields.xml should return custom fields" do
get '/custom_fields.xml', {}, credentials('admin')
assert_response :success
assert_equal 'application/xml', response.content_type
assert_select 'custom_fields' do
assert_select 'custom_field' do
assert_select 'name', :text => 'Database'
assert_select 'id', :text => '2'
assert_select 'customized_type', :text => 'issue'
assert_select 'possible_values[type=array]' do
assert_select 'possible_value>value', :text => 'PostgreSQL'
end
end
end
end
end

View File

@ -44,4 +44,11 @@ class RoutingCustomFieldsTest < ActionController::IntegrationTest
{ :controller => 'custom_fields', :action => 'destroy', :id => '2' } { :controller => 'custom_fields', :action => 'destroy', :id => '2' }
) )
end end
def test_custom_fields_api
assert_routing(
{ :method => 'get', :path => "/custom_fields.xml" },
{ :controller => 'custom_fields', :action => 'index', :format => 'xml' }
)
end
end end