killbill-paypal-express 4.1.3 → 4.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d005c1bdd9b05742e9898d5fef94c1f72c0eb81
-  data.tar.gz: 683c9b2837efe00ff16d65f62c964b9e46020540
+  metadata.gz: 9fb4b33361ba8a20052ea37ef62c5108a0ee7395
+  data.tar.gz: 2b398f445e49529f890d60365c7389a6c943b81a
 SHA512:
-  metadata.gz: b8c9c42cb7e253e38338107f86efdd8dbc27d762c2590dd7bc5f9718de8e9b1acf3b82c186930d1dd8f85fe1698aec7d7ede4ced070a3a0ea2d37730399f35fb
-  data.tar.gz: 03da6bfa63eaaa3631f48a40c07c99fff32ce0e58ff97a28b67a2bf2166bee83ca0546ab599e1cc91a0e6b8c0ef706631e5c35c5ae2e877b15dce200f8baf447
+  metadata.gz: c1ec6393cfb317f04f0ecde7e1bcbd0df40a2274345aafea0b67a2a9aafcd045658838e1debc7e09f4cd817dd3d9944892ea03a737aafe00c2aea3e28e9d3ca9
+  data.tar.gz: 83d24ce07bf944636c4b991fe4e8bc59632907c3c82a6d58c2bc8a50fea771fe65412cfffccab77bf119359edb0dbc741fb54265c876516f613973fff374f989

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    killbill-paypal-express (4.1.3)
+    killbill-paypal-express (4.1.4)
       actionpack (~> 4.1.0)
       actionview (~> 4.1.0)
       activemerchant (~> 1.53.0)
@@ -83,7 +83,7 @@ GEM
     jdbc-sqlite3 (3.8.11.2)
     jruby-openssl (0.9.16-java)
     json (1.8.3-java)
-    killbill (7.0.3)
+    killbill (7.0.5)
       rack (>= 1.5.2)
       sinatra (~> 1.3.4)
       typhoeus (~> 0.6.9)

data/NEWS

@@ -1,3 +1,7 @@
+4.1.4
+    Cancel expired payments
+    Always store the PayPal Payer Id
+
 4.1.3
     Add support for auth-only HPP flow
     Add support for multiple merchant accounts

data/VERSION

@@ -1 +1 @@
-4.1.3
+4.1.4

data/lib/paypal_express/api.rb

@@ -2,6 +2,8 @@ module Killbill #:nodoc:
   module PaypalExpress #:nodoc:
     class PaymentPlugin < ::Killbill::Plugin::ActiveMerchant::PaymentPlugin
 
+      THREE_HOURS_AGO = (3*3600)
+
       def initialize
         gateway_builder = Proc.new do |config|
           ::ActiveMerchant::Billing::PaypalExpressGateway.application_id = config[:button_source] || 'killbill_SP'
@@ -83,15 +85,29 @@ module Killbill #:nodoc:
 
       def get_payment_info(kb_account_id, kb_payment_id, properties, context)
         t_info_plugins = super(kb_account_id, kb_payment_id, properties, context)
+        # Should never happen...
+        return [] if t_info_plugins.nil?
 
         # Completed purchases/authorizations will have two rows in the responses table (one for api_call 'build_form_descriptor', one for api_call 'purchase/authorize')
         # Other transaction types don't support the :PENDING state
         target_transaction_types = [:PURCHASE, :AUTHORIZE]
-        is_transaction_pending = t_info_plugins.find { |t_info_plugin| target_transaction_types.include?(t_info_plugin.transaction_type) && t_info_plugin.status != :PENDING }.nil?
+        only_pending_transaction = t_info_plugins.find { |t_info_plugin| target_transaction_types.include?(t_info_plugin.transaction_type) && t_info_plugin.status != :PENDING }.nil?
         t_info_plugins_without_pending = t_info_plugins.reject { |t_info_plugin| target_transaction_types.include?(t_info_plugin.transaction_type) && t_info_plugin.status == :PENDING }
 
