Merge pull request #1034 from NARKOZ/api

API version

lib/api.rb

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

lib/api/projects.rb

@@ -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

spec/api/projects_spec.rb

@@ -3,81 +3,92 @@ 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
     it "should return authentication error" do
-      get "/api/projects"
+      get "#{api_prefix}/projects"
       response.status.should == 401
     end
 
     describe "authenticated GET /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
-        json = JSON.parse(response.body)
-        json.should be_an Array
-        json.first['name'].should == project.name
-        json.first['owner']['email'].should == user.email
+        json_response.should be_an Array
+        json_response.first['name'].should == project.name
+        json_response.first['owner']['email'].should == user.email
       end
     end
   end
 
   describe "GET /projects/: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
-      json = JSON.parse(response.body)
-      json['name'].should == project.name
-      json['owner']['email'].should == user.email
+      json_response['name'].should == project.name
+      json_response['owner']['email'].should == user.email
     end
   end
 
   describe "GET /projects/:id/repository/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
-      json = JSON.parse(response.body)
-      json.should be_an Array
-      json.first['name'].should == project.repo.heads.sort_by(&:name).first.name
+      json_response.should be_an Array
+      json_response.first['name'].should == project.repo.heads.sort_by(&:name).first.name
     end
   end
 
   describe "GET /projects/:id/repository/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
-      json = JSON.parse(response.body)
-      json.should be_an Array
-      json.first['name'].should == project.repo.tags.sort_by(&:name).reverse.first.name
+      json_response.should be_an Array
+      json_response.first['name'].should == project.repo.tags.sort_by(&:name).reverse.first.name
     end
   end
 
   describe "GET /projects/:id/snippets/:snippet_id" 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
-      json = JSON.parse(response.body)
-      json['title'].should == snippet.title
+      json_response['title'].should == snippet.title
     end
   end
 
   describe "POST /projects/:id/snippets" 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'
       response.status.should == 201
-      json = JSON.parse(response.body)
-      json['title'].should == 'api test'
+      json_response['title'].should == 'api test'
+    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 {
-        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)
     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

spec/api/users_spec.rb

@@ -5,34 +5,33 @@ describe Gitlab::API do
 
   describe "GET /users" do
     it "should return authentication error" do
-      get "/api/users"
+      get "#{api_prefix}/users"
       response.status.should == 401
     end
 
     describe "authenticated GET /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
-        json = JSON.parse(response.body)
-        json.should be_an Array
-        json.first['email'].should == user.email
+        json_response.should be_an Array
+        json_response.first['email'].should == user.email
       end
     end
   end
 
   describe "GET /users/: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
-      JSON.parse(response.body)['email'].should == user.email
+      json_response['email'].should == user.email
     end
   end
 
   describe "GET /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
-      JSON.parse(response.body)['email'].should == user.email
+      json_response['email'].should == user.email
     end
   end
 end

spec/support/api.rb

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