didkit 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d974c618ebe4702ec35b8f4e1465b3cc0664d1cf932fd8739ac4371f7c20caa2
-  data.tar.gz: 66479727000f96ef26d09074bd97cd59d43f14388ea213f25deb846c6e75cb3d
+  metadata.gz: 76dd4f3787cf1cc288015511eb35ea6d41ef4c390f85ca67854617fe7c46d710
+  data.tar.gz: 40ea426b53fa3176dccd4c538cbd40050a3883bb6632af2b45ca1a6f49ac84b7
 SHA512:
-  metadata.gz: b3b84e04e7be85c0af2a544173a14338870fc3163727dd9341a1c76d83ce6397c03f4f28284549c5c07c2c3625e018b81c7a4149c80dac8e817f01f7b724c042
-  data.tar.gz: e476000c6bbc05a3e5664e2fb44a8bb19e302c2b13d880bfc9d98a2144916b7982d914d41beea55e5775f55a1a3d01a9bd0854ff4cfa9274d86aba4a406441e1
+  metadata.gz: a26c81e89e2397bb7690149e143a0de6c9e9635a993e8cd13d572d76b21b38ce37628eb3c3ebc4ea9ffc20b3807f619acb46612a76af9f816b336315a10f7aab
+  data.tar.gz: 89b4d9eb1ec2b7f5207587cde9b0a2b2db8a5912a92dc1ef996f0bac493996aae8b1340fc673838c404ac28d4ab191be6e7ce3a984f35a83402b9ef489feea8b

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.0.4] - 2024-03-07
+
+- extracted resolving code from `DID` to a new `Resolver` class (`DID` has helper methods to call the resolver)
+- added `Resolver#get_validated_handle` method to validate handles from the `Document` (+ helpers in `DID` in `Document`)
+- added timeout to `#resolve_handle_by_well_known`
+
 ## [0.0.3] - 2024-03-06
 
 - added `Document#handles` with handle info extracted from `alsoKnownAs` field

data/lib/didkit/did.rb

@@ -1,54 +1,10 @@
-require 'json'
-require 'net/http'
-require 'open-uri'
-require 'resolv'
-
-require_relative 'document'
 require_relative 'errors'
+require_relative 'resolver'
 
 module DIDKit
   class DID
     def self.resolve_handle(handle)
-      domain = handle.gsub(/^@/, '')
-
-      if dns_did = resolve_handle_by_dns(domain)
-        DID.new(dns_did, :dns)
-      elsif http_did = resolve_handle_by_well_known(domain)
-        DID.new(http_did, :http)
-      else
-        nil
-      end
-    end
-
-    def self.resolve_handle_by_dns(domain)
-      dns_records = Resolv::DNS.open { |d| d.getresources("_atproto.#{domain}", Resolv::DNS::Resource::IN::TXT) }
-
-      if record = dns_records.first
-        if string = record.strings.first
-          if string =~ /^did\=(did\:\w+\:.*)$/
-            return $1
-          end
-        end
-      end
-
-      nil
-    end
-
-    def self.resolve_handle_by_well_known(domain)
-      url = URI("https://#{domain}/.well-known/atproto-did")
-      response = Net::HTTP.get_response(url)
-
-      if response.is_a?(Net::HTTPSuccess)
-        if text = response.body
-          if text.lines.length == 1 && text.start_with?('did:')
-            return text
-          end
-        end
-      end
-
-      nil
-    rescue StandardError => e
-      nil
+      Resolver.new.resolve_handle(handle)
     end
 
     attr_reader :type, :did, :resolved_by
@@ -71,23 +27,25 @@ module DIDKit
     alias to_s did
 
     def get_document
-      type == :plc ? resolve_did_plc : resolve_did_web
+      Resolver.new.resolve_did(self)
     end
 
-    def web_domain
-      did.gsub(/^did\:web\:/, '') if type == :web
+    def get_validated_handle
+      Resolver.new.get_validated_handle(self)
     end
 
-    def resolve_did_plc
-      url = "https://plc.directory/#{did}"
-      json = JSON.parse(URI.open(url).read)
-      Document.new(self, json)
+    def web_domain
+      did.gsub(/^did\:web\:/, '') if type == :web
     end
 
