Permalink
Please sign in to comment.
Showing
with
114 additions
and 0 deletions.
| @@ -0,0 +1,114 @@ | ||
| +# webmention.io | ||
| + | ||
| +Implementation Home Page URL: https://webmention.io | ||
| + | ||
| +Source Code repo URL(s) (optional): | ||
| +* [x] 100% open source implementation | ||
| + | ||
| +Programming Language(s): Ruby | ||
| + | ||
| +Developer(s): [Aaron Parecki](https://aaronparecki.com) | ||
| + | ||
| +Implementation Classes (Sender and/or Receiver): Receiver | ||
| + | ||
| +## Implementation Notes | ||
| + | ||
| +Webmention.io is a Webmention and Pingback receiver, but does not display webmentions itself. It makes webmentions available via an API, and can also send a web hook to the website using it. | ||
| + | ||
| +## Receiving | ||
| + | ||
| +Indicate which type of response the receiver provides: | ||
| + | ||
| +* [ ] HTTP 200 - Receiver synchronously processes the Webmention request (not recommended) | ||
| +* [x] HTTP 201 - Receiver creates a status URL the sender can use to check the status of the Webmention | ||
| +* [ ] HTTP 202 - Receiver processes the Webmention asynchronously | ||
| + | ||
| +Describe the response body (if any) which is returned in the request: | ||
| + | ||
| + | ||
| +### Request Verification (3.2.1) | ||
| + | ||
| +* [x] Verifies source and target are valid URLs, rejecting with HTTP 400 (MUST) | ||
| +* [ ] Verifies that target is a valid resource for which the receiver accepts Webmentions, rejecting with HTTP 400 (SHOULD) | ||
| + * the endpoint accepts webmentions for any URL | ||
| +* [ ] Ignores fragment when checking if target is supported (SHOULD) | ||
| + | ||
| +### Webmention Verification (3.2.2) | ||
| + | ||
| +* [x] Verification is processed asynchronously (SHOULD) | ||
| +* [x] Follows at least one HTTP redirect on source URL (MUST) | ||
| +* [x] Respects a self-imposed limit on number of HTTP redirects to follow (MUST) | ||
| + | ||
| +#### Source URL content-types supported | ||
| + | ||
| +Please list the content types that your implementation supports when checking if the source document links to the target URL. | ||
| + | ||
| +* [x] HTML | ||
| +* [ ] Other: ______ | ||
| + | ||
| + | ||
| +### HTML Verification (3.2.2) | ||
| + | ||
| +The tests below apply when the source document is HTML. | ||
| + | ||
| +* [x] Accepts a Webmention where the target URL is in an `<a>` tag | ||
| +* [ ] Accepts a Webmention where the target URL is in an `<img>` tag | ||
| +* [ ] Accepts a Webmention where the target URL is in an `<video>` tag | ||
| +* [ ] Accepts a Webmention where the target URL is in an `<audio>` tag | ||
| +* [x] Rejects a Webmention where the target URL is in the document as text | ||
| +* [x] Rejects a Webmention where the target URL is in an `<a>` tag inside an HTML comment | ||
| +* [x] Rejects a Webmention where the target URL is not in the document | ||
| + | ||
| + | ||
| +### Webmention Display/Use | ||
| + | ||
| +* [ ] The receiver displays data from the source URL on the target post (MAY) | ||
| + | ||
| +* [x] The receiver recognizes that the source URL is a "comment" or "reply" to the post | ||
| + * [x] using HTML markup: `class="u-in-reply-to"` | ||
| +* [x] The receiver recognizes that the source URL is a "like" of the post | ||
| + * [x] using HTML markup: `class="u-like-of"` | ||
| +* [x] The receiver recognizes that the source URL is a "repost" of the post | ||
| + * [x] using HTML markup: `class="u-repost-of"` | ||
| +* [x] The receiver recognizes that the source URL is an "RSVP" to the post | ||
| + * [x] using HTML markup: `class="p-rsvp"` | ||
| +* [ ] The receiver recognizes additional response types, using markup: | ||
| + * [ ] Response: __________ using HTML markup: __________ | ||
| + * (Please add lines like above for additional response types the receiver has implemented) | ||
| + | ||
| +Please describe any other ways the Webmention is displayed or used if applicable. | ||
| + | ||
| +The endpoint stores the content found at the source and makes it available through an API. | ||
| + | ||
| + | ||
| +### Update Tests (3.2.4) | ||
| + | ||
| +* [x] Does not display an update Webmention as a new response (SHOULD) | ||
| +* [ ] Removes the response when an update Webmention is sent and the source URL returns 200 and no link is found (SHOULD) | ||
| +* [x] Updates and stores the information from the primary object at the source URL (MUST) | ||
| +* [ ] Updates and stores the information from children or descendant objects at the source URL (MAY) | ||
| + | ||
| + | ||
| +### Delete Tests (3.2.4) | ||
| + | ||
| +* [ ] Recognizes an HTTP 410 response as a delete, and removes the response (SHOULD) | ||
| + | ||
| + | ||
| +### Security Considerations (4) | ||
| + | ||
| +* [ ] Webmentions are moderated before being displayed (MAY) | ||
| +* [ ] Webmentions are periodically re-verified (MAY) | ||
| +* [x] The receiver ensures any displayed data it properly encoded/filtered to prevent XSS attacks (MUST) | ||
| +* [x] Respects a self-imposed limit on the time spent fetching the source URL (SHOULD) | ||
| +* [ ] Respects a self-imposed limit on the number of bytes fetched from the source URL (SHOULD) | ||
| +* [ ] The receiver accepts additional parameters or headers, and so has CSRF protection (SHOULD) | ||
| + | ||
| + | ||
| +### Extensions | ||
| + | ||
| +This implementation has also implemented the following extensions. | ||
| + | ||
| +* [ ] [Salmention](http://indiewebcamp.com/Salmention) | ||
| +* [ ] [Vouch](http://indiewebcamp.com/Vouch) | ||
| +* [ ] Other: _______ | ||
| + |
0 comments on commit
a0cc913