module Killbill #:nodoc: module Cybersource #:nodoc: class PaymentPlugin < ::Killbill::Plugin::ActiveMerchant::PaymentPlugin SIXTY_DAYS_AGO = (60 * 86400) def initialize gateway_builder = Proc.new do |config| ::ActiveMerchant::Billing::CyberSourceGateway.new :login => config[:login], :password => config[:password] end super(gateway_builder, :cybersource, ::Killbill::Cybersource::CybersourcePaymentMethod, ::Killbill::Cybersource::CybersourceTransaction, ::Killbill::Cybersource::CybersourceResponse) end def on_event(event) # Require to deal with per tenant configuration invalidation super(event) # # Custom event logic could be added below... # 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 = {} 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) end def capture_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 = {} 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) end def purchase_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 = {} 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) end def void_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, properties, context) # Pass extra parameters for the gateway here options = {} 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, properties, context) end def credit_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 = {} 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) end def refund_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context) if should_credit?(kb_payment_id, context, properties_to_hash(properties)) # Note: from the plugin perspective, this transaction is a CREDIT but Kill Bill doesn't care about PaymentTransactionInfoPlugin#TransactionType return credit_payment(kb_account_id, kb_payment_id, kb_payment_transaction_id, kb_payment_method_id, amount, currency, properties, context) end # Pass extra parameters for the gateway here options = {} 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) end def get_payment_info(kb_account_id, kb_payment_id, properties, context) # Pass extra parameters for the gateway here options = {} properties = merge_properties(properties, options) 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) # Pass extra parameters for the gateway here options = {} properties = merge_properties(properties, options) super(search_key, offset, limit, properties, context) end def add_payment_method(kb_account_id, kb_payment_method_id, payment_method_props, set_default, properties, context) # Pass extra parameters for the gateway here options = {} properties = merge_properties(properties, options) super(kb_account_id, kb_payment_method_id, payment_method_props, set_default, properties, context) end def delete_payment_method(kb_account_id, kb_payment_method_id, properties, context) # Pass extra parameters for the gateway here options = {} properties = merge_properties(properties, options) super(kb_account_id, kb_payment_method_id, properties, context) end def get_payment_method_detail(kb_account_id, kb_payment_method_id, properties, context) # Pass extra parameters for the gateway here options = {} properties = merge_properties(properties, options) super(kb_account_id, kb_payment_method_id, properties, context) end def set_default_payment_method(kb_account_id, kb_payment_method_id, properties, context) # TODO end def get_payment_methods(kb_account_id, refresh_from_gateway, properties, context) # Pass extra parameters for the gateway here options = {} properties = merge_properties(properties, options) super(kb_account_id, refresh_from_gateway, properties, context) end def search_payment_methods(search_key, offset, limit, properties, context) # Pass extra parameters for the gateway here options = {} properties = merge_properties(properties, options) super(search_key, offset, limit, properties, context) end def reset_payment_methods(kb_account_id, payment_methods, properties, context) super end def build_form_descriptor(kb_account_id, descriptor_fields, properties, context) # Pass extra parameters for the gateway here options = {} properties = merge_properties(properties, options) # Add your custom static hidden tags here options = { #:token => config[:cybersource][:token] } descriptor_fields = merge_properties(descriptor_fields, options) super(kb_account_id, descriptor_fields, properties, context) end def process_notification(notification, properties, context) # Pass extra parameters for the gateway here options = {} properties = merge_properties(properties, options) super(notification, properties, context) do |gw_notification, service| # Retrieve the payment # gw_notification.kb_payment_id = # # Set the response body # gw_notification.entity = end end def should_credit?(kb_payment_id, context, options = {}) # Transform refunds on old payments into credits automatically unless the disable_auto_credit property is passed return false if Killbill::Plugin::ActiveMerchant::Utils.normalized(options, :disable_auto_credit) transaction = @transaction_model.find_candidate_transaction_for_refund(kb_payment_id, context.tenant_id) return false if transaction.nil? threshold = (Killbill::Plugin::ActiveMerchant::Utils.normalized(options, :auto_credit_threshold) || SIXTY_DAYS_AGO).to_i # we might want a 'util' function to make the conversion joda DateTime to a ruby Time object now = Time.parse(@clock.get_clock.get_utc_now.to_s) (now - transaction.created_at) >= threshold end # Make calls idempotent def before_gateway(gateway, kb_transaction, last_transaction, payment_source, amount_in_cents, currency, options, context) super merchant_reference_code = options[:order_id] 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') if email.nil? # Note: we need to clone the context otherwise it will be transformed back to a Java one here kb_account = @kb_apis.account_user_api.get_account_by_id(kb_account_id, @kb_apis.create_context(context.tenant_id)) email = kb_account.email end 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