{"id":15512276,"url":"https://github.com/indieweb/webmention-client-ruby","last_synced_at":"2025-04-09T16:14:06.695Z","repository":{"id":44669634,"uuid":"11133470","full_name":"indieweb/webmention-client-ruby","owner":"indieweb","description":"A Ruby gem for sending and verifying Webmention notifications.","archived":false,"fork":false,"pushed_at":"2025-04-02T00:32:17.000Z","size":325,"stargazers_count":74,"open_issues_count":0,"forks_count":9,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-04-09T16:13:58.440Z","etag":null,"topics":["indieweb","notifications","ruby","rubygems","webmention"],"latest_commit_sha":null,"homepage":"https://rubygems.org/gems/webmention","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/indieweb.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2013-07-02T19:43:20.000Z","updated_at":"2025-04-02T00:32:21.000Z","dependencies_parsed_at":"2024-03-22T08:05:20.849Z","dependency_job_id":"5ece41f6-4869-40ae-a010-f9bc1762684e","html_url":"https://github.com/indieweb/webmention-client-ruby","commit_stats":{"total_commits":326,"total_committers":6,"mean_commits":"54.333333333333336","dds":"0.14723926380368102","last_synced_commit":"a7586b6ece111cc9fe931fa01e8f730651dfda19"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indieweb%2Fwebmention-client-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indieweb%2Fwebmention-client-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indieweb%2Fwebmention-client-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indieweb%2Fwebmention-client-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/indieweb","download_url":"https://codeload.github.com/indieweb/webmention-client-ruby/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248065282,"owners_count":21041872,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["indieweb","notifications","ruby","rubygems","webmention"],"created_at":"2024-10-02T09:53:33.905Z","updated_at":"2025-04-09T16:14:06.668Z","avatar_url":"https://github.com/indieweb.png","language":"Ruby","readme":"# webmention-client-ruby\n\n**A Ruby gem for sending and verifying [Webmention](https://indieweb.org/Webmention) notifications.**\n\n[![Gem](https://img.shields.io/gem/v/webmention.svg?logo=rubygems\u0026style=for-the-badge)](https://rubygems.org/gems/webmention)\n[![Downloads](https://img.shields.io/gem/dt/webmention.svg?logo=rubygems\u0026style=for-the-badge)](https://rubygems.org/gems/webmention)\n[![Build](https://img.shields.io/github/actions/workflow/status/indieweb/webmention-client-ruby/ci.yml?branch=main\u0026logo=github\u0026style=for-the-badge)](https://github.com/indieweb/webmention-client-ruby/actions/workflows/ci.yml)\n\n## Key Features\n\n- Crawl a URL for mentioned URLs.\n- Perform [endpoint discovery](https://www.w3.org/TR/webmention/#sender-discovers-receiver-webmention-endpoint) on mentioned URLs.\n- Send webmentions to one or more mentioned URLs (and optionally include a [vouch](https://indieweb.org/Vouch) URL).\n- 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).\n\n## Getting Started\n\nBefore 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.\n\nwebmention-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).\n\n## Installation\n\nAdd webmention-client-ruby to your project's `Gemfile` and run `bundle install`:\n\n```ruby\nsource \"https://rubygems.org\"\n\ngem \"webmention\"\n```\n\n## Usage\n\nSee [USAGE.md](https://github.com/indieweb/webmention-client-ruby/blob/main/USAGE.md) for documentation of webmention-client-ruby's features.\n\n## Migrating to version 6\n\nwebmention-client-ruby was completely rewritten for version 6 to better support new features and future development. Some notes on migrating to the new version:\n\n♻️ **Renamed:** for clarity and consistency, the `Webmention.send_mention` method has been renamed `Webmention.send_webmention`. Both methods use the same interface.\n\n❌ **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.\n\n❌ **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.\n\n🛠 **Refactored:** Exception handling has been greatly improved [as noted above](#exception-handling).\n\n## Contributing\n\nSee [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!\n\nBy 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).\n\n## Acknowledgments\n\nwebmention-client-ruby is written and maintained by [Jason Garber](https://sixtwothree.org) ([@jgarber623](https://github.com/jgarber623)) with help from [these additional contributors](https://github.com/indieweb/webmention-client-ruby/graphs/contributors). Prior to 2018, webmention-client-ruby was written and maintained by [Aaron Parecki](https://aaronparecki.com) ([@aaronpk](https://github.com/aaronpk)) and [Nat Welch](https://natwelch.com) ([@icco](https://github.com/icco)).\n\nTo learn more about Webmention, see [indieweb.org/Webmention](https://indieweb.org/Webmention) and [webmention.net](https://webmention.net).\n\n## License\n\nwebmention-client-ruby is freely available under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html). See [LICENSE](https://github.com/indieweb/webmention-client-ruby/blob/main/LICENSE) for more details.\n","funding_links":[],"categories":["Ruby"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Findieweb%2Fwebmention-client-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Findieweb%2Fwebmention-client-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Findieweb%2Fwebmention-client-ruby/lists"}