killbill-cybersource 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d96b3cde985847f615dfb6827472f74fa18286f9
-  data.tar.gz: 7061ae8a789e1122e79109548133334695ff8f37
+  metadata.gz: bfa04a9b0d7a032fbd01ed8e985c0a77682c54f4
+  data.tar.gz: baabc471f68b9130025b82c0045438246178c6b9
 SHA512:
-  metadata.gz: 7fbd21f7d2483df9594fddaf45249528162dc8f8ea374f94dda8ada1343edf12b1179d995d469426b2ea06e19f6c05ec61d6049249c77da5fac1be4fb27fcb4b
-  data.tar.gz: a3db194b14bfcf50f66ba93dec2815f12048ad008013237f1f6a9a7ea578246af78cdaa9aacbe7eaa6bdacd7eb8d8e34386337bb1f2b6ed8567b4d0810457a95
+  metadata.gz: 50e85249fc100dd9006445ea729cdb7fce42e16d9b39504fcad05d3e206f5c2d7d174ec75c97eaec72218f83ce0227e70ccb33df3c7194886c9502661f6bdc01
+  data.tar.gz: 7265f9d257964c162e754f0153eeb84a40324a848f3e23c872fc9ef59e283a846717eb24f6f0bb9bad86657710814ee2bedf2c8157f494fb84bc6f750b0bf23e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    killbill-cybersource (1.0.0)
+    killbill-cybersource (2.0.0)
       actionpack (~> 4.1.0)
       actionview (~> 4.1.0)
       activemerchant (~> 1.48.0)
@@ -9,7 +9,7 @@ PATH
       activerecord-bogacs (~> 0.3)
       activerecord-jdbc-adapter (~> 1.3)
       jruby-openssl (~> 0.9.6)
-      killbill (~> 4.0.0)
+      killbill (~> 4.4.0)
       monetize (~> 1.1.0)
       money (~> 6.5.1)
       offsite_payments (~> 2.1.0)
@@ -19,13 +19,13 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (4.1.10)
-      actionview (= 4.1.10)
-      activesupport (= 4.1.10)
+    actionpack (4.1.12)
+      actionview (= 4.1.12)
+      activesupport (= 4.1.12)
       rack (~> 1.5.2)
       rack-test (~> 0.6.2)
-    actionview (4.1.10)
-      activesupport (= 4.1.10)
+    actionview (4.1.12)
+      activesupport (= 4.1.12)
       builder (~> 3.1)
       erubis (~> 2.7.0)
     active_utils (3.0.0)
@@ -36,18 +36,18 @@ GEM
       builder (>= 2.1.2, < 4.0.0)
       i18n (>= 0.6.9)
       nokogiri (~> 1.4)
-    activemodel (4.1.10)
-      activesupport (= 4.1.10)
+    activemodel (4.1.12)
+      activesupport (= 4.1.12)
       builder (~> 3.1)
-    activerecord (4.1.10)
-      activemodel (= 4.1.10)
-      activesupport (= 4.1.10)
+    activerecord (4.1.12)
+      activemodel (= 4.1.12)
+      activesupport (= 4.1.12)
       arel (~> 5.0.0)
     activerecord-bogacs (0.3.0)
       thread_safe (~> 0.3)
-    activerecord-jdbc-adapter (1.3.16)
+    activerecord-jdbc-adapter (1.3.17)
       activerecord (>= 2.2)
-    activesupport (4.1.10)
+    activesupport (4.1.12)
       i18n (~> 0.6, >= 0.6.9)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -57,24 +57,24 @@ GEM
     builder (3.2.2)
     diff-lcs (1.1.3)
     erubis (2.7.0)
-    ethon (0.7.3)
+    ethon (0.7.4)
       ffi (>= 1.3.0)
-    ffi (1.9.8-java)
+    ffi (1.9.10-java)
     i18n (0.7.0)
     jbundler (0.4.3)
       maven-tools (~> 0.32.1)
       ruby-maven (~> 3.0.4)
     jdbc-mariadb (1.1.8)
-    jdbc-sqlite3 (3.8.7)
+    jdbc-sqlite3 (3.8.10.1)
     jruby-openssl (0.9.7-java)
-    json (1.8.2-java)
-    killbill (4.0.0)
+    json (1.8.3-java)
+    killbill (4.4.0)
       rack (>= 1.5.2)
       sinatra (~> 1.3.4)
       typhoeus (~> 0.6.9)
       tzinfo (~> 1.2.0)
     maven-tools (0.32.5)
-    minitest (5.6.1)
+    minitest (5.7.0)
     monetize (1.1.0)
       money (~> 6.5.0)
     money (6.5.1)
@@ -88,7 +88,7 @@ GEM
       i18n (~> 0.5)
       money (>= 5.0.0, < 7.0.0)
       nokogiri (~> 1.4)
-    rack (1.5.3)
+    rack (1.5.5)
     rack-protection (1.5.3)
       rack
     rack-test (0.6.3)
@@ -127,3 +127,6 @@ DEPENDENCIES
   killbill-cybersource!
   rake (>= 10.0.0)
   rspec (~> 2.12.0)
+
+BUNDLED WITH
+   1.10.5

data/Jarfile

