google_storage 0.1.2 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README.textile +137 -49
- data/bin/deploy_gs_yml +35 -0
- data/google_storage.gemspec +2 -1
- data/lib/google_storage/bucket.rb +1 -1
- data/lib/google_storage/client.rb +3 -2
- data/lib/google_storage/request.rb +11 -3
- data/lib/google_storage/token.rb +11 -2
- data/lib/google_storage/version.rb +1 -1
- metadata +55 -55
- data/.gitignore +0 -10
- data/.yardopts +0 -1
- data/Gemfile +0 -4
- data/doc/GoogleStorage.html +0 -120
- data/doc/GoogleStorage/Client.html +0 -1514
- data/doc/GoogleStorage/InstallGenerator.html +0 -220
- data/doc/_index.html +0 -136
- data/doc/class_list.html +0 -47
- data/doc/css/common.css +0 -1
- data/doc/css/full_list.css +0 -53
- data/doc/css/style.css +0 -320
- data/doc/file.README.html +0 -211
- data/doc/file_list.html +0 -49
- data/doc/frames.html +0 -13
- data/doc/index.html +0 -211
- data/doc/js/app.js +0 -205
- data/doc/js/full_list.js +0 -150
- data/doc/js/jquery.js +0 -16
- data/doc/method_list.html +0 -158
- data/doc/top-level-namespace.html +0 -103
- data/examples/examples.rb +0 -57
data/doc/file_list.html
DELETED
@@ -1,49 +0,0 @@
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
-
<html>
|
4
|
-
<head>
|
5
|
-
<meta http-equiv="Content-Type" content="text/html; 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
|
-
<base id="base_target" target="_parent" />
|
19
|
-
</head>
|
20
|
-
<body>
|
21
|
-
<script type="text/javascript" charset="utf-8">
|
22
|
-
if (window.top.frames.main) {
|
23
|
-
document.getElementById('base_target').target = 'main';
|
24
|
-
document.body.className = 'frames';
|
25
|
-
}
|
26
|
-
</script>
|
27
|
-
<div id="content">
|
28
|
-
<h1 id="full_list_header">File List</h1>
|
29
|
-
<div id="nav">
|
30
|
-
|
31
|
-
<a target="_self" href="class_list.html">Classes</a>
|
32
|
-
|
33
|
-
<a target="_self" href="method_list.html">Methods</a>
|
34
|
-
|
35
|
-
<a target="_self" href="file_list.html">Files</a>
|
36
|
-
|
37
|
-
</div>
|
38
|
-
<div id="search">Search: <input type="text" /></div>
|
39
|
-
|
40
|
-
<ul id="full_list" class="files">
|
41
|
-
|
42
|
-
|
43
|
-
<li class="r1"><a href="index.html" title="README">README</a></li>
|
44
|
-
|
45
|
-
|
46
|
-
</ul>
|
47
|
-
</div>
|
48
|
-
</body>
|
49
|
-
</html>
|
data/doc/frames.html
DELETED
@@ -1,13 +0,0 @@
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
|
2
|
-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
|
3
|
-
|
4
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
5
|
-
<head>
|
6
|
-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
|
7
|
-
<title>Documentation by YARD 0.7.2</title>
|
8
|
-
</head>
|
9
|
-
<frameset cols="20%,*">
|
10
|
-
<frame name="list" src="class_list.html" />
|
11
|
-
<frame name="main" src="index.html" />
|
12
|
-
</frameset>
|
13
|
-
</html>
|
data/doc/index.html
DELETED
@@ -1,211 +0,0 @@
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
-
<head>
|
5
|
-
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
6
|
-
<title>
|
7
|
-
File: README
|
8
|
-
|
9
|
-
— Documentation by YARD 0.7.2
|
10
|
-
|
11
|
-
</title>
|
12
|
-
|
13
|
-
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
|
14
|
-
|
15
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
16
|
-
|
17
|
-
<script type="text/javascript" charset="utf-8">
|
18
|
-
relpath = '';
|
19
|
-
if (relpath != '') relpath += '/';
|
20
|
-
</script>
|
21
|
-
|
22
|
-
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
23
|
-
|
24
|
-
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
25
|
-
|
26
|
-
|
27
|
-
</head>
|
28
|
-
<body>
|
29
|
-
<script type="text/javascript" charset="utf-8">
|
30
|
-
if (window.top.frames.main) document.body.className = 'frames';
|
31
|
-
</script>
|
32
|
-
|
33
|
-
<div id="header">
|
34
|
-
<div id="menu">
|
35
|
-
|
36
|
-
<a href="_index.html" title="Index">Index</a> »
|
37
|
-
<span class="title">File: README</span>
|
38
|
-
|
39
|
-
|
40
|
-
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
41
|
-
</div>
|
42
|
-
|
43
|
-
<div id="search">
|
44
|
-
|
45
|
-
<a id="class_list_link" href="#">Class List</a>
|
46
|
-
|
47
|
-
<a id="method_list_link" href="#">Method List</a>
|
48
|
-
|
49
|
-
<a id="file_list_link" href="#">File List</a>
|
50
|
-
|
51
|
-
</div>
|
52
|
-
<div class="clear"></div>
|
53
|
-
</div>
|
54
|
-
|
55
|
-
<iframe id="search_frame"></iframe>
|
56
|
-
|
57
|
-
<div id="content"><div id='filecontents'><h1>Google Storage using <span class="caps">API</span> v2</h1>
|
58
|
-
<p>I wrote this gem because the only google storage gems I could find already written were either written a while ago and only set up to use the original
|
59
|
-
version of Google’s <span class="caps">API</span> or they were dependent on Gems that don’t run properly on… dare I say it… windows.. :) Apologies, I’m without choice
|
60
|
-
at the moment, but anyways, this gem should run fine on all platforms and I’ve tried to keep dependencies to a minimum. Let me know if you find
|
61
|
-
any bugs though ok and feel free to contribute.</p>
|
62
|
-
<h2>Response Object</h2>
|
63
|
-
<p>A lot of the responses from GS on the backend are a little bit inconsistent, sometimes returning response codes, sometimes returning heavily
|
64
|
-
nested xml data and sometimes just returning information in the response header. I’ve tried to parse all responses that are returned from GS into a fairly
|
65
|
-
consistent type of response Hash object. Usually this is in the form of something like this:</p>
|
66
|
-
<pre class="code">
|
67
|
-
#successful responses will always include a :success => true key/value pair
|
68
|
-
|
69
|
-
client.list_buckets
|
70
|
-
=> {:success=>true,
|
71
|
-
:buckets=>[ {"Name"=>"bucket_1_example", "CreationDate"=>"2011-06-07T07:11:18.480Z"},
|
72
|
-
{"Name"=>"bucket_2_example", "CreationDate"=>"2011-05-31T10:58:08.097Z"},
|
73
|
-
{"Name"=>"bucket_3_example", "CreationDate"=>"2011-06-06T22:47:10.728Z"}],
|
74
|
-
:raw=>{ THIS :raw FIELD WILL RETURN A HASH OF THE UNPARSED RESPONSE IN CASE YOU NEED IT }
|
75
|
-
}
|
76
|
-
|
77
|
-
#Unsuccessful responses will return an "Error" Hash
|
78
|
-
|
79
|
-
client.get_bucket("bucket_4_example")
|
80
|
-
=> {"Error"=>{
|
81
|
-
"Code"=>"NoSuchBucket",
|
82
|
-
"Message"=>"The specified bucket does not exist."
|
83
|
-
}}
|
84
|
-
</pre>
|
85
|
-
<h2>Setup Guide</h2>
|
86
|
-
<p>There’s a couple of steps to follow in order to setup this gem. The new Google Storage APIv2 uses OAuth 2.0 to authenticate requests, you can read up
|
87
|
-
more on the nitty gritty if you like here: <a href="http://code.google.com/apis/accounts/docs/OAuth2.html">Google’s OAuth2 Guide</a></p>
|
88
|
-
<p>I’ll try and add client side support also once this gem is up and running properly, but for the moment it’s only setup to support server side web
|
89
|
-
applications.</p>
|
90
|
-
<p>But it’s also possible to run this gem from the command line if you want.</p>
|
91
|
-
<h2>Install the google_storage Gem</h2>
|
92
|
-
<p>Include the google_storage gem in your Gemfile and install config files
|
93
|
-
<pre class="code"><span class='id gem'>gem</span> <span class='id “google_storage”'>“google_storage”</span>
|
94
|
-
<span class='id bundle'>bundle</span> <span class='id install'>install</span>
|
95
|
-
</pre>
|
96
|
-
Then in your Rails application directory run:
|
97
|
-
<pre class="code"><span class='id rails'>rails</span> <span class='id generate'>generate</span> <span class='label'>google_storage:</span><span class='id install'>install</span>
|
98
|
-
</pre>
|
99
|
-
This will generate some rake tasks a google_storage.yml file in your config directory.
|
100
|
-
<pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>Application</span><span class='regexp_end'>/config</span></span><span class='op'>/</span><span class='id google_storage'>google_storage</span><span class='period'>.</span><span class='id yml'>yml</span>
|
101
|
-
<span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>Application</span><span class='regexp_end'>/lib</span></span><span class='op'>/</span><span class='id tasks'>tasks</span><span class='op'>/</span><span class='id google_storage'>google_storage</span><span class='period'>.</span><span class='id task'>task</span>
|
102
|
-
</pre></p>
|
103
|
-
<h2>Setup your Google Project Client ID’s</h2>
|
104
|
-
<p>Visit <a href="http://code.google.com/apis/storage/">Google Storage</a> and select activate Google Storage.
|
105
|
-
If you haven’t already got a project set up, it’ll prompt you to create one.</p>
|
106
|
-
<p>When you have access to your Google APIs Console, you need to enable Google Storage. When you select enable, you’ll be shown terms and conditions
|
107
|
-
and you’ll then need to setup billing. They have full pricing details there for you to check out as well but I think it’s pretty reasonable..</p>
|
108
|
-
<p>Create a client ID for your project
|
109
|
-
On the left menu select “<span class="caps">API</span> Access” and then “Create an OAuth 2.0 client ID”
|
110
|
-
Enter your project’s name and brand information.</p>
|
111
|
-
<p>Select Application type = Web Application and enter your site’s information. If you’re using localhost and running
|
112
|
-
locally make sure you include the port number you’re using as well.</p>
|
113
|
-
<h2>Enter your Client ID details into your google_storage.yml</h2>
|
114
|
-
<p>This is the example google_storage.yml file that is copied into your config directory of your rails application.</p>
|
115
|
-
<p>Follow the steps to obtain a refresh token from google.</p>
|
116
|
-
<pre class="code">
|
117
|
-
#Replace the following example ids with your own
|
118
|
-
|
119
|
-
google_config:
|
120
|
-
x-goog-project-id: 825628431245
|
121
|
-
|
122
|
-
#Client ID for web applications
|
123
|
-
web_applications:
|
124
|
-
client_id: 825628431245.apps.googleusercontent.com
|
125
|
-
client_secret: lpNYX5SPFDB6N-40lyMIPlQn
|
126
|
-
redirect_uris: 'http://localhost:3000/example'
|
127
|
-
js_origins: 'http://localhost:3000'
|
128
|
-
|
129
|
-
#refresh_token: replace this line with a refresh token from google, read below on how to get one
|
130
|
-
|
131
|
-
#You need to acquire a refresh token from google so that the google_storage gem
|
132
|
-
#can acquire access tokens whenever it needs to make new requests
|
133
|
-
|
134
|
-
# 1. Make sure you've signed up for Google Storage and filled in the above client ID details
|
135
|
-
# for your web application first
|
136
|
-
#
|
137
|
-
# 2. Depending on how much access you want to grant to your application run
|
138
|
-
# ONE of the following from your applications root directory. If you intend to be able to create and
|
139
|
-
# destroy objects and buckets and also be able to set permissions then use full_control
|
140
|
-
#
|
141
|
-
# rake gs:grant:read_only
|
142
|
-
# rake gs:grant:read_write
|
143
|
-
# rake gs:grant:full_control
|
144
|
-
#
|
145
|
-
# 3. Step 2 will generate a URL for you. Copy and paste the URL into a browser and you should be prompted
|
146
|
-
# by google to authorize the request by logging into your browser using the google email account you setup
|
147
|
-
# your google storage account with
|
148
|
-
#
|
149
|
-
# 4. When you 'allow access' you'll be redirected back to the redirect URL you setup in your client ID
|
150
|
-
# Your redirect URL should now include an authorization code. It'll look something like this:
|
151
|
-
# http://localhost:3000/example?code=4/WvlklnjtybhRJpaKpmDYrzIhAzyx
|
152
|
-
#
|
153
|
-
# 5. Copy that code from your URL and run the following rake task from your application directory
|
154
|
-
#
|
155
|
-
# rake gs:refresh_token['paste_your_auth_code_here']
|
156
|
-
# Example: rake gs:refresh_token['4/WvlklnjtybhRJpaKpmDYrzIhAzyx']
|
157
|
-
#
|
158
|
-
# 6. If everything worked you should see something that looks like the following:
|
159
|
-
#
|
160
|
-
# refresh_token: 1/x4X-U57snRMkLIWWYHWLCXPbfcnyGsdfx04sWAiG_1k
|
161
|
-
#
|
162
|
-
# 7. Copy and paste the refresh_token into this file. Your application should now be able to make calls to your
|
163
|
-
# Google Storage API
|
164
|
-
</pre>
|
165
|
-
<p>Once you’ve acquired your refresh_token you can now make calls to the <span class="caps">API</span>.</p>
|
166
|
-
<h2>Examples</h2>
|
167
|
-
<h3>Configuration</h3>
|
168
|
-
<pre class="code"><span class='id require'>require</span> <span class='id “google_storage”'>“google_storage”</span></pre>
|
169
|
-
The following will look for google_storage.yml in your rails config directory
|
170
|
-
<pre class="code"><span class='id client'>client</span> <span class='op'>=</span> <span class='const'>GoogleStorage</span><span class='op'>::</span><span class='const'>Client</span><span class='period'>.</span><span class='id new'>new</span></pre>
|
171
|
-
Otherwise you can pass in the path to the google_storage.yml
|
172
|
-
<pre class="code">client = GoogleStorage::Client.new(:config_yml => ‘C:/github/highvoltage/config/google_storage.yml’)
|
173
|
-
</pre>
|
174
|
-
<h3>Service Requests</h3>
|
175
|
-
<span class="caps">GET</span> Service
|
176
|
-
<pre class="code"><span class='id client'>client</span><span class='period'>.</span><span class='id list_buckets'>list_buckets</span></pre>
|
177
|
-
<h3>Bucket Requests</h3>
|
178
|
-
<span class="caps">GET</span> Access Control List for Bucket
|
179
|
-
<pre class="code"><span class='id client'>client</span><span class='period'>.</span><span class='id bucket_acls'>bucket_acls</span><span class='lparen'>(</span><span class='id ‘bucket_name’'>‘bucket_name’</span><span class='rparen'>)</span></pre>
|
180
|
-
<span class="caps">PUT</span> Bucket
|
181
|
-
<pre class="code">client.create_bucket(‘bucket_name’) <— private bucket
|
182
|
-
client.create_bucket(‘bucket_name’, :x_goog_acl => ‘public-read’) <— public bucket </pre>
|
183
|
-
<span class="caps">GET</span> Bucket
|
184
|
-
<pre class="code"><span class='id client'>client</span><span class='period'>.</span><span class='id get_bucket'>get_bucket</span><span class='lparen'>(</span><span class='id ‘bucket_name’'>‘bucket_name’</span><span class='rparen'>)</span></pre>
|
185
|
-
<span class="caps">DELETE</span> Bucket
|
186
|
-
<pre class="code"><span class='id client'>client</span><span class='period'>.</span><span class='id delete_bucket'>delete_bucket</span><span class='lparen'>(</span><span class='id ‘bucket_name’'>‘bucket_name’</span><span class='rparen'>)</span></pre>
|
187
|
-
<h3>Object Requests</h3>
|
188
|
-
<span class="caps">GET</span> Access Control List for Object
|
189
|
-
<pre class="code"><span class='id client'>client</span><span class='period'>.</span><span class='id object_acls'>object_acls</span><span class='lparen'>(</span><span class='id ‘bucket_name’'>‘bucket_name’</span><span class='comma'>,</span> <span class='id ‘filename'>‘filename</span><span class='period'>.</span><span class='id jpg’'>jpg’</span><span class='rparen'>)</span></pre>
|
190
|
-
<span class="caps">GET</span> Object
|
191
|
-
<pre class="code">client.get_object(‘bucket_name’, ‘filename.jpg’)
|
192
|
-
client.get_object(‘bucket_name’, ‘filename.jpg’, :write_to_file => ‘c:/temp/new_file_name.jpg’)</pre>
|
193
|
-
<span class="caps">POST</span> Object
|
194
|
-
<pre class="code">Sorry, not including a ‘post’ object method as it still requires use of the old legacy access,
|
195
|
-
Please use the ‘put’ object method below instead to upload files to a bucket.</pre>
|
196
|
-
<span class="caps">PUT</span> Object
|
197
|
-
<pre class="code">client.put_object(‘bucket_name’, ‘filename.jpg’, :data => File.read(‘c:/temp/file.jpg’), :x_goog_acl => ‘public-read’)
|
198
|
-
client.upload_object(‘bucket_name’, ‘filename.jpg’, :path_to_file => ‘c:/temp/file.jpg’)</pre>
|
199
|
-
<span class="caps">HEAD</span> Object
|
200
|
-
<pre class="code"><span class='id client'>client</span><span class='period'>.</span><span class='id object_head'>object_head</span><span class='lparen'>(</span><span class='id ‘bucket_name’'>‘bucket_name’</span><span class='comma'>,</span> <span class='id ‘filename'>‘filename</span><span class='period'>.</span><span class='id jpg’'>jpg’</span><span class='rparen'>)</span></pre>
|
201
|
-
<span class="caps">DELETE</span> Object
|
202
|
-
<pre class="code"><span class='id client'>client</span><span class='period'>.</span><span class='id delete_object'>delete_object</span><span class='lparen'>(</span><span class='id ‘bucket_name’'>‘bucket_name’</span><span class='comma'>,</span> <span class='id ‘filename'>‘filename</span><span class='period'>.</span><span class='id jpg’'>jpg’</span><span class='rparen'>)</span></pre></div></div>
|
203
|
-
|
204
|
-
<div id="footer">
|
205
|
-
Generated on Fri Jul 1 12:07:25 2011 by
|
206
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
207
|
-
0.7.2 (ruby-1.9.2).
|
208
|
-
</div>
|
209
|
-
|
210
|
-
</body>
|
211
|
-
</html>
|
data/doc/js/app.js
DELETED
@@ -1,205 +0,0 @@
|
|
1
|
-
function createSourceLinks() {
|
2
|
-
$('.method_details_list .source_code').
|
3
|
-
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
4
|
-
$('.toggleSource').toggle(function() {
|
5
|
-
$(this).parent().next().slideDown(100);
|
6
|
-
$(this).text("Hide source");
|
7
|
-
},
|
8
|
-
function() {
|
9
|
-
$(this).parent().next().slideUp(100);
|
10
|
-
$(this).text("View source");
|
11
|
-
});
|
12
|
-
}
|
13
|
-
|
14
|
-
function createDefineLinks() {
|
15
|
-
var tHeight = 0;
|
16
|
-
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
17
|
-
$('.toggleDefines').toggle(function() {
|
18
|
-
tHeight = $(this).parent().prev().height();
|
19
|
-
$(this).prev().show();
|
20
|
-
$(this).parent().prev().height($(this).parent().height());
|
21
|
-
$(this).text("(less)");
|
22
|
-
},
|
23
|
-
function() {
|
24
|
-
$(this).prev().hide();
|
25
|
-
$(this).parent().prev().height(tHeight);
|
26
|
-
$(this).text("more...");
|
27
|
-
});
|
28
|
-
}
|
29
|
-
|
30
|
-
function createFullTreeLinks() {
|
31
|
-
var tHeight = 0;
|
32
|
-
$('.inheritanceTree').toggle(function() {
|
33
|
-
tHeight = $(this).parent().prev().height();
|
34
|
-
$(this).parent().toggleClass('showAll');
|
35
|
-
$(this).text("(hide)");
|
36
|
-
$(this).parent().prev().height($(this).parent().height());
|
37
|
-
},
|
38
|
-
function() {
|
39
|
-
$(this).parent().toggleClass('showAll');
|
40
|
-
$(this).parent().prev().height(tHeight);
|
41
|
-
$(this).text("show all");
|
42
|
-
});
|
43
|
-
}
|
44
|
-
|
45
|
-
function fixBoxInfoHeights() {
|
46
|
-
$('dl.box dd.r1, dl.box dd.r2').each(function() {
|
47
|
-
$(this).prev().height($(this).height());
|
48
|
-
});
|
49
|
-
}
|
50
|
-
|
51
|
-
function searchFrameLinks() {
|
52
|
-
$('#method_list_link').click(function() {
|
53
|
-
toggleSearchFrame(this, relpath + 'method_list.html');
|
54
|
-
});
|
55
|
-
|
56
|
-
$('#class_list_link').click(function() {
|
57
|
-
toggleSearchFrame(this, relpath + 'class_list.html');
|
58
|
-
});
|
59
|
-
|
60
|
-
$('#file_list_link').click(function() {
|
61
|
-
toggleSearchFrame(this, relpath + 'file_list.html');
|
62
|
-
});
|
63
|
-
}
|
64
|
-
|
65
|
-
function toggleSearchFrame(id, link) {
|
66
|
-
var frame = $('#search_frame');
|
67
|
-
$('#search a').removeClass('active').addClass('inactive');
|
68
|
-
if (frame.attr('src') == link && frame.css('display') != "none") {
|
69
|
-
frame.slideUp(100);
|
70
|
-
$('#search a').removeClass('active inactive');
|
71
|
-
}
|
72
|
-
else {
|
73
|
-
$(id).addClass('active').removeClass('inactive');
|
74
|
-
frame.attr('src', link).slideDown(100);
|
75
|
-
}
|
76
|
-
}
|
77
|
-
|
78
|
-
function linkSummaries() {
|
79
|
-
$('.summary_signature').click(function() {
|
80
|
-
document.location = $(this).find('a').attr('href');
|
81
|
-
});
|
82
|
-
}
|
83
|
-
|
84
|
-
function framesInit() {
|
85
|
-
if (window.top.frames.main) {
|
86
|
-
document.body.className = 'frames';
|
87
|
-
$('#menu .noframes a').attr('href', document.location);
|
88
|
-
$('html head title', window.parent.document).text($('html head title').text());
|
89
|
-
}
|
90
|
-
}
|
91
|
-
|
92
|
-
function keyboardShortcuts() {
|
93
|
-
if (window.top.frames.main) return;
|
94
|
-
$(document).keypress(function(evt) {
|
95
|
-
if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
|
96
|
-
if (typeof evt.target !== "undefined" &&
|
97
|
-
(evt.target.nodeName == "INPUT" ||
|
98
|
-
evt.target.nodeName == "TEXTAREA")) return;
|
99
|
-
switch (evt.charCode) {
|
100
|
-
case 67: case 99: $('#class_list_link').click(); break; // 'c'
|
101
|
-
case 77: case 109: $('#method_list_link').click(); break; // 'm'
|
102
|
-
case 70: case 102: $('#file_list_link').click(); break; // 'f'
|
103
|
-
default: break;
|
104
|
-
}
|
105
|
-
});
|
106
|
-
}
|
107
|
-
|
108
|
-
function summaryToggle() {
|
109
|
-
$('.summary_toggle').click(function() {
|
110
|
-
localStorage.summaryCollapsed = $(this).text();
|
111
|
-
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
112
|
-
var next = $(this).parent().parent().next();
|
113
|
-
if (next.hasClass('compact')) {
|
114
|
-
next.toggle();
|
115
|
-
next.next().toggle();
|
116
|
-
}
|
117
|
-
else if (next.hasClass('summary')) {
|
118
|
-
var list = $('<ul class="summary compact" />');
|
119
|
-
list.html(next.html());
|
120
|
-
list.find('.summary_desc, .note').remove();
|
121
|
-
list.find('a').each(function() {
|
122
|
-
$(this).html($(this).find('strong').html());
|
123
|
-
$(this).parent().html($(this)[0].outerHTML);
|
124
|
-
});
|
125
|
-
next.before(list);
|
126
|
-
next.toggle();
|
127
|
-
}
|
128
|
-
return false;
|
129
|
-
});
|
130
|
-
if (localStorage) {
|
131
|
-
if (localStorage.summaryCollapsed == "collapse") $('.summary_toggle').click();
|
132
|
-
else localStorage.summaryCollapsed = "expand";
|
133
|
-
}
|
134
|
-
}
|
135
|
-
|
136
|
-
function fixOutsideWorldLinks() {
|
137
|
-
$('a').each(function() {
|
138
|
-
if (window.location.host != this.host) this.target = '_parent';
|
139
|
-
});
|
140
|
-
}
|
141
|
-
|
142
|
-
function generateTOC() {
|
143
|
-
if ($('#filecontents').length === 0) return;
|
144
|
-
var _toc = $('<ol class="top"></ol>');
|
145
|
-
var show = false;
|
146
|
-
var toc = _toc;
|
147
|
-
var counter = 0;
|
148
|
-
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
149
|
-
var i;
|
150
|
-
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
151
|
-
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
152
|
-
var lastTag = parseInt(tags[0][1], 10);
|
153
|
-
$(tags.join(', ')).each(function() {
|
154
|
-
if (this.id == "filecontents") return;
|
155
|
-
show = true;
|
156
|
-
var thisTag = parseInt(this.tagName[1], 10);
|
157
|
-
if (this.id.length === 0) {
|
158
|
-
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
159
|
-
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
160
|
-
this.id = proposedId;
|
161
|
-
}
|
162
|
-
if (thisTag > lastTag) {
|
163
|
-
for (i = 0; i < thisTag - lastTag; i++) {
|
164
|
-
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
165
|
-
}
|
166
|
-
}
|
167
|
-
if (thisTag < lastTag) {
|
168
|
-
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
169
|
-
}
|
170
|
-
toc.append('<li><a href="#' + this.id + '">' + $(this).text() + '</a></li>');
|
171
|
-
lastTag = thisTag;
|
172
|
-
});
|
173
|
-
if (!show) return;
|
174
|
-
html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
|
175
|
-
$('#content').prepend(html);
|
176
|
-
$('#toc').append(_toc);
|
177
|
-
$('#toc .hide_toc').toggle(function() {
|
178
|
-
$('#toc .top').slideUp('fast');
|
179
|
-
$('#toc').toggleClass('hidden');
|
180
|
-
$('#toc .title small').toggle();
|
181
|
-
}, function() {
|
182
|
-
$('#toc .top').slideDown('fast');
|
183
|
-
$('#toc').toggleClass('hidden');
|
184
|
-
$('#toc .title small').toggle();
|
185
|
-
});
|
186
|
-
$('#toc .float_toc').toggle(function() {
|
187
|
-
$(this).text('float');
|
188
|
-
$('#toc').toggleClass('nofloat');
|
189
|
-
}, function() {
|
190
|
-
$(this).text('left');
|
191
|
-
$('#toc').toggleClass('nofloat');
|
192
|
-
});
|
193
|
-
}
|
194
|
-
|
195
|
-
$(framesInit);
|
196
|
-
$(createSourceLinks);
|
197
|
-
$(createDefineLinks);
|
198
|
-
$(createFullTreeLinks);
|
199
|
-
$(fixBoxInfoHeights);
|
200
|
-
$(searchFrameLinks);
|
201
|
-
$(linkSummaries);
|
202
|
-
$(keyboardShortcuts);
|
203
|
-
$(summaryToggle);
|
204
|
-
$(fixOutsideWorldLinks);
|
205
|
-
$(generateTOC);
|