Class: ProcessOut::Refund

Inherits:
Object
  • Object
show all
Defined in:
lib/processout/refund.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client, data = {}) ⇒ Refund

Initializes the Refund object Params:

client

ProcessOut client instance

data

data that can be used to fill the object



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/processout/refund.rb', line 79

def initialize(client, data = {})
  @client = client

  self.id = data.fetch(:id, nil)
  self.transaction = data.fetch(:transaction, nil)
  self.transaction_id = data.fetch(:transaction_id, nil)
  self.amount = data.fetch(:amount, nil)
  self.reason = data.fetch(:reason, nil)
  self.information = data.fetch(:information, nil)
  self.has_failed = data.fetch(:has_failed, nil)
  self.metadata = data.fetch(:metadata, nil)
  self.sandbox = data.fetch(:sandbox, nil)
  self.created_at = data.fetch(:created_at, nil)
  
end

Instance Attribute Details

#amount ⇒ Object

Returns the value of attribute amount.



13
14
15
 
# File 'lib/processout/refund.rb', line 13

def amount
  @amount
end

#created_at ⇒ Object

Returns the value of attribute created_at.



19
20
21
 
# File 'lib/processout/refund.rb', line 19

def created_at
  @created_at
end

#has_failed ⇒ Object

Returns the value of attribute has_failed.



16
17
18
 
# File 'lib/processout/refund.rb', line 16

def has_failed
  @has_failed
end

#id ⇒ Object

Returns the value of attribute id.



10
11
12
 
# File 'lib/processout/refund.rb', line 10

def id
  @id
end

#information ⇒ Object

Returns the value of attribute information.



15
16
17
 
# File 'lib/processout/refund.rb', line 15

def information
  @information
end

#metadata ⇒ Object

Returns the value of attribute metadata.



17
18
19
 
# File 'lib/processout/refund.rb', line 17

def metadata
  @metadata
end

#reason ⇒ Object

Returns the value of attribute reason.



14
15
16
 
# File 'lib/processout/refund.rb', line 14

def reason
  @reason
end

#sandbox ⇒ Object

Returns the value of attribute sandbox.



18
19
20
 
# File 'lib/processout/refund.rb', line 18

def sandbox
  @sandbox
end

#transaction ⇒ Object

Returns the value of attribute transaction.



11
12
13
 
# File 'lib/processout/refund.rb', line 11

def transaction
  @transaction
end

#transaction_id ⇒ Object

Returns the value of attribute transaction_id.



12
13
14
 
# File 'lib/processout/refund.rb', line 12

def transaction_id
  @transaction_id
end

Instance Method Details

#create(options = {}) ⇒ Object

Create a refund for a transaction. Params:

options

Hash of options



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/processout/refund.rb', line 225

def create(options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/transactions/" + CGI.escape(@transaction_id) + "/refunds"
  data    = {
    "amount" => @amount, 
    "metadata" => @metadata, 
    "reason" => @reason, 
    "information" => @information
  }

  response = Response.new(request.post(path, data, options))
  return_values = Array.new
  
  return_values.push(response.success)

  
  return_values[0]
end

#fetch_transaction_refunds(transaction_id, options = {}) ⇒ Object

Get the transaction’s refunds. Params:

transaction_id

ID of the transaction

options

Hash of options



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/processout/refund.rb', line 166

def fetch_transaction_refunds(transaction_id, options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/transactions/" + CGI.escape(transaction_id) + "/refunds"
  data    = {

  }

  response = Response.new(request.get(path, data, options))
  return_values = Array.new
  
  a    = Array.new
  body = response.body
  for v in body['refunds']
    tmp = Refund.new(@client)
    tmp.fill_with_data(v)
    a.push(tmp)
  end

  return_values.push(a)
  

  
  return_values[0]
end

#fill_with_data(data) ⇒ Object

Fills the object with data coming from the API Params:

data

Hash of data coming from the API



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/processout/refund.rb', line 103

def fill_with_data(data)
  if data.nil?
    return self
  end
  if data.include? "id"
    self.id = data["id"]
  end
  if data.include? "transaction"
    self.transaction = data["transaction"]
  end
  if data.include? "transaction_id"
    self.transaction_id = data["transaction_id"]
  end
  if data.include? "amount"
    self.amount = data["amount"]
  end
  if data.include? "reason"
    self.reason = data["reason"]
  end
  if data.include? "information"
    self.information = data["information"]
  end
  if data.include? "has_failed"
    self.has_failed = data["has_failed"]
  end
  if data.include? "metadata"
    self.metadata = data["metadata"]
  end
  if data.include? "sandbox"
    self.sandbox = data["sandbox"]
  end
  if data.include? "created_at"
    self.created_at = data["created_at"]
  end
  
  self
end

#find(transaction_id, refund_id, options = {}) ⇒ Object

Find a transaction’s refund by its ID. Params:

transaction_id

ID of the transaction on which the refund was applied

refund_id

ID of the refund

options

Hash of options



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/processout/refund.rb', line 198

def find(transaction_id, refund_id, options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/transactions/" + CGI.escape(transaction_id) + "/refunds/" + CGI.escape(refund_id) + ""
  data    = {

  }

  response = Response.new(request.get(path, data, options))
  return_values = Array.new
  
  body = response.body
  body = body["refund"]
  
  
  obj = Refund.new(@client)
  return_values.push(obj.fill_with_data(body))
  

  
  return_values[0]
end

#new(data = {}) ⇒ Object

Create a new Refund using the current client



96
97
98
 
# File 'lib/processout/refund.rb', line 96

def new(data = {})
  Refund.new(@client, data)
end

#prefill(data) ⇒ Object

Prefills the object with the data passed as parameters Params:

data

Hash of data



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/processout/refund.rb', line 144

def prefill(data)
  if data.nil?
    return self
  end
  self.id = data.fetch(:id, self.id)
  self.transaction = data.fetch(:transaction, self.transaction)
  self.transaction_id = data.fetch(:transaction_id, self.transaction_id)
  self.amount = data.fetch(:amount, self.amount)
  self.reason = data.fetch(:reason, self.reason)
  self.information = data.fetch(:information, self.information)
  self.has_failed = data.fetch(:has_failed, self.has_failed)
  self.metadata = data.fetch(:metadata, self.metadata)
  self.sandbox = data.fetch(:sandbox, self.sandbox)
  self.created_at = data.fetch(:created_at, self.created_at)
  
  self
end