didkit 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0170f70f452400a399264cccd61a96a0ef96d570caca53547b2794eb8067d4bd
-  data.tar.gz: 68197fe06b766fbe69d09d6d85b8abf59467f09560cb600b9af34bb900efaf6b
+  metadata.gz: fd7709e2b0973a44b71e939798901a6fd74bc9fa25e284958948fc4fe22de51e
+  data.tar.gz: b38397ddc0244f9035719dba7eb0fdcd844feb549e9628462da16b4aba662cf4
 SHA512:
-  metadata.gz: 367f5acd94953397d5ca72edec0a43f2a96e8dfef3615d16210edc203abe14b1875c1e78316efe351e223c881cbc80d2fd6cf7314753c78caea6c9ccb7ed78d0
-  data.tar.gz: 15ade27998fbc1881f28bc07fe7d625f310e686be7f101508460db48df7ca263adfc6731bf9f8bb935363fb23e51f33b1f560183595ba624d1fd7ad4e8dcf00f
+  metadata.gz: 2d5ddb2ce60022530ffd59879d5734d4300a091eb78db13028ae10a55d8ee83981ba6d20a7c933c2b6249245f40adf7458d0687f7349fa042915445e260b2e3a
+  data.tar.gz: 9a8c796fee2372323a405ec8962671438cbd7263b1265f31eb45a324dfcab7e33557dbf74b1f4b87fed0492467965ef7222569ee7fad2511efb41b7b52d33ed9

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.2.2] - 2024-04-01
+
+- added helpers for checking if a DID is known by (federated with) a relay or if the repo exists on its assigned PDS
+
+## [0.2.1] - 2024-03-26
+
+- tweaked validations in `Document` and `PLCOperation` to make them more aligned with what might be expected
+- added Ruby stdlib dependencies explicitly to the gemspec
+
 ## [0.2.0] - 2024-03-19
 
 - added `PLCImporter` class, which lets you import operations from PLC in pages of 1000 through the "export" API

data/lib/didkit/at_handles.rb

@@ -6,9 +6,8 @@ module DIDKit
     def parse_also_known_as(aka)
       raise FormatError, "Invalid alsoKnownAs: #{aka.inspect}" unless aka.is_a?(Array)
       raise FormatError, "Invalid alsoKnownAs: #{aka.inspect}" unless aka.all? { |x| x.is_a?(String) }
