Class: ProcessOut::Product

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Initializes the Product object Params:

client

ProcessOut client instance

data

data that can be used to fill the object



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/processout/product.rb', line 99

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

  self.id = data.fetch(:id, nil)
  self.project = data.fetch(:project, nil)
  self.project_id = data.fetch(:project_id, nil)
  self.url = data.fetch(:url, nil)
  self.name = data.fetch(:name, nil)
  self.amount = data.fetch(:amount, nil)
  self.currency = data.fetch(:currency, nil)
  self.metadata = data.fetch(:metadata, nil)
  self.request_email = data.fetch(:request_email, nil)
  self.request_shipping = data.fetch(:request_shipping, nil)
  self.return_url = data.fetch(:return_url, nil)
  self.cancel_url = data.fetch(:cancel_url, 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.



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

def amount
  @amount
end

#cancel_url ⇒ Object

Returns the value of attribute cancel_url.



21
22
23
 
# File 'lib/processout/product.rb', line 21

def cancel_url
  @cancel_url
end

#created_at ⇒ Object

Returns the value of attribute created_at.



23
24
25
 
# File 'lib/processout/product.rb', line 23

def created_at
  @created_at
end

#currency ⇒ Object

Returns the value of attribute currency.



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

def currency
  @currency
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#metadata ⇒ Object

Returns the value of attribute metadata.



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

def metadata
  @metadata
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#project ⇒ Object

Returns the value of attribute project.



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

def project
  @project
end

#project_id ⇒ Object

Returns the value of attribute project_id.



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

def project_id
  @project_id
end

#request_email ⇒ Object

Returns the value of attribute request_email.



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

def request_email
  @request_email
end

#request_shipping ⇒ Object

Returns the value of attribute request_shipping.



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

def request_shipping
  @request_shipping
end

#return_url ⇒ Object

Returns the value of attribute return_url.



20
21
22
 
# File 'lib/processout/product.rb', line 20

def return_url
  @return_url
end

#sandbox ⇒ Object

Returns the value of attribute sandbox.



22
23
24
 
# File 'lib/processout/product.rb', line 22

def sandbox
  @sandbox
end

#url ⇒ Object

Returns the value of attribute url.



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

def url
  @url
end

Instance Method Details

#all(options = {}) ⇒ Object

Get all the products. Params:

options

Hash of options



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/processout/product.rb', line 229

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

  request = Request.new(@client)
  path    = "/products"
  data    = {

  }

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

  return_values.push(a)
  

  
  return_values[0]
end

#create(options = {}) ⇒ Object

Create a new product. Params:

options

Hash of options



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/processout/product.rb', line 259

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

  request = Request.new(@client)
  path    = "/products"
  data    = {
    "name" => @name, 
    "amount" => @amount, 
    "currency" => @currency, 
    "metadata" => @metadata, 
    "request_email" => @request_email, 
    "request_shipping" => @request_shipping, 
    "return_url" => @return_url, 
    "cancel_url" => @cancel_url
  }

  response = Response.new(request.post(path, data, options))
  return_values = Array.new
  
  body = response.body
  body = body["product"]
  
  
  return_values.push(self.fill_with_data(body))
  

  
  return_values[0]
end

#create_invoice(options = {}) ⇒ Object

Create a new invoice from the product. Params:

options

Hash of options



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/processout/product.rb', line 205

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

  request = Request.new(@client)
  path    = "/products/" + CGI.escape(@id) + "/invoices"
  data    = {

  }

  response = Response.new(request.post(path, data, options))
  return_values = Array.new
  
  body = response.body
  body = body["invoice"]
  invoice = Invoice.new(@client)
  return_values.push(invoice.fill_with_data(body))

  
  return_values[0]
end

#delete(options = {}) ⇒ Object

Delete the product. Params:

options

Hash of options



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/processout/product.rb', line 353

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

  request = Request.new(@client)
  path    = "/products/" + CGI.escape(@id) + ""
  data    = {

  }

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

  
  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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/processout/product.rb', line 127

def fill_with_data(data)
  if data.nil?
    return self
  end
  if data.include? "id"
    self.id = data["id"]
  end
  if data.include? "project"
    self.project = data["project"]
  end
  if data.include? "project_id"
    self.project_id = data["project_id"]
  end
  if data.include? "url"
    self.url = data["url"]
  end
  if data.include? "name"
    self.name = data["name"]
  end
  if data.include? "amount"
    self.amount = data["amount"]
  end
  if data.include? "currency"
    self.currency = data["currency"]
  end
  if data.include? "metadata"
    self.metadata = data["metadata"]
  end
  if data.include? "request_email"
    self.request_email = data["request_email"]
  end
  if data.include? "request_shipping"
    self.request_shipping = data["request_shipping"]
  end
  if data.include? "return_url"
    self.return_url = data["return_url"]
  end
  if data.include? "cancel_url"
    self.cancel_url = data["cancel_url"]
  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(product_id, options = {}) ⇒ Object

Find a product by its ID. Params:

product_id

ID of the product

options

Hash of options



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/processout/product.rb', line 293

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

  request = Request.new(@client)
  path    = "/products/" + CGI.escape(product_id) + ""
  data    = {

  }

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

  
  return_values[0]
end

#new(data = {}) ⇒ Object

Create a new Product using the current client



120
121
122
 
# File 'lib/processout/product.rb', line 120

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

#prefill(data) ⇒ Object

Prefills the object with the data passed as parameters Params:

data

Hash of data



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/processout/product.rb', line 180

def prefill(data)
  if data.nil?
    return self
  end
  self.id = data.fetch(:id, self.id)
  self.project = data.fetch(:project, self.project)
  self.project_id = data.fetch(:project_id, self.project_id)
  self.url = data.fetch(:url, self.url)
  self.name = data.fetch(:name, self.name)
  self.amount = data.fetch(:amount, self.amount)
  self.currency = data.fetch(:currency, self.currency)
  self.metadata = data.fetch(:metadata, self.metadata)
  self.request_email = data.fetch(:request_email, self.request_email)
  self.request_shipping = data.fetch(:request_shipping, self.request_shipping)
  self.return_url = data.fetch(:return_url, self.return_url)
  self.cancel_url = data.fetch(:cancel_url, self.cancel_url)
  self.sandbox = data.fetch(:sandbox, self.sandbox)
  self.created_at = data.fetch(:created_at, self.created_at)
  
  self
end

#save(options = {}) ⇒ Object

Save the updated product attributes. Params:

options

Hash of options



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/processout/product.rb', line 320

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

  request = Request.new(@client)
  path    = "/products/" + CGI.escape(@id) + ""
  data    = {
    "name" => @name, 
    "amount" => @amount, 
    "currency" => @currency, 
    "metadata" => @metadata, 
    "request_email" => @request_email, 
    "request_shipping" => @request_shipping, 
    "return_url" => @return_url, 
    "cancel_url" => @cancel_url
  }

  response = Response.new(request.put(path, data, options))
  return_values = Array.new
  
  body = response.body
  body = body["product"]
  
  
  return_values.push(self.fill_with_data(body))
  

  
  return_values[0]
end