ability to update and get a raw snippet via API

This commit is contained in:
Nihad Abbasov 2012-07-04 02:03:32 -07:00
parent fbd559d44f
commit 61910eb8fa
2 changed files with 59 additions and 1 deletions

View file

@ -86,6 +86,34 @@ module Gitlab
end
end
# Update an existing project snippet
#
# Parameters:
# id (required) - The code name of a project
# snippet_id (required) - The ID of a project snippet
# title (optional) - The title of a snippet
# file_name (optional) - The name of a snippet file
# lifetime (optional) - The expiration date of a snippet
# code (optional) - The content of a snippet
# Example Request:
# PUT /projects/:id/snippets/:snippet_id
put ":id/snippets/:snippet_id" do
@project = current_user.projects.find_by_code(params[:id])
@snippet = @project.snippets.find(params[:snippet_id])
parameters = {
:title => (params[:title] || @snippet.title),
:file_name => (params[:file_name] || @snippet.file_name),
:expires_at => (params[:lifetime] || @snippet.expires_at),
:content => (params[:code] || @snippet.content)
}
if @snippet.update_attributes(parameters)
present @snippet, :with => Entities::ProjectSnippet
else
error!({'message' => '404 Not found'}, 404)
end
end
# Delete a project snippet
#
# Parameters:
@ -98,6 +126,19 @@ module Gitlab
@snippet = @project.snippets.find(params[:snippet_id])
@snippet.destroy
end
# Get a raw project snippet
#
# Parameters:
# id (required) - The code of a project
# snippet_id (required) - The ID of a project snippet
# Example Request:
# GET /projects/:id/snippets/:snippet_id/raw
get ":id/snippets/:snippet_id/raw" do
@project = current_user.projects.find_by_code(params[:id])
@snippet = @project.snippets.find(params[:snippet_id])
present @snippet.content
end
end
end
end

View file

@ -3,7 +3,7 @@ require 'spec_helper'
describe Gitlab::API do
let(:user) { Factory :user }
let!(:project) { Factory :project, :owner => user }
let!(:snippet) { Factory :snippet, :author => user, :project => project }
let!(:snippet) { Factory :snippet, :author => user, :project => project, :title => 'example' }
before { project.add_access(user, :read) }
describe "GET /projects" do
@ -67,6 +67,16 @@ describe Gitlab::API do
end
end
describe "PUT /projects/:id/snippets" do
it "should update an existing project snippet" do
put "#{api_prefix}/projects/#{project.code}/snippets/#{snippet.id}?private_token=#{user.private_token}",
:code => 'updated code'
response.status.should == 200
json_response['title'].should == 'example'
snippet.reload.content.should == 'updated code'
end
end
describe "DELETE /projects/:id/snippets/:snippet_id" do
it "should create a new project snippet" do
expect {
@ -74,4 +84,11 @@ describe Gitlab::API do
}.should change { Snippet.count }.by(-1)
end
end
describe "GET /projects/:id/snippets/:snippet_id/raw" do
it "should get a raw project snippet" do
get "#{api_prefix}/projects/#{project.code}/snippets/#{snippet.id}/raw?private_token=#{user.private_token}"
response.status.should == 200
end
end
end