didkit 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04d52ea6bded9fd573e1d4f5794b1b46691159982228b699e32e7b6d83c73573
-  data.tar.gz: e866504833f5abd3cdc6d6225836eb5d6388415a0640439e57ec6a535226ade0
+  metadata.gz: d974c618ebe4702ec35b8f4e1465b3cc0664d1cf932fd8739ac4371f7c20caa2
+  data.tar.gz: 66479727000f96ef26d09074bd97cd59d43f14388ea213f25deb846c6e75cb3d
 SHA512:
-  metadata.gz: 636c2e274e596338aa463971ab1dadac22fb655c67622cce15b65059a99e0bd91ef3ed5a78984c4c48f5ff1731287f8d3efe2d05bc0445871778b9911e3c2977
-  data.tar.gz: 62c9f5ef2238320d598050ff00d696adf572e69c663d85b04424251f4664376193ce40d0dc7bf92daf8d9e315b6d245510ad560759aacb0452955452d3027d2f
+  metadata.gz: b3b84e04e7be85c0af2a544173a14338870fc3163727dd9341a1c76d83ce6397c03f4f28284549c5c07c2c3625e018b81c7a4149c80dac8e817f01f7b724c042
+  data.tar.gz: e476000c6bbc05a3e5664e2fb44a8bb19e302c2b13d880bfc9d98a2144916b7982d914d41beea55e5775f55a1a3d01a9bd0854ff4cfa9274d86aba4a406441e1

data/CHANGELOG.md

@@ -1,2 +1,21 @@
-## [Unreleased]
+## [0.0.3] - 2024-03-06
 
+- added `Document#handles` with handle info extracted from `alsoKnownAs` field
+- added validation of various fields of the DID document
+- added `DID#resolved_by` (`:dns` or `:http`)
+- added `DID#did` which returns the DID in a string form like `to_s`
+- added `DID#web_domain` which returns the domain part of a `did:web`
+- changed `DID#type` to be stored as a symbol
+
+## [0.0.2] - 2023-11-14
+
+- fixed missing require
+- fixed some connection error handling
+
+## [0.0.1] - 2023-11-14
+
+Initial release:
+
+- resolving handle to DID via DNS or HTTP well-known
+- loading DID document via PLC or did:web well-known
+- extracting PDS endpoint field from the DID doc

data/README.md

@@ -1,31 +1,22 @@
-# Didkit
+# DidKit
 
-TODO: Delete this and the text below, and describe your gem
+A small Ruby gem for handling Distributed Identifiers (DIDs) in Bluesky / AT Protocol
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/didkit`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
+## What does it do
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+**TODO** - not much yet :)
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+See the [did.rb](https://github.com/mackuba/didkit/blob/master/lib/didkit/did.rb) file for now.
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
 
-## Usage
-
-TODO: Write usage instructions here
+## Installation
 
-## Development
+    gem install didkit
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Credits
 
-## Contributing
+Copyright © 2023 Kuba Suder ([@mackuba.eu](https://bsky.app/profile/mackuba.eu)).
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/didkit.
+The code is available under the terms of the [zlib license](https://choosealicense.com/licenses/zlib/) (permissive, similar to MIT).

data/lib/didkit/did.rb

@@ -12,9 +12,9 @@ module DIDKit
       domain = handle.gsub(/^@/, '')
 
       if dns_did = resolve_handle_by_dns(domain)
-        DID.new(dns_did)
+        DID.new(dns_did, :dns)
       elsif http_did = resolve_handle_by_well_known(domain)
-        DID.new(http_did)
+        DID.new(http_did, :http)
       else
         nil
       end
@@ -51,44 +51,43 @@ module DIDKit
       nil
     end
 
-    attr_reader :type
+    attr_reader :type, :did, :resolved_by
 
-    def initialize(did)
+    def initialize(did, resolved_by = nil)
       if did =~ /^did\:(\w+)\:/
         @did = did
-        @type = $1
+        @type = $1.to_sym
       else
         raise DIDError.new("Invalid DID format")
       end
 
-      if @type != 'plc' && @type != 'web'
+      if @type != :plc && @type != :web
         raise DIDError.new("Unrecognized DID type: #{@type}")
       end
-    end
 
-    def to_s
-      @did
+      @resolved_by = resolved_by
     end
 
+    alias to_s did
+
     def get_document
-      if @type == 'plc'
-        resolve_did_plc(@did)
-      elsif @type == 'web'
-        resolve_did_web(@did)
-      end
+      type == :plc ? resolve_did_plc : resolve_did_web
+    end
+
+    def web_domain
+      did.gsub(/^did\:web\:/, '') if type == :web
     end
 
-    def resolve_did_plc(did)
+    def resolve_did_plc
       url = "https://plc.directory/#{did}"
       json = JSON.parse(URI.open(url).read)
-      Document.new(json)
+      Document.new(self, json)
     end
 
-    def resolve_did_web(did)
-      host = did.gsub(/^did\:web\:/, '')
-      url = "https://#{host}/.well-known/did.json"
+    def resolve_did_web
+      url = "https://#{web_domain}/.well-known/did.json"
       json = JSON.parse(URI.open(url).read)
-      Document.new(json)
+      Document.new(self, json)
     end
   end
 end

data/lib/didkit/document.rb

@@ -1,14 +1,41 @@
 module DIDKit
   class Document
-    attr_reader :json
+    class FormatError < StandardError
+    end
+
+    attr_reader :json, :did, :pds_endpoint, :handles
 
-    def initialize(json)
+    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
+
+      @did = did
       @json = json
-    end
 
-    def pds_endpoint
-      service = (@json['service'] || []).detect { |s| s['id'] == '#atproto_pds' }
-      service && service['serviceEndpoint']
+      service = json['service']
+      raise FormatError, "Missing service key" if service.nil?
+      raise FormatError, "Invalid service data" unless service.is_a?(Array) && service.all? { |x| x.is_a?(Hash) }
+
+      if pds = service.detect { |x| x['id'] == '#atproto_pds' }
+        raise FormatError, "Missing PDS type" unless pds['type']
+        raise FormatError, "Invalid PDS type" unless pds['type'] == 'AtprotoPersonalDataServer'
+        raise FormatError, "Missing PDS endpoint" unless pds['serviceEndpoint']
+        raise FormatError, "Invalid PDS endpoint" unless pds['serviceEndpoint'].is_a?(String)
+        raise FormatError, "Invalid PDS endpoint" unless pds['serviceEndpoint'] =~ %r(://)
+
+        @pds_endpoint = pds['serviceEndpoint']
+      end
+
+      if aka = json['alsoKnownAs']
+        raise FormatError, "Invalid alsoKnownAs" unless aka.is_a?(Array)
+        raise FormatError, "Invalid alsoKnownAs" unless aka.all? { |x| x.is_a?(String) }
+        raise FormatError, "Invalid alsoKnownAs" unless aka.all? { |x| x =~ %r(\Aat://[^/]+\z) }
+
+        @handles = aka.map { |x| x.gsub('at://', '') }
+      else
+        @handles = []
+      end
     end
   end
 end

data/lib/didkit/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: didkit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Kuba Suder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-14 00:00:00.000000000 Z
+date: 2024-03-06 00:00:00.000000000 Z
 dependencies: []
 description:
 email: