braintree 2.76.0 → 2.77.0

data/lib/braintree/dispute_search.rb

@@ -0,0 +1,30 @@
+module Braintree
+  class DisputeSearch < AdvancedSearch # :nodoc:
+    text_fields(
+      :case_number,
+      :id,
+      :reference_number,
+      :transaction_id
+    )
+
+    multiple_value_field :kind, :allows => Dispute::Kind::All
+    multiple_value_field :merchant_account_id
+    multiple_value_field :reason, :allows => Dispute::Reason::All
+    multiple_value_field :reason_code
+    multiple_value_field :status, :allows => Dispute::Status::All
+
+    multiple_value_field :transaction_source, :allows => [
+      Transaction::Source::Api,
+      Transaction::Source::ControlPanel,
+      Transaction::Source::Recurring,
+      Transaction::Source::Unrecognized,
+    ]
+
+    range_fields(
+      :amount_disputed,
+      :amount_won,
+      :received_date,
+      :reply_by_date
+    )
+  end
+end

data/lib/braintree/document_upload.rb

@@ -0,0 +1,34 @@
+module Braintree
+  class DocumentUpload
+    include BaseModule
+
+    module Kind
+      IdentityDocument          = "identity_document"
+      EvidenceDocument          = "evidence_document"
+      PayoutInvoiceDocument     = "payout_invoice_document"
+    end
+
+    attr_reader :id, :kind, :content_type, :name, :size
+
+    def self.create(attributes)
+      Configuration.gateway.document_upload.create(attributes)
+    end
+
+    def initialize(attributes) # :nodoc:
+      set_instance_variables_from_hash(attributes)
+    end
+
+    # True if <tt>other</tt> has the same id.
+    def ==(other)
+      return false unless other.is_a?(DocumentUpload)
+      id == other.id
+    end
+
+    class << self
+      protected :new
+      def _new(*args) # :nodoc:
+        self.new *args
+      end
+    end
+  end
+end

data/lib/braintree/document_upload_gateway.rb

@@ -0,0 +1,32 @@
+module Braintree
+  class DocumentUploadGateway # :nodoc:
+    def initialize(gateway)
+      @gateway = gateway
+      @config = gateway.config
+      @config.assert_has_access_token_or_keys
+    end
+
+    def create(attributes)
+      Util.verify_keys(DocumentUploadGateway._create_signature, attributes)
+      _do_create "/document_uploads", {"document_upload[kind]" => attributes[:kind]}, attributes[:file]
+    end
+
+    def self._create_signature # :nodoc:
+      [
+        :kind,
+        :file
+      ]
+    end
+
+    def _do_create(path, params, file) # :nodoc:
+      response = @config.http.post("#{@config.base_merchant_path}#{path}", params, file)
+      if response[:document_upload]
+        SuccessfulResult.new(:document_upload => DocumentUpload._new(response[:document_upload]))
+      elsif response[:api_error_response]
+        ErrorResult.new(@gateway, response[:api_error_response])
+      else
+        raise UnexpectedError, "expected :document_upload or :api_error_response"
+      end
+    end
+  end
+end

data/lib/braintree/error_codes.rb

@@ -146,6 +146,21 @@ module Braintree
       UrlFormatIsInvalid = "92206"
     end
 
+    module Dispute
+      CanOnlyAddEvidenceToOpenDispute = "95701"
+      CanOnlyRemoveEvidenceFromOpenDispute = "95702"
+      CanOnlyAddEvidenceDocumentToDispute = "95703"
+      CanOnlyAcceptOpenDispute = "95704"
+      CanOnlyFinalizeOpenDispute = "95705"
+    end
+
+    module DocumentUpload
+      KindIsInvalid = "84901"
+      FileIsTooLarge = "84902"
+      FileTypeIsInvalid = "84903"
+      FileIsMalformedOrEncrypted = "84904"
+    end
+
     module PayPalAccount
       AuthExpired = "92911"
       CannotHaveBothAccessTokenAndConsentCode = "82903"
@@ -292,6 +307,7 @@ module Braintree
       CustomerIdIsInvalid = "91510"
       HasAlreadyBeenRefunded = "91512"
       IdealPaymentNotComplete = "815141"
