BigW Consortium Gitlab

system_hooks.rb 1.53 KB
Newer Older
1
module API
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
  # Hooks API
  class SystemHooks < Grape::API
    before {
      authenticate!
      authenticated_as_admin!
    }

    resource :hooks do
      # Get the list of system hooks
      #
      # Example Request:
      #   GET /hooks
      get do
        @hooks = SystemHook.all
        present @hooks, with: Entities::Hook
      end

      # Create new system hook
      #
      # Parameters:
      #   url (required) - url for system hook
      # Example Request
      #   POST /hooks
      post do
        attrs = attributes_for_keys [:url]
        required_attributes! [:url]
        @hook = SystemHook.new attrs
        if @hook.save
          present @hook, with: Entities::Hook
        else
          not_found!
        end
      end

      # Test a hook
      #
      # Example Request
      #   GET /hooks/:id
      get ":id" do
        @hook = SystemHook.find(params[:id])
        data = {
          event_name: "project_create",
          name: "Ruby",
          path: "ruby",
          project_id: 1,
          owner_name: "Someone",
          owner_email: "example@gitlabhq.com"
        }
        @hook.execute(data)
        data
      end

      # Delete a hook. This is an idempotent function.
      #
      # Parameters:
      #   id (required) - ID of the hook
      # Example Request:
      #   DELETE /hooks/:id
      delete ":id" do
        begin
          @hook = SystemHook.find(params[:id])
          @hook.destroy
        rescue
          # SystemHook raises an Error if no hook with id found
        end
      end
    end
  end
end