authorizenet 1.8

data/lib/authorize_net/arb/response.rb

@@ -0,0 +1,34 @@
+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
+  
+end

data/lib/authorize_net/arb/subscription.rb

@@ -0,0 +1,72 @@
+module AuthorizeNet::ARB
+
+  # Models an ARB subscription.
+  class Subscription
+    
+    # Use this constant for the value of total_occurrences to get a subscription with no end.
+    UNLIMITED_OCCURRENCES = 9999
+    
+    # Constants for the various interval units supported by the ARB API.
+    module IntervalUnits
+      MONTH = 'months'
+      DAY = 'days'
+    end
+    
+    # Constants for the various statuses a subscription can have. These are returned by the get_status call.
+    module Status
+      ACTIVE = 'active'
+      EXPIRED = 'expired'
+      SUSPENDED = 'suspended'
+      CANCELED = 'canceled'
+      TERMINATED = 'terminated'
+    end
+    
+    include AuthorizeNet::Model
+    
+    attr_accessor :name, :length, :unit, :start_date, :total_occurrences, :trial_occurrences, :amount, :trial_amount, :invoice_number, :description, :subscription_id, :credit_card, :billing_address, :shipping_address, :customer
+    
+    # Override the length setter to provide support for :unlimited shortcut. Do not document this method in rdoc.
+    def length=(new_length) #:nodoc:
+      if new_length == :unlimited
+        @length = UNLIMITED_OCCURRENCES
+      else
+        @length = new_length
+      end
+    end
+    
+    # Override the unit setter to provide support for :day, :days, :month, :months shortcut. Do not document this method in rdoc.
+    def unit=(new_unit) #:nodoc:
+      case new_unit
+      when :day, :days
+        @unit = IntervalUnits::DAY
+      when :month, :months
+        @unit = IntervalUnits::MONTH
+      else
+        @unit = new_unit
+      end
+    end
+    
+    def to_hash
+      hash = {
+        :subscription_name => @name,
+        :subscription_length => @length,
+        :subscription_unit => @unit,
+        :subscription_start_date => @start_date,
+        :subscription_total_occurrences => @total_occurrences,
+        :subscription_trial_occurrences => @trial_occurrences,
+        :subscription_amount => @amount,
+        :subscription_trial_amount => @trial_amount,
+        :invoice_num => @invoice_number,
+        :description => @description,
+        :subscription_id => @subscription_id
+      }
+      hash.merge!(@credit_card.to_hash) unless @credit_card.nil?
+      hash.merge!(@billing_address.to_hash) unless @billing_address.nil?
+      hash.merge!(@shipping_address.to_hash) unless @shipping_address.nil?
+      hash.merge!(@customer.to_hash) unless @customer.nil?
+      hash.delete_if {|k, v| v.nil?}
+    end
+    
+  end
+
+end

data/lib/authorize_net/arb/transaction.rb

@@ -0,0 +1,146 @@
+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 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

data/lib/authorize_net/authorize_net.rb

