Merge pull request #1411 from miks/project_hooks_api

Project hooks API

Merge pull request #1411 from miks/project_hooks_api
Project hooks API
Dmitriy Zaporozhets
2 parents 6233fb6b 6d76e000
Showing 4 changed files with 122 additions and 0 deletions Show diff stats
doc/api/projects.md
lib/api/entities.rb
lib/api/projects.rb
spec/requests/api/projects_spec.rb
@@ -173,6 +173,50 @@ Parameters:
 Will return status `200 OK` on success, or `404 Not found` on fail.
+## Get project hooks
+
+Get hooks for project
+
+```
+GET /projects/:id/hooks
+```
+
+Parameters:
+
++ `id` (required) - The ID or code name of a project
+
+Will return hooks with status `200 OK` on success, or `404 Not found` on fail.
+
+## Add project hook
+
+Add hook to project
+
+```
+POST /projects/:id/hooks
+```
+
+Parameters:
+
++ `id` (required) - The ID or code name of a project
++ `url` (required) - The hook URL
+
+Will return status `201 Created` on success, or `404 Not found` on fail.
+
+## Delete project hook
+
+Delete hook from project
+
+```
+DELETE /projects/:id/hooks
+```
+
+Parameters:
+
++ `id` (required) - The ID or code name of a project
++ `hook_id` (required) - The ID of hook to delete
+
+Will return status `200 OK` on success, or `404 Not found` on fail.
+
 ## Project repository branches
 Get a list of repository branches from a project, sorted by name alphabetically.
@@ -9,6 +9,10 @@ module Gitlab
       expose :id, :email, :name, :blocked, :created_at
     end
+    class Hook < Grape::Entity
+      expose :id, :url
+    end
+
     class Project < Grape::Entity
       expose :id, :code, :name, :description, :path, :default_branch
       expose :owner, using: Entities::UserBasic
@@ -106,6 +106,49 @@ module Gitlab
         nil
       end
+      # Get project hooks
+      #
+      # Parameters:
+      #   id (required) - The ID or code name of a project
+      # Example Request:
+      #   GET /projects/:id/hooks
+      get ":id/hooks" do
+        authorize! :admin_project, user_project
+        @hooks = paginate user_project.hooks
+        present @hooks, with: Entities::Hook
+      end
+
+      # Add hook to project
+      #
+      # Parameters:
+      #   id (required) - The ID or code name of a project
+      #   url (required) - The hook URL
+      # Example Request:
+      #   POST /projects/:id/hooks
+      post ":id/hooks" do
+        authorize! :admin_project, user_project
+        @hook = user_project.hooks.new({"url" => params[:url]})
+        if @hook.save
+          present @hook, with: Entities::Hook
+        else
+          error!({'message' => '404 Not found'}, 404)
+        end
+      end
+
+      # Delete project hook
+      #
+      # Parameters:
+      #   id (required) - The ID or code name of a project
+      #   hook_id (required) - The ID of hook to delete
+      # Example Request:
+      #   DELETE /projects/:id/hooks
+      delete ":id/hooks" do
+        authorize! :admin_project, user_project
+        @hook = user_project.hooks.find(params[:hook_id])
+        @hook.destroy
+        nil
+      end
+
       # Get a project repository branches
       #
       # Parameters:
@@ -6,6 +6,7 @@ describe Gitlab::API do
   let(:user) { Factory :user }
   let(:user2) { Factory.create(:user) }
   let(:user3) { Factory.create(:user) }
+  let!(:hook) { Factory :project_hook, project: project, url: "http://example.com" }
   let!(:project) { Factory :project, owner: user }
   let!(:snippet) { Factory :snippet, author: user, project: project, title: 'example' }
   let!(:users_project) { Factory :users_project, user: user, project: project, project_access: UsersProject::MASTER  }
@@ -149,6 +150,36 @@ describe Gitlab::API do
     end
   end
+  describe "GET /projects/:id/hooks" do
+    it "should return project hooks" do
+      get api("/projects/#{project.code}/hooks", user)
+
+      response.status.should == 200
+
+      json_response.should be_an Array
+      json_response.count.should == 1
+      json_response.first['url'].should == "http://example.com"
+    end
+  end
+
+  describe "POST /projects/:id/users" do
+    it "should add hook to project" do
+      expect {
+        post api("/projects/#{project.code}/hooks", user),
+          "url" => "http://example.com"
+      }.to change {project.hooks.count}.by(1)
+    end
+  end
+
+  describe "DELETE /projects/:id/hooks" do
+    it "should delete hook from project" do
+      expect {
+        delete api("/projects/#{project.code}/hooks", user),
+          hook_id: hook.id
+      }.to change {project.hooks.count}.by(-1)
+    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", user)
	@@ -173,6 +173,50 @@ Parameters:		@@ -173,6 +173,50 @@ Parameters:
