refactor: move métodos do Model para Trait

src/GuSubscriptionTrait.php

@@ -0,0 +1,230 @@
+<?php
+
+namespace Potelo\GuPayment;
+
+use Carbon\Carbon;
+use Potelo\GuPayment\Iugu\IuguSubscriptionDecorator;
+
+/**
+ * @mixin \Illuminate\Database\Eloquent\Model
+ */
+trait GuSubscriptionTrait
+{
+    /**
+     * Get the user that owns the subscription.
+     */
+    public function user()
+    {
+        $model = getenv('IUGU_MODEL') ?: config('services.iugu.model');
+        $column = getenv('IUGU_MODEL_FOREIGN_KEY') ?: config('services.iugu.model_foreign_key', 'user_id');
+
+        if (in_array("Illuminate\Database\Eloquent\SoftDeletes", class_uses($model))) {
+            return $this->belongsTo($model, $column)->withTrashed();
+        }
+
+        return $this->belongsTo($model, $column);
+    }
+
+    /**
+     * Determine if the subscription is active, on trial, or within its grace period.
+     *
+     * @return bool
+     */
+    public function valid()
+    {
+        return $this->active() || $this->onTrial() || $this->onGracePeriod();
+    }
+
+    /**
+     * Determine if the subscription is active.
+     *
+     * @return bool
+     */
+    public function active()
+    {
+        return is_null($this->ends_at) || $this->onGracePeriod();
+    }
+
+    /**
+     * Determine if the subscription is no longer active.
+     *
+     * @return bool
+     */
+    public function cancelled()
+    {
+        return ! is_null($this->ends_at);
+    }
+
+    /**
+     * Determine if the subscription is within its trial period.
+     *
+     * @return bool
+     */
+    public function onTrial()
+    {
+        if (! is_null($this->trial_ends_at)) {
+            return Carbon::today()->lt($this->trial_ends_at);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * Determine if the subscription is within its grace period after cancellation.
+     *
+     * @return bool
+     */
+    public function onGracePeriod()
+    {
+        if (! is_null($endsAt = $this->ends_at)) {
+            return Carbon::now()->lt(Carbon::instance($endsAt));
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * Swap the subscription to a new Iugu plan.
+     *
+     * @param  string  $plan
+     * @return bool|\Iugu_SearchResult
+     */
+    public function swapPlanSimulation($plan)
+    {
+        $subscription = $this->asIuguSubscription();
+
+        $decorated = new IuguSubscriptionDecorator($subscription);
+
+        $simulation = $decorated->change_plan_simulation($plan);
+
+        return $simulation;
+    }
+
+    /**
+     * Swap the subscription to a new Iugu plan.
+     *
+     * @param string $plan
+     * @param bool $skipCharge
+     * @param \Carbon\Carbon $expiresAt
+     * @return $this
+     */
+    public function swap($plan, $skipCharge = false, Carbon $expiresAt = null)
+    {
+        $subscription = $this->asIuguSubscription();
+
+        // if skip charge, use put method
+        if ($skipCharge) {
+            $subscription->plan_identifier = $plan;
+            $subscription->skip_charge = true;
+            if ($expiresAt) {
+                $subscription->expires_at = $expiresAt->format('Y-m-d');
+            }
+            $subscription->save();
+        } else {
+            $subscription->change_plan($plan);
+        }
+
+        $this->fill([
+            $this->iuguSubscriptionModelPlanColumn => $plan,
+            'ends_at' => null,
+        ])->save();
+
+        return $this;
+    }
+
+    /**
+     * Cancel the subscription at the end of the billing period.
+     *
+     * @return $this
+     */
+    public function cancel()
+    {
+        $subscription = $this->asIuguSubscription();
+
+        $subscription->suspend();
+
+        // If the user was on trial, we will set the grace period to end when the trial
+        // would have ended. Otherwise, we'll retrieve the end of the billing period
+        // period and make that the end of the grace period for this current user.
+        if ($this->onTrial()) {
+            $this->ends_at = $this->trial_ends_at;
+        } else {
+            $this->ends_at = is_null($subscription->expires_at)
+                ? Carbon::now()
+                : new Carbon($subscription->expires_at);
+        }
+
+        $this->save();
+
+        return $this;
+    }
+
+    /**
+     * Cancel the subscription immediately.
+     *
+     * @return $this
+     */
+    public function cancelNow()
+    {
+        $subscription = $this->asIuguSubscription();
+
+        $subscription->suspend();
+
+        $this->markAsCancelled();
+
+        return $this;
+    }
+
+    /**
+     * Mark the subscription as cancelled.
+     *
+     * @return void
+     */
+    public function markAsCancelled()
+    {
+        $this->fill(['ends_at' => Carbon::now()])->save();
+    }
+
+    /**
+     * Resume the cancelled subscription.
+     *
+     * @return $this
+     *
+     * @throws \LogicException
+     */
+    public function resume()
+    {
+        $subscription = $this->asIuguSubscription();
+
+        $subscription->activate();
+
+        // Finally, we will remove the ending timestamp from the user's record in the
+        // local database to indicate that the subscription is active again and is
+        // no longer "cancelled". Then we will save this record in the database.
+        $this->fill(['ends_at' => null])->save();
+
+        return $this;
+    }
+
+    /**
+     * @param $iuguSubscription
+     */
+    public function setCacheIuguSubscription($iuguSubscription)
+    {
+        $this->cacheIuguSubscription = $iuguSubscription;
+    }
+
+    /**
+     * Get the subscription as a Iugu subscription object.
+     *
+     * @return \Iugu_Subscription
+     */
+    public function asIuguSubscription($useCache = false)
+    {
+        if ( $useCache && ! is_null($this->cacheIuguSubscription) ) {
+            return $this->cacheIuguSubscription;
+        }
+
+        return $this->cacheIuguSubscription = $this->user->getIuguSubscription($this->{$this->iuguSubscriptionModelIdColumn});
+    }
+}