fu: Close-up of Fu, bringing a scoop of water to her mouth (Default)
fu ([staff profile] fu) wrote2011-01-11 12:54 am

Supporting Atom Publishing Protocol

I've been working on updating our implementation of the Atom Publishing Protocol for Bug 852, and I have a patch up there now.

Have several longish comments, but the short version is that our implementation was old to the point where I don't think any clients could use it, so I have felt free to break the old URLs while updating our implementation.

That is, I've removed support for:
http://www.dreamwidth.org/interface/atomapi/username/* (completely broken;
username had no effect on which journal the interface would use)
http://www.dreamwidth.org/interface/atom/feed
http://www.dreamwidth.org/interface/atom/post
http://www.dreamwidth.org/interface/atom/...

And I've implemented a new interface:

http://www.dreamwidth.org/interface/atom
GET: service document / used to discover the APP URLs we provide

http://www.dreamwidth.org/interface/entries
GET : lists the entries
POST: makes a new entry

http://www.dreamwidth.org/interface/entries/tags
GET: lists the journal's tags

http://www.dreamwidth.org/interface/entries/123
GET: retrieves entry 123
PUT: edits entry 123
DELETE: deletes entry 123


Does anyone have any concrete reasons I shouldn't push forward with this?

Also, any suggestions for how / whether to support posting to communities? What URL should we use? :-)
matgb: Artwork of 19th century upper class anarchist, text: MatGB (Default)

[personal profile] matgb 2011-01-10 05:05 pm (UTC)(link)
Second set of URLs has some broken code , I think it's a missing " in the cut text.

Definitely need to support posting to comms, but client protocol stuff is completely beyond me (trying to learn it though, in the process of updating Delicious Glue, simple enough for a newbie to get working, only, well, I can't do anything beyond the basics). Essentially, if a client won't let me post to a comm, it's not a client I can use. And I'm not a heavy Comm user.
matgb: Artwork of 19th century upper class anarchist, text: MatGB (Default)

[personal profile] matgb 2011-01-10 05:21 pm (UTC)(link)
I would say the latter two work to be consistent, the former might be a good shortcut, but could be confusing, especially for client authors that aren't normally DW users?

On most other platforms that I know of, username and blogname are always separate, so having a shortcut for people posting to just their journal may confuse those used to those standards.

But, given my complete lack of knowledge of this field, I don't know.
matgb: Artwork of 19th century upper class anarchist, text: MatGB (Default)

[personal profile] matgb 2011-01-10 05:40 pm (UTC)(link)
Thought occurs. Why not put them on the subdomains themselves?

matgb.dreamwidth.org/interface/atom/entries

Is that possible or would it require too much duplication/redirecting?

Or does ATOM include auto detection in some way? I'm partially thinking mid term, if/when we get domain mapping setup, there will be some that'll make their setup appear completely separate from DW.
mark: A photo of Mark kneeling on top of the Taal Volcano in the Philippines. It was a long hike. (Default)

[staff profile] mark 2011-01-12 06:55 am (UTC)(link)
I am 100% for "username.dreamwidth.org/interface/atom" ... that's what we use for everything else, right?
allen: (wetkitten)

[personal profile] allen 2011-01-10 10:21 pm (UTC)(link)
Just so you know, the completely out of date Atom implementation is why bug 2296 drove me crazy enough to have to take a break from DW coding. So thanks for tackling this.
sophie: A cartoon-like representation of a girl standing on a hill, with brown hair, blue eyes, a flowery top, and blue skirt. ☀ (Default)

[personal profile] sophie 2011-01-10 11:38 pm (UTC)(link)
Will the Dreamhack machine need any updates for this? I noticed that you were talking about an outdated version of XML::Atom in the bug.
whump: QR code for "http://whump.dreamwidth.org/" (Default)

[personal profile] whump 2011-01-12 09:11 am (UTC)(link)
Hi, I've been underwater lately and had not had time to follow up.

First, thank you for taking on this ticket!

Second, what do you need from me on testing?
pauamma: Cartooney crab holding drink (Default)

[personal profile] pauamma 2011-01-20 11:19 pm (UTC)(link)
If using user-domain URLs for the service document, the username would have to be "who I'm posting *as*", since the document lets the client know what they can post *to*. Thus, the username would be redundant with the authentication credentials and would also require configuring per-account service documents (even if you only have one account, you can't rely on the client knowing out of the box that the service document for Dreamwidth is http://www.dreamwidth.org/mumble - you have to tell it the URL of the service document for post-as account "pauamma"). When you add people with multiple accounts, it only gets more tedious. So I would use www. for the service document.

Now the collections listed in the service document can have user-domain URLs - and in fact should, because they're just an Atom feed for the collection, just like the one used for syndication. But what the exact URLs shouldn't matter IMO, because a conformant client would just get them by retrieving the servce document, and not by using any programmed-in notion of what the collection URLs (and resource URLs) for Dreamwidth (Or any DW clone, or LJ clone) would look like. In fact, there's no reason to believe that they will remain unchanged as time goes on...

Another point worth keeping in mind for the future: the APP lets clients create media resources (which could conceivably be icons or pictures in whchever photo album thingy ends up having, or collections of links, for DW's memories/favorites/whatever feature). However, it also allows in-place modification, which requires a stable-across-revisions URLs. This doesn't fit the current URL scheme for icons (or the LJ/ScrapbookURL scheme for pictures), and any use of the APP for those features would have to deal with that.
pauamma: Cartooney crab holding drink (Default)

[personal profile] pauamma 2011-01-21 03:24 pm (UTC)(link)
Basically, yes.
pauamma: Cartooney crab holding drink (Default)

[personal profile] pauamma 2011-01-21 03:32 pm (UTC)(link)
I would favor the latter approach. In addition to making it easier for clients to have a "post entry to" dropdown like the web update page does, it would allow future extensions to add "community userpics" as a collection for each comm the user miantains.

[personal profile] faithofone 2011-01-27 03:33 am (UTC)(link)
Please forgive me if this comment makes no sense, I'm completely uneducated about how the whole atom thing works.

Right now, I'm using the atom api with Loudtwitter to post my twitter digests. The URL that I'm using is http://www.dreamwidth.org/interface/atom/post

If you're removing that URL, it'll break my twitter syndication, and it would be sad making.

[personal profile] faithofone 2011-01-30 06:37 pm (UTC)(link)
No need to be sorry about taking a few days, we all do that occasionally. Thank you for taking the time to reply. I appreciate your work to ensure that I can still spam my friends with tweets.