aktivemerchant 2.0.0

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

@@ -0,0 +1,275 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class EpayGateway < Gateway
+      API_HOST = 'ssl.ditonlinebetalingssystem.dk'
+      self.live_url = 'https://' + API_HOST + '/remote/payment'
+
+      self.default_currency = 'DKK'
+      self.money_format = :cents
+      self.supported_cardtypes = [:dankort, :forbrugsforeningen, :visa, :master,
+                                  :american_express, :diners_club, :jcb, :maestro]
+      self.supported_countries = ['DK', 'SE', 'NO']
+      self.homepage_url = 'http://epay.dk/'
+      self.display_name = 'ePay'
+
+      CURRENCY_CODES = {
+        :ADP => '020', :AED => '784', :AFA => '004', :ALL => '008', :AMD => '051',
+        :ANG => '532', :AOA => '973', :ARS => '032', :AUD => '036', :AWG => '533',
+        :AZM => '031', :BAM => '977', :BBD => '052', :BDT => '050', :BGL => '100',
+        :BGN => '975', :BHD => '048', :BIF => '108', :BMD => '060', :BND => '096',
+        :BOB => '068', :BOV => '984', :BRL => '986', :BSD => '044', :BTN => '064',
+        :BWP => '072', :BYR => '974', :BZD => '084', :CAD => '124', :CDF => '976',
+        :CHF => '756', :CLF => '990', :CLP => '152', :CNY => '156', :COP => '170',
+        :CRC => '188', :CUP => '192', :CVE => '132', :CYP => '196', :CZK => '203',
+        :DJF => '262', :DKK => '208', :DOP => '214', :DZD => '012', :ECS => '218',
+        :ECV => '983', :EEK => '233', :EGP => '818', :ERN => '232', :ETB => '230',
+        :EUR => '978', :FJD => '242', :FKP => '238', :GBP => '826', :GEL => '981',
+        :GHC => '288', :GIP => '292', :GMD => '270', :GNF => '324', :GTQ => '320',
+        :GWP => '624', :GYD => '328', :HKD => '344', :HNL => '340', :HRK => '191',
+        :HTG => '332', :HUF => '348', :IDR => '360', :ILS => '376', :INR => '356',
+        :IQD => '368', :IRR => '364', :ISK => '352', :JMD => '388', :JOD => '400',
+        :JPY => '392', :KES => '404', :KGS => '417', :KHR => '116', :KMF => '174',
+        :KPW => '408', :KRW => '410', :KWD => '414', :KYD => '136', :KZT => '398',
+        :LAK => '418', :LBP => '422', :LKR => '144', :LRD => '430', :LSL => '426',
+        :LTL => '440', :LVL => '428', :LYD => '434', :MAD => '504', :MDL => '498',
+        :MGF => '450', :MKD => '807', :MMK => '104', :MNT => '496', :MOP => '446',
+        :MRO => '478', :MTL => '470', :MUR => '480', :MVR => '462', :MWK => '454',
+        :MXN => '484', :MXV => '979', :MYR => '458', :MZM => '508', :NAD => '516',
+        :NGN => '566', :NIO => '558', :NOK => '578', :NPR => '524', :NZD => '554',
+        :OMR => '512', :PAB => '590', :PEN => '604', :PGK => '598', :PHP => '608',
+        :PKR => '586', :PLN => '985', :PYG => '600', :QAR => '634', :ROL => '642',
+        :RUB => '643', :RUR => '810', :RWF => '646', :SAR => '682', :SBD => '090',
+        :SCR => '690', :SDD => '736', :SEK => '752', :SGD => '702', :SHP => '654',
+        :SIT => '705', :SKK => '703', :SLL => '694', :SOS => '706', :SRG => '740',
+        :STD => '678', :SVC => '222', :SYP => '760', :SZL => '748', :THB => '764',
+        :TJS => '972', :TMM => '795', :TND => '788', :TOP => '776', :TPE => '626',
+        :TRL => '792', :TRY => '949', :TTD => '780', :TWD => '901', :TZS => '834',
+        :UAH => '980', :UGX => '800', :USD => '840', :UYU => '858', :UZS => '860',
+        :VEB => '862', :VND => '704', :VUV => '548', :XAF => '950', :XCD => '951',
+        :XOF => '952', :XPF => '953', :YER => '886', :YUM => '891', :ZAR => '710',
+        :ZMK => '894', :ZWD => '716'
+      }
+
+      # login: merchant number
+      # password: referrer url (for authorize authentication)
+      def initialize(options = {})
+        requires!(options, :login)
+        super
+      end
+
+      def authorize(money, credit_card_or_reference, options = {})
+        post = {}
+
+        add_amount(post, money, options)
+        add_invoice(post, options)
+        add_creditcard_or_reference(post, credit_card_or_reference)
+        add_instant_capture(post, false)
+
+        commit(:authorize, post)
+      end
+
+      def purchase(money, credit_card_or_reference, options = {})
+        post = {}
+
+        add_amount(post, money, options)
+        add_creditcard_or_reference(post, credit_card_or_reference)
+        add_invoice(post, options)
+        add_instant_capture(post, true)
+
+        commit(:authorize, post)
+      end
+
+      def capture(money, authorization, options = {})
+        post = {}
+
+        add_reference(post, authorization)
+        add_amount_without_currency(post, money)
+
+        commit(:capture, post)
+      end
+
+      def void(identification, options = {})
+        post = {}
+
+        add_reference(post, identification)
+
+        commit(:void, post)
+      end
+
+      def refund(money, identification, options = {})
+        post = {}
+
+        add_amount_without_currency(post, money)
+        add_reference(post, identification)
+
+        commit(:credit, post)
+      end
+
+      def credit(money, identification, options = {})
+        ActiveMerchant.deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, identification, options)
+      end
+
+      private
+
+      def add_amount(post, money, options)
+        post[:amount]   = amount(money)
+        post[:currency] = CURRENCY_CODES[(options[:currency] || currency(money)).to_sym]
+      end
+
+      def add_amount_without_currency(post, money)
+        post[:amount] = amount(money)
+      end
+
+      def add_reference(post, identification)
+        post[:transaction] = identification
+      end
+
+      def add_invoice(post, options)
+        post[:orderid] = format_order_number(options[:order_id])
+      end
+
+      def add_creditcard(post, credit_card)
+        post[:cardno]   = credit_card.number
+        post[:cvc]      = credit_card.verification_value
+        post[:expmonth] = credit_card.month
+        post[:expyear]  = credit_card.year
+      end
+
+      def add_creditcard_or_reference(post, credit_card_or_reference)
+        if credit_card_or_reference.respond_to?(:number)
+          add_creditcard(post, credit_card_or_reference)
+        else
+          add_reference(post, credit_card_or_reference.to_s)
+        end
+      end
+
+      def add_instant_capture(post, option)
+        post[:instantcapture] = option ? 1 : 0
+      end
+
+      def commit(action, params)
+        response = send("do_#{action}", params)
+
+        if action == :authorize
+          Response.new response['accept'].to_i == 1,
+                       response['errortext'],
+                       response,
+                       :test => test?,
+                       :authorization => response['tid']
+        else
+          Response.new response['result'] == 'true',
+                       messages(response['epay'], response['pbs']),
+                       response,
+                       :test => test?,
+                       :authorization => params[:transaction]
+        end
+      end
+
+      def messages(epay, pbs = nil)
+        response = "ePay: #{epay}"
+        response << " PBS: #{pbs}" if pbs
+        return response
+      end
+
+      def soap_post(method, params)
+        data = xml_builder(params, method)
+        headers = make_headers(data, method)
+        REXML::Document.new(ssl_post('https://' + API_HOST + '/remote/payment.asmx', data, headers))
+      end
+
+      def do_authorize(params)
+        headers = {}
+        headers['Referer'] = (options[:password] || "activemerchant.org")
+
+        response = raw_ssl_request(:post, 'https://' + API_HOST + '/auth/default.aspx', authorize_post_data(params), headers)
+
+        # Authorize gives the response back by redirecting with the values in
+        # the URL query
+        if location = response['Location']
+          query = CGI::parse(URI.parse(location.gsub(' ', '%20')).query)
+        else
+          return {
+            'accept' => '0',
+            'errortext' => 'ePay did not respond as expected. Please try again.',
+            'response_code' => response.code,
+            'response_message' => response.message
+          }
+        end
+
+        result = {}
+        query.each_pair do |k,v|
+          result[k] = v.is_a?(Array) && v.size == 1 ? v[0] : v # make values like ['v'] into 'v'
+        end
+        result
+      end
+
+      def do_capture(params)
+        response = soap_post('capture', params)
+        {
+          'result' => response.elements['//captureResponse/captureResult'].text,
+          'pbs' => response.elements['//captureResponse/pbsResponse'].text,
+          'epay' => response.elements['//captureResponse/epayresponse'].text
+        }
+      end
+
+      def do_credit(params)
+        response = soap_post('credit', params)
+        {
+          'result' => response.elements['//creditResponse/creditResult'].text,
+          'pbs' => response.elements['//creditResponse/pbsresponse'].text,
+          'epay' => response.elements['//creditResponse/epayresponse'].text
+        }
+      end
+
+      def do_void(params)
+        response = soap_post('delete', params)
+        {
+          'result' => response.elements['//deleteResponse/deleteResult'].text,
+          'epay' => response.elements['//deleteResponse/epayresponse'].text
+        }
+      end
+
+      def make_headers(data, soap_call)
+        {
+          'Content-Type' => 'text/xml; charset=utf-8',
+          'Host' => API_HOST,
+          'Content-Length' => data.size.to_s,
+          'SOAPAction' => self.live_url + '/' + soap_call
+        }
+      end
+
+      def xml_builder(params, soap_call)
+        xml = Builder::XmlMarkup.new(:indent => 2)
+        xml.instruct!
+          xml.tag! 'soap:Envelope', { 'xmlns:xsi' => 'http://schemas.xmlsoap.org/soap/envelope/',
+                                      'xmlns:xsd' => 'http://www.w3.org/2001/XMLSchema',
+                                      'xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/' } do
+            xml.tag! 'soap:Body' do
+              xml.tag! soap_call, { 'xmlns' => self.live_url } do
+                xml.tag! 'merchantnumber', @options[:login]
+                xml.tag! 'transactionid', params[:transaction]
+                xml.tag! 'amount', params[:amount].to_s if soap_call != 'delete'
+              end
+            end
+          end
+        xml.target!
+      end
+
+      def authorize_post_data(params = {})
+        params[:language] = '2'
+        params[:cms] = 'activemerchant'
+        params[:accepturl] = 'https://ssl.ditonlinebetalingssystem.dk/auth/default.aspx?accept=1'
+        params[:declineurl] = 'https://ssl.ditonlinebetalingssystem.dk/auth/default.aspx?decline=1'
+        params[:merchantnumber] = @options[:login]
+
+        params.collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+      end
+
+      # Limited to 20 digits max
+      def format_order_number(number)
+        number.to_s.gsub(/[^\w]/, '').rjust(4, "0")[0...20]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,308 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    # === EVO Canada payment gateway.
+    #
+    # EVO returns two different identifiers for most transactions, the
+    # +authcode+ and the +transactionid+.  Since +transactionid+ is used more
+    # often (i.e. for {#capture}, {#refund}, {#void} and {#update}) we store it in the
+    # Response#authorization attribute.  The +authcode+ from the merchant
+    # account is accessible via {Response#params}.
+    #
+    # Two different but related response messages are also returned from EVO.
+    # The message indicated by EVO's <tt>response_code</tt> parameter is returned as
+    # {Response#message} (Those messages can be seen in the {MESSAGES} hash.)
+    # The other, shorter message is available via {Response#params}.
+    #
+    # It's recommended to save the contents of the {Response#params} in your
+    # transaction log for future reference.
+    #
+    # === Sample Use
+    #
+    #    gateway = ActiveMerchant::Billing::EvoCaGateway.new(username: 'demo', password: 'password')
+    #
+    #    response = gateway.authorize(1000, credit_card, options)
+    #
+    #    puts response.authorization          # the transactionid
+    #    puts response.params['authcode']     # the authcode from the merchant account
+    #    puts response.message                # the 'pretty' response message
+    #    puts response.params['responsetext'] # the 'terse' response message
+    #
+    #    gateway.capture(1000, response.authorization)
+    #    gateway.update(response.authorization, shipping_carrier: 'fedex')
+    #    gateway.refund(500, response.authorization)
+    #
+    class EvoCaGateway < Gateway
+      self.test_url = 'https://secure.evoepay.com/api/transact.php'
+      self.live_url = 'https://secure.evoepay.com/api/transact.php'
+
+      self.supported_countries  = ['CA']
+      self.supported_cardtypes  = [:visa, :master, :american_express, :jcb, :discover]
+      self.money_format         = :dollars
+      self.homepage_url         = 'http://www.evocanada.com/'
+      self.display_name         = 'EVO Canada'
+
+      APPROVED, DECLINED, ERROR = 1, 2, 3
+
+      MESSAGES = {
+        100 => 'Transaction was approved',
+        200 => 'Transaction was declined by processor',
+        201 => 'Do not honor',
+        202 => 'Insufficient funds',
+        203 => 'Over limit',
+        204 => 'Transaction not allowed',
+        220 => 'Incorrect payment data',
+        221 => 'No such card issuer',
+        222 => 'No card number on file with issuer',
+        223 => 'Expired card',
+        224 => 'Invalid expiration date',
+        225 => 'Invalid card security code',
+        240 => 'Call issuer for futher information',
+        250 => 'Pick up card',
+        251 => 'Lost card',
+        252 => 'Stolen card',
+        253 => 'Fraudulant card',
+        260 => 'Declined with further instructions available',
+        261 => 'Declined - stop all recurring payments',
+        262 => 'Declined - stop this recurring program',
+        263 => 'Declined - updated cardholder data available',
+        264 => 'Declined - retry in a few days',
+        300 => 'Transaction was rejected by gateway',
+        400 => 'Transaction error returned by processor',
+        410 => 'Invalid merchant configuration',
+        411 => 'Merchant account is inactive',
+        420 => 'Communication error',
+        421 => 'Communication error with issuer',
+        430 => 'Duplicate transaction at processor',
+        440 => 'Processor format error',
+        441 => 'Invalid transaction information',
+        460 => 'Processor feature not available',
+        461 => 'Unsupported card type'
+      }
+
+      # This gateway requires that a valid username and password be passed
+      # in the +options+ hash.
+      #
+      # === Required Options
+      #
+      # * <tt>:username</tt>
+      # * <tt>:password</tt>
+      def initialize(options = {})
+        requires!(options, :username, :password)
+        super
+      end
+
+      # Transaction sales are submitted and immediately flagged for settlement.
+      # These transactions will automatically be settled.
+      #
+      # Payment source can be either a {CreditCard} or {Check}.
+      #
+      # === Additional Options
+      # In addition to the standard options, this gateway supports
+      #
+      # * <tt>:tracking_number</tt> - Shipping tracking number
+      # * <tt>:shipping_carrier</tt> - ups/fedex/dhl/usps
+      # * <tt>:po_number</tt> - Purchase order
+      # * <tt>:tax</tt> - Tax amount
+      # * <tt>:shipping</tt> - Shipping cost
+      def purchase(money, credit_card_or_check, options = {})
+        post = {}
+        add_invoice(post, options)
+        add_order(post, options)
+        add_paymentmethod(post, credit_card_or_check)
+        add_address(post, options)
+        add_customer_data(post, options)
+        commit('sale', money, post)
+      end
+
+      # Transaction authorizations are authorized immediately but are not
+      # flagged for settlement. These transactions must be flagged for
+      # settlement using the _capture_ transaction type. Authorizations
+      # typically remain activate for three to seven business days.
+      #
+      # Payment source must be a {CreditCard}.
+      def authorize(money, credit_card, options = {})
+        post = {}
+        add_invoice(post, options)
+        add_order(post, options)
+        add_paymentmethod(post, credit_card)
+        add_address(post, options)
+        add_customer_data(post, options)
+        commit('auth', money, post)
+      end
+
+      # Transaction captures flag existing _authorizations_ for settlement. Only
+      # authorizations can be captured. Captures can be submitted for an amount
+      # equal to or less than the original authorization.
+      #
+      # The <tt>authorization</tt> parameter is the transaction ID, retrieved
+      # from Response#authorization. See EvoCaGateway#purchase for the
+      # <tt>options</tt>.
+      def capture(money, authorization, options = {})
+        post = {
+          :amount         => amount(money),
+          :transactionid  => authorization
+        }
+        add_order(post, options)
+        commit('capture', money, post)
+      end
+
+      # Transaction refunds will reverse a previously settled transaction. If
+      # the transaction has not been settled, it must be _voided_ instead of
+      # refunded.
+      #
+      # The <tt>identification</tt> parameter is the transaction ID, retrieved
+      # from {Response#authorization}.
+      def refund(money, identification)
+        post = {:transactionid => identification}
+        commit('refund', money, post)
+      end
+
+      # Transaction credits apply a negative amount to the cardholder's card.
+      # In most situations credits are disabled as transaction refunds should
+      # be used instead.
+      #
+      # Note that this is different from a {#refund} (which is usually what
+      # you'll be looking for).
+      def credit(money, credit_card, options = {})
+        post = {}
+        add_invoice(post, options)
+        add_order(post, options)
+        add_paymentmethod(post, credit_card)
+        add_address(post, options)
+        add_customer_data(post, options)
+        commit('credit', money, post)
+      end
+
+      # Transaction voids will cancel an existing sale or captured
+      # authorization. In addition, non-captured authorizations can be voided to
+      # prevent any future capture. Voids can only occur if the transaction has
+      # not been settled.
+      #
+      # The <tt>identification</tt> parameter is the transaction ID, retrieved
+      # from {Response#authorization}.
+      def void(identification)
+        post = {:transactionid => identification}
+        commit('void', nil, post)
+      end
+
+      # Transaction updates can be used to update previous transactions with
+      # specific order information, such as a tracking number and shipping
+      # carrier. See EvoCaGateway#purchase for <tt>options</tt>.
+      #
+      # The <tt>identification</tt> parameter is the transaction ID, retrieved
+      # from {Response#authorization}.
+      def update(identification, options)
+        post = {:transactionid => identification}
+        add_order(post, options)
+        commit('update', nil, post)
+      end
+
+      private
+
+      def add_customer_data(post, options)
+        post[:email]      = options[:email]
+        post[:ipaddress]  = options[:ip]
+      end
+
+      def add_address(post, options)
+        if address = options[:billing_address] || options[:address]
+          post[:firstname]    = address[:first_name]
+          post[:lastname]     = address[:last_name]
+          post[:address1]     = address[:address1]
+          post[:address2]     = address[:address2]
+          post[:company]      = address[:company]
+          post[:phone]        = address[:phone]
+          post[:city]         = address[:city]
+          post[:state]        = address[:state]
+          post[:zip]          = address[:zip]
+          post[:country]      = address[:country]
+        end
+
+        if address = options[:shipping_address]
+          post[:shipping_firstname]   = address[:first_name]
+          post[:shipping_lastname]    = address[:last_name]
+          post[:shipping_address1]    = address[:address1]
+          post[:shipping_address2]    = address[:address2]
+          post[:shipping_company]     = address[:company]
+          post[:shipping_zip]         = address[:zip]
+          post[:shipping_city]        = address[:city]
+          post[:shipping_state]       = address[:state]
+          post[:shipping_country]     = address[:country]
+        end
+      end
+
+      def add_order(post, options)
+        post[:orderid]          = options[:order_id]
+        post[:tracking_number]  = options[:tracking_number]
+        post[:shipping_carrier] = options[:shipping_carrier]
+      end
+
+      def add_invoice(post, options)
+        post[:orderdescription] = options[:description]
+        post[:ponumber]         = options[:po_number]
+        post[:shipping]         = amount(options[:shipping])
+        post[:tax]              = amount(options[:tax])
+      end
+
+      def add_paymentmethod(post, payment)
+        if card_brand(payment)=='check'
+          post[:payment]              = 'check'
+          post[:checkname]            = payment.name
+          post[:checkaba]             = payment.routing_number
+          post[:checkaccount]         = payment.account_number
+          post[:account_holder_type]  = payment.account_holder_type
+          post[:account_type]         = payment.account_type
+        else
+          post[:payment]  = 'creditcard'
+          post[:ccnumber] = payment.number
+          post[:ccexp]    = "#{format(payment.month, :two_digits)}#{format(payment.year, :two_digits)}"
+          post[:cvv]      = payment.verification_value
+        end
+      end
+
+      def parse(body)
+        fields = {}
+        CGI::parse(body).each do |k, v|
+          fields[k.to_s] = v.kind_of?(Array) ? v[0] : v
+        end
+        fields
+      end
+
+      def success?(response)
+        response['response'].to_i == APPROVED
+      end
+
+      def commit(action, money, parameters)
+        parameters[:amount] = amount(money) unless action == 'void'
+
+        data = ssl_post self.live_url, post_data(action, parameters)
+        response = parse(data)
+        message = message_from(response)
+
+        Response.new(success?(response), message, response,
+          :test          => test?,
+          :authorization => response['transactionid'],
+          :avs_result    => { :code => response['avsresponse'] },
+          :cvv_result    => response['cvvresponse']
+        )
+      end
+
+      def message_from(response)
+        MESSAGES.fetch(response['response_code'].to_i, false) || response['message']
+      end
+
+      def post_data(action, parameters = {})
+        post = {:type => action}
+
+        if test?
+          post[:username] = 'demo'
+          post[:password] = 'password'
+        else
+          post[:username] = options[:username]
+          post[:password] = options[:password]
+        end
+        post.merge(parameters).collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" unless value.nil? }.compact.join("&")
+      end
+    end
+  end
+end