File Coverage

blib/lib/Business/Stripe/Subscription.pm

Criterion	Covered	Total	%
statement	34	139	24.4
branch	11	88	12.5
condition	5	13	38.4
subroutine	8	17	47.0
pod	11	11	100.0
total	69	268	25.7

package Business::Stripe::Subscription;

use HTTP::Tiny;
use JSON::PP;
use Data::Dumper;

use strict;
use warnings;

our $VERSION = '1.0';
$VERSION = eval $VERSION;

my $http = HTTP::Tiny->new;

# Create Subscription class object
sub new {
    my $class = shift;
    my %attrs = @_;

    $attrs{'currency'} //= 'GBP';

    $attrs{'error'} = '';

    $attrs{'cancel_url'}  //= "$ENV{'REQUEST_SCHEME'}://$ENV{'HTTP_HOST'}$ENV{'SCRIPT_NAME'}";
    $attrs{'success_url'} //= "$ENV{'REQUEST_SCHEME'}://$ENV{'HTTP_HOST'}$ENV{'SCRIPT_NAME'}";
    $attrs{'error'}         = 'cancel_url and success_url cannot be derived from the environment and need to be provided' unless ($attrs{'cancel_url'} and $attrs{'success_url'});

    # This is changed during testing only
    $attrs{'url'}         //= 'https://api.stripe.com/v1/';

    $attrs{'error'} = 'Secret API key provided as Public key' if $attrs{'api_public'} =~ /^sk_/;
    $attrs{'error'} = 'Public API key provided as Secret key' if $attrs{'api_secret'} =~ /^pk_/;
    $attrs{'error'} = 'Public API key provided is not a valid key' unless $attrs{'api_public'} =~ /^pk_/;
    $attrs{'error'} = 'Secret API key provided is not a valid key' unless $attrs{'api_secret'} =~ /^sk_/;
    $attrs{'error'} = 'Secret API key is missing' unless $attrs{'api_secret'};
    $attrs{'error'} = 'Public API key is missing' unless $attrs{'api_public'};

    return bless \%attrs, $class;
}

# Returns true if last operation was success
sub success {
    my $self = shift;
    return !$self->{'error'};
}

# Returns error if last operation failed
sub error {
    my $self = shift;
    return $self->{'error'};
}

# Create headers for calling Stripe API
sub _get_header {
    my $self = shift;
    return {
        'headers'   => {
            'Authorization'     => 'Bearer ' . $self->{'api_secret'},
            'Stripe-Version'    => '2022-11-15',
        },
        'agent'     => "Perl-Business::Stripe::Subscription-v$VERSION",
    };
}

# Create Stripe customer object
sub customer {
    my ($self, $customer) = @_;


    $self->{'error'} = '';
    $self->{'error'} = 'Name missing from Customer object'  unless $customer->{'name'};
    return undef if $self->{'error'};

    my $response = $http->post_form($self->{'url'} . 'customers', $customer, $self->_get_header);
    if ($response->{'success'}) {
        my $payload = decode_json($response->{'content'});
        if ($payload->{'object'} eq 'customer') {
            return $payload->{'id'};
        }
    }
    return undef;
}

# Create Stripe subsciption object
sub subscription {
    my ($self, $customer, $plan) = @_;

    $self->{'error'} = '';
    $self->{'error'} = 'Customer missing'          unless $customer;
    $self->{'error'} = 'Subscription plan missing' unless $plan;
    return undef if $self->{'error'};

    my $success_url = $self->{'success_url'};
    if ($self->{'append_customer'}) {
        if ($success_url =~ /\?/) {
            $success_url .= "&customer=$customer";
        } else {
            $success_url .= "?customer=$customer";
        }
    }

    my $session = {
        'success_url'                   => $success_url,
        'cancel_url'                    => $self->{'cancel_url'},
        'payment_method_types[0]'       => 'card',
        'mode'                          => 'subscription',
        'customer'                      => $customer,
        'line_items[0][price]'          => $plan,
        'line_items[0][quantity]'       => 1,
    };
    $session->{'subscription_data[trial_period_days]'} = $self->{'trial_days'} if $self->{'trial_days'};

    my $response = $http->post_form($self->{'url'} . 'checkout/sessions', $session, $self->_get_header);
    if ($response->{'success'}) {
        my $payload = decode_json($response->{'content'});
        if ($payload->{'object'} eq 'checkout.session') {
            return $payload->{'url'};
        }
    }
    $self->{'error'} = 'Failed to update checkout session';
    return undef;
}

# Retrieve subscription object from Stripe
sub get_subscription {
    my ($self, $subscription) = @_;

    if (!$subscription) {
        $self->{'error'} = 'Subscription missing';
        $self->_error('Subscription missing');
        return undef;
    }

    return $http->get("https://api.stripe.com/v1/subscriptions/$subscription", $self->_get_header);
}

