braintree 4.23.0 → 4.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80f9d00b4dec8e85066f61cecaf04c5863399c8c6552d5158d0fe69f8b81a64f
-  data.tar.gz: 4664e8431f59bf1293d6cafbaf3623b6fe2069aa81af17520384b5e85c34a0a5
+  metadata.gz: a53b0f33066dc60083b87ba8eb176eecef8e765c87d4b0073f09d74ce584aeaf
+  data.tar.gz: '09b4b509edaa9c5a8d20a52ee735eca5067a28c05fd01401a1a08034b84d6d49'
 SHA512:
-  metadata.gz: 73131e462a1c99744d967f82cecdda88dc2780e04c3bb69f51cd7149fc8e747d7e487e31cc5e5e3fe7f4440d6da3ef42a90ee7e027c7fa0f567ad2b84a6119dd
-  data.tar.gz: a17216eb8f219f33af17d79accae60eccc23e059753ac159aed34063ec7f8abb0566c6268097647bb1a657fabf507d4f9d1d90c39e3c73b0e66f9d4c1a29c8bc
+  metadata.gz: ae0bc77b138805d06321f200d61376328173630dc730f0fecd91483b70fd35f7817632323923a8bcf95c76c99b095825f472101f2bc3a657ad7d6c8d278ec5a2
+  data.tar.gz: 8d28568a72404894d70b00546f2dd391520253cbe1729d852bbea67ebfbf8d65857389a42783b8f9923dee8add8677e38879421c5a9262f5d7a50076f04e2887

data/lib/braintree/customer_session_gateway.rb

