braintree 2.10.0 → 4.26.0

data/lib/braintree/credit_card.rb

@@ -1,7 +1,7 @@
 module Braintree
-  # See http://www.braintreepaymentsolutions.com/docs/ruby
   class CreditCard
-    include BaseModule # :nodoc:
+    include BaseModule
+    include Braintree::Util::TokenEquality
 
     module CardType
       AmEx = "American Express"
@@ -9,8 +9,10 @@ module Braintree
       ChinaUnionPay = "China UnionPay"
       DinersClubInternational = "Diners Club"
       Discover = "Discover"
+      Elo = "Elo"
       JCB = "JCB"
       Laser = "Laser"
+      UK_Maestro = "UK Maestro"
       Maestro = "Maestro"
       MasterCard = "MasterCard"
       Solo = "Solo"
@@ -21,136 +23,134 @@ module Braintree
       All = constants.map { |c| const_get(c) }
     end
 
-    module CustomerLocation
-      International = "international"
-      US = "us"
-    end
-
-    attr_reader :billing_address, :bin, :card_type, :cardholder_name, :created_at, :customer_id, :expiration_month,
-      :expiration_year, :last_4, :subscriptions, :token, :updated_at
-
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/create
-    def self.create(attributes)
-      Configuration.gateway.credit_card.create(attributes)
-    end
+    module DebitNetwork
+      Accel = "ACCEL"
+      Maestro = "MAESTRO"
+      Nyce = "NYCE"
+      Pulse = "PULSE"
+      Star = "STAR"
+      Star_Access = "STAR_ACCESS"
 
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/create
-    def self.create!(attributes)
-      return_object_or_raise(:credit_card) { create(attributes) }
+      All = constants.map { |c| const_get(c) }
     end
 
-    # Deprecated. Use Braintree::TransparentRedirect.url
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/create_tr
-    def self.create_credit_card_url
-      warn "[DEPRECATED] CreditCard.create_credit_card_url is deprecated. Please use TransparentRedirect.url"
-      Configuration.gateway.credit_card.create_credit_card_url
+    module CustomerLocation
+      International = "international"
+      US = "us"
     end
 
-    # Deprecated. Use Braintree::TransparentRedirect.confirm
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/create_tr
-    def self.create_from_transparent_redirect(query_string)
-      warn "[DEPRECATED] CreditCard.create_from_transparent_redirect is deprecated. Please use TransparentRedirect.confirm"
-      Configuration.gateway.credit_card.create_from_transparent_redirect(query_string)
+    module CardTypeIndicator
+      Yes = "Yes"
+      No = "No"
+      Unknown = "Unknown"
     end
 
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
+    Commercial = CountryOfIssuance = Debit = DurbinRegulated = Healthcare =
+      IssuingBank = Payroll = Prepaid = PrepaidReloadable = ProductId = CardTypeIndicator
+
+    attr_reader :billing_address
+    attr_reader :bin
+    attr_reader :card_type
+    attr_reader :cardholder_name
+    attr_reader :commercial
+    attr_reader :country_of_issuance
+    attr_reader :created_at
+    attr_reader :customer_id
+    attr_reader :debit
+    attr_reader :durbin_regulated
+    attr_reader :expiration_month
+    attr_reader :expiration_year
+    attr_reader :healthcare
+    attr_reader :image_url
+    attr_reader :issuing_bank
+    attr_reader :last_4
+    attr_reader :payroll
+    attr_reader :prepaid
+    attr_reader :prepaid_reloadable
+    attr_reader :product_id
+    attr_reader :subscriptions
+    attr_reader :token
+    attr_reader :unique_number_identifier
+    attr_reader :updated_at
+    attr_reader :verification
+
+    def self.create(*args)
+      Configuration.gateway.credit_card.create(*args)
+    end
+
+    def self.create!(*args)
+      Configuration.gateway.credit_card.create!(*args)
+    end
+
+    # NEXT_MAJOR_VERSION remove this method
+    # CreditCard.credit has been deprecated in favor of Transaction.credit
     def self.credit(token, transaction_attributes)
+      warn "[DEPRECATED] CreditCard.credit is deprecated. Use Transaction.credit instead"
       Transaction.credit(transaction_attributes.merge(:payment_method_token => token))
     end
 
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
+    # NEXT_MAJOR_VERSION remove this method
+    # CreditCard.credit has been deprecated in favor of Transaction.credit
     def self.credit!(token, transaction_attributes)
