braintree 4.34.0 → 4.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c3d511f196493254353d03633aedd94e6bc5ac4c0d075ab354a19435ca1e223
-  data.tar.gz: dcfc72a09d796a25d40451abe117dda0ea63a2e53874f45de0ee5546b94fc440
+  metadata.gz: bddd5ecd987b2c8f75088ac1877e7273eebe8463165f9c1db10c92f61aa5961a
+  data.tar.gz: 7757bdac8b5bf0808812c073b5e8fcd50e759b4078c51c41def3590467651f12
 SHA512:
-  metadata.gz: aa45eeeda00fb2a9d9999c8c2d41a3f9ef4385190598ade9d89ca2017222e893b31e9e3104ed81aa6f03a96bd4f9b0e1247b5e948d2687885eac5e5a0dbd7967
-  data.tar.gz: d554568c2653f57c5b69ce9bec05655d84f8aa01b96357b3effda416bc1c1c3a8da473db9930669e3c65b7165d1b4fe131ca5578ed4f396fab201d61cbdf376c
+  metadata.gz: 37bba6f56222e7f56caca748920befd5d8f443669411cd42f998fe9c17d4c381605e50c38732ce5831f1e6368806ddb96ac0baa4438dd3dc34294d63db5cdfde
+  data.tar.gz: 7f2ae5944a6e3b08da6df35cb6c26aeffbac5c6baa6124d24ddf52abdc7216b6a6a3e77278124993cec2592513cff4ad9d2619eb7b65b15ea835f3fa37f239a5

data/lib/braintree/apple_pay_card.rb

@@ -44,12 +44,19 @@ module Braintree
     attr_reader :subscriptions
     attr_reader :token
     attr_reader :updated_at
+    attr_reader :verification
 
     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
+
+    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
 
     def default?

data/lib/braintree/apple_pay_gateway.rb

@@ -33,5 +33,48 @@ module Braintree
         raise "expected :response or :api_error_response"
       end
     end
+
+    def self._card_signature(type)
+      billing_address_params = AddressGateway._shared_signature
+
+      options = [
+        :verification_account_type,
+        :verification_amount,
+        :verification_merchant_account_id,
+        :verify_card
+      ]
+
+      signature = [
+        :cardholder_name,
+        :cryptogram,
+        :eci_indicator,
+        :expiration_month,
+        :expiration_year,
+        :network_transaction_id,
+        :number,
+        :token,
+        {:billing_address => billing_address_params},
+        {:options => options}
+      ]
+
+      case type
+      when :create
+        nil
+      when :update
+        options << :make_default
+      else
+        raise ArgumentError, "Invalid signature type: #{type}"
+      end
+
+      signature
+    end
+
+    def self._create_card_signature
+      _card_signature(:create)
+    end
+
+    def self._update_card_signature
+      _card_signature(:update)
+    end
   end
 end

data/lib/braintree/base_module.rb

@@ -35,6 +35,15 @@ module Braintree
       def singleton_class
         class << self; self; end
       end
+
+      private
+
+      def _format_hash(hash)
+        formatted_pairs = hash.map do |key, value|
+          ":#{key}=>#{value.inspect}"
+        end
+        "{#{formatted_pairs.join(", ")}}"
+      end
     end
 
     def self.included(klass)

data/lib/braintree/credit_card_verification.rb

@@ -28,6 +28,7 @@ module Braintree
     attr_reader :amount
     attr_reader :ani_first_name_response_code
     attr_reader :ani_last_name_response_code
+    attr_reader :apple_pay
     attr_reader :avs_error_response_code
     attr_reader :avs_postal_code_response_code
     attr_reader :avs_street_address_response_code
@@ -64,6 +65,7 @@ module Braintree
         :amount,
         :ani_first_name_response_code,
         :ani_last_name_response_code,
+        :apple_pay,
         :avs_error_response_code,
         :avs_postal_code_response_code,
         :avs_street_address_response_code,

data/lib/braintree/customer.rb

@@ -90,7 +90,7 @@ module Braintree
       @google_pay_cards = (@google_pay_cards || []).map { |pm| GooglePayCard._new gateway, pm }
       @venmo_accounts = (@venmo_accounts || []).map { |pm| VenmoAccount._new gateway, pm }
       @us_bank_accounts = (@us_bank_accounts || []).map { |pm| UsBankAccount._new gateway, pm }
