Merge pull request #179 from sherrardb/capture-partial-charge

capture partial charge

Author: sherrardb

README.pod

@@ -236,6 +236,8 @@ L<https://stripe.com/docs/api/charges/capture#capture_charge>
 
 =item * charge - L<Net::Stripe::Charge> or Str - charge to capture
 
+=item * amount - Int - amount to capture
+
 =back
 
 Returns a L<Net::Stripe::Charge>.
@@ -1086,6 +1088,13 @@ Charge->status.
 
 Added type and client_ip attributes for L<Net::Stripe::Token>.
 
+=item allow capture of partial charge
+
+Passing 'amount' to capture_charge() allows capture of a partial charge.
+Per the API, any remaining amount is immediately refunded. The charge object
+now also has a 'refunds' attribute, representing a L<Net::Stripe::List>
+of L<Net::Stripe::Refund> objects for the charge.
+
 =back
 
 =head1 SEE ALSO

lib/Net/Stripe.pm

@@ -182,6 +182,13 @@ Charge->status.
 
 Added type and client_ip attributes for L<Net::Stripe::Token>.
 
+=item allow capture of partial charge
+
+Passing 'amount' to capture_charge() allows capture of a partial charge.
+Per the API, any remaining amount is immediately refunded. The charge object
+now also has a 'refunds' attribute, representing a L<Net::Stripe::List>
+of L<Net::Stripe::Refund> objects for the charge.
+
 =back
 
 =method new PARAMHASH
@@ -312,6 +319,8 @@ L<https://stripe.com/docs/api/charges/capture#capture_charge>
 
 =item * charge - L<Net::Stripe::Charge> or Str - charge to capture
 
+=item * amount - Int - amount to capture
+
 =back
 
 Returns a L<Net::Stripe::Charge>.
@@ -403,12 +412,18 @@ Charges: {
                             );
     }
 
-    method capture_charge(Net::Stripe::Charge|Str :$charge) {
+    method capture_charge(
+        Net::Stripe::Charge|Str :$charge!,
+        Int :$amount?,
+    ) {
         if (ref($charge)) {
             $charge = $charge->id;
         }
 
-        return $self->_post("charges/$charge/capture");
+        my %args = (
+            amount => $amount,
+        );
+        return $self->_post("charges/$charge/capture", \%args);
     }
 
 }
@@ -1848,6 +1863,27 @@ sub _pre_2011_08_01_processing {
             $hash->{$type}->{url} = "/v1/customers/$customer_id/$type";
         }
     }
+
+    foreach my $type ( qw/ refunds / ) {
+        if ( exists( $hash->{$type} ) && ref( $hash->{$type} ) eq 'ARRAY' ) {
+            $hash->{$type} = _array_to_list( delete( $hash->{$type} ) );
+            my $charge_id;
+            if ( exists( $hash->{object} ) && $hash->{object} eq 'charge' && exists( $hash->{id} ) ) {
+                $charge_id = $hash->{id};
+            }
+            # Net::Stripe::List->new() will fail without url, but we
+            # can make debugging easier by providing a message here
+            die Net::Stripe::Error->new(
+                type => "object coercion error",
+                message => sprintf(
+                    "Could not determine charge id while coercing %s list into Net::Stripe::List.",
+                    $type,
+                ),
+            ) unless $charge_id;
+            # mimic the url sent with standard Stripe lists
+            $hash->{$type}->{url} = "/v1/charges/$charge_id/$type";
+        }
+    }
     return $hash;
 }
 

lib/Net/Stripe/Charge.pm

@@ -28,6 +28,7 @@ has 'receipt_email'       => (is => 'ro', isa => 'Maybe[Str]');
 has 'status'              => (is => 'ro', isa => 'Maybe[Str]');
 has 'capture'             => (is => 'ro', isa => 'Bool', default=> 1);
 has 'statement_descriptor' => (is => 'ro', isa => 'Maybe[Str]');
+has 'refunds'             => (is => 'ro', isa => 'Net::Stripe::List');
 
 method form_fields {
     return $self->form_fields_for(

t/live.t

@@ -493,6 +493,46 @@ Charges: {
         is $captured_charge->amount, $amount, "amount is $amount";
         is $captured_charge->id, $charge->id, 'Charge ids match';
     }
+
+    Auth_then_partial_capture: {
+        my $amount = 1234;
+        my $charge = $stripe->post_charge(
+            amount => $amount,
+            currency => 'usd',
+            card => $token_id_visa,
+            capture => 0,
+        );
+        isa_ok $charge, 'Net::Stripe::Charge';
+        ok !$charge->refunded, 'charge is not refunded';
+        ok $charge->paid, 'charge was paid';
+        ok !$charge->captured, 'charge was not captured';
+        ok !defined( $charge->balance_transaction ), 'balance_transaction is undef';
+        is $charge->amount, $amount, "amount matches";
+        my $refunds = $charge->refunds;
+        isa_ok $refunds, "Net::Stripe::List";
+        my @refunds = $refunds->elements;
+        is scalar( @refunds ), 0, 'charge has no refunds';
+
+        my $auth_charge_id = $charge->id;
+        my $partial = 567;
+        my $captured_charge = $stripe->capture_charge(
+            charge => $auth_charge_id,
+            amount => $partial,
+        );
+        ok !$captured_charge->refunded, 'charge is not refunded';
+        ok $captured_charge->paid, 'charge was paid';
+        ok $captured_charge->captured, 'charge was captured';
+        ok defined( $captured_charge->balance_transaction ), 'balance_transaction is defined';
+        is $captured_charge->amount, $amount, "amount matches";
+        is $captured_charge->id, $charge->id, 'Charge ids match';
+        is $captured_charge->amount_refunded, $amount - $partial, "amount_refunded matches";
+        $refunds = $captured_charge->refunds;
+        isa_ok $refunds, "Net::Stripe::List";
+        @refunds = $refunds->elements;
+        is scalar( @refunds ), 1, 'charge has one refund';
+        is $refunds[0]->amount, $amount - $partial, "refund amount matches";
+        is $refunds[0]->status, 'succeeded', 'refund was successful';
+    }
 }
 
 Customers: {