Merge pull request #40 from LaurentEsc/master

Make testing easier by adding a disable() method

Author: msurguy

README.md

@@ -69,6 +69,19 @@ Please note that "honeytime" takes a parameter specifying number of seconds it s
 
 That's it! Enjoy getting less spam in your inbox. If you need stronger spam protection, consider using [Akismet](https://github.com/kenmoini/akismet) or [reCaptcha](https://github.com/dontspamagain/recaptcha)   
 
+## Testing
+
+If you want to test the submission of a form using this package, you might want to disable Honeypot so that the validation passes. To do so, simply call the `disable()` method in your test:
+
+    Honeypot::disable();
+
+    $this->visit('contact')
+        ->type('User', 'name')
+        ->type('[email protected]', 'email')
+        ->type('Hello World', 'message')
+        ->press('submit')
+        ->see('Your message has been sent!');
+
 ## Credits
 
 Based on work originally created by Ian Landsman: <https://github.com/ianlandsman/Honeypot>

src/Msurguy/Honeypot/Honeypot.php

@@ -4,6 +4,24 @@
 
 class Honeypot {
 
+    protected $disabled = false;
+
+    /**
+     * Enable the Honeypot validation
+     */
+    public function enable()
+    {
+        $this->disabled = false;
+    }
+
+    /**
+     * Disable the Honeypot validation
+     */
+    public function disable()
+    {
+        $this->disabled = true;
+    }
+
     /**
      * Generate a new honeypot and return the form HTML
      * @param  string $honey_name
@@ -23,6 +41,44 @@ public function generate($honey_name, $honey_time)
         return $html;
     }
 
+    /**
+    * Validate honeypot is empty
+    *
+    * @param  string $attribute
+    * @param  mixed $value
+    * @param  array $parameters
+    * @return boolean
+    */
+    public function validateHoneypot($attribute, $value, $parameters)
+    {
+        if ($this->disabled) {
+            return true;
+        }
+
+        return $value == '';
+    }
+
+    /**
+     * Validate honey time was within the time limit
+     *
+     * @param  string $attribute
+     * @param  mixed $value
+     * @param  array $parameters
+     * @return boolean
+     */
+    public function validateHoneytime($attribute, $value, $parameters)
+    {
+        if ($this->disabled) {
+            return true;
+        }
+        
+        // Get the decrypted time
+        $value = $this->decryptTime($value);
+
+        // The current time should be greater than the time the form was built + the speed option
+        return ( is_numeric($value) && time() > ($value + $parameters[0]) );
+    }
+
     /**
      * Get encrypted time
      * @return string
@@ -32,4 +88,23 @@ public function getEncryptedTime()
         return Crypt::encrypt(time());
     }
 
+    /**
+     * Decrypt the given time
+     *
+     * @param  mixed $time
+     * @return string|null
+     */
+    public function decryptTime($time)
+    {
+        // Laravel will throw an uncaught exception if the value is empty
+        // We will try and catch it to make it easier on users.
+    	try {
+            return Crypt::decrypt($time);
+    	}
+    	catch (\Illuminate\Encryption\DecryptException $exception)
+        {
+            return null;
+        }
+    }
+
 }

src/Msurguy/Honeypot/HoneypotServiceProvider.php

@@ -49,8 +49,9 @@ public function boot()
             $translator = $app['translator'];
 
             // Add honeypot and honeytime custom validation rules
-            $validator->extend('honeypot', 'Msurguy\Honeypot\HoneypotValidator@validateHoneypot', $translator->get('honeypot::validation.honeypot'));
-            $validator->extend('honeytime', 'Msurguy\Honeypot\HoneypotValidator@validateHoneytime', $translator->get('honeypot::validation.honeytime'));
+            $validator->extend('honeypot', 'honeypot@validateHoneypot', $translator->get('honeypot::validation.honeypot'));
+            $validator->extend('honeytime', 'honeypot@validateHoneytime', $translator->get('honeypot::validation.honeytime'));
+
         });
     }
 

src/Msurguy/Honeypot/HoneypotValidator.php

@@ -8,7 +8,7 @@ class HoneypotValidatorTest extends \PHPUnit_Framework_TestCase {
 
     public function setUp()
     {
-        $this->validator = Mockery::mock('Msurguy\Honeypot\HoneypotValidator[decryptTime]');
+        $this->validator = Mockery::mock('Msurguy\Honeypot\Honeypot[decryptTime]');
     }
 
     /** @test */