oydid 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 072b6ccce2a1b7bf3c607aa01d3a3c97cfd37f8e41d52bb9db529d539ccb6eda
-  data.tar.gz: 75ccf1a0357d60e629dac7ea3a046cfe0933693a04b5179bf0db7b54929abc6b
+  metadata.gz: b941c83aec6492dfb37d272fd83a77f1b036902b70aab64634fed657d1ccaf6a
+  data.tar.gz: 0ba0f288c5c30e2cd7d7d831bd072ef0c4924082d70fba44634e1412578a8dc7
 SHA512:
-  metadata.gz: c936a18cf7106ae73e76fb30fc5ee789a50330a342dfa9624f29bd03574cde42b9c8a4b6a710e0f7e3ed9c6865fb8ec49aaac2cf7cd24c5d5330405e4f20cd81
-  data.tar.gz: 3d6c15c81d795cd470f75031722f211aac478dc239a1ece245a64e1b00144d7d37eadfe3c5db8dab4ebfd487e685011f50615f5c40d05ea502d59762cbb51a1f
+  metadata.gz: ddc6020c44371fee58f2e527513e4d94974ee5d4a3ebabd22a01b5cc039f5c91cfe1a0ab0f4046c50a356ab0784db6a626c971c5ee18e10b076e03625250605e
+  data.tar.gz: eaba43282881c1239cde7af7733707d5beff7670b27388327926b4e7a5c739e9c221c1f9b70565a629adb3e7b4ee43dd3ebb3cb977bf6b2dd885ff6f55a34e93

data/VERSION

@@ -1 +1 @@
-0.9.2
+0.9.3

data/lib/oydid/basic.rb

@@ -1248,6 +1248,30 @@ class Oydid
         end
     end
 
+    # Marks a failure of the queried repository itself (HTTP 5xx) as opposed to
+    # a DID that is simply not stored there. Without the distinction a caller
+    # turns a broken upstream into "not found", which claims the identifier
+    # never existed - see upstream_error?.
+    UPSTREAM_ERROR_PREFIX = "upstream error"
+
+    def self.upstream_error?(message)
+        message.to_s.start_with?(UPSTREAM_ERROR_PREFIX)
+    end
+
+    # Failure message for a non-200 response: the repository's own error field
+    # when it sent one, otherwise a message naming status and URL. A 5xx gets
+    # the prefix above so callers can tell it apart from a missing DID.
+    def self.http_error_message(response, url)
+        msg = (response.parsed_response["error"].to_s rescue "")
+        return msg unless msg.to_s == ""
+        code = response.code.to_i rescue 0
+        if code >= 500
+            UPSTREAM_ERROR_PREFIX + " " + code.to_s + " from " + url.to_s
+        else
+            "invalid response from " + url.to_s
+        end
+    end
+
     def self.retrieve_document(doc_identifier, doc_file, doc_location, options)
         # in-process callers can supply the DID document directly (e.g. read from
         # a local database) to avoid any HTTP/file lookup
@@ -1271,11 +1295,7 @@ class Oydid
             end
             retVal = HTTParty.get(doc_location + "/doc/" + doc_identifier + option_str)
             if retVal.code != 200
-                msg = retVal.parsed_response["error"].to_s rescue ""
-                if msg.to_s == ""
-                    msg = "invalid response from " + doc_location.to_s + "/doc/" + doc_identifier.to_s
-                end
-                return [nil, msg]
+                return [nil, http_error_message(retVal, doc_location.to_s + "/doc/" + doc_identifier.to_s)]
             end
             if options.transform_keys(&:to_s)["trace"]
                 if options[:silent].nil? || !options[:silent]
@@ -1324,8 +1344,7 @@ class Oydid
             doc_location = doc_location.sub("%3A%2F%2F","://").sub("%3A", ":")
             retVal = HTTParty.get(doc_location + "/doc_raw/" + doc_hash)
             if retVal.code != 200
