jro_apps/redmine Commit - r15727:e068f855dcc7

Files REST API (#19116)....

Jean-Philippe Lang -

r15727:e068f855dcc7

parent child

Context file:

r15727:e068f855dcc7

Collapse all files

app/views/files/index.api.rsb created 644 +14 0

@@ -0,0 +1,14
	1	api.array :files do
	2	@containers.each do \|container\|
	3	container.attachments.each do \|attachment\|
	4	api.file do
	5	render_api_attachment_attributes(attachment, api)
	6	if container.is_a?(Version)
	7	api.version :id => container.id, :name => container.name
	8	end
	9	api.digest attachment.digest
	10	api.downloads attachment.downloads
	11	end
	12	end
	13	end
	14	end

test/integration/api_test/files_test.rb created 644 +115 0

@@ -0,0 +1,115
	1	# Redmine - project management software
	2	# Copyright (C) 2006-2015 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 Redmine::ApiTest::FilesTest < Redmine::ApiTest::Base
	21	fixtures :projects,
	22	:users,
	23	:members,
	24	:roles,
	25	:member_roles,
	26	:enabled_modules,
	27	:attachments,
	28	:versions
	29
	30	test "GET /projects/:project_id/files.xml should return the list of uploaded files" do
	31	get '/projects/1/files.xml', {}, credentials('jsmith')
	32	assert_response :success
	33	assert_select 'files>file>id', :text => '8'
	34	end
	35
	36	test "POST /projects/:project_id/files.json should create a file" do
	37	set_tmp_attachments_directory
	38	post '/uploads.xml', 'File content', {"CONTENT_TYPE" => 'application/octet-stream'}.merge(credentials('jsmith'))
	39	token = Attachment.last.token
	40	payload = <<-JSON
	41	{ "file": {
	42	"token": "#{token}"
	43	}
	44	}
	45	JSON
	46	post '/projects/1/files.json', payload, {"CONTENT_TYPE" => 'application/json'}.merge(credentials('jsmith'))
	47	assert_response :success
	48	assert_equal 1, Attachment.last.container_id
	49	assert_equal "Project", Attachment.last.container_type
	50	end
	51
	52	test "POST /projects/:project_id/files.xml should create a file" do
	53	set_tmp_attachments_directory
	54	post '/uploads.xml', 'File content', {"CONTENT_TYPE" => 'application/octet-stream'}.merge(credentials('jsmith'))
	55	token = Attachment.last.token
	56	payload = <<-XML
	57	<file>
	58	<token>#{token}</token>
	59	</file>
	60	XML
	61	post '/projects/1/files.xml', payload, {"CONTENT_TYPE" => 'application/xml'}.merge(credentials('jsmith'))
	62	assert_response :success
	63	assert_equal 1, Attachment.last.container_id
	64	assert_equal "Project", Attachment.last.container_type
	65	end
	66
	67	test "POST /projects/:project_id/files.json should refuse requests without the :token parameter" do
	68	payload = <<-JSON
	69	{ "file": {
	70	"filename": "project_file.zip",
	71	}
	72	}
	73	JSON
	74	post '/projects/1/files.json', payload, {"CONTENT_TYPE" => 'application/json'}.merge(credentials('jsmith'))
	75	assert_response :bad_request
	76	end
	77
	78	test "POST /projects/:project_id/files.json should accept :filename, :description, :content_type as optional parameters" do
	79	set_tmp_attachments_directory
	80	post '/uploads.xml', 'File content', {"CONTENT_TYPE" => 'application/octet-stream'}.merge(credentials('jsmith'))
	81	token = Attachment.last.token
	82	payload = <<-JSON
	83	{ "file": {
	84	"filename": "New filename",
	85	"description": "New description",
	86	"content_type": "application/txt",
	87	"token": "#{token}"
	88	}
	89	}
	90	JSON
	91	post '/projects/1/files.json', payload, {"CONTENT_TYPE" => 'application/json'}.merge(credentials('jsmith'))
	92	assert_response :success
	93	assert_equal "New filename", Attachment.last.filename
	94	assert_equal "New description", Attachment.last.description
	95	assert_equal "application/txt", Attachment.last.content_type
	96	end
	97
	98	test "POST /projects/:project_id/files.json should accept :version_id to attach the files to a version" do
	99	set_tmp_attachments_directory
	100	post '/uploads.xml', 'File content', {"CONTENT_TYPE" => 'application/octet-stream'}.merge(credentials('jsmith'))
	101	token = Attachment.last.token
	102	payload = <<-JSON
	103	{ "file": {
	104	"version_id": 3,
	105	"filename": "New filename",
	106	"description": "New description",
	107	"token": "#{token}"
	108	}
	109	}
	110	JSON
	111	post '/projects/1/files.json', payload, {"CONTENT_TYPE" => 'application/json'}.merge(credentials('jsmith'))
	112	assert_equal 3, Attachment.last.container_id
	113	assert_equal "Version", Attachment.last.container_type
	114	end
	115	end

app/controllers/files_controller.rb +22 -8

             # Redmine - project management software
             # Copyright (C) 2006-2016  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 FilesController < ApplicationController
               menu_item :files
               before_action :find_project_by_project_id
               before_action :authorize
+              accept_api_auth :index, :create
+              helper :attachments
               helper :sort
               include SortHelper
               def index
                 sort_init 'filename', 'asc'
                 sort_update 'filename' => "#{Attachment.table_name}.filename",
                             'created_on' => "#{Attachment.table_name}.created_on",
                             'size' => "#{Attachment.table_name}.filesize",
                             'downloads' => "#{Attachment.table_name}.downloads"
                 @containers = [Project.includes(:attachments).
                                  references(:attachments).reorder(sort_clause).find(@project.id)]
                 @containers += @project.versions.includes(:attachments).
                                 references(:attachments).reorder(sort_clause).to_a.sort.reverse
-                render :layout => !request.xhr?
+                respond_to do |format|
+                  format.html { render :layout => !request.xhr? }
+                  format.api
+                end
               end
               def new
                 @versions = @project.versions.sort
               end
               def create
-                container = (params[:version_id].blank? ? @project : @project.versions.find_by_id(params[:version_id]))
+                version_id = params[:version_id] || (params[:file] && params[:file][:version_id])
-                attachments = Attachment.attach_files(container, params[:attachments])
+                container = version_id.blank? ? @project : @project.versions.find_by_id(version_id)
+                attachments = Attachment.attach_files(container, (params[:attachments] || (params[:file] && params[:file][:token] && params)))
                 render_attachment_warning_if_needed(container)
                 if attachments[:files].present?
                   if Setting.notified_events.include?('file_added')
                     Mailer.attachments_added(attachments[:files]).deliver
                   end
-                  flash[:notice] = l(:label_file_added)
+                  respond_to do |format|
-                  redirect_to project_files_path(@project)
+                    format.html {
+                      flash[:notice] = l(:label_file_added)
+                      redirect_to project_files_path(@project) }
+                    format.api { render_api_ok }
+                  end
                 else
-                  flash.now[:error] = l(:label_attachment) + " " + l('activerecord.errors.messages.invalid')
+                  respond_to do |format|
-                  new
+                    format.html {
-                  render :action => 'new'
+                      flash.now[:error] = l(:label_attachment) + " " + l('activerecord.errors.messages.invalid')
+                      new
+                      render :action => 'new' }
+                    format.api { render :status => :bad_request }
+                  end
                 end
               end
             end

app/helpers/attachments_helper.rb +19 -12

             # encoding: utf-8
             #
             # Redmine - project management software
             # Copyright (C) 2006-2016  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.
             module AttachmentsHelper
               def container_attachments_edit_path(container)
                 object_attachments_edit_path container.class.name.underscore.pluralize, container.id
               end
               def container_attachments_path(container)
                 object_attachments_path container.class.name.underscore.pluralize, container.id
               end
               # Displays view/delete links to the attachments of the given object
               # Options:
               #   :author -- author names are not displayed if set to false
               #   :thumbails -- display thumbnails if enabled in settings
               def link_to_attachments(container, options = {})
                 options.assert_valid_keys(:author, :thumbnails)
                 attachments = container.attachments.preload(:author).to_a
                 if attachments.any?
                   options = {
                     :editable => container.attachments_editable?,
                     :deletable => container.attachments_deletable?,
                     :author => true
                   }.merge(options)
                   render :partial => 'attachments/links',
                     :locals => {
                       :container => container,
                       :attachments => attachments,
                       :options => options,
                       :thumbnails => (options[:thumbnails] && Setting.thumbnails_enabled?)
                     }
                 end
               end
-              def render_api_attachment(attachment, api)
+              def render_api_attachment(attachment, api, options={})
                 api.attachment do
-                  api.id attachment.id
+                  render_api_attachment_attributes(attachment, api)
-                  api.filename attachment.filename
+                  options.each { |key, value| eval("api.#{key} value") }
-                  api.filesize attachment.filesize
-                  api.content_type attachment.content_type
-                  api.description attachment.description
-                  api.content_url download_named_attachment_url(attachment, attachment.filename)
-                  if attachment.thumbnailable?
-                    api.thumbnail_url thumbnail_url(attachment)
-                  end
-                  api.author(:id => attachment.author.id, :name => attachment.author.name) if attachment.author
-                  api.created_on attachment.created_on
                 end
               end
+              def render_api_attachment_attributes(attachment, api)
+                api.id attachment.id
+                api.filename attachment.filename
+                api.filesize attachment.filesize
+                api.content_type attachment.content_type
+                api.description attachment.description
+                api.content_url download_named_attachment_url(attachment, attachment.filename)
+                if attachment.thumbnailable?
+                  api.thumbnail_url thumbnail_url(attachment)
+                end
+                if attachment.author
+                  api.author(:id => attachment.author.id, :name => attachment.author.name)
+                end
+                api.created_on attachment.created_on
+              end
             end

test/integration/api_test/api_routing_test.rb +5 0

             # Redmine - project management software
             # Copyright (C) 2006-2016  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::ApiRoutingTest < Redmine::ApiTest::Routing
               def test_attachments
                 should_route 'GET /attachments/1' => 'attachments#show', :id => '1'
                 should_route 'PATCH /attachments/1' => 'attachments#update', :id => '1'
                 should_route 'DELETE /attachments/1' => 'attachments#destroy', :id => '1'
                 should_route 'POST /uploads' => 'attachments#upload'
               end
               def test_custom_fields
                 should_route 'GET /custom_fields' => 'custom_fields#index'
               end
               def test_enumerations
                 should_route 'GET /enumerations/issue_priorities' => 'enumerations#index', :type => 'issue_priorities'
               end
+              def test_files
+                should_route 'GET /projects/foo/files' => 'files#index', :project_id => 'foo'
+                should_route 'POST /projects/foo/files' => 'files#create', :project_id => 'foo'
+              end
               def test_groups
                 should_route 'GET /groups' => 'groups#index'
                 should_route 'POST /groups' => 'groups#create'
                 should_route 'GET /groups/1' => 'groups#show', :id => '1'
                 should_route 'PUT /groups/1' => 'groups#update', :id => '1'
                 should_route 'DELETE /groups/1' => 'groups#destroy', :id => '1'
               end
               def test_group_users
                 should_route 'POST /groups/567/users' => 'groups#add_users', :id => '567'
                 should_route 'DELETE /groups/567/users/12' => 'groups#remove_user', :id => '567', :user_id => '12'
               end
               def test_issue_categories
                 should_route 'GET /projects/foo/issue_categories' => 'issue_categories#index', :project_id => 'foo'
                 should_route 'POST /projects/foo/issue_categories' => 'issue_categories#create', :project_id => 'foo'
                 should_route 'GET /issue_categories/1' => 'issue_categories#show', :id => '1'
                 should_route 'PUT /issue_categories/1' => 'issue_categories#update', :id => '1'
                 should_route 'DELETE /issue_categories/1' => 'issue_categories#destroy', :id => '1'
               end
               def test_issue_relations
                 should_route 'GET /issues/1/relations' => 'issue_relations#index', :issue_id => '1'
                 should_route 'POST /issues/1/relations' => 'issue_relations#create', :issue_id => '1'
                 should_route 'GET /relations/23' => 'issue_relations#show', :id => '23'
                 should_route 'DELETE /relations/23' => 'issue_relations#destroy', :id => '23'
               end
               def test_issue_statuses
                 should_route 'GET /issue_statuses' => 'issue_statuses#index'
               end
               def test_issues
                 should_route 'GET /issues' => 'issues#index'
                 should_route 'POST /issues' => 'issues#create'
                 should_route 'GET /issues/64' => 'issues#show', :id => '64'
                 should_route 'PUT /issues/64' => 'issues#update', :id => '64'
                 should_route 'DELETE /issues/64' => 'issues#destroy', :id => '64'
               end
               def test_issue_watchers
                 should_route 'POST /issues/12/watchers' => 'watchers#create', :object_type => 'issue', :object_id => '12'
                 should_route 'DELETE /issues/12/watchers/3' => 'watchers#destroy', :object_type => 'issue', :object_id => '12', :user_id => '3'
               end
               def test_memberships
                 should_route 'GET /projects/5234/memberships' => 'members#index', :project_id => '5234'
                 should_route 'POST /projects/5234/memberships' => 'members#create', :project_id => '5234'
                 should_route 'GET /memberships/5234' => 'members#show', :id => '5234'
                 should_route 'PUT /memberships/5234' => 'members#update', :id => '5234'
                 should_route 'DELETE /memberships/5234' => 'members#destroy', :id => '5234'
               end
               def test_news
                 should_route 'GET /news' => 'news#index'
                 should_route 'GET /projects/567/news' => 'news#index', :project_id => '567'
               end
               def test_projects
                 should_route 'GET /projects' => 'projects#index'
                 should_route 'POST /projects' => 'projects#create'
                 should_route 'GET /projects/1' => 'projects#show', :id => '1'
                 should_route 'PUT /projects/1' => 'projects#update', :id => '1'
                 should_route 'DELETE /projects/1' => 'projects#destroy', :id => '1'
               end
               def test_queries
                 should_route 'GET /queries' => 'queries#index'
               end
               def test_roles
                 should_route 'GET /roles' => 'roles#index'
                 should_route 'GET /roles/2' => 'roles#show', :id => '2'
               end
               def test_time_entries
                 should_route 'GET /time_entries' => 'timelog#index'
                 should_route 'POST /time_entries' => 'timelog#create'
                 should_route 'GET /time_entries/1' => 'timelog#show', :id => '1'
                 should_route 'PUT /time_entries/1' => 'timelog#update', :id => '1'
                 should_route 'DELETE /time_entries/1' => 'timelog#destroy', :id => '1'
               end
               def test_trackers
                 should_route 'GET /trackers' => 'trackers#index'
               end
               def test_users
                 should_route 'GET /users' => 'users#index'
                 should_route 'POST /users' => 'users#create'
                 should_route 'GET /users/44' => 'users#show', :id => '44'
                 should_route 'GET /users/current' => 'users#show', :id => 'current'
                 should_route 'PUT /users/44' => 'users#update', :id => '44'
                 should_route 'DELETE /users/44' => 'users#destroy', :id => '44'
               end
               def test_versions
                 should_route 'GET /projects/foo/versions' => 'versions#index', :project_id => 'foo'
                 should_route 'POST /projects/foo/versions' => 'versions#create', :project_id => 'foo'
                 should_route 'GET /versions/1' => 'versions#show', :id => '1'
                 should_route 'PUT /versions/1' => 'versions#update', :id => '1'
                 should_route 'DELETE /versions/1' => 'versions#destroy', :id => '1'
               end
               def test_wiki
                 should_route 'GET /projects/567/wiki/index' => 'wiki#index', :project_id => '567'
                 should_route 'GET /projects/567/wiki/my_page' => 'wiki#show', :project_id => '567', :id => 'my_page'
                 should_route 'GET /projects/567/wiki/my_page' => 'wiki#show', :project_id => '567', :id => 'my_page'
                 should_route 'GET /projects/1/wiki/my_page/2' => 'wiki#show', :project_id => '1', :id => 'my_page', :version => '2'
                 should_route 'PUT /projects/567/wiki/my_page' => 'wiki#update', :project_id => '567', :id => 'my_page'
                 should_route 'DELETE /projects/567/wiki/my_page' => 'wiki#destroy', :project_id => '567', :id => 'my_page'
               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