start_activemerchant 1.50.0

data/lib/active_merchant/billing/credit_card_formatting.rb

@@ -0,0 +1,24 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module CreditCardFormatting
+
+      def expdate(credit_card)
+        "#{format(credit_card.month, :two_digits)}#{format(credit_card.year, :two_digits)}"
+      end
+
+      # This method is used to format numerical information pertaining to credit cards.
+      #
+      #   format(2005, :two_digits)  # => "05"
+      #   format(05,   :four_digits) # => "0005"
+      def format(number, option)
+        return '' if number.blank?
+
+        case option
+          when :two_digits  ; sprintf("%.2i", number.to_i)[-2..-1]
+          when :four_digits ; sprintf("%.4i", number.to_i)[-4..-1]
+          else number
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/credit_card_methods.rb

@@ -0,0 +1,195 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    # Convenience methods that can be included into a custom Credit Card object, such as an ActiveRecord based Credit Card object.
+    module CreditCardMethods
+      CARD_COMPANIES = {
+        'visa'               => /^4\d{12}(\d{3})?(\d{3})?$/,
+        'master'             => /^(5[1-5]\d{4}|677189)\d{10}$/,
+        'discover'           => /^(6011|65\d{2}|64[4-9]\d)\d{12}|(62\d{14})$/,
+        'american_express'   => /^3[47]\d{13}$/,
+        'diners_club'        => /^3(0[0-5]|[68]\d)\d{11}$/,
+        'jcb'                => /^35(28|29|[3-8]\d)\d{12}$/,
+        'switch'             => /^6759\d{12}(\d{2,3})?$/,
+        'solo'               => /^6767\d{12}(\d{2,3})?$/,
+        'dankort'            => /^5019\d{12}$/,
+        'maestro'            => /^(5[06-8]|6\d)\d{10,17}$/,
+        'forbrugsforeningen' => /^600722\d{10}$/,
+        'laser'              => /^(6304|6706|6709|6771(?!89))\d{8}(\d{4}|\d{6,7})?$/
+      }
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      def valid_month?(month)
+        (1..12).include?(month.to_i)
+      end
+
+      def valid_expiry_year?(year)
+        (Time.now.year..Time.now.year + 20).include?(year.to_i)
+      end
+
+      def valid_start_year?(year)
+        ((year.to_s =~ /^\d{4}$/) && (year.to_i > 1987))
+      end
+
+      # Credit card providers have 3 digit verification values
+      # This isn't standardised, these are called various names such as
+      # CVC, CVV, CID, CSC and more
+      # See: http://en.wikipedia.org/wiki/Card_security_code
+      # American Express is the exception with 4 digits
+      #
+      # Below are links from the card providers with their requirements
+      # visa:             http://usa.visa.com/personal/security/3-digit-security-code.jsp
+      # master:           http://www.mastercard.com/ca/merchant/en/getstarted/Anatomy_MasterCard.html
+      # jcb:              http://www.jcbcard.com/security/info.html
+      # diners_club:      http://www.dinersclub.com/assets/DinersClub_card_ID_features.pdf
+      # discover:         https://www.discover.com/credit-cards/help-center/glossary.html
+      # american_express: https://online.americanexpress.com/myca/fuidfyp/us/action?request_type=un_fuid&Face=en_US
+      def valid_card_verification_value?(cvv, brand)
+        cvv.to_s =~ /^\d{#{card_verification_value_length(brand)}}$/
+      end
+
+      def card_verification_value_length(brand)
+        brand == 'american_express' ? 4 : 3
+      end
+
+      def valid_issue_number?(number)
+        (number.to_s =~ /^\d{1,2}$/)
+      end
+
+      module ClassMethods
+        # Returns true if it validates. Optionally, you can pass a card brand as an argument and
+        # make sure it is of the correct brand.
+        #
+        # References:
+        # - http://perl.about.com/compute/perl/library/nosearch/P073000.htm
+        # - http://www.beachnet.com/~hstiles/cardtype.html
+        def valid_number?(number)
+          valid_test_mode_card_number?(number) ||
+            valid_card_number_length?(number) &&
+            valid_checksum?(number)
+        end
+
+        # Regular expressions for the known card companies.
+        #
+        # References:
+        # - http://en.wikipedia.org/wiki/Credit_card_number
+        # - http://www.barclaycardbusiness.co.uk/information_zone/processing/bin_rules.html
+        def card_companies
+          CARD_COMPANIES
+        end
+
+        # Returns a string containing the brand of card from the list of known information below.
+        # Need to check the cards in a particular order, as there is some overlap of the allowable ranges
+        #--
+        # TODO Refactor this method. We basically need to tighten up the Maestro Regexp.
+        #
+        # Right now the Maestro regexp overlaps with the MasterCard regexp (IIRC). If we can tighten
+        # things up, we can boil this whole thing down to something like...
+        #
+        #   def brand?(number)
+        #     return 'visa' if valid_test_mode_card_number?(number)
+        #     card_companies.find([nil]) { |brand, regexp| number =~ regexp }.first.dup
+        #   end
+        #
+        def brand?(number)
+          return 'bogus' if valid_test_mode_card_number?(number)
+
+          card_companies.reject { |c,p| c == 'maestro' }.each do |company, pattern|
+            return company.dup if number =~ pattern
+          end
+
+          return 'maestro' if number =~ card_companies['maestro']
+
+          return nil
+        end
+
+        def type?(number)
+          ActiveMerchant.deprecated "CreditCard#type? is deprecated and will be removed from a future release of ActiveMerchant. Please use CreditCard#brand? instead."
+          brand?(number)
+        end
+
+        def first_digits(number)
+          number.to_s.slice(0,6)
+        end
+
+        def last_digits(number)
+          number.to_s.length <= 4 ? number : number.to_s.slice(-4..-1)
+        end
+
+        def mask(number)
+          "XXXX-XXXX-XXXX-#{last_digits(number)}"
+        end
+
+        # Checks to see if the calculated brand matches the specified brand
+        def matching_brand?(number, brand)
+          brand?(number) == brand
+        end
+
+        def matching_type?(number, brand)
+          ActiveMerchant.deprecated "CreditCard#matching_type? is deprecated and will be removed from a future release of ActiveMerchant. Please use CreditCard#matching_brand? instead."
+          matching_brand?(number, brand)
+        end
+
+        private
+
+        def valid_card_number_length?(number) #:nodoc:
+          number.to_s.length >= 12
+        end
+
+        def valid_test_mode_card_number?(number) #:nodoc:
+          ActiveMerchant::Billing::Base.test? &&
+            %w[1 2 3 success failure error].include?(number.to_s)
+        end
+
+        ODD_LUHN_VALUE = {
+          48 => 0,
+          49 => 1,
+          50 => 2,
+          51 => 3,
+          52 => 4,
+          53 => 5,
+          54 => 6,
+          55 => 7,
+          56 => 8,
+          57 => 9,
+          nil => 0
+        }.freeze
+
+        EVEN_LUHN_VALUE = {
+          48 => 0, # 0 * 2
+          49 => 2, # 1 * 2
+          50 => 4, # 2 * 2
+          51 => 6, # 3 * 2
+          52 => 8, # 4 * 2
+          53 => 1, # 5 * 2 - 9
+          54 => 3, # 6 * 2 - 9
+          55 => 5, # etc ...
+          56 => 7,
+          57 => 9,
+        }.freeze
+
+        # Checks the validity of a card number by use of the Luhn Algorithm.
+        # Please see http://en.wikipedia.org/wiki/Luhn_algorithm for details.
+        # This implementation is from the luhn_checksum gem, https://github.com/zendesk/luhn_checksum.
+        def valid_checksum?(numbers) #:nodoc:
+          sum = 0
+
+          odd = true
+          numbers.reverse.bytes.each do |number|
+            if odd
+              odd = false
+              sum += ODD_LUHN_VALUE[number]
+            else
+              odd = true
+              sum += EVEN_LUHN_VALUE[number]
+            end
+          end
+
+          sum % 10 == 0
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/cvv_result.rb

@@ -0,0 +1,38 @@
+module ActiveMerchant
+  module Billing
+    # Result of the Card Verification Value check
+    # http://www.bbbonline.org/eExport/doc/MerchantGuide_cvv2.pdf
+    # Check additional codes from cybersource website
+    class CVVResult
+
+      MESSAGES = {
+        'D'  =>  'CVV check flagged transaction as suspicious',
+        'I'  =>  'CVV failed data validation check',
+        'M'  =>  'CVV matches',
+        'N'  =>  'CVV does not match',
+        'P'  =>  'CVV not processed',
+        'S'  =>  'CVV should have been present',
+        'U'  =>  'CVV request unable to be processed by issuer',
+        'X'  =>  'CVV check not supported for card'
+      }
+
+      def self.messages
+        MESSAGES
+      end
+
+      attr_reader :code, :message
+
+      def initialize(code)
+        @code = (code.blank? ? nil : code.upcase)
+        @message = MESSAGES[@code]
+      end
+
+      def to_hash
+        {
+          'code' => code,
+          'message' => message
+        }
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/gateway.rb

@@ -0,0 +1,291 @@
+require 'net/http'
+require 'net/https'
+require 'active_merchant/billing/response'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    #
+    # == Description
+    # The Gateway class is the base class for all ActiveMerchant gateway implementations.
+    #
+    # The standard list of gateway functions that most concrete gateway subclasses implement is:
+    #
+    # * <tt>purchase(money, credit_card, options = {})</tt>
+    # * <tt>authorize(money, credit_card, options = {})</tt>
+    # * <tt>capture(money, authorization, options = {})</tt>
+    # * <tt>void(identification, options = {})</tt>
+    # * <tt>refund(money, identification, options = {})</tt>
+    # * <tt>verify(credit_card, options = {})</tt>
+    #
+    # Some gateways also support features for storing credit cards:
+    #
+    # * <tt>store(credit_card, options = {})</tt>
+    # * <tt>unstore(identification, options = {})</tt>
+    #
+    # === Gateway Options
+    # The options hash consists of the following options:
+    #
+    # * <tt>:order_id</tt> - The order number
+    # * <tt>:ip</tt> - The IP address of the customer making the purchase
+    # * <tt>:customer</tt> - The name, customer number, or other information that identifies the customer
+    # * <tt>:invoice</tt> - The invoice number
+    # * <tt>:merchant</tt> - The name or description of the merchant offering the product
+    # * <tt>:description</tt> - A description of the transaction
+    # * <tt>:email</tt> - The email address of the customer
+    # * <tt>:currency</tt> - The currency of the transaction.  Only important when you are using a currency that is not the default with a gateway that supports multiple currencies.
+    # * <tt>:billing_address</tt> - A hash containing the billing address of the customer.
+    # * <tt>:shipping_address</tt> - A hash containing the shipping address of the customer.
+    #
+    # The <tt>:billing_address</tt>, and <tt>:shipping_address</tt> hashes can have the following keys:
+    #
+    # * <tt>:name</tt> - The full name of the customer.
+    # * <tt>:company</tt> - The company name of the customer.
+    # * <tt>:address1</tt> - The primary street address of the customer.
+    # * <tt>:address2</tt> - Additional line of address information.
+    # * <tt>:city</tt> - The city of the customer.
+    # * <tt>:state</tt> - The state of the customer.  The 2 digit code for US and Canadian addresses. The full name of the state or province for foreign addresses.
+    # * <tt>:country</tt> - The [ISO 3166-1-alpha-2 code](http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm) for the customer.
+    # * <tt>:zip</tt> - The zip or postal code of the customer.
+    # * <tt>:phone</tt> - The phone number of the customer.
+    #
+    # == Implmenting new gateways
+    #
+    # See the {ActiveMerchant Guide to Contributing}[https://github.com/activemerchant/active_merchant/wiki/Contributing]
+    #
+    class Gateway
+      include PostsData
+      include CreditCardFormatting
+
+      DEBIT_CARDS = [ :switch, :solo ]
+      CURRENCIES_WITHOUT_FRACTIONS = [ 'BIF', 'BYR', 'CLP', 'CVE', 'DJF', 'GNF', 'HUF', 'ISK', 'JPY', 'KMF', 'KRW', 'PYG', 'RWF', 'TWD', 'UGX', 'VND', 'VUV', 'XAF', 'XOF', 'XPF' ]
+
+      CREDIT_DEPRECATION_MESSAGE = "Support for using credit to refund existing transactions is deprecated and will be removed from a future release of ActiveMerchant. Please use the refund method instead."
+      RECURRING_DEPRECATION_MESSAGE = "Recurring functionality in ActiveMerchant is deprecated and will be removed in a future version. Please contact the ActiveMerchant maintainers if you have an interest in taking ownership of a separate gem that continues support for it."
+
+      # == Standardized Error Codes
+      #
+      # :incorrect_number - Card number does not comply with ISO/IEC 7812 numbering standard
+      # :invalid_number - Card number was not matched by processor
+      # :invalid_expiry_date - Expiry date deos not match correct formatting
+      # :invalid_cvc - Security codes does not match correct format (3-4 digits)
+      # :expired_card - Card number is expired
+      # :incorrect_cvc - Secerity code was not matched by the processor
+      # :incorrect_zip - Zip code is not in correct format
+      # :incorrect_address - Billing address info was not matched by the processor
+      # :card_declined - Card number declined by processor
+      # :processing_error - Processor error
+      # :call_issuer - Transaction requires voice authentication, call issuer
+      # :pickup_card - Issuer requests that you pickup the card from merchant
+
+      STANDARD_ERROR_CODE = {
+        :incorrect_number => 'incorrect_number',
+        :invalid_number => 'invalid_number',
+        :invalid_expiry_date => 'invalid_expiry_date',
+        :invalid_cvc => 'invalid_cvc',
+        :expired_card => 'expired_card',
+        :incorrect_cvc => 'incorrect_cvc',
+        :incorrect_zip => 'incorrect_zip',
+        :incorrect_address => 'incorrect_address',
+        :card_declined => 'card_declined',
+        :processing_error => 'processing_error',
+        :call_issuer => 'call_issuer',
+        :pickup_card => 'pick_up_card'
+      }
+
+      cattr_reader :implementations
+      @@implementations = []
+
+      def self.inherited(subclass)
+        super
+        @@implementations << subclass
+      end
+
+      def generate_unique_id
+        SecureRandom.hex(16)
+      end
+
+      # The format of the amounts used by the gateway
+      # :dollars => '12.50'
+      # :cents => '1250'
+      class_attribute :money_format
+      self.money_format = :dollars
+
+      # The default currency for the transactions if no currency is provided
+      class_attribute :default_currency
+
+      # The supported card types for the gateway
+      class_attribute :supported_cardtypes
+      self.supported_cardtypes = []
+
+      class_attribute :homepage_url
+      class_attribute :display_name
+
+      class_attribute :test_url, :live_url
+
+      class_attribute :abstract_class
+
+      self.abstract_class = false
+
+      # The application making the calls to the gateway
+      # Useful for things like the PayPal build notation (BN) id fields
+      class_attribute :application_id, instance_writer: false
+      self.application_id = 'ActiveMerchant'
+
+      attr_reader :options
+
+      # Use this method to check if your gateway of interest supports a credit card of some type
+      def self.supports?(card_type)
+        supported_cardtypes.include?(card_type.to_sym)
+      end
+
+      def self.card_brand(source)
+        result = source.respond_to?(:brand) ? source.brand : source.type
+        result.to_s.downcase
+      end
+
+      def self.non_fractional_currency?(currency)
+        CURRENCIES_WITHOUT_FRACTIONS.include?(currency.to_s)
+      end
+
+      def self.supported_countries=(country_codes)
+        country_codes.each do |country_code|
+          unless ActiveMerchant::Country.find(country_code)
+            raise ActiveMerchant::InvalidCountryCodeError, "No country could be found for the country #{country_code}"
+          end
+        end
+        @supported_countries = country_codes.dup
+      end
+
+      def self.supported_countries
+        @supported_countries ||= []
+      end
+
+      def supported_countries
+        self.class.supported_countries
+      end
+
+      def card_brand(source)
+        self.class.card_brand(source)
+      end
+
+      # Initialize a new gateway.
+      #
+      # See the documentation for the gateway you will be using to make sure there are no other
+      # required options.
+      def initialize(options = {})
+        @options = options
+      end
+
+      # Are we running in test mode?
+      def test?
+        (@options.has_key?(:test) ? @options[:test] : Base.test?)
+      end
+
+      # Does this gateway know how to scrub sensitive information out of HTTP transcripts?
+      def supports_scrubbing?
+        false
+      end
+
+      def scrub(transcript)
+        raise RuntimeError.new("This gateway does not support scrubbing.")
+      end
+
+      protected # :nodoc: all
+
+      def normalize(field)
+        case field
+          when "true"   then true
+          when "false"  then false
+          when ""       then nil
+          when "null"   then nil
+          else field
+        end
+      end
+
+      def user_agent
+        @@ua ||= JSON.dump({
+          :bindings_version => ActiveMerchant::VERSION,
+          :lang => 'ruby',
+          :lang_version => "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
+          :platform => RUBY_PLATFORM,
+          :publisher => 'active_merchant'
+        })
+      end
+
+      def strip_invalid_xml_chars(xml)
+        begin
+          REXML::Document.new(xml)
+        rescue REXML::ParseException
+          xml = xml.gsub(/&(?!(?:[a-z]+|#[0-9]+|x[a-zA-Z0-9]+);)/, '&amp;')
+        end
+
+        xml
+      end
+
+      private # :nodoc: all
+
+      def name
+        self.class.name.scan(/\:\:(\w+)Gateway/).flatten.first
+      end
+
+      def amount(money)
+        return nil if money.nil?
+        cents = if money.respond_to?(:cents)
+          ActiveMerchant.deprecated "Support for Money objects is deprecated and will be removed from a future release of ActiveMerchant. Please use an Integer value in cents"
+          money.cents
+        else
+          money
+        end
+
+        if money.is_a?(String)
+          raise ArgumentError, 'money amount must be a positive Integer in cents.'
+        end
+
+        if self.money_format == :cents
+          cents.to_s
+        else
+          sprintf("%.2f", cents.to_f / 100)
+        end
+      end
+
+      def localized_amount(money, currency)
+        amount = amount(money)
+
+        return amount unless Gateway.non_fractional_currency?(currency)
+
+        if self.money_format == :cents
+          sprintf("%.0f", amount.to_f / 100)
+        else
+          amount.split('.').first
+        end
+      end
+
+      def currency(money)
+        money.respond_to?(:currency) ? money.currency : self.default_currency
+      end
+
+      def truncate(value, max_size)
+        return nil unless value
+        value.to_s[0, max_size]
+      end
+
+      def requires_start_date_or_issue_number?(credit_card)
+        return false if card_brand(credit_card).blank?
+        DEBIT_CARDS.include?(card_brand(credit_card).to_sym)
+      end
+
+      def requires!(hash, *params)
+        params.each do |param|
+          if param.is_a?(Array)
+            raise ArgumentError.new("Missing required parameter: #{param.first}") unless hash.has_key?(param.first)
+
+            valid_options = param[1..-1]
+            raise ArgumentError.new("Parameter: #{param.first} must be one of #{valid_options.to_sentence(:words_connector => 'or')}") unless valid_options.include?(hash[param.first])
+          else
+            raise ArgumentError.new("Missing required parameter: #{param}") unless hash.has_key?(param)
+          end
+        end
+      end
+    end
+  end
+end