gitlab-org--gitlab-foss/lib/api/v3/project_hooks.rb

module API
  module V3
    class ProjectHooks < Grape::API
      include PaginationParams

      before { authenticate! }
      before { authorize_admin_project }

      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 :confidential_issues_events, type: Boolean, desc: "Trigger hook on confidential 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"
          optional :wiki_page_events, type: Boolean, desc: "Trigger hook on wiki events"
          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

      params do
        requires :id, type: String, desc: 'The ID of a project'
      end
      resource :projects, requirements: { id: %r{[^/]+} } do
        desc 'Get project hooks' do
          success ::API::V3::Entities::ProjectHook
        end
        params do
          use :pagination
        end
        get ":id/hooks" do
          hooks = paginate user_project.hooks

          present hooks, with: ::API::V3::Entities::ProjectHook
        end

        desc 'Get a project hook' do
          success ::API::V3::Entities::ProjectHook
        end
        params do
          requires :hook_id, type: Integer, desc: 'The ID of a project hook'
        end
        get ":id/hooks/:hook_id" do
          hook = user_project.hooks.find(params[:hook_id])
          present hook, with: ::API::V3::Entities::ProjectHook
        end

        desc 'Add hook to project' do
          success ::API::V3::Entities::ProjectHook
        end
        params do
          use :project_hook_properties
        end
        post ":id/hooks" do
          attrs = declared_params(include_missing: false)
          attrs[:job_events] = attrs.delete(:build_events) if attrs.key?(:build_events)
          hook = user_project.hooks.new(attrs)

          if hook.save
            present hook, with: ::API::V3::Entities::ProjectHook
          else
            error!("Invalid url given", 422) if hook.errors[:url].present?

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

        desc 'Update an existing project hook' do
          success ::API::V3::Entities::ProjectHook
        end
        params do
          requires :hook_id, type: Integer, desc: "The ID of the hook to update"
          use :project_hook_properties
        end
        put ":id/hooks/:hook_id" do
          hook = user_project.hooks.find(params.delete(:hook_id))

          attrs = declared_params(include_missing: false)
          attrs[:job_events] = attrs.delete(:build_events) if attrs.key?(:build_events)
          if hook.update_attributes(attrs)
            present hook, with: ::API::V3::Entities::ProjectHook
          else
            error!("Invalid url given", 422) if hook.errors[:url].present?

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

        desc 'Deletes project hook' do
          success ::API::V3::Entities::ProjectHook
        end
        params do
          requires :hook_id, type: Integer, desc: 'The ID of the hook to delete'
        end
        delete ":id/hooks/:hook_id" do
          begin
            present user_project.hooks.destroy(params[:hook_id]), with: ::API::V3::Entities::ProjectHook
          rescue
            # ProjectHook can raise Error if hook_id not found
            not_found!("Error deleting hook #{params[:hook_id]}")
          end
        end
      end
    end
  end
end