# Cancel subscription at end of current period
sub cancel {
    my ($self, $subscription, $cancel) = @_;

    $self->{'error'} = '';
    $self->{'error'} = 'Subscription missing' unless $subscription;
    return undef if $self->{'error'};

    $cancel = 1 unless defined $cancel;
    my $state = $cancel ? 'true' : 'false';

    my $vars = {
        'cancel_at_period_end'  => $state,
    };

    my $response = $http->post_form("https://api.stripe.com/v1/subscriptions/$subscription", $vars, $self->_get_header);

    if ($response->{'success'}) {
        return $cancel;
    }
    $self->{'error'} = 'Failed to set cancellation';
    return undef;
}

# Cancel subscription immediately
sub cancel_now {
    my ($self, $subscription) = @_;

    $self->{'error'} = '';
    $self->{'error'} = 'Subscription missing' unless $subscription;
    return undef if $self->{'error'};

    my $response = $http->delete("https://api.stripe.com/v1/subscriptions/$subscription",  $self->_get_header);

    if ($response->{'success'}) {
        return $response->{'content'}->{'id'} eq $subscription;
    }
    $self->{'error'} = 'Cancellation failed';
    return undef;
}

# Change subscripotion to a different price plan
sub update {
    my ($self, $subscription, $plan) = @_;

    $self->{'error'} = '';
    $self->{'error'} = 'Subscription missing'      unless $subscription;
    $self->{'error'} = 'Subscription plan missing' unless $plan;
    return undef if $self->{'error'};

    my $res = $http->post_form("https://api.stripe.com/v1/subscriptions/$subscription", {}, $self->_get_header);
    my $payload = decode_json($res->{'content'});

    # Don't change to the same plan
    if ($payload->{'items'}->{'data'}[0]->{'price'}->{'id'} eq $plan) {
        $self->{'error'} = 'Cannot change to the same price plan';
        return 0;
    }

    my $vars = {
        'items[0][id]'             => $payload->{'items'}->{'data'}[0]->{'id'},
        'items[0][price]'          => $plan,
        'proration_behavior'       => 'create_prorations',
        'cancel_at_period_end'     => 'false',
    };

    my $response = $http->post_form("https://api.stripe.com/v1/subscriptions/$subscription", $vars, $self->_get_header);

    if ($response->{'success'}) {
        return $response->{'content'}->{'id'} eq $subscription;
    }
    $self->{'error'} = 'Update failed';
    return undef;
}

# Update card details
sub new_card {
    my ($self, $customer, $subscription) = @_;

    $self->{'error'} = '';
    $self->{'error'} = 'Customer missing'       unless $customer;
    $self->{'error'} = 'Subscription missing'   unless $subscription;
    return undef if $self->{'error'};

    my $session = {
        'success_url'                                   => $self->{'success_url'},
        'cancel_url'                                    => $self->{'cancel_url'},
        'payment_method_types[0]'                       => 'card',
        'mode'                                          => 'setup',
        'customer'                                      => $customer,
        'setup_intent_data[metadata][subscription_id]'  => $subscription,
    };

    my $response = $http->post_form($self->{'url'} . 'checkout/sessions', $session, $self->_get_header);
    if ($response->{'success'}) {
        return decode_json $response->{'content'};
    }

    $self->{'error'} = 'Failed to obtain card update URL';
    return undef;
}

# Set default card
sub set_card {
    my ($self, $customer, $subscription, $session) = @_;

    $self->{'error'} = '';
    $self->{'error'} = 'Customer missing'           unless $customer;
    $self->{'error'} = 'Subscription missing'       unless $subscription;
    $self->{'error'} = 'Checkout session missing'   unless $session;
    return undef if $self->{'error'};

    my $response = $http->get($self->{'url'} . "checkout/sessions/$session", $self->_get_header);
    my $json = decode_json $response->{'content'};

    if (!$json->{'setup_intent'}) {
        $self->{'error'} = 'Failed to get setup intent card';
        return undef;
    }

    $response = $http->get($self->{'url'} . "setup_intents/" . $json->{'setup_intent'}, $self->_get_header);

    if ($response->{'success'}) {
        $json = decode_json $response->{'content'};

        my $payload = {
            'default_payment_method'    => $json->{'payment_method'},
        };

        $response = $http->post_form($self->{'url'} . "subscriptions/$subscription", $payload, $self->_get_header);

        if ($response->{'success'}) {
            return 1;
        }
    }

    $self->{'error'} = 'Failed to set default card';
    return undef;
}

1;

__END__