didkit 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1dfc5eee5f96a374d8f67151f8d44f5eafffc8a8e3624d7fe507e783d5ff814
-  data.tar.gz: 74f0cd8da39a5e723b806e07560bd15325d2176c93ca746d619975e6b0510c77
+  metadata.gz: ae1ff103a9695991ae3e0e97072c2b10731e7c18e44cfa5f715995ef0631df4f
+  data.tar.gz: b2bc822873a7804515d3ad06caa6c15e4177943668f6bcbb79f8c48fa87e4733
 SHA512:
-  metadata.gz: 976f7d9a63ad453dde3064872dafb558cbc80f96db0a61d5243abb68664b360a38ede6cfe5a702df7609b60c6d7c6e917ffc1a0479351bb89c7c693af5ffb3c7
-  data.tar.gz: da1e08939b8c19d62ceef10bd48d278b7190fffdbcad65385f9ca36edd9377d0ee37d1b1d78e8ae963304dd06863cdcf9fa992a504b3e219c1f01dbf60248f6a
+  metadata.gz: 5e4bbd991480a0a98c13c514e52a65bdceafd1c1a4feb75d60db07b22af10f376edaaea89bd98122c94c902c718c241a01965abaa801433b2a48162bb86d6ec1
+  data.tar.gz: 791481ed39520a72eb750e2d511f6017ca476a1386c15d6d6a667e2a170a7e63d0723e868b2d843c87d66d3d33306fcc6bd5cd3d359cbea8e213e6ba8a401f99

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [0.2.3] - 2024-07-02
+
+- added a `DID#get_audit_log` method that fetches the PLC audit log for a DID
+- added a way to set an error handler in `PLCImporter`
+- reverted the change from 0.2.1 that added Ruby stdlib dependencies explicitly to the gemspec, since this causes more problems than it's worth
+- minor bug fixes
+
+## [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

data/README.md

@@ -1,6 +1,9 @@
-# DIDKit
+# DIDKit 🪪
 
-A small Ruby gem for handling Distributed Identifiers (DIDs) in Bluesky / AT Protocol
+A small Ruby gem for handling Distributed Identifiers (DIDs) in Bluesky / AT Protocol.
+
+> [!NOTE]
+> ATProto Ruby gems collection: [skyfall](https://github.com/mackuba/skyfall) | [blue_factory](https://github.com/mackuba/blue_factory) | [minisky](https://github.com/mackuba/minisky) | [didkit](https://github.com/mackuba/didkit)
 
 
 ## What does it do

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
@@ -34,10 +37,46 @@ module DIDKit
       Resolver.new.get_validated_handle(self)
     end
 
+    def get_audit_log
+      if @type == :plc
+        PLCImporter.new.fetch_audit_log(self)
+      else
+        raise DIDError.new("Audit log not supported for did:#{@type}")
+      end
+    end
+
     def web_domain
       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/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_importer.rb

@@ -9,7 +9,7 @@ module DIDKit
     PLC_SERVICE = 'plc.directory'
     MAX_PAGE = 1000
 
-    attr_accessor :ignore_errors, :last_date
+    attr_accessor :ignore_errors, :last_date, :error_handler
 
     def initialize(since: nil)
       if since.to_s == 'beginning'
@@ -22,14 +22,22 @@ module DIDKit
         @last_date = Time.now
         @eof = true
       end
-
-      @ignore_errors = false
     end
 
     def plc_service
       PLC_SERVICE
     end
 
+    def ignore_errors=(val)
+      @ignore_errors = val
+
+      if val
+        @error_handler = proc { |e, j| "(ignore error)" }
+      else
+        @error_handler = nil
+      end
+    end
+
     def get_export(args = {})
       url = URI("https://#{plc_service}/export")
       url.query = URI.encode_www_form(args)
@@ -38,6 +46,11 @@ module DIDKit
       data.lines.map(&:strip).reject(&:empty?).map { |x| JSON.parse(x) }
     end
 
+    def fetch_audit_log(did)
+      response = URI.open("https://#{plc_service}/#{did}/log/audit").read
+      JSON.parse(response).map { |j| PLCOperation.new(j) }
+    end      
+
     def fetch_page
       request_time = Time.now
 
@@ -47,8 +60,9 @@ module DIDKit
       operations = rows.filter_map do |json|
         begin
           PLCOperation.new(json)
-        rescue PLCOperation::FormatError => e
-          ignore_errors ? nil : raise
+        rescue PLCOperation::FormatError, AtHandles::FormatError, ServiceRecord::FormatError => e
+          @error_handler ? @error_handler.call(e, json) : raise
+          nil
         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/service_record.rb

@@ -3,6 +3,9 @@ require_relative 'errors'
 
 module DIDKit
   class ServiceRecord
+    class FormatError < StandardError
+    end
+
     attr_reader :key, :type, :endpoint
 
     def initialize(key, type, endpoint)

data/lib/didkit/version.rb

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

metadata

@@ -1,99 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: didkit
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Kuba Suder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-26 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'
+date: 2024-07-02 00:00:00.000000000 Z
+dependencies: []
 description:
 email:
 - jakub.suder@gmail.com
@@ -111,6 +27,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