didkit 0.3.3 → 0.5.0

data/lib/didkit/services.rb

@@ -21,33 +21,61 @@ module DIDKit
       @services&.detect { |s| s.key == key && s.type == type }
     end
 
-    # Returns the PDS service endpoint, if present.
+    # Returns the PDS service endpoint, if present and valid.
     #
     # If the DID has an `#atproto_pds` service declared in its `service` section,
     # returns the URL in its `serviceEndpoint` field. In other words, this is the URL
     # of the PDS assigned to a given user, which stores the user's account and repo.
     #
+    # Returns nil if the service record is present, but the URL is not a valid HTTP(S) URL.
+    # For PDS endpoint specifically, the URL should only contain the scheme, hostname, and
+    # optional port number, but no userinfo, path, query or other components. As an exception,
+    # a path in the form of a single trailing slash is also allowed.
+    #
     # @api public
     # @return [String, nil] PDS service endpoint URL
 
     def pds_endpoint
-      @pds_endpoint ||= get_service('atproto_pds', 'AtprotoPersonalDataServer')&.endpoint
+      return @pds_endpoint if @pds_endpoint
+
+      endpoint = get_service('atproto_pds', 'AtprotoPersonalDataServer')&.endpoint
+      return nil if endpoint.nil?
+
+      uri = URI(endpoint)
+
+      return nil if uri.scheme !~ /^https?$/ || uri.host.nil? || uri.host.empty?
+      return nil if uri.userinfo || uri.query || uri.fragment
+      return nil unless uri.path.empty? || uri.path == '/'
+
+      @pds_endpoint = endpoint
     end
 
-    # Returns the labeler service endpoint, if present.
+    # Returns the labeler service endpoint, if present and valid.
     #
     # If the DID has an `#atproto_labeler` service declared in its `service` section,
     # returns the URL in its `serviceEndpoint` field.
     #
+    # Returns nil if the service record is present, but the URL is not an HTTP(S) URL.
+    #
     # @api public
     # @return [String, nil] labeler service endpoint URL
 
     def labeler_endpoint
-      @labeler_endpoint ||= get_service('atproto_labeler', 'AtprotoLabeler')&.endpoint
+      return @labeler_endpoint if @labeler_endpoint
+
+      endpoint = get_service('atproto_labeler', 'AtprotoLabeler')&.endpoint
+      return nil if endpoint.nil?
+
+      uri = URI(endpoint)
+      return nil if uri.scheme !~ /^https?$/ || uri.host.nil? || uri.host.empty?
+
+      @labeler_endpoint = endpoint
     end
 
     # Returns the hostname of the PDS service, if present.
     #
+    # If the endpoint URL includes a port number, it is excluded.
+    #
     # @api public
     # @return [String, nil] hostname of the PDS endpoint URL
 
@@ -57,6 +85,8 @@ module DIDKit
 
     # Returns the hostname of the labeler service, if present.
     #
+    # If the endpoint URL includes a port number, it is excluded.
+    #
     # @api public
     # @return [String, nil] hostname of the labeler endpoint URL
 

data/lib/didkit/version.rb

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

data/lib/didkit.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+require_relative "didkit/constants"
 require_relative "didkit/did"
 require_relative "didkit/document"
+require_relative "didkit/global_did"
 require_relative "didkit/plc_importer"
 require_relative "didkit/plc_operation"
 require_relative "didkit/resolver"
@@ -9,5 +11,3 @@ require_relative "didkit/version"
 
 module DIDKit
 end
-
-DID = DIDKit::DID

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: didkit
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Kuba Suder
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base58
+  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'
 email:
 - jakub.suder@gmail.com
 executables: []
@@ -18,19 +32,22 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- SECURITY.md
 - lib/didkit.rb
 - lib/didkit/at_handles.rb
+- lib/didkit/constants.rb
 - lib/didkit/did.rb
 - lib/didkit/document.rb
 - lib/didkit/errors.rb
+- lib/didkit/global_did.rb
 - lib/didkit/plc_importer.rb
 - lib/didkit/plc_operation.rb
+- lib/didkit/public_key.rb
 - lib/didkit/requests.rb
 - lib/didkit/resolver.rb
 - lib/didkit/service_record.rb
 - lib/didkit/services.rb
 - lib/didkit/version.rb
-- sig/didkit.rbs
 homepage: https://ruby.sdk.blue
 licenses:
 - Zlib
@@ -38,6 +55,7 @@ metadata:
   bug_tracker_uri: https://tangled.org/mackuba.eu/didkit/issues
   changelog_uri: https://tangled.org/mackuba.eu/didkit/blob/master/CHANGELOG.md
   source_code_uri: https://tangled.org/mackuba.eu/didkit
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -52,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.18
 specification_version: 4
 summary: A library for handling Distributed ID (DID) identifiers used in Bluesky AT
   Protocol

data/sig/didkit.rbs

@@ -1,4 +0,0 @@
-module Didkit
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end