authorizenet_blaq 1.9.3

data/lib/authorize_net/api/transaction.rb

@@ -0,0 +1,258 @@
+module AuthorizeNet::API
+  class Transaction < ApiTransaction    
+    attr_accessor :access_token
+	attr_accessor :options_OAuth
+	
+    def initialize(api_login_id = nil, api_transaction_key = nil, options = {})
+       super
+    end
+       
+    # This request enables you to create a transaction, and optional customer profile.
+    # NOTE: Tokenized transactions (e.g. Apple Pay), or PayPal should not be used to
+    # create payment profiles.
+    # 
+    # See spec/api_spec.rb for usage examples
+    def create_transaction(request)  
+      make_request(request,CreateTransactionResponse,Type::API_CREATE_TRANSACTION)
+    end
+    
+    # This request enables you to create a recurring billing subscription
+    # 
+    # See spec/api_spec.rb for usage examples
+    def create_subscription(request)
+      make_request(request,ARBCreateSubscriptionResponse,Type::API_CREATE_SUBSCRIPTION)
+    end
+
+    # This request enables you to update a recurring billing subscription
+    # 
+    # See spec/api_spec.rb for usage examples
+    def update_subscription(request)
+      make_request(request,ARBUpdateSubscriptionResponse,Type::API_UPDATE_SUBSCRIPTION)
+    end
+
+    # This request enables you to cancel a recurring billing subscription
+    # 
+    # See spec/api_spec.rb for usage examples
+    def cancel_subscription(request)
+      make_request(request,ARBCancelSubscriptionResponse,Type::API_CANCEL_SUBSCRIPTION)
+    end
+
+    # This request enables you to get a recurring billing subscription status
+    # 
+    # See spec/api_spec.rb for usage examples
+    def get_subscription_status(request)
+      make_request(request,ARBGetSubscriptionStatusResponse,Type::API_GET_SUBSCRIPTION_STATUS)
+    end
+
+    # This request enables you to get a list of all recurring billing subscriptions
+    # 
+    # See spec/api_spec.rb for usage examples
+    def get_subscription_list(request)
+      make_request(request,ARBGetSubscriptionListResponse,Type::API_GET_SUBSCRIPTION_LIST)
+    end
+
+    # This request enables you to create a customer profile
+    # 
+    # See spec/api_spec.rb for usage examples
+    def create_customer_profile(request)
+      make_request(request,CreateCustomerProfileResponse,Type::API_CREATE_CUSTOMER_PROFILE)
+    end
+    
+    # This request enables you to retrieve a customer profile
+    # 
+    # See spec/api_spec.rb for usage examples
+    def get_customer_profile(request)
+      make_request(request,GetCustomerProfileResponse,Type::API_GET_CUSTOMER_PROFILE)
+    end
+
+
+    # This request enables you to retrieve all customer profile ids
+    # 
+    # See spec/api_spec.rb for usage examples
+    def get_customer_profile_ids(request)
+      make_request(request,GetCustomerProfileIdsResponse,Type::API_GET_CUSTOMER_PROFILE_IDS)
+    end
+
+    # This request enables you to update a customer profile
+    # 
+    # See spec/api_spec.rb for usage examples
+    def update_customer_profile(request)
+      make_request(request,UpdateCustomerProfileResponse,Type::API_UPDATE_CUSTOMER_PROFILE)
+    end
+
+    # This request enables you to delete a customer profile
+    # 
+    # See spec/api_spec.rb for usage examples
+    def delete_customer_profile(request)
+      make_request(request,DeleteCustomerProfileResponse,Type::API_DELETE_CUSTOMER_PROFILE)
+    end
+   
+    # This request enables you to create a customer payment profile
+    # 
+    # See spec/api_spec.rb for usage examples
+    def create_customer_payment_profile(request)
+      make_request(request,CreateCustomerPaymentProfileResponse,Type::API_CREATE_CUSTOMER_PAYMENT_PROFILE)
+    end
+    
+    # This request enables you to retrieve a customer payment profile
+    # 
+    # See spec/api_spec.rb for usage examples
+    def get_customer_payment_profile(request)
+      make_request(request,GetCustomerPaymentProfileResponse,Type::API_GET_CUSTOMER_PAYMENT_PROFILE)
+    end
+
+    # This request enables you to update a customer payment profile
+    # 
+    # See spec/api_spec.rb for usage examples
+    def update_customer_payment_profile(request)
+      make_request(request,UpdateCustomerPaymentProfileResponse,Type::API_UPDATE_CUSTOMER_PAYMENT_PROFILE)
+    end
+
+    # This request enables you to delete a customer payment profile
+    # 
+    # See spec/api_spec.rb for usage examples
+    def delete_customer_payment_profile(request)
+      make_request(request,DeleteCustomerPaymentProfileResponse,Type::API_DELETE_CUSTOMER_PAYMENT_PROFILE)
+    end
+
+    # This request enables you to create a customer shipping profile
+    # 
+    # See spec/api_spec.rb for usage examples
+    def create_customer_shipping_profile(request)
+      make_request(request,CreateCustomerShippingAddressResponse,Type::API_CREATE_CUSTOMER_SHIPPING_PROFILE)
+    end
+    
+    # This request enables you to retrieve a customer shipping profile
+    # 
+    # See spec/api_spec.rb for usage examples
+    def get_customer_shipping_profile(request)
+      make_request(request,GetCustomerShippingAddressResponse,Type::API_GET_CUSTOMER_SHIPPING_PROFILE)
+    end
+
+    # This request enables you to update a customer shipping profile
+    # 
+    # See spec/api_spec.rb for usage examples
+    def update_customer_shipping_profile(request)
+      make_request(request,UpdateCustomerShippingAddressResponse,Type::API_UPDATE_CUSTOMER_SHIPPING_PROFILE)
+    end
+
+    # This request enables you to delete a customer shipping profile
+    # 
+    # See spec/api_spec.rb for usage examples
+    def delete_customer_shipping_profile(request)
+      make_request(request,DeleteCustomerShippingAddressResponse,Type::API_DELETE_CUSTOMER_SHIPPING_PROFILE)
+    end
+   
+
+    # This request enables you to create a customer profile, payment profile,
+    # and shipping profile from an existing successful transaction.
+    # NOTE: Tokenized transactions (e.g. Apple Pay), or PayPal should not be used to
+    # create payment profiles.
+    # 
+    # See spec/api_spec.rb for usage examples
+    def create_customer_profile_from_transaction(request)
+      make_request(request,CreateProfileResponse,Type::API_CREATE_CUSTOMER_PROFILE_FROM_TRANSACTION)
+    end
+
+    # This request enables you to decrypt a payment data blob.
+    # 
+    # See spec/api_spec.rb for usage examples
+    def decrypt_payment_data(request)
+      make_request(request,DecryptPaymentDataResponse,Type::API_DECRYPT_PAYMENT_DATA)
+    end
+
+    # This request enables confirm authentication values
+    # 
+    # See spec/api_spec.rb for usage examples
+    def authenticate_test_request(request)            
+      make_request(request,AuthenticateTestResponse,Type::API_AUTHENTICATE_TEST_REQUEST)
+    end
+    
+    # This request enables you to get batch statistics details
+    # 
+    # See spec/api_spec.rb for usage examples
+    def get_batch_statistics(request)            
+      make_request(request,GetBatchStatisticsResponse,Type::API_GET_BATCH_STATISTICS)
+    end
+
+    # This request enables you to get batch transaction details
+    # 
+    # See spec/api_spec.rb for usage examples
+    def get_transaction_details(request)            
+      make_request(request,GetTransactionDetailsResponse,Type::API_GET_TRANSACTION_DETAILS)
+    end
+
+    # This request enables you to get batch settled transaction details
+    # 
+    # See spec/api_spec.rb for usage examples
+    def get_settled_batch_list(request)            
+      make_request(request,GetSettledBatchListResponse,Type::API_GET_SETTLED_BATCH_LIST)
+    end
+
+    # This request enables you to get batch unsettled transaction details
+    # 
+    # See spec/api_spec.rb for usage examples
+    def get_unsettled_transaction_list(request)            
+      make_request(request,GetUnsettledTransactionListResponse,Type::API_GET_UNSETTLED_TRANSACTION_LIST)
+    end
+  
+  # This request enables confirm authentication values
+    # 
+    # See spec/api_spec.rb for usage examples
+    def get_hosted_profile_page(request)            
+      make_request(request,GetHostedProfilePageResponse,Type::API_GET_HOSTED_PROFILE_PAGE)
+    end
+    
+    # This request enables you to update split tender group
+    # 
+    # See spec/api_spec.rb for usage examples
+    def update_split_tender_group(request)  
+      make_request(request,UpdateSplitTenderGroupResponse,Type::API_UPDATE_SPLIT_TENDER_GROUP)
+    end
+    
+    # This request enables you to get customer payment profile list
+    # 
+    # See spec/api_spec.rb for usage examples
+    def get_customer_payment_profile_list(request)  
+      make_request(request,GetCustomerPaymentProfileListResponse,Type::API_GET_CUSTOMER_PAYMENT_PROFILE_LIST)
+    end
+    
+    # This request enables you to get ARB Subscription
+    # 
+    # See spec/api_spec.rb for usage examples
+    def arb_get_subscription_request(request)  
+      make_request(request,ARBGetSubscriptionResponse,Type::API_ARB_GET_SUBSCRIPTION_REQUEST)
+    end
+
+    # This request enables you to get transaction list
+    #
+    # See spec/api_spec.rb for usage examples
+    def get_transaction_list(request)
+      make_request(request,GetTransactionListResponse,Type::API_GET_TRANSACTION_LIST)
+    end
+    
+    # This request enables you to validate customer payment profile
+    # 
+    # See spec/api_spec.rb for usage examples
+    def validate_customer_payment_profile(request)  
+      make_request(request,ValidateCustomerPaymentProfileResponse,Type::API_VALIDATE_CUSTOMER_PAYMENT_PROFILE)
+    end
+
+    def get_merchant_details(request)  
+      make_request(request,GetMerchantDetailsResponse,Type::API_GET_MERCHANT_DETAILS)
+    end
+
+    def get_hosted_payment_page(request)  
+      make_request(request,GetHostedPaymentPageResponse,Type::API_GET_HOSTED_PAYMENT_PAGE)
+    end
+
+    def update_held_transaction(request)  
+      make_request(request,UpdateHeldTransactionResponse,Type::API_UDPATE_HELD_TRANSACTION)
+    end
+
+    def get_transaction_list_for_customer(request)
+      make_request(request,GetTransactionListResponse,Type::API_GET_TRANSACTION_LIST_FOR_CUSTOMER)
+    end
+	
+  end
+end