173		173
174	Will return status `200 OK` on success, or `404 Not found` on fail.	174	Will return status `200 OK` on success, or `404 Not found` on fail.
175		175
		176	+## Get project hooks
		177	+
		178	+Get hooks for project
		179	+
		180	+```
		181	+GET /projects/:id/hooks
		182	+```
		183	+
		184	+Parameters:
		185	+
		186	++ `id` (required) - The ID or code name of a project
		187	+
		188	+Will return hooks with status `200 OK` on success, or `404 Not found` on fail.
		189	+
		190	+## Add project hook
		191	+
		192	+Add hook to project
		193	+
		194	+```
		195	+POST /projects/:id/hooks
		196	+```
		197	+
		198	+Parameters:
		199	+
		200	++ `id` (required) - The ID or code name of a project
		201	++ `url` (required) - The hook URL
		202	+
		203	+Will return status `201 Created` on success, or `404 Not found` on fail.
		204	+
		205	+## Delete project hook
		206	+
		207	+Delete hook from project
		208	+
		209	+```
		210	+DELETE /projects/:id/hooks
		211	+```
		212	+
		213	+Parameters:
		214	+
		215	++ `id` (required) - The ID or code name of a project
		216	++ `hook_id` (required) - The ID of hook to delete
		217	+
		218	+Will return status `200 OK` on success, or `404 Not found` on fail.
		219	+
176	## Project repository branches	220	## Project repository branches
177		221
178	Get a list of repository branches from a project, sorted by name alphabetically.	222	Get a list of repository branches from a project, sorted by name alphabetically.
	@@ -106,6 +106,49 @@ module Gitlab		@@ -106,6 +106,49 @@ module Gitlab
106	nil	106	nil
107	end	107	end
108		108
		109	+ # Get project hooks
		110	+ #
		111	+ # Parameters:
		112	+ # id (required) - The ID or code name of a project
		113	+ # Example Request:
		114	+ # GET /projects/:id/hooks
		115	+ get ":id/hooks" do
		116	+ authorize! :admin_project, user_project
		117	+ @hooks = paginate user_project.hooks
		118	+ present @hooks, with: Entities::Hook
		119	+ end
		120	+
		121	+ # Add hook to project
		122	+ #
		123	+ # Parameters:
		124	+ # id (required) - The ID or code name of a project
		125	+ # url (required) - The hook URL
		126	+ # Example Request:
		127	+ # POST /projects/:id/hooks
		128	+ post ":id/hooks" do
		129	+ authorize! :admin_project, user_project
		130	+ @hook = user_project.hooks.new({"url" => params[:url]})
		131	+ if @hook.save
		132	+ present @hook, with: Entities::Hook
		133	+ else
		134	+ error!({'message' => '404 Not found'}, 404)
		135	+ end
		136	+ end
		137	+
		138	+ # Delete project hook
		139	+ #
		140	+ # Parameters:
		141	+ # id (required) - The ID or code name of a project
		142	+ # hook_id (required) - The ID of hook to delete
		143	+ # Example Request:
		144	+ # DELETE /projects/:id/hooks
		145	+ delete ":id/hooks" do
		146	+ authorize! :admin_project, user_project
		147	+ @hook = user_project.hooks.find(params[:hook_id])
		148	+ @hook.destroy
		149	+ nil
		150	+ end
		151	+
109	# Get a project repository branches	152	# Get a project repository branches
110	#	153	#
111	# Parameters:	154	# Parameters:
	@@ -6,6 +6,7 @@ describe Gitlab::API do		@@ -6,6 +6,7 @@ describe Gitlab::API do
6	let(:user) { Factory :user }	6	let(:user) { Factory :user }
7	let(:user2) { Factory.create(:user) }	7	let(:user2) { Factory.create(:user) }
8	let(:user3) { Factory.create(:user) }	8	let(:user3) { Factory.create(:user) }
		9	+ let!(:hook) { Factory :project_hook, project: project, url: "http://example.com" }
9	let!(:project) { Factory :project, owner: user }	10	let!(:project) { Factory :project, owner: user }
10	let!(:snippet) { Factory :snippet, author: user, project: project, title: 'example' }	11	let!(:snippet) { Factory :snippet, author: user, project: project, title: 'example' }
11	let!(:users_project) { Factory :users_project, user: user, project: project, project_access: UsersProject::MASTER }	12	let!(:users_project) { Factory :users_project, user: user, project: project, project_access: UsersProject::MASTER }
	@@ -149,6 +150,36 @@ describe Gitlab::API do		@@ -149,6 +150,36 @@ describe Gitlab::API do
149	end	150	end
150	end	151	end
151		152
		153	+ describe "GET /projects/:id/hooks" do
		154	+ it "should return project hooks" do
		155	+ get api("/projects/#{project.code}/hooks", user)
		156	+
		157	+ response.status.should == 200
		158	+
		159	+ json_response.should be_an Array
		160	+ json_response.count.should == 1
		161	+ json_response.first['url'].should == "http://example.com"
		162	+ end
		163	+ end
		164	+
		165	+ describe "POST /projects/:id/users" do
		166	+ it "should add hook to project" do
		167	+ expect {
		168	+ post api("/projects/#{project.code}/hooks", user),
		169	+ "url" => "http://example.com"
		170	+ }.to change {project.hooks.count}.by(1)
		171	+ end
		172	+ end
		173	+
		174	+ describe "DELETE /projects/:id/hooks" do
		175	+ it "should delete hook from project" do
		176	+ expect {
		177	+ delete api("/projects/#{project.code}/hooks", user),
		178	+ hook_id: hook.id
		179	+ }.to change {project.hooks.count}.by(-1)
		180	+ end
		181	+ end
		182	+
152	describe "GET /projects/:id/repository/tags" do	183	describe "GET /projects/:id/repository/tags" do
153	it "should return an array of project tags" do	184	it "should return an array of project tags" do
154	get api("/projects/#{project.code}/repository/tags", user)	185	get api("/projects/#{project.code}/repository/tags", user)