didkit 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7744ae1dc9ba4ca678d641139ffa94931130ee7f91fa93d3ee89e3d6e196ba8d
-  data.tar.gz: 4111e824027b646aa8b3a21fb3032dfdba26019b6fecaf3f40f2120dfa417e52
+  metadata.gz: 0170f70f452400a399264cccd61a96a0ef96d570caca53547b2794eb8067d4bd
+  data.tar.gz: 68197fe06b766fbe69d09d6d85b8abf59467f09560cb600b9af34bb900efaf6b
 SHA512:
-  metadata.gz: ed96e325c2d0e8152b1db1f6a46e34afdbec049e0442f2298a89a2bbd07afb96e3ca166fca40adf1ff90d0da02997b825addd20163eb858c6074771d9ea229ce
-  data.tar.gz: 9237183a427ad4f5380504334abcfb16a965b0e95ce39693e9aa8d58d24c6acc6c00d7150bd86be18332e02da3cbd379eb516ccb60716a3b09bf11efc155c26c
+  metadata.gz: 367f5acd94953397d5ca72edec0a43f2a96e8dfef3615d16210edc203abe14b1875c1e78316efe351e223c881cbc80d2fd6cf7314753c78caea6c9ccb7ed78d0
+  data.tar.gz: 15ade27998fbc1881f28bc07fe7d625f310e686be7f101508460db48df7ca263adfc6731bf9f8bb935363fb23e51f33b1f560183595ba624d1fd7ad4e8dcf00f

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.2.0] - 2024-03-19
+
+- added `PLCImporter` class, which lets you import operations from PLC in pages of 1000 through the "export" API
+- implemented parsing of all services from DID doc & operations, not only `atproto_pds` (specifically labeller endpoints)
+- allow setting the nameserver in `Resolver` initializer
+
 ## [0.1.0] - 2024-03-12
 
 - rejecting handles from disallowed domains like `.arpa` or `.test`

data/lib/didkit/at_handles.rb

@@ -0,0 +1,14 @@
+module DIDKit
+  module AtHandles
+    class FormatError < StandardError
+    end
+
+    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://', '') }
+    end
+  end
+end

data/lib/didkit/document.rb

@@ -1,11 +1,17 @@
+require_relative 'at_handles'
 require_relative 'resolver'
+require_relative 'service_record'
+require_relative 'services'
 
 module DIDKit
   class Document
     class FormatError < StandardError
     end
 
-    attr_reader :json, :did, :pds_endpoint, :handles
+    include AtHandles
+    include Services
+
+    attr_reader :json, :did, :handles, :services
 
     def initialize(did, json)
       raise FormatError, "Missing id field" if json['id'].nil?
@@ -19,25 +25,20 @@ module DIDKit
       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
+      @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)
+      }
+
+      @handles = parse_also_known_as(json['alsoKnownAs'] || [])
     end
 
     def get_validated_handle

data/lib/didkit/plc_importer.rb

@@ -1,5 +1,4 @@
 require 'json'
-require 'net/http'
 require 'open-uri'
 require 'time'
 
@@ -8,21 +7,42 @@ require_relative 'plc_operation'
 module DIDKit
   class PLCImporter
     PLC_SERVICE = 'plc.directory'
+    MAX_PAGE = 1000
 
-    attr_accessor :ignore_errors
+    attr_accessor :ignore_errors, :last_date
+
+    def initialize(since: nil)
+      if since.to_s == 'beginning'
+        @last_date = nil
+      elsif since.is_a?(String)
+        @last_date = Time.parse(since)
+      elsif since
+        @last_date = since
+      else
+        @last_date = Time.now
+        @eof = true
+      end
 
-    def initialize(last_date = Time.now)
-      @last_date = last_date
       @ignore_errors = false
     end
 
-    def fetch
-      url = URI("https://#{PLC_SERVICE}/export")
-      url.query = URI.encode_www_form(:after => @last_date.utc.iso8601(6)) if @last_date
-      request_time = Time.now
+    def plc_service
+      PLC_SERVICE
+    end
+
+    def get_export(args = {})
+      url = URI("https://#{plc_service}/export")
+      url.query = URI.encode_www_form(args)
 
       data = URI.open(url).read
-      rows = data.lines.map(&:strip).reject(&:empty?).map { |x| JSON.parse(x) }
+      data.lines.map(&:strip).reject(&:empty?).map { |x| JSON.parse(x) }
+    end
+
+    def fetch_page
+      request_time = Time.now
+
+      query = @last_date ? { :after => @last_date.utc.iso8601(6) } : {}
+      rows = get_export(query)
 
       operations = rows.filter_map do |json|
         begin
@@ -32,14 +52,22 @@ module DIDKit
         end
       end
 
-      block.call(operations)
+      @last_date = operations.last&.created_at || request_time
+      @eof = (rows.length < MAX_PAGE)
 
-      if rows.length == 1000
-        @last_date = operations.last.created_at || request_time
-        run_update
-      else
-        @last_date = request_time
+      operations
+    end
+
+    def fetch(&block)
+      loop do
+        operations = fetch_page
+        block.call(operations)
+        break if eof?
       end
     end
+
+    def eof?
+      !!@eof
+    end
   end
 end

data/lib/didkit/plc_operation.rb

@@ -1,56 +1,57 @@
 require 'time'
 
+require_relative 'at_handles'
+require_relative 'service_record'
+require_relative 'services'
+
 module DIDKit
   class PLCOperation
     class FormatError < StandardError
     end
 