@@ -0,0 +1,194 @@
+# Creates and manages PayPal customer sessions.
+
+module Braintree
+    class CustomerSessionGateway
+      CREATE_CUSTOMER_SESSION = <<~GRAPHQL
+        mutation CreateCustomerSession($input: CreateCustomerSessionInput!) {
+          createCustomerSession(input: $input) {
+            sessionId
+          }
+        }
+      GRAPHQL
+
+      UPDATE_CUSTOMER_SESSION = <<~GRAPHQL
+        mutation UpdateCustomerSession($input: UpdateCustomerSessionInput!) {
+          updateCustomerSession(input: $input) {
+            sessionId
+          }
+        }
+      GRAPHQL
+
+      GET_CUSTOMER_RECOMMENDATIONS = <<~GRAPHQL
+        query CustomerRecommendations($input: CustomerRecommendationsInput!) {
+          customerRecommendations(input: $input) {
+            isInPayPalNetwork
+            recommendations {
+              ... on PaymentRecommendations {
+                paymentOptions {
+                  paymentOption
+                  recommendedPriority
+                }
+              }
+            }
+          }
+        }
+      GRAPHQL
+
+      def initialize(gateway, graphql_client)
+        @gateway = gateway
+        @graphql_client = graphql_client
+      end
+
+      # Creates a new customer session.
+      #
+      # Example:
+      #   customer = {
+      #    email: "test@example.com",
+      #    device_fingerprint_id: "1234",
+      #    phone: {country_phone_code: "1", phone_number: "5555555555"},
+      #    paypal_app_installed: true,
+      #    venmo_app_installed: true,
+      #   }
+      #   input = Braintree::CreateCustomerSessionInput.new(
+      #                customer: customer,
+      #   )
+      #   result = gateway.customer_session.create_customer_session(input)
+      #   if result.success?
+      #     puts "Created session #{result.session_id}"
+      #   else
+      #     puts "Validations failed"
+      #     puts result.errors.first.message
+      #   end
+      #
+      # @param input [CreateCustomerSessionInput] The input parameters for creating a customer session.
+      #
+      # @return [(Successful|Error)Result] A result object with session ID if successful, or errors otherwise.
+      #
+      # @raise [UnexpectedError] If there is an unexpected error during the process.
+      def create_customer_session(input)
+        execute_mutation(CREATE_CUSTOMER_SESSION, input, :createCustomerSession)
+      end
+
+
+      # Updates an existing customer session.
+      #
+      # Example:
+      #   customer = {
+      #    email: "test@example.com",
+      #    device_fingerprint_id: "1234",
+      #    phone: {country_phone_code: "1", phone_number: "5555555555"},
+      #    paypal_app_installed: true,
+      #    venmo_app_installed: true,
+      #   }
+      #   input = Braintree::UpdateCustomerSessionInput.new(
+      #                session_id: "11EF-34BC-2702904B-9026-555555555555",
+      #                customer: customer,
+      #   )
+      #   result = gateway.customer_session.updated_customer_session(input)
+      #   if result.success?
+      #     puts "Updated session #{result.session_id}"
+      #   else
+      #     puts "Validations failed"
+      #     puts result.errors.first.message
+      #   end
+      #
+      # @param input [UpdateCustomerSessionInput] The input parameters for updating a customer session.
+      #
+      # @return [(Successful|Error)Result] A result object with session ID if successful, or errors otherwise.
+      #
+      # @raise [UnexpectedError] If there is an unexpected error during the process.
+      def update_customer_session(input)
+        execute_mutation(UPDATE_CUSTOMER_SESSION, input, :updateCustomerSession)
+      end
+
+      # Retrieves customer recommendations associated with a customer session.
+      #
+      # Example:
+      #   customer = {
+      #    email: "test@example.com",
+      #    device_fingerprint_id: "1234",
+      #    phone: {country_phone_code: "1", phone_number: "5555555555"},
+      #    paypal_app_installed: true,
+      #    venmo_app_installed: true,
+      #   }
+      #   input = Braintree::CustomerRecommendationsInput.new(
+      #                session_id: "11EF-34BC-2702904B-9026-555555555555",
+      #                customer: customer,
+      #                recommendations: [Braintree::Recommendations::PAYMENT_RECOMMENDATIONS]
+      #   )
+      #   result = gateway.customer_session.get_customer_recommendations(input)
+      #   if result.success?
+      #     puts "Fetched customer recommendations"
+      #     payload = result.customer_recommendations
+      #     puts payload
+      #   else
+      #     puts "Validations failed"
+      #     puts result.errors.first.message
+      #   end
+      #
+      # @param input [CustomerRecommendationsInput] The input parameters for retrieving customer recommendations.
+      #
+      # @return [Result\Error|Result\Successful] A result object containing the customer recommendations if successful, or errors otherwise.
+      #
+      # @raise [UnexpectedError] If there is an unexpected error during the process.
+      def get_customer_recommendations(customer_recommendations_input)
+        variables = {"input" => customer_recommendations_input.to_graphql_variables}
+
+        begin
+          response = @graphql_client.query(GET_CUSTOMER_RECOMMENDATIONS, variables)
+          errors = GraphQLClient.get_validation_errors(response)
+          if errors
+            ErrorResult.new(@gateway, {errors:errors})
+          else
+            SuccessfulResult.new(:customer_recommendations => extract_customer_recommendations_payload(response))
+          end
+        rescue StandardError => e
+          raise UnexpectedError, e.message
+        end
+      end
+
+      private
+
+      def execute_mutation(query, input, operation_name)
+        variables = {"input" => input.to_graphql_variables}
+        begin
+          response = @graphql_client.query(query, variables)
+          errors = GraphQLClient.get_validation_errors(response)
+          if errors
+            ErrorResult.new(@gateway, {errors:errors})
+          else
+            session_id = get_value(response, "data.#{operation_name}.sessionId")
+            SuccessfulResult.new(:session_id => session_id)
+          end
+        rescue StandardError => e
+          raise UnexpectedError, e.message
+        end
+      end
+
+      def get_value(response, key)
+        map = response
+        key_parts = key.split(".")
+
+        key_parts[0..-2].each do |sub_key|
+          map = pop_value(map, sub_key)
+          raise UnexpectedError, "Couldn't parse response"  unless map.is_a?(Hash)
+        end
+
+        pop_value(map, key_parts.last)
+      end
+
+      def pop_value(map, key)
+        key = key.to_sym
+        if map.key?(key)
+          map[key]
+        else
+          raise UnexpectedError, "Couldn't parse response"
+        end
+      end
+
+      def extract_customer_recommendations_payload(data)
+        customer_recommendations_hash = get_value(data, "data.customerRecommendations")
+        Braintree::CustomerRecommendationsPayload._new(customer_recommendations_hash)
+      end
+    end
+  end

