killbill-cybersource 4.0.2 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b493be89fec342f29d8b2301b33df6d1fb2242f
-  data.tar.gz: af046593004ae23ac977ea4c818df2fc53620e5d
+  metadata.gz: bf0b374a0672d53db036f9f39c45d663c5478b71
+  data.tar.gz: f7244811da2b9e5c2dae307c84e919b3886a1692
 SHA512:
-  metadata.gz: 1f76a9a57ab6780e4bfefc3deb1429a7d86cfba8efb70bc45d0ac058557c36edf0912cdd6a87209dd699ba0bfd4fbcbbfbfaeb46a1ce6a4447aca02bbff59b5a
-  data.tar.gz: fd5086b9920e5cc9b734b094b94952e428b37b19d41f9bc4879fec8f3051ed85812aedd9440a94ca6eec5da944c507275ddd6747a19e17806b55212b9443fdee
+  metadata.gz: 23bd9c1612dfa4bc4c2af62fb090865a64ab1e8ef2acbd8bb7d6ad9ead71da4b22814c0fe08cabf1b50a362d9e25528909fe475a696924477e124fc8c30d14a3
+  data.tar.gz: 3989c693a1c021c9ec0186638bbaeb78154c007884be21b5a237281948cb5f49016b5c15ab93ac9f6f988d3f28cb60af84eb99cd764393f6d3edcbf2b92e609d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    killbill-cybersource (4.0.2)
+    killbill-cybersource (4.0.3)
       actionpack (~> 4.1.0)
       actionview (~> 4.1.0)
       activemerchant (~> 1.48.0)
@@ -65,7 +65,7 @@ GEM
     diff-lcs (1.1.3)
     equalizer (0.0.11)
     erubis (2.7.0)
-    ethon (0.8.1)
+    ethon (0.9.0)
       ffi (>= 1.3.0)
     ffi (1.9.10-java)
     i18n (0.7.0)

data/NEWS

