vaulted_billing 1.1.6 → 1.2.0

data/lib/vaulted_billing/gateways/bogus/failure.rb

@@ -0,0 +1,43 @@
+module VaultedBilling
+  module Gateways
+    class Bogus
+      module Failure
+        FailureCards = %w(4222222222222)
+        FailureMessages = [
+          'This transaction has been declined.',
+          'This transaction has been approved.',
+          'This transaction has been declined.',
+          'This transaction has been declined.',
+          'This transaction has been declined.',
+          'A valid amount is required.',
+          'The credit card number is invalid.',
+          'The credit card expiration date is invalid',
+          'The credit card has expired.',
+          'The ABA code is invalid',
+          'The account number is invalid.',
+          'A duplicate transaction has been submitted.',
+        ]
+
+
+        protected
+
+
+        def error_code_for(credit_card, amount)
+          amount.to_i
+        end
+
+        def failure_message_for(credit_card, amount)
+          FailureMessages[error_code_for(credit_card, amount)] || FailureMessages.first
+        end
+
+        def success?(credit_card, amount)
+          credit_card.nil? || !failure?(credit_card, amount)
+        end
+
+        def failure?(credit_card, amount)
+          !credit_card.nil? && FailureCards.include?(credit_card.card_number)
+        end
+      end
+    end
+  end
+end

data/lib/vaulted_billing/gateways/bogus.rb

@@ -5,15 +5,49 @@ module VaultedBilling
     ##
     # The Bogus gateway should only be used for simple interface testing
     # to the VaultedBilling library.  All customer and credit card requests
-    # will always return successfully.  All transaction requests (purchase,
-    # authorize, capture, etc.) will always return successfully.
+    # will always return successfully. All transaction requests (purchase,
+    # authorize, capture, etc.) will always return successfully, unless a
+    # failure credit card number is given.
+    #
+    # If a failure credit card number is given, then the transaction amount is
+    # used to determine the error message and code to return.
     #
     # The primary purpose of this gateway is to provide you with an end
     # point for testing your interface, as well as a fairly reasonable
     # gateway for performing simple, non-network based tests against.
     #
+    # To test failure messages, use the credit card number '4222222222222'.
+    # This card number will trigger failed transaction responses from the
+    # Bogus gateway for purchase and authorize requests.  In order to receive a
+    # specific error message / code, set the transaction amount to one of the
+    # following:
+    #
+    #  0: 'This transaction has been declined.'
+    #  1: 'This transaction has been approved.'
+    #  2: 'This transaction has been declined.'
+    #  3: 'This transaction has been declined.'
+    #  4: 'This transaction has been declined.'
+    #  5: 'A valid amount is required.'
+    #  6: 'The credit card number is invalid.'
+    #  7: 'The credit card expiration date is invalid'
+    #  8: 'The credit card has expired.'
+    #  9: 'The ABA code is invalid'
+    #  10: 'The account number is invalid.'
+    #  11: 'A duplicate transaction has been submitted.'
+    #
+    # Example:
+    #
+    #   customer = Customer.new(...)
+    #   credit_card = CreditCard.new(:card_number => '4222222222222')
+    #   bogus.purchase(customer, credit_card, 6.00)
+    #   # => Failed transaction, 'The credit card number is invalid.'
+    #
     class Bogus
+      autoload :Failure, 'vaulted_billing/gateways/bogus/failure'
+
       include VaultedBilling::Gateway
+      include VaultedBilling::Gateways::Bogus::Failure
+
 
       def initialize(options = {})
       end
@@ -43,23 +77,23 @@ module VaultedBilling
       end
 
       def authorize(customer, credit_card, amount, options = {})
-        transaction_response
+        transaction_response credit_card, amount
       end
 
       def purchase(customer, credit_card, amount, options = {})
-        transaction_response
+        transaction_response credit_card, amount
       end
 
       def void(transaction_id, options = {})
-        transaction_response
+        transaction_response nil, nil
       end
 
       def capture(transaction_id, amount, options = {})
-        transaction_response
+        transaction_response nil, amount
       end
 
       def refund(transaction_id, amount, options = {})
-        transaction_response
+        transaction_response nil, amount
       end
 
 
@@ -70,13 +104,22 @@ module VaultedBilling
         Digest::MD5.hexdigest("--#{Time.now.to_f}--#{rand(1_000_000)}--#{rand(1_000_000)}--")
       end
 
-      def transaction_response
-        respond_with VaultedBilling::Transaction.new({
-          :id => new_identifier,
-          :authcode => new_identifier[0..5],
-          :masked_card_number => "XXXX%04d" % [rand(9999)]
-        })
+      def transaction_response(credit_card, amount)
+        attributes = { :id => new_identifier }
+        attributes[:masked_card_number] = "XXXX%04d" % [credit_card ? credit_card.card_number.to_s[-4..-1].to_i : rand(9999)]
+        success = true
+        error_code = nil
+
+        if success?(credit_card, amount)
+          attributes[:authcode] = new_identifier[0..5]
+        else
+          success = false
+          attributes[:message] = failure_message_for(credit_card, amount)
+          error_code = error_code_for(credit_card, amount)
+        end
+
+        respond_with VaultedBilling::Transaction.new(attributes), :success => success, :error_code => error_code
       end
     end
   end