-        # If only pending transactions exist, return the pending one. Otherwise, only return those non-pending transaction.
-        is_transaction_pending ? t_info_plugins: t_info_plugins_without_pending
+        # If its token has expired, cancel the payment and update the response row.
+        if only_pending_transaction
+          return t_info_plugins unless token_expired(t_info_plugins.last)
+          begin
+            cancel_pending_transaction(t_info_plugins.last).nil?
+            logger.info("Cancel pending kb_payment_id='#{t_info_plugins.last.kb_payment_id}', kb_payment_transaction_id='#{t_info_plugins.last.kb_transaction_payment_id}'")
+            super(kb_account_id, kb_payment_id, properties, context)
+          rescue => e
+            logger.warn("Unexpected exception while canceling pending kb_payment_id='#{t_info_plugins.last.kb_payment_id}', kb_payment_transaction_id='#{t_info_plugins.last.kb_transaction_payment_id}': #{e.message}\n#{e.backtrace.join("\n")}")
+            t_info_plugins
+          end
+        else
+          t_info_plugins_without_pending
+        end
       end
 
       def search_payments(search_key, offset, limit, properties, context)
@@ -188,9 +204,11 @@ module Killbill #:nodoc:
         create_pending_payment = ::Killbill::Plugin::ActiveMerchant::Utils.normalized(options, :create_pending_payment)
         if create_pending_payment
           payment_processor_account_id = ::Killbill::Plugin::ActiveMerchant::Utils.normalized(options, :payment_processor_account_id)
+          token_expiration_period = ::Killbill::Plugin::ActiveMerchant::Utils.normalized(options, :token_expiration_period)
           custom_props = hash_to_properties(:from_hpp                     => true,
                                             :token                        => response.token,
-                                            :payment_processor_account_id => payment_processor_account_id)
+                                            :payment_processor_account_id => payment_processor_account_id,
+                                            :token_expiration_period      => token_expiration_period)
           payment_external_key = ::Killbill::Plugin::ActiveMerchant::Utils.normalized(options, :payment_external_key)
           transaction_external_key = ::Killbill::Plugin::ActiveMerchant::Utils.normalized(options, :transaction_external_key)
 
@@ -321,14 +339,16 @@ module Killbill #:nodoc:
       end
 
       def authorize_or_purchase_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context, is_authorize = false)
-        payment_processor_account_id = find_value_from_properties(properties, 'payment_processor_account_id')
+        properties_hash = properties_to_hash properties
+        payment_processor_account_id = ::Killbill::Plugin::ActiveMerchant::Utils.normalized(properties_hash, :payment_processor_account_id)
         transaction_type = is_authorize ? :AUTHORIZE : :PURCHASE
         api_call_type = is_authorize ? :authorize : :purchase
 
         # Callback from the plugin itself (HPP flow)
-        if find_value_from_properties(properties, 'from_hpp') == 'true'
-          token = find_value_from_properties(properties, 'token')
-
+        if ::Killbill::Plugin::ActiveMerchant::Utils.normalized(properties_hash, :from_hpp)
+          token = ::Killbill::Plugin::ActiveMerchant::Utils.normalized(properties_hash, :token)
+          message = {:payment_plugin_status => :PENDING,
+                     :token_expiration_period => ::Killbill::Plugin::ActiveMerchant::Utils.normalized(properties_hash, :token_expiration_period) || THREE_HOURS_AGO.to_s}
           response = @response_model.create(:api_call                     => :build_form_descriptor,
                                             :kb_account_id                => kb_account_id,
                                             :kb_payment_id                => kb_payment_id,
@@ -340,7 +360,7 @@ module Killbill #:nodoc:
                                             :success                      => true,
                                             :created_at                   => Time.now.utc,
                                             :updated_at                   => Time.now.utc,
-                                            :message                      => { :payment_plugin_status => :PENDING }.to_json)
+                                            :message                      => message.to_json)
           transaction          = response.to_transaction_info_plugin(nil)
           transaction.amount   = amount
           transaction.currency = currency
@@ -364,7 +384,7 @@ module Killbill #:nodoc:
             end
           else
             # One-off payment
-            options[:token] = find_value_from_properties(properties, 'token') || find_last_token(kb_account_id, context.tenant_id)
+            options[:token] = ::Killbill::Plugin::ActiveMerchant::Utils.normalized(properties_hash, :token) || find_last_token(kb_account_id, context.tenant_id)
             if is_authorize
               gateway_call_proc  = Proc.new do |gateway, linked_transaction, payment_source, amount_in_cents, options|
                 gateway.authorize(amount_in_cents, options)
@@ -381,7 +401,7 @@ module Killbill #:nodoc:
           options[:payment_processor_account_id] = payment_processor_account_id
 
           # Populate the Payer id if missing