@@ -1,9 +1,10 @@
-jar 'org.kill-bill.billing:killbill-api', '0.14'
-jar 'org.kill-bill.billing.plugin:killbill-plugin-api-currency', '0.9'
-jar 'org.kill-bill.billing.plugin:killbill-plugin-api-invoice', '0.9'
-jar 'org.kill-bill.billing.plugin:killbill-plugin-api-notification', '0.9'
-jar 'org.kill-bill.billing.plugin:killbill-plugin-api-payment', '0.9'
-jar 'org.kill-bill.billing.plugin:killbill-plugin-api-routing', '0.9'
-jar 'org.kill-bill.billing:killbill-util:tests', '0.13.7'
+jar 'org.kill-bill.billing:killbill-api', '0.18'
+jar 'org.kill-bill.billing.plugin:killbill-plugin-api-currency', '0.11'
+jar 'org.kill-bill.billing.plugin:killbill-plugin-api-invoice', '0.11'
+jar 'org.kill-bill.billing.plugin:killbill-plugin-api-notification', '0.11'
+jar 'org.kill-bill.billing.plugin:killbill-plugin-api-payment', '0.11'
+jar 'org.kill-bill.billing.plugin:killbill-plugin-api-routing', '0.11'
+jar 'org.kill-bill.billing.plugin:killbill-plugin-api-catalog', '0.11'
+jar 'org.kill-bill.billing:killbill-util:tests', '0.14.0'
 jar 'org.mockito:mockito-all', '1.10.19'
 jar 'javax.servlet:javax.servlet-api', '3.1.0'

data/Jarfile.lock

@@ -1,12 +1,15 @@
-org.kill-bill.billing:killbill-api:jar:0.14
+org.bouncycastle:bcpkix-jdk15on:jar:1.50
+org.bouncycastle:bcprov-jdk15on:jar:1.50
+org.kill-bill.billing:killbill-api:jar:0.18
 com.fasterxml.jackson.core:jackson-annotations:jar:2.4.3
 joda-time:joda-time:jar:2.3
-org.kill-bill.billing.plugin:killbill-plugin-api-currency:jar:0.9
-org.kill-bill.billing.plugin:killbill-plugin-api-invoice:jar:0.9
-org.kill-bill.billing.plugin:killbill-plugin-api-notification:jar:0.9
-org.kill-bill.billing.plugin:killbill-plugin-api-payment:jar:0.9
-org.kill-bill.billing.plugin:killbill-plugin-api-routing:jar:0.9
-org.kill-bill.billing:killbill-util:jar:tests:0.13.7
+org.kill-bill.billing.plugin:killbill-plugin-api-currency:jar:0.11
+org.kill-bill.billing.plugin:killbill-plugin-api-invoice:jar:0.11
+org.kill-bill.billing.plugin:killbill-plugin-api-notification:jar:0.11
+org.kill-bill.billing.plugin:killbill-plugin-api-payment:jar:0.11
+org.kill-bill.billing.plugin:killbill-plugin-api-routing:jar:0.11
+org.kill-bill.billing.plugin:killbill-plugin-api-catalog:jar:0.11
+org.kill-bill.billing:killbill-util:jar:tests:0.14.0
 com.fasterxml.jackson.core:jackson-databind:jar:2.4.3
 com.fasterxml.jackson.core:jackson-core:jar:2.4.3
 com.fasterxml.jackson.dataformat:jackson-dataformat-csv:jar:2.4.3
@@ -32,7 +35,7 @@ aopalliance:aopalliance:jar:1.0
 com.google.inject.extensions:guice-multibindings:jar:3.0
 org.jdbi:jdbi:jar:2.62
 org.joda:joda-money:jar:0.9
-org.kill-bill.billing:killbill-internal-api:jar:0.13.7
+org.kill-bill.billing:killbill-internal-api:jar:0.14.0
 org.kill-bill.billing:killbill-platform-api:jar:0.2
 org.kill-bill.billing:killbill-platform-base:jar:0.2
 com.google.code.findbugs:annotations:jar:3.0.0
@@ -54,5 +57,3 @@ org.slf4j:slf4j-api:jar:1.7.12
 org.weakref:jmxutils:jar:1.12
 org.mockito:mockito-all:jar:1.10.19
 javax.servlet:javax.servlet-api:jar:3.1.0
-org.bouncycastle:bcpkix-jdk15on:jar:1.50
-org.bouncycastle:bcprov-jdk15on:jar:1.50

data/VERSION

@@ -1 +1 @@
-1.0.0
+2.0.0

data/killbill-cybersource.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
 
   s.rdoc_options << '--exclude' << '.'
 
-  s.add_dependency 'killbill', '~> 4.0.0'
+  s.add_dependency 'killbill', '~> 4.4.0'
 
   s.add_dependency 'sinatra', '~> 1.3.4'
   s.add_dependency 'thread_safe', '~> 0.3.4'

data/lib/cybersource/api.rb

@@ -22,14 +22,6 @@ module Killbill #:nodoc:
         #
       end
 
-      def start_plugin
-        super
-        gateway     = lookup_gateway(:on_demand)
-        @report_api = CyberSourceOnDemand.new(gateway, logger)
-      rescue => e
-        @report_api = nil
-      end
-
       def authorize_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context)
         # Pass extra parameters for the gateway here
         options = {}
@@ -95,7 +87,64 @@ module Killbill #:nodoc:
         options = {}
 
         properties = merge_properties(properties, options)