@@ -1,3 +1,16 @@
+4.0.3
+    Add support for business rules on Apple Pay
+    You can now specify commerce_indicator as a plugin property to override the commerceIndicator value
+    You can now specify force_validation=true as a plugin property to trigger $1 CC validation in case
+      the processor used doesn't support $0 auth for that card
+    Disable costly duplicate checks by default when triggering a payment if the reporting API is configured
+      - Set check_for_duplicates: true in your configuration to enable them
+      - No change in the GET path (UNDEFINED transactions will be fixed if possible)
+    Fix XML parsing of responses (authorization reversal errors weren't parsed correctly)
+    Improve categorization of error codes to return the right transaction status
+    Set clientLibrary to 'Kill Bill' and clientLibraryVersion to the plugin version
+    Change cybersource_responses.message to text
+
 4.0.2
     Add support for auth reversal after voiding a capture
     Add support for ignore_avs and ignore_cvv properties

data/README.md

@@ -130,29 +130,32 @@ curl -v \
 Plugin properties
 -----------------
 
-| Key                          | Description                                                       |
-| ---------------------------: | ----------------------------------------------------------------- |
-| skip_gw                      | If true, skip the call to CyberSource                             |
-| payment_processor_account_id | Config entry name of the merchant account to use                  |
-| external_key_as_order_id     | If true, set the payment external key as the CyberSource order id |
-| ignore_avs                   | If true, ignore the results of AVS checking                       |
-| ignore_cvv                   | If true, ignore the results of CVN checking                       |
-| cc_first_name                | Credit card holder first name                                     |
-| cc_last_name                 | Credit card holder last name                                      |
-| cc_type                      | Credit card brand                                                 |
-| cc_expiration_month          | Credit card expiration month                                      |
-| cc_expiration_year           | Credit card expiration year                                       |
-| cc_verification_value        | CVC/CVV/CVN                                                       |
-| email                        | Purchaser email                                                   |
-| address1                     | Billing address first line                                        |
-| address2                     | Billing address second line                                       |
-| city                         | Billing address city                                              |
-| zip                          | Billing address zip code                                          |
-| state                        | Billing address state                                             |
-| country                      | Billing address country                                           |
-| eci                          | Network tokenization attribute                                    |
-| payment_cryptogram           | Network tokenization attribute                                    |
-| transaction_id               | Network tokenization attribute                                    |
-| payment_instrument_name      | ApplePay tokenization attribute                                   |
-| payment_network              | ApplePay tokenization attribute                                   |
-| transaction_identifier       | ApplePay tokenization attribute                                   |
+| Key                          | Description                                                             |
+| ---------------------------: | ------------------------------------------------------------------------|
+| skip_gw                      | If true, skip the call to CyberSource                                   |
+| payment_processor_account_id | Config entry name of the merchant account to use                        |
+| external_key_as_order_id     | If true, set the payment external key as the CyberSource order id       |
+| ignore_avs                   | If true, ignore the results of AVS checking                             |
+| ignore_cvv                   | If true, ignore the results of CVN checking                             |
+| cc_first_name                | Credit card holder first name                                           |
+| cc_last_name                 | Credit card holder last name                                            |
+| cc_type                      | Credit card brand                                                       |
+| cc_expiration_month          | Credit card expiration month                                            |
+| cc_expiration_year           | Credit card expiration year                                             |
+| cc_verification_value        | CVC/CVV/CVN                                                             |
+| email                        | Purchaser email                                                         |
+| address1                     | Billing address first line                                              |
+| address2                     | Billing address second line                                             |
+| city                         | Billing address city                                                    |
+| zip                          | Billing address zip code                                                |
+| state                        | Billing address state                                                   |
+| country                      | Billing address country                                                 |
+| commerce_indicator           | Override the commerce indicator field                                   |
+| eci                          | Network tokenization attribute                                          |
+| payment_cryptogram           | Network tokenization attribute                                          |
+| transaction_id               | Network tokenization attribute                                          |
+| payment_instrument_name      | ApplePay tokenization attribute                                         |
+| payment_network              | ApplePay tokenization attribute                                         |
+| transaction_identifier       | ApplePay tokenization attribute                                         |
+| 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                              |

data/VERSION

@@ -1 +1 @@
-4.0.2
+4.0.3

data/cybersource.yml

@@ -7,6 +7,7 @@
 #    :merchantID: <%= ENV['MERCHANT_ID'] %>
 #    :username: <%= ENV['OD_USERNAME'] %>
 #    :password: <%= ENV['OD_PASSWORD'] %>
+#    :check_for_duplicates: true
 
 :database:
 # SQLite (development)

data/db/ddl.sql

@@ -57,7 +57,7 @@ CREATE TABLE `cybersource_responses` (
   `kb_payment_transaction_id` varchar(255) DEFAULT NULL,
   `transaction_type` varchar(255) DEFAULT NULL,
   `payment_processor_account_id` varchar(255) DEFAULT NULL,
-  `message` varchar(255) DEFAULT NULL,
+  `message` text DEFAULT NULL,
   `authorization` varchar(255) DEFAULT NULL,
   `fraud_review` tinyint(1) DEFAULT NULL,
   `test` tinyint(1) DEFAULT NULL,

data/db/migrate/20162519092522_enlarge_message.rb

@@ -0,0 +1,11 @@
+class EnlargeMessage < ActiveRecord::Migration
+
+  def change
+    reversible do |dir|
+      change_table :cybersource_responses do |t|
+        dir.up { t.change :message, :text }
+        dir.down { t.change :message, :string }
+      end
+    end
+  end
+end

data/db/schema.rb

@@ -58,7 +58,7 @@ ActiveRecord::Schema.define(:version => 20140410153635) do
     t.string   "kb_payment_transaction_id"
     t.string   "transaction_type"
     t.string   "payment_processor_account_id"
-    t.string   "message"
+    t.text     "message"
     t.string   "authorization"
     t.boolean  "fraud_review"
     t.boolean  "test"

data/lib/cybersource/api.rb

@@ -31,7 +31,18 @@ module Killbill #:nodoc:
         add_required_options(kb_account_id, properties, options, context)
 
         properties = merge_properties(properties, options)
-        super(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+        auth_response = super(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+
+        # Error 234 is "A problem exists with your CyberSource merchant configuration", most likely the processor used doesn't support $0 auth for this card type
+        if auth_response.gateway_error_code == '234' && to_cents(amount, currency) == 0
+          h_props = properties_to_hash(properties)
+          if ::Killbill::Plugin::ActiveMerchant::Utils.normalized(h_props, :force_validation)
+            force_validation_amount = (::Killbill::Plugin::ActiveMerchant::Utils.normalized(h_props, :force_validation_amount) || 1).to_f
+            auth_response = force_validation(auth_response, kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, force_validation_amount, currency, properties, context)
+          end
+        end
+
+        auth_response
       end
 
       def capture_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
@@ -257,18 +268,31 @@ module Killbill #:nodoc:
         super
 
         merchant_reference_code = options[:order_id]
-        report = get_report(merchant_reference_code, kb_transaction.created_date, options, context)
+        report = get_report_for_kb_transaction(merchant_reference_code, kb_transaction, options, context)
         return nil if report.nil? || report.empty?
 
-        logger.info "Skipping gateway call for existing transaction #{kb_transaction.id}, merchant reference code #{merchant_reference_code}"
+        logger.info "Skipping gateway call for existing kb_transaction_id='#{kb_transaction.id}', merchant_reference_code='#{merchant_reference_code}'"
         options[:skip_gw] = true
       rescue => e
-        logger.warn "Error checking for duplicate payment: #{e.message}"
+        logger.warn "Error checking for duplicate payment for merchant_reference_code='#{merchant_reference_code}'\n#{e.backtrace.join("\n")}"
+      end
+
+      # Duplicate check
+      def get_report_for_kb_transaction(merchant_reference_code, kb_transaction, options, context)
+        report_api = get_report_api(options, context)
+        return nil if report_api.nil? || !report_api.check_for_duplicates?
+        # kb_transaction is a Utils::LazyEvaluator, delay evaluation as much as possible
+        get_single_transaction_report(report_api, merchant_reference_code, kb_transaction.created_date)
       end
 
+      # Janitor path
       def get_report(merchant_reference_code, date, options, context)
-        report_api = get_report_api(context.tenant_id)
-        return nil if report_api.nil? || options[:skip_gw]
+        report_api = get_report_api(options, context)
+        return nil if report_api.nil?
+        get_single_transaction_report(report_api, merchant_reference_code, date)
+      end
+
+      def get_single_transaction_report(report_api, merchant_reference_code, date)
         report_api.single_transaction_report(merchant_reference_code, date.strftime('%Y%m%d'))
       end
 
@@ -287,12 +311,57 @@ module Killbill #:nodoc:
         ::Killbill::Plugin::ActiveMerchant::Utils.normalize_property(properties, 'ignore_cvv')
       end
 
-      def get_report_api(kb_tenant_id)
-        gateway = lookup_gateway(:on_demand, kb_tenant_id)
-        CyberSourceOnDemand.new(gateway, logger)
-      rescue
+      def get_report_api(options, context)
+        return nil if options[:skip_gw] || options[:bypass_duplicate_check]
+        cybersource_config = config(context.tenant_id)[:cybersource]
+        return nil unless cybersource_config.is_a?(Array)
+        on_demand_config = cybersource_config.find { |c| c[:account_id].to_s == 'on_demand' }
+        return nil if on_demand_config.nil?
+        CyberSourceOnDemand.new(on_demand_config, logger)
+      rescue => e
+        @logger.warn("Unexpected exception while looking-up reporting API for kb_tenant_id='#{context.tenant_id}'\n#{e.backtrace.join("\n")}")
         nil
       end
+
+      # TODO: should this eventually be hardened and extracted into the base framework?
+      def force_validation(auth_response, kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+        # Trigger a non-$0 auth
+        new_auth_response = nil
+        begin
+          # If duplicate checks are enabled, we need to bypass them (since a transaction for that merchant reference code was already attempted)
+          properties << build_property(:bypass_duplicate_check, true)
+          new_auth_response = authorize_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
+        rescue => e
+          # Note: state might be broken here (potentially two responses with the same kb_payment_transaction_id)
+          @logger.warn("Unexpected exception while forcing validation for kb_payment_id='#{kb_payment_id}', kb_payment_transaction_id='#{kb_payment_transaction_id}'\n#{e.backtrace.join("\n")}")
+          return auth_response
+        end
+
+        # Void it right away on success (make sure we didn't skip the gateway call too)
+        if new_auth_response.status == :PROCESSED && !new_auth_response.first_payment_reference_id.blank?
+          begin
+            void_payment(kb_account_id, kb_payment_id, SecureRandom.uuid, kb_payment_method_id, properties, context)
+          rescue => e
+            @logger.warn("Unexpected exception while voiding forced validation for kb_payment_id='#{kb_payment_id}', kb_payment_transaction_id='#{kb_payment_transaction_id}'\n#{e.backtrace.join("\n")}")
+          end
+        end
+
+        # Finally, clean up the state of the original (failed) auth
+        cybersource_response_id = find_value_from_properties(auth_response.properties, 'cybersourceResponseId')
+        if cybersource_response_id.nil?
+          @logger.warn "Unable to find cybersourceResponseId matching failed authorization for kb_payment_id='#{kb_payment_id}', kb_payment_transaction_id='#{kb_payment_transaction_id}'"
+        else
+          response = CybersourceResponse.find_by(:id => cybersource_response_id)
+          if response.nil?
+            @logger.warn "Unable to find response matching failed authorization for kb_payment_id='#{kb_payment_id}', kb_payment_transaction_id='#{kb_payment_transaction_id}'"
+          else
+            # Change the kb_payment_transaction_id to avoid confusing Kill Bill (there is no transaction row to update since the call wasn't successful)
+            response.update(:kb_payment_transaction_id => SecureRandom.uuid)
+          end
+        end
+
+        new_auth_response
+      end
     end
   end
 end

data/lib/cybersource/cyber_source_on_demand.rb

@@ -3,17 +3,20 @@ module Killbill #:nodoc:
     # See http://apps.cybersource.com/library/documentation/dev_guides/Reporting_Developers_Guide/reporting_dg.pdf
     class CyberSourceOnDemand
 
-      @@live_url = 'https://ebc.cybersource.com/ebc/Query'
-      @@test_url = 'https://ebctest.cybersource.com/ebctest/Query'
+      # For convenience, re-use the ActiveMerchant connection code, as the configuration is global currently
+      # (see https://github.com/killbill/killbill-plugin-framework-ruby/issues/47)
+      include ActiveMerchant::PostsData
 
-      def initialize(gateway, logger)
-        @gateway = gateway
+      def initialize(config, logger)
+        @config = config
         @logger = logger
+
+        configure_connection
       end
 
       def single_transaction_report(merchant_reference_code, target_date)
         params = {
-            :merchantID => @gateway.config[:merchantID],
+            :merchantID => @config[:merchantID],
             :merchantReferenceNumber => merchant_reference_code,
             :targetDate => target_date,
             :type => 'transaction',
@@ -23,14 +26,50 @@ module Killbill #:nodoc:
 
         headers = {
             # Don't use symbols or it will confuse Net/HTTP
-            'Authorization' => 'Basic ' + Base64.encode64("#{@gateway.config[:username]}:#{@gateway.config[:password]}").chomp
+            'Authorization' => 'Basic ' + Base64.encode64("#{@config[:username]}:#{@config[:password]}").chomp
         }
 
         data = URI.encode_www_form(params)
-        endpoint = @gateway.test? ? @@test_url : @@live_url
 
         # Will raise ResponseError if the response code is > 300
-        CyberSourceOnDemandTransactionReport.new(@gateway.ssl_post(endpoint, data, headers), @logger)
+        CyberSourceOnDemandTransactionReport.new(ssl_post(endpoint, data, headers), @logger)
+      end
+
+      def check_for_duplicates?
+        @config[:check_for_duplicates] == true
+      end
+
+      private
+
+      def endpoint
+        @config[:test] == false ? live_url : test_url
+      end
+
+      def live_url
+        @config[:live_url] || 'https://ebc.cybersource.com/ebc/Query'
+      end
+
+      def test_url
+        @config[:test_url] || 'https://ebctest.cybersource.com/ebctest/Query'
+      end
+
+      def configure_connection
+        if @config[:log_file]
+          self.wiredump_device = File.open(@config[:log_file], 'w')
+        else
+          log_method = @config[:quiet] ? :debug : :info
+          self.wiredump_device = ::Killbill::Plugin::ActiveMerchant::Utils::KBWiredumpDevice.new(@logger, log_method)
+        end
+        self.wiredump_device.sync = true
+
+        self.open_timeout = @config[:open_timeout] unless @config[:open_timeout].nil?
+        self.read_timeout = @config[:read_timeout] unless @config[:read_timeout].nil?
+        self.retry_safe = @config[:retry_safe] unless @config[:retry_safe].nil?
+        self.ssl_strict = @config[:ssl_strict] unless @config[:ssl_strict].nil?
+        self.ssl_version = @config[:ssl_version] unless @config[:ssl_version].nil?
+        self.max_retries = @config[:max_retries] unless @config[:max_retries].nil?
+        self.proxy_address = @config[:proxy_address] unless @config[:proxy_address].nil?
+        self.proxy_port = @config[:proxy_port] unless @config[:proxy_port].nil?
       end
 
       class CyberSourceOnDemandTransactionReport

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

@@ -1,7 +1,18 @@
 module ActiveMerchant
   module Billing
+
+    KB_PLUGIN_VERSION = Gem.loaded_specs['killbill-cybersource'].version.version rescue nil
+
     class CyberSourceGateway
 
+      def initialize(options = {})
+        super
+
+        # Add missing response codes
+        @@response_codes[:r104] = 'The merchant reference code for this authorization request matches the merchant reference code of another authorization request that you sent within the past 15 minutes.'
+        @@response_codes[:r110] = 'Only a partial amount was approved'
+      end
+
       # Add support for CreditCard objects
       def build_credit_request(money, creditcard_or_reference, options)
         xml = Builder::XmlMarkup.new :indent => 2
@@ -14,6 +25,67 @@ module ActiveMerchant
         xml.target!
       end
 
+      # Add support for commerceIndicator override
+      def add_auth_service(xml, payment_method, options)
+        if network_tokenization?(payment_method)
+          add_network_tokenization(xml, payment_method, options)
+        else
+          xml.tag! 'ccAuthService', {'run' => 'true'} do
+            # Let CyberSource figure it out otherwise (internet is the default unless tokens are used)
+            xml.tag!("commerceIndicator", options[:commerce_indicator]) unless options[:commerce_indicator].blank?
+          end
+        end
+      end
+
+      # Changes:
+      #  * Add support for commerceIndicator override
+      #  * Don't set paymentNetworkToken (needs to be set after businessRules)
+      def add_network_tokenization(xml, payment_method, options)
+        return unless network_tokenization?(payment_method)
+
+        case card_brand(payment_method).to_sym
+          when :visa
+            xml.tag! 'ccAuthService', {'run' => 'true'} do
+              xml.tag!("cavv", payment_method.payment_cryptogram)
+              xml.tag!("commerceIndicator", options[:commerce_indicator] || "vbv")
+              xml.tag!("xid", payment_method.payment_cryptogram)
+            end
+          when :mastercard
+            xml.tag! 'ucaf' do
+              xml.tag!("authenticationData", payment_method.payment_cryptogram)
+              xml.tag!("collectionIndicator", "2")
+            end
+            xml.tag! 'ccAuthService', {'run' => 'true'} do
+              xml.tag!("commerceIndicator", options[:commerce_indicator] || "spa")
+            end
+          when :american_express
+            cryptogram = Base64.decode64(payment_method.payment_cryptogram)
+            xml.tag! 'ccAuthService', {'run' => 'true'} do
+              xml.tag!("cavv", Base64.encode64(cryptogram[0...20]))
+              xml.tag!("commerceIndicator", options[:commerce_indicator] || "aesk")
+              xml.tag!("xid", Base64.encode64(cryptogram[20...40]))
+            end
+        end
+      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)
+      def add_business_rules_data(xml, payment_method, options)
+        prioritized_options = [options, @options]
+
+        xml.tag! 'businessRules' do
+          xml.tag!('ignoreAVSResult', 'true') if extract_option(prioritized_options, :ignore_avs)
+          xml.tag!('ignoreCVResult', 'true') if extract_option(prioritized_options, :ignore_cvv)
+        end
+
+        if network_tokenization?(payment_method)
+          xml.tag! 'paymentNetworkToken' do
+            xml.tag!('transactionType', "1")
+          end
+        end
+      end
+
       # See https://github.com/killbill/killbill-cybersource-plugin/issues/4
       def commit(request, options)
         request = build_request(request, options)
@@ -24,14 +96,23 @@ module ActiveMerchant
         end
         response = parse(raw_response)
 
+        # Remove namespace when unnecessary (ActiveMerchant and our original code expect it that way)
+        response.keys.each do |k|
+          _, actual_key = k.to_s.split('_', 2)
+          if !actual_key.nil? && !response.has_key?(actual_key)
+            response[actual_key] = response[k]
+            response.delete(k)
+          end
+        end
+
         success = response[:decision] == 'ACCEPT'
-        authorization = success ? [options[:order_id], response[:requestID], response[:requestToken]].compact.join(";") : nil
+        authorization = success ? [options[:order_id], response[:requestID], response[:requestToken]].compact.join(';') : nil
 
-        if response[:faultcode] == 'wsse:FailedCheck'
-          message = { :exception_message => response[:message], :payment_plugin_status => :CANCELED }.to_json
-        else
-          message = @@response_codes[('r' + response[:reasonCode]).to_sym] rescue response[:message]
+        message = nil
+        if response[:reasonCode].blank? && (response[:faultcode] == 'wsse:FailedCheck' || response[:faultcode] == 'wsse:InvalidSecurity' || response[:faultcode] == 'soap:Client' || response[:faultcode] == 'c:ServerError')
+          message = {:exception_message => response[:message], :payment_plugin_status => :CANCELED}.to_json
         end
+        message ||= @@response_codes[('r' + response[:reasonCode].to_s).to_sym] || response[:message]
 
         Response.new(success, message, response,
                      :test => test?,
@@ -40,6 +121,31 @@ module ActiveMerchant
                      :cvv_result => response[:cvCode]
         )
       end
+
+      def add_merchant_data(xml, options)
+        xml.tag! 'merchantID', @options[:login]
+        xml.tag! 'merchantReferenceCode', options[:order_id]
+        xml.tag! 'clientLibrary' ,'Kill Bill'
+        xml.tag! 'clientLibraryVersion', KB_PLUGIN_VERSION
+        xml.tag! 'clientEnvironment' , RUBY_PLATFORM
+      end
+
+      def parse_element(reply, node)
+        if node.has_elements?
+          node.elements.each { |e| parse_element(reply, e) }
+        else
+          # The original ActiveMerchant implementation clobbers top level fields with values from the children
+          # Instead, always namespace the keys for children (cleanup is needed afterwards, see above)
+          is_top_level = node.parent.name == 'replyMessage' || node.parent.name == 'Fault'
+          key = node.name.to_sym
+          unless is_top_level
+            parent = node.parent.name + (node.parent.attributes['id'] ? '_' + node.parent.attributes['id'] : '')
+            key = (parent + '_' + node.name).to_sym
+          end
+          reply[key] = node.text
+        end
+        return reply
+      end
     end
   end
 end

data/lib/cybersource/models/response.rb

@@ -6,6 +6,9 @@ module Killbill #:nodoc:
 
       has_one :cybersource_transaction
 
+      UNDEFINED_ERROR_CODES = [ 151, 152, 250 ]
+      CANCELED_ERROR_CODES = [ 101, 102, 104, 150, 207, 232, 234, 235, 236, 237, 238, 239, 240, 241, 243, 246, 247, 254 ]
+
       def self.from_response(api_call, kb_account_id, kb_payment_id, kb_payment_transaction_id, transaction_type, payment_processor_account_id, kb_tenant_id, response, extra_params = {}, model = ::Killbill::Cybersource::CybersourceResponse)
         super(api_call,
               kb_account_id,
@@ -98,8 +101,23 @@ module Killbill #:nodoc:
 
         t_info_plugin.properties << create_plugin_property('cybersourceResponseId', id)
 
+        set_correct_status(t_info_plugin)
+
         t_info_plugin
       end
+
+      def set_correct_status(t_info_plugin)
+        # Respect the existing status if the payment was successful, if overridden or if there is no error code
+        return if success || message.strip.start_with?('{') || gateway_error_code.blank?
+
+        if CANCELED_ERROR_CODES.include?(gateway_error_code.to_i)
+          t_info_plugin.status = :CANCELED
+        elsif UNDEFINED_ERROR_CODES.include?(gateway_error_code.to_i)
+          t_info_plugin.status = :UNDEFINED
+        else
+          t_info_plugin.status = :ERROR
+        end
+      end
     end
   end
 end

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.2</version>
+    <version>4.0.3</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

@@ -24,6 +24,26 @@ describe Killbill::Cybersource::PaymentPlugin do
     end
   end
 
+  let(:expected_successful_params) do
+    {
+        :params_merchant_reference_code => 'b0a6cf9aa07f1a8495f89c364bbd6a9a',
+        :params_request_id => '2004333231260008401927',
+        :params_decision => 'ACCEPT',
+        :params_reason_code => '100',
+        :params_request_token => 'Afvvj7Ke2Fmsbq0wHFE2sM6R4GAptYZ0jwPSA+R9PhkyhFTb0KRjoE4+ynthZrG6tMBwjAtT',
+        :params_currency => 'USD',
+        :params_amount => '1.00',
+        :params_authorization_code => '123456',
+        :params_avs_code => 'Y',
+        :params_avs_code_raw => 'Y',
+        :params_cv_code => 'M',
+        :params_authorized_date_time => '2008-01-15T21:42:03Z',
+        :params_processor_response => '00',
+        :params_reconciliation_id => 'ABCDEF',
+        :params_subscription_id => 'XXYYZZ'
+    }
+  end
+
   it 'should start and stop correctly' do
     @plugin.stop_plugin
   end
@@ -54,8 +74,8 @@ describe Killbill::Cybersource::PaymentPlugin do
         request_body.should_not match('<ignoreCVResult>')
         successful_purchase_response
       end
-      purchase
-      purchase(:PROCESSED, [build_property('ignore_avs', 'false'), build_property('ignore_cvv', 'false')])
+      purchase_with_token(:PROCESSED, [], expected_successful_params)
+      purchase_with_token(:PROCESSED, [build_property('ignore_avs', 'false'), build_property('ignore_cvv', 'false')], expected_successful_params)
     end
 
     it 'ignores AVS and CVN' do
@@ -64,7 +84,7 @@ describe Killbill::Cybersource::PaymentPlugin do
         request_body.should match('<ignoreCVResult>')
         successful_purchase_response
       end
-      purchase(:PROCESSED, [build_property('ignore_avs', 'true'), build_property('ignore_cvv', 'true')])
+      purchase_with_token(:PROCESSED, [build_property('ignore_avs', 'true'), build_property('ignore_cvv', 'true')], expected_successful_params)
     end
 
     it 'ignores AVS but not CVN' do
@@ -73,8 +93,8 @@ describe Killbill::Cybersource::PaymentPlugin do
         request_body.should_not match('<ignoreCVResult>')
         successful_purchase_response
       end
-      purchase(:PROCESSED, [build_property('ignore_avs', 'true')])
-      purchase(:PROCESSED, [build_property('ignore_avs', 'true'), build_property('ignore_cvv', 'false')])
+      purchase_with_token(:PROCESSED, [build_property('ignore_avs', 'true')], expected_successful_params)
+      purchase_with_token(:PROCESSED, [build_property('ignore_avs', 'true'), build_property('ignore_cvv', 'false')], expected_successful_params)
     end
 
     it 'ignores CVN but not AVS' do
@@ -83,8 +103,45 @@ describe Killbill::Cybersource::PaymentPlugin do
         request_body.should match('<ignoreCVResult>')
         successful_purchase_response
       end
-      purchase(:PROCESSED, [build_property('ignore_cvv', 'true')])
-      purchase(:PROCESSED, [build_property('ignore_avs', 'false'), build_property('ignore_cvv', 'true')])
+      purchase_with_token(:PROCESSED, [build_property('ignore_cvv', 'true')], expected_successful_params)
+      purchase_with_token(:PROCESSED, [build_property('ignore_avs', 'false'), build_property('ignore_cvv', 'true')], expected_successful_params)
+    end
+  end
+
+  context 'Override parameters' do
+
+    it 'has a default commerceIndicator' do
+      ::ActiveMerchant::Billing::CyberSourceGateway.any_instance.stub(:ssl_post) do |host, request_body|
+        request_body.should_not match('<commerceIndicator>')
+        successful_purchase_response
+      end
+      purchase_with_token(:PROCESSED, [], expected_successful_params)
+    end
+
+    it 'can override commerceIndicator for card-on-file' do
+      ::ActiveMerchant::Billing::CyberSourceGateway.any_instance.stub(:ssl_post) do |host, request_body|
+        request_body.should match('<commerceIndicator>recurring</commerceIndicator>')
+        successful_purchase_response
+      end
+      purchase_with_card(:PROCESSED, [build_property('commerce_indicator', 'recurring')], expected_successful_params)
+    end
+
+    it 'has a default commerceIndicator for Apple Pay' do
+      ::ActiveMerchant::Billing::CyberSourceGateway.any_instance.stub(:ssl_post) do |host, request_body|
+        request_body.should_not match('<commerceIndicator>internet</commerceIndicator>')
+        request_body.should match('<commerceIndicator>vbv</commerceIndicator>')
+        successful_purchase_response
+      end
+      purchase_with_network_tokenization(:PROCESSED, [], expected_successful_params)
+    end
+
+    it 'can override commerceIndicator for Apple Pay' do
+      ::ActiveMerchant::Billing::CyberSourceGateway.any_instance.stub(:ssl_post) do |host, request_body|
+        request_body.should_not match('<commerceIndicator>vbv</commerceIndicator>')
+        request_body.should match('<commerceIndicator>internet</commerceIndicator>')
+        successful_purchase_response
+      end
+      purchase_with_network_tokenization(:PROCESSED, [build_property('commerce_indicator', 'internet')], expected_successful_params)
     end
   end
 
@@ -92,17 +149,24 @@ describe Killbill::Cybersource::PaymentPlugin do
 
     it 'handles expired passwords as CANCELED transactions' do
       ::ActiveMerchant::Billing::CyberSourceGateway.any_instance.stub(:ssl_post).and_return(password_expired_response)
-      purchase(:CANCELED).gateway_error.should == 'wsse:FailedCheck: Security Data : Merchant password has expired.'
+      purchase_with_token(:CANCELED).gateway_error.should == 'wsse:FailedCheck: Security Data : Merchant password has expired.'
     end
 
     it 'handles bad passwords as CANCELED transactions' do
       ::ActiveMerchant::Billing::CyberSourceGateway.any_instance.stub(:ssl_post).and_return(bad_password_response)
-      purchase(:CANCELED).gateway_error.should == 'wsse:FailedCheck: Security Data : UsernameToken authentication failed.'
+      purchase_with_token(:CANCELED).gateway_error.should == 'wsse:FailedCheck: Security Data : UsernameToken authentication failed.'
     end
 
     it 'handles unsuccessful authorizations as ERROR transactions' do
       ::ActiveMerchant::Billing::CyberSourceGateway.any_instance.stub(:ssl_post).and_return(unsuccessful_authorization_response)
-      purchase(:ERROR).gateway_error.should == 'Invalid account number'
+      purchase_with_token(:ERROR).gateway_error.should == 'Invalid account number'
+    end
+
+    it 'parses correctly authorization reversal errors' do
+      ::ActiveMerchant::Billing::CyberSourceGateway.any_instance.stub(:ssl_post).and_return(unsuccessful_auth_reversal_response)
+      payment_response = purchase_with_token(:CANCELED)
+      payment_response.gateway_error.should == 'One or more fields contains invalid data'
+      payment_response.gateway_error_code.should == '102'
     end
   end
 
@@ -125,16 +189,43 @@ describe Killbill::Cybersource::PaymentPlugin do
     t.destroy! unless t.nil?
   end
 
-  def purchase(expected_status = :PROCESSED, properties = [])
-    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_card(expected_status = :PROCESSED, properties = [], expected_params = {})
+    properties << build_property('email', 'foo@bar.com')
+    properties << build_property('cc_number', '4111111111111111')
 
+    purchase(expected_status, properties, expected_params)
+  end
+
+  def purchase_with_token(expected_status = :PROCESSED, properties = [], expected_params = {})
     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 = {})
+    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')
+
+    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
+
     payment_response = @plugin.purchase_payment(SecureRandom.uuid, kb_payment_id, kb_transaction_id, SecureRandom.uuid, BigDecimal.new('100'), 'USD', properties, build_call_context)
     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
+
     payment_response
   end
 
@@ -142,7 +233,7 @@ describe Killbill::Cybersource::PaymentPlugin do
     <<-XML
 <?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
 <soap:Header>
-<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"><wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="Timestamp-2636690"><wsu:Created>2008-01-15T21:42:03.343Z</wsu:Created></wsu:Timestamp></wsse:Security></soap:Header><soap:Body><c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.26"><c:merchantReferenceCode>b0a6cf9aa07f1a8495f89c364bbd6a9a</c:merchantReferenceCode><c:requestID>2004333231260008401927</c:requestID><c:decision>ACCEPT</c:decision><c:reasonCode>100</c:reasonCode><c:requestToken>Afvvj7Ke2Fmsbq0wHFE2sM6R4GAptYZ0jwPSA+R9PhkyhFTb0KRjoE4+ynthZrG6tMBwjAtT</c:requestToken><c:purchaseTotals><c:currency>USD</c:currency></c:purchaseTotals><c:ccAuthReply><c:reasonCode>100</c:reasonCode><c:amount>1.00</c:amount><c:authorizationCode>123456</c:authorizationCode><c:avsCode>Y</c:avsCode><c:avsCodeRaw>Y</c:avsCodeRaw><c:cvCode>M</c:cvCode><c:cvCodeRaw>M</c:cvCodeRaw><c:authorizedDateTime>2008-01-15T21:42:03Z</c:authorizedDateTime><c:processorResponse>00</c:processorResponse><c:authFactorCode>U</c:authFactorCode></c:ccAuthReply></c:replyMessage></soap:Body></soap:Envelope>
+<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"><wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="Timestamp-2636690"><wsu:Created>2008-01-15T21:42:03.343Z</wsu:Created></wsu:Timestamp></wsse:Security></soap:Header><soap:Body><c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.26"><c:merchantReferenceCode>b0a6cf9aa07f1a8495f89c364bbd6a9a</c:merchantReferenceCode><c:requestID>2004333231260008401927</c:requestID><c:decision>ACCEPT</c:decision><c:reasonCode>100</c:reasonCode><c:requestToken>Afvvj7Ke2Fmsbq0wHFE2sM6R4GAptYZ0jwPSA+R9PhkyhFTb0KRjoE4+ynthZrG6tMBwjAtT</c:requestToken><c:purchaseTotals><c:currency>USD</c:currency></c:purchaseTotals><c:ccAuthReply><c:reasonCode>100</c:reasonCode><c:amount>1.00</c:amount><c:authorizationCode>123456</c:authorizationCode><c:avsCode>Y</c:avsCode><c:avsCodeRaw>Y</c:avsCodeRaw><c:cvCode>M</c:cvCode><c:cvCodeRaw>M</c:cvCodeRaw><c:authorizedDateTime>2008-01-15T21:42:03Z</c:authorizedDateTime><c:processorResponse>00</c:processorResponse><c:reconciliationID>ABCDEF</c:reconciliationID><c:authFactorCode>U</c:authFactorCode></c:ccAuthReply><c:paySubscriptionCreateReply><c:reasonCode>100</c:reasonCode><c:subscriptionID>XXYYZZ</c:subscriptionID></c:paySubscriptionCreateReply></c:replyMessage></soap:Body></soap:Envelope>
     XML
   end
 
@@ -169,4 +260,12 @@ describe Killbill::Cybersource::PaymentPlugin do
 <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"><wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="Timestamp-28121162"><wsu:Created>2008-01-15T21:50:41.580Z</wsu:Created></wsu:Timestamp></wsse:Security></soap:Header><soap:Body><c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.26"><c:merchantReferenceCode>a1efca956703a2a5037178a8a28f7357</c:merchantReferenceCode><c:requestID>2004338415330008402434</c:requestID><c:decision>REJECT</c:decision><c:reasonCode>231</c:reasonCode><c:requestToken>Afvvj7KfIgU12gooCFE2/DanQIApt+G1OgTSA+R9PTnyhFTb0KRjgFY+ynyIFNdoKKAghwgx</c:requestToken><c:ccAuthReply><c:reasonCode>231</c:reasonCode></c:ccAuthReply></c:replyMessage></soap:Body></soap:Envelope>
     XML
   end
+
+  def unsuccessful_auth_reversal_response
+    <<-XML
+<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+<soap:Header>
+<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"><wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="Timestamp-28121162"><wsu:Created>2008-01-15T21:50:41.580Z</wsu:Created></wsu:Timestamp></wsse:Security></soap:Header><soap:Body><c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.26"><c:merchantReferenceCode>a1efca956703a2a5037178a8a28f7357</c:merchantReferenceCode><c:requestID>2004338415330008402434</c:requestID><c:decision>REJECT</c:decision><c:reasonCode>102</c:reasonCode><c:requestToken>Afvvj7KfIgU12gooCFE2/DanQIApt+G1OgTSA+R9PTnyhFTb0KRjgFY+ynyIFNdoKKAghwgx</c:requestToken><c:ccAuthReversalReply><c:reasonCode>102</c:reasonCode></c:ccAuthReversalReply><c:originalTransaction><c:amount>0.00</c:amount><c:reasonCode>100</c:reasonCode></c:originalTransaction></c:replyMessage></soap:Body></soap:Envelope>
+    XML
+  end
 end

data/spec/cybersource/remote/integration_spec.rb

@@ -21,18 +21,19 @@ describe Killbill::Cybersource::PaymentPlugin do
     @amount     = BigDecimal.new('100')
     @currency   = 'USD'
 
-    kb_payment_id = SecureRandom.uuid
-    1.upto(6) do
-      @kb_payment = @plugin.kb_apis.proxied_services[:payment_api].add_payment(kb_payment_id)
-    end
+    @kb_payment = setup_kb_payment(6)
   end
 
   after(:each) do
     @plugin.stop_plugin
   end
 
+  let(:report_api) do
+    @plugin.get_report_api({}, @call_context)
+  end
+
   let(:with_report_api) do
-    @plugin.get_report_api(@call_context.tenant_id).present?
+    report_api.present?
   end
 
   it 'should be able to charge a Credit Card directly and calls should be idempotent' do
@@ -43,12 +44,9 @@ describe Killbill::Cybersource::PaymentPlugin do
     Killbill::Cybersource::CybersourceTransaction.all.size.should == 0
 
     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)
-    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
-    payment_response.amount.should == @amount
-    payment_response.transaction_type.should == :PURCHASE
+    check_response(payment_response, @amount, :PURCHASE, :PROCESSED, 'Successful transaction', '100')
     payment_response.first_payment_reference_id.should_not be_nil
     payment_response.second_payment_reference_id.should_not be_nil
-    payment_response.gateway_error_code.should_not be_nil
 
     responses = Killbill::Cybersource::CybersourceResponse.all
     responses.size.should == 2
@@ -60,8 +58,8 @@ describe Killbill::Cybersource::PaymentPlugin do
     transactions.size.should == 1
     transactions[0].api_call.should == 'purchase'
 
-    # Skip the rest of the test if the report API isn't configured
-    break unless with_report_api
+    # Skip the rest of the test if the report API isn't configured to check for duplicates
+    break unless with_report_api && report_api.check_for_duplicates?
 
     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)
     payment_response.amount.should == @amount
@@ -88,9 +86,77 @@ describe Killbill::Cybersource::PaymentPlugin do
     transactions[1].txn_id.should be_nil
   end
 
+  it 'should be able to verify a Credit Card' do
+    # Valid card
+    properties = build_pm_properties
+    kb_payment = setup_kb_payment(2)
+    payment_response = @plugin.authorize_payment(@pm.kb_account_id, kb_payment.id, kb_payment.transactions[0].id, @pm.kb_payment_method_id, 0, @currency, properties, @call_context)
+    check_response(payment_response, 0, :AUTHORIZE, :PROCESSED, 'Successful transaction', '100')
+    payment_response.first_payment_reference_id.should_not be_nil
+    payment_response.second_payment_reference_id.should_not be_nil
+
+    # Note that you won't be able to void the $0 auth
+    payment_response = @plugin.void_payment(@pm.kb_account_id, kb_payment.id, kb_payment.transactions[1].id, @pm.kb_payment_method_id, @properties, @call_context)
+    check_response(payment_response, nil, :VOID, :CANCELED, 'One or more fields contains invalid data', '102')
+
+    # Invalid card
+    # See http://www.cybersource.com/developers/getting_started/test_and_manage/simple_order_api/HTML/General_testing_info/soapi_general_test.html
+    properties = build_pm_properties(nil, { :cc_exp_year => 1998 })
+    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, 0, @currency, properties, @call_context)
+    check_response(payment_response, nil, :AUTHORIZE, :ERROR, 'Expired card', '202')
+    payment_response.first_payment_reference_id.should_not be_nil
+    payment_response.second_payment_reference_id.should be_nil
+
+    # Discover card (doesn't support $0 auth on Paymentech)
+    # See http://www.cybersource.com/developers/other_resources/quick_references/test_cc_numbers/
+    properties = build_pm_properties(nil, { :cc_number => '6011111111111117', :cc_type => :discover })
+    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, 0, @currency, properties, @call_context)
+    check_response(payment_response, nil, :AUTHORIZE, :CANCELED, 'A problem exists with your CyberSource merchant configuration', '234')
+    payment_response.first_payment_reference_id.should_not be_nil
+    payment_response.second_payment_reference_id.should be_nil
+    # Verify the GET path
+    transaction_info_plugins = @plugin.get_payment_info(@pm.kb_account_id, kb_payment.id, @properties, @call_context)
+    transaction_info_plugins.size.should == 1
+    transaction_info_plugins.first.transaction_type.should eq(:AUTHORIZE)
+    transaction_info_plugins.first.status.should eq(:CANCELED)
+
+    # Force the validation on Discover
+    properties << build_property('force_validation', 'true')
+    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, 0, @currency, properties, @call_context)
+    check_response(payment_response, 1, :AUTHORIZE, :PROCESSED, 'Successful transaction', '100')
+    payment_response.first_payment_reference_id.should_not be_nil
+    payment_response.second_payment_reference_id.should_not be_nil
+    # Verify the GET path
+    transaction_info_plugins = @plugin.get_payment_info(@pm.kb_account_id, kb_payment.id, @properties, @call_context)
+    transaction_info_plugins.size.should == 3
+    transaction_info_plugins[0].transaction_type.should eq(:AUTHORIZE)
+    transaction_info_plugins[0].status.should eq(:CANCELED)
+    transaction_info_plugins[0].kb_transaction_payment_id.should_not eq(kb_payment.transactions[0].id)
+    transaction_info_plugins[1].transaction_type.should eq(:AUTHORIZE)
+    transaction_info_plugins[1].status.should eq(:PROCESSED)
+    transaction_info_plugins[1].kb_transaction_payment_id.should eq(kb_payment.transactions[0].id)
+    transaction_info_plugins[2].transaction_type.should eq(:VOID)
+    transaction_info_plugins[2].status.should eq(:PROCESSED)
+    transaction_info_plugins[2].kb_transaction_payment_id.should_not eq(kb_payment.transactions[0].id)
+  end
+
+  it 'should be able to bypass AVS and CVV rules with Apple Pay' do
+    properties = build_pm_properties(nil,
+                                     {
+                                         :payment_cryptogram => 'EHuWW9PiBkWvqE5juRwDzAUFBAk=',
+                                         :ignore_avs => true,
+                                         :ignore_cvv => true
+                                     })
+    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')
+  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)
-    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
+    check_response(payment_response, @amount, :PURCHASE, :PROCESSED, 'Successful transaction', '100')
 
     # Force a transition to :UNDEFINED
     Killbill::Cybersource::CybersourceTransaction.last.delete
