BigW Consortium Gitlab

project_hooks.rb 3.26 KB
Newer Older
1 2 3 4
module API
  # Projects API
  class ProjectHooks < Grape::API
    before { authenticate! }
5
    before { authorize_admin_project }
6 7 8 9 10 11 12 13 14 15

    resource :projects do
      # Get project hooks
      #
      # Parameters:
      #   id (required) - The ID of a project
      # Example Request:
      #   GET /projects/:id/hooks
      get ":id/hooks" do
        @hooks = paginate user_project.hooks
16
        present @hooks, with: Entities::ProjectHook
17 18 19 20 21 22 23 24 25 26 27
      end

      # Get a project hook
      #
      # Parameters:
      #   id (required) - The ID of a project
      #   hook_id (required) - The ID of a project hook
      # Example Request:
      #   GET /projects/:id/hooks/:hook_id
      get ":id/hooks/:hook_id" do
        @hook = user_project.hooks.find(params[:hook_id])
28
        present @hook, with: Entities::ProjectHook
29 30 31 32 33 34 35 36 37 38 39
      end

      # Add hook to project
      #
      # Parameters:
      #   id (required) - The ID of a project
      #   url (required) - The hook URL
      # Example Request:
      #   POST /projects/:id/hooks
      post ":id/hooks" do
        required_attributes! [:url]
40 41 42 43 44
        attrs = attributes_for_keys [
          :url,
          :push_events,
          :issues_events,
          :merge_requests_events,
45
          :tag_push_events,
46
          :note_events,
47
          :build_events,
48
          :pipeline_events,
49
          :wiki_page_events,
50
          :enable_ssl_verification
51
        ]
52
        @hook = user_project.hooks.new(attrs)
53 54

        if @hook.save
55
          present @hook, with: Entities::ProjectHook
56 57 58 59
        else
          if @hook.errors[:url].present?
            error!("Invalid url given", 422)
          end
60
          not_found!("Project hook #{@hook.errors.messages}")
61 62 63 64 65 66 67 68 69 70 71 72 73 74
        end
      end

      # Update an existing project hook
      #
      # Parameters:
      #   id (required) - The ID of a project
      #   hook_id (required) - The ID of a project hook
      #   url (required) - The hook URL
      # Example Request:
      #   PUT /projects/:id/hooks/:hook_id
      put ":id/hooks/:hook_id" do
        @hook = user_project.hooks.find(params[:hook_id])
        required_attributes! [:url]
75 76 77 78 79
        attrs = attributes_for_keys [
          :url,
          :push_events,
          :issues_events,
          :merge_requests_events,
80
          :tag_push_events,
81
          :note_events,
82
          :build_events,
83
          :pipeline_events,
84
          :wiki_page_events,
85
          :enable_ssl_verification
86
        ]
87 88

        if @hook.update_attributes attrs
89
          present @hook, with: Entities::ProjectHook
90 91 92 93
        else
          if @hook.errors[:url].present?
            error!("Invalid url given", 422)
          end
94
          not_found!("Project hook #{@hook.errors.messages}")
95 96 97 98 99 100 101 102 103 104 105 106 107 108
        end
      end

      # Deletes project hook. This is an idempotent function.
      #
      # Parameters:
      #   id (required) - The ID of a project
      #   hook_id (required) - The ID of hook to delete
      # Example Request:
      #   DELETE /projects/:id/hooks/:hook_id
      delete ":id/hooks/:hook_id" do
        required_attributes! [:hook_id]

        begin
109
          @hook = user_project.hooks.destroy(params[:hook_id])
110 111
        rescue
          # ProjectHook can raise Error if hook_id not found
112
          not_found!("Error deleting hook #{params[:hook_id]}")
113 114 115 116 117
        end
      end
    end
  end
end