+      warn "[DEPRECATED] CreditCard.credit is deprecated. Use Transaction.credit instead"
       return_object_or_raise(:transaction) { credit(token, transaction_attributes) }
     end
 
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/delete
-    def self.delete(token)
-      Configuration.gateway.credit_card.delete(token)
+    def self.delete(*args)
+      Configuration.gateway.credit_card.delete(*args)
+    end
+
+    def self.expired(*args)
+      Configuration.gateway.credit_card.expired(*args)
     end
 
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/search
-    def self.expired(options = {})
-      Configuration.gateway.credit_card.expired(options)
+    def self.expiring_between(*args)
+      Configuration.gateway.credit_card.expiring_between(*args)
     end
 
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/search
-    def self.expiring_between(start_date, end_date, options = {})
-      Configuration.gateway.credit_card.expiring_between(start_date, end_date, options)
+    def self.find(*args)
+      Configuration.gateway.credit_card.find(*args)
     end
 
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/search
-    def self.find(token)
-      Configuration.gateway.credit_card.find(token)
+    def self.from_nonce(*args)
+      Configuration.gateway.credit_card.from_nonce(*args)
     end
 
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
+    # NEXT_MAJOR_VERSION remove this method
+    # CreditCard.sale has been deprecated in favor of Transaction.sale
     def self.sale(token, transaction_attributes)
+      warn "[DEPRECATED] CreditCard.sale is deprecated. Use Transaction.sale instead"
       Configuration.gateway.transaction.sale(transaction_attributes.merge(:payment_method_token => token))
     end
 
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
+    # NEXT_MAJOR_VERSION remove this method
+    # CreditCard.sale has been deprecated in favor of Transaction.sale
     def self.sale!(token, transaction_attributes)
+      warn "[DEPRECATED] CreditCard.sale is deprecated. Use Transaction.sale instead"
       return_object_or_raise(:transaction) { sale(token, transaction_attributes) }
     end
 
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/update
-    def self.update(token, attributes)
-      Configuration.gateway.credit_card.update(token, attributes)
+    def self.update(*args)
+      Configuration.gateway.credit_card.update(*args)
     end
 
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/update
-    def self.update!(token, attributes)
-      return_object_or_raise(:credit_card) { update(token, attributes) }
+    def self.update!(*args)
+      Configuration.gateway.credit_card.update!(*args)
     end
 
-    # Deprecated. Use Braintree::TransparentRedirect.confirm
-    #
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/update_tr
-    def self.update_from_transparent_redirect(query_string)
-      warn "[DEPRECATED] CreditCard.update_via_transparent_redirect_request is deprecated. Please use TransparentRedirect.confirm"
-      Configuration.gateway.credit_card.update_from_transparent_redirect(query_string)
-    end
-
-    # Deprecated. Use Braintree::TransparentRedirect.url
-    #
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/update_tr
-    def self.update_credit_card_url
-      warn "[DEPRECATED] CreditCard.update_credit_card_url is deprecated. Please use TransparentRedirect.url"
-      Configuration.gateway.credit_card.update_credit_card_url
-    end
-
-    def initialize(gateway, attributes) # :nodoc:
+    def initialize(gateway, attributes)
       @gateway = gateway
       set_instance_variables_from_hash(attributes)
       @billing_address = attributes[:billing_address] ? Address._new(@gateway, attributes[:billing_address]) : nil
       @subscriptions = (@subscriptions || []).map { |subscription_hash| Subscription._new(@gateway, subscription_hash) }
+      @verification = _most_recent_verification(attributes)
     end
 
-    # Deprecated. Use Braintree::CreditCard.credit
-    #
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
-    def credit(transaction_attributes)
-      warn "[DEPRECATED] credit as an instance method is deprecated. Please use CreditCard.credit"
-      @gateway.transaction.credit(transaction_attributes.merge(:payment_method_token => token))
+    def _most_recent_verification(attributes)
+      sorted_verifications = (attributes[:verifications] || []).sort_by { |verification| verification[:created_at] }.reverse.first
+      CreditCardVerification._new(sorted_verifications) if sorted_verifications
     end
 
-    # Deprecated. Use Braintree::CreditCard.credit!
-    #
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
-    def credit!(transaction_attributes)
-      warn "[DEPRECATED] credit! as an instance method is deprecated. Please use CreditCard.credit!"
-      return_object_or_raise(:transaction) { credit(transaction_attributes) }
-    end
-
-    # Deprecated. Use Braintree::CreditCard.delete
-    #
-    # http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/delete
-    def delete
-      warn "[DEPRECATED] delete as an instance method is deprecated. Please use CreditCard.delete"
-      @gateway.credit_card.delete(token)
-    end
-
-    # Returns true if this credit card is the customer's default.
     def default?
       @default
     end