@@ -149,71 +215,51 @@ describe Killbill::Cybersource::PaymentPlugin do
 
   it 'should be able to charge and refund' 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)
-    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
-    payment_response.amount.should == @amount
-    payment_response.transaction_type.should == :PURCHASE
+    check_response(payment_response, @amount, :PURCHASE, :PROCESSED, 'Successful transaction', '100')
 
     # 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)
-    refund_response.status.should eq(:PROCESSED), refund_response.gateway_error
-    refund_response.amount.should == @amount
-    refund_response.transaction_type.should == :REFUND
+    check_response(refund_response, @amount, :REFUND, :PROCESSED, 'Successful transaction', '100')
   end
 
   it 'should be able to auth, capture and refund' do
     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)
-    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
-    payment_response.amount.should == @amount
-    payment_response.transaction_type.should == :AUTHORIZE
+    check_response(payment_response, @amount, :AUTHORIZE, :PROCESSED, 'Successful transaction', '100')
 
     # Try multiple partial captures
     partial_capture_amount = BigDecimal.new('10')
     1.upto(3) do |i|
       payment_response = @plugin.capture_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[i].id, @pm.kb_payment_method_id, partial_capture_amount, @currency, @properties, @call_context)
-      payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
-      payment_response.amount.should == partial_capture_amount
-      payment_response.transaction_type.should == :CAPTURE
+      check_response(payment_response, partial_capture_amount, :CAPTURE, :PROCESSED, 'Successful transaction', '100')
     end
 
     # Try a partial refund
     refund_response = @plugin.refund_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[4].id, @pm.kb_payment_method_id, partial_capture_amount, @currency, @properties, @call_context)
