22digital / laravel-cashier-fastspring

src/Subscription.php

<?php
/**
 * This file implements a Subscription.
 *
 * @author    Bilal Gultekin <bilal@gultekin.me>
 * @author    Justin Hartman <justin@22digital.co.za>
 * @copyright 2019 22 Digital
 * @license   MIT
 * @since     v0.1
 */

namespace TwentyTwoDigital\CashierFastspring;

use Carbon\Carbon;
use Exception;
use Illuminate\Database\Eloquent\Model;
use LogicException;
use TwentyTwoDigital\CashierFastspring\Fastspring\Fastspring;

/**
 * This class describes a subscription.
 *
 * {@inheritdoc}
 */
class Subscription extends Model
{
    /**
     * The attributes that are not mass assignable.
     *
     * @var array
     */
    protected $guarded = [];

    /**
     * The attributes that should be mutated to dates.
     *
     * @var array
     */
    protected $dates = [
        'created_at', 'updated_at', 'swap_at',
    ];

    /**
     * The date on which the billing cycle should be anchored.
     *
     * @var string|null
     */
    protected $billingCycleAnchor = null;

    /**
     * Get the user that owns the subscription.
     */
    public function user()
    {
        return $this->owner();
    }

    /**
     * Get periods of the subscription.
     */
    public function periods()
    {
        return $this->hasMany('TwentyTwoDigital\CashierFastspring\SubscriptionPeriod');
    }

    /**
     * Get active period of the subscription.
     */
    public function activePeriod()
    {
        return $this->hasOne('TwentyTwoDigital\CashierFastspring\SubscriptionPeriod')
                    ->where('start_date', '<=', Carbon::now()->format('Y-m-d H:i:s'))
                    ->where('end_date', '>=', Carbon::now()->format('Y-m-d H:i:s'))
                    ->where('type', $this->type());
    }

    /**
     * Get active period or retrieve the active period from fastspring and create.
     *
     * Note: This is not eloquent relation, it returns SubscriptionPeriod model directly.
     *
     * @return \TwentyTwoDigital\CashierFastspring\SubscriptionPeriod
     */
    public function activePeriodOrCreate()
    {
        if ($this->isFastspring()) {
            return $this->activeFastspringPeriodOrCreate();
        }

        return $this->activeLocalPeriodOrCreate();
    }

    /**
     * Get active fastspring period or retrieve the active period from fastspring and create.
     *
     * @return \TwentyTwoDigital\CashierFastspring\SubscriptionPeriod
     */
    public function activeFastspringPeriodOrCreate()
    {
        // activePeriod is not used on purpose
        // because it caches and causes confusion
        // after this method is called
        $today = Carbon::today()->format('Y-m-d');

        $activePeriod = SubscriptionPeriod::where('subscription_id', $this->id)
            ->where('start_date', '<=', $today)
            ->where('end_date', '>=', $today)
            ->where('type', 'fastspring')
            ->first();

        // if there is any return it
        if ($activePeriod) {
            return $activePeriod;
        }

        return $this->createPeriodFromFastspring();
    }

    /**
     * Get active local period or create.
     *
     * @return \TwentyTwoDigital\CashierFastspring\SubscriptionPeriod
     */
    public function activeLocalPeriodOrCreate()
    {
        // activePeriod is not used on purpose
        // because it caches and causes confusion
        // after this method is called
        $today = Carbon::today()->format('Y-m-d');

        $activePeriod = SubscriptionPeriod::where('subscription_id', $this->id)
            ->where('start_date', '<=', $today)
            ->where('end_date', '>=', $today)
            ->where('type', 'local')
            ->first();

        // if there is any return it
        if ($activePeriod) {
            return $activePeriod;
        }

        return $this->createPeriodLocally();
    }

    /**
     * Create period with the information from fastspring.
     *
     * @return \TwentyTwoDigital\CashierFastspring\SubscriptionPeriod
     */
    protected function createPeriodFromFastspring()
    {
        $response = Fastspring::getSubscriptionsEntries([$this->fastspring_id]);

        $period = [
            // there is no info related to type in the entries endpoint
            // so we assume it is regular type
            // because we create first periods (especially including trial if there is any)
            // at the subscription creation
            'type' => 'fastspring',

            // dates
            'start_date'      => $response[0]->beginPeriodDate,
            'end_date'        => $response[0]->endPeriodDate,
            'subscription_id' => $this->id,
        ];

        // try to find or create
        return SubscriptionPeriod::firstOrCreate($period);
    }