-      raise FormatError, "Invalid alsoKnownAs: #{aka.inspect}" unless aka.all? { |x| x =~ %r(\Aat://[^/]+\z) }
 
-      aka.map { |x| x.gsub('at://', '') }
+      aka.select { |x| x =~ %r(\Aat://[^/]+\z) }.map { |x| x.gsub('at://', '') }
     end
   end
 end

data/lib/didkit/did.rb

@@ -1,8 +1,11 @@
 require_relative 'errors'
+require_relative 'requests'
 require_relative 'resolver'
 
 module DIDKit
   class DID
+    include Requests
+
     def self.resolve_handle(handle)
       Resolver.new.resolve_handle(handle)
     end
@@ -38,6 +41,34 @@ module DIDKit
       did.gsub(/^did\:web\:/, '') if type == :web
     end
 
+    def is_known_by_relay?(relay, options = {})
+      relay_host = relay.include?('://') ? URI(relay).origin : "https://#{relay}"
+      url = URI("#{relay_host}/xrpc/com.atproto.sync.getLatestCommit")
+      url.query = URI.encode_www_form(:did => did)
+
+      response = get_response(url, { timeout: 30, max_redirects: 5 }.merge(options))
+      status = response.code.to_i
+      is_json = (response['Content-Type'] =~ /^application\/json(;.*)?$/)
+
+      if status == 200
+        true
+      elsif status == 400 && is_json && JSON.parse(response.body)['error'] == 'RepoNotFound'
+        false
+      elsif status == 404 && is_json && JSON.parse(response.body)['error']
+        false
+      else
+        raise APIError.new(response)
+      end
+    end
+
+    def account_exists?
+      doc = get_document
+      return false if doc.pds_endpoint.nil?
+
+      pds_host = URI(doc.pds_endpoint).origin
+      is_known_by_relay?(pds_host, timeout: 10)
+    end
+
     def ==(other)
       if other.is_a?(String)
         self.did == other

data/lib/didkit/document.rb

@@ -21,22 +21,18 @@ module DIDKit
       @did = did
       @json = json
 
-      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) }
-
-      @services = service.map { |x|
-        id, type, endpoint = x.values_at('id', 'type', 'serviceEndpoint')
-
-        raise FormatError, "Missing service id" unless id
-        raise FormatError, "Invalid service id: #{id.inspect}" unless id.is_a?(String) && id.start_with?('#')
-        raise FormatError, "Missing service type" unless type
-        raise FormatError, "Invalid service type: #{type.inspect}" unless type.is_a?(String)
-        raise FormatError, "Missing service endpoint" unless endpoint
-        raise FormatError, "Invalid service endpoint: #{endpoint.inspect}" unless endpoint.is_a?(String)
-
-        ServiceRecord.new(id.gsub(/^#/, ''), type, endpoint)
-      }
+      if service = json['service']
+        raise FormatError, "Invalid service data" unless service.is_a?(Array) && service.all? { |x| x.is_a?(Hash) }
+
+        @services = service.filter_map { |x|
+          id, type, endpoint = x.values_at('id', 'type', 'serviceEndpoint')
+          next unless id.is_a?(String) && id.start_with?('#') && type.is_a?(String) && endpoint.is_a?(String)
+
+          ServiceRecord.new(id.gsub(/^#/, ''), type, endpoint)
+        }
+      else
+        @services = []
+      end
 
       @handles = parse_also_known_as(json['alsoKnownAs'] || [])
     end

data/lib/didkit/errors.rb

@@ -1,4 +1,21 @@
 module DIDKit
   class DIDError < StandardError
   end
+
+  class APIError < StandardError
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+      super("APIError: #{response}")
+    end
+
+    def status
+      response.code.to_i
+    end
+
+    def body
+      response.body
+    end
+  end
 end

data/lib/didkit/plc_operation.rb

@@ -51,7 +51,7 @@ module DIDKit
         ServiceRecord.new(k, type, endpoint)
       }
 
-      @handles = parse_also_known_as(operation['alsoKnownAs'] || [])
+      @handles = parse_also_known_as(operation['alsoKnownAs'])
     end
   end
 end

data/lib/didkit/requests.rb

@@ -0,0 +1,28 @@
+module DIDKit::Requests
+  def get_response(url, options = {})
+    url = URI(url) unless url.is_a?(URI)
+    request_options = { use_ssl: true }
+
+    if timeout = options[:timeout]
+      request_options[:open_timeout] = timeout
+      request_options[:read_timeout] = timeout
+    end
+
+    redirects = 0
+    max_redirects = options[:max_redirects] || 0
+
+    loop do
+      response = Net::HTTP.start(url.host, url.port, request_options) do |http|
+        request = Net::HTTP::Get.new(url)
+        http.request(request)
+      end
+
+      if response.is_a?(Net::HTTPRedirection) && redirects < max_redirects && (location = response['Location'])
+        url = URI(location.include?('://') ? location : (url.origin + location))
+        redirects += 1
+      else
+        return response
+      end
+    end
+  end
+end

data/lib/didkit/resolver.rb

@@ -5,12 +5,15 @@ require 'resolv'
 
 require_relative 'did'
 require_relative 'document'
+require_relative 'requests'
 
 module DIDKit
   class Resolver
     RESERVED_DOMAINS = %w(alt arpa example internal invalid local localhost onion test)
     MAX_REDIRECTS = 5
 
+    include Requests
+
     attr_accessor :nameserver
 
     def initialize(options = {})
@@ -32,9 +35,9 @@ module DIDKit
     end
 
     def resolve_handle_by_dns(domain)
-      dns_records = Resolv::DNS.open(resolv_options) { |d|
+      dns_records = Resolv::DNS.open(resolv_options) do |d|
         d.getresources("_atproto.#{domain}", Resolv::DNS::Resource::IN::TXT)
-      }
+      end
 
       if record = dns_records.first
         if string = record.strings.first
@@ -46,26 +49,11 @@ module DIDKit
     end
 
     def resolve_handle_by_well_known(domain)
-      resolve_handle_from_url("https://#{domain}/.well-known/atproto-did")
-    end
-
-    def resolve_handle_from_url(url, redirects = 0)
-      url = URI(url) unless url.is_a?(URI)
+      url = "https://#{domain}/.well-known/atproto-did"
+      response = get_response(url, timeout: 10, max_redirects: MAX_REDIRECTS)
 
-      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
-          return parse_did_from_well_known(text)
-        end
-      elsif response.is_a?(Net::HTTPRedirection) && redirects < MAX_REDIRECTS
-        if location = response['Location']
-          target_url = location.include?('://') ? location : (url.origin + location)
-          return resolve_handle_from_url(target_url, redirects + 1)
-        end
+      if response.is_a?(Net::HTTPSuccess) && (text = response.body)
+        return parse_did_from_well_known(text)
       end
 
       nil

data/lib/didkit/version.rb

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

metadata

@@ -1,15 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: didkit
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Kuba Suder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-19 00:00:00.000000000 Z
-dependencies: []
+date: 2024-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: open-uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: resolv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: time
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
 description:
 email:
 - jakub.suder@gmail.com
@@ -27,6 +111,7 @@ files:
 - lib/didkit/errors.rb
 - lib/didkit/plc_importer.rb
 - lib/didkit/plc_operation.rb
+- lib/didkit/requests.rb
 - lib/didkit/resolver.rb
 - lib/didkit/service_record.rb
 - lib/didkit/services.rb