feat(enmeshed): support nmshd::Connector API version 3.1.0

Main changes:
- Relationship: Adapt parsing of the userdata to new schema
  Values to the requested attributes are now passed in `creationContent/response/items`
  (former: `changes/request/response/items`).
- Connector: Adapt accepting/rejecting a Relationship to new endpoints
  `/api/v2/Relationships/#{relationship_id}/Changes/#{change_id}/#{action}` was dropped
  in favor of `/api/v2/Relationships/#{relationship_id}/Accept` (and `Reject`)

Part of XI-6523

Author: nenock

lib/enmeshed/api_schema.yml

@@ -36,6 +36,17 @@ def to_h
       default_attributes.deep_merge(additional_attributes)
     end
 
+    def to_json(*)
+      {
+        content: {
+          value: {
+            '@type': @type,
+            value: @value,
+          },
+        },
+      }.to_json(*)
+    end
+
     def id
       @id ||= persistent_id
     end

lib/enmeshed/attribute.rb

@@ -20,7 +20,7 @@ def enmeshed_address
       # @return [String] The ID of the created attribute.
       def create_attribute(attribute)
         response = connection.post('/api/v2/Attributes') do |request|
-          request.body = {content: attribute.to_h}.to_json
+          request.body = attribute.to_json
         end
         parse_result(response, Attribute).id
       end
@@ -67,14 +67,21 @@ def pending_relationships
         parse_result(response, Relationship)
       end
 
-      # @return [Boolean] Whether the relationship change was changed (accepted or rejected) successfully.
-      def respond_to_rel_change(relationship_id, change_id, action = 'Accept')
-        response =
-          connection.put("/api/v2/Relationships/#{relationship_id}/Changes/#{change_id}/#{action}") do |request|
-            request.body = {content: {}}.to_json
-          end
+      # @return [Boolean] Whether the relationship was accepted successfully.
+      def accept_relationship(relationship_id)
+        response = connection.put("/api/v2/Relationships/#{relationship_id}/Accept")
         Rails.logger.debug do
-          "Enmeshed::ConnectorApi responded to RelationshipChange with: #{action}; " \
+          "Enmeshed::ConnectorApi accepted the relationship; connector response status is #{response.status}"
+        end
+
+        response.status == 200
+      end
+
+      # @return [Boolean] Whether the relationship was rejected successfully.
+      def reject_relationship(relationship_id)
+        response = connection.put("/api/v2/Relationships/#{relationship_id}/Reject")
+        Rails.logger.debug do
+          'Enmeshed::ConnectorApi rejected the relationship; ' \
             "connector response status is #{response.status}"
         end
 

lib/enmeshed/connector.rb

@@ -18,8 +18,14 @@ def schema
       end
 
       def validate!(instance)
-        raise ConnectorError.new("Invalid #{klass} schema") unless schema.valid?(instance)
+        unless schema.valid?(instance)
+          error = schema.validate(instance).first.fetch('error')
+          Rails.logger.debug(error)
+          raise ConnectorError.new("Invalid #{klass} schema: #{error}") unless KNOWN_API_ISSUES.include? error
+        end
       end
+
+      KNOWN_API_ISSUES = ['value at `/auditLog/0/createdBy` does not match format: date-time'].freeze
     end
   end
 end

lib/enmeshed/object.rb

@@ -5,12 +5,12 @@ class Relationship < Object
     STATUS_GROUP_SYNONYMS = YAML.safe_load_file(Rails.root.join('lib/enmeshed/status_group_synonyms.yml'))
 
     delegate :expires_at, :nbp_uid, :truncated_reference, to: :@template
-    attr_reader :relationship_changes
+    attr_reader :response_items
 
-    def initialize(json:, template:, changes: [])
+    def initialize(json:, template:, response_items: [])
       @json = json
       @template = template
-      @relationship_changes = changes
+      @response_items = response_items
     end
 
     def peer
@@ -37,25 +37,19 @@ def id
     end
 
     def accept!
-      if relationship_changes.size != 1
-        raise ConnectorError.new('Relationship should have exactly one RelationshipChange')
-      end
-
       Rails.logger.debug do
         "Enmeshed::ConnectorApi accepting Relationship for template #{truncated_reference}"
       end
 
