Service plan include of service offering/space.organization

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

Author: pivotal-marcela-campo

app/controllers/v3/service_plans_controller.rb

@@ -25,6 +25,8 @@ def show
     service_plan_not_found! unless visible_to_current_user?(plan: service_plan)
 
     decorators = []
+    decorators << IncludeServicePlanSpaceOrganizationDecorator if IncludeServicePlanSpaceOrganizationDecorator.match?(message.include)
+    decorators << IncludeServicePlanServiceOfferingDecorator if IncludeServicePlanServiceOfferingDecorator.match?(message.include)
     decorators << FieldServicePlanServiceBrokerDecorator.new(message.fields) if FieldServicePlanServiceBrokerDecorator.match?(message.fields)
 
     presenter = Presenters::V3::ServicePlanPresenter.new(service_plan, decorators: decorators)

app/messages/service_plans_show_message.rb

@@ -1,16 +1,24 @@
 module VCAP::CloudController
   class ServicePlansShowMessage < BaseMessage
-    register_allowed_keys [:fields]
+    @array_keys = [
+      :include
+    ]
+    @single_keys = [
+      :fields
+    ]
+
+    register_allowed_keys(@single_keys + @array_keys)
 
     validates_with NoAdditionalParamsValidator
+    validates_with IncludeParamValidator, valid_values: %w(space.organization service_offering)
     validates :fields, allow_nil: true, fields: {
       allowed: {
         'service_offering.service_broker' => ['guid', 'name']
       }
     }
 
     def self.from_params(params)
-      super(params, [], fields: %w(fields))
+      super(params, @array_keys.map(&:to_s), fields: %w(fields))
     end
   end
 end

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

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

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

@@ -31,6 +31,7 @@ This endpoint retrieves the service plan by GUID.
 Name | Type | Description
 ---- | ---- | ------------
 **fields** | [_fields parameter_](#fields-parameter) | [_Allowed values_](#service-plan-fields)
+**include** | _list of strings_ | Optionally include a list of related resources in the response. <br>Valid values are `space.organization` and `service_offering`.
 
 ##### Service Plan Fields
 

spec/request/service_plans_spec.rb

@@ -141,6 +141,34 @@
         expect(parsed_response['included']['service_brokers'][0]['name']).to eq(service_plan.service.service_broker.name)
       end
     end
+
+    describe 'includes' do
+      it 'can include `space.organization`' do
+        plan = generate_space_scoped_plan(space)
+        guid = plan.guid
+
+        get "/v3/service_plans/#{guid}?include=space.organization", nil, admin_headers
+        expect(last_response).to have_status_code(200)
+
+        expect(parsed_response['included']['spaces']).to have(1).element
+        expect(parsed_response['included']['spaces'][0]['guid']).to eq(space.guid)
+
+        expect(parsed_response['included']['organizations']).to have(1).element
+        expect(parsed_response['included']['organizations'][0]['guid']).to eq(space.organization.guid)
+      end
+
+      it 'can include `service_offering`' do
+        offering = VCAP::CloudController::Service.make
+        plan = VCAP::CloudController::ServicePlan.make(service: offering)
+        guid = plan.guid
+
+        get "/v3/service_plans/#{guid}?include=service_offering", nil, admin_headers
+        expect(last_response).to have_status_code(200)
+
+        expect(parsed_response['included']['service_offerings']).to have(1).element
+        expect(parsed_response['included']['service_offerings'][0]['guid']).to eq(offering.guid)
+      end
+    end
   end
 
   describe 'GET /v3/service_plans' do

spec/unit/messages/service_plans_show_message_spec.rb

@@ -8,6 +8,7 @@ module VCAP::CloudController
       let(:params) do
         {
           'fields' => { 'service_offering.service_broker' => 'guid,name' },
+          'include' => 'space.organization,service_offering',
         }.with_indifferent_access
       end
 
@@ -17,11 +18,13 @@ module VCAP::CloudController
         expect(message).to be_valid
         expect(message).to be_a(described_class)
         expect(message.fields).to match({ 'service_offering.service_broker': ['guid', 'name'] })
+        expect(message.include).to contain_exactly('space.organization', 'service_offering')
       end
 
       it 'converts requested keys to symbols' do
         message = described_class.from_params(params)
         expect(message.requested?(:fields)).to be_truthy
+        expect(message.requested?(:include)).to be_truthy
       end
 
       it 'accepts an empty set' do
@@ -41,6 +44,14 @@ module VCAP::CloudController
 
         it_behaves_like 'field query parameter', 'service_offering.service_broker', 'guid,name'
       end
+
+      context 'include' do
+        it 'does not accept other values' do
+          message = described_class.from_params({ include: 'space' }.with_indifferent_access)
+          expect(message).not_to be_valid
+          expect(message.errors[:base]).to include(include("Invalid included resource: 'space'"))
+        end
+      end
     end
   end
 end