jro_apps/redmine Commit - r3652:345301284a9b

Added JSON support to the issues API. #1214...

Eric Davis -

r3652:345301284a9b

parent child

Context file:

r3652:345301284a9b

Collapse all files

app/controllers/application_controller.rb +7 0

             # redMine - project management software
             # Copyright (C) 2006-2007  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 'uri'
             require 'cgi'
             class ApplicationController < ActionController::Base
               include Redmine::I18n
               layout 'base'
               exempt_from_layout 'builder'
               # Remove broken cookie after upgrade from 0.8.x (#4292)
               # See https://rails.lighthouseapp.com/projects/8994/tickets/3360
               # TODO: remove it when Rails is fixed
               before_filter :delete_broken_cookies
               def delete_broken_cookies
                 if cookies['_redmine_session'] && cookies['_redmine_session'] !~ /--/
                   cookies.delete '_redmine_session'
                   redirect_to home_path
                   return false
                 end
               end
               before_filter :user_setup, :check_if_login_required, :set_localization
               filter_parameter_logging :password
               protect_from_forgery
               rescue_from ActionController::InvalidAuthenticityToken, :with => :invalid_authenticity_token
               include Redmine::Search::Controller
               include Redmine::MenuManager::MenuController
               helper Redmine::MenuManager::MenuHelper
               Redmine::Scm::Base.all.each do |scm|
                 require_dependency "repository/#{scm.underscore}"
               end
               def user_setup
                 # Check the settings cache for each request
                 Setting.check_cache
                 # Find the current user
                 User.current = find_current_user
               end
               # Returns the current user or nil if no user is logged in
               # and starts a session if needed
               def find_current_user
                 if session[:user_id]
                   # existing session
                   (User.active.find(session[:user_id]) rescue nil)
                 elsif cookies[:autologin] && Setting.autologin?
                   # auto-login feature starts a new session
                   user = User.try_to_autologin(cookies[:autologin])
                   session[:user_id] = user.id if user
                   user
                 elsif params[:format] == 'atom' && params[:key] && accept_key_auth_actions.include?(params[:action])
                   # RSS key authentication does not start a session
                   User.find_by_rss_key(params[:key])
                 elsif Setting.rest_api_enabled? && ['xml', 'json'].include?(params[:format])
                   if params[:key].present? && accept_key_auth_actions.include?(params[:action])
                     # Use API key
                     User.find_by_api_key(params[:key])
                   else
                     # HTTP Basic, either username/password or API key/random
                     authenticate_with_http_basic do |username, password|
                       User.try_to_login(username, password) || User.find_by_api_key(username)
                     end
                   end
                 end
               end
               # Sets the logged in user
               def logged_user=(user)
                 reset_session
                 if user && user.is_a?(User)
                   User.current = user
                   session[:user_id] = user.id
                 else
                   User.current = User.anonymous
                 end
               end
               # check if login is globally required to access the application
               def check_if_login_required
                 # no check needed if user is already logged in
                 return true if User.current.logged?
                 require_login if Setting.login_required?
               end
               def set_localization
                 lang = nil
                 if User.current.logged?
                   lang = find_language(User.current.language)
                 end
                 if lang.nil? && request.env['HTTP_ACCEPT_LANGUAGE']
                   accept_lang = parse_qvalues(request.env['HTTP_ACCEPT_LANGUAGE']).first
                   if !accept_lang.blank?
                     accept_lang = accept_lang.downcase
                     lang = find_language(accept_lang) || find_language(accept_lang.split('-').first)
                   end
                 end
                 lang ||= Setting.default_language
                 set_language_if_valid(lang)
               end
               def require_login
                 if !User.current.logged?
                   # Extract only the basic url parameters on non-GET requests
                   if request.get?
                     url = url_for(params)
                   else
                     url = url_for(:controller => params[:controller], :action => params[:action], :id => params[:id], :project_id => params[:project_id])
                   end
                   respond_to do |format|
                     format.html { redirect_to :controller => "account", :action => "login", :back_url => url }
                     format.atom { redirect_to :controller => "account", :action => "login", :back_url => url }
                     format.xml  { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' }
                     format.json { head :unauthorized, 'WWW-Authenticate' => 'Basic realm="Redmine API"' }
                   end
                   return false
                 end
                 true
               end
               def require_admin
                 return unless require_login
                 if !User.current.admin?
                   render_403
                   return false
                 end
                 true
               end
               def deny_access
                 User.current.logged? ? render_403 : require_login
               end
               # Authorize the user for the requested action
               def authorize(ctrl = params[:controller], action = params[:action], global = false)
                 allowed = User.current.allowed_to?({:controller => ctrl, :action => action}, @project, :global => global)
                 allowed ? true : deny_access
               end
               # Authorize the user for the requested action outside a project
               def authorize_global(ctrl = params[:controller], action = params[:action], global = true)
                 authorize(ctrl, action, global)
               end
               # Find project of id params[:id]
               def find_project
                 @project = Project.find(params[:id])
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               # Find a project based on params[:project_id]
               # TODO: some subclasses override this, see about merging their logic
               def find_optional_project
                 @project = Project.find(params[:project_id]) unless params[:project_id].blank?
                 allowed = User.current.allowed_to?({:controller => params[:controller], :action => params[:action]}, @project, :global => true)
                 allowed ? true : deny_access
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               # Finds and sets @project based on @object.project
               def find_project_from_association
                 render_404 unless @object.present?
                 @project = @object.project
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               def find_model_object
                 model = self.class.read_inheritable_attribute('model_object')
                 if model
                   @object = model.find(params[:id])
                   self.instance_variable_set('@' + controller_name.singularize, @object) if @object
                 end
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               def self.model_object(model)
                 write_inheritable_attribute('model_object', model)
               end
               # make sure that the user is a member of the project (or admin) if project is private
               # used as a before_filter for actions that do not require any particular permission on the project
               def check_project_privacy
                 if @project && @project.active?
                   if @project.is_public? || User.current.member_of?(@project) || User.current.admin?
                     true
                   else
                     User.current.logged? ? render_403 : require_login
                   end
                 else
                   @project = nil
                   render_404
                   false
                 end
               end
               def redirect_back_or_default(default)
                 back_url = CGI.unescape(params[:back_url].to_s)
                 if !back_url.blank?
                   begin
                     uri = URI.parse(back_url)
                     # do not redirect user to another host or to the login or register page
                     if (uri.relative? || (uri.host == request.host)) && !uri.path.match(%r{/(login|account/register)})
                       redirect_to(back_url)
                       return
                     end
                   rescue URI::InvalidURIError
                     # redirect to default
                   end
                 end
                 redirect_to default
               end
               def render_403
                 @project = nil
                 respond_to do |format|
                   format.html { render :template => "common/403", :layout => (request.xhr? ? false : 'base'), :status => 403 }
                   format.atom { head 403 }
                   format.xml { head 403 }
                   format.json { head 403 }
                 end
                 return false
               end
               def render_404
                 respond_to do |format|
                   format.html { render :template => "common/404", :layout => !request.xhr?, :status => 404 }
                   format.atom { head 404 }
                   format.xml { head 404 }
                   format.json { head 404 }
                 end
                 return false
               end
               def render_error(msg)
                 respond_to do |format|
                   format.html {
                     flash.now[:error] = msg
                     render :text => '', :layout => !request.xhr?, :status => 500
                   }
                   format.atom { head 500 }
                   format.xml { head 500 }
                   format.json { head 500 }
                 end
               end
               def invalid_authenticity_token
                 if api_request?
                   logger.error "Form authenticity token is missing or is invalid. API calls must include a proper Content-type header (text/xml or text/json)."
                 end
                 render_error "Invalid form authenticity token."
               end
               def render_feed(items, options={})
                 @items = items || []
                 @items.sort! {|x,y| y.event_datetime <=> x.event_datetime }
                 @items = @items.slice(0, Setting.feeds_limit.to_i)
                 @title = options[:title] || Setting.app_title
                 render :template => "common/feed.atom.rxml", :layout => false, :content_type => 'application/atom+xml'
               end
               def self.accept_key_auth(*actions)
                 actions = actions.flatten.map(&:to_s)
                 write_inheritable_attribute('accept_key_auth_actions', actions)
               end
               def accept_key_auth_actions
                 self.class.read_inheritable_attribute('accept_key_auth_actions') || []
               end
               # Returns the number of objects that should be displayed
               # on the paginated list
               def per_page_option
                 per_page = nil
                 if params[:per_page] && Setting.per_page_options_array.include?(params[:per_page].to_s.to_i)
                   per_page = params[:per_page].to_s.to_i
                   session[:per_page] = per_page
                 elsif session[:per_page]
                   per_page = session[:per_page]
                 else
                   per_page = Setting.per_page_options_array.first || 25
                 end
                 per_page
               end
               # qvalues http header parser
               # code taken from webrick
               def parse_qvalues(value)
                 tmp = []
                 if value
                   parts = value.split(/,\s*/)
                   parts.each {|part|
                     if m = %r{^([^\s,]+?)(?:;\s*q=(\d+(?:\.\d+)?))?$}.match(part)
                       val = m[1]
                       q = (m[2] or 1).to_f
                       tmp.push([val, q])
                     end
                   }
                   tmp = tmp.sort_by{|val, q| -q}
                   tmp.collect!{|val, q| val}
                 end
                 return tmp
               rescue
                 nil
               end
               # Returns a string that can be used as filename value in Content-Disposition header
               def filename_for_content_disposition(name)
                 request.env['HTTP_USER_AGENT'] =~ %r{MSIE} ? ERB::Util.url_encode(name) : name
               end
               def api_request?
                 %w(xml json).include? params[:format]
               end
               # Renders a warning flash if obj has unsaved attachments
               def render_attachment_warning_if_needed(obj)
                 flash[:warning] = l(:warning_attachments_not_saved, obj.unsaved_attachments.size) if obj.unsaved_attachments.present?
               end
               # Rescues an invalid query statement. Just in case...
               def query_statement_invalid(exception)
                 logger.error "Query::StatementInvalid: #{exception.message}" if logger
                 session.delete(:query)
                 sort_clear if respond_to?(:sort_clear)
                 render_error "An error occurred while executing the query and has been logged. Please report this error to your Redmine administrator."
               end
+              # Converts the errors on an ActiveRecord object into a common JSON format
+              def object_errors_to_json(object)
+                object.errors.collect do |attribute, error|
+                  { attribute => error }
+                end.to_json
+              end
             end

app/controllers/issues_controller.rb +8 -1

             # Redmine - project management software
             # Copyright (C) 2006-2008  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.
             class IssuesController < ApplicationController
               menu_item :new_issue, :only => [:new, :create]
               default_search_scope :issues
               before_filter :find_issue, :only => [:show, :edit, :update, :reply]
               before_filter :find_issues, :only => [:bulk_edit, :move, :destroy]
               before_filter :find_project, :only => [:new, :create, :update_form, :preview, :auto_complete]
               before_filter :authorize, :except => [:index, :changes, :preview, :context_menu]
               before_filter :find_optional_project, :only => [:index, :changes]
               before_filter :check_for_default_issue_status, :only => [:new, :create]
               before_filter :build_new_issue_from_params, :only => [:new, :create]
               accept_key_auth :index, :show, :changes
               rescue_from Query::StatementInvalid, :with => :query_statement_invalid
               helper :journals
               helper :projects
               include ProjectsHelper
               helper :custom_fields
               include CustomFieldsHelper
               helper :issue_relations
               include IssueRelationsHelper
               helper :watchers
               include WatchersHelper
               helper :attachments
               include AttachmentsHelper
               helper :queries
               include QueriesHelper
               helper :sort
               include SortHelper
               include IssuesHelper
               helper :timelog
               include Redmine::Export::PDF
               verify :method => [:post, :delete],
                      :only => :destroy,
                      :render => { :nothing => true, :status => :method_not_allowed }
               verify :method => :post, :only => :create, :render => {:nothing => true, :status => :method_not_allowed }
               verify :method => :put, :only => :update, :render => {:nothing => true, :status => :method_not_allowed }
               def index
                 retrieve_query
                 sort_init(@query.sort_criteria.empty? ? [['id', 'desc']] : @query.sort_criteria)
                 sort_update(@query.sortable_columns)
                 if @query.valid?
                   limit = case params[:format]
                   when 'csv', 'pdf'
                     Setting.issues_export_limit.to_i
                   when 'atom'
                     Setting.feeds_limit.to_i
                   else
                     per_page_option
                   end
                   @issue_count = @query.issue_count
                   @issue_pages = Paginator.new self, @issue_count, limit, params['page']
                   @issues = @query.issues(:include => [:assigned_to, :tracker, :priority, :category, :fixed_version],
                                           :order => sort_clause,
                                           :offset => @issue_pages.current.offset,
                                           :limit => limit)
                   @issue_count_by_group = @query.issue_count_by_group
                   respond_to do |format|
                     format.html { render :template => 'issues/index.rhtml', :layout => !request.xhr? }
                     format.xml  { render :layout => false }
+                    format.json { render :text => @issues.to_json, :layout => false }
                     format.atom { render_feed(@issues, :title => "#{@project || Setting.app_title}: #{l(:label_issue_plural)}") }
                     format.csv  { send_data(issues_to_csv(@issues, @project), :type => 'text/csv; header=present', :filename => 'export.csv') }
                     format.pdf  { send_data(issues_to_pdf(@issues, @project, @query), :type => 'application/pdf', :filename => 'export.pdf') }
                   end
                 else
                   # Send html if the query is not valid
                   render(:template => 'issues/index.rhtml', :layout => !request.xhr?)
                 end
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               def changes
                 retrieve_query
                 sort_init 'id', 'desc'
                 sort_update(@query.sortable_columns)
                 if @query.valid?
                   @journals = @query.journals(:order => "#{Journal.table_name}.created_on DESC",
                                               :limit => 25)
                 end
                 @title = (@project ? @project.name : Setting.app_title) + ": " + (@query.new_record? ? l(:label_changes_details) : @query.name)
                 render :layout => false, :content_type => 'application/atom+xml'
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               def show
                 @journals = @issue.journals.find(:all, :include => [:user, :details], :order => "#{Journal.table_name}.created_on ASC")
                 @journals.each_with_index {|j,i| j.indice = i+1}
                 @journals.reverse! if User.current.wants_comments_in_reverse_order?
                 @changesets = @issue.changesets.visible.all
                 @changesets.reverse! if User.current.wants_comments_in_reverse_order?
                 @allowed_statuses = @issue.new_statuses_allowed_to(User.current)
                 @edit_allowed = User.current.allowed_to?(:edit_issues, @project)
                 @priorities = IssuePriority.all
                 @time_entry = TimeEntry.new
                 respond_to do |format|
                   format.html { render :template => 'issues/show.rhtml' }
                   format.xml  { render :layout => false }
+                  format.json { render :text => @issue.to_json, :layout => false }
                   format.atom { render :action => 'changes', :layout => false, :content_type => 'application/atom+xml' }
                   format.pdf  { send_data(issue_to_pdf(@issue), :type => 'application/pdf', :filename => "#{@project.identifier}-#{@issue.id}.pdf") }
                 end
               end
               # Add a new issue
               # The new issue will be created from an existing one if copy_from parameter is given
               def new
                 render :action => 'new', :layout => !request.xhr?
               end
               def create
                 call_hook(:controller_issues_new_before_save, { :params => params, :issue => @issue })
                 if @issue.save
                   attachments = Attachment.attach_files(@issue, params[:attachments])
                   render_attachment_warning_if_needed(@issue)
                   flash[:notice] = l(:notice_successful_create)
                   call_hook(:controller_issues_new_after_save, { :params => params, :issue => @issue})
                   respond_to do |format|
                     format.html {
                       redirect_to(params[:continue] ? { :action => 'new', :issue => {:tracker_id => @issue.tracker, :parent_issue_id => @issue.parent_issue_id}.reject {|k,v| v.nil?} } :
                                   { :action => 'show', :id => @issue })
                     }
                     format.xml  { render :action => 'show', :status => :created, :location => url_for(:controller => 'issues', :action => 'show', :id => @issue) }
+                    format.json { render :text => @issue.to_json, :status => :created, :location => url_for(:controller => 'issues', :action => 'show'), :layout => false }
                   end
                   return
                 else
                   respond_to do |format|
                     format.html { render :action => 'new' }
                     format.xml  { render(:xml => @issue.errors, :status => :unprocessable_entity); return }
+                    format.json { render :text => object_errors_to_json(@issue), :status => :unprocessable_entity, :layout => false }
                   end
                 end
               end
               # Attributes that can be updated on workflow transition (without :edit permission)
               # TODO: make it configurable (at least per role)
               UPDATABLE_ATTRS_ON_TRANSITION = %w(status_id assigned_to_id fixed_version_id done_ratio) unless const_defined?(:UPDATABLE_ATTRS_ON_TRANSITION)
               def edit
                 update_issue_from_params
                 @journal = @issue.current_journal
                 respond_to do |format|
                   format.html { }
                   format.xml  { }
                 end
               end
               def update
                 update_issue_from_params
                 if @issue.save_issue_with_child_records(params, @time_entry)
                   render_attachment_warning_if_needed(@issue)
                   flash[:notice] = l(:notice_successful_update) unless @issue.current_journal.new_record?
                   respond_to do |format|
                     format.html { redirect_back_or_default({:action => 'show', :id => @issue}) }
                     format.xml  { head :ok }
+                    format.json  { head :ok }
                   end
                 else
                   render_attachment_warning_if_needed(@issue)
                   flash[:notice] = l(:notice_successful_update) unless @issue.current_journal.new_record?
                   @journal = @issue.current_journal
                   respond_to do |format|
                     format.html { render :action => 'edit' }
                     format.xml  { render :xml => @issue.errors, :status => :unprocessable_entity }
+                    format.json { render :text => object_errors_to_json(@issue), :status => :unprocessable_entity, :layout => false }
                   end
                 end
               end
               def reply
                 journal = Journal.find(params[:journal_id]) if params[:journal_id]
                 if journal
                   user = journal.user
                   text = journal.notes
                 else
                   user = @issue.author
                   text = @issue.description
                 end
                 # Replaces pre blocks with [...]
                 text = text.to_s.strip.gsub(%r{<pre>((.|\s)*?)</pre>}m, '[...]')
                 content = "#{ll(Setting.default_language, :text_user_wrote, user)}\n> "
                 content << text.gsub(/(\r?\n|\r\n?)/, "\n> ") + "\n\n"
                 render(:update) { |page|
                   page.<< "$('notes').value = \"#{escape_javascript content}\";"
                   page.show 'update'
                   page << "Form.Element.focus('notes');"
                   page << "Element.scrollTo('update');"
                   page << "$('notes').scrollTop = $('notes').scrollHeight - $('notes').clientHeight;"
                 }
               end
               # Bulk edit a set of issues
               def bulk_edit
                 @issues.sort!
                 if request.post?
                   attributes = (params[:issue] || {}).reject {|k,v| v.blank?}
                   attributes.keys.each {|k| attributes[k] = '' if attributes[k] == 'none'}
                   attributes[:custom_field_values].reject! {|k,v| v.blank?} if attributes[:custom_field_values]
                   unsaved_issue_ids = []
                   @issues.each do |issue|
                     issue.reload
                     journal = issue.init_journal(User.current, params[:notes])
                     issue.safe_attributes = attributes
                     call_hook(:controller_issues_bulk_edit_before_save, { :params => params, :issue => issue })
                     unless issue.save
                       # Keep unsaved issue ids to display them in flash error
                       unsaved_issue_ids << issue.id
                     end
                   end
                   set_flash_from_bulk_issue_save(@issues, unsaved_issue_ids)
                   redirect_back_or_default({:controller => 'issues', :action => 'index', :project_id => @project})
                   return
                 end
                 @available_statuses = Workflow.available_statuses(@project)
                 @custom_fields = @project.all_issue_custom_fields
               end
               def move
                 @issues.sort!
                 @copy = params[:copy_options] && params[:copy_options][:copy]
                 @allowed_projects = Issue.allowed_target_projects_on_move
                 @target_project = @allowed_projects.detect {|p| p.id.to_s == params[:new_project_id]} if params[:new_project_id]
                 @target_project ||= @project
                 @trackers = @target_project.trackers
                 @available_statuses = Workflow.available_statuses(@project)
                 if request.post?
                   new_tracker = params[:new_tracker_id].blank? ? nil : @target_project.trackers.find_by_id(params[:new_tracker_id])
                   unsaved_issue_ids = []
                   moved_issues = []
                   @issues.each do |issue|
                     issue.reload
                     changed_attributes = {}
                     [:assigned_to_id, :status_id, :start_date, :due_date].each do |valid_attribute|
                       unless params[valid_attribute].blank?
                         changed_attributes[valid_attribute] = (params[valid_attribute] == 'none' ? nil : params[valid_attribute])
                       end
                     end
                     issue.init_journal(User.current)
                     call_hook(:controller_issues_move_before_save, { :params => params, :issue => issue, :target_project => @target_project, :copy => !!@copy })
                     if r = issue.move_to_project(@target_project, new_tracker, {:copy => @copy, :attributes => changed_attributes})
                       moved_issues << r
                     else
                       unsaved_issue_ids << issue.id
                     end
                   end
                   set_flash_from_bulk_issue_save(@issues, unsaved_issue_ids)
                   if params[:follow]
                     if @issues.size == 1 && moved_issues.size == 1
                       redirect_to :controller => 'issues', :action => 'show', :id => moved_issues.first
                     else
                       redirect_to :controller => 'issues', :action => 'index', :project_id => (@target_project || @project)
                     end
                   else
                     redirect_to :controller => 'issues', :action => 'index', :project_id => @project
                   end
                   return
                 end
                 render :layout => false if request.xhr?
               end
               def destroy
                 @hours = TimeEntry.sum(:hours, :conditions => ['issue_id IN (?)', @issues]).to_f
                 if @hours > 0
                   case params[:todo]
                   when 'destroy'
                     # nothing to do
                   when 'nullify'
                     TimeEntry.update_all('issue_id = NULL', ['issue_id IN (?)', @issues])
                   when 'reassign'
                     reassign_to = @project.issues.find_by_id(params[:reassign_to_id])
                     if reassign_to.nil?
                       flash.now[:error] = l(:error_issue_not_found_in_project)
                       return
                     else
                       TimeEntry.update_all("issue_id = #{reassign_to.id}", ['issue_id IN (?)', @issues])
                     end
                   else
-                    unless params[:format] == 'xml'
+                    unless params[:format] == 'xml' || params[:format] == 'json'
                       # display the destroy form if it's a user request
                       return
                     end
                   end
                 end
                 @issues.each(&:destroy)
                 respond_to do |format|
                   format.html { redirect_to :action => 'index', :project_id => @project }
                   format.xml  { head :ok }
+                  format.json  { head :ok }
                 end
               end
               def context_menu
                 @issues = Issue.find_all_by_id(params[:ids], :include => :project)
                 if (@issues.size == 1)
                   @issue = @issues.first
                   @allowed_statuses = @issue.new_statuses_allowed_to(User.current)
                 end
                 projects = @issues.collect(&:project).compact.uniq
                 @project = projects.first if projects.size == 1
                 @can = {:edit => (@project && User.current.allowed_to?(:edit_issues, @project)),
                         :log_time => (@project && User.current.allowed_to?(:log_time, @project)),
                         :update => (@project && (User.current.allowed_to?(:edit_issues, @project) || (User.current.allowed_to?(:change_status, @project) && @allowed_statuses && !@allowed_statuses.empty?))),
                         :move => (@project && User.current.allowed_to?(:move_issues, @project)),
                         :copy => (@issue && @project.trackers.include?(@issue.tracker) && User.current.allowed_to?(:add_issues, @project)),
                         :delete => (@project && User.current.allowed_to?(:delete_issues, @project))
                         }
                 if @project
                   @assignables = @project.assignable_users
                   @assignables << @issue.assigned_to if @issue && @issue.assigned_to && !@assignables.include?(@issue.assigned_to)
                   @trackers = @project.trackers
                 end
                 @priorities = IssuePriority.all.reverse
                 @statuses = IssueStatus.find(:all, :order => 'position')
                 @back = params[:back_url] || request.env['HTTP_REFERER']
                 render :layout => false
               end
               def update_form
                 if params[:id].blank?
                   @issue = Issue.new
                   @issue.project = @project
                 else
                   @issue = @project.issues.visible.find(params[:id])
                 end
                 @issue.attributes = params[:issue]
                 @allowed_statuses = ([@issue.status] + @issue.status.find_new_statuses_allowed_to(User.current.roles_for_project(@project), @issue.tracker)).uniq
                 @priorities = IssuePriority.all
                 render :partial => 'attributes'
               end
               def preview
                 @issue = @project.issues.find_by_id(params[:id]) unless params[:id].blank?
                 if @issue
                   @attachements = @issue.attachments
                   @description = params[:issue] && params[:issue][:description]
                   if @description && @description.gsub(/(\r?\n|\n\r?)/, "\n") == @issue.description.to_s.gsub(/(\r?\n|\n\r?)/, "\n")
                     @description = nil
                   end
                   @notes = params[:notes]
                 else
                   @description = (params[:issue] ? params[:issue][:description] : nil)
                 end
                 render :layout => false
               end
               def auto_complete
                 @issues = []
                 q = params[:q].to_s
                 if q.match(/^\d+$/)
                   @issues << @project.issues.visible.find_by_id(q.to_i)
                 end
                 unless q.blank?
                   @issues += @project.issues.visible.find(:all, :conditions => ["LOWER(#{Issue.table_name}.subject) LIKE ?", "%#{q.downcase}%"], :limit => 10)
                 end
                 render :layout => false
               end
             private
               def find_issue
                 @issue = Issue.find(params[:id], :include => [:project, :tracker, :status, :author, :priority, :category])
                 @project = @issue.project
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               # Filter for bulk operations
               def find_issues
                 @issues = Issue.find_all_by_id(params[:id] || params[:ids])
                 raise ActiveRecord::RecordNotFound if @issues.empty?
                 projects = @issues.collect(&:project).compact.uniq
                 if projects.size == 1
                   @project = projects.first
                 else
                   # TODO: let users bulk edit/move/destroy issues from different projects
                   render_error 'Can not bulk edit/move/destroy issues from different projects'
                   return false
                 end
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               def find_project
                 project_id = (params[:issue] && params[:issue][:project_id]) || params[:project_id]
                 @project = Project.find(project_id)
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               # Used by #edit and #update to set some common instance variables
               # from the params
               # TODO: Refactor, not everything in here is needed by #edit
               def update_issue_from_params
                 @allowed_statuses = @issue.new_statuses_allowed_to(User.current)
                 @priorities = IssuePriority.all
                 @edit_allowed = User.current.allowed_to?(:edit_issues, @project)
                 @time_entry = TimeEntry.new
                 @notes = params[:notes]
                 @issue.init_journal(User.current, @notes)
                 # User can change issue attributes only if he has :edit permission or if a workflow transition is allowed
                 if (@edit_allowed || !@allowed_statuses.empty?) && params[:issue]
                   attrs = params[:issue].dup
                   attrs.delete_if {|k,v| !UPDATABLE_ATTRS_ON_TRANSITION.include?(k) } unless @edit_allowed
                   attrs.delete(:status_id) unless @allowed_statuses.detect {|s| s.id.to_s == attrs[:status_id].to_s}
                   @issue.safe_attributes = attrs
                 end
               end
               # TODO: Refactor, lots of extra code in here
               def build_new_issue_from_params
                 @issue = Issue.new
                 @issue.copy_from(params[:copy_from]) if params[:copy_from]
                 @issue.project = @project
                 # Tracker must be set before custom field values
                 @issue.tracker ||= @project.trackers.find((params[:issue] && params[:issue][:tracker_id]) || params[:tracker_id] || :first)
                 if @issue.tracker.nil?
                   render_error l(:error_no_tracker_in_project)
                   return false
                 end
                 if params[:issue].is_a?(Hash)
                   @issue.safe_attributes = params[:issue]
                   @issue.watcher_user_ids = params[:issue]['watcher_user_ids'] if User.current.allowed_to?(:add_issue_watchers, @project)
                 end
                 @issue.author = User.current
                 @issue.start_date ||= Date.today
                 @priorities = IssuePriority.all
                 @allowed_statuses = @issue.new_statuses_allowed_to(User.current, true)
               end
               def set_flash_from_bulk_issue_save(issues, unsaved_issue_ids)
                 if unsaved_issue_ids.empty?
                   flash[:notice] = l(:notice_successful_update) unless issues.empty?
                 else
                   flash[:error] = l(:notice_failed_to_save_issues,
                                     :count => unsaved_issue_ids.size,
                                     :total => issues.size,
                                     :ids => '#' + unsaved_issue_ids.join(', #'))
                 end
               end
               def check_for_default_issue_status
                 if IssueStatus.default.nil?
                   render_error l(:error_no_default_issue_status)
                   return false
                 end
               end
             end

test/integration/issues_api_test.rb +152 0

             # Redmine - project management software
             # Copyright (C) 2006-2010  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.dirname(__FILE__)}/../test_helper"
             class IssuesApiTest < ActionController::IntegrationTest
               fixtures :projects,
                 :users,
                 :roles,
                 :members,
                 :member_roles,
                 :issues,
                 :issue_statuses,
                 :versions,
                 :trackers,
                 :projects_trackers,
                 :issue_categories,
                 :enabled_modules,
                 :enumerations,
                 :attachments,
                 :workflows,
                 :custom_fields,
                 :custom_values,
                 :custom_fields_projects,
                 :custom_fields_trackers,
                 :time_entries,
                 :journals,
                 :journal_details,
                 :queries
               def setup
                 Setting.rest_api_enabled = '1'
               end
               context "/index.xml" do
                 setup do
                   get '/issues.xml'
                 end
                 should_respond_with :success
                 should_respond_with_content_type 'application/xml'
               end
+              context "/index.json" do
+                setup do
+                  get '/issues.json'
+                end
+                should_respond_with :success
+                should_respond_with_content_type 'application/json'
+                should 'return a valid JSON string' do
+                  assert ActiveSupport::JSON.decode(response.body)
+                end
+              end
               context "/index.xml with filter" do
                 setup do
                   get '/issues.xml?status_id=5'
                 end
                 should_respond_with :success
                 should_respond_with_content_type 'application/xml'
                 should "show only issues with the status_id" do
                   assert_tag :tag => 'issues',
                              :children => { :count => Issue.visible.count(:conditions => {:status_id => 5}),
                                             :only => { :tag => 'issue' } }
                 end
               end
+              context "/index.json with filter" do
+                setup do
+                  get '/issues.json?status_id=5'
+                end
+                should_respond_with :success
+                should_respond_with_content_type 'application/json'
+                should 'return a valid JSON string' do
+                  assert ActiveSupport::JSON.decode(response.body)
+                end
+                should "show only issues with the status_id" do
+                  json = ActiveSupport::JSON.decode(response.body)
+                  status_ids_used = json.collect {|j| j['status_id'] }
+                  assert_equal 3, status_ids_used.length
+                  assert status_ids_used.all? {|id| id == 5 }
+                end
+              end
               context "/issues/1.xml" do
                 setup do
                   get '/issues/1.xml'
                 end
                 should_respond_with :success
                 should_respond_with_content_type 'application/xml'
               end
+              context "/issues/1.json" do
+                setup do
+                  get '/issues/1.json'
+                end
+                should_respond_with :success
+                should_respond_with_content_type 'application/json'
+                should 'return a valid JSON string' do
+                  assert ActiveSupport::JSON.decode(response.body)
+                end
+              end
               context "POST /issues.xml" do
                 setup do
                   @issue_count = Issue.count
                   @attributes = {:project_id => 1, :subject => 'API test', :tracker_id => 2, :status_id => 3}
                   post '/issues.xml', {:issue => @attributes}, :authorization => credentials('jsmith')
                 end
                 should_respond_with :created
                 should_respond_with_content_type 'application/xml'
                 should "create an issue with the attributes" do
                   assert_equal Issue.count, @issue_count + 1
                   issue = Issue.first(:order => 'id DESC')
                   @attributes.each do |attribute, value|
                     assert_equal value, issue.send(attribute)
                   end
                 end
               end
               context "POST /issues.xml with failure" do
                 setup do
                   @attributes = {:project_id => 1}
                   post '/issues.xml', {:issue => @attributes}, :authorization => credentials('jsmith')
                 end
                 should_respond_with :unprocessable_entity
                 should_respond_with_content_type 'application/xml'
                 should "have an errors tag" do
                   assert_tag :errors, :child => {:tag => 'error', :content => "Subject can't be blank"}
                 end
               end
+              context "POST /issues.json" do
+                setup do
+                  @issue_count = Issue.count
+                  @attributes = {:project_id => 1, :subject => 'API test', :tracker_id => 2, :status_id => 3}
+                  post '/issues.json', {:issue => @attributes}, :authorization => credentials('jsmith')
+                end
+                should_respond_with :created
+                should_respond_with_content_type 'application/json'
+                should "create an issue with the attributes" do
+                  assert_equal Issue.count, @issue_count + 1
+                  issue = Issue.first(:order => 'id DESC')
+                  @attributes.each do |attribute, value|
+                    assert_equal value, issue.send(attribute)
+                  end
+                end
+              end
+              context "POST /issues.json with failure" do
+                setup do
+                  @attributes = {:project_id => 1}
+                  post '/issues.json', {:issue => @attributes}, :authorization => credentials('jsmith')
+                end
+                should_respond_with :unprocessable_entity
+                should_respond_with_content_type 'application/json'
+                should "have an errors element" do
+                  json = ActiveSupport::JSON.decode(response.body)
+                  assert_equal "can't be blank", json.first['subject']
+                end
+              end
               context "PUT /issues/1.xml" do
                 setup do
                   @issue_count = Issue.count
                   @journal_count = Journal.count
                   @attributes = {:subject => 'API update'}
                   put '/issues/1.xml', {:issue => @attributes}, :authorization => credentials('jsmith')
                 end
                 should_respond_with :ok
                 should_respond_with_content_type 'application/xml'
                 should "not create a new issue" do
                   assert_equal Issue.count, @issue_count
                 end
                 should "create a new journal" do
                   assert_equal Journal.count, @journal_count + 1
                 end
                 should "update the issue" do
                   issue = Issue.find(1)
                   @attributes.each do |attribute, value|
                     assert_equal value, issue.send(attribute)
                   end
                 end
               end
               context "PUT /issues/1.xml with failed update" do
                 setup do
                   @attributes = {:subject => ''}
                   @issue_count = Issue.count
                   @journal_count = Journal.count
                   put '/issues/1.xml', {:issue => @attributes}, :authorization => credentials('jsmith')
                 end
                 should_respond_with :unprocessable_entity
                 should_respond_with_content_type 'application/xml'
                 should "not create a new issue" do
                   assert_equal Issue.count, @issue_count
                 end
                 should "not create a new journal" do
                   assert_equal Journal.count, @journal_count
                 end
                 should "have an errors tag" do
                   assert_tag :errors, :child => {:tag => 'error', :content => "Subject can't be blank"}
                 end
               end
+              context "PUT /issues/1.json" do
+                setup do
+                  @issue_count = Issue.count
+                  @journal_count = Journal.count
+                  @attributes = {:subject => 'API update'}
+                  put '/issues/1.json', {:issue => @attributes}, :authorization => credentials('jsmith')
+                end
+                should_respond_with :ok
+                should_respond_with_content_type 'application/json'
+                should "not create a new issue" do
+                  assert_equal Issue.count, @issue_count
+                end
+                should "create a new journal" do
+                  assert_equal Journal.count, @journal_count + 1
+                end
+                should "update the issue" do
+                  issue = Issue.find(1)
+                  @attributes.each do |attribute, value|
+                    assert_equal value, issue.send(attribute)
+                  end
+                end
+              end
+              context "PUT /issues/1.json with failed update" do
+                setup do
+                  @attributes = {:subject => ''}
+                  @issue_count = Issue.count
+                  @journal_count = Journal.count
+                  put '/issues/1.json', {:issue => @attributes}, :authorization => credentials('jsmith')
+                end
+                should_respond_with :unprocessable_entity
+                should_respond_with_content_type 'application/json'
+                should "not create a new issue" do
+                  assert_equal Issue.count, @issue_count
+                end
+                should "not create a new journal" do
+                  assert_equal Journal.count, @journal_count
+                end
+                should "have an errors attribute" do
+                  json = ActiveSupport::JSON.decode(response.body)
+                  assert_equal "can't be blank", json.first['subject']
+                end
+              end
               context "DELETE /issues/1.xml" do
                 setup do
                   @issue_count = Issue.count
                   delete '/issues/1.xml', {}, :authorization => credentials('jsmith')
                 end
                 should_respond_with :ok
                 should_respond_with_content_type 'application/xml'
                 should "delete the issue" do
                   assert_equal Issue.count, @issue_count -1
                   assert_nil Issue.find_by_id(1)
                 end
               end
+              context "DELETE /issues/1.json" do
+                setup do
+                  @issue_count = Issue.count
+                  delete '/issues/1.json', {}, :authorization => credentials('jsmith')
+                end
+                should_respond_with :ok
+                should_respond_with_content_type 'application/json'
+                should "delete the issue" do
+                  assert_equal Issue.count, @issue_count -1
+                  assert_nil Issue.find_by_id(1)
+                end
+              end
               def credentials(user, password=nil)
                 ActionController::HttpAuthentication::Basic.encode_credentials(user, password || user)
               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