braintree 2.98.0 → 4.23.0

data/lib/braintree/payment_method_nonce_details_payer_info.rb

@@ -0,0 +1,32 @@
+module Braintree
+  class PaymentMethodNonceDetailsPayerInfo
+    include BaseModule
+
+    attr_reader :billing_agreement_id
+    attr_reader :country_code
+    attr_reader :email
+    attr_reader :first_name
+    attr_reader :last_name
+    attr_reader :payer_id
+
+    def initialize(attributes)
+      set_instance_variables_from_hash attributes unless attributes.nil?
+    end
+
+    def inspect
+      attr_order = [
+        :billing_agreement_id,
+        :country_code,
+        :email,
+        :first_name,
+        :last_name,
+        :payer_id,
+      ]
+
+      formatted_attrs = attr_order.map do |attr|
+        "#{attr}: #{send(attr).inspect}"
+      end
+      "#<PaymentMethodNonceDetailsPayerInfo #{formatted_attrs.join(", ")}>"
+    end
+  end
+end

data/lib/braintree/payment_method_nonce_gateway.rb

@@ -1,5 +1,5 @@
 module Braintree
-  class PaymentMethodNonceGateway # :nodoc:
+  class PaymentMethodNonceGateway
     include BaseModule
 
     def initialize(gateway)
@@ -8,12 +8,23 @@ module Braintree
       @config.assert_has_access_token_or_keys
     end
 
-    def create(payment_method_token)
-      response = @config.http.post("#{@config.base_merchant_path}/payment_methods/#{payment_method_token}/nonces")
+    def create(payment_method_token, args = {payment_method_nonce: {}})
+      Util.verify_keys(PaymentMethodNonceGateway._create_signature, args)
+
+      response = @config.http.post("#{@config.base_merchant_path}/payment_methods/#{payment_method_token}/nonces", args)
       payment_method_nonce = PaymentMethodNonce._new(@gateway, response.fetch(:payment_method_nonce))
       SuccessfulResult.new(:payment_method_nonce => payment_method_nonce)
     end
 
+    def self._create_signature
+      [ {
+        :payment_method_nonce=> [
+          :merchant_account_id, :authentication_insight,
+          {:authentication_insight_options => [:amount, :recurring_customer_consent, :recurring_max_amount]}
+        ]
+      }]
+    end
+
     def create!(*args)
       return_object_or_raise(:payment_method_nonce) { create(*args) }
     end

data/lib/braintree/payment_method_parser.rb

@@ -6,24 +6,21 @@ module Braintree
         CreditCard._new(gateway, attributes[:credit_card])
       elsif attributes[:paypal_account]
         PayPalAccount._new(gateway, attributes[:paypal_account])
-      elsif attributes[:coinbase_account]
-        CoinbaseAccount._new(gateway, attributes[:coinbase_account])
       elsif attributes[:us_bank_account]
         UsBankAccount._new(gateway, attributes[:us_bank_account])
       elsif attributes[:apple_pay_card]
         ApplePayCard._new(gateway, attributes[:apple_pay_card])
       elsif attributes[:android_pay_card]
-        AndroidPayCard._new(gateway, attributes[:android_pay_card])
-      elsif attributes[:amex_express_checkout_card]
-        AmexExpressCheckoutCard._new(gateway, attributes[:amex_express_checkout_card])
+        GooglePayCard._new(gateway, attributes[:android_pay_card])
       elsif attributes[:venmo_account]
         VenmoAccount._new(gateway, attributes[:venmo_account])
       elsif attributes[:visa_checkout_card]
         VisaCheckoutCard._new(gateway, attributes[:visa_checkout_card])
-      elsif attributes[:masterpass_card]
-        MasterpassCard._new(gateway, attributes[:masterpass_card])
       elsif attributes[:samsung_pay_card]
+        warn "[DEPRECATED] SamsungPayCard is no longer a supported payment method type"
         SamsungPayCard._new(gateway, attributes[:samsung_pay_card])
+      elsif attributes[:sepa_debit_account]
+        SepaDirectDebitAccount._new(gateway, attributes[:sepa_debit_account])
       else
         UnknownPaymentMethod._new(gateway, attributes)
       end

data/lib/braintree/paypal_account.rb

@@ -5,7 +5,9 @@ module Braintree
     attr_reader :billing_agreement_id
     attr_reader :created_at
     attr_reader :customer_id
