authorizenet 1.8.2 → 1.8.3

data/lib/authorize_net/aim/response.rb~

@@ -1,131 +0,0 @@
-module AuthorizeNet::AIM
-  
-  # The AIM response class. Handles parsing the response from the gateway.
-  class Response < AuthorizeNet::KeyValueResponse
-    
-    # Our MD5 digest generator.
-    @@digest = OpenSSL::Digest.new('md5')
-
-    include AuthorizeNet::AIM::Fields
-    
-    # Fields to convert to/from booleans.     
-    @@boolean_fields = [:tax_exempt]
-    
-    # Fields to convert to/from BigDecimal.
-    @@decimal_fields = [:amount, :tax, :freight, :duty, :requested, :balance_on_card]
-    
-    
-    # Constructs a new response object from a +raw_response+ and the +transaction+ that generated
-    # the +raw_response+. You don't typically construct this object yourself, as AuthorizeNet::AIM::Transaction
-    # will build one for you when it makes the request to the gateway.
-    def initialize(raw_response, transaction)
-      @version = transaction.version
-      raise "AuthorizeNet gem only supports AIM version 3.1" unless @version.to_s == '3.1'
-      @raw_response = raw_response
-      @fields = {}
-      @transaction = transaction
-      custom_field_names = transaction.custom_fields.keys.collect(&:to_s).sort.collect(&:to_sym)
-      @custom_fields = {}
-      split_on = transaction.delimiter
-      if @raw_response.kind_of?(Net::HTTPOK) || @raw_response.kind_of?(Nokogiri::XML::Element)
-        if @raw_response.kind_of?(Net::HTTPOK)
-          raw_data = @raw_response.body 
-        else
-          raw_data = @raw_response.text
-        end
-        unless transaction.encapsulation_character.nil?
-          split_on = transaction.encapsulation_character + split_on + transaction.encapsulation_character
-          raw_data = raw_data[1..raw_data.length - 2]
-        end
-        raw_data.split(split_on).each_with_index  do |field, index|
-          if transaction.cp_version.nil?
-            field_desc = FIELDS
-          else
-            field_desc = CP_FIELDS
-          end
-          if index < field_desc.length
-            @fields[field_desc[index]] = field
-          else
-            @custom_fields[custom_field_names[index - field_desc.length]] = field
-          end
-        end
-        @fields.delete(nil)
-        @fields.each do |k, v|
-          if @@boolean_fields.include?(k)
-            @fields[k] = value_to_boolean(v)
-          elsif @@decimal_fields.include?(k)
-            @fields[k] = value_to_decimal(v)
-          end
-        end
-      end
-    end
-    
-    # Returns True if the MD5 hash found in the response payload validates using
-    # the supplied api_login and secret merchant_value (THIS IS NOT YOUR API KEY).
-    def valid_md5?(api_login, merchant_value)
-      if @fields[:md5_hash].nil?
-        return false
-      end
-      @@digest.hexdigest("#{merchant_value}#{api_login}#{@fields[:transaction_id]}#{@transaction.fields[:amount]}").downcase == @fields[:md5_hash].downcase
-    end
-    
-    # Returns the current API version that we are adhering to.
-    def version
-      @version
-    end
-    
-    # Check to see if the response indicated success. Success is defined as a 200 OK response indicating
-    # that the transaction was approved.
-    def success?
-      !connection_failure? && approved?
-    end
-    
-    # Returns true if we failed to open a connection to the gateway or got back a non-200 OK HTTP response.
-    def connection_failure?
-      !@raw_response.kind_of?(Net::HTTPOK) && !@raw_response.kind_of?(Nokogiri::XML::Element)
-    end
-    
-    # Returns the underlying Net::HTTPResponse object. This has the original response body along with
-    # headers and such. Note that if an exception is generated while making the request (which happens
-    # if there is no internet connection for example), you will get the exception object here instead of
-    # a Net::HTTPResponse object.
-    def raw
-      @raw_response
-    end
-    
-    # Returns the AuthorizeNet::Transaction instance that owns this response.
-    def transaction
-      @transaction
-    end
-    
-    # Returns the transaction's authorization code. This should be shown to the
-    # end user.
-    def authorization_code
-      @fields[:authorization_code]
-    end
-    
-    # Returns the transaction's authorization id. You will need this for future void, refund
-    # and prior authorization capture requests.
-    def transaction_id
-      @fields[:transaction_id]
-    end
-    
-    # Returns the customer id from the response.
-    def customer_id
-      @fields[:customer_id]
-    end
-    
-    # Returns a response code (from AVSResponseCode) indicating the result of any Address Verification
-    # Service checks. 
-    def avs_response
-      @fields[:avs_response]
-    end
-    
-    # Returns the credit card type used in the transaction. The values returned can be found in CardType.
-    def card_type
-      @fields[:card_type]
-    end
-    
-  end
-  
-end

