Add /v3/routes endpoint

- Allow for paginated listing of routes, filtered by page and per_page

[Finished #162402733]

Co-authored-by: Luan Santos <[email protected]>
Co-authored-by: Reid Mitchell <[email protected]>

Author: reidmit

Diff for: app/controllers/v3/routes_controller.rb

@@ -1,9 +1,25 @@
 require 'messages/route_create_message'
 require 'messages/route_show_message'
+require 'messages/routes_list_message'
 require 'presenters/v3/route_presenter'
+require 'presenters/v3/paginated_list_presenter'
 require 'actions/route_create'
 
 class RoutesController < ApplicationController
+  def index
+    message = RoutesListMessage.from_params(query_params)
+    invalid_param!(message.errors.full_messages) unless message.valid?
+
+    dataset = Route.where(guid: permission_queryer.readable_route_guids)
+
+    render status: :ok, json: Presenters::V3::PaginatedListPresenter.new(
+      presenter: Presenters::V3::RoutePresenter,
+      paginated_result: SequelPaginator.new.get_page(dataset, message.try(:pagination_options)),
+      path: '/v3/routes',
+      message: message,
+    )
+  end
+
   def show
     message = RouteShowMessage.new({ guid: hashed_params['guid'] })
     unprocessable!(message.errors.full_messages) unless message.valid?

Diff for: app/messages/routes_list_message.rb

@@ -0,0 +1,9 @@
+require 'messages/metadata_list_message'
+
+module VCAP::CloudController
+  class RoutesListMessage < ListMessage
+    def self.from_params(params)
+      super(params, [])
+    end
+  end
+end

Diff for: config/routes.rb

@@ -146,6 +146,7 @@
   get '/apps/:app_guid/route_mappings', to: 'route_mappings#index'
 
   # routes
+  get '/routes', to: 'routes#index'
   post '/routes', to: 'routes#create'
   get '/routes/:guid', to: 'routes#show'
 

Diff for: docs/v3/source/includes/api_resources/_routes.erb

@@ -1,33 +1,83 @@
-<% content_for :single_route  do | metadata={} | %>
+<% content_for :single_route do %>
   {
-     "guid": "cbad697f-cac1-48f4-9017-ac08f39dfb31",
-     "host": "a-hostname",
-     "path": "/some_path",
-     "created_at": "2019-05-10T17:17:48Z",
-     "updated_at": "2019-05-10T17:17:48Z",
-     "relationships": {
-        "space": {
-           "data": {
+    "guid": "cbad697f-cac1-48f4-9017-ac08f39dfb31",
+    "host": "a-hostname",
+    "path": "/some_path",
+    "created_at": "2019-05-10T17:17:48Z",
+    "updated_at": "2019-05-10T17:17:48Z",
+    "relationships": {
+      "space": {
+        "data": {
+          "guid": "885a8cb3-c07b-4856-b448-eeb10bf36236"
+        }
+      },
+      "domain": {
+        "data": {
+          "guid": "0b5f3633-194c-42d2-9408-972366617e0e"
+        }
+      }
+    },
+    "links": {
+      "self": {
+        "href": "https://api.example.org/v3/routes/cbad697f-cac1-48f4-9017-ac08f39dfb31"
+      },
+      "space": {
+        "href": "https://api.example.org/v3/spaces/885a8cb3-c07b-4856-b448-eeb10bf36236"
+      },
+      "domain": {
+        "href": "https://api.example.org/v3/domains/0b5f3633-194c-42d2-9408-972366617e0e"
+      }
+    }
+  }
+<% end %>
+
+<% content_for :paginated_list_of_routes do %>
+  {
+    "pagination": {
+      "total_results": 3,
+      "total_pages": 2,
+      "first": {
+        "href": "https://api.example.org/v3/routes?page=1&per_page=2"
+      },
+      "last": {
+        "href": "https://api.example.org/v3/routes?page=2&per_page=2"
+      },
+      "next": {
+        "href": "https://api.example.org/v3/routes?page=2&per_page=2"
+      },
+      "previous": null
+    },
+    "resources": [
+      {
+        "guid": "cbad697f-cac1-48f4-9017-ac08f39dfb31",
+        "host": "a-hostname",
+        "path": "/some_path",
+        "created_at": "2019-05-10T17:17:48Z",
+        "updated_at": "2019-05-10T17:17:48Z",
+        "relationships": {
+          "space": {
+            "data": {
               "guid": "885a8cb3-c07b-4856-b448-eeb10bf36236"
-           }
-        },
-        "domain": {
-           "data": {
+            }
+          },
+          "domain": {
+            "data": {
               "guid": "0b5f3633-194c-42d2-9408-972366617e0e"
-           }
-        }
-     },
-     "links": {
-        "self": {
-           "href": "https://api.example.org/v3/routes/cbad697f-cac1-48f4-9017-ac08f39dfb31"
+            }
+          }
         },
-        "space": {
-           "href": "https://api.example.org/v3/spaces/885a8cb3-c07b-4856-b448-eeb10bf36236"
-        },
-        "domain": {
-           "href": "https://api.example.org/v3/domains/0b5f3633-194c-42d2-9408-972366617e0e"
+        "links": {
+          "self": {
+            "href": "https://api.example.org/v3/routes/cbad697f-cac1-48f4-9017-ac08f39dfb31"
+          },
+          "space": {
+            "href": "https://api.example.org/v3/spaces/885a8cb3-c07b-4856-b448-eeb10bf36236"
+          },
+          "domain": {
+            "href": "https://api.example.org/v3/domains/0b5f3633-194c-42d2-9408-972366617e0e"
+          }
         }
-     }
+      }
+    ]
   }
 <% end %>
-

Diff for: docs/v3/source/includes/experimental_resources/routes/_list.md.erb

@@ -0,0 +1,40 @@
+### List routes
+
+```
+Example Request
+```
+
+```shell
+curl "https://api.example.org/v3/routes" \
+  -X GET \
+  -H "Authorization: bearer [token]"
+```
+
+```
+Example Response
+```
+
+```http
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+<%= yield_content :paginated_list_of_routes, '/v3/routes' %>
+```
+
+Retrieve all routes the user has access to.
+
+#### Definition
+`GET /v3/routes`
+
+#### Query Parameters
+
+Name | Type | Description
+---- | ---- | ------------
+**page** | _integer_ | Page to display. Valid values are integers >= 1.
+**per_page** | _integer_ | Number of results per page. <br>Valid values are 1 through 5000.
+**order_by** | _string_ | Value to sort by. Defaults to ascending. Prepend with `-` to sort descending. <br>Valid values are `created_at`, `updated_at`.
+
+#### Permitted Roles
+ |
+--- | ---
+All Roles |

Diff for: docs/v3/source/index.md

@@ -225,6 +225,7 @@ includes:
   - experimental_resources/routes/object
   - experimental_resources/routes/create
   - experimental_resources/routes/get
+  - experimental_resources/routes/list
   - experimental_resources/service_bindings/header
   - experimental_resources/service_bindings/object
   - experimental_resources/service_bindings/create
@@ -233,8 +234,8 @@ includes:
   - experimental_resources/service_bindings/delete
   - experimental_resources/service_brokers/header
   - experimental_resources/service_brokers/object
-  - experimental_resources/service_brokers/list
   - experimental_resources/service_brokers/get
+  - experimental_resources/service_brokers/list
   - experimental_resources/sidecars/header
   - experimental_resources/sidecars/object
   - experimental_resources/sidecars/create_from_app

Diff for: spec/request/routes_spec.rb

@@ -7,6 +7,93 @@
   let(:space) { VCAP::CloudController::Space.make }
   let(:org) { space.organization }
 
+  describe 'GET /v3/routes' do
+    let(:other_space) { VCAP::CloudController::Space.make }
+    let(:domain) { VCAP::CloudController::PrivateDomain.make(owning_organization: space.organization) }
+    let(:route_in_org) { VCAP::CloudController::Route.make(space: space, domain: domain) }
+    let(:route_in_other_org) { VCAP::CloudController::Route.make(space: other_space) }
+    let(:api_call) { lambda { |user_headers| get '/v3/routes', nil, user_headers } }
+    let(:route_in_org_json) do
+      {
+        guid: UUID_REGEX,
+        host: route_in_org.host,
+        path: route_in_org.path,
+        created_at: iso8601,
+        updated_at: iso8601,
+        relationships: {
+          space: {
+            data: { guid: route_in_org.space.guid }
+          },
+          domain: {
+            data: { guid: route_in_org.domain.guid }
+          }
+        },
+        links: {
+          self: { href: %r(#{Regexp.escape(link_prefix)}\/v3\/routes\/#{UUID_REGEX}) },
+          space: { href: %r(#{Regexp.escape(link_prefix)}\/v3\/spaces\/#{route_in_org.space.guid}) },
+          domain: { href: %r(#{Regexp.escape(link_prefix)}\/v3\/domains\/#{route_in_org.domain.guid}) }
+        }
+      }
+    end
+
+    let(:route_in_other_org_json) do
+      {
+        guid: UUID_REGEX,
+        host: route_in_other_org.host,
+        path: route_in_other_org.path,
+        created_at: iso8601,
+        updated_at: iso8601,
+        relationships: {
+          space: {
+            data: { guid: route_in_other_org.space.guid }
+          },
+          domain: {
+            data: { guid: route_in_other_org.domain.guid }
+          }
+        },
+        links: {
+          self: { href: %r(#{Regexp.escape(link_prefix)}\/v3\/routes\/#{UUID_REGEX}) },
+          space: { href: %r(#{Regexp.escape(link_prefix)}\/v3\/spaces\/#{route_in_other_org.space.guid}) },
+          domain: { href: %r(#{Regexp.escape(link_prefix)}\/v3\/domains\/#{route_in_other_org.domain.guid}) }
+        }
+      }
+    end
+
+    context 'when the user is a member in the routes org' do
+      let(:expected_codes_and_responses) do
+        h = Hash.new(
+          code: 200,
+          response_objects: [route_in_org_json]
+        )
+
+        h['admin'] = { code: 200, response_objects: [route_in_org_json, route_in_other_org_json] }
+        h['admin_read_only'] = { code: 200, response_objects: [route_in_org_json, route_in_other_org_json] }
+        h['global_auditor'] = { code: 200, response_objects: [route_in_org_json, route_in_other_org_json] }
+
+        h['org_billing_manager'] = { code: 200, response_objects: [] }
+        h['no_role'] = { code: 200, response_objects: [] }
+        h
+      end
+
+      it_behaves_like 'permissions for list endpoint', ALL_PERMISSIONS
+    end
+
+    context 'when the request is invalid' do
+      it 'returns 400 with a meaningful error' do
+        get '/v3/routes?page=potato', nil, admin_header
+        expect(last_response.status).to eq(400)
+        expect(last_response).to have_error_message('The query parameter is invalid: Page must be a positive integer')
+      end
+    end
+
+    context 'when the user is not logged in' do
+      it 'returns 401 for Unauthenticated requests' do
+        get '/v3/routes', nil, base_json_headers
+        expect(last_response.status).to eq(401)
+      end
+    end
+  end
+
   describe 'GET /v3/routes/:guid' do
     let(:domain) { VCAP::CloudController::PrivateDomain.make(owning_organization: space.organization) }
     let(:route) { VCAP::CloudController::Route.make(space: space, domain: domain) }

Diff for: spec/request_spec_shared_examples.rb

@@ -28,6 +28,15 @@
         if (200...300).cover? expected_response_code
           expected_response_objects = expected_codes_and_responses[role][:response_objects]
           expect({ resources: parsed_response['resources'] }).to match_json_response({ resources: expected_response_objects })
+
+          expect(parsed_response['pagination']).to match_json_response({
+            total_results: an_instance_of(Integer),
+            total_pages: an_instance_of(Integer),
+            first: { href: /#{link_prefix}.+page=\d+&per_page=\d+/ },
+            last: { href: /#{link_prefix}.+page=\d+&per_page=\d+/ },
+            next: anything,
+            previous: anything
+          })
         end
       end
     end

Diff for: spec/unit/presenters/v3/droplet_presenter_spec.rb

@@ -76,16 +76,20 @@ module VCAP::CloudController::Presenters::V3
           let(:buildpack_receipt_buildpack) { 'https://amelia:[email protected]' }
 
           it 'obfuscates the username and password' do
-            expect(result[:buildpacks]).to match_array([{ name: 'shaq',
-              detect_output: nil,
-              buildpack_name: nil,
-              version: nil
-            },
-              { name: 'https://***:***@neopets.com',
+            expect(result[:buildpacks]).to match_array([
+              {
+                name: 'shaq',
+                detect_output: nil,
+                buildpack_name: nil,
+                version: nil
+              },
+              {
+                name: 'https://***:***@neopets.com',
                 detect_output: 'the-happiest-buildpack-detect-output',
                 buildpack_name: nil,
                 version: nil
-              }])
+              }
+            ])
           end
         end