-    attr_reader :did, :created_at, :type, :pds_endpoint, :handles
+    include AtHandles
+    include Services
+
+    attr_reader :json, :did, :created_at, :type, :handles, :services
 
     def initialize(json)
+      @json = json
       @did = json['did']
-      raise FormatError, "Missing DID" if @did.nil?
-      raise FormatError, "Invalid DID" unless @did.is_a?(String) && @did.start_with?('did:')
+      raise FormatError, "Missing DID: #{json}" if @did.nil?
+      raise FormatError, "Invalid DID: #{@did}" unless @did.is_a?(String) && @did.start_with?('did:')
 
       timestamp = json['createdAt']
-      raise FormatError, "Missing createdAt" if timestamp.nil?
-      raise FormatError, "Invalid createdAt" unless timestamp.is_a?(String)
+      raise FormatError, "Missing createdAt: #{json}" if timestamp.nil?
+      raise FormatError, "Invalid createdAt: #{timestamp.inspect}" unless timestamp.is_a?(String)
 
       @created_at = Time.parse(timestamp)
 
       operation = json['operation']
-      raise FormatError, "Missing operation key" if operation.nil?
-      raise FormatError, "Invalid operation data" unless operation.is_a?(Hash)
+      raise FormatError, "Missing operation key: #{json}" if operation.nil?
+      raise FormatError, "Invalid operation data: #{operation.inspect}" unless operation.is_a?(Hash)
 
       type = operation['type']
-      raise FormatError, "Missing type" if type.nil?
+      raise FormatError, "Missing operation type: #{json}" if type.nil?
 
       @type = type.to_sym
       return unless @type == :plc_operation
 
       services = operation['services']
-      raise FormatError, "Missing services key" if services.nil?
-      raise FormatError, "Invalid services data" unless services.is_a?(Hash)
-
-      if pds = services['atproto_pds']
-        raise FormatError, "Invalid PDS data" unless pds.is_a?(Hash)
-        raise FormatError, "Missing PDS type" unless pds['type']
-        raise FormatError, "Invalid PDS type" unless pds['type'] == 'AtprotoPersonalDataServer'
-        raise FormatError, "Missing PDS endpoint" unless pds['endpoint']
-        raise FormatError, "Invalid PDS endpoint" unless pds['endpoint'].is_a?(String) && pds['endpoint'] =~ %r(://)
-
-        @pds_endpoint = pds['endpoint']
-      end
-
-      if aka = operation['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
+      raise FormatError, "Missing services key: #{json}" if services.nil?
+      raise FormatError, "Invalid services data: #{services}" unless services.is_a?(Hash)
+
+      @services = services.map { |k, x|
+        type, endpoint = x.values_at('type', 'endpoint')
+
+        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(k, type, endpoint)
+      }
+
+      @handles = parse_also_known_as(operation['alsoKnownAs'] || [])
     end
   end
 end

data/lib/didkit/resolver.rb

@@ -13,6 +13,10 @@ module DIDKit
 
     attr_accessor :nameserver
 
+    def initialize(options = {})
+      @nameserver = options[:nameserver]
+    end
+
     def resolve_handle(handle)
       domain = handle.gsub(/^@/, '')
 

data/lib/didkit/service_record.rb

@@ -0,0 +1,20 @@
+require 'uri'
+require_relative 'errors'
+
+module DIDKit
+  class ServiceRecord
+    attr_reader :key, :type, :endpoint
+
+    def initialize(key, type, endpoint)
+      begin
+        uri = URI(endpoint)
+      rescue URI::Error
+        raise FormatError, "Invalid service endpoint: #{endpoint.inspect}"
+      end
+
+      @key = key
+      @type = type
+      @endpoint = endpoint
+    end
+  end
+end

data/lib/didkit/services.rb

@@ -0,0 +1,15 @@
+module DIDKit
+  module Services
+    def get_service(key, type)
+      @services&.detect { |s| s.key == key && s.type == type }
+    end
+
+    def pds_endpoint
+      @pds_endpoint ||= get_service('atproto_pds', 'AtprotoPersonalDataServer')&.endpoint
+    end
+
+    def labeler_endpoint
+      @labeler_endpoint ||= get_service('atproto_labeler', 'AtprotoLabeler')&.endpoint
+    end
+  end
+end

data/lib/didkit/version.rb

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

data/lib/didkit.rb

@@ -2,6 +2,9 @@
 
 require_relative "didkit/did"
 require_relative "didkit/document"
+require_relative "didkit/plc_importer"
+require_relative "didkit/plc_operation"
+require_relative "didkit/resolver"
 require_relative "didkit/version"
 
 module DIDKit

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: didkit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kuba Suder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-12 00:00:00.000000000 Z
+date: 2024-03-19 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -21,12 +21,15 @@ files:
 - LICENSE.txt
 - README.md
 - lib/didkit.rb
+- lib/didkit/at_handles.rb
 - lib/didkit/did.rb
 - lib/didkit/document.rb
 - lib/didkit/errors.rb
 - lib/didkit/plc_importer.rb
 - lib/didkit/plc_operation.rb
 - lib/didkit/resolver.rb
+- lib/didkit/service_record.rb
+- lib/didkit/services.rb
 - lib/didkit/version.rb
 - sig/didkit.rbs
 homepage: https://github.com/mackuba/didkit