Get guid,name of service broker in service offering list request

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

Author: pivotal-marcela-campo

app/controllers/v3/service_offerings_controller.rb

@@ -8,6 +8,7 @@
 require 'actions/service_offering_delete'
 require 'actions/transactional_metadata_update'
 require 'controllers/v3/mixins/service_permissions'
+require 'decorators/field_service_offering_service_broker_decorator'
 
 class ServiceOfferingsController < ApplicationController
   include ServicePermissions
@@ -30,11 +31,15 @@ def index
                 )
               end
 
+    decorators = []
+    decorators << FieldServiceOfferingServiceBrokerDecorator.new(message.fields) if FieldServiceOfferingServiceBrokerDecorator.match?(message.fields)
+
     presenter = Presenters::V3::PaginatedListPresenter.new(
       presenter: Presenters::V3::ServiceOfferingPresenter,
       paginated_result: SequelPaginator.new.get_page(dataset, message.try(:pagination_options)),
       message: message,
       path: '/v3/service_offerings',
+      decorators: decorators
     )
 
     render status: :ok, json: presenter.to_json

app/decorators/field_service_offering_service_broker_decorator.rb

@@ -0,0 +1,28 @@
+module VCAP::CloudController
+  class FieldServiceOfferingServiceBrokerDecorator
+    def self.allowed
+      Set['name', 'guid']
+    end
+
+    def self.match?(fields)
+      fields.is_a?(Hash) && fields[:'service_broker']&.to_set&.intersect?(self.allowed)
+    end
+
+    def initialize(fields)
+      @fields = fields[:'service_broker'].to_set.intersection(self.class.allowed)
+    end
+
+    def decorate(hash, service_offerings)
+      hash[:included] ||= {}
+      service_brokers = service_offerings.map(&:service_broker).uniq
+      hash[:included][:service_brokers] = service_brokers.sort_by(&:created_at).map do |broker|
+        broker_view = {}
+        broker_view[:name] = broker.name if @fields.include?('name')
+        broker_view[:guid] = broker.guid if @fields.include?('guid')
+        broker_view
+      end
+
+      hash
+    end
+  end
+end

app/messages/service_offerings_list_message.rb

@@ -3,20 +3,32 @@
 
 module VCAP::CloudController
   class ServiceOfferingsListMessage < MetadataListMessage
