Class: Braintree::DisputeGateway

Inherits:
Object
  • Object
show all
Defined in:
lib/braintree/dispute_gateway.rb

Overview

:nodoc:

Instance Method Summary collapse

Constructor Details

#initialize(gateway) ⇒ DisputeGateway

Returns a new instance of DisputeGateway.


3
4
5
6
7
# File 'lib/braintree/dispute_gateway.rb', line 3

def initialize(gateway)
  @gateway = gateway
  @config = gateway.config
  @config.assert_has_access_token_or_keys
end

Instance Method Details

#_fetch_disputes(search, page) ⇒ Object


134
135
136
137
138
139
140
# File 'lib/braintree/dispute_gateway.rb', line 134

def _fetch_disputes(search, page)
  response = @config.http.post("#{@config.base_merchant_path}/disputes/advanced_search?page=#{page}", {:search => search.to_hash, :page => page})
  body = response[:disputes]
  disputes = Util.extract_attribute_as_array(body, :dispute).map { |d| Dispute._new(d) }

  PaginatedResult.new(body[:total_items], body[:page_size], disputes)
end

#accept(dispute_id) ⇒ Object


9
10
11
12
13
14
15
16
17
18
19
20
21
# File 'lib/braintree/dispute_gateway.rb', line 9

def accept(dispute_id)
  raise ArgumentError, "dispute_id contains invalid characters" unless dispute_id.to_s =~ /\A[\w-]+\z/
  raise ArgumentError, "dispute_id cannot be blank" if dispute_id.nil? || dispute_id.to_s.strip == ""

  response = @config.http.put("#{@config.base_merchant_path}/disputes/#{dispute_id}/accept")
  if response[:api_error_response]
    ErrorResult.new(@gateway, response[:api_error_response])
  else
    SuccessfulResult.new
  end
rescue NotFoundError
  raise NotFoundError, "dispute with id #{dispute_id} not found"
end

#add_file_evidence(dispute_id, document_id_or_request) ⇒ Object


23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# File 'lib/braintree/dispute_gateway.rb', line 23

def add_file_evidence(dispute_id, document_id_or_request)
  raise ArgumentError, "dispute_id contains invalid characters" unless dispute_id.to_s =~ /\A[\w-]+\z/
  raise ArgumentError, "dispute_id cannot be blank" if dispute_id.nil? || dispute_id.to_s.strip == ""
  raise ArgumentError, "document_id_or_request cannot be blank" if document_id_or_request.nil?

  request = document_id_or_request.is_a?(Hash) ? document_id_or_request : {document_id: document_id_or_request}

  raise ArgumentError, "document_id contains invalid characters" unless request[:document_id].to_s =~ /\A[\w-]+\z/
  raise ArgumentError, "document_id cannot be blank" if request[:document_id].nil? || dispute_id.to_s.strip == ""
  raise ArgumentError, "category must be a string" if request[:category] && !request[:category].is_a?(String)

  params = {
    evidence: {
      document_upload_id: request[:document_id],
      category: request[:category],
    }
  }
  response = @config.http.post("#{@config.base_merchant_path}/disputes/#{dispute_id}/evidence", params)

  if response[:evidence]
    SuccessfulResult.new(:evidence => Dispute::Evidence.new(response[:evidence]))
  elsif response[:api_error_response]
    ErrorResult.new(@gateway, response[:api_error_response])
  else
    raise "expected :evidence or :api_error_response"
  end
rescue NotFoundError
  raise NotFoundError, "dispute with id #{dispute_id} not found"
end

#add_text_evidence(dispute_id, content_or_request) ⇒ Object


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/braintree/dispute_gateway.rb', line 53

