Provide index, show, and destroy endpoints for usage consumers

Allows for usage consumers to de-register themselves with the cloud controller. Index and show methods allow consumers to make informed decisions before initiating a purge of usage events.

Usage event endpoint re-ordered to align with convention of other resources.

Author: joyvuu-dave

app/controllers/v3/app_usage_consumers_controller.rb

@@ -0,0 +1,50 @@
+require 'presenters/v3/app_usage_consumer_presenter'
+require 'messages/app_usage_consumers_list_message'
+require 'fetchers/app_usage_consumer_list_fetcher'
+
+class AppUsageConsumersController < ApplicationController
+  def index
+    message = AppUsageConsumersListMessage.from_params(query_params)
+    invalid_param!(message.errors.full_messages) unless message.valid?
+
+    app_usage_consumers = AppUsageConsumer.where(guid: [])
+
+    app_usage_consumers = AppUsageConsumerListFetcher.fetch_all(message, AppUsageConsumer.dataset) if permission_queryer.can_read_globally?
+
+    render status: :ok, json: Presenters::V3::PaginatedListPresenter.new(
+      presenter: Presenters::V3::AppUsageConsumerPresenter,
+      paginated_result: SequelPaginator.new.get_page(app_usage_consumers, message.try(:pagination_options)),
+      path: '/v3/app_usage_consumers',
+      message: message
+    )
+  end
+
+  def show
+    app_usage_consumer_not_found! unless permission_queryer.can_read_globally?
+    app_usage_consumer = AppUsageConsumer.first(guid: hashed_params[:guid])
+    app_usage_consumer_not_found! unless app_usage_consumer
+
+    render status: :ok, json: Presenters::V3::AppUsageConsumerPresenter.new(app_usage_consumer)
+  end
+
+  def destroy
+    unauthorized! unless permission_queryer.can_write_globally?
+
+    app_usage_consumer = AppUsageConsumer.find(consumer_guid: hashed_params[:guid])
+
+    resource_not_found!(:app_usage_consumer) unless app_usage_consumer
+
+    app_usage_consumer_access = VCAP::CloudController::AppUsageConsumerAccess.new(context: SecurityContext)
+    unauthorized! unless app_usage_consumer_access.delete?(app_usage_consumer)
+
+    app_usage_consumer.destroy
+
+    head :no_content
+  end
+
+  private
+
+  def app_usage_consumer_not_found!
+    resource_not_found!(:app_usage_consumer)
+  end
+end

app/controllers/v3/service_usage_consumers_controller.rb

@@ -0,0 +1,50 @@
+require 'presenters/v3/service_usage_consumer_presenter'
+require 'messages/service_usage_consumers_list_message'
+require 'fetchers/service_usage_consumer_list_fetcher'
+
+class ServiceUsageConsumersController < ApplicationController
+  def index
+    message = ServiceUsageConsumersListMessage.from_params(query_params)
+    invalid_param!(message.errors.full_messages) unless message.valid?
+
+    service_usage_consumers = ServiceUsageConsumer.where(guid: [])
+
+    service_usage_consumers = ServiceUsageConsumerListFetcher.fetch_all(message, ServiceUsageConsumer.dataset) if permission_queryer.can_read_globally?
+
+    render status: :ok, json: Presenters::V3::PaginatedListPresenter.new(
+      presenter: Presenters::V3::ServiceUsageConsumerPresenter,
+      paginated_result: SequelPaginator.new.get_page(service_usage_consumers, message.try(:pagination_options)),
+      path: '/v3/service_usage_consumers',
+      message: message
+    )
+  end
+
+  def show
+    service_usage_consumer_not_found! unless permission_queryer.can_read_globally?
+    service_usage_consumer = ServiceUsageConsumer.first(guid: hashed_params[:guid])
+    service_usage_consumer_not_found! unless service_usage_consumer
+
+    render status: :ok, json: Presenters::V3::ServiceUsageConsumerPresenter.new(service_usage_consumer)
+  end
+
+  def destroy
+    unauthorized! unless permission_queryer.can_write_globally?
+
+    service_usage_consumer = ServiceUsageConsumer.find(consumer_guid: hashed_params[:guid])
+
+    resource_not_found!(:service_usage_consumer) unless service_usage_consumer
+
+    service_usage_consumer_access = VCAP::CloudController::ServiceUsageConsumerAccess.new(context: SecurityContext)
+    unauthorized! unless service_usage_consumer_access.delete?(service_usage_consumer)
+
+    service_usage_consumer.destroy
+
+    head :no_content
+  end
+
+  private
+
+  def service_usage_consumer_not_found!
+    resource_not_found!(:service_usage_consumer)
+  end
+end

app/fetchers/app_usage_consumer_list_fetcher.rb

@@ -0,0 +1,21 @@
+require 'fetchers/base_list_fetcher'
+
+module VCAP::CloudController
+  class AppUsageConsumerListFetcher
+    class << self
+      def fetch_all(message, dataset)
+        filter(message, dataset)
+      end
+
+      private
+
+      def filter(message, dataset)
+        dataset = dataset.where(consumer_guid: message.consumer_guids) if message.requested?(:consumer_guids)
+
+        dataset = dataset.where(last_processed_guid: message.last_processed_guids) if message.requested?(:last_processed_guids)
+
+        dataset
+      end
+    end
+  end
+end

app/fetchers/service_usage_consumer_list_fetcher.rb