@@ -160,12 +160,11 @@ module Braintree
       "#{expiration_month}/#{expiration_year}"
     end
 
-    # Returns true if the credit card is expired.
     def expired?
       @expired
     end
 
-    def inspect # :nodoc:
+    def inspect
       first = [:token]
       order = first + (self.class._attributes - first)
       nice_attributes = order.map do |attr|
@@ -178,61 +177,37 @@ module Braintree
       "#{bin}******#{last_4}"
     end
 
-    # Deprecated. Use Braintree::CreditCard.sale
-    #
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
-    def sale(transaction_attributes)
-      warn "[DEPRECATED] sale as an instance method is deprecated. Please use CreditCard.sale"
-      @gateway.transaction.sale(transaction_attributes.merge(:payment_method_token => token))
-    end
-
-    # Deprecated. Use Braintree::CreditCard.sale!
-    #
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
-    def sale!(transaction_attributes)
-      warn "[DEPRECATED] sale! as an instance method is deprecated. Please use CreditCard.sale!"
-      return_object_or_raise(:transaction) { sale(transaction_attributes) }
-    end
-
-    # Deprecated. Use Braintree::CreditCard.update
-    #
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/update
-    def update(attributes)
-      warn "[DEPRECATED] update as an instance method is deprecated. Please use CreditCard.update"
-      result = @gateway.credit_card.update(token, attributes)
-      if result.success?
-        copy_instance_variables_from_object result.credit_card
-      end
-      result
+    def nonce
+      @nonce ||= PaymentMethodNonce.create(token)
     end
 
-    # Deprecated. Use Braintree::CreditCard.update!
-    #
-    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/update
-    def update!(attributes)
-      warn "[DEPRECATED] update! as an instance method is deprecated. Please use CreditCard.update!"
-      return_object_or_raise(:credit_card) { update(attributes) }
+    # NEXT_MAJOR_VERSION can this be removed? Venmo SDK integration is no more
+    # Returns true if the card is associated with Venmo SDK
+    # NEXT_MAJOR_VERSION Remove this method
+    # The old venmo SDK class has been deprecated
+    def venmo_sdk?
+      warn "[DEPRECATED] The Venmo SDK integration is Unsupported. Please update your integration to use Pay with Venmo instead."
+      @venmo_sdk
     end
 
-    # Returns true if +other+ is a +CreditCard+ with the same token.
-    def ==(other)
-      return false unless other.is_a?(CreditCard)
-      token == other.token
+    def is_network_tokenized?
+      @is_network_tokenized
     end
 
     class << self
       protected :new
     end
 
-    def self._attributes # :nodoc:
+    def self._attributes
       [
-        :billing_address, :bin, :card_type, :cardholder_name, :created_at, :customer_id, :expiration_month,
-        :expiration_year, :last_4, :token, :updated_at
+        :billing_address, :bin, :card_type, :cardholder_name, :commercial, :country_of_issuance, :created_at, :customer_id,
+        :debit, :durbin_regulated, :expiration_month, :expiration_year, :healthcare, :image_url, :is_network_tokenized?,
+        :issuing_bank, :last_4, :payroll, :prepaid, :prepaid_reloadable, :product_id, :token, :updated_at
       ]
     end
 
-    def self._new(*args) # :nodoc:
-      self.new *args
+    def self._new(*args)
+      self.new(*args)
     end
   end
 end

data/lib/braintree/credit_card_gateway.rb

@@ -1,87 +1,136 @@
 module Braintree
-  class CreditCardGateway # :nodoc:
+  class CreditCardGateway
+    include BaseModule
+
     def initialize(gateway)
       @gateway = gateway
       @config = gateway.config
+      @config.assert_has_access_token_or_keys
     end
 
     def create(attributes)
       if attributes.has_key?(:expiration_date) && (attributes.has_key?(:expiration_month) || attributes.has_key?(:expiration_year))
         raise ArgumentError.new("create with both expiration_month and expiration_year or only expiration_date")
       end
+      # NEXT_MAJOR_VERSION remove this check
+      if attributes.has_key?(:venmo_sdk_payment_method_code) || attributes.has_key?(:venmo_sdk_session)
+        warn "[DEPRECATED] The Venmo SDK integration is Unsupported. Please update your integration to use Pay with Venmo instead."
+      end
       Util.verify_keys(CreditCardGateway._create_signature, attributes)
       _do_create("/payment_methods", :credit_card => attributes)
     end
 