data/lib/braintree/error_result.rb

@@ -12,7 +12,7 @@ module Braintree
 
     def initialize(gateway, data)
       @gateway = gateway
-      @params = data[:params]
+      @params = data[:params] if data[:params]
       @credit_card_verification = CreditCardVerification._new(data[:verification]) if data[:verification]
       @merchant_account = MerchantAccount._new(gateway, data[:merchant_account]) if data[:merchant_account]
       @message = data[:message]

data/lib/braintree/errors.rb

@@ -3,7 +3,8 @@ module Braintree
     include Enumerable
 
     def initialize(data = {})
-      @errors = ValidationErrorCollection.new(data.merge(:errors => []))
+      data = data.merge(:errors => []) unless data
+      @errors = ValidationErrorCollection.new(data)
     end
 
     def each(&block)

data/lib/braintree/gateway.rb

@@ -38,6 +38,10 @@ module Braintree
       CustomerGateway.new(self)
     end
 
+    def customer_session
+      CustomerSessionGateway.new(self, graphql_client)
+    end
+
     def discount
       DiscountGateway.new(self)
     end

data/lib/braintree/graphql/enums/recommendations.rb

@@ -0,0 +1,7 @@
+# Represents available types of customer recommendations that can be retrieved using a PayPal customer session.
+
+module Braintree
+  module Recommendations
+    PAYMENT_RECOMMENDATIONS = "PAYMENT_RECOMMENDATIONS"
+  end
+end

data/lib/braintree/graphql/enums/recommended_payment_option.rb

@@ -0,0 +1,8 @@
+# Represents available payment options related to PayPal customer session recommendations.
+
+module Braintree
+  module RecommendedPaymentOption
+    PAYPAL = "PAYPAL"
+    VENMO = "VENMO"
+  end
+end

data/lib/braintree/graphql/inputs/create_customer_session_input.rb

@@ -0,0 +1,35 @@
+# Represents the input to request the creation of a PayPal customer session.
+
+module Braintree
+    class CreateCustomerSessionInput
+        include BaseModule
+
+        attr_reader :attrs
+        attr_reader :merchant_account_id
+        attr_reader :session_id
+        attr_reader :customer
+        attr_reader :domain
+
+        def initialize(attributes)
+            @attrs = attributes.keys
+            set_instance_variables_from_hash(attributes)
+            @customer = attributes[:customer] ? CustomerSessionInput.new(attributes[:customer]) : nil
+        end
+
+        def inspect
+            inspected_attributes = @attrs.map { |attr| "#{attr}:#{send(attr).inspect}" }
+            "#<#{self.class} #{inspected_attributes.join(" ")}>"
+        end
+
+        def to_graphql_variables
+            variables = {}
+            variables["merchantAccountId"] = merchant_account_id if merchant_account_id
+            variables["sessionId"] = session_id if session_id
+            variables["domain"] = domain if domain
+            variables["customer"] = customer.to_graphql_variables if customer
+            variables
+        end
+    end
+end
+
+

data/lib/braintree/graphql/inputs/customer_recommendations_input.rb

@@ -0,0 +1,41 @@
+# Represents the input to request PayPal customer session recommendations.
+
+module Braintree
+    class CustomerRecommendationsInput
+        include BaseModule
+
+        attr_reader :attrs
+        attr_reader :merchant_account_id
+        attr_reader :session_id
+        attr_reader :recommendations
+        attr_reader :customer
+
+        def initialize(attributes)
+            unless attributes[:session_id]
+                raise ArgumentError, "Expected hash to contain a :session_id"
+            end
+            unless attributes[:recommendations]
+                raise ArgumentError, "Expected hash to contain a :recommendations"
+            end
+            @attrs = attributes.keys
+            set_instance_variables_from_hash(attributes)
+            @customer = attributes[:customer] ? CustomerSessionInput.new(attributes[:customer]) : nil
+        end
+
+        def inspect
+            inspected_attributes = @attrs.map { |attr| "#{attr}:#{send(attr).inspect}" }
+            "#<#{self.class} #{inspected_attributes.join(" ")}>"
+        end
+
+        def to_graphql_variables
+            variables = {}
+            variables["merchantAccountId"] = merchant_account_id if merchant_account_id
+            variables["sessionId"] = session_id if session_id
+            variables["recommendations"] = recommendations if recommendations
+            variables["customer"] = customer.to_graphql_variables if customer
+            variables
+        end
+    end
+end
+
+