+    attr_reader :edit_paypal_vault_id
     attr_reader :email
+    attr_reader :funding_source_description
     attr_reader :image_url
     attr_reader :payer_id
     attr_reader :revoked_at
@@ -13,7 +15,7 @@ module Braintree
     attr_reader :token
     attr_reader :updated_at
 
-    def initialize(gateway, attributes) # :nodoc:
+    def initialize(gateway, attributes)
       @gateway = gateway
       set_instance_variables_from_hash(attributes)
       @subscriptions = (@subscriptions || []).map { |subscription_hash| Subscription._new(@gateway, subscription_hash) }
@@ -51,7 +53,6 @@ module Braintree
       return_object_or_raise(:transaction) { sale(token, transaction_attributes) }
     end
 
-    # Returns true if this paypal account is the customer's default payment method.
     def default?
       @default
     end

data/lib/braintree/paypal_account_gateway.rb

@@ -28,7 +28,7 @@ module Braintree
       @config.http.delete("#{@config.base_merchant_path}/payment_methods/paypal_account/#{token}")
     end
 
-    def _do_create(path, params) # :nodoc:
+    def _do_create(path, params)
       response = @config.http.post("#{@config.base_merchant_path}#{path}", params)
       if response[:paypal_account]
         SuccessfulResult.new(:paypal_account => PayPalAccount._new(@gateway, response[:paypal_account]))
@@ -39,7 +39,7 @@ module Braintree
       end
     end
 
-    def _do_update(http_verb, path, params) # :nodoc:
+    def _do_update(http_verb, path, params)
       response = @config.http.send(http_verb, "#{@config.base_merchant_path}#{path}", params)
       if response[:paypal_account]
         SuccessfulResult.new(:paypal_account => PayPalAccount._new(@gateway, response[:paypal_account]))
@@ -50,7 +50,7 @@ module Braintree
       end
     end
 
-    def self._create_signature # :nodoc:
+    def self._create_signature
       options = [:fail_on_duplicate_payment_method, :make_default]
       [
         :email, :token, :billing_agreement_id, :customer_id,
@@ -58,14 +58,14 @@ module Braintree
       ]
     end
 
-    def self._create_nested_signature # :nodoc:
+    def self._create_nested_signature
       [
         :email, :token, :billing_agreement_id,
         {:options => [:make_default]}
       ]
     end
 
-    def self._update_signature # :nodoc:
+    def self._update_signature
       options = [:fail_on_duplicate_payment_method, :make_default]
       [:email, :token, :billing_agreement_id, {:options => options}]
     end

data/lib/braintree/plan.rb

@@ -23,7 +23,7 @@ module Braintree
       Configuration.gateway.plan.all
     end
 
-    def initialize(gateway, attributes) # :nodoc:
+    def initialize(gateway, attributes)
       @gateway = gateway
       set_instance_variables_from_hash(attributes)
       add_ons.map! { |attrs| AddOn._new(attrs) }
@@ -33,10 +33,30 @@ module Braintree
 
     class << self
       protected :new
+
+      def create(*args)
+        Configuration.gateway.plan.create(*args)
+      end
+
+      def create!(*args)
+        Configuration.gateway.plan.create!(*args)
+      end
+
+      def find(*args)
+        Configuration.gateway.plan.find(*args)
+      end
+
+      def update(*args)
+        Configuration.gateway.plan.update(*args)
+      end
+
+      def update!(*args)
+        Configuration.gateway.plan.update!(*args)
+      end
     end
 
     def self._new(*args)
-      self.new *args
+      self.new(*args)
     end
   end
 end

data/lib/braintree/plan_gateway.rb

@@ -1,5 +1,7 @@
 module Braintree
-  class PlanGateway # :nodoc:
+  class PlanGateway
+    include BaseModule
+
     def initialize(gateway)
       @gateway = gateway
       @config = gateway.config
@@ -13,5 +15,103 @@ module Braintree
         Plan._new(@gateway, attributes)
       end
     end
