Class: ProcessOut::Plan

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Initializes the Plan object Params:

client

ProcessOut client instance

data

data that can be used to fill the object



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/processout/plan.rb', line 84

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

  @id = data.fetch(:id, "")
  @project = data.fetch(:project, nil)
  @name = data.fetch(:name, "")
  @amount = data.fetch(:amount, "")
  @currency = data.fetch(:currency, "")
  @metadata = data.fetch(:metadata, Hash.new)
  @interval = data.fetch(:interval, "")
  @trial_period = data.fetch(:trial_period, "0d")
  @return_url = data.fetch(:return_url, "")
  @cancel_url = data.fetch(:cancel_url, "")
  @sandbox = data.fetch(:sandbox, false)
  @created_at = data.fetch(:created_at, "")
  
end

Instance Attribute Details

#amount ⇒ Object

Returns the value of attribute amount.



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

def amount
  @amount
end

#cancel_url ⇒ Object

Returns the value of attribute cancel_url.



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

def cancel_url
  @cancel_url
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#currency ⇒ Object

Returns the value of attribute currency.



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

def currency
  @currency
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#interval ⇒ Object

Returns the value of attribute interval.



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

def interval
  @interval
end

#metadata ⇒ Object

Returns the value of attribute metadata.



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

def metadata
  @metadata
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#project ⇒ Object

Returns the value of attribute project.



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

def project
  @project
end

#return_url ⇒ Object

Returns the value of attribute return_url.



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

def return_url
  @return_url
end

#sandbox ⇒ Object

Returns the value of attribute sandbox.



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

def sandbox
  @sandbox
end

#trial_period ⇒ Object

Returns the value of attribute trial_period.



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

def trial_period
  @trial_period
end

Instance Method Details

#all(options = {}) ⇒ Object

Get all the plans. Params:

options

Hash of options



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/processout/plan.rb', line 154

def all(options = {})
  request = Request.new(@client)
  path    = "/plans"
  data    = {

  }

  response = Response.new(request.get(path, data, options))
  return_values = Array.new
  
  a    = Array.new
  body = response.body
  for v in body['plans']
    tmp = Plan.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 plan. Params:

options

Hash of options



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/processout/plan.rb', line 182

def create(options = {})
  request = Request.new(@client)
  path    = "/plans"
  data    = {
    "id" => @id, 
    "name" => @name, 
    "amount" => @amount, 
    "currency" => @currency, 
    "interval" => @interval, 
    "trial_period" => @trial_period, 
    "metadata" => @metadata, 
    "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["plan"]
  
  
  return_values.push(self.fill_with_data(body))
  

  
  return_values[0]
end

#end(options = {}) ⇒ Object

Delete a plan. Subscriptions linked to this plan won’t be affected. Params:

options

Hash of options



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/processout/plan.rb', line 268

def end(options = {})
  request = Request.new(@client)
  path    = "/plans/" + 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



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
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/processout/plan.rb', line 110

def fill_with_data(data)
  if data.include? "id"
    self.id = data["id"]
  end
  if data.include? "project"
    self.project = data["project"]
  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? "interval"
    self.interval = data["interval"]
  end
  if data.include? "trial_period"
    self.trial_period = data["trial_period"]
  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(plan_id, options = {}) ⇒ Object

Find a plan by its ID. Params:

plan_id

ID of the plan

options

Hash of options



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/processout/plan.rb', line 215

def find(plan_id, options = {})
  request = Request.new(@client)
  path    = "/plans/" + CGI.escape(plan_id) + ""
  data    = {

  }

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

  
  return_values[0]
end

#new(data = {}) ⇒ Object

Create a new Plan using the current client



103
104
105
 
# File 'lib/processout/plan.rb', line 103

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

#update(options = {}) ⇒ Object

Update the plan. This action won’t affect subscriptions already linked to this plan. Params:

options

Hash of options



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/processout/plan.rb', line 240

def update(options = {})
  request = Request.new(@client)
  path    = "/plans/" + CGI.escape(@id) + ""
  data    = {
    "name" => @name, 
    "trial_period" => @trial_period, 
    "metadata" => @metadata, 
    "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["plan"]
  
  
  return_values.push(self.fill_with_data(body))
  

  
  return_values[0]
end