data/lib/authorize_net/arb/fields.rb

@@ -0,0 +1,24 @@
+module AuthorizeNet::ARB
+    module Fields
+      EntityDescription = Struct.new(:node_structure, :entity_class, :arg_mapping)
+
+      SUBSCRIPTION_DETAIL_ENTITY_DESCRIPTION = EntityDescription.new(
+        [
+          {:id => :id},
+          {:name => :name},
+          {:status => :status},
+	  {:createTimeStampUTC => :create_time_stamp_utc},
+	  {:firstName => :first_name},
+	  {:lastName => :last_name},
+	  {:totalOccurrences => :total_occurrences},
+	  {:pastOccurrences => :past_occurrences},
+	  {:paymentMethod => :payment_method},
+	  {:accountNumber => :account_number},
+	  {:invoice => :invoice},
+	  {:amount => :amount},
+          {:currencyId => :currency_id}
+        ],
+        AuthorizeNet::ARB::SubscriptionDetail
+      )
+    end
+end

data/lib/authorize_net/arb/paging.rb

@@ -0,0 +1,33 @@
+module AuthorizeNet::ARB
+
+  class Paging
+
+    # Models Paging
+    include AuthorizeNet::Model
+    
+    attr_accessor :offset,:limit
+
+    # Initializes Paging object. 
+    #
+    # Typical usage:
+    #  paging = AuthorizeNet::ARB::Paging.new(1,1000)
+    #
+    # Valid values for offset: 1 to 100000
+    # Valid values for limit: 1 to 1000
+    #
+    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

@@ -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/sorting.rb

@@ -0,0 +1,43 @@
+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.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 total_occurrences setter to provide support for :unlimited shortcut.
+    def total_occurrences=(new_total_occurrences) #:nodoc:
+      if new_total_occurrences == :unlimited
+        @total_occurrences = UNLIMITED_OCCURRENCES
+      else
+        @total_occurrences = new_total_occurrences
+      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/subscription_detail.rb

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

data/lib/authorize_net/arb/subscription_list_response.rb

@@ -0,0 +1,43 @@
+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'))
+
+        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