+
+    def create(attributes)
+      Util.verify_keys(PlanGateway._create_signature, attributes)
+      _do_create "/plans", :plan => attributes
+    end
+
+    def create!(*args)
+      return_object_or_raise(:plan) { create(*args) }
+    end
+
+    def find(id)
+      raise ArgumentError if id.nil? || id.to_s.strip == ""
+      response = @config.http.get("#{@config.base_merchant_path}/plans/#{id}")
+      Plan._new(@gateway, response[:plan])
+    rescue NotFoundError
+      raise NotFoundError, "plan with id #{id.inspect} not found"
+    end
+
+    def update(plan_id, attributes)
+      Util.verify_keys(PlanGateway._update_signature, attributes)
+      response = @config.http.put("#{@config.base_merchant_path}/plans/#{plan_id}", :plan => attributes)
+      if response[:plan]
+        SuccessfulResult.new(:plan => Plan._new(@gateway, response[:plan]))
+      elsif response[:api_error_response]
+        ErrorResult.new(@gateway, response[:api_error_response])
+      else
+        raise UnexpectedError, "expected :plan or :api_error_response"
+      end
+    end
+
+    def update!(*args)
+      return_object_or_raise(:plan) { update(*args) }
+    end
+
+    def self._create_signature
+      [
+        :billing_day_of_month,
+        :billing_frequency,
+        :currency_iso_code,
+        :description,
+        :id,
+        :merchant_id,
+        :name,
+        :number_of_billing_cycles,
+        :price,
+        :trial_duration,
+        :trial_duration_unit,
+        :trial_period
+      ] + _add_on_discount_signature
+    end
+
+    def self._update_signature
+      [
+        :billing_day_of_month,
+        :billing_frequency,
+        :currency_iso_code,
+        :description,
+        :id,
+        :merchant_id,
+        :name,
+        :number_of_billing_cycles,
+        :price,
+        :trial_duration,
+        :trial_duration_unit,
+        :trial_period
+      ] + _add_on_discount_signature
+    end
+
+    def self._add_on_discount_signature
+      [
+        {
+          :add_ons => [
+            {:add => [:amount, :inherited_from_id, :never_expires, :number_of_billing_cycles, :quantity]},
+            {:update => [:amount, :existing_id, :never_expires, :number_of_billing_cycles, :quantity]},
+            {:remove => [:_any_key_]}
+          ]
+        },
+        {
+          :discounts => [
+            {:add => [:amount, :inherited_from_id, :never_expires, :number_of_billing_cycles, :quantity]},
+            {:update => [:amount, :existing_id, :never_expires, :number_of_billing_cycles, :quantity]},
+            {:remove => [:_any_key_]}
+          ]
+        }
+      ]
+    end
+
+    def _do_create(path, params)
+      response = @config.http.post("#{@config.base_merchant_path}#{path}", params)
+      if response[:plan]
+        SuccessfulResult.new(:plan => Plan._new(@gateway, response[:plan]))
+      elsif response[:api_error_response]
+        ErrorResult.new(@gateway, response[:api_error_response])
+      else
+        raise UnexpectedError, "expected :plan or :api_error_response"
+      end
+    end
   end
 end
+

data/lib/braintree/processor_response_types.rb

@@ -1,7 +1,7 @@
 module Braintree
   module ProcessorResponseTypes
-    Approved = 'approved'
-    SoftDeclined = 'soft_declined'
-    HardDeclined = 'hard_declined'
+    Approved = "approved"
+    SoftDeclined = "soft_declined"
+    HardDeclined = "hard_declined"
   end
 end

data/lib/braintree/resource_collection.rb

@@ -1,10 +1,10 @@
 module Braintree
-  class ResourceCollection # :nodoc:
+  class ResourceCollection
     include Enumerable
 
     attr_reader :ids
 
-    def initialize(response, &block) # :nodoc:
+    def initialize(response, &block)
       @ids = Util.extract_attribute_as_array(response[:search_results], :ids)
       @page_size = response[:search_results][:page_size]
       @paging_block = block
@@ -22,9 +22,14 @@ module Braintree
       @ids.empty?
     end
 
-    # Returns the first item in the collection or nil if the collection is empty
-    def first
-      @paging_block.call([@ids.first]).first
+    # Returns the first or the first N items in the collection or nil if the collection is empty
+    def first(amount = 1)
+      return nil if @ids.empty?
+      return @paging_block.call([@ids.first]).first if amount == 1
+
+      @ids.first(amount).each_slice(@page_size).flat_map do |page_of_ids|
+        @paging_block.call(page_of_ids)
+      end
     end
 
     # Only the maximum size of a resource collection can be determined since the data on the server can change while