-      Connector.respond_to_rel_change(id, relationship_changes.first[:id], 'Accept')
+      Connector.accept_relationship(id)
     end
 
     def reject!
       Rails.logger.debug do
         "Enmeshed::ConnectorApi rejecting Relationship for template #{truncated_reference}"
       end
 
-      @json[:changes].each do |change|
-        Connector.respond_to_rel_change(id, change[:id], 'Reject')
-      end
+      Connector.reject_relationship(id)
     end
 
     class << self
@@ -64,7 +58,7 @@ def parse(content)
         attributes = {
           json: content,
           template: RelationshipTemplate.parse(content[:template]),
-          changes: content[:changes],
+          response_items: content[:creationContent][:response][:items],
         }
         new(**attributes)
       end
@@ -80,17 +74,10 @@ def pending_for(nbp_uid)
     private
 
     def parse_userdata # rubocop:disable Metrics/AbcSize
-      # Since the RelationshipTemplate has a `maxNumberOfAllocations` attribute set to 1,
-      # you cannot request multiple Relationships with the same template.
-      # Further, RelationshipChanges should not be possible before accepting the Relationship.
-      if relationship_changes.size != 1
-        raise ConnectorError.new('Relationship should have exactly one RelationshipChange')
+      user_provided_attributes = response_items.select do |item|
+        item[:@type] == 'ReadAttributeAcceptResponseItem'
       end
 
-      change_response_items = relationship_changes.first.dig(:request, :content, :response, :items)
-
-      user_provided_attributes = change_response_items.select {|item| item[:@type] == 'ReadAttributeAcceptResponseItem' }
-
       enmeshed_user_attributes = {}
 
       user_provided_attributes.each do |item|
@@ -109,7 +96,7 @@ def parse_userdata # rubocop:disable Metrics/AbcSize
         status_group: parse_status_group(enmeshed_user_attributes['AffiliationRole'].downcase),
       }
     rescue NoMethodError
-      raise ConnectorError.new("Could not parse userdata in relationship change: #{relationship_changes.first}")
+      raise ConnectorError.new("Could not parse userdata in the response items: #{response_items}")
     end
 
     def check_for_required_attributes!(enmeshed_user_attributes)

lib/enmeshed/relationship.rb

@@ -3,7 +3,7 @@
     "id": "ATT_id_of_a_new_name",
     "content": {
       "@type": "IdentityAttribute",
-      "owner": "id1JttmYYvjT6wojkJ9rpaFkMUKHAWKr9RDf",
+      "owner": "did:e:example.com:dids:checksum______________",
       "value": {
         "@type": "DisplayName",
         "value": "CodeHarbor"

spec/fixtures/files/enmeshed/display_name_created.json

@@ -4,7 +4,7 @@
       "id": "ATT_id_of_other_name",
       "content": {
         "@type": "IdentityAttribute",
-        "owner": "id1GyHw8CefvC62VGQ5oTZjT3PvbveyDsrW2",
+        "owner": "did:e:example.com:dids:checksum______________",
         "value": {
           "@type": "DisplayName",
           "value": "Some other display name"
@@ -16,7 +16,7 @@
       "id": "ATT_id_of_exist_name",
       "content": {
         "@type": "IdentityAttribute",
-        "owner": "id1GyHw8CefvC62VGQ5oTZjT3PvbveyDsrW2",
+        "owner": "did:e:example.com:dids:checksum______________",
         "value": {
           "@type": "DisplayName",
           "value": "CodeHarbor"

spec/fixtures/files/enmeshed/existing_display_name.json

@@ -1,6 +1,6 @@
 {
   "result": {
-    "address": "id_of_an_example_enmeshed_address_AB",
+    "address": "did:e:example.com:dids:checksum______________",
     "publicKey": "eyJwdWIiOiJZV2xVNDV1aEJsZmREa05iQ3RMSnhZaW1zckRGTlBXVHFfcjdLZUlYemN3IiwiYWxnIjozfQ"
   }
 }