project_hooks.rb 2.92 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 16 17 18 19 20 21 22 23 24

    resource :projects do
      helpers do
        def handle_project_member_errors(errors)
          if errors[:project_access].any?
            error!(errors[:project_access], 422)
          end
          not_found!
        end
      end

      # 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
25
        present @hooks, with: Entities::ProjectHook
26 27 28 29 30 31 32 33 34 35 36
      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])
37
        present @hook, with: Entities::ProjectHook
38 39 40 41 42 43 44 45 46 47 48 49
      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]
50 51
        attrs = attributes_for_keys [:url, :push_events, :issues_events, :merge_requests_events]
        @hook = user_project.hooks.new(attrs)
52 53

        if @hook.save
54
          present @hook, with: Entities::ProjectHook
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
        else
          if @hook.errors[:url].present?
            error!("Invalid url given", 422)
          end
          not_found!
        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]
74
        attrs = attributes_for_keys [:url, :push_events, :issues_events, :merge_requests_events]
75 76

        if @hook.update_attributes attrs
77
          present @hook, with: Entities::ProjectHook
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
        else
          if @hook.errors[:url].present?
            error!("Invalid url given", 422)
          end
          not_found!
        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
          @hook = ProjectHook.find(params[:hook_id])
          @hook.destroy
        rescue
          # ProjectHook can raise Error if hook_id not found
        end
      end
    end
  end
end