data/lib/braintree/graphql/inputs/customer_session_input.rb

@@ -0,0 +1,39 @@
+# Customer identifying information for a PayPal customer session.
+
+module Braintree
+    class CustomerSessionInput
+        include BaseModule
+
+        attr_reader :attrs
+        attr_reader :email
+        attr_reader :phone
+        attr_reader :device_fingerprint_id
+        attr_reader :paypal_app_installed
+        attr_reader :venmo_app_installed
+        attr_reader :user_agent
+
+        def initialize(attributes)
+            @attrs = attributes.keys
+            set_instance_variables_from_hash(attributes)
+            @phone = attributes[:phone] ? PhoneInput.new(attributes[:phone]) : nil
+        end
+
+        def inspect
+            inspected_attributes = @attrs.map { |attr| "#{attr}:#{send(attr).inspect}" }
+            "#<#{self.class} #{inspected_attributes.join(" ")}>"
+        end
+
+        def to_graphql_variables
+            variables = {}
+            variables["email"] = email if email
+            variables["phone"] = phone.to_graphql_variables if phone
+            variables["deviceFingerprintId"] = device_fingerprint_id if device_fingerprint_id
+            variables["paypalAppInstalled"] = paypal_app_installed if paypal_app_installed
+            variables["venmoAppInstalled"] = venmo_app_installed if venmo_app_installed
+            variables["userAgent"] = user_agent if user_agent
+            variables
+        end
+    end
+end
+
+

data/lib/braintree/graphql/inputs/phone_input.rb

@@ -0,0 +1,32 @@
+# Phone number input for PayPal customer session.
+
+module Braintree
+    class PhoneInput
+        include BaseModule
+
+        attr_reader :attrs
+        attr_reader :country_phone_code
+        attr_reader :phone_number
+        attr_reader :extension_number
+
+        def initialize(attributes)
+            @attrs = attributes.keys
+            set_instance_variables_from_hash(attributes)
+        end
+
+        def inspect
+            inspected_attributes = @attrs.map { |attr| "#{attr}:#{send(attr).inspect}" }
+            "#<#{self.class} #{inspected_attributes.join(" ")}>"
+        end
+
+        def to_graphql_variables
+            variables = {}
+            variables["countryPhoneCode"] = country_phone_code if country_phone_code
+            variables["phoneNumber"] = phone_number if phone_number
+            variables["extensionNumber"] = extension_number if extension_number
+            variables
+        end
+    end
+end
+
+

data/lib/braintree/graphql/inputs/update_customer_session_input.rb

@@ -0,0 +1,37 @@
+# Represents the input to request an update to a PayPal customer session.
+
+module Braintree
+    class UpdateCustomerSessionInput
+        include BaseModule
+
+        attr_reader :attrs
+        attr_reader :merchant_account_id
+        attr_reader :session_id
+        attr_reader :customer
+
+        def initialize(attributes)
+            unless attributes[:session_id]
+                raise ArgumentError, "Expected hash to contain a :session_id"
+            end
+            @attrs = attributes.keys
+            set_instance_variables_from_hash(attributes)
+            @customer = attributes[:customer] ? CustomerSessionInput.new(attributes[:customer]) : nil
+        end
+
+        def inspect
+            inspected_attributes = @attrs.map { |attr| "#{attr}:#{send(attr).inspect}" }
+            "#<#{self.class} #{inspected_attributes.join(" ")}>"
+        end
+
+        def to_graphql_variables
+            variables = {}
+            variables["merchantAccountId"] = merchant_account_id if merchant_account_id
+            variables["sessionId"] = session_id if session_id
+            variables["customer"] = customer.to_graphql_variables if customer
+            variables
+        end
+
+    end
+end
+
+

