Under Construction NOTICE This proposal is being revised and is not ready for review!

Zend Framework: Zend_Service_Digg Component Proposal

Table of Contents

1. Overview

Zend_Service_Digg is a ZF implementation of popular digg API services.

2. References

• Digg API docs

3. Component Requirements, Constraints, and Acceptance Criteria

• This component will implement the non-draft ListStories endpoints of the Digg API. (Add other endpoints later?)
• This component will support all query string parameters.
• This component will use an HTTP Accept header to specify json-serialized responses from Digg.
• This component will not implement any other endpoints until future releases.

4. Dependencies on Other Framework Components

• Zend_Http_Client
• Zend_Json

5. Theory of Operation

Instantiate an object of Zend_Service_Digg with any valid absolute URI in the constructor, which will be url-encoded and used as the mandatory appkey request parameter. Call getStories() to get an array of Zend_Service_Digg_Story objects, call getStory() to get an individual Zend_Service_Digg_Story object. getStories() has optional container, topic, and grouping (i.e., popular, upcoming, top, hot) parameters.

6. Milestones / Tasks

Describe some intermediate state of this component in terms of design notes, additional material added to this page, and / code. Note any significant dependencies here, such as, "Milestone #3 can not be completed until feature Foo has been added to ZF component XYZ." Milestones will be required for acceptance of future proposals. They are not hard, and many times you will only need to think of the first three below.

• Milestone 1: Working prototype checked into the incubator supporting use case #1
• Milestone 2: Unit tests exist, work, and are checked into SVN.
• Milestone 3: Initial documentation exists.
• Milestone 4: Add implementation for ListEvents endpoints.
  If a milestone is already done, begin the description with "[DONE]", like this:
• Milestone #: [DONE] Unit tests ...

7. Class Index

• Zend_Service_Digg
• Zend_Service_Digg_DataElement
• Zend_Service_Digg_Exception

8. Use Cases

9. Class Skeletons

Labels parameters

Labels:

None

Enter labels to add to this page:

 

Looking for a label? Just start typing.

11 Comments

comments.show.hide

1. 

   Nov 08, 2007

   Darby Felton

   When this proposal is ready for review, please edit the page and change the Parent Page field value to "Ready for Review". Also don't forget to remove the "Under Construction" banner at the top that indicates that the proposal is not ready for review.

   • Permalink

2. 

   May 13, 2008

   Wil Sinclair

   Luke, this proposal looks pretty complete at this stage. Do you plan to present it to the community for review? Please let me know either way so we can put it in the right section.

   Thanks.
   ,Wil

   • Permalink

3. 

   Dec 24, 2008

   Alexander Veremyev

   Zend Comments Proposal looks good and complete. Approved to the Standard Incubator.

   • Permalink

4. 

   Mar 18, 2009

   Wil Sinclair

   Luke, do you plan to finish this component? We'd love to have it in 1.8.

   • Permalink

   1. 

      Mar 19, 2009

      Luke Crouch

      I'll take another look at it. It's been a long time since I worked on it and I'll have to see if the digg API is still the same even!

      • Permalink

5. 

   Aug 12, 2009

   Duo Zheng

   Is it possible for me to help finish this if I am not one of the original proposers? It appears that a re-evaluation is needed due to how far this dates back anyways.

   I am unsure of the policies for this, but I am offering to take over this if needed. Please let me know how I can help.

   • Permalink

   1. 

      Aug 12, 2009

      Luke Crouch

      Duo,

      Feel free to work on the component. You can find the ZF Contributor guide here:

      http://framework.zend.com/wiki/display/ZFDEV/Contributing+to+Zend+Framework

      And check the SVN standards page for info on checking out the incubator, where you should put all of the code, per Alexander's Zend comment.

      http://framework.zend.com/wiki/display/ZFDEV/Subversion+Standards

      • Permalink

      1. 

         Aug 12, 2009

         Duo Zheng

         Thanks Luke

         I am going to speak to the Liaison about this and to request SVN access for the component.

         • Permalink

      2. 

         Sep 30, 2009

         Duo Zheng

         Luke,

         I was unable to get an answer from Alexander. I actually looked through your proposal again and looked at the Digg API. I wanted to expand your proposal to include the full Digg API this time as it seems to be "stable"? I am going to get in contact with Matthew Weier O'Phinney to ask the best way to proceed at this time. So just a quick update to assure you I am still here .

          If for some reason you don't agree that the full Digg API should be supported let me know.

         • Permalink

         1. 

            Oct 01, 2009

            Luke Crouch

            Sounds good!

            • Permalink

6. 

   Oct 05, 2009

   Duo Zheng

   Update: I will be re-proposing to support the full Digg API and will put it up for community review again as per the recommendation by Matthew Weier O'Phinney.

   • Permalink