jro_apps/redmine Commit - r6175:f89483a206b4

REST API for reading attachments (#7671)....

Jean-Philippe Lang -

r6175:f89483a206b4

parent child

Context file:

r6175:f89483a206b4

Collapse all files

app/views/attachments/show.api.rsb created 644 +1 0

	@@ -0,0 +1,1
				1	render_api_attachment(@attachment, api)

test/integration/api_test/attachments_test.rb created 644 +78 0

@@ -0,0 +1,78
	1	# Redmine - project management software
	2	# Copyright (C) 2006-2011 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::AttachmentsTest < ActionController::IntegrationTest
	21	fixtures :all
	22
	23	def setup
	24	Setting.rest_api_enabled = '1'
	25	Attachment.storage_path = "#{Rails.root}/test/fixtures/files"
	26	end
	27
	28	context "/attachments/:id" do
	29	context "GET" do
	30	should "return the attachment" do
	31	get '/attachments/7.xml', {}, :authorization => credentials('jsmith')
	32
	33	assert_response :success
	34	assert_equal 'application/xml', @response.content_type
	35	assert_tag :tag => 'attachment',
	36	:child => {
	37	:tag => 'id',
	38	:content => '7',
	39	:sibling => {
	40	:tag => 'filename',
	41	:content => 'archive.zip',
	42	:sibling => {
	43	:tag => 'content_url',
	44	:content => 'http://www.example.com/attachments/download/7/archive.zip'
	45	}
	46	}
	47	}
	48	end
	49
	50	should "deny access without credentials" do
	51	get '/attachments/7.xml'
	52
	53	assert_response 401
	54	end
	55	end
	56	end
	57
	58	context "/attachments/download/:id/:filename" do
	59	context "GET" do
	60	should "return the attachment content" do
	61	get '/attachments/download/7/archive.zip', {}, :authorization => credentials('jsmith')
	62
	63	assert_response :success
	64	assert_equal 'application/octet-stream', @response.content_type
	65	end
	66
	67	should "deny access without credentials" do
	68	get '/attachments/download/7/archive.zip'
	69
	70	assert_response 302
	71	end
	72	end
	73	end
	74
	75	def credentials(user, password=nil)
	76	ActionController::HttpAuthentication::Basic.encode_credentials(user, password \|\| user)
	77	end
	78	end

app/controllers/attachments_controller.rb +15 -9

               before_filter :file_readable, :read_authorize, :except => :destroy
               before_filter :delete_authorize, :only => :destroy
-              verify :method => :post, :only => :destroy
+              accept_api_auth :show, :download
               def show
-                if @attachment.is_diff?
+                respond_to do |format|
-                  @diff = File.new(@attachment.diskfile, "rb").read
+                  format.html {
-                  render :action => 'diff'
+                    if @attachment.is_diff?
-                elsif @attachment.is_text? && @attachment.filesize <= Setting.file_max_size_displayed.to_i.kilobyte
+                      @diff = File.new(@attachment.diskfile, "rb").read
-                  @content = File.new(@attachment.diskfile, "rb").read
+                      render :action => 'diff'
-                  render :action => 'file'
+                    elsif @attachment.is_text? && @attachment.filesize <= Setting.file_max_size_displayed.to_i.kilobyte
-                else
+                      @content = File.new(@attachment.diskfile, "rb").read
-                  download
+                      render :action => 'file'
+                    else
+                      download
+                    end
+                  }
+                  format.api
                 end
               end
               end
+              verify :method => :post, :only => :destroy
               def destroy
                 # Make sure association callbacks are called
                 @attachment.container.attachments.delete(@attachment)

app/helpers/attachments_helper.rb +13 0

@@ -43,4 +43,17 module AttachmentsHelper
43	str	43	str
44	end	44	end
45	end	45	end
		46
		47	def render_api_attachment(attachment, api)
		48	api.attachment do
		49	api.id attachment.id
		50	api.filename attachment.filename
		51	api.filesize attachment.filesize
		52	api.content_type attachment.content_type
		53	api.description attachment.description
		54	api.content_url url_for(:controller => 'attachments', :action => 'download', :id => attachment, :filename => attachment.filename, :only_path => false)
		55	api.author(:id => attachment.author.id, :name => attachment.author.name) if attachment.author
		56	api.created_on attachment.created_on
		57	end
		58	end
46	end	59	end

app/views/issues/show.api.rsb +6 0

               render_api_issue_children(@issue, api) if include_in_api_response?('children')
+              api.array :attachments do
+                @issue.attachments.each do |attachment|
+                  render_api_attachment(attachment, api)
+                end
+              end if include_in_api_response?('attachments')
               api.array :relations do
                 @relations.each do |relation|
                   api.relation(:id => relation.id, :issue_id => relation.issue_from_id, :issue_to_id => relation.issue_to_id, :relation_type => relation.relation_type, :delay => relation.delay)

config/routes.rb +1 0

               end
               map.connect 'attachments/:id', :controller => 'attachments', :action => 'show', :id => /\d+/
+              map.connect 'attachments/:id.:format', :controller => 'attachments', :action => 'show', :id => /\d+/
               map.connect 'attachments/:id/:filename', :controller => 'attachments', :action => 'show', :id => /\d+/, :filename => /.*/
               map.connect 'attachments/download/:id/:filename', :controller => 'attachments', :action => 'download', :id => /\d+/, :filename => /.*/

test/integration/api_test/issues_test.rb +28 -2

@@ -1,5 +1,5
1	# Redmine - project management software	1	# Redmine - project management software
2	# Copyright (C) 2006-2010 Jean-Philippe Lang	2	# Copyright (C) 2006-2011 Jean-Philippe Lang
3	#	3	#
4	# This program is free software; you can redistribute it and/or	4	# This program is free software; you can redistribute it and/or
5	# modify it under the terms of the GNU General Public License	5	# modify it under the terms of the GNU General Public License
@@ -40,7 +40,8 class ApiTest::IssuesTest < ActionController::IntegrationTest
40	:time_entries,	40	:time_entries,
41	:journals,	41	:journals,
42	:journal_details,	42	:journal_details,
43	:queries	43	:queries,
		44	:attachments
44		45
45	def setup	46	def setup
46	Setting.rest_api_enabled = '1'	47	Setting.rest_api_enabled = '1'
@@ -201,6 +202,31 class ApiTest::IssuesTest < ActionController::IntegrationTest
201	end	202	end
202	end	203	end
203		204
		205	context "with attachments" do
		206	context ".xml" do
		207	should "display attachments" do
		208	get '/issues/3.xml?include=attachments'
		209
		210	assert_tag :tag => 'issue',
		211	:child => {
		212	:tag => 'attachments',
		213	:children => {:count => 5},
		214	:child => {
		215	:tag => 'attachment',
		216	:child => {
		217	:tag => 'filename',
		218	:content => 'source.rb',
		219	:sibling => {
		220	:tag => 'content_url',
		221	:content => 'http://www.example.com/attachments/download/4/source.rb'
		222	}
		223	}
		224	}
		225	}
		226	end
		227	end
		228	end
		229
204	context "with subtasks" do	230	context "with subtasks" do
205	setup do	231	setup do
206	@c1 = Issue.generate!(:status_id => 1, :subject => "child c1", :tracker_id => 1, :project_id => 1, :parent_issue_id => 1)	232	@c1 = Issue.generate!(:status_id => 1, :subject => "child c1", :tracker_id => 1, :project_id => 1, :parent_issue_id => 1)

test/integration/routing_test.rb +2 0

               context "attachments" do
                 should_route :get, "/attachments/1", :controller => 'attachments', :action => 'show', :id => '1'
+                should_route :get, "/attachments/1.xml", :controller => 'attachments', :action => 'show', :id => '1', :format => 'xml'
+                should_route :get, "/attachments/1.json", :controller => 'attachments', :action => 'show', :id => '1', :format => 'json'
                 should_route :get, "/attachments/1/filename.ext", :controller => 'attachments', :action => 'show', :id => '1', :filename => 'filename.ext'
                 should_route :get, "/attachments/download/1", :controller => 'attachments', :action => 'download', :id => '1'
                 should_route :get, "/attachments/download/1/filename.ext", :controller => 'attachments', :action => 'download', :id => '1', :filename => 'filename.ext'

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