-          options[:payer_id] = find_value_from_properties(properties, 'payer_id')
+          options[:payer_id] = ::Killbill::Plugin::ActiveMerchant::Utils.normalized(properties_hash, :payer_id)
           begin
             options[:payer_id] ||= find_payer_id(options[:token],
                                                  kb_account_id,
@@ -405,13 +425,30 @@ module Killbill #:nodoc:
           end
 
           properties = merge_properties(properties, options)
-          dispatch_to_gateways(api_call_type, kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context, gateway_call_proc)
+          dispatch_to_gateways(api_call_type, kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context, gateway_call_proc, nil, {:payer_id => options[:payer_id]})
         end
       end
 
       def find_payment_processor_id_from_initial_call(kb_account_id, kb_tenant_id, token)
         @response_model.initial_payment_account_processor_id kb_account_id, kb_tenant_id, token
       end
+
+      def token_expired(transaction_plugin_info)
+        paypal_response_id = find_value_from_properties(transaction_plugin_info.properties, 'paypalExpressResponseId')
+        response = PaypalExpressResponse.find_by(:id => paypal_response_id)
+        begin
+          message_details = JSON.parse response.message
+          expiration_period = (message_details['token_expiration_period'] || THREE_HOURS_AGO).to_i
+        rescue
+          expiration_period = THREE_HOURS_AGO.to_i
+        end
+        now = Time.parse(@clock.get_clock.get_utc_now.to_s)
+        (now - transaction_plugin_info.created_date) >= expiration_period
+      end
+
+      def cancel_pending_transaction(transaction_plugin_info)
+        @response_model.cancel_pending_payment transaction_plugin_info
+      end
     end
   end
 end

data/lib/paypal_express/models/response.rb

@@ -77,6 +77,14 @@ module Killbill #:nodoc:
         response.nil? ? nil : response.payment_processor_account_id
       end
 
+      def self.cancel_pending_payment(transaction_plugin_info)
+         where( :api_call => 'build_form_descriptor',
+                :kb_payment_id => transaction_plugin_info.kb_payment_id,
+                :kb_payment_transaction_id => transaction_plugin_info.kb_transaction_payment_id).update_all( :success => false,
+                                                                                                             :updated_at => Time.now.utc,
+                                                                                                             :message => { :payment_plugin_status => :CANCELED, :exception_message => 'Token expired. Payment Canceled by Janitor.' }.to_json)
+      end
+
       def to_transaction_info_plugin(transaction=nil)
         t_info_plugin = super(transaction)
 
@@ -119,6 +127,7 @@ module Killbill #:nodoc:
         t_info_plugin.properties << create_plugin_property('paymentInfoShipDiscount', payment_info_shipdiscount)
         t_info_plugin.properties << create_plugin_property('paymentInfoInsuranceAmount', payment_info_insuranceamount)
         t_info_plugin.properties << create_plugin_property('paymentInfoSubject', payment_info_subject)
+        t_info_plugin.properties << create_plugin_property('paypalExpressResponseId', id)
 
         t_info_plugin
       end

data/pom.xml

@@ -26,7 +26,7 @@
     <groupId>org.kill-bill.billing.plugin.ruby</groupId>
     <artifactId>paypal-express-plugin</artifactId>
     <packaging>pom</packaging>
-    <version>4.1.3</version>
+    <version>4.1.4</version>
     <name>paypal-express-plugin</name>
     <url>http://github.com/killbill/killbill-paypal-express-plugin</url>
     <description>Plugin for accessing Paypal Express Checkout as a payment gateway</description>

data/spec/paypal_express/remote/baid_spec.rb

@@ -18,6 +18,8 @@ shared_examples 'baid_spec_common' do
     payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
     payment_response.amount.should == @amount
     payment_response.transaction_type.should == :PURCHASE
+    payer_id = find_value_from_properties(payment_response.properties, 'payerId')
+    payer_id.should_not be_nil
 
     # Verify GET API
     payment_infos = @plugin.get_payment_info(@pm.kb_account_id, @kb_payment.id, [], @call_context)
@@ -30,6 +32,7 @@ shared_examples 'baid_spec_common' do
     payment_infos[0].gateway_error.should == 'Success'
     payment_infos[0].gateway_error_code.should be_nil
     find_value_from_properties(payment_infos[0].properties, 'payment_processor_account_id').should == @payment_processor_account_id
+    find_value_from_properties(payment_infos[0].properties, 'payerId').should == payer_id
 
     # Try a full refund
     refund_response = @plugin.refund_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[1].id, @pm.kb_payment_method_id, @amount, @currency, @properties, @call_context)
@@ -63,6 +66,8 @@ shared_examples 'baid_spec_common' do
     payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
     payment_response.amount.should == @amount
     payment_response.transaction_type.should == :AUTHORIZE
