Version 1 by Christopher Valles
on May 17, 2011 15:49.

compared with
Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (30)

View Page History
{info:title=New Proposal Template}
This page has been created from a template that uses "zones." To proceed:

# Edit the page
# Replace sample content within each zone-data tag with your own content
# Remove this notice
# Save the page
# When you are ready for community review, move this page to the [Ready for Review] section on the edit page.

{note:title=No placeholders allowed!}
Please do not create placeholders. Wait until you have sufficient content to replace all sample data in the proposal template before creating your proposal document.
{note}
{info}

{zone-template-instance:ZFPROP:Proposal Zone Template}

{zone-data:component-name}
Zend_Magic Zend_Service_ShortUrl_Bitly
{zone-data}

{zone-data:proposer-list}
[My Name|mailto:noreply@zend.com]
[Christopher Valles|mailto:info@christophervalles.com]
{zone-data}


{zone-data:revision}
1.0 - 1 January 2008: 17 May 2011: Initial Draft.
{zone-data}

{zone-data:overview}
Zend_Magic is a simple component that reads my mind and generates code dynamically to do what I want.
Zend_Service_ShortUrl_Bitly is a component to integrate the Bit.ly short url service inside our applications. This component will allow shorting and expanding urls.
{zone-data}

{zone-data:references}
* [Harry Houdini Wikipedia Entry|http://en.wikipedia.org/wiki/Harry_Houdini]
* [MagicTricks.com|http://www.magictricks.com/]
* [Bit.ly API Documentation|http://code.google.com/p/bitly-api/wiki/ApiDocumentation]
{zone-data}

{zone-data:requirements}
Most requirements take the form of "foo will do ...." or "foo will not support ...", although different words and sentence structure might be used. Adding functionality to your proposal is requirements creep (bad), unless listed below. Discuss major changes with your team first, and then open a "feature improvement" issue against this component.

* This component *will* correctly reads a developers mind for intent and generate the right configuration file.
* The generated config file *will not* support XML, but will provide an extension point in the API.
* This component *will* use no more memory than twice the size of all data it contains.
* This component *will* include a factory method.
* This component *will not* allow subclassing. (i.e. when reviewed, we expect to see "final" keyword in code)
* This component *will* only generate data exports strictly complying with RFC 12345.
* This component *will* validate input data against formats supported by ZF component Foo.
* This component *will not* save any data using Zend_Cache or the filesystem. All transient data *will be* saved using Zend_Session.
* This component *will* allow the developer to create short urls.
* This component *will* allow the developer to expand short urls.
{zone-data}

{zone-data:dependencies}
* Zend_Exception Zend_Service_ShortUrl_AbstractShortener
* Zend_Service_ShortUrl_Exception
* Zend_Json
{zone-data}

{zone-data:operation}
The component is instantiated with a mind-link that ...
The developer has an account with bit.ly
The developer instantiates Zend_Service_ShortUrl_Bitly with their username and API key
The developer uses the component to create short url and/or expand them
{zone-data}

{zone-data:milestones}
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: [design notes will be published here|http://framework.zend.com/wiki/x/sg]
* Milestone 1: \[DONE\] Supporting Documentation, Use Cases, Class Skeletons, uploaded
* Milestone 2: Working prototype checked into the incubator supporting use cases #1, #2, ...
* Milestone 3: Working prototype checked into the incubator supporting use cases #3 and #4.
* Milestone 43: Unit tests exist, work, and are checked into SVN.
* Milestone 5: Initial documentation exists.

If a milestone is already done, begin the description with "\[DONE\]", like this:
* Milestone #: \[DONE\] Unit tests ...
{zone-data}

{zone-data:class-list}
* Zend_Magic_Exception Zend_Service_ShortUrl_Bitly
* Zend_Magic (factory class)
* Zend_Magic_MindProbe
* Zend_Magic_MindProbe_Intent
* Zend_Magic_Action
* Zend_Magic_CodeGen
{zone-data}

{zone-data:use-cases}
||UC-01||
{code}
<?php

... (see good use cases book)
$bitlyService = new App_Service_ShortUrl_BitLy($username, $apiKey);
$shortUrl = $bitlyService->shorten('http://google.es');
{code}

||UC-02||
{code}
<?php

$bitlyService = new App_Service_ShortUrl_BitLy($username, $apiKey);
$url = $bitlyService->unshorten('http://bit.ly/1C7Y');
{code}
{zone-data}

{zone-data:skeletons}
{code}
class Zend_Magic_Exception extends Zend_Exception {}
<?php
/**
* Zend Framework
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://framework.zend.com/license/new-bsd
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@zend.com so we can send you a copy immediately.
*
* @category Zend
* @package Zend_Service_ShortUrl
* @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @version $Id: $
*/

class Zend_Magic {
... /**
* Bit.ly API implementation
*
* @category Zend
* @package Zend_Service_ShortUrl
* @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Zend_Service_ShortUrl_BitLy extends Zend_Service_ShortUrl_AbstractShortener
{
/**
* Base URI of the service
*
* @var string
*/
protected $_baseUri = 'http://bit.ly';

/**
* Username used to authenticate the api call
*
* @var string
*/
protected $_username;

/**
* The api key of the service
*
* @var string
*/
protected $_apiKey;

/**
* Store the username and the apiKey
*
* @param string $username
* @param string $apiKey
*/
public function __construct($username, $apiKey) {}

/**
* Create a short url from a full url
*
* @param string $url URL to Shorten
* @throws Zend_Service_ShortUrl_Exception When URL is not valid
* @return string Shorted URL
*/
public function shorten($url) {}

/**
* Expand a short url and return the original url
*
* @param string $shortenedUrl URL to reveal target of
* @throws Zend_Service_ShortUrl_Exception When URL is not valid or is not shortened by this service
* @return string
*/
public function unshorten($shortenedUrl) {}
}
{code}
{zone-data}