heartland_portico 3.2.5

data/lib/active_merchant/billing/gateways/heartland_portico.rb

@@ -0,0 +1,165 @@
+require 'heartland_portico'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class HeartlandPorticoGateway < Gateway
+      #self.test_url = 'https://example.com/test'
+      #self.live_url = 'https://example.com/live'
+
+      # The countries the gateway supports merchants from as 2 digit ISO country codes
+      self.supported_countries = ['US']
+
+      # The card types supported by the payment gateway
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+
+      # The homepage URL of the gateway
+      self.homepage_url = 'http://www.heartlandpaymentsystems.com/Payment-Processing/Payment-Processing/Portico-Virtual-Terminal'
+
+      # The name of the gateway
+      self.display_name = 'Heartland Portico'
+
+      self.money_format = :dollars
+
+      def initialize(options = {})
+        @options = options
+        requires!(@options, :user_name, :password)
+        requires!(@options, :developer_i_d, :device_id, :license_id, :site_id, :version_nbr)
+        super
+      end
+
+      def verify(creditcard, options = {})
+        post = {}
+        add_creditcard(post, creditcard)
+        add_address(post, creditcard, options)
+        add_customer_data(post, options)
+
+        commit('credit_account_verify', nil, post)
+      end
+
+      def authorize(money, creditcard, options = {})
+        post = initial_post(options)
+        add_invoice(post, options)
+        add_creditcard(post, creditcard)
+        add_address(post, creditcard, options)
+        add_customer_data(post, options)
+
+        commit('credit_auth', money, post)
+      end
+
+      def purchase(money, creditcard, options = {})
+        post = initial_post(options)
+        add_invoice(post, options)
+        add_creditcard(post, creditcard)
+        add_address(post, creditcard, options)
+        add_customer_data(post, options)
+
+        commit('credit_sale', money, post)
+      end
+
+      def capture(money, authorization, options = {})
+        post = initial_post(options)
+        add_authorization(post, authorization)
+
+        commit('credit_add_to_batch', money, post)
+      end
+
+      def return(money, creditcard, options = {})
+        post = initial_post(options)
+        add_creditcard(post, creditcard)
+
+        commit('credit_return', money, post)
+      end
+      alias refund return
+
+      def reverse(money, authorization, options = {})
+        post = initial_post(options)
+        add_authorization(post, authorization)
+
+        commit('credit_reversal', money, post)
+      end
+
+      def void(authorization, options = {})
+        post = initial_post(options)
+        add_authorization(post, authorization)
+
+        commit('credit_void', nil, post)
+      end
+
+      private
+
+      def add_customer_data(post, options)
+        # TODO?
+      end
+
+      def add_address(post, creditcard, options)
+        address = options[:billing_address] || {}
+        post[:card_holder_data] = {
+          :card_holder_first_name => creditcard.first_name,
+          :card_holder_last_name  => creditcard.last_name,
+          :card_holder_addr       => [address[:address1], address[:address2]].compact.join(" "),
+          :card_holder_city       => address[:city],
+          :card_holder_state      => address[:state],
+          :card_holder_zip        => address[:zip].to_s.gsub(/[^0-9A-Za-z]/, ''),
+          :card_holder_phone      => address[:phone].to_s.gsub(/[^0-9]/, ''),
+          #:card_holder_email     => "",
+        }
+      end
+
+      def add_authorization(post, authorization)
+        post[:gateway_txn_id] = authorization
+      end
+
+      def add_creditcard(post, creditcard)
+        post[:card_data] = {
+          :manual_entry => {
+            :card_nbr  => creditcard.number,
+            :exp_month => creditcard.month,
+            :exp_year  => creditcard.year,
+            :c_v_v_2   => creditcard.verification_value,
+            :card_present   => 'N',
+            :reader_present => 'N',
+          }
+        }
+      end
+
+      def initial_post(options)
+        # Not usually expected to be true, mostly just here for
+        # testing purposes
+        { :allow_dup => options[:allow_dup] }
+      end
+
+      def add_invoice(post, options)
+        # avoid empty hash
+        return unless options[:invoice] || options[:invoice_ship_month] || options[:invoice_ship_day]
+        post[:direct_mkt_data] = {
+          :direct_mkt_invoice_nbr => options[:invoice],
+          :direct_mkt_ship_month  => options[:invoice_ship_month],
+          :direct_mkt_ship_day    => options[:invoice_ship_day],
+        }
+      end
+
+      def client
+        @client ||= HeartlandPortico.new(@options, test?)
+      end
+
+      def commit(action, money, parameters)
+        parameters[:amt] = amount(money)
+        translate_response(client.send(action, parameters))
+      end
+
+      def translate_response(heartland_response)
+        Response.new(
+          heartland_response.success?,
+          heartland_response.message,
+          heartland_response.body,
+          { :fraud_review => false,
+            :authorization => heartland_response.authorization,
+            :test => test?,
+            :avs_result => { :code => heartland_response.avs_code },
+            :cvv_result => heartland_response.cvv_code
+          }
+        )
+      end
+    end
+  end
+end