-    refund_response.status.should eq(:PROCESSED), refund_response.gateway_error
-    refund_response.amount.should == partial_capture_amount
-    refund_response.transaction_type.should == :REFUND
+    check_response(refund_response, partial_capture_amount, :REFUND, :PROCESSED, 'Successful transaction', '100')
 
     # Try to capture again
     payment_response = @plugin.capture_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[5].id, @pm.kb_payment_method_id, partial_capture_amount, @currency, @properties, @call_context)
-    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
-    payment_response.amount.should == partial_capture_amount
-    payment_response.transaction_type.should == :CAPTURE
+    check_response(payment_response, partial_capture_amount, :CAPTURE, :PROCESSED, 'Successful transaction', '100')
   end
 
   it 'should be able to auth and void' do
     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)
-    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
-    payment_response.amount.should == @amount
-    payment_response.transaction_type.should == :AUTHORIZE
+    check_response(payment_response, @amount, :AUTHORIZE, :PROCESSED, 'Successful transaction', '100')
 
     payment_response = @plugin.void_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[1].id, @pm.kb_payment_method_id, @properties, @call_context)
-    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
-    payment_response.transaction_type.should == :VOID
+    check_response(payment_response, nil, :VOID, :PROCESSED, 'Successful transaction', '100')
   end
 
   it 'should be able to auth, partial capture and void' do
     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)