-      @visa_checkout_cards = (@visa_checkout_cards|| []).map { |pm| VisaCheckoutCard._new gateway, pm }
+      @visa_checkout_cards = (@visa_checkout_cards|| []).map { |pm| VisaCheckoutCard._new gateway, pm } # Deprecated
       @sepa_direct_debit_accounts = (@sepa_debit_accounts || []).map { |pm| SepaDirectDebitAccount._new gateway, pm }
       @samsung_pay_cards = (@samsung_pay_cards|| []).map { |pm| SamsungPayCard._new gateway, pm } # Deprecated
       @addresses = (@addresses || []).map { |addr| Address._new gateway, addr }
@@ -129,7 +129,7 @@ module Braintree
     def inspect
       first = [:id]
       last = [:addresses, :credit_cards, :paypal_accounts, :tax_identifiers]
-      order = first + (self.class._attributes - first - last) + last
+      order = (first + ((self.class._attributes - first) - last)) + last
       nice_attributes = order.map do |attr|
         "#{attr}: #{send(attr).inspect}"
       end

data/lib/braintree/customer_gateway.rb

@@ -82,6 +82,7 @@ module Braintree
         :last_name, :phone, :website,
         :device_data, :payment_method_nonce,
         {:risk_data => [:customer_browser, :customer_ip]},
+        {:apple_pay_card => ApplePayGateway._create_card_signature},
         {:credit_card => credit_card_signature},
         {:paypal_account => paypal_account_signature},
         {:tax_identifiers => [:country_code, :identifier]},
@@ -147,6 +148,7 @@ module Braintree
         {:international_phone => [:country_code, :national_number]},
         :last_name, :phone, :website,
         :device_data, :payment_method_nonce, :default_payment_method_token,
+        {:apple_pay_card => ApplePayGateway._update_card_signature},
         {:credit_card => credit_card_signature},
         {:tax_identifiers => [:country_code, :identifier]},
         {:options => options},

data/lib/braintree/error_codes.rb

@@ -51,6 +51,7 @@ module Braintree
       MerchantKeysAlreadyConfigured = "93515"
       MerchantKeysNotConfigured = "93516"
       MerchantNotConfigured = "93514"
+      NetworkTransactionIdNotAllowed = "93532"
       NumberIsRequired = "93508"
       PaymentMethodNonceCardTypeIsNotAccepted = "83518"
       PaymentMethodNonceConsumed = "93504"
@@ -58,6 +59,17 @@ module Braintree
       PaymentMethodNonceUnknown = "93505"
       PrivateKeyMismatch = "93521"
       TokenIsInUse = "93503"
+
+      module Options
+        VerificationAccountTypeIsInvalid = "93538"
+        VerificationAccountTypeNotSupported = "93543"
+        VerificationAmountCannotBeNegative = "93535"
+        VerificationAmountFormatIsInvalid = "93534"
+        VerificationAmountIsTooLarge = "93537"
+        VerificationAmountNotSupportedByProcessor = "93536"
+        VerificationMerchantAccountIdIsInvalid = "93540"
+        VerificationMerchantAccountIsSuspended = "93541"
+      end
     end
 
     module CreditCard
@@ -136,6 +148,8 @@ module Braintree
       IdIsNotAllowed = "91611"
       IdIsRequired = "91613"
       IdIsTooLong = "91612"
+      InternationalPhoneCountryCodeIsInvalid = "91625"
+      InternationalPhoneNationalNumberIsInvalid = "91626"
       LastNameIsTooLong = "81613"
       PhoneIsTooLong = "81614"
       VaultedPaymentInstrumentNonceBelongsToDifferentCustomer = "91617"
@@ -365,6 +379,12 @@ module Braintree
       DiscountAmountFormatIsInvalid = "915159"
       DiscountAmountIsTooLarge = "915161"
       ExchangeRateQuoteIdTooLong = "915229"
+      ApiRequestKeyTooLong = "915230"
+      ApiRequestKeyNotAllowed = "915231"
+      ApiRequestKeyCanBeReusedOnlyWithTheSameRequest = "915232"
+      ApiRequestKeyIsInFlight = "915233"
+      ApiRequestKeyWithFailedRequest = "915234"
+      ApiRequestKeyServerError = "915235"
       FailedAuthAdjustmentAllowRetry = "95603"
       FailedAuthAdjustmentHardDecline = "95602"
       FinalAuthSubmitForSettlementForDifferentAmount = "95601"

