Update spamprotection module from 0.3 to 2.0.5

Author: Fenrirthviti

spamprotection/CHANGELOG

@@ -1,5 +1,9 @@
 # SpamProtection Module
 
+[![Build Status](https://secure.travis-ci.org/silverstripe/silverstripe-spamprotection.png?branch=master)](http://travis-ci.org/silverstripe/silverstripe-spamprotection)
+![helpfulrobot](https://helpfulrobot.io/silverstripe/spamprotection/badge)
+
+
 ## Maintainer Contact
 
  * Saophalkun Ponlu
@@ -14,12 +18,110 @@ SilverStripe 3.0.0 or greater
 
 ## Documentation
 
-See docs/
+This module provides a generic, consistent API for adding spam protection to 
+your SilverStripe Forms. This does not provide any spam protection out of the 
+box, for that, you must also download one of the spam protection 
+implementations. Currently available options are:
+
+* [Mollom](https://github.com/silverstripe/silverstripe-mollom)
+* [Recaptcha](https://github.com/chillu/silverstripe-recaptcha)
+* [MathSpamProtection](https://github.com/silverstripe/silverstripe-mathspamprotection)
+* [Akismet](https://github.com/tractorcow/silverstripe-akismet)
+
+As a developer you can also provide your own protector by creating a class which
+implements the `SpamProtector` interface. More on that below.
+
+## Configuring
+
+After installing this module and a protector of your choice (i.e mollom) you'll 
+need to rebuild your database through `dev/build` and set the default protector 
+via SilverStripe's config system. This will update any Form instances that have
+spam protection hooks with that protector.
+
+*mysite/_config/spamprotection.yml*
+
+	---
+	name: spamprotection
+	---
+	FormSpamProtectionExtension:
+	  default_spam_protector: MollomSpamProtector
+
+To add spam protection to your form instance call `enableSpamProtection`.
+	
+	// your existing form code
+	$form = new Form( .. );
+	$form->enableSpamProtection();
+
+The logic to perform the actual spam validation is controlled by each of the 
+individual `SpamProtector` implementation since they each require a different 
+implementation client side or server side.
+
+### Options
+
+`enableSpamProtection` takes a hash of optional configuration values. 
+
+	$form->enableSpamProtection(array(
+		'protector' => 'MathSpamProtector',
+		'name' => 'Captcha'
+	));
+
+Options to configure are:
+
+*`protector`* a class name string or class instance which implements 
+`SpamProtector`. Defaults to your 
+`FormSpamProtectionExtension.default_spam_protector` value.
+
+*`name`* the form field name argument for the Captcha. Defaults to `Catcha`.
+*`title`* title of the Captcha form field. Defaults to `''`
+*`insertBefore`* name of existing field to insert the spam protection field prior to
+*`mapping`* an array mapping of the Form fields to the standardized list of 
+field names. The list of standardized fields to pass to the spam protector are:
+
+		title
+		body
+		contextUrl
+		contextTitle
+		authorName
+		authorMail
+		authorUrl
+		authorIp
+		authorId
+
+## Defining your own `SpamProtector`
+
+Any class that implements `SpamProtector` and the `getFormField()` method can
+be set as the spam protector. The `getFormField()` method returns the 
+`FormField` to be inserted into the `Form`. The `FormField` returned should be
+in charge of the validation process.
+
+	<?php
+
+	class CustomSpamProtector implements SpamProtector {
+
+		public function getFormField($name = null, $title = null, $value = null) {
+			// CaptchaField is a imagined class which has some functionality.
+			// See silverstripe-mollom module for an example.
+			return new CaptchaField($name, $title, $value);
+		}
+	}
+
+
+## Using Spam Protection with User Forms
+
+This module provides an EditableSpamProtectionField wrapper which you can add
+to your UserForm instances. After installing this module and running /dev/build
+to rebuild the database, your Form Builder interface will have an option for 
+`Spam Protection Field`. The type of spam protection used will be based on your 
+currently selected SpamProtector instance.
 
-## Installation Instructions
+## Releasing code with Spam Protection support
 
-See docs/Install
+Spam protection is useful to provide but in some cases we do not want to require 
+the developer to use spam protection. In that case, modules can provide the 
+following pattern
 
-## Usage Overview
+	$form = new Form(..);
 
-See docs/Install
+	if($form->hasExtension('FormSpamProtectionExtension')) {
+		$form->enableSpamProtection();
+	}

spamprotection/LICENSE

@@ -8,12 +8,4 @@
  *
  * @package spamprotection
  */
-
-/**
- * If the comments module is installed then add the spam protection module 
- * to the comments form via this extension.
- *
- * Place this line in your mysite/_config.php
- */
-
-// CommentingController::add_extension('CommentSpamProtection');
+Deprecation::notification_version('1.1', 'spamprotection');