apispree_core 0.0.0

data/lib/spree/config.rb

@@ -0,0 +1,33 @@
+module Spree
+  # Singleton class to access the configuration object (AppConfiguration.first by default) and its preferences.
+  #
+  # Usage:
+  #   Spree::Config[:foo]                  # Returns the +foo+ preference
+  #   Spree::Config[]                      # Returns a Hash with all the application preferences
+  #   Spree::Config.instance               # Returns the configuration object (AppConfiguration.first)
+  #   Spree::Config.set(preferences_hash)  # Set the application preferences as especified in +preference_hash+
+  #   Spree::Config.searcher/searcher=     # get/set the default product search implementation
+  class Config
+    include Singleton
+    include Spree::PreferenceAccess
+
+    class << self
+      def instance
+        return @configuration if @configuration
+        return nil unless ActiveRecord::Base.connection.tables.include?('configurations')
+        @configuration ||= AppConfiguration.find_or_create_by_name("Default configuration")
+        @configuration
+      end
+
+      # searcher_class allows spree extension writers to provide their own Search class
+      def searcher_class
+        @searcher_class ||= Spree::Search::Base
+      end
+
+      def searcher_class=(sclass)
+        @searcher_class = sclass
+      end
+
+    end
+  end
+end

data/lib/spree/current_order.rb

@@ -0,0 +1,30 @@
+module Spree
+  module CurrentOrder
+
+    # This should be overridden by an auth-related extension which would then have the
+    # opportunity to associate the new order with the # current user before saving.
+    def before_save_new_order
+    end
+
+    # This should be overridden by an auth-related extension which would then have the
+    # opporutnity to store tokens, etc. in the session # after saving.
+    def after_save_new_order
+    end
+
+    # The current incomplete order from the session for use in cart and during checkout
+    def current_order(create_order_if_necessary = false)
+      return @current_order if @current_order
+      if session[:order_id]
+        @current_order = Order.find_by_id(session[:order_id], :include => :adjustments)
+      end
+      if create_order_if_necessary and (@current_order.nil? or @current_order.completed?)
+        @current_order = Order.new
+        before_save_new_order
+        @current_order.save!
+        after_save_new_order
+      end
+      session[:order_id] = @current_order ? @current_order.id : nil
+      @current_order
+    end
+  end
+end

data/lib/spree/file_utilz.rb

@@ -0,0 +1,73 @@
+require 'fileutils'
+
+module Spree
+  class FileUtilz
+    # A general purpose method to mirror a directory (+source+) into a destination
+    # directory, including all files and subdirectories. Files will not be mirrored
+    # if they are identical already (checked via FileUtils#identical?).
+    #
+    # Copyright (c) 2008 James Adam (The MIT License)
+
+    # added: do mirroring with backup saving turned on
+    def self.mirror_with_backup(source, destination)
+      self.mirror_files(source, destination, true)
+    end
+
+    def self.mirror_files(source, destination, create_backups = false)
+      # TODO: use Rake::FileList#pathmap?
+      if File.directory?(source)
+        source_files  = Dir[source + "/**/*"]
+        source_dirs   = source_files.select { |d| File.directory?(d) }
+        source_files -= source_dirs
+      elsif File.exist? source
+        source_dirs   = []
+        source_files  = [source]
+        source        = File.dirname source
+      else
+        puts "Could not mirror #{source} - entity does not exist"
+        return
+      end
+
+      unless source_files.empty?
+        base_target_dir = File.join(destination)
+        base_target_dir = File.dirname base_target_dir unless File.directory? base_target_dir
+        FileUtils.mkdir_p(base_target_dir)
+      end
+
+      base_target_dir ||= File.join(destination)
+
+      source_dirs.each do |dir|
+        # strip down these paths so we have simple, relative paths we can
+        # add to the destination
+        target_dir = File.join(base_target_dir, dir.gsub(source, ''))
+        begin
+          FileUtils.mkdir_p(target_dir)
+        rescue Exception => e
+          raise "Could not create directory #{target_dir}: \n" + e
+        end
+      end
+
+      source_files.each do |file|
+        begin
+          target = File.join(base_target_dir, file.gsub(source, ''))
+          unless File.exist?(target) && self.same_contents(file, target)
+            # WAS FileUtils.identical?(file, target), but we want to test contents too
+            if create_backups && File.exist?(target)
+              File.rename(target, target + '~')
+            end
+            FileUtils.cp(file, target)
+          end
+        rescue Exception => e
+          raise "Could not copy #{file} to #{target}: \n" + e
+        end
+      end
+    end
+
+    # for windows users...
+    def self.same_contents(source,destination)
+      File.read(source) == File.read(destination)
+    end
+
+  end
+end
+

data/lib/spree/gateway_error.rb

@@ -0,0 +1,3 @@
+module Spree
+  class GatewayError < RuntimeError; end
+end

data/lib/spree/mail_interceptor.rb

@@ -0,0 +1,23 @@
+# Allows us to intercept any outbound mail message and make last minute changes (such as specifying a "from" address or
+# sending to a test email account.)
+#
+# See http://railscasts.com/episodes/206-action-mailer-in-rails-3 for more details.
+module Spree
+  class MailInterceptor
+
+    def self.delivering_email(message)
+      return unless mail_method = MailMethod.current
+      message.from ||= mail_method.preferred_mails_from
+
+      if mail_method.preferred_intercept_email.present?
+        message.subject = "[#{message.to}] #{message.subject}"
+        message.to = mail_method.preferred_intercept_email
+      end
+
+      if mail_method.preferred_mail_bcc.present?
+        message.bcc = mail_method.preferred_mail_bcc
+      end
+    end
+
+  end
+end

data/lib/spree/mail_settings.rb

@@ -0,0 +1,33 @@
+module Spree
+  module MailSettings
+
+    # Override the Rails application mail settings based on preference.
+    # This makes it possible to configure the mail settings
+    # through an admin interface instead of requiring changes to the Rails envrionment file.
+    def self.init
+      return unless mail_method = MailMethod.current
+      if mail_method.prefers_enable_mail_delivery?
+        mail_server_settings = {
+          :address => mail_method.preferred_mail_host,
+          :domain => mail_method.preferred_mail_domain,
+          :port => mail_method.preferred_mail_port,
+          :authentication => mail_method.preferred_mail_auth_type
+        }
+
+        if mail_method.preferred_mail_auth_type != 'none'
+          mail_server_settings[:user_name] = mail_method.preferred_smtp_username
+          mail_server_settings[:password] = mail_method.preferred_smtp_password
+        end
+
+        mail_server_settings[:enable_starttls_auto] = (mail_method.preferred_secure_connection_type == 'TLS')
+
+        ActionMailer::Base.smtp_settings = mail_server_settings
+        ActionMailer::Base.perform_deliveries = true
+      else
+        #logger.warn "NOTICE: Mail not enabled"
+        ActionMailer::Base.perform_deliveries = false
+      end
+    end
+
+  end
+end

