4.15.0

Co-authored-by: Sara Vasquez <saravasquez@paypal.com> Co-authored-by: Debra Do <debdo@paypal.com>
braintree · Oct 18, 2023 · 35ec79f · 35ec79f
1 parent c2e1e49
commit 35ec79f
Show file tree

Hide file tree

Showing 111 changed files with 5,043 additions and 4,696 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,16 @@
 # Changelog
 
+## 4.15.0
+- Add `retry_ids`, `retried_transaction_id`, and `debit_network` to `Transaction`
+- Add `evidence_submittable` to Dispute
+- Add `implicitly_vaulted_payment_method_token` and `implicitly_vaulted_payment_method_global_id` to `LocalPaymentDetails`
+- Add `merchant_token_identifier` and `source_card_last4` to ApplePayCard and ApplePayDetails response objects
+- Add `debit_network` to `TransactionSearch`
+- Add `DebitNetwork` enum to `CreditCard`
+- Add `SubscriptionBillingSkipped` webhook notification support
+- Deprecate `three_d_secure_token` in favor of `three_d_secure_authentication_id`
+- Deprecate `venmo_sdk_session`, `venmo_sdk_payment_method_code`, and `venmo_sdk?`
+
 ## 4.14.0
 
 - Add `payment_receipt` object to `Transaction`

diff --git a/lib/braintree/credit_card.rb b/lib/braintree/credit_card.rb
@@ -23,6 +23,16 @@ module CardType
       All = constants.map { |c| const_get(c) }
     end
 
+    module DebitNetwork
+      Accel = "ACCEL"
+      Nyce = "NYCE"
+      Pulse = "PULSE"
+      Star = "STAR"
+      Star_Access = "STAR_ACCESS"
+
+      All = constants.map { |c| const_get(c) }
+    end
+
     module CustomerLocation
       International = "international"
       US = "us"
@@ -160,7 +170,10 @@ def nonce
     end
 
     # 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
 

diff --git a/lib/braintree/credit_card_gateway.rb b/lib/braintree/credit_card_gateway.rb
@@ -12,6 +12,10 @@ 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
@@ -61,6 +65,10 @@ def from_nonce(nonce)
     end
 
     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
@@ -79,21 +87,25 @@ def self._update_signature # :nodoc:
 
     def self._signature(type) # :nodoc:
       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,
         :make_default,
         :skip_advanced_fraud_checking,
-        :venmo_sdk_session,
+        :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, :venmo_sdk_payment_method_code, :device_data,
-        :payment_method_nonce,
+        :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}

diff --git a/lib/braintree/payment_method_gateway.rb b/lib/braintree/payment_method_gateway.rb
@@ -9,6 +9,10 @@ def initialize(gateway)
     end
 
     def create(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(PaymentMethodGateway._create_signature, attributes)
       _do_create("/payment_methods", :payment_method => attributes)
     end
@@ -60,6 +64,10 @@ def find(token)
     end
 
     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(PaymentMethodGateway._update_signature, attributes)
       _do_update(:put, "/payment_methods/any/#{token}", :payment_method => attributes)
     end
@@ -149,11 +157,13 @@ def self._delete_signature # :nodoc:
     def self._signature(type) # :nodoc:
       billing_address_params = AddressGateway._shared_signature
       paypal_options_shipping_signature = AddressGateway._shared_signature
+      # NEXT_MAJOR_VERSION Remove venmo_sdk_session
+      # The old venmo SDK class has been deprecated
       options = [
         :make_default,
         :skip_advanced_fraud_checking,
         :us_bank_account_verification_method,
-        :venmo_sdk_session,
+        :venmo_sdk_session, # Deprecated
         :verification_account_type,
         :verification_amount,
         :verification_currency_iso_code,
@@ -168,10 +178,12 @@ def self._signature(type) # :nodoc:
           {:shipping => paypal_options_shipping_signature}
         ],
       ]
+      # 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, :venmo_sdk_payment_method_code, :device_data,
-        :payment_method_nonce,
+        :expiration_year, :number, :token, :venmo_sdk_payment_method_code, # Deprecated
+        :device_data, :payment_method_nonce,
         {:options => options},
         {:billing_address => billing_address_params}
       ]

diff --git a/lib/braintree/test/nonce.rb b/lib/braintree/test/nonce.rb
@@ -53,6 +53,7 @@ module Nonce
       TransactableCountryOfIssuanceUSA = "fake-valid-country-of-issuance-usa-nonce"
       TransactableCountryOfIssuanceCAD = "fake-valid-country-of-issuance-cad-nonce"
       TransactableIssuingBankNetworkOnly = "fake-valid-issuing-bank-network-only-nonce"
+      TransactablePinlessDebitVisa = "fake-pinless-debit-visa-nonce"
       ProcessorDeclinedVisa = "fake-processor-declined-visa-nonce"
       ProcessorDeclinedMasterCard = "fake-processor-declined-mastercard-nonce"
       ProcessorDeclinedAmEx = "fake-processor-declined-amex-nonce"