-    def resolve_did_web
-      url = "https://#{web_domain}/.well-known/did.json"
-      json = JSON.parse(URI.open(url).read)
-      Document.new(self, json)
+    def ==(other)
+      if other.is_a?(String)
+        self.did == other
+      elsif other.is_a?(DID)
+        self.did == other.did
+      else
+        false
+      end
     end
   end
 end

data/lib/didkit/document.rb

@@ -8,7 +8,7 @@ module DIDKit
     def initialize(did, json)
       raise FormatError, "Missing id field" if json['id'].nil?
       raise FormatError, "Invalid id field" unless json['id'].is_a?(String)
-      raise FormatError, "Id field doesn't match expected DID" unless json['id'] == did.to_s
+      raise FormatError, "id field doesn't match expected DID" unless json['id'] == did.to_s
 
       @did = did
       @json = json
@@ -37,5 +37,9 @@ module DIDKit
         @handles = []
       end
     end
+
+    def get_validated_handle
+      Resolver.new.get_validated_handle(self)
+    end
   end
 end

data/lib/didkit/resolver.rb

@@ -0,0 +1,82 @@
+require 'json'
+require 'open-uri'
+require 'net/http'
+require 'resolv'
+
+require_relative 'did'
+require_relative 'document'
+
+module DIDKit
+  class Resolver
+    def resolve_handle(handle)
+      domain = handle.gsub(/^@/, '')
+
+      if dns_did = resolve_handle_by_dns(domain)
+        DID.new(dns_did, :dns)
+      elsif http_did = resolve_handle_by_well_known(domain)
+        DID.new(http_did, :http)
+      else
+        nil
+      end
+    end
+
+    def resolve_handle_by_dns(domain)
+      dns_records = Resolv::DNS.open { |d| d.getresources("_atproto.#{domain}", Resolv::DNS::Resource::IN::TXT) }
+
+      if record = dns_records.first
+        if string = record.strings.first
+          if string =~ /^did\=(did\:\w+\:.*)$/
+            return $1
+          end
+        end
+      end
+
+      nil
+    end
+
+    def resolve_handle_by_well_known(domain)
+      url = URI("https://#{domain}/.well-known/atproto-did")
+
+      response = Net::HTTP.start(url.host, url.port, use_ssl: true, open_timeout: 10, read_timeout: 10) do |http|
+        request = Net::HTTP::Get.new(url)
+        http.request(request)
+      end
+
+      if response.is_a?(Net::HTTPSuccess)
+        if text = response.body
+          if text.lines.length == 1 && text.start_with?('did:')
+            return text
+          end
+        end
+      end
+
+      nil
+    rescue StandardError => e
+      nil
+    end
+
+    def resolve_did(did)
+      did = DID.new(did) if did.is_a?(String)
+
+      did.type == :plc ? resolve_did_plc(did) : resolve_did_web(did)
+    end
+
+    def resolve_did_plc(did)
+      url = "https://plc.directory/#{did}"
+      json = JSON.parse(URI.open(url).read)
+      Document.new(did, json)
+    end
+
+    def resolve_did_web(did)
+      url = "https://#{did.web_domain}/.well-known/did.json"
+      json = JSON.parse(URI.open(url).read)
+      Document.new(did, json)
+    end
+
+    def get_validated_handle(did_or_doc)
+      document = did_or_doc.is_a?(Document) ? did_or_doc : resolve_did(did_or_doc)
+
+      document.handles.detect { |h| resolve_handle(h) == document.did }
+    end
+  end
+end

data/lib/didkit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DIDKit
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: didkit
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Kuba Suder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-06 00:00:00.000000000 Z
+date: 2024-03-07 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -24,6 +24,7 @@ files:
 - lib/didkit/did.rb
 - lib/didkit/document.rb
 - lib/didkit/errors.rb
+- lib/didkit/resolver.rb
 - lib/didkit/version.rb
 - sig/didkit.rbs
 homepage: https://github.com/mackuba/didkit