{"id":21191674,"url":"https://github.com/indieweb/indieweb-endpoints-ruby","last_synced_at":"2025-07-10T03:30:49.732Z","repository":{"id":56877556,"uuid":"183339402","full_name":"indieweb/indieweb-endpoints-ruby","owner":"indieweb","description":"A Ruby gem for discovering a URL's IndieAuth, Micropub, Microsub, and Webmention endpoints.","archived":false,"fork":false,"pushed_at":"2024-03-16T14:35:35.000Z","size":230,"stargazers_count":19,"open_issues_count":0,"forks_count":2,"subscribers_count":10,"default_branch":"main","last_synced_at":"2024-10-29T20:22:35.267Z","etag":null,"topics":["indieauth","indieweb","micropub","microsub","ruby","rubygems","webmention"],"latest_commit_sha":null,"homepage":"https://rubygems.org/gems/indieweb-endpoints","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","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":"2019-04-25T02:16:17.000Z","updated_at":"2024-06-02T14:44:17.000Z","dependencies_parsed_at":"2023-10-12T07:13:53.947Z","dependency_job_id":"3bd12b58-4c03-4307-9423-e1193cdaa8b7","html_url":"https://github.com/indieweb/indieweb-endpoints-ruby","commit_stats":{"total_commits":224,"total_committers":3,"mean_commits":74.66666666666667,"dds":"0.013392857142857095","last_synced_commit":"8722dc7a9e11f27ac2ff52f6ab0c99dca5bce9e9"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indieweb%2Findieweb-endpoints-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indieweb%2Findieweb-endpoints-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indieweb%2Findieweb-endpoints-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/indieweb%2Findieweb-endpoints-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/indieweb","download_url":"https://codeload.github.com/indieweb/indieweb-endpoints-ruby/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225313441,"owners_count":17454733,"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":["indieauth","indieweb","micropub","microsub","ruby","rubygems","webmention"],"created_at":"2024-11-20T19:04:24.157Z","updated_at":"2025-07-10T03:30:49.725Z","avatar_url":"https://github.com/indieweb.png","language":"Ruby","readme":"# indieweb-endpoints-ruby\n\n**A Ruby gem for discovering a URL's [IndieAuth](https://indieweb.org/IndieAuth), [Micropub](https://indieweb.org/Micropub), [Microsub](https://indieweb.org/Microsub), and [Webmention](https://indieweb.org/Webmention) endpoints.**\n\n[![Gem](https://img.shields.io/gem/v/indieweb-endpoints.svg?logo=rubygems\u0026style=for-the-badge)](https://rubygems.org/gems/indieweb-endpoints)\n[![Downloads](https://img.shields.io/gem/dt/indieweb-endpoints.svg?logo=rubygems\u0026style=for-the-badge)](https://rubygems.org/gems/indieweb-endpoints)\n[![Build](https://img.shields.io/github/actions/workflow/status/indieweb/indieweb-endpoints-ruby/ci.yml?branch=main\u0026logo=github\u0026style=for-the-badge)](https://github.com/indieweb/indieweb-endpoints-ruby/actions/workflows/ci.yml)\n\n## Key Features\n\n- Compliant with [Section 4.1](https://www.w3.org/TR/indieauth/#discovery-by-clients) and [Section 4.2.2](https://www.w3.org/TR/indieauth/#redirect-url) of [the W3C's IndieAuth Working Group Note](https://www.w3.org/TR/indieauth/), [Section 5.3](https://www.w3.org/TR/micropub/#endpoint-discovery) of [the W3C's Micropub Recommendation](https://www.w3.org/TR/micropub/), and [Section 3.1.2](https://www.w3.org/TR/webmention/#sender-discovers-receiver-webmention-endpoint) of [the W3C's Webmention Recommendation](https://www.w3.org/TR/webmention/).\n- Passes all Endpoint Discovery tests on [webmention.rocks](https://webmention.rocks).\n- Supports Ruby 2.7 and newer.\n\n## Getting Started\n\nBefore installing and using indieweb-endpoints-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.\n\nindieweb-endpoints-ruby is developed using Ruby 3.4 and is tested against additional Ruby versions using [GitHub Actions](https://github.com/indieweb/indieweb-endpoints-ruby/actions).\n\n## Installation\n\nAdd indieweb-endpoints-ruby to your project's `Gemfile` and run `bundle install`:\n\n```ruby\nsource \"https://rubygems.org\"\n\ngem \"indieweb-endpoints\"\n```\n\n## Usage\n\n### Basic Usage\n\nWith indieweb-endpoints-ruby added to your project's `Gemfile` and installed, you may discover a URL's IndieWeb-relevant endpoints by doing:\n\n```ruby\nrequire \"indieweb/endpoints\"\n\nIndieWeb::Endpoints.get(\"https://aaronparecki.com\")\n#=\u003e { authorization_endpoint: \"https://aaronparecki.com/auth\", \"indieauth-metadata\": \"https://aaronparecki.com/.well-known/oauth-authorization-server\", micropub: \"https://aaronparecki.com/micropub\", microsub: \"https://aperture.p3k.io/microsub/1\", redirect_uri: nil, token_endpoint: \"https://aaronparecki.com/auth/token\", webmention: \"https://webmention.io/aaronpk/webmention\" }\n```\n\nThis example will search [Aaron's website](https://aaronparecki.com) for valid IndieAuth, Micropub, and Webmention endpoints and return a `Hash` of results. Each key in the returned `Hash` will have a value of either a `String` representing a URL or `nil`. The `redirect_uri` key's value will be either an `Array` or `nil` since a given URL may register multiple callback URLs.\n\n### Advanced Usage\n\nShould the need arise, you may work with the `IndieWeb::Endpoints::Client` class:\n\n```ruby\nrequire \"indieweb/endpoints\"\n\nclient = IndieWeb::Endpoints::Client.new(\"https://aaronparecki.com\")\n#=\u003e #\u003cIndieWeb::Endpoints::Client uri: \"https://aaronparecki.com\"\u003e\n\nclient.response\n#=\u003e #\u003cHTTP::Response/1.1 200 OK {…}\u003e\n\nclient.endpoints\n#=\u003e { authorization_endpoint: \"https://aaronparecki.com/auth\", micropub: \"https://aaronparecki.com/micropub\", microsub: \"https://aperture.p3k.io/microsub/1\", redirect_uri: nil, token_endpoint: \"https://aaronparecki.com/auth/token\", webmention: \"https://webmention.io/aaronpk/webmention\" }\n```\n\n### Exception Handling\n\nindieweb-endpoints-ruby may raise the following exceptions which are subclasses of `IndieWeb::Endpoints::Error` (which itself is a subclass of `StandardError`).\n\n- `IndieWeb::Endpoints::InvalidURIError`\n- `IndieWeb::Endpoints::HttpError`\n- `IndieWeb::Endpoints::SSLError`\n\n## Contributing\n\nSee [CONTRIBUTING.md](https://github.com/indieweb/indieweb-endpoints-ruby/blob/main/CONTRIBUTING.md) for more on how to contribute to indieweb-endpoints-ruby. Your help is greatly appreciated!\n\nBy contributing to and participating in the development of indieweb-endpoints-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\nindieweb-endpoints-ruby wouldn't exist without IndieAuth, Micropub, and Webmention and the hard work put in by everyone involved in the [IndieWeb](https://indieweb.org) movement. Additionally, the comprehensive Webmention Endpoint Discovery test suite at [webmention.rocks](https://webmention.rocks) was invaluable in the development of this Ruby gem.\n\nindieweb-endpoints-ruby is written and maintained by [Jason Garber](https://sixtwothree.org).\n\n## License\n\nindieweb-endpoints-ruby is freely available under the [MIT License](https://opensource.org/licenses/MIT).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Findieweb%2Findieweb-endpoints-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Findieweb%2Findieweb-endpoints-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Findieweb%2Findieweb-endpoints-ruby/lists"}