webmention-client-ruby

A Ruby gem for sending and verifying Webmention notifications.

• Crawl a URL for mentioned URLs.
• Perform endpoint discovery on mentioned URLs.
• Send webmentions to one or more mentioned URLs (and optionally include a 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.

Before installing and using webmention-client-ruby, you'll want to have Ruby 2.7 (or newer) installed. Using a Ruby version managment tool like rbenv, chruby, or rvm is recommended.

webmention-client-ruby is developed using Ruby 3.4 and is tested against additional Ruby versions using GitHub Actions.

Add webmention-client-ruby to your project's Gemfile and run bundle install:

source "https://rubygems.org"

gem "webmention"

See USAGE.md for documentation of webmention-client-ruby's features.

See 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.

webmention-client-ruby is written and maintained by Jason Garber (@jgarber623) with help from these additional contributors. Prior to 2018, webmention-client-ruby was written and maintained by Aaron Parecki (@aaronpk) and Nat Welch (@icco).

To learn more about Webmention, see indieweb.org/Webmention and webmention.net.

webmention-client-ruby is freely available under the Apache License 2.0. See LICENSE for more details.