    /**
     * Create period for non-fastspring/local subscriptions.
     *
     * Simply finds latest and add its dates $interval_length * $interval_unit
     * If there is no subscription period, it creates a subscription period started today
     *
     * @throws \Exception
     *
     * @return \TwentyTwoDigital\CashierFastspring\SubscriptionPeriod
     */
    protected function createPeriodLocally()
    {
        $lastPeriod = $this->periods()->orderBy('end_date', 'desc')->first();
        $today = Carbon::today();

        // there may be times subscriptionperiods not created more than
        // interval_length * interval_unit
        // For this kind of situations, we should fill the blank (actually we dont
        // have to but while we are calculating it is nice to save them)
        do {
            // add interval value to it to create next start_date
            // and sub one day to get next end_date
            switch ($this->interval_unit) {
                // fastspring adds month without overflow
                // so lets we do the same
                case 'month':
                    $start_date = $lastPeriod
                        ? $lastPeriod->start_date->addMonthsNoOverflow($this->interval_length)
                        : Carbon::now();

                    $end_date = $start_date->copy()->addMonthsNoOverflow($this->interval_length)->subDay();
                    break;

                case 'week':
                    $start_date = $lastPeriod
                        ? $lastPeriod->start_date->addWeeks($this->interval_length)
                        : Carbon::now();

                    $end_date = $start_date->copy()->addWeeks($this->interval_length)->subDay();
                    break;

                // probably same thing with the year
                case 'year':
                    $start_date = $lastPeriod
                        ? $lastPeriod->start_date->addYearsNoOverflow($this->interval_length)
                        : Carbon::now();

                    $end_date = $start_date->copy()->addYearsNoOverflow($this->interval_length)->subDay();
                    break;

                default:
                    throw new Exception('Unexcepted interval unit: ' . $subscription->interval_unit);

The variable $subscription does not exist. Did you maybe mean $subscriptionPeriodData?

            }

            $subscriptionPeriodData = [
                'type'            => 'local',
                'start_date'      => $start_date->format('Y-m-d'),
                'end_date'        => $end_date->format('Y-m-d'),
                'subscription_id' => $this->id,
            ];

            $lastPeriod = SubscriptionPeriod::firstOrCreate($subscriptionPeriodData);
        } while (!($today->greaterThanOrEqualTo($lastPeriod->start_date)
            && $today->lessThanOrEqualTo($lastPeriod->end_date)
        ));

        return $lastPeriod;
    }

    /**
     * Get the model related to the subscription.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function owner()
    {
        $model = getenv('FASTSPRING_MODEL') ?: config('services.fastspring.model', 'App\\User');

        $model = new $model();

        return $this->belongsTo(get_class($model), $model->getForeignKey());
    }

    /**
     * Determine if the subscription is valid.
     * This includes following states on fastspring: active, trial, overdue, canceled.
     * The only state that you should stop serving is deactivated state.
     *
     * @return bool
     */
    public function valid()
    {
        return !$this->deactivated();
    }

    /**
     * Determine if the subscription is active.
     *
     * @return bool
     */
    public function active()
    {
        return $this->state == 'active';
    }

    /**
     * Determine if the subscription is deactivated.
     *
     * @return bool
     */
    public function deactivated()
    {
        return $this->state == 'deactivated';
    }

    /**
     * Determine if the subscription is not paid and in wait.
     *
     * @return bool
     */
    public function overdue()
    {
        return $this->state == 'overdue';
    }

    /**
     * Determine if the subscription is on trial.
     *
     * @return bool
     */
    public function trial()
    {
        return $this->state == 'trial';
    }

    /**
     * Determine if the subscription is cancelled.
     *
     * Note: That doesn't mean you should stop serving. This state means
     * user ordered to cancel at end of the billing period.
     * Subscription is converted into deactivated on the start of next payment period,
     * after cancelling it.
     *
     * @return bool
     */
    public function canceled()
    {
        return $this->state == 'canceled';
    }

    /**
     * ALIASES.
     */