+    payer_id = find_value_from_properties(payment_response.properties, 'payerId')
+    payer_id.should_not be_nil
 
     # Verify GET API
     payment_infos = @plugin.get_payment_info(@pm.kb_account_id, @kb_payment.id, [], @call_context)
@@ -75,6 +80,7 @@ shared_examples 'baid_spec_common' do
     payment_infos[0].gateway_error.should == 'Success'
     payment_infos[0].gateway_error_code.should be_nil
     find_value_from_properties(payment_infos[0].properties, 'payment_processor_account_id').should == @payment_processor_account_id
+    find_value_from_properties(payment_infos[0].properties, 'payerId').should == payer_id
 
     # Try multiple partial captures
     partial_capture_amount = BigDecimal.new('10')

data/spec/paypal_express/remote/hpp_spec.rb

@@ -91,7 +91,8 @@ shared_examples 'hpp_spec_common' do
       payment_infos[0].amount.should be_nil
       payment_infos[0].currency.should be_nil
       payment_infos[0].status.should == :PENDING
-      payment_infos[0].gateway_error.should == '{"payment_plugin_status":"PENDING"}'
+      payment_infos[0].gateway_error.should == {:payment_plugin_status => 'PENDING',
+                                                :token_expiration_period => @plugin.class.const_get(:THREE_HOURS_AGO).to_s}.to_json
       payment_infos[0].gateway_error_code.should be_nil
 
       properties = []
@@ -155,7 +156,8 @@ shared_examples 'hpp_spec_common' do
         payment_infos[0].amount.should be_nil
         payment_infos[0].currency.should be_nil
         payment_infos[0].status.should == :PENDING
-        payment_infos[0].gateway_error.should == '{"payment_plugin_status":"PENDING"}'
+        payment_infos[0].gateway_error.should == {:payment_plugin_status => 'PENDING',
+                                                  :token_expiration_period => @plugin.class.const_get(:THREE_HOURS_AGO).to_s}.to_json
         payment_infos[0].gateway_error_code.should be_nil
         find_value_from_properties(payment_infos[0].properties, :payment_processor_account_id).should == @payment_processor_account_id
       else
@@ -293,6 +295,80 @@ shared_examples 'hpp_spec_common' do
     token = validate_form_property(form, 'token')
     @plugin.send(:find_payment_processor_id_from_initial_call, @pm.kb_account_id, @call_context.tenant_id, token).should == @payment_processor_account_id
   end
