BigW Consortium Gitlab

project_hooks.rb 3.36 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 16 17
    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"
        optional :build_events, type: Boolean, desc: "Trigger hook on build events"
        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
        hook = user_project.hooks.new(declared_params(include_missing: false))
57

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

          not_found!("Project hook #{hook.errors.messages}")
64 65 66
        end
      end

67 68 69 70 71
      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"
72
        use :project_hook_properties
73
      end
74
      put ":id/hooks/:hook_id" do
75
        hook = user_project.hooks.find(params.delete(:hook_id))
76

77
        if hook.update_attributes(declared_params(include_missing: false))
78
          present hook, with: Entities::ProjectHook
79
        else
80 81 82
          error!("Invalid url given", 422) if hook.errors[:url].present?

          not_found!("Project hook #{hook.errors.messages}")
83 84 85
        end
      end

86 87 88 89 90 91
      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
92
      delete ":id/hooks/:hook_id" do
93 94 95
        hook = user_project.hooks.find(params.delete(:hook_id))

        hook.destroy
96 97 98 99
      end
    end
  end
end