Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/create billing plan #637

Closed
wants to merge 7 commits into from
Closed

Feat/create billing plan #637

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cd5342c
feat: adding endpoint to create billing plans
MuthoniMN Feb 28, 2025
e1333a6
docs: updating billing plan documentation
MuthoniMN Feb 28, 2025
0087f72
test: adding test for creating billing plans
MuthoniMN Feb 28, 2025
8a51020
fix: spelling
MuthoniMN Feb 28, 2025
683b467
fix: using the same request body as nestjs
MuthoniMN Feb 28, 2025
dd9a7fa
fix(test): providing correct mock data
MuthoniMN Feb 28, 2025
3d3268b
Merge branch 'dev' into feat/create-billing-plan
MuthoniMN Mar 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 45 additions & 1 deletion app/Http/Controllers/BillingPlanController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,51 @@ public function create()
*/
public function store(Request $request)
{
//
$validated = $request->validate([
'name' => 'required|string|max:255',
'frequency' => 'required|string|in:Monthly,Yearly',
'is_active' => 'boolean',
'amount' => 'required|numeric|min:0',
'description' => 'required|string',
]);

try {
$billingPlan = SubscriptionPlan::where('name', '=', $validated['name'])->first();

if($billingPlan){
return response()->json([
"status" => "error",
"status_code" => 403,
"message" => "Billing plan already exists!",
"data" => []
], 403);
}

$billingPlan = new SubscriptionPlan;
$billingPlan->name = $validated['name'];
$billingPlan->duration = $validated['frequency'];
$billingPlan->price = $validated['amount'];
$billingPlan->description = $validated['description'];
$billingPlan->save();

return response()->json([
"status" => "success",
"status_code" => 201,
"message" => "Billing plan successfully created!",
"data" => [
...$billingPlan->toArray()
]
], 201);

} catch (\Throwable $th) {
print_r($th);
return response()->json([
"status" => "error",
"status_code" => 500,
"message" => "Internal Server Error!",
"data" => []
], 500);
}
}

/**
Expand Down
100 changes: 98 additions & 2 deletions resources/docs/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -603,6 +603,57 @@
}
},
"/api/v1/billing-plans": {
"post": {
"summary": "Create new billing plan",
"tags": ["Billing"],
"security": [
{
"bearerAuth": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillingPlan"
}
}
}
},
"responses": {
"201": {
"description": "Billing plan created successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillingPlanResponse"
}
}
}
},
"403": {
"description": "Billing plan already exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"get": {
"summary": "Get billing plans",
"tags": ["Billing"],
Expand Down Expand Up @@ -633,14 +684,59 @@
}
}
},
"delete": {
"summary": "Delete billing plan",
"put": {
"summary": "Update billing plan",
"tags": ["Billing"],
"security": [
{
"bearerAuth": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillingPlan"
}
}
}
},
"responses": {
"201": {
"description": "Billing plan created successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillingPlanResponse"
}
}
}
},
"404": {
"description": "Billing plan not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"summary": "Delete billing plan",
"parameters": [
{
"name": "id",
Expand Down
1 change: 1 addition & 0 deletions routes/api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@
Route::delete('/products/{product_id}', [ProductController::class, 'delete']);

Route::get('/billing-plans', [BillingPlanController::class, 'index']);
Route::post('/billing-plans', [BillingPlanController::class, 'store']);
Route::get('/billing-plans/{id}', [BillingPlanController::class, 'getBillingPlan']);
Route::put('/billing-plans/{id}', [BillingPlanController::class, 'update']);
Route::delete('/billing-plans/{id}', [BillingPlanController::class, 'destroy']);
Expand Down
57 changes: 57 additions & 0 deletions tests/Feature/BillingPlanControllerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,63 @@ class BillingPlanControllerTest extends TestCase
{
use RefreshDatabase;

/** @test */
public function it_creates_a_billing_plan_successfully()
{
$user = User::factory()->create();
$this->actingAs($user);
$saved = SubscriptionPlan::where('name', '=', 'Discounted Plan')->first();

if($saved) $saved->delete();

$data = [
'name' => 'Discounted Plan',
'frequency' => 'Yearly',
'amount' => 20000,
'is_active' => true,
'description' => 'A discounted plan description',
];

$response = $this->postJson("/api/v1/billing-plans", $data);

// Assert: Check the response status and structure
$response->assertStatus(201)
->assertJsonStructure([
'data' => [
'id',
'name',
'duration',
'price',
'description',
'created_at',
'updated_at',
],
'message',
'status_code',
'status'
]);

$this->assertDatabaseHas('subscription_plans', [
'name' => 'Discounted Plan',
'duration' => 'Yearly',
'price' => 20000,
'description' => 'A discounted plan description',
]);


$res = $this->postJson("/api/v1/billing-plans", $data);

// Assert: Check the response status and structure
$res->assertStatus(403)
->assertJsonStructure([
'data' => [],
'message',
'status_code',
'status'
]);

}

/** @test */
public function it_updates_a_billing_plan_successfully()
{
Expand Down
Loading