+      IdealPaymentsCannotBeVaulted = "915150"
       MerchantAccountDoesNotMatch3DSecureMerchantAccount = "91584"
       MerchantAccountDoesNotMatchIdealPaymentMerchantAccount = "915143"
       MerchantAccountDoesNotSupportMOTO = "91558"
@@ -548,6 +564,7 @@ module Braintree
       PaymentMethodNonceUnknown = "93108"
       PaymentMethodNonceLocked = "93109"
       CannotForwardPaymentMethodType = "93107"
+      PaymentMethodNoLongerSupported = "93117"
     end
 
     module AuthorizationFingerprint

data/lib/braintree/facilitated_details.rb

@@ -0,0 +1,19 @@
+module Braintree
+  class FacilitatedDetails # :nodoc:
+    include BaseModule
+
+    attr_reader :merchant_id, :merchant_name, :payment_method_nonce
+
+    def initialize(attributes)
+      set_instance_variables_from_hash attributes unless attributes.nil?
+    end
+
+    def inspect
+      attr_order = [:merchant_id, :merchant_name, :payment_method_nonce]
+      formatted_attrs = attr_order.map do |attr|
+        "#{attr}: #{send(attr).inspect}"
+      end
+      "#<FacilitatorDetails #{formatted_attrs.join(", ")}>"
+    end
+  end
+end

data/lib/braintree/gateway.rb

@@ -20,6 +20,10 @@ module Braintree
       AddressGateway.new(self)
     end
 
+    def apple_pay
+      ApplePayGateway.new(self)
+    end
+
     def client_token
       ClientTokenGateway.new(self)
     end
@@ -36,6 +40,14 @@ module Braintree
       DiscountGateway.new(self)
     end
 
+    def dispute
+      DisputeGateway.new(self)
+    end
+
+    def document_upload
+      DocumentUploadGateway.new(self)
+    end
+
     def oauth
       OAuthGateway.new(self)
     end

data/lib/braintree/http.rb

@@ -1,20 +1,25 @@
 module Braintree
   class Http # :nodoc:
 
+    LINE_FEED = "\r\n"
+
     def initialize(config)
       @config = config
     end
 
-    def delete(path)
+    def delete(_path, query_params = {})
+      path = _path + _build_query_string(query_params)
       response = _http_do Net::HTTP::Delete, path
-      if response.code.to_i == 200
+      if response.code.to_i == 200 || response.code.to_i == 204
         true
+      elsif response.code.to_i == 422
+        Xml.hash_from_xml(_body(response))
       else
         Util.raise_exception_for_status_code(response.code)
       end
     end
 
-    def get(_path, query_params={})
+    def get(_path, query_params = {})
       path = _path + _build_query_string(query_params)
       response = _http_do Net::HTTP::Get, path
       if response.code.to_i == 200 || response.code.to_i == 422
@@ -24,8 +29,12 @@ module Braintree
       end
     end
 
-    def post(path, params = nil)
-      response = _http_do Net::HTTP::Post, path, _build_xml(params)
+    def post(path, params = nil, file = nil)
+      body = params
+      if !file
+        body = _build_xml(params)
+      end
+      response = _http_do Net::HTTP::Post, path, body, file
       if response.code.to_i == 200 || response.code.to_i == 201 || response.code.to_i == 422
         Xml.hash_from_xml(_body(response))
       else
@@ -58,7 +67,7 @@ module Braintree
       end
     end
 