data/lib/braintree/revoked_payment_method_metadata.rb

@@ -14,8 +14,8 @@ module Braintree
 
     class << self
       protected :new
-      def _new(*args) # :nodoc:
-        self.new *args
+      def _new(*args)
+        self.new(*args)
       end
     end
   end

data/lib/braintree/risk_data/liability_shift.rb

@@ -0,0 +1,22 @@
+module Braintree
+  class RiskData
+    class LiabilityShift
+      include BaseModule
+
+      attr_reader :responsible_party
+      attr_reader :conditions
+
+      def initialize(attributes)
+        set_instance_variables_from_hash attributes unless attributes.nil?
+      end
+
+      def inspect
+        attr_order = [:responsible_party, :conditions]
+        formatted_attrs = attr_order.map do |attr|
+          "#{attr}: #{send(attr).inspect}"
+        end
+        "#<LiabilityShift #{formatted_attrs.join(", ")}>"
+      end
+    end
+  end
+end

data/lib/braintree/risk_data.rb

@@ -1,18 +1,25 @@
 module Braintree
-  class RiskData # :nodoc:
+  class RiskData
     include BaseModule
 
+    attr_reader :customer_device_id
+    attr_reader :customer_location_zip
+    attr_reader :customer_tenure
     attr_reader :decision
+    attr_reader :decision_reasons
     attr_reader :device_data_captured
-    attr_reader :id
     attr_reader :fraud_service_provider
+    attr_reader :id
+    attr_reader :liability_shift
+    attr_reader :transaction_risk_score
 
     def initialize(attributes)
       set_instance_variables_from_hash attributes unless attributes.nil?
+      @liability_shift = LiabilityShift.new(attributes[:liability_shift]) if attributes[:liability_shift]
     end
 
     def inspect
-      attr_order = [:id, :decision, :device_data_captured, :fraud_service_provider]
+      attr_order = [:id, :decision, :decision_reasons, :device_data_captured, :fraud_service_provider, :liability_shift, :transaction_risk_score]
       formatted_attrs = attr_order.map do |attr|
         "#{attr}: #{send(attr).inspect}"
       end

data/lib/braintree/samsung_pay_card.rb

@@ -1,6 +1,8 @@
 module Braintree
+  # NEXT_MAJOR_VERSION remove this class
+  # SamsungPayCard has been deprecated
   class SamsungPayCard
-    include BaseModule # :nodoc:
+    include BaseModule
     include Braintree::Util::TokenEquality
 
     attr_reader :billing_address
@@ -29,7 +31,7 @@ module Braintree
     attr_reader :unique_number_identifier
     attr_reader :updated_at
 
-    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
@@ -49,7 +51,7 @@ module Braintree
       @expired
     end
 
-    def inspect # :nodoc:
+    def inspect
       first = [:token]
       order = first + (self.class._attributes - first)
       nice_attributes = order.map do |attr|
@@ -66,7 +68,7 @@ module Braintree
       protected :new
     end
 
-    def self._attributes # :nodoc:
+    def self._attributes
       [
         :billing_address, :bin, :cardholder_name, :card_type, :created_at, :customer_id,
         :customer_location, :expiration_month, :expiration_year,
@@ -76,8 +78,8 @@ module Braintree
       ]
     end
 
-    def self._new(*args) # :nodoc:
-      self.new *args
+    def self._new(*args)
+      self.new(*args)
     end
   end
 end

data/lib/braintree/sepa_direct_debit_account.rb