def add_text_evidence(dispute_id, content_or_request)
  raise ArgumentError, "dispute_id contains invalid characters" unless dispute_id.to_s =~ /\A[\w-]+\z/
  raise ArgumentError, "dispute_id cannot be blank" if dispute_id.nil? || dispute_id.to_s.strip == ""
  raise ArgumentError, "content_or_request cannot be blank" if content_or_request.nil?

  request = content_or_request.is_a?(String) ? {content: content_or_request} : content_or_request

  raise ArgumentError, "content cannot be blank" if request[:content].nil? || request[:content].to_s.strip == ""
  raise ArgumentError, "request can only contain the keys [:content, :category, :sequence_number]" if (request.keys - [:category, :content, :sequence_number]).any?
  raise ArgumentError, "sequence_number must be an integer" if request[:sequence_number] && request[:sequence_number].to_s.match(/\D/)
  raise ArgumentError, "category must be a string" if request[:category] && !request[:category].is_a?(String)

  params_for_http_post = {
    evidence: {
      comments: request[:content]
    }.tap do |evidence_params|
      evidence_params[:category] = request[:category] if request[:category]
      evidence_params[:sequence_number] = request[:sequence_number] if request[:sequence_number]
    end
  }
  response = @config.http.post("#{@config.base_merchant_path}/disputes/#{dispute_id}/evidence", params_for_http_post)

  if response[:evidence]
    SuccessfulResult.new(:evidence => Dispute::Evidence.new(response[:evidence]))
  elsif response[:api_error_response]
    ErrorResult.new(@gateway, response[:api_error_response])
  else
    raise "expected :evidence or :api_error_response"
  end
rescue NotFoundError
  raise NotFoundError, "dispute with id #{dispute_id} not found"
end

#finalize(dispute_id) ⇒ Object


86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/braintree/dispute_gateway.rb', line 86

def finalize(dispute_id)
  raise ArgumentError, "dispute_id contains invalid characters" unless dispute_id.to_s =~ /\A[\w-]+\z/
  raise ArgumentError, "dispute_id cannot be blank" if dispute_id.nil? || dispute_id.to_s.strip == ""

  response = @config.http.put("#{@config.base_merchant_path}/disputes/#{dispute_id}/finalize")
  if response[:api_error_response]
    ErrorResult.new(@gateway, response[:api_error_response])
  else
    SuccessfulResult.new
  end
rescue NotFoundError
  raise NotFoundError, "dispute with id #{dispute_id} not found"
end

#find(dispute_id) ⇒ Object


100
101
102
103
104
105
106
107
# File 'lib/braintree/dispute_gateway.rb', line 100

def find(dispute_id)
  raise ArgumentError, "dispute_id contains invalid characters" unless dispute_id.to_s =~ /\A[\w-]+\z/
  raise ArgumentError, "dispute_id cannot be blank" if dispute_id.nil? || dispute_id.to_s.strip == ""
  response = @config.http.get("#{@config.base_merchant_path}/disputes/#{dispute_id}")
  Dispute._new(response[:dispute])
rescue NotFoundError
  raise NotFoundError, "dispute with id #{dispute_id} not found"
end

#remove_evidence(dispute_id, evidence_id) ⇒ Object


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/braintree/dispute_gateway.rb', line 109

def remove_evidence(dispute_id, evidence_id)
  raise ArgumentError, "dispute_id contains invalid characters" unless dispute_id.to_s =~ /\A[\w-]+\z/
  raise ArgumentError, "dispute_id cannot be blank" if dispute_id.nil? || dispute_id.to_s.strip == ""
  raise ArgumentError, "evidence_id contains invalid characters" unless evidence_id.to_s =~ /\A[\w-]+\z/
  raise ArgumentError, "evidence_id cannot be blank" if evidence_id.nil? || evidence_id.to_s.strip == ""

  response = @config.http.delete("#{@config.base_merchant_path}/disputes/#{dispute_id}/evidence/#{evidence_id}")

  if response.respond_to?(:to_hash) && response[:api_error_response]
    ErrorResult.new(@gateway, response[:api_error_response])
  else
    SuccessfulResult.new
  end
rescue NotFoundError
  raise NotFoundError, "evidence with id #{evidence_id} for dispute with id #{dispute_id} not found"
end

#search(&block) ⇒ Object


126
127
128
129
130
131
132
# File 'lib/braintree/dispute_gateway.rb', line 126

def search(&block)
  search = DisputeSearch.new
  block.call(search) if block

  paginated_results = PaginatedCollection.new { |page| _fetch_disputes(search, page) }
  SuccessfulResult.new(:disputes => paginated_results)
end