V3 service plans - optionally include service offering in response

[#172309159](https://www.pivotaltracker.com/story/show/172309159)

Author: blgm

app/controllers/v3/service_plans_controller.rb

@@ -7,6 +7,7 @@
 require 'messages/metadata_update_message'
 require 'actions/transactional_metadata_update'
 require 'decorators/include_service_plan_space_organization_decorator'
+require 'decorators/include_service_plan_service_offering_decorator'
 
 class ServicePlansController < ApplicationController
   include ServicePermissions
@@ -42,6 +43,7 @@ def index
 
     decorators = []
     decorators << IncludeServicePlanSpaceOrganizationDecorator if IncludeServicePlanSpaceOrganizationDecorator.match?(message.include)
+    decorators << IncludeServicePlanServiceOfferingDecorator if IncludeServicePlanServiceOfferingDecorator.match?(message.include)
 
     presenter = Presenters::V3::PaginatedListPresenter.new(
       presenter: Presenters::V3::ServicePlanPresenter,

app/decorators/include_service_plan_service_offering_decorator.rb

@@ -0,0 +1,20 @@
+module VCAP::CloudController
+  class IncludeServicePlanServiceOfferingDecorator
+    class << self
+      def match?(include)
+        include&.include?('service_offering')
+      end
+
+      def decorate(hash, service_plans)
+        hash[:included] ||= {}
+        service_offerings = service_plans.map(&:service).uniq
+
+        hash[:included][:service_offerings] = service_offerings.sort_by(&:created_at).map do |service_offering|
+          Presenters::V3::ServiceOfferingPresenter.new(service_offering).to_hash
+        end
+
+        hash
+      end
+    end
+  end
+end

app/messages/service_plans_list_message.rb

@@ -22,7 +22,7 @@ class ServicePlansListMessage < MetadataListMessage
     register_allowed_keys(@single_keys + @array_keys)
 
     validates_with NoAdditionalParamsValidator
-    validates_with IncludeParamValidator, valid_values: ['space.organization']
+    validates_with IncludeParamValidator, valid_values: %w(space.organization service_offering)
     validates :available, inclusion: { in: %w(true false), message: "only accepts values 'true' or 'false'" }, allow_nil: true
 
     def self.from_params(params)

docs/v3/source/includes/concepts/_includes.md.erb

@@ -18,6 +18,7 @@ Resource | Allowed values
 **roles/[:guid]** | `user`, `space`, `organization`
 **routes** | `domain`
 **routes/[:guid]** | `domain`
+**service_plans** | `space.organization`, `service_offering`
 **spaces** | `organization`
 **spaces/[:guid]** | `organization`
 

docs/v3/source/includes/experimental_resources/service_plans/_list.md.erb

@@ -41,6 +41,8 @@ Name | Type | Description
 **service_offering_names** | _list of strings_ | Comma-delimited list of Service Offering names to filter by.
 **service_instance_guids** | _list of strings_ | Comma-delimited list of Service Instance GUIDs to filter by.
 **label_selector** | _string_ | **Experimental** - A query string containing a list of [label selector](#labels-and-selectors) requirements.
+**include** | _list of strings_ | Optionally include a list of unique related resources in the response. <br>Valid values are `space.organization` and `service_offering`.
+
 
 The **organization_guids** and **space_guids** filters do not filter plans that are public.
 They both act on plans that are restricted to certain Organizations, and to plans from Space-Scoped

spec/request/service_plans_spec.rb

@@ -149,9 +149,9 @@
           space_guids: %w(hoge piyo),
           include: 'space.organization',
           available: true,
-          per_page:   '10',
+          per_page: '10',
           page: 2,
-          order_by:   'updated_at',
+          order_by: 'updated_at',
           label_selector: 'foo==bar',
         }
       end
@@ -443,12 +443,12 @@
     end
 
     describe 'includes' do
-      let(:space_1) { VCAP::CloudController::Space.make }
-      let(:space_2) { VCAP::CloudController::Space.make }
-      let!(:space_scoped_plan_1) { generate_space_scoped_plan(space_1) }
-      let!(:space_scoped_plan_2) { generate_space_scoped_plan(space_2) }
-
       it 'can include `space.organization`' do
+        space_1 = VCAP::CloudController::Space.make
+        space_2 = VCAP::CloudController::Space.make
+        generate_space_scoped_plan(space_1)
+        generate_space_scoped_plan(space_2)
+
         get '/v3/service_plans?include=space.organization', nil, admin_headers
         expect(last_response).to have_status_code(200)
 
@@ -460,6 +460,21 @@
         expect(parsed_response['included']['organizations'][0]['guid']).to eq(space_1.organization.guid)
         expect(parsed_response['included']['organizations'][1]['guid']).to eq(space_2.organization.guid)
       end
+
+      it 'can include `service_offering`' do
+        offering_1 = VCAP::CloudController::Service.make
+        offering_2 = VCAP::CloudController::Service.make
+        VCAP::CloudController::ServicePlan.make(service: offering_1)
+        VCAP::CloudController::ServicePlan.make(service: offering_2)
+        VCAP::CloudController::ServicePlan.make(service: offering_2)
+
+        get '/v3/service_plans?include=service_offering', nil, admin_headers
+        expect(last_response).to have_status_code(200)
+
+        expect(parsed_response['included']['service_offerings']).to have(2).elements
+        expect(parsed_response['included']['service_offerings'][0]['guid']).to eq(offering_1.guid)
+        expect(parsed_response['included']['service_offerings'][1]['guid']).to eq(offering_2.guid)
+      end
     end
   end
 

spec/unit/decorators/include_service_plan_service_offering_decorator_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'decorators/include_service_plan_service_offering_decorator'
+
+module VCAP::CloudController
+  RSpec.describe IncludeServicePlanServiceOfferingDecorator do
+    describe '.decorate' do
+      let(:offering_1) { Service.make }
+      let(:offering_2) { Service.make }
+      let(:plan_1) { ServicePlan.make(service: offering_1) }
+      let(:plan_2) { ServicePlan.make(service: offering_2) }
+      let(:plan_3) { ServicePlan.make(service: offering_2) }
+
+      it 'decorates the given hash with service offerings from service plans' do
+        undecorated_hash = { foo: 'bar', included: { monkeys: %w(zach greg) } }
+        hash = described_class.decorate(undecorated_hash, [plan_1, plan_2, plan_3])
+
+        expect(hash[:foo]).to eq('bar')
+        expect(hash[:included][:monkeys]).to contain_exactly('zach', 'greg')
+        expect(hash[:included].keys).to have(2).keys
+
+        expect(hash[:included][:service_offerings]).to match_array([
+          Presenters::V3::ServiceOfferingPresenter.new(offering_1).to_hash,
+          Presenters::V3::ServiceOfferingPresenter.new(offering_2).to_hash
+        ])
+      end
+
+      it 'only includes the service offerings from the specified service plans' do
+        hash = described_class.decorate({}, [plan_1])
+        expect(hash[:included][:service_offerings]).to have(1).element
+      end
+    end
+
+    describe '.match?' do
+      it 'matches arrays containing "service_offering"' do
+        expect(described_class.match?(['potato', 'service_offering', 'turnip'])).to be_truthy
+      end
+
+      it 'does not match other arrays' do
+        expect(described_class.match?(['potato', 'turnip'])).to be_falsey
+      end
+    end
+  end
+end

spec/unit/messages/service_plans_list_message_spec.rb

@@ -8,7 +8,7 @@ module VCAP::CloudController
         {
           'available' => 'true',
           'broker_catalog_ids' => 'broker_catalog_id_1,broker_catalog_id_2',
-          'include' => 'space.organization',
+          'include' => 'space.organization,service_offering',
           'names' => 'name_1,name_2',
           'organization_guids' => 'org_guid_1,org_guid_2',
           'service_broker_guids' => 'broker_guid_1,broker_guid_2',
@@ -27,7 +27,7 @@ module VCAP::CloudController
         expect(message).to be_a(ServicePlansListMessage)
         expect(message.available).to eq('true')
         expect(message.broker_catalog_ids).to contain_exactly('broker_catalog_id_1', 'broker_catalog_id_2')
-        expect(message.include).to contain_exactly('space.organization')
+        expect(message.include).to contain_exactly('space.organization', 'service_offering')
         expect(message.names).to contain_exactly('name_1', 'name_2')
         expect(message.organization_guids).to contain_exactly('org_guid_1', 'org_guid_2')
         expect(message.service_broker_guids).to contain_exactly('broker_guid_1', 'broker_guid_2')