-end
+end

data/lib/vaulted_billing/gateways/ipcommerce.rb

@@ -17,6 +17,11 @@ module VaultedBilling
     #
     class Ipcommerce
       include VaultedBilling::Gateway
+      
+      AvsResults = [
+        "Not Set", "Not Included", "Match", "No Match", "Issuer Not Certified",
+        "No Response From Card Association", "Unknown Response From Card Association", "Not Verified", "Bad Format"
+      ]
 
       Countries = %w(
         !! AF AX AL DZ AS AD AO AI AQ
@@ -44,7 +49,7 @@ module VaultedBilling
         TG TK TP TO TT TN TR TM TC TV
         UG UA AE GB US UM UY UZ VU VE
         VN VG VI WF EH YE YU ZM ZW
-      )
+      ).freeze
        
       Companies = {
         2 => /^4\d{12}(\d{3})?$/, # Visa
@@ -54,6 +59,12 @@ module VaultedBilling
         6 => /^(6011|65\d{2}|64[4-9]\d)\d{12}|(62\d{14})$/, # Discover
         7 => /^35(28|29|[3-8]\d)\d{12}$/ # JCB
       }.freeze
+
+      CVResults = [
+        "Not Set", "Match", "No Match", "Not Processed", "Not Included",
+        "No Code Present", "Should Have Been Present", "Issuer Not Certified", "Invalid", "No Response",
+        "Not Applicable"
+      ].freeze
       
       Endpoints = [
         "https://cws-01.ipcommerce.com/REST/2.0.15/",
@@ -325,32 +336,28 @@ module VaultedBilling
 
       def card_data(credit_card)
         return nil if credit_card.nil?
-        
-        if credit_card.vault_id.present?
-          { :PaymentAccountDataToken => credit_card.vault_id }
-        else
-          {
-            :CardData => { 
-              :CardholderName => credit_card.name_on_card,
-              :CardType => self.class.credit_card_type_id(credit_card.card_number),
-              :Expire => credit_card.expires_on.try(:strftime, "%m%y"),
-              :PAN => credit_card.card_number
-            },
-            :CardSecurityData => {
-              :AVSData => {
-                :CardholderName => credit_card.name_on_card,
-                :Street => credit_card.street_address.try(:[], (0...20)),
-                :City => credit_card.locality,
-                :StateProvince => credit_card.region,
-                :PostalCode => credit_card.postal_code.try(:gsub, /[^[:alnum:]]/, '').try(:[], (0...8)),
-                :Country => credit_card.country.try(:to_ipcommerce_id),
-                :Phone => credit_card.phone
-              }.select { |k, v| !v.nil? },
-              :CVDataProvided => credit_card.cvv_number.nil? ? nil : 2,
-              :CVData => credit_card.cvv_number
-            }.select { |k, v| !v.nil? }
-          }
-        end
+        { 
+          'PaymentAccountDataToken' => credit_card.vault_id,
+          'CardData' => { 
+            'CardholderName' => credit_card.name_on_card.blank? ? nil : credit_card.name_on_card,
+            'CardType' => self.class.credit_card_type_id(credit_card.card_number),
+            'Expire' => credit_card.expires_on.try(:strftime, "%m%y"),
+            'PAN' => credit_card.vault_id ? ("XXXXXXXXXXX%04d" % [credit_card.card_number[-4..-1]]) : credit_card.card_number
+          },
+          'CardSecurityData' => {
+            'AVSData' => {
+              'CardholderName' => credit_card.name_on_card.blank? ? nil : credit_card.name_on_card,
+              'Street' => credit_card.street_address.try(:[], (0...20)),
+              'City' => credit_card.locality,
+              'StateProvince' => credit_card.region,
+              'PostalCode' => credit_card.postal_code.try(:gsub, /[^[:alnum:]]/, '').try(:[], (0...8)),
+              'Country' => credit_card.country.try(:to_ipcommerce_id),
+              'Phone' => credit_card.phone
+            }.select { |k, v| !v.nil? },
+            'CVDataProvided' => credit_card.cvv_number.nil? ? nil : 2,
+            'CVData' => credit_card.cvv_number
+          }.select { |k, v| v.is_a?(Hash) ? !v.empty? : !v.nil?  }
+        }.select { |k, v| !v.nil? }
       end
 
       private
@@ -411,8 +418,8 @@ module VaultedBilling
         if response.success?
           Transaction.new({
             :id => response.body['TransactionId'],
-            :avs_response => response.body['AVSResult'] == 1,
-            :cvv_response => response.body['CVResult'] == 1,
+            :avs_response => parse_avs_result(response.body['AVSResult']),
+            :cvv_response => parse_cvv_result(response.body['CVResult']),
             :authcode => response.body['ApprovalCode'],
             :message => response.body['StatusMessage'],
             :code => response.body['Status'],
@@ -433,6 +440,25 @@ module VaultedBilling
         end
       end
 
+      def parse_avs_result(result)
+        return nil unless result
+        { 
+          :result => result['ActualResult'],
+          :address => AvsResults[result['AddressResult']],
+          :country => AvsResults[result['CountryResult']],
+          :state => AvsResults[result['StateResult']],
+          :postal_code => AvsResults[result['PostalCodeResult']],
+          :phone => AvsResults[result['PhoneResult']],
+          :cardholder_name => AvsResults[result['CardholderNameResult']],
+          :city => AvsResults[result['CityResult']]
+        }
+      end
+
+      def parse_cvv_result(result)
+        return nil unless result
+        CVResults[result]
+      end
+
       def parse_validation_errors(response)
         errors = ChainableHash.new.merge(response.body || {})
         if errors['ErrorResponse']['ValidationErrors'].present?

data/lib/vaulted_billing/gateways.rb

@@ -1,6 +1,6 @@
 module VaultedBilling
   module Gateways
-    Dir[File.expand_path(File.join(File.dirname(__FILE__), 'gateways', '**', '*.rb'))].each do |file|
+    Dir[File.expand_path(File.join(File.dirname(__FILE__), 'gateways', '*.rb'))].each do |file|
       filename = File.basename(file, '.rb')
       gateway_class = filename.camelize
       autoload gateway_class, file

data/lib/vaulted_billing/version.rb

@@ -1,3 +1,3 @@
 module VaultedBilling
-  Version = '1.1.6'
+  Version = '1.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vaulted_billing
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-13 00:00:00.000000000Z
+date: 2011-10-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2156657220 !ruby/object:Gem::Requirement
+  requirement: &2165677980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2.3'
   type: :runtime
   prerelease: false
-  version_requirements: *2156657220
+  version_requirements: *2165677980
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &2156656760 !ruby/object:Gem::Requirement
+  requirement: &2165677480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 2.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *2156656760
+  version_requirements: *2165677480
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &2156656300 !ruby/object:Gem::Requirement
+  requirement: &2165677000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156656300
+  version_requirements: *2165677000
 - !ruby/object:Gem::Dependency
   name: multi_xml
-  requirement: &2156655840 !ruby/object:Gem::Requirement
+  requirement: &2165676400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156655840
+  version_requirements: *2165676400
 - !ruby/object:Gem::Dependency
   name: countries
-  requirement: &2156655460 !ruby/object:Gem::Requirement
+  requirement: &2165675960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156655460
+  version_requirements: *2165675960
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156654920 !ruby/object:Gem::Requirement
+  requirement: &2165675180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *2156654920
+  version_requirements: *2165675180
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &2156654420 !ruby/object:Gem::Requirement
+  requirement: &2165674380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '1.7'
   type: :development
   prerelease: false
-  version_requirements: *2156654420
+  version_requirements: *2165674380
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2156653960 !ruby/object:Gem::Requirement
+  requirement: &2165673920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: '1.6'
   type: :development
   prerelease: false
-  version_requirements: *2156653960
+  version_requirements: *2165673920
 - !ruby/object:Gem::Dependency
   name: factory_girl
-  requirement: &2156653500 !ruby/object:Gem::Requirement
+  requirement: &2165667440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *2156653500
+  version_requirements: *2165667440
 - !ruby/object:Gem::Dependency
   name: faker
-  requirement: &2156653040 !ruby/object:Gem::Requirement
+  requirement: &2165666980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *2156653040
+  version_requirements: *2165666980
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156652560 !ruby/object:Gem::Requirement
+  requirement: &2165666520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,10 +131,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *2156652560
+  version_requirements: *2165666520
 - !ruby/object:Gem::Dependency
   name: watchr
-  requirement: &2156628320 !ruby/object:Gem::Requirement
+  requirement: &2165666100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156628320
+  version_requirements: *2165666100
 - !ruby/object:Gem::Dependency
   name: open4
-  requirement: &2156627860 !ruby/object:Gem::Requirement
+  requirement: &2165665620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156627860
+  version_requirements: *2165665620
 - !ruby/object:Gem::Dependency
   name: appraisal
-  requirement: &2156627380 !ruby/object:Gem::Requirement
+  requirement: &2165665200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,7 +164,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156627380
+  version_requirements: *2165665200
 description: Several card processors and gateways support offloading the storage of
   credit card information onto their service.  This offloads PCI compliance to the
   gateway rather than keeping it with each retailer.  This library abstracts the interface
@@ -184,6 +184,7 @@ files:
 - lib/vaulted_billing/errors.rb
 - lib/vaulted_billing/gateway.rb
 - lib/vaulted_billing/gateways/authorize_net_cim.rb
+- lib/vaulted_billing/gateways/bogus/failure.rb
 - lib/vaulted_billing/gateways/bogus.rb
 - lib/vaulted_billing/gateways/ipcommerce.rb
 - lib/vaulted_billing/gateways/nmi_customer_vault.rb