data/lib/authorize_net/arb/fields.rb~

@@ -1,13 +0,0 @@
-module AuthorizeNet::ARB
-    module Fields
-      EntityDescription = Struct.new(:node_structure, :entity_class, :arg_mapping)
-
-      SUBSCRIPTION_DETAIL_ENTITY_DESCRIPTION = EntityDescription.new(
-        [
-          {:id => :id},
-          {:name => :name}
-        ],
-        AuthorizeNet::ARB::SubscriptionDetail
-      )
-    end
-end

data/lib/authorize_net/arb/paging.rb~

@@ -1,25 +0,0 @@
-module AuthorizeNet::ARB
-
-  class Paging
-
-    # Models Paging
-    include AuthorizeNet::Model
-    
-    attr_accessor :offset,:limit
-
-    def initialize(offset,limit)
-      @offset = offset
-      @limit = limit
-    end
-
-    def to_hash
-      hash = {
-        :offset => @offset,
-        :limit => @limit
-      }
-      hash.delete_if {|k, v| v.nil?}
-    end
-      
-  end
-
-end

data/lib/authorize_net/arb/response.rb~

@@ -1,68 +0,0 @@
-module AuthorizeNet::ARB
-
-  # The ARB response class.
-  class Response < AuthorizeNet::XmlResponse    
-    # Constructs a new response object from a +raw_response. You don't typically
-    # construct this object yourself, as AuthorizeNet::ARB::Transaction will
-    # build one for you when it makes the request to the gateway.
-    def initialize(raw_response, transaction)
-      super
-      unless connection_failure?
-        begin
-          @subscription_id = node_content_unless_nil(@root.at_css('subscriptionId'))
-          @subscription_status = node_content_unless_nil(@root.at_css('Status'))
-
-        rescue
-          @raw_response = $!
-        end
-      end
-    end
-    
-    # Returns the subscriptionId from the response if there is one. Otherwise returns nil.
-    def subscription_id
-      @subscription_id
-    end
-    
-    # Returns the status of the Subscription from the response if there is one. Otherwise returns nil. This value
-    # is only returned in response to a get_status transaction.
-    def subscription_status
-      @subscription_status
-    end
-    
-  end #Response
-
-  class SubscriptionListResponse < AuthorizeNet::XmlResponse
-    def initialize(raw_response, transaction)
-      super
-      unless connection_failure?
-        begin
-	  @subscription_details = @root.at_css('subscriptionDetails')
-          @subscription_detail = @root.at_css('subscriptionDetail')
-          @total_num_in_resultset = node_content_unless_nil(@root.at_css('totalNumInResultSet'))
-
-        rescue
-          @raw_response = $!
-        end
-      end
-    end
-
-    def total_num_in_resultset
-      @total_num_in_resultset
-    end
-
-    # Returns an Array of SubscriptionDetail objects built from the entities returned in the response. Returns nil if no subscriptions were returned.
-    def subscription_details
-      unless @subscription_details.nil?
-          subscription_details = []
-          @subscription_details.element_children.each do |child|
-            unless child.nil?
-              subscription_detail = build_entity(child, Fields::SUBSCRIPTION_DETAIL_ENTITY_DESCRIPTION)
-            
-              subscription_details <<= subscription_detail
-            end
-          end
-          return subscription_details unless subscription_details.length == 0
-       end
-    end
-  end #SubscriptionListResponse
-end

