Zend Framework: Zend_Service_TypePad_AntiSpam Component Proposal

Proposed Component Name	Zend_Service_TypePad_AntiSpam
Developer Notes	http://framework.zend.com/wiki/display/ZFDEV/Zend_Service_TypePad_AntiSpam
Proposers	Jordan Ryan Moore
Zend Liaison	TBD
Revision	1.0 - 30 May 2008: Initial Draft. (wiki revision: 10)

Zend_Service_TypePad_AntiSpam provides a simple interface for interacting with the TypePad AntiSpam API. Zend_Service_TypePad_AntiSpam provides a REST-based service for checking comment spam and reporting spam and ham (non-spam) comments. A rewrite of Zend_Service_Akismet internals will be necessary to make it more extensible.

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

This component will modify Zend_Service_Akismet to be more extensible.
This component will not modify the API of current public Zend_Service_Akismet methods.
Zend_Service_TypePad_AntiSpam will extend Zend_Service_Akismet.
Zend_Service_TypePad_AntiSpam will not provide additional functionality that is not available in Zend_Service_Akismet.

4. Dependencies on Other Framework Components

Zend_Http_Client
Zend_Service_Abstract
Zend_Service_Akismet
Zend_Service_Exception
Zend_Version

5. Theory of Operation

A Zend_Service_TypePad_AntiSpam object is instantiated with an API key and blog URL. After that, the developer need only call one of the API methods, each of which returns a boolean.

6. Milestones / Tasks

Milestone 1: Proposal published
Milestone 2: Proposal accepted
Milestone 3: Working code and unit tests checked into incubator
Milestone 4: Documentation checked into incubator

7. Class Index

Zend_Service_Akismet
Zend_Service_TypePad_AntiSpam

8. Use Cases

UC-01

$antiSpam = new Zend_Service_TypePad_AntiSpam('http://example.com/blog/', $apiKey);
$antiSpam->verifyKey();

UC-02

$antiSpam = new Zend_Service_TypePad_AntiSpam('http://example.com/blog/', $apiKey);
$antiSpam->commentCheck(array(
    'user_ip'              => '111.222.222.222',
    'user_agent'           => 'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.1.1) Gecko/20061204 Firefox/2.0.0.1)',
    'referrer'             => 'http://www.example.com/blog/',
    'comment_type'         => 'comment',
    'comment_author'       => 'viagra-test-123',
    'comment_author_email' => 'spammer@nooneknows.com',
    'comment_content'      => 'a little v i a g r a goes a l o n g way'
`
));

UC-03

$antiSpam = new Zend_Service_TypePad_AntiSpam('http://example.com/blog/', $apiKey);
$antiSpam->submitSpam(array(
    'user_ip'              => '111.222.222.222',
    'user_agent'           => 'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.1.1) Gecko/20061204 Firefox/2.0.0.1)',
    'referrer'             => 'http://www.example.com/blog/',
    'comment_type'         => 'comment',
    'comment_author'       => 'viagra-test-123',
    'comment_author_email' => 'spammer@example.com',
    'comment_content'      => 'a little v i a g r a goes a l o n g way'
`
));

UC-04

$antiSpam = new Zend_Service_TypePad_AntiSpam('http://example.com/blog/', $apiKey);
$antiSpam->submitHam(array(
    'user_ip'              => '111.222.222.222',
    'user_agent'           => 'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.1.1) Gecko/20061204 Firefox/2.0.0.1)',
    'referrer'             => 'http://www.example.com/blog/',
    'comment_type'         => 'comment',
    'comment_author'       => 'Mr. Goodbar',
    'comment_author_email' => 'goodbar@example.com',
    'comment_content'      => 'Why are my comments always trapped as spam?'
`
));

UC-05

// Use behind a proxy
// Setup an HTTP client with a proxy adapter, with the necessary proxy options
$httpClient = new Zend_Http_Client(null, array(
    'adapter'    => 'Zend_Http_Client_Adapter_Proxy',
    'proxy_host' => 'proxy.example.com',
    'proxy_port' => 8080,
    'proxy_user' => 'me',
    'proxy_pass' => 'bananarama'
));

// Pass it into the TypePad AntiSpam client
Zend_Service_TypePad_AntiSpam::setHttpClient($httpClient);

// Everything else is as normal
$antiSpam = new Zend_Service_TypePad_AntiSpam('http://example.com/blog/', $apiKey);
$antiSpam->submitHam(array(
    'user_ip'              => '111.222.222.222',
    'user_agent'           => 'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.1.1) Gecko/20061204 Firefox/2.0.0.1)',
    'referrer'             => 'http://www.example.com/blog/',
    'comment_type'         => 'comment',
    'comment_author'       => 'Mr. Goodbar',
    'comment_author_email' => 'goodbar@example.com',
    'comment_content'      => 'Why are my comments always trapped as spam?',
));

9. Class Skeletons

class Zend_Service_Akismet extends Zend_Service_Abstract {
    const PLUGIN_NAME = 'Akismet';
    const PLUGIN_VERSION = 1.11;
    const API_HOSTNAME = 'rest.akismet.com';
    const API_VERSION = 1.1;
    protected $_apiKey;
    protected $_blogUrl;
    protected $_charset = 'UTF-8';
    protected $_port = 80;
    protected $_userAgent;
    public function __construct($apiKey, $blogUrl) {}
    public function getBlogUrl() {}
    public function setBlogUrl($blogUrl) {}
    public function getApiKey() {}
    public function setApiKey($apiKey) {}
    public function getCharset() {}
    public function setCharset($charset) {}
    public function getPort() {}
    public function setPort($port) {}
    public function getUserAgent() {}
    public function setUserAgent($userAgent) {}
    public function verifyKey($key = null, $blog = null) {}
    public function isSpam($params) {}
    public function submitSpam($params) {}
    public function submitHam($params) {}
    protected function _post($host, $path, array $params) {}
    protected function _makeApiCall($path, $params) {}
}

class Zend_Service_TypePad_AntiSpam extends Zend_Service_Akismet {
    const PLUGIN_NAME = 'TypePadAntiSpam';
    const PLUGIN_VERSION = 1.0;
    const API_HOSTNAME = 'api.antispam.typepad.com';
}

Page Operations

Browse Space

Zend_Service_TypePad_AntiSpam - Jordan Ryan Moore

Labels