badgeville_berlin 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (114) hide show
  1. data/.gitignore +5 -0
  2. data/.rspec +1 -0
  3. data/.rvmrc +1 -0
  4. data/.yardoc/checksums +17 -0
  5. data/.yardoc/objects/root.dat +0 -0
  6. data/.yardoc/proxy_types +0 -0
  7. data/Gemfile +4 -0
  8. data/LICENSE.md +7 -0
  9. data/README.md +150 -0
  10. data/README_ADVANCED.md +120 -0
  11. data/Rakefile +11 -0
  12. data/badgeville.gemspec +36 -0
  13. data/doc/BadgevilleBerlin.html +131 -0
  14. data/doc/BadgevilleBerlin/Activity.html +135 -0
  15. data/doc/BadgevilleBerlin/ActivityDefinition.html +135 -0
  16. data/doc/BadgevilleBerlin/BaseResource.html +462 -0
  17. data/doc/BadgevilleBerlin/Config.html +280 -0
  18. data/doc/BadgevilleBerlin/Errors.html +276 -0
  19. data/doc/BadgevilleBerlin/Group.html +135 -0
  20. data/doc/BadgevilleBerlin/Leaderboard.html +135 -0
  21. data/doc/BadgevilleBerlin/Player.html +135 -0
  22. data/doc/BadgevilleBerlin/Reward.html +135 -0
  23. data/doc/BadgevilleBerlin/RewardDefinition.html +135 -0
  24. data/doc/BadgevilleBerlin/Site.html +135 -0
  25. data/doc/BadgevilleBerlin/Track.html +135 -0
  26. data/doc/BadgevilleBerlin/User.html +135 -0
  27. data/doc/BadgevilleBerlinJsonFormat.html +530 -0
  28. data/doc/_index.html +285 -0
  29. data/doc/class_list.html +47 -0
  30. data/doc/css/common.css +1 -0
  31. data/doc/css/full_list.css +53 -0
  32. data/doc/css/style.css +320 -0
  33. data/doc/file.README.html +182 -0
  34. data/doc/file_list.html +49 -0
  35. data/doc/frames.html +13 -0
  36. data/doc/index.html +182 -0
  37. data/doc/js/app.js +205 -0
  38. data/doc/js/full_list.js +150 -0
  39. data/doc/js/jquery.js +16 -0
  40. data/doc/method_list.html +118 -0
  41. data/doc/top-level-namespace.html +103 -0
  42. data/examples/.DS_Store +0 -0
  43. data/examples/shell/.DS_Store +0 -0
  44. data/examples/shell/lib/.DS_Store +0 -0
  45. data/examples/shell/lib/berlin_shell.rb +34 -0
  46. data/examples/shell/lib/berlin_shell/.DS_Store +0 -0
  47. data/examples/shell/lib/berlin_shell/cd.rb +17 -0
  48. data/examples/shell/lib/berlin_shell/core.rb +118 -0
  49. data/examples/shell/lib/berlin_shell/ls.rb +72 -0
  50. data/examples/shell/lib/berlin_shell/prompt.rb +39 -0
  51. data/examples/shell/shell_demo.rb +319 -0
  52. data/examples/shell/spec/integration/basic_spec.rb +7 -0
  53. data/lib/.yardoc/checksums +0 -0
  54. data/lib/.yardoc/objects/root.dat +0 -0
  55. data/lib/.yardoc/proxy_types +0 -0
  56. data/lib/badgeville_berlin.rb +24 -0
  57. data/lib/badgeville_berlin/.yardoc/checksums +0 -0
  58. data/lib/badgeville_berlin/.yardoc/objects/root.dat +0 -0
  59. data/lib/badgeville_berlin/.yardoc/proxy_types +0 -0
  60. data/lib/badgeville_berlin/activity.rb +5 -0
  61. data/lib/badgeville_berlin/activity_definition.rb +5 -0
  62. data/lib/badgeville_berlin/base_resource.rb +68 -0
  63. data/lib/badgeville_berlin/config.rb +36 -0
  64. data/lib/badgeville_berlin/doc/_index.html +84 -0
  65. data/lib/badgeville_berlin/doc/class_list.html +47 -0
  66. data/lib/badgeville_berlin/doc/css/common.css +1 -0
  67. data/lib/badgeville_berlin/doc/css/full_list.css +53 -0
  68. data/lib/badgeville_berlin/doc/css/style.css +320 -0
  69. data/lib/badgeville_berlin/doc/file_list.html +46 -0
  70. data/lib/badgeville_berlin/doc/frames.html +13 -0
  71. data/lib/badgeville_berlin/doc/index.html +84 -0
  72. data/lib/badgeville_berlin/doc/js/app.js +205 -0
  73. data/lib/badgeville_berlin/doc/js/full_list.js +150 -0
  74. data/lib/badgeville_berlin/doc/js/jquery.js +16 -0
  75. data/lib/badgeville_berlin/doc/method_list.html +46 -0
  76. data/lib/badgeville_berlin/doc/top-level-namespace.html +93 -0
  77. data/lib/badgeville_berlin/errors.rb +28 -0
  78. data/lib/badgeville_berlin/formats/badgeville_berlin_json_format.rb +55 -0
  79. data/lib/badgeville_berlin/group.rb +5 -0
  80. data/lib/badgeville_berlin/leaderboard.rb +5 -0
  81. data/lib/badgeville_berlin/player.rb +5 -0
  82. data/lib/badgeville_berlin/reward.rb +5 -0
  83. data/lib/badgeville_berlin/reward_definition.rb +5 -0
  84. data/lib/badgeville_berlin/site.rb +5 -0
  85. data/lib/badgeville_berlin/track.rb +5 -0
  86. data/lib/badgeville_berlin/user.rb +5 -0
  87. data/lib/badgeville_berlin/version.rb +3 -0
  88. data/lib/doc/_index.html +84 -0
  89. data/lib/doc/class_list.html +47 -0
  90. data/lib/doc/css/common.css +1 -0
  91. data/lib/doc/css/full_list.css +53 -0
  92. data/lib/doc/css/style.css +320 -0
  93. data/lib/doc/file_list.html +46 -0
  94. data/lib/doc/frames.html +13 -0
  95. data/lib/doc/index.html +84 -0
  96. data/lib/doc/js/app.js +205 -0
  97. data/lib/doc/js/full_list.js +150 -0
  98. data/lib/doc/js/jquery.js +16 -0
  99. data/lib/doc/method_list.html +46 -0
  100. data/lib/doc/top-level-namespace.html +93 -0
  101. data/spec/factories.rb +54 -0
  102. data/spec/integration/activity_spec.rb +0 -0
  103. data/spec/integration/basic_spec.rb +68 -0
  104. data/spec/integration/player_spec.rb +6 -0
  105. data/spec/integration/site_spec.rb +11 -0
  106. data/spec/integration/user_spec.rb +3 -0
  107. data/spec/response_json.yml +36 -0
  108. data/spec/spec_helper.rb +60 -0
  109. data/spec/unit/badgeville_berlin_json_format_spec.rb +68 -0
  110. data/spec/unit/base_resource_spec.rb +47 -0
  111. data/spec/unit/config_spec.rb +65 -0
  112. data/spec/unit/errors_spec.rb +47 -0
  113. data/spec/use_case/readme_use_case_spec.rb +262 -0
  114. metadata +286 -0