data/lib/heartland_portico.rb

@@ -0,0 +1,182 @@
+require 'savon'
+
+# Note: Full data schema can be found at:
+#   https://cert.api2.heartlandportico.com/Hps.Exchange.PosGateway/POSGatewayService.asmx?schema=schema1
+
+# Additional Note: No idea what schema version that's for, or if it ever returns
+# anything except latest :(
+
+class HeartlandPortico
+  attr_reader :credentials
+  def initialize(credentials, test=false)
+    @credentials = credentials
+    @test = test
+  end
+
+  SUPPORTED_REQUEST_METHODS = %w(
+    check_sale
+    check_void
+    credit_account_verify
+    credit_add_to_batch
+    credit_auth
+    credit_return
+    credit_reversal
+    credit_sale
+    credit_void
+  )
+
+  SUPPORTED_REQUEST_METHODS.each do |method|
+    define_method method do |params|
+      client_call(method, params)
+    end
+  end
+
+private
+  def camelize(string)
+    # Couldn't get ActiveSupport to load standalone, rolling my own
+    string.to_s.gsub(/(?:^|_)(.)/) { $1.upcase }
+  end
+
+  def client
+    Savon.client do |savon|
+      savon.wsdl wsdl_path
+      savon.soap_version 2
+      savon.endpoint endpoint
+
+      # savon.log_level :debug
+      # savon.log true
+
+      savon.convert_request_keys_to :camelcase
+      savon.pretty_print_xml true
+    end
+  end
+
+  def client_call(operation, params)
+    message = xml_message(operation) do |xml|
+      if pin_block?(operation)
+        xml.tag!("tns:Block1") do
+          xml_build(xml, params)
+        end
+      else
+        xml_build(xml, params)
+      end
+    end
+    Response.new(operation, client.call(:do_transaction, :message_tag => 'PosRequest', :message => message))
+  end
+
+  def endpoint
+    if @test
+      "https://cert.api2-C.heartlandportico.com/Hps.Exchange.PosGateway/POSGatewayService.asmx"
+    else
+      "https://api2-C.heartlandportico.com/Hps.Exchange.PosGateway/PosGatewayService.asmx"
+    end
+  end
+
+  def pin_block?(operation)
+    %w(
+      check_sale
+      check_void
+      credit_account_verify
+      credit_auth
+      credit_sale
+      credit_return
+      credit_reversal
+    ).include? operation.to_s
+  end
+
+  # Loaded live in production, or from a local cache for testing
+  def wsdl_path
+    if @test
+      File.expand_path(File.join(__FILE__, '..', 'wsdl.xml'))
+    else
+      "#{endpoint}?wsdl=wsdl1"
+    end
+  end
+
+  def xml_build(xml, values)
+    values.keys.sort_by{|k|k.to_s}.each do |key|
+      value = values[key]
+      tag = "tns:#{camelize(key)}"
+
+      if value.to_s.empty?
+        # Skip empty values
+      elsif value.kind_of? Hash
+        xml.tag!(tag) { xml_build(xml, value) }
+      else
+        xml.tag!(tag, value)
+      end
+    end
+  end
+
+  def xml_message(operation)
+    xml = Builder::XmlMarkup.new
+    xml.tag!("tns:Ver1.0") do
+      xml.tag!("tns:Header") do
+        xml_build(xml, credentials)
+      end
+      xml.tag!("tns:Transaction") do
+        xml.tag!("tns:#{camelize(operation)}") do
+          yield xml
+        end
+      end
+    end
+  end
+
+  class Response
+    attr_reader :body, :operation
+    def initialize(operation, savon_response)
+      @operation = operation.to_sym
+      @body = savon_response.body[:pos_response][:ver1_0]
+    end
+
+    def authorization
+      body[:header][:gateway_txn_id] if success?
+    end
+
+    def message
+      return "ERROR" unless successful_request?
+      # CreditAddToBatch has an explicit empty response, with hard errors if not successful
+      return "APPROVAL" if body[:transaction].has_key?(operation) and body[:transaction][operation].nil?
+      response[:rsp_text] || response[:rsp_message]
+    end
+
+    def success?
+      ["APPROVAL", "CARD OK", "Transaction Approved"].include? message
+    end
+
+    def successful_request?
+      body[:header][:gateway_rsp_msg] == "Success"
+    end
+
+    def avs_code
+      response[:avs_rslt_code]
+    end
+    def avs_address
+      %w(A Y X B D M).include? avs_code
+    end
+    def avs_zip
+      %w(Z W Y X D M P).include? avs_code
+    end
+
+    def cvv_code
+      response[:cvv_rslt_code]
+    end
+
+    def cvv
+      # Valid Values:
+      # M: Match
+      # N: No Match
+      # P: Not Processed
+      # S: Should have been present
+      # U: Issuer not certified
+      cvv_code == "M"
+    end
+
+    def response
+      # Yes, I know that's a lot of edge case handling, but I _really_
+      # want that to be a hash.
+      body[:transaction][operation] || {} rescue {}
+    end
+    alias params response
+  end
+end

