gandi_v5 0.2.0 → 0.7.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +2 -0
- data/.rubocop.yml +13 -3
- data/.travis.yml +15 -1
- data/CHANGELOG.md +63 -0
- data/FUNDING.yml +10 -0
- data/LICENSE.md +2 -6
- data/README.md +16 -21
- data/gandi_v5.gemspec +3 -2
- data/lib/gandi_v5.rb +64 -24
- data/lib/gandi_v5/billing.rb +0 -2
- data/lib/gandi_v5/billing/info.rb +0 -2
- data/lib/gandi_v5/data.rb +1 -4
- data/lib/gandi_v5/data/converter.rb +0 -4
- data/lib/gandi_v5/data/converter/integer.rb +26 -0
- data/lib/gandi_v5/domain.rb +167 -28
- 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/domain/sharing_space.rb +10 -2
- data/lib/gandi_v5/email.rb +0 -4
- data/lib/gandi_v5/email/forward.rb +102 -0
- data/lib/gandi_v5/email/mailbox.rb +57 -13
- data/lib/gandi_v5/email/slot.rb +11 -3
- data/lib/gandi_v5/error.rb +0 -2
- data/lib/gandi_v5/live_dns.rb +0 -16
- data/lib/gandi_v5/live_dns/domain.rb +221 -80
- data/lib/gandi_v5/live_dns/domain/dnssec_key.rb +115 -0
- data/lib/gandi_v5/live_dns/domain/record.rb +81 -0
- data/lib/gandi_v5/live_dns/domain/snapshot.rb +107 -0
- data/lib/gandi_v5/live_dns/domain/tsig_key.rb +71 -0
- data/lib/gandi_v5/organization.rb +38 -5
- data/lib/gandi_v5/organization/customer.rb +90 -0
- data/lib/gandi_v5/version.rb +1 -1
- data/spec/.rubocop.yml +9 -2
- data/spec/fixtures/bodies/GandiV5_Billing/{info.yaml → info.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_Domain/{get.yaml → fetch.yml} +8 -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/fetch.yml +3 -0
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/{list.yaml → list.yml} +0 -0
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/list_tsig.yml +3 -0
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/nameservers.yml +3 -0
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain_DnssecKey/fetch.yml +12 -0
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain_DnssecKey/list.yml +9 -0
- data/spec/fixtures/bodies/{GandiV5_LiveDNS_Zone_Snapshot/fetch.yaml → GandiV5_LiveDNS_Domain_Snapshot/fetch.yml} +4 -3
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain_Snapshot/list.yml +5 -0
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain_TsigKey/fetch.yml +9 -0
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain_TsigKey/list.yml +4 -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/bodies/GandiV5_Organization_Customer/list.yml +8 -0
- data/spec/spec_helper.rb +2 -2
- data/spec/units/gandi_v5/billing_spec.rb +2 -2
- data/spec/units/gandi_v5/data/converter/integer_spec.rb +16 -0
- 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 +294 -65
- data/spec/units/gandi_v5/email/forward_spec.rb +92 -0
- data/spec/units/gandi_v5/email/mailbox_spec.rb +122 -40
- data/spec/units/gandi_v5/email/slot_spec.rb +13 -5
- data/spec/units/gandi_v5/live_dns/domain/dnssec_key_spec.rb +128 -0
- data/spec/units/gandi_v5/live_dns/{record_set_spec.rb → domain/record_spec.rb} +1 -1
- data/spec/units/gandi_v5/live_dns/domain/snapshot_spec.rb +101 -0
- data/spec/units/gandi_v5/live_dns/domain/tsig_key_spec.rb +78 -0
- data/spec/units/gandi_v5/live_dns/domain_spec.rb +299 -120
- data/spec/units/gandi_v5/live_dns_spec.rb +0 -12
- data/spec/units/gandi_v5/organization/customer_spec.rb +81 -0
- data/spec/units/gandi_v5/organization_spec.rb +52 -1
- data/spec/units/gandi_v5_spec.rb +139 -30
- metadata +68 -95
- 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/lib/gandi_v5/live_dns/record_set.rb +0 -79
- data/lib/gandi_v5/live_dns/zone.rb +0 -305
- data/lib/gandi_v5/live_dns/zone/snapshot.rb +0 -81
- data/spec/features/domain_spec.rb +0 -45
- data/spec/features/livedns_domain_spec.rb +0 -8
- data/spec/features/livedns_zone_spec.rb +0 -45
- data/spec/features/mailbox_spec.rb +0 -18
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Domain/get.yaml +0 -4
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone/get.yaml +0 -11
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone/list.yaml +0 -11
- data/spec/fixtures/bodies/GandiV5_LiveDNS_Zone_Snapshot/list.yaml +0 -3
- data/spec/fixtures/vcr/Domain_features/List_domains.yml +0 -54
- data/spec/fixtures/vcr/Domain_features/Renew_domain.yml +0 -133
- data/spec/fixtures/vcr/LiveDNS_Domain_features/List_domains.yml +0 -32
- data/spec/fixtures/vcr/LiveDNS_Zone_features/List_zones.yml +0 -42
- data/spec/fixtures/vcr/LiveDNS_Zone_features/Make_and_save_snapshot.yml +0 -72
- data/spec/fixtures/vcr/LiveDNS_Zone_features/Save_zone_to_file.yml +0 -28
- data/spec/fixtures/vcr/Mailbox_features/List_mailboxes.yml +0 -39
- data/spec/units/gandi_v5/live_dns/zone/snapshot_spec.rb +0 -66
- data/spec/units/gandi_v5/live_dns/zone_spec.rb +0 -347
data/doc/file.README.html
DELETED
@@ -1,175 +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
|
-
File: README
|
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 = "README";
|
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="file_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</a> »
|
40
|
-
<span class="title">File: README</span>
|
41
|
-
|
42
|
-
</div>
|
43
|
-
|
44
|
-
<div id="search">
|
45
|
-
|
46
|
-
<a class="full_list_link" id="class_list_link"
|
47
|
-
href="class_list.html">
|
48
|
-
|
49
|
-
<svg width="24" height="24">
|
50
|
-
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
51
|
-
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
52
|
-
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
-
</svg>
|
54
|
-
</a>
|
55
|
-
|
56
|
-
</div>
|
57
|
-
<div class="clear"></div>
|
58
|
-
</div>
|
59
|
-
|
60
|
-
<div id="content"><div id='filecontents'><p><a href="http://badge.fury.io/rb/gandi_v5"><img src="https://badge.fury.io/rb/gandi_v5.png" alt="Gem Version"></a></p>
|
61
|
-
|
62
|
-
<p>Master branch:
|
63
|
-
<a href="http://travis-ci.org/robertgauld/gandi_v5"><img src="https://secure.travis-ci.org/robertgauld/gandi_v5.png?branch=master" alt="Build Status"></a>
|
64
|
-
<a href="https://coveralls.io/r/robertgauld/gandi_v5"><img src="https://coveralls.io/repos/robertgauld/gandi_v5/badge.png?branch=master" alt="Coveralls Status"></a>
|
65
|
-
<a href="https://codeclimate.com/github/robertgauld/gandi_v5"><img src="https://codeclimate.com/github/robertgauld/gandi_v5.png?branch=master" alt="Code Climate"></a></p>
|
66
|
-
|
67
|
-
<p>Staging branch:
|
68
|
-
<a href="http://travis-ci.org/robertgauld/gandi_v5"><img src="https://secure.travis-ci.org/robertgauld/gandi_v5.png?branch=staging" alt="Build Status"></a>
|
69
|
-
<a href="https://coveralls.io/r/robertgauld/gandi_v5"><img src="https://coveralls.io/repos/robertgauld/gandi_v5/badge.png?branch=staging" alt="Coveralls Status"></a></p>
|
70
|
-
|
71
|
-
<h2>Build State</h2>
|
72
|
-
|
73
|
-
<p>This project uses continuous integration to help ensure that a quality product is delivered.
|
74
|
-
Travis CI monitors two branches (versions) of the code:</p>
|
75
|
-
|
76
|
-
<ul>
|
77
|
-
<li>Master (which is what gets released)</li>
|
78
|
-
<li>Staging (which is what is currently being developed ready for moving to master).</li>
|
79
|
-
</ul>
|
80
|
-
|
81
|
-
<h2>Ruby Versions</h2>
|
82
|
-
|
83
|
-
<p>This gem supports the following versions of ruby, it may work on other versions but is not tested against them so don't rely on it.</p>
|
84
|
-
|
85
|
-
<ul>
|
86
|
-
<li>ruby:
|
87
|
-
|
88
|
-
<ul>
|
89
|
-
<li>2.6.0 - 2.6.3</li>
|
90
|
-
</ul></li>
|
91
|
-
<li>jruby, once it's reached parity with ruby 2.6.x</li>
|
92
|
-
</ul>
|
93
|
-
|
94
|
-
<h2>Gandi V5</h2>
|
95
|
-
|
96
|
-
<p>Make use of Gandi's V5 API.
|
97
|
-
See the table in the <a href="#Versioning">Versioning section</a> to see what Gandi
|
98
|
-
API Changes each version is current for.</p>
|
99
|
-
|
100
|
-
<p>Gandi say: <strong><em>"Please note that this API is currently in BETA testing, so care should be taken when used in production.</em>"</strong></p>
|
101
|
-
|
102
|
-
<p>But then you were going to be careful anyway as this gem is currently in the version 0.something range weren't you!</p>
|
103
|
-
|
104
|
-
<p>Details of the API can be found at:</p>
|
105
|
-
|
106
|
-
<ul>
|
107
|
-
<li><a href="https://api.gandi.net/docs/">https://api.gandi.net/docs/</a></li>
|
108
|
-
<li><a href="https://doc.livedns.gandi.net/">https://doc.livedns.gandi.net/</a></li>
|
109
|
-
</ul>
|
110
|
-
|
111
|
-
<h2>Installation</h2>
|
112
|
-
|
113
|
-
<p>If you're using bundler then add it to your Gemfile and run the bundle command.</p>
|
114
|
-
|
115
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>gandi_v5</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>~> 0.1</span><span class='tstring_end'>'</span></span>
|
116
|
-
</code></pre>
|
117
|
-
|
118
|
-
<p>If you're not using bundler then install it from the command line.</p>
|
119
|
-
|
120
|
-
<pre class="code bash"><code class="bash">gem install gandi_v5 -v '~> 0.1'
|
121
|
-
</code></pre>
|
122
|
-
|
123
|
-
<h2>Usage</h2>
|
124
|
-
|
125
|
-
<h3>Setup</h3>
|
126
|
-
|
127
|
-
<p>You'll need you Gandi API KEY, you can get this by logging into Gandi and
|
128
|
-
navigating to User Settings -> Change password & configure access restrictions.</p>
|
129
|
-
|
130
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>gandi_v5</span><span class='tstring_end'>'</span></span> <span class='comment'># Unless you're using Bundler
|
131
|
-
</span><span class='const'><span class='object_link'><a href="GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_key'>api_key</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>…</span><span class='tstring_end'>'</span></span> <span class='comment'># Unless you've set it in the environment variable GANDI_API_KEY
|
132
|
-
</span></code></pre>
|
133
|
-
|
134
|
-
<h3>Examples</h3>
|
135
|
-
|
136
|
-
<h4>Domains</h4>
|
137
|
-
|
138
|
-
<pre class="code ruby"><code class="ruby"><span class='comment'># Get an array of all your domains.
|
139
|
-
</span><span class='id identifier rubyid_domains'>domains</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='period'>.</span><span class='id identifier rubyid_domains'><span class='object_link'><a href="GandiV5.html#domains-class_method" title="GandiV5.domains (method)">domains</a></span></span>
|
140
|
-
|
141
|
-
<span class='comment'># Since each domain has only basic information, lets get all of the information.
|
142
|
-
</span><span class='id identifier rubyid_domains'>domains</span><span class='period'>.</span><span class='id identifier rubyid_map!'>map!</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:refresh</span><span class='rparen'>)</span>
|
143
|
-
</code></pre>
|
144
|
-
|
145
|
-
<p>TODO: More examples!</p>
|
146
|
-
|
147
|
-
<h2>Versioning</h2>
|
148
|
-
|
149
|
-
<p>We follow the <a href="http://semver.org/">Semantic Versioning</a> concept.</p>
|
150
|
-
|
151
|
-
<table><thead>
|
152
|
-
<tr>
|
153
|
-
<th>Gem Version</th>
|
154
|
-
<th>Gandi API Release Date</th>
|
155
|
-
</tr>
|
156
|
-
</thead><tbody>
|
157
|
-
<tr>
|
158
|
-
<td>0.1.0</td>
|
159
|
-
<td>2019-05-16</td>
|
160
|
-
</tr>
|
161
|
-
</tbody></table>
|
162
|
-
|
163
|
-
<p>See <a href="https://api.gandi.net/docs/reference#API-Changelog">https://api.gandi.net/docs/reference#API-Changelog</a> to find out what
|
164
|
-
Gandi changed on each date.</p>
|
165
|
-
</div></div>
|
166
|
-
|
167
|
-
<div id="footer">
|
168
|
-
Generated on Mon Jul 22 16:44:23 2019 by
|
169
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
170
|
-
0.9.19 (ruby-2.6.3).
|
171
|
-
</div>
|
172
|
-
|
173
|
-
</div>
|
174
|
-
</body>
|
175
|
-
</html>
|
data/doc/file_list.html
DELETED
@@ -1,56 +0,0 @@
|
|
1
|
-
<!DOCTYPE html>
|
2
|
-
<html>
|
3
|
-
<head>
|
4
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
5
|
-
<meta charset="utf-8" />
|
6
|
-
|
7
|
-
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
8
|
-
|
9
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
14
|
-
|
15
|
-
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
16
|
-
|
17
|
-
|
18
|
-
<title>File List</title>
|
19
|
-
<base id="base_target" target="_parent" />
|
20
|
-
</head>
|
21
|
-
<body>
|
22
|
-
<div id="content">
|
23
|
-
<div class="fixed_header">
|
24
|
-
<h1 id="full_list_header">File List</h1>
|
25
|
-
<div id="full_list_nav">
|
26
|
-
|
27
|
-
<span><a target="_self" href="class_list.html">
|
28
|
-
Classes
|
29
|
-
</a></span>
|
30
|
-
|
31
|
-
<span><a target="_self" href="method_list.html">
|
32
|
-
Methods
|
33
|
-
</a></span>
|
34
|
-
|
35
|
-
<span><a target="_self" href="file_list.html">
|
36
|
-
Files
|
37
|
-
</a></span>
|
38
|
-
|
39
|
-
</div>
|
40
|
-
|
41
|
-
<div id="search">Search: <input type="text" /></div>
|
42
|
-
</div>
|
43
|
-
|
44
|
-
<ul id="full_list" class="file">
|
45
|
-
|
46
|
-
|
47
|
-
<li id="object_README" class="odd">
|
48
|
-
<div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
|
49
|
-
</li>
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
</ul>
|
54
|
-
</div>
|
55
|
-
</body>
|
56
|
-
</html>
|
data/doc/frames.html
DELETED
@@ -1,17 +0,0 @@
|
|
1
|
-
<!DOCTYPE html>
|
2
|
-
<html>
|
3
|
-
<head>
|
4
|
-
<meta charset="utf-8">
|
5
|
-
<title>Documentation by YARD 0.9.19</title>
|
6
|
-
</head>
|
7
|
-
<script type="text/javascript" charset="utf-8">
|
8
|
-
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
9
|
-
var name = match ? match[1] : 'index.html';
|
10
|
-
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
11
|
-
window.top.location = name;
|
12
|
-
</script>
|
13
|
-
<noscript>
|
14
|
-
<h1>Oops!</h1>
|
15
|
-
<h2>YARD requires JavaScript!</h2>
|
16
|
-
</noscript>
|
17
|
-
</html>
|
data/doc/index.html
DELETED
@@ -1,175 +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
|
-
File: README
|
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 = "README";
|
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</a> »
|
40
|
-
<span class="title">File: README</span>
|
41
|
-
|
42
|
-
</div>
|
43
|
-
|
44
|
-
<div id="search">
|
45
|
-
|
46
|
-
<a class="full_list_link" id="class_list_link"
|
47
|
-
href="class_list.html">
|
48
|
-
|
49
|
-
<svg width="24" height="24">
|
50
|
-
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
51
|
-
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
52
|
-
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
-
</svg>
|
54
|
-
</a>
|
55
|
-
|
56
|
-
</div>
|
57
|
-
<div class="clear"></div>
|
58
|
-
</div>
|
59
|
-
|
60
|
-
<div id="content"><div id='filecontents'><p><a href="http://badge.fury.io/rb/gandi_v5"><img src="https://badge.fury.io/rb/gandi_v5.png" alt="Gem Version"></a></p>
|
61
|
-
|
62
|
-
<p>Master branch:
|
63
|
-
<a href="http://travis-ci.org/robertgauld/gandi_v5"><img src="https://secure.travis-ci.org/robertgauld/gandi_v5.png?branch=master" alt="Build Status"></a>
|
64
|
-
<a href="https://coveralls.io/r/robertgauld/gandi_v5"><img src="https://coveralls.io/repos/robertgauld/gandi_v5/badge.png?branch=master" alt="Coveralls Status"></a>
|
65
|
-
<a href="https://codeclimate.com/github/robertgauld/gandi_v5"><img src="https://codeclimate.com/github/robertgauld/gandi_v5.png?branch=master" alt="Code Climate"></a></p>
|
66
|
-
|
67
|
-
<p>Staging branch:
|
68
|
-
<a href="http://travis-ci.org/robertgauld/gandi_v5"><img src="https://secure.travis-ci.org/robertgauld/gandi_v5.png?branch=staging" alt="Build Status"></a>
|
69
|
-
<a href="https://coveralls.io/r/robertgauld/gandi_v5"><img src="https://coveralls.io/repos/robertgauld/gandi_v5/badge.png?branch=staging" alt="Coveralls Status"></a></p>
|
70
|
-
|
71
|
-
<h2>Build State</h2>
|
72
|
-
|
73
|
-
<p>This project uses continuous integration to help ensure that a quality product is delivered.
|
74
|
-
Travis CI monitors two branches (versions) of the code:</p>
|
75
|
-
|
76
|
-
<ul>
|
77
|
-
<li>Master (which is what gets released)</li>
|
78
|
-
<li>Staging (which is what is currently being developed ready for moving to master).</li>
|
79
|
-
</ul>
|
80
|
-
|
81
|
-
<h2>Ruby Versions</h2>
|
82
|
-
|
83
|
-
<p>This gem supports the following versions of ruby, it may work on other versions but is not tested against them so don't rely on it.</p>
|
84
|
-
|
85
|
-
<ul>
|
86
|
-
<li>ruby:
|
87
|
-
|
88
|
-
<ul>
|
89
|
-
<li>2.6.0 - 2.6.3</li>
|
90
|
-
</ul></li>
|
91
|
-
<li>jruby, once it's reached parity with ruby 2.6.x</li>
|
92
|
-
</ul>
|
93
|
-
|
94
|
-
<h2>Gandi V5</h2>
|
95
|
-
|
96
|
-
<p>Make use of Gandi's V5 API.
|
97
|
-
See the table in the <a href="#Versioning">Versioning section</a> to see what Gandi
|
98
|
-
API Changes each version is current for.</p>
|
99
|
-
|
100
|
-
<p>Gandi say: <strong><em>"Please note that this API is currently in BETA testing, so care should be taken when used in production.</em>"</strong></p>
|
101
|
-
|
102
|
-
<p>But then you were going to be careful anyway as this gem is currently in the version 0.something range weren't you!</p>
|
103
|
-
|
104
|
-
<p>Details of the API can be found at:</p>
|
105
|
-
|
106
|
-
<ul>
|
107
|
-
<li><a href="https://api.gandi.net/docs/">https://api.gandi.net/docs/</a></li>
|
108
|
-
<li><a href="https://doc.livedns.gandi.net/">https://doc.livedns.gandi.net/</a></li>
|
109
|
-
</ul>
|
110
|
-
|
111
|
-
<h2>Installation</h2>
|
112
|
-
|
113
|
-
<p>If you're using bundler then add it to your Gemfile and run the bundle command.</p>
|
114
|
-
|
115
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>gandi_v5</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>~> 0.1</span><span class='tstring_end'>'</span></span>
|
116
|
-
</code></pre>
|
117
|
-
|
118
|
-
<p>If you're not using bundler then install it from the command line.</p>
|
119
|
-
|
120
|
-
<pre class="code bash"><code class="bash">gem install gandi_v5 -v '~> 0.1'
|
121
|
-
</code></pre>
|
122
|
-
|
123
|
-
<h2>Usage</h2>
|
124
|
-
|
125
|
-
<h3>Setup</h3>
|
126
|
-
|
127
|
-
<p>You'll need you Gandi API KEY, you can get this by logging into Gandi and
|
128
|
-
navigating to User Settings -> Change password & configure access restrictions.</p>
|
129
|
-
|
130
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>gandi_v5</span><span class='tstring_end'>'</span></span> <span class='comment'># Unless you're using Bundler
|
131
|
-
</span><span class='const'><span class='object_link'><a href="GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='period'>.</span><span class='id identifier rubyid_api_key'>api_key</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>…</span><span class='tstring_end'>'</span></span> <span class='comment'># Unless you've set it in the environment variable GANDI_API_KEY
|
132
|
-
</span></code></pre>
|
133
|
-
|
134
|
-
<h3>Examples</h3>
|
135
|
-
|
136
|
-
<h4>Domains</h4>
|
137
|
-
|
138
|
-
<pre class="code ruby"><code class="ruby"><span class='comment'># Get an array of all your domains.
|
139
|
-
</span><span class='id identifier rubyid_domains'>domains</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="GandiV5.html" title="GandiV5 (class)">GandiV5</a></span></span><span class='period'>.</span><span class='id identifier rubyid_domains'><span class='object_link'><a href="GandiV5.html#domains-class_method" title="GandiV5.domains (method)">domains</a></span></span>
|
140
|
-
|
141
|
-
<span class='comment'># Since each domain has only basic information, lets get all of the information.
|
142
|
-
</span><span class='id identifier rubyid_domains'>domains</span><span class='period'>.</span><span class='id identifier rubyid_map!'>map!</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:refresh</span><span class='rparen'>)</span>
|
143
|
-
</code></pre>
|
144
|
-
|
145
|
-
<p>TODO: More examples!</p>
|
146
|
-
|
147
|
-
<h2>Versioning</h2>
|
148
|
-
|
149
|
-
<p>We follow the <a href="http://semver.org/">Semantic Versioning</a> concept.</p>
|
150
|
-
|
151
|
-
<table><thead>
|
152
|
-
<tr>
|
153
|
-
<th>Gem Version</th>
|
154
|
-
<th>Gandi API Release Date</th>
|
155
|
-
</tr>
|
156
|
-
</thead><tbody>
|
157
|
-
<tr>
|
158
|
-
<td>0.1.0</td>
|
159
|
-
<td>2019-05-16</td>
|
160
|
-
</tr>
|
161
|
-
</tbody></table>
|
162
|
-
|
163
|
-
<p>See <a href="https://api.gandi.net/docs/reference#API-Changelog">https://api.gandi.net/docs/reference#API-Changelog</a> to find out what
|
164
|
-
Gandi changed on each date.</p>
|
165
|
-
</div></div>
|
166
|
-
|
167
|
-
<div id="footer">
|
168
|
-
Generated on Mon Jul 22 16:44:23 2019 by
|
169
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
170
|
-
0.9.19 (ruby-2.6.3).
|
171
|
-
</div>
|
172
|
-
|
173
|
-
</div>
|
174
|
-
</body>
|
175
|
-
</html>
|
data/doc/js/app.js
DELETED
@@ -1,303 +0,0 @@
|
|
1
|
-
(function() {
|
2
|
-
|
3
|
-
var localStorage = {}, sessionStorage = {};
|
4
|
-
try { localStorage = window.localStorage; } catch (e) { }
|
5
|
-
try { sessionStorage = window.sessionStorage; } catch (e) { }
|
6
|
-
|
7
|
-
function createSourceLinks() {
|
8
|
-
$('.method_details_list .source_code').
|
9
|
-
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
10
|
-
$('.toggleSource').toggle(function() {
|
11
|
-
$(this).parent().nextAll('.source_code').slideDown(100);
|
12
|
-
$(this).text("Hide source");
|
13
|
-
},
|
14
|
-
function() {
|
15
|
-
$(this).parent().nextAll('.source_code').slideUp(100);
|
16
|
-
$(this).text("View source");
|
17
|
-
});
|
18
|
-
}
|
19
|
-
|
20
|
-
function createDefineLinks() {
|
21
|
-
var tHeight = 0;
|
22
|
-
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
23
|
-
$('.toggleDefines').toggle(function() {
|
24
|
-
tHeight = $(this).parent().prev().height();
|
25
|
-
$(this).prev().css('display', 'inline');
|
26
|
-
$(this).parent().prev().height($(this).parent().height());
|
27
|
-
$(this).text("(less)");
|
28
|
-
},
|
29
|
-
function() {
|
30
|
-
$(this).prev().hide();
|
31
|
-
$(this).parent().prev().height(tHeight);
|
32
|
-
$(this).text("more...");
|
33
|
-
});
|
34
|
-
}
|
35
|
-
|
36
|
-
function createFullTreeLinks() {
|
37
|
-
var tHeight = 0;
|
38
|
-
$('.inheritanceTree').toggle(function() {
|
39
|
-
tHeight = $(this).parent().prev().height();
|
40
|
-
$(this).parent().toggleClass('showAll');
|
41
|
-
$(this).text("(hide)");
|
42
|
-
$(this).parent().prev().height($(this).parent().height());
|
43
|
-
},
|
44
|
-
function() {
|
45
|
-
$(this).parent().toggleClass('showAll');
|
46
|
-
$(this).parent().prev().height(tHeight);
|
47
|
-
$(this).text("show all");
|
48
|
-
});
|
49
|
-
}
|
50
|
-
|
51
|
-
function searchFrameButtons() {
|
52
|
-
$('.full_list_link').click(function() {
|
53
|
-
toggleSearchFrame(this, $(this).attr('href'));
|
54
|
-
return false;
|
55
|
-
});
|
56
|
-
window.addEventListener('message', function(e) {
|
57
|
-
if (e.data === 'navEscape') {
|
58
|
-
$('#nav').slideUp(100);
|
59
|
-
$('#search a').removeClass('active inactive');
|
60
|
-
$(window).focus();
|
61
|
-
}
|
62
|
-
});
|
63
|
-
|
64
|
-
$(window).resize(function() {
|
65
|
-
if ($('#search:visible').length === 0) {
|
66
|
-
$('#nav').removeAttr('style');
|
67
|
-
$('#search a').removeClass('active inactive');
|
68
|
-
$(window).focus();
|
69
|
-
}
|
70
|
-
});
|
71
|
-
}
|
72
|
-
|
73
|
-
function toggleSearchFrame(id, link) {
|
74
|
-
var frame = $('#nav');
|
75
|
-
$('#search a').removeClass('active').addClass('inactive');
|
76
|
-
if (frame.attr('src') === link && frame.css('display') !== "none") {
|
77
|
-
frame.slideUp(100);
|
78
|
-
$('#search a').removeClass('active inactive');
|
79
|
-
}
|
80
|
-
else {
|
81
|
-
$(id).addClass('active').removeClass('inactive');
|
82
|
-
if (frame.attr('src') !== link) frame.attr('src', link);
|
83
|
-
frame.slideDown(100);
|
84
|
-
}
|
85
|
-
}
|
86
|
-
|
87
|
-
function linkSummaries() {
|
88
|
-
$('.summary_signature').click(function() {
|
89
|
-
document.location = $(this).find('a').attr('href');
|
90
|
-
});
|
91
|
-
}
|
92
|
-
|
93
|
-
function summaryToggle() {
|
94
|
-
$('.summary_toggle').click(function(e) {
|
95
|
-
e.preventDefault();
|
96
|
-
localStorage.summaryCollapsed = $(this).text();
|
97
|
-
$('.summary_toggle').each(function() {
|
98
|
-
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
99
|
-
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
100
|
-
if (next.hasClass('compact')) {
|
101
|
-
next.toggle();
|
102
|
-
next.nextAll('ul.summary').first().toggle();
|
103
|
-
}
|
104
|
-
else if (next.hasClass('summary')) {
|
105
|
-
var list = $('<ul class="summary compact" />');
|
106
|
-
list.html(next.html());
|
107
|
-
list.find('.summary_desc, .note').remove();
|
108
|
-
list.find('a').each(function() {
|
109
|
-
$(this).html($(this).find('strong').html());
|
110
|
-
$(this).parent().html($(this)[0].outerHTML);
|
111
|
-
});
|
112
|
-
next.before(list);
|
113
|
-
next.toggle();
|
114
|
-
}
|
115
|
-
});
|
116
|
-
return false;
|
117
|
-
});
|
118
|
-
if (localStorage.summaryCollapsed == "collapse") {
|
119
|
-
$('.summary_toggle').first().click();
|
120
|
-
} else { localStorage.summaryCollapsed = "expand"; }
|
121
|
-
}
|
122
|
-
|
123
|
-
function constantSummaryToggle() {
|
124
|
-
$('.constants_summary_toggle').click(function(e) {
|
125
|
-
e.preventDefault();
|
126
|
-
localStorage.summaryCollapsed = $(this).text();
|
127
|
-
$('.constants_summary_toggle').each(function() {
|
128
|
-
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
129
|
-
var next = $(this).parent().parent().nextAll('dl.constants').first();
|
130
|
-
if (next.hasClass('compact')) {
|
131
|
-
next.toggle();
|
132
|
-
next.nextAll('dl.constants').first().toggle();
|
133
|
-
}
|
134
|
-
else if (next.hasClass('constants')) {
|
135
|
-
var list = $('<dl class="constants compact" />');
|
136
|
-
list.html(next.html());
|
137
|
-
list.find('dt').each(function() {
|
138
|
-
$(this).addClass('summary_signature');
|
139
|
-
$(this).text( $(this).text().split('=')[0]);
|
140
|
-
if ($(this).has(".deprecated").length) {
|
141
|
-
$(this).addClass('deprecated');
|
142
|
-
};
|
143
|
-
});
|
144
|
-
// Add the value of the constant as "Tooltip" to the summary object
|
145
|
-
list.find('pre.code').each(function() {
|
146
|
-
console.log($(this).parent());
|
147
|
-
var dt_element = $(this).parent().prev();
|
148
|
-
var tooltip = $(this).text();
|
149
|
-
if (dt_element.hasClass("deprecated")) {
|
150
|
-
tooltip = 'Deprecated. ' + tooltip;
|
151
|
-
};
|
152
|
-
dt_element.attr('title', tooltip);
|
153
|
-
});
|
154
|
-
list.find('.docstring, .tags, dd').remove();
|
155
|
-
next.before(list);
|
156
|
-
next.toggle();
|
157
|
-
}
|
158
|
-
});
|
159
|
-
return false;
|
160
|
-
});
|
161
|
-
if (localStorage.summaryCollapsed == "collapse") {
|
162
|
-
$('.constants_summary_toggle').first().click();
|
163
|
-
} else { localStorage.summaryCollapsed = "expand"; }
|
164
|
-
}
|
165
|
-
|
166
|
-
function generateTOC() {
|
167
|
-
if ($('#filecontents').length === 0) return;
|
168
|
-
var _toc = $('<ol class="top"></ol>');
|
169
|
-
var show = false;
|
170
|
-
var toc = _toc;
|
171
|
-
var counter = 0;
|
172
|
-
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
173
|
-
var i;
|
174
|
-
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
175
|
-
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
176
|
-
var lastTag = parseInt(tags[0][1], 10);
|
177
|
-
$(tags.join(', ')).each(function() {
|
178
|
-
if ($(this).parents('.method_details .docstring').length != 0) return;
|
179
|
-
if (this.id == "filecontents") return;
|
180
|
-
show = true;
|
181
|
-
var thisTag = parseInt(this.tagName[1], 10);
|
182
|
-
if (this.id.length === 0) {
|
183
|
-
var proposedId = $(this).attr('toc-id');
|
184
|
-
if (typeof(proposedId) != "undefined") this.id = proposedId;
|
185
|
-
else {
|
186
|
-
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
187
|
-
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
188
|
-
this.id = proposedId;
|
189
|
-
}
|
190
|
-
}
|
191
|
-
if (thisTag > lastTag) {
|
192
|
-
for (i = 0; i < thisTag - lastTag; i++) {
|
193
|
-
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
194
|
-
}
|
195
|
-
}
|
196
|
-
if (thisTag < lastTag) {
|
197
|
-
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
198
|
-
}
|
199
|
-
var title = $(this).attr('toc-title');
|
200
|
-
if (typeof(title) == "undefined") title = $(this).text();
|
201
|
-
toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
202
|
-
lastTag = thisTag;
|
203
|
-
});
|
204
|
-
if (!show) return;
|
205
|
-
html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
|
206
|
-
$('#content').prepend(html);
|
207
|
-
$('#toc').append(_toc);
|
208
|
-
$('#toc .hide_toc').toggle(function() {
|
209
|
-
$('#toc .top').slideUp('fast');
|
210
|
-
$('#toc').toggleClass('hidden');
|
211
|
-
$('#toc .title small').toggle();
|
212
|
-
}, function() {
|
213
|
-
$('#toc .top').slideDown('fast');
|
214
|
-
$('#toc').toggleClass('hidden');
|
215
|
-
$('#toc .title small').toggle();
|
216
|
-
});
|
217
|
-
}
|
218
|
-
|
219
|
-
function navResizeFn(e) {
|
220
|
-
if (e.which !== 1) {
|
221
|
-
navResizeFnStop();
|
222
|
-
return;
|
223
|
-
}
|
224
|
-
|
225
|
-
sessionStorage.navWidth = e.pageX.toString();
|
226
|
-
$('.nav_wrap').css('width', e.pageX);
|
227
|
-
$('.nav_wrap').css('-ms-flex', 'inherit');
|
228
|
-
}
|
229
|
-
|
230
|
-
function navResizeFnStop() {
|
231
|
-
$(window).unbind('mousemove', navResizeFn);
|
232
|
-
window.removeEventListener('message', navMessageFn, false);
|
233
|
-
}
|
234
|
-
|
235
|
-
function navMessageFn(e) {
|
236
|
-
if (e.data.action === 'mousemove') navResizeFn(e.data.event);
|
237
|
-
if (e.data.action === 'mouseup') navResizeFnStop();
|
238
|
-
}
|
239
|
-
|
240
|
-
function navResizer() {
|
241
|
-
$('#resizer').mousedown(function(e) {
|
242
|
-
e.preventDefault();
|
243
|
-
$(window).mousemove(navResizeFn);
|
244
|
-
window.addEventListener('message', navMessageFn, false);
|
245
|
-
});
|
246
|
-
$(window).mouseup(navResizeFnStop);
|
247
|
-
|
248
|
-
if (sessionStorage.navWidth) {
|
249
|
-
navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
|
250
|
-
}
|
251
|
-
}
|
252
|
-
|
253
|
-
function navExpander() {
|
254
|
-
var done = false, timer = setTimeout(postMessage, 500);
|
255
|
-
function postMessage() {
|
256
|
-
if (done) return;
|
257
|
-
clearTimeout(timer);
|
258
|
-
var opts = { action: 'expand', path: pathId };
|
259
|
-
document.getElementById('nav').contentWindow.postMessage(opts, '*');
|
260
|
-
done = true;
|
261
|
-
}
|
262
|
-
|
263
|
-
window.addEventListener('message', function(event) {
|
264
|
-
if (event.data === 'navReady') postMessage();
|
265
|
-
return false;
|
266
|
-
}, false);
|
267
|
-
}
|
268
|
-
|
269
|
-
function mainFocus() {
|
270
|
-
var hash = window.location.hash;
|
271
|
-
if (hash !== '' && $(hash)[0]) {
|
272
|
-
$(hash)[0].scrollIntoView();
|
273
|
-
}
|
274
|
-
|
275
|
-
setTimeout(function() { $('#main').focus(); }, 10);
|
276
|
-
}
|
277
|
-
|
278
|
-
function navigationChange() {
|
279
|
-
// This works around the broken anchor navigation with the YARD template.
|
280
|
-
window.onpopstate = function() {
|
281
|
-
var hash = window.location.hash;
|
282
|
-
if (hash !== '' && $(hash)[0]) {
|
283
|
-
$(hash)[0].scrollIntoView();
|
284
|
-
}
|
285
|
-
};
|
286
|
-
}
|
287
|
-
|
288
|
-
$(document).ready(function() {
|
289
|
-
navResizer();
|
290
|
-
navExpander();
|
291
|
-
createSourceLinks();
|
292
|
-
createDefineLinks();
|
293
|
-
createFullTreeLinks();
|
294
|
-
searchFrameButtons();
|
295
|
-
linkSummaries();
|
296
|
-
summaryToggle();
|
297
|
-
constantSummaryToggle();
|
298
|
-
generateTOC();
|
299
|
-
mainFocus();
|
300
|
-
navigationChange();
|
301
|
-
});
|
302
|
-
|
303
|
-
})();
|