data/lib/authorize_net/arb/sorting.rb~

@@ -1,43 +0,0 @@
-module AuthorizeNet::ARB
-
-  class Sorting
-    
-    # Models Sorting
-    include AuthorizeNet::Model
-    
-    attr_accessor :order_by, :order_descending
-
-    # Initializes Sorting object. 
-    #
-    # Typical usage:
-    #  sorting = AuthorizeNet::ARB::Sorting.new('name',true)
-    #
-    # Valid values for order_by values of the AuthorizeNet::ARB::Sorting:
-    #    id
-    #    name
-    #    status
-    #    createTimeStampUTC
-    #    lastName
-    #    firstName
-    #    accountNumber
-    #    amount
-    #    pastOccurrences
-    #
-    # Valid values for order_descending: true, false, 1,0
-    #
-    def initialize(order_by, order_descending)
-      @order_by = order_by
-      @order_descending = order_descending
-    end
-   
-    def to_hash
-      hash = {
-        :order_by => @order_by,
-        :order_descending => @order_descending
-      }
-      hash.delete_if {|k, v| v.nil?}
-    end
-      
-  end
-
-end

data/lib/authorize_net/arb/subscription_detail.rb~

@@ -1,56 +0,0 @@
-module AuthorizeNet::ARB
-
-  # Models Subscription Detail.
-  class SubscriptionDetail
-    
-    include AuthorizeNet::Model
-    
-    attr_accessor :id, :name, :status, :create_time_stamp_utc, :first_name,
-                  :last_name, :total_occurrences, :past_occurrences,
-                  :payment_method, :account_number, :invoice, :amount, :currency_id
-      
-  end
-
-  class Sorting
-    
-    include AuthorizeNet::Model
-    
-    attr_accessor :order_by, :order_descending
-
-    def initialize(order_by, order_descending)
-      @order_by = order_by
-      @order_descending = order_descending
-    end
-   
-    def to_hash
-      hash = {
-        :order_by => @order_by,
-        :order_descending => @order_descending
-      }
-      hash.delete_if {|k, v| v.nil?}
-    end
-      
-  end
-
-  class Paging
-    
-    include AuthorizeNet::Model
-    
-    attr_accessor :offset,:limit
-
-    def initialize(offset,limit)
-      @offset = offset
-      @limit = limit
-    end
-
-    def to_hash
-      hash = {
-        :offset => @offset,
-        :limit => @limit
-      }
-      hash.delete_if {|k, v| v.nil?}
-    end
-      
-  end
-
-end

data/lib/authorize_net/arb/subscription_list_response.rb~

@@ -1,45 +0,0 @@
-module AuthorizeNet::ARB
-
-  class SubscriptionListResponse < AuthorizeNet::XmlResponse
-    # Constructs a new response object from a +raw_response. You don't typically
-    # construct this object yourself, as AuthorizeNet::ARB::Transaction will
-    # build one for you when it makes the request to the gateway.
-    def initialize(raw_response, transaction)
-      super
-      unless connection_failure?
-        begin
-	  @subscription_details = @root.at_css('subscriptionDetails')
-          @subscription_detail = @root.at_css('subscriptionDetail')
-          @total_num_in_resultset = node_content_unless_nil(@root.at_css('totalNumInResultSet'))
-
-puts "bla bla"
-
-        rescue
-          @raw_response = $!
-        end
-      end
-    end
-
-    # Returns total number of subscriptions matching the search criteria
-    def total_num_in_resultset
-      @total_num_in_resultset
-    end
-
-    # Returns an Array of SubscriptionDetail objects built from the entities returned in the response. Returns nil if no subscriptions were returned.
-    def subscription_details
-      unless @subscription_details.nil?
-          subscription_details = []
-          @subscription_details.element_children.each do |child|
-            unless child.nil?
-              subscription_detail = build_entity(child, Fields::SUBSCRIPTION_DETAIL_ENTITY_DESCRIPTION)
-            
-              subscription_details <<= subscription_detail
-            end
-          end
-          return subscription_details unless subscription_details.length == 0
-       end
-    end
-
-  end 
-
-end

