jro_apps/redmine Commit - r10453:d62b90db7327

Makes enumerations available through the REST API....

Jean-Philippe Lang -

r10453:d62b90db7327

parent child

Context file:

r10453:d62b90db7327

Collapse all files

app/views/enumerations/index.api.rsb created 644 +9 0

			@@ -0,0 +1,9
		1	api.array @klass.name.underscore.pluralize do
		2	@enumerations.each do \|enumeration\|
		3	api.__send__ @klass.name.underscore do
		4	api.id enumeration.id
		5	api.name enumeration.name
		6	api.is_default enumeration.is_default
		7	end
		8	end
		9	end

test/integration/api_test/enumerations_test.rb created 644 +44 0

			@@ -0,0 +1,44
		1	# Redmine - project management software
		2	# Copyright (C) 2006-2012 Jean-Philippe Lang
		3	#
		4	# This program is free software; you can redistribute it and/or
		5	# modify it under the terms of the GNU General Public License
		6	# as published by the Free Software Foundation; either version 2
		7	# of the License, or (at your option) any later version.
		8	#
		9	# This program is distributed in the hope that it will be useful,
		10	# but WITHOUT ANY WARRANTY; without even the implied warranty of
		11	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		12	# GNU General Public License for more details.
		13	#
		14	# You should have received a copy of the GNU General Public License
		15	# along with this program; if not, write to the Free Software
		16	# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
		17
		18	require File.expand_path('../../../test_helper', __FILE__)
		19
		20	class ApiTest::EnumerationsTest < ActionController::IntegrationTest
		21	fixtures :enumerations
		22
		23	def setup
		24	Setting.rest_api_enabled = '1'
		25	end
		26
		27	context "/enumerations/issue_priorities" do
		28	context "GET" do
		29
		30	should "return priorities" do
		31	get '/enumerations/issue_priorities.xml'
		32
		33	assert_response :success
		34	assert_equal 'application/xml', response.content_type
		35	assert_select 'issue_priorities[type=array]' do
		36	assert_select 'issue_priority' do
		37	assert_select 'id', :text => '6'
		38	assert_select 'name', :text => 'High'
		39	end
		40	end
		41	end
		42	end
		43	end
		44	end

app/controllers/enumerations_controller.rb +16 -3

              class EnumerationsController < ApplicationController
                layout 'admin'
-               before_filter :require_admin
+               before_filter :require_admin, :except => :index
+               before_filter :require_admin_or_api_request, :only => :index
                before_filter :build_new_enumeration, :only => [:new, :create]
                before_filter :find_enumeration, :only => [:edit, :update, :destroy]
+               accept_api_auth :index
                helper :custom_fields
                def index
+                 respond_to do |format|
+                   format.html
+                   format.api {
+                     @klass = Enumeration.get_subclass(params[:type])
+                     if @klass
+                       @enumerations = @klass.shared.sorted.all
+                     else
+                       render_404
+                     end
+                   }
+                 end
                end
                def new
                def create
                  if request.post? && @enumeration.save
                    flash[:notice] = l(:notice_successful_create)
-                   redirect_to :action => 'index', :type => @enumeration.type
+                   redirect_to :action => 'index'
                  else
                    render :action => 'new'
                  end
                def update
                  if request.put? && @enumeration.update_attributes(params[:enumeration])
                    flash[:notice] = l(:notice_successful_update)
-                   redirect_to :action => 'index', :type => @enumeration.type
+                   redirect_to :action => 'index'
                  else
                    render :action => 'edit'
                  end

app/models/enumeration.rb +1 0

                validates_length_of :name, :maximum => 30
                scope :shared, where(:project_id => nil)
+               scope :sorted, order("#{table_name}.position ASC")
                scope :active, where(:active => true)
                scope :named, lambda {|arg| where("LOWER(#{table_name}.name) = LOWER(?)", arg.to_s.strip)}

config/routes.rb +2 -1

                    match 'copy', :via => [:get, :post]
                  end
-                 resources :memberships, :shallow => true, :controller => 'members', :only => [:index, :show, :create, :update, :destroy] do
+                 resources :memberships, :shallow => true, :controller => 'members', :only => [:index, :show, :new, :create, :update, :destroy] do
                    collection do
                      get 'autocomplete'
                    end
                  end
                end
                resources :enumerations, :except => :show
+               match 'enumerations/:type', :to => 'enumerations#index', :via => :get
                get 'projects/:id/search', :controller => 'search', :action => 'index'
                get 'search', :controller => 'search', :action => 'index'

lib/redmine/subclass_factory.rb +7 -2

                  end
                  module ClassMethods
-                   # Returns an instance of the given subclass name
-                   def new_subclass_instance(class_name, *args)
+                   def get_subclass(class_name)
                      klass = nil
                      begin
                        klass = class_name.to_s.classify.constantize
                      unless subclasses.include? klass
                        klass = nil
                      end
+                     klass
+                   end
+                   # Returns an instance of the given subclass name
+                   def new_subclass_instance(class_name, *args)
+                     klass = get_subclass(class_name)
                      if klass
                        klass.new(*args)
                      end

test/functional/enumerations_controller_test.rb +8 -2

                  assert_template 'index'
                end
+               def test_index_should_require_admin
+                 @request.session[:user_id] = nil
+                 get :index
+                 assert_response 302
+               end
                def test_new
                  get :new, :type => 'IssuePriority'
                  assert_response :success
                  assert_difference 'IssuePriority.count' do
                    post :create, :enumeration => {:type => 'IssuePriority', :name => 'Lowest'}
                  end
-                 assert_redirected_to '/enumerations?type=IssuePriority'
+                 assert_redirected_to '/enumerations'
                  e = IssuePriority.find_by_name('Lowest')
                  assert_not_nil e
                end
                  assert_no_difference 'IssuePriority.count' do
                    put :update, :id => 6, :enumeration => {:type => 'IssuePriority', :name => 'New name'}
                  end
-                 assert_redirected_to '/enumerations?type=IssuePriority'
+                 assert_redirected_to '/enumerations'
                  e = IssuePriority.find(6)
                  assert_equal 'New name', e.name
                end

test/integration/routing/enumerations_test.rb +4 0

                      { :method => 'delete', :path => "/enumerations/2" },
                      { :controller => 'enumerations', :action => 'destroy', :id => '2' }
                    )
+                 assert_routing(
+                     { :method => 'get', :path => "/enumerations/issue_priorities.xml" },
+                     { :controller => 'enumerations', :action => 'index', :type => 'issue_priorities', :format => 'xml' }
+                   )
                end
              end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages