gandi_v5 0.2.0 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (121) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/.rubocop.yml +1 -1
  4. data/.travis.yml +9 -0
  5. data/CHANGELOG.md +15 -0
  6. data/FUNDING.yml +10 -0
  7. data/README.md +7 -17
  8. data/gandi_v5.gemspec +3 -2
  9. data/lib/gandi_v5.rb +24 -10
  10. data/lib/gandi_v5/billing.rb +0 -2
  11. data/lib/gandi_v5/billing/info.rb +0 -2
  12. data/lib/gandi_v5/data.rb +0 -2
  13. data/lib/gandi_v5/data/converter.rb +0 -4
  14. data/lib/gandi_v5/domain.rb +159 -17
  15. data/lib/gandi_v5/domain/availability.rb +0 -3
  16. data/lib/gandi_v5/domain/availability/product.rb +0 -3
  17. data/lib/gandi_v5/domain/live_dns.rb +42 -0
  18. data/lib/gandi_v5/domain/renewal_information.rb +0 -3
  19. data/lib/gandi_v5/email.rb +0 -4
  20. data/lib/gandi_v5/email/forward.rb +108 -0
  21. data/lib/gandi_v5/email/mailbox.rb +0 -2
  22. data/lib/gandi_v5/error.rb +0 -2
  23. data/lib/gandi_v5/live_dns.rb +0 -4
  24. data/lib/gandi_v5/live_dns/domain.rb +1 -144
  25. data/lib/gandi_v5/live_dns/has_zone_records.rb +153 -0
  26. data/lib/gandi_v5/live_dns/zone.rb +1 -146
  27. data/lib/gandi_v5/organization.rb +28 -5
  28. data/lib/gandi_v5/version.rb +1 -1
  29. data/spec/.rubocop.yml +1 -1
  30. data/spec/features/domain_spec.rb +1 -1
  31. data/spec/fixtures/bodies/GandiV5_Billing/{info.yaml → info.yml} +0 -0
  32. data/spec/fixtures/bodies/GandiV5_Domain/{get.yaml → fetch.yml} +0 -0
  33. data/spec/fixtures/bodies/GandiV5_Domain/{fetch_contacts.yaml → fetch_contacts.yml} +0 -0
  34. data/spec/fixtures/bodies/GandiV5_Domain/fetch_glue_records.yml +7 -0
  35. data/spec/fixtures/bodies/GandiV5_Domain/fetch_livedns.yml +6 -0
  36. data/spec/fixtures/bodies/GandiV5_Domain/fetch_name_servers.yml +2 -0
  37. data/spec/fixtures/bodies/GandiV5_Domain/{renewal_info.yaml → fetch_renewal_info.yml} +0 -3
  38. data/spec/fixtures/bodies/GandiV5_Domain/{restore_info.yaml → fetch_restore_info.yml} +0 -0
  39. data/spec/fixtures/bodies/GandiV5_Domain/{list.yaml → list.yml} +1 -0
  40. data/spec/fixtures/bodies/GandiV5_Domain_Availability/{fetch.yaml → fetch.yml} +0 -0
  41. data/spec/fixtures/bodies/GandiV5_Domain_TLD/{fetch.yaml → fetch.yml} +0 -0
  42. data/spec/fixtures/bodies/GandiV5_Domain_TLD/{list.yaml → list.yml} +0 -0
  43. data/spec/fixtures/bodies/GandiV5_Email_Forward/list.yml +6 -0
  44. data/spec/fixtures/bodies/GandiV5_Email_Mailbox/{get.yaml → fetch.yml} +0 -0
  45. data/spec/fixtures/bodies/GandiV5_Email_Mailbox/{list.yaml → list.yml} +0 -0
  46. data/spec/fixtures/bodies/GandiV5_Email_Slot/{get.yaml → fetch.yml} +0 -0
  47. data/spec/fixtures/bodies/GandiV5_Email_Slot/{list.yaml → list.yml} +0 -0
  48. data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/{get.yaml → fetch.yml} +0 -0
  49. data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/{list.yaml → list.yml} +0 -0
  50. data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone/{get.yaml → fetch.yml} +0 -0
  51. data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone/{list.yaml → list.yml} +0 -0
  52. data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone_Snapshot/{fetch.yaml → fetch.yml} +0 -0
  53. data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone_Snapshot/{list.yaml → list.yml} +0 -0
  54. data/spec/fixtures/bodies/GandiV5_Organization/{get.yaml → fetch.yml} +0 -0
  55. data/spec/fixtures/bodies/GandiV5_Organization/list.yml +7 -0
  56. data/spec/fixtures/vcr/Domain_features/List_domains.yml +2 -1
  57. data/spec/spec_helper.rb +2 -2
  58. data/spec/units/gandi_v5/billing_spec.rb +2 -2
  59. data/spec/units/gandi_v5/domain/availability_spec.rb +1 -1
  60. data/spec/units/gandi_v5/domain/live_dns_spec.rb +45 -0
  61. data/spec/units/gandi_v5/domain/tld_spec.rb +2 -2
  62. data/spec/units/gandi_v5/domain_spec.rb +241 -22
  63. data/spec/units/gandi_v5/email/forward_spec.rb +121 -0
  64. data/spec/units/gandi_v5/email/mailbox_spec.rb +3 -3
  65. data/spec/units/gandi_v5/email/slot_spec.rb +3 -3
  66. data/spec/units/gandi_v5/live_dns/domain_spec.rb +3 -3
  67. data/spec/units/gandi_v5/live_dns/zone/snapshot_spec.rb +2 -2
  68. data/spec/units/gandi_v5/live_dns/zone_spec.rb +2 -2
  69. data/spec/units/gandi_v5/organization_spec.rb +38 -1
  70. metadata +51 -77
  71. data/doc/GandiV5.html +0 -1183
  72. data/doc/GandiV5/Billing.html +0 -293
  73. data/doc/GandiV5/Billing/Info.html +0 -641
  74. data/doc/GandiV5/Billing/Info/Prepaid.html +0 -817
  75. data/doc/GandiV5/Data.html +0 -785
  76. data/doc/GandiV5/Data/ClassMethods.html +0 -223
  77. data/doc/GandiV5/Data/Converter.html +0 -433
  78. data/doc/GandiV5/Data/Converter/ArrayOf.html +0 -413
  79. data/doc/GandiV5/Data/Converter/Symbol.html +0 -322
  80. data/doc/GandiV5/Data/Converter/Time.html +0 -330
  81. data/doc/GandiV5/Domain.html +0 -16847
  82. data/doc/GandiV5/Domain/AutoRenew.html +0 -1237
  83. data/doc/GandiV5/Domain/Availability.html +0 -1020
  84. data/doc/GandiV5/Domain/Availability/Product.html +0 -988
  85. data/doc/GandiV5/Domain/Availability/Product/Period.html +0 -220
  86. data/doc/GandiV5/Domain/Availability/Product/Price.html +0 -1031
  87. data/doc/GandiV5/Domain/Availability/Tax.html +0 -440
  88. data/doc/GandiV5/Domain/Contact.html +0 -4459
  89. data/doc/GandiV5/Domain/Contract.html +0 -520
  90. data/doc/GandiV5/Domain/Dates.html +0 -1313
  91. data/doc/GandiV5/Domain/RenewalInformation.html +0 -1147
  92. data/doc/GandiV5/Domain/RestoreInformation.html +0 -339
  93. data/doc/GandiV5/Domain/SharingSpace.html +0 -437
  94. data/doc/GandiV5/Domain/TLD.html +0 -1565
  95. data/doc/GandiV5/Email.html +0 -144
  96. data/doc/GandiV5/Email/Mailbox.html +0 -6307
  97. data/doc/GandiV5/Email/Mailbox/Responder.html +0 -1560
  98. data/doc/GandiV5/Email/Offer.html +0 -514
  99. data/doc/GandiV5/Email/Slot.html +0 -4244
  100. data/doc/GandiV5/Error.html +0 -151
  101. data/doc/GandiV5/Error/GandiError.html +0 -270
  102. data/doc/GandiV5/LiveDNS.html +0 -300
  103. data/doc/GandiV5/LiveDNS/Domain.html +0 -2984
  104. data/doc/GandiV5/LiveDNS/RecordSet.html +0 -1593
  105. data/doc/GandiV5/LiveDNS/Zone.html +0 -8891
  106. data/doc/GandiV5/LiveDNS/Zone/Snapshot.html +0 -1556
  107. data/doc/GandiV5/Organization.html +0 -2341
  108. data/doc/_index.html +0 -474
  109. data/doc/class_list.html +0 -51
  110. data/doc/css/common.css +0 -1
  111. data/doc/css/full_list.css +0 -58
  112. data/doc/css/style.css +0 -496
  113. data/doc/file.README.html +0 -175
  114. data/doc/file_list.html +0 -56
  115. data/doc/frames.html +0 -17
  116. data/doc/index.html +0 -175
  117. data/doc/js/app.js +0 -303
  118. data/doc/js/full_list.js +0 -216
  119. data/doc/js/jquery.js +0 -4
  120. data/doc/method_list.html +0 -2427
  121. data/doc/top-level-namespace.html +0 -110
@@ -1,151 +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
- Exception: GandiV5::Error
8
-
9
- &mdash; 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::Error";
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 (E)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span>
41
- &raquo;
42
- <span class="title">Error</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>Exception: GandiV5::Error
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
- <dl>
70
- <dt>Inherits:</dt>
71
- <dd>
72
- <span class="inheritName">RuntimeError</span>
73
-
74
- <ul class="fullTree">
75
- <li>Object</li>
76
-
77
- <li class="next">RuntimeError</li>
78
-
79
- <li class="next">GandiV5::Error</li>
80
-
81
- </ul>
82
- <a href="#" class="inheritanceTree">show all</a>
83
-
84
- </dd>
85
- </dl>
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
-
96
-
97
- <dl>
98
- <dt>Defined in:</dt>
99
- <dd>lib/gandi_v5/error.rb<span class="defines">,<br />
100
- lib/gandi_v5/error/gandi_error.rb</span>
101
- </dd>
102
- </dl>
103
-
104
- </div>
105
-
106
- <h2>Overview</h2><div class="docstring">
107
- <div class="discussion">
108
-
109
- <p>Generic error class for errors occuring using the API.</p>
110
-
111
-
112
- </div>
113
- </div>
114
- <div class="tags">
115
-
116
-
117
- </div><div id="subclasses">
118
- <h2>Direct Known Subclasses</h2>
119
- <p class="children"><span class='object_link'><a href="Error/GandiError.html" title="GandiV5::Error::GandiError (class)">GandiError</a></span></p>
120
- </div>
121
- <h2>Defined Under Namespace</h2>
122
- <p class="children">
123
-
124
-
125
-
126
-
127
- <strong class="classes">Classes:</strong> <span class='object_link'><a href="Error/GandiError.html" title="GandiV5::Error::GandiError (class)">GandiError</a></span>
128
-
129
-
130
- </p>
131
-
132
-
133
-
134
-
135
-
136
-
137
-
138
-
139
-
140
-
141
- </div>
142
-
143
- <div id="footer">
144
- Generated on Mon Jul 22 16:44:23 2019 by
145
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
146
- 0.9.19 (ruby-2.6.3).
147
- </div>
148
-
149
- </div>
150
- </body>
151
- </html>
@@ -1,270 +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
- Exception: GandiV5::Error::GandiError
8
-
9
- &mdash; 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::Error::GandiError";
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> &raquo;
40
- <span class='title'><span class='object_link'><a href="../../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Error.html" title="GandiV5::Error (class)">Error</a></span></span>
41
- &raquo;
42
- <span class="title">GandiError</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>Exception: GandiV5::Error::GandiError
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
- <dl>
70
- <dt>Inherits:</dt>
71
- <dd>
72
- <span class="inheritName"><span class='object_link'><a href="../Error.html" title="GandiV5::Error (class)">GandiV5::Error</a></span></span>
73
-
74
- <ul class="fullTree">
75
- <li>Object</li>
76
-
77
- <li class="next">RuntimeError</li>
78
-
79
- <li class="next"><span class='object_link'><a href="../Error.html" title="GandiV5::Error (class)">GandiV5::Error</a></span></li>
80
-
81
- <li class="next">GandiV5::Error::GandiError</li>
82
-
83
- </ul>
84
- <a href="#" class="inheritanceTree">show all</a>
85
-
86
- </dd>
87
- </dl>
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
-
96
-
97
-
98
-
99
- <dl>
100
- <dt>Defined in:</dt>
101
- <dd>lib/gandi_v5/error/gandi_error.rb</dd>
102
- </dl>
103
-
104
- </div>
105
-
106
- <h2>Overview</h2><div class="docstring">
107
- <div class="discussion">
108
-
109
- <p>Generic error class for errors returned by Gandi.</p>
110
-
111
-
112
- </div>
113
- </div>
114
- <div class="tags">
115
-
116
-
117
- </div>
118
-
119
-
120
-
121
-
122
-
123
-
124
-
125
- <h2>
126
- Class Method Summary
127
- <small><a href="#" class="summary_toggle">collapse</a></small>
128
- </h2>
129
-
130
- <ul class="summary">
131
-
132
- <li class="public ">
133
- <span class="summary_signature">
134
-
135
- <a href="#from_hash-class_method" title="from_hash (class method)">.<strong>from_hash</strong>(hash) &#x21d2; GandiV5::Error::GandiError </a>
136
-
137
-
138
-
139
- </span>
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
- <span class="summary_desc"><div class='inline'>
150
- <p>Generate a new GandiV5::Error::GandiError from the hash returned by Gandi.</p>
151
- </div></span>
152
-
153
- </li>
154
-
155
-
156
- </ul>
157
-
158
-
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
- <div id="class_method_details" class="method_details_list">
169
- <h2>Class Method Details</h2>
170
-
171
-
172
- <div class="method_details first">
173
- <h3 class="signature first" id="from_hash-class_method">
174
-
175
- .<strong>from_hash</strong>(hash) &#x21d2; <tt><span class='object_link'><a href="" title="GandiV5::Error::GandiError (class)">GandiV5::Error::GandiError</a></span></tt>
176
-
177
-
178
-
179
-
180
-
181
- </h3><div class="docstring">
182
- <div class="discussion">
183
-
184
- <p>Generate a new GandiV5::Error::GandiError from the hash returned by Gandi.</p>
185
-
186
-
187
- </div>
188
- </div>
189
- <div class="tags">
190
- <p class="tag_title">Parameters:</p>
191
- <ul class="param">
192
-
193
- <li>
194
-
195
- <span class='name'>hash</span>
196
-
197
-
198
- <span class='type'>(<tt>Hash</tt>)</span>
199
-
200
-
201
-
202
- &mdash;
203
- <div class='inline'>
204
- <p>the hash returned by Gandi.</p>
205
- </div>
206
-
207
- </li>
208
-
209
- </ul>
210
-
211
- <p class="tag_title">Returns:</p>
212
- <ul class="return">
213
-
214
- <li>
215
-
216
-
217
- <span class='type'>(<tt><span class='object_link'><a href="" title="GandiV5::Error::GandiError (class)">GandiV5::Error::GandiError</a></span></tt>)</span>
218
-
219
-
220
-
221
- </li>
222
-
223
- </ul>
224
-
225
- </div><table class="source_code">
226
- <tr>
227
- <td>
228
- <pre class="lines">
229
-
230
-
231
- 10
232
- 11
233
- 12
234
- 13
235
- 14
236
- 15
237
- 16
238
- 17
239
- 18</pre>
240
- </td>
241
- <td>
242
- <pre class="code"><span class="info file"># File 'lib/gandi_v5/error/gandi_error.rb', line 10</span>
243
-
244
- <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from_hash'>from_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
245
- <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>errors</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
246
-
247
- <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
248
- <span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>errors</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_count'>count</span> <span class='op'>&gt;</span> <span class='int'>1</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='op'>+</span>
249
- <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>errors</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_err'>err</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_err'>err</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>location</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>-&gt;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_err'>err</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>name</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_err'>err</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>description</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
250
- <span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
251
- <span class='rparen'>)</span>
252
- <span class='kw'>end</span></pre>
253
- </td>
254
- </tr>
255
- </table>
256
- </div>
257
-
258
- </div>
259
-
260
- </div>
261
-
262
- <div id="footer">
263
- Generated on Mon Jul 22 16:44:33 2019 by
264
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
265
- 0.9.19 (ruby-2.6.3).
266
- </div>
267
-
268
- </div>
269
- </body>
270
- </html>
@@ -1,300 +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::LiveDNS
8
-
9
- &mdash; 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::LiveDNS";
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 (L)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span>
41
- &raquo;
42
- <span class="title">LiveDNS</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::LiveDNS
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::LiveDNS</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/live_dns.rb<span class="defines">,<br />
98
- lib/gandi_v5/live_dns/zone.rb,<br /> lib/gandi_v5/live_dns/domain.rb,<br /> lib/gandi_v5/live_dns/record_set.rb,<br /> lib/gandi_v5/live_dns/zone/snapshot.rb</span>
99
- </dd>
100
- </dl>
101
-
102
- </div>
103
-
104
- <h2>Overview</h2><div class="docstring">
105
- <div class="discussion">
106
-
107
- <p>Gandi LiveDNS Management API.</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
-
120
-
121
- <strong class="classes">Classes:</strong> <span class='object_link'><a href="LiveDNS/Domain.html" title="GandiV5::LiveDNS::Domain (class)">Domain</a></span>, <span class='object_link'><a href="LiveDNS/RecordSet.html" title="GandiV5::LiveDNS::RecordSet (class)">RecordSet</a></span>, <span class='object_link'><a href="LiveDNS/Zone.html" title="GandiV5::LiveDNS::Zone (class)">Zone</a></span>
122
-
123
-
124
- </p>
125
-
126
-
127
- <h2>
128
- Constant Summary
129
- <small><a href="#" class="constants_summary_toggle">collapse</a></small>
130
- </h2>
131
-
132
- <dl class="constants">
133
-
134
- <dt id="BASE-constant" class="">BASE =
135
-
136
- </dt>
137
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://dns.api.gandi.net/api/v5/</span><span class='tstring_end'>&#39;</span></span></pre></dd>
138
-
139
- <dt id="RECORD_TYPES-constant" class="">RECORD_TYPES =
140
-
141
- </dt>
142
- <dd><pre class="code"><span class='qwords_beg'>%w[</span><span class='words_sep'>
143
- </span><span class='tstring_content'>A</span><span class='words_sep'> </span><span class='tstring_content'>AAAA</span><span class='words_sep'> </span><span class='tstring_content'>CNAME</span><span class='words_sep'> </span><span class='tstring_content'>MX</span><span class='words_sep'> </span><span class='tstring_content'>NS</span><span class='words_sep'> </span><span class='tstring_content'>TXT</span><span class='words_sep'> </span><span class='tstring_content'>ALIAS</span><span class='words_sep'>
144
- </span><span class='tstring_content'>WKS</span><span class='words_sep'> </span><span class='tstring_content'>SRV</span><span class='words_sep'> </span><span class='tstring_content'>LOC</span><span class='words_sep'> </span><span class='tstring_content'>SPF</span><span class='words_sep'> </span><span class='tstring_content'>CAA</span><span class='words_sep'> </span><span class='tstring_content'>DS</span><span class='words_sep'> </span><span class='tstring_content'>SSHFP</span><span class='words_sep'> </span><span class='tstring_content'>PTR</span><span class='words_sep'> </span><span class='tstring_content'>KEY</span><span class='words_sep'> </span><span class='tstring_content'>DNAME</span><span class='words_sep'> </span><span class='tstring_content'>TLSA</span><span class='words_sep'> </span><span class='tstring_content'>OPENPGPKEY</span><span class='words_sep'> </span><span class='tstring_content'>CDS</span><span class='words_sep'>
145
- </span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
146
-
147
- </dl>
148
-
149
-
150
-
151
-
152
-
153
-
154
-
155
-
156
-
157
- <h2>
158
- Class Method Summary
159
- <small><a href="#" class="summary_toggle">collapse</a></small>
160
- </h2>
161
-
162
- <ul class="summary">
163
-
164
- <li class="public ">
165
- <span class="summary_signature">
166
-
167
- <a href="#require_valid_record_type-class_method" title="require_valid_record_type (class method)">.<strong>require_valid_record_type</strong>(type) &#x21d2; nil </a>
168
-
169
-
170
-
171
- </span>
172
-
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
-
181
- <span class="summary_desc"><div class='inline'>
182
- <p>Raise an error if passed type is invalid.</p>
183
- </div></span>
184
-
185
- </li>
186
-
187
-
188
- </ul>
189
-
190
-
191
-
192
-
193
- <div id="class_method_details" class="method_details_list">
194
- <h2>Class Method Details</h2>
195
-
196
-
197
- <div class="method_details first">
198
- <h3 class="signature first" id="require_valid_record_type-class_method">
199
-
200
- .<strong>require_valid_record_type</strong>(type) &#x21d2; <tt>nil</tt>
201
-
202
-
203
-
204
-
205
-
206
- </h3><div class="docstring">
207
- <div class="discussion">
208
-
209
- <p>Raise an error if passed type is invalid. rubocop:disable Style/GuardClause</p>
210
-
211
-
212
- </div>
213
- </div>
214
- <div class="tags">
215
- <p class="tag_title">Parameters:</p>
216
- <ul class="param">
217
-
218
- <li>
219
-
220
- <span class='name'>type</span>
221
-
222
-
223
- <span class='type'>(<tt>String</tt>)</span>
224
-
225
-
226
-
227
- &mdash;
228
- <div class='inline'>
229
- <p>the record type to check.</p>
230
- </div>
231
-
232
- </li>
233
-
234
- </ul>
235
-
236
- <p class="tag_title">Returns:</p>
237
- <ul class="return">
238
-
239
- <li>
240
-
241
-
242
- <span class='type'>(<tt>nil</tt>)</span>
243
-
244
-
245
-
246
- </li>
247
-
248
- </ul>
249
- <p class="tag_title">Raises:</p>
250
- <ul class="raise">
251
-
252
- <li>
253
-
254
-
255
- <span class='type'>(<tt>ArgumentError</tt>)</span>
256
-
257
-
258
-
259
- </li>
260
-
261
- </ul>
262
-
263
- </div><table class="source_code">
264
- <tr>
265
- <td>
266
- <pre class="lines">
267
-
268
-
269
- 19
270
- 20
271
- 21
272
- 22
273
- 23</pre>
274
- </td>
275
- <td>
276
- <pre class="code"><span class="info file"># File 'lib/gandi_v5/live_dns.rb', line 19</span>
277
-
278
- <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_require_valid_record_type'>require_valid_record_type</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
279
- <span class='kw'>unless</span> <span class='const'><span class='object_link'><a href="#RECORD_TYPES-constant" title="GandiV5::LiveDNS::RECORD_TYPES (constant)">RECORD_TYPES</a></span></span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
280
- <span class='id identifier rubyid_fail'>fail</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>type must be one of </span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#RECORD_TYPES-constant" title="GandiV5::LiveDNS::RECORD_TYPES (constant)">RECORD_TYPES</a></span></span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>, </span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
281
- <span class='kw'>end</span>
282
- <span class='kw'>end</span></pre>
283
- </td>
284
- </tr>
285
- </table>
286
- </div>
287
-
288
- </div>
289
-
290
- </div>
291
-
292
- <div id="footer">
293
- Generated on Mon Jul 22 16:44:26 2019 by
294
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
295
- 0.9.19 (ruby-2.6.3).
296
- </div>
297
-
298
- </div>
299
- </body>
300
- </html>