data/lib/braintree/graphql/types/customer_recommendations_payload.rb

@@ -0,0 +1,32 @@
+# Represents the customer recommendations information associated with a PayPal customer session.
+
+module Braintree
+    class CustomerRecommendationsPayload
+        include BaseModule
+
+        attr_reader :attrs
+        attr_reader :is_in_paypal_network
+        attr_reader :recommendations
+
+        def initialize(attributes)
+            @attrs = [:is_in_paypal_network, :recommendations]
+            @is_in_paypal_network = attributes[:isInPayPalNetwork] if attributes[:isInPayPalNetwork]
+            @recommendations = CustomerRecommendations._new(attributes[:recommendations]) if attributes[:recommendations]
+        end
+
+        def inspect
+            inspected_attributes = @attrs.map { |attr| "#{attr}:#{send(attr).inspect}" }
+            "#<#{self.class} #{inspected_attributes.join(" ")}>"
+        end
+
+        class << self
+            protected :new
+        end
+
+        def self._new(*args)
+            self.new(*args)
+        end
+    end
+end
+
+

data/lib/braintree/graphql/types/payment_options.rb

@@ -0,0 +1,33 @@
+# Represents the payment method and priority associated with a PayPal customer session.
+
+module Braintree
+    class PaymentOptions
+        include BaseModule
+
+        attr_reader :attrs
+        attr_reader :payment_option
+        attr_reader :recommended_priority
+
+        def initialize(attributes)
+            @attrs = [:payment_option, :recommended_priority]
+            @payment_option = attributes[:paymentOption] if attributes[:paymentOption]
+            @recommended_priority = attributes[:recommendedPriority] if attributes[:recommendedPriority]
+
+        end
+
+        def inspect
+            inspected_attributes = @attrs.map { |attr| "#{attr}:#{send(attr).inspect}" }
+            "#<#{self.class} #{inspected_attributes.join(" ")}>"
+        end
+
+        class << self
+            protected :new
+        end
+
+        def self._new(*args)
+            self.new(*args)
+        end
+    end
+end
+
+

data/lib/braintree/graphql/unions/customer_recommendations.rb

@@ -0,0 +1,34 @@
+# A union of all possible customer recommendations associated with a PayPal customer session.
+
+module Braintree
+    class CustomerRecommendations
+        include BaseModule
+
+        attr_reader :attrs
+        attr_reader :payment_options
+
+        def initialize(attributes)
+            @attrs = [:payment_options]
+            if attributes.nil?
+                @payment_options = []
+            else
+                @payment_options = (attributes[:paymentOptions] || []).map { |payment_options_hash| PaymentOptions._new(payment_options_hash) }
+            end
+        end
+
+        def inspect
+            inspected_attributes = @attrs.map { |attr| "#{attr}:#{send(attr).inspect}" }
+            "#<#{self.class} #{inspected_attributes.join(" ")}>"
+        end
+
+        class << self
+            protected :new
+        end
+
+        def self._new(*args)
+            self.new(*args)
+        end
+    end
+end
+
+

data/lib/braintree/graphql_client.rb

@@ -30,5 +30,21 @@ module Braintree
       body = Zlib::GzipReader.new(StringIO.new(body)).read if response.header["Content-Encoding"] == "gzip"
       JSON.parse(body, :symbolize_names => true)
     end
+
+    def self.get_validation_errors(response)
+      return nil unless response.key?(:errors) && response[:errors].is_a?(Array)
+      validation_errors = response[:errors].map do |error|
+        {
+          :attribute => "",
+          :code => get_validation_error_code(error),
+          :message => error[:message]
+        }
+      end
+      {errors: validation_errors}
+    end
+
+    def self.get_validation_error_code(error)
+      error[:extensions] && error[:extensions][:legacyCode] rescue nil
+    end
   end
 end

data/lib/braintree/successful_result.rb

@@ -24,6 +24,8 @@ module Braintree
     attr_reader :supported_networks
     attr_reader :transaction
     attr_reader :us_bank_account_verification
+    attr_reader :session_id
+    attr_reader :customer_recommendations
 
     def initialize(attributes = {})
       @attrs = attributes.keys