-        super(kb_account_id, kb_payment_id, properties, context)
+        transaction_info_plugins = super(kb_account_id, kb_payment_id, properties, context)
+
+        # Should never happen...
+        return [] if transaction_info_plugins.nil?
+
+        # Note: this won't handle the case where we don't have any record in the DB. While this should very rarely happen
+        # (see Killbill::Plugin::ActiveMerchant::Gateway), we could use the CyberSource Payment Batch Detail Report to fix it.
+
+        options = properties_to_hash(properties)
+
+        stale = false
+        transaction_info_plugins.each do |transaction_info_plugin|
+          # We only need to fix the UNDEFINED ones
+          next unless transaction_info_plugin.status == :UNDEFINED
+
+          cybersource_response_id = find_value_from_properties(transaction_info_plugin.properties, 'cybersourceResponseId')
+          next if cybersource_response_id.nil?
+
+          report_date = transaction_info_plugin.created_date
+          authorization = find_value_from_properties(transaction_info_plugin.properties, 'authorization')
+
+          order_id = Killbill::Plugin::ActiveMerchant::Utils.normalized(options, :order_id)
+          # authorization is very likely nil, as we didn't get an answer from the gateway in the first place
+          order_id ||= authorization.split(';')[0] unless authorization.nil?
+
+          # Retrieve the report from CyberSource
+          if order_id.nil?
+            # order_id undetermined - try the defaults (see PaymentPlugin#dispatch_to_gateways)
+            report = get_report(transaction_info_plugin.kb_transaction_payment_id, report_date, options, context)
+            if report.nil?
+              kb_transaction = get_kb_transaction(kb_payment_id, transaction_info_plugin.kb_transaction_payment_id, context.tenant_id)
+              report = get_report(kb_transaction.external_key, report_date, options, context)
+            end
+          else
+            report = get_report(order_id, report_date, options, context)
+          end
+
+          # Report API not configured or skip_gw=true
+          next if report.nil?
+
+          # Report not found
+          if report.empty?
+            logger.info("Unable to fix UNDEFINED transaction #{transaction_info_plugin.kb_transaction_payment_id} (not found in CyberSource)")
+            next
+          end
+
+          # Update our rows
+          response = CybersourceResponse.find_by(:id => cybersource_response_id)
+          next if response.nil?
+
+          logger.info("Fixing UNDEFINED transaction #{transaction_info_plugin.kb_transaction_payment_id}: success? = #{report.response.success?}")
+
+          response.update_and_create_transaction(report.response)
+          stale = true
+        end
+
+        # If we updated the state, re-fetch the latest data
+        stale ? super(kb_account_id, kb_payment_id, properties, context) : transaction_info_plugins
       end
 
       def search_payments(search_key, offset, limit, properties, context)
@@ -183,25 +232,25 @@ module Killbill #:nodoc:
       end
 
       # Make calls idempotent
-      def before_gateway(gateway, kb_transaction, last_transaction, payment_source, amount_in_cents, currency, options)
+      def before_gateway(gateway, kb_transaction, last_transaction, payment_source, amount_in_cents, currency, options, context)
         super
-        return if @report_api.nil? || options[:skip_gw]
 
         merchant_reference_code = options[:order_id]
-        report                  = @report_api.single_transaction_report(merchant_reference_code, kb_transaction.created_date.strftime('%Y%m%d'))
-
-        if !report.nil? &&
-            !report['Report'].nil? &&
-            !report['Report']['Requests'].nil? &&
-            !report['Report']['Requests']['Request'].nil? &&
-            report['Report']['Requests']['Request']['MerchantReferenceNumber'] == merchant_reference_code
-          logger.info "Skipping gateway call for existing transaction #{kb_transaction.id}, merchant reference code #{merchant_reference_code}"
-          options[:skip_gw] = true
-        end
+        report = get_report(merchant_reference_code, kb_transaction.created_date, 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}"
+        options[:skip_gw] = true
       rescue => e
         logger.warn "Error checking for duplicate payment: #{e.message}"
       end
 
+      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.single_transaction_report(merchant_reference_code, date.strftime('%Y%m%d'))
+      end
+
       def add_required_options(kb_account_id, properties, options, context)
         if options[:email].nil?
           email = find_value_from_properties(properties, 'email')
@@ -213,6 +262,13 @@ module Killbill #:nodoc:
           options[:email] = email
         end
       end
+
+      def get_report_api(kb_tenant_id)
+        gateway = lookup_gateway(:on_demand, kb_tenant_id)
+        CyberSourceOnDemand.new(gateway, logger)
+      rescue
+        nil
+      end
     end
   end
 end

data/lib/cybersource/cyber_source_on_demand.rb

@@ -1,5 +1,6 @@
 module Killbill #:nodoc:
   module Cybersource #: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'
@@ -7,17 +8,17 @@ module Killbill #:nodoc:
 
       def initialize(gateway, logger)
         @gateway = gateway
-        @logger  = logger
+        @logger = logger
       end
 
       def single_transaction_report(merchant_reference_code, target_date)
         params = {
-            :merchantID              => @gateway.config[:merchantID],
+            :merchantID => @gateway.config[:merchantID],
             :merchantReferenceNumber => merchant_reference_code,
-            :targetDate              => target_date,
-            :type                    => 'transaction',
-            :subtype                 => 'transactionDetail',
-            :versionNumber           => '1.7',
+            :targetDate => target_date,
+            :type => 'transaction',
+            :subtype => 'transactionDetail',
+            :versionNumber => '1.7',
         }
 
         headers = {
@@ -25,21 +26,118 @@ module Killbill #:nodoc:
             'Authorization' => 'Basic ' + Base64.encode64("#{@gateway.config[:username]}:#{@gateway.config[:password]}").chomp
         }
 
-        data     = URI.encode_www_form(params)
+        data = URI.encode_www_form(params)
         endpoint = @gateway.test? ? @@test_url : @@live_url
 
         # Will raise ResponseError if the response code is > 300
-        parse(@gateway.ssl_post(endpoint, data, headers))
+        CyberSourceOnDemandTransactionReport.new(@gateway.ssl_post(endpoint, data, headers), @logger)
       end
 
