SoC webservices revisited - Revision history

Dirk: added a link to Webservices API/Media page

2009-05-16T18:01:17Z

added a link to Webservices API/Media page

Dirk: list student / mentor on the top of the page

2009-05-15T19:01:17Z

list student / mentor on the top of the page

Choplair: pre-SoC / present work content seperation

2009-05-09T17:24:17Z

pre-SoC / present work content seperation

Dirk: Updated note about editable comments

2009-02-05T14:55:23Z

Updated note about editable comments

Dirk at 10:07, 3 March 2008

2008-03-03T10:07:04Z

Dirk: Further Reading

2008-02-26T19:24:15Z

Dirk: Fixed link to the 2008 version of the comment proposal

2008-02-24T11:22:28Z

Fixed link to the 2008 version of the comment proposal

Dirk: Submissions should be available for plugins, too

2008-01-13T15:34:22Z

Submissions should be available for plugins, too

Dirk: SoC: Webservices revisited

2008-01-13T13:19:02Z

SoC: Webservices revisited

New page

<center>(This is an idea page for the [[Google Summer of Code]])</center>

== Incentive ==

As part of the 2007 Summer of Code, a webservices API has been [[SoC_webservices_publishing|implemented]] in Geeklog. It provides the basic framework (RESTful communication, authentication) and implements the Atom Publishing Protocol (RFC 5023, ''Atompub'') for stories and the plugin API (with the Static Pages plugin as a sample implementation).

In this project, we would like the student to look into areas where the webservices could also be added and, possibly, where they need changes or additions.

== Goals ==

The following areas would appear to make useful additions to the webservices API:

* image upload in stories
* story submissions
* comments

This is not a fixed list of features that ''must'' be implemented. The student and mentor will have to review the amount of work required to implement these and may decide to re-focus the project accordingly. They could also identify other areas where support for the webservices may make more sense and decide to implement those instead (or in addition).

== Details ==

=== Image Upload ===

When using the Admin's version of the story editor, a user can upload images that are to be used in the article (includes automatic thumbnail creation, link to the full-size version, etc.). This has been left out in the original implementation of the webservices API for the stories.

Atompub includes support for images. Therefore, it should be possible to implement the image upload via the webservices API so that an Atompub client can be used to publish articles with images in them.

=== Story Submissions ===

A Geeklog site allows visitors to submit stories for publication on the site. These will usually have to be approved by a moderator first. Story submissions are stored in a separate submission queue until approved (or rejected). The webservices API should be extended to allow users to submit stories and moderators to approve or reject (delete) submissions.

=== Comments ===

Comments by readers are supported for stories and plugins using the comment plugin API (e.g. Polls, Static Pages). There should be a way for users to submit (and possibly edit) their comments through the webservices API.

Note: This may have to be coordinated with the attempts to [[SoC_improving_comments|improve the comment handling]], should that project be picked up again.

[[Category:Summer of Code]] [[Category:Development]]

← Older revision		Revision as of 18:01, 16 May 2009
Line 6:		Line 6:
	== Project info and advancement during Summer of Code ==		== Project info and advancement during Summer of Code ==

−	(to ~~be written~~)	+	* [[Webservices API/Media\|To-do list and Progress]]
		+
		+	(more to come)

← Older revision		Revision as of 19:01, 15 May 2009
Line 1:		Line 1:
−	~~<center>(~~This is ~~an idea page for~~ the [[Google Summer of Code]]~~)</center>~~	+	This is one of the projects to be implemented during the [[Google Summer of Code]] 2009.
		+
		+	'''Student:''' Phaneendra Kaddi, '''Mentor:''' Ramnath Iyer

@@ Line 1: / Line 1: @@
 <center>(This is an idea page for the [[Google Summer of Code]])</center>
 == Incentive ==
 As part of the 2007 Summer of Code, a webservices API has been [[SoC_webservices_publishing|implemented]] in Geeklog. It provides the basic framework (RESTful communication, authentication) and implements the Atom Publishing Protocol (RFC 5023, ''Atompub'') for stories and the plugin API (with the Static Pages plugin as a sample implementation).
@@ Line 8: / Line 16: @@
-== Areas of Interest ==
+=== Areas of Interest ===
 The following areas would appear to make useful additions to the webservices API:
@@ Line 21: / Line 29: @@
-== Details ==
+=== Details ===
-=== Image Upload ===
+==== Image Upload ====
 When using the Admin's version of the story editor, a user can upload images that are to be used in the article (includes automatic thumbnail creation, link to the full-size version, etc.). This has been left out in the original implementation of the webservices API for the stories.
@@ Line 29: / Line 37: @@
 Atompub does have support for images and other types of media (''Media Resources''). Therefore, it should be possible to implement the image upload via the webservices API so that an Atompub client can be used to publish articles with images in them.
-=== Story Submissions ===
+==== Story Submissions ====
 A Geeklog site allows visitors to submit stories for publication on the site. These will usually have to be approved by a moderator first. Story submissions are stored in a separate submission queue until approved (or rejected). The webservices API should be extended to allow users to submit stories and moderators to approve or reject (delete) submissions.
@@ Line 37: / Line 45: @@
 To be discussed: Whether to expose the existence of a submission queue or not. It may make sense to treat submissions as normal entries and only set the "draft" flag for them.