@@ -0,0 +1,21 @@
+require 'fetchers/base_list_fetcher'
+
+module VCAP::CloudController
+  class ServiceUsageConsumerListFetcher
+    class << self
+      def fetch_all(message, dataset)
+        filter(message, dataset)
+      end
+
+      private
+
+      def filter(message, dataset)
+        dataset = dataset.where(consumer_guid: message.consumer_guids) if message.requested?(:consumer_guids)
+
+        dataset = dataset.where(last_processed_guid: message.last_processed_guids) if message.requested?(:last_processed_guids)
+
+        dataset
+      end
+    end
+  end
+end

app/messages/app_usage_consumers_list_message.rb

@@ -0,0 +1,19 @@
+require 'messages/list_message'
+
+module VCAP::CloudController
+  class AppUsageConsumersListMessage < ListMessage
+    register_allowed_keys %i[
+      consumer_guids
+      last_processed_guids
+    ]
+
+    validates_with NoAdditionalKeysValidator
+
+    validates :consumer_guids, array: true, allow_nil: true
+    validates :last_processed_guids, array: true, allow_nil: true
+
+    def self.from_params(params)
+      super(params, %w[consumer_guids last_processed_guids])
+    end
+  end
+end

app/messages/service_usage_consumers_list_message.rb

@@ -0,0 +1,19 @@
+require 'messages/list_message'
+
+module VCAP::CloudController
+  class ServiceUsageConsumersListMessage < ListMessage
+    register_allowed_keys %i[
+      consumer_guids
+      last_processed_guids
+    ]
+
+    validates_with NoAdditionalKeysValidator
+
+    validates :consumer_guids, array: true, allow_nil: true
+    validates :last_processed_guids, array: true, allow_nil: true
+
+    def self.from_params(params)
+      super(params, %w[consumer_guids last_processed_guids])
+    end
+  end
+end

app/presenters/v3/app_usage_consumer_presenter.rb

@@ -0,0 +1,35 @@
+require 'presenters/v3/base_presenter'
+
+module VCAP::CloudController::Presenters::V3
+  class AppUsageConsumerPresenter < BasePresenter
+    def to_hash
+      {
+        guid: consumer_guid,
+        last_processed_guid: last_processed_guid,
+        created_at: resource.created_at,
+        updated_at: resource.updated_at,
+        links: build_links
+      }
+    end
+
+    private
+
+    def consumer_guid
+      resource.consumer_guid
+    end
+
+    def last_processed_guid
+      resource.last_processed_guid
+    end
+
+    def build_links
+      url_builder = VCAP::CloudController::Presenters::ApiUrlBuilder.new
+
+      {
+        self: {
+          href: url_builder.build_url(path: "/v3/app_usage_consumers/#{consumer_guid}")
+        }
+      }
+    end
+  end
+end

app/presenters/v3/service_usage_consumer_presenter.rb

@@ -0,0 +1,35 @@
+require 'presenters/v3/base_presenter'
+
+module VCAP::CloudController::Presenters::V3
+  class ServiceUsageConsumerPresenter < BasePresenter
+    def to_hash
+      {
+        guid: consumer_guid,
+        last_processed_guid: last_processed_guid,
+        created_at: resource.created_at,
+        updated_at: resource.updated_at,
+        links: build_links
+      }
+    end
+
+    private
+
+    def consumer_guid
+      resource.consumer_guid
+    end
+
+    def last_processed_guid
+      resource.last_processed_guid
+    end
+
+    def build_links
+      url_builder = VCAP::CloudController::Presenters::ApiUrlBuilder.new
+
+      {
+        self: {
+          href: url_builder.build_url(path: "/v3/service_usage_consumers/#{consumer_guid}")
+        }
+      }
+    end
+  end
+end

config/routes.rb

@@ -323,15 +323,25 @@
   get '/audit_events/:guid', to: 'events#show'
 
   # app usage events
-  get '/app_usage_events/:guid', to: 'app_usage_events#show'
   get '/app_usage_events', to: 'app_usage_events#index'
+  get '/app_usage_events/:guid', to: 'app_usage_events#show'
   post '/app_usage_events/actions/destructively_purge_all_and_reseed', to: 'app_usage_events#destructively_purge_all_and_reseed'
 
   # service usage events
-  get '/service_usage_events/:guid', to: 'service_usage_events#show'
   get '/service_usage_events', to: 'service_usage_events#index'
+  get '/service_usage_events/:guid', to: 'service_usage_events#show'
   post '/service_usage_events/actions/destructively_purge_all_and_reseed', to: 'service_usage_events#destructively_purge_all_and_reseed'
 
+  # app usage consumers
+  get '/app_usage_consumers', to: 'app_usage_consumers#index'
+  get '/app_usage_consumers/:guid', to: 'app_usage_consumers#show'
+  delete '/app_usage_consumers/:guid', to: 'app_usage_consumers#destroy'
+
+  # service usage consumers
+  get '/service_usage_consumers', to: 'service_usage_consumers#index'
+  get '/service_usage_consumers/:guid', to: 'service_usage_consumers#show'
+  delete '/service_usage_consumers/:guid', to: 'service_usage_consumers#destroy'
+
   # environment variable groups
   get '/environment_variable_groups/:name', to: 'environment_variable_groups#show'
   patch '/environment_variable_groups/:name', to: 'environment_variable_groups#update'