    /**
     * Alias of canceled.
     *
     * @return bool
     */
    public function cancelled()
    {
        return $this->canceled();
    }

    /**
     * Determine if the subscription is within its trial period.
     *
     * @return bool
     */
    public function onTrial()
    {
        return $this->trial();
    }

    /**
     * Determine if the subscription is within its grace period after cancellation.
     *
     * @return bool
     */
    public function onGracePeriod()
    {
        return $this->canceled();
    }

    /**
     * Determine type of the subscription: fastspring, local.
     *
     * @return string
     */
    public function type()
    {
        return $this->fastspring_id ? 'fastspring' : 'local';
    }

    /**
     * Determine if the subscription is local.
     *
     * @return bool
     */
    public function isLocal()
    {
        return $this->type() == 'local';
    }

    /**
     * Determine if the subscription is fastspring.
     *
     * @return string
     */
    public function isFastspring()
    {
        return $this->type() == 'fastspring';
    }

    /**
     * Swap the subscription to a new Fastspring plan.
     *
     * @param string $plan     New plan
     * @param bool   $prorate  Prorate
     * @param int    $quantity Quantity of the product
     * @param array  $coupons  Coupons wanted to be applied
     *
     * @throws \Exception
     *
     * @return object Response of fastspring
     */
    public function swap($plan, $prorate, $quantity = 1, $coupons = [])
    {
        $response = Fastspring::swapSubscription($this->fastspring_id, $plan, $prorate, $quantity, $coupons);
        $status = $response->subscriptions[0];

        if ($status->result == 'success') {
            // we update subscription
            // according to prorate value
            if ($prorate) {
                // if prorate is true
                // the plan is changed immediately
                // no need to fill swap columns

                // if the plan is in the trial state
                // then delete the current period
                // because it will change immediately
                // but period won't update because it exists
                if ($this->state == 'trial') {
                    $activePeriod = $this->activePeriodOrCreate();
                    $activePeriod->delete();
                }

                $this->plan = $plan;
                $this->save();
            } else {
                // if prorate is false
                // save plan swap_to
                // because the plan will change after a while
                $activePeriod = $this->activePeriodOrCreate();

                $this->swap_to = $plan;
                $this->swap_at = $activePeriod
                    ? $activePeriod->end_date
                    : null;
                $this->save();
            }

            return $this;
        }

        throw new Exception('Swap operation failed. Response: ' . json_encode($response));
    }

    /**
     * Cancel the subscription at the end of the billing period.
     *
     * @throws \Exception
     *
     * @return object Response of fastspring
     */
    public function cancel()
    {
        $response = Fastspring::cancelSubscription($this->fastspring_id);
        $status = $response->subscriptions[0];
        $activePeriod = $this->activePeriodOrCreate();

        if ($status->result == 'success') {
            $this->state = 'canceled';
            $this->swap_at = $activePeriod
                ? $activePeriod->end_date
                : null;
            $this->save();

            return $this;
        }

        throw new Exception('Cancel operation failed. Response: ' . json_encode($response));
    }

    /**
     * Cancel the subscription immediately.
     *
     * @throws \Exception
     *
     * @return object Response of fastspring
     */
    public function cancelNow()
    {
        $response = Fastspring::cancelSubscription($this->fastspring_id, ['billing_period' => 0]);
        $status = $response->subscriptions[0];

        if ($status->result == 'success') {
            // if it is canceled now
            // state should be deactivated
            $this->state = 'deactivated';
            $this->save();

            return $this;
        }

        throw new Exception('CancelNow operation failed. Response: ' . json_encode($response));
    }

    /**
     * Resume the cancelled subscription.
     *
     * @throws \LogicException
     * @throws \Exception
     *
     * @return object Response of fastspring
     */
    public function resume()
    {
        if (!$this->onGracePeriod()) {
            throw new LogicException('Unable to resume subscription that is not within grace period or not canceled.');
        }

        $response = Fastspring::uncancelSubscription($this->fastspring_id);
        $status = $response->subscriptions[0];

        if ($status->result == 'success') {
            $this->state = 'active';

            // set null swap columns
            $this->swap_at = null;
            $this->swap_to = null;

            $this->save();

            return $this;
        }

        throw new Exception('Resume operation failed. Response: ' . json_encode($response));
    }
}