data/lib/braintree/gateway.rb

@@ -46,6 +46,10 @@ module Braintree
       CustomerSessionGateway.new(self, graphql_client)
     end
 
+    def local_payment_context
+      LocalPaymentContextGateway.new(self, graphql_client)
+    end
+
     def discount
       DiscountGateway.new(self)
     end

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

@@ -0,0 +1,34 @@
+module Braintree
+  class BillingAddressInput
+    include BaseModule
+
+    attr_reader :attrs
+    attr_reader :country_code_alpha2
+    attr_reader :extended_address
+    attr_reader :locality
+    attr_reader :postal_code
+    attr_reader :region
+    attr_reader :street_address
+
+    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
+      {
+        "countryCode" => country_code_alpha2,
+        "extendedAddress" => extended_address,
+        "locality" => locality,
+        "postalCode" => postal_code,
+        "region" => region,
+        "streetAddress" => street_address
+      }.compact
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Braintree
+  class CreateLocalPaymentContextInput
+    include BaseModule
+
+    attr_reader :amount
+    attr_reader :attrs
+    attr_reader :cancel_url
+    attr_reader :country_code
+    attr_reader :expiry_date
+    attr_reader :merchant_account_id
+    attr_reader :order_id
+    attr_reader :payer_info
+    attr_reader :return_url
+    attr_reader :type
+
+    def initialize(attributes)
+      @attrs = attributes.keys
+      set_instance_variables_from_hash(attributes)
+      @amount = attributes[:amount] ? MonetaryAmountInput.new(attributes[:amount]) : nil
+      @payer_info = attributes[:payer_info] ? PayerInfoInput.new(attributes[:payer_info]) : nil
+    end
+
+    def inspect
+      inspected_attributes = @attrs.map { |attr| "#{attr}:#{send(attr).inspect}" }
+      "#<#{self.class} #{inspected_attributes.join(" ")}>"
+    end
+
+    def to_graphql_variables
+      {
+        "paymentContext" => {
+          "amount" => amount&.to_graphql_variables,
+          "cancelUrl" => cancel_url,
+          "countryCode" => country_code,
+          "expiryDate" => expiry_date,
+          "merchantAccountId" => merchant_account_id,
+          "orderId" => order_id,
+          "payerInfo" => payer_info&.to_graphql_variables,
+          "returnUrl" => return_url,
+          "type" => type
+        }.compact
+      }
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Braintree
+  class PayerInfoInput
+    include BaseModule
+
+    attr_reader :attrs
+    attr_reader :billing_address
+    attr_reader :email
+    attr_reader :given_name
+    attr_reader :phone_country_code
+    attr_reader :phone_number
+    attr_reader :shipping_address
+    attr_reader :surname
+
+    def initialize(attributes)
+      @attrs = attributes.keys
+      set_instance_variables_from_hash(attributes)
+      @billing_address = attributes[:billing_address] ? BillingAddressInput.new(attributes[:billing_address]) : nil
+      @shipping_address = attributes[:shipping_address] ? ShippingAddressInput.new(attributes[:shipping_address]) : nil
+    end
+
+    def inspect
+      inspected_attributes = @attrs.map { |attr| "#{attr}:#{send(attr).inspect}" }
+      "#<#{self.class} #{inspected_attributes.join(" ")}>"
+    end
+
+    def to_graphql_variables
+      {
+        "billingAddress" => billing_address&.to_graphql_variables,
+        "email" => email,
+        "givenName" => given_name,
+        "phoneCountryCode" => phone_country_code,
+        "phoneNumber" => phone_number,
+        "shippingAddress" => shipping_address&.to_graphql_variables,
+        "surname" => surname
+      }.compact
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module Braintree
+  class ShippingAddressInput
+    include BaseModule
+
+    attr_reader :attrs
+    attr_reader :country_code_alpha2
+    attr_reader :extended_address
+    attr_reader :locality
+    attr_reader :postal_code
+    attr_reader :region
+    attr_reader :street_address
+
+    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
+      {
+        "countryCode" => country_code_alpha2,
+        "extendedAddress" => extended_address,
+        "locality" => locality,
+        "postalCode" => postal_code,
+        "region" => region,
+        "streetAddress" => street_address
+      }.compact
+    end
+  end
+end

data/lib/braintree/local_payment_context.rb