-      private
+      class CyberSourceOnDemandTransactionReport
 
-      def parse(body)
-        # Thanks ActiveSupport!
-        Hash.from_xml(body)
-      rescue # Parser error - request failed
-        @logger.warn "Error checking for duplicate payment, CyberSource response: #{body}"
-        nil
+        attr_reader :response
+
+        def initialize(xml_report, logger)
+          @logger = logger
+          @hash_report = parse_xml(xml_report)
+          parse
+        end
+
+        def success?
+          @response.success?
+        end
+
+        def empty?
+          @response.params['merchantReferenceCode'].nil?
+        end
+
+        private
+
+        def parse
+          report = parse_report
+          request = parse_request(report)
+          payment_data = !request.nil? ? request['PaymentData'] : nil
+          profile = !request.nil? && !request['ProfileList'].nil? ? request['ProfileList']['Profile'] : nil
+
+          test = parse_test(report)
+          success, message = parse_success_message(request)
+          merchant_reference_code = extract(request, 'MerchantReferenceNumber')
+          request_id = extract(request, 'RequestID') || extract(payment_data, 'PaymentRequestID')
+          request_token = nil
+
+          # ActiveMerchant specific
+          authorization = "#{merchant_reference_code};#{request_id};#{request_token}"
+
+          # See CybersourceResponse
+          params = {
+              'merchantReferenceCode' => merchant_reference_code,
+              'requestID' => request_id,
+              'decision' => extract(profile, 'ProfileDecision'),
+              'reasonCode' => nil,
+              'requestToken' => request_token,
+              'currency' => extract(payment_data, 'CurrencyCode'),
+              'amount' => extract(payment_data, 'Amount'),
+              'authorizationCode' => extract(payment_data, 'AuthorizationCode'),
+              'avsCode' => extract(payment_data, 'AVSResultMapped'),
+              'avsCodeRaw' => extract(payment_data, 'AVSResult'),
+              'cvCode' => nil,
+              'authorizedDateTime' => nil,
+              'processorResponse' => nil,
+              'reconciliationID' => extract(request, 'TransactionReferenceNumber'),
+              'subscriptionID' => extract(request, 'SubscriptionID')
+          }
+
+          @response = ::ActiveMerchant::Billing::Response.new(success,
+                                                              message,
+                                                              params,
+                                                              :test => test,
+                                                              :authorization => authorization,
+                                                              :avs_result => {:code => params['avsCode']},
+                                                              :cvv_result => params['cvCode'])
+        end
+
+        def parse_report
+          !@hash_report.nil? ? @hash_report['Report'] : nil
+        end
+
+        def parse_test(report)
+          !report.nil? && !report['xmlns'].nil? && report['xmlns'].starts_with?('https://ebctest.cybersource.com')
+        end
+
+        def parse_request(report)
+          # Assume the report contains a single request
+          !report.nil? && !report['Requests'].nil? ? report['Requests']['Request'] : nil
+        end
+
+        # Note: for now, we only look at the response from CyberSource.
+        # It would be nice to take into account the processor response too.
+        def parse_success_message(request)
+          success = false
+          msg = nil
+          return [success, msg] if request.nil? || request['ApplicationReplies'].nil? || request['ApplicationReplies']['ApplicationReply'].nil? || request['ApplicationReplies']['ApplicationReply'].empty?
+
+          application_replies = request['ApplicationReplies']['ApplicationReply'].is_a?(Hash) ? [request['ApplicationReplies']['ApplicationReply']] : request['ApplicationReplies']['ApplicationReply']
+
+          success = true
+          application_replies.each do |application_reply|
+            success &&= (application_reply['RCode'].to_s == '1')
+            # Last message by convention
+            msg = application_reply['RMsg']
+          end
+          [success, msg]
+        end
+
+        def extract(hash, key)
+          !hash.nil? ? hash[key] : nil
+        end
+
+        def parse_xml(body)
+          # Thanks ActiveSupport!
+          Hash.from_xml(body)
+        rescue # Parser error - request failed
+          @logger.warn "Error checking for duplicate payment, CyberSource response: #{!body.nil? && body.respond_to?(:message) ? body.message : body}"
+          nil
+        end
       end
     end
   end

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

@@ -0,0 +1,28 @@
+module ActiveMerchant
+  module Billing
+    class CyberSourceGateway
+
+      # See https://github.com/killbill/killbill-cybersource-plugin/issues/4
+      def commit(request, options)
+        request = build_request(request, options)
+        begin
+          raw_response = ssl_post(test? ? self.test_url : self.live_url, request)
+        rescue ResponseError => e
+          raw_response = e.response.body
+        end
+        response = parse(raw_response)
+
+        success = response[:decision] == 'ACCEPT'
+        message = @@response_codes[('r' + response[:reasonCode]).to_sym] rescue response[:message]
+        authorization = success ? [options[:order_id], response[:requestID], response[:requestToken]].compact.join(";") : nil
+
+        Response.new(success, message, response,
+                     :test => test?,
+                     :authorization => authorization,
+                     :avs_result => {:code => response[:avsCode]},
+                     :cvv_result => response[:cvCode]
+        )
+      end
+    end
+  end
+end

data/lib/cybersource/models/response.rb

@@ -15,26 +15,72 @@ module Killbill #:nodoc:
               payment_processor_account_id,
               kb_tenant_id,
               response,
