Merge branch '293_order_address_change' into '319_order_address_change_ui'

merge change order address api

See merge request CIEFWorldwideSdnBhd/shipping-portal!47

app/Classes/Modules/Addresses/DataTransferObjects/AddressObject.php

@@ -3,6 +3,7 @@
 namespace App\Classes\Modules\Addresses\DataTransferObjects;
 
 use App\Classes\General\Interfaces\DataTransferObject;
+use App\Classes\ValueObjects\Constants\ApprovalStatus;
 
 class AddressObject implements DataTransferObject
 {
@@ -38,7 +39,7 @@ class AddressObject implements DataTransferObject
      * @param int $postCode
      * @param null|string $reference
      */
-    public function __construct(string $streetOne, ?string $streetTwo, int $countryId, int $stateId, int $districtId, int $postCode, ?string $reference = null)
+    public function __construct(string $streetOne, ?string $streetTwo, int $countryId, int $stateId, int $districtId, int $postCode, ?string $reference = null, ?int $status = ApprovalStatus::APPROVED)
     {
         $this->streetOne = $streetOne;
         $this->streetTwo = $streetTwo;
@@ -47,6 +48,7 @@ class AddressObject implements DataTransferObject
         $this->districtId = $districtId;
         $this->postCode = $postCode;
         $this->reference = $reference;
+        $this->status = $status;
     }
 
     /**
@@ -105,5 +107,13 @@ class AddressObject implements DataTransferObject
         return $this->reference;
     }
 
+    /**
+     * @return int
+     */
+    public function getStatus(): int
+    {
+        return $this->status;
+    }
+
 
 }

app/Classes/Modules/Addresses/Services/CreatesAddress.php

@@ -28,6 +28,7 @@ class CreatesAddress extends AbstractUpdateRelationshipRecord
         $model->state_id = $object->getStateId();
         $model->district_id = $object->getDistrictId();
         $model->postcode = $object->getPostCode();
+        $model->status = $object->getStatus();
 
         return $this->handler($addressable->addresses(), $model);
 

app/Classes/Modules/Orders/ControllersLogic/ApproveChangeOrderAddressLogic.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace App\Classes\Modules\Orders\ControllersLogic;
+
+use App\Classes\General\Abstracts\AbstractControllerLogic;
+use App\Classes\Modules\Orders\Processors\ApproveChangeOrderAddressProcessor;
+use App\Http\Resources\OrderResource;
+use Illuminate\Http\Request;
+use Illuminate\Http\JsonResponse;
+
+class ApproveChangeOrderAddressLogic extends AbstractControllerLogic
+{
+    /**
+     * @return array
+     */
+    protected function notification(): array
+    {
+        return [
+            'title' => 'Change Order Address Approval',
+            'message' => 'You have successfully change the order address'
+        ];
+    }
+
+    /** @var ApproveChangeOrderAddressProcessor */
+    private $approveChangeOrderAddressProcessor;
+
+    /**
+     * ApproveChangeOrderAddressLogic constructor.
+     * @param ApproveChangeOrderAddressProcessor $approveChangeOrderAddressProcessor
+     */
+
+    public function __construct(ApproveChangeOrderAddressProcessor $approveChangeOrderAddressProcessor)
+    {
+        $this->approveChangeOrderAddressProcessor = $approveChangeOrderAddressProcessor;
+    }
+
+    public function logic(Request $request): JsonResponse
+    {
+        $order = $this->approveChangeOrderAddressProcessor->execute($request);
+
+        return $this->resourceResponse(new OrderResource($order));
+    }
+}

app/Classes/Modules/Orders/ControllersLogic/RequestChangeOrderAddressLogic.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace App\Classes\Modules\Orders\ControllersLogic;
+
+use App\Classes\General\Abstracts\AbstractControllerLogic;
+use App\Classes\Modules\Orders\Processors\RequestChangeOrderAddressProcessor;
+use App\Http\Resources\OrderResource;
+use Illuminate\Http\Request;
+use Illuminate\Http\JsonResponse;
+
+class RequestChangeOrderAddressLogic extends AbstractControllerLogic
+{
+    /**
+     * @return array
+     */
+    protected function notification(): array
+    {
+        return [
+            'title' => 'Request To Change Order Address',
+            'message' => 'You have successfully request to change order address'
+        ];
+    }
+
+    /** @var RequestChangeOrderAddressProcessor */
+    private $requestChangeOrderAddressProcessor;
+
+    /**
+     * RequestChangeOrderAddressLogic constructor.
+     * @param RequestChangeOrderAddressProcessor $requestChangeOrderAddressProcessor
+     */
+
+    public function __construct(RequestChangeOrderAddressProcessor $requestChangeOrderAddressProcessor)
+    {
+        $this->requestChangeOrderAddressProcessor = $requestChangeOrderAddressProcessor;
+    }
+
+    /**
+     * @param Request $request
+     * @return JsonResponse
+     * @throws \App\Classes\Exceptions\MalformedRequestException
+     */
+
+    public function logic(Request $request): JsonResponse
+    {
+        $order = $this->requestChangeOrderAddressProcessor->execute($request);
+
+        return $this->resourceResponse(new OrderResource($order));
+    }
+}

