BigW Consortium Gitlab

project_hooks.rb 3.45 KB
Newer Older
1 2
module API
  class ProjectHooks < Grape::API
3 4 5 6 7
    include PaginationParams

    before { authenticate! }
    before { authorize_admin_project }

8 9 10 11 12 13 14 15
    helpers do
      params :project_hook_properties do
        requires :url, type: String, desc: "The URL to send the request to"
        optional :push_events, type: Boolean, desc: "Trigger hook on push events"
        optional :issues_events, type: Boolean, desc: "Trigger hook on issues events"
        optional :merge_requests_events, type: Boolean, desc: "Trigger hook on merge request events"
        optional :tag_push_events, type: Boolean, desc: "Trigger hook on tag push events"
        optional :note_events, type: Boolean, desc: "Trigger hook on note(comment) events"
16
        optional :job_events, type: Boolean, desc: "Trigger hook on job events"
17
        optional :pipeline_events, type: Boolean, desc: "Trigger hook on pipeline events"
18
        optional :wiki_page_events, type: Boolean, desc: "Trigger hook on wiki events"
19 20 21 22 23
        optional :enable_ssl_verification, type: Boolean, desc: "Do SSL verification when triggering the hook"
        optional :token, type: String, desc: "Secret token to validate received payloads; this will not be returned in the response"
      end
    end

24 25 26
    params do
      requires :id, type: String, desc: 'The ID of a project'
    end
27
    resource :projects, requirements: { id: %r{[^/]+} } do
28 29 30
      desc 'Get project hooks' do
        success Entities::ProjectHook
      end
31 32 33
      params do
        use :pagination
      end
34
      get ":id/hooks" do
35
        present paginate(user_project.hooks), with: Entities::ProjectHook
36 37
      end

38 39 40 41 42 43
      desc 'Get a project hook' do
        success Entities::ProjectHook
      end
      params do
        requires :hook_id, type: Integer, desc: 'The ID of a project hook'
      end
44
      get ":id/hooks/:hook_id" do
45 46
        hook = user_project.hooks.find(params[:hook_id])
        present hook, with: Entities::ProjectHook
47 48
      end

49 50 51 52
      desc 'Add hook to project' do
        success Entities::ProjectHook
      end
      params do
53
        use :project_hook_properties
54
      end
55
      post ":id/hooks" do
56 57 58
        hook_params = declared_params(include_missing: false)

        hook = user_project.hooks.new(hook_params)
59

60 61
        if hook.save
          present hook, with: Entities::ProjectHook
62
        else
63 64 65
          error!("Invalid url given", 422) if hook.errors[:url].present?

          not_found!("Project hook #{hook.errors.messages}")
66 67 68
        end
      end

69 70 71 72 73
      desc 'Update an existing project hook' do
        success Entities::ProjectHook
      end
      params do
        requires :hook_id, type: Integer, desc: "The ID of the hook to update"
74
        use :project_hook_properties
75
      end
76
      put ":id/hooks/:hook_id" do
77
        hook = user_project.hooks.find(params.delete(:hook_id))
78

79 80 81
        update_params = declared_params(include_missing: false)

        if hook.update_attributes(update_params)
82
          present hook, with: Entities::ProjectHook
83
        else
84 85 86
          error!("Invalid url given", 422) if hook.errors[:url].present?

          not_found!("Project hook #{hook.errors.messages}")
87 88 89
        end
      end

90 91 92 93 94 95
      desc 'Deletes project hook' do
        success Entities::ProjectHook
      end
      params do
        requires :hook_id, type: Integer, desc: 'The ID of the hook to delete'
      end
96
      delete ":id/hooks/:hook_id" do
97 98
        hook = user_project.hooks.find(params.delete(:hook_id))

Dmitriy Zaporozhets committed
99
        status 204
100
        hook.destroy
101 102 103 104
      end
    end
  end
end