-              {
-                  :params_merchant_reference_code => extract(response, 'merchantReferenceCode'),
-                  :params_request_id              => extract(response, 'requestID'),
-                  :params_decision                => extract(response, 'decision'),
-                  :params_reason_code             => extract(response, 'reasonCode'),
-                  :params_request_token           => extract(response, 'requestToken'),
-                  :params_currency                => extract(response, 'currency'),
-                  :params_amount                  => extract(response, 'amount'),
-                  :params_authorization_code      => extract(response, 'authorizationCode'),
-                  :params_avs_code                => extract(response, 'avsCode'),
-                  :params_avs_code_raw            => extract(response, 'avsCodeRaw'),
-                  :params_cv_code                 => extract(response, 'cvCode'),
-                  :params_authorized_date_time    => extract(response, 'authorizedDateTime'),
-                  :params_processor_response      => extract(response, 'processorResponse'),
-                  :params_reconciliation_id       => extract(response, 'reconciliationID'),
-                  :params_subscription_id         => extract(response, 'subscriptionID'),
-              }.merge!(extra_params),
+              cybersource_response_params(response).merge!(extra_params),
               model)
       end
 
+      def self.cybersource_response_params(response)
+        {
+            :params_merchant_reference_code => extract(response, 'merchantReferenceCode'),
+            :params_request_id => extract(response, 'requestID'),
+            :params_decision => extract(response, 'decision'),
+            :params_reason_code => extract(response, 'reasonCode'),
+            :params_request_token => extract(response, 'requestToken'),
+            :params_currency => extract(response, 'currency'),
+            :params_amount => extract(response, 'amount'),
+            :params_authorization_code => extract(response, 'authorizationCode'),
+            :params_avs_code => extract(response, 'avsCode'),
+            :params_avs_code_raw => extract(response, 'avsCodeRaw'),
+            :params_cv_code => extract(response, 'cvCode'),
+            :params_authorized_date_time => extract(response, 'authorizedDateTime'),
+            :params_processor_response => extract(response, 'processorResponse'),
+            :params_reconciliation_id => extract(response, 'reconciliationID'),
+            :params_subscription_id => extract(response, 'subscriptionID'),
+        }
+      end
+
+      def update_and_create_transaction(gw_response)
+        updated_attributes = {
+            :message => gw_response.message,
+            :authorization => gw_response.authorization,
+            :fraud_review => gw_response.fraud_review?,
+            :test => gw_response.test?,
+            :avs_result_code => gw_response.avs_result.kind_of?(::ActiveMerchant::Billing::AVSResult) ? gw_response.avs_result.code : gw_response.avs_result['code'],
+            :avs_result_message => gw_response.avs_result.kind_of?(::ActiveMerchant::Billing::AVSResult) ? gw_response.avs_result.message : gw_response.avs_result['message'],
+            :avs_result_street_match => gw_response.avs_result.kind_of?(::ActiveMerchant::Billing::AVSResult) ? gw_response.avs_result.street_match : gw_response.avs_result['street_match'],
+            :avs_result_postal_match => gw_response.avs_result.kind_of?(::ActiveMerchant::Billing::AVSResult) ? gw_response.avs_result.postal_match : gw_response.avs_result['postal_match'],
+            :cvv_result_code => gw_response.cvv_result.kind_of?(::ActiveMerchant::Billing::CVVResult) ? gw_response.cvv_result.code : gw_response.cvv_result['code'],
+            :cvv_result_message => gw_response.cvv_result.kind_of?(::ActiveMerchant::Billing::CVVResult) ? gw_response.cvv_result.message : gw_response.cvv_result['message'],
+            :success => gw_response.success?,
+            :updated_at => Time.now.utc
+        }.merge(CybersourceResponse.cybersource_response_params(gw_response))
+
+        # Keep original values as much as possible
+        updated_attributes.delete_if { |k, v| v.blank? }
+
+        # Update the response row
+        update!(updated_attributes)
+
+        # Create the transaction row if needed (cannot have been created before or the state wouldn't have been UNDEFINED)
+        if gw_response.success?
+          amount = gw_response.params['amount']
+          currency = gw_response.params['currency']
+          amount_in_cents = amount.nil? ? nil : ::Monetize.from_numeric(amount.to_f, currency).cents.to_i
+          build_cybersource_transaction(:kb_account_id => kb_account_id,
+                                        :kb_tenant_id => kb_tenant_id,
+                                        :amount_in_cents => amount_in_cents,
+                                        :currency => currency,
+                                        :api_call => api_call,
+                                        :kb_payment_id => kb_payment_id,
+                                        :kb_payment_transaction_id => kb_payment_transaction_id,
+                                        :transaction_type => transaction_type,
+                                        :payment_processor_account_id => payment_processor_account_id,
+                                        :txn_id => txn_id,
+                                        :created_at => updated_at,
+                                        :updated_at => updated_at).save!
+        end
+      end
+
       def first_reference_id
         params_request_id
       end
@@ -46,6 +92,14 @@ module Killbill #:nodoc:
       def gateway_error_code
         params_reason_code
       end
+
+      def to_transaction_info_plugin(transaction=nil)
+        t_info_plugin = super(transaction)
+
+        t_info_plugin.properties << create_plugin_property('cybersourceResponseId', id)
+
+        t_info_plugin
+      end
     end
   end
 end

data/lib/cybersource.rb

@@ -18,6 +18,8 @@ require 'yaml'
 require 'killbill'
 require 'killbill/helpers/active_merchant'
 
+require 'cybersource/ext/active_merchant/active_merchant.rb'
+
 require 'cybersource/cyber_source_on_demand'
 require 'cybersource/api'
 require 'cybersource/private_api'

data/pom.xml