app/Classes/Modules/Orders/Processors/ApproveChangeOrderAddressProcessor.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace App\Classes\Modules\Orders\Processors;
+
+use App\Classes\Modules\Orders\Standards\Rules\CanApproveChangeOrderAddress;
+use App\Classes\Modules\Orders\Services\FetchesOrder;
+use App\Classes\Modules\Addresses\Services\DeletesAddress;
+use App\Classes\Modules\Orders\Services\UpdatesOrdersAddress;
+use App\Classes\ValueObjects\Constants\ApprovalStatus;
+
+use Illuminate\Http\Request;
+
+class ApproveChangeOrderAddressProcessor
+{
+    /** @var CanApproveChangeOrderAddress */
+    private $canApproveChangeOrderAddress;
+
+    /** @var FetchesOrder */
+    private $fetchesOrder;
+
+    /** @var UpdatesOrdersAddress */
+    private $updatesOrdersAddress;
+
+    /** @var DeletesAddress */
+    private $deletesAddress;
+
+    /**
+     * CreateOrderProcessor constructor.
+     * @param CanApproveChangeOrderAddress $canApproveChangeOrderAddress
+     * @param FetchesOrder $fetchesOrder
+     * @param DeletesAddress $deletesAddress
+     * @param UpdatesOrdersAddress $updatesOrdersAddress
+     */
+    public function __construct(CanApproveChangeOrderAddress $canApproveChangeOrderAddress, FetchesOrder $fetchesOrder, DeletesAddress $deletesAddress, UpdatesOrdersAddress $updatesOrdersAddress)
+    {
+        $this->canApproveChangeOrderAddress = $canApproveChangeOrderAddress;
+        $this->fetchesOrder = $fetchesOrder;
+        $this->deletesAddress = $deletesAddress;
+        $this->updatesOrdersAddress = $updatesOrdersAddress;
+    }
+
+
+    public function execute(Request $request)
+    {
+        $this->canApproveChangeOrderAddress->passes();
+
+        $order = $this->fetchesOrder->execute(['id' => $request->get('order_id')]);
+        $this->deletesAddress->execute($order->addressesApproved->first());
+        $this->updatesOrdersAddress->execute($order->addressesPendingVerification->first(), ApprovalStatus::APPROVED);
+
+        return $order;
+    }
+}

app/Classes/Modules/Orders/Processors/RequestChangeOrderAddressProcessor.php

@@ -0,0 +1,66 @@
+<?php
+
+namespace App\Classes\Modules\Orders\Processors;
+
+use App\Classes\Modules\Orders\Standards\Rules\CanChangeOrderAddress;
+use App\Classes\Modules\Orders\Services\FetchesOrder;
+use App\Classes\Modules\Addresses\Services\CreatesAddress;
+use App\Classes\Modules\Addresses\Services\FetchesAddress;
+use App\Classes\Modules\Addresses\Services\DeletesAddress;
+use App\Classes\Modules\Addresses\DataTransferObjects\AddressObject;
+use App\Classes\ValueObjects\Constants\ApprovalStatus;
+
+use Illuminate\Http\Request;
+
+class RequestChangeOrderAddressProcessor
+{
+    /** @var CanChangeOrderAddress */
+    private $canChangeOrderAddress;
+
+    /** @var FetchesOrder */
+    private $fetchesOrder;
+
+    /** @var FetchesAddress */
+    private $fetchesAddress;
+
+    /** @var CreatesAddress */
+    private $createsAddress;
+
+    /** @var DeletesAddress */
+    private $deletesAddress;
+
+    /**
+     * ChangeOrderAddressProcessor constructor.
+     * @param FetchesOrder $fetchesOrder
+     * @param CreatesAddress $createsAddress
+     * @param FetchesAddress $fetchesAddress
+     * @param DeletesAddress $deletesAddress
+     */
+    public function __construct(CanChangeOrderAddress $canChangeOrderAddress, FetchesOrder $fetchesOrder, CreatesAddress $createsAddress, FetchesAddress $fetchesAddress, DeletesAddress $deletesAddress)
+    {
+
+        $this->canChangeOrderAddress = $canChangeOrderAddress;
+        $this->fetchesOrder = $fetchesOrder;
+        $this->createsAddress = $createsAddress;
+        $this->fetchesAddress = $fetchesAddress;
+        $this->deletesAddress = $deletesAddress;
+    }
+
+
+    public function execute(Request $request)
+    {
+
+        $this->canChangeOrderAddress->passes();
+
+        $order = $this->fetchesOrder->execute(['id' => $request->get('order_id')]);
+        foreach ($order->addressesPendingVerification as $address) {
+            $this->deletesAddress->execute($address);
+        }
+
+        $address = $this->fetchesAddress->execute(['id' => $request->get('address_id')]);
+        $addressObject = new AddressObject($address->street_one, $address->street_two, $address->country_id, $address->state_id, $address->district_id, $address->postcode, $address->reference, ApprovalStatus::PENDING_VERIFICATION);
+        $this->createsAddress->execute($order, $addressObject);
+
+        return $order;
+    }
+}

