v3(services): GET Credential binding object response (cloudfoundry#1769)

Derik Evangelista · Brian Butz · web-flow · commit 6c5f962e2cf3 · 2020-08-05T13:35:15.000+01:00
[#173129426](https://www.pivotaltracker.com/story/show/173129426) Co-authored-by: Brian Butz <bbutz@pivotal.io>
diff --git a/app/fetchers/service_credential_binding_fetcher.rb b/app/fetchers/service_credential_binding_fetcher.rb
@@ -1,15 +1,8 @@
 module VCAP
   module CloudController
     class ServiceCredentialBindingFetcher
-      ServiceInstanceCredential = Struct.new(:guid, :type).freeze
-
       def fetch(guid, space_guids:)
-        list_fetcher.fetch(space_guids: space_guids).first(guid: guid).try do |db_binding|
-          ServiceInstanceCredential.new(
-            db_binding.guid,
-            db_binding.type
-          )
-        end
+        list_fetcher.fetch(space_guids: space_guids).first(guid: guid)
       end
 
       private
diff --git a/app/models/services/service_credential_binding_view.rb b/app/models/services/service_credential_binding_view.rb
@@ -10,7 +10,17 @@ module Types
         Sequel.as(:service_keys__guid, :guid),
         Sequel.as(Types::SERVICE_KEY, :type),
         Sequel.as(:spaces__guid, :space_guid),
-        Sequel.as(:service_keys__created_at, :created_at)
+        Sequel.as(:service_keys__created_at, :created_at),
+        Sequel.as(:service_keys__updated_at, :updated_at),
+        Sequel.as(:service_keys__name, :name),
+        Sequel.as(:service_instances__guid, :service_instance_guid),
+        Sequel.as(nil, :app_guid),
+        Sequel.as(nil, :last_operation_state),
+        Sequel.as(nil, :last_operation_description),
+        Sequel.as(nil, :last_operation_created_at),
+        Sequel.as(nil, :last_operation_updated_at),
+        Sequel.as(nil, :last_operation_type),
+        Sequel.as(nil, :last_operation_id)
       ).join(
         :service_instances, id: Sequel[:service_keys][:service_instance_id]
       ).join(
@@ -21,11 +31,23 @@ module Types
         Sequel.as(:service_bindings__guid, :guid),
         Sequel.as(Types::SERVICE_BINDING, :type),
         Sequel.as(:spaces__guid, :space_guid),
-        Sequel.as(:service_bindings__created_at, :created_at)
+        Sequel.as(:service_bindings__created_at, :created_at),
+        Sequel.as(:service_bindings__updated_at, :updated_at),
+        Sequel.as(:service_bindings__name, :name),
+        Sequel.as(:service_bindings__service_instance_guid, :service_instance_guid),
+        Sequel.as(:service_bindings__app_guid, :app_guid),
+        Sequel.as(:service_binding_operations__state, :last_operation_state),
+        Sequel.as(:service_binding_operations__description, :last_operation_description),
+        Sequel.as(:service_binding_operations__created_at, :last_operation_created_at),
+        Sequel.as(:service_binding_operations__updated_at, :last_operation_updated_at),
+        Sequel.as(:service_binding_operations__type, :last_operation_type),
+        Sequel.as(:service_binding_operations__id, :last_operation_id)
       ).join(
         :apps, guid: Sequel[:service_bindings][:app_guid]
       ).join(
         :spaces, guid: Sequel[:apps][:space_guid]
+      ).left_join(
+        :service_binding_operations, service_binding_id: Sequel[:service_bindings][:id]
       ).freeze
 
       VIEW = [
diff --git a/app/presenters/v3/base_presenter.rb b/app/presenters/v3/base_presenter.rb
@@ -1,4 +1,5 @@
 require 'presenters/helpers/censorship'
+require 'presenters/api_url_builder'
 
 module VCAP
   module CloudController
diff --git a/app/presenters/v3/service_credential_binding_presenter.rb b/app/presenters/v3/service_credential_binding_presenter.rb
@@ -8,9 +8,64 @@ class ServiceCredentialBindingPresenter < BasePresenter
           def to_hash
             {
               guid: @resource.guid,
-              type: @resource.type
+              type: @resource.type,
+              name: @resource.name,
+              created_at: @resource.created_at,
+              updated_at: @resource.updated_at,
+              last_operation: last_operation,
+              relationships: build_relationships,
+              links: build_links
             }
           end
+
+          private
+
+          def build_relationships
+            base_relationships.merge(app_relationship)
+          end
+
+          def build_links
+            base_links.merge(app_link)
+          end
+
+          def last_operation
+            return nil if @resource.last_operation_id.blank?
+
+            {
+              type: @resource.last_operation_type,
+              state: @resource.last_operation_state,
+              description: @resource.last_operation_description,
+              created_at: @resource.last_operation_created_at,
+              updated_at: @resource.last_operation_updated_at
+            }
+          end
+
+          def base_links
+            {
+              self: { href: url_builder.build_url(path: "/v3/service_credential_bindings/#{@resource.guid}") },
+              service_instance: {
+                href: url_builder.build_url(path: "/v3/service_instances/#{@resource.service_instance_guid}")
+              }
+            }
+          end
+
+          def base_relationships
+            {
+              service_instance: { data: { guid: @resource.service_instance_guid } }
+            }
+          end
+
+          def app_relationship
+            return {} if @resource.app_guid.blank?
+
+            { app: { data: { guid: @resource.app_guid } } }
+          end
+
+          def app_link
+            return {} if @resource.app_guid.blank?
+
+            { app: { href: url_builder.build_url(path: "/v3/apps/#{@resource.app_guid}") } }
+          end
         end
       end
     end
diff --git a/docs/v3/source/includes/api_resources/_service_credential_bindings.erb b/docs/v3/source/includes/api_resources/_service_credential_bindings.erb
@@ -1,19 +1,61 @@
 <% content_for :single_service_credential_binding_app do %>
 {
-  "guid": "ddd7fb26-c42d-4acf-a035-60fdd094a167",
-  "type": "app"
+  "guid": "dde5ad2a-d8f4-44dc-a56f-0452d744f1c3",
+  "type": "app",
+  "created_at": "2015-11-13T17:02:56Z",
+  "updated_at": "2016-06-08T16:41:26Z",
+  "relationships": {
+    "app": {
+      "data": {
+        "guid": "74f7c078-0934-470f-9883-4fddss5b8f13"
+      }
+    },
+    "service_instances": {
+      "data": {
+        "guid": "8bfe4c1b-9e18-45b1-83be-124163f31f9e"
+      }
+    }
+  },
+  "links": {
+    "self": {
+      "href": "https://api.example.org/v3/service_bindings/dde5ad2a-d8f4-44dc-a56f-0452d744f1c3"
+    },
+    "service_instance": {
+      "href": "https://api.example.org/v3/service_instances/8bfe4c1b-9e18-45b1-83be-124163f31f9e"
+    },
+    "app": {
+      "href": "https://api.example.org/v3/apps/74f7c078-0934-470f-9883-4fddss5b8f13"
+    }
+  }
 }
 <% end %>
 
 <% content_for :single_service_credential_binding_key do %>
 {
-  "guid": "ddd7fb26-c42d-4acf-a035-60fdd094a167",
-  "type": "key"
+  "guid": "dde5ad2a-d8f4-44dc-a56f-0452d744f1c3",
+  "type": "key",
+  "created_at": "2015-11-13T17:02:56Z",
+  "updated_at": "2016-06-08T16:41:26Z",
+  "relationships": {
+    "service_instances": {
+      "data": {
+        "guid": "8bfe4c1b-9e18-45b1-83be-124163f31f9e"
+      }
+    }
+  },
+  "links": {
+    "self": {
+      "href": "https://api.example.org/v3/service_bindings/dde5ad2a-d8f4-44dc-a56f-0452d744f1c3"
+    },
+    "service_instance": {
+      "href": "https://api.example.org/v3/service_instances/8bfe4c1b-9e18-45b1-83be-124163f31f9e"
+    }
+  }
 }
 <% end %>
 
 <% content_for :paginated_list_of_service_credential_bindings do |base_url| %>
-  {
+{
   "pagination": {
     "total_results": 3,
     "total_pages": 2,
@@ -31,11 +73,61 @@
   "resources": [
     {
       "guid": "dde5ad2a-d8f4-44dc-a56f-0452d744f1c3",
-      "type": "app"
+      "type": "app",
+      "created_at": "2015-11-13T17:02:56Z",
+      "updated_at": "2016-06-08T16:41:26Z",
+      "last_operation": {
+        "type": "create",
+        "state": "succeeded",
+        "created_at": "2015-11-13T17:02:56Z",
+        "created_at": "2015-11-13T17:02:56Z",
+        "updated_at": "2015-11-13T17:02:56Z"
+      },
+      "relationships": {
+        "app": {
+          "data": {
+            "guid": "74f7c078-0934-470f-9883-4fddss5b8f13"
+          }
+        },
+        "service_instances": {
+          "data": {
+            "guid": "8bfe4c1b-9e18-45b1-83be-124163f31f9e"
+          }
+        }
+      },
+      "links": {
+        "self": {
+          "href": "https://api.example.org/v3/service_bindings/dde5ad2a-d8f4-44dc-a56f-0452d744f1c3"
+        },
+        "service_instance": {
+          "href": "https://api.example.org/v3/service_instances/8bfe4c1b-9e18-45b1-83be-124163f31f9e"
+        },
+        "app": {
+          "href": "https://api.example.org/v3/apps/74f7c078-0934-470f-9883-4fddss5b8f13"
+        }
+      }
     },
     {
       "guid": "7aa37bad-6ccb-4ef9-ba48-9ce3a91b2b62",
-      "type": "key"
+      "type": "key",
+      "created_at": "2015-11-13T17:02:56Z",
+      "updated_at": "2016-06-08T16:41:26Z",
+      "last_operation": null,
+      "relationships": {
+        "service_instances": {
+          "data": {
+            "guid": "8bfe4c1b-9e18-45b1-83be-124163f31f9e"
+          }
+        }
+      },
+      "links": {
+        "self": {
+          "href": "https://api.example.org/v3/service_bindings/7aa37bad-6ccb-4ef9-ba48-9ce3a91b2b62"
+        },
+        "service_instance": {
+          "href": "https://api.example.org/v3/service_instances/8bf356j3-9e18-45b1-3333-124163f31f9e"
+        }
+      }
     }
   ]
 }
diff --git a/spec/request/service_credential_bindings_spec.rb b/spec/request/service_credential_bindings_spec.rb
@@ -74,7 +74,7 @@
     let(:key) { VCAP::CloudController::ServiceKey.make(service_instance: instance) }
     let(:instance) { VCAP::CloudController::ManagedServiceInstance.make(space: space) }
     let(:api_call) { ->(user_headers) { get "/v3/service_credential_bindings/#{key.guid}", nil, user_headers } }
-    let(:expected_object) { { guid: key.guid, type: 'key' } }
+    let(:expected_object) { expected_json(key) }
 
     context 'global roles' do
       let(:expected_codes_and_responses) do
@@ -117,10 +117,18 @@
 
   describe 'GET /v3/service_credential_bindings/:app_guid' do
     let(:app_to_bind_to) { VCAP::CloudController::AppModel.make(space: space) }
-    let(:app_binding) { VCAP::CloudController::ServiceBinding.make(service_instance: instance, app: app_to_bind_to) }
+    let(:app_binding) {
+      b = VCAP::CloudController::ServiceBinding.make(service_instance: instance, app: app_to_bind_to)
+      b.save_with_new_operation({
+        type: 'create',
+        state: 'succeeded',
+        description: 'some description'
+      })
+      b
+    }
     let(:instance) { VCAP::CloudController::ManagedServiceInstance.make(space: space) }
     let(:api_call) { ->(user_headers) { get "/v3/service_credential_bindings/#{app_binding.guid}", nil, user_headers } }
-    let(:expected_object) { { guid: app_binding.guid, type: 'app' } }
+    let(:expected_object) { expected_json(app_binding) }
 
     context 'global roles' do
       let(:expected_codes_and_responses) do
@@ -169,19 +177,60 @@
 
   def expected_json(binding)
     {
-      guid: binding.guid
-    }.merge(extra(binding))
+      guid: binding.guid,
+      created_at: iso8601,
+      updated_at: iso8601,
+      name: binding.name,
+      last_operation: nil,
+      relationships: {
+        service_instance: {
+          data: {
+            guid: binding.service_instance.guid
+          }
+        }
+      },
+      links: {
+        self: {
+          href: "#{link_prefix}/v3/service_credential_bindings/#{binding.guid}"
+        },
+        service_instance: {
+          href: "#{link_prefix}/v3/service_instances/#{binding.service_instance.guid}"
+        }
+      }
+    }.deep_merge(extra(binding))
   end
 
   def extra(binding)
     case binding
     when VCAP::CloudController::ServiceKey
       {
-        type: 'key'
+        type: 'key',
       }
     when VCAP::CloudController::ServiceBinding
+      if binding.last_operation.present?
+        last_operation = {
+                            type: binding.last_operation.type,
+                            state: binding.last_operation.state,
+                            description: binding.last_operation.description,
+                            created_at: iso8601,
+                            updated_at: iso8601
+                         }
+      end
       {
-        type: 'app'
+        type: 'app',
+        last_operation: last_operation,
+        relationships: {
+          app: {
+            data: {
+              guid: binding.app.guid
+            }
+          }
+        },
+        links: {
+          app: {
+            href: "#{link_prefix}/v3/apps/#{binding.app.guid}"
+          }
+        }
       }
     else
       raise 'not a binding'
diff --git a/spec/unit/fetchers/service_credential_binding_fetcher_spec.rb b/spec/unit/fetchers/service_credential_binding_fetcher_spec.rb
diff --git a/spec/unit/presenters/v3/service_credential_binding_presenter_spec.rb b/spec/unit/presenters/v3/service_credential_binding_presenter_spec.rb

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`require 'presenters/helpers/censorship'`
	`2`	`+require 'presenters/api_url_builder'`
`2`	`3`
`3`	`4`	`module VCAP`
`4`	`5`	`module CloudController`