webmention 8.0.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4443988ec11a8c807bcaefa41a2838d7b9bfe9943ae9f53e28a155a9c6d7c68
-  data.tar.gz: 77147bbffe3370285afcc0e49f016912efd65d7e4904f67bd0ac802f72077385
+  metadata.gz: 68b2e3b667fedde2265819a6c01a0b547b3a8503389a5209e2b9ce600b50945a
+  data.tar.gz: 622770cbe635b33de6125be189bf43a9cd23bbfff223f8897198862a463e6007
 SHA512:
-  metadata.gz: 26283df86f92e3e3f29d601878d3f604a92ae7e31af52d8d153d6c8b1ee13d94e064df906bed83e9cf2d6e27d7d7c89dc09f105862c30e5c999e5680a9eb6095
-  data.tar.gz: 450e7178e1d6354fae32b35e958692c7d6d25243b10dd52104f5c63a1cec09854d5e7d1be3570f707fef5298c163af1712dac1d5a458a4fa7d0e22165a673a23
+  metadata.gz: 8be2cd5b737f7ea3c6321373ac41cc53f73830b5f01163591485ec0d1f2138bb133cb9eee39f57d82bb1c5e9871b435f8acbc0a7cf190f2bc55c84b7cfd56006
+  data.tar.gz: 2415239ef05fdd79ce8e417c4071f21bab937487ad499f2ac53c681f0605b986f4922a3b3c1204bfae10cade9916d3e6394ebd5661b03a438a096911ac3ace5d

data/CONTRIBUTING.md

@@ -8,9 +8,12 @@ There are a couple ways you can help improve webmention-client-ruby:
 
 ## Getting Started
 
