Add voucher validation rule

Author: mpociot

src/Rules/Voucher.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace BeyondCode\Vouchers\Rules;
+
+use Vouchers;
+use Illuminate\Contracts\Validation\Rule;
+use BeyondCode\Vouchers\Exceptions\VoucherExpired;
+use BeyondCode\Vouchers\Exceptions\VoucherIsInvalid;
+use BeyondCode\Vouchers\Exceptions\VoucherAlreadyRedeemed;
+
+class Voucher implements Rule
+{
+    protected $isInvalid = false;
+    protected $isExpired = false;
+    protected $wasRedeemd = false;
+
+    /**
+     * Determine if the validation rule passes.
+     *
+     * @param  string $attribute
+     * @param  mixed $value
+     * @return bool
+     */
+    public function passes($attribute, $value)
+    {
+        try {
+            $voucher = Vouchers::check($value);
+
+            // Check if the voucher was already redeemed
+            if (auth()->check() && $voucher->users()->wherePivot('user_id', auth()->id())->exists()) {
+                throw VoucherAlreadyRedeemed::create($voucher);
+            }
+        } catch (VoucherIsInvalid $exception) {
+            $this->isInvalid = true;
+            return false;
+        } catch (VoucherExpired $exception) {
+            $this->isExpired = true;
+            return false;
+        } catch (VoucherAlreadyRedeemed $exception) {
+            $this->wasRedeemd = true;
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Get the validation error message.
+     *
+     * @return string
+     */
+    public function message()
+    {
+        if ($this->wasRedeemd) {
+            return trans('vouchers::validation.code_redeemed');
+        }
+        if ($this->isExpired) {
+            return trans('vouchers::validation.code_expired');
+        }
+        return trans('vouchers::validation.code_invalid');
+    }
+}

src/Vouchers.php

@@ -2,6 +2,7 @@
 
 namespace BeyondCode\Vouchers;
 
+use BeyondCode\Vouchers\Exceptions\VoucherExpired;
 use BeyondCode\Vouchers\Exceptions\VoucherIsInvalid;
 use BeyondCode\Vouchers\Models\Voucher;
 use Illuminate\Database\Eloquent\Model;
@@ -61,6 +62,7 @@ public function create(Model $model, int $amount = 1, array $data = [], $expires
     /**
      * @param string $code
      * @throws VoucherIsInvalid
+     * @throws VoucherExpired
      * @return Voucher
      */
     public function check(string $code)
@@ -70,6 +72,9 @@ public function check(string $code)
         if ($voucher === null) {
             throw VoucherIsInvalid::withCode($code);
         }
+        if ($voucher->isExpired()) {
+            throw VoucherExpired::create($voucher);
+        }
 
         return $voucher;
     }

src/VouchersServiceProvider.php

@@ -11,6 +11,8 @@ class VouchersServiceProvider extends ServiceProvider
      */
     public function boot()
     {
+        $this->loadTranslationsFrom(__DIR__.'/../translations', 'vouchers');
+
         if ($this->app->runningInConsole()) {
             $this->publishes([
                 __DIR__.'/../config/config.php' => config_path('vouchers.php'),
@@ -22,6 +24,10 @@ public function boot()
                     __DIR__.'/../database/migrations/create_vouchers_table.php.stub' => database_path('migrations/'.date('Y_m_d_His', time()).'_create_vouchers_table.php'),
                 ], 'migrations');
             }
+
+            $this->publishes([
+                __DIR__.'/../translations' => resource_path('lang/vendor/vouchers'),
+            ], 'translations');
         }
     }
 

tests/VoucherRuleTest.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace BeyondCode\Vouchers\Tests;
+
+use Vouchers;
+use Validator;
+use BeyondCode\Vouchers\Rules\Voucher;
+use BeyondCode\Vouchers\Tests\Models\User;
+use BeyondCode\Vouchers\Tests\Models\Item;
+
+class VoucherRuleTest extends TestCase
+{
+
+    /**
+     * @return \Illuminate\Validation\Validator
+     */
+    protected function validator($code)
+    {
+        return Validator::make(['code' => $code], ['code' => new Voucher()]);
+    }
+
+    /** @test */
+    public function it_validated_voucher_codes()
+    {
+        $item = Item::create(['name' => 'Foo']);
+
+        $vouchers = Vouchers::create($item);
+
+        $this->assertTrue($this->validator($vouchers[0]->code)->passes());
+        $this->assertTrue($this->validator('invalid')->fails());
+    }
+
+    /** @test */
+    public function it_returns_correct_error_messages_for_invalid_vouchers()
+    {
+        $validator = $this->validator('invalid');
+        $validator->passes();
+
+        $message = $validator->messages()->first('code');
+
+        $this->assertSame('The voucher code is invalid.', $message);
+    }
+
+    /** @test */
+    public function it_returns_correct_error_messages_for_redeemed_vouchers()
+    {
+        $item = Item::create(['name' => 'Foo']);
+        $vouchers = Vouchers::create($item);
+
+        $user = User::first();
+        $user->redeemCode($vouchers[0]->code);
+
+        auth()->login($user);
+
+        $validator = $this->validator($vouchers[0]->code);
+
+        $this->assertTrue($validator->fails());
+
+        $message = $validator->messages()->first('code');
+
+        $this->assertSame('The voucher code was already redeemed.', $message);
+    }
+
+    /** @test */
+    public function it_returns_correct_error_messages_for_expired_vouchers()
+    {
+        $item = Item::create(['name' => 'Foo']);
+        $vouchers = Vouchers::create($item, 1, [], now()->subDay(1));
+
+        $validator = $this->validator($vouchers[0]->code);
+
+        $this->assertTrue($validator->fails());
+
+        $message = $validator->messages()->first('code');
+
+        $this->assertSame('The voucher code is already expired.', $message);
+    }
+
+}

translations/en/validation.php

@@ -0,0 +1,9 @@
+<?php
+
+return [
+
+    'code_invalid' => 'The voucher code is invalid.',
+    'code_redeemed' => 'The voucher code was already redeemed.',
+    'code_expired' => 'The voucher code is already expired.',
+
+];