Some changes for easier extendability (for example in Vouchers packag…

…e) (#49)

* Some changes for easier extendability (for example in Vouchers package)

* Endpoint for finding Product with type `single` for given Productable

* Add return types to Resources `toArray` method

src/Http/Controllers/Admin/ProductableAdminApiController.php

@@ -4,7 +4,9 @@
 
 use EscolaLms\Cart\Http\Requests\Admin\ProductableAttachRequest;
 use EscolaLms\Cart\Http\Requests\Admin\ProductableDetachRequest;
+use EscolaLms\Cart\Http\Requests\Admin\ProductableProductRequest;
 use EscolaLms\Cart\Http\Requests\Admin\ProductableRegisteredListRequest;
+use EscolaLms\Cart\Http\Resources\ProductResource;
 use EscolaLms\Cart\Http\Swagger\Admin\ProductableAdminSwagger;
 use EscolaLms\Cart\Services\Contracts\ProductServiceContract;
 use EscolaLms\Cart\Services\Contracts\ShopServiceContract;
@@ -38,6 +40,16 @@ public function detach(ProductableDetachRequest $request): JsonResponse
         return $this->sendSuccess(__('Productable detached from user'));
     }
 
+    public function product(ProductableProductRequest $request): JsonResponse
+    {
+        $productable = $this->productService->findProductable($request->getProductableType(), $request->getProductableId());
+        $product = $this->productService->findSingleProductForProductable($productable);
+        if ($product) {
+            return $this->sendResponseForResource(ProductResource::make($product), __('Single Product for Productable found'));
+        }
+        return $this->sendError(__('Single Product for this productable does not exist'), 404);
+    }
+
     public function registered(ProductableRegisteredListRequest $request): JsonResponse
     {
         return $this->sendResponse($this->productService->listRegisteredProductableClasses(), __('List of registered Productable types'));

src/Http/Requests/Admin/ProductableProductRequest.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace EscolaLms\Cart\Http\Requests\Admin;
+
+use EscolaLms\Cart\Enums\CartPermissionsEnum;
+use EscolaLms\Cart\Rules\ProductableExistsRule;
+use EscolaLms\Cart\Rules\ProductableRegisteredRule;
+use Illuminate\Foundation\Http\FormRequest;
+
+class ProductableProductRequest extends FormRequest
+{
+    public function authorize()
+    {
+        return $this->user()->can(CartPermissionsEnum::MANAGE_PRODUCTS);
+    }
+
+    public function rules(): array
+    {
+        return [
+            'productable_id' => ['required', new ProductableExistsRule()],
+            'productable_type' => ['required', 'string', new ProductableRegisteredRule()],
+        ];
+    }
+
+    public function getProductableId(): int
+    {
+        return $this->validated()['productable_id'];
+    }
+
+    public function getProductableType(): string
+    {
+        return $this->validated()['productable_type'];
+    }
+}

src/Http/Resources/CartItemResource.php

@@ -21,7 +21,7 @@ protected function getCartItem(): CartItem
         return $this->resource;
     }
 
