Added by Jan Miczaika, last edited by Jan Miczaika on Aug 01, 2008  (view change)

Labels

 
Under Construction

This proposal is under construction and is not ready for review.

Zend Framework: Zend_Service_Hitmeister Component Proposal

Proposed Component Name Zend_Service_Hitmeister
Developer Notes http://framework.zend.com/wiki/display/ZFDEV/Zend_Service_Hitmeister
Proposers Jan Miczaika
Zend Liaison TBD
Revision 1.0 - 23 June 2008: Initial Draft. (wiki revision: 5)

Table of Contents

1. Overview

Hitmeister is a marketplace for DVDs, Books, Games, CDs and audiobooks in Germany (serving all of Europe). Expansion into new categories will come in the summer.

Zend_Service_Hitmeister is a PHP client for the Hitmeister API. The API consists of two main functionality blocks:
a) Querying Hitmeister for information about an item
b) Managing a Seller's inventory on the site

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

  • This component will implement the Hitmeister API requests for receiving information about an item
  • This component will not implement the API requests for managing inventory in the first release
  • This component will parse and return server responses as intuitive data objects.
  • This component will validate any API request option before any HTTP request
  • This component will throw an Exception in case of a Hitmeister response error

4. Dependencies on Other Framework Components

  • Zend_Service_Abstract
  • Zend_Service_Exception
  • Zend_Uri
  • Zend_HTTP_Client

5. Theory of Operation

This component generates requests to the Hitmeister API.

6. Milestones / Tasks

  • Milestone 1: design notes will be published here including use cases
  • Milestone 2: Working prototype checked into the incubator supporting use cases
  • Milestone 3: Unit tests exist, work, and are checked into SVN.
  • Milestone 4: Initial documentation exists.
  • Milestones 5-8: Repeat above for all API commands

7. Class Index

  • Zend_Service_Hitmeister

8. Use Cases

UC-01

... (see good use cases book)

9. Class Skeletons