-                msg = retVal.parsed_response("error").to_s rescue "invalid response from " + doc_location.to_s + "/doc/" + doc_hash.to_s
-                return [nil, msg]
+                return [nil, http_error_message(retVal, doc_location.to_s + "/doc_raw/" + doc_hash.to_s)]
             end
             if options.transform_keys(&:to_s)["trace"]
                 if options[:silent].nil? || !options[:silent]

data/lib/oydid/log.rb

@@ -44,10 +44,7 @@ class Oydid
             log_location = log_location.gsub("%2F%2F","//")
             retVal = HTTParty.get(log_location + "/log/" + did_hash)
             if retVal.code != 200
-                msg = retVal.parsed_response("error").to_s rescue 
-                        "invalid response from " + log_location.to_s + "/log/" + did_hash.to_s
-
-                return [nil, msg]
+                return [nil, http_error_message(retVal, log_location.to_s + "/log/" + did_hash.to_s)]
             end
             if options.transform_keys(&:to_s)["trace"]
                 if options[:silent].nil? || !options[:silent]
@@ -79,9 +76,7 @@ class Oydid
             log_location = log_location.gsub("%2F%2F","//")
             retVal = HTTParty.get(log_location + "/log/" + log_hash + "/item")
             if retVal.code != 200
-                msg = retVal.parsed_response("error").to_s rescue 
-                        "invalid response from " + log_location.to_s + "/log/" + log_hash.to_s + "/item"
-                return [nil, msg]
+                return [nil, http_error_message(retVal, log_location.to_s + "/log/" + log_hash.to_s + "/item")]
             end
             if options.transform_keys(&:to_s)["trace"]
                 if options[:silent].nil? || !options[:silent]
@@ -558,9 +553,22 @@ class Oydid
                 # handle DID Rotation
                 if (i == (currentDID["log"].length-1))
                     if options[:followAlsoKnownAs]
+                        # the payload of a DID Document is arbitrary JSON: an
+                        # Array or a scalar is valid and simply carries no
+                        # alsoKnownAs, so only a Hash can be inspected for it.
+                        # Without this guard a revoked DID whose document holds
+                        # e.g. [5] raised NoMethodError here, the repository
+                        # answered 500 with an empty body, and the resolver
+                        # degraded that to "not found" instead of "deactivated".
                         current_doc = currentDID["doc"]
-                        if current_doc["doc"].transform_keys(&:to_s).has_key?("alsoKnownAs")
-                            rotate_DID = current_doc["doc"].transform_keys(&:to_s)["alsoKnownAs"]
+                        doc_payload = current_doc.is_a?(Hash) ? current_doc["doc"] : nil
+                        doc_payload = doc_payload.transform_keys(&:to_s) if doc_payload.is_a?(Hash)
+                        if doc_payload.is_a?(Hash) && doc_payload.has_key?("alsoKnownAs")
+                            # DID Core defines alsoKnownAs as a set; older
+                            # documents wrote a bare String
+                            rotate_DID = doc_payload["alsoKnownAs"]
+                            rotate_DID = rotate_DID.first if rotate_DID.is_a?(Array)
+                            rotate_DID = rotate_DID.to_s
                             if rotate_DID.start_with?("did:")
                                 rotate_DID_method = rotate_DID.split(":").take(2).join(":")
                                 did_orig = currentDID["did"]
@@ -586,8 +594,14 @@ class Oydid
                                         currentDID["verification"] += "(Details: https://ownyourdata.github.io/oydid/#did_rotation)" + "\n\n"
                                     end
                                 when "did:oyd"