@@ -0,0 +1,154 @@
+# :title: Authorize.Net Ruby SDK
+# The core AuthoizeNet module. The entire SDK is name-spaced inside of this module.
+module AuthorizeNet
+  
+  # Some type conversion routines that will be injected into our Transaction/Response
+  # classes.
+  module TypeConversions
+    
+    API_FIELD_PREFIX = 'x_'
+    
+    # Coverts a value received from Authorize.Net into a boolean if possible. This
+    # is designed to handle the wide range of boolean formats that Authorize.Net uses.
+    def value_to_boolean(value)
+      case value
+      when "TRUE", "T", "YES", "Y", "1", "true"
+        true
+      when "FALSE", "F", "NO", "N", "0", "false"
+        false
+      else
+        value
+      end
+    end
+    
+    # Converts a boolean into an Authorize.Net boolean value string. This
+    # is designed to handle the wide range of boolean formats that Authorize.Net
+    # uses. If bool isn't a Boolean, its converted to a string and passed along.
+    def boolean_to_value(bool)
+      case bool
+      when TrueClass, FalseClass
+        bool ? 'TRUE' : 'FALSE'
+      else
+        bool.to_s
+      end
+    end
+    
+    # Coverts a value received from Authorize.Net into a BigDecimal.
+    def value_to_decimal(value)
+      BigDecimal.new(value)
+    end
+    
+    # Converts a BigDecimal (or Float) into an Authorize.Net float value string. If float isn't
+    # a BigDecimal (or Float), its converted to a string and passed along.
+    def decimal_to_value(float)
+      case float
+      when Float
+        "%0.2f" % float
+      when BigDecimal
+        float.truncate(2).to_s('F')
+      else
+        float.to_s
+      end
+    end
+    
+    # Coverts a value received from Authorize.Net into a Date.
+    def value_to_date(value)
+      Date.strptime(value, '%Y-%m-%d')
+    end
+    
+    # Converts a Date (or DateTime, or Time) into an Authorize.Net date value string. If date isn't
+    # a Date (or DateTime, or Time), its converted to a string and passed along.
+    def date_to_value(date)
+      case date
+      when Date, DateTime, Time
+        date.strftime('%Y-%m-%d')
+      else
+        date.to_s
+      end
+    end
+    
+    # Coverts a value received from Authorize.Net into a DateTime.
+    def value_to_datetime(value)
+      DateTime.strptime(value, '%Y-%m-%dT%H:%M:%S')
+    end
+    
+    # Converts a Date (or DateTime, or Time) into an Authorize.Net datetime value string. If date isn't
+    # a Date (or DateTime, or Time), its converted to a string and passed along.
+    def datetime_to_value(datetime)
+      case datetime
+      when Date, DateTime
+        datetime.new_offset(0).strftime('%Y-%m-%dT%H:%M:%SZ')
+      when Time
+        datetime.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
+      else
+        datetime.to_s
+      end
+    end
+    
+    # Coverts a value received from Authorize.Net into an Integer.
+    def value_to_integer(value)
+      value.to_s.to_i
+    end
+    
+    # Coverts an Integer into an Authorize.Net integer string.
+    def integer_to_value(int)
+      int.to_s
+    end
+    
+    # Converts a key value pair into a HTTP POST parameter. The key is prefixed
+    # with key_prefix when being converted to a parameter name.
+    def to_param(key, value, key_prefix = API_FIELD_PREFIX)
+      key_str = "#{key_prefix}#{key}="
+      if value.kind_of?(Array) 
+        (value.collect do |v|
+          key_str + CGI::escape(v.to_s)
+        end).join('&')
+      else
+        key_str + CGI::escape(value.to_s)
+      end
+    end
+    
+    
+    # Converts an internal field name (Symbol) into an external field name (Symbol)
+    # that can be consumed by the Authorize.Net API.
+    def to_external_field(key)
+      (API_FIELD_PREFIX + key.to_s).to_sym
+    end
+    
+    # Converts an external field name (Symbol) into an internal field name (Symbol). This
+    # is the exact inverse of to_external_field. Running to_internal_field(to_external_field(:foo))
+    # would return :foo back.
+    def to_internal_field(key)
+      k_str = key.to_s
+      k_str[API_FIELD_PREFIX.length..k_str.length].to_sym
+    end
+  end
+  
+  # Provides some basic methods used by the various model classes.
+  module Model
+    
+    # The constructor for models. Takes any of the supported attributes
+    # as key/value pairs.
+    def initialize(fields = {})
+      fields.each do |k, v|
+        method_name = (k.to_s + '=').to_sym
+        if self.respond_to?(method_name)
+          self.send(method_name, v)
+        end
+      end
+    end
+    
+    def to_a
+      [self]
+    end
+    
+    #:enddoc:
+    protected
+    
+    def handle_multivalue_hashing(obj)
+      obj.to_a.collect(&:to_hash)
+    end
+    
+  end
+
+end

data/lib/authorize_net/cim/customer_profile.rb

@@ -0,0 +1,19 @@
+module AuthorizeNet::CIM
+  
+  # Models a customer profile.
+  class CustomerProfile < AuthorizeNet::Customer
+    
+    include AuthorizeNet::Model
+    
+    attr_accessor :customer_profile_id, :payment_profiles
+    
+    def to_hash
+      hash = super
+      hash.delete_if {|k, v| v.nil?}
+      hash[:payment_profiles] = handle_multivalue_hashing(@payment_profiles)
+      hash
+    end
+    
+  end
+  
+end

data/lib/authorize_net/cim/payment_profile.rb

@@ -0,0 +1,37 @@
+module AuthorizeNet::CIM
+  # Models a payment profile.
+  class PaymentProfile
+    
+    module CustomerType
+      INDIVIDUAL = 'individual'
+      BUSINESS = 'business'
+    end
+    
+    include AuthorizeNet::Model
+    
+    attr_accessor :cust_type, :billing_address, :payment_method, :customer_payment_profile_id
+    
+    def cust_type=(type) #:nodoc:
+      case type
+      when :business
+        @cust_type = CustomerType::BUSINESS
+      when :individual
+        @cust_type = CustomerType::INDIVIDUAL
+      else
+        @cust_type = type
+      end
+    end
+    
+    def to_hash
+      hash = {
+        :cust_type => @cust_type,
+        :customer_payment_profile_id => @customer_payment_profile_id
+      }
+      hash.delete_if {|k, v| v.nil?}
+      hash.merge!(@billing_address.to_hash) unless @billing_address.nil?
+      hash.merge!(@payment_method.to_hash) unless @payment_method.nil?
+      hash
+    end
+    
+  end
+end