-    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
-    payment_response.amount.should == @amount
-    payment_response.transaction_type.should == :AUTHORIZE
+    check_response(payment_response, @amount, :AUTHORIZE, :PROCESSED, 'Successful transaction', '100')
 
     partial_capture_amount = BigDecimal.new('10')
     payment_response       = @plugin.capture_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[1].id, @pm.kb_payment_method_id, partial_capture_amount, @currency, @properties, @call_context)
-    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
-    payment_response.amount.should == partial_capture_amount
-    payment_response.transaction_type.should == :CAPTURE
+    check_response(payment_response, partial_capture_amount, :CAPTURE, :PROCESSED, 'Successful transaction', '100')
 
     payment_response = @plugin.void_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[2].id, @pm.kb_payment_method_id, @properties, @call_context)
-    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
-    payment_response.transaction_type.should == :VOID
+    check_response(payment_response, nil, :VOID, :PROCESSED, 'Successful transaction', '100')
     Killbill::Cybersource::CybersourceResponse.last.params_amount.should == '10.00'
 
     # From the CyberSource documentation:
@@ -221,25 +267,217 @@ describe Killbill::Cybersource::PaymentPlugin do
     # your processor supports authorization reversal after void as described in "Authorization Reversal After Void," page 39, CyberSource recommends that you request an authorization reversal
     # to release the hold on the unused credit card funds.
     payment_response = @plugin.void_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[3].id, @pm.kb_payment_method_id, @properties, @call_context)