app/Classes/Modules/Orders/Services/UpdatesOrdersAddress.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Classes\Modules\Orders\Services;
+
+use App\Classes\General\Eloquent\AbstractUpdateRecord;
+use App\Models\Address;
+
+class UpdatesOrdersAddress extends AbstractUpdateRecord
+{
+    /**
+     * @param Address $address
+     * @param int $type
+     * @return void
+     */
+    public function execute(Address $address, int $type)
+    {
+        $address->status = $type;
+        return $this->handler($address);
+    }
+}

app/Classes/Modules/Orders/Standards/Rules/CanApproveChangeOrderAddress.php

@@ -0,0 +1,39 @@
+<?php
+
+
+namespace App\Classes\Modules\Orders\Standards\Rules;
+
+use App\Classes\General\Abstracts\AbstractRule;
+
+
+class CanApproveChangeOrderAddress extends AbstractRule
+{
+    /**
+     * @return bool
+     */
+    protected function authorized(): bool
+    {
+        // TODO  Set Authorization rules
+        return true;
+
+    }
+
+    /**
+     * @param OrderObject $object
+     * @return bool
+     */
+    protected function validators($object): bool
+    {
+        return true;
+
+    }
+
+    /**
+     * @param OrderObject $object
+     * @return bool
+     */
+    protected function criteria($object): bool
+    {
+        return true;
+    }
+}

app/Classes/Modules/Orders/Standards/Rules/CanChangeOrderAddress.php

@@ -0,0 +1,39 @@
+<?php
+
+
+namespace App\Classes\Modules\Orders\Standards\Rules;
+
+use App\Classes\General\Abstracts\AbstractRule;
+
+
+class CanChangeOrderAddress extends AbstractRule
+{
+    /**
+     * @return bool
+     */
+    protected function authorized(): bool
+    {
+        // TODO  Set Authorization rules
+        return true;
+
+    }
+
+    /**
+     * @param OrderObject $object
+     * @return bool
+     */
+    protected function validators($object): bool
+    {
+        return true;
+
+    }
+
+    /**
+     * @param OrderObject $object
+     * @return bool
+     */
+    protected function criteria($object): bool
+    {
+        return true;
+    }
+}

app/Http/Controllers/Orders/ApproveChangeOrderAddressController.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Http\Controllers\Orders;
+
+use App\Classes\Modules\Orders\ControllersLogic\ApproveChangeOrderAddressLogic;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+
+class ApproveChangeOrderAddressController
+{
+    /**
+     * @param Request $request
+     * @param ApproveChangeOrderAddressLogic $logic
+     * @return JsonResponse
+     */
+    public function approve(Request $request, ApproveChangeOrderAddressLogic $logic): JsonResponse
+    {
+        return $logic->execute($request);
+    }
+}

app/Http/Controllers/Orders/RequestChangeOrderAddressController.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\Http\Controllers\Orders;
+
+use App\Classes\Modules\Orders\ControllersLogic\RequestChangeOrderAddressLogic;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+
+class RequestChangeOrderAddressController
+{
+    /**
+     * @param Request $request
+     * @param ChangeOrderAddressLogic $logic
+     * @return JsonResponse
+     */
+    public function request(Request $request, RequestChangeOrderAddressLogic $logic): JsonResponse
+    {
+        return $logic->execute($request);
+    }
+}

app/Models/Order.php