data/lib/spree/preference_access.rb

@@ -0,0 +1,27 @@
+module Spree::PreferenceAccess
+
+  def self.included(base)
+    class << base
+      def get(key = nil)
+        key = key.to_s if key.is_a?(Symbol)
+        return nil unless config = self.instance
+        # preferences will be cached under the name of the class including this module (ex. Spree::Config)
+        prefs = Rails.cache.fetch("configuration_#{config.class.name}".to_sym) { config.preferences }
+        return prefs if key.nil?
+        prefs[key]
+      end
+
+      # Set the preferences as specified in a hash (like params[:preferences] from a post request)
+      def set(preferences={})
+        config = self.instance
+        preferences.each do |key, value|
+          config.set_preference(key, value)
+        end
+        config.save
+        Rails.cache.delete("configuration_#{config.class.name}".to_sym)
+      end
+
+      alias_method :[], :get
+    end
+  end
+end

data/lib/spree/search/base.rb

@@ -0,0 +1,64 @@
+module Spree::Search
+  class Base
+    attr_accessor :properties
+
+    def initialize(params)
+      @properties = {}
+      prepare(params)
+    end
+
+    def retrieve_products
+      base_scope = get_base_scope
+      @products_scope = @product_group.apply_on(base_scope)
+      curr_page = manage_pagination && keywords ? 1 : page
+
+      @products = @products_scope.paginate({
+          :include  => [:images, :master],
+          :per_page => per_page,
+          :page     => curr_page
+        })
+    end
+
+    def method_missing(name)
+      @properties[name]
+    end
+
+    protected
+    def get_base_scope
+      base_scope = @cached_product_group ? @cached_product_group.products.active : Product.active
+      base_scope = base_scope.in_taxon(taxon) unless taxon.blank?
+      base_scope = get_products_conditions_for(base_scope, keywords) unless keywords.blank?
+
+      base_scope = base_scope.on_hand unless Spree::Config[:show_zero_stock_products]
+      base_scope = base_scope.group_by_products_id if @product_group.product_scopes.size > 1
+      base_scope
+    end
+
+    # method should return new scope based on base_scope
+    def get_products_conditions_for(base_scope, query)
+      base_scope.like_any([:name, :description], query.split)
+    end
+
+    def prepare(params)
+      @properties[:taxon] = params[:taxon].blank? ? nil : Taxon.find(params[:taxon])
+      @properties[:keywords] = params[:keywords]
+
+      per_page = params[:per_page].to_i
+      @properties[:per_page] = per_page > 0 ? per_page : Spree::Config[:products_per_page]
+      @properties[:page] = (params[:page].to_i <= 0) ? 1 : params[:page].to_i
+
+      if !params[:order_by_price].blank?
+        @product_group = ProductGroup.new.from_route([params[:order_by_price]+"_by_master_price"])
+      elsif params[:product_group_name]
+        @cached_product_group = ProductGroup.find_by_permalink(params[:product_group_name])
+        @product_group = ProductGroup.new
+      elsif params[:product_group_query]
+        @product_group = ProductGroup.new.from_route(params[:product_group_query].split("/"))
+      else
+        @product_group = ProductGroup.new
+      end
+      @product_group = @product_group.from_search(params[:search]) if params[:search]
+
+    end
+  end
+end

data/lib/spree_base.rb

@@ -0,0 +1,116 @@
+module SpreeBase
+  module InstanceMethods
+    def access_forbidden
+      render :text => 'Access Forbidden', :layout => true, :status => 401
+    end
+
+    # can be used in views as well as controllers.
+    # e.g. <% title = 'This is a custom title for this view' %>
+    attr_writer :title
+
+    def title
+      title_string = @title.blank? ? accurate_title : @title
+      if title_string.blank?
+        default_title
+      else
+        if Spree::Config[:always_put_site_name_in_title]
+          [default_title, title_string].join(' - ')
+        else
+          title_string
+        end
+      end
+    end
+
+    protected
+
+    def default_title
+      Spree::Config[:site_name]
+    end
+
+    # this is a hook for subclasses to provide title
+    def accurate_title
+      Spree::Config[:default_seo_title]
+    end
+
+    # def reject_unknown_object
+    #   # workaround to catch problems with loading errors for permalink ids (reconsider RC permalink hack elsewhere?)
+    #   begin
+    #     load_object
+    #   rescue Exception => e
+    #     @object = nil
+    #   end
+    #   the_object = instance_variable_get "@#{object_name}"
+    #   the_object = nil if (the_object.respond_to?(:deleted?) && the_object.deleted?)
+    #   unless params[:id].blank? || the_object
+    #     if self.respond_to? :object_missing
+    #       self.object_missing(params[:id])
+    #     else
+    #       render_404(Exception.new("missing object in #{self.class.to_s}"))
+    #     end
+    #   end
+    #   true
+    # end
+
+    def render_404(exception = nil)
+      respond_to do |type|
+        type.html { render :status => :not_found, :file    => "#{Rails.root}/public/404.html", :layout => nil}
+        type.all  { render :status => :not_found, :nothing => true }
+      end
+    end
+
+    private
+
+    def redirect_back_or_default(default)
+      redirect_to(session["user_return_to"] || default)
+      session["user_return_to"] = nil
+    end
+
+    def instantiate_controller_and_action_names
+      @current_action = action_name
+      @current_controller = controller_name
+    end
+
+    def get_taxonomies
+      @taxonomies ||= Taxonomy.includes(:root => :children)
+      @taxonomies.reject { |t| t.root.nil? }
+    end
+
+    def current_gateway
+      @current_gateway ||= Gateway.current
+    end
+
+    #RAILS 3 TODO
+    # # Load all models using STI to fix associations such as @order.credits giving no results and resulting in incorrect order totals
+    # def touch_sti_subclasses
+    #   if Rails.env == 'development'
+    #     load(File.join(SPREE_ROOT,'config/initializers/touch.rb'))
+    #   end
+    # end
+
+    def set_user_language
+      locale = session[:locale] || Spree::Config[:default_locale]
+      locale = I18n.default_locale unless locale && I18n.available_locales.include?(locale.to_sym)
+      I18n.locale = locale.to_sym
+    end
+  end
+
+  def self.included(receiver)
+    #receiver.extend         ClassMethods
+    receiver.send :include, InstanceMethods
+    receiver.send :layout, 'spree_application'
+    receiver.send :helper, 'hook'
+    receiver.send :before_filter, 'instantiate_controller_and_action_names'
+    #  #RAILS 3 TODO
+    #  #before_filter :touch_sti_subclasses
+    receiver.send :before_filter, 'set_user_language'
+
+    receiver.send :helper_method, 'title'
+    receiver.send :helper_method, 'title='
+    receiver.send :helper_method, 'accurate_title'
+    receiver.send :helper_method, 'get_taxonomies'
+    receiver.send :helper_method, 'current_gateway'
+    receiver.send :helper_method, 'current_order'
+    receiver.send :include, SslRequirement
+    receiver.send :include, Spree::CurrentOrder
+  end
+end