-    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
-    payment_response.transaction_type.should == :VOID
+    check_response(payment_response, nil, :VOID, :PROCESSED, 'Successful transaction', '100')
     Killbill::Cybersource::CybersourceResponse.last.params_amount.should == '100.00'
   end
 
   it 'should be able to credit' do
     payment_response = @plugin.credit_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[0].id, @pm.kb_payment_method_id, @amount, @currency, @properties, @call_context)
-    payment_response.status.should eq(:PROCESSED), payment_response.gateway_error
-    payment_response.amount.should == @amount
-    payment_response.transaction_type.should == :CREDIT
+    check_response(payment_response, @amount, :CREDIT, :PROCESSED, 'Successful transaction', '100')
   end
 
   # See https://github.com/killbill/killbill-cybersource-plugin/issues/4
-  it 'handles errors gracefully' do
+  it 'handles 500 errors gracefully' do
     properties_with_no_expiration_year = build_pm_properties
     cc_exp_year = properties_with_no_expiration_year.find { |prop| prop.key == 'ccExpirationYear' }
     cc_exp_year.value = nil
 
-    payment_response = @plugin.purchase_payment(@pm.kb_account_id, @kb_payment.id, @kb_payment.transactions[0].id, SecureRandom.uuid, @amount, @currency, properties_with_no_expiration_year, @call_context)
-    payment_response.status.should eq(:ERROR), payment_response.gateway_error
+    kb_payment = setup_kb_payment
+    payment_response = @plugin.purchase_payment(@pm.kb_account_id, kb_payment.id, kb_payment.transactions[0].id, SecureRandom.uuid, @amount, @currency, properties_with_no_expiration_year, @call_context)
+    check_response(payment_response, nil, :PURCHASE, :CANCELED, '{"exception_message":"soap:Client: \\nXML parse error.\\n","payment_plugin_status":"CANCELED"}', nil)
+  end
+
+  # See http://www.cybersource.com/developers/getting_started/test_and_manage/simple_order_api/HTML/General_testing_info/soapi_general_test.html
+  it 'sets the correct transaction status' do
+    properties = build_pm_properties
+
+    kb_payment = setup_kb_payment
+    payment_response = @plugin.purchase_payment(@pm.kb_account_id, kb_payment.id, kb_payment.transactions[0].id, SecureRandom.uuid, -1, @currency, properties, @call_context)
+    check_response(payment_response, nil, :PURCHASE, :CANCELED, 'One or more fields contains invalid data', '102')
+
+    kb_payment = setup_kb_payment
+    payment_response = @plugin.purchase_payment(@pm.kb_account_id, kb_payment.id, kb_payment.transactions[0].id, SecureRandom.uuid, 100000000000, @currency, properties, @call_context)
+    check_response(payment_response, nil, :PURCHASE, :CANCELED, 'One or more fields contains invalid data', '102')
+
+    kb_payment = setup_kb_payment
+    bogus_properties = build_pm_properties(nil, {:cc_number => '4111111111111112'})
+    payment_response = @plugin.purchase_payment(@pm.kb_account_id, kb_payment.id, kb_payment.transactions[0].id, SecureRandom.uuid, @amount, @currency, bogus_properties, @call_context)
+    check_response(payment_response, nil, :PURCHASE, :ERROR, 'Invalid account number', '231')
+
+    kb_payment = setup_kb_payment
+    bogus_properties = build_pm_properties(nil, {:cc_number => '412345678912345678914'})
+    payment_response = @plugin.purchase_payment(@pm.kb_account_id, kb_payment.id, kb_payment.transactions[0].id, SecureRandom.uuid, @amount, @currency, bogus_properties, @call_context)
+    check_response(payment_response, nil, :PURCHASE, :ERROR, 'Invalid account number', '231')
+
+    kb_payment = setup_kb_payment
+    bogus_properties = build_pm_properties(nil, {:cc_exp_month => '13'})
+    payment_response = @plugin.purchase_payment(@pm.kb_account_id, kb_payment.id, kb_payment.transactions[0].id, SecureRandom.uuid, @amount, @currency, bogus_properties, @call_context)
+    check_response(payment_response, nil, :PURCHASE, :CANCELED, 'One or more fields contains invalid data', '102')
+  end
+
+  context 'Processors' do
+
+    # See http://www.cybersource.com/developers/getting_started/test_and_manage/simple_order_api/HTML/Paymentech/soapi_ptech_err.html
+    it 'handles Chase Paymentech Solutions errors' do
+      properties = build_pm_properties
+
+      %w(000 236 248 265 266 267 301 519 769 902 905 906).each do |expected_processor_response|
+        kb_payment = setup_kb_payment
+        amount = 2000 + expected_processor_response.to_i
+        payment_response = @plugin.purchase_payment(@pm.kb_account_id, kb_payment.id, kb_payment.transactions[0].id, SecureRandom.uuid, amount, @currency, properties, @call_context)
+        check_response(payment_response, nil, :PURCHASE, :CANCELED, 'General failure', '150', expected_processor_response)
+      end
+
+      %w(239 241 249 833).each do |expected_processor_response|
+        kb_payment = setup_kb_payment
+        amount = 2000 + expected_processor_response.to_i
+        payment_response = @plugin.purchase_payment(@pm.kb_account_id, kb_payment.id, kb_payment.transactions[0].id, SecureRandom.uuid, amount, @currency, properties, @call_context)
+        check_response(payment_response, nil, :PURCHASE, :CANCELED, 'A problem exists with your CyberSource merchant configuration', '234', expected_processor_response)
+      end
+
+      {'201' => '231',
+       '202' => '233',
+       '203' => '233',
+       # Disable most of the checks by default (test lasts for 7 minutes otherwise)
+=begin
+       '204' => '233',
+       '205' => '233',
+       '218' => '233',
+       '219' => '233',
+       '220' => '233',
+       '225' => '233',
+       '227' => '233',
+       '231' => '233',
+       '233' => '233',
+       '234' => '233',
+       '238' => '233',
+       '243' => '233',
+       '244' => '233',
+       '245' => '233',
+       '246' => '233',
+       '247' => '233',
+       '253' => '233',
+       '257' => '233',
+       '258' => '233',
+       '261' => '233',
+       '263' => '233',
+       '264' => '233',
+       '268' => '233',
+       '269' => '203',
+       '270' => '203',
+       '271' => '203',
+       '273' => '203',
+       '275' => '203',
+       '302' => '210',
+       '303' => '203',
+       '304' => '231',
+       '401' => '201',
+       '402' => '201',
+       '501' => '205',
+       '502' => '205',
+       '503' => '209',
+       '505' => '203',
+       '508' => '203',
+       '509' => '204',
+       '510' => '203',
+       '521' => '204',
+       '522' => '202',
+       '523' => '233',
+       '524' => '211',
+       '530' => '203',
+       '531' => '211',
+       '540' => '203',
+       '541' => '205',
+       '542' => '203',
+       '543' => '203',
+       '544' => '203',
+       '545' => '203',
+       '546' => '203',
+       '547' => '233',
+       '548' => '233',
+       '549' => '203',
+       '550' => '203',
+       '551' => '233',
+       '560' => '203',
+       '561' => '203',
+       '562' => '203',
+       '563' => '203',
+       '564' => '203',
+       '567' => '203',
+       '570' => '203',
+       '571' => '203',
+       '572' => '203',
+       '591' => '231',
+       '592' => '203',
+       '594' => '203',
+       '595' => '208',
+       '596' => '205',
+       '597' => '233',
+       '602' => '233',
+       '603' => '233',
+       '605' => '233',
+       '606' => '208',
+       '607' => '233',
+       '610' => '231',
+       '617' => '203',
+       '719' => '203',
+       '740' => '233',
+       '741' => '233',
+       '742' => '233',
+       '747' => '233',
+       '750' => '233',
+       '751' => '233',
+       '752' => '233',
+       '753' => '233',
+       '754' => '233',
+       '755' => '233',
+       '756' => '233',
+       '757' => '233',
+       '758' => '233',
+       '759' => '233',
+       '760' => '233',
+       '763' => '233',
+       '764' => '233',
+       '765' => '233',
+       '766' => '233',
+       '767' => '233',
+       '768' => '233',
+       '802' => '203',
+       '806' => '203',
+=end
+       '811' => '209',
+       '813' => '203',
+       '825' => '231',
+       '834' => '203',
+       '903' => '203',
+       '904' => '203'}.each do |expected_processor_response, expected_reason_code|
+        kb_payment = setup_kb_payment
+        amount = 2000 + expected_processor_response.to_i
+        payment_response = @plugin.purchase_payment(@pm.kb_account_id, kb_payment.id, kb_payment.transactions[0].id, SecureRandom.uuid, amount, @currency, properties, @call_context)
+        expected_error = ::ActiveMerchant::Billing::CyberSourceGateway.class_variable_get(:@@response_codes)[('r' + expected_reason_code).to_sym]
+        check_response(payment_response, nil, :PURCHASE, :ERROR, expected_error, expected_reason_code, expected_processor_response)
+      end
+    end
+  end
+
+  private
+
+  def check_response(payment_response, amount, transaction_type, expected_status, expected_error, expected_error_code, expected_processor_response = nil)
+    payment_response.amount.should == amount
+    payment_response.transaction_type.should == transaction_type
+    payment_response.status.should eq(expected_status), payment_response.gateway_error
+
+    gw_response = Killbill::Cybersource::CybersourceResponse.last
+    gw_response.gateway_error.should == expected_error
+    gw_response.gateway_error_code.should == expected_error_code
+    gw_response.params_processor_response.should == expected_processor_response unless expected_processor_response.nil?
+  end
+
+  def setup_kb_payment(nb_transactions=1, kb_payment_id=SecureRandom.uuid)
+    kb_payment = nil
+    1.upto(nb_transactions) do
+      kb_payment = @plugin.kb_apis.proxied_services[:payment_api].add_payment(kb_payment_id)
+    end
+    kb_payment
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: killbill-cybersource
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.0.3
 platform: ruby
 authors:
 - Kill Bill core team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-22 00:00:00.000000000 Z
+date: 2016-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: killbill
@@ -283,6 +283,7 @@ files:
 - config.ru
 - cybersource.yml
 - db/ddl.sql
+- db/migrate/20162519092522_enlarge_message.rb
 - db/schema.rb
 - killbill-cybersource.gemspec
 - killbill.properties
@@ -324,7 +325,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.1.9
+rubygems_version: 2.4.6
 signing_key:
 specification_version: 4
 summary: Plugin to use Cybersource as a gateway.