rocketgate-ruby 0.0.1.pre

data/lib/rocketgate/customer.rb

@@ -0,0 +1,33 @@
+module RocketGate
+  class Customer
+    include Hashable, Validatable
+
+    attr_accessor :id, :first_name, :last_name, :street_address, :city,
+                  :postal_code, :state, :country, :email, :username, :ip_address
+
+    validatable :id, :first_name, :last_name
+
+    hashable({
+      merchantCustomerID:     :id,
+      customerFirstName:      :first_name,
+      customerLastName:       :last_name,
+      billingAddress:         :street_address,
+      billingCity:            :city,
+      billingState:           :state,
+      billingZipCode:         :postal_code,
+      billingCountry:         :country,
+      email:                  :email,
+      username:               :username,
+      ipAddress:              :ip_address
+    })
+
+    def initialize(*args)
+      @first_name, @last_name, @street_address, @city, @state, @postal_code,
+        @country, @email, @username, @ip_address, @id = *args
+    end
+
+    def id
+      @id ||= SecureRandom.uuid
+    end
+  end
+end

data/lib/rocketgate/hashable.rb

@@ -0,0 +1,63 @@
+module RocketGate::Hashable
+  module ClassMethods
+    def hashable(mapping_hash, *mergable_items)
+      @mappings, @mergables = {}, []
+
+      mapping_hash.each do |display_name, obj|
+        if self.new.send(:is_callable?, obj)
+          @mappings[display_name] = obj
+        else
+          raise RocketGate::ValidationError.new("Invalid attribute: #{obj}")
+        end
+      end
+
+      mergable_items.each do |obj|
+        if self.new.send(:is_callable?, obj)
+          @mergables << obj
+        else
+          raise RocketGate::ValidationError.new("Invalid attribute: #{obj}")
+        end
+      end
+    end
+
+    def mappings
+      @mappings ||= {}
+    end
+
+    def mergables
+      @mergables ||= []
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def to_hash
+    hash = Hash.new.tap do |hsh|
+      self.class.mappings.each do |display_name, obj|
+        hsh[display_name] = attribute_or_proc_value(obj)
+      end
+    end
+
+    self.class.mergables.each do |obj|
+      hash.merge!(attribute_or_proc_value(obj))
+    end if self.class.mergables.any?
+
+    hash
+  end
+
+  private
+
+  def attribute_or_proc_value(obj)
+    if obj.is_a?(Proc)
+      obj.call
+    elsif self.respond_to?(obj)
+      self.send(obj)
+    end
+  end
+
+  def is_callable?(obj)
+    obj.is_a?(Proc) || self.respond_to?(obj)
+  end
+end

data/lib/rocketgate/request.rb

@@ -0,0 +1,48 @@
+require 'gyoku'
+
+module RocketGate
+  class Request
+    attr_accessor :transaction
+
+    def initialize(transaction = nil)
+      @transaction = transaction
+    end
+
+    def build_gateway_request
+      transaction.validate!
+
+      parameters = base_parameters
+      parameters.merge!(transaction.to_hash)
+
+      xml_head = '<?xml version="1.0" encoding="UTF-8"?>'
+      xml_body = Gyoku.xml({
+        gatewayRequest: parameters.select{|_,v| !v.nil? }
+      })
+
+      [xml_head, xml_body].join
+    end
+
+    def base_parameters
+      config = RocketGate.configuration
+      config.validate!
+
+      params = {
+        version:          config.request_version,
+        merchantID:       config.merchant_id,
+        merchantPassword: config.merchant_password
+      }
+
+      params.merge!({
+        avsCheck:         yes_or_ignore(config.require_avs),
+        cvv2Check:        yes_or_ignore(config.require_cvv),
+        scrub:            yes_or_ignore(config.require_scrub)
+      }) unless transaction && transaction.is_referenced?
+
+      params
+    end
+
+    def yes_or_ignore(boolean)
+      boolean ? 'YES' : 'IGNORE'
+    end
+  end
+end

