mushikago-sdk 0.1.6 → 0.1.7
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 +125 -0
- data/autotest/discover.rb +7 -0
- data/doc/Mushikago.html +243 -0
- data/doc/Mushikago/Auth.html +120 -0
- data/doc/Mushikago/Auth/Signature.html +305 -0
- data/doc/Mushikago/Auth/Signer.html +452 -0
- data/doc/Mushikago/Config.html +272 -0
- data/doc/Mushikago/Http.html +118 -0
- data/doc/Mushikago/Http/Client.html +551 -0
- data/doc/Mushikago/Http/Request.html +1264 -0
- data/doc/Mushikago/Http/Response.html +706 -0
- data/doc/Mushikago/Tombo.html +118 -0
- data/doc/Mushikago/Tombo/CaptureRequest.html +446 -0
- data/doc/Mushikago/Tombo/CapturesRequest.html +389 -0
- data/doc/Mushikago/Tombo/Client.html +770 -0
- data/doc/Mushikago/Tombo/DeleteRequest.html +391 -0
- data/doc/Mushikago/Tombo/InfoRequest.html +325 -0
- data/doc/Mushikago/Tombo/Request.html +287 -0
- data/doc/_index.html +278 -0
- data/doc/class_list.html +47 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +53 -0
- data/doc/css/style.css +320 -0
- data/doc/file.README.html +201 -0
- data/doc/file_list.html +49 -0
- data/doc/frames.html +13 -0
- data/doc/index.html +201 -0
- data/doc/js/app.js +205 -0
- data/doc/js/full_list.js +150 -0
- data/doc/js/jquery.js +16 -0
- data/doc/method_list.html +398 -0
- data/doc/top-level-namespace.html +103 -0
- data/lib/mushikago/tombo/capture_request.rb +1 -1
- data/lib/mushikago/tombo/client.rb +1 -1
- data/lib/mushikago/version.rb +1 -1
- data/spec/mushikago/tombo/capture_request_spec.rb +3 -3
- metadata +34 -3
data/doc/class_list.html
ADDED
@@ -0,0 +1,47 @@
|
|
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">Class 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="class">
|
41
|
+
<li><span class='object_link'><a href="top-level-namespace.html" title=" (root)">Top Level Namespace</a></span></li>
|
42
|
+
<li><a class='toggle'></a> <span class='object_link'><a href="Mushikago.html" title="Mushikago (module)">Mushikago</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><a class='toggle'></a> <span class='object_link'><a href="Mushikago/Auth.html" title="Mushikago::Auth (module)">Auth</a></span><small class='search_info'>Mushikago</small></li><ul><li><span class='object_link'><a href="Mushikago/Auth/Signature.html" title="Mushikago::Auth::Signature (module)">Signature</a></span><small class='search_info'>Mushikago::Auth</small></li><li><span class='object_link'><a href="Mushikago/Auth/Signer.html" title="Mushikago::Auth::Signer (class)">Signer</a></span> < Object<small class='search_info'>Mushikago::Auth</small></li></ul><li><span class='object_link'><a href="Mushikago/Config.html" title="Mushikago::Config (class)">Config</a></span> < Object<small class='search_info'>Mushikago</small></li><li><a class='toggle'></a> <span class='object_link'><a href="Mushikago/Http.html" title="Mushikago::Http (module)">Http</a></span><small class='search_info'>Mushikago</small></li><ul><li><span class='object_link'><a href="Mushikago/Http/Client.html" title="Mushikago::Http::Client (class)">Client</a></span> < Object<small class='search_info'>Mushikago::Http</small></li><li><span class='object_link'><a href="Mushikago/Http/Request.html" title="Mushikago::Http::Request (class)">Request</a></span> < Object<small class='search_info'>Mushikago::Http</small></li><li><span class='object_link'><a href="Mushikago/Http/Response.html" title="Mushikago::Http::Response (class)">Response</a></span> < Object<small class='search_info'>Mushikago::Http</small></li></ul><li><a class='toggle'></a> <span class='object_link'><a href="Mushikago/Tombo.html" title="Mushikago::Tombo (module)">Tombo</a></span><small class='search_info'>Mushikago</small></li><ul><li><span class='object_link'><a href="Mushikago/Tombo/CaptureRequest.html" title="Mushikago::Tombo::CaptureRequest (class)">CaptureRequest</a></span> < Request<small class='search_info'>Mushikago::Tombo</small></li><li><span class='object_link'><a href="Mushikago/Tombo/CapturesRequest.html" title="Mushikago::Tombo::CapturesRequest (class)">CapturesRequest</a></span> < Request<small class='search_info'>Mushikago::Tombo</small></li><li><span class='object_link'><a href="Mushikago/Tombo/Client.html" title="Mushikago::Tombo::Client (class)">Client</a></span> < Client<small class='search_info'>Mushikago::Tombo</small></li><li><span class='object_link'><a href="Mushikago/Tombo/DeleteRequest.html" title="Mushikago::Tombo::DeleteRequest (class)">DeleteRequest</a></span> < Request<small class='search_info'>Mushikago::Tombo</small></li><li><span class='object_link'><a href="Mushikago/Tombo/InfoRequest.html" title="Mushikago::Tombo::InfoRequest (class)">InfoRequest</a></span> < Request<small class='search_info'>Mushikago::Tombo</small></li><li><span class='object_link'><a href="Mushikago/Tombo/Request.html" title="Mushikago::Tombo::Request (class)">Request</a></span> < Request<small class='search_info'>Mushikago::Tombo</small></li></ul></ul>
|
43
|
+
|
44
|
+
</ul>
|
45
|
+
</div>
|
46
|
+
</body>
|
47
|
+
</html>
|
data/doc/css/common.css
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
/* Override this file with custom rules */
|
@@ -0,0 +1,53 @@
|
|
1
|
+
body {
|
2
|
+
margin: 0;
|
3
|
+
font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
|
4
|
+
font-size: 13px;
|
5
|
+
height: 101%;
|
6
|
+
overflow-x: hidden;
|
7
|
+
}
|
8
|
+
|
9
|
+
h1 { padding: 12px 10px; padding-bottom: 0; margin: 0; font-size: 1.4em; }
|
10
|
+
.clear { clear: both; }
|
11
|
+
#search { position: absolute; right: 5px; top: 9px; padding-left: 24px; }
|
12
|
+
#content.insearch #search, #content.insearch #noresults { background: url(data:image/gif;base64,R0lGODlhEAAQAPYAAP///wAAAPr6+pKSkoiIiO7u7sjIyNjY2J6engAAAI6OjsbGxjIyMlJSUuzs7KamppSUlPLy8oKCghwcHLKysqSkpJqamvT09Pj4+KioqM7OzkRERAwMDGBgYN7e3ujo6Ly8vCoqKjY2NkZGRtTU1MTExDw8PE5OTj4+PkhISNDQ0MrKylpaWrS0tOrq6nBwcKysrLi4uLq6ul5eXlxcXGJiYoaGhuDg4H5+fvz8/KKiohgYGCwsLFZWVgQEBFBQUMzMzDg4OFhYWBoaGvDw8NbW1pycnOLi4ubm5kBAQKqqqiQkJCAgIK6urnJyckpKSjQ0NGpqatLS0sDAwCYmJnx8fEJCQlRUVAoKCggICLCwsOTk5ExMTPb29ra2tmZmZmhoaNzc3KCgoBISEiIiIgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQJCAAAACwAAAAAEAAQAAAHaIAAgoMgIiYlg4kACxIaACEJCSiKggYMCRselwkpghGJBJEcFgsjJyoAGBmfggcNEx0flBiKDhQFlIoCCA+5lAORFb4AJIihCRbDxQAFChAXw9HSqb60iREZ1omqrIPdJCTe0SWI09GBACH5BAkIAAAALAAAAAAQABAAAAdrgACCgwc0NTeDiYozCQkvOTo9GTmDKy8aFy+NOBA7CTswgywJDTIuEjYFIY0JNYMtKTEFiRU8Pjwygy4ws4owPyCKwsMAJSTEgiQlgsbIAMrO0dKDGMTViREZ14kYGRGK38nHguHEJcvTyIEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDAggPg4iJAAMJCRUAJRIqiRGCBI0WQEEJJkWDERkYAAUKEBc4Po1GiKKJHkJDNEeKig4URLS0ICImJZAkuQAhjSi/wQyNKcGDCyMnk8u5rYrTgqDVghgZlYjcACTA1sslvtHRgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCQARAtOUoQRGRiFD0kJUYWZhUhKT1OLhR8wBaaFBzQ1NwAlkIszCQkvsbOHL7Y4q4IuEjaqq0ZQD5+GEEsJTDCMmIUhtgk1lo6QFUwJVDKLiYJNUd6/hoEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4uen4ICCA+IkIsDCQkVACWmhwSpFqAABQoQF6ALTkWFnYMrVlhWvIKTlSAiJiVVPqlGhJkhqShHV1lCW4cMqSkAR1ofiwsjJyqGgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCSMhREZGIYYGY2ElYebi56fhyWQniSKAKKfpaCLFlAPhl0gXYNGEwkhGYREUywag1wJwSkHNDU3D0kJYIMZQwk8MjPBLx9eXwuETVEyAC/BOKsuEjYFhoEAIfkECQgAAAAsAAAAABAAEAAAB2eAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4ueICImip6CIQkJKJ4kigynKaqKCyMnKqSEK05StgAGQRxPYZaENqccFgIID4KXmQBhXFkzDgOnFYLNgltaSAAEpxa7BQoQF4aBACH5BAkIAAAALAAAAAAQABAAAAdogACCg4SFggJiPUqCJSWGgkZjCUwZACQkgxGEXAmdT4UYGZqCGWQ+IjKGGIUwPzGPhAc0NTewhDOdL7Ykji+dOLuOLhI2BbaFETICx4MlQitdqoUsCQ2vhKGjglNfU0SWmILaj43M5oEAOwAAAAAAAAAAAA==) no-repeat center left; }
|
13
|
+
#full_list { padding: 0; list-style: none; margin-left: 0; }
|
14
|
+
#full_list ul { padding: 0; }
|
15
|
+
#full_list li { padding: 5px; padding-left: 12px; margin: 0; font-size: 1.1em; list-style: none; }
|
16
|
+
#noresults { padding: 7px 12px; }
|
17
|
+
#content.insearch #noresults { margin-left: 7px; }
|
18
|
+
ul.collapsed ul, ul.collapsed li { display: none; }
|
19
|
+
li a.toggle { cursor: default; position: relative; left: -5px; top: 4px; text-indent: -999px; width: 10px; height: 9px; margin-left: -10px; display: block; float: left; background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAASCAYAAABb0P4QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAK8AAACvABQqw0mAAAABx0RVh0U29mdHdhcmUAQWRvYmUgRmlyZXdvcmtzIENTM5jWRgMAAAAVdEVYdENyZWF0aW9uIFRpbWUAMy8xNC8wOeNZPpQAAAE2SURBVDiNrZTBccIwEEXfelIAHUA6CZ24BGaWO+FuzZAK4k6gg5QAdGAq+Bxs2Yqx7BzyL7Llp/VfzZeQhCTc/ezuGzKKnKSzpCxXJM8fwNXda3df5RZETlIt6YUzSQDs93sl8w3wBZxCCE10GM1OcWbWjB2mWgEH4Mfdyxm3PSepBHibgQE2wLe7r4HjEidpnXMYdQPKEMJcsZ4zs2POYQOcaPfwMVOo58zsAdMt18BuoVDPxUJRacELbXv3hUIX2vYmOUvi8C8ydz/ThjXrqKqqLbDIAdsCKBd+Wo7GWa7o9qzOQHVVVXeAbs+yHHCH4aTsaCOQqunmUy1yBUAXkdMIfMlgF5EXLo2OpV/c/Up7jG4hhHcYLgWzAZXUc2b2ixsfvc/RmNNfOXD3Q/oeL9axJE1yT9IOoUu6MGUkAAAAAElFTkSuQmCC) no-repeat bottom left; }
|
20
|
+
li.collapsed a.toggle { opacity: 0.5; cursor: default; background-position: top left; }
|
21
|
+
li { color: #888; cursor: pointer; }
|
22
|
+
li.deprecated { text-decoration: line-through; font-style: italic; }
|
23
|
+
li.r1 { background: #f0f0f0; }
|
24
|
+
li.r2 { background: #fafafa; }
|
25
|
+
li:hover { background: #ddd; }
|
26
|
+
li small:before { content: "("; }
|
27
|
+
li small:after { content: ")"; }
|
28
|
+
li small.search_info { display: none; }
|
29
|
+
a:link, a:visited { text-decoration: none; color: #05a; }
|
30
|
+
li.clicked { background: #05a; color: #ccc; }
|
31
|
+
li.clicked a:link, li.clicked a:visited { color: #eee; }
|
32
|
+
li.clicked a.toggle { opacity: 0.5; background-position: bottom right; }
|
33
|
+
li.collapsed.clicked a.toggle { background-position: top right; }
|
34
|
+
#search input { border: 1px solid #bbb; -moz-border-radius: 3px; -webkit-border-radius: 3px; }
|
35
|
+
#nav { margin-left: 10px; font-size: 0.9em; display: none; color: #aaa; }
|
36
|
+
#nav a:link, #nav a:visited { color: #358; }
|
37
|
+
#nav a:hover { background: transparent; color: #5af; }
|
38
|
+
|
39
|
+
.frames #content h1 { margin-top: 0; }
|
40
|
+
.frames li { white-space: nowrap; cursor: normal; }
|
41
|
+
.frames li small { display: block; font-size: 0.8em; }
|
42
|
+
.frames li small:before { content: ""; }
|
43
|
+
.frames li small:after { content: ""; }
|
44
|
+
.frames li small.search_info { display: none; }
|
45
|
+
.frames #search { width: 170px; position: static; margin: 3px; margin-left: 10px; font-size: 0.9em; color: #888; padding-left: 0; padding-right: 24px; }
|
46
|
+
.frames #content.insearch #search { background-position: center right; }
|
47
|
+
.frames #search input { width: 110px; }
|
48
|
+
.frames #nav { display: block; }
|
49
|
+
|
50
|
+
#full_list.insearch li { display: none; }
|
51
|
+
#full_list.insearch li.found { display: list-item; padding-left: 10px; }
|
52
|
+
#full_list.insearch li a.toggle { display: none; }
|
53
|
+
#full_list.insearch li small.search_info { display: block; }
|
data/doc/css/style.css
ADDED
@@ -0,0 +1,320 @@
|
|
1
|
+
body {
|
2
|
+
padding: 0 20px;
|
3
|
+
font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
|
4
|
+
font-size: 13px;
|
5
|
+
}
|
6
|
+
body.frames { padding: 0 5px; }
|
7
|
+
h1 { font-size: 25px; margin: 1em 0 0.5em; padding-top: 4px; border-top: 1px dotted #d5d5d5; }
|
8
|
+
h1.noborder { border-top: 0px; margin-top: 0; padding-top: 4px; }
|
9
|
+
h1.title { margin-bottom: 10px; }
|
10
|
+
h1.alphaindex { margin-top: 0; font-size: 22px; }
|
11
|
+
h2 {
|
12
|
+
padding: 0;
|
13
|
+
padding-bottom: 3px;
|
14
|
+
border-bottom: 1px #aaa solid;
|
15
|
+
font-size: 1.4em;
|
16
|
+
margin: 1.8em 0 0.5em;
|
17
|
+
}
|
18
|
+
h2 small { font-weight: normal; font-size: 0.7em; display: block; float: right; }
|
19
|
+
.clear { clear: both; }
|
20
|
+
.inline { display: inline; }
|
21
|
+
.inline p:first-child { display: inline; }
|
22
|
+
.docstring h1, .docstring h2, .docstring h3, .docstring h4 { padding: 0; border: 0; border-bottom: 1px dotted #bbb; }
|
23
|
+
.docstring h1 { font-size: 1.2em; }
|
24
|
+
.docstring h2 { font-size: 1.1em; }
|
25
|
+
.docstring h3, .docstring h4 { font-size: 1em; border-bottom: 0; padding-top: 10px; }
|
26
|
+
.summary_desc .object_link, .docstring .object_link { font-family: monospace; }
|
27
|
+
|
28
|
+
/* style for <ul> */
|
29
|
+
#filecontents li > p, .docstring li > p { margin: 0px; }
|
30
|
+
#filecontents ul, .docstring ul { padding-left: 20px; }
|
31
|
+
/* style for <dl> */
|
32
|
+
#filecontents dl, .docstring dl { border: 1px solid #ccc; }
|
33
|
+
#filecontents dt, .docstring dt { background: #ddd; font-weight: bold; padding: 3px 5px; }
|
34
|
+
#filecontents dd, .docstring dd { padding: 5px 0px; margin-left: 18px; }
|
35
|
+
#filecontents dd > p, .docstring dd > p { margin: 0px; }
|
36
|
+
|
37
|
+
.note {
|
38
|
+
color: #222;
|
39
|
+
-moz-border-radius: 3px; -webkit-border-radius: 3px;
|
40
|
+
background: #e3e4e3; border: 1px solid #d5d5d5; padding: 7px 10px;
|
41
|
+
display: block;
|
42
|
+
}
|
43
|
+
.note.todo { background: #ffffc5; border-color: #ececaa; }
|
44
|
+
.note.returns_void { background: #efefef; }
|
45
|
+
.note.deprecated { background: #ffe5e5; border-color: #e9dada; }
|
46
|
+
.note.private { background: #ffffc5; border-color: #ececaa; }
|
47
|
+
.note.title { text-transform: lowercase; padding: 1px 5px; font-size: 0.9em; font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; display: inline; }
|
48
|
+
.summary_signature + .note.title { margin-left: 7px; }
|
49
|
+
h1 .note.title { font-size: 0.5em; font-weight: normal; padding: 3px 5px; position: relative; top: -3px; text-transform: capitalize; }
|
50
|
+
.note.title.constructor { color: #fff; background: #6a98d6; border-color: #6689d6; }
|
51
|
+
.note.title.writeonly { color: #fff; background: #45a638; border-color: #2da31d; }
|
52
|
+
.note.title.readonly { color: #fff; background: #6a98d6; border-color: #6689d6; }
|
53
|
+
.note.title.private { background: #d5d5d5; border-color: #c5c5c5; }
|
54
|
+
.discussion .note { margin-top: 6px; }
|
55
|
+
.discussion .note:first-child { margin-top: 0; }
|
56
|
+
|
57
|
+
h3.inherited {
|
58
|
+
font-style: italic;
|
59
|
+
font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
|
60
|
+
font-weight: normal;
|
61
|
+
padding: 0;
|
62
|
+
margin: 0;
|
63
|
+
margin-top: 12px;
|
64
|
+
margin-bottom: 3px;
|
65
|
+
font-size: 13px;
|
66
|
+
}
|
67
|
+
p.inherited {
|
68
|
+
padding: 0;
|
69
|
+
margin: 0;
|
70
|
+
margin-left: 25px;
|
71
|
+
}
|
72
|
+
|
73
|
+
#filecontents dl.box, dl.box {
|
74
|
+
border: 0;
|
75
|
+
width: 520px;
|
76
|
+
font-size: 1em;
|
77
|
+
}
|
78
|
+
#filecontents dl.box dt, dl.box dt {
|
79
|
+
float: left;
|
80
|
+
display: block;
|
81
|
+
width: 100px;
|
82
|
+
margin: 0;
|
83
|
+
text-align: right;
|
84
|
+
font-weight: bold;
|
85
|
+
background: transparent;
|
86
|
+
border: 1px solid #aaa;
|
87
|
+
border-width: 1px 0px 0px 1px;
|
88
|
+
padding: 6px 0;
|
89
|
+
padding-right: 10px;
|
90
|
+
}
|
91
|
+
#filecontents dl.box dd, dl.box dd {
|
92
|
+
float: left;
|
93
|
+
display: block;
|
94
|
+
width: 380px;
|
95
|
+
margin: 0;
|
96
|
+
padding: 6px 0;
|
97
|
+
padding-right: 20px;
|
98
|
+
border: 1px solid #aaa;
|
99
|
+
border-width: 1px 1px 0 0;
|
100
|
+
}
|
101
|
+
#filecontents dl.box .last, dl.box .last {
|
102
|
+
border-bottom: 1px solid #aaa;
|
103
|
+
}
|
104
|
+
#filecontents dl.box .r1, dl.box .r1 { background: #eee; }
|
105
|
+
|
106
|
+
ul.toplevel { list-style: none; padding-left: 0; font-size: 1.1em; }
|
107
|
+
#files { padding-left: 15px; font-size: 1.1em; }
|
108
|
+
|
109
|
+
#files { padding: 0; }
|
110
|
+
#files li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; }
|
111
|
+
|
112
|
+
dl.constants { margin-left: 40px; }
|
113
|
+
dl.constants dt { font-weight: bold; font-size: 1.1em; margin-bottom: 5px; }
|
114
|
+
dl.constants dd { width: 75%; white-space: pre; font-family: monospace; margin-bottom: 18px; }
|
115
|
+
|
116
|
+
.summary_desc { margin-left: 32px; display: block; font-family: sans-serif; }
|
117
|
+
.summary_desc tt { font-size: 0.9em; }
|
118
|
+
dl.constants .note { padding: 2px 6px; padding-right: 12px; margin-top: 6px; }
|
119
|
+
dl.constants .docstring { margin-left: 32px; font-size: 0.9em; font-weight: normal; }
|
120
|
+
dl.constants .tags { padding-left: 32px; font-size: 0.9em; line-height: 0.8em; }
|
121
|
+
dl.constants .discussion *:first-child { margin-top: 0; }
|
122
|
+
dl.constants .discussion *:last-child { margin-bottom: 0; }
|
123
|
+
|
124
|
+
.method_details { border-top: 1px dotted #aaa; margin-top: 15px; padding-top: 0; }
|
125
|
+
.method_details.first { border: 0; }
|
126
|
+
p.signature {
|
127
|
+
font-size: 1.1em; font-weight: normal; font-family: Monaco, Consolas, Courier, monospace;
|
128
|
+
padding: 6px 10px; margin-top: 18px;
|
129
|
+
background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
|
130
|
+
}
|
131
|
+
p.signature tt { font-family: Monaco, Consolas, Courier, monospace; }
|
132
|
+
p.signature .overload { display: block; }
|
133
|
+
p.signature .extras { font-weight: normal; font-family: sans-serif; color: #444; font-size: 1em; }
|
134
|
+
p.signature .aliases { display: block; font-weight: normal; font-size: 0.9em; font-family: sans-serif; margin-top: 0px; color: #555; }
|
135
|
+
p.signature .aliases .names { font-family: Monaco, Consolas, Courier, monospace; font-weight: bold; color: #000; font-size: 1.2em; }
|
136
|
+
|
137
|
+
.tags h3 { font-size: 1em; margin-bottom: 0; }
|
138
|
+
.tags ul { margin-top: 5px; padding-left: 30px; list-style: square; }
|
139
|
+
.tags ul li { margin-bottom: 3px; }
|
140
|
+
.tags ul .name { font-family: monospace; font-weight: bold; }
|
141
|
+
.tags ul .note { padding: 3px 6px; }
|
142
|
+
.tags { margin-bottom: 12px; }
|
143
|
+
|
144
|
+
.tags .examples h3 { margin-bottom: 10px; }
|
145
|
+
.tags .examples h4 { padding: 0; margin: 0; margin-left: 15px; font-weight: bold; font-size: 0.9em; }
|
146
|
+
|
147
|
+
.tags .overload .overload_item { list-style: none; margin-bottom: 25px; }
|
148
|
+
.tags .overload .overload_item .signature {
|
149
|
+
padding: 2px 8px;
|
150
|
+
background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
|
151
|
+
}
|
152
|
+
.tags .overload .signature { margin-left: -15px; font-family: monospace; display: block; font-size: 1.1em; }
|
153
|
+
.tags .overload .docstring { margin-top: 15px; }
|
154
|
+
|
155
|
+
.defines { display: none; }
|
156
|
+
|
157
|
+
#method_missing_details .notice.this { position: relative; top: -8px; color: #888; padding: 0; margin: 0; }
|
158
|
+
|
159
|
+
.showSource { font-size: 0.9em; }
|
160
|
+
.showSource a:link, .showSource a:visited { text-decoration: none; color: #666; }
|
161
|
+
|
162
|
+
#content a:link, #content a:visited { text-decoration: none; color: #05a; }
|
163
|
+
#content a:hover { background: #ffffa5; }
|
164
|
+
.docstring { margin-right: 6em; }
|
165
|
+
|
166
|
+
ul.summary {
|
167
|
+
list-style: none;
|
168
|
+
font-family: monospace;
|
169
|
+
font-size: 1em;
|
170
|
+
line-height: 1.5em;
|
171
|
+
}
|
172
|
+
ul.summary a:link, ul.summary a:visited {
|
173
|
+
text-decoration: none; font-size: 1.1em;
|
174
|
+
}
|
175
|
+
ul.summary li { margin-bottom: 5px; }
|
176
|
+
.summary .summary_signature {
|
177
|
+
padding: 1px 10px;
|
178
|
+
background: #eaeaff; border: 1px solid #dfdfe5;
|
179
|
+
-moz-border-radius: 3px; -webkit-border-radius: 3px;
|
180
|
+
}
|
181
|
+
.summary_signature:hover { background: #eeeeff; cursor: pointer; }
|
182
|
+
ul.summary.compact li { display: inline-block; margin: 0px 5px 0px 0px; line-height: 2.6em;}
|
183
|
+
ul.summary.compact .summary_signature { padding: 5px 7px; padding-right: 4px; }
|
184
|
+
#content .summary_signature:hover a:link,
|
185
|
+
#content .summary_signature:hover a:visited {
|
186
|
+
background: transparent;
|
187
|
+
color: #48f;
|
188
|
+
}
|
189
|
+
|
190
|
+
p.inherited a { font-family: monospace; font-size: 0.9em; }
|
191
|
+
p.inherited { word-spacing: 5px; font-size: 1.2em; }
|
192
|
+
|
193
|
+
p.children { font-size: 1.2em; }
|
194
|
+
p.children a { font-size: 0.9em; }
|
195
|
+
p.children strong { font-size: 0.8em; }
|
196
|
+
p.children strong.modules { padding-left: 5px; }
|
197
|
+
|
198
|
+
ul.fullTree { display: none; padding-left: 0; list-style: none; margin-left: 0; margin-bottom: 10px; }
|
199
|
+
ul.fullTree ul { margin-left: 0; padding-left: 0; list-style: none; }
|
200
|
+
ul.fullTree li { text-align: center; padding-top: 18px; padding-bottom: 12px; background: url(data:image/gif;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAAKT2lDQ1BQaG90b3Nob3AgSUNDIHByb2ZpbGUAAHjanVNnVFPpFj333vRCS4iAlEtvUhUIIFJCi4AUkSYqIQkQSoghodkVUcERRUUEG8igiAOOjoCMFVEsDIoK2AfkIaKOg6OIisr74Xuja9a89+bN/rXXPues852zzwfACAyWSDNRNYAMqUIeEeCDx8TG4eQuQIEKJHAAEAizZCFz/SMBAPh+PDwrIsAHvgABeNMLCADATZvAMByH/w/qQplcAYCEAcB0kThLCIAUAEB6jkKmAEBGAYCdmCZTAKAEAGDLY2LjAFAtAGAnf+bTAICd+Jl7AQBblCEVAaCRACATZYhEAGg7AKzPVopFAFgwABRmS8Q5ANgtADBJV2ZIALC3AMDOEAuyAAgMADBRiIUpAAR7AGDIIyN4AISZABRG8lc88SuuEOcqAAB4mbI8uSQ5RYFbCC1xB1dXLh4ozkkXKxQ2YQJhmkAuwnmZGTKBNA/g88wAAKCRFRHgg/P9eM4Ors7ONo62Dl8t6r8G/yJiYuP+5c+rcEAAAOF0ftH+LC+zGoA7BoBt/qIl7gRoXgugdfeLZrIPQLUAoOnaV/Nw+H48PEWhkLnZ2eXk5NhKxEJbYcpXff5nwl/AV/1s+X48/Pf14L7iJIEyXYFHBPjgwsz0TKUcz5IJhGLc5o9H/LcL//wd0yLESWK5WCoU41EScY5EmozzMqUiiUKSKcUl0v9k4t8s+wM+3zUAsGo+AXuRLahdYwP2SycQWHTA4vcAAPK7b8HUKAgDgGiD4c93/+8//UegJQCAZkmScQAAXkQkLlTKsz/HCAAARKCBKrBBG/TBGCzABhzBBdzBC/xgNoRCJMTCQhBCCmSAHHJgKayCQiiGzbAdKmAv1EAdNMBRaIaTcA4uwlW4Dj1wD/phCJ7BKLyBCQRByAgTYSHaiAFiilgjjggXmYX4IcFIBBKLJCDJiBRRIkuRNUgxUopUIFVIHfI9cgI5h1xGupE7yAAygvyGvEcxlIGyUT3UDLVDuag3GoRGogvQZHQxmo8WoJvQcrQaPYw2oefQq2gP2o8+Q8cwwOgYBzPEbDAuxsNCsTgsCZNjy7EirAyrxhqwVqwDu4n1Y8+xdwQSgUXACTYEd0IgYR5BSFhMWE7YSKggHCQ0EdoJNwkDhFHCJyKTqEu0JroR+cQYYjIxh1hILCPWEo8TLxB7iEPENyQSiUMyJ7mQAkmxpFTSEtJG0m5SI+ksqZs0SBojk8naZGuyBzmULCAryIXkneTD5DPkG+Qh8lsKnWJAcaT4U+IoUspqShnlEOU05QZlmDJBVaOaUt2ooVQRNY9aQq2htlKvUYeoEzR1mjnNgxZJS6WtopXTGmgXaPdpr+h0uhHdlR5Ol9BX0svpR+iX6AP0dwwNhhWDx4hnKBmbGAcYZxl3GK+YTKYZ04sZx1QwNzHrmOeZD5lvVVgqtip8FZHKCpVKlSaVGyovVKmqpqreqgtV81XLVI+pXlN9rkZVM1PjqQnUlqtVqp1Q61MbU2epO6iHqmeob1Q/pH5Z/YkGWcNMw09DpFGgsV/jvMYgC2MZs3gsIWsNq4Z1gTXEJrHN2Xx2KruY/R27iz2qqaE5QzNKM1ezUvOUZj8H45hx+Jx0TgnnKKeX836K3hTvKeIpG6Y0TLkxZVxrqpaXllirSKtRq0frvTau7aedpr1Fu1n7gQ5Bx0onXCdHZ4/OBZ3nU9lT3acKpxZNPTr1ri6qa6UbobtEd79up+6Ynr5egJ5Mb6feeb3n+hx9L/1U/W36p/VHDFgGswwkBtsMzhg8xTVxbzwdL8fb8VFDXcNAQ6VhlWGX4YSRudE8o9VGjUYPjGnGXOMk423GbcajJgYmISZLTepN7ppSTbmmKaY7TDtMx83MzaLN1pk1mz0x1zLnm+eb15vft2BaeFostqi2uGVJsuRaplnutrxuhVo5WaVYVVpds0atna0l1rutu6cRp7lOk06rntZnw7Dxtsm2qbcZsOXYBtuutm22fWFnYhdnt8Wuw+6TvZN9un2N/T0HDYfZDqsdWh1+c7RyFDpWOt6azpzuP33F9JbpL2dYzxDP2DPjthPLKcRpnVOb00dnF2e5c4PziIuJS4LLLpc+Lpsbxt3IveRKdPVxXeF60vWdm7Obwu2o26/uNu5p7ofcn8w0nymeWTNz0MPIQ+BR5dE/C5+VMGvfrH5PQ0+BZ7XnIy9jL5FXrdewt6V3qvdh7xc+9j5yn+M+4zw33jLeWV/MN8C3yLfLT8Nvnl+F30N/I/9k/3r/0QCngCUBZwOJgUGBWwL7+Hp8Ib+OPzrbZfay2e1BjKC5QRVBj4KtguXBrSFoyOyQrSH355jOkc5pDoVQfujW0Adh5mGLw34MJ4WHhVeGP45wiFga0TGXNXfR3ENz30T6RJZE3ptnMU85ry1KNSo+qi5qPNo3ujS6P8YuZlnM1VidWElsSxw5LiquNm5svt/87fOH4p3iC+N7F5gvyF1weaHOwvSFpxapLhIsOpZATIhOOJTwQRAqqBaMJfITdyWOCnnCHcJnIi/RNtGI2ENcKh5O8kgqTXqS7JG8NXkkxTOlLOW5hCepkLxMDUzdmzqeFpp2IG0yPTq9MYOSkZBxQqohTZO2Z+pn5mZ2y6xlhbL+xW6Lty8elQfJa7OQrAVZLQq2QqboVFoo1yoHsmdlV2a/zYnKOZarnivN7cyzytuQN5zvn//tEsIS4ZK2pYZLVy0dWOa9rGo5sjxxedsK4xUFK4ZWBqw8uIq2Km3VT6vtV5eufr0mek1rgV7ByoLBtQFr6wtVCuWFfevc1+1dT1gvWd+1YfqGnRs+FYmKrhTbF5cVf9go3HjlG4dvyr+Z3JS0qavEuWTPZtJm6ebeLZ5bDpaql+aXDm4N2dq0Dd9WtO319kXbL5fNKNu7g7ZDuaO/PLi8ZafJzs07P1SkVPRU+lQ27tLdtWHX+G7R7ht7vPY07NXbW7z3/T7JvttVAVVN1WbVZftJ+7P3P66Jqun4lvttXa1ObXHtxwPSA/0HIw6217nU1R3SPVRSj9Yr60cOxx++/p3vdy0NNg1VjZzG4iNwRHnk6fcJ3/ceDTradox7rOEH0x92HWcdL2pCmvKaRptTmvtbYlu6T8w+0dbq3nr8R9sfD5w0PFl5SvNUyWna6YLTk2fyz4ydlZ19fi753GDborZ752PO32oPb++6EHTh0kX/i+c7vDvOXPK4dPKy2+UTV7hXmq86X23qdOo8/pPTT8e7nLuarrlca7nuer21e2b36RueN87d9L158Rb/1tWeOT3dvfN6b/fF9/XfFt1+cif9zsu72Xcn7q28T7xf9EDtQdlD3YfVP1v+3Njv3H9qwHeg89HcR/cGhYPP/pH1jw9DBY+Zj8uGDYbrnjg+OTniP3L96fynQ89kzyaeF/6i/suuFxYvfvjV69fO0ZjRoZfyl5O/bXyl/erA6xmv28bCxh6+yXgzMV70VvvtwXfcdx3vo98PT+R8IH8o/2j5sfVT0Kf7kxmTk/8EA5jz/GMzLdsAAAAgY0hSTQAAeiUAAICDAAD5/wAAgOkAAHUwAADqYAAAOpgAABdvkl/FRgAAAHtJREFUeNqMzrEJAkEURdGzuhgZbSoYWcAWoBVsB4JgZAGmphsZCZYzTQgWNCYrDN9RvMmHx+X916SUBFbo8CzD1idXrLErw1mQttgXtyrOcQ/Ny5p4Qh+2XqLYYazsPWNTiuMkRxa4vcV+evuNAUOLIx5+c2hyzv7hNQC67Q+/HHmlEwAAAABJRU5ErkJggg==) no-repeat top center; }
|
201
|
+
ul.fullTree li:first-child { padding-top: 0; background: transparent; }
|
202
|
+
ul.fullTree li:last-child { padding-bottom: 0; }
|
203
|
+
.showAll ul.fullTree { display: block; }
|
204
|
+
.showAll .inheritName { display: none; }
|
205
|
+
|
206
|
+
#search { position: absolute; right: 14px; top: 0px; }
|
207
|
+
#search a:link, #search a:visited {
|
208
|
+
display: block; float: left; margin-right: 4px;
|
209
|
+
padding: 8px 10px; text-decoration: none; color: #05a;
|
210
|
+
border: 1px solid #d8d8e5;
|
211
|
+
-moz-border-radius-bottomleft: 3px; -moz-border-radius-bottomright: 3px;
|
212
|
+
-webkit-border-bottom-left-radius: 3px; -webkit-border-bottom-right-radius: 3px;
|
213
|
+
background: #eaf0ff;
|
214
|
+
-webkit-box-shadow: -1px 1px 3px #ddd;
|
215
|
+
}
|
216
|
+
#search a:hover { background: #f5faff; color: #06b; }
|
217
|
+
#search a.active {
|
218
|
+
background: #568; padding-bottom: 20px; color: #fff; border: 1px solid #457;
|
219
|
+
-moz-border-radius-topleft: 5px; -moz-border-radius-topright: 5px;
|
220
|
+
-webkit-border-top-left-radius: 5px; -webkit-border-top-right-radius: 5px;
|
221
|
+
}
|
222
|
+
#search a.inactive { color: #999; }
|
223
|
+
.frames #search { display: none; }
|
224
|
+
.inheritanceTree, .toggleDefines { float: right; }
|
225
|
+
|
226
|
+
#menu { font-size: 1.3em; color: #bbb; top: -5px; position: relative; }
|
227
|
+
#menu .title, #menu a { font-size: 0.7em; }
|
228
|
+
#menu .title a { font-size: 1em; }
|
229
|
+
#menu .title { color: #555; }
|
230
|
+
#menu a:link, #menu a:visited { color: #333; text-decoration: none; border-bottom: 1px dotted #bbd; }
|
231
|
+
#menu a:hover { color: #05a; }
|
232
|
+
#menu .noframes { display: none; }
|
233
|
+
.frames #menu .noframes { display: inline; float: right; }
|
234
|
+
|
235
|
+
#footer { margin-top: 15px; border-top: 1px solid #ccc; text-align: center; padding: 7px 0; color: #999; }
|
236
|
+
#footer a:link, #footer a:visited { color: #444; text-decoration: none; border-bottom: 1px dotted #bbd; }
|
237
|
+
#footer a:hover { color: #05a; }
|
238
|
+
|
239
|
+
#listing ul.alpha { font-size: 1.1em; }
|
240
|
+
#listing ul.alpha { margin: 0; padding: 0; padding-bottom: 10px; list-style: none; }
|
241
|
+
#listing ul.alpha li.letter { font-size: 1.4em; padding-bottom: 10px; }
|
242
|
+
#listing ul.alpha ul { margin: 0; padding-left: 15px; }
|
243
|
+
#listing ul small { color: #666; font-size: 0.7em; }
|
244
|
+
|
245
|
+
li.r1 { background: #f0f0f0; }
|
246
|
+
li.r2 { background: #fafafa; }
|
247
|
+
|
248
|
+
#search_frame {
|
249
|
+
z-index: 9999;
|
250
|
+
background: #fff;
|
251
|
+
display: none;
|
252
|
+
position: absolute;
|
253
|
+
top: 36px;
|
254
|
+
right: 18px;
|
255
|
+
width: 500px;
|
256
|
+
height: 80%;
|
257
|
+
overflow-y: scroll;
|
258
|
+
border: 1px solid #999;
|
259
|
+
border-collapse: collapse;
|
260
|
+
-webkit-box-shadow: -7px 5px 25px #aaa;
|
261
|
+
-moz-box-shadow: -7px 5px 25px #aaa;
|
262
|
+
-moz-border-radius: 2px;
|
263
|
+
-webkit-border-radius: 2px;
|
264
|
+
}
|
265
|
+
|
266
|
+
#content ul.summary li.deprecated .summary_signature a:link,
|
267
|
+
#content ul.summary li.deprecated .summary_signature a:visited { text-decoration: line-through; font-style: italic; }
|
268
|
+
|
269
|
+
#toc {
|
270
|
+
padding: 20px; padding-right: 30px; border: 1px solid #ddd; float: right; background: #fff; margin-left: 20px; margin-bottom: 20px;
|
271
|
+
max-width: 300px;
|
272
|
+
-webkit-box-shadow: -2px 2px 6px #bbb;
|
273
|
+
-moz-box-shadow: -2px 2px 6px #bbb;
|
274
|
+
z-index: 5000;
|
275
|
+
position: relative;
|
276
|
+
}
|
277
|
+
#toc.nofloat { float: none; max-width: none; border: none; padding: 0; margin: 20px 0; -webkit-box-shadow: none; -moz-box-shadow: none; }
|
278
|
+
#toc.nofloat.hidden { padding: 0; background: 0; margin-bottom: 5px; }
|
279
|
+
#toc .title { margin: 0; }
|
280
|
+
#toc ol { padding-left: 1.8em; }
|
281
|
+
#toc li { font-size: 1.1em; line-height: 1.7em; }
|
282
|
+
#toc > ol > li { font-size: 1.1em; font-weight: bold; }
|
283
|
+
#toc ol > ol { font-size: 0.9em; }
|
284
|
+
#toc ol ol > ol { padding-left: 2.3em; }
|
285
|
+
#toc ol + li { margin-top: 0.3em; }
|
286
|
+
#toc.hidden { padding: 10px; background: #f6f6f6; -webkit-box-shadow: none; -moz-box-shadow: none; }
|
287
|
+
#filecontents h1 + #toc.nofloat { margin-top: 0; }
|
288
|
+
|
289
|
+
/* syntax highlighting */
|
290
|
+
.source_code { display: none; padding: 3px 8px; border-left: 8px solid #ddd; margin-top: 5px; }
|
291
|
+
#filecontents pre.code, .docstring pre.code, .source_code pre { font-family: monospace; }
|
292
|
+
#filecontents pre.code, .docstring pre.code { display: block; }
|
293
|
+
.source_code .lines { padding-right: 12px; color: #555; text-align: right; }
|
294
|
+
#filecontents pre.code, .docstring pre.code,
|
295
|
+
.tags .example { padding: 5px 12px; margin-top: 4px; border: 1px solid #eef; background: #f5f5ff; }
|
296
|
+
pre.code { color: #000; }
|
297
|
+
pre.code .info.file { color: #555; }
|
298
|
+
pre.code .val { color: #036A07; }
|
299
|
+
pre.code .tstring_content,
|
300
|
+
pre.code .heredoc_beg, pre.code .heredoc_end,
|
301
|
+
pre.code .qwords_beg, pre.code .qwords_end,
|
302
|
+
pre.code .tstring, pre.code .dstring { color: #036A07; }
|
303
|
+
pre.code .fid, pre.code .id.new, pre.code .id.to_s,
|
304
|
+
pre.code .id.to_sym, pre.code .id.to_f,
|
305
|
+
pre.code .dot + pre.code .id,
|
306
|
+
pre.code .id.to_i pre.code .id.each { color: #0085FF; }
|
307
|
+
pre.code .comment { color: #0066FF; }
|
308
|
+
pre.code .const, pre.code .constant { color: #585CF6; }
|
309
|
+
pre.code .symbol { color: #C5060B; }
|
310
|
+
pre.code .kw,
|
311
|
+
pre.code .label,
|
312
|
+
pre.code .id.require,
|
313
|
+
pre.code .id.extend,
|
314
|
+
pre.code .id.include { color: #0000FF; }
|
315
|
+
pre.code .ivar { color: #318495; }
|
316
|
+
pre.code .gvar,
|
317
|
+
pre.code .id.backref,
|
318
|
+
pre.code .id.nth_ref { color: #6D79DE; }
|
319
|
+
pre.code .regexp, .dregexp { color: #036A07; }
|
320
|
+
pre.code a { border-bottom: 1px dotted #bbf; }
|
@@ -0,0 +1,201 @@
|
|
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'>
|
58
|
+
<p>Mushikago SDK for Ruby.</p>
|
59
|
+
|
60
|
+
<h23></h23>
|
61
|
+
<ul><li>
|
62
|
+
<p>*<b>Homepage</b>*: [<a
|
63
|
+
href="http://www.miningbrownie.co.jp/](http://www.miningbrownie.co.jp">www.miningbrownie.co.jp/](http://www.miningbrownie.co.jp</a>/)</p>
|
64
|
+
</li><li>
|
65
|
+
<p>*<b>Author</b>*: Toru Matsuoka</p>
|
66
|
+
</li><li>
|
67
|
+
<p>*<b>Copyright</b>*: 2011</p>
|
68
|
+
</li><li>
|
69
|
+
<p>*<b>License</b>*: MIT License</p>
|
70
|
+
</li><li>
|
71
|
+
<p>**Latest Version**: 0.1.7</p>
|
72
|
+
</li><li>
|
73
|
+
<p>**Release Date**: September 6th 2011</p>
|
74
|
+
</li></ul>
|
75
|
+
|
76
|
+
<p>概要</p>
|
77
|
+
<hr style="height: 2px">
|
78
|
+
|
79
|
+
<p>[株式会社マイニングブラウニー](<a
|
80
|
+
href="http://www.miningbrownie.co.jp/)が提供するMushikago">www.miningbrownie.co.jp/)が提供するMushikago</a>
|
81
|
+
Webサービスを、Rubyから扱うためのライブラリです。</p>
|
82
|
+
|
83
|
+
<p>機能一覧</p>
|
84
|
+
<hr style="height: 6px">
|
85
|
+
|
86
|
+
<p>**1.Tomboを利用する**: [Tombo](<a
|
87
|
+
href="http://www.tombo.ne.jp/)は、APIを通してWeb">www.tombo.ne.jp/)は、APIを通してWeb</a>サイトのキャプチャ画像を取得するサービスです。
|
88
|
+
キャプチャ画像にはタグをつけて管理することができます。
|
89
|
+
キャプチャ画像は非同期で取得され、サーバの混雑具合によってリクエストから取得まで最大1時間の時間差があります。</p>
|
90
|
+
|
91
|
+
<p>インストール方法</p>
|
92
|
+
<hr style="height: 10px">
|
93
|
+
|
94
|
+
<p>Mushikago SDK for Rubyはgemを使ってインストールします。</p>
|
95
|
+
|
96
|
+
<pre class="code">$ <span class='gem identifier id'>gem</span> <span class='install identifier id'>install</span> <span class='mushikago identifier id'>mushikago</span><span class='minus op'>-</span><span class='sdk identifier id'>sdk</span>
|
97
|
+
</pre>
|
98
|
+
|
99
|
+
<p>(root権限が必要な場合は`sudo`を使ってください。)</p>
|
100
|
+
|
101
|
+
<p>使い方</p>
|
102
|
+
<hr style="height: 4px">
|
103
|
+
|
104
|
+
<p>### Tomboを利用する</p>
|
105
|
+
|
106
|
+
<p>以下のコードで[Tombo](<a
|
107
|
+
href="http://www.tombo.ne.jp">www.tombo.ne.jp</a>/)を利用することができます。</p>
|
108
|
+
|
109
|
+
<pre class="code"><span class='require identifier id'>require</span> <span class='string val'>'rubygems'</span>
|
110
|
+
<span class='require identifier id'>require</span> <span class='string val'>'mushikago'</span>
|
111
|
+
|
112
|
+
<span class='client identifier id'>client</span> <span class='assign token'>=</span> <span class='Mushikago constant id'>Mushikago</span><span class='colon2 op'>::</span><span class='Tombo constant id'>Tombo</span><span class='colon2 op'>::</span><span class='Client constant id'>Client</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:api_key</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>'<APIキー>'</span><span class='comma token'>,</span> <span class='symbol val'>:secret_key</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>'<シークレットキー>'</span><span class='rparen token'>)</span>
|
113
|
+
|
114
|
+
<span class='comment val'>########</span>
|
115
|
+
<span class='comment val'># Captureメソッド</span>
|
116
|
+
<span class='ret identifier id'>ret</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='capture identifier id'>capture</span><span class='lparen token'>(</span><span class='string val'>'http://www.tombo.ne.jp/'</span><span class='comma token'>,</span> <span class='lbrace token'>{</span><span class='symbol val'>:tags</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>'service'</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:thumbnail</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='true true kw'>true</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
117
|
+
<span class='p identifier id'>p</span> <span class='ret identifier id'>ret</span><span class='dot token'>.</span><span class='meta identifier id'>meta</span>
|
118
|
+
<span class='p identifier id'>p</span> <span class='ret identifier id'>ret</span><span class='dot token'>.</span><span class='response identifier id'>response</span>
|
119
|
+
<span class='comment val'># => {"message"=>"OK", "status"=>200} </span>
|
120
|
+
<span class='comment val'># => {"image_url"=>"http://img.tombo.ne.jp/tombo-sample/7e11d3fd-7865-4ab9-80fb-b0fc8f362614.jpg", ...</span>
|
121
|
+
|
122
|
+
<span class='comment val'>########</span>
|
123
|
+
<span class='comment val'># Capturesメソッド</span>
|
124
|
+
<span class='ret identifier id'>ret</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='captures identifier id'>captures</span>
|
125
|
+
<span class='p identifier id'>p</span> <span class='ret identifier id'>ret</span><span class='dot token'>.</span><span class='meta identifier id'>meta</span>
|
126
|
+
<span class='p identifier id'>p</span> <span class='ret identifier id'>ret</span><span class='dot token'>.</span><span class='response identifier id'>response</span>
|
127
|
+
<span class='comment val'># => {"message"=>"OK", "status"=>200} </span>
|
128
|
+
<span class='comment val'># => {"total"=>134, "images"=>[{"image_id"=>"ea7998d3-f8b6-4505-ae22-fc986439c569", "thumbnail_size"=>5120, ....</span>
|
129
|
+
|
130
|
+
<span class='comment val'>########</span>
|
131
|
+
<span class='comment val'># deleteメソッド</span>
|
132
|
+
<span class='ret identifier id'>ret</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='string val'>'xxxxxxxx'</span><span class='rparen token'>)</span>
|
133
|
+
<span class='p identifier id'>p</span> <span class='ret identifier id'>ret</span><span class='dot token'>.</span><span class='meta identifier id'>meta</span>
|
134
|
+
<span class='p identifier id'>p</span> <span class='ret identifier id'>ret</span><span class='dot token'>.</span><span class='response identifier id'>response</span>
|
135
|
+
<span class='comment val'># => {"message"=>"OK", "status"=>200} </span>
|
136
|
+
<span class='comment val'># => {"id"=>"xxxxxxxx"}</span>
|
137
|
+
|
138
|
+
<span class='comment val'>########</span>
|
139
|
+
<span class='comment val'># infoメソッド</span>
|
140
|
+
<span class='ret identifier id'>ret</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='info identifier id'>info</span>
|
141
|
+
<span class='p identifier id'>p</span> <span class='ret identifier id'>ret</span><span class='dot token'>.</span><span class='meta identifier id'>meta</span>
|
142
|
+
<span class='p identifier id'>p</span> <span class='ret identifier id'>ret</span><span class='dot token'>.</span><span class='response identifier id'>response</span>
|
143
|
+
<span class='comment val'># => {"message"=>"OK", "status"=>200} </span>
|
144
|
+
<span class='comment val'># => {"disk_usage"=>25372565, "image_num"=>133, "api_count"=>499}</span>
|
145
|
+
</pre>
|
146
|
+
|
147
|
+
<p>#### APIキーとシークレットキーの設定方法</p>
|
148
|
+
|
149
|
+
<p>APIキーとシークレットキーは以下の方法でも設定することができます。</p>
|
150
|
+
|
151
|
+
<p>**YAMLファイルを利用する場合**</p>
|
152
|
+
|
153
|
+
<p>以下のYAMLファイルを用意します。</p>
|
154
|
+
|
155
|
+
<p><pre class=“code”> api_key:&lt;APIキー&gt;
|
156
|
+
secret_key:&lt;シークレットキー&gt; </pre></p>
|
157
|
+
|
158
|
+
<p>以下のコードでYAMLファイルを読み込んで使用してください。</p>
|
159
|
+
|
160
|
+
<pre class="code"><span class='require identifier id'>require</span> <span class='string val'>'rubygems'</span>
|
161
|
+
<span class='require identifier id'>require</span> <span class='string val'>'mushikago'</span>
|
162
|
+
|
163
|
+
<span class='Mushikago constant id'>Mushikago</span><span class='dot token'>.</span><span class='config identifier id'>config</span><span class='dot token'>.</span><span class='load identifier id'>load</span><span class='lparen token'>(</span><span class='YAML constant id'>YAML</span><span class='dot token'>.</span><span class='load identifier id'>load</span><span class='lparen token'>(</span><span class='File constant id'>File</span><span class='dot token'>.</span><span class='read identifier id'>read</span><span class='lparen token'>(</span><span class='string val'>'config.yml'</span><span class='rparen token'>)</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
|
164
|
+
|
165
|
+
<span class='client identifier id'>client</span> <span class='assign token'>=</span> <span class='Mushikago constant id'>Mushikago</span><span class='colon2 op'>::</span><span class='Tombo constant id'>Tombo</span><span class='colon2 op'>::</span><span class='Client constant id'>Client</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
|
166
|
+
</pre>
|
167
|
+
|
168
|
+
<p>**環境変数を利用する場合**</p>
|
169
|
+
|
170
|
+
<p>環境変数MUSHIKAGO_API_KEYとMUSHIKAGO_SECRET_KEYにそれぞれAPIキーとシークレットキーの設定を行います。</p>
|
171
|
+
|
172
|
+
<p><pre class=“code”> $ export
|
173
|
+
MUSHIKAGO_API_KEY=&lt;APIキー&gt; $ export
|
174
|
+
MUSHIKAGO_SECRET_KEY=&lt;シークレットキー&gt; </pre></p>
|
175
|
+
|
176
|
+
<pre class="code"><span class='require identifier id'>require</span> <span class='string val'>'rubygems'</span>
|
177
|
+
<span class='require identifier id'>require</span> <span class='string val'>'mushikago'</span>
|
178
|
+
|
179
|
+
<span class='client identifier id'>client</span> <span class='assign token'>=</span> <span class='Mushikago constant id'>Mushikago</span><span class='colon2 op'>::</span><span class='Tombo constant id'>Tombo</span><span class='colon2 op'>::</span><span class='Client constant id'>Client</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
|
180
|
+
</pre>
|
181
|
+
|
182
|
+
<p>変更履歴</p>
|
183
|
+
<hr style="height: 6px">
|
184
|
+
<ul><li>
|
185
|
+
<p>*<b>Sep.6.11</b>*: 0.1.7 release</p>
|
186
|
+
<ul><li>
|
187
|
+
<p>Mushikago SDK for Ruby新規作成</p>
|
188
|
+
</li><li>
|
189
|
+
<p>Tombo サポート</p>
|
190
|
+
</li></ul>
|
191
|
+
</li></ul>
|
192
|
+
</div></div>
|
193
|
+
|
194
|
+
<div id="footer">
|
195
|
+
Generated on Tue Sep 6 18:22:59 2011 by
|
196
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
197
|
+
0.7.2 (ruby-1.8.7).
|
198
|
+
</div>
|
199
|
+
|
200
|
+
</body>
|
201
|
+
</html>
|