webmention 9.1.0 → 10.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84916e475f4ede9be2eb1cd988b5b4b54e0225b13dbfca4cdc6e4ea0c10ae174
-  data.tar.gz: 2f6bbd1523b427a6a32297a86c52b35ea6c91ccff0569d46c80272c21e373c7b
+  metadata.gz: 04d6dfabcd47d82e0191f80b7dbbf7b0c78c29e019c1994514f3ac4eb96d025a
+  data.tar.gz: a340c6d249f9e16f453be9f1346518268dc2c66f2f85568c1bd8ae15158e5b12
 SHA512:
-  metadata.gz: 75f2535f613d08e21149a6678a5cc22748346048b567caa977261c6ea9cc55ced8c421d08599a5780ed0bfa78b8091d901ed9b6cf9dd4ea96e5ba908dc5fe1bf
-  data.tar.gz: eef43a1a408dabacabc445ec7c85c6ff19aaeec7f40de8897b94e38c31e20e511f9a5cd3ba3879d5152a3b82f66fd7256334fec213d1cab9697132a888416cb3
+  metadata.gz: 22d043cdb6500397afc4c5c9b52464ff5026937883fac4b272e277fbb6c208b1856254604b4effd60c87d94c7621550bf0f6103fd6593a6214b51e7f24317b0f
+  data.tar.gz: 7a71592e478ab9322c622115ec4327516a472cff31136b48b5b531b5eddc6bc193e5369964246583d9e25a1654f29f78e42e9504014c14937c09884a19abc8ee

data/.yardopts

@@ -0,0 +1,6 @@
+-
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md
+LICENSE
+USAGE.md

data/CONTRIBUTING.md

@@ -8,12 +8,12 @@ There are a couple ways you can help improve webmention-client-ruby:
 
 ## Getting Started
 
