Merge branch 'chore/bump-php-min-8.1' of github.com:enmaboya/laravel-shopify; branch 'master' of github.com:Kyon147/laravel-shopify

Author: enmaboya

src/Actions/ActivatePlan.php

@@ -18,116 +18,45 @@
 use Osiset\ShopifyApp\Objects\Values\ShopId;
 use Osiset\ShopifyApp\Services\ChargeHelper;
 
-/**
- * Activates a plan for a shop.
- */
 class ActivatePlan
 {
     /**
-     * The charge helper.
-     *
-     * @var ChargeHelper
-     */
-    protected $chargeHelper;
-
-    /**
-     * Action which cancels the current plan.
-     *
-     * @var callable
-     */
-    protected $cancelCurrentPlan;
-
-    /**
-     * Querier for shops.
-     *
-     * @var IShopQuery
-     */
-    protected $shopQuery;
-
-    /**
-     * Command for charges.
-     *
-     * @var IChargeCommand
-     */
-    protected $chargeCommand;
-
-    /**
-     * Command for shops.
-     *
-     * @var IShopCommand
-     */
-    protected $shopCommand;
-
-    /**
-     * Querier for plans.
-     *
-     * @var IPlanQuery
-     */
-    protected $planQuery;
-
-    /**
-     * Setup.
-     *
-     * @param callable       $cancelCurrentPlanAction Action which cancels the current plan.
-     * @param ChargeHelper   $chargeHelper            The charge helper.
-     * @param IShopQuery     $shopQuery               The querier for shops.
-     * @param IPlanQuery     $planQuery               The querier for plans.
-     * @param IChargeCommand $chargeCommand           The commands for charges.
-     * @param IShopCommand   $shopCommand             The commands for shops.
-     *
-     * @return void
+     * @param callable $cancelCurrentPlan
      */
     public function __construct(
-        callable $cancelCurrentPlanAction,
-        ChargeHelper $chargeHelper,
-        IShopQuery $shopQuery,
-        IPlanQuery $planQuery,
-        IChargeCommand $chargeCommand,
-        IShopCommand $shopCommand
+        protected $cancelCurrentPlan,
+        protected ChargeHelper $chargeHelper,
+        protected IShopQuery $shopQuery,
+        protected IPlanQuery $planQuery,
+        protected IChargeCommand $chargeCommand,
+        protected IShopCommand $shopCommand
     ) {
-        $this->cancelCurrentPlan = $cancelCurrentPlanAction;
-        $this->chargeHelper = $chargeHelper;
-        $this->shopQuery = $shopQuery;
-        $this->planQuery = $planQuery;
-        $this->chargeCommand = $chargeCommand;
-        $this->shopCommand = $shopCommand;
     }
 
     /**
-     * Execution.
      * TODO: Rethrow an API exception.
-     *
-     * @param ShopId          $shopId    The shop ID.
-     * @param PlanId          $planId    The plan to use.
-     * @param ChargeReference $chargeRef The charge ID from Shopify.
-     *
-     * @return ChargeId
      */
     public function __invoke(ShopId $shopId, PlanId $planId, ChargeReference $chargeRef, string $host): ChargeId
     {
-        // Get the shop
         $shop = $this->shopQuery->getById($shopId);
-
-        // Get the plan
         $plan = $this->planQuery->getById($planId);
         $chargeType = ChargeType::fromNative($plan->getType()->toNative());
 
         // Activate the plan on Shopify
         $response = $shop->apiHelper()->activateCharge($chargeType, $chargeRef);
-
         // Cancel the shop's current plan
         call_user_func($this->cancelCurrentPlan, $shopId);
-
         // Cancel the existing charge if it exists (happens if someone refreshes during)
         $this->chargeCommand->delete($chargeRef, $shopId);
 
-        // Create the charge transfer
         $transfer = new ChargeTransfer();
         $transfer->shopId = $shopId;
         $transfer->planId = $planId;
         $transfer->chargeReference = $chargeRef;
         $transfer->chargeType = $chargeType;
         $transfer->chargeStatus = ChargeStatus::fromNative(strtoupper($response['status']));
+        $transfer->planDetails = $this->chargeHelper->details($plan, $shop, $host);
+
         if ($plan->isType(PlanType::RECURRING())) {
             $transfer->activatedOn = new Carbon($response['activated_on']);
             $transfer->billingOn = new Carbon($response['billing_on']);
@@ -137,9 +66,7 @@ public function __invoke(ShopId $shopId, PlanId $planId, ChargeReference $charge
             $transfer->billingOn = null;
             $transfer->trialEndsOn = null;
         }
-        $transfer->planDetails = $this->chargeHelper->details($plan, $shop, $host);
 
-        // Create the charge
         $charge = $this->chargeCommand->make($transfer);
         $this->shopCommand->setToPlan($shopId, $planId);
 

src/Actions/ActivateUsageCharge.php

@@ -13,89 +13,45 @@
 use Osiset\ShopifyApp\Objects\Values\ShopId;
 use Osiset\ShopifyApp\Services\ChargeHelper;
 
-/**
- * Activates a usage charge for a shop.
- */
 class ActivateUsageCharge
 {
-    /**
-     * The helper for charges.
-     *
-     * @var ChargeHelper
-     */
-    protected $chargeHelper;
-
-    /**
-     * Command for charges.
-     *
-     * @var IChargeCommand
-     */
-    protected $chargeCommand;
-
-    /**
-     * Querier for shops.
-     *
-     * @var IShopQuery
-     */
-    protected $shopQuery;
-
-    /**
-     * Setup.
-     *
-     * @param ChargeHelper   $chargeHelper  The helper for charges.
-     * @param IChargeCommand $chargeCommand The commands for charges.
-     * @param IShopQuery     $shopQuery     The querier for shops.
-     *
-     * @return void
-     */
     public function __construct(
-        ChargeHelper $chargeHelper,
-        IChargeCommand $chargeCommand,
-        IShopQuery $shopQuery
+        protected ChargeHelper $chargeHelper,
+        protected IChargeCommand $chargeCommand,
+        protected IShopQuery $shopQuery
     ) {
-        $this->chargeHelper = $chargeHelper;
-        $this->chargeCommand = $chargeCommand;
-        $this->shopQuery = $shopQuery;
     }
 
     /**
-     * Execute.
      * TODO: Rethrow an API exception.
      *
-     * @param ShopId                    $shopId The shop ID.
-     * @param UsageChargeDetailsTransfer $ucd    The usage charge details (without charge ID).
-     *
      * @throws ChargeNotRecurringException
-     *
-     * @return ChargeId|bool
      */
-    public function __invoke(ShopId $shopId, UsageChargeDetailsTransfer $ucd)
+    public function __invoke(ShopId $shopId, UsageChargeDetailsTransfer $ucd): ChargeId|bool
     {
-        // Get the shop
         $shop = $this->shopQuery->getById($shopId);
-
         // Ensure we have a recurring charge
         $currentCharge = $this->chargeHelper->chargeForPlan($shop->plan->getId(), $shop);
+
         if (! $currentCharge->isType(ChargeType::RECURRING())) {
             throw new ChargeNotRecurringException('Can only create usage charges for recurring charge.');
         }
 
         // Create the usage charge
         $ucd->chargeReference = $currentCharge->getReference();
         $response = $shop->apiHelper()->createUsageCharge($ucd);
+
         if (! $response) {
             // Could not make usage charge, limit possibly reached
             return false;
         }
 
-        // Create the transfer
-        $uct = new UsageChargeTransfer();
-        $uct->shopId = $shopId;
-        $uct->planId = $shop->plan->getId();
-        $uct->chargeReference = ChargeReference::fromNative((int) $response['id']);
-        $uct->details = $ucd;
+        $transfer = new UsageChargeTransfer();
+        $transfer->shopId = $shopId;
+        $transfer->planId = $shop->plan->getId();
+        $transfer->chargeReference = ChargeReference::fromNative((int) $response['id']);
+        $transfer->details = $ucd;
 
-        // Save the usage charge
-        return $this->chargeCommand->makeUsage($uct);
+        return $this->chargeCommand->makeUsage($transfer);
     }
 }

src/Actions/AfterAuthorize.php

@@ -8,55 +8,23 @@
 use Osiset\ShopifyApp\Contracts\ShopModel as IShopModel;
 use Osiset\ShopifyApp\Util;
 
-/**
- * Run after authentication jobs.
- */
 class AfterAuthorize
 {
-    /**
-     * Querier for shops.
-     *
-     * @var IShopQuery
-     */
-    protected $shopQuery;
-
-    /**
-     * Setup.
-     *
-     * @param IShopQuery $shopQuery The querier for the shop.
-     *
-     * @return void
-     */
-    public function __construct(IShopQuery $shopQuery)
+    public function __construct(protected IShopQuery $shopQuery)
     {
-        $this->shopQuery = $shopQuery;
     }
 
     /**
-     * Execution.
      * TODO: Rethrow an API exception.
-     *
-     * @param ShopIdValue $shopId The shop ID.
-     *
-     * @return bool
      */
     public function __invoke(ShopIdValue $shopId): bool
     {
-        /**
-         * Fires the job.
-         *
-         * @param array      $config The job's configuration.
-         * @param IShopModel $shop   The shop instance.
-         *
-         * @return bool
-         */
         $fireJob = function (array $config, IShopModel $shop): bool {
             $job = Arr::get($config, 'job');
+
             if (Arr::get($config, 'inline', false)) {
-                // Run this job immediately
                 $job::dispatchSync($shop);
             } else {
-                // Run later
                 $job::dispatch($shop)
                     ->onConnection(Util::getShopifyConfig('job_connections')['after_authenticate'])
                     ->onQueue(Util::getShopifyConfig('job_queues')['after_authenticate']);
@@ -65,25 +33,19 @@ public function __invoke(ShopIdValue $shopId): bool
             return true;
         };
 
-        // Get the shop
         $shop = $this->shopQuery->getById($shopId);
-
-        // Grab the jobs config
         $jobsConfig = Util::getShopifyConfig('after_authenticate_job');
+
         if (Arr::has($jobsConfig, 0)) {
-            // We have multi-jobs
             foreach ($jobsConfig as $jobConfig) {
-                // We have a job, pass the shop object to the constructor
                 $fireJob($jobConfig, $shop);
             }
 
             return true;
         } elseif (Arr::has($jobsConfig, 'job')) {
-            // We have a single job
             return $fireJob($jobsConfig, $shop);
         }
 
-        // We have no jobs
         return false;
     }
 }