data/lib/authorize_net/arb/transaction.rb~

@@ -1,176 +0,0 @@
-module AuthorizeNet::ARB
-
-  # The ARB transaction class.
-  class Transaction < AuthorizeNet::XmlTransaction
-    
-    include AuthorizeNet::ARB::Fields
-    
-    # The default options for the constructor.
-    @@option_defaults = {
-      :gateway => :production,
-      :verify_ssl => false,
-      :reference_id => nil
-    }
-    
-    # Fields to convert to/from booleans.
-    @@boolean_fields = []
-    
-    # Fields to convert to/from BigDecimal.
-    @@decimal_fields = [:amount, :trial_amount]
-    
-    # Fields to convert to/from Date.
-    @@date_fields = [:subscription_start_date]
-    
-    # The class to wrap our response in.
-    @response_class = AuthorizeNet::ARB::Response   
-    
-    # Constructs an ARB transaction. You can use the new ARB transaction object
-    # to issue a request to the payment gateway and parse the response into a new
-    # AuthorizeNet::ARB::Response object.
-    # 
-    # +api_login_id+:: Your API login ID, as a string.
-    # +api_transaction_key+:: Your API transaction key, as a string.
-    # +options+:: A hash of options. See below for values.
-    # 
-    # Options
-    # +gateway+:: The gateway to submit the transaction to. Can be a URL string, an AuthorizeNet::ARB::Transaction::Gateway constant, or one of the convenience symbols :sandbox, :test, :production, or :live (:test is an alias for :sandbox, and :live is an alias for :production). 
-    # +verify_ssl+:: A boolean indicating if the SSL certificate of the +gateway+ should be verified. Defaults to false.
-    # +reference_id+:: A string that can be used to identify a particular transaction with its response. Will be echo'd in the response, only if it was provided in the transaction. Defaults to nil.
-    #
-    def initialize(api_login_id, api_transaction_key, options = {})
-      super
-    end
-    
-    # Sets up and submits a start of subscription (ARBCreateSubscriptionRequest) transaction. Returns a response object. If the transaction
-    # has already been run, it will return nil.
-    # 
-    # +subscription+:: An instance of AuthorizeNet::ARB::Subscription describing the recurring payment you would like to create.
-    # 
-    # 
-    # Typical usage:
-    # 
-    #   subscription = AuthorizeNet::ARB::Subscription.new(
-    #     :name => "Monthly Gift Basket",
-    #     :length => 1,
-    #     :unit => :month,
-    #     :start_date => Date.today,
-    #     :total_occurrences => :unlimited,
-    #     :amount => 100.00,
-    #     :invoice_number => '1234567',
-    #     :description => "John Doe's Monthly Gift Basket",
-    #     :credit_card => AuthorizeNet::CreditCard.new('4111111111111111', '1120'),
-    #     :billing_address => AuthorizeNet::Address.new(:first_name => 'John', :last_name => 'Doe')
-    #   )
-    #   response = transaction.create(subscription)
-    #
-    def create(subscription)
-      @type = Type::ARB_CREATE
-      set_fields(subscription.to_hash)
-      run
-    end
-    
-    # Sets up and submits a subscription update (ARBUpdateSubscriptionRequest) transaction. Returns a response object. If the transaction
-    # has already been run, it will return nil.
-    # 
-    # +subscription+:: An instance of AuthorizeNet::ARB::Subscription describing the changes to make. It must have a value for subscription_id so that the API knows what subscription to update. Note that some information (intervals, start dates, etc) can't be changed. See the ARB guide for more details.
-    # 
-    # 
-    # Typical usage:
-    # 
-    #   subscription = AuthorizeNet::ARB::Subscription.new(
-    #     :billing_address => AuthorizeNet::Address.new(:first_name => 'Jane', :last_name => 'Doe'),
-    #     :subscription_id => '123456'
-    #   )
-    #   response = transaction.update(subscription)
-    #
-    def update(subscription)
-      @type = Type::ARB_UPDATE
-      set_fields(subscription.to_hash)
-      run
-    end
-    
-    # Sets up and submits a subscription status query (ARBGetSubscriptionStatusRequest) transaction. Returns a response object (which contains the subscription status). If the transaction
-    # has already been run, it will return nil.
-    # 
-    # +subscription_id+:: Either the subscription id of the subscription to get the status of as a string, or a Subscription instance with a value for subscription_id set on it.
-    # 
-    # 
-    # Typical usage:
-    # 
-    #   response = transaction.get_status('123456')
-    #   response.subscription_status    # A value from AuthorizeNet::ARB::Subscription::Status
-    #
-    def get_status(subscription_id)
-      @type = Type::ARB_GET_STATUS
-      handle_subscription_id(subscription_id)
-      run
-    end
-
-    # Sets up and submits a subscription list query (ARBGetSubscriptionListRequest). Returns a response object 
-    # which contains the list of subscription details and the total number of subscriptions matching the search 
-    # criteria. Sorting and Paging are optional parameters.
-    #
-    # Valid values for search type parameter:
-    #    cardExpiringThisMonth
-    #    subscriptionActive
-    #    subscriptionExpiringThisMonth
-    #    subscriptionInactive
-    #
-    # Typical usage:
-    # 
-    #   sorting = AuthorizeNet::ARB::Sorting.new('name',true)
-    #   paging = AuthorizeNet::ARB::Paging.new(1,1000)
-    #   response = transaction.get_subscription_list('subscriptionActive',sorting,paging)
-    #
-    def get_subscription_list(search_type, sorting = nil, paging = nil)
-      unless search_type.nil?
-        self.class.instance_variable_set(:@response_class,SubscriptionListResponse)
-        @type = Type::ARB_GET_SUBSCRIPTION_LIST
-        set_fields(:search_type => search_type.to_s) 
-        unless sorting.nil?  
-          set_fields(sorting.to_hash) 
-        end
-        unless paging.nil?
-          set_fields(paging.to_hash) 
-        end
-      run
-      end
-    end
-      
-    # Sets up and submits a subscription cancelation (ARBCancelSubscriptionRequest) transaction. Returns a response object. If the transaction
-    # has already been run, it will return nil.
-    # 
-    # +subscription_id+:: Either the subscription id of the subscription to get the status of as a string, or a Subscription instance with a value for subscription_id set on it.
-    # 
-    # 
-    # Typical usage:
-    # 
-    #   response = transaction.cancel('123456')
-    #
-    def cancel(subscription_id)
-      @type = Type::ARB_CANCEL
-      handle_subscription_id(subscription_id)
-      run
-    end
-        
-    #:enddoc:
-    protected
-    
-    # Internal method to handle multiple types of subscription id arguments.
-    def handle_subscription_id(subscription_id)
-      case subscription_id
-      when Subscription
-        set_fields(:subscription_id => subscription_id.subscription_id.to_s)
-      else
-        set_fields(:subscription_id => subscription_id.to_s)
-      end
-    end
-    
-    # An internal method that builds the POST body, submits it to the gateway, and constructs a Response object with the response.
-    def make_request
-      set_fields(:reference_id => @reference_id)
-      super
-    end
-    
-  end
-end