Skip to end of metadata
Go to start of metadata

<ac:macro ac:name="unmigrated-inline-wiki-markup"><ac:plain-text-body><![CDATA[

<ac:macro ac:name="unmigrated-inline-wiki-markup"><ac:plain-text-body><![CDATA[

Zend Framework: Zend_Service_Tumblr Component Proposal

Proposed Component Name Zend_Service_Tumblr
Developer Notes
Proposers Duo Zheng
Zend Liaison TBD
Revision 1.0 - 23 June 2009: Initial Draft. (wiki revision: 49)

Table of Contents

1. Overview

Zend_Service_Tumblr is a full implementation of the Tumblr API. It provides an object oriented interface to the API and returns data as PHP data objects.

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

  • This component will implement the full Tumblr API.
  • This component should namespace the various API methods similar to Tumblr's API documentation where appropriate.
  • This component should provide php data object representations for different post types that Tumblr offers.

4. Dependencies on Other Framework Components

  • Zend_Loader
  • Zend_Service_Exception
  • Zend_Http_Client
  • Zend_Http_Client_Adapter_Curl

5. Theory of Operation

Zend_Service_Tumblr will allow a developer to easily interact with the Tumblr API in a object oriented manner, supporting such actions as reading posts, creating posts, editing posts, validating credentials and getting account information. All data returned are represented as php data objects. Zend_Service_Tumblr creates a php client for the Tumblr API.

6. Milestones / Tasks

  • Milestone 1: Proposal, Community Review and Acceptance
  • Milestone 2: Unit-Testing and Development
  • Milestone 3: Documentation and Testing

7. Class Index

  • Zend_Service_Tumblr_Exception
  • Zend_Service_Tumblr
  • Zend_Service_Tumblr_PostList
  • Zend_Service_Tumblr_Post_Abstract
  • Zend_Service_Tumblr_Post_Text
  • Zend_Service_Tumblr_Post_Photo
  • Zend_Service_Tumblr_Post_Quote
  • Zend_Service_Tumblr_Post_Link
  • Zend_Service_Tumblr_Post_Video
  • Zend_Service_Tumblr_Post_Conversation
  • Zend_Service_Tumblr_Post_Audio
  • Zend_Service_Tumblr_Tumblelog
  • Zend_Service_Tumblr_User
  • Zend_Service_Tumblr_Feed

8. Use Cases

Creating New Posts
"Text Post"
"Photo Post"
"Quote Post"
"Link Post"
"Conversation Post"
"Video Post"
"Audio Post"
"Optional Methods"
Modifying Posts
"Edit Text Post"
"Delete Post"
"Retrieving user attributes"
"Retrieving tumblelog attributes"
Reading Posts
"Get Posts"
"Get Posts with optional paramaters"
"Get Tumblelog"

9. Class Skeletons

Currently "partial" working code:



Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Jun 29, 2009

    <p>I would like to get general feedback and more specifically on the use cases to make sure they are appropriate.</p>


  2. Jul 28, 2009

    <p>I made some final changes to use cases based on additional research. I've also added a github link for the partial workng code I've started. I've had no feedback for this proposal, but it has been a month since it has been "Ready for Review". I am moving this to "Ready for Recommendation" to push this forward.</p>

  3. Aug 20, 2009

    <ac:macro ac:name="note"><ac:parameter ac:name="title">Zend Acceptance</ac:parameter><ac:rich-text-body>
    <p>This proposal is accepted for immediate development in the standard incubator.The proposal is <strong>very</strong> well written, and shows plentiful use cases; I have absolutely no doubts on reading it that you have fully considered the Tumblr API and will be fully exposing it for users. Thank you for taking the time to provide such good detail!</p></ac:rich-text-body></ac:macro>