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/actions/app_usage_consumer_delete.rb

@@ -0,0 +1,9 @@
+module VCAP::CloudController
+  class AppUsageConsumerDelete
+    def delete(app_usage_consumer)
+      app_usage_consumer.destroy
+    rescue Sequel::Error => e
+      raise CloudController::Errors::ApiError.new_from_details('AppUsageConsumerDeleteError', e.message)
+    end
+  end
+end

app/actions/service_usage_consumer_delete.rb

@@ -0,0 +1,9 @@
+module VCAP::CloudController
+  class ServiceUsageConsumerDelete
+    def delete(service_usage_consumer)
+      service_usage_consumer.destroy
+    rescue Sequel::Error => e
+      raise CloudController::Errors::ApiError.new_from_details('ServiceUsageConsumerDeleteError', e.message)
+    end
+  end
+end

app/controllers/v3/app_usage_consumers_controller.rb

@@ -0,0 +1,41 @@
+require 'presenters/v3/app_usage_consumer_presenter'
+require 'messages/app_usage_consumers_list_message'
+require 'fetchers/app_usage_consumer_list_fetcher'
+require 'actions/app_usage_consumer_delete'
+
+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,
+      extra_presenter_args: {}
+    )
+  end
+
+  def show
+    app_usage_consumer = AppUsageConsumer.where(consumer_guid: params[:guid]).first
+    resource_not_found!(:app_usage_consumer) unless app_usage_consumer && permission_queryer.can_read_globally?
+
+    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.where(consumer_guid: params[:guid]).first
+    resource_not_found!(:app_usage_consumer) unless app_usage_consumer
+
+    AppUsageConsumerDelete.new.delete(app_usage_consumer)
+
+    head :no_content
+  end
+end

app/controllers/v3/service_usage_consumers_controller.rb

@@ -0,0 +1,41 @@
+require 'presenters/v3/service_usage_consumer_presenter'
+require 'messages/service_usage_consumers_list_message'
+require 'fetchers/service_usage_consumer_list_fetcher'
+require 'actions/service_usage_consumer_delete'
+
+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,
+      extra_presenter_args: {}
+    )
+  end
+
+  def show
+    service_usage_consumer = ServiceUsageConsumer.where(consumer_guid: params[:guid]).first
+    resource_not_found!(:service_usage_consumer) unless service_usage_consumer && permission_queryer.can_read_globally?
+
+    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.where(consumer_guid: params[:guid]).first
+    resource_not_found!(:service_usage_consumer) unless service_usage_consumer
+
+    ServiceUsageConsumerDelete.new.delete(service_usage_consumer)
+
+    head :no_content
+  end
+end

app/fetchers/app_usage_consumer_list_fetcher.rb

@@ -0,0 +1,17 @@
+require 'fetchers/base_list_fetcher'
+
+module VCAP::CloudController
+  class AppUsageConsumerListFetcher < BaseListFetcher
+    class << self
+      def fetch_all(message, dataset)
+        dataset = filter(message, dataset, AppUsageConsumer)
+
+        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,17 @@
+require 'fetchers/base_list_fetcher'
+
+module VCAP::CloudController
+  class ServiceUsageConsumerListFetcher < BaseListFetcher
+    class << self
+      def fetch_all(message, dataset)
+        dataset = filter(message, dataset, ServiceUsageConsumer)
+
+        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,14 @@
+require 'messages/list_message'
+
+module VCAP::CloudController
+  class AppUsageConsumersListMessage < ListMessage
+    register_allowed_keys %i[consumer_guids last_processed_guids]
+
+    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,14 @@
+require 'messages/list_message'
+
+module VCAP::CloudController
+  class ServiceUsageConsumersListMessage < ListMessage
+    register_allowed_keys %i[consumer_guids last_processed_guids]
+
+    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,29 @@
+require 'presenters/v3/base_presenter'
+
+module VCAP::CloudController::Presenters::V3
+  class AppUsageConsumerPresenter < BasePresenter
+    def to_hash
+      {
+        guid: app_usage_consumer.consumer_guid,
+        last_processed_guid: app_usage_consumer.last_processed_guid,
+        created_at: app_usage_consumer.created_at,
+        updated_at: app_usage_consumer.updated_at,
+        links: build_links
+      }
+    end
+
+    private
+
+    def app_usage_consumer
+      @resource
+    end
+
+    def build_links
+      {
+        self: {
+          href: url_builder.build_url(path: "/v3/app_usage_consumers/#{app_usage_consumer.consumer_guid}")
+        }
+      }
+    end
+  end
+end

app/presenters/v3/service_usage_consumer_presenter.rb

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