Class: ProcessOut::Plan
- Inherits:
-
Object
- Object
- ProcessOut::Plan
- Defined in:
- lib/processout/plan.rb
Instance Attribute Summary collapse
-
#amount ⇒ Object
Returns the value of attribute amount.
-
#cancel_url ⇒ Object
Returns the value of attribute cancel_url.
-
#created_at ⇒ Object
Returns the value of attribute created_at.
-
#currency ⇒ Object
Returns the value of attribute currency.
-
#id ⇒ Object
Returns the value of attribute id.
-
#interval ⇒ Object
Returns the value of attribute interval.
-
#metadata ⇒ Object
Returns the value of attribute metadata.
-
#name ⇒ Object
Returns the value of attribute name.
-
#project ⇒ Object
Returns the value of attribute project.
-
#project_id ⇒ Object
Returns the value of attribute project_id.
-
#return_url ⇒ Object
Returns the value of attribute return_url.
-
#sandbox ⇒ Object
Returns the value of attribute sandbox.
-
#trial_period ⇒ Object
Returns the value of attribute trial_period.
-
#url ⇒ Object
Returns the value of attribute url.
Instance Method Summary collapse
-
#all(options = {}) ⇒ Object
Get all the plans.
-
#create(options = {}) ⇒ Object
Create a new plan.
-
#end(options = {}) ⇒ Object
Delete a plan.
-
#fill_with_data(data) ⇒ Object
- Fills the object with data coming from the API Params:
data
-
Hash
of data coming from the API.
- Fills the object with data coming from the API Params:
-
#find(plan_id, options = {}) ⇒ Object
Find a plan by its ID.
-
#initialize(client, data = {}) ⇒ Plan
constructor
- Initializes the Plan object Params:
client
ProcessOut
client instancedata
-
data that can be used to fill the object.
- Initializes the Plan object Params:
-
#new(data = {}) ⇒ Object
Create a new Plan using the current client.
-
#prefill(data) ⇒ Object
- Prefills the object with the data passed as parameters Params:
data
-
Hash
of data.
- Prefills the object with the data passed as parameters Params:
-
#save(options = {}) ⇒ Object
Save the updated plan attributes.
-
#to_json(options) ⇒ Object
Overrides the JSON marshaller to only send the fields we want.
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
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/processout/plan.rb', line 100 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. = data.fetch(:metadata, nil) self.interval = data.fetch(:interval, nil) self.trial_period = data.fetch(:trial_period, 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.
16 17 18 |
# File 'lib/processout/plan.rb', line 16 def amount @amount end |
#cancel_url ⇒ Object
Returns the value of attribute cancel_url.
22 23 24 |
# File 'lib/processout/plan.rb', line 22 def cancel_url @cancel_url end |
#created_at ⇒ Object
Returns the value of attribute created_at.
24 25 26 |
# File 'lib/processout/plan.rb', line 24 def created_at @created_at end |
#currency ⇒ Object
Returns the value of attribute currency.
17 18 19 |
# File 'lib/processout/plan.rb', line 17 def currency @currency end |
#id ⇒ Object
Returns the value of attribute id.
11 12 13 |
# File 'lib/processout/plan.rb', line 11 def id @id end |
#interval ⇒ Object
Returns the value of attribute interval.
19 20 21 |
# File 'lib/processout/plan.rb', line 19 def interval @interval end |
#metadata ⇒ Object
Returns the value of attribute metadata.
18 19 20 |
# File 'lib/processout/plan.rb', line 18 def @metadata end |
#name ⇒ Object
Returns the value of attribute name.
15 16 17 |
# File 'lib/processout/plan.rb', line 15 def name @name end |
#project ⇒ Object
Returns the value of attribute project.
12 13 14 |
# File 'lib/processout/plan.rb', line 12 def project @project end |
#project_id ⇒ Object
Returns the value of attribute project_id.
13 14 15 |
# File 'lib/processout/plan.rb', line 13 def project_id @project_id end |
#return_url ⇒ Object
Returns the value of attribute return_url.
21 22 23 |
# File 'lib/processout/plan.rb', line 21 def return_url @return_url end |
#sandbox ⇒ Object
Returns the value of attribute sandbox.
23 24 25 |
# File 'lib/processout/plan.rb', line 23 def sandbox @sandbox end |
#trial_period ⇒ Object
Returns the value of attribute trial_period.
20 21 22 |
# File 'lib/processout/plan.rb', line 20 def trial_period @trial_period end |
#url ⇒ Object
Returns the value of attribute url.
14 15 16 |
# File 'lib/processout/plan.rb', line 14 def url @url end |
Instance Method Details
#all(options = {}) ⇒ Object
Get all the plans. Params:
options
-
Hash
of options
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/processout/plan.rb', line 226 def all( = {}) self.prefill() request = Request.new(@client) path = "/plans" data = { } response = Response.new(request.get(path, data, )) 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
256 257 258 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 |
# File 'lib/processout/plan.rb', line 256 def create( = {}) self.prefill() 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, )) 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
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 |
# File 'lib/processout/plan.rb', line 348 def end( = {}) self.prefill() request = Request.new(@client) path = "/plans/" + CGI.escape(@id) + "" data = { } response = Response.new(request.delete(path, data, )) 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
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 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
# File 'lib/processout/plan.rb', line 148 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. = 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
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 |
# File 'lib/processout/plan.rb', line 291 def find(plan_id, = {}) self.prefill() request = Request.new(@client) path = "/plans/" + CGI.escape(plan_id) + "" data = { } response = Response.new(request.get(path, data, )) 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
121 122 123 |
# File 'lib/processout/plan.rb', line 121 def new(data = {}) Plan.new(@client, data) end |
#prefill(data) ⇒ Object
Prefills the object with the data passed as parameters Params:
data
-
Hash
of data
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/processout/plan.rb', line 201 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. = data.fetch(:metadata, self.) self.interval = data.fetch(:interval, self.interval) self.trial_period = data.fetch(:trial_period, self.trial_period) 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 plan attributes. This action won’t affect subscriptions already linked to this plan. Params:
options
-
Hash
of options
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 |
# File 'lib/processout/plan.rb', line 318 def save( = {}) self.prefill() 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, )) return_values = Array.new body = response.body body = body["plan"] return_values.push(self.fill_with_data(body)) return_values[0] end |
#to_json(options) ⇒ Object
Overrides the JSON marshaller to only send the fields we want
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/processout/plan.rb', line 126 def to_json() { "id": self.id, "project": self.project, "project_id": self.project_id, "url": self.url, "name": self.name, "amount": self.amount, "currency": self.currency, "metadata": self., "interval": self.interval, "trial_period": self.trial_period, "return_url": self.return_url, "cancel_url": self.cancel_url, "sandbox": self.sandbox, "created_at": self.created_at, }.to_json end |