add API version

This commit is contained in:
Nihad Abbasov 2012-07-04 00:48:00 -07:00
parent 378dc55d29
commit fbd559d44f
5 changed files with 37 additions and 34 deletions

View file

@ -2,6 +2,9 @@ Dir["#{Rails.root}/lib/api/*.rb"].each {|file| require file}
module Gitlab module Gitlab
class API < Grape::API class API < Grape::API
VERSION = 'v2'
version VERSION, :using => :path
format :json format :json
error_format :json error_format :json
helpers APIHelpers helpers APIHelpers

View file

@ -8,75 +8,69 @@ describe Gitlab::API do
describe "GET /projects" do describe "GET /projects" do
it "should return authentication error" do it "should return authentication error" do
get "/api/projects" get "#{api_prefix}/projects"
response.status.should == 401 response.status.should == 401
end end
describe "authenticated GET /projects" do describe "authenticated GET /projects" do
it "should return an array of projects" do it "should return an array of projects" do
get "/api/projects?private_token=#{user.private_token}" get "#{api_prefix}/projects?private_token=#{user.private_token}"
response.status.should == 200 response.status.should == 200
json = JSON.parse(response.body) json_response.should be_an Array
json.should be_an Array json_response.first['name'].should == project.name
json.first['name'].should == project.name json_response.first['owner']['email'].should == user.email
json.first['owner']['email'].should == user.email
end end
end end
end end
describe "GET /projects/:id" do describe "GET /projects/:id" do
it "should return a project by id" do it "should return a project by id" do
get "/api/projects/#{project.code}?private_token=#{user.private_token}" get "#{api_prefix}/projects/#{project.code}?private_token=#{user.private_token}"
response.status.should == 200 response.status.should == 200
json = JSON.parse(response.body) json_response['name'].should == project.name
json['name'].should == project.name json_response['owner']['email'].should == user.email
json['owner']['email'].should == user.email
end end
end end
describe "GET /projects/:id/repository/branches" do describe "GET /projects/:id/repository/branches" do
it "should return an array of project branches" do it "should return an array of project branches" do
get "/api/projects/#{project.code}/repository/branches?private_token=#{user.private_token}" get "#{api_prefix}/projects/#{project.code}/repository/branches?private_token=#{user.private_token}"
response.status.should == 200 response.status.should == 200
json = JSON.parse(response.body) json_response.should be_an Array
json.should be_an Array json_response.first['name'].should == project.repo.heads.sort_by(&:name).first.name
json.first['name'].should == project.repo.heads.sort_by(&:name).first.name
end end
end end
describe "GET /projects/:id/repository/tags" do describe "GET /projects/:id/repository/tags" do
it "should return an array of project tags" do it "should return an array of project tags" do
get "/api/projects/#{project.code}/repository/tags?private_token=#{user.private_token}" get "#{api_prefix}/projects/#{project.code}/repository/tags?private_token=#{user.private_token}"
response.status.should == 200 response.status.should == 200
json = JSON.parse(response.body) json_response.should be_an Array
json.should be_an Array json_response.first['name'].should == project.repo.tags.sort_by(&:name).reverse.first.name
json.first['name'].should == project.repo.tags.sort_by(&:name).reverse.first.name
end end
end end
describe "GET /projects/:id/snippets/:snippet_id" do describe "GET /projects/:id/snippets/:snippet_id" do
it "should return a project snippet" do it "should return a project snippet" do
get "/api/projects/#{project.code}/snippets/#{snippet.id}?private_token=#{user.private_token}" get "#{api_prefix}/projects/#{project.code}/snippets/#{snippet.id}?private_token=#{user.private_token}"
response.status.should == 200 response.status.should == 200
json = JSON.parse(response.body) json_response['title'].should == snippet.title
json['title'].should == snippet.title
end end
end end
describe "POST /projects/:id/snippets" do describe "POST /projects/:id/snippets" do
it "should create a new project snippet" do it "should create a new project snippet" do
post "/api/projects/#{project.code}/snippets?private_token=#{user.private_token}", post "#{api_prefix}/projects/#{project.code}/snippets?private_token=#{user.private_token}",
:title => 'api test', :file_name => 'sample.rb', :code => 'test' :title => 'api test', :file_name => 'sample.rb', :code => 'test'
response.status.should == 201 response.status.should == 201
json = JSON.parse(response.body) json_response['title'].should == 'api test'
json['title'].should == 'api test'
end end
end end
describe "DELETE /projects/:id/snippets/:snippet_id" do describe "DELETE /projects/:id/snippets/:snippet_id" do
it "should create a new project snippet" do it "should create a new project snippet" do
expect { expect {
delete "/api/projects/#{project.code}/snippets/#{snippet.id}?private_token=#{user.private_token}" delete "#{api_prefix}/projects/#{project.code}/snippets/#{snippet.id}?private_token=#{user.private_token}"
}.should change { Snippet.count }.by(-1) }.should change { Snippet.count }.by(-1)
end end
end end

View file

@ -5,34 +5,33 @@ describe Gitlab::API do
describe "GET /users" do describe "GET /users" do
it "should return authentication error" do it "should return authentication error" do
get "/api/users" get "#{api_prefix}/users"
response.status.should == 401 response.status.should == 401
end end
describe "authenticated GET /users" do describe "authenticated GET /users" do
it "should return an array of users" do it "should return an array of users" do
get "/api/users?private_token=#{user.private_token}" get "#{api_prefix}/users?private_token=#{user.private_token}"
response.status.should == 200 response.status.should == 200
json = JSON.parse(response.body) json_response.should be_an Array
json.should be_an Array json_response.first['email'].should == user.email
json.first['email'].should == user.email
end end
end end
end end
describe "GET /users/:id" do describe "GET /users/:id" do
it "should return a user by id" do it "should return a user by id" do
get "/api/users/#{user.id}?private_token=#{user.private_token}" get "#{api_prefix}/users/#{user.id}?private_token=#{user.private_token}"
response.status.should == 200 response.status.should == 200
JSON.parse(response.body)['email'].should == user.email json_response['email'].should == user.email
end end
end end
describe "GET /user" do describe "GET /user" do
it "should return current user" do it "should return current user" do
get "/api/user?private_token=#{user.private_token}" get "#{api_prefix}/user?private_token=#{user.private_token}"
response.status.should == 200 response.status.should == 200
JSON.parse(response.body)['email'].should == user.email json_response['email'].should == user.email
end end
end end
end end

7
spec/support/api.rb Normal file
View file

@ -0,0 +1,7 @@
def api_prefix
"/api/#{Gitlab::API::VERSION}"
end
def json_response
JSON.parse(response.body)
end