data/lib/heartland_portico/ach.rb

@@ -0,0 +1,81 @@
+class HeartlandPortico
+  class ACH
+    # Credentials include:
+    #   developer_i_d
+    #   device_id
+    #   license_id
+    #   password
+    #   site_id
+    #   user_name
+    #   version_nbr
+    def initialize(credentials, test=true)
+      @credentials = credentials
+      @test = test
+    end
+
+    # Params:
+    #   sec_code (PPD for consumer, CCD for corporate)
+    #   routing_number
+    #   account_number
+    #   account_type (CHECKING or SAVINGS)
+    #   check_type (PERSONAL, BUSINESS, or PAYROLL)
+    #   first_name
+    #   last_name
+    #   address
+    #   city
+    #   state
+    #   zip
+    #   phone
+    def sale(amount, params)
+      client.check_sale(
+        :check_action    => 'SALE', # OVERRIDE, RETURN
+        :data_entry_mode => 'MANUAL', # SWIPE
+        :amt             => "%.2f" % (amount.to_i / 100.0),
+
+        :s_e_c_code      => params[:sec_code], # PPD, CCD
+        :account_info    => {
+          :routing_number => params[:routing_number],
+          :account_number => params[:account_number],
+          #:check_number # Populate this with transaction ID?
+          #:m_i_c_r_data
+          :account_type   => params[:account_type], # CHECKING, SAVINGS
+        },
+        :check_type      => params[:check_type], # PERSONAL, BUSINESS, PAYROLL
+        #:verify_info
+          #:check_verify
+          #:a_c_h_verify
+        :consumer_info   => {
+          :first_name    => params[:first_name],
+          :last_name     => params[:last_name],
+          :check_name    => params[:memo],
+          :address1      => params[:address],
+          #:address2
+          :city          => params[:city],
+          :state         => params[:state],
+          :zip           => params[:zip],
+          :phone_number  => params[:phone],
+          #:email_address => params[:email],
+          #:d_l_state
+          #:d_l_number
+          #:courtesy_card
+          #:identity_info
+            #:s_s_n_l4
+            #:d_o_b_year
+        }
+        #:additional_txn_fields
+        #:payment_method_key
+        #:recurring_data
+        #:token_value
+      )
+    end
+
+    def void(authorization)
+      client.check_void(authorization)
+    end
+
+  private
+    def client
+      HeartlandPortico.new(@credentials, @test)
+    end
+  end
+end

data/lib/wsdl.xml

@@ -0,0 +1,43 @@
+<wsdl:definitions xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tm="http://microsoft.com/wsdl/mime/textMatching/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/" xmlns:tns="http://Hps.Exchange.PosGateway" xmlns:s="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" targetNamespace="http://Hps.Exchange.PosGateway">
+<wsdl:types>
+<s:schema targetNamespace="http://Hps.Exchange.PosGateway">
+<s:include schemaLocation="https://cert.api2.heartlandportico.com/Hps.Exchange.PosGateway/POSGatewayService.asmx?schema=schema1"/>
+</s:schema>
+</wsdl:types>
+<wsdl:message name="DoTransactionSoapIn">
+<wsdl:part name="PosRequest" element="tns:PosRequest"/>
+</wsdl:message>
+<wsdl:message name="DoTransactionSoapOut">
+<wsdl:part name="DoTransactionResult" element="tns:PosResponse"/>
+</wsdl:message>
+<wsdl:portType name="PosGatewayInterface">
+<wsdl:operation name="DoTransaction">
+<wsdl:input message="tns:DoTransactionSoapIn"/>
+<wsdl:output message="tns:DoTransactionSoapOut"/>
+</wsdl:operation>
+</wsdl:portType>
+<wsdl:binding name="PosGatewayInterface" type="tns:PosGatewayInterface">
+<soap:binding transport="http://schemas.xmlsoap.org/soap/http"/>
+<wsdl:operation name="DoTransaction">
+<soap:operation soapAction="" style="document"/>
+<wsdl:input>
+<soap:body use="literal"/>
+</wsdl:input>
+<wsdl:output>
+<soap:body use="literal"/>
+</wsdl:output>
+</wsdl:operation>
+</wsdl:binding>
+<wsdl:binding name="PosGatewayInterface1" type="tns:PosGatewayInterface">
+<soap12:binding transport="http://schemas.xmlsoap.org/soap/http"/>
+<wsdl:operation name="DoTransaction">
+<soap12:operation soapAction="" style="document"/>
+<wsdl:input>
+<soap12:body use="literal"/>
+</wsdl:input>
+<wsdl:output>
+<soap12:body use="literal"/>
+</wsdl:output>
+</wsdl:operation>
+</wsdl:binding>
+</wsdl:definitions>