gandi_v5 0.2.0 → 0.3.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.
- checksums.yaml +4 -4
- data/.gitignore +1 -0
- data/.rubocop.yml +1 -1
- data/.travis.yml +9 -0
- data/CHANGELOG.md +15 -0
- data/FUNDING.yml +10 -0
- data/README.md +7 -17
- data/gandi_v5.gemspec +3 -2
- data/lib/gandi_v5.rb +24 -10
- data/lib/gandi_v5/billing.rb +0 -2
- data/lib/gandi_v5/billing/info.rb +0 -2
- data/lib/gandi_v5/data.rb +0 -2
- data/lib/gandi_v5/data/converter.rb +0 -4
- data/lib/gandi_v5/domain.rb +159 -17
- data/lib/gandi_v5/domain/availability.rb +0 -3
- data/lib/gandi_v5/domain/availability/product.rb +0 -3
- data/lib/gandi_v5/domain/live_dns.rb +42 -0
- data/lib/gandi_v5/domain/renewal_information.rb +0 -3
- data/lib/gandi_v5/email.rb +0 -4
- data/lib/gandi_v5/email/forward.rb +108 -0
- data/lib/gandi_v5/email/mailbox.rb +0 -2
- data/lib/gandi_v5/error.rb +0 -2
- data/lib/gandi_v5/live_dns.rb +0 -4
- data/lib/gandi_v5/live_dns/domain.rb +1 -144
- data/lib/gandi_v5/live_dns/has_zone_records.rb +153 -0
- data/lib/gandi_v5/live_dns/zone.rb +1 -146
- data/lib/gandi_v5/organization.rb +28 -5
- data/lib/gandi_v5/version.rb +1 -1
- data/spec/.rubocop.yml +1 -1
- data/spec/features/domain_spec.rb +1 -1
- data/spec/fixtures/bodies/GandiV5_Billing/{info.yaml → info.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Domain/{get.yaml → fetch.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Domain/{fetch_contacts.yaml → fetch_contacts.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Domain/fetch_glue_records.yml +7 -0
- data/spec/fixtures/bodies/GandiV5_Domain/fetch_livedns.yml +6 -0
- data/spec/fixtures/bodies/GandiV5_Domain/fetch_name_servers.yml +2 -0
- data/spec/fixtures/bodies/GandiV5_Domain/{renewal_info.yaml → fetch_renewal_info.yml} +0 -3
- data/spec/fixtures/bodies/GandiV5_Domain/{restore_info.yaml → fetch_restore_info.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Domain/{list.yaml → list.yml} +1 -0
- data/spec/fixtures/bodies/GandiV5_Domain_Availability/{fetch.yaml → fetch.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Domain_TLD/{fetch.yaml → fetch.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Domain_TLD/{list.yaml → list.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Email_Forward/list.yml +6 -0
- data/spec/fixtures/bodies/GandiV5_Email_Mailbox/{get.yaml → fetch.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Email_Mailbox/{list.yaml → list.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Email_Slot/{get.yaml → fetch.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Email_Slot/{list.yaml → list.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/{get.yaml → fetch.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/{list.yaml → list.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone/{get.yaml → fetch.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone/{list.yaml → list.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone_Snapshot/{fetch.yaml → fetch.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone_Snapshot/{list.yaml → list.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Organization/{get.yaml → fetch.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Organization/list.yml +7 -0
- data/spec/fixtures/vcr/Domain_features/List_domains.yml +2 -1
- data/spec/spec_helper.rb +2 -2
- data/spec/units/gandi_v5/billing_spec.rb +2 -2
- data/spec/units/gandi_v5/domain/availability_spec.rb +1 -1
- data/spec/units/gandi_v5/domain/live_dns_spec.rb +45 -0
- data/spec/units/gandi_v5/domain/tld_spec.rb +2 -2
- data/spec/units/gandi_v5/domain_spec.rb +241 -22
- data/spec/units/gandi_v5/email/forward_spec.rb +121 -0
- data/spec/units/gandi_v5/email/mailbox_spec.rb +3 -3
- data/spec/units/gandi_v5/email/slot_spec.rb +3 -3
- data/spec/units/gandi_v5/live_dns/domain_spec.rb +3 -3
- data/spec/units/gandi_v5/live_dns/zone/snapshot_spec.rb +2 -2
- data/spec/units/gandi_v5/live_dns/zone_spec.rb +2 -2
- data/spec/units/gandi_v5/organization_spec.rb +38 -1
- metadata +51 -77
- data/doc/GandiV5.html +0 -1183
- data/doc/GandiV5/Billing.html +0 -293
- data/doc/GandiV5/Billing/Info.html +0 -641
- data/doc/GandiV5/Billing/Info/Prepaid.html +0 -817
- data/doc/GandiV5/Data.html +0 -785
- data/doc/GandiV5/Data/ClassMethods.html +0 -223
- data/doc/GandiV5/Data/Converter.html +0 -433
- data/doc/GandiV5/Data/Converter/ArrayOf.html +0 -413
- data/doc/GandiV5/Data/Converter/Symbol.html +0 -322
- data/doc/GandiV5/Data/Converter/Time.html +0 -330
- data/doc/GandiV5/Domain.html +0 -16847
- data/doc/GandiV5/Domain/AutoRenew.html +0 -1237
- data/doc/GandiV5/Domain/Availability.html +0 -1020
- data/doc/GandiV5/Domain/Availability/Product.html +0 -988
- data/doc/GandiV5/Domain/Availability/Product/Period.html +0 -220
- data/doc/GandiV5/Domain/Availability/Product/Price.html +0 -1031
- data/doc/GandiV5/Domain/Availability/Tax.html +0 -440
- data/doc/GandiV5/Domain/Contact.html +0 -4459
- data/doc/GandiV5/Domain/Contract.html +0 -520
- data/doc/GandiV5/Domain/Dates.html +0 -1313
- data/doc/GandiV5/Domain/RenewalInformation.html +0 -1147
- data/doc/GandiV5/Domain/RestoreInformation.html +0 -339
- data/doc/GandiV5/Domain/SharingSpace.html +0 -437
- data/doc/GandiV5/Domain/TLD.html +0 -1565
- data/doc/GandiV5/Email.html +0 -144
- data/doc/GandiV5/Email/Mailbox.html +0 -6307
- data/doc/GandiV5/Email/Mailbox/Responder.html +0 -1560
- data/doc/GandiV5/Email/Offer.html +0 -514
- data/doc/GandiV5/Email/Slot.html +0 -4244
- data/doc/GandiV5/Error.html +0 -151
- data/doc/GandiV5/Error/GandiError.html +0 -270
- data/doc/GandiV5/LiveDNS.html +0 -300
- data/doc/GandiV5/LiveDNS/Domain.html +0 -2984
- data/doc/GandiV5/LiveDNS/RecordSet.html +0 -1593
- data/doc/GandiV5/LiveDNS/Zone.html +0 -8891
- data/doc/GandiV5/LiveDNS/Zone/Snapshot.html +0 -1556
- data/doc/GandiV5/Organization.html +0 -2341
- data/doc/_index.html +0 -474
- data/doc/class_list.html +0 -51
- data/doc/css/common.css +0 -1
- data/doc/css/full_list.css +0 -58
- data/doc/css/style.css +0 -496
- data/doc/file.README.html +0 -175
- data/doc/file_list.html +0 -56
- data/doc/frames.html +0 -17
- data/doc/index.html +0 -175
- data/doc/js/app.js +0 -303
- data/doc/js/full_list.js +0 -216
- data/doc/js/jquery.js +0 -4
- data/doc/method_list.html +0 -2427
- data/doc/top-level-namespace.html +0 -110
data/doc/GandiV5.html
DELETED
@@ -1,1183 +0,0 @@
|
|
1
|
-
<!DOCTYPE html>
|
2
|
-
<html>
|
3
|
-
<head>
|
4
|
-
<meta charset="utf-8">
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
-
<title>
|
7
|
-
Class: GandiV5
|
8
|
-
|
9
|
-
— Documentation by YARD 0.9.19
|
10
|
-
|
11
|
-
</title>
|
12
|
-
|
13
|
-
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
14
|
-
|
15
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
|
-
|
17
|
-
<script type="text/javascript" charset="utf-8">
|
18
|
-
pathId = "GandiV5";
|
19
|
-
relpath = '';
|
20
|
-
</script>
|
21
|
-
|
22
|
-
|
23
|
-
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
24
|
-
|
25
|
-
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
26
|
-
|
27
|
-
|
28
|
-
</head>
|
29
|
-
<body>
|
30
|
-
<div class="nav_wrap">
|
31
|
-
<iframe id="nav" src="class_list.html?1"></iframe>
|
32
|
-
<div id="resizer"></div>
|
33
|
-
</div>
|
34
|
-
|
35
|
-
<div id="main" tabindex="-1">
|
36
|
-
<div id="header">
|
37
|
-
<div id="menu">
|
38
|
-
|
39
|
-
<a href="_index.html">Index (G)</a> »
|
40
|
-
|
41
|
-
|
42
|
-
<span class="title">GandiV5</span>
|
43
|
-
|
44
|
-
</div>
|
45
|
-
|
46
|
-
<div id="search">
|
47
|
-
|
48
|
-
<a class="full_list_link" id="class_list_link"
|
49
|
-
href="class_list.html">
|
50
|
-
|
51
|
-
<svg width="24" height="24">
|
52
|
-
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
-
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
54
|
-
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
55
|
-
</svg>
|
56
|
-
</a>
|
57
|
-
|
58
|
-
</div>
|
59
|
-
<div class="clear"></div>
|
60
|
-
</div>
|
61
|
-
|
62
|
-
<div id="content"><h1>Class: GandiV5
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
</h1>
|
67
|
-
<div class="box_info">
|
68
|
-
|
69
|
-
<dl>
|
70
|
-
<dt>Inherits:</dt>
|
71
|
-
<dd>
|
72
|
-
<span class="inheritName">Object</span>
|
73
|
-
|
74
|
-
<ul class="fullTree">
|
75
|
-
<li>Object</li>
|
76
|
-
|
77
|
-
<li class="next">GandiV5</li>
|
78
|
-
|
79
|
-
</ul>
|
80
|
-
<a href="#" class="inheritanceTree">show all</a>
|
81
|
-
|
82
|
-
</dd>
|
83
|
-
</dl>
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
<dl>
|
96
|
-
<dt>Defined in:</dt>
|
97
|
-
<dd>lib/gandi_v5.rb<span class="defines">,<br />
|
98
|
-
lib/gandi_v5/data.rb,<br /> lib/gandi_v5/email.rb,<br /> lib/gandi_v5/error.rb,<br /> lib/gandi_v5/domain.rb,<br /> lib/gandi_v5/billing.rb,<br /> lib/gandi_v5/version.rb,<br /> lib/gandi_v5/live_dns.rb,<br /> lib/gandi_v5/domain/tld.rb,<br /> lib/gandi_v5/email/slot.rb,<br /> lib/gandi_v5/email/offer.rb,<br /> lib/gandi_v5/billing/info.rb,<br /> lib/gandi_v5/domain/dates.rb,<br /> lib/gandi_v5/organization.rb,<br /> lib/gandi_v5/email/mailbox.rb,<br /> lib/gandi_v5/live_dns/zone.rb,<br /> lib/gandi_v5/data/converter.rb,<br /> lib/gandi_v5/domain/contact.rb,<br /> lib/gandi_v5/domain/contract.rb,<br /> lib/gandi_v5/live_dns/domain.rb,<br /> lib/gandi_v5/domain/auto_renew.rb,<br /> lib/gandi_v5/error/gandi_error.rb,<br /> lib/gandi_v5/data/converter/time.rb,<br /> lib/gandi_v5/domain/availability.rb,<br /> lib/gandi_v5/live_dns/record_set.rb,<br /> lib/gandi_v5/billing/info/prepaid.rb,<br /> lib/gandi_v5/domain/sharing_space.rb,<br /> lib/gandi_v5/data/converter/symbol.rb,<br /> lib/gandi_v5/live_dns/zone/snapshot.rb,<br /> lib/gandi_v5/data/converter/array_of.rb,<br /> lib/gandi_v5/domain/availability/tax.rb,<br /> lib/gandi_v5/email/mailbox/responder.rb,<br /> lib/gandi_v5/domain/renewal_information.rb,<br /> lib/gandi_v5/domain/restore_information.rb,<br /> lib/gandi_v5/domain/availability/product.rb,<br /> lib/gandi_v5/domain/availability/product/price.rb,<br /> lib/gandi_v5/domain/availability/product/period.rb</span>
|
99
|
-
</dd>
|
100
|
-
</dl>
|
101
|
-
|
102
|
-
</div>
|
103
|
-
|
104
|
-
<h2>Overview</h2><div class="docstring">
|
105
|
-
<div class="discussion">
|
106
|
-
|
107
|
-
<p>Namespace for classes which access LiveDNS details.</p>
|
108
|
-
|
109
|
-
|
110
|
-
</div>
|
111
|
-
</div>
|
112
|
-
<div class="tags">
|
113
|
-
|
114
|
-
|
115
|
-
</div><h2>Defined Under Namespace</h2>
|
116
|
-
<p class="children">
|
117
|
-
|
118
|
-
|
119
|
-
<strong class="modules">Modules:</strong> <span class='object_link'><a href="GandiV5/Data.html" title="GandiV5::Data (module)">Data</a></span>
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
<strong class="classes">Classes:</strong> <span class='object_link'><a href="GandiV5/Billing.html" title="GandiV5::Billing (class)">Billing</a></span>, <span class='object_link'><a href="GandiV5/Domain.html" title="GandiV5::Domain (class)">Domain</a></span>, <span class='object_link'><a href="GandiV5/Email.html" title="GandiV5::Email (class)">Email</a></span>, <span class='object_link'><a href="GandiV5/Error.html" title="GandiV5::Error (class)">Error</a></span>, <span class='object_link'><a href="GandiV5/LiveDNS.html" title="GandiV5::LiveDNS (class)">LiveDNS</a></span>, <span class='object_link'><a href="GandiV5/Organization.html" title="GandiV5::Organization (class)">Organization</a></span>
|
124
|
-
|
125
|
-
|
126
|
-
</p>
|
127
|
-
|
128
|
-
|
129
|
-
<h2>
|
130
|
-
Constant Summary
|
131
|
-
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
132
|
-
</h2>
|
133
|
-
|
134
|
-
<dl class="constants">
|
135
|
-
|
136
|
-
<dt id="BASE-constant" class="">BASE =
|
137
|
-
|
138
|
-
</dt>
|
139
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://api.gandi.net/v5/</span><span class='tstring_end'>'</span></span></pre></dd>
|
140
|
-
|
141
|
-
<dt id="VERSION-constant" class="">VERSION =
|
142
|
-
|
143
|
-
</dt>
|
144
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>0.2.0</span><span class='tstring_end'>'</span></span></pre></dd>
|
145
|
-
|
146
|
-
</dl>
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
|
152
|
-
<h2>Class Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
153
|
-
<ul class="summary">
|
154
|
-
|
155
|
-
<li class="public ">
|
156
|
-
<span class="summary_signature">
|
157
|
-
|
158
|
-
<a href="#api_key=-class_method" title="api_key= (class method)">.<strong>api_key</strong> ⇒ Object </a>
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
</span>
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
<span class="note title writeonly">writeonly</span>
|
169
|
-
|
170
|
-
|
171
|
-
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
|
176
|
-
|
177
|
-
<span class="summary_desc"><div class='inline'>
|
178
|
-
<p>Sets the attribute api_key.</p>
|
179
|
-
</div></span>
|
180
|
-
|
181
|
-
</li>
|
182
|
-
|
183
|
-
|
184
|
-
</ul>
|
185
|
-
|
186
|
-
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
187
|
-
<ul class="summary">
|
188
|
-
|
189
|
-
<li class="public ">
|
190
|
-
<span class="summary_signature">
|
191
|
-
|
192
|
-
<a href="#api_key=-instance_method" title="#api_key= (instance method)">#<strong>api_key</strong> ⇒ String </a>
|
193
|
-
|
194
|
-
|
195
|
-
|
196
|
-
</span>
|
197
|
-
|
198
|
-
|
199
|
-
|
200
|
-
|
201
|
-
|
202
|
-
<span class="note title writeonly">writeonly</span>
|
203
|
-
|
204
|
-
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
|
209
|
-
|
210
|
-
|
211
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
212
|
-
|
213
|
-
</li>
|
214
|
-
|
215
|
-
|
216
|
-
</ul>
|
217
|
-
|
218
|
-
|
219
|
-
|
220
|
-
|
221
|
-
|
222
|
-
<h2>
|
223
|
-
Class Method Summary
|
224
|
-
<small><a href="#" class="summary_toggle">collapse</a></small>
|
225
|
-
</h2>
|
226
|
-
|
227
|
-
<ul class="summary">
|
228
|
-
|
229
|
-
<li class="public ">
|
230
|
-
<span class="summary_signature">
|
231
|
-
|
232
|
-
<a href="#delete-class_method" title="delete (class method)">.<strong>delete</strong>(url, **headers) ⇒ Object </a>
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
</span>
|
237
|
-
|
238
|
-
|
239
|
-
|
240
|
-
|
241
|
-
|
242
|
-
|
243
|
-
|
244
|
-
|
245
|
-
|
246
|
-
<span class="summary_desc"><div class='inline'>
|
247
|
-
<p>Might raise: * RestClient::NotFound * RestClient::Unauthorized Bad authentication attempt because of a wrong API Key.</p>
|
248
|
-
</div></span>
|
249
|
-
|
250
|
-
</li>
|
251
|
-
|
252
|
-
|
253
|
-
<li class="public ">
|
254
|
-
<span class="summary_signature">
|
255
|
-
|
256
|
-
<a href="#domains-class_method" title="domains (class method)">.<strong>domains</strong> ⇒ Object </a>
|
257
|
-
|
258
|
-
|
259
|
-
|
260
|
-
</span>
|
261
|
-
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
|
269
|
-
|
270
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
271
|
-
|
272
|
-
</li>
|
273
|
-
|
274
|
-
|
275
|
-
<li class="public ">
|
276
|
-
<span class="summary_signature">
|
277
|
-
|
278
|
-
<a href="#get-class_method" title="get (class method)">.<strong>get</strong>(url, **headers) ⇒ Object </a>
|
279
|
-
|
280
|
-
|
281
|
-
|
282
|
-
</span>
|
283
|
-
|
284
|
-
|
285
|
-
|
286
|
-
|
287
|
-
|
288
|
-
|
289
|
-
|
290
|
-
|
291
|
-
|
292
|
-
<span class="summary_desc"><div class='inline'>
|
293
|
-
<p>Might raise: * RestClient::NotFound * RestClient::Unauthorized Bad authentication attempt because of a wrong API Key.</p>
|
294
|
-
</div></span>
|
295
|
-
|
296
|
-
</li>
|
297
|
-
|
298
|
-
|
299
|
-
<li class="public ">
|
300
|
-
<span class="summary_signature">
|
301
|
-
|
302
|
-
<a href="#patch-class_method" title="patch (class method)">.<strong>patch</strong>(url, payload = '', **headers) ⇒ Object </a>
|
303
|
-
|
304
|
-
|
305
|
-
|
306
|
-
</span>
|
307
|
-
|
308
|
-
|
309
|
-
|
310
|
-
|
311
|
-
|
312
|
-
|
313
|
-
|
314
|
-
|
315
|
-
|
316
|
-
<span class="summary_desc"><div class='inline'>
|
317
|
-
<p>Might raise: * RestClient::NotFound * RestClient::Unauthorized Bad authentication attempt because of a wrong API Key.</p>
|
318
|
-
</div></span>
|
319
|
-
|
320
|
-
</li>
|
321
|
-
|
322
|
-
|
323
|
-
<li class="public ">
|
324
|
-
<span class="summary_signature">
|
325
|
-
|
326
|
-
<a href="#post-class_method" title="post (class method)">.<strong>post</strong>(url, payload = '', **headers) ⇒ Object </a>
|
327
|
-
|
328
|
-
|
329
|
-
|
330
|
-
</span>
|
331
|
-
|
332
|
-
|
333
|
-
|
334
|
-
|
335
|
-
|
336
|
-
|
337
|
-
|
338
|
-
|
339
|
-
|
340
|
-
<span class="summary_desc"><div class='inline'>
|
341
|
-
<p>Might raise: * RestClient::NotFound * RestClient::Unauthorized Bad authentication attempt because of a wrong API Key.</p>
|
342
|
-
</div></span>
|
343
|
-
|
344
|
-
</li>
|
345
|
-
|
346
|
-
|
347
|
-
<li class="public ">
|
348
|
-
<span class="summary_signature">
|
349
|
-
|
350
|
-
<a href="#put-class_method" title="put (class method)">.<strong>put</strong>(url, payload = '', **headers) ⇒ Object </a>
|
351
|
-
|
352
|
-
|
353
|
-
|
354
|
-
</span>
|
355
|
-
|
356
|
-
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
<span class="summary_desc"><div class='inline'>
|
365
|
-
<p>Might raise: * RestClient::NotFound * RestClient::Unauthorized Bad authentication attempt because of a wrong API Key.</p>
|
366
|
-
</div></span>
|
367
|
-
|
368
|
-
</li>
|
369
|
-
|
370
|
-
|
371
|
-
</ul>
|
372
|
-
|
373
|
-
|
374
|
-
|
375
|
-
<div id="class_attr_details" class="attr_details">
|
376
|
-
<h2>Class Attribute Details</h2>
|
377
|
-
|
378
|
-
|
379
|
-
<span id="api_key-class_method"></span>
|
380
|
-
<div class="method_details first">
|
381
|
-
<h3 class="signature first" id="api_key=-class_method">
|
382
|
-
|
383
|
-
.<strong>api_key=</strong>(value) ⇒ <tt>Object</tt>
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
|
389
|
-
</h3><div class="docstring">
|
390
|
-
<div class="discussion">
|
391
|
-
|
392
|
-
<p>Sets the attribute api_key</p>
|
393
|
-
|
394
|
-
|
395
|
-
</div>
|
396
|
-
</div>
|
397
|
-
<div class="tags">
|
398
|
-
<p class="tag_title">Parameters:</p>
|
399
|
-
<ul class="param">
|
400
|
-
|
401
|
-
<li>
|
402
|
-
|
403
|
-
<span class='name'>value</span>
|
404
|
-
|
405
|
-
|
406
|
-
<span class='type'></span>
|
407
|
-
|
408
|
-
|
409
|
-
|
410
|
-
—
|
411
|
-
<div class='inline'>
|
412
|
-
<p>the value to set the attribute api_key to.</p>
|
413
|
-
</div>
|
414
|
-
|
415
|
-
</li>
|
416
|
-
|
417
|
-
</ul>
|
418
|
-
|
419
|
-
|
420
|
-
</div><table class="source_code">
|
421
|
-
<tr>
|
422
|
-
<td>
|
423
|
-
<pre class="lines">
|
424
|
-
|
425
|
-
|
426
|
-
35
|
427
|
-
36
|
428
|
-
37</pre>
|
429
|
-
</td>
|
430
|
-
<td>
|
431
|
-
<pre class="code"><span class="info file"># File 'lib/gandi_v5.rb', line 35</span>
|
432
|
-
|
433
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_api_key='>api_key=</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
|
434
|
-
<span class='ivar'>@api_key</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
|
435
|
-
<span class='kw'>end</span></pre>
|
436
|
-
</td>
|
437
|
-
</tr>
|
438
|
-
</table>
|
439
|
-
</div>
|
440
|
-
|
441
|
-
</div>
|
442
|
-
|
443
|
-
<div id="instance_attr_details" class="attr_details">
|
444
|
-
<h2>Instance Attribute Details</h2>
|
445
|
-
|
446
|
-
|
447
|
-
<span id=""></span>
|
448
|
-
<div class="method_details first">
|
449
|
-
<h3 class="signature first" id="api_key=-instance_method">
|
450
|
-
|
451
|
-
#<strong>api_key=</strong>(value) ⇒ <tt>String</tt> <span class="extras">(writeonly)</span>
|
452
|
-
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
|
457
|
-
</h3><div class="docstring">
|
458
|
-
<div class="discussion">
|
459
|
-
|
460
|
-
|
461
|
-
</div>
|
462
|
-
</div>
|
463
|
-
<div class="tags">
|
464
|
-
|
465
|
-
<p class="tag_title">Returns:</p>
|
466
|
-
<ul class="return">
|
467
|
-
|
468
|
-
<li>
|
469
|
-
|
470
|
-
|
471
|
-
<span class='type'>(<tt>String</tt>)</span>
|
472
|
-
|
473
|
-
|
474
|
-
|
475
|
-
</li>
|
476
|
-
|
477
|
-
</ul>
|
478
|
-
|
479
|
-
</div><table class="source_code">
|
480
|
-
<tr>
|
481
|
-
<td>
|
482
|
-
<pre class="lines">
|
483
|
-
|
484
|
-
|
485
|
-
26
|
486
|
-
27
|
487
|
-
28
|
488
|
-
29
|
489
|
-
30
|
490
|
-
31
|
491
|
-
32
|
492
|
-
33
|
493
|
-
34
|
494
|
-
35
|
495
|
-
36
|
496
|
-
37
|
497
|
-
38
|
498
|
-
39
|
499
|
-
40
|
500
|
-
41
|
501
|
-
42
|
502
|
-
43
|
503
|
-
44
|
504
|
-
45
|
505
|
-
46
|
506
|
-
47
|
507
|
-
48
|
508
|
-
49
|
509
|
-
50
|
510
|
-
51
|
511
|
-
52
|
512
|
-
53
|
513
|
-
54
|
514
|
-
55
|
515
|
-
56
|
516
|
-
57
|
517
|
-
58
|
518
|
-
59
|
519
|
-
60
|
520
|
-
61
|
521
|
-
62
|
522
|
-
63
|
523
|
-
64
|
524
|
-
65
|
525
|
-
66
|
526
|
-
67
|
527
|
-
68
|
528
|
-
69
|
529
|
-
70
|
530
|
-
71
|
531
|
-
72
|
532
|
-
73
|
533
|
-
74
|
534
|
-
75
|
535
|
-
76
|
536
|
-
77
|
537
|
-
78
|
538
|
-
79
|
539
|
-
80
|
540
|
-
81
|
541
|
-
82
|
542
|
-
83
|
543
|
-
84
|
544
|
-
85
|
545
|
-
86
|
546
|
-
87
|
547
|
-
88
|
548
|
-
89
|
549
|
-
90
|
550
|
-
91
|
551
|
-
92
|
552
|
-
93
|
553
|
-
94
|
554
|
-
95
|
555
|
-
96
|
556
|
-
97
|
557
|
-
98
|
558
|
-
99
|
559
|
-
100
|
560
|
-
101
|
561
|
-
102
|
562
|
-
103
|
563
|
-
104
|
564
|
-
105
|
565
|
-
106
|
566
|
-
107
|
567
|
-
108
|
568
|
-
109
|
569
|
-
110
|
570
|
-
111
|
571
|
-
112
|
572
|
-
113
|
573
|
-
114
|
574
|
-
115
|
575
|
-
116
|
576
|
-
117
|
577
|
-
118
|
578
|
-
119
|
579
|
-
120
|
580
|
-
121
|
581
|
-
122
|
582
|
-
123
|
583
|
-
124
|
584
|
-
125
|
585
|
-
126
|
586
|
-
127
|
587
|
-
128
|
588
|
-
129
|
589
|
-
130
|
590
|
-
131
|
591
|
-
132
|
592
|
-
133
|
593
|
-
134
|
594
|
-
135
|
595
|
-
136
|
596
|
-
137
|
597
|
-
138
|
598
|
-
139
|
599
|
-
140
|
600
|
-
141
|
601
|
-
142
|
602
|
-
143
|
603
|
-
144
|
604
|
-
145
|
605
|
-
146
|
606
|
-
147
|
607
|
-
148
|
608
|
-
149
|
609
|
-
150
|
610
|
-
151
|
611
|
-
152
|
612
|
-
153
|
613
|
-
154
|
614
|
-
155
|
615
|
-
156
|
616
|
-
157
|
617
|
-
158
|
618
|
-
159
|
619
|
-
160
|
620
|
-
161
|
621
|
-
162
|
622
|
-
163
|
623
|
-
164
|
624
|
-
165
|
625
|
-
166
|
626
|
-
167
|
627
|
-
168
|
628
|
-
169
|
629
|
-
170
|
630
|
-
171
|
631
|
-
172
|
632
|
-
173
|
633
|
-
174
|
634
|
-
175
|
635
|
-
176
|
636
|
-
177
|
637
|
-
178
|
638
|
-
179
|
639
|
-
180
|
640
|
-
181
|
641
|
-
182
|
642
|
-
183</pre>
|
643
|
-
</td>
|
644
|
-
<td>
|
645
|
-
<pre class="code"><span class="info file"># File 'lib/gandi_v5.rb', line 26</span>
|
646
|
-
|
647
|
-
<span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="GandiV5 (class)">GandiV5</a></span></span>
|
648
|
-
<span class='const'><span class='object_link'><a href="#BASE-constant" title="GandiV5::BASE (constant)">BASE</a></span></span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://api.gandi.net/v5/</span><span class='tstring_end'>'</span></span>
|
649
|
-
|
650
|
-
<span class='comment'># @see GandiV5::Domain#list
|
651
|
-
</span> <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_domains'>domains</span>
|
652
|
-
<span class='const'><span class='object_link'><a href="" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GandiV5/Domain.html" title="GandiV5::Domain (class)">Domain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_list'><span class='object_link'><a href="GandiV5/Domain.html#list-class_method" title="GandiV5::Domain.list (method)">list</a></span></span>
|
653
|
-
<span class='kw'>end</span>
|
654
|
-
|
655
|
-
<span class='kw'>class</span> <span class='op'><<</span> <span class='kw'>self</span>
|
656
|
-
<span class='id identifier rubyid_attr_writer'>attr_writer</span> <span class='symbol'>:api_key</span>
|
657
|
-
|
658
|
-
<span class='comment'># Might raise:
|
659
|
-
</span> <span class='comment'># * RestClient::NotFound
|
660
|
-
</span> <span class='comment'># * RestClient::Unauthorized
|
661
|
-
</span> <span class='comment'># Bad authentication attempt because of a wrong API Key.
|
662
|
-
</span> <span class='comment'># * RestClient::Forbidden
|
663
|
-
</span> <span class='comment'># Access to the resource is denied.
|
664
|
-
</span> <span class='comment'># Mainly due to a lack of permissions to access it.
|
665
|
-
</span> <span class='comment'># * GandiV5::Error
|
666
|
-
</span> <span class='comment'># * JSON::ParserError
|
667
|
-
</span> <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
668
|
-
<span class='id identifier rubyid_prepare_headers'>prepare_headers</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span>
|
669
|
-
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>RestClient</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span>
|
670
|
-
<span class='lbracket'>[</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_parse_response'>parse_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span><span class='rbracket'>]</span>
|
671
|
-
<span class='kw'>rescue</span> <span class='const'>RestClient</span><span class='op'>::</span><span class='const'>BadRequest</span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span>
|
672
|
-
<span class='id identifier rubyid_handle_bad_request'>handle_bad_request</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span>
|
673
|
-
<span class='kw'>end</span>
|
674
|
-
|
675
|
-
<span class='comment'># Might raise:
|
676
|
-
</span> <span class='comment'># * RestClient::NotFound
|
677
|
-
</span> <span class='comment'># * RestClient::Unauthorized
|
678
|
-
</span> <span class='comment'># Bad authentication attempt because of a wrong API Key.
|
679
|
-
</span> <span class='comment'># * RestClient::Forbidden
|
680
|
-
</span> <span class='comment'># Access to the resource is denied.
|
681
|
-
</span> <span class='comment'># Mainly due to a lack of permissions to access it.
|
682
|
-
</span> <span class='comment'># * RestClient::Conflict
|
683
|
-
</span> <span class='comment'># * GandiV5::Error
|
684
|
-
</span> <span class='comment'># * JSON::ParserError
|
685
|
-
</span> <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
686
|
-
<span class='id identifier rubyid_prepare_headers'>prepare_headers</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span>
|
687
|
-
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>RestClient</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span>
|
688
|
-
<span class='lbracket'>[</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_parse_response'>parse_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span><span class='rbracket'>]</span>
|
689
|
-
<span class='kw'>rescue</span> <span class='const'>RestClient</span><span class='op'>::</span><span class='const'>BadRequest</span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span>
|
690
|
-
<span class='id identifier rubyid_handle_bad_request'>handle_bad_request</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span>
|
691
|
-
<span class='kw'>end</span>
|
692
|
-
|
693
|
-
<span class='comment'># Might raise:
|
694
|
-
</span> <span class='comment'># * RestClient::NotFound
|
695
|
-
</span> <span class='comment'># * RestClient::Unauthorized
|
696
|
-
</span> <span class='comment'># Bad authentication attempt because of a wrong API Key.
|
697
|
-
</span> <span class='comment'># * RestClient::Forbidden
|
698
|
-
</span> <span class='comment'># Access to the resource is denied.
|
699
|
-
</span> <span class='comment'># Mainly due to a lack of permissions to access it.
|
700
|
-
</span> <span class='comment'># * RestClient::BadRequest
|
701
|
-
</span> <span class='comment'># * RestClient::Conflict
|
702
|
-
</span> <span class='comment'># * GandiV5::Error
|
703
|
-
</span> <span class='comment'># * JSON::ParserError
|
704
|
-
</span> <span class='kw'>def</span> <span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
705
|
-
<span class='id identifier rubyid_prepare_headers'>prepare_headers</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span>
|
706
|
-
<span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='symbol'>:'content-type'</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span>
|
707
|
-
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>RestClient</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span>
|
708
|
-
<span class='lbracket'>[</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_parse_response'>parse_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span><span class='rbracket'>]</span>
|
709
|
-
<span class='kw'>rescue</span> <span class='const'>RestClient</span><span class='op'>::</span><span class='const'>BadRequest</span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span>
|
710
|
-
<span class='id identifier rubyid_handle_bad_request'>handle_bad_request</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span>
|
711
|
-
<span class='kw'>end</span>
|
712
|
-
|
713
|
-
<span class='comment'># Might raise:
|
714
|
-
</span> <span class='comment'># * RestClient::NotFound
|
715
|
-
</span> <span class='comment'># * RestClient::Unauthorized
|
716
|
-
</span> <span class='comment'># Bad authentication attempt because of a wrong API Key.
|
717
|
-
</span> <span class='comment'># * RestClient::Forbidden
|
718
|
-
</span> <span class='comment'># Access to the resource is denied.
|
719
|
-
</span> <span class='comment'># Mainly due to a lack of permissions to access it.
|
720
|
-
</span> <span class='comment'># * RestClient::BadRequest
|
721
|
-
</span> <span class='comment'># * RestClient::Conflict
|
722
|
-
</span> <span class='comment'># * GandiV5::Error
|
723
|
-
</span> <span class='comment'># * JSON::ParserError
|
724
|
-
</span> <span class='kw'>def</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
725
|
-
<span class='id identifier rubyid_prepare_headers'>prepare_headers</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span>
|
726
|
-
<span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='symbol'>:'content-type'</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span>
|
727
|
-
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>RestClient</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span>
|
728
|
-
<span class='lbracket'>[</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_parse_response'>parse_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span><span class='rbracket'>]</span>
|
729
|
-
<span class='kw'>rescue</span> <span class='const'>RestClient</span><span class='op'>::</span><span class='const'>BadRequest</span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span>
|
730
|
-
<span class='id identifier rubyid_handle_bad_request'>handle_bad_request</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span>
|
731
|
-
<span class='kw'>end</span>
|
732
|
-
|
733
|
-
<span class='comment'># Might raise:
|
734
|
-
</span> <span class='comment'># * RestClient::NotFound
|
735
|
-
</span> <span class='comment'># * RestClient::Unauthorized
|
736
|
-
</span> <span class='comment'># Bad authentication attempt because of a wrong API Key.
|
737
|
-
</span> <span class='comment'># * RestClient::Forbidden
|
738
|
-
</span> <span class='comment'># Access to the resource is denied.
|
739
|
-
</span> <span class='comment'># Mainly due to a lack of permissions to access it.
|
740
|
-
</span> <span class='comment'># * RestClient::BadRequest
|
741
|
-
</span> <span class='comment'># * RestClient::Conflict
|
742
|
-
</span> <span class='comment'># * GandiV5::Error
|
743
|
-
</span> <span class='comment'># * JSON::ParserError
|
744
|
-
</span> <span class='kw'>def</span> <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
745
|
-
<span class='id identifier rubyid_prepare_headers'>prepare_headers</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span>
|
746
|
-
<span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='symbol'>:'content-type'</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span>
|
747
|
-
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>RestClient</span><span class='period'>.</span><span class='id identifier rubyid_put'>put</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span>
|
748
|
-
<span class='lbracket'>[</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_parse_response'>parse_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span><span class='rbracket'>]</span>
|
749
|
-
<span class='kw'>rescue</span> <span class='const'>RestClient</span><span class='op'>::</span><span class='const'>BadRequest</span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span>
|
750
|
-
<span class='id identifier rubyid_handle_bad_request'>handle_bad_request</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span>
|
751
|
-
<span class='kw'>end</span>
|
752
|
-
|
753
|
-
<span class='id identifier rubyid_private'>private</span>
|
754
|
-
|
755
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_api_key'>api_key</span>
|
756
|
-
<span class='ivar'>@api_key</span> <span class='op'>||=</span> <span class='const'>ENV</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>GANDI_API_KEY</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
757
|
-
<span class='kw'>end</span>
|
758
|
-
|
759
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_authorisation_header'>authorisation_header</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span>
|
760
|
-
<span class='kw'>if</span> <span class='id identifier rubyid_url'>url</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#BASE-constant" title="GandiV5::BASE (constant)">BASE</a></span></span><span class='rparen'>)</span>
|
761
|
-
<span class='lbrace'>{</span> <span class='label'>Authorization:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Apikey </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_api_key'>api_key</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span>
|
762
|
-
<span class='kw'>elsif</span> <span class='id identifier rubyid_url'>url</span><span class='period'>.</span><span class='id identifier rubyid_start_with?'>start_with?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GandiV5/LiveDNS.html" title="GandiV5::LiveDNS (class)">LiveDNS</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GandiV5/LiveDNS.html#BASE-constant" title="GandiV5::LiveDNS::BASE (constant)">BASE</a></span></span><span class='rparen'>)</span>
|
763
|
-
<span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>X-Api-Key</span><span class='label_end'>':</span> <span class='id identifier rubyid_api_key'>api_key</span> <span class='rbrace'>}</span>
|
764
|
-
<span class='kw'>else</span>
|
765
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Don't know how to authorise for url: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_url'>url</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
766
|
-
<span class='kw'>end</span>
|
767
|
-
<span class='kw'>end</span>
|
768
|
-
|
769
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_parse_response'>parse_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
770
|
-
<span class='id identifier rubyid_type'>type</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_headers'>headers</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='symbol'>:content_type</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>;</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_chomp'>chomp</span>
|
771
|
-
<span class='kw'>case</span> <span class='id identifier rubyid_type'>type</span>
|
772
|
-
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>'</span></span>
|
773
|
-
<span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
774
|
-
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span>
|
775
|
-
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span><span class='rparen'>)</span>
|
776
|
-
<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_response'>response</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>status</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_eql?'>eql?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>error</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
777
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'><span class='object_link'><a href="" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GandiV5/Error.html" title="GandiV5::Error (class)">Error</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GandiV5/Error/GandiError.html" title="GandiV5::Error::GandiError (class)">GandiError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_from_hash'><span class='object_link'><a href="GandiV5/Error/GandiError.html#from_hash-class_method" title="GandiV5::Error::GandiError.from_hash (method)">from_hash</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
|
778
|
-
<span class='kw'>end</span>
|
779
|
-
|
780
|
-
<span class='id identifier rubyid_response'>response</span>
|
781
|
-
<span class='kw'>else</span>
|
782
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Don't know how to parse a </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_type'>type</span><span class='embexpr_end'>}</span><span class='tstring_content'> response</span><span class='tstring_end'>"</span></span>
|
783
|
-
<span class='kw'>end</span>
|
784
|
-
<span class='kw'>end</span>
|
785
|
-
|
786
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_prepare_headers'>prepare_headers</span><span class='lparen'>(</span><span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span>
|
787
|
-
<span class='id identifier rubyid_headers'>headers</span><span class='period'>.</span><span class='id identifier rubyid_transform_keys!'>transform_keys!</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:to_sym</span><span class='rparen'>)</span>
|
788
|
-
<span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='symbol'>:accept</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span>
|
789
|
-
<span class='id identifier rubyid_headers'>headers</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_authorisation_header'>authorisation_header</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
790
|
-
<span class='kw'>end</span>
|
791
|
-
|
792
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_handle_bad_request'>handle_bad_request</span><span class='lparen'>(</span><span class='id identifier rubyid_exception'>exception</span><span class='rparen'>)</span>
|
793
|
-
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span> <span class='id identifier rubyid_exception'>exception</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
|
794
|
-
<span class='kw'>unless</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>status</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_eql?'>eql?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>error</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>errors</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span>
|
795
|
-
<span class='id identifier rubyid_raise'>raise</span> <span class='id identifier rubyid_exception'>exception</span>
|
796
|
-
<span class='kw'>end</span>
|
797
|
-
|
798
|
-
<span class='id identifier rubyid_field'>field</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>errors</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_values_at'>values_at</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>name</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>description</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
799
|
-
<span class='id identifier rubyid_fail'>fail</span> <span class='const'><span class='object_link'><a href="" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GandiV5/Error.html" title="GandiV5::Error (class)">Error</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GandiV5/Error/GandiError.html" title="GandiV5::Error::GandiError (class)">GandiError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_field'>field</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_message'>message</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
800
|
-
<span class='kw'>rescue</span> <span class='const'>JSON</span><span class='op'>::</span><span class='const'>ParserError</span>
|
801
|
-
<span class='id identifier rubyid_raise'>raise</span> <span class='id identifier rubyid_exception'>exception</span>
|
802
|
-
<span class='kw'>end</span>
|
803
|
-
<span class='kw'>end</span>
|
804
|
-
<span class='kw'>end</span></pre>
|
805
|
-
</td>
|
806
|
-
</tr>
|
807
|
-
</table>
|
808
|
-
</div>
|
809
|
-
|
810
|
-
</div>
|
811
|
-
|
812
|
-
|
813
|
-
<div id="class_method_details" class="method_details_list">
|
814
|
-
<h2>Class Method Details</h2>
|
815
|
-
|
816
|
-
|
817
|
-
<div class="method_details first">
|
818
|
-
<h3 class="signature first" id="delete-class_method">
|
819
|
-
|
820
|
-
.<strong>delete</strong>(url, **headers) ⇒ <tt>Object</tt>
|
821
|
-
|
822
|
-
|
823
|
-
|
824
|
-
|
825
|
-
|
826
|
-
</h3><div class="docstring">
|
827
|
-
<div class="discussion">
|
828
|
-
|
829
|
-
<p>Might raise:</p>
|
830
|
-
|
831
|
-
<pre class="code ruby"><code class="ruby">* RestClient::NotFound
|
832
|
-
* RestClient::Unauthorized
|
833
|
-
Bad authentication attempt because of a wrong API Key.
|
834
|
-
* RestClient::Forbidden
|
835
|
-
Access to the resource is denied.
|
836
|
-
Mainly due to a lack of permissions to access it.
|
837
|
-
* RestClient::Conflict
|
838
|
-
* GandiV5::Error
|
839
|
-
* JSON::ParserError
|
840
|
-
</code></pre>
|
841
|
-
|
842
|
-
|
843
|
-
</div>
|
844
|
-
</div>
|
845
|
-
<div class="tags">
|
846
|
-
|
847
|
-
|
848
|
-
</div><table class="source_code">
|
849
|
-
<tr>
|
850
|
-
<td>
|
851
|
-
<pre class="lines">
|
852
|
-
|
853
|
-
|
854
|
-
64
|
855
|
-
65
|
856
|
-
66
|
857
|
-
67
|
858
|
-
68
|
859
|
-
69
|
860
|
-
70</pre>
|
861
|
-
</td>
|
862
|
-
<td>
|
863
|
-
<pre class="code"><span class="info file"># File 'lib/gandi_v5.rb', line 64</span>
|
864
|
-
|
865
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
866
|
-
<span class='id identifier rubyid_prepare_headers'>prepare_headers</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span>
|
867
|
-
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>RestClient</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span>
|
868
|
-
<span class='lbracket'>[</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_parse_response'>parse_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span><span class='rbracket'>]</span>
|
869
|
-
<span class='kw'>rescue</span> <span class='const'>RestClient</span><span class='op'>::</span><span class='const'>BadRequest</span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span>
|
870
|
-
<span class='id identifier rubyid_handle_bad_request'>handle_bad_request</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span>
|
871
|
-
<span class='kw'>end</span></pre>
|
872
|
-
</td>
|
873
|
-
</tr>
|
874
|
-
</table>
|
875
|
-
</div>
|
876
|
-
|
877
|
-
<div class="method_details ">
|
878
|
-
<h3 class="signature " id="domains-class_method">
|
879
|
-
|
880
|
-
.<strong>domains</strong> ⇒ <tt>Object</tt>
|
881
|
-
|
882
|
-
|
883
|
-
|
884
|
-
|
885
|
-
|
886
|
-
</h3><div class="docstring">
|
887
|
-
<div class="discussion">
|
888
|
-
|
889
|
-
|
890
|
-
</div>
|
891
|
-
</div>
|
892
|
-
<div class="tags">
|
893
|
-
|
894
|
-
|
895
|
-
<p class="tag_title">See Also:</p>
|
896
|
-
<ul class="see">
|
897
|
-
|
898
|
-
<li><span class='object_link'><a href="GandiV5/Domain.html#list-class_method" title="GandiV5::Domain.list (method)">GandiV5::Domain.list</a></span></li>
|
899
|
-
|
900
|
-
</ul>
|
901
|
-
|
902
|
-
</div><table class="source_code">
|
903
|
-
<tr>
|
904
|
-
<td>
|
905
|
-
<pre class="lines">
|
906
|
-
|
907
|
-
|
908
|
-
30
|
909
|
-
31
|
910
|
-
32</pre>
|
911
|
-
</td>
|
912
|
-
<td>
|
913
|
-
<pre class="code"><span class="info file"># File 'lib/gandi_v5.rb', line 30</span>
|
914
|
-
|
915
|
-
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_domains'>domains</span>
|
916
|
-
<span class='const'><span class='object_link'><a href="" title="GandiV5 (class)">GandiV5</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="GandiV5/Domain.html" title="GandiV5::Domain (class)">Domain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_list'><span class='object_link'><a href="GandiV5/Domain.html#list-class_method" title="GandiV5::Domain.list (method)">list</a></span></span>
|
917
|
-
<span class='kw'>end</span></pre>
|
918
|
-
</td>
|
919
|
-
</tr>
|
920
|
-
</table>
|
921
|
-
</div>
|
922
|
-
|
923
|
-
<div class="method_details ">
|
924
|
-
<h3 class="signature " id="get-class_method">
|
925
|
-
|
926
|
-
.<strong>get</strong>(url, **headers) ⇒ <tt>Object</tt>
|
927
|
-
|
928
|
-
|
929
|
-
|
930
|
-
|
931
|
-
|
932
|
-
</h3><div class="docstring">
|
933
|
-
<div class="discussion">
|
934
|
-
|
935
|
-
<p>Might raise:</p>
|
936
|
-
|
937
|
-
<pre class="code ruby"><code class="ruby">* RestClient::NotFound
|
938
|
-
* RestClient::Unauthorized
|
939
|
-
Bad authentication attempt because of a wrong API Key.
|
940
|
-
* RestClient::Forbidden
|
941
|
-
Access to the resource is denied.
|
942
|
-
Mainly due to a lack of permissions to access it.
|
943
|
-
* GandiV5::Error
|
944
|
-
* JSON::ParserError
|
945
|
-
</code></pre>
|
946
|
-
|
947
|
-
|
948
|
-
</div>
|
949
|
-
</div>
|
950
|
-
<div class="tags">
|
951
|
-
|
952
|
-
|
953
|
-
</div><table class="source_code">
|
954
|
-
<tr>
|
955
|
-
<td>
|
956
|
-
<pre class="lines">
|
957
|
-
|
958
|
-
|
959
|
-
46
|
960
|
-
47
|
961
|
-
48
|
962
|
-
49
|
963
|
-
50
|
964
|
-
51
|
965
|
-
52</pre>
|
966
|
-
</td>
|
967
|
-
<td>
|
968
|
-
<pre class="code"><span class="info file"># File 'lib/gandi_v5.rb', line 46</span>
|
969
|
-
|
970
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
971
|
-
<span class='id identifier rubyid_prepare_headers'>prepare_headers</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span>
|
972
|
-
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>RestClient</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span>
|
973
|
-
<span class='lbracket'>[</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_parse_response'>parse_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span><span class='rbracket'>]</span>
|
974
|
-
<span class='kw'>rescue</span> <span class='const'>RestClient</span><span class='op'>::</span><span class='const'>BadRequest</span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span>
|
975
|
-
<span class='id identifier rubyid_handle_bad_request'>handle_bad_request</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span>
|
976
|
-
<span class='kw'>end</span></pre>
|
977
|
-
</td>
|
978
|
-
</tr>
|
979
|
-
</table>
|
980
|
-
</div>
|
981
|
-
|
982
|
-
<div class="method_details ">
|
983
|
-
<h3 class="signature " id="patch-class_method">
|
984
|
-
|
985
|
-
.<strong>patch</strong>(url, payload = '', **headers) ⇒ <tt>Object</tt>
|
986
|
-
|
987
|
-
|
988
|
-
|
989
|
-
|
990
|
-
|
991
|
-
</h3><div class="docstring">
|
992
|
-
<div class="discussion">
|
993
|
-
|
994
|
-
<p>Might raise:</p>
|
995
|
-
|
996
|
-
<pre class="code ruby"><code class="ruby">* RestClient::NotFound
|
997
|
-
* RestClient::Unauthorized
|
998
|
-
Bad authentication attempt because of a wrong API Key.
|
999
|
-
* RestClient::Forbidden
|
1000
|
-
Access to the resource is denied.
|
1001
|
-
Mainly due to a lack of permissions to access it.
|
1002
|
-
* RestClient::BadRequest
|
1003
|
-
* RestClient::Conflict
|
1004
|
-
* GandiV5::Error
|
1005
|
-
* JSON::ParserError
|
1006
|
-
</code></pre>
|
1007
|
-
|
1008
|
-
|
1009
|
-
</div>
|
1010
|
-
</div>
|
1011
|
-
<div class="tags">
|
1012
|
-
|
1013
|
-
|
1014
|
-
</div><table class="source_code">
|
1015
|
-
<tr>
|
1016
|
-
<td>
|
1017
|
-
<pre class="lines">
|
1018
|
-
|
1019
|
-
|
1020
|
-
83
|
1021
|
-
84
|
1022
|
-
85
|
1023
|
-
86
|
1024
|
-
87
|
1025
|
-
88
|
1026
|
-
89
|
1027
|
-
90</pre>
|
1028
|
-
</td>
|
1029
|
-
<td>
|
1030
|
-
<pre class="code"><span class="info file"># File 'lib/gandi_v5.rb', line 83</span>
|
1031
|
-
|
1032
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
1033
|
-
<span class='id identifier rubyid_prepare_headers'>prepare_headers</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span>
|
1034
|
-
<span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='symbol'>:'content-type'</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span>
|
1035
|
-
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>RestClient</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span>
|
1036
|
-
<span class='lbracket'>[</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_parse_response'>parse_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span><span class='rbracket'>]</span>
|
1037
|
-
<span class='kw'>rescue</span> <span class='const'>RestClient</span><span class='op'>::</span><span class='const'>BadRequest</span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span>
|
1038
|
-
<span class='id identifier rubyid_handle_bad_request'>handle_bad_request</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span>
|
1039
|
-
<span class='kw'>end</span></pre>
|
1040
|
-
</td>
|
1041
|
-
</tr>
|
1042
|
-
</table>
|
1043
|
-
</div>
|
1044
|
-
|
1045
|
-
<div class="method_details ">
|
1046
|
-
<h3 class="signature " id="post-class_method">
|
1047
|
-
|
1048
|
-
.<strong>post</strong>(url, payload = '', **headers) ⇒ <tt>Object</tt>
|
1049
|
-
|
1050
|
-
|
1051
|
-
|
1052
|
-
|
1053
|
-
|
1054
|
-
</h3><div class="docstring">
|
1055
|
-
<div class="discussion">
|
1056
|
-
|
1057
|
-
<p>Might raise:</p>
|
1058
|
-
|
1059
|
-
<pre class="code ruby"><code class="ruby">* RestClient::NotFound
|
1060
|
-
* RestClient::Unauthorized
|
1061
|
-
Bad authentication attempt because of a wrong API Key.
|
1062
|
-
* RestClient::Forbidden
|
1063
|
-
Access to the resource is denied.
|
1064
|
-
Mainly due to a lack of permissions to access it.
|
1065
|
-
* RestClient::BadRequest
|
1066
|
-
* RestClient::Conflict
|
1067
|
-
* GandiV5::Error
|
1068
|
-
* JSON::ParserError
|
1069
|
-
</code></pre>
|
1070
|
-
|
1071
|
-
|
1072
|
-
</div>
|
1073
|
-
</div>
|
1074
|
-
<div class="tags">
|
1075
|
-
|
1076
|
-
|
1077
|
-
</div><table class="source_code">
|
1078
|
-
<tr>
|
1079
|
-
<td>
|
1080
|
-
<pre class="lines">
|
1081
|
-
|
1082
|
-
|
1083
|
-
103
|
1084
|
-
104
|
1085
|
-
105
|
1086
|
-
106
|
1087
|
-
107
|
1088
|
-
108
|
1089
|
-
109
|
1090
|
-
110</pre>
|
1091
|
-
</td>
|
1092
|
-
<td>
|
1093
|
-
<pre class="code"><span class="info file"># File 'lib/gandi_v5.rb', line 103</span>
|
1094
|
-
|
1095
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
1096
|
-
<span class='id identifier rubyid_prepare_headers'>prepare_headers</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span>
|
1097
|
-
<span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='symbol'>:'content-type'</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span>
|
1098
|
-
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>RestClient</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span>
|
1099
|
-
<span class='lbracket'>[</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_parse_response'>parse_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span><span class='rbracket'>]</span>
|
1100
|
-
<span class='kw'>rescue</span> <span class='const'>RestClient</span><span class='op'>::</span><span class='const'>BadRequest</span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span>
|
1101
|
-
<span class='id identifier rubyid_handle_bad_request'>handle_bad_request</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span>
|
1102
|
-
<span class='kw'>end</span></pre>
|
1103
|
-
</td>
|
1104
|
-
</tr>
|
1105
|
-
</table>
|
1106
|
-
</div>
|
1107
|
-
|
1108
|
-
<div class="method_details ">
|
1109
|
-
<h3 class="signature " id="put-class_method">
|
1110
|
-
|
1111
|
-
.<strong>put</strong>(url, payload = '', **headers) ⇒ <tt>Object</tt>
|
1112
|
-
|
1113
|
-
|
1114
|
-
|
1115
|
-
|
1116
|
-
|
1117
|
-
</h3><div class="docstring">
|
1118
|
-
<div class="discussion">
|
1119
|
-
|
1120
|
-
<p>Might raise:</p>
|
1121
|
-
|
1122
|
-
<pre class="code ruby"><code class="ruby">* RestClient::NotFound
|
1123
|
-
* RestClient::Unauthorized
|
1124
|
-
Bad authentication attempt because of a wrong API Key.
|
1125
|
-
* RestClient::Forbidden
|
1126
|
-
Access to the resource is denied.
|
1127
|
-
Mainly due to a lack of permissions to access it.
|
1128
|
-
* RestClient::BadRequest
|
1129
|
-
* RestClient::Conflict
|
1130
|
-
* GandiV5::Error
|
1131
|
-
* JSON::ParserError
|
1132
|
-
</code></pre>
|
1133
|
-
|
1134
|
-
|
1135
|
-
</div>
|
1136
|
-
</div>
|
1137
|
-
<div class="tags">
|
1138
|
-
|
1139
|
-
|
1140
|
-
</div><table class="source_code">
|
1141
|
-
<tr>
|
1142
|
-
<td>
|
1143
|
-
<pre class="lines">
|
1144
|
-
|
1145
|
-
|
1146
|
-
123
|
1147
|
-
124
|
1148
|
-
125
|
1149
|
-
126
|
1150
|
-
127
|
1151
|
-
128
|
1152
|
-
129
|
1153
|
-
130</pre>
|
1154
|
-
</td>
|
1155
|
-
<td>
|
1156
|
-
<pre class="code"><span class="info file"># File 'lib/gandi_v5.rb', line 123</span>
|
1157
|
-
|
1158
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
|
1159
|
-
<span class='id identifier rubyid_prepare_headers'>prepare_headers</span> <span class='id identifier rubyid_headers'>headers</span><span class='comma'>,</span> <span class='id identifier rubyid_url'>url</span>
|
1160
|
-
<span class='id identifier rubyid_headers'>headers</span><span class='lbracket'>[</span><span class='symbol'>:'content-type'</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span>
|
1161
|
-
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='const'>RestClient</span><span class='period'>.</span><span class='id identifier rubyid_put'>put</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_headers'>headers</span>
|
1162
|
-
<span class='lbracket'>[</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_parse_response'>parse_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span><span class='rbracket'>]</span>
|
1163
|
-
<span class='kw'>rescue</span> <span class='const'>RestClient</span><span class='op'>::</span><span class='const'>BadRequest</span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span>
|
1164
|
-
<span class='id identifier rubyid_handle_bad_request'>handle_bad_request</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span>
|
1165
|
-
<span class='kw'>end</span></pre>
|
1166
|
-
</td>
|
1167
|
-
</tr>
|
1168
|
-
</table>
|
1169
|
-
</div>
|
1170
|
-
|
1171
|
-
</div>
|
1172
|
-
|
1173
|
-
</div>
|
1174
|
-
|
1175
|
-
<div id="footer">
|
1176
|
-
Generated on Mon Jul 22 16:44:23 2019 by
|
1177
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1178
|
-
0.9.19 (ruby-2.6.3).
|
1179
|
-
</div>
|
1180
|
-
|
1181
|
-
</div>
|
1182
|
-
</body>
|
1183
|
-
</html>
|