-    # Deprecated
-    def create_credit_card_url
-      "#{@config.base_merchant_url}/payment_methods/all/create_via_transparent_redirect_request"
+    def create!(*args)
+      return_object_or_raise(:credit_card) { create(*args) }
+    end
+
+    # NEXT_MAJOR_VERSION remove this method
+    # CreditCard.credit has been deprecated in favor of Transaction.credit
+    def credit(token, transaction_attributes)
+      warn "[DEPRECATED] CreditCard.credit is deprecated. Use Transaction.credit instead"
+      @gateway.transaction.credit(transaction_attributes.merge(:payment_method_token => token))
     end
 
-    # Deprecated
-    def create_from_transparent_redirect(query_string)
-      params = @gateway.transparent_redirect.parse_and_validate_query_string query_string
-      _do_create("/payment_methods/all/confirm_transparent_redirect_request", :id => params[:id])
+     # NEXT_MAJOR_VERSION remove this method
+     # CreditCard.credit has been deprecated in favor of Transaction.credit
+    def credit!(*args)
+      warn "[DEPRECATED] CreditCard.credit is deprecated. Use Transaction.credit instead"
+      return_object_or_raise(:transaction) { credit(*args) }
     end
 
     def delete(token)
-      @config.http.delete("/payment_methods/#{token}")
+      @config.http.delete("#{@config.base_merchant_path}/payment_methods/credit_card/#{token}")
     end
 
     def expired(options = {})
-      response = @config.http.post("/payment_methods/all/expired_ids")
+      response = @config.http.post("#{@config.base_merchant_path}/payment_methods/all/expired_ids")
       ResourceCollection.new(response) { |ids| _fetch_expired(ids) }
     end
 
     def expiring_between(start_date, end_date, options = {})
-      formatted_start_date = start_date.strftime('%m%Y')
-      formatted_end_date = end_date.strftime('%m%Y')
-      response = @config.http.post("/payment_methods/all/expiring_ids?start=#{formatted_start_date}&end=#{formatted_end_date}")
+      formatted_start_date = start_date.strftime("%m%Y")
+      formatted_end_date = end_date.strftime("%m%Y")
+      response = @config.http.post("#{@config.base_merchant_path}/payment_methods/all/expiring_ids?start=#{formatted_start_date}&end=#{formatted_end_date}")
       ResourceCollection.new(response) { |ids| _fetch_expiring_between(formatted_start_date, formatted_end_date, ids) }
     end
 
     def find(token)
-      response = @config.http.get "/payment_methods/#{token}"
+      raise ArgumentError if token.nil? || token.to_s.strip == ""
+      response = @config.http.get("#{@config.base_merchant_path}/payment_methods/credit_card/#{token}")
       CreditCard._new(@gateway, response[:credit_card])
     rescue NotFoundError
       raise NotFoundError, "payment method with token #{token.inspect} not found"
     end
 
-    def update(token, attributes)
-      Util.verify_keys(CreditCardGateway._update_signature, attributes)
-      _do_update(:put, "/payment_methods/#{token}", :credit_card => attributes)
+    def from_nonce(nonce)
+      raise ArgumentError if nonce.nil? || nonce.to_s.strip == ""
+      response = @config.http.get("#{@config.base_merchant_path}/payment_methods/from_nonce/#{nonce}")
+      CreditCard._new(@gateway, response[:credit_card])
+    rescue NotFoundError
+      raise NotFoundError, "nonce #{nonce.inspect} locked, consumed, or not found"
     end
 
-    # Deprecated
-    def update_from_transparent_redirect(query_string)
-      warn "[DEPRECATED] CreditCard.update_via_transparent_redirect_request is deprecated. Please use TransparentRedirect.confirm"
-      params = @gateway.transparent_redirect.parse_and_validate_query_string query_string
-      _do_update(:post, "/payment_methods/all/confirm_transparent_redirect_request", :id => params[:id])
+    def update(token, attributes)
+      # NEXT_MAJOR_VERSION remove this check
+      if attributes.has_key?(:venmo_sdk_payment_method_code) || attributes.has_key?(:venmo_sdk_session)
+        warn "[DEPRECATED] The Venmo SDK integration is Unsupported. Please update your integration to use Pay with Venmo instead."
+      end
+      Util.verify_keys(CreditCardGateway._update_signature, attributes)
+      _do_update(:put, "/payment_methods/credit_card/#{token}", :credit_card => attributes)
     end
 