-    register_allowed_keys [
-      :available,
+    @array_keys = [
       :service_broker_guids,
       :service_broker_names,
       :names,
       :space_guids,
       :organization_guids,
     ]
 
+    @single_keys = [
+      :available,
+      :fields
+    ]
+
+    register_allowed_keys(@single_keys + @array_keys)
+
     validates_with NoAdditionalParamsValidator
     validates :available, inclusion: { in: %w(true false), message: "only accepts values 'true' or 'false'" }, allow_nil: true
 
+    validates :fields, allow_nil: true, fields: {
+      allowed: {
+        'service_broker' => ['guid', 'name']
+      }
+    }
+
     def self.from_params(params)
-      super(params, %w(service_broker_guids service_broker_names names space_guids organization_guids))
+      super(params, @array_keys.map(&:to_s), fields: %w(fields))
     end
   end
 end

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

@@ -37,6 +37,13 @@ Name | Type | Description
 **space_guids** | _list of strings_ | Comma-delimited list of Space GUIDs to filter by.
 **organization_guids** | _list of strings_ | Comma-delimited list of Organization GUIDs to filter by.
 **label_selector** | _string_ | **Experimental** - A query string containing a list of [label selector](#labels-and-selectors) requirements.
+**fields** | [_fields parameter_](#fields-parameter) | **Experimental** [_Allowed values_](#service-offerings-list-fields)
+
+##### Service Offerings List Fields
+
+Resource            | Allowed Keys
+------------------- | ----
+service_broker| `guid`, `name`
 
 #### Permitted roles
  |

spec/field_message_spec_shared_examples.rb

@@ -25,4 +25,18 @@
     quoted_keys = keys_list.map { |k| "'#{k}'" }
     expect(message.errors[:fields]).to include("valid keys for '#{resource}' are: #{quoted_keys.join(', ')}")
   end
+
+  it 'validates `fields` is a hash' do
+    message = described_class.from_params({ 'fields' => 'foo' }.with_indifferent_access)
+    expect(message).not_to be_valid
+    expect(message.errors[:fields][0]).to include('must be an object')
+  end
+
+  it 'does not accept fields resources that are not allowed' do
+    message = described_class.from_params({ 'fields' => { 'space.foo': 'name' } })
+    expect(message).not_to be_valid
+    expect(message.errors[:fields]).to include(include(
+                                                 '[space.foo] valid resources are:'
+    ))
+  end
 end

spec/request/service_offerings_spec.rb

@@ -204,6 +204,7 @@
           page: 2,
           order_by:   'updated_at',
           label_selector: 'foo==bar',
+          fields: { 'service_broker' => 'name' }
         }
       end
     end
@@ -690,6 +691,22 @@
         it_behaves_like 'permissions for list endpoint', COMPLETE_PERMISSIONS
       end
     end
+
+    describe 'fields' do
+      let!(:service_1) { VCAP::CloudController::Service.make }
+      let!(:service_2) { VCAP::CloudController::Service.make }
+
+      it 'can include service broker name and guid' do
+        get '/v3/service_offerings?fields[service_broker]=name,guid', nil, admin_headers
+        expect(last_response).to have_status_code(200)
+
+        expect(parsed_response['included']['service_brokers']).to have(2).elements
+        expect(parsed_response['included']['service_brokers'][0]['guid']).to eq(service_1.service_broker.guid)
+        expect(parsed_response['included']['service_brokers'][0]['name']).to eq(service_1.service_broker.name)
+        expect(parsed_response['included']['service_brokers'][1]['guid']).to eq(service_2.service_broker.guid)
+        expect(parsed_response['included']['service_brokers'][1]['name']).to eq(service_2.service_broker.name)
+      end
+    end
   end
 
   describe 'DELETE /v3/service_offerings/:guid' do

spec/unit/decorators/field_service_offering_service_broker_decorator_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'decorators/field_service_offering_service_broker_decorator'
+require 'field_decorator_spec_shared_examples'
+
+module VCAP::CloudController
+  RSpec.describe FieldServiceOfferingServiceBrokerDecorator do
+    describe '.decorate' do
+      let(:offering1) { Service.make }
+      let(:offering2) { Service.make }
+
+      it 'decorated the given hash with broker name and guid' do
+        undecorated_hash = { foo: 'bar', included: { monkeys: %w(zach greg) } }
+        decorator = described_class.new({ 'service_broker': ['name', 'guid'] })
+
+        hash = decorator.decorate(undecorated_hash, [offering1, offering2])
+
+        expect(hash).to match({
+          foo: 'bar',
+          included: {
+            monkeys: %w(zach greg),
+            service_brokers: [
+              {
+                guid: offering1.service_broker.guid,
+                name: offering1.service_broker.name
+              },
+              {
+                guid: offering2.service_broker.guid,
+                name: offering2.service_broker.name
+              }
+            ]
+          }
+        })
+      end
+
+      context 'when offerings are from the same broker' do
+        let(:offering3) { Service.make(service_broker: offering1.service_broker) }
+
+        it 'does not duplicate the broker' do
+          decorator = described_class.new({ 'service_broker': ['name'] })
+          hash = decorator.decorate({}, [offering1, offering3])
+          expect(hash[:included][:service_brokers]).to have(1).element
+        end
+      end
+    end
+
+    describe '.match?' do
+      it_behaves_like 'field decorator match?', 'service_broker', ['name', 'guid']
+    end
+  end
+end

spec/unit/messages/service_offerings_list_message_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'messages/service_offerings_list_message'
+require 'field_message_spec_shared_examples'
 
 module VCAP::CloudController
   RSpec.describe ServiceOfferingsListMessage do
@@ -71,6 +72,10 @@ module VCAP::CloudController
           expect(message.errors[:available]).to include("only accepts values 'true' or 'false'")
         end
       end
+
+      context 'fields' do
+        it_behaves_like 'field query parameter', 'service_broker', 'guid,name'
+      end
     end
   end
 end