digital_ocean 0.0.1 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +0 -1
- data/CHANGELOG.md +40 -0
- data/LICENSE.txt +1 -1
- data/README.md +114 -2
- data/digital_ocean.gemspec +1 -0
- data/doc/DigitalOcean/API.html +844 -0
- data/doc/DigitalOcean/AuthenticationMiddleware.html +342 -0
- data/doc/DigitalOcean/Resource/Base.html +206 -0
- data/doc/DigitalOcean/Resource/Droplet.html +1016 -0
- data/doc/DigitalOcean/Resource/Image.html +312 -0
- data/doc/DigitalOcean/Resource/Region.html +247 -0
- data/doc/DigitalOcean/Resource/SSHKey.html +312 -0
- data/doc/DigitalOcean/Resource/Size.html +208 -0
- data/doc/DigitalOcean/Resource.html +117 -0
- data/doc/DigitalOcean.html +131 -0
- data/doc/_index.html +213 -0
- data/doc/class_list.html +53 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +328 -0
- data/doc/file.README.html +402 -0
- data/doc/file_list.html +55 -0
- data/doc/frames.html +28 -0
- data/doc/index.html +402 -0
- data/doc/js/app.js +214 -0
- data/doc/js/full_list.js +173 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +332 -0
- data/doc/top-level-namespace.html +112 -0
- data/lib/digital_ocean/api.rb +28 -0
- data/lib/digital_ocean/resource/droplet.rb +2 -2
- data/lib/digital_ocean/resource/region.rb +3 -0
- data/lib/digital_ocean/version.rb +1 -1
- data/spec/api_spec.rb +8 -4
- data/spec/vcr/cassettes/DigitalOcean_API/_droplets/_create/should_be_successful.yml +7 -5
- data/spec/vcr/cassettes/DigitalOcean_API/_droplets/_create/should_return_droplet_id.yml +50 -0
- data/spec/vcr/cassettes/DigitalOcean_API/_droplets/_delete/should_be_successful.yml +8 -6
- data/spec/vcr/cassettes/DigitalOcean_API/_droplets/_disable_backups/should_be_successful.yml +8 -6
- data/spec/vcr/cassettes/DigitalOcean_API/_droplets/_enable_backups/should_be_successful.yml +8 -6
- data/spec/vcr/cassettes/DigitalOcean_API/_droplets/_list/should_be_successful.yml +7 -5
- data/spec/vcr/cassettes/DigitalOcean_API/_droplets/_list/should_return_a_list_of_all_droplets.yml +7 -5
- data/spec/vcr/cassettes/DigitalOcean_API/_droplets/{_reset_root_password → _password_reset}/should_be_successful.yml +10 -9
- data/spec/vcr/cassettes/DigitalOcean_API/_droplets/_power_cycle/should_be_successful.yml +8 -6
- data/spec/vcr/cassettes/DigitalOcean_API/_droplets/_power_off/should_be_successful.yml +8 -6
- data/spec/vcr/cassettes/DigitalOcean_API/_droplets/_power_on/should_be_successful.yml +8 -6
- data/spec/vcr/cassettes/DigitalOcean_API/_droplets/_reboot/should_be_successful.yml +8 -6
- data/spec/vcr/cassettes/DigitalOcean_API/_droplets/_rebuild/should_be_successful.yml +8 -6
- data/spec/vcr/cassettes/DigitalOcean_API/_droplets/_resize/should_be_successful.yml +8 -6
- data/spec/vcr/cassettes/DigitalOcean_API/_droplets/_restore/should_be_successful.yml +1 -1
- data/spec/vcr/cassettes/DigitalOcean_API/_droplets/_show/should_be_successful.yml +6 -4
- data/spec/vcr/cassettes/DigitalOcean_API/_droplets/_shutdown/should_be_successful.yml +8 -6
- data/spec/vcr/cassettes/DigitalOcean_API/_droplets/_snapshot/should_be_successful.yml +8 -6
- metadata +34 -7
@@ -0,0 +1,844 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
6
|
+
<title>
|
7
|
+
Class: DigitalOcean::API
|
8
|
+
|
9
|
+
— Documentation by YARD 0.8.3
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
19
|
+
relpath = '../';
|
20
|
+
framesUrl = "../frames.html#!" + escape(window.location.href);
|
21
|
+
</script>
|
22
|
+
|
23
|
+
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
25
|
+
|
26
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
27
|
+
|
28
|
+
|
29
|
+
</head>
|
30
|
+
<body>
|
31
|
+
<div id="header">
|
32
|
+
<div id="menu">
|
33
|
+
|
34
|
+
<a href="../_index.html">Index (A)</a> »
|
35
|
+
<span class='title'><span class='object_link'><a href="../DigitalOcean.html" title="DigitalOcean (module)">DigitalOcean</a></span></span>
|
36
|
+
»
|
37
|
+
<span class="title">API</span>
|
38
|
+
|
39
|
+
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
41
|
+
</div>
|
42
|
+
|
43
|
+
<div id="search">
|
44
|
+
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
46
|
+
href="../class_list.html">
|
47
|
+
Class List
|
48
|
+
</a>
|
49
|
+
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
51
|
+
href="../method_list.html">
|
52
|
+
Method List
|
53
|
+
</a>
|
54
|
+
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
56
|
+
href="../file_list.html">
|
57
|
+
File List
|
58
|
+
</a>
|
59
|
+
|
60
|
+
</div>
|
61
|
+
<div class="clear"></div>
|
62
|
+
</div>
|
63
|
+
|
64
|
+
<iframe id="search_frame"></iframe>
|
65
|
+
|
66
|
+
<div id="content"><h1>Class: DigitalOcean::API
|
67
|
+
|
68
|
+
|
69
|
+
|
70
|
+
</h1>
|
71
|
+
|
72
|
+
<dl class="box">
|
73
|
+
|
74
|
+
<dt class="r1">Inherits:</dt>
|
75
|
+
<dd class="r1">
|
76
|
+
<span class="inheritName">Object</span>
|
77
|
+
|
78
|
+
<ul class="fullTree">
|
79
|
+
<li>Object</li>
|
80
|
+
|
81
|
+
<li class="next">DigitalOcean::API</li>
|
82
|
+
|
83
|
+
</ul>
|
84
|
+
<a href="#" class="inheritanceTree">show all</a>
|
85
|
+
|
86
|
+
</dd>
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
<dt class="r2 last">Defined in:</dt>
|
97
|
+
<dd class="r2 last">lib/digital_ocean/api.rb</dd>
|
98
|
+
|
99
|
+
</dl>
|
100
|
+
<div class="clear"></div>
|
101
|
+
|
102
|
+
|
103
|
+
|
104
|
+
|
105
|
+
|
106
|
+
|
107
|
+
|
108
|
+
|
109
|
+
|
110
|
+
<h2>
|
111
|
+
Instance Method Summary
|
112
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
113
|
+
</h2>
|
114
|
+
|
115
|
+
<ul class="summary">
|
116
|
+
|
117
|
+
<li class="public ">
|
118
|
+
<span class="summary_signature">
|
119
|
+
|
120
|
+
<a href="#default_faraday-instance_method" title="#default_faraday (instance method)">- (Object) <strong>default_faraday</strong> </a>
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
</span>
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
135
|
+
|
136
|
+
</li>
|
137
|
+
|
138
|
+
|
139
|
+
<li class="public ">
|
140
|
+
<span class="summary_signature">
|
141
|
+
|
142
|
+
<a href="#droplets-instance_method" title="#droplets (instance method)">- (DigitalOcean::Resource::Droplet) <strong>droplets</strong> </a>
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
</span>
|
147
|
+
|
148
|
+
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
<span class="summary_desc"><div class='inline'>
|
157
|
+
<p>Access Droplets (virtual machines).</p>
|
158
|
+
</div></span>
|
159
|
+
|
160
|
+
</li>
|
161
|
+
|
162
|
+
|
163
|
+
<li class="public ">
|
164
|
+
<span class="summary_signature">
|
165
|
+
|
166
|
+
<a href="#images-instance_method" title="#images (instance method)">- (DigitalOcean::Resource::Image) <strong>images</strong> </a>
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
</span>
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
<span class="summary_desc"><div class='inline'>
|
181
|
+
<p>Access Images (Snapshots, Backups).</p>
|
182
|
+
</div></span>
|
183
|
+
|
184
|
+
</li>
|
185
|
+
|
186
|
+
|
187
|
+
<li class="public ">
|
188
|
+
<span class="summary_signature">
|
189
|
+
|
190
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (API) <strong>initialize</strong>(params) </a>
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
</span>
|
195
|
+
|
196
|
+
|
197
|
+
<span class="note title constructor">constructor</span>
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
<span class="summary_desc"><div class='inline'>
|
207
|
+
<p>Creates a new API client instance.</p>
|
208
|
+
</div></span>
|
209
|
+
|
210
|
+
</li>
|
211
|
+
|
212
|
+
|
213
|
+
<li class="public ">
|
214
|
+
<span class="summary_signature">
|
215
|
+
|
216
|
+
<a href="#regions-instance_method" title="#regions (instance method)">- (DigitalOcean::Resource::Region) <strong>regions</strong> </a>
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
</span>
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
|
230
|
+
<span class="summary_desc"><div class='inline'>
|
231
|
+
<p>Access Regions (data center location).</p>
|
232
|
+
</div></span>
|
233
|
+
|
234
|
+
</li>
|
235
|
+
|
236
|
+
|
237
|
+
<li class="public ">
|
238
|
+
<span class="summary_signature">
|
239
|
+
|
240
|
+
<a href="#sizes-instance_method" title="#sizes (instance method)">- (DigitalOcean::Resource::Size) <strong>sizes</strong> </a>
|
241
|
+
|
242
|
+
|
243
|
+
|
244
|
+
</span>
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
|
251
|
+
|
252
|
+
|
253
|
+
|
254
|
+
<span class="summary_desc"><div class='inline'>
|
255
|
+
<p>Access Sizes (virtual machine types/sizes).</p>
|
256
|
+
</div></span>
|
257
|
+
|
258
|
+
</li>
|
259
|
+
|
260
|
+
|
261
|
+
<li class="public ">
|
262
|
+
<span class="summary_signature">
|
263
|
+
|
264
|
+
<a href="#ssh_keys-instance_method" title="#ssh_keys (instance method)">- (DigitalOcean::Resource::SSHKey) <strong>ssh_keys</strong> </a>
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
</span>
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
|
278
|
+
<span class="summary_desc"><div class='inline'>
|
279
|
+
<p>Access SSH keys.</p>
|
280
|
+
</div></span>
|
281
|
+
|
282
|
+
</li>
|
283
|
+
|
284
|
+
|
285
|
+
</ul>
|
286
|
+
|
287
|
+
|
288
|
+
<div id="constructor_details" class="method_details_list">
|
289
|
+
<h2>Constructor Details</h2>
|
290
|
+
|
291
|
+
<div class="method_details first">
|
292
|
+
<h3 class="signature first" id="initialize-instance_method">
|
293
|
+
|
294
|
+
- (<tt><span class='object_link'><a href="" title="DigitalOcean::API (class)">API</a></span></tt>) <strong>initialize</strong>(params)
|
295
|
+
|
296
|
+
|
297
|
+
|
298
|
+
|
299
|
+
|
300
|
+
</h3><div class="docstring">
|
301
|
+
<div class="discussion">
|
302
|
+
|
303
|
+
<p>Creates a new API client instance.</p>
|
304
|
+
|
305
|
+
|
306
|
+
</div>
|
307
|
+
</div>
|
308
|
+
<div class="tags">
|
309
|
+
|
310
|
+
<div class="examples">
|
311
|
+
<p class="tag_title">Examples:</p>
|
312
|
+
|
313
|
+
|
314
|
+
<pre class="example code"><span class='id identifier rubyid_client'>client</span> <span class='op'>=</span> <span class='const'>DigitalOcean</span><span class='op'>::</span><span class='const'>API</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='symbol'>:client_id</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>######</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:api_key</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>#######</span><span class='tstring_end'>'</span></span></pre>
|
315
|
+
|
316
|
+
</div>
|
317
|
+
<p class="tag_title">Parameters:</p>
|
318
|
+
<ul class="param">
|
319
|
+
|
320
|
+
<li>
|
321
|
+
|
322
|
+
<span class='name'>params</span>
|
323
|
+
|
324
|
+
|
325
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
326
|
+
|
327
|
+
|
328
|
+
|
329
|
+
</li>
|
330
|
+
|
331
|
+
</ul>
|
332
|
+
|
333
|
+
|
334
|
+
|
335
|
+
|
336
|
+
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
|
337
|
+
<ul class="option">
|
338
|
+
|
339
|
+
<li>
|
340
|
+
<span class="name">:client_id</span>
|
341
|
+
<span class="type">(<tt>String</tt>)</span>
|
342
|
+
<span class="default">
|
343
|
+
|
344
|
+
</span>
|
345
|
+
|
346
|
+
— <div class='inline'>
|
347
|
+
<p>The client_id (required)</p>
|
348
|
+
</div>
|
349
|
+
|
350
|
+
</li>
|
351
|
+
|
352
|
+
<li>
|
353
|
+
<span class="name">:api_key</span>
|
354
|
+
<span class="type">(<tt>String</tt>)</span>
|
355
|
+
<span class="default">
|
356
|
+
|
357
|
+
</span>
|
358
|
+
|
359
|
+
— <div class='inline'>
|
360
|
+
<p>The api_key (required)</p>
|
361
|
+
</div>
|
362
|
+
|
363
|
+
</li>
|
364
|
+
|
365
|
+
<li>
|
366
|
+
<span class="name">:base_url</span>
|
367
|
+
<span class="type">(<tt>String</tt>)</span>
|
368
|
+
<span class="default">
|
369
|
+
|
370
|
+
— default:
|
371
|
+
<tt>'https://api.digitalocean.com/'</tt>
|
372
|
+
|
373
|
+
</span>
|
374
|
+
|
375
|
+
— <div class='inline'>
|
376
|
+
<p>API base url</p>
|
377
|
+
</div>
|
378
|
+
|
379
|
+
</li>
|
380
|
+
|
381
|
+
<li>
|
382
|
+
<span class="name">:faraday_adapter</span>
|
383
|
+
<span class="type">(<tt>Symbol</tt>)</span>
|
384
|
+
<span class="default">
|
385
|
+
|
386
|
+
— default:
|
387
|
+
<tt>'Faraday.default_adapter'</tt>
|
388
|
+
|
389
|
+
</span>
|
390
|
+
|
391
|
+
— <div class='inline'>
|
392
|
+
<p>Faraday adapter/http client library to use.</p>
|
393
|
+
</div>
|
394
|
+
|
395
|
+
</li>
|
396
|
+
|
397
|
+
</ul>
|
398
|
+
|
399
|
+
|
400
|
+
<p class="tag_title">Raises:</p>
|
401
|
+
<ul class="raise">
|
402
|
+
|
403
|
+
<li>
|
404
|
+
|
405
|
+
|
406
|
+
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
407
|
+
|
408
|
+
|
409
|
+
|
410
|
+
—
|
411
|
+
<div class='inline'>
|
412
|
+
<p>when no client_id is provided</p>
|
413
|
+
</div>
|
414
|
+
|
415
|
+
</li>
|
416
|
+
|
417
|
+
<li>
|
418
|
+
|
419
|
+
|
420
|
+
<span class='type'>(<tt>ArgumentError</tt>)</span>
|
421
|
+
|
422
|
+
|
423
|
+
|
424
|
+
—
|
425
|
+
<div class='inline'>
|
426
|
+
<p>when no api_key is provided</p>
|
427
|
+
</div>
|
428
|
+
|
429
|
+
</li>
|
430
|
+
|
431
|
+
</ul>
|
432
|
+
|
433
|
+
<p class="tag_title">See Also:</p>
|
434
|
+
<ul class="see">
|
435
|
+
|
436
|
+
<li>[Faraday]</li>
|
437
|
+
|
438
|
+
</ul>
|
439
|
+
|
440
|
+
</div><table class="source_code">
|
441
|
+
<tr>
|
442
|
+
<td>
|
443
|
+
<pre class="lines">
|
444
|
+
|
445
|
+
|
446
|
+
16
|
447
|
+
17
|
448
|
+
18
|
449
|
+
19
|
450
|
+
20
|
451
|
+
21
|
452
|
+
22
|
453
|
+
23
|
454
|
+
24
|
455
|
+
25
|
456
|
+
26</pre>
|
457
|
+
</td>
|
458
|
+
<td>
|
459
|
+
<pre class="code"><span class="info file"># File 'lib/digital_ocean/api.rb', line 16</span>
|
460
|
+
|
461
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
462
|
+
<span class='ivar'>@client_id</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:client_id</span><span class='rbracket'>]</span>
|
463
|
+
<span class='ivar'>@api_key</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:api_key</span><span class='rbracket'>]</span>
|
464
|
+
<span class='ivar'>@debug</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:debug</span><span class='rbracket'>]</span>
|
465
|
+
<span class='ivar'>@base_url</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:base_url</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://api.digitalocean.com/</span><span class='tstring_end'>'</span></span>
|
466
|
+
<span class='ivar'>@faraday_adapter</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:faraday_adapter</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='const'>Faraday</span><span class='period'>.</span><span class='id identifier rubyid_default_adapter'>default_adapter</span>
|
467
|
+
<span class='ivar'>@faraday</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:faraday</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_default_faraday'>default_faraday</span>
|
468
|
+
|
469
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>:client_id missing</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span> <span class='ivar'>@client_id</span>
|
470
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>:api_key missing</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span> <span class='ivar'>@api_key</span>
|
471
|
+
<span class='kw'>end</span></pre>
|
472
|
+
</td>
|
473
|
+
</tr>
|
474
|
+
</table>
|
475
|
+
</div>
|
476
|
+
|
477
|
+
</div>
|
478
|
+
|
479
|
+
|
480
|
+
<div id="instance_method_details" class="method_details_list">
|
481
|
+
<h2>Instance Method Details</h2>
|
482
|
+
|
483
|
+
|
484
|
+
<div class="method_details first">
|
485
|
+
<h3 class="signature first" id="default_faraday-instance_method">
|
486
|
+
|
487
|
+
- (<tt>Object</tt>) <strong>default_faraday</strong>
|
488
|
+
|
489
|
+
|
490
|
+
|
491
|
+
|
492
|
+
|
493
|
+
</h3><table class="source_code">
|
494
|
+
<tr>
|
495
|
+
<td>
|
496
|
+
<pre class="lines">
|
497
|
+
|
498
|
+
|
499
|
+
63
|
500
|
+
64
|
501
|
+
65
|
502
|
+
66
|
503
|
+
67
|
504
|
+
68
|
505
|
+
69
|
506
|
+
70
|
507
|
+
71
|
508
|
+
72</pre>
|
509
|
+
</td>
|
510
|
+
<td>
|
511
|
+
<pre class="code"><span class="info file"># File 'lib/digital_ocean/api.rb', line 63</span>
|
512
|
+
|
513
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_default_faraday'>default_faraday</span>
|
514
|
+
<span class='const'>Faraday</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='symbol'>:url</span> <span class='op'>=></span> <span class='ivar'>@base_url</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_faraday'>faraday</span><span class='op'>|</span>
|
515
|
+
<span class='id identifier rubyid_faraday'>faraday</span><span class='period'>.</span><span class='id identifier rubyid_use'>use</span> <span class='const'>AuthenticationMiddleware</span><span class='comma'>,</span> <span class='ivar'>@client_id</span><span class='comma'>,</span> <span class='ivar'>@api_key</span>
|
516
|
+
<span class='id identifier rubyid_faraday'>faraday</span><span class='period'>.</span><span class='id identifier rubyid_request'>request</span> <span class='symbol'>:url_encoded</span>
|
517
|
+
<span class='id identifier rubyid_faraday'>faraday</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span> <span class='symbol'>:rashify</span>
|
518
|
+
<span class='id identifier rubyid_faraday'>faraday</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span> <span class='symbol'>:json</span>
|
519
|
+
<span class='id identifier rubyid_faraday'>faraday</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='lparen'>(</span><span class='symbol'>:logger</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='ivar'>@debug</span>
|
520
|
+
<span class='id identifier rubyid_faraday'>faraday</span><span class='period'>.</span><span class='id identifier rubyid_adapter'>adapter</span> <span class='ivar'>@faraday_adapter</span>
|
521
|
+
<span class='kw'>end</span>
|
522
|
+
<span class='kw'>end</span></pre>
|
523
|
+
</td>
|
524
|
+
</tr>
|
525
|
+
</table>
|
526
|
+
</div>
|
527
|
+
|
528
|
+
<div class="method_details ">
|
529
|
+
<h3 class="signature " id="droplets-instance_method">
|
530
|
+
|
531
|
+
- (<tt><span class='object_link'><a href="Resource/Droplet.html" title="DigitalOcean::Resource::Droplet (class)">DigitalOcean::Resource::Droplet</a></span></tt>) <strong>droplets</strong>
|
532
|
+
|
533
|
+
|
534
|
+
|
535
|
+
|
536
|
+
|
537
|
+
</h3><div class="docstring">
|
538
|
+
<div class="discussion">
|
539
|
+
|
540
|
+
<p>Access Droplets (virtual machines)</p>
|
541
|
+
|
542
|
+
|
543
|
+
</div>
|
544
|
+
</div>
|
545
|
+
<div class="tags">
|
546
|
+
|
547
|
+
<p class="tag_title">Returns:</p>
|
548
|
+
<ul class="return">
|
549
|
+
|
550
|
+
<li>
|
551
|
+
|
552
|
+
|
553
|
+
<span class='type'>(<tt><span class='object_link'><a href="Resource/Droplet.html" title="DigitalOcean::Resource::Droplet (class)">DigitalOcean::Resource::Droplet</a></span></tt>)</span>
|
554
|
+
|
555
|
+
|
556
|
+
|
557
|
+
</li>
|
558
|
+
|
559
|
+
</ul>
|
560
|
+
|
561
|
+
<p class="tag_title">See Also:</p>
|
562
|
+
<ul class="see">
|
563
|
+
|
564
|
+
<li><span class='object_link'><a href="Resource/Droplet.html" title="DigitalOcean::Resource::Droplet (class)">Resource::Droplet</a></span></li>
|
565
|
+
|
566
|
+
</ul>
|
567
|
+
|
568
|
+
</div><table class="source_code">
|
569
|
+
<tr>
|
570
|
+
<td>
|
571
|
+
<pre class="lines">
|
572
|
+
|
573
|
+
|
574
|
+
31
|
575
|
+
32
|
576
|
+
33</pre>
|
577
|
+
</td>
|
578
|
+
<td>
|
579
|
+
<pre class="code"><span class="info file"># File 'lib/digital_ocean/api.rb', line 31</span>
|
580
|
+
|
581
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_droplets'>droplets</span>
|
582
|
+
<span class='const'>DigitalOcean</span><span class='op'>::</span><span class='const'>Resource</span><span class='op'>::</span><span class='const'>Droplet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@faraday</span><span class='rparen'>)</span>
|
583
|
+
<span class='kw'>end</span></pre>
|
584
|
+
</td>
|
585
|
+
</tr>
|
586
|
+
</table>
|
587
|
+
</div>
|
588
|
+
|
589
|
+
<div class="method_details ">
|
590
|
+
<h3 class="signature " id="images-instance_method">
|
591
|
+
|
592
|
+
- (<tt><span class='object_link'><a href="Resource/Image.html" title="DigitalOcean::Resource::Image (class)">DigitalOcean::Resource::Image</a></span></tt>) <strong>images</strong>
|
593
|
+
|
594
|
+
|
595
|
+
|
596
|
+
|
597
|
+
|
598
|
+
</h3><div class="docstring">
|
599
|
+
<div class="discussion">
|
600
|
+
|
601
|
+
<p>Access Images (Snapshots, Backups)</p>
|
602
|
+
|
603
|
+
|
604
|
+
</div>
|
605
|
+
</div>
|
606
|
+
<div class="tags">
|
607
|
+
|
608
|
+
<p class="tag_title">Returns:</p>
|
609
|
+
<ul class="return">
|
610
|
+
|
611
|
+
<li>
|
612
|
+
|
613
|
+
|
614
|
+
<span class='type'>(<tt><span class='object_link'><a href="Resource/Image.html" title="DigitalOcean::Resource::Image (class)">DigitalOcean::Resource::Image</a></span></tt>)</span>
|
615
|
+
|
616
|
+
|
617
|
+
|
618
|
+
</li>
|
619
|
+
|
620
|
+
</ul>
|
621
|
+
|
622
|
+
<p class="tag_title">See Also:</p>
|
623
|
+
<ul class="see">
|
624
|
+
|
625
|
+
<li><span class='object_link'><a href="Resource/Image.html" title="DigitalOcean::Resource::Image (class)">Resource::Image</a></span></li>
|
626
|
+
|
627
|
+
</ul>
|
628
|
+
|
629
|
+
</div><table class="source_code">
|
630
|
+
<tr>
|
631
|
+
<td>
|
632
|
+
<pre class="lines">
|
633
|
+
|
634
|
+
|
635
|
+
59
|
636
|
+
60
|
637
|
+
61</pre>
|
638
|
+
</td>
|
639
|
+
<td>
|
640
|
+
<pre class="code"><span class="info file"># File 'lib/digital_ocean/api.rb', line 59</span>
|
641
|
+
|
642
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_images'>images</span>
|
643
|
+
<span class='const'>DigitalOcean</span><span class='op'>::</span><span class='const'>Resource</span><span class='op'>::</span><span class='const'>Image</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@faraday</span><span class='rparen'>)</span>
|
644
|
+
<span class='kw'>end</span></pre>
|
645
|
+
</td>
|
646
|
+
</tr>
|
647
|
+
</table>
|
648
|
+
</div>
|
649
|
+
|
650
|
+
<div class="method_details ">
|
651
|
+
<h3 class="signature " id="regions-instance_method">
|
652
|
+
|
653
|
+
- (<tt><span class='object_link'><a href="Resource/Region.html" title="DigitalOcean::Resource::Region (class)">DigitalOcean::Resource::Region</a></span></tt>) <strong>regions</strong>
|
654
|
+
|
655
|
+
|
656
|
+
|
657
|
+
|
658
|
+
|
659
|
+
</h3><div class="docstring">
|
660
|
+
<div class="discussion">
|
661
|
+
|
662
|
+
<p>Access Regions (data center location)</p>
|
663
|
+
|
664
|
+
|
665
|
+
</div>
|
666
|
+
</div>
|
667
|
+
<div class="tags">
|
668
|
+
|
669
|
+
<p class="tag_title">Returns:</p>
|
670
|
+
<ul class="return">
|
671
|
+
|
672
|
+
<li>
|
673
|
+
|
674
|
+
|
675
|
+
<span class='type'>(<tt><span class='object_link'><a href="Resource/Region.html" title="DigitalOcean::Resource::Region (class)">DigitalOcean::Resource::Region</a></span></tt>)</span>
|
676
|
+
|
677
|
+
|
678
|
+
|
679
|
+
</li>
|
680
|
+
|
681
|
+
</ul>
|
682
|
+
|
683
|
+
<p class="tag_title">See Also:</p>
|
684
|
+
<ul class="see">
|
685
|
+
|
686
|
+
<li><span class='object_link'><a href="Resource/Region.html" title="DigitalOcean::Resource::Region (class)">Resource::Region</a></span></li>
|
687
|
+
|
688
|
+
</ul>
|
689
|
+
|
690
|
+
</div><table class="source_code">
|
691
|
+
<tr>
|
692
|
+
<td>
|
693
|
+
<pre class="lines">
|
694
|
+
|
695
|
+
|
696
|
+
45
|
697
|
+
46
|
698
|
+
47</pre>
|
699
|
+
</td>
|
700
|
+
<td>
|
701
|
+
<pre class="code"><span class="info file"># File 'lib/digital_ocean/api.rb', line 45</span>
|
702
|
+
|
703
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_regions'>regions</span>
|
704
|
+
<span class='const'>DigitalOcean</span><span class='op'>::</span><span class='const'>Resource</span><span class='op'>::</span><span class='const'>Region</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@faraday</span><span class='rparen'>)</span>
|
705
|
+
<span class='kw'>end</span></pre>
|
706
|
+
</td>
|
707
|
+
</tr>
|
708
|
+
</table>
|
709
|
+
</div>
|
710
|
+
|
711
|
+
<div class="method_details ">
|
712
|
+
<h3 class="signature " id="sizes-instance_method">
|
713
|
+
|
714
|
+
- (<tt><span class='object_link'><a href="Resource/Size.html" title="DigitalOcean::Resource::Size (class)">DigitalOcean::Resource::Size</a></span></tt>) <strong>sizes</strong>
|
715
|
+
|
716
|
+
|
717
|
+
|
718
|
+
|
719
|
+
|
720
|
+
</h3><div class="docstring">
|
721
|
+
<div class="discussion">
|
722
|
+
|
723
|
+
<p>Access Sizes (virtual machine types/sizes)</p>
|
724
|
+
|
725
|
+
|
726
|
+
</div>
|
727
|
+
</div>
|
728
|
+
<div class="tags">
|
729
|
+
|
730
|
+
<p class="tag_title">Returns:</p>
|
731
|
+
<ul class="return">
|
732
|
+
|
733
|
+
<li>
|
734
|
+
|
735
|
+
|
736
|
+
<span class='type'>(<tt><span class='object_link'><a href="Resource/Size.html" title="DigitalOcean::Resource::Size (class)">DigitalOcean::Resource::Size</a></span></tt>)</span>
|
737
|
+
|
738
|
+
|
739
|
+
|
740
|
+
</li>
|
741
|
+
|
742
|
+
</ul>
|
743
|
+
|
744
|
+
<p class="tag_title">See Also:</p>
|
745
|
+
<ul class="see">
|
746
|
+
|
747
|
+
<li><span class='object_link'><a href="Resource/Size.html" title="DigitalOcean::Resource::Size (class)">Resource::Size</a></span></li>
|
748
|
+
|
749
|
+
</ul>
|
750
|
+
|
751
|
+
</div><table class="source_code">
|
752
|
+
<tr>
|
753
|
+
<td>
|
754
|
+
<pre class="lines">
|
755
|
+
|
756
|
+
|
757
|
+
38
|
758
|
+
39
|
759
|
+
40</pre>
|
760
|
+
</td>
|
761
|
+
<td>
|
762
|
+
<pre class="code"><span class="info file"># File 'lib/digital_ocean/api.rb', line 38</span>
|
763
|
+
|
764
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_sizes'>sizes</span>
|
765
|
+
<span class='const'>DigitalOcean</span><span class='op'>::</span><span class='const'>Resource</span><span class='op'>::</span><span class='const'>Size</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@faraday</span><span class='rparen'>)</span>
|
766
|
+
<span class='kw'>end</span></pre>
|
767
|
+
</td>
|
768
|
+
</tr>
|
769
|
+
</table>
|
770
|
+
</div>
|
771
|
+
|
772
|
+
<div class="method_details ">
|
773
|
+
<h3 class="signature " id="ssh_keys-instance_method">
|
774
|
+
|
775
|
+
- (<tt><span class='object_link'><a href="Resource/SSHKey.html" title="DigitalOcean::Resource::SSHKey (class)">DigitalOcean::Resource::SSHKey</a></span></tt>) <strong>ssh_keys</strong>
|
776
|
+
|
777
|
+
|
778
|
+
|
779
|
+
|
780
|
+
|
781
|
+
</h3><div class="docstring">
|
782
|
+
<div class="discussion">
|
783
|
+
|
784
|
+
<p>Access SSH keys</p>
|
785
|
+
|
786
|
+
|
787
|
+
</div>
|
788
|
+
</div>
|
789
|
+
<div class="tags">
|
790
|
+
|
791
|
+
<p class="tag_title">Returns:</p>
|
792
|
+
<ul class="return">
|
793
|
+
|
794
|
+
<li>
|
795
|
+
|
796
|
+
|
797
|
+
<span class='type'>(<tt><span class='object_link'><a href="Resource/SSHKey.html" title="DigitalOcean::Resource::SSHKey (class)">DigitalOcean::Resource::SSHKey</a></span></tt>)</span>
|
798
|
+
|
799
|
+
|
800
|
+
|
801
|
+
</li>
|
802
|
+
|
803
|
+
</ul>
|
804
|
+
|
805
|
+
<p class="tag_title">See Also:</p>
|
806
|
+
<ul class="see">
|
807
|
+
|
808
|
+
<li><span class='object_link'><a href="Resource/SSHKey.html" title="DigitalOcean::Resource::SSHKey (class)">Resource::SSHKey</a></span></li>
|
809
|
+
|
810
|
+
</ul>
|
811
|
+
|
812
|
+
</div><table class="source_code">
|
813
|
+
<tr>
|
814
|
+
<td>
|
815
|
+
<pre class="lines">
|
816
|
+
|
817
|
+
|
818
|
+
52
|
819
|
+
53
|
820
|
+
54</pre>
|
821
|
+
</td>
|
822
|
+
<td>
|
823
|
+
<pre class="code"><span class="info file"># File 'lib/digital_ocean/api.rb', line 52</span>
|
824
|
+
|
825
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_ssh_keys'>ssh_keys</span>
|
826
|
+
<span class='const'>DigitalOcean</span><span class='op'>::</span><span class='const'>Resource</span><span class='op'>::</span><span class='const'>SSHKey</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@faraday</span><span class='rparen'>)</span>
|
827
|
+
<span class='kw'>end</span></pre>
|
828
|
+
</td>
|
829
|
+
</tr>
|
830
|
+
</table>
|
831
|
+
</div>
|
832
|
+
|
833
|
+
</div>
|
834
|
+
|
835
|
+
</div>
|
836
|
+
|
837
|
+
<div id="footer">
|
838
|
+
Generated on Wed Feb 20 12:33:48 2013 by
|
839
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
840
|
+
0.8.3 (ruby-1.9.3).
|
841
|
+
</div>
|
842
|
+
|
843
|
+
</body>
|
844
|
+
</html>
|