-                                    puts "try to resolve did:oyd with our own resolver"
-                                    puts "add verification text"
+                                    # DID Rotation to another did:oyd identifier
+                                    # is not implemented yet: resolving it needs
+                                    # a second pass through this resolver.
+                                    if verification_output
+                                        currentDID["verification"] += "DID rotation to: " + rotate_DID.to_s + "\n"
+                                        currentDID["verification"] += "⚠️ rotation to another did:oyd identifier is not supported yet\n"
+                                        currentDID["verification"] += "(Details: https://ownyourdata.github.io/oydid/#did_rotation)" + "\n\n"
+                                    end
                                 else
                                     # do nothing: DID Rotation is not supported for this DID method yet
                                 end

data/spec/oydid_spec.rb

@@ -519,6 +519,65 @@ describe "OYDID handling" do
   #   end
   # end
 
+  # regression: the payload of a DID Document is arbitrary JSON, not
+  # necessarily an object. A revoked DID whose payload is an Array used to
+  # raise NoMethodError in the alsoKnownAs lookup - the repository then
+  # answered 500 with an empty body and the resolver reported "not found"
+  # instead of "deactivated".
+  describe "dag_update with a non-object DID Document payload" do
+    def revoked_state(payload)
+      { "did" => "did:oyd:zQmPyjnkL52gQxBBhPuCFkf167MzpCKquqbu5Qt5ia2JGTr",
+        "doc" => { "doc" => payload, "key" => "", "log" => "" },
+        "log" => [{ "ts" => 1647732475, "op" => 1, "doc" => "zQmcVLwEtzU8By7TTeRFGvVUKm7HhZS6GgRTDFt51QNnans",
+                    "sig" => "", "previous" => [] }] }
+    end
+
+    it "does not raise for an Array payload" do
+      expect {
+        Oydid.dag_update(revoked_state([5]), { followAlsoKnownAs: true })
+      }.not_to raise_error
+    end
+
+    it "does not raise for a scalar payload" do
+      expect {
+        Oydid.dag_update(revoked_state("plain"), { followAlsoKnownAs: true })
+      }.not_to raise_error
+    end
+
+    it "accepts alsoKnownAs written as a set" do
+      state = revoked_state({ "alsoKnownAs" => ["did:oyd:zQmaBZTghndXTgxNwfbdpVLWdFf6faYE4oeuN2zzXdQt1kh"] })
+      expect {
+        Oydid.dag_update(state, { followAlsoKnownAs: true })
+      }.not_to raise_error
+    end
+  end
+
+  # a broken repository (5xx) has to stay distinguishable from a DID that is
+  # not stored there - otherwise the caller reports "not found" and thereby
+  # claims the identifier never existed
+  describe "failure messages for non-200 responses" do
+    it "marks a 5xx as an upstream error" do
+      reply = double(code: 500, parsed_response: "")
+      msg = Oydid.http_error_message(reply, "https://oydid.ownyourdata.eu/doc/zQmXY")
+      expect(Oydid.upstream_error?(msg)).to be true
+      expect(msg).to include("500")
+    end
+
+    it "passes the repository's own error through" do
+      reply = double(code: 410, parsed_response: { "error" => "revoked" })
+      msg = Oydid.http_error_message(reply, "https://oydid.ownyourdata.eu/doc/zQmXY")
+      expect(msg).to eq "revoked"
+      expect(Oydid.upstream_error?(msg)).to be false
+    end
+
+    it "does not mark a 4xx without an error field as upstream error" do
+      reply = double(code: 404, parsed_response: nil)
+      msg = Oydid.http_error_message(reply, "https://oydid.ownyourdata.eu/doc/zQmXY")
+      expect(msg).to start_with("invalid response from")
+      expect(Oydid.upstream_error?(msg)).to be false
+    end
+  end
+
   # main functionds
   Dir.glob(File.expand_path("../input/main/*_read.doc", __FILE__)).each do |input|
     it "execute read for #{input.split('/').last}" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: oydid
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Christoph Fabianek
 bindir: bin
 cert_chain: []
-date: 2026-08-28 00:00:00.000000000 Z
+date: 2026-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_dag