did_resolver 0.1.0

data/lib/did_resolver.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+# DID Resolver Library
+#
+# A Ruby implementation inspired by the Decentralized Identity Foundation's
+# did-resolver (https://github.com/decentralized-identity/did-resolver)
+#
+# This library provides a universal interface for resolving Decentralized
+# Identifiers (DIDs) according to the W3C DID Core specification.
+#
+# Usage:
+#   require 'did_resolver'
+#
+#   # Create a resolver with method resolvers
+#   resolver = DidResolver::Resolver.new(
+#     DidResolver::Methods::Web.resolver,
+#     DidResolver::Methods::Key.resolver,
+#     DidResolver::Methods::Jwk.resolver
+#   )
+#
+#   # Resolve a DID
+#   result = resolver.resolve("did:web:example.com")
+#   result.did_document # => DIDDocument
+#
+# Method Resolver Implementation:
+#   Each method resolver exports a .resolver method returning { method_name: resolve_proc }
+#   The resolve_proc receives (did, parsed, resolver, options) and returns a DIDResolutionResult
+#
+module DidResolver
+  class Error < StandardError; end
+  class InvalidDIDError < Error; end
+  class UnsupportedMethodError < Error; end
+  class ResolutionError < Error; end
+  class NotFoundError < ResolutionError; end
+  class NetworkError < ResolutionError; end
+
+  # DID Resolution Result as per DID Core spec
+  # @see https://www.w3.org/TR/did-core/#did-resolution
+  class ResolutionResult
+    attr_reader :did_resolution_metadata, :did_document, :did_document_metadata
+
+    def initialize(did_document: nil, did_resolution_metadata: {}, did_document_metadata: {})
+      @did_document = did_document
+      @did_resolution_metadata = did_resolution_metadata.freeze
+      @did_document_metadata = did_document_metadata.freeze
+    end
+
+    def error?
+      !did_resolution_metadata[:error].nil? && did_resolution_metadata[:error] != ""
+    end
+
+    def error
+      did_resolution_metadata[:error]
+    end
+
+    def error_message
+      did_resolution_metadata[:error_message]
+    end
+
+    def content_type
+      did_resolution_metadata[:content_type] || "application/did+ld+json"
+    end
+
+    def to_h
+      {
+        did_resolution_metadata: did_resolution_metadata,
+        did_document: did_document&.to_h,
+        did_document_metadata: did_document_metadata
+      }
+    end
+
+    # Factory methods for common results
+    class << self
+      def success(did_document, metadata: {}, document_metadata: {})
+        new(
+          did_document: did_document,
+          did_resolution_metadata: { content_type: "application/did+ld+json" }.merge(metadata),
+          did_document_metadata: document_metadata
+        )
+      end
+
+      def error(error_type, message = nil)
+        new(
+          did_resolution_metadata: {
+            error: error_type,
+            error_message: message
+          }.compact
+        )
+      end
+
+      def not_found(did)
+        error("notFound", "DID not found: #{did}")
+      end
+
+      def method_not_supported(method)
+        error("methodNotSupported", "DID method not supported: #{method}")
+      end
+
+      def invalid_did(did, reason = nil)
+        error("invalidDid", reason || "Invalid DID format: #{did}")
+      end
+    end
+  end
+
+  # Parsed DID components
+  # @see https://www.w3.org/TR/did-core/#did-syntax
+  class ParsedDID
+    attr_reader :did, :method, :id, :path, :query, :fragment, :params
+
+    # DID Syntax: did:method-name:method-specific-id
+    DID_REGEX = /\Adid:([a-z0-9]+):([^#?\/]+)(\/[^#?]*)?(\\?[^#]*)?(#.*)?\z/i.freeze
+
+    def initialize(did:, method:, id:, path: nil, query: nil, fragment: nil, params: {})
+      @did = did
+      @method = method
+      @id = id
+      @path = path
+      @query = query
+      @fragment = fragment
+      @params = params.freeze
+    end
+
+    # The full DID URL (did + path + query + fragment)
+    def did_url
+      @did_url ||= "#{did}#{path}#{query}#{fragment}"
+    end
+
+    def to_h
+      {
+        did: did,
+        method: method,
+        id: id,
+        path: path,
+        query: query,
+        fragment: fragment,
+        params: params
+      }.compact
+    end
+
+    class << self
+      # Parse a DID string into components
+      # @param did_string [String] The DID or DID URL to parse
+      # @return [ParsedDID]
+      # @raise [InvalidDIDError] if the DID format is invalid
+      def parse(did_string)
+        raise InvalidDIDError, "DID cannot be nil" if did_string.nil?
+        raise InvalidDIDError, "DID cannot be empty" if did_string.empty?
+
+        # Normalize and extract parts
+        did_string = did_string.strip
+
+        match = did_string.match(DID_REGEX)
+        raise InvalidDIDError, "Invalid DID format: #{did_string}" unless match
+
+        method = match[1].downcase
+        id = match[2]
+        path = match[3]
+        query = match[4]
+        fragment = match[5]
+
+        # Extract DID parameters from query if present
+        params = parse_params(query)
+
+        # The base DID (without path, query, fragment)
+        base_did = "did:#{method}:#{id}"
+
+        new(
+          did: base_did,
+          method: method,
+          id: id,
+          path: path,
+          query: query,
+          fragment: fragment,
+          params: params
+        )
+      end
+
+      private
+
+      def parse_params(query_string)
+        return {} unless query_string
+
+        # Remove leading ?
+        query_string = query_string[1..] if query_string.start_with?("?")
+        return {} if query_string.empty?
+
+        query_string.split("&").each_with_object({}) do |pair, hash|
+          key, value = pair.split("=", 2)
+          hash[key] = value
+        end
+      end
+    end
+  end
+end
+
+# Load sub-modules
+require_relative "did_resolver/version"
+require_relative "did_resolver/did_document"
+require_relative "did_resolver/resolver"
+require_relative "did_resolver/cache"
+require_relative "did_resolver/methods"

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: did_resolver
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean De Block
+bindir: exe
+cert_chain: []
+date: 2026-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |
+  A Ruby implementation of a universal DID (Decentralized Identifier) resolver,
+  inspired by the Decentralized Identity Foundation's did-resolver.
+
+  Supports multiple DID methods:
+  - did:web - HTTPS domain-based DIDs
+  - did:key - Self-describing cryptographic key DIDs
+  - did:jwk - JWK-encoded DIDs
+
+  Includes support for EBSI jwk_jcs-pub format (multicodec 0xeb51).
+email:
+- dean.de.block@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/did_resolver.rb
+- lib/did_resolver/cache.rb
+- lib/did_resolver/did_document.rb
+- lib/did_resolver/methods.rb
+- lib/did_resolver/methods/jwk.rb
+- lib/did_resolver/methods/key.rb
+- lib/did_resolver/methods/web.rb
+- lib/did_resolver/resolver.rb
+- lib/did_resolver/version.rb
+homepage: https://github.com/DeanDeBlock/did_resolver
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/DeanDeBlock/did_resolver
+  source_code_uri: https://github.com/DeanDeBlock/did_resolver
+  changelog_uri: https://github.com/DeanDeBlock/did_resolver/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Universal DID Resolver for Ruby
+test_files: []