@@ -6,6 +6,7 @@ use App\Classes\General\Interfaces\Addressable;
 use App\Classes\General\Interfaces\Contactable;
 use App\Classes\General\Interfaces\Packable;
 use App\Classes\ValueObjects\Constants\RoleTypes;
+use App\Classes\ValueObjects\Constants\ApprovalStatus;
 use App\Scopes\CustomerOrdersScope;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\Relations\HasManyThrough;
@@ -77,4 +78,14 @@ class Order extends AbstractModel implements Addressable, Packable
 //            static::addGlobalScope(new CustomerOrdersScope);
 //        }
     }
+
+    public function addressesPendingVerification()
+    {
+        return $this->addresses()->where('status','=',ApprovalStatus::PENDING_VERIFICATION);
+    }
+
+    public function addressesApproved()
+    {
+        return $this->addresses()->where('status','=',ApprovalStatus::APPROVED);
+    }
 }

resources/views/swagger/json.blade.php

@@ -2430,6 +2430,148 @@
         }
       }
     },
+    "/order/show/{id}": {
+      "get": {
+        "tags": [
+          "Order"
+        ],
+        "produces": [
+          "application/json"
+        ],
+        "operationId": "showOrder",
+        "summary": "Show order",
+        "description": "",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "description": "Order Reference Id",
+            "required": true,
+            "type": "integer"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "successful operation",
+            "headers": {
+              "X-Expires-After": {
+                "type": "string",
+                "format": "date-time",
+                "description": "date in UTC when token expires"
+              },
+              "X-Rate-Limit": {
+                "type": "integer",
+                "format": "int32",
+                "description": "calls per hour allowed by the user"
+              }
+            },
+            "schema": {
+              "type": "string"
+            }
+          },
+          "422": {
+            "description": "Invalid input supplied"
+          }
+        }
+      }
+    },
+    "/order/address/change/request": {
+      "post": {
+        "tags": [
+          "Order"
+        ],
+        "produces": [
+          "application/json"
+        ],
+        "operationId": "requestChangeOrderAddress",
+        "summary": "Request Change Order Address",
+        "description": "",
+        "parameters": [
+          {
+            "name": "order_id",
+            "in": "query",
+            "description": "Order ID",
+            "required": true,
+            "type": "integer"
+          },
+          {
+            "name": "address_id",
+            "in": "query",
+            "description": "New Order Address ID",
+            "required": true,
+            "type": "integer"
+          },
+        ],
+        "responses": {
+          "200": {
+            "description": "successful operation",
+            "headers": {
+              "X-Expires-After": {
+                "type": "string",
+                "format": "date-time",
+                "description": "date in UTC when token expires"
+              },
+              "X-Rate-Limit": {
+                "type": "integer",
+                "format": "int32",
+                "description": "calls per hour allowed by the user"
+              }
+            },
+            "schema": {
+              "type": "string"
+            }
+          },
+          "422": {
+            "description": "Invalid input supplied"
+          }
+        }
+      }
+    },
+    "/order/address/change/approve": {
+      "post": {
+        "tags": [
+          "Order"
+        ],
+        "produces": [
+          "application/json"
+        ],
+        "operationId": "approveChangeOrderAddress",
+        "summary": "Approve Change Order Address",
+        "description": "",
+        "parameters": [
+          {
+            "name": "order_id",
+            "in": "query",
+            "description": "Order ID",
+            "required": true,
+            "type": "integer"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "successful operation",
+            "headers": {
+              "X-Expires-After": {
+                "type": "string",
+                "format": "date-time",
+                "description": "date in UTC when token expires"
+              },
+              "X-Rate-Limit": {
+                "type": "integer",
+                "format": "int32",
+                "description": "calls per hour allowed by the user"
+              }
+            },
+            "schema": {
+              "type": "string"
+            }
+          },
+          "422": {
+            "description": "Invalid input supplied"
+          }
+        }
+      }
+    },
     "/address/create": {
       "post": {
         "tags": [

routes/order.php

@@ -9,4 +9,6 @@ Route::group(['prefix' => 'order', 'as' => 'order.', 'namespace' => 'Orders'], f
     Route::put('/confirm/{id}', 'ConfirmOrderController@confirm')->name('confirm');
     Route::put('/cancel/{id}', 'CancelOrderController@cancel')->name('cancel');
     Route::put('/restore/{id}', 'RestoreOrderController@restore')->name('restore');
+    Route::post('/address/change/request', 'RequestChangeOrderAddressController@request')->name('address.change.request');
+    Route::post('/address/change/approve', 'ApproveChangeOrderAddressController@approve')->name('address.change.approve');
 });