Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version. Compare with Current  |   View Page History

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

Zend Framework: Zend\Service\GitHub Component Proposal

Proposed Component Name Zend\Service\GitHub
Developer Notes\Service\GitHub
Proposers Dennis Winter
Zend Liaison TBD
Revision 1.0 - 17 November 2010: Initial Draft. (wiki revision: 12)

Table of Contents

1. Overview

Zend\Service\GitHub allows to easily use GitHub's REST API.

"GitHub is the best way to collaborate with others. Fork, send pull requests and manage all your public and private git repositories."

2. References

GitHub's API Overview

3. Component Requirements, Constraints, and Acceptance Criteria

  • This component will partly require a valid GitHub-Account.
  • This component will implement full GitHub REST API.
  • This component will throw an Exception in case of a response error.
  • This component will not provide a way to commit any data to the Git repository.

4. Dependencies on Other Framework Components

  • Zend\Http\Client
  • Zend\Rest\RestClient
  • Zend\Json

5. Theory of Operation

6. Milestones / Tasks

  • Milestone 1: Complete class overview and method signatures
  • Milestone 2: Use cases
  • Milestone 3: Prototype
  • Milestone 4: Acceptance
  • Milestone 5: Unit tests exist, work and are checked into SVN
  • Milestone 6: Initial documentation exists

7. Class Index

  • Zend\Service\GitHub
  • Zend\Service\GitHub\Blob
  • Zend\Service\GitHub\Commits
  • Zend\Service\GitHub\Exception
  • Zend\Service\GitHub\Exception\InvalidArgumentException
  • Zend\Service\GitHub\Exception\OutOfRangeException
  • Zend\Service\GitHub\Exception\RuntimeException
  • Zend\Service\GitHub\Exception\UnexpectedValueException
  • Zend\Service\GitHub\Gist
  • Zend\Service\GitHub\Issues
  • Zend\Service\GitHub\Issues\Comment
  • Zend\Service\GitHub\Issues\Label
  • Zend\Service\GitHub\Network
  • Zend\Service\GitHub\Repository
  • Zend\Service\GitHub\Repository\Collaborators
  • Zend\Service\GitHub\Repository\Key
  • Zend\Service\GitHub\Repository\Set
  • Zend\Service\GitHub\Tree
  • Zend\Service\GitHub\User
  • Zend\Service\GitHub\User\Email
  • Zend\Service\GitHub\User\Key

8. Use Cases

9. Class Skeletons


Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.