killbill-cybersource 4.0.7 → 4.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7471ac43901ed2efb3ebeaa6b6ed62a28a38286f
-  data.tar.gz: 4a697cfdb6b8fad42f07c13df1a8ae1d4ce1f808
+  metadata.gz: e5e9dc0988edff5c4623bbe0b78fff943f7deeca
+  data.tar.gz: 8021eb5f7e6a7ad4c8132ecf7f7d7a2f96fc4523
 SHA512:
-  metadata.gz: 05e6ea3dba262e59947a316d7b26e4fa31388762ae3f79e308c11798cdeff366f64439b05c7241288918d4e807d9719ff95619dae073d81c28784b4221dab5d0
-  data.tar.gz: 61e4584909179d697d4ba137f4928b3a5a1d1af3dc0eff91289832c8f058d3a2390f6b00d01236b64c883f450c86e7d9231d4b0b74f9d6ef88ec20d80f3908c3
+  metadata.gz: 8c8240aff2da9f916e0dad419b4ca2a335a38850ec4628046819d858dc5fead9fbccda182e22cee2340f655a54a5d21449e440e9b5a2cbc9c6985239ca1d6b50
+  data.tar.gz: 25bf63b13df3da99c28903e0534398dedd6e24ae3c80b4e6799f6d0e62e78d4aa8b236fa3a713ee0373d33cdeed5b5c7fc12b5bf16ff021b5481b75c34919847

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    killbill-cybersource (4.0.7)
+    killbill-cybersource (4.0.8)
       actionpack (~> 4.1.0)
       actionview (~> 4.1.0)
       activemerchant (~> 1.48.0)
@@ -78,7 +78,7 @@ GEM
       ruby-maven (~> 3.3, >= 3.3.3)
     jdbc-mariadb (1.2.3)
     jdbc-sqlite3 (3.8.11.2)
-    jruby-openssl (0.9.16-java)
+    jruby-openssl (0.9.17-java)
     json (1.8.3-java)
     killbill (7.0.6)
       rack (>= 1.5.2)

data/NEWS

