basecamp3 0.1.3

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.
Files changed (89) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +12 -0
  3. data/.rspec +2 -0
  4. data/.travis.yml +5 -0
  5. data/Gemfile +2 -0
  6. data/LICENSE.txt +21 -0
  7. data/README.md +65 -0
  8. data/Rakefile +6 -0
  9. data/basecamp3.gemspec +38 -0
  10. data/bin/console +14 -0
  11. data/bin/setup +8 -0
  12. data/docs/Basecamp3.html +367 -0
  13. data/docs/Basecamp3/Campfire.html +901 -0
  14. data/docs/Basecamp3/CampfireLine.html +1025 -0
  15. data/docs/Basecamp3/Comment.html +1284 -0
  16. data/docs/Basecamp3/Concerns.html +117 -0
  17. data/docs/Basecamp3/Concerns/Bucketable.html +211 -0
  18. data/docs/Basecamp3/Concerns/Commentable.html +285 -0
  19. data/docs/Basecamp3/Concerns/Creatorable.html +209 -0
  20. data/docs/Basecamp3/Concerns/Parentable.html +211 -0
  21. data/docs/Basecamp3/Concerns/Recordingable.html +189 -0
  22. data/docs/Basecamp3/Concerns/Recordingable/ClassMethods.html +236 -0
  23. data/docs/Basecamp3/Document.html +1262 -0
  24. data/docs/Basecamp3/Forward.html +1070 -0
  25. data/docs/Basecamp3/Inbox.html +840 -0
  26. data/docs/Basecamp3/Message.html +1262 -0
  27. data/docs/Basecamp3/MessageBoard.html +840 -0
  28. data/docs/Basecamp3/MessageType.html +1160 -0
  29. data/docs/Basecamp3/Model.html +236 -0
  30. data/docs/Basecamp3/Person.html +1288 -0
  31. data/docs/Basecamp3/Project.html +1280 -0
  32. data/docs/Basecamp3/Question.html +1050 -0
  33. data/docs/Basecamp3/QuestionAnswer.html +887 -0
  34. data/docs/Basecamp3/Questionnaire.html +840 -0
  35. data/docs/Basecamp3/Request.html +933 -0
  36. data/docs/Basecamp3/ResponseParser.html +303 -0
  37. data/docs/Basecamp3/Schedule.html +840 -0
  38. data/docs/Basecamp3/ScheduleEntry.html +1560 -0
  39. data/docs/Basecamp3/Todo.html +1726 -0
  40. data/docs/Basecamp3/TodoList.html +1480 -0
  41. data/docs/Basecamp3/TodoSet.html +980 -0
  42. data/docs/Basecamp3/TypeMapper.html +329 -0
  43. data/docs/Basecamp3/Vault.html +1514 -0
  44. data/docs/_index.html +415 -0
  45. data/docs/class_list.html +51 -0
  46. data/docs/css/common.css +1 -0
  47. data/docs/css/full_list.css +58 -0
  48. data/docs/css/style.css +492 -0
  49. data/docs/file.README.html +157 -0
  50. data/docs/file_list.html +56 -0
  51. data/docs/frames.html +17 -0
  52. data/docs/index.html +157 -0
  53. data/docs/js/app.js +248 -0
  54. data/docs/js/full_list.js +216 -0
  55. data/docs/js/jquery.js +4 -0
  56. data/docs/method_list.html +1875 -0
  57. data/docs/top-level-namespace.html +110 -0
  58. data/lib/basecamp3.rb +61 -0
  59. data/lib/basecamp3/concerns/bucketable.rb +17 -0
  60. data/lib/basecamp3/concerns/commentable.rb +15 -0
  61. data/lib/basecamp3/concerns/creatorable.rb +16 -0
  62. data/lib/basecamp3/concerns/parentable.rb +17 -0
  63. data/lib/basecamp3/concerns/recordingable.rb +22 -0
  64. data/lib/basecamp3/model.rb +23 -0
  65. data/lib/basecamp3/models/campfire.rb +42 -0
  66. data/lib/basecamp3/models/campfire_line.rb +52 -0
  67. data/lib/basecamp3/models/comment.rb +65 -0
  68. data/lib/basecamp3/models/document.rb +71 -0
  69. data/lib/basecamp3/models/forward.rb +40 -0
  70. data/lib/basecamp3/models/inbox.rb +31 -0
  71. data/lib/basecamp3/models/message.rb +73 -0
  72. data/lib/basecamp3/models/message_board.rb +31 -0
  73. data/lib/basecamp3/models/message_type.rb +68 -0
  74. data/lib/basecamp3/models/person.rb +46 -0
  75. data/lib/basecamp3/models/project.rb +70 -0
  76. data/lib/basecamp3/models/question.rb +43 -0
  77. data/lib/basecamp3/models/question_answer.rb +35 -0
  78. data/lib/basecamp3/models/questionnaire.rb +31 -0
  79. data/lib/basecamp3/models/schedule.rb +31 -0
  80. data/lib/basecamp3/models/schedule_entry.rb +93 -0
  81. data/lib/basecamp3/models/todo.rb +108 -0
  82. data/lib/basecamp3/models/todo_list.rb +77 -0
  83. data/lib/basecamp3/models/todo_set.rb +33 -0
  84. data/lib/basecamp3/models/vault.rb +79 -0
  85. data/lib/basecamp3/request.rb +163 -0
  86. data/lib/basecamp3/response_parser.rb +44 -0
  87. data/lib/basecamp3/type_mapper.rb +53 -0
  88. data/lib/basecamp3/version.rb +3 -0
  89. metadata +202 -0