@@ -25,7 +25,7 @@
     <groupId>org.kill-bill.billing.plugin.ruby</groupId>
     <artifactId>cybersource-plugin</artifactId>
     <packaging>pom</packaging>
-    <version>1.0.0</version>
+    <version>2.0.0</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/cyber_source_on_demand_spec.rb

@@ -0,0 +1,276 @@
+require 'spec_helper'
+
+describe Killbill::Cybersource::CyberSourceOnDemand do
+
+  it 'parses a transaction detail report with a single ApplicationReply correctly' do
+    xml_report = <<eos
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE Report SYSTEM "https://ebctest.cybersource.com/ebctest/reports/dtd/tdr_1_3.dtd">
+<Report xmlns="https://ebctest.cybersource.com/ebctest/reports/dtd/tdr_1_3.dtd"
+        Name="Transaction Detail"
+        Version="1.3"
+        MerchantID="testMerchant"
+        ReportStartDate="2008-09-10 21:46:41.765-08:00"
+        ReportEndDate="2008-09-10 21:46:41.765-08:00">
+  <Requests>
+    <Request MerchantReferenceNumber="33038191"
+             RequestDate="2008-09-10T14:00:08-08:00"
+             RequestID="2210804330010167904567"
+             SubscriptionID=""
+             Source="SCMP API"
+             User="merchant123"
+             TransactionReferenceNumber="0001094522"
+             PredecessorRequestID="7904567221330010160804">
+      <BillTo>
+        <FirstName>JANE</FirstName>
+        <LastName>Smith</LastName>
+        <Address1>1295 Charleston Rd</Address1>
+        <Address2>Suite 2</Address2>
+        <City>Mountain View</City>
+        <State>CA</State>
+        <Zip>06513</Zip>
+        <Email>null@cybersource.com</Email>
+        <Country>US</Country>
+      </BillTo>
+      <ShipTo>
+        <FirstName>JANE</FirstName>
+        <LastName>SMITH</LastName>
+        <Address1>1295 Charleston Rd</Address1>
+        <Address2>Suite 2</Address2>
+        <City>Mountain View</City>
+        <State>CA</State>
+        <Zip>94043</Zip>
+        <Country>US</Country>
+      </ShipTo>
+      <PaymentMethod>
+        <Card>
+          <AccountSuffix>1111</AccountSuffix>
+          <ExpirationMonth>11</ExpirationMonth>
+          <ExpirationYear>2011</ExpirationYear>
+          <CardType>Visa</CardType>
+        </Card>
+      </PaymentMethod>
+      <LineItems>
+        <LineItem Number="0">
+          <FulfillmentType/>
+          <Quantity>1</Quantity>
+          <UnitPrice>1.56</UnitPrice>
+          <TaxAmount>0.25</TaxAmount>
+          <MerchantProductSKU>testdl</MerchantProductSKU>
+          <ProductName>PName1</ProductName>
+          <ProductCode>electronic_software</ProductCode>
+        </LineItem>
+      </LineItems>
+      <ApplicationReplies>
+        <ApplicationReply Name="ics_bill">
+          <RCode>1</RCode>
+          <RFlag>SOK</RFlag>
+          <RMsg>Request was processed successfully.</RMsg>
+        </ApplicationReply>
+      </ApplicationReplies>
+      <PaymentData>
+        <PaymentProcessor>vital</PaymentProcessor>
+        <Amount>1.81</Amount>
+        <CurrencyCode>eur</CurrencyCode>
+        <TotalTaxAmount>0.25</TotalTaxAmount>
+        <EventType>TRANSMITTED</EventType>
+      </PaymentData>
+    </Request>
+  </Requests>
+</Report>
+eos
+    report = Killbill::Cybersource::CyberSourceOnDemand::CyberSourceOnDemandTransactionReport.new(xml_report, Logger.new(STDOUT))
+    response = report.response
+    response.success?.should be_true
+    response.message.should == 'Request was processed successfully.'
+    response.params['merchantReferenceCode'].should == '33038191'
+    response.params['requestID'].should == '2210804330010167904567'
+    response.params['decision'].should be_nil
+    response.params['reasonCode'].should be_nil
+    response.params['requestToken'].should be_nil
+    response.params['currency'].should == 'eur'
+    response.params['amount'].should == '1.81'
+    response.params['authorizationCode'].should be_nil
+    response.params['avsCode'].should be_nil
+    response.params['avsCodeRaw'].should be_nil
+    response.params['cvCode'].should be_nil
+    response.params['authorizedDateTime'].should be_nil
+    response.params['processorResponse'].should be_nil
+    response.params['reconciliationID'].should == '0001094522'
+    response.params['subscriptionID'].should == ''
+  end
+
+  it 'parses a transaction detail report with multiple ApplicationReplies correctly' do
+    xml_report = <<eos
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE Report SYSTEM "https://ebctest.cybersource.com/ebctest/reports/dtd/tdr_1_6.dtd">
+<Report xmlns="https://ebctest.cybersource.com/ebctest/reports/dtd/tdr_1_6.dtd"
+        Name="Transaction Detail"
+        Version="1.6"
+        MerchantID="ok_go"
+        ReportStartDate="2009-05-26T18:30:00-08:00"
+        ReportEndDate="2009-05-27T18:30:00-08:00">
+  <Requests>
+    <Request RequestID="2434465504100167904567"
+             RequestDate="2009-05-27T17:49:10+05:30"
+             MerchantReferenceNumber="1234"
+             Source="SCMP API"
+             User=""
+             SubscriptionID=""
+             TransactionReferenceNumber="00013791KV8BZF3P">
+      <BillTo>
+        <FirstName>sample</FirstName>
+        <LastName>merchant</LastName>
+        <Address1>11 Lico Ave</Address1>
+        <City>Big City</City>
+        <State>CA</State>
+        <Zip>99999</Zip>
+        <Email>smerchant@example.com</Email>
+        <Country>US</Country>
+        <Phone/>
+      </BillTo>
+      <ShipTo>
+        <City>xyz</City>
+        <Zip>95117</Zip>
+      </ShipTo>
+      <PaymentMethod>
+        <Card>
+          <AccountSuffix>7392</AccountSuffix>
+          <ExpirationMonth>12</ExpirationMonth>
+          <ExpirationYear>2009</ExpirationYear>
+          <CardType>Visa</CardType>
+        </Card>
+      </PaymentMethod>
+      <LineItems>
+        <LineItem Number="0">
+          <FulfillmentType>P</FulfillmentType>
+          <Quantity>1</Quantity>
+          <UnitPrice>2.00</UnitPrice>
+          <TaxAmount>0.00</TaxAmount>
+          <ProductCode>default</ProductCode>
+        </LineItem>
+      </LineItems>
+      <ApplicationReplies>
+        <ApplicationReply Name="ics_auth">
+          <RCode>1</RCode>
+          <RFlag>SOK</RFlag>
+          <RMsg>Request was processed successfully.</RMsg>
+        </ApplicationReply>
+        <ApplicationReply Name="ics_decision">
+          <RCode>0</RCode>
+          <RFlag>DREVIEW</RFlag>
+          <RMsg>Decision is REVIEW.</RMsg>
+        </ApplicationReply>
+        <ApplicationReply Name="ics_decision_early">
+          <RCode>1</RCode>
+          <RFlag/>
+        </ApplicationReply>
+        <ApplicationReply Name="ics_score">
+          <RCode>1</RCode>
+          <RFlag>DSCORE</RFlag>
+          <RMsg>Score exceeds threshold. Score = 84</RMsg>
+        </ApplicationReply>
+      </ApplicationReplies>
+      <PaymentData>
+        <PaymentRequestID>2434465504100167904567</PaymentRequestID>
+        <PaymentProcessor>smartpay</PaymentProcessor>
+        <Amount>2.00</Amount>
+        <CurrencyCode>USD</CurrencyCode>
+        <TotalTaxAmount>0.00</TotalTaxAmount>
+        <AuthorizationType>O</AuthorizationType>
+        <AuthorizationCode>888888</AuthorizationCode>
+        <AVSResult>I1</AVSResult>
+        <AVSResultMapped>X</AVSResultMapped>
+        <GrandTotal>2.00</GrandTotal>
+        <ACHVerificationResult>100</ACHVerificationResult>
+      </PaymentData>
+      <MerchantDefinedData>
+        <field1 name="mdd1">ca</field1>
+      </MerchantDefinedData>
+      <RiskData>
+        <Factors>C,Y,Z</Factors>
+        <HostSeverity>1</HostSeverity>
+        <Score>84</Score>
+        <TimeLocal>2009-05-27T10:49:10</TimeLocal>
+        <AppliedThreshold>20</AppliedThreshold>
+        <AppliedTimeHedge>normal</AppliedTimeHedge>
+        <AppliedVelocityHedge>high</AppliedVelocityHedge>
+        <AppliedHostHedge>normal</AppliedHostHedge>
+        <AppliedCategoryGift>n</AppliedCategoryGift>
+        <AppliedCategoryTime/>
+        <AppliedAVS>X</AppliedAVS>
+        <BinAccountType>CN</BinAccountType>
+        <BinScheme>Visa Credit</BinScheme>
+        <BinIssuer>Sample issuer</BinIssuer>
+        <BinCountry>us</BinCountry>
+        <InfoCodes>
+          <InfoCode>
+            <CodeType>address</CodeType>
+            <CodeValue>MM-C,MM-Z</CodeValue>
+          </InfoCode>
+          <InfoCode>
+            <CodeType>velocity</CodeType>
+            <CodeValue>VEL-CC</CodeValue>
+          </InfoCode>
+        </InfoCodes>
+      </RiskData>
+      <ProfileList>
+        <Profile Name="Default Profile">
+          <ProfileMode>Active</ProfileMode>
+          <ProfileDecision>ACCEPT</ProfileDecision>
+          <RuleList>
+            <Rule>
+              <RuleName>sample rule name</RuleName>
+              <RuleDecision>IGNORE</RuleDecision>
+            </Rule>
+          </RuleList>
+        </Profile>
+      </ProfileList>
+      <TravelData>
+        <TripInfo>
+          <CompleteRoute>AB-CD:EF-GH</CompleteRoute>
+          <JourneyType>round trip</JourneyType>
+          <DepartureDateTime>sample date &amp; time</DepartureDateTime>
+        </TripInfo>
+        <PassengerInfo>
+          <Passenger Number="0">
+            <PassengerFirstName>jane</PassengerFirstName>
+            <PassengerLastName>doe</PassengerLastName>
+            <PassengerID>Sing-001</PassengerID>
+          </Passenger>
+          <Passenger Number="1">
+            <PassengerFirstName>john</PassengerFirstName>
+            <PassengerLastName>doe</PassengerLastName>
+            <PassengerID>sing-002</PassengerID>
+            <PassengerStatus>Adult</PassengerStatus>
+            <PassengerType>Gold</PassengerType>
+            <PassengerPhone>9995551212</PassengerPhone>
+            <PassengerEmail>jdoe@example.com</PassengerEmail>
+          </Passenger>
+        </PassengerInfo>
+      </TravelData>
+    </Request>
+  </Requests>
+</Report>
+eos
+    report = Killbill::Cybersource::CyberSourceOnDemand::CyberSourceOnDemandTransactionReport.new(xml_report, Logger.new(STDOUT))
+    response = report.response
+    response.success?.should be_false
+    response.message.should == 'Score exceeds threshold. Score = 84'
+    response.params['merchantReferenceCode'].should == '1234'
+    response.params['requestID'].should == '2434465504100167904567'
+    response.params['decision'].should == 'ACCEPT'
+    response.params['reasonCode'].should be_nil
+    response.params['requestToken'].should be_nil
+    response.params['currency'].should == 'USD'
+    response.params['amount'].should == '2.00'
+    response.params['authorizationCode'].should == '888888'
+    response.params['avsCode'].should == 'X'
+    response.params['avsCodeRaw'].should == 'I1'
+    response.params['cvCode'].should be_nil
+    response.params['authorizedDateTime'].should be_nil
+    response.params['processorResponse'].should be_nil
+    response.params['reconciliationID'].should == '00013791KV8BZF3P'
+    response.params['subscriptionID'].should == ''
+  end
+end