data/doc/file.README.html ADDED
@@ -0,0 +1,182 @@
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
+ &mdash; Documentation by YARD 0.7.1
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> &raquo;
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>Badgeville RESTful Wrapper for Berlin API -- Basic README</h1>
58
+
59
+ <p>This is a Ruby wrapper for interacting with the <a href="http://rules.badgeville.com/display/doc/2.0+Core+API+Documentation">Badgeville RESTful Berlin API</a>.</p>
60
+
61
+ <h2>Features</h2>
62
+
63
+ <ul>
64
+ <li>Uses the activeresource (3.0.5) gem to map ActiveModel-like RESTful methods to resources on the remote Badgeville server.</li>
65
+ <li>Allows creating, reading (finding), updating and deleting the following classes of remote resources: Site, User, Player, ActivityDefinition, Activity.</li>
66
+ </ul>
67
+
68
+
69
+ <h2>Basic Examples</h2>
70
+
71
+ <h3>1. Configure the gem to use your Badgeville API Key and the site to which your requests should go.</h3>
72
+
73
+ <p><code>ruby
74
+ BadgevilleBerlin::Config.conf(
75
+ :site =&gt; "http://sandbox.v2.badgeville.com",
76
+ :api_key =&gt; MY_API_KEY)
77
+ </code></p>
78
+
79
+ <h3>2. Add a new site to your network. Find your network ID the Publisher Module's tabbed menu Develop > Home or contact support@badgeville.com.</h3>
80
+
81
+ <p><code>ruby
82
+ new_site = BadgevilleBerlin::Site.new(
83
+ :name =&gt; "My Website",
84
+ :url =&gt; "mydomain.com",
85
+ :network_id =&gt; MY_NETWORK_ID )
86
+ success = new_site.save
87
+ </code></p>
88
+
89
+ <h3>3. Create a user to add them to your network.</h3>
90
+
91
+ <p><code>ruby
92
+ new_user = BadgevilleBerlin::User.new(
93
+ :name =&gt; 'visitor_username',
94
+ :network_id =&gt; MY_NETWORK_ID,
95
+ :email =&gt; 'visitor@emailserver.com',
96
+ :password =&gt; 'visitor_password' )
97
+ success = new_user.save
98
+ </code></p>
99
+
100
+ <h3>4. Find the newly created user by ID to update their email address.</h3>
101
+
102
+ <p><code>ruby
103
+ user_found_by_id = BadgevilleBerlin::User.find( new_user.id )
104
+ user_found_by_id.email = 'revised_visitor@emailserver.com'
105
+ success = user_found_by_id.save
106
+ </code></p>
107
+
108
+ <h3>5. Create a player using the user corresponding to the updated email address for the site you created.</h3>
109
+
110
+ <p><code>ruby
111
+ new_player = BadgevilleBerlin::Player.new(
112
+ :site_id =&gt; new_site.id,
113
+ :user_id =&gt; new_user.id )
114
+ success = new_player.save
115
+ </code></p>
116
+
117
+ <h3>6. Register a player behavior (e.g. share) for the newly created player.</h3>
118
+
119
+ <p><code>ruby
120
+ new_activity = BadgevilleBerlin::Activity.new(
121
+ :verb =&gt; 'share',
122
+ :player_id =&gt; new_player.id )
123
+ success = new_activity.save
124
+ </code></p>
125
+
126
+ <h2>Tips</h2>
127
+
128
+ <h3>Monitoring HTTP Requests and JSON Responses</h3>
129
+
130
+ <p>Print HTTP requests and JSON responses by installing the "logger" gem and including this code in your script.</p>
131
+
132
+ <p>```ruby
133
+ require 'logger'
134
+ BadgevilleBerlin::BaseResource.logger = Logger.new(STDOUT)
135
+ BadgevilleBerlin::BaseResource.logger.level = Logger::DEBUG</p>
136
+
137
+ <p>```</p>
138
+
139
+ <h3>Avoiding "BadgevilleBerlin::"</h3>
140
+
141
+ <p>Encapsulate your code inside a module Badgeville to avoid frequently typing "Badgeville::"</p>
142
+
143
+ <p><code>ruby
144
+ module BadgevilleBerlin
145
+ # your code goes here
146
+ end
147
+ </code></p>
148
+
149
+ <h2>Dependencies</h2>
150
+
151
+ <ul>
152
+ <li>activeresource (3.1.3) - Provides Ruby classes to RESTfully interact with remote resources.</li>
153
+ <li>logger (1.2.8) - Provides logging to the standard output stream.</li>
154
+ </ul>
155
+
156
+
157
+ <h2>Installation</h2>
158
+
159
+ <p>[STILL NEEDS TO BE WRITTEN]</p>
160
+
161
+ <h2>Documentation</h2>
162
+
163
+ <p>For more documentation on how the Badgeville RESTful Berlin API works, see [here] (http://rules.badgeville.com/display/doc/2.0+Core+API+Documentation).</p>
164
+
165
+ <h2>Contributors</h2>
166
+
167
+ <p>David Czarnecki of Major League Gaming wrote the initial gem that inspired this wrapper. David's gem and supporting documentation is available here.</p>
168
+
169
+ <h2>Feedback</h2>
170
+
171
+ <p>Please email your comments to supraja@badgeville.com</p>
172
+
173
+ <p>Copyright (c) 2012 Badgeville.</p></div></div>
174
+
175
+ <div id="footer">
176
+ Generated on Tue Jan 24 14:21:13 2012 by
177
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
178
+ 0.7.1 (ruby-1.9.2).
179
+ </div>
180
+
181
+ </body>
182
+ </html>
data/doc/file_list.html ADDED
@@ -0,0 +1,49 @@
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 ADDED
@@ -0,0 +1,13 @@
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.1</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 ADDED
@@ -0,0 +1,182 @@
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
+ &mdash; Documentation by YARD 0.7.1
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> &raquo;
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>Badgeville RESTful Wrapper for Berlin API -- Basic README</h1>
58
+
59
+ <p>This is a Ruby wrapper for interacting with the <a href="http://rules.badgeville.com/display/doc/2.0+Core+API+Documentation">Badgeville RESTful Berlin API</a>.</p>
60
+
61
+ <h2>Features</h2>
62
+
63
+ <ul>
64
+ <li>Uses the activeresource (3.0.5) gem to map ActiveModel-like RESTful methods to resources on the remote Badgeville server.</li>
65
+ <li>Allows creating, reading (finding), updating and deleting the following classes of remote resources: Site, User, Player, ActivityDefinition, Activity.</li>
66
+ </ul>
67
+
68
+
69
+ <h2>Basic Examples</h2>
70
+
71
+ <h3>1. Configure the gem to use your Badgeville API Key and the site to which your requests should go.</h3>
72
+
73
+ <p><code>ruby
74
+ BadgevilleBerlin::Config.conf(
75
+ :site =&gt; "http://sandbox.v2.badgeville.com",
76
+ :api_key =&gt; MY_API_KEY)
77
+ </code></p>
78
+
79
+ <h3>2. Add a new site to your network. Find your network ID the Publisher Module's tabbed menu Develop > Home or contact support@badgeville.com.</h3>
80
+
81
+ <p><code>ruby
82
+ new_site = BadgevilleBerlin::Site.new(
83
+ :name =&gt; "My Website",
84
+ :url =&gt; "mydomain.com",
85
+ :network_id =&gt; MY_NETWORK_ID )
86
+ success = new_site.save
87
+ </code></p>
88
+
89
+ <h3>3. Create a user to add them to your network.</h3>
90
+
91
+ <p><code>ruby
92
+ new_user = BadgevilleBerlin::User.new(
93
+ :name =&gt; 'visitor_username',
94
+ :network_id =&gt; MY_NETWORK_ID,
95
+ :email =&gt; 'visitor@emailserver.com',
96
+ :password =&gt; 'visitor_password' )
97
+ success = new_user.save
98
+ </code></p>
99
+
100
+ <h3>4. Find the newly created user by ID to update their email address.</h3>
101
+
102
+ <p><code>ruby
103
+ user_found_by_id = BadgevilleBerlin::User.find( new_user.id )
104
+ user_found_by_id.email = 'revised_visitor@emailserver.com'
105
+ success = user_found_by_id.save
106
+ </code></p>
107
+
108
+ <h3>5. Create a player using the user corresponding to the updated email address for the site you created.</h3>
109
+
110
+ <p><code>ruby
111
+ new_player = BadgevilleBerlin::Player.new(
112
+ :site_id =&gt; new_site.id,
113
+ :user_id =&gt; new_user.id )
114
+ success = new_player.save
115
+ </code></p>
116
+
117
+ <h3>6. Register a player behavior (e.g. share) for the newly created player.</h3>
118
+
119
+ <p><code>ruby
120
+ new_activity = BadgevilleBerlin::Activity.new(
121
+ :verb =&gt; 'share',
122
+ :player_id =&gt; new_player.id )
123
+ success = new_activity.save
124
+ </code></p>
125
+
126
+ <h2>Tips</h2>
127
+
128
+ <h3>Monitoring HTTP Requests and JSON Responses</h3>
129
+
130
+ <p>Print HTTP requests and JSON responses by installing the "logger" gem and including this code in your script.</p>
131
+
132
+ <p>```ruby
133
+ require 'logger'
134
+ BadgevilleBerlin::BaseResource.logger = Logger.new(STDOUT)
135
+ BadgevilleBerlin::BaseResource.logger.level = Logger::DEBUG</p>
136
+
137
+ <p>```</p>
138
+
139
+ <h3>Avoiding "BadgevilleBerlin::"</h3>
140
+
141
+ <p>Encapsulate your code inside a module Badgeville to avoid frequently typing "Badgeville::"</p>
142
+
143
+ <p><code>ruby
144
+ module BadgevilleBerlin
145
+ # your code goes here
146
+ end
147
+ </code></p>
148
+
149
+ <h2>Dependencies</h2>
150
+
151
+ <ul>
152
+ <li>activeresource (3.1.3) - Provides Ruby classes to RESTfully interact with remote resources.</li>
153
+ <li>logger (1.2.8) - Provides logging to the standard output stream.</li>
154
+ </ul>
155
+
156
+
157
+ <h2>Installation</h2>
158
+
159
+ <p>[STILL NEEDS TO BE WRITTEN]</p>
160
+
161
+ <h2>Documentation</h2>
162
+
163
+ <p>For more documentation on how the Badgeville RESTful Berlin API works, see [here] (http://rules.badgeville.com/display/doc/2.0+Core+API+Documentation).</p>
164
+
165
+ <h2>Contributors</h2>
166
+
167
+ <p>David Czarnecki of Major League Gaming wrote the initial gem that inspired this wrapper. David's gem and supporting documentation is available here.</p>
168
+
169
+ <h2>Feedback</h2>
170
+
171
+ <p>Please email your comments to supraja@badgeville.com</p>
172
+
173
+ <p>Copyright (c) 2012 Badgeville.</p></div></div>
174
+
175
+ <div id="footer">
176
+ Generated on Tue Jan 24 14:21:13 2012 by
177
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
178
+ 0.7.1 (ruby-1.9.2).
179
+ </div>
180
+
181
+ </body>
182
+ </html>
data/doc/js/app.js ADDED
@@ -0,0 +1,205 @@
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);