-=== Comments ===
+==== Comments ====
 Comments by readers are supported for stories and plugins using the comment plugin API (e.g. Polls, Static Pages). There should be a way for users to submit (and possibly edit) their comments through the webservices API.
@@ Line 44: / Line 52: @@
-== Level of Difficulty ==
+=== Level of Difficulty ===
 ''medium to high''
@@ Line 53: / Line 61: @@
-== Further Reading ==
+=== Further Reading ===
 * [[Webservices API]]

@@ Line 33: / Line 33: @@
 A Geeklog site allows visitors to submit stories for publication on the site. These will usually have to be approved by a moderator first. Story submissions are stored in a separate submission queue until approved (or rejected). The webservices API should be extended to allow users to submit stories and moderators to approve or reject (delete) submissions.
-Since moderation of submissions is also available for plugins (through Geeklog's plugin API), it would be preferrable if this could be implemented in such a manner that webservices access is also available for plugins.
+Since moderation of submissions is also available for plugins (through Geeklog's plugin API), it would be preferable if this could be implemented in such a manner that webservices access is also available for plugins.
 To be discussed: Whether to expose the existence of a submission queue or not. It may make sense to treat submissions as normal entries and only set the "draft" flag for them.
@@ Line 41: / Line 41: @@
 Comments by readers are supported for stories and plugins using the comment plugin API (e.g. Polls, Static Pages). There should be a way for users to submit (and possibly edit) their comments through the webservices API.
-Note: This may have to be coordinated with the attempts to [[SoC_improving_comments_2008|improve the comment handling]], should that project be picked up again.
+Note: Editable comments were part a [[SoC_improving_comments_2008|GSoC project in 2008]] and will be available as of Geeklog 1.6.0.

@@ Line 8: / Line 8: @@
-== Goals ==
+== Areas of Interest ==
 The following areas would appear to make useful additions to the webservices API:
@@ Line 16: / Line 16: @@
 * comments
-This is not a fixed list of features that ''must'' be implemented. The student and mentor will have to review the amount of work required to implement these and may decide to re-focus the project accordingly. They could also identify other areas where support for the webservices may make more sense and decide to implement those instead (or in addition).
+These would appear to make the most sense at this time, to round off the existing functionality of the webservices API and bring it in sync with what can be done through the normal web-based UI.
@@ Line 25: / Line 27: @@
 When using the Admin's version of the story editor, a user can upload images that are to be used in the article (includes automatic thumbnail creation, link to the full-size version, etc.). This has been left out in the original implementation of the webservices API for the stories.
-Atompub includes support for images. Therefore, it should be possible to implement the image upload via the webservices API so that an Atompub client can be used to publish articles with images in them.
+Atompub does have support for images and other types of media (''Media Resources''). Therefore, it should be possible to implement the image upload via the webservices API so that an Atompub client can be used to publish articles with images in them.
 === Story Submissions ===
@@ Line 32: / Line 34: @@
 Since moderation of submissions is also available for plugins (through Geeklog's plugin API), it would be preferrable if this could be implemented in such a manner that webservices access is also available for plugins.
 === Comments ===
@@ Line 38: / Line 42: @@
 Note: This may have to be coordinated with the attempts to [[SoC_improving_comments_2008|improve the comment handling]], should that project be picked up again.

← Older revision		Revision as of 19:24, 26 February 2008
Line 38:		Line 38:

	Note: This may have to be coordinated with the attempts to [[SoC_improving_comments_2008\|improve the comment handling]], should that project be picked up again.		Note: This may have to be coordinated with the attempts to [[SoC_improving_comments_2008\|improve the comment handling]], should that project be picked up again.
		+
		+
		+	== Further Reading ==
		+
		+	* [[Webservices API]]
		+	* [[Using the Webservices]]
		+	* RFC 5023: The Atom Publishing Protocol


	[[Category:Summer of Code]] [[Category:Development]]		[[Category:Summer of Code]] [[Category:Development]]

@@ Line 37: / Line 37: @@
 Comments by readers are supported for stories and plugins using the comment plugin API (e.g. Polls, Static Pages). There should be a way for users to submit (and possibly edit) their comments through the webservices API.
-Note: This may have to be coordinated with the attempts to [[SoC_improving_comments|improve the comment handling]], should that project be picked up again.
+Note: This may have to be coordinated with the attempts to [[SoC_improving_comments_2008|improve the comment handling]], should that project be picked up again.
 [[Category:Summer of Code]] [[Category:Development]]

← Older revision		Revision as of 15:34, 13 January 2008
Line 30:		Line 30:

	A Geeklog site allows visitors to submit stories for publication on the site. These will usually have to be approved by a moderator first. Story submissions are stored in a separate submission queue until approved (or rejected). The webservices API should be extended to allow users to submit stories and moderators to approve or reject (delete) submissions.		A Geeklog site allows visitors to submit stories for publication on the site. These will usually have to be approved by a moderator first. Story submissions are stored in a separate submission queue until approved (or rejected). The webservices API should be extended to allow users to submit stories and moderators to approve or reject (delete) submissions.
		+
		+	Since moderation of submissions is also available for plugins (through Geeklog's plugin API), it would be preferrable if this could be implemented in such a manner that webservices access is also available for plugins.

	=== Comments ===		=== Comments ===