Add newsletter subscription endpoint (email/mobile) plus admin CSV export
Deploy Backend / deploy (push) Successful in 2m50s

This commit is contained in:
Parsa Aghayi committed 2026-10-03 08:31:17 -04:00
1 parent e98807da05
commit eacd0d73f1
6 files changed
+214

No files matched your search

@@ -7,6 +7,7 @@ use App\Models\Blog\Category;
use App\Models\Blog\Comment;
use App\Models\Blog\Post;
use App\Models\Blog\Tag;
use App\Models\NewsletterSubscription;
use App\Models\Website\AboutMe;
use App\Models\Website\Project;
use App\Models\Website\ProjectCategory;
@@ -28,6 +29,7 @@ class AdminResourceController extends Controller
'project-categories' => ProjectCategory::class,
'about-me' => AboutMe::class,
'comments' => Comment::class,
'newsletter-subscriptions' => NewsletterSubscription::class,
];
/**
@@ -0,0 +1,70 @@
<?php
namespace App\Http\Controllers\Api;
use App\Http\Controllers\Controller;
use App\Models\NewsletterSubscription;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
/**
* @OA\Tag(name="Newsletter", description="Blog newsletter subscriptions")
*/
class NewsletterSubscriptionController extends Controller
{
/**
* Store a new subscription. The site has no mail service of its own, so
* subscriptions are stored in the database and read from the admin panel,
* like contact messages and blog comments.
*
* A visitor may join with an email, a mobile number, or both; repeating an
* email is harmless and idempotent.
*/
public function subscribe(Request $request): JsonResponse
{
$validated = $request->validate([
'email' => ['nullable', 'email', 'max:255'],
'mobile' => ['nullable', 'string', 'max:30'],
]);
$email = isset($validated['email']) ? trim($validated['email']) : null;
$mobile = isset($validated['mobile']) ? trim($validated['mobile']) : null;
if ($email === null || $email === '') {
$email = null;
}
if ($mobile === null || $mobile === '') {
$mobile = null;
}
if ($email === null && $mobile === null) {
return response()->json([
'message' => 'حداقل ایمیل یا شماره موبایل را وارد کنید.',
'errors' => [
'email' => ['حداقل ایمیل یا شماره موبایل را وارد کنید.'],
],
], 422);
}
if ($email !== null) {
$existing = NewsletterSubscription::where('email', $email)->first();
if ($existing !== null) {
return response()->json([
'message' => 'شما قبلاً در خبرنامه عضویت داشتهاید.',
'subscribed' => true,
]);
}
}
$subscription = NewsletterSubscription::create([
'email' => $email,
'mobile' => $mobile,
]);
return response()->json([
'message' => 'عضویت شما در خبرنامه با موفقیت ثبت شد.',
'subscription' => $subscription,
], 201);
}
}
+10
View File
@@ -0,0 +1,10 @@
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
class NewsletterSubscription extends Model
{
protected $fillable = ['email', 'mobile'];
}
@@ -0,0 +1,23 @@
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
public function up(): void
{
Schema::create('newsletter_subscriptions', function (Blueprint $table) {
$table->id();
$table->string('email', 255)->nullable()->index();
$table->string('mobile', 30)->nullable();
$table->timestamps();
});
}
public function down(): void
{
Schema::dropIfExists('newsletter_subscriptions');
}
};
+12
View File
@@ -10,6 +10,7 @@ use App\Http\Controllers\Api\Blog\PostController;
use App\Http\Controllers\Api\Blog\PostInteractionController;
use App\Http\Controllers\Api\Blog\TagController;
use App\Http\Controllers\Api\ContactMessageController;
use App\Http\Controllers\Api\NewsletterSubscriptionController;
use App\Http\Controllers\Api\Website\AboutMeController;
use App\Http\Controllers\Api\Website\ProjectCategoryController;
use App\Http\Controllers\Api\Website\ProjectController;
@@ -84,6 +85,17 @@ Route::middleware('throttle:60,1')->group(function () {
Route::post('contact', [ContactMessageController::class, 'store'])
->middleware('throttle:5,1');
/*
|--------------------------------------------------------------------------
| Newsletter subscriptions
|--------------------------------------------------------------------------
| Stored and read from the admin panel like contact messages, so the write
| endpoint is public (no auth) but throttled the same way.
*/
Route::post('newsletter/subscribe', [NewsletterSubscriptionController::class, 'subscribe'])
->middleware('throttle:5,1');
/*
|--------------------------------------------------------------------------
| Public blog interactions
@@ -0,0 +1,97 @@
<?php
namespace Tests\Feature;
use App\Models\NewsletterSubscription;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;
class NewsletterSubscriptionTest extends TestCase
{
use RefreshDatabase;
public function test_email_subscription_creates_a_row()
{
$response = $this->postJson('/api/newsletter/subscribe', [
'email' => 'reader@example.com',
]);
$response->assertStatus(201);
$this->assertDatabaseHas('newsletter_subscriptions', [
'email' => 'reader@example.com',
'mobile' => null,
]);
}
public function test_mobile_only_subscription_is_accepted()
{
$response = $this->postJson('/api/newsletter/subscribe', [
'mobile' => '+989120001122',
]);
$response->assertStatus(201);
$this->assertDatabaseHas('newsletter_subscriptions', [
'mobile' => '+989120001122',
]);
}
public function test_email_and_mobile_are_both_stored()
{
$response = $this->postJson('/api/newsletter/subscribe', [
'email' => 'reader@example.com',
'mobile' => '+989120001122',
]);
$response->assertStatus(201);
$this->assertDatabaseHas('newsletter_subscriptions', [
'email' => 'reader@example.com',
'mobile' => '+989120001122',
]);
}
public function test_subscription_requires_email_or_mobile()
{
$this->postJson('/api/newsletter/subscribe', [])->assertStatus(422);
$this->postJson('/api/newsletter/subscribe', ['email' => ''])->assertStatus(422);
}
public function test_invalid_email_is_rejected()
{
$this->postJson('/api/newsletter/subscribe', [
'email' => 'not-an-email',
])->assertStatus(422);
}
public function test_duplicate_email_is_idempotent()
{
NewsletterSubscription::create(['email' => 'reader@example.com']);
$response = $this->postJson('/api/newsletter/subscribe', [
'email' => 'reader@example.com',
]);
$response->assertStatus(200);
$this->assertDatabaseCount('newsletter_subscriptions', 1);
}
public function test_admin_can_list_subscriptions()
{
$this->actingAsAdmin();
NewsletterSubscription::create(['email' => 'a@example.com', 'mobile' => '+989120001122']);
NewsletterSubscription::create(['email' => 'b@example.com']);
$this->getJson('/api/admin/resources/newsletter-subscriptions')
->assertStatus(200)
->assertJsonCount(2, 'data');
}
public function test_subscriptions_require_an_admin()
{
$this->getJson('/api/admin/resources/newsletter-subscriptions')
->assertUnauthorized();
}
}