+
+  it 'should cancel the pending payment if the token expires' do
+    ::Killbill::PaypalExpress::PaypalExpressTransaction.count.should == 0
+    ::Killbill::PaypalExpress::PaypalExpressResponse.count.should == 0
+
+    expiration_period = 5
+    payment_external_key = SecureRandom.uuid
+    properties = @plugin.hash_to_properties(
+        :transaction_external_key => payment_external_key,
+        :create_pending_payment => true,
+        :token_expiration_period => expiration_period
+    )
+
+    form = @plugin.build_form_descriptor(@pm.kb_account_id, @form_fields, properties, @call_context)
+    kb_payment_id = validate_form_property(form, 'kb_payment_id')
+    payment_infos = @plugin.get_payment_info(@pm.kb_account_id, kb_payment_id, properties, @call_context)
+    payment_infos.size.should == 1
+    payment_infos[0].kb_payment_id.should == kb_payment_id
+    payment_infos[0].amount.should be_nil
+    payment_infos[0].currency.should be_nil
+    payment_infos[0].status.should == :PENDING
+    payment_infos[0].gateway_error.should == {:payment_plugin_status => 'PENDING',
+                                              :token_expiration_period => expiration_period.to_s}.to_json
+    payment_infos[0].gateway_error_code.should be_nil
+
+    sleep payment_infos[0].created_date + expiration_period - Time.parse(@plugin.clock.get_clock.get_utc_now.to_s) + 1
+
+    payment_infos = @plugin.get_payment_info(@pm.kb_account_id, kb_payment_id, properties, @call_context)
+    # Make sure no extra response is created
+    payment_infos.size.should == 1
+    payment_infos[0].kb_payment_id.should == kb_payment_id
+    payment_infos[0].amount.should be_nil
+    payment_infos[0].currency.should be_nil
+    payment_infos[0].status.should == :CANCELED
+    payment_infos[0].gateway_error.should == 'Token expired. Payment Canceled by Janitor.'
+    payment_infos[0].gateway_error_code.should be_nil
+  end
+
+  it 'should cancel the pending payment if the token expires without passing property' do
+    ::Killbill::PaypalExpress::PaypalExpressTransaction.count.should == 0
+    ::Killbill::PaypalExpress::PaypalExpressResponse.count.should == 0
+
+    expiration_period = 5
+    @plugin.class.const_set(:THREE_HOURS_AGO, expiration_period)
+    payment_external_key = SecureRandom.uuid
+    properties = @plugin.hash_to_properties(
+        :transaction_external_key => payment_external_key,
+        :create_pending_payment => true
+    )
+
+    form = @plugin.build_form_descriptor(@pm.kb_account_id, @form_fields, properties, @call_context)
+    kb_payment_id = validate_form_property(form, 'kb_payment_id')
+    payment_infos = @plugin.get_payment_info(@pm.kb_account_id, kb_payment_id, properties, @call_context)
+    payment_infos.size.should == 1
+    payment_infos[0].kb_payment_id.should == kb_payment_id
+    payment_infos[0].amount.should be_nil
+    payment_infos[0].currency.should be_nil
+    payment_infos[0].status.should == :PENDING
+    payment_infos[0].gateway_error.should == {:payment_plugin_status => 'PENDING',
+                                              :token_expiration_period => expiration_period.to_s}.to_json
+    payment_infos[0].gateway_error_code.should be_nil
+
+    sleep payment_infos[0].created_date + expiration_period - Time.parse(@plugin.clock.get_clock.get_utc_now.to_s) + 1
+
+    payment_infos = @plugin.get_payment_info(@pm.kb_account_id, kb_payment_id, properties, @call_context)
+    # Make sure no extra response is created
+    payment_infos.size.should == 1
+    payment_infos[0].kb_payment_id.should == kb_payment_id
+    payment_infos[0].amount.should be_nil
+    payment_infos[0].currency.should be_nil
+    payment_infos[0].status.should == :CANCELED
+    payment_infos[0].gateway_error.should == 'Token expired. Payment Canceled by Janitor.'
+    payment_infos[0].gateway_error_code.should be_nil
+  end
 end
 
 describe Killbill::PaypalExpress::PaymentPlugin do

data/spec/paypal_express/remote/hpp_spec_helpers.rb

@@ -50,6 +50,8 @@ module Killbill
         payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
         payment_response.amount.should == @amount
         payment_response.transaction_type.should == :PURCHASE
+        payer_id = find_value_from_properties(payment_response.properties, 'payerId')
+        payer_id.should_not be_nil
 
         # Verify GET API
         payment_infos = @plugin.get_payment_info(@pm.kb_account_id, kb_payment_id, [], @call_context)
@@ -61,6 +63,7 @@ module Killbill
         payment_infos[0].status.should == :PROCESSED
         payment_infos[0].gateway_error.should == 'Success'
         payment_infos[0].gateway_error_code.should be_nil
+        find_value_from_properties(payment_infos[0].properties, 'payerId').should == payer_id
 
         # Try a full refund
         refund_response = @plugin.refund_payment(@pm.kb_account_id, kb_payment_id, SecureRandom.uuid, @pm.kb_payment_method_id, @amount, @currency, [], @call_context)
@@ -93,6 +96,8 @@ module Killbill
         payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
         payment_response.amount.should == @amount
         payment_response.transaction_type.should == :AUTHORIZE
+        payer_id = find_value_from_properties(payment_response.properties, 'payerId')
+        payer_id.should_not be_nil
 
         # Verify GET AUTHORIZED PAYMENT
         payment_infos = @plugin.get_payment_info(@pm.kb_account_id, kb_payment_id, properties, @call_context)
@@ -104,6 +109,7 @@ module Killbill
         payment_infos[0].status.should == :PROCESSED
         payment_infos[0].gateway_error.should == 'Success'
         payment_infos[0].gateway_error_code.should be_nil
+        find_value_from_properties(payment_infos[0].properties, 'payerId').should == payer_id
         find_value_from_properties(payment_infos[0].properties, 'paymentInfoPaymentStatus').should == 'Pending'
         find_value_from_properties(payment_infos[0].properties, 'paymentInfoPendingReason').should == 'authorization'
         find_value_from_properties(payment_infos[0].properties, 'payment_processor_account_id').should == payment_processor_account_id

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: killbill-paypal-express
 version: !ruby/object:Gem::Version
-  version: 4.1.3
+  version: 4.1.4
 platform: ruby
 authors:
 - Kill Bill core team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2016-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: killbill