@@ -1,3 +1,9 @@
+4.0.8
+    Add Android Pay support
+    Add support for merchant descriptors
+    Return processor response in PaymentTransactionInfoPlugin
+    Update jruby-openssl to 0.9.17 (see jruby/jruby-openssl#94)
+
 4.0.7
     Fix auth reversal in non-USD
     Cancel old UNDEFINED transactions that cannot be found in CyberSource

data/README.md

@@ -157,5 +157,7 @@ Plugin properties
 | payment_instrument_name      | ApplePay tokenization attribute                                         |
 | payment_network              | ApplePay tokenization attribute                                         |
 | transaction_identifier       | ApplePay tokenization attribute                                         |
+| source                       | androidpay for AndroidPay                                               |
 | force_validation             | If true, trigger a non-$0 auth to validate cards not supporting $0 auth |
 | force_validation_amount      | Amount to use when force_validation is set                              |
+| merchant_descriptor          | Merchant descriptor as `{"name":"Merchant Name","contact":"8888888888"}`|

data/VERSION

@@ -1 +1 @@
-4.0.7
+4.0.8

data/lib/cybersource/api.rb

@@ -30,6 +30,7 @@ module Killbill #:nodoc:
         options = {}
 
         add_required_options(kb_account_id, properties, options, context)
+        add_merchant_descriptor(:AUTHORIZE, properties, options)
 
         properties = merge_properties(properties, options)
         auth_response = super(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
@@ -51,6 +52,7 @@ module Killbill #:nodoc:
         options = {}
 
         add_required_options(kb_account_id, properties, options, context)
+        add_merchant_descriptor(:CAPTURE, properties, options)
 
         properties = merge_properties(properties, options)
         super(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
@@ -96,6 +98,7 @@ module Killbill #:nodoc:
         options = {}
 
         add_required_options(kb_account_id, properties, options, context)
+        add_merchant_descriptor(:REFUND, properties, options)
 
         properties = merge_properties(properties, options)
         super(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
@@ -276,6 +279,19 @@ module Killbill #:nodoc:
         (now - transaction.created_at) >= threshold
       end
 
+      def before_gateways(kb_transaction, last_transaction, payment_source, amount_in_cents, currency, options, context = nil)
+        # Provide necessary information for merchant descriptor
+        if options[:merchant_descriptor].present? &&
+           options[:merchant_descriptor][:card_type].nil? &&
+           payment_source.present? &&
+           payment_source.respond_to?(:brand)
+
+          options[:merchant_descriptor][:card_type] = payment_source.brand
+        end
+
+        super
+      end
+
       # Make calls idempotent
       def before_gateway(gateway, kb_transaction, last_transaction, payment_source, amount_in_cents, currency, options, context)
         super
@@ -336,6 +352,22 @@ module Killbill #:nodoc:
         ::Killbill::Plugin::ActiveMerchant::Utils.normalize_property(properties, 'ignore_cvv')
       end
 
+      def add_merchant_descriptor(transaction_type, properties, options)
+        merchant_descriptor = find_value_from_properties(properties, 'merchant_descriptor')
+        return unless merchant_descriptor.present?
+
+        merchant_descriptor_hash = JSON.parse(merchant_descriptor) rescue nil
+        return unless merchant_descriptor_hash.present? && merchant_descriptor_hash.is_a?(Hash)
+
+        merchant_descriptor_hash = merchant_descriptor_hash.with_indifferent_access
+
+        merchant_descriptor_hash[:transaction_type] = transaction_type
+        if merchant_descriptor_hash[:card_type].nil?
+          merchant_descriptor_hash[:card_type] = ::Killbill::Plugin::ActiveMerchant::Utils.normalized(properties_to_hash(properties), :cc_type)
+        end
+        options[:merchant_descriptor] = merchant_descriptor_hash
+      end
+
       def get_report_api(options, context)
         return nil if options[:skip_gw] || options[:bypass_duplicate_check]
         cybersource_config = config(context.tenant_id)[:cybersource]

data/lib/cybersource/ext/active_merchant/active_merchant.rb

@@ -48,7 +48,7 @@ module ActiveMerchant
           when :visa
             xml.tag! 'ccAuthService', {'run' => 'true'} do
               xml.tag!("cavv", payment_method.payment_cryptogram)
-              xml.tag!("commerceIndicator", options[:commerce_indicator] || "vbv")
+              xml.tag!("commerceIndicator", options[:commerce_indicator] || (is_android_pay(payment_method, options) ? 'internet' : 'vbv'))
               xml.tag!("xid", payment_method.payment_cryptogram)
             end
           when :master
@@ -69,9 +69,22 @@ module ActiveMerchant
         end
       end
 
+      # Changes:
+      #  * http://apps.cybersource.com/library/documentation/dev_guides/Android_Pay_SO_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm#href=ch_soAPI.html
+      #  * add paymentSolution tag to support Android Pay
+      def add_payment_solution(xml, payment_method, options)
+        if is_android_pay(payment_method, options)
+          xml.tag!('paymentSolution', '006')
+        end
+      end
+
+      def is_android_pay(payment_method, options)
+        (payment_method.respond_to?(:source) && payment_method.source == :android_pay) || options[:source] == 'androidpay'
+      end
+
       # Changes:
       #  * Enable business rules for Apple Pay
-      #  * Set paymentNetworkToken if needed (a bit of a hack to do it here, but it avoids having to override too much code)
+      #  * Set paymentNetworkToken and paymentSolution if needed (a bit of a hack to do it here, but it avoids having to override too much code)
       def add_business_rules_data(xml, payment_method, options)
         prioritized_options = [options, @options]
 
@@ -84,6 +97,8 @@ module ActiveMerchant
           xml.tag! 'paymentNetworkToken' do
             xml.tag!('transactionType', "1")
           end
+
+          add_payment_solution(xml, payment_method, options)
         end
       end
 
@@ -129,6 +144,31 @@ module ActiveMerchant
         xml.tag! 'clientLibrary' ,'Kill Bill'
         xml.tag! 'clientLibraryVersion', KB_PLUGIN_VERSION
         xml.tag! 'clientEnvironment' , RUBY_PLATFORM
+        add_invoice_header(xml, options) # Merchant soft descriptor
+      end
+
+      def add_invoice_header(xml, options)
+        merchant_descriptor = options[:merchant_descriptor]
+        if merchant_descriptor.present? &&
+           merchant_descriptor.is_a?(Hash) &&
+           !merchant_descriptor['card_type'].nil? &&
+           !merchant_descriptor['transaction_type'].nil?
+          name    = merchant_descriptor['name']
+          contact = merchant_descriptor['contact']
+          if merchant_descriptor['card_type'].to_s == 'american_express'
+            unless merchant_descriptor['transaction_type'] == :AUTHORIZE # Amex only supports capture and refund
+              xml.tag! 'invoiceHeader' do
+                xml.tag! 'amexDataTAA1', format_string(name, 40)
+                xml.tag! 'amexDataTAA2', format_string(contact, 40)
+              end
+            end
+          else
+            xml.tag! 'invoiceHeader' do
+              xml.tag! 'merchantDescriptor', format_name(name)
+              xml.tag! 'merchantDescriptorContact', format_contact(contact)
+            end
+          end
+        end
       end
 
       def parse_element(reply, node)
@@ -147,6 +187,26 @@ module ActiveMerchant
         end
         return reply
       end
+
+      def format_string(str, max_length)
+        return '' if str.nil?
+        str.first(max_length)
+      end
+
+      def format_contact(contact)
+        contact ||= ''
+        contact = contact.gsub(/\D/, '').ljust(10, '0')
+        [contact[0..2],contact[3..5],contact[6..9]].join('-')
+      end
+
+      def format_name(name)
+        name ||= ''
+        if name.index('*') != nil
+          subnames = name.split('*')
+          name = subnames[0].ljust(12)[0..11] + '*' + subnames[1]
+        end
+        name.ljust(22)[0..21]
+      end
     end
   end
 end

data/lib/cybersource/models/response.rb

@@ -121,6 +121,7 @@ module Killbill #:nodoc:
         t_info_plugin = super(transaction)
 
         t_info_plugin.properties << create_plugin_property('cybersourceResponseId', id)
+        t_info_plugin.properties << create_plugin_property('processorResponse', params_processor_response)
 
         set_correct_status(t_info_plugin)
 

data/pom.xml

@@ -25,7 +25,7 @@
     <groupId>org.kill-bill.billing.plugin.ruby</groupId>
     <artifactId>cybersource-plugin</artifactId>
     <packaging>pom</packaging>
-    <version>4.0.7</version>
+    <version>4.0.8</version>
     <name>cybersource-plugin</name>
     <url>http://github.com/killbill/killbill-cybersource-plugin</url>
     <description>Plugin for accessing Cybersource as a payment gateway</description>

data/spec/cybersource/base_plugin_spec.rb

@@ -196,6 +196,82 @@ describe Killbill::Cybersource::PaymentPlugin do
     end
   end
 
+  def stub_gateway_for_invoice_header(invoice_match_status)
+    ::ActiveMerchant::Billing::CyberSourceGateway.any_instance.stub(:ssl_post) do |host, request_body|
+      case(invoice_match_status)
+      when :none
+        request_body.should_not match('<invoiceHeader>')
+      when :all
+        request_body.should match('<invoiceHeader>\n        <merchantDescriptor>Ray Qiu               </merchantDescriptor>\n        <merchantDescriptorContact>650-888-3161</merchantDescriptorContact>\n      </invoiceHeader>')
+      when :except_authorize
+        if request_body.index('ccAuthService').present?
+          request_body.should_not match('<invoiceHeader>\n        <amexDataTAA1>Ray Qiu</amexDataTAA1>\n        <amexDataTAA2>6508883161</amexDataTAA2>')
+        else
+          request_body.should match('<invoiceHeader>\n        <amexDataTAA1>Ray Qiu</amexDataTAA1>\n        <amexDataTAA2>6508883161</amexDataTAA2>')
+        end
+      end
+      successful_purchase_response
+    end
+  end
+
+  shared_examples 'full payment' do
+    before do
+      send(add_payment_properties, txn_properties, card_type)
+      stub_gateway_for_invoice_header(invoice_match_status)
+    end
+
+    it 'should met expectations' do
+      auth_responses = create_transaction(card_type, :authorize, nil, :PROCESSED, txn_properties, expected_successful_params)
+      capture_responses = create_transaction(card_type, :capture, auth_responses, :PROCESSED, txn_properties, expected_successful_params)
+      create_transaction(card_type, :refund, capture_responses, :PROCESSED, txn_properties, expected_successful_params)
+    end
+  end
+
+  shared_examples 'invoice header example' do
+    let(:card_type){ :visa }
+    let(:txn_properties){ [] }
+
+    context 'while no descriptor provided' do
+      let(:invoice_match_status){ :none }
+
+      context 'visa' do
+        it_behaves_like 'full payment'
+      end
+
+      context 'amex' do
+        let(:card_type){ :amex }
+        it_behaves_like 'full payment'
+      end
+    end
+
+    context 'while descriptor provided' do
+      before{ txn_properties << build_property('merchant_descriptor', {"name"=>"Ray Qiu", "contact"=>"6508883161"}.to_json) }
+
+      context 'visa' do
+        let(:invoice_match_status){ :all }
+        it_behaves_like 'full payment'
+      end
+
+      context 'amex' do
+        let(:card_type){ :amex }
+        let(:invoice_match_status){ :except_authorize }
+        it_behaves_like 'full payment'
+      end
+    end
+  end
+
+  context 'Invoice Header' do
+    context 'payments with card' do
+      let(:add_payment_properties){ :add_card_property }
+      it_behaves_like 'invoice header example'
+    end
+
+    context 'payments with network tokenization' do
+      let(:add_payment_properties){ :add_network_tokenization_properties }
+      it_behaves_like 'invoice header example'
+    end
+  end
+
   private
 
   def with_transaction(kb_payment_id, transaction_type, created_at, context)
@@ -215,43 +291,98 @@ describe Killbill::Cybersource::PaymentPlugin do
     t.destroy! unless t.nil?
   end
 
-  def purchase_with_card(expected_status = :PROCESSED, properties = [], expected_params = {})
+  def add_card_property(properties, card_type = :visa)
     properties << build_property('email', 'foo@bar.com')
-    properties << build_property('cc_number', '4111111111111111')
-
-    purchase(expected_status, properties, expected_params)
+    if card_type == :amex
+      properties << build_property('cc_number', '378282246310005')
+    else
+      properties << build_property('cc_number', '4111111111111111')
+    end
   end
 
-  def purchase_with_token(expected_status = :PROCESSED, properties = [], expected_params = {})
+  def add_token_property(properties)
     properties << build_property('email', 'foo@bar.com')
     properties << build_property('token', '1234')
-
-    purchase(expected_status, properties, expected_params)
   end
 
-  def purchase_with_network_tokenization(expected_status = :PROCESSED, properties = [], expected_params = {})
+  def add_network_tokenization_properties(properties, card_type = :visa)
+    if card_type == :amex
+      properties << build_property('cc_number', '378282246310005')
+      properties << build_property('brand', 'american_express')
+      properties << build_property('payment_cryptogram', Base64.encode64('111111111100cryptogram'))
+    else
+      properties << build_property('cc_number', '4111111111111111')
+      properties << build_property('brand', 'visa')
+      properties << build_property('payment_cryptogram', '111111111100cryptogram')
+    end
     properties << build_property('email', 'foo@bar.com')
-    properties << build_property('cc_number', '4111111111111111')
-    properties << build_property('brand', 'visa')
     properties << build_property('eci', '05')
-    properties << build_property('payment_cryptogram', '111111111100cryptogram')
+  end
 
+  def purchase_with_card(expected_status = :PROCESSED, properties = [], expected_params = {})
+    add_card_property(properties)
     purchase(expected_status, properties, expected_params)
   end
 
-  def purchase(expected_status = :PROCESSED, properties = [], expected_params = {})
-    kb_payment_id = SecureRandom.uuid
-    kb_payment = @plugin.kb_apis.proxied_services[:payment_api].add_payment(kb_payment_id)
-    kb_transaction_id = kb_payment.transactions[0].id
+  def purchase_with_token(expected_status = :PROCESSED, properties = [], expected_params = {})
+    add_token_property(properties)
+    purchase(expected_status, properties, expected_params)
+  end
 
-    payment_response = @plugin.purchase_payment(SecureRandom.uuid, kb_payment_id, kb_transaction_id, SecureRandom.uuid, BigDecimal.new('100'), 'USD', properties, build_call_context)
+  def purchase_with_network_tokenization(expected_status = :PROCESSED, properties = [], expected_params = {})
+    add_network_tokenization_properties(properties)
+    purchase(expected_status, properties, expected_params)
+  end
+
+  def verify_response(payment_response, expected_status, expected_params)
     payment_response.status.should eq(expected_status), payment_response.gateway_error
 
     gw_response = Killbill::Cybersource::CybersourceResponse.last
     expected_params.each do |k, v|
       gw_response.send(k.to_sym).should == v
     end
+  end
 
+  def create_transaction(card_type = :visa, txn_type = :authorize, previous_response = nil, expected_status = :PROCESSED, properties = [], expected_params = {})
+    if txn_type == :authorize
+      authorize(expected_status, properties, expected_params)
+    else
+      previous_response.shift
+      send(txn_type, *previous_response, expected_status, properties, expected_params)
+    end
+  end
+
+  def authorize(expected_status = :PROCESSED, properties = [], expected_params = {})
+    kb_account_id = SecureRandom.uuid
+    kb_payment_method_id = SecureRandom.uuid
+    kb_payment_id = SecureRandom.uuid
+    kb_payment = @plugin.kb_apis.proxied_services[:payment_api].add_payment(kb_payment_id)
+    kb_transaction_id = kb_payment.transactions[0].id
+
+    payment_response = @plugin.authorize_payment(kb_account_id, kb_payment_id, kb_transaction_id, kb_payment_method_id, BigDecimal.new('100'), 'USD', properties, build_call_context)
+    verify_response(payment_response, expected_status, expected_params)
+    return payment_response, kb_account_id, kb_payment_id, kb_transaction_id, kb_payment_method_id
+  end
+
+  def capture(kb_account_id, kb_payment_id, kb_transaction_id, kb_payment_method_id, expected_status = :PROCESSED, properties = [], expected_params = {})
+    payment_response = @plugin.capture_payment(kb_account_id, kb_payment_id, kb_transaction_id, kb_payment_method_id, BigDecimal.new('100'), 'USD', properties, build_call_context)
+    verify_response(payment_response, expected_status, expected_params)
+    return payment_response, kb_account_id, kb_payment_id, kb_transaction_id, kb_payment_method_id
+  end
+
+  def refund(kb_account_id, kb_payment_id, kb_transaction_id, kb_payment_method_id, expected_status = :PROCESSED, properties = [], expected_params = {})
+    payment_response = @plugin.refund_payment(kb_account_id, kb_payment_id, kb_transaction_id, kb_payment_method_id, BigDecimal.new('100'), 'USD', properties, build_call_context)
+    verify_response(payment_response, expected_status, expected_params)
+    return payment_response, kb_account_id, kb_payment_id, kb_transaction_id, kb_payment_method_id
+  end
+
+  def purchase(expected_status = :PROCESSED, properties = [], expected_params = {})
+    kb_payment_id = SecureRandom.uuid
+    kb_payment = @plugin.kb_apis.proxied_services[:payment_api].add_payment(kb_payment_id)
+    kb_transaction_id = kb_payment.transactions[0].id
+
+    payment_response = @plugin.purchase_payment(SecureRandom.uuid, kb_payment_id, kb_transaction_id, SecureRandom.uuid, BigDecimal.new('100'), 'USD', properties, build_call_context)
+    verify_response(payment_response, expected_status, expected_params)
     payment_response
   end
 

data/spec/cybersource/remote/integration_spec.rb

@@ -184,6 +184,22 @@ describe Killbill::Cybersource::PaymentPlugin do
     check_response(payment_response, @amount, :PURCHASE, :PROCESSED, 'Successful transaction', '100')
   end
 
+  it 'should be able to pay with Android Pay' do
+    properties = build_pm_properties(nil,
+                                     {
+                                         :cc_number => 4895370012003478,
+                                         :cc_type => 'visa',
+                                         :payment_cryptogram => 'AgAAAAAABk4DWZ4C28yUQAAAAAA=',
+                                         :ignore_avs => true,
+                                         :ignore_cvv => true
+                                     })
+    properties << build_property('source', 'androidpay')
+
+    kb_payment = setup_kb_payment
+    payment_response = @plugin.authorize_payment(@pm.kb_account_id, kb_payment.id, kb_payment.transactions[0].id, @pm.kb_payment_method_id, @amount, @currency, properties, @call_context)
+    check_response(payment_response, @amount, :AUTHORIZE, :PROCESSED, 'Successful transaction', '100')
+  end
+
   it 'should be able to fix UNDEFINED payments' do
     payment_response = @plugin.purchase_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[0].id, @pm.kb_payment_method_id, @amount, @currency, @properties, @call_context)
     check_response(payment_response, @amount, :PURCHASE, :PROCESSED, 'Successful transaction', '100')
@@ -545,6 +561,42 @@ describe Killbill::Cybersource::PaymentPlugin do
     end
   end
 
+  shared_examples 'success_auth_capture_and_refund' do
+    it 'should be able to auth, capture and refund with descriptors' do
+      @pm = create_payment_method(::Killbill::Cybersource::CybersourcePaymentMethod, nil, @call_context.tenant_id, @properties)
+
+      payment_response = @plugin.authorize_payment(@pm.kb_account_id, payment_id, SecureRandom.uuid, @pm.kb_payment_method_id, @amount, @currency, @properties, @call_context)
+      check_response(payment_response, @amount, :AUTHORIZE, :PROCESSED, 'Successful transaction', '100')
+
+      # Try a capture
+      payment_response = @plugin.capture_payment(@pm.kb_account_id, payment_id, SecureRandom.uuid, @pm.kb_payment_method_id, @amount, @currency, @properties, @call_context)
+      check_response(payment_response, @amount, :CAPTURE, :PROCESSED, 'Successful transaction', '100')
+
+      # Try a refund
+      refund_response = @plugin.refund_payment(@pm.kb_account_id, payment_id, SecureRandom.uuid, @pm.kb_payment_method_id, @amount, @currency, @properties, @call_context)
+      check_response(refund_response, @amount, :REFUND, :PROCESSED, 'Successful transaction', '100')
+    end
+  end
+
+  describe 'with merchant descriptor' do
+    before do
+      @properties << build_property('merchant_descriptor', {"name"=>"Ray Qiu", "contact"=>"6508883161"}.to_json)
+    end
+    let(:payment_id){ SecureRandom.uuid }
+
+    context 'using cybersource token' do
+      it_behaves_like 'success_auth_capture_and_refund'
+    end
+
+    context 'using credit card' do
+      before do
+        @properties << build_property('email', 'foo@bar.com')
+        @properties << build_property('cc_number', '4111111111111111')
+      end
+      it_behaves_like 'success_auth_capture_and_refund'
+    end
+  end
+
   private
 
   def check_response(payment_response, amount, transaction_type, expected_status, expected_error, expected_error_code, expected_processor_response = nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: killbill-cybersource
 version: !ruby/object:Gem::Version
-  version: 4.0.7
+  version: 4.0.8
 platform: ruby
 authors:
 - Kill Bill core team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-06-24 00:00:00.000000000 Z
+date: 2016-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: killbill