Skip to content

Commit

Permalink
update screech report w/ micropub.rocks results
Browse files Browse the repository at this point in the history
  • Loading branch information
martymcguire committed Mar 21, 2017
1 parent 12099de commit d4d6a52
Showing 1 changed file with 44 additions and 40 deletions.
84 changes: 44 additions & 40 deletions implementation-reports/screech.md
Expand Up @@ -10,8 +10,8 @@ Programming Language(s): Python, JavaScript
Developer(s): [Name](https://martymcgui.re)

Answers are:
* [ ] Confirmed via micropub.rocks
* [x] Self-reported
* [x] Confirmed via micropub.rocks
* [ ] Self-reported

## Discovery
* [x] The client discovers the Micropub endpoint given the profile URL of a user (e.g. the sign-in form asks the user to enter their URL, which is used to find the Micropub endpoint)
Expand All @@ -20,46 +20,48 @@ Answers are:
* [x] The client sends the access token in the HTTP `Authorization` header.
* [ ] The client sends the access token in the post body for `x-www-form-urlencoded` requests.
* [x] The client requests one or more `scope` values when obtaining user authorization.
* post
* create

## Syntax
* [x] Creates posts using `x-www-form-urlencoded` syntax.
* [ ] Creates posts using JSON syntax.
* [x] Creates posts using `x-www-form-urlencoded` syntax with multiple values of the same property name (e.g. tags).
* [ ] Creates posts using JSON syntax with multiple values of the same property name (e.g. tags).
* [ ] Creates posts using JSON syntax including a nested Microformats2 object.
* [x] Creates posts including a file by sending the request as `multipart/form-data` to the Micropub endpoint.
* [x] 100: Creates posts using `x-www-form-urlencoded` syntax.
* [ ] 200: Creates posts using JSON syntax.
* [x] 101: Creates posts using `x-www-form-urlencoded` syntax with multiple values of the same property name (e.g. tags).
* [ ] 201: Creates posts using JSON syntax with multiple values of the same property name (e.g. tags).
* [ ] 202: Creates posts with HTML content. (JSON)
* [ ] 204: Creates posts using JSON syntax including a nested Microformats2 object.
* [ ] 300: Creates posts including a file by sending the request as `multipart/form-data` to the Micropub endpoint.

## Creating Posts
* [ ] Allows creating posts with a photo referenced by URL rather than uploading the photo as a Multipart request.
* [ ] Allows creating posts with a photo including image alt text.
* [ ] Recognizes HTTP 201 and 202 with a `Location` header as a successful response from the Micropub endpoint.
* [ ] Allows the user to specify one or more syndication endpoints from their list of endpoints discovered in the `q=config` or `q=syndicate-to` query.
* [ ] 104: Allows creating posts with a photo referenced by URL rather than uploading the photo as a Multipart request. (form-encoded)
* [ ] 203: Allows creating posts with a photo referenced by URL rather than uploading the photo as a Multipart request. (JSON)
* [ ] 205: Allows creating posts with a photo including image alt text.
* [x] Recognizes HTTP 201 and 202 with a `Location` header as a successful response from the Micropub endpoint.
* [ ] 105: Allows the user to specify one or more syndication endpoints from their list of endpoints discovered in the `q=config` or `q=syndicate-to` query.

## Media Endpoint
* [ ] Checks to see if the Micropub endpoint specifies a Media Endpoint, and uploads photos there instead.
* [ ] 700: Checks to see if the Micropub endpoint specifies a Media Endpoint, and uploads photos there instead.
* [ ] Uses multipart requests only as a fallback when there is no Media Endpoint specified.

## Updates
* [ ] Supports replacing all values of a property (e.g. replacing the post content).
* [ ] Supports adding a value to a property (e.g. adding a tag).
* [ ] Supports removing a value from a property (e.g. removing a specific tag).
* [ ] Supports removing a property.
* [ ] 400: Supports replacing all values of a property (e.g. replacing the post content).
* [ ] 401: Supports adding a value to a property (e.g. adding a tag).
* [ ] 402: Supports removing a value from a property (e.g. removing a specific tag).
* [ ] 403: Supports removing a property.
* [ ] Recognizes HTTP 200, 201 and 204 as a successful response from the Micropub endpoint.

## Deletes
* [ ] Sends deletion requests using `x-www-form-urlencoded` syntax.
* [ ] Sends deletion requests using JSON syntax.
* [ ] Sends undeletion requests using `x-www-form-urlencoded` syntax.
* [ ] Sends undeletion requests using JSON syntax.
* [ ] 500: Sends deletion requests using `x-www-form-urlencoded` syntax.
* [ ] 500: Sends deletion requests using JSON syntax.
* [ ] 502: Sends undeletion requests using `x-www-form-urlencoded` syntax.
* [ ] 502: Sends undeletion requests using JSON syntax.

## Querying
* [x] Queries the Micropub endpoint with `q=config`
* [x] Looks in the response for the Media Endpoint
* [ ] Looks in the response for syndication targets
* [ ] Queries the Micropub endpoint with `q=syndicate-to`
* [ ] Queries the Micropub endpoint for a post's source content without specifying a list of properties
* [ ] Queries the Micropub endpoint for a post's source content looking only for specific properties
* [x] 600: Queries the Micropub endpoint with `q=config`
* [x] Looks in the response for the Media Endpoint
* [ ] Looks in the response for syndication targets
* [ ] 601: Queries the Micropub endpoint with `q=syndicate-to`
* [ ] 602: Queries the Micropub endpoint for a post's source content without specifying a list of properties
* [ ] 603: Queries the Micropub endpoint for a post's source content looking only for specific properties

## Extensions

Expand All @@ -72,19 +74,21 @@ None.
Please list all vocabularies and properties the client supports, if applicable.

* h-entry
* audio
* name
* content (text)
* category[]
* slug
* additional properties computed from the id3 or other metadata in the uploaded audio file:
* id3-duration (seconds)
* id3-enclosure-length (file size in bytes)
* id3-artist (artist name)
* id3-album (album name)
* id3-title (track title)
* id3-track (track number)
* audio
* name
* content (text)
* category[]
* slug
* additional properties computed from the id3 or other metadata in the uploaded audio file:
* id3-duration (seconds)
* id3-enclosure-length (file size in bytes)
* id3-artist (artist name)
* id3-album (album name)
* id3-title (track title)
* id3-track (track number)

## Other Notes

micropub.rocks test for file uploads expect `photo`, but screech supports `audio`. Therefore, I would say that Screech passes "300: Creates posts including a file by sending the request as `multipart/form-data` to the Micropub endpoint.", but cannot verify this with the micropub.rocks tests

Media endpoint query is supported but media endpoint uploads are not yet implemented.

0 comments on commit d4d6a52

Please sign in to comment.