data/lib/spree_core/action_callbacks.rb

@@ -0,0 +1,26 @@
+module Spree
+  class ActionCallbacks
+    attr_reader :before_methods
+    attr_reader :after_methods
+    attr_reader :fails_methods
+    
+    def initialize
+      @before_methods = []
+      @after_methods = []
+      @fails_methods = []
+    end
+    
+    def before(method)
+      @before_methods << method
+    end
+    
+    def after(method)
+      @after_methods << method
+    end
+    
+    def fails(method)
+      @fails_methods << method
+    end
+  end
+
+end

data/lib/spree_core/authorize_net_cim_hack.rb

@@ -0,0 +1,871 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    # ==== Customer Information Manager (CIM)
+    #
+    # The Authorize.Net Customer Information Manager (CIM) is an optional additional service that allows you to store sensitive payment information on
+    # Authorize.Net's servers, simplifying payments for returning customers and recurring transactions. It can also help with Payment Card Industry (PCI)
+    # Data Security Standard compliance, since customer data is no longer stored locally.
+    #
+    # To use the AuthorizeNetCimGateway CIM must be enabled for your account.
+    #
+    # Information about CIM is available on the {Authorize.Net website}[http://www.authorize.net/solutions/merchantsolutions/merchantservices/cim/].
+    # Information about the CIM API is available at the {Authorize.Net Integration Center}[http://developer.authorize.net/]
+    #
+    # ==== Login and Password
+    #
+    # The login and password are not the username and password you use to
+    # login to the Authorize.Net Merchant Interface. Instead, you will
+    # use the API Login ID as the login and Transaction Key as the
+    # password.
+    #
+    # ==== How to Get Your API Login ID and Transaction Key
+    #
+    # 1. Log into the Merchant Interface
+    # 2. Select Settings from the Main Menu
+    # 3. Click on API Login ID and Transaction Key in the Security section
+    # 4. Type in the answer to the secret question configured on setup
+    # 5. Click Submit
+    class AuthorizeNetCimGateway < Gateway
+
+      class_attribute :test_url, :live_url
+
+      self.test_url = 'https://apitest.authorize.net/xml/v1/request.api'
+      self.live_url = 'https://api.authorize.net/xml/v1/request.api'
+
+      AUTHORIZE_NET_CIM_NAMESPACE = 'AnetApi/xml/v1/schema/AnetApiSchema.xsd'
+
+      CIM_ACTIONS = {
+        :create_customer_profile => 'createCustomerProfile',
+        :create_customer_payment_profile => 'createCustomerPaymentProfile',
+        :create_customer_shipping_address => 'createCustomerShippingAddress',
+        :get_customer_profile => 'getCustomerProfile',
+        :get_customer_payment_profile => 'getCustomerPaymentProfile',
+        :get_customer_shipping_address => 'getCustomerShippingAddress',
+        :delete_customer_profile => 'deleteCustomerProfile',
+        :delete_customer_payment_profile => 'deleteCustomerPaymentProfile',
+        :delete_customer_shipping_address => 'deleteCustomerShippingAddress',
+        :update_customer_profile => 'updateCustomerProfile',
+        :update_customer_payment_profile => 'updateCustomerPaymentProfile',
+        :update_customer_shipping_address => 'updateCustomerShippingAddress',
+        :create_customer_profile_transaction => 'createCustomerProfileTransaction',
+        :validate_customer_payment_profile => 'validateCustomerPaymentProfile'
+      }
+
+      CIM_TRANSACTION_TYPES = {
+        :auth_capture => 'profileTransAuthCapture',
+        :auth_only => 'profileTransAuthOnly',
+        :capture_only => 'profileTransCaptureOnly',
+        :prior_auth_capture => 'profileTransPriorAuthCapture',
+        :refund => 'profileTransRefund',
+        :void => 'profileTransVoid'
+      }
+
+      CIM_VALIDATION_MODES = {
+        :none => 'none',
+        :test => 'testMode',
+        :live => 'liveMode'
+      }
+
+      BANK_ACCOUNT_TYPES = {
+        :checking => 'checking',
+        :savings => 'savings',
+        :business_checking => 'businessChecking'
+      }
+
+      ECHECK_TYPES = {
+        :ccd => 'CCD',
+        :ppd => 'PPD'
+      }
+
+      self.homepage_url = 'http://www.authorize.net/'
+      self.display_name = 'Authorize.Net CIM'
+      self.supported_countries = ['US']
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+
+      # Creates a new AuthorizeNetCimGateway
+      #
+      # The gateway requires that a valid API Login ID and Transaction Key be passed
+      # in the +options+ hash.
+      #
+      # ==== Options
+      #
+      # * <tt>:login</tt> -- The Authorize.Net API Login ID (REQUIRED)
+      # * <tt>:password</tt> -- The Authorize.Net Transaction Key. (REQUIRED)
+      # * <tt>:test</tt> -- +true+ or +false+. If true, perform transactions against the test server.
+      #   Otherwise, perform transactions against the production server.
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        super
+      end
+
+      # Creates a new customer profile along with any customer payment profiles and customer shipping addresses
+      # for the customer profile.
+      #
+      # Returns a Response with the Customer Profile ID of the new customer profile in the authorization field.
+      # It is *CRITICAL* that you save this ID. There is no way to retrieve this through the API. You will not
+      # be able to create another Customer Profile with the same information.
+      #
+      # ==== Options
+      #
+      # TODO
+      def create_customer_profile(options)
+        # TODO Add requires
+        request = build_request(:create_customer_profile, options)
+        commit(:create_customer_profile, request)
+      end
+
+      # Creates a new customer payment profile for an existing customer profile.
+      #
+      # ==== Options
+      #
+      # * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer the payment profile will be added to. (REQUIRED)
+      # * <tt>:payment_profile</tt> -- A hash containing the elements of the new payment profile (REQUIRED)
+      #
+      # ==== Payment Profile
+      #
+      # * <tt>:payment</tt> -- A hash containing information on payment. Either :credit_card or :bank_account (REQUIRED)
+      def create_customer_payment_profile(options)
+        requires!(options, :customer_profile_id)
+        requires!(options, :payment_profile)
+        requires!(options[:payment_profile], :payment)
+
+        request = build_request(:create_customer_payment_profile, options)
+        commit(:create_customer_payment_profile, request)
+      end
+
+      # Creates a new customer shipping address for an existing customer profile.
+      #
+      # ==== Options
+      #
+      # * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer the payment profile will be added to. (REQUIRED)
+      # * <tt>:address</tt> -- A hash containing the elements of the shipping address (REQUIRED)
+      def create_customer_shipping_address(options)
+        requires!(options, :customer_profile_id)
+        requires!(options, :address)
+
+        request = build_request(:create_customer_shipping_address, options)
+        commit(:create_customer_shipping_address, request)
+      end
+
+      # Deletes an existing customer profile along with all associated customer payment profiles and customer shipping addresses.
+      #
+      # ==== Options
+      #
+      # * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer to be deleted. (REQUIRED)
+      def delete_customer_profile(options)
+        requires!(options, :customer_profile_id)
+
+        request = build_request(:delete_customer_profile, options)
+        commit(:delete_customer_profile, request)
+      end
+
+      # Deletes a customer payment profile from an existing customer profile.
+      #
+      # ==== Options
+      #
+      # * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer with the payment profile to be deleted. (REQUIRED)
+      # * <tt>:customer_payment_profile_id</tt> -- The Payment Profile ID of the payment profile to be deleted. (REQUIRED)
+      def delete_customer_payment_profile(options)
+        requires!(options, :customer_profile_id)
+        requires!(options, :customer_payment_profile_id)
+
+        request = build_request(:delete_customer_payment_profile, options)
+        commit(:delete_customer_payment_profile, request)
+      end
+
+      # Deletes a customer shipping address from an existing customer profile.
+      #
+      # ==== Options
+      #
+      # * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer with the payment profile to be deleted. (REQUIRED)
+      # * <tt>:customer_address_id</tt> -- The Shipping Address ID of the shipping address to be deleted. (REQUIRED)
+      def delete_customer_shipping_address(options)
+        requires!(options, :customer_profile_id)
+        requires!(options, :customer_address_id)
+
+        request = build_request(:delete_customer_shipping_address, options)
+        commit(:delete_customer_shipping_address, request)
+      end
+
+      # Retrieves an existing customer profile along with all the associated customer payment profiles and customer shipping addresses.
+      #
+      # Returns a Response whose params hash contains all the profile information.
+      #
+      # ==== Options
+      #
+      # * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer to retrieve. (REQUIRED)
+      def get_customer_profile(options)
+        requires!(options, :customer_profile_id)
+
+        request = build_request(:get_customer_profile, options)
+        commit(:get_customer_profile, request)
+      end
+
+      # Retrieve a customer payment profile for an existing customer profile.
+      #
+      # Returns a Response whose params hash contains all the payment profile information. Sensitive information such as credit card
+      # numbers will be masked.
+      #
+      # ==== Options
+      #
+      # * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer with the payment profile to be retrieved. (REQUIRED)
+      # * <tt>:customer_payment_profile_id</tt> -- The Payment Profile ID of the payment profile to be retrieved. (REQUIRED)
+      def get_customer_payment_profile(options)
+        requires!(options, :customer_profile_id)
+        requires!(options, :customer_payment_profile_id)
+
+        request = build_request(:get_customer_payment_profile, options)
+        commit(:get_customer_payment_profile, request)
+      end
+
+      # Retrieve a customer shipping address for an existing customer profile.
+      #
+      # Returns a Response whose params hash contains all the shipping address information.
+      #
+      # ==== Options
+      #
+      # * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer with the payment profile to be retrieved. (REQUIRED)
+      # * <tt>:customer_address_id</tt> -- The Shipping Address ID of the shipping address to be retrieved. (REQUIRED)
+      def get_customer_shipping_address(options)
+        requires!(options, :customer_profile_id)
+        requires!(options, :customer_address_id)
+
+        request = build_request(:get_customer_shipping_address, options)
+        commit(:get_customer_shipping_address, request)
+      end
+
+      # Updates an existing customer profile.
+      #
+      # Warning: if you do not provide a parameter in the <tt>:payment_profile</tt> hash, it is automatically set to nil at
+      # Authorize.Net. You will most likely want to first get the profile hash using get_customer_profile and then only change the
+      # elements you wish to change.
+      #
+      # ==== Options
+      #
+      # * <tt>:profile</tt> -- A hash containing the values the Customer Profile should be updated to. (REQUIRED)
+      #
+      # ==== Profile
+      #
+      # * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer profile to update. (REQUIRED)
+      def update_customer_profile(options)
+        requires!(options, :profile)
+        requires!(options[:profile], :customer_profile_id)
+
+        request = build_request(:update_customer_profile, options)
+        commit(:update_customer_profile, request)
+      end
+
+      # Updates a customer payment profile for an existing customer profile.
+      #
+      # Warning: if you do not provide a parameter in the <tt>:payment_profile</tt> hash, it is automatically set to nil at
+      # Authorize.Net. You will most likely want to first get the profile hash using get_customer_payment_profile and then only
+      # change the elements you wish to change.
+      #
+      # ==== Options
+      #
+      # * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer with the payment profile to be updated. (REQUIRED)
+      # * <tt>:payment_profile</tt> -- A hash containing the values the Customer Payment Profile should be updated to. (REQUIRED)
+      #
+      # ==== Payment Profile
+      #
+      # * <tt>:customer_payment_profile_id</tt> -- The Customer Payment Profile ID of the Customer Payment Profile to update. (REQUIRED)
+      def update_customer_payment_profile(options)
+        requires!(options, :customer_profile_id, :payment_profile)
+        requires!(options[:payment_profile], :customer_payment_profile_id)
+
+        request = build_request(:update_customer_payment_profile, options)
+        commit(:update_customer_payment_profile, request)
+      end
+
+      # Updates a customer shipping address for an existing customer profile.
+      #
+      # Warning: if you do not provide a parameter in the <tt>:address</tt> hash, it is automatically set to nil at
+      # Authorize.Net. You will most likely want to first get the profile hash using get_customer_shipping_address and then only
+      # change the elements you wish to change.
+      #
+      # ==== Options
+      #
+      # * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer with the payment profile to be updated. (REQUIRED)
+      # * <tt>:address</tt> -- A hash containing the values the Customer Shipping Address should be updated to. (REQUIRED)
+      #
+      # ==== Address
+      #
+      # * <tt>:customer_address_id</tt> -- The Customer Address ID of the Customer Payment Profile to update. (REQUIRED)
+      def update_customer_shipping_address(options)
+        requires!(options, :customer_profile_id, :address)
+        requires!(options[:address], :customer_address_id)
+
+        request = build_request(:update_customer_shipping_address, options)
+        commit(:update_customer_shipping_address, request)
+      end
+
+      # Creates a new payment transaction from an existing customer profile
+      #
+      # This is what is used to charge a customer whose information you have stored in a Customer Profile.
+      #
+      # Returns a Response object that contains the result of the transaction in <tt>params['direct_response']</tt>
+      #
+      # ==== Options
+      #
+      # * <tt>:transaction</tt> -- A hash containing information on the transaction that is being requested. (REQUIRED)
+      #
+      # ==== Transaction
+      #
+      # * <tt>:type</tt> -- The type of transaction. Can be either <tt>:auth_only</tt>, <tt>:capture_only</tt>, <tt>:auth_capture</tt>, <tt>:prior_auth_capture</tt>, <tt>:refund</tt> or <tt>:void</tt>. (REQUIRED)
+      # * <tt>:amount</tt> -- The amount for the tranaction. Formatted with a decimal. For example "4.95" (CONDITIONAL)
+      #     - :type == :void (NOT USED)
+      #     - :type == (:refund, :auth_only, :capture_only, :auth_capture, :prior_auth_capture) (REQUIRED)
+      #
+      # * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer to use in this transaction. (CONDITIONAL)
+      #     - :type == (:void, :prior_auth_capture) (OPTIONAL)
+      #     - :type == :refund (CONDITIONAL - required if masked information is not being submitted [see below])
+      #     - :type == (:auth_only, :capture_only, :auth_capture) (REQUIRED)
+      #
+      # * <tt>:customer_payment_profile_id</tt> -- The Customer Payment Profile ID of the Customer Payment Profile to use in this transaction. (CONDITIONAL)
+      #     - :type == (:void, :prior_auth_capture) (OPTIONAL)
+      #     - :type == :refund (CONDITIONAL - required if masked information is not being submitted [see below])
+      #     - :type == (:auth_only, :capture_only, :auth_capture) (REQUIRED)
+      #
+      # * <tt>:trans_id</tt> -- The payment gateway assigned transaction ID of the original transaction (CONDITIONAL):
+      #     - :type = (:void, :refund, :prior_auth_capture) (REQUIRED)
+      #     - :type = (:auth_only, :capture_only, :auth_capture) (NOT USED)
+      #
+      # * <tt>customer_shipping_address_id</tt> -- Payment gateway assigned ID associated with the customer shipping address (CONDITIONAL)
+      #     - :type = (:void, :refund) (OPTIONAL)
+      #     - :type = (:auth_only, :capture_only, :auth_capture) (NOT USED)
+      #     - :type = (:prior_auth_capture) (OPTIONAL)
+      #
+      # ==== For :type == :refund only
+      # * <tt>:credit_card_number_masked</tt> -- (CONDITIONAL - requied for credit card refunds is :customer_profile_id AND :customer_payment_profile_id are missing)
+      # * <tt>:bank_routing_number_masked && :bank_account_number_masked</tt> -- (CONDITIONAL - requied for electronic check refunds is :customer_profile_id AND :customer_payment_profile_id are missing) (NOT ABLE TO TEST - I keep getting "ACH transactions are not accepted by this merchant." when trying to make a payment and, until that's possible I can't refund (wiseleyb@gmail.com))
+      def create_customer_profile_transaction(options)
+        requires!(options, :transaction)
+        requires!(options[:transaction], :type)
+        case options[:transaction][:type]
+          when :void
+            requires!(options[:transaction], :trans_id)
+          when :refund
+            requires!(options[:transaction], :trans_id) &&
+              (
+                (options[:transaction][:customer_profile_id] && options[:transaction][:customer_payment_profile_id]) ||
+                options[:transaction][:credit_card_number_masked] ||
+                (options[:transaction][:bank_routing_number_masked] && options[:transaction][:bank_account_number_masked])
+              )
+          when :prior_auth_capture
+            requires!(options[:transaction], :amount, :trans_id)
+          else
+            requires!(options[:transaction], :amount, :customer_profile_id, :customer_payment_profile_id)
+        end
+        request = build_request(:create_customer_profile_transaction, options)
+        commit(:create_customer_profile_transaction, request)
+      end
+
+      # Creates a new payment transaction for refund from an existing customer profile
+      #
+      # This is what is used to refund a transaction you have stored in a Customer Profile.
+      #
+      # Returns a Response object that contains the result of the transaction in <tt>params['direct_response']</tt>
+      #
+      # ==== Options
+      #
+      # * <tt>:transaction</tt> -- A hash containing information on the transaction that is being requested. (REQUIRED)
+      #
+      # ==== Transaction
+      #
+      # * <tt>:amount</tt> -- The total amount to be refunded (REQUIRED)
+      #
+      # * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer to use in this transaction. (CONDITIONAL :customer_payment_profile_id must be included if used)
+      # * <tt>:customer_payment_profile_id</tt> -- The Customer Payment Profile ID of the Customer Payment Profile to use in this transaction. (CONDITIONAL :customer_profile_id must be included if used)
+      #
+      # * <tt>:credit_card_number_masked</tt> -- Four Xs follwed by the last four digits of the credit card (CONDITIONAL - used if customer_profile_id and customer_payment_profile_id aren't given)
+      #
+      # * <tt>:bank_routing_number_masked</tt> -- The last four gidits of the routing number to be refunded (CONDITIONAL - must be used with :bank_account_number_masked)
+      # * <tt>:bank_account_number_masked</tt> -- The last four digis of the bank account number to be refunded, Ex. XXXX1234 (CONDITIONAL - must be used with :bank_routing_number_masked)
+      def create_customer_profile_transaction_for_refund(options)
+        requires!(options, :transaction)
+        options[:transaction][:type] = :refund
+        requires!(options[:transaction], :trans_id)
+        requires!(options[:transaction], :amount)
+        request = build_request(:create_customer_profile_transaction, options)
+        commit(:create_customer_profile_transaction, request)
+      end
+
+      # Creates a new payment transaction for void from an existing customer profile
+      #
+      # This is what is used to void a transaction you have stored in a Customer Profile.
+      #
+      # Returns a Response object that contains the result of the transaction in <tt>params['direct_response']</tt>
+      #
+      # ==== Options
+      #
+      # * <tt>:transaction</tt> -- A hash containing information on the transaction that is being requested. (REQUIRED)
+      #
+      # ==== Transaction
+      #
+      # * <tt>:trans_id</tt> -- The payment gateway assigned transaction id of the original transaction. (REQUIRED)
+      # * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer to use in this transaction.
+      # * <tt>:customer_payment_profile_id</tt> -- The Customer Payment Profile ID of the Customer Payment Profile to use in this transaction.
+      # * <tt>:customer_shipping_address_id</tt> -- Payment gateway assigned ID associated with the customer shipping address.
+      def create_customer_profile_transaction_for_void(options)
+        requires!(options, :transaction)
+        options[:transaction][:type] = :void
+        requires!(options[:transaction], :trans_id)
+        request = build_request(:create_customer_profile_transaction, options)
+        commit(:create_customer_profile_transaction, request)
+      end
+
+      # Verifies an existing customer payment profile by generating a test transaction
+      #
+      # Returns a Response object that contains the result of the transaction in <tt>params['direct_response']</tt>
+      #
+      # ==== Options
+      #
+      # * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer to use in this transaction. (REQUIRED)
+      # * <tt>:customer_payment_profile_id</tt> -- The Customer Payment Profile ID of the Customer Payment Profile to be verified. (REQUIRED)
+      # * <tt>:customer_address_id</tt> -- The Customer Address ID of the Customer Shipping Address to be verified.
+      # * <tt>:validation_mode</tt> -- <tt>:live</tt> or <tt>:test</tt> In Test Mode, only field validation is performed.
+      #   In Live Mode, a transaction is generated and submitted to the processor with the amount of $0.01. If successful, the transaction is immediately voided. (REQUIRED)
+      def validate_customer_payment_profile(options)
+        requires!(options, :customer_profile_id, :customer_payment_profile_id, :validation_mode)
+
+        request = build_request(:validate_customer_payment_profile, options)
+        commit(:validate_customer_payment_profile, request)
+      end
+
+      private
+
+      def expdate(credit_card)
+        sprintf('%04d-%02d', credit_card.year, credit_card.month)
+      end
+
+      def build_request(action, options = {})
+        unless CIM_ACTIONS.include?(action)
+          raise StandardError, "Invalid Customer Information Manager Action: #{action}"
+        end
+
+        xml = Builder::XmlMarkup.new(:indent => 2)
+        xml.instruct!(:xml, :version => '1.0', :encoding => 'utf-8')
+        xml.tag!("#{CIM_ACTIONS[action]}Request", :xmlns => AUTHORIZE_NET_CIM_NAMESPACE) do
+          add_merchant_authentication(xml)
+          # Merchant-assigned reference ID for the request
+          xml.tag!('refId', options[:ref_id]) if options[:ref_id]
+          send("build_#{action}_request", xml, options)
+        end
+      end
+
+      # Contains the merchant’s payment gateway account authentication information
+      def add_merchant_authentication(xml)
+        xml.tag!('merchantAuthentication') do
+          xml.tag!('name', @options[:login])
+          xml.tag!('transactionKey', @options[:password])
+        end
+      end
+
+      def build_create_customer_profile_request(xml, options)
+        add_profile(xml, options[:profile])
+
+        xml.tag!('validationMode',CIM_VALIDATION_MODES[options[:validation_mode]]) if options[:validation_mode]
+
+        xml.target!
+      end
+
+      def build_create_customer_payment_profile_request(xml, options)
+        xml.tag!('customerProfileId', options[:customer_profile_id])
+
+        xml.tag!('paymentProfile') do
+          add_payment_profile(xml, options[:payment_profile])
+        end
+
+        xml.tag!('validationMode', CIM_VALIDATION_MODES[options[:validation_mode]]) if options[:validation_mode]
+
+        xml.target!
+      end
+
+      def build_create_customer_shipping_address_request(xml, options)
+        xml.tag!('customerProfileId', options[:customer_profile_id])
+
+        xml.tag!('address') do
+          add_address(xml, options[:address])
+        end
+
+        xml.target!
+      end
+
+      def build_delete_customer_profile_request(xml, options)
+        xml.tag!('customerProfileId', options[:customer_profile_id])
+        xml.target!
+      end
+
+      def build_delete_customer_payment_profile_request(xml, options)
+        xml.tag!('customerProfileId', options[:customer_profile_id])
+        xml.tag!('customerPaymentProfileId', options[:customer_payment_profile_id])
+        xml.target!
+      end
+
+      def build_delete_customer_shipping_address_request(xml, options)
+        xml.tag!('customerProfileId', options[:customer_profile_id])
+        xml.tag!('customerAddressId', options[:customer_address_id])
+        xml.target!
+      end
+
+      def build_get_customer_profile_request(xml, options)
+        xml.tag!('customerProfileId', options[:customer_profile_id])
+        xml.target!
+      end
+
+      def build_get_customer_payment_profile_request(xml, options)
+        xml.tag!('customerProfileId', options[:customer_profile_id])
+        xml.tag!('customerPaymentProfileId', options[:customer_payment_profile_id])
+        xml.target!
+      end
+
+      def build_get_customer_shipping_address_request(xml, options)
+        xml.tag!('customerProfileId', options[:customer_profile_id])
+        xml.tag!('customerAddressId', options[:customer_address_id])
+        xml.target!
+      end
+
+      def build_update_customer_profile_request(xml, options)
+        add_profile(xml, options[:profile], true)
+
+        xml.target!
+      end
+
+      def build_update_customer_payment_profile_request(xml, options)
+        xml.tag!('customerProfileId', options[:customer_profile_id])
+
+        xml.tag!('paymentProfile') do
+          add_payment_profile(xml, options[:payment_profile])
+        end
+
+        xml.target!
+      end
+
+      def build_update_customer_shipping_address_request(xml, options)
+        xml.tag!('customerProfileId', options[:customer_profile_id])
+
+        xml.tag!('address') do
+          add_address(xml, options[:address])
+        end
+
+        xml.target!
+      end
+
+      def build_create_customer_profile_transaction_request(xml, options)
+        add_transaction(xml, options[:transaction])
+        xml.tag!('extraOptions', "x_test_request=TRUE") if @options[:test]
+
+        xml.target!
+      end
+
+      def build_validate_customer_payment_profile_request(xml, options)
+        xml.tag!('customerProfileId', options[:customer_profile_id])
+        xml.tag!('customerPaymentProfileId', options[:customer_payment_profile_id])
+        xml.tag!('customerShippingAddressId', options[:customer_address_id]) if options[:customer_address_id]
+        xml.tag!('validationMode', CIM_VALIDATION_MODES[options[:validation_mode]]) if options[:validation_mode]
+
+        xml.target!
+      end
+
+      # :merchant_customer_id (Optional)
+      # :description (Optional)
+      # :email (Optional)
+      # :payment_profiles (Optional)
+      def add_profile(xml, profile, update = false)
+        xml.tag!('profile') do
+          # Merchant assigned ID for the customer. Up to 20 characters. (optional)
+          xml.tag!('merchantCustomerId', profile[:merchant_customer_id]) if profile[:merchant_customer_id]
+          # Description of the customer. Up to 255 Characters (optional)
+          xml.tag!('description', profile[:description]) if profile[:description]
+          # Email Address for the customer. Up to 255 Characters (optional)
+          xml.tag!('email', profile[:email]) if profile[:email]
+
+          if update
+            xml.tag!('customerProfileId', profile[:customer_profile_id])
+          else
+            add_payment_profiles(xml, profile[:payment_profiles]) if profile[:payment_profiles]
+            add_ship_to_list(xml, profile[:ship_to_list]) if profile[:ship_to_list]
+          end
+        end
+      end
+
+      def add_transaction(xml, transaction)
+        unless CIM_TRANSACTION_TYPES.include?(transaction[:type])
+          raise StandardError, "Invalid Customer Information Manager Transaction Type: #{transaction[:type]}"
+        end
+
+        xml.tag!('transaction') do
+          xml.tag!(CIM_TRANSACTION_TYPES[transaction[:type]]) do
+            # The amount to be billed to the customer
+            case transaction[:type]
+              when :void
+                tag_unless_blank(xml,'customerProfileId', transaction[:customer_profile_id])
+                tag_unless_blank(xml,'customerPaymentProfileId', transaction[:customer_payment_profile_id])
+                tag_unless_blank(xml,'customerShippingAddressId', transaction[:customer_shipping_address_id])
+                xml.tag!('transId', transaction[:trans_id])
+              when :refund
+                #TODO - add support for all the other options fields
+                xml.tag!('amount', transaction[:amount])
+                tag_unless_blank(xml, 'customerProfileId', transaction[:customer_profile_id])
+                tag_unless_blank(xml, 'customerPaymentProfileId', transaction[:customer_payment_profile_id])
+                tag_unless_blank(xml, 'customerShippingAddressId', transaction[:customer_shipping_address_id])
+                tag_unless_blank(xml, 'creditCardNumberMasked', transaction[:credit_card_number_masked])
+                tag_unless_blank(xml, 'bankRoutingNumberMasked', transaction[:bank_routing_number_masked])
+                tag_unless_blank(xml, 'bankAccountNumberMasked', transaction[:bank_account_number_masked])
+                xml.tag!('transId', transaction[:trans_id])
+              when :prior_auth_capture
+                xml.tag!('amount', transaction[:amount])
+                xml.tag!('transId', transaction[:trans_id])
+              else
+                xml.tag!('amount', transaction[:amount])
+                xml.tag!('customerProfileId', transaction[:customer_profile_id])
+                xml.tag!('customerPaymentProfileId', transaction[:customer_payment_profile_id])
+                xml.tag!('approvalCode', transaction[:approval_code]) if transaction[:type] == :capture_only
+            end
+            add_order(xml, transaction[:order]) if transaction[:order]
+          end
+        end
+      end
+
+      def add_order(xml, order)
+        xml.tag!('order') do
+          xml.tag!('invoiceNumber', order[:invoice_number]) if order[:invoice_number]
+          xml.tag!('description', order[:description]) if order[:description]
+          xml.tag!('purchaseOrderNumber', order[:purchase_order_number]) if order[:purchase_order_number]
+        end
+      end
+
+      def add_payment_profiles(xml, payment_profiles)
+        xml.tag!('paymentProfiles') do
+          add_payment_profile(xml, payment_profiles)
+        end
+      end
+
+      # :customer_type => 'individual or business', # Optional
+      # :bill_to => @address,
+      # :payment => @payment
+      def add_payment_profile(xml, payment_profile)
+        # 'individual' or 'business' (optional)
+        xml.tag!('customerType', payment_profile[:customer_type]) if payment_profile[:customer_type]
+
+        if payment_profile[:bill_to]
+          xml.tag!('billTo') do
+            add_address(xml, payment_profile[:bill_to])
+          end
+        end
+
+        if payment_profile[:payment]
+          xml.tag!('payment') do
+            add_credit_card(xml, payment_profile[:payment][:credit_card]) if payment_profile[:payment].has_key?(:credit_card)
+            add_bank_account(xml, payment_profile[:payment][:bank_account]) if payment_profile[:payment].has_key?(:bank_account)
+            add_drivers_license(xml, payment_profile[:payment][:drivers_license]) if payment_profile[:payment].has_key?(:drivers_license)
+            # This element is only required for Wells Fargo SecureSource eCheck.Net merchants
+            # The customer's Social Security Number or Tax ID
+            xml.tag!('taxId', payment_profile[:payment]) if payment_profile[:payment].has_key?(:tax_id)
+          end
+        end
+
+        xml.tag!('customerPaymentProfileId', payment_profile[:customer_payment_profile_id]) if payment_profile[:customer_payment_profile_id]
+      end
+
+      def add_ship_to_list(xml, ship_to_list)
+        xml.tag!('shipToList') do
+          add_address(xml, ship_to_list)
+        end
+      end
+
+      def add_address(xml, address)
+        xml.tag!('firstName', address[:first_name])
+        xml.tag!('lastName', address[:last_name])
+        xml.tag!('company', address[:company])
+        xml.tag!('address', address[:address1]) if address[:address1]
+        xml.tag!('address', address[:address]) if address[:address]
+        xml.tag!('city', address[:city])
+        xml.tag!('state', address[:state])
+        xml.tag!('zip', address[:zip])
+        xml.tag!('country', address[:country])
+        xml.tag!('phoneNumber', address[:phone_number]) if address[:phone_number]
+        xml.tag!('faxNumber', address[:fax_number]) if address[:fax_number]
+
+        xml.tag!('customerAddressId', address[:customer_address_id]) if address[:customer_address_id]
+      end
+
+      # Adds customer’s credit card information
+      # Note: This element should only be included
+      # when the payment method is credit card.
+      def add_credit_card(xml, credit_card)
+        return unless credit_card
+        xml.tag!('creditCard') do
+          # The credit card number used for payment of the subscription
+          xml.tag!('cardNumber', credit_card.number)
+          # The expiration date of the credit card used for the subscription
+          xml.tag!('expirationDate', expdate(credit_card))
+          xml.tag!('cardCode', credit_card.verification_value) if credit_card.verification_value?
+        end
+      end
+
+      # Adds customer’s bank account information
+      # Note: This element should only be included
+      # when the payment method is bank account.
+      def add_bank_account(xml, bank_account)
+        raise StandardError, "Invalid Bank Account Type: #{bank_account[:account_type]}" unless BANK_ACCOUNT_TYPES.include?(bank_account[:account_type])
+        raise StandardError, "Invalid eCheck Type: #{bank_account[:echeck_type]}" unless ECHECK_TYPES.include?(bank_account[:echeck_type])
+
+        xml.tag!('bankAccount') do
+          # The type of bank account
+          xml.tag!('accountType', BANK_ACCOUNT_TYPES[bank_account[:account_type]])
+          # The routing number of the customer’s bank
+          xml.tag!('routingNumber', bank_account[:routing_number])
+          # The bank account number
+          xml.tag!('accountNumber', bank_account[:account_number])
+          # The full name of the individual associated
+          # with the bank account number
+          xml.tag!('nameOnAccount', bank_account[:name_on_account])
+          # The type of electronic check transaction
+          xml.tag!('echeckType', ECHECK_TYPES[bank_account[:echeck_type]])
+          # The full name of the individual associated
+          # with the bank account number (optional)
+          xml.tag!('bankName', bank_account[:bank_name]) if bank_account[:bank_name]
+        end
+      end
+
+      # Adds customer’s driver's license information
+      # Note: This element is only required for
+      # Wells Fargo SecureSource eCheck.Net merchants
+      def add_drivers_license(xml, drivers_license)
+        xml.tag!('driversLicense') do
+          # The state of the customer's driver's license
+          # A valid two character state code
+          xml.tag!('state', drivers_license[:state])
+          # The customer’s driver's license number
+          xml.tag!('number', drivers_license[:number])
+          # The date of birth listed on the customer's driver's license
+          # YYYY-MM-DD
+          xml.tag!('dateOfBirth', drivers_license[:date_of_birth])
+        end
+      end
+
+      def commit(action, request)
+        url = test? ? test_url : live_url
+        xml = ssl_post(url, request, "Content-Type" => "text/xml")
+        response_params = parse(action, xml)
+        message = response_params['messages']['message']
+
+        if message.class.is_a? Array
+          text = "#{message[0]['code']} - #{message[0]['text']}"
+        else
+          text = "#{message['code']} - #{message['text']}"
+        end
+        test_mode = test? || text =~ /Test Mode/
+        success = response_params['messages']['result_code'] == 'Ok'
+
+        Rails.logger.error("Gateway Error: #{text}") unless success
+
+        direct_response_params = parse_direct_response(response_params['direct_response'])
+
+        response = Response.new(success, text, response_params,
+          :test => test_mode,
+          :authorization => response_params['customer_profile_id'] || (response_params['profile'] ? response_params['profile']['customer_profile_id'] : direct_response_params['transaction_id']),
+          :avs_result => {:code => direct_response_params['avs_response']}
+        )
+        response.params['direct_response'] = direct_response_params
+
+        # transaction_id from direct response should be used for the authorization option on response
+        if response.authorization.nil? and response.params['direct_response']
+          if !response.params['direct_response']['transaction_id'].blank? and response.params['direct_response']['transaction_id'] != '0'
+            response.authorization = response.params['direct_response']['transaction_id']
+          end
+        end
+
+        response
+      end
+
+      def tag_unless_blank(xml, tag_name, data)
+        xml.tag!(tag_name, data) unless data.blank? || data.nil?
+      end
+
+      def parse_direct_response(raw)
+        return {} if raw.blank?
+        direct_response_fields = raw.split(',')
+        {
+          'raw' => raw,
+          'response_code' => direct_response_fields[0],
+          'response_subcode' => direct_response_fields[1],
+          'response_reason_code' => direct_response_fields[2],
+          'message' => direct_response_fields[3],
+          'approval_code' => direct_response_fields[4],
+          'avs_response' => direct_response_fields[5],
+          'transaction_id' => direct_response_fields[6],
+          'invoice_number' => direct_response_fields[7],
+          'order_description' => direct_response_fields[8],
+          'amount' => direct_response_fields[9],
+          'method' => direct_response_fields[10],
+          'transaction_type' => direct_response_fields[11],
+          'customer_id' => direct_response_fields[12],
+          'first_name' => direct_response_fields[13],
+          'last_name' => direct_response_fields[14],
+          'company' => direct_response_fields[15],
+          'address' => direct_response_fields[16],
+          'city' => direct_response_fields[17],
+          'state' => direct_response_fields[18],
+          'zip_code' => direct_response_fields[19],
+          'country' => direct_response_fields[20],
+          'phone' => direct_response_fields[21],
+          'fax' => direct_response_fields[22],
+          'email_address' => direct_response_fields[23],
+          'ship_to_first_name' => direct_response_fields[24],
+          'ship_to_last_name' => direct_response_fields[25],
+          'ship_to_company' => direct_response_fields[26],
+          'ship_to_address' => direct_response_fields[27],
+          'ship_to_city' => direct_response_fields[28],
+          'ship_to_state' => direct_response_fields[29],
+          'ship_to_zip_code' => direct_response_fields[30],
+          'ship_to_country' => direct_response_fields[31],
+          'tax' => direct_response_fields[32],
+          'duty' => direct_response_fields[33],
+          'freight' => direct_response_fields[34],
+          'tax_exempt' => direct_response_fields[35],
+          'purchase_order_number' => direct_response_fields[36],
+          'md5_hash' => direct_response_fields[37],
+          'card_code' => direct_response_fields[38],
+          'cardholder_authentication_verification_response' => direct_response_fields[39]
+        }
+      end
+
+      def parse(action, xml)
+        xml = REXML::Document.new(xml)
+        root = REXML::XPath.first(xml, "//#{CIM_ACTIONS[action]}Response") ||
+               REXML::XPath.first(xml, "//ErrorResponse")
+        if root
+          response = parse_element(root)
+        end
+
+        response
+      end
+
+      def parse_element(node)
+        if node.has_elements?
+          response = {}
+          node.elements.each{ |e|
+            key = e.name.underscore
+            value = parse_element(e)
+            if response.has_key?(key)
+              if response[key].is_a?(Array)
+                response[key].push(value)
+              else
+                response[key] = [response[key], value]
+              end
+            else
+              response[key] = parse_element(e)
+            end
+          }
+        else
+          response = node.text
+        end
+
+        response
+      end
+    end
+  end
+end