@@ -0,0 +1,108 @@
+module Braintree
+  class LocalPaymentContext
+    include BaseModule
+
+    attr_reader :amount
+    attr_reader :approval_url
+    attr_reader :approved_at
+    attr_reader :attrs
+    attr_reader :created_at
+    attr_reader :expired_at
+    attr_reader :id
+    attr_reader :legacy_id
+    attr_reader :merchant_account_id
+    attr_reader :order_id
+    attr_reader :payment_id
+    attr_reader :transacted_at
+    attr_reader :type
+    attr_reader :updated_at
+
+    def initialize(attributes)
+      @attrs = [:amount, :approval_url, :approved_at, :attrs, :created_at, :expired_at, :id, :legacy_id,
+                :merchant_account_id, :order_id, :payment_id, :transacted_at, :type, :updated_at]
+
+      if attributes.key?(:response)
+        response = attributes[:response]
+        @id = _get_value(response, "paymentContext.id")
+        @legacy_id = _get_value_optional(response, "paymentContext.legacyId")
+        @type = _get_value(response, "paymentContext.type")
+        @payment_id = _get_value_optional(response, "paymentContext.paymentId")
+        @order_id = _get_value_optional(response, "paymentContext.orderId")
+        @approval_url = _get_value_optional(response, "paymentContext.approvalUrl")
+        @merchant_account_id = _get_value_optional(response, "paymentContext.merchantAccountId")
+        @created_at = _get_value_optional(response, "paymentContext.createdAt")
+        @updated_at = _get_value_optional(response, "paymentContext.updatedAt")
+        @transacted_at = _get_value_optional(response, "paymentContext.transactedAt")
+        @approved_at = _get_value_optional(response, "paymentContext.approvedAt")
+        @expired_at = _get_value_optional(response, "paymentContext.expiredAt")
+        @amount = _extract_amount(response)
+      else
+        set_instance_variables_from_hash(attributes)
+      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
+
+    private
+
+    def _extract_amount(response)
+      amount_hash = _get_value_optional(response, "paymentContext.amount")
+      return nil unless amount_hash
+
+      currency = amount_hash[:currencyCode] || amount_hash["currencyCode"] ||
+                 amount_hash[:currencyIsoCode] || amount_hash["currencyIsoCode"]
+
+      MonetaryAmount._new({
+        value: amount_hash[:value] || amount_hash["value"],
+        currency_code: currency
+      })
+    end
+
+    def _get_value(response, key)
+      current_map = response
+      key_parts = key.split(".")
+
+      (0...key_parts.length - 1).each do |i|
+        sub_key = key_parts[i]
+        current_map = _pop_value(current_map, sub_key)
+      end
+
+      last_key = key_parts[-1]
+      _pop_value(current_map, last_key)
+    end
+
+    def _get_value_optional(response, key)
+      _get_value(response, key)
+    rescue ServerError
+      nil
+    end
+
+    def _pop_value(response, key)
+      if response.key?(key)
+        return response[key]
+      end
+
+      symkey = key.to_sym
+      if response.key?(symkey)
+        return response[symkey]
+      end
+
+      if response.key?(key.to_s)
+        return response[key.to_s]
+      end
+
+      raise ServerError.new("Couldn't parse response")
+    end
+  end
+end

data/lib/braintree/local_payment_context_gateway.rb