@@ -0,0 +1,60 @@
+module Braintree
+  class SepaDirectDebitAccount
+    include BaseModule
+
+    attr_reader :bank_reference_token
+    attr_reader :created_at
+    attr_reader :customer_id
+    attr_reader :customer_global_id
+    attr_reader :default
+    attr_reader :global_id
+    attr_reader :image_url
+    attr_reader :last_4
+    attr_reader :mandate_type
+    attr_reader :merchant_or_partner_customer_id
+    attr_reader :subscriptions
+    attr_reader :token
+    attr_reader :updated_at
+    attr_reader :view_mandate_url
+
+    def initialize(gateway, attributes)
+      @gateway = gateway
+      @subscriptions = (@subscriptions || []).map { |subscription_hash| Subscription._new(@gateway, subscription_hash) }
+      set_instance_variables_from_hash(attributes)
+    end
+
+    def default?
+      @default
+    end
+
+    class << self
+      protected :new
+    end
+
+    def self._new(*args)
+      self.new(*args)
+    end
+
+    def self.find(*args)
+      Configuration.gateway.sepa_direct_debit_account.find(*args)
+    end
+
+    def self.delete(*args)
+      Configuration.gateway.sepa_direct_debit_account.delete(*args)
+    end
+
+    def self.sale(token, transaction_attributes)
+      options = transaction_attributes[:options] || {}
+      Configuration.gateway.transaction.sale(
+        transaction_attributes.merge(
+          :payment_method_token => token,
+          :options => options.merge(:submit_for_settlement => true),
+        ),
+      )
+    end
+
+    def self.sale!(token, transaction_attributes)
+      return_object_or_raise(:transaction) { sale(token, transaction_attributes) }
+    end
+  end
+end

data/lib/braintree/sepa_direct_debit_account_gateway.rb

@@ -0,0 +1,25 @@
+module Braintree
+  class SepaDirectDebitAccountGateway
+    def initialize(gateway)
+      @gateway = gateway
+      @config = gateway.config
+      @config.assert_has_access_token_or_keys
+    end
+
+    def find(token)
+      raise ArgumentError if token.nil? || token.to_s.strip == ""
+      response = @config.http.get("#{@config.base_merchant_path}/payment_methods/sepa_debit_account/#{token}")
+      SepaDirectDebitAccount._new(@gateway, response[:sepa_debit_account])
+    rescue NotFoundError
+      raise NotFoundError, "sepa direct debit account with token #{token.inspect} not found"
+    end
+
+    def delete(token)
+      raise ArgumentError if token.nil? || token.to_s.strip == ""
+      @config.http.delete("#{@config.base_merchant_path}/payment_methods/sepa_debit_account/#{token}")
+      SuccessfulResult.new
+    rescue NotFoundError
+      raise NotFoundError, "sepa direct debit account with token #{token.inspect} not found"
+    end
+  end
+end

data/lib/braintree/sepa_direct_debit_account_nonce_details.rb

@@ -0,0 +1,28 @@
+module Braintree
+  class SepaDirectDebitAccountNonceDetails
+    include BaseModule
+
+    attr_reader :bank_reference_token
+    attr_reader :last_4
+    attr_reader :mandate_type
+    attr_reader :merchant_or_partner_customer_id
+
+    def initialize(attributes)
+      set_instance_variables_from_hash attributes unless attributes.nil?
+    end
+
+    def inspect
+      attr_order = [
+        :bank_reference_token,
+        :last_4,
+        :mandate_type,
+        :merchant_or_partner_customer_id,
+      ]
+
+      formatted_attrs = attr_order.map do |attr|
+        "#{attr}: #{send(attr).inspect}"
+      end
+      "#<SepaDirectDebitAccountNonceDetails#{formatted_attrs.join(", ")}>"
+    end
+  end
+end

data/lib/braintree/settlement_batch_summary.rb

@@ -1,11 +1,11 @@
 module Braintree
   class SettlementBatchSummary
     include BaseModule
-    
+
     attr_reader :records
 
     def self.generate(settlement_date, group_by_custom_field = nil)
-      criteria = { :settlement_date => settlement_date }
+      criteria = {:settlement_date => settlement_date}
       criteria.merge!({:group_by_custom_field => group_by_custom_field}) if group_by_custom_field
       Configuration.gateway.settlement_batch_summary.generate(criteria)
     end

data/lib/braintree/settlement_batch_summary_gateway.rb

@@ -1,5 +1,5 @@
 module Braintree
-  class SettlementBatchSummaryGateway # :nodoc
+  class SettlementBatchSummaryGateway
     include BaseModule
 
     def initialize(gateway)

data/lib/braintree/sha256_digest.rb

@@ -1,5 +1,5 @@
 module Braintree
-  module SHA256Digest # :nodoc:
+  module SHA256Digest
     def self.hexdigest(private_key, string)
       _hmac(private_key, string)
     end

data/lib/braintree/subscription/status_details.rb

@@ -1,6 +1,6 @@
 module Braintree
   class Subscription
-    class StatusDetails # :nodoc:
+    class StatusDetails
       include BaseModule
 
       attr_reader :balance