data/lib/rocketgate/response.rb

@@ -0,0 +1,64 @@
+require 'nokogiri'
+
+module RocketGate
+  class Response
+    attr_accessor :authorization, :response_code, :xml_document
+
+    def self.from_xml(xml)
+      response = self.new.tap do |r|
+        r.xml_document = Nokogiri.parse(xml)
+        r.build!
+      end
+    end
+
+    def build!
+      @response_code = RocketGate::ResponseCode::RESPONSE[find_value('responseCode')]
+
+      @authorization = RocketGate::Authorization.new.tap do |auth|
+        auth.avs_response       = RocketGate::ResponseCode::AVS[find_value('avsResponse')]
+        auth.cvv_response       = RocketGate::ResponseCode::CVV[find_value('cvv2Code')]
+        auth.reason_code        = RocketGate::ResponseCode::REASON[find_value('reasonCode')]
+        auth.auth_code          = find_value('authNo')
+        auth.reference_id       = find_value('guidNo')
+        auth.approved_amount    = find_value('approvedAmount').to_f
+        auth.approved_currency  = find_value('approvedCurrency')
+        auth.card_hash          = find_value('cardHash')
+        auth.card_expiration    = find_value('cardExpiration')
+        auth.card_last_four     = find_value('cardLastFour')
+      end
+    end
+
+    def confirm!
+      if success?
+        confirmation = RocketGate::Transaction.new.tap do |tx|
+          tx.reference_id = self.authorization.reference_id
+          tx.type = RocketGate::Transaction::TYPE[:confirmation]
+        end
+
+        RocketGate.send_request!(RocketGate::Request.new(confirmation))
+      else
+        raise RocketGate::AuthorizationError.new('Unable to confirm unauthorized transaction')
+      end
+    end
+
+    def authorized?
+      !!(authorization && authorization.success?)
+    end
+
+    def success?
+      authorized? && response_code == :success
+    end
+
+    private
+
+    def find_value(key)
+      nodes = xml_document.at('gatewayResponse')
+      if nodes && nodes.children
+        element = nodes % key
+        element.content if element
+      else
+        raise RocketGate::GatewayResponseError.new('Unexpected response format')
+      end
+    end
+  end
+end

data/lib/rocketgate/response_code.rb