-webmention-client-ruby is developed using Ruby 3.3.0 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 3.4 and is tested against additional Ruby versions using [GitHub Actions](https://github.com/indieweb/webmention-client-ruby/actions).
 
-Before making changes to webmention-client-ruby, you'll want to install Ruby 3.3.0. 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.3.0 using your method of choice, install the project's gems by running:
+> [!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:
 
 ```sh
 bundle install
@@ -19,17 +22,17 @@ bundle install
 ## Making Changes
 
 1. Fork and clone the project's repo.
-1. Install development dependencies as outlined above.
-1. Create a feature branch for the code changes you're looking to make: `git checkout -b my-new-feature`.
-1. _Write some code!_
-1. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `bundle exec rspec`.
-1. Commit your changes: `git commit -am 'Add some new feature or fix some issue'`. _(See [this excellent article](https://chris.beams.io/posts/git-commit/) for tips on writing useful Git commit messages.)_
-1. Push the branch to your fork: `git push -u origin my-new-feature`.
-1. Create a new [Pull Request][pulls] and we'll review your changes.
+2. Install development dependencies as outlined above.
+3. Create a feature branch for the code changes you're looking to make: `git checkout -b my-new-feature`.
+4. _Write some code!_
+5. If your changes would benefit from testing, add the necessary tests and verify everything passes by running `bin/rspec`.
+6. Commit your changes: `git commit -am 'Add some new feature or fix some issue'`. _(See [this excellent article](https://cbea.ms/git-commit/) for tips on writing useful Git commit messages.)_
+7. Push the branch to your fork: `git push -u origin my-new-feature`.
+8. Create a new [Pull Request][pulls] and we'll review your changes.
 
 ## Code Style
 
-Code formatting conventions are defined in the `.editorconfig` file which uses the [EditorConfig](http://editorconfig.org) syntax. There are [plugins for a variety of editors](http://editorconfig.org/#download) that utilize the settings in the `.editorconfig` file. We recommended installing the EditorConfig plugin for your editor of choice.
+Code formatting conventions are defined in the `.editorconfig` file which uses the [EditorConfig](https://editorconfig.org) syntax. There are [plugins for a variety of editors](https://editorconfig.org/#download) that utilize the settings in the `.editorconfig` file. We recommended installing the EditorConfig plugin for your editor of choice.
 
 Your bug fix or feature addition won't be rejected if it runs afoul of any (or all) of these guidelines, but following the guidelines will definitely make everyone's lives a little easier.
 

data/README.md

@@ -12,12 +12,13 @@
 - Perform [endpoint discovery](https://www.w3.org/TR/webmention/#sender-discovers-receiver-webmention-endpoint) on mentioned URLs.
 - Send webmentions to one or more mentioned URLs (and optionally include a [vouch](https://indieweb.org/Vouch) URL).
 - Verify that a received webmention's source URL links to a target URL (and optionally verify that a vouch URL mentions the source URL's domain).
+- Supports Ruby 2.7 and newer.
 
 ## Getting Started
 
-Before installing and using webmention-client-ruby, you'll want to have [Ruby](https://www.ruby-lang.org) 3.0 (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 [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm) is recommended.
 
-webmention-client-ruby is developed using Ruby 3.0.0 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 3.4 and is tested against additional Ruby versions using [GitHub Actions](https://github.com/indieweb/webmention-client-ruby/actions).
 
 ## Installation
 
@@ -26,24 +27,12 @@ Add webmention-client-ruby to your project's `Gemfile` and run `bundle install`:
 ```ruby
 source "https://rubygems.org"
 
-gem "webmention-client"
+gem "webmention"
 ```
 
 ## Usage
 
-See [USAGE.md](https://github.com/indieweb/webmention-client-ruby/blob/main/USAGE.md) for documentation of webmention-client-ruby's features.
-
-## Migrating to version 6
-
-webmention-client-ruby was completely rewritten for version 6 to better support new features and future development. Some notes on migrating to the new version:
-
-♻️ **Renamed:** for clarity and consistency, the `Webmention.send_mention` method has been renamed `Webmention.send_webmention`. Both methods use the same interface.
-
-❌ **Removed:** the `Webmention.client` method has been removed in favor of the additional module methods [noted above](#usage). While the underlying `Webmention::Client` class still exists, its interface has changed and its direct usage is generally unnecessary.
-
-❌ **Removed:** `Webmention::Client#send_all_mentions` has been removed in favor of `Webmention.send_webmentions`. Combine `Webmention.mentioned_urls` and `Webmention.send_webmentions` to achieve similar results.
-
-🛠 **Refactored:** Exception handling has been greatly improved [as noted above](#exception-handling).
+See [USAGE.md](USAGE.md) for documentation of webmention-client-ruby's features.
 
 ## Contributing
 

data/USAGE.md

@@ -1,6 +1,7 @@
 # Using webmention-client-ruby
 
-Before using webmention-client-ruby, please read the [Getting Started](https://github.com/indieweb/webmention-client-ruby/blob/main/README.md#getting-started) and [Installation](https://github.com/indieweb/webmention-client-ruby/blob/main/README.md#installation) sections of the project's [README.md](https://github.com/indieweb/webmention-client-ruby/blob/main/README.md).
+> [!NOTE]
+> Before using webmention-client-ruby, please read the [Getting Started](README.md#getting-started) and [Installation](README.md#installation) sections of the project's [README.md](README.md).
 
 ## Sending a webmention
 
@@ -15,9 +16,7 @@ target = "https://aaronpk.example/post/100" # A post on someone else's website
 response = Webmention.send_webmention(source, target)
 ```
 
-`Webmention.send_webmention` will return either a `Webmention::Response` or a `Webmention::ErrorResponse`. Instances of both classes respond to `ok?`. Building on the examples above:
-
-A `Webmention::ErrorResponse` may be returned when:
+`Webmention.send_webmention` will return either a `Webmention::Response` or a `Webmention::ErrorResponse`. Instances of both classes respond to `ok?`. Building on the examples above,  a `Webmention::ErrorResponse` may be returned when:
 
 1. The target URL does not advertise a Webmention endpoint.
 2. The request to the target URL raises an `HTTP::Error` or an `OpenSSL::SSL::SSLError`.
@@ -54,7 +53,8 @@ response.mime_type #=> String
 response.uri       #=> HTTP::URI
 ```
 
-💡 **Note:** `Webmention::Response` objects may return a variety of status codes that will vary depending on the endpoint's capabilities and the success or failure of the request. See [the Webmention spec](https://www.w3.org/TR/webmention/) for more on status codes on their implications. A `Webmention::Response` responding affirmatively to `ok?` _may_ also have a non-successful HTTP status code (e.g. `404 Not Found`).
+> [!NOTE]
+> `Webmention::Response` objects may return a variety of status codes that will vary depending on the endpoint's capabilities and the success or failure of the request. See [the Webmention spec](https://www.w3.org/TR/webmention/) for more on status codes on their implications. A `Webmention::Response` responding affirmatively to `ok?` _may_ also have a non-successful HTTP status code (e.g. `404 Not Found`).
 
 ## Sending multiple webmentions
 
@@ -93,7 +93,8 @@ urls = Webmention.mentioned_urls("https://jgarber.example/post/100")
 
 When parsing HTML documents, webmention-client-ruby will find the first [h-entry](https://microformats.org/wiki/h-entry) and search its markup for URLs. If no h-entry is found, the parser will search the document's `<body>`.
 
-💡 **Note:** Links pointing to the supplied URL (or those with internal fragment identifiers) will be rejected. You may wish to additionally filter the results returned by `Webmention.mentioned_urls` before sending webmentions.
+> [!NOTE]
+> Links pointing to the supplied URL (or those with internal fragment identifiers) will be rejected. You may wish to additionally filter the results returned by `Webmention.mentioned_urls` before sending webmentions.
 
 ## Verifying a webmention
 
@@ -141,13 +142,11 @@ verification.verify_vouch?
 verification.vouch_mentions_source?
 ```
 
-💡 **Note:** `Webmention.verify_webmention` parses HTML documents using the same rules outlined in [Discovering mentioned URLs](#discovering-mentioned-urls).
+> [!NOTE]
+> `Webmention.verify_webmention` parses HTML documents using the same rules outlined in [Discovering mentioned URLs](#discovering-mentioned-urls).
 
 ## 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.
+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.

data/lib/webmention/client.rb

@@ -9,10 +9,10 @@ module Webmention
       attr_reader :registered_parsers
     end
 
-    # @return [Webmention::Url]
+    # @return [Url]
     attr_reader :source_url
 
-    # @return [Webmention::Url]
+    # @return [Url]
     attr_reader :vouch_url
 
     # @api private
@@ -20,21 +20,19 @@ module Webmention
       klass.mime_types.each { |mime_type| @registered_parsers[mime_type] = klass }
     end
 
-    # Create a new Webmention::Client.
+    # Create a new {Client}.
     #
     # @example
-    #   Webmention::Client.new('https://jgarber.example/posts/100')
+    #   Webmention::Client.new("https://jgarber.example/posts/100")
     #
     # @example
-    #   Webmention::Client.new('https://jgarber.example/posts/100', vouch: 'https://tantek.example/notes/1')
+    #   Webmention::Client.new("https://jgarber.example/posts/100", vouch: "https://tantek.example/notes/1")
     #
     # @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.
-    #
-    # @return [Webmention::Client]
     def initialize(source, vouch: nil)
       @source_url = Url.new(source)
       @vouch_url = Url.new(vouch)
@@ -52,11 +50,11 @@ module Webmention
     # Retrieve unique URLs mentioned by this client's source URL.
     #
     # @example
-    #   client = Webmention::Client.new('https://jgarber.example/posts/100')
+    #   client = Webmention::Client.new("https://jgarber.example/posts/100")
     #   client.mentioned_urls
     #
     # @raise [NoMethodError]
-    #   Raised when response is a Webmention::ErrorResponse or response is of an
+    #   Raised when response is an {ErrorResponse} or response is of an
     #   unsupported MIME type.
     #
     # @return [Array<String>]
@@ -78,13 +76,13 @@ module Webmention
     # Send a webmention from this client's source URL to a target URL.
     #
     # @example
-    #   client = Webmention::Client.new('https://jgarber.example/posts/100')
-    #   client.send_webmention('https://aaronpk.example/notes/1')
+    #   client = Webmention::Client.new("https://jgarber.example/posts/100")
+    #   client.send_webmention("https://aaronpk.example/notes/1")
     #
     # @param target [String, HTTP::URI, #to_s]
     #   An absolute URL representing a target document.
     #
-    # @return [Webmention::Response, Webmention::ErrorResponse]
+    # @return [Response, ErrorResponse]
     def send_webmention(target)
       target_url = Url.new(target)
 
@@ -103,14 +101,14 @@ module Webmention
     # Send webmentions from this client's source URL to multiple target URLs.
     #
     # @example
-    #   client = Webmention::Client.new('https://jgarber.example/posts/100')
-    #   targets = ['https://aaronpk.example/notes/1', 'https://adactio.example/notes/1']
+    #   client = Webmention::Client.new("https://jgarber.example/posts/100")
+    #   targets = ["https://aaronpk.example/notes/1", "https://adactio.example/notes/1"]
     #   client.send_webmentions(targets)
     #
     # @param targets [Array<String, HTTP::URI, #to_s>]
     #   An array of absolute URLs representing multiple target documents.
     #
-    # @return [Array<Webmention::Response, Webmention::ErrorResponse>]
+    # @return [Array<Response, ErrorResponse>]
     def send_webmentions(*targets)
       targets.map { |target| send_webmention(target) }
     end
@@ -120,9 +118,9 @@ module Webmention
     # @param target [String, HTTP::URI, #to_s]
     #   An absolute URL representing a target document.
     #
-    # @raise (see Webmention::Client#mentioned_urls)
+    # @raise (see Client#mentioned_urls)
     #
-    # @return [Webmention::Verification]
+    # @return [Verification]
     def verify_webmention(target)
       Verification.new(source_url, Url.new(target), vouch_url: vouch_url)
     end
@@ -136,7 +134,7 @@ module Webmention
       opts = {
         source: source_url,
         target: target,
-        vouch: vouch_url
+        vouch: vouch_url,
       }
 
       opts.transform_values! { |value| value.to_s.strip }

data/lib/webmention/error_response.rb

@@ -5,20 +5,18 @@ module Webmention
     # @return [String]
     attr_reader :message
 
-    # @return [Webmention::Request]
+    # @return [Request]
     attr_reader :request
 
-    # Create a new Webmention::ErrorResponse.
+    # 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 <code>#message</code>
-    # instance method.
+    # endpoint. The nature of the error is captured in the {#message} instance
+    # method.
     #
     # @param message [String]
-    # @param request [Webmention::Request]
-    #
-    # @return [Webmention::ErrorResponse]
+    # @param request [Request]
     def initialize(message, request)
       @message = message
       @request = request

data/lib/webmention/parser.rb

@@ -3,7 +3,7 @@
 module Webmention
   # @api private
   class Parser
-    URI_REGEXP = URI::DEFAULT_PARSER.make_regexp(%w[http https]).freeze
+    URI_REGEXP = URI::DEFAULT_PARSER.make_regexp(["http", "https"]).freeze
 
     public_constant :URI_REGEXP
 

data/lib/webmention/parsers/html_parser.rb

@@ -9,17 +9,16 @@ module Webmention
       Client.register_parser(self)
 
       HTML_ATTRIBUTES_MAP = {
-        "cite" => %w[blockquote del ins q],
-        "data" => %w[object],
-        "href" => %w[a area],
-        "poster" => %w[video],
-        "src" => %w[audio embed img source track video],
-        "srcset" => %w[img source]
+        "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 do |attribute, names|
-        names.map { |name| "#{name}[#{attribute}]" }
-      end.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
 
@@ -62,7 +61,7 @@ module Webmention
 
       # @return [Array<Nokogiri::XML::Attr>]
       def url_attributes
-        url_nodes.flat_map(&:attribute_nodes).find_all { |attribute| HTML_ATTRIBUTES_MAP.key?(attribute.name) }
+        url_nodes.flat_map(&:attribute_nodes).select { |attribute| HTML_ATTRIBUTES_MAP.key?(attribute.name) }
       end
 
       # @return [Nokogiri::XML::NodeSet]

data/lib/webmention/parsers/plaintext_parser.rb

@@ -10,7 +10,7 @@ module Webmention
 
       # @return [Array<String>] An array of absolute URLs.
       def results
-        @results ||= URI::DEFAULT_PARSER.extract(response_body, %w[http https])
+        @results ||= URI::DEFAULT_PARSER.extract(response_body, ["http", "https"])
       end
     end
   end

data/lib/webmention/request.rb

@@ -2,20 +2,22 @@
 
 module Webmention
   class Request
-    # Defaults derived from Webmention specification examples.
+    # Set defaults derived from Webmention specification examples.
+    #
     # @see https://www.w3.org/TR/webmention/#limits-on-get-requests
+    #   W3C Webmention Recommendation § 4.2 Limits on GET requests
     HTTP_CLIENT_OPTS = {
       follow: {
-        max_hops: 20
+        max_hops: 20,
       },
       headers: {
         accept: "*/*",
-        user_agent: "Webmention Client (https://rubygems.org/gems/webmention)"
+        user_agent: "Webmention Client (https://rubygems.org/gems/webmention)",
       },
       timeout_options: {
         connect_timeout: 5,
-        read_timeout: 5
-      }
+        read_timeout: 5,
+      },
     }.freeze
 
     private_constant :HTTP_CLIENT_OPTS
@@ -32,11 +34,11 @@ module Webmention
     # Send an HTTP GET request to the supplied URL.
     #
     # @example
-    #   Request.get('https://jgarber.example/posts/100')
+    #   Webmention::Request.get("https://jgarber.example/posts/100")
     #
     # @param url [String]
     #
-    # @return [Webmention::Response, Webmention::ErrorResponse]
+    # @return [Response, ErrorResponse]
     def self.get(url)
       new(:get, url).perform
     end
@@ -44,11 +46,11 @@ module Webmention
     # Send an HTTP POST request with form-encoded data to the supplied URL.
     #
     # @example
-    #   Request.post(
-    #     'https://aaronpk.example/webmention',
-    #     source: 'https://jgarber.examples/posts/100',
-    #     target: 'https://aaronpk.example/notes/1',
-    #     vouch: 'https://tantek.example/notes/1'
+    #   Webmention::Request.post(
+    #     "https://aaronpk.example/webmention",
+    #     source: "https://jgarber.examples/posts/100",
+    #     target: "https://aaronpk.example/notes/1",
+    #     vouch: "https://tantek.example/notes/1"
     #   )
     #
     # @param url [String]
@@ -61,18 +63,16 @@ module Webmention
     #   An absolute URL representing a document vouching for the source document.
     #   See https://indieweb.org/Vouch for additional details.
     #
-    # @return [Webmention::Response, Webmention::ErrorResponse]
+    # @return [Response, ErrorResponse]
     def self.post(url, **options)
       new(:post, url, form: options.slice(:source, :target, :vouch)).perform
     end
 
-    # Create a new Webmention::Request.
+    # Create a new {Request}.
     #
     # @param method [Symbol]
     # @param url [String]
     # @param options [Hash{Symbol => String}]
-    #
-    # @return [Webmention::Request]
     def initialize(method, url, **options)
       @method = method.to_sym
       @uri = HTTP::URI.parse(url.to_s)
@@ -88,9 +88,9 @@ module Webmention
     end
     # :nocov:
 
-    # Submit the Webmention::Request.
+    # Submit the {Request}.
     #
-    # @return [Webmention::Response, Webmention::ErrorResponse]
+    # @return [Response, ErrorResponse]
     def perform
       Response.new(client.request(method, uri, options), self)
     rescue HTTP::Error, OpenSSL::SSL::SSLError => e
@@ -99,6 +99,7 @@ module Webmention
 
     private
 
+    # @return [HTTP::Client]
     def client
       @client ||= HTTP::Client.new(HTTP_CLIENT_OPTS)
     end

data/lib/webmention/response.rb

@@ -4,7 +4,7 @@ module Webmention
   class Response
     extend Forwardable
 
-    # @return [Webmention::Request]
+    # @return [Request]
     attr_reader :request
 
     # @!method
@@ -31,16 +31,14 @@ module Webmention
     #   @return [HTTP::URI]
     def_delegator :@response, :uri
 
-    # Create a new Webmention::Response.
+    # Create a new {Response}.
     #
     # Instances of this class represent completed HTTP requests, the details
-    # of which may be accessed using the delegated <code>#code</code> and
-    # <code>#reason</code>) instance methods.
+    # of which may be accessed using the delegated {#code} and {#reason}
+    # instance methods.
     #
     # @param response [HTTP::Response]
-    # @param request [Webmention::Request]
-    #
-    # @return [Webmention::Response]
+    # @param request [Request]
     def initialize(response, request)
       @response = response
       @request = request

data/lib/webmention/url.rb

@@ -11,11 +11,9 @@ module Webmention
     #   @return [String]
     def_delegator :uri, :to_s
 
-    # Create a new Webmention::Url.
+    # Create a new {Url}.
     #
     # @param url [String, HTTP::URI, #to_s] An absolute URL.
-    #
-    # @return [Webmention::Url]
     def initialize(url)
       @uri = HTTP::URI.parse(url.to_s)
     end
@@ -28,14 +26,14 @@ module Webmention
     end
     # :nocov:
 
-    # @return [Webmention::Response, Webmention::ErrorResponse]
+    # @return [Response, ErrorResponse]
     def response
       @response ||= Request.get(uri)
     end
 
     # @return [String, nil]
     def webmention_endpoint
-      @webmention_endpoint ||= IndieWeb::Endpoints::Parser.new(response).results[:webmention] if response.ok?
+      @webmention_endpoint ||= IndieWeb::Endpoints::Parser.new(response).to_h[:webmention] if response.ok?
     end
 
     # @return [Boolean]

data/lib/webmention/verification.rb

@@ -2,9 +2,15 @@
 
 module Webmention
   class Verification
-    # @param source_url [Webmention::Url]
-    # @param target_url [Webmention::Url]
-    # @param vouch_url [Webmention::Url]
+    # Create a new {Verification}.
+    #
+    # @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
@@ -46,27 +52,27 @@ module Webmention
 
     private
 
-    # @return [Webmention::Url]
+    # @return [Url]
     attr_reader :source_url
 
-    # @return [Webmention::Url]
+    # @return [Url]
     attr_reader :target_url
 
-    # @return [Webmention::Url]
+    # @return [Url]
     attr_reader :vouch_url
 
-    # @param response [Webmention::Response]
+    # @param response [Response]
     #
-    # @raise (see Webmention::Client#mentioned_urls)
+    # @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 [Webmention::Response]
+    # @param response [Response]
     #
-    # @raise (see Webmention::Client#mentioned_urls)
+    # @raise (see Client#mentioned_urls)
     #
     # @return [Array<String>]
     def mentioned_urls(response)

data/lib/webmention.rb

@@ -6,8 +6,6 @@ require "http"
 require "indieweb/endpoints"
 require "nokogiri"
 
-require_relative "webmention/version"
-
 require_relative "webmention/client"
 require_relative "webmention/url"
 require_relative "webmention/request"
@@ -24,12 +22,12 @@ module Webmention
   # Retrieve unique URLs mentioned by the provided URL.
   #
   # @example
-  #   Webmention.mentioned_urls('https://jgarber.example/posts/100')
+  #   Webmention.mentioned_urls("https://jgarber.example/posts/100")
   #
   # @param url [String, HTTP::URI, #to_s] An absolute URL.
   #
   # @raise [NoMethodError]
-  #   Raised when response is a Webmention::ErrorResponse or response is of an
+  #   Raised when response is an {ErrorResponse} or response is of an
   #   unsupported MIME type.
   #
   # @return [Array<String>]
@@ -40,14 +38,14 @@ module Webmention
   # Send a webmention from a source URL to a target URL.
   #
   # @example Send a webmention
-  #   source = 'https://jgarber.example/posts/100'
-  #   target = 'https://aaronpk.example/notes/1'
+  #   source = "https://jgarber.example/posts/100"
+  #   target = "https://aaronpk.example/notes/1"
   #   Webmention.send_webmention(source, target)
   #
   # @example Send a webmention with a vouch URL
-  #   source = 'https://jgarber.example/posts/100'
-  #   target = 'https://aaronpk.example/notes/1'
-  #   Webmention.send_webmention(source, target, vouch: 'https://tantek.example/notes/1')
+  #   source = "https://jgarber.example/posts/100"
+  #   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.
@@ -57,7 +55,7 @@ module Webmention
   #   An absolute URL representing a document vouching for the source document.
   #   See https://indieweb.org/Vouch for additional details.
   #
-  # @return [Webmention::Response, Webmention::ErrorResponse]
+  # @return [Response, ErrorResponse]
   def self.send_webmention(source, target, vouch: nil)
     Client.new(source, vouch: vouch).send_webmention(target)
   end
@@ -65,14 +63,14 @@ module Webmention
   # Send webmentions from a source URL to multiple target URLs.
   #
   # @example Send multiple webmentions
-  #   source = 'https://jgarber.example/posts/100'
-  #   targets = ['https://aaronpk.example/notes/1', 'https://adactio.example/notes/1']
+  #   source = "https://jgarber.example/posts/100"
+  #   targets = ["https://aaronpk.example/notes/1", "https://adactio.example/notes/1"]
   #   Webmention.send_webmentions(source, targets)
   #
   # @example Send multiple webmentions with a vouch URL
-  #   source = 'https://jgarber.example/posts/100'
-  #   targets = ['https://aaronpk.example/notes/1', 'https://adactio.example/notes/1']
-  #   Webmention.send_webmentions(source, targets, vouch: 'https://tantek.example/notes/1')
+  #   source = "https://jgarber.example/posts/100"
+  #   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.
@@ -82,7 +80,7 @@ module Webmention
   #   An absolute URL representing a document vouching for the source document.
   #   See https://indieweb.org/Vouch for additional details.
   #
-  # @return [Array<Webmention::Response, Webmention::ErrorResponse>]
+  # @return [Array<Response, ErrorResponse>]
   def self.send_webmentions(source, *targets, vouch: nil)
     Client.new(source, vouch: vouch).send_webmentions(*targets)
   end
@@ -91,7 +89,7 @@ module Webmention
   #
   # @param (see Webmention.send_webmention)
   #
-  # @raise (see Webmention::Client#mentioned_urls)
+  # @raise (see Client#mentioned_urls)
   #
   # @return [Boolean]
   def self.verify_webmention(source, target, vouch: nil)

data/webmention.gemspec

@@ -1,34 +1,34 @@
 # frozen_string_literal: true
 
-require_relative "lib/webmention/version"
-
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = ">= 3.0"
+  spec.required_ruby_version = ">= 2.7"
 
   spec.name = "webmention"
-  spec.version = Webmention::VERSION
+  spec.version = "9.0.0"
   spec.authors = ["Jason Garber"]
   spec.email = ["jason@sixtwothree.org"]
 
-  spec.summary = "Webmention notification client"
-  spec.description = "A Ruby gem for sending and verifying Webmention notifications."
+  spec.summary = "A Ruby gem for sending and verifying Webmention notifications."
+  spec.description = spec.summary
   spec.homepage = "https://github.com/indieweb/webmention-client-ruby"
   spec.license = "Apache-2.0"
 
   spec.files = Dir["lib/**/*"].reject { |f| File.directory?(f) }
-  spec.files += %w[LICENSE CHANGELOG.md CONTRIBUTING.md README.md USAGE.md]
-  spec.files += %w[webmention.gemspec]
+  spec.files += ["LICENSE", "CHANGELOG.md", "CONTRIBUTING.md", "README.md", "USAGE.md"]
+  spec.files += ["webmention.gemspec"]
 
   spec.require_paths = ["lib"]
 
   spec.metadata = {
     "bug_tracker_uri" => "#{spec.homepage}/issues",
     "changelog_uri" => "#{spec.homepage}/releases/tag/v#{spec.version}",
+    "documentation_uri" => "https://rubydoc.info/gems/#{spec.name}/#{spec.version}",
+    "homepage_uri" => spec.homepage,
     "rubygems_mfa_required" => "true",
-    "source_code_uri" => "#{spec.homepage}/tree/v#{spec.version}"
+    "source_code_uri" => "#{spec.homepage}/tree/v#{spec.version}",
   }
 
-  spec.add_runtime_dependency "http", "~> 5.2"
-  spec.add_runtime_dependency "indieweb-endpoints", "~> 9.0"
-  spec.add_runtime_dependency "nokogiri", ">= 1.16"
+  spec.add_dependency "http", "~> 5.3"
+  spec.add_dependency "indieweb-endpoints", "~> 10.0"
+  spec.add_dependency "nokogiri", ">= 1.14"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: webmention
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 9.0.0
 platform: ruby
 authors:
 - Jason Garber
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -16,42 +15,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.3'
 - !ruby/object:Gem::Dependency
   name: indieweb-endpoints
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '10.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.14'
 description: A Ruby gem for sending and verifying Webmention notifications.
 email:
 - jason@sixtwothree.org
@@ -75,17 +74,17 @@ files:
 - lib/webmention/response.rb
 - lib/webmention/url.rb
 - lib/webmention/verification.rb
-- lib/webmention/version.rb
 - webmention.gemspec
 homepage: https://github.com/indieweb/webmention-client-ruby
 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/v8.0.0
+  changelog_uri: https://github.com/indieweb/webmention-client-ruby/releases/tag/v9.0.0
+  documentation_uri: https://rubydoc.info/gems/webmention/9.0.0
+  homepage_uri: https://github.com/indieweb/webmention-client-ruby
   rubygems_mfa_required: 'true'
-  source_code_uri: https://github.com/indieweb/webmention-client-ruby/tree/v8.0.0
-post_install_message: 
+  source_code_uri: https://github.com/indieweb/webmention-client-ruby/tree/v9.0.0
 rdoc_options: []
 require_paths:
 - lib
@@ -93,15 +92,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
-summary: Webmention notification client
+summary: A Ruby gem for sending and verifying Webmention notifications.
 test_files: []

data/lib/webmention/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module Webmention
-  VERSION = "8.0.0"
-end