-    def _http_do(http_verb, path, body = nil)
+    def _http_do(http_verb, path, body = nil, file = nil)
       if @config.proxy_address
         connection = Net::HTTP.new(
           @config.server,
@@ -96,9 +105,22 @@ module Braintree
         end
         @config.logger.debug "[Braintree] [#{_current_time}] #{request.method} #{path}"
         if body
-          request["Content-Type"] = "application/xml"
-          request.body = body
-          @config.logger.debug _format_and_sanitize_body_for_log(body)
+          if file
+            boundary = DateTime.now.strftime("%Q")
+            request["Content-Type"] = "multipart/form-data; boundary=#{boundary}"
+
+            form_params = []
+            body.each do |k, v|
+              form_params.push(_add_form_field(k, v))
+            end
+            form_params.push(_add_file_part("file", file))
+            request.body = form_params.collect {|p| "--" + boundary + "#{LINE_FEED}" + p}.join("") + "--" + boundary + "--"
+            @config.logger.debug _format_and_sanitize_body_for_log(_build_xml(body))
+          else
+            request["Content-Type"] = "application/xml"
+            request.body = body
+            @config.logger.debug _format_and_sanitize_body_for_log(body)
+          end
         end
         response = http.request(request)
         @config.logger.info "[Braintree] [#{_current_time}] #{request.method} #{path} #{response.code}"
@@ -112,9 +134,35 @@ module Braintree
       raise Braintree::SSLCertificateError
     end
 
+    def _add_form_field(key, value)
+      return "Content-Disposition: form-data; name=\"#{key}\"#{LINE_FEED}#{LINE_FEED}#{value}#{LINE_FEED}"
+    end
+
+    def _add_file_part(key, file)
+      mime_type = _mime_type_for_file_name(file.path)
+      return "Content-Disposition: form-data; name=\"#{key}\"; filename=\"#{file.path}\"#{LINE_FEED}" +
+          "Content-Type: #{mime_type}#{LINE_FEED}#{LINE_FEED}#{file.read}#{LINE_FEED}"
+    end
+
+    def _mime_type_for_file_name(filename)
+      file_extension = File.extname(filename).strip.downcase[1..-1]
+      if file_extension == "jpeg" || file_extension == "jpg"
+        return "image/jpeg"
+      elsif file_extension == "png"
+        return "image/png"
+      elsif file_extension == "pdf"
+        return "application/pdf"
+      else
+        return "application/octet-stream"
+      end
+    end
+
     def _body(response)
-      if response.header["Content-Encoding"] == "gzip"
+      content_encoding = response.header["Content-Encoding"]
+      if content_encoding == "gzip"
         Zlib::GzipReader.new(StringIO.new(response.body)).read
+      elsif content_encoding.nil?
+        ""
       else
         raise UnexpectedError, "expected a gzipped response"
       end
@@ -126,8 +174,8 @@ module Braintree
 
     def _format_and_sanitize_body_for_log(input_xml)
       formatted_xml = input_xml.gsub(/^/, "[Braintree] ")
-      formatted_xml = formatted_xml.gsub(/<number>(.{6}).+?(.{4})<\/number>/, '<number>\1******\2</number>')
-      formatted_xml = formatted_xml.gsub(/<cvv>.+?<\/cvv>/, '<cvv>***</cvv>')
+      formatted_xml = formatted_xml.gsub(/<number>(.{6}).+?(.{4})<\/number>/m, '<number>\1******\2</number>')
+      formatted_xml = formatted_xml.gsub(/<cvv>.+?<\/cvv>/m, '<cvv>***</cvv>')
       formatted_xml
     end
 

data/lib/braintree/successful_result.rb

@@ -2,7 +2,7 @@ module Braintree
   class SuccessfulResult
     include BaseModule
 
-    attr_reader :address, :credit_card, :customer, :merchant_account, :payment_method, :settlement_batch_summary, :subscription, :new_transaction, :transaction, :payment_method_nonce, :credentials, :merchant, :supported_networks, :paypal_account, :merchant_accounts
+    attr_reader :address, :credit_card, :customer, :document_upload, :merchant_account, :payment_method, :settlement_batch_summary, :subscription, :new_transaction, :transaction, :payment_method_nonce, :credentials, :merchant, :supported_networks, :paypal_account, :merchant_accounts, :disputes, :evidence, :apple_pay_options
 
     def initialize(attributes = {}) # :nodoc:
       @attrs = attributes.keys

data/lib/braintree/test/credit_card.rb

@@ -54,6 +54,12 @@ module Braintree
         All = [Success, IneligibleCard, InsufficientPoints]
       end
 
+      module Disputes
+        Chargeback = "4023898493988028"
+
+        Numbers = [Chargeback]
+      end
+
       All = AmExes + Discovers + MasterCards + Visas + AmexPayWithPoints::All
     end
 

data/lib/braintree/transaction.rb

@@ -120,12 +120,14 @@ module Braintree
     attr_reader :add_ons, :discounts
     attr_reader :payment_instrument_type
     attr_reader :risk_data
+    attr_reader :facilitated_details
     attr_reader :facilitator_details
     attr_reader :three_d_secure_info
     attr_reader :us_bank_account_details
     attr_reader :ideal_payment_details
     attr_reader :visa_checkout_card_details
     attr_reader :masterpass_card_details
+    attr_reader :authorization_adjustments
 
     def self.create(attributes)
       Configuration.gateway.transaction.create(attributes)
@@ -269,12 +271,14 @@ module Braintree
       discounts.map! { |attrs| Discount._new(attrs) } if discounts
       @payment_instrument_type = attributes[:payment_instrument_type]
       @risk_data = RiskData.new(attributes[:risk_data]) if attributes[:risk_data]
+      @facilitated_details = FacilitatedDetails.new(attributes[:facilitated_details]) if attributes[:facilitated_details]
       @facilitator_details = FacilitatorDetails.new(attributes[:facilitator_details]) if attributes[:facilitator_details]
       @three_d_secure_info = ThreeDSecureInfo.new(attributes[:three_d_secure_info]) if attributes[:three_d_secure_info]
       @us_bank_account_details = UsBankAccountDetails.new(attributes[:us_bank_account]) if attributes[:us_bank_account]
       @ideal_payment_details = IdealPaymentDetails.new(attributes[:ideal_payment]) if attributes[:ideal_payment]
       @visa_checkout_card_details = VisaCheckoutCardDetails.new(attributes[:visa_checkout_card])
       @masterpass_card_details = MasterpassCardDetails.new(attributes[:masterpass_card])
+      authorization_adjustments.map! { |attrs| AuthorizationAdjustment._new(attrs) } if authorization_adjustments
     end
 
     # True if <tt>other</tt> is a Braintree::Transaction with the same id.

data/lib/braintree/version.rb

@@ -1,7 +1,7 @@
 module Braintree
   module Version
     Major = 2
-    Minor = 76
+    Minor = 77
     Tiny = 0
 
     String = "#{Major}.#{Minor}.#{Tiny}"

data/lib/braintree/webhook_testing_gateway.rb

@@ -241,10 +241,33 @@ module Braintree
     end
 
     def _dispute_opened_sample_xml(id)
+      if id == "legacy_dispute_id"
+        _old_dispute_opened_sample_xml(id)
+      else
+        _new_dispute_opened_sample_xml(id)
+      end
+    end
+
+    def _dispute_lost_sample_xml(id)
+      if id == "legacy_dispute_id"
+        _old_dispute_lost_sample_xml(id)
+      else
+        _new_dispute_lost_sample_xml(id)
+      end
+    end
+
+    def _dispute_won_sample_xml(id)
+      if id == "legacy_dispute_id"
+        _old_dispute_won_sample_xml(id)
+      else
+        _new_dispute_won_sample_xml(id)
+      end
+    end
 
+    def _old_dispute_opened_sample_xml(id)
       <<-XML
         <dispute>
-          <amount>250.00</amount>
+          <amount>100.00</amount>
           <currency-iso-code>USD</currency-iso-code>
           <received-date type="date">2014-03-01</received-date>
           <reply-by-date type="date">2014-03-21</reply-by-date>
@@ -254,18 +277,17 @@ module Braintree
           <id>#{id}</id>
           <transaction>
             <id>#{id}</id>
-            <amount>250.00</amount>
+            <amount>100.00</amount>
           </transaction>
           <date-opened type=\"date\">2014-03-21</date-opened>
         </dispute>
       XML
     end
 
-    def _dispute_lost_sample_xml(id)
-
+    def _old_dispute_lost_sample_xml(id)
       <<-XML
         <dispute>
-          <amount>250.00</amount>
+          <amount>100.00</amount>
           <currency-iso-code>USD</currency-iso-code>
           <received-date type="date">2014-03-01</received-date>
           <reply-by-date type="date">2014-03-21</reply-by-date>
@@ -275,18 +297,17 @@ module Braintree
           <id>#{id}</id>
           <transaction>
             <id>#{id}</id>
-            <amount>250.00</amount>
+            <amount>100.00</amount>
           </transaction>
           <date-opened type=\"date\">2014-03-21</date-opened>
         </dispute>
       XML
     end
 
-    def _dispute_won_sample_xml(id)
-
+    def _old_dispute_won_sample_xml(id)
       <<-XML
         <dispute>
-          <amount>250.00</amount>
+          <amount>100.00</amount>
           <currency-iso-code>USD</currency-iso-code>
           <received-date type="date">2014-03-01</received-date>
           <reply-by-date type="date">2014-03-21</reply-by-date>
@@ -296,7 +317,172 @@ module Braintree
           <id>#{id}</id>
           <transaction>
             <id>#{id}</id>
-            <amount>250.00</amount>
+            <amount>100.00</amount>
+          </transaction>
+          <date-opened type=\"date\">2014-03-21</date-opened>
+          <date-won type=\"date\">2014-03-22</date-won>
+        </dispute>
+      XML
+    end
+
+    def _new_dispute_opened_sample_xml(id)
+      <<-XML
+        <dispute>
+          <id>#{id}</id>
+          <amount>100.00</amount>
+          <amount-disputed>100.00</amount-disputed>
+          <amount-won>95.00</amount-won>
+          <case-number>CASE-12345</case-number>
+          <created-at type="datetime">2017-06-16T20:44:41Z</created-at>
+          <currency-iso-code>USD</currency-iso-code>
+          <forwarded-comments nil="true"/>
+          <kind>chargeback</kind>
+          <merchant-account-id>ytnlulaloidoqwvzxjrdqputg</merchant-account-id>
+          <reason>fraud</reason>
+          <reason-code nil="true"/>
+          <reason-description nil="true"/>
+          <received-date type="date">2016-02-15</received-date>
+          <reference-number>REF-9876</reference-number>
+          <reply-by-date type="date">2016-02-22</reply-by-date>
+          <status>open</status>
+          <updated-at type="datetime">2017-06-16T20:44:41Z</updated-at>
+          <original-dispute-id>9qde5qgp</original-dispute-id>
+          <status-history type="array">
+            <status-history>
+              <status>open</status>
+              <timestamp type="datetime">2017-06-16T20:44:41Z</timestamp>
+            </status-history>
+          </status-history>
+          <evidence type="array"/>
+          <transaction>
+            <id>#{id}</id>
+            <amount>100.00</amount>
+            <created-at>2017-06-21T20:44:41Z</created-at>
+            <order-id nil="true"/>
+            <purchase-order-number nil="true"/>
+            <payment-instrument-subtype>Visa</payment-instrument-subtype>
+          </transaction>
+          <date-opened type=\"date\">2014-03-21</date-opened>
+        </dispute>
+      XML
+    end
+
+    def _new_dispute_lost_sample_xml(id)
+      <<-XML
+        <dispute>
+          <id>#{id}</id>
+          <amount>100.00</amount>
+          <amount-disputed>100.00</amount-disputed>
+          <amount-won>95.00</amount-won>
+          <case-number>CASE-12345</case-number>
+          <created-at type="datetime">2017-06-16T20:44:41Z</created-at>
+          <currency-iso-code>USD</currency-iso-code>
+          <forwarded-comments nil="true"/>
+          <kind>chargeback</kind>
+          <merchant-account-id>ytnlulaloidoqwvzxjrdqputg</merchant-account-id>
+          <reason>fraud</reason>
+          <reason-code nil="true"/>
+          <reason-description nil="true"/>
+          <received-date type="date">2016-02-15</received-date>
+          <reference-number>REF-9876</reference-number>
+          <reply-by-date type="date">2016-02-22</reply-by-date>
+          <status>lost</status>
+          <updated-at type="datetime">2017-06-21T20:44:41Z</updated-at>
+          <original-dispute-id>9qde5qgp</original-dispute-id>
+          <status-history type="array">
+            <status-history>
+              <status>open</status>
+              <timestamp type="datetime">2017-06-16T20:44:41Z</timestamp>
+            </status-history>
+            <status-history>
+              <status>lost</status>
+              <timestamp type="datetime">2017-06-25T20:50:55Z</timestamp>
+            </status-history>
+          </status-history>
+          <evidence type="array">
+            <evidence>
+              <id>rxtngk9j5j93tsrq</id>
+              <comments nil="true"/>
+              <created-at type="datetime">2017-06-21T20:44:42Z</created-at>
+              <sent-to-processor-at nil="true"/>
+              <url>s3.amazonaws.com/foo.jpg</url>
+            </evidence>
+            <evidence>
+              <id>88cfb8dd</id>
+              <comments>text evidence</comments>
+              <created-at type="datetime">2017-06-21T20:44:42Z</created-at>
+              <sent-to-processor-at nil="true"/>
+              <url nil="true"/>
+            </evidence>
+          </evidence>
+          <transaction>
+            <id>#{id}</id>
+            <amount>100.00</amount>
+            <created-at>2017-06-21T20:44:41Z</created-at>
+            <order-id nil="true"/>
+            <purchase-order-number nil="true"/>
+            <payment-instrument-subtype>Visa</payment-instrument-subtype>
+          </transaction>
+          <date-opened type=\"date\">2014-03-21</date-opened>
+        </dispute>
+      XML
+    end
+
+    def _new_dispute_won_sample_xml(id)
+      <<-XML
+        <dispute>
+          <id>#{id}</id>
+          <amount>100.00</amount>
+          <amount-disputed>100.00</amount-disputed>
+          <amount-won>95.00</amount-won>
+          <case-number>CASE-12345</case-number>
+          <created-at type="datetime">2017-06-16T20:44:41Z</created-at>
+          <currency-iso-code>USD</currency-iso-code>
+          <forwarded-comments nil="true"/>
+          <kind>chargeback</kind>
+          <merchant-account-id>ytnlulaloidoqwvzxjrdqputg</merchant-account-id>
+          <reason>fraud</reason>
+          <reason-code nil="true"/>
+          <reason-description nil="true"/>
+          <received-date type="date">2016-02-15</received-date>
+          <reference-number>REF-9876</reference-number>
+          <reply-by-date type="date">2016-02-22</reply-by-date>
+          <status>won</status>
+          <updated-at type="datetime">2017-06-21T20:44:41Z</updated-at>
+          <original-dispute-id>9qde5qgp</original-dispute-id>
+          <status-history type="array">
+            <status-history>
+              <status>open</status>
+              <timestamp type="datetime">2017-06-16T20:44:41Z</timestamp>
+            </status-history>
+            <status-history>
+              <status>won</status>
+              <timestamp type="datetime">2017-06-25T20:50:55Z</timestamp>
+            </status-history>
+          </status-history>
+          <evidence type="array">
+            <evidence>
+              <id>rxtngk9j5j93tsrq</id>
+              <comments nil="true"/>
+              <created-at type="datetime">2017-06-21T20:44:42Z</created-at>
+              <sent-to-processor-at nil="true"/>
+              <url>s3.amazonaws.com/foo.jpg</url>
+            </evidence>
+            <evidence>
+              <id>88cfb8dd</id>
+              <comments>text evidence</comments>
+              <created-at type="datetime">2017-06-21T20:44:42Z</created-at>
+              <sent-to-processor-at nil="true"/>
+              <url nil="true"/>
+            </evidence>
+          </evidence>
+          <transaction>
+            <id>#{id}</id>
+            <amount>100.00</amount>
+            <created-at>2017-06-21T20:44:41Z</created-at>
+            <order-id nil="true"/>
+            <purchase-order-number nil="true"/>
+            <payment-instrument-subtype>Visa</payment-instrument-subtype>
           </transaction>
           <date-opened type=\"date\">2014-03-21</date-opened>
           <date-won type=\"date\">2014-03-22</date-won>
@@ -395,15 +581,6 @@ module Braintree
           <currency>EUR</currency>
           <amount>10.00</amount>
           <created-at>2016-11-29T23:27:34.547Z</created-at>
-          <iban-bank-account>
-            <created-at>2016-11-29T23:27:36.386Z</created-at>
-            <description>DESCRIPTION ABC</description>
-            <bic>XXXXNLXX</bic>
-            <iban-country>11</iban-country>
-            <iban-account-number-last-4>0000</iban-account-number-last-4>
-            <masked-iban>NL************0000</masked-iban>
-            <account-holder-name>Account Holder</account-holder-name>
-          </iban-bank-account>
           <approval-url>https://example.com</approval-url>
           <ideal-transaction-id>1234567890</ideal-transaction-id>
         </ideal-payment>