data/docs/file.README.html ADDED
@@ -0,0 +1,157 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.9.9
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "README";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="file_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index</a> &raquo;
40
+ <span class="title">File: README</span>
41
+
42
+ </div>
43
+
44
+ <div id="search">
45
+
46
+ <a class="full_list_link" id="class_list_link"
47
+ href="class_list.html">
48
+
49
+ <svg width="24" height="24">
50
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
+ </svg>
54
+ </a>
55
+
56
+ </div>
57
+ <div class="clear"></div>
58
+ </div>
59
+
60
+ <div id="content"><div id='filecontents'>
61
+ <h1 id="label-Basecamp3+API+Wrapper">Basecamp3 API Wrapper</h1>
62
+
63
+ <p>A simple Ruby Wrapper for the Basecamp3 API.</p>
64
+
65
+ <p><a href="https://github.com/basecamp/bc3-api">For more information about
66
+ Basecamp3 API, see the official documentation</a></p>
67
+
68
+ <h2 id="label-Installation">Installation</h2>
69
+
70
+ <p>Add this line to your application&#39;s Gemfile:</p>
71
+
72
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>basecamp3</span><span class='tstring_end'>&#39;</span></span>
73
+ </code></pre>
74
+
75
+ <p>And then execute:</p>
76
+
77
+ <pre class="code ruby"><code class="ruby">$ bundle</code></pre>
78
+
79
+ <p>Or install it yourself as:</p>
80
+
81
+ <pre class="code ruby"><code class="ruby">$ gem install basecamp3</code></pre>
82
+
83
+ <h2 id="label-Basic+usage">Basic usage</h2>
84
+
85
+ <p>First, you have to establish a connection to Basecamp3. If you don&#39;t
86
+ know how to get the access token, <a
87
+ href="https://github.com/basecamp/api/blob/master/sections/authentication.md">see
88
+ the official authentication guide</a></p>
89
+
90
+ <pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='period'>.</span><span class='id identifier rubyid_connect'><span class='object_link'><a href="Basecamp3.html#connect-class_method" title="Basecamp3.connect (method)">connect</a></span></span><span class='lparen'>(</span><span class='const'>YOUR_BASECAMP3_ACCOUNT_ID</span><span class='comma'>,</span> <span class='const'>YOUR_BASECAMP3_ACCESS_TOKEN</span><span class='rparen'>)</span>
91
+ </code></pre>
92
+
93
+ <p>That&#39;s all. You can make requests now.</p>
94
+
95
+ <p>E.g.: to get the TODO, just call the <code>find</code> method from the
96
+ <code>Basecamp3::Todo</code> class:</p>
97
+
98
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_todo'>todo</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Basecamp3/Todo.html" title="Basecamp3::Todo (class)">Todo</a></span></span><span class='period'>.</span><span class='id identifier rubyid_find'><span class='object_link'><a href="Basecamp3/Todo.html#find-class_method" title="Basecamp3::Todo.find (method)">find</a></span></span><span class='lparen'>(</span><span class='const'>BUCKET_ID</span><span class='comma'>,</span> <span class='const'>TODO_ID</span><span class='rparen'>)</span>
99
+ <span class='id identifier rubyid_todo'>todo</span><span class='period'>.</span><span class='id identifier rubyid_content'>content</span> <span class='comment'># = &#39;Hello world!&#39;
100
+ </span></code></pre>
101
+
102
+ <h2 id="label-Documentation">Documentation</h2>
103
+
104
+ <p>For the full documentation go <a
105
+ href="https://miastologia.github.io/basecamp3-api-wrapper/">here</a>.</p>
106
+
107
+ <h2 id="label-TODO">TODO</h2>
108
+
109
+ <h3 id="label-Missing+models">Missing models</h3>
110
+ <ul><li>
111
+ <p>Attachments</p>
112
+ </li><li>
113
+ <p>Chatbots</p>
114
+ </li><li>
115
+ <p>Client approvals</p>
116
+ </li><li>
117
+ <p>Client correspondences</p>
118
+ </li><li>
119
+ <p>Client replies</p>
120
+ </li><li>
121
+ <p>Events</p>
122
+ </li><li>
123
+ <p>Recordings</p>
124
+ </li><li>
125
+ <p>Templates</p>
126
+ </li><li>
127
+ <p>Uploads</p>
128
+ </li><li>
129
+ <p>Webhooks</p>
130
+ </li></ul>
131
+
132
+ <h3 id="label-Other">Other</h3>
133
+ <ul><li>
134
+ <p>updating Basecamp data directly from a model instance (something like
135
+ <code>save</code> method)</p>
136
+ </li></ul>
137
+
138
+ <h2 id="label-Contributing">Contributing</h2>
139
+
140
+ <p>Bug reports and pull requests are welcome on GitHub at <a
141
+ href="https://github.com/miastologia/basecamp3-api-wrapper">github.com/miastologia/basecamp3-api-wrapper</a>.</p>
142
+
143
+ <h2 id="label-License">License</h2>
144
+
145
+ <p>The gem is available as open source under the terms of the <a
146
+ href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
147
+ </div></div>
148
+
149
+ <div id="footer">
150
+ Generated on Tue May 9 15:32:16 2017 by
151
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
152
+ 0.9.9 (ruby-2.2.2).
153
+ </div>
154
+
155
+ </div>
156
+ </body>
157
+ </html>
data/docs/file_list.html ADDED
@@ -0,0 +1,56 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
5
+ <meta charset="utf-8" />
6
+
7
+ <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
8
+
9
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
10
+
11
+
12
+
13
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
16
+
17
+
18
+ <title>File List</title>
19
+ <base id="base_target" target="_parent" />
20
+ </head>
21
+ <body>
22
+ <div id="content">
23
+ <div class="fixed_header">
24
+ <h1 id="full_list_header">File List</h1>
25
+ <div id="full_list_nav">
26
+
27
+ <span><a target="_self" href="class_list.html">
28
+ Classes
29
+ </a></span>
30
+
31
+ <span><a target="_self" href="method_list.html">
32
+ Methods
33
+ </a></span>
34
+
35
+ <span><a target="_self" href="file_list.html">
36
+ Files
37
+ </a></span>
38
+
39
+ </div>
40
+
41
+ <div id="search">Search: <input type="text" /></div>
42
+ </div>
43
+
44
+ <ul id="full_list" class="file">
45
+
46
+
47
+ <li id="object_README" class="odd">
48
+ <div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
49
+ </li>
50
+
51
+
52
+
53
+ </ul>
54
+ </div>
55
+ </body>
56
+ </html>
data/docs/frames.html ADDED
@@ -0,0 +1,17 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>Documentation by YARD 0.9.9</title>
6
+ </head>
7
+ <script type="text/javascript" charset="utf-8">
8
+ var match = unescape(window.location.hash).match(/^#!(.+)/);
9
+ var name = match ? match[1] : 'index.html';
10
+ name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
11
+ window.top.location = name;
12
+ </script>
13
+ <noscript>
14
+ <h1>Oops!</h1>
15
+ <h2>YARD requires JavaScript!</h2>
16
+ </noscript>
17
+ </html>
data/docs/index.html ADDED
@@ -0,0 +1,157 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.9.9
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "README";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index</a> &raquo;
40
+ <span class="title">File: README</span>
41
+
42
+ </div>
43
+
44
+ <div id="search">
45
+
46
+ <a class="full_list_link" id="class_list_link"
47
+ href="class_list.html">
48
+
49
+ <svg width="24" height="24">
50
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
+ </svg>
54
+ </a>
55
+
56
+ </div>
57
+ <div class="clear"></div>
58
+ </div>
59
+
60
+ <div id="content"><div id='filecontents'>
61
+ <h1 id="label-Basecamp3+API+Wrapper">Basecamp3 API Wrapper</h1>
62
+
63
+ <p>A simple Ruby Wrapper for the Basecamp3 API.</p>
64
+
65
+ <p><a href="https://github.com/basecamp/bc3-api">For more information about
66
+ Basecamp3 API, see the official documentation</a></p>
67
+
68
+ <h2 id="label-Installation">Installation</h2>
69
+
70
+ <p>Add this line to your application&#39;s Gemfile:</p>
71
+
72
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>basecamp3</span><span class='tstring_end'>&#39;</span></span>
73
+ </code></pre>
74
+
75
+ <p>And then execute:</p>
76
+
77
+ <pre class="code ruby"><code class="ruby">$ bundle</code></pre>
78
+
79
+ <p>Or install it yourself as:</p>
80
+
81
+ <pre class="code ruby"><code class="ruby">$ gem install basecamp3</code></pre>
82
+
83
+ <h2 id="label-Basic+usage">Basic usage</h2>
84
+
85
+ <p>First, you have to establish a connection to Basecamp3. If you don&#39;t
86
+ know how to get the access token, <a
87
+ href="https://github.com/basecamp/api/blob/master/sections/authentication.md">see
88
+ the official authentication guide</a></p>
89
+
90
+ <pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='period'>.</span><span class='id identifier rubyid_connect'><span class='object_link'><a href="Basecamp3.html#connect-class_method" title="Basecamp3.connect (method)">connect</a></span></span><span class='lparen'>(</span><span class='const'>YOUR_BASECAMP3_ACCOUNT_ID</span><span class='comma'>,</span> <span class='const'>YOUR_BASECAMP3_ACCESS_TOKEN</span><span class='rparen'>)</span>
91
+ </code></pre>
92
+
93
+ <p>That&#39;s all. You can make requests now.</p>
94
+
95
+ <p>E.g.: to get the TODO, just call the <code>find</code> method from the
96
+ <code>Basecamp3::Todo</code> class:</p>
97
+
98
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_todo'>todo</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Basecamp3/Todo.html" title="Basecamp3::Todo (class)">Todo</a></span></span><span class='period'>.</span><span class='id identifier rubyid_find'><span class='object_link'><a href="Basecamp3/Todo.html#find-class_method" title="Basecamp3::Todo.find (method)">find</a></span></span><span class='lparen'>(</span><span class='const'>BUCKET_ID</span><span class='comma'>,</span> <span class='const'>TODO_ID</span><span class='rparen'>)</span>
99
+ <span class='id identifier rubyid_todo'>todo</span><span class='period'>.</span><span class='id identifier rubyid_content'>content</span> <span class='comment'># = &#39;Hello world!&#39;
100
+ </span></code></pre>
101
+
102
+ <h2 id="label-Documentation">Documentation</h2>
103
+
104
+ <p>For the full documentation go <a
105
+ href="https://miastologia.github.io/basecamp3-api-wrapper/">here</a>.</p>
106
+
107
+ <h2 id="label-TODO">TODO</h2>
108
+
109
+ <h3 id="label-Missing+models">Missing models</h3>
110
+ <ul><li>
111
+ <p>Attachments</p>
112
+ </li><li>
113
+ <p>Chatbots</p>
114
+ </li><li>
115
+ <p>Client approvals</p>
116
+ </li><li>
117
+ <p>Client correspondences</p>
118
+ </li><li>
119
+ <p>Client replies</p>
120
+ </li><li>
121
+ <p>Events</p>
122
+ </li><li>
123
+ <p>Recordings</p>
124
+ </li><li>
125
+ <p>Templates</p>
126
+ </li><li>
127
+ <p>Uploads</p>
128
+ </li><li>
129
+ <p>Webhooks</p>
130
+ </li></ul>
131
+
132
+ <h3 id="label-Other">Other</h3>
133
+ <ul><li>
134
+ <p>updating Basecamp data directly from a model instance (something like
135
+ <code>save</code> method)</p>
136
+ </li></ul>
137
+
138
+ <h2 id="label-Contributing">Contributing</h2>
139
+
140
+ <p>Bug reports and pull requests are welcome on GitHub at <a
141
+ href="https://github.com/miastologia/basecamp3-api-wrapper">github.com/miastologia/basecamp3-api-wrapper</a>.</p>
142
+
143
+ <h2 id="label-License">License</h2>
144
+
145
+ <p>The gem is available as open source under the terms of the <a
146
+ href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
147
+ </div></div>
148
+
149
+ <div id="footer">
150
+ Generated on Tue May 9 15:32:16 2017 by
151
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
152
+ 0.9.9 (ruby-2.2.2).
153
+ </div>
154
+
155
+ </div>
156
+ </body>
157
+ </html>
data/docs/js/app.js ADDED
@@ -0,0 +1,248 @@
1
+ (function() {
2
+
3
+ var localStorage = {}, sessionStorage = {};
4
+ try { localStorage = window.localStorage; } catch (e) { }
5
+ try { sessionStorage = window.sessionStorage; } catch (e) { }
6
+
7
+ function createSourceLinks() {
8
+ $('.method_details_list .source_code').
9
+ before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
10
+ $('.toggleSource').toggle(function() {
11
+ $(this).parent().nextAll('.source_code').slideDown(100);
12
+ $(this).text("Hide source");
13
+ },
14
+ function() {
15
+ $(this).parent().nextAll('.source_code').slideUp(100);
16
+ $(this).text("View source");
17
+ });
18
+ }
19
+
20
+ function createDefineLinks() {
21
+ var tHeight = 0;
22
+ $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
23
+ $('.toggleDefines').toggle(function() {
24
+ tHeight = $(this).parent().prev().height();
25
+ $(this).prev().css('display', 'inline');
26
+ $(this).parent().prev().height($(this).parent().height());
27
+ $(this).text("(less)");
28
+ },
29
+ function() {
30
+ $(this).prev().hide();
31
+ $(this).parent().prev().height(tHeight);
32
+ $(this).text("more...");
33
+ });
34
+ }
35
+
36
+ function createFullTreeLinks() {
37
+ var tHeight = 0;
38
+ $('.inheritanceTree').toggle(function() {
39
+ tHeight = $(this).parent().prev().height();
40
+ $(this).parent().toggleClass('showAll');
41
+ $(this).text("(hide)");
42
+ $(this).parent().prev().height($(this).parent().height());
43
+ },
44
+ function() {
45
+ $(this).parent().toggleClass('showAll');
46
+ $(this).parent().prev().height(tHeight);
47
+ $(this).text("show all");
48
+ });
49
+ }
50
+
51
+ function searchFrameButtons() {
52
+ $('.full_list_link').click(function() {
53
+ toggleSearchFrame(this, $(this).attr('href'));
54
+ return false;
55
+ });
56
+ window.addEventListener('message', function(e) {
57
+ if (e.data === 'navEscape') {
58
+ $('#nav').slideUp(100);
59
+ $('#search a').removeClass('active inactive');
60
+ $(window).focus();
61
+ }
62
+ });
63
+
64
+ $(window).resize(function() {
65
+ if ($('#search:visible').length === 0) {
66
+ $('#nav').removeAttr('style');
67
+ $('#search a').removeClass('active inactive');
68
+ $(window).focus();
69
+ }
70
+ });
71
+ }
72
+
73
+ function toggleSearchFrame(id, link) {
74
+ var frame = $('#nav');
75
+ $('#search a').removeClass('active').addClass('inactive');
76
+ if (frame.attr('src') === link && frame.css('display') !== "none") {
77
+ frame.slideUp(100);
78
+ $('#search a').removeClass('active inactive');
79
+ }
80
+ else {
81
+ $(id).addClass('active').removeClass('inactive');
82
+ if (frame.attr('src') !== link) frame.attr('src', link);
83
+ frame.slideDown(100);
84
+ }
85
+ }
86
+
87
+ function linkSummaries() {
88
+ $('.summary_signature').click(function() {
89
+ document.location = $(this).find('a').attr('href');
90
+ });
91
+ }
92
+
93
+ function summaryToggle() {
94
+ $('.summary_toggle').click(function(e) {
95
+ e.preventDefault();
96
+ localStorage.summaryCollapsed = $(this).text();
97
+ $('.summary_toggle').each(function() {
98
+ $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
99
+ var next = $(this).parent().parent().nextAll('ul.summary').first();
100
+ if (next.hasClass('compact')) {
101
+ next.toggle();
102
+ next.nextAll('ul.summary').first().toggle();
103
+ }
104
+ else if (next.hasClass('summary')) {
105
+ var list = $('<ul class="summary compact" />');
106
+ list.html(next.html());
107
+ list.find('.summary_desc, .note').remove();
108
+ list.find('a').each(function() {
109
+ $(this).html($(this).find('strong').html());
110
+ $(this).parent().html($(this)[0].outerHTML);
111
+ });
112
+ next.before(list);
113
+ next.toggle();
114
+ }
115
+ });
116
+ return false;
117
+ });
118
+ if (localStorage.summaryCollapsed == "collapse") {
119
+ $('.summary_toggle').first().click();
120
+ } else { localStorage.summaryCollapsed = "expand"; }
121
+ }
122
+
123
+ function generateTOC() {
124
+ if ($('#filecontents').length === 0) return;
125
+ var _toc = $('<ol class="top"></ol>');
126
+ var show = false;
127
+ var toc = _toc;
128
+ var counter = 0;
129
+ var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
130
+ var i;
131
+ if ($('#filecontents h1').length > 1) tags.unshift('h1');
132
+ for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
133
+ var lastTag = parseInt(tags[0][1], 10);
134
+ $(tags.join(', ')).each(function() {
135
+ if ($(this).parents('.method_details .docstring').length != 0) return;
136
+ if (this.id == "filecontents") return;
137
+ show = true;
138
+ var thisTag = parseInt(this.tagName[1], 10);
139
+ if (this.id.length === 0) {
140
+ var proposedId = $(this).attr('toc-id');
141
+ if (typeof(proposedId) != "undefined") this.id = proposedId;
142
+ else {
143
+ var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
144
+ if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
145
+ this.id = proposedId;
146
+ }
147
+ }
148
+ if (thisTag > lastTag) {
149
+ for (i = 0; i < thisTag - lastTag; i++) {
150
+ var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
151
+ }
152
+ }
153
+ if (thisTag < lastTag) {
154
+ for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
155
+ }
156
+ var title = $(this).attr('toc-title');
157
+ if (typeof(title) == "undefined") title = $(this).text();
158
+ toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
159
+ lastTag = thisTag;
160
+ });
161
+ if (!show) return;
162
+ html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
163
+ $('#content').prepend(html);
164
+ $('#toc').append(_toc);
165
+ $('#toc .hide_toc').toggle(function() {
166
+ $('#toc .top').slideUp('fast');
167
+ $('#toc').toggleClass('hidden');
168
+ $('#toc .title small').toggle();
169
+ }, function() {
170
+ $('#toc .top').slideDown('fast');
171
+ $('#toc').toggleClass('hidden');
172
+ $('#toc .title small').toggle();
173
+ });
174
+ }
175
+
176
+ function navResizeFn(e) {
177
+ if (e.which !== 1) {
178
+ navResizeFnStop();
179
+ return;
180
+ }
181
+
182
+ sessionStorage.navWidth = e.pageX.toString();
183
+ $('.nav_wrap').css('width', e.pageX);
184
+ $('.nav_wrap').css('-ms-flex', 'inherit');
185
+ }
186
+
187
+ function navResizeFnStop() {
188
+ $(window).unbind('mousemove', navResizeFn);
189
+ window.removeEventListener('message', navMessageFn, false);
190
+ }
191
+
192
+ function navMessageFn(e) {
193
+ if (e.data.action === 'mousemove') navResizeFn(e.data.event);
194
+ if (e.data.action === 'mouseup') navResizeFnStop();
195
+ }
196
+
197
+ function navResizer() {
198
+ $('#resizer').mousedown(function(e) {
199
+ e.preventDefault();
200
+ $(window).mousemove(navResizeFn);
201
+ window.addEventListener('message', navMessageFn, false);
202
+ });
203
+ $(window).mouseup(navResizeFnStop);
204
+
205
+ if (sessionStorage.navWidth) {
206
+ navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
207
+ }
208
+ }
209
+
210
+ function navExpander() {
211
+ var done = false, timer = setTimeout(postMessage, 500);
212
+ function postMessage() {
213
+ if (done) return;
214
+ clearTimeout(timer);
215
+ var opts = { action: 'expand', path: pathId };
216
+ document.getElementById('nav').contentWindow.postMessage(opts, '*');
217
+ done = true;
218
+ }
219
+
220
+ window.addEventListener('message', function(event) {
221
+ if (event.data === 'navReady') postMessage();
222
+ return false;
223
+ }, false);
224
+ }
225
+
226
+ function mainFocus() {
227
+ var hash = window.location.hash;
228
+ if (hash !== '' && $(hash)[0]) {
229
+ $(hash)[0].scrollIntoView();
230
+ }
231
+
232
+ setTimeout(function() { $('#main').focus(); }, 10);
233
+ }
234
+
235
+ $(document).ready(function() {
236
+ navResizer();
237
+ navExpander();
238
+ createSourceLinks();
239
+ createDefineLinks();
240
+ createFullTreeLinks();
241
+ searchFrameButtons();
242
+ linkSummaries();
243
+ summaryToggle();
244
+ generateTOC();
245
+ mainFocus();
246
+ });
247
+
248
+ })();