data/lib/braintree/transaction/paypal_details.rb

@@ -20,6 +20,8 @@ module Braintree
       attr_reader :payer_last_name
       attr_reader :payer_status
       attr_reader :payment_id
+      attr_reader :recipient_email
+      attr_reader :recipient_phone
       attr_reader :refund_from_transaction_fee_amount
       attr_reader :refund_from_transaction_fee_currency_iso_code
       attr_reader :refund_id

data/lib/braintree/transaction_gateway.rb

@@ -254,24 +254,24 @@ module Braintree
         {:installments => [:count]},
         {:line_items => [:commodity_code, :description, :discount_amount, :image_url, :kind, :name, :product_code, :quantity, :tax_amount, :total_amount, :unit_amount, :unit_of_measure, :unit_tax_amount, :upc_code, :upc_type, :url]},
         {:options => [
-          :hold_in_escrow,
-          :store_in_vault,
-          :store_in_vault_on_success,
-          :submit_for_settlement,
           :add_billing_address_to_payment_method,
-          :store_shipping_address_in_vault,
-          :venmo_sdk_session, # Deprecated
+          {:amex_rewards => [:request_id, :points, :currency_amount, :currency_iso_code]},
+          {:credit_card => [:account_type, :process_debit_as_credit]},
+          :hold_in_escrow,
           :payee_id,
           :payee_email,
+          {:paypal => [:custom_field, :description, :payee_id, :payee_email, :recipient_email,  {:recipient_phone => [:country_code, :national_number]}, {:supplementary_data => :_any_key_}]},
+          {:processing_overrides => [:customer_email, :customer_first_name, :customer_last_name, :customer_tax_identifier]},
           :skip_advanced_fraud_checking,
           :skip_avs,
           :skip_cvv,
-          {:paypal => [:custom_field, :payee_id, :payee_email, :description, {:supplementary_data => :_any_key_}]},
-          {:processing_overrides => [:customer_email, :customer_first_name, :customer_last_name, :customer_tax_identifier]},
+          :store_in_vault,
+          :store_in_vault_on_success,
+          :store_shipping_address_in_vault,
+          :submit_for_settlement,
           {:three_d_secure => [:required]},
-          {:amex_rewards => [:request_id, :points, :currency_amount, :currency_iso_code]},
           {:venmo => [:profile_id]},
-          {:credit_card => [:account_type, :process_debit_as_credit]},
+          :venmo_sdk_session, # Deprecated
         ]
         },
         {:paypal_account => [:email, :token, :paypal_data, :payee_id, :payee_email, :payer_id, :payment_id]},

data/lib/braintree/version.rb

@@ -1,7 +1,7 @@
 module Braintree
   module Version
     Major = 4
-    Minor = 23
+    Minor = 25
     Tiny = 0
 
     String = "#{Major}.#{Minor}.#{Tiny}"

data/lib/braintree.rb

@@ -51,6 +51,7 @@ require "braintree/customer"
 require "braintree/customer_gateway"
 require "braintree/granted_payment_instrument_update"
 require "braintree/customer_search"
+require "braintree/customer_session_gateway"
 require "braintree/descriptor"
 require "braintree/digest"
 require "braintree/discount"
@@ -75,6 +76,16 @@ require "braintree/exchange_rate_quote_input"
 require "braintree/exchange_rate_quote_response"
 require "braintree/exchange_rate_quote_request"
 require "braintree/gateway"
+require "braintree/graphql/enums/recommendations"
+require "braintree/graphql/enums/recommended_payment_option"
+require "braintree/graphql/inputs/create_customer_session_input"
+require "braintree/graphql/inputs/customer_recommendations_input"
+require "braintree/graphql/inputs/customer_session_input"
+require "braintree/graphql/inputs/phone_input"
+require "braintree/graphql/inputs/update_customer_session_input"
+require "braintree/graphql/types/customer_recommendations_payload"
+require "braintree/graphql/types/payment_options"
+require "braintree/graphql/unions/customer_recommendations"
 require "braintree/graphql_client"
 require "braintree/google_pay_card"
 require "braintree/local_payment_completed"