vaulted_billing 1.0.2 → 1.1.0

data/README.md

@@ -1,4 +1,4 @@
-# VaultedBilling
+# VaultedBilling [![Build status][ci-image]][ci]
 
 VaultedBilling is an abstraction library for use when working with "vaulted" payment processors.  These processors store your customer's data - being their credit card number, verification number, name, address, and more - on their systems to alleviate your need for expensive software auditing, hardware security, and more.  In nearly all cases, these processors provide you a unique customer and/or payment token in exchange for your actual customer payment information.  Then, all current and future interactions with the payment processor on behalf of the customer are made using their identifiers, rather than credit card details.
 
@@ -12,8 +12,8 @@ Since you only store identifiers on your end, you are only responsible for: 1) t
 
 VaultedBilling supports the following payment providers:
 
-* [Authorize.net Customer Information Manager](http://www.authorize.net/solutions/merchantsolutions/merchantservices/cim/)
-* [Network Merchant Inc. Customer Vault](https://www.nmi.com/newsmedia/index.php?ann_id=14)
+* [Authorize.net Customer Information Manager][authorize-net-cim]
+* [Network Merchant Inc. Customer Vault][nmi-vault]
 
 VaultedBilling also supports the following fictitious payment provider for testing purposes:
 
@@ -25,7 +25,7 @@ VaultedBilling should be installed as a RubyGem dependency:
 
     gem install vaulted_billing
 
-If your application uses [Bundler](http://gembundler.com/), then add the following to your Gemfile:
+If your application uses [Bundler][bundler], then add the following to your Gemfile:
 
     gem 'vaulted_billing'
 
@@ -33,37 +33,39 @@ If your application uses [Bundler](http://gembundler.com/), then add the followi
 
 Simple (not particularly clean or recommended) example:
 
-    require 'vaulted_billing'
-    
-    bogus = VaultedBilling::Gateways::Bogus.new(:username => 'Foo', :password => 'Bar')
-    customer = VaultedBilling::Customer.new(:email => "foo@example.com")
-    credit_card = VaultedBilling::CreditCard.new({
-      :card_number => '4111111111111111',
-      :cvv_number => '123',
-      :expires_on => Date.today + 1.year
-    })
-    
-    bogus.add_customer(customer).tap do |customer_response|
-      if customer_response.success?
-        # normally, you'd store the vault_id on your local customer object,
-        # because you use this when referencing that customer in the future.
-        # But, for now, we'll just:
-        customer.vault_id = customer_response.vault_id
-
-        bogus.add_customer_credit_card(customer, credit_card).tap do |credit_response|
-          if response.success?
-            # Again, same as above, but for the credit card information:
-            credit_card.vault_id = credit_response.vault_id
-
-            puts "Wow! We stored a the payment credentials successfully!"
-
-            if bogus.purchase(customer, credit_card, 10.00).success?
-              puts "OMG WE'RE RICH!"
-            end
-          end
+```ruby
+require 'vaulted_billing'
+
+bogus = VaultedBilling::Gateways::Bogus.new(:username => 'Foo', :password => 'Bar')
+customer = VaultedBilling::Customer.new(:email => "foo@example.com")
+credit_card = VaultedBilling::CreditCard.new({
+  :card_number => '4111111111111111',
+  :cvv_number => '123',
+  :expires_on => Date.today + 1.year
+})
+
+bogus.add_customer(customer).tap do |customer_response|
+  if customer_response.success?
+    # normally, you'd store the vault_id on your local customer object,
+    # because you use this when referencing that customer in the future.
+    # But, for now, we'll just:
+    customer.vault_id = customer_response.vault_id
+
+    bogus.add_customer_credit_card(customer, credit_card).tap do |credit_response|
+      if response.success?
+        # Again, same as above, but for the credit card information:
+        credit_card.vault_id = credit_response.vault_id
+
+        puts "Wow! We stored a the payment credentials successfully!"
+
+        if bogus.purchase(customer, credit_card, 10.00).success?
+          puts "OMG WE'RE RICH!"
         end
       end
     end
+  end
+end
+```
 
 ### Real world example
 
@@ -71,6 +73,14 @@ TODO: Real world example coming soon.
 
 ## Testing
 
-When you're manually testing your application - meaning Development mode - it is often best to actually have a "sandbox" or "test" account with your payment processor.  In this mode, you should use those credentials with VaultedBilling and indicate to VaultedBilling that the processor is in test mode, either by setting it in the VaultedBilling::Configuration (see Configuration) or when you instantiate your Gateway.  You should note that all gateways, except for the Bogus gateway, attempt to open network connections when in use.  So, if you are testing with them (which is suggested), you should look into an HTTP mocking library like [VCR](https://github.com/myronmarston/vcr) with [WebMock](https://github.com/bblimke/webmock).
+When you're manually testing your application - meaning Development mode - it is often best to actually have a "sandbox" or "test" account with your payment processor.  In this mode, you should use those credentials with VaultedBilling and indicate to VaultedBilling that the processor is in test mode, either by setting it in the VaultedBilling::Configuration (see Configuration) or when you instantiate your Gateway.  You should note that all gateways, except for the Bogus gateway, attempt to open network connections when in use.  So, if you are testing with them (which is suggested), you should look into an HTTP mocking library like [VCR][vcr] with [WebMock][webmock].
 
-Strictly for testing interaction with the VaultedBilling library, there is a "Bogus" gateway provided.  This processor will always successfully store customer and credit card information and return their identifiers.  It will also always respond successfully to transaction (authorize, capture, refund, void, etc.) requests.  This processor does not attempt to make network requests to any 3rd parties.  It is not recommended that you solely test against this gateway, as you will find that your actual payment processor may have quirks which are unique and cannot be easily replicated.
+Strictly for testing interaction with the VaultedBilling library, there is a "Bogus" gateway provided.  This processor will always successfully store customer and credit card information and return their identifiers.  It will also always respond successfully to transaction (authorize, capture, refund, void, etc.) requests.  This processor does not attempt to make network requests to any 3rd parties.  It is not recommended that you solely test against this gateway, as you will find that your actual payment processor may have quirks which are unique and cannot be easily replicated.
+
+[ci]: http://travis-ci.org/envylabs/vaulted_billing
+[ci-image]: https://secure.travis-ci.org/envylabs/vaulted_billing.png
+[authorize-net-cim]: http://www.authorize.net/solutions/merchantsolutions/merchantservices/cim/
+[nmi-vault]: https://www.nmi.com/newsmedia/index.php?ann_id=14
+[bundler]: http://gembundler.com/
+[vcr]: https://github.com/myronmarston/vcr
+[webmock]: https://github.com/bblimke/webmock

data/lib/vaulted_billing/chainable_hash.rb

@@ -0,0 +1,7 @@
+module VaultedBilling
+  class ChainableHash < ::Hash
+    def initialize
+      super { |hash, key| ChainableHash.new }
+    end
+  end
+end

data/lib/vaulted_billing/configuration.rb

@@ -53,13 +53,14 @@ module VaultedBilling
       options = options.with_indifferent_access
       self.test_mode = options.has_key?(:test_mode) ? options[:test_mode] : true
       @_authorize_net_cim = GatewayConfiguration.new(options[:authorize_net_cim]) if options[:authorize_net_cim]
+      @_ipcommerce = GatewayConfiguration.new(options[:ipcommerce]) if options[:ipcommerce]
       @_nmi_customer_vault = GatewayConfiguration.new(options[:nmi_customer_vault]) if options[:nmi_customer_vault]
       @_bogus = GatewayConfiguration.new(options[:bogus]) if options[:bogus]
       @ca_file = File.expand_path('../../ext/cacert.pem', __FILE__)
     end
 
     ##
-    # Returns a VaultedBilling::Configuration::GatewayConfiguration 
+    # Returns a VaultedBilling::Configuration::GatewayConfiguration
     # instance to be used for defining default settings for the
     # Authorize.net CIM gateway.
     #
@@ -68,7 +69,16 @@ module VaultedBilling
     end
 
     ##
-    # Returns a VaultedBilling::Configuration::GatewayConfiguration 
+    # Returns a VaultedBilling::Configuration::GatewayConfiguration
+    # instance to be used for defining default settings for the
+    # IP Commerce gateway.
+    #
+    def ipcommerce
+      @_ipcommerce ||= GatewayConfiguration.new
+    end
+
+    ##
+    # Returns a VaultedBilling::Configuration::GatewayConfiguration
     # instance to be used for defining default settings for the
     # NMI Customer Vault gateway.
     #
@@ -77,7 +87,7 @@ module VaultedBilling
     end
 
     ##
-    # Returns a VaultedBilling::Configuration::GatewayConfiguration 
+    # Returns a VaultedBilling::Configuration::GatewayConfiguration
     # instance to be used for defining default settings for the
     # Bogus gateway.
     #

data/lib/vaulted_billing/errors.rb

@@ -0,0 +1,4 @@
+module VaultedBilling
+  Error = Class.new(RuntimeError)
+  CredentialError = Class.new(Error)
+end

data/lib/vaulted_billing/gateway.rb

@@ -34,15 +34,15 @@ module VaultedBilling
       raise NotImplementedError
     end
 
-    def authorize(customer, credit_card, amount)
+    def authorize(customer, credit_card, amount, options = {})
       raise NotImplementedError
     end
 
-    def capture(transaction_id, amount)
+    def capture(transaction_id, amount, options = {})
       raise NotImplementedError
     end
 
-    def purchase(customer, credit_card, amount)
+    def purchase(customer, credit_card, amount, options = {})
       raise NotImplementedError
     end
 
@@ -50,7 +50,7 @@ module VaultedBilling
       raise NotImplementedError
     end
 
-    def void(transaction_id)
+    def void(transaction_id, options = {})
       raise NotImplementedError
     end
 

data/lib/vaulted_billing/gateways/authorize_net_cim.rb

@@ -1,4 +1,5 @@
 require 'builder'
+require 'multi_xml'
 
 module VaultedBilling
   module Gateways
@@ -8,17 +9,17 @@ module VaultedBilling
     #
     class AuthorizeNetCim
       include VaultedBilling::Gateway
-      include VaultedBilling::HttpsInterface
+      attr_accessor :use_test_uri
 
       def initialize(options = {})
-        self.test_uri = 'https://apitest.authorize.net/xml/v1/request.api'
-        self.live_uri = 'https://api.authorize.net/xml/v1/request.api'
+        @test_uri = 'https://apitest.authorize.net/xml/v1/request.api'
+        @live_uri = 'https://api.authorize.net/xml/v1/request.api'
 
         options = options.symbolize_keys!
         @login = options[:username] || VaultedBilling.config.authorize_net_cim.username
         @password = options[:password] || VaultedBilling.config.authorize_net_cim.password
         @raw_options = options[:raw_options] || VaultedBilling.config.authorize_net_cim.raw_options
-        self.use_test_uri = options.has_key?(:test) ? options[:test] : (VaultedBilling.config.authorize_net_cim.test_mode || VaultedBilling.config.test_mode)
+        @use_test_uri = options.has_key?(:test) ? options[:test] : (VaultedBilling.config.authorize_net_cim.test_mode || VaultedBilling.config.test_mode)
       end
 
       def add_customer(customer)
@@ -29,7 +30,7 @@ module VaultedBilling
             xml.email customer.email if customer.email
           end
         end
-        result = post_data(data)
+        result = http.post(data)
         respond_with(customer, result, :success => result.success?) do |c|
           c.vault_id = result.body['createCustomerProfileResponse']['customerProfileId'] if c.success?
         end
@@ -37,34 +38,38 @@ module VaultedBilling
 
       def update_customer(customer)
         customer = customer.to_vaulted_billing
-        result = post_data(build_request('updateCustomerProfileRequest') { |xml|
+        data = build_request('updateCustomerProfileRequest') { |xml|
           xml.tag!('profile') {
             xml.email customer.email
             xml.customerProfileId customer.vault_id
           }
-        })
+        }
+        result = http.post(data)
         respond_with(customer, result, :success => result.success?)
       end
 
       def remove_customer(customer)
         customer = customer.to_vaulted_billing
-        result = post_data(build_request('deleteCustomerProfileRequest') { |xml|
+        data = build_request('deleteCustomerProfileRequest') { |xml|
           xml.customerProfileId customer.vault_id
-        })
+        }
 
+        result = http.post(data)
         respond_with(customer, result, :success => result.success?)
       end
 
       def add_customer_credit_card(customer, credit_card)
         customer = customer.to_vaulted_billing
         credit_card = credit_card.to_vaulted_billing
-        result = post_data(build_request('createCustomerPaymentProfileRequest') { |xml|
+        data = build_request('createCustomerPaymentProfileRequest') { |xml|
           xml.customerProfileId customer.vault_id
           xml.paymentProfile do
             billing_info!(xml, customer, credit_card)
             credit_card_info!(xml, customer, credit_card)
           end
-        })
+        }
+
+        result = http.post(data)
         respond_with(credit_card, result, :success => result.success?) do |c|
           c.vault_id = result.body['createCustomerPaymentProfileResponse']['customerPaymentProfileId'] if c.success?
         end
@@ -73,31 +78,35 @@ module VaultedBilling
       def update_customer_credit_card(customer, credit_card)
         customer = customer.to_vaulted_billing
         credit_card = credit_card.to_vaulted_billing
-        result = post_data(build_request('updateCustomerPaymentProfileRequest') { |xml|
+        data = build_request('updateCustomerPaymentProfileRequest') { |xml|
           xml.customerProfileId customer.vault_id
           xml.paymentProfile do
             billing_info!(xml, customer, credit_card)
             credit_card_info!(xml, customer, credit_card)
             xml.customerPaymentProfileId credit_card.vault_id
           end
-        })
+        }
+
+        result = http.post(data)
         respond_with(credit_card, result, :success => result.success?)
       end
 
       def remove_customer_credit_card(customer, credit_card)
         customer = customer.to_vaulted_billing
         credit_card = credit_card.to_vaulted_billing
-        result = post_data(build_request('deleteCustomerPaymentProfileRequest') { |xml|
+        data = build_request('deleteCustomerPaymentProfileRequest') { |xml|
           xml.customerProfileId customer.vault_id
           xml.customerPaymentProfileId credit_card.vault_id
-        })
+        }
+
+        result = http.post(data)
         respond_with(credit_card, result, :success => result.success?)
       end
 
-      def purchase(customer, credit_card, amount)
+      def purchase(customer, credit_card, amount, options = {})
         customer = customer.to_vaulted_billing
         credit_card = credit_card.to_vaulted_billing
-        result = post_data(build_request('createCustomerProfileTransactionRequest') { |xml|
+        data = build_request('createCustomerProfileTransactionRequest') { |xml|
           xml.transaction do
             xml.profileTransAuthCapture do
               xml.amount amount
@@ -106,14 +115,16 @@ module VaultedBilling
             end
           end
           xml.extraOptions @raw_options.presence
-        })
+        }
+
+        result = http.post(data)
         respond_with(new_transaction_from_response(result.body), result, :success => result.success?)
       end
 
-      def authorize(customer, credit_card, amount)
+      def authorize(customer, credit_card, amount, options = {})
         customer = customer.to_vaulted_billing
         credit_card = credit_card.to_vaulted_billing
-        result = post_data(build_request('createCustomerProfileTransactionRequest') { |xml|
+        data = build_request('createCustomerProfileTransactionRequest') { |xml|
           xml.transaction do
             xml.profileTransAuthOnly do
               xml.amount amount
@@ -122,12 +133,14 @@ module VaultedBilling
             end
           end
           xml.extraOptions @raw_options.presence
-        })
+        }
+
+        result = http.post(data)
         respond_with(new_transaction_from_response(result.body), result, :success => result.success?)
       end
 
-      def capture(transaction_id, amount)
-        result = post_data(build_request('createCustomerProfileTransactionRequest') { |xml|
+      def capture(transaction_id, amount, options = {})
+        data = build_request('createCustomerProfileTransactionRequest') { |xml|
           xml.transaction do
             xml.profileTransPriorAuthCapture do
               xml.amount amount
@@ -135,12 +148,14 @@ module VaultedBilling
             end
           end
           xml.extraOptions @raw_options.presence
-        })
+        }
+
+        result = http.post(data)
         respond_with(new_transaction_from_response(result.body), result, :success => result.success?)
       end
 
       def refund(transaction_id, amount, options = {})
-        result = post_data(build_request('createCustomerProfileTransactionRequest') { |xml|
+        data = build_request('createCustomerProfileTransactionRequest') { |xml|
           xml.transaction do
             xml.profileTransRefund do
               xml.amount amount
@@ -151,30 +166,33 @@ module VaultedBilling
             end
           end
           xml.extraOptions @raw_options.presence
-        })
+        }
+
+        result = http.post(data)
         respond_with(new_transaction_from_response(result.body), result, :success => result.success?)
       end
 
-      def void(transaction_id)
-        result = post_data(build_request('createCustomerProfileTransactionRequest') { |xml|
+      def void(transaction_id, options = {})
+        data = build_request('createCustomerProfileTransactionRequest') { |xml|
           xml.transaction do
             xml.profileTransVoid do
               xml.transId transaction_id
             end
           end
           xml.extraOptions @raw_options.presence
-        })
+        }
+        
+        result = http.post(data)
         respond_with(new_transaction_from_response(result.body), result, :success => result.success?)
       end
 
+      def uri
+        @use_test_uri ? @test_uri : @live_uri
+      end
 
       protected
 
 
-      def post_data(data, headers = {})
-        super(data, {'Content-Type' => 'text/xml'}.merge(headers))
-      end
-
       def after_post_on_exception(response, exception)
         response.body = {
           'ErrorResponse' => {
@@ -192,7 +210,7 @@ module VaultedBilling
       end
 
       def after_post_on_success(response)
-        response.body = Hash.from_xml(response.body)
+        response.body = MultiXml.parse(response.body)
         response.success = response.body[response.body.keys.first]['messages']['resultCode'] == 'Ok'
       end
 
@@ -208,7 +226,7 @@ module VaultedBilling
         xml.target!
       end
 
-
+      
       private
 
 
@@ -278,7 +296,13 @@ module VaultedBilling
         "XXXX%04d" % [input.to_s[-4..-1].to_i]
       end
 
+      def http
+        VaultedBilling::HTTP.new(self, uri, {
+          :headers => {'Content-Type' => 'text/xml'},
+          :on_success => :after_post_on_success,
+          :on_error => :after_post_on_exception
+        })
+      end      
     end
-
   end
 end