@@ -0,0 +1,132 @@
+module Braintree
+  class LocalPaymentContextGateway
+    CREATE_LOCAL_PAYMENT_CONTEXT = <<~GRAPHQL
+      mutation CreateLocalPaymentContext($input: CreateLocalPaymentContextInput!) {
+        createLocalPaymentContext(input: $input) {
+          paymentContext {
+            id
+            legacyId
+            type
+            paymentId
+            approvalUrl
+            merchantAccountId
+            orderId
+            createdAt
+            transactedAt
+            approvedAt
+            amount {
+              value
+              currencyCode
+            }
+          }
+        }
+      }
+    GRAPHQL
+
+    FIND_LOCAL_PAYMENT_CONTEXT = <<~GRAPHQL
+      query Node($id: ID!) {
+        node(id: $id) {
+          ... on LocalPaymentContext {
+            id
+            legacyId
+            type
+            amount {
+              value
+              currencyIsoCode
+            }
+            approvalUrl
+            merchantAccountId
+            transactedAt
+            approvedAt
+            createdAt
+            updatedAt
+            expiredAt
+            paymentId
+            orderId
+          }
+        }
+      }
+    GRAPHQL
+
+    def initialize(gateway, graphql_client)
+      @gateway = gateway
+      @graphql_client = graphql_client
+    end
+
+    def create(input)
+      variables = {"input" => input.to_graphql_variables}
+
+      begin
+        response = @graphql_client.query(CREATE_LOCAL_PAYMENT_CONTEXT, variables)
+        errors = GraphQLClient.get_validation_errors(response)
+
+        if errors
+          ErrorResult.new(@gateway, {errors: errors})
+        else
+          payment_context = extract_payment_context(response)
+          SuccessfulResult.new(:payment_context => payment_context)
+        end
+      rescue StandardError => e
+        raise UnexpectedError, e.message
+      end
+    end
+
+    def find(id)
+      variables = {"id" => id}
+
+      begin
+        response = @graphql_client.query(FIND_LOCAL_PAYMENT_CONTEXT, variables)
+        errors = GraphQLClient.get_validation_errors(response)
+
+        if errors
+          ErrorResult.new(@gateway, {errors: errors})
+        else
+          payment_context = extract_node_payment_context(response)
+          SuccessfulResult.new(:payment_context => payment_context)
+        end
+      rescue NotFoundError
+        raise
+      rescue StandardError => e
+        raise UnexpectedError, e.message
+      end
+    end
+
+    private
+
+    def extract_payment_context(response)
+      context_hash = get_value(response, "data.createLocalPaymentContext.paymentContext")
+      LocalPaymentContext._new({:response => {"paymentContext" => context_hash}})
+    end
+
+    def extract_node_payment_context(response)
+      node_hash = get_value(response, "data.node")
+
+      if node_hash.nil?
+        raise NotFoundError, "Payment context not found"
+      end
+
+      LocalPaymentContext._new({:response => {"paymentContext" => node_hash}})
+    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
+  end
+end

data/lib/braintree/local_payment_type.rb

@@ -0,0 +1,6 @@
+module Braintree
+  module LocalPaymentType
+    CRYPTO = "CRYPTO"
+    MBWAY = "MBWAY"
+  end
+end

data/lib/braintree/merchant_gateway.rb

@@ -5,22 +5,10 @@ module Braintree
       @config = gateway.config
     end
 
-    def provision_raw_apple_pay
-      response = @config.http.put("#{@config.base_merchant_path}/provision_raw_apple_pay")
-      if response[:apple_pay]
-        SuccessfulResult.new(response[:apple_pay])
-      elsif response[:api_error_response]
-        ErrorResult.new(@gateway, response[:api_error_response])
-      else
-        raise UnexpectedError, "expected :apple_pay or :api_error_response"
-      end
-    end
-
+    # NEXT_MAJOR_VERSION remove this method
+    # The create_via_api endpoint has been disabled; this method always raises a server error
     def create(params)
-      _create_merchant(params)
-    end
-
-    def _create_merchant(params)
+      warn "[DEPRECATED] Merchant.create is deprecated and will be removed in a future version."
       response = @config.http.post("/merchants/create_via_api", :merchant => params)
 
       if response.has_key?(:response) && response[:response][:merchant]
@@ -31,8 +19,20 @@ module Braintree
       elsif response[:api_error_response]
         ErrorResult.new(@gateway, response[:api_error_response])
       else
-        raise "expected :merchant or :api_error_response"
+        raise UnexpectedError, "expected :merchant or :api_error_response"
       end
     end
+
+    def provision_raw_apple_pay
+      response = @config.http.put("#{@config.base_merchant_path}/provision_raw_apple_pay")
+      if response[:apple_pay]
+        SuccessfulResult.new(response[:apple_pay])
+      elsif response[:api_error_response]
+        ErrorResult.new(@gateway, response[:api_error_response])
+      else
+        raise UnexpectedError, "expected :apple_pay or :api_error_response"
+      end
+    end
+
   end
 end

data/lib/braintree/monetary_amount.rb

@@ -0,0 +1,24 @@
+module Braintree
+  class MonetaryAmount
+    include BaseModule
+
+    attr_reader :currency_code
+    attr_reader :value
+
+    def initialize(attributes)
+      set_instance_variables_from_hash(attributes)
+    end
+
+    def inspect
+      "#<MonetaryAmount currency_code:#{currency_code.inspect} value:#{value.inspect}>"
+    end
+
+    class << self
+      protected :new
+    end
+
+    def self._new(*args)
+      self.new(*args)
+    end
+  end
+end