-webmention-client-ruby is developed using Ruby 3.4 and is tested against additional Ruby versions using [GitHub Actions](https://github.com/indieweb/webmention-client-ruby/actions).
+webmention-client-ruby is developed using Ruby 4.0 and is tested against additional Ruby versions using [GitHub Actions](https://github.com/indieweb/webmention-client-ruby/actions).
 
 > [!TIP]
 > This project is configured with a [Dev Container](https://containers.dev) which includes everything you'd need to contribute to webmention-client-ruby. If you use a supported code editor or IDE, you're encouraged to use the existing Dev Container setup.
 
-Before making changes to webmention-client-ruby, you'll want to install Ruby 3.4. Using a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm) is recommended. Once you've installed Ruby 3.4 using your method of choice, install the project's gems by running:
+Before making changes to webmention-client-ruby, you'll want to install Ruby 4.0. Using a Ruby version managment tool like [rv](https://github.com/spinel-coop/rv) or [rbenv](https://github.com/rbenv/rbenv) is recommended. Once you've installed Ruby 4.0 using your method of choice, install the project's gems by running:
 
 ```sh
 bundle install

data/README.md

@@ -16,9 +16,9 @@ A Ruby gem for sending and verifying [Webmention](https://indieweb.org/Webmentio
 
 ## Getting Started
 
-Before installing and using webmention-client-ruby, you'll want to have [Ruby](https://www.ruby-lang.org) 2.7 (or newer) installed. Using a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm) is recommended.
+Before installing and using webmention-client-ruby, you'll want to have [Ruby](https://www.ruby-lang.org) 2.7 (or newer) installed. Using a Ruby version managment tool like [rv](https://github.com/spinel-coop/rv) or [rbenv](https://github.com/rbenv/rbenv) is recommended.
 
-webmention-client-ruby is developed using Ruby 3.4 and is tested against additional Ruby versions using [GitHub Actions](https://github.com/indieweb/webmention-client-ruby/actions).
+webmention-client-ruby is developed using Ruby 4.0 and is tested against additional Ruby versions using [GitHub Actions](https://github.com/indieweb/webmention-client-ruby/actions).
 
 ## Installation
 
@@ -36,7 +36,7 @@ See [USAGE.md](USAGE.md) for documentation of webmention-client-ruby's features.
 
 ## Contributing
 
-See [CONTRIBUTING.md](https://github.com/indieweb/webmention-client-ruby/blob/main/CONTRIBUTING.md) for more on how to contribute to webmention-client-ruby. Your help is greatly appreciated!
+See [CONTRIBUTING.md](CONTRIBUTING.md) for more on how to contribute to webmention-client-ruby. Your help is greatly appreciated!
 
 By contributing to and participating in the development of webmention-client-ruby, you acknowledge that you have read and agree to the [IndieWeb Code of Conduct](https://indieweb.org/code-of-conduct).
 

data/USAGE.md

@@ -29,7 +29,7 @@ response.class
 #=> Webmention::ErrorResponse
 
 response.message
-#=> "No webmention endpoint found for target URL https://aaronpk.example/post/100"
+#=> "No Webmention endpoint found for target URL https://aaronpk.example/post/100"
 ```
 
 A `Webmention::Response` will be returned in all other cases.
@@ -147,6 +147,4 @@ verification.vouch_mentions_source?
 
 ## Exception Handling
 
-webmention-client-ruby avoids raising exceptions when making HTTP requests. As noted above, a `Webmention::ErrorResponse` should be returned in cases where an HTTP request triggers an exception.
-
-When crawling the supplied URL, `Webmention.mentioned_urls` _may_ raise a `NoMethodError` if a `Webmention::ErrorResponse` is returned, or the response is of an unsupported MIME type.
+webmention-client-ruby avoids raising exceptions when making HTTP requests. As noted above, a `Webmention::ErrorResponse` should be returned in cases where an HTTP request triggers an exception. `Webmention.mentioned_urls` will raise a `Burly::UnsupportedMimeType` exception when the response is of an unsupported MIME type, though.

data/lib/webmention/client.rb

@@ -1,25 +1,14 @@
 # frozen_string_literal: true
 
 module Webmention
+  # A client interface to send and verify Webmention notifications.
   class Client
-    @registered_parsers = {}
-
-    class << self
-      # @api private
-      attr_reader :registered_parsers
-    end
-
     # @return [Url]
     attr_reader :source_url
 
     # @return [Url]
     attr_reader :vouch_url
 
-    # @api private
-    def self.register_parser(klass)
-      klass.mime_types.each { |mime_type| @registered_parsers[mime_type] = klass }
-    end
-
     # Create a new {Client}.
     #
     # @example
@@ -28,52 +17,47 @@ module Webmention
     # @example
     #   Webmention::Client.new("https://jgarber.example/posts/100", vouch: "https://tantek.example/notes/1")
     #
+    # @see https://indieweb.org/Vouch
+    #
     # @param source [String, HTTP::URI, #to_s]
     #   An absolute URL representing a source document.
     # @param vouch [String, HTTP::URI, #to_s]
     #   An absolute URL representing a document vouching for the source document.
-    #   See https://indieweb.org/Vouch for additional details.
     def initialize(source, vouch: nil)
       @source_url = Url.new(source)
       @vouch_url = Url.new(vouch)
     end
 
-    # :nocov:
-    # @return [String]
+    # @!visibility private
+    # simplecov:disable
     def inspect
       "#<#{self.class}:#{format("%#0x", object_id)} " \
         "source_url: #{source_url} " \
         "vouch_url: #{vouch_url}>"
     end
-    # :nocov:
+    # simplecov:enable
 
-    # Retrieve unique URLs mentioned by this client's source URL.
+    # Unique URLs mentioned by {source_url}.
     #
     # @example
     #   client = Webmention::Client.new("https://jgarber.example/posts/100")
     #   client.mentioned_urls
     #
-    # @raise [NoMethodError]
-    #   Raised when response is an {ErrorResponse} or response is of an
-    #   unsupported MIME type.
+    # @raise [Burly::UnsupportedMimeType]
+    #   Raised when response is of an unsupported MIME type.
     #
     # @return [Array<String>]
     def mentioned_urls
       response = source_url.response
 
-      urls = Set.new(
-        self.class
-            .registered_parsers[response.mime_type]
-            .new(response.body, response.uri)
-            .results
-      )
-
-      urls.reject! { |url| url.match(/^#{response.uri}(?:#.*)?$/) }
-
-      urls.to_a.sort
+      response
+        .mentioned_urls
+        .lazy
+        .reject { |url| url.match(/^#{response.uri}(?:#.*)?$/) }
+        .sort
     end
 
-    # Send a webmention from this client's source URL to a target URL.
+    # Send a webmention from this client's {source_url} to a target URL.
     #
     # @example
     #   client = Webmention::Client.new("https://jgarber.example/posts/100")
@@ -85,20 +69,20 @@ module Webmention
     # @return [Response, ErrorResponse]
     def send_webmention(target)
       target_url = Url.new(target)
+      endpoint = target_url.webmention_endpoint
+      response = target_url.response
 
       # A Webmention endpoint exists. Send the request and return the response.
-      if target_url.webmention_endpoint?
-        return Request.post(target_url.webmention_endpoint, **request_options_for(target))
-      end
+      return Request.new(:post, endpoint, **request_options_for(target)).perform unless endpoint.nil?
 
       # An error was encountered fetching the target URL. Return the response.
-      return target_url.response unless target_url.response.ok?
+      return response unless response.ok?
 
       # No Webmention endpoint exists. Return a new ErrorResponse.
-      ErrorResponse.new("No webmention endpoint found for target URL #{target}", target_url.response.request)
+      ErrorResponse.new("No Webmention endpoint found for target URL #{target}", response.request)
     end
 
-    # Send webmentions from this client's source URL to multiple target URLs.
+    # Send webmentions from {source_url} to multiple target URLs.
     #
     # @example
     #   client = Webmention::Client.new("https://jgarber.example/posts/100")
@@ -113,10 +97,9 @@ module Webmention
       targets.map { |target| send_webmention(target) }
     end
 
-    # Verify that this client's source URL links to a target URL.
+    # Verify that {source_url} links to a target URL.
     #
-    # @param target [String, HTTP::URI, #to_s]
-    #   An absolute URL representing a target document.
+    # @param target (see #send_webmention)
     #
     # @raise (see Client#mentioned_urls)
     #
@@ -127,7 +110,7 @@ module Webmention
 
     private
 
-    # @param target [String, HTTP::URI, #to_s]
+    # @param target (see #send_webmention)
     #
     # @return [Hash{Symbol => String}]
     def request_options_for(target)
@@ -140,7 +123,7 @@ module Webmention
       opts.transform_values! { |value| value.to_s.strip }
       opts.reject! { |_, value| value.empty? }
 
-      opts
+      { form: opts }
     end
   end
 end

data/lib/webmention/error_response.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
 module Webmention
+  # An interface to instances of the {Request} class.
+  #
+  # An {ErrorResponse} represents {Request}s that generated errors (e.g.
+  # connection error, SSL error) or that could not locate a Webmention endpoint.
+  # The nature of the error is captured in the {#message} instance method.
   class ErrorResponse
     # @return [String]
     attr_reader :message
@@ -10,10 +15,7 @@ module Webmention
 
     # Create a new {ErrorResponse}.
     #
-    # Instances of this class represent HTTP requests that generated errors
-    # (e.g. connection error, SSL error) or that could not locate a Webmention
-    # endpoint. The nature of the error is captured in the {#message} instance
-    # method.
+    # @api private
     #
     # @param message [String]
     # @param request [Request]
@@ -22,15 +24,24 @@ module Webmention
       @request = request
     end
 
-    # :nocov:
-    # @return [String]
+    # @!visibility private
+    # simplecov:disable
     def inspect
       "#<#{self.class}:#{format("%#0x", object_id)} " \
         "message: #{message}>"
     end
-    # :nocov:
+    # simplecov:enable
 
-    # @return [Boolean]
+    # An {ErrorResponse} has no mentioned URLs.
+    #
+    # @return [Set]
+    def mentioned_urls
+      Set.new
+    end
+
+    # An {ErrorResponse} is never okay!
+    #
+    # @return [false]
     def ok?
       false
     end

data/lib/webmention/request.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 module Webmention
+  # An interface for executing HTTP requests and generating {Response}s and
+  # {ErrorResponse}s.
+  #
+  # @api private
   class Request
     # Set defaults derived from Webmention specification examples.
     #
@@ -31,64 +35,45 @@ module Webmention
     # @return [Hash]
     attr_reader :options
 
-    # Send an HTTP GET request to the supplied URL.
+    # Create a new {Request}.
     #
     # @example
-    #   Webmention::Request.get("https://jgarber.example/posts/100")
-    #
-    # @param url [String]
-    #
-    # @return [Response, ErrorResponse]
-    def self.get(url)
-      new(:get, url).perform
-    end
-
-    # Send an HTTP POST request with form-encoded data to the supplied URL.
+    #   Webmention::Request.new(:get, "https://jgarber.example/posts/100")
     #
     # @example
-    #   Webmention::Request.post(
+    #   Webmention::Request.new(
+    #     :post,
     #     "https://aaronpk.example/webmention",
-    #     source: "https://jgarber.examples/posts/100",
-    #     target: "https://aaronpk.example/notes/1",
-    #     vouch: "https://tantek.example/notes/1"
+    #     form: {
+    #       source: "https://jgarber.examples/posts/100",
+    #       target: "https://aaronpk.example/notes/1",
+    #       vouch: "https://tantek.example/notes/1",
+    #     },
     #   )
     #
-    # @param url [String]
-    # @param options [Hash{Symbol => String}]
-    # @option options [String] :source
-    #   An absolute URL representing a source document.
-    # @option options [String] :target
-    #   An absolute URL representing a target document.
-    # @option options [String] :vouch
-    #   An absolute URL representing a document vouching for the source document.
-    #   See https://indieweb.org/Vouch for additional details.
-    #
-    # @return [Response, ErrorResponse]
-    def self.post(url, **options)
-      new(:post, url, form: options.slice(:source, :target, :vouch)).perform
-    end
-
-    # Create a new {Request}.
+    # @see https://indieweb.org/Vouch
     #
     # @param method [Symbol]
     # @param url [String]
-    # @param options [Hash{Symbol => String}]
+    # @param options [Hash{Symbol => Hash{Symbol => String}}]
+    # @option options [Hash{Symbol => String}] :form
+    #   A Hash of options to serialize as form-encoded.
     def initialize(method, url, **options)
       @method = method.to_sym
       @uri = HTTP::URI.parse(url.to_s)
       @options = options
     end
 
-    # :nocov:
-    # @return [String]
+    # @!visibility private
+    # simplecov:disable
     def inspect
       "#<#{self.class}:#{format("%#0x", object_id)} " \
         "method: #{method.upcase}, " \
         "url: #{uri}>"
     end
-    # :nocov:
+    # simplecov:enable
 
-    # Submit the {Request}.
+    # Execute the {Request}.
     #
     # @return [Response, ErrorResponse]
     def perform

data/lib/webmention/response.rb

@@ -1,33 +1,50 @@
 # frozen_string_literal: true
 
 module Webmention
+  # An interface to instances of the {Request} and `HTTP::Response` classes.
+  #
+  # A {Response} represents the results of a successful {Request}.
   class Response
     extend Forwardable
 
+    # Consider the first h-entry to be the authoritative content container when
+    # parsing a document for mentioned URLs. Fall back to the `<body>` element
+    # when no h-entry is found.
+    #
+    # @see http://microformats.org/wiki/h-entry
+    PARSE_CONTEXT = [".h-entry .e-content", ".h-entry", "body"].freeze
+
+    URI_REGEXP = URI::RFC2396_Parser.new.make_regexp(["http", "https"]).freeze
+
+    public_constant :PARSE_CONTEXT
+    private_constant :URI_REGEXP
+
+    # The {Request} associated with this {Response}.
+    #
     # @return [Request]
     attr_reader :request
 
-    # @!method
+    # @!method headers
     #   @return [HTTP::Headers]
     def_delegator :@response, :headers
 
-    # @!method
+    # @!method body
     #   @return [HTTP::Response::Body]
     def_delegator :@response, :body
 
-    # @!method
+    # @!method code
     #   @return [Integer]
     def_delegator :@response, :code
 
-    # @!method
+    # @!method reason
     #   @return [String]
     def_delegator :@response, :reason
 
-    # !@method
+    # @!method mime_type
     #   @return [String]
     def_delegator :@response, :mime_type
 
-    # !@method
+    # @!method uri
     #   @return [HTTP::URI]
     def_delegator :@response, :uri
 
@@ -37,6 +54,8 @@ module Webmention
     # of which may be accessed using the delegated {#code} and {#reason}
     # instance methods.
     #
+    # @api private
+    #
     # @param response [HTTP::Response]
     # @param request [Request]
     def initialize(response, request)
@@ -44,17 +63,45 @@ module Webmention
       @request = request
     end
 
-    # :nocov:
-    # @return [String]
+    # @!visibility private
+    # simplecov:disable
     def inspect
       "#<#{self.class}:#{format("%#0x", object_id)} " \
         "code: #{code.inspect}, " \
         "reason: #{reason}, " \
         "url: #{request.uri}>"
     end
-    # :nocov:
+    # simplecov:enable
 
-    # @return [Boolean]
+    # Unique host names parsed from the response body.
+    #
+    # The returned `Set` contains the unique host names ("domain names") derived
+    # from the `Set` of {mentioned_urls}. Order is not guaranteed.
+    #
+    # @return [Set<String>]
+    def mentioned_hosts
+      @mentioned_hosts ||= Set.new(mentioned_urls.map { |url| HTTP::URI.parse(url).host })
+    end
+
+    # Unique mentioned URLs parsed from the response body.
+    #
+    # The returned `Set` contains the unique URLs parsed from the
+    # {PARSE_CONTEXT}. Order is not guaranteed.
+    #
+    # @return [Set<String>]
+    def mentioned_urls
+      @mentioned_urls ||=
+        Set.new(
+          Burly
+            .parse(@response.body, context: PARSE_CONTEXT, mime_type: @response.mime_type)
+            .map { |url| @response.uri.join(url).to_s }
+            .grep(URI_REGEXP)
+        )
+    end
+
+    # A {Response} is always okay!
+    #
+    # @return [true]
     def ok?
       true
     end

data/lib/webmention/url.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module Webmention
+  # An interface representing a parsed URL and its {Response}.
+  #
+  # @api private
   class Url
     extend Forwardable
 
@@ -18,27 +21,22 @@ module Webmention
       @uri = HTTP::URI.parse(url.to_s)
     end
 
-    # :nocov:
-    # @return [String]
+    # @!visibility private
+    # simplecov:disable
     def inspect
       "#<#{self.class}:#{format("%#0x", object_id)} " \
         "uri: #{uri}>"
     end
-    # :nocov:
+    # simplecov:enable
 
     # @return [Response, ErrorResponse]
     def response
-      @response ||= Request.get(uri)
+      @response ||= Request.new(:get, uri).perform
     end
 
     # @return [String, nil]
     def webmention_endpoint
       @webmention_endpoint ||= IndieWeb::Endpoints::Parser.new(response).to_h[:webmention] if response.ok?
     end
-
-    # @return [Boolean]
-    def webmention_endpoint?
-      !webmention_endpoint.nil?
-    end
   end
 end

data/lib/webmention/verification.rb

@@ -1,86 +1,56 @@
 # frozen_string_literal: true
 
 module Webmention
+  # Verify that a source URL links to a target URL.
   class Verification
     # Create a new {Verification}.
     #
+    # @api private
+    #
+    # @see https://indieweb.org/Vouch
+    #
     # @param source_url [Url]
     #   An {URL} representing a source document.
     # @param target_url [Url]
     #   An {URL} representing a target document.
     # @param vouch_url [Url]
     #   An {URL} representing a document vouching for the source document.
-    #   See https://indieweb.org/Vouch for additional details.
     def initialize(source_url, target_url, vouch_url: nil)
       @source_url = source_url
       @target_url = target_url
       @vouch_url = vouch_url
     end
 
-    # :nocov:
-    # @return [String]
+    # @!visibility private
+    # simplecov:disable
     def inspect
       "#<#{self.class}:#{format("%#0x", object_id)} " \
-        "source_url: #{source_url} " \
-        "target_url: #{target_url} " \
-        "vouch_url: #{vouch_url}>"
+        "source_url: #{@source_url} " \
+        "target_url: #{@target_url} " \
+        "vouch_url: #{@vouch_url}>"
     end
-    # :nocov:
+    # simplecov:enable
 
     # @return [Boolean]
     def source_mentions_target?
-      @source_mentions_target ||= mentioned_urls(source_url.response).any?(target_url.to_s)
+      @source_mentions_target ||= @source_url.response.mentioned_urls.any?(@target_url.to_s)
     end
 
     # @return [Boolean]
     def verified?
-      return source_mentions_target? unless verify_vouch?
+      return source_mentions_target? && vouch_mentions_source? if verify_vouch?
 
-      source_mentions_target? && vouch_mentions_source?
+      source_mentions_target?
     end
 
     # @return [Boolean]
     def verify_vouch?
-      !vouch_url.nil? && !vouch_url.to_s.strip.empty?
+      !@vouch_url.to_s.strip.empty?
     end
 
     # @return [Boolean]
     def vouch_mentions_source?
-      @vouch_mentions_source ||=
-        verify_vouch? && mentioned_domains(vouch_url.response).any?(source_url.uri.host)
-    end
-
-    private
-
-    # @return [Url]
-    attr_reader :source_url
-
-    # @return [Url]
-    attr_reader :target_url
-
-    # @return [Url]
-    attr_reader :vouch_url
-
-    # @param response [Response]
-    #
-    # @raise (see Client#mentioned_urls)
-    #
-    # @return [Array<String>]
-    def mentioned_domains(response)
-      Set.new(mentioned_urls(response).map { |url| HTTP::URI.parse(url).host }).to_a
-    end
-
-    # @param response [Response]
-    #
-    # @raise (see Client#mentioned_urls)
-    #
-    # @return [Array<String>]
-    def mentioned_urls(response)
-      Set.new(
-        Client.registered_parsers[response.mime_type]
-              .new(response.body, response.uri)
-              .results
-      ).to_a
+      @vouch_mentions_source ||= verify_vouch? && @vouch_url.response.mentioned_hosts.any?(@source_url.uri.host)
     end
   end
 end

data/lib/webmention.rb

@@ -2,6 +2,7 @@
 
 require "json"
 
+require "burly"
 require "http"
 require "indieweb/endpoints"
 require "nokogiri"
@@ -13,11 +14,9 @@ require_relative "webmention/response"
 require_relative "webmention/error_response"
 require_relative "webmention/verification"
 
-require_relative "webmention/parser"
-require_relative "webmention/parsers/html_parser"
-require_relative "webmention/parsers/json_parser"
-require_relative "webmention/parsers/plaintext_parser"
-
+# Send and verify Webmention notifications.
+#
+# @see https://indieweb.org/Webmention
 module Webmention
   # Retrieve unique URLs mentioned by the provided URL.
   #
@@ -26,11 +25,9 @@ module Webmention
   #
   # @param url [String, HTTP::URI, #to_s] An absolute URL.
   #
-  # @raise [NoMethodError]
-  #   Raised when response is an {ErrorResponse} or response is of an
-  #   unsupported MIME type.
+  # @raise (see Client#mentioned_urls)
   #
-  # @return [Array<String>]
+  # @return (see Client#mentioned_urls)
   def self.mentioned_urls(url)
     Client.new(url).mentioned_urls
   end
@@ -47,15 +44,13 @@ module Webmention
   #   target = "https://aaronpk.example/notes/1"
   #   Webmention.send_webmention(source, target, vouch: "https://tantek.example/notes/1")
   #
-  # @param source [String, HTTP::URI, #to_s]
-  #   An absolute URL representing a source document.
-  # @param target [String, HTTP::URI, #to_s]
-  #   An absolute URL representing a target document.
-  # @param vouch [String, HTTP::URI, #to_s]
-  #   An absolute URL representing a document vouching for the source document.
-  #   See https://indieweb.org/Vouch for additional details.
+  # @see https://indieweb.org/Vouch
   #
-  # @return [Response, ErrorResponse]
+  # @param source (see Client#initialize)
+  # @param target (see Client#send_webmention)
+  # @param vouch (see Client#initialize)
+  #
+  # @return (see Client#send_webmention)
   def self.send_webmention(source, target, vouch: nil)
     Client.new(source, vouch: vouch).send_webmention(target)
   end
@@ -72,13 +67,9 @@ module Webmention
   #   targets = ["https://aaronpk.example/notes/1", "https://adactio.example/notes/1"]
   #   Webmention.send_webmentions(source, targets, vouch: "https://tantek.example/notes/1")
   #
-  # @param source [String, HTTP::URI, #to_s]
-  #   An absolute URL representing a source document.
-  # @param targets [Array<String, HTTP::URI, #to_s>]
-  #   An array of absolute URLs representing multiple target documents.
-  # @param vouch [String, HTTP::URI, #to_s]
-  #   An absolute URL representing a document vouching for the source document.
-  #   See https://indieweb.org/Vouch for additional details.
+  # @see https://indieweb.org/Vouch
+  #
+  # @param (see .send_webmention)
   #
   # @return [Array<Response, ErrorResponse>]
   def self.send_webmentions(source, *targets, vouch: nil)
@@ -87,7 +78,7 @@ module Webmention
 
   # Verify that a source URL links to a target URL.
   #
-  # @param (see Webmention.send_webmention)
+  # @param (see .send_webmention)
   #
   # @raise (see Client#mentioned_urls)
   #

data/webmention.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.7"
 
   spec.name = "webmention"
-  spec.version = "9.1.0"
+  spec.version = "10.0.1"
   spec.authors = ["Jason Garber"]
   spec.email = ["jason@sixtwothree.org"]
 
@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.license = "Apache-2.0"
 
   spec.files = Dir["lib/**/*"].reject { |f| File.directory?(f) }
-  spec.files += ["LICENSE", "CHANGELOG.md", "CONTRIBUTING.md", "README.md", "USAGE.md"]
+  spec.files += [".yardopts", "LICENSE", "CHANGELOG.md", "CONTRIBUTING.md", "README.md", "USAGE.md"]
   spec.files += ["webmention.gemspec"]
 
   spec.require_paths = ["lib"]
@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
     "source_code_uri" => "#{spec.homepage}/tree/v#{spec.version}",
   }
 
+  spec.add_dependency "burly", "~> 0.4"
   spec.add_dependency "http", ">= 5.3"
   spec.add_dependency "indieweb-endpoints", "~> 10.1"
   spec.add_dependency "nokogiri", ">= 1.14"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webmention
 version: !ruby/object:Gem::Version
-  version: 9.1.0
+  version: 10.0.1
 platform: ruby
 authors:
 - Jason Garber
@@ -9,6 +9,20 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: burly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +72,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - LICENSE
@@ -66,10 +81,6 @@ files:
 - lib/webmention.rb
 - lib/webmention/client.rb
 - lib/webmention/error_response.rb
-- lib/webmention/parser.rb
-- lib/webmention/parsers/html_parser.rb
-- lib/webmention/parsers/json_parser.rb
-- lib/webmention/parsers/plaintext_parser.rb
 - lib/webmention/request.rb
 - lib/webmention/response.rb
 - lib/webmention/url.rb
@@ -80,11 +91,11 @@ licenses:
 - Apache-2.0
 metadata:
   bug_tracker_uri: https://github.com/indieweb/webmention-client-ruby/issues
-  changelog_uri: https://github.com/indieweb/webmention-client-ruby/releases/tag/v9.1.0
-  documentation_uri: https://rubydoc.info/gems/webmention/9.1.0
+  changelog_uri: https://github.com/indieweb/webmention-client-ruby/releases/tag/v10.0.1
+  documentation_uri: https://rubydoc.info/gems/webmention/10.0.1
   homepage_uri: https://github.com/indieweb/webmention-client-ruby
   rubygems_mfa_required: 'true'
-  source_code_uri: https://github.com/indieweb/webmention-client-ruby/tree/v9.1.0
+  source_code_uri: https://github.com/indieweb/webmention-client-ruby/tree/v10.0.1
 rdoc_options: []
 require_paths:
 - lib
@@ -99,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.20
 specification_version: 4
 summary: A Ruby gem for sending and verifying Webmention notifications.
 test_files: []

data/lib/webmention/parser.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Webmention
-  # @api private
-  class Parser
-    URI_PARSER = defined?(URI::RFC2396_PARSER) ? URI::RFC2396_PARSER : URI::Generic::DEFAULT_PARSER
-
-    URI_REGEXP = URI_PARSER.make_regexp(["http", "https"]).freeze
-
-    public_constant :URI_REGEXP
-
-    class << self
-      # @return [Array<String>]
-      attr_reader :mime_types
-    end
-
-    # @param response_body [HTTP::Response::Body, String, #to_s]
-    # @param response_uri [String, HTTP::URI, #to_s]
-    def initialize(response_body, response_uri)
-      @response_body = response_body.to_s
-      @response_uri = HTTP::URI.parse(response_uri.to_s)
-    end
-
-    private
-
-    # @return [String]
-    attr_reader :response_body
-
-    # @return [HTTP::URI]
-    attr_reader :response_uri
-  end
-end

data/lib/webmention/parsers/html_parser.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-module Webmention
-  module Parsers
-    # @api private
-    class HtmlParser < Parser
-      @mime_types = ["text/html"]
-
-      Client.register_parser(self)
-
-      HTML_ATTRIBUTES_MAP = {
-        "cite" => ["blockquote", "del", "ins", "q"],
-        "data" => ["object"],
-        "href" => ["a", "area"],
-        "poster" => ["video"],
-        "src" => ["audio", "embed", "img", "source", "track", "video"],
-        "srcset" => ["img", "source"],
-      }.freeze
-
-      CSS_SELECTORS_ARRAY = HTML_ATTRIBUTES_MAP
-                              .flat_map { |attribute, names| names.map { |name| "#{name}[#{attribute}]" } }.freeze
-
-      ROOT_NODE_SELECTORS_ARRAY = [".h-entry .e-content", ".h-entry", "body"].freeze
-
-      private_constant :HTML_ATTRIBUTES_MAP
-      private_constant :CSS_SELECTORS_ARRAY
-      private_constant :ROOT_NODE_SELECTORS_ARRAY
-
-      # @return [Array<String>] An array of absolute URLs.
-      def results
-        @results ||=
-          extract_urls_from(*url_attributes)
-            .map { |url| response_uri.join(url).to_s }
-            .grep(Parser::URI_REGEXP)
-      end
-
-      private
-
-      # @return [Nokogiri::HTML5::Document]
-      def doc
-        Nokogiri.HTML5(response_body)
-      end
-
-      # @param attributes [Array<Nokogiri::XML::Attr>]
-      #
-      # @return [Array<String>]
-      def extract_urls_from(*attributes)
-        attributes.flat_map do |attribute|
-          if attribute.name == "srcset"
-            attribute.value.split(",").map { |value| value.strip.match(/^\S+/).to_s }
-          else
-            attribute.value
-          end
-        end
-      end
-
-      # @return [Nokogiri::XML::Element]
-      def root_node
-        doc.at_css(*ROOT_NODE_SELECTORS_ARRAY)
-      end
-
-      # @return [Array<Nokogiri::XML::Attr>]
-      def url_attributes
-        url_nodes.flat_map(&:attribute_nodes).select { |attribute| HTML_ATTRIBUTES_MAP.key?(attribute.name) }
-      end
-
-      # @return [Nokogiri::XML::NodeSet]
-      def url_nodes
-        root_node.css(*CSS_SELECTORS_ARRAY)
-      end
-    end
-  end
-end

data/lib/webmention/parsers/json_parser.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Webmention
-  module Parsers
-    # @api private
-    class JsonParser < Parser
-      @mime_types = ["application/json"]
-
-      Client.register_parser(self)
-
-      # @return [Array<String>] An array of absolute URLs.
-      def results
-        @results ||= extract_urls_from(JSON.parse(response_body))
-      end
-
-      private
-
-      # @param objs [Array<Hash, Array, String, Integer, Boolean, nil>]
-      #
-      # @return [Array<String>]
-      def extract_urls_from(*objs)
-        objs.flat_map do |obj|
-          return obj.flat_map { |value| extract_urls_from(value) }.compact if obj.is_a?(Array)
-          return extract_urls_from(obj.values) if obj.is_a?(Hash)
-
-          obj if obj.is_a?(String) && obj.match?(Parser::URI_REGEXP)
-        end
-      end
-    end
-  end
-end

data/lib/webmention/parsers/plaintext_parser.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Webmention
-  module Parsers
-    # @api private
-    class PlaintextParser < Parser
-      @mime_types = ["text/plain"]
-
-      Client.register_parser(self)
-
-      # @return [Array<String>] An array of absolute URLs.
-      def results
-        @results ||= URI_PARSER.extract(response_body, ["http", "https"])
-      end
-    end
-  end
-end