-    # Deprecated
-    def update_credit_card_url
-      warn "[DEPRECATED] CreditCard.update_credit_card_url is deprecated. Please use TransparentRedirect.url"
-      "#{@config.base_merchant_url}/payment_methods/all/update_via_transparent_redirect_request"
+    def update!(*args)
+      return_object_or_raise(:credit_card) { update(*args) }
     end
 
-    def self._create_signature # :nodoc:
+    def self._create_signature
       _signature(:create)
     end
 
-    def self._update_signature # :nodoc:
+    def self._update_signature
       _signature(:update)
     end
 
-    def self._signature(type) # :nodoc:
+    def self._signature(type)
       billing_address_params = AddressGateway._shared_signature
+      # NEXT_MAJOR_VERSION Remove venmo_sdk_session
+      # The old venmo SDK class has been deprecated
+      options = [
+        :fail_on_duplicate_payment_method,
+        :fail_on_duplicate_payment_method_for_customer,
+        :make_default,
+        :skip_advanced_fraud_checking,
+        :venmo_sdk_session, # Deprecated
+        :verification_account_type,
+        :verification_amount,
+        :verification_currency_iso_code,
+        :verification_merchant_account_id,
+        :verify_card
+      ]
+      # NEXT_MAJOR_VERSION Remove venmo_sdk_payment_method_code
+      # The old venmo SDK class has been deprecated
       signature = [
-        :billing_address_id, :cardholder_name, :cvv, :expiration_date,
-        :expiration_month, :expiration_year, :number, :token,
-        {:options => [:make_default, :verification_merchant_account_id, :verify_card]},
+        :billing_address_id, :cardholder_name, :cvv, :expiration_date, :expiration_month,
+        :expiration_year, :number, :token, :venmo_sdk_payment_method_code, # Deprecated
+        :device_data, :payment_method_nonce,
+        {:external_vault => [:network_transaction_id]},
+        {:options => options},
         {:billing_address => billing_address_params}
       ]
 
+      signature << {
+        :three_d_secure_pass_thru => [
+          :eci_flag,
+          :cavv,
+          :xid,
+          :three_d_secure_version,
+          :authentication_response,
+          :directory_response,
+          :cavv_algorithm,
+          :ds_transaction_id,
+        ]
+      }
+
       case type
       when :create
         signature << :customer_id
@@ -94,8 +143,8 @@ module Braintree
       return signature
     end
 
-    def _do_create(url, params=nil) # :nodoc:
-      response = @config.http.post url, params
+    def _do_create(path, params=nil)
+      response = @config.http.post("#{@config.base_merchant_path}#{path}", params)
       if response[:credit_card]
         SuccessfulResult.new(:credit_card => CreditCard._new(@gateway, response[:credit_card]))
       elsif response[:api_error_response]
@@ -105,8 +154,8 @@ module Braintree
       end
     end
 
-    def _do_update(http_verb, url, params) # :nodoc:
-      response = @config.http.send http_verb, url, params
+    def _do_update(http_verb, path, params)
+      response = @config.http.send(http_verb, "#{@config.base_merchant_path}#{path}", params)
       if response[:credit_card]
         SuccessfulResult.new(:credit_card => CreditCard._new(@gateway, response[:credit_card]))
       elsif response[:api_error_response]
@@ -116,16 +165,16 @@ module Braintree
       end
     end
 
-    def _fetch_expired(ids) # :nodoc:
-      response = @config.http.post("/payment_methods/all/expired", :search => {:ids => ids})
+    def _fetch_expired(ids)
+      response = @config.http.post("#{@config.base_merchant_path}/payment_methods/all/expired", :search => {:ids => ids})
       attributes = response[:payment_methods]
       Util.extract_attribute_as_array(attributes, :credit_card).map { |attrs| CreditCard._new(@gateway, attrs) }
     end
 
-    def _fetch_expiring_between(formatted_start_date, formatted_end_date, ids) # :nodoc:
+    def _fetch_expiring_between(formatted_start_date, formatted_end_date, ids)
       response = @config.http.post(
-        "/payment_methods/all/expiring?start=#{formatted_start_date}&end=#{formatted_end_date}",
-        :search => {:ids => ids}
+        "#{@config.base_merchant_path}/payment_methods/all/expiring?start=#{formatted_start_date}&end=#{formatted_end_date}",
+        :search => {:ids => ids},
       )
       attributes = response[:payment_methods]
       Util.extract_attribute_as_array(attributes, :credit_card).map { |attrs| CreditCard._new(@gateway, attrs) }