Use Grape DSL for environment endpoints

Also a couple of minor edits for this branch are included

2 files changed, 47 insertions, 48 deletions

diff --git a/lib/api/api.rb b/lib/api/api.rb
index 9c960d74495..bd16806892b 100644
--- a/lib/api/api.rb
+++ b/lib/api/api.rb
@@ -7,6 +7,10 @@ module API
       rack_response({ 'message' => '404 Not found' }.to_json, 404)
     end
 
+    rescue_from Grape::Exceptions::ValidationErrors do |e|
+      error!({ messages: e.full_messages }, 400)
+    end
+
     rescue_from :all do |exception|
       # lifted from https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb#L60
       # why is this not wrapped in something reusable?
diff --git a/lib/api/environments.rb b/lib/api/environments.rb
index 532baec42c7..a50f007d697 100644
--- a/lib/api/environments.rb
+++ b/lib/api/environments.rb
@@ -3,82 +3,77 @@ module API
   class Environments < Grape::API
     before { authenticate! }
 
+    params do
+      requires :id, type: String, desc: 'The project ID'
+    end
     resource :projects do
-      # Get all labels of the project
-      #
-      # Parameters:
-      #   id (required) - The ID of a project
-      # Example Request:
-      #   GET /projects/:id/environments
+      desc 'Get all environments of the project' do
+        detail 'This feature was introduced in GitLab 8.11.'
+        success Entities::Environment
+      end
       get ':id/environments' do
         authorize! :read_environment, user_project
 
         present paginate(user_project.environments), with: Entities::Environment
       end
 
-      # Creates a new environment
-      #
-      # Parameters:
-      #   id    (required)        - The ID of a project
-      #   name  (required)        - The name of the environment to be created
-      #   external_url (optional) - URL on which this deployment is viewable
-      #
-      # Example Request:
-      #   POST /projects/:id/labels
+      desc 'Creates a new environment' do
+        detail 'This feature was introduced in GitLab 8.11.'
+        success Entities::Environment
+      end
+      params do
+        requires :name,           type: String,   desc: 'The name of the environment to be created'
+        optional :external_url,   type: String,   desc: 'URL on which this deployment is viewable'
+      end
       post ':id/environments' do
         authorize! :create_environment, user_project
-        required_attributes! [:name]
-
-        attrs = attributes_for_keys [:name, :external_url]
 
-        environment = user_project.environments.create(attrs)
+        create_params = declared(params, include_parent_namespaces: false).to_h
+        environment = user_project.environments.create(create_params)
 
-        if environment.valid?
+        if environment.persisted?
           present environment, with: Entities::Environment
         else
           render_validation_error!(environment)
         end
       end
 
-      # Deletes an existing environment
-      #
-      # Parameters:
-      #   id    (required)          - The ID of a project
-      #   environment_id (required) - The name of the environment to be deleted
-      #
-      # Example Request:
-      #   DELETE /projects/:id/environments/:environment_id
-      delete ':id/environments/:environment_id' do
-        authorize! :update_environment, user_project
-
-        environment = user_project.environments.find(params[:environment_id])
-
-        present environment.destroy, with: Entities::Environment
+      desc 'Updates an existing environment' do
+        detail 'This feature was introduced in GitLab 8.11.'
+        success Entities::Environment
+      end
+      params do
+        requires :environment_id, type: Integer,  desc: 'The environment ID'
+        optional :name,           type: String,   desc: 'The new environment name'
+        optional :external_url,   type: String,   desc: 'The new URL on which this deployment is viewable'
       end
-
-      # Updates an existing environment
-      #
-      # Parameters:
-      #   id              (required) - The ID of a project
-      #   environment_id  (required) - The ID of the environment
-      #   name            (optional) - The name of the label to be deleted
-      #   external_url    (optional) - The new name of the label
-      #
-      # Example Request:
-      #   PUT /projects/:id/environments/:environment_id
       put ':id/environments/:environment_id' do
         authorize! :update_environment, user_project
 
         environment = user_project.environments.find(params[:environment_id])
 
-        attrs = attributes_for_keys [:name, :external_url]
-
-        if environment.update(attrs)
+        update_params = declared(params, include_missing: false).extract!(:name, :external_url).to_h
+        if environment.update(update_params)
           present environment, with: Entities::Environment
         else
           render_validation_error!(environment)
         end
       end
+
+      desc 'Deletes an existing environment' do
+        detail 'This feature was introduced in GitLab 8.11.'
+        success Entities::Environment
+      end
+      params do
+        requires :environment_id, type: Integer,  desc: 'The environment ID'
+      end
+      delete ':id/environments/:environment_id' do
+        authorize! :update_environment, user_project
+
+        environment = user_project.environments.find(params[:environment_id])
+
+        present environment.destroy, with: Entities::Environment
+      end
     end
   end
 end