diff --git a/lib/braintree/test/venmo_sdk.rb b/lib/braintree/test/venmo_sdk.rb
@@ -1,3 +1,5 @@
+# NEXT_MAJOR_VERSION Remove this class
+# The old venmo SDK class has been deprecated
 module Braintree
   module Test
     module VenmoSDK

diff --git a/lib/braintree/transaction.rb b/lib/braintree/transaction.rb
@@ -91,8 +91,9 @@ module Status
       end
     end
 
-    attr_reader :acquirer_reference_number
     attr_reader :ach_return_code
+    attr_reader :ach_return_responses
+    attr_reader :acquirer_reference_number
     attr_reader :add_ons
     attr_reader :additional_processor_response          # The raw response from the processor.
     attr_reader :amount
@@ -111,6 +112,7 @@ module Status
     attr_reader :custom_fields
     attr_reader :customer_details
     attr_reader :cvv_response_code
+    attr_reader :debit_network
     attr_reader :descriptor
     attr_reader :disbursement_details
     attr_reader :discount_amount
@@ -150,18 +152,18 @@ module Status
     attr_reader :purchase_order_number
     attr_reader :recurring
     attr_reader :refund_ids
-    attr_reader :refunded_transaction_id
     attr_reader :refunded_installments
+    attr_reader :refunded_transaction_id
     attr_reader :retried
     attr_reader :retried_transaction_id                 # the primary/parent transaction id of any retried transaction
     attr_reader :retrieval_reference_number
     attr_reader :retry_ids                              # all retried transactions ids for a primary transaction
     attr_reader :risk_data
     attr_reader :samsung_pay_card_details
     attr_reader :sca_exemption_requested
-    attr_reader :service_fee_amount
     attr_reader :sepa_direct_debit_account_details
     attr_reader :sepa_direct_debit_return_code
+    attr_reader :service_fee_amount
     attr_reader :settlement_batch_id
     attr_reader :shipping_amount
     attr_reader :shipping_details
@@ -179,7 +181,6 @@ module Status
     attr_reader :venmo_account_details
     attr_reader :visa_checkout_card_details
     attr_reader :voice_referral_number
-    attr_reader :ach_return_responses
 
     def self.adjust_authorization(*args)
       Configuration.gateway.transaction.adjust_authorization(*args)

diff --git a/lib/braintree/transaction/credit_card_details.rb b/lib/braintree/transaction/credit_card_details.rb
@@ -64,7 +64,10 @@ def masked_number
         "#{bin}******#{last_4}"
       end
 
+      # 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
 

diff --git a/lib/braintree/transaction/local_payment_details.rb b/lib/braintree/transaction/local_payment_details.rb
@@ -8,6 +8,8 @@ class LocalPaymentDetails
       attr_reader :debug_id
       attr_reader :description
       attr_reader :funding_source
+      attr_reader :implicitly_vaulted_payment_method_global_id
+      attr_reader :implicitly_vaulted_payment_method_token
       attr_reader :payer_id
       attr_reader :payment_id
       attr_reader :refund_from_transaction_fee_amount