data/spec/cybersource/remote/integration_spec.rb

@@ -81,6 +81,62 @@ describe Killbill::Cybersource::PaymentPlugin do
     transactions[1].txn_id.should be_nil
   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
+
+    # Force a transition to :UNDEFINED
+    Killbill::Cybersource::CybersourceTransaction.last.delete
+    response = Killbill::Cybersource::CybersourceResponse.last
+    response.update(:message => {:payment_plugin_status => 'UNDEFINED'}.to_json)
+
+    skip_gw = Killbill::Plugin::Model::PluginProperty.new
+    skip_gw.key = 'skip_gw'
+    skip_gw.value = 'true'
+    properties_with_skip_gw = @properties.clone
+    properties_with_skip_gw << skip_gw
+
+    # Set skip_gw=true, to avoid calling the report API
+    transaction_info_plugins = @plugin.get_payment_info(@pm.kb_account_id, @kb_payment.id, properties_with_skip_gw, @call_context)
+    transaction_info_plugins.size.should == 1
+    transaction_info_plugins.first.status.should eq(:UNDEFINED)
+
+    # Fix it
+    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.status.should eq(:PROCESSED)
+
+    # Set skip_gw=true, to check the local state
+    transaction_info_plugins = @plugin.get_payment_info(@pm.kb_account_id, @kb_payment.id, properties_with_skip_gw, @call_context)
+    transaction_info_plugins.size.should == 1
+    transaction_info_plugins.first.status.should eq(:PROCESSED)
+
+    # Compare the state of the old and new response
+    new_response = Killbill::Cybersource::CybersourceResponse.last
+    new_response.id.should == response.id
+    new_response.api_call.should == 'purchase'
+    new_response.kb_tenant_id.should == @call_context.tenant_id
+    new_response.kb_account_id.should == @pm.kb_account_id
+    new_response.kb_payment_id.should == @kb_payment.id
+    new_response.kb_payment_transaction_id.should == @kb_payment.transactions[0].id
+    new_response.transaction_type.should == 'PURCHASE'
+    new_response.payment_processor_account_id.should == 'default'
+    # The report API doesn't give us the token
+    new_response.authorization.split(';')[0..1].should == response.authorization.split(';')[0..1]
+    new_response.test.should be_true
+    new_response.params_merchant_reference_code.should == response.params_merchant_reference_code
+    new_response.params_decision.should == response.params_decision
+    new_response.params_request_token.should == response.params_request_token
+    new_response.params_currency.should == response.params_currency
+    new_response.params_amount.should == response.params_amount
+    new_response.params_authorization_code.should == response.params_authorization_code
+    new_response.params_avs_code.should == response.params_avs_code
+    new_response.params_avs_code_raw.should == response.params_avs_code_raw
+    new_response.params_reconciliation_id.should == response.params_reconciliation_id
+    new_response.success.should be_true
+    new_response.message.should == 'Request was processed successfully.'
+  end
+
   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
