milestones.rb 3.91 KB
Newer Older
1
module API
Robert Speicher's avatar
Robert Speicher committed
2 3 4 5
  # Milestones API
  class Milestones < Grape::API
    before { authenticate! }

6 7 8 9 10 11 12 13 14 15
    helpers do
      def filter_milestones_state(milestones, state)
        case state
        when 'active' then milestones.active
        when 'closed' then milestones.closed
        else milestones
        end
      end
    end

Robert Speicher's avatar
Robert Speicher committed
16 17 18 19
    resource :projects do
      # Get a list of project milestones
      #
      # Parameters:
20 21
      #   id (required)    - The ID of a project
      #   state (optional) - Return "active" or "closed" milestones
Robert Speicher's avatar
Robert Speicher committed
22 23
      # Example Request:
      #   GET /projects/:id/milestones
24 25
      #   GET /projects/:id/milestones?state=active
      #   GET /projects/:id/milestones?state=closed
Robert Speicher's avatar
Robert Speicher committed
26
      get ":id/milestones" do
27 28
        authorize! :read_milestone, user_project

29
        milestones = user_project.milestones
30
        milestones = filter_milestones_state(milestones, params[:state])
31 32

        present paginate(milestones), with: Entities::Milestone
Robert Speicher's avatar
Robert Speicher committed
33 34 35 36 37
      end

      # Get a single project milestone
      #
      # Parameters:
38
      #   id (required) - The ID of a project
Robert Speicher's avatar
Robert Speicher committed
39 40 41 42
      #   milestone_id (required) - The ID of a project milestone
      # Example Request:
      #   GET /projects/:id/milestones/:milestone_id
      get ":id/milestones/:milestone_id" do
43 44
        authorize! :read_milestone, user_project

Robert Speicher's avatar
Robert Speicher committed
45 46 47 48 49 50 51
        @milestone = user_project.milestones.find(params[:milestone_id])
        present @milestone, with: Entities::Milestone
      end

      # Create a new project milestone
      #
      # Parameters:
52
      #   id (required) - The ID of the project
Robert Speicher's avatar
Robert Speicher committed
53 54 55 56 57 58
      #   title (required) - The title of the milestone
      #   description (optional) - The description of the milestone
      #   due_date (optional) - The due date of the milestone
      # Example Request:
      #   POST /projects/:id/milestones
      post ":id/milestones" do
59 60 61 62
        authorize! :admin_milestone, user_project
        required_attributes! [:title]
        attrs = attributes_for_keys [:title, :description, :due_date]
        milestone = ::Milestones::CreateService.new(user_project, current_user, attrs).execute
63

64 65 66
        if milestone.valid?
          present milestone, with: Entities::Milestone
        else
67
          render_api_error!("Failed to create milestone #{milestone.errors.messages}", 400)
Robert Speicher's avatar
Robert Speicher committed
68 69 70 71 72 73
        end
      end

      # Update an existing project milestone
      #
      # Parameters:
74
      #   id (required) - The ID of a project
75
      #   milestone_id (required) - The ID of a project milestone
Robert Speicher's avatar
Robert Speicher committed
76 77 78
      #   title (optional) - The title of a milestone
      #   description (optional) - The description of a milestone
      #   due_date (optional) - The due date of a milestone
79
      #   state_event (optional) - The state event of the milestone (close|activate)
Robert Speicher's avatar
Robert Speicher committed
80 81 82
      # Example Request:
      #   PUT /projects/:id/milestones/:milestone_id
      put ":id/milestones/:milestone_id" do
83 84 85 86
        authorize! :admin_milestone, user_project
        attrs = attributes_for_keys [:title, :description, :due_date, :state_event]
        milestone = user_project.milestones.find(params[:milestone_id])
        milestone = ::Milestones::UpdateService.new(user_project, current_user, attrs).execute(milestone)
randx's avatar
randx committed
87

88 89 90
        if milestone.valid?
          present milestone, with: Entities::Milestone
        else
91
          render_api_error!("Failed to update milestone #{milestone.errors.messages}", 400)
Robert Speicher's avatar
Robert Speicher committed
92 93
        end
      end
94

95
      # Get all issues for a single project milestone
96 97 98 99 100 101 102 103 104 105
      #
      # Parameters:
      #   id (required) - The ID of a project
      #   milestone_id (required) - The ID of a project milestone
      # Example Request:
      #   GET /projects/:id/milestones/:milestone_id/issues
      get ":id/milestones/:milestone_id/issues" do
        authorize! :read_milestone, user_project

        @milestone = user_project.milestones.find(params[:milestone_id])
106
        present paginate(@milestone.issues), with: Entities::Issue, current_user: current_user
107 108
      end

Robert Speicher's avatar
Robert Speicher committed
109 110 111
    end
  end
end