diff --git a/lib/braintree/transaction_gateway.rb b/lib/braintree/transaction_gateway.rb
@@ -9,6 +9,14 @@ def initialize(gateway)
     end
 
     def create(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
+      # NEXT_MAJOR_VERSION remove this check
+      if attributes.has_key?(:three_d_secure_token)
+        warn "[DEPRECATED] Passing :three_d_secure_token to create is deprecated. Please use :three_d_secure_authentication_id"
+      end
       Util.verify_keys(TransactionGateway._create_signature, attributes)
       _do_create "/transactions", :transaction => attributes
     end
@@ -183,15 +191,19 @@ def self._clone_signature # :nodoc:
       [:amount, :channel, {:options => [:submit_for_settlement]}]
     end
 
+
+    # NEXT_MAJOR_VERSION Remove venmo_sdk_payment_method_code, venmo_sdk_session, and three_d_secure_token
+    # The old venmo SDK class has been deprecated
+    # three_d_secure_token has been deprecated in favor of three_d_secure_authentication_id
     def self._create_signature # :nodoc:
       [
         :amount, :billing_address_id, :channel, :customer_id, :device_data, :discount_amount,
         :merchant_account_id, :order_id, :payment_method_nonce, :payment_method_token,
         :product_sku, :purchase_order_number, :service_fee_amount, :shared_billing_address_id,
         :shared_customer_id, :shared_payment_method_nonce, :shared_payment_method_token,
         :shared_shipping_address_id, :shipping_address_id, :shipping_amount,
-        :ships_from_postal_code, :tax_amount, :tax_exempt, :three_d_secure_authentication_id,
-        :three_d_secure_token, :transaction_source, :type, :venmo_sdk_payment_method_code,
+        :ships_from_postal_code, :tax_amount, :tax_exempt, :three_d_secure_authentication_id,:three_d_secure_token, #Deprecated
+        :transaction_source, :type, :venmo_sdk_payment_method_code, # Deprecated
         :sca_exemption, :currency_iso_code, :exchange_rate_quote_id,
         {:line_items => [:quantity, :name, :description, :kind, :unit_amount, :unit_tax_amount, :total_amount, :discount_amount, :tax_amount, :unit_of_measure, :product_code, :commodity_code, :url]},
         {:risk_data => [:customer_browser, :customer_device_id, :customer_ip, :customer_location_zip, :customer_tenure]},
@@ -222,7 +234,7 @@ def self._create_signature # :nodoc:
           :submit_for_settlement,
           :add_billing_address_to_payment_method,
           :store_shipping_address_in_vault,
-          :venmo_sdk_session,
+          :venmo_sdk_session, # Deprecated
           :payee_id,
           :payee_email,
           :skip_advanced_fraud_checking,

diff --git a/lib/braintree/transaction_search.rb b/lib/braintree/transaction_search.rb
@@ -54,15 +54,16 @@ class TransactionSearch < AdvancedSearch # :nodoc:
       CreditCard::CustomerLocation::International,
       CreditCard::CustomerLocation::US
     ]
+    multiple_value_field :debit_network, :allows => CreditCard::DebitNetwork::All
     multiple_value_field :ids
-    multiple_value_field :payment_instrument_type
-    multiple_value_field :user
     multiple_value_field :merchant_account_id
-    multiple_value_field :status, :allows => Transaction::Status::All
+    multiple_value_field :payment_instrument_type
+    multiple_value_field :reason_code
     multiple_value_field :source
-    multiple_value_field :type, :allows => Transaction::Type::All
+    multiple_value_field :status, :allows => Transaction::Status::All
     multiple_value_field :store_ids
-    multiple_value_field :reason_code
+    multiple_value_field :type, :allows => Transaction::Type::All
+    multiple_value_field :user
 
     key_value_fields :refund
 

diff --git a/lib/braintree/version.rb b/lib/braintree/version.rb
@@ -1,7 +1,7 @@
 module Braintree
   module Version
     Major = 4
-    Minor = 14
+    Minor = 15
     Tiny = 0
 
     String = "#{Major}.#{Minor}.#{Tiny}"

diff --git a/lib/braintree/webhook_notification.rb b/lib/braintree/webhook_notification.rb
@@ -45,6 +45,7 @@ module Kind
 
       RecipientUpdatedGrantedPaymentMethod = "recipient_updated_granted_payment_method"
 
+      SubscriptionBillingSkipped = "subscription_billing_skipped"
       SubscriptionCanceled = "subscription_canceled"
       SubscriptionChargedSuccessfully = "subscription_charged_successfully"
       SubscriptionChargedUnsuccessfully = "subscription_charged_unsuccessfully"

diff --git a/lib/braintree/webhook_testing_gateway.rb b/lib/braintree/webhook_testing_gateway.rb
@@ -72,6 +72,8 @@ def _subject_sample_xml(kind, id)
         _disbursement_exception_sample_xml(id)
       when Braintree::WebhookNotification::Kind::Disbursement
         _disbursement_sample_xml(id)
+      when Braintree::WebhookNotification::Kind::SubscriptionBillingSkipped
+        _subscription_billing_skipped(id)
       when Braintree::WebhookNotification::Kind::SubscriptionChargedSuccessfully
         _subscription_charged_successfully(id)
       when Braintree::WebhookNotification::Kind::SubscriptionChargedUnsuccessfully
@@ -112,6 +114,21 @@ def _check
       XML
     end
 
+    def _subscription_billing_skipped(id)
+
+      <<-XML
+        <subscription>
+          <id>#{id}</id>
+          <transactions type="array">
+          </transactions>
+          <add_ons type="array">
+          </add_ons>
+          <discounts type="array">
+          </discounts>
+        </subscription>
+      XML
+    end
+
     def _subscription_charged_successfully(id)
 
       <<-XML

diff --git a/spec/integration/braintree/add_on_spec.rb b/spec/integration/braintree/add_on_spec.rb
@@ -20,15 +20,15 @@
       add_ons = Braintree::AddOn.all
       add_on = add_ons.select { |add_on| add_on.id == id }.first
 
-      add_on.should_not be_nil
-      add_on.amount.should == BigDecimal(expected[:amount])
-      add_on.created_at.should_not be_nil
-      add_on.description.should == expected[:description]
-      add_on.kind.should == expected[:kind]
-      add_on.name.should == expected[:name]
-      add_on.never_expires.should == expected[:never_expires]
-      add_on.number_of_billing_cycles.should == expected[:number_of_billing_cycles]
-      add_on.updated_at.should_not be_nil
+      expect(add_on).not_to be_nil
+      expect(add_on.amount).to eq(BigDecimal(expected[:amount]))
+      expect(add_on.created_at).not_to be_nil
+      expect(add_on.description).to eq(expected[:description])
+      expect(add_on.kind).to eq(expected[:kind])
+      expect(add_on.name).to eq(expected[:name])
+      expect(add_on.never_expires).to eq(expected[:never_expires])
+      expect(add_on.number_of_billing_cycles).to eq(expected[:number_of_billing_cycles])
+      expect(add_on.updated_at).not_to be_nil
     end
 
     it "raises with a helpful error if public_key and private_key are not set" do