-    public function toArray($request)
+    public function toArray($request): array
     {
         return self::apply([
             'id' => $this->getCartItem()->getKey(),

src/Http/Resources/CartResource.php

@@ -5,6 +5,7 @@
 use EscolaLms\Auth\Traits\ResourceExtandable;
 use EscolaLms\Cart\Models\Cart;
 use Illuminate\Http\Resources\Json\JsonResource;
+use Illuminate\Http\Resources\Json\ResourceCollection;
 
 class CartResource extends JsonResource
 {
@@ -23,13 +24,18 @@ protected function getCart(): Cart
         return $this->resource;
     }
 
-    public function toArray($request)
+    protected function getCartItemsResourceCollection(): ResourceCollection
+    {
+        return  CartItemResource::collection($this->getCart()->items);
+    }
+
+    public function toArray($request): array
     {
         return self::apply([
             'total' => $this->getCart()->total,
             'subtotal' =>  $this->getCart()->subtotal,
             'tax' =>  $this->getCart()->getTaxAttribute($this->taxRate),
-            'items' => CartItemResource::collection($this->getCart()->items)
+            'items' => $this->getCartItemsResourceCollection()
         ], $this);
     }
 }

src/Http/Resources/OrderItemResource.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace EscolaLms\Cart\Http\Resources;
+
+use EscolaLms\Auth\Traits\ResourceExtandable;
+use EscolaLms\Cart\Models\OrderItem;
+use EscolaLms\Cart\Models\Product;
+use Illuminate\Http\Resources\Json\JsonResource;
+
+class OrderItemResource extends JsonResource
+{
+    use ResourceExtandable;
+
+    public function __construct(OrderItem $orderItem)
+    {
+        parent::__construct($orderItem);
+    }
+
+    protected function getOrderItem(): OrderItem
+    {
+        return $this->resource;
+    }
+
+    public function toArray($request): array
+    {
+        return self::apply([
+            'price' =>  $this->getOrderItem()->price,
+            'quantity' => $this->getOrderItem()->quantity,
+            'subtotal' =>  $this->getOrderItem()->subtotal,
+            'tax' =>  $this->getOrderItem()->tax,
+            'total' => $this->getOrderItem()->total,
+            'total_with_tax' => $this->getOrderItem()->total_with_tax,
+            'order_id' => $this->getOrderItem()->order_id,
+            'product_id' => $this->getOrderItem()->buyable_id,
+            'product_type' => $this->getOrderItem()->buyable_type,
+            $this->mergeWhen($this->getOrderItem()->buyable instanceof Product, fn () => ['product' => ProductResource::make($this->getOrderItem()->buyable)]),
+        ], $this);
+    }
+}

src/Http/Resources/OrderResource.php

@@ -2,12 +2,16 @@
 
 namespace EscolaLms\Cart\Http\Resources;
 
+use EscolaLms\Auth\Traits\ResourceExtandable;
 use EscolaLms\Cart\Enums\OrderStatus;
 use EscolaLms\Cart\Models\Order;
 use Illuminate\Http\Resources\Json\JsonResource;
+use Illuminate\Http\Resources\Json\ResourceCollection;
 
 class OrderResource extends JsonResource
 {
+    use ResourceExtandable;
+
     public function __construct(Order $order)
     {
         parent::__construct($order);
@@ -18,18 +22,17 @@ protected function getOrder(): Order
         return $this->resource;
     }
 
-    /**
-     * Transform the resource into an array.
-     *
-     * @param \Illuminate\Http\Request $request
-     * @return array
-     */
-    public function toArray($request)
+    protected function getOrderItemsResourceCollection(): ResourceCollection
+    {
+        return OrderItemResource::collection($this->getOrder()->items);
+    }
+
+    public function toArray($request): array
     {
-        return [
+        return self::apply([
             'id' => $this->resource->getKey(),
             'status' => OrderStatus::getName($this->status),
-            'items' => $this->items->toArray(),
+            'items' => $this->getOrderItemsResourceCollection(),
             'total' => $this->total,
             'subtotal' => $this->subtotal,
             'tax' => $this->tax,
@@ -42,6 +45,6 @@ public function toArray($request)
             'client_country' => $this->client_country,
             'client_company' => $this->client_company,
             'client_taxid' => $this->client_taxid,
-        ];
+        ], $this);
     }
 }

src/Http/Resources/ProductResource.php

@@ -21,7 +21,7 @@ protected function getProduct(): Product
         return $this->resource;
     }
 
-    public function toArray($request)
+    public function toArray($request): array
     {
         $user = $request ? $request->user() : Auth::user();
         return [

src/Http/Resources/ProductableGenericResource.php

@@ -19,7 +19,7 @@ public function getProductable(): Productable
         return $this->resource;
     }
 
-    public function toArray($request)
+    public function toArray($request): array
     {
         return [
             'id' => $this->getProductable()->getKey(),

src/Http/Swagger/Admin/ProductableAdminSwagger.php

@@ -4,6 +4,7 @@
 
 use EscolaLms\Cart\Http\Requests\Admin\ProductableAttachRequest;
 use EscolaLms\Cart\Http\Requests\Admin\ProductableDetachRequest;
+use EscolaLms\Cart\Http\Requests\Admin\ProductableProductRequest;
 use EscolaLms\Cart\Http\Requests\Admin\ProductableRegisteredListRequest;
 use Illuminate\Http\JsonResponse;
 
@@ -167,4 +168,64 @@ public function detach(ProductableDetachRequest $request): JsonResponse;
      *   )
      */
     public function registered(ProductableRegisteredListRequest $request): JsonResponse;
+
+    /**
+     * @OA\Get(
+     *      path="/api/admin/productables/product",
+     *      description="Get single product for this productable (if it exists)",
+     *      tags={"Admin Product"},
+     *      security={
+     *          {"passport": {}},
+     *      },
+     *      @OA\Parameter(
+     *          name="productable_type",
+     *          description="Productable class",
+     *          required=true,
+     *          in="query",
+     *          @OA\Schema(
+     *              type="string",
+     *          ),
+     *      ),
+     *      @OA\Parameter(
+     *          name="productable_id",
+     *          description="Productable id",
+     *          required=true,
+     *          in="query",
+     *          @OA\Schema(
+     *              type="integer",
+     *          ),
+     *      ),
+     *      @OA\Response(
+     *          response=200,
+     *          description="successful operation",
+     *          @OA\MediaType(
+     *              mediaType="application/json",
+     *          ),
+     *          @OA\Schema(
+     *              type="object",
+     *              @OA\Property(
+     *                  property="data",
+     *                  type="object",
+     *                  @OA\Schema(ref="#/components/schemas/Product")
+     *              ),
+     *              @OA\Property(
+     *                  property="success",
+     *                  type="boolean"
+     *              ),
+     *              @OA\Property(
+     *                  property="message",
+     *                  type="string"
+     *              )
+     *          )
+     *      ),
+     *      @OA\Response(
+     *          response=422,
+     *          description="Bad request",
+     *          @OA\MediaType(
+     *              mediaType="application/json"
+     *          )
+     *      )
+     *   )
+     */
+    public function product(ProductableProductRequest $request): JsonResponse;
 }

src/Models/Cart.php

@@ -15,6 +15,7 @@
  * @property int|null $user_id
  * @property \Illuminate\Support\Carbon|null $created_at
  * @property \Illuminate\Support\Carbon|null $updated_at
+ * @property-read CartManager $cart_manager
  * @property-read int $subtotal
  * @property-read int $tax
  * @property-read int $total
@@ -33,8 +34,6 @@
  */
 class Cart extends BaseCart
 {
-    private ?CartManager $cartManager = null;
-
     public function user(): BelongsTo
     {
         return $this->belongsTo(User::class);
@@ -45,24 +44,24 @@ public function items(): HasMany
         return $this->hasMany(CartItem::class);
     }
 
-    public function getCartManager(): CartManager
+    public function getCartManagerAttribute(): CartManager
     {
-        return $this->cartManager ?? ($this->cartManager = app(ShopServiceContract::class)->cartManagerForCart($this));
+        return app(ShopServiceContract::class)->cartManagerForCart($this);
     }
 
     public function getSubtotalAttribute(): int
     {
-        return $this->getCartManager()->subtotalInt();
+        return $this->cartManager->subtotalInt();
     }
 
     public function getTotalAttribute(): int
     {
-        return $this->getCartManager()->total();
+        return $this->cartManager->total();
     }
 
     public function getTaxAttribute(?int $rate = null): int
     {
-        return $this->getCartManager()->taxInt($rate);
+        return $this->cartManager->taxInt($rate);
     }
 
     public function getTotalWithTaxAttribute(?int $rate = null): int

src/Models/CartItem.php

@@ -3,6 +3,7 @@
 namespace EscolaLms\Cart\Models;
 
 use EscolaLms\Cart\Models\Contracts\Base\Taxable;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Support\Facades\Config;
 use Treestoneit\ShoppingCart\Models\CartItem as BaseCartItem;
 
@@ -18,6 +19,7 @@
  * @property \Illuminate\Support\Carbon|null $created_at
  * @property \Illuminate\Support\Carbon|null $updated_at
  * @property-read \Illuminate\Database\Eloquent\Model|\Eloquent $buyable
+ * @property-read \EscolaLms\Cart\Models\Cart $cart
  * @property-read mixed $description
  * @property-read float|int $extra_fees
  * @property-read string $identifier
@@ -44,6 +46,11 @@
  */
 class CartItem extends BaseCartItem
 {
+    public function cart(): BelongsTo
+    {
+        return $this->belongsTo(Cart::class);
+    }
+
     public function getTaxRateAttribute(?int $rate = null): int
     {
         if (!$rate && Config::get('shopping-cart.tax.mode') == 'flat') {

src/Models/OrderItem.php

@@ -5,6 +5,8 @@
 use EscolaLms\Cart\QueryBuilders\OrderItemModelQueryBuilder;
 use EscolaLms\Cart\Support\OrderItemCollection;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
 
 /**
  * EscolaLms\Cart\Models\OrderItem
@@ -57,12 +59,12 @@ class OrderItem extends Model
 
     protected $casts = ['options' => 'array'];
 
-    public function buyable()
+    public function buyable(): MorphTo
     {
         return $this->morphTo('buyable');
     }
 
-    public function order()
+    public function order(): BelongsTo
     {
         return $this->belongsTo(Order::class);
     }