@@ -156,4 +212,14 @@ describe Killbill::Cybersource::PaymentPlugin do
     payment_response.amount.should == @amount
     payment_response.transaction_type.should == :CREDIT
   end
+
+  # See https://github.com/killbill/killbill-cybersource-plugin/issues/4
+  it 'handles 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
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: killbill-cybersource
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Kill Bill core team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-05-08 00:00:00.000000000 Z
+date: 2015-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: killbill
@@ -16,12 +16,12 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.4.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.4.0
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
@@ -290,6 +290,7 @@ files:
 - lib/cybersource/api.rb
 - lib/cybersource/application.rb
 - lib/cybersource/cyber_source_on_demand.rb
+- lib/cybersource/ext/active_merchant/active_merchant.rb
 - lib/cybersource/models/payment_method.rb
 - lib/cybersource/models/response.rb
 - lib/cybersource/models/transaction.rb
@@ -298,6 +299,7 @@ files:
 - pom.xml
 - release.sh
 - spec/cybersource/base_plugin_spec.rb
+- spec/cybersource/cyber_source_on_demand_spec.rb
 - spec/cybersource/remote/integration_spec.rb
 - spec/spec_helper.rb
 homepage: http://killbill.io
@@ -322,8 +324,12 @@ 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.
-test_files: []
+test_files:
+- spec/cybersource/base_plugin_spec.rb
+- spec/cybersource/cyber_source_on_demand_spec.rb
+- spec/cybersource/remote/integration_spec.rb
+- spec/spec_helper.rb