@@ -0,0 +1,148 @@
+module RocketGate::ResponseCode
+  AVS = {
+    'D'             => :match,
+    'F'             => :match,
+    'M'             => :match,
+    'X'             => :match,
+    'Y'             => :match,
+    'A'             => :address_only_match,
+    'B'             => :address_only_match,
+    'P'             => :zip_only_match,
+    'T'             => :zip_only_match,
+    'W'             => :zip_only_match,
+    'Z'             => :zip_only_match,
+    'C'             => :not_verified,
+    'G'             => :not_verified,
+    'I'             => :not_verified,
+    'R'             => :unavailable,
+    'U'             => :unavailable,
+    'S'             => :unsupported,
+    'N'             => :no_match
+  }
+  AVS_SUCCESSES = [ :match, :address_only_match, :zip_only_match, nil ]
+
+  CVV = {
+    'M'             => :match,
+    'N'             => :no_match,
+    'P'             => :not_processed,
+    'S'             => :should_have_been_present,
+    'U'             => :issuer_could_not_process
+  }
+  CVV_SUCCESSES = [ :match, :not_processed, :issuer_could_not_process, nil ]
+
+  CARD_BRAND = {
+    'AMEX'          => :amex,
+    'CARTEBLANCHE'  => :carte_blanche,
+    'DINERSCLUB'    => :diners_club,
+    'DISCOVER'      => :discover,
+    'JCB'           => :jcb,
+    'MAESTRO'       => :maestro,
+    'MC'            => :master_card,
+    'SOLO'          => :solo,
+    'VISA'          => :visa
+  }
+
+  CARD_REGION = {
+    '1'             => :usa,
+    '2'             => :canada,
+    '3'             => :europe,
+    '4'             => :asia_pacific,
+    '5'             => :latin_america,
+    '6'             => :africa_middle_east
+  }
+
+  CARD_TYPE = {
+    '0'             => :debit,
+    '1'             => :credit,
+    '2'             => :both
+  }
+
+  REASON = {
+    '0'             => :success,
+    '100'           => :no_matching_transaction,
+    '101'           => :cannot_void,
+    '102'           => :cannot_credit,
+    '103'           => :cannot_ticket,
+    '104'           => :declined_generic,
+    '105'           => :declined_over_limit,
+    '106'           => :declined_cvv_mismatch,
+    '107'           => :declined_expired,
+    '108'           => :declined_call_issuer,
+    '109'           => :declined_pickup_card,
+    '110'           => :declined_excessive_use,
+    '111'           => :declined_invalid_card,
+    '112'           => :declined_invalid_expiration,
+    '113'           => :declined_bank_unavailable,
+    '117'           => :declined_avs_mismatch,
+    '123'           => :declined_by_user_request,
+    '150'           => :declined_avs_mismatch,
+    '151'           => :declined_cvv_mismatch,
+    '152'           => :declined_invalid_amount,
+    '154'           => :declined_integration_error,
+    '156'           => :declined_unsupported_card,
+    '157'           => :declined_processor_risk,
+    '200'           => :declined_fraud_scrubbing,
+    '201'           => :declined_customer_blocked,
+    '208'           => :declined_duplicate_membership_id,
+    '209'           => :declined_duplicate_membership_card,
+    '210'           => :declined_duplicate_membership_email,
+    '211'           => :declined_over_max_purchase,
+    '212'           => :declined_duplicate_transaction,
+    '213'           => :declined_customer_velocity,
+    '214'           => :declined_card_velocity,
+    '215'           => :declined_email_velocity,
+    '216'           => :declined_iovation_generic,
+    '217'           => :declined_iovation_email_velocity,
+    '218'           => :declined_iovation_duplicate_membership,
+    '219'           => :declined_different_source_ip,
+    '220'           => :declined_too_many_cards,
+    '221'           => :declined_affiliate_blocked,
+    '222'           => :declined_trial_abuse,
+    '300'           => :error_dns_failed,
+    '301'           => :error_connection_failed,
+    '303'           => :error_read_timeout,
+    '311'           => :error_bank_communcations,
+    '312'           => :error_bank_communcations,
+    '313'           => :error_bank_communcations,
+    '314'           => :error_bank_communcations,
+    '315'           => :error_bank_communcations,
+    '316'           => :error_bank_communcations,
+    '321'           => :error_bank_communcations,
+    '323'           => :error_bank_communcations,
+    '325'           => :error_3d_secure,
+    '403'           => :error_invalid_card_number,
+    '404'           => :error_invalid_expiration,
+    '405'           => :error_invalid_amount,
+    '406'           => :error_invalid_merchant_id,
+    '407'           => :error_invalid_merchant_account,
+    '408'           => :error_incompatible_card_type,
+    '409'           => :error_no_suitable_account,
+    '410'           => :error_invalid_transaction_id,
+    '411'           => :error_invalid_access_code,
+    '412'           => :error_invalid_customer_data,
+    '413'           => :error_invalid_external_data,
+    '414'           => :error_invalid_customer_id,
+    '418'           => :error_invalid_currency,
+    '419'           => :error_incompatible_currency,
+    '420'           => :error_invalid_rebill_arguments,
+    '436'           => :error_incompatible_descriptor,
+    '438'           => :error_invalid_site_id,
+    '441'           => :error_invoice_not_found,
+    '443'           => :error_missing_customer_id,
+    '444'           => :error_missing_customer_name,
+    '445'           => :error_missing_customer_address,
+    '446'           => :error_missing_cvv,
+    '448'           => :error_no_active_membership,
+    '449'           => :error_invalid_cvv,
+    '451'           => :error_invalid_clone_data,
+    '452'           => :error_redundant_operation
+  }
+
+  RESPONSE = {
+    '0'             => :success,
+    '1'             => :bank_decline,
+    '2'             => :rocketgate_scrubbing_decline,
+    '3'             => :system_error,
+    '4'             => :missing_or_invalid_fields
+  }
+end

data/lib/rocketgate/transaction.rb

@@ -0,0 +1,75 @@
+module RocketGate
+  class Transaction
+    extend Forwardable
+    include Hashable, Validatable
+
+    attr_accessor :amount, :credit_card, :customer, :currency, :type, :reference_id, :id
+
+    validatable :amount, :credit_card, :customer, :currency, :id
+
+    def_delegator :credit_card, :to_hash, :credit_card_hash
+    def_delegator :customer,    :to_hash, :customer_hash
+
+    hashable({
+        amount:             :amount,
+        currency:           :currency,
+        merchantInvoiceID:  :id,
+        transactionType:    :type,
+        referenceGUID:      :reference_id
+      }, :credit_card_hash, :customer_hash)
+
+    TYPE = {
+      auth:          'CC_AUTH',
+      confirmation:  'CC_CONFIRM',
+      credit:        'CC_CREDIT',
+      purchase:      'CC_PURCHASE',
+      rebill_cancel: 'REBILL_CANCEL',
+      rebill_update: 'REBILL_UPDATE',
+      scrub:         'CARDSCRUB',
+      ticket:        'CC_TICKET',
+      void:          'CC_VOID'
+    }
+
+    def initialize(*args)
+      @amount, @customer, @credit_card, @currency, @id = *args
+    end
+
+    def id
+      @id ||= SecureRandom.uuid
+    end
+
+    def currency
+      @currency ||= RocketGate.configuration.currency
+    end
+
+    def to_hash
+      if is_referenced?
+        { referenceGUID: reference_id, transactionType: type }
+      else
+        super
+      end
+    end
+
+    def type=(new_type)
+      new_type = TYPE[new_type] if TYPE.keys.include?(new_type)
+
+      if TYPE.values.include?(new_type)
+        @type = new_type
+      else
+        raise ValidationError.new("Unknown transaction type: #{new_type}")
+      end
+    end
+
+    def type
+      @type ||= TYPE[:auth]
+    end
+
+    def is_referenced?
+      [ TYPE[:confirmation], TYPE[:ticket], TYPE[:void] ].include?(type) && !reference_id.nil?
+    end
+
+    def valid?
+      is_referenced? || super
+    end
+  end
+end

data/lib/rocketgate/validatable.rb

@@ -0,0 +1,52 @@
+module RocketGate::Validatable
+  module ClassMethods
+    def validatable(*args)
+      args.each do |attribute|
+        if self.new.respond_to?(attribute)
+          validatable_attributes << attribute
+        else
+          raise RocketGate::ValidationError.new("Invalid attribute: #{attribute}")
+        end
+      end
+    end
+
+    def validatable_attributes
+      @validatable_attributes ||= []
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def valid?
+    self.class.validatable_attributes.all? {|v| is_object_valid?(send(v)) }
+  end
+
+  def validate!
+    if valid?
+      self
+    else
+      message = "Invalid attributes: #{invalid_attributes.join(', ')}"
+      raise RocketGate::ValidationError.new(message) unless valid?
+    end
+  end
+
+  def invalid_attributes
+    self.class.validatable_attributes.select {|v| !is_object_valid?(send(v)) }
+  end
+
+  private
+
+  def is_class_validatable?(klazz)
+    klazz.included_modules.include?(RocketGate::Validatable)
+  end
+
+  def is_object_valid?(obj)
+    if is_class_validatable?(obj.class)
+      obj.valid?
+    else
+      !obj.nil?
+    end
+  end
+end