beanstalkapp 1.2.0 → 1.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (110) hide show
  1. data/CHANGES.rdoc +4 -0
  2. data/VERSION +1 -1
  3. data/beanstalkapp.gemspec +106 -2
  4. data/doc/account.html +192 -0
  5. data/doc/changelog.html +150 -0
  6. data/doc/changeset.html +256 -0
  7. data/doc/comment.html +299 -0
  8. data/doc/files/javascripts/code-highlighter.js +190 -0
  9. data/doc/files/javascripts/global.js +67 -0
  10. data/doc/files/javascripts/mootools-1.2.4-core-yc.js +357 -0
  11. data/doc/files/stylesheets/global.css +2152 -0
  12. data/doc/files/stylesheets/ie7.css +85 -0
  13. data/doc/images/apple-touch-icon.png +0 -0
  14. data/doc/images/b-search.gif +0 -0
  15. data/doc/images/b-submit.gif +0 -0
  16. data/doc/images/b-tour.png +0 -0
  17. data/doc/images/bg-comments-count.png +0 -0
  18. data/doc/images/bg-corners.png +0 -0
  19. data/doc/images/bg-header-pattern-alt.png +0 -0
  20. data/doc/images/bg-header-pattern.png +0 -0
  21. data/doc/images/bg-header.png +0 -0
  22. data/doc/images/bg-input.png +0 -0
  23. data/doc/images/bg-page-pattern-alt.png +0 -0
  24. data/doc/images/bg-page-pattern.png +0 -0
  25. data/doc/images/bg-plans.png +0 -0
  26. data/doc/images/bg-ref-basecamp.gif +0 -0
  27. data/doc/images/bg-ref-lighthouse.gif +0 -0
  28. data/doc/images/bg-ref-rackspace.gif +0 -0
  29. data/doc/images/bg-ref-versions.gif +0 -0
  30. data/doc/images/bg-referrer.png +0 -0
  31. data/doc/images/bg-screenshot.png +0 -0
  32. data/doc/images/bg-tooltip.png +0 -0
  33. data/doc/images/button.png +0 -0
  34. data/doc/images/customers/blueflavor.png +0 -0
  35. data/doc/images/customers/brightcove.png +0 -0
  36. data/doc/images/customers/flipshake-s.png +0 -0
  37. data/doc/images/customers/flipshake.png +0 -0
  38. data/doc/images/customers/helloenjoy-s.png +0 -0
  39. data/doc/images/customers/helloenjoy.png +0 -0
  40. data/doc/images/customers/netmagazine.jpg +0 -0
  41. data/doc/images/customers/newrelic.png +0 -0
  42. data/doc/images/customers/puma.png +0 -0
  43. data/doc/images/customers/realmac-s.png +0 -0
  44. data/doc/images/customers/realmac.png +0 -0
  45. data/doc/images/customers/scrapblog.png +0 -0
  46. data/doc/images/customers/store74.gif +0 -0
  47. data/doc/images/customers/theappleblog.jpg +0 -0
  48. data/doc/images/customers/tuaw.jpg +0 -0
  49. data/doc/images/customers/vzaar-s.png +0 -0
  50. data/doc/images/customers/vzaar.png +0 -0
  51. data/doc/images/customers/wufoo-s.png +0 -0
  52. data/doc/images/customers/wufoo.png +0 -0
  53. data/doc/images/favicon.ico +0 -0
  54. data/doc/images/i-arrow.png +0 -0
  55. data/doc/images/i-cc.png +0 -0
  56. data/doc/images/i-checkmark.png +0 -0
  57. data/doc/images/i-features.png +0 -0
  58. data/doc/images/i-help.png +0 -0
  59. data/doc/images/i-input-email.png +0 -0
  60. data/doc/images/i-input-password.png +0 -0
  61. data/doc/images/i-leaf.png +0 -0
  62. data/doc/images/i-lock-sml.png +0 -0
  63. data/doc/images/i-rss.png +0 -0
  64. data/doc/images/i-tour-help.png +0 -0
  65. data/doc/images/logo-rackspace.gif +0 -0
  66. data/doc/images/logo-sml.png +0 -0
  67. data/doc/images/logo-wildbit.png +0 -0
  68. data/doc/images/logo.png +0 -0
  69. data/doc/images/logos/basecamp-ref.png +0 -0
  70. data/doc/images/logos/basecamp.png +0 -0
  71. data/doc/images/logos/campfire.png +0 -0
  72. data/doc/images/logos/cloudscaling.png +0 -0
  73. data/doc/images/logos/collabnet.gif +0 -0
  74. data/doc/images/logos/dynect.png +0 -0
  75. data/doc/images/logos/fogbugz.png +0 -0
  76. data/doc/images/logos/freckle.png +0 -0
  77. data/doc/images/logos/harvest-ref.gif +0 -0
  78. data/doc/images/logos/harvest.png +0 -0
  79. data/doc/images/logos/lighthouse-ref.png +0 -0
  80. data/doc/images/logos/lighthouse.png +0 -0
  81. data/doc/images/logos/pixelnovel.png +0 -0
  82. data/doc/images/logos/rackspace-ref.gif +0 -0
  83. data/doc/images/logos/rackspace.gif +0 -0
  84. data/doc/images/logos/rackspace.png +0 -0
  85. data/doc/images/logos/splunk-s.png +0 -0
  86. data/doc/images/logos/splunk.png +0 -0
  87. data/doc/images/logos/teamsupport.png +0 -0
  88. data/doc/images/logos/twitter.png +0 -0
  89. data/doc/images/logos/versions-ref.gif +0 -0
  90. data/doc/images/logos/versions.png +0 -0
  91. data/doc/images/promo-screenshots.png +0 -0
  92. data/doc/images/sep-promo.png +0 -0
  93. data/doc/images/ss-browse.png +0 -0
  94. data/doc/images/ss-changeset.png +0 -0
  95. data/doc/images/ss-dashboard.png +0 -0
  96. data/doc/images/ss-integrations.png +0 -0
  97. data/doc/images/ss-releases.png +0 -0
  98. data/doc/images/ss-repositories.png +0 -0
  99. data/doc/images/ss-signup-motivator.jpg +0 -0
  100. data/doc/introduction.html +152 -0
  101. data/doc/rails_plugin.html +141 -0
  102. data/doc/release.html +282 -0
  103. data/doc/release_server.html +340 -0
  104. data/doc/repository.html +326 -0
  105. data/doc/ruby_gem.html +160 -0
  106. data/doc/server_environment.html +270 -0
  107. data/doc/user.html +210 -0
  108. data/lib/beanstalkapp/release.rb +6 -2
  109. data/test/integration.rb +11 -3
  110. metadata +106 -2
@@ -0,0 +1,326 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html lang="en">
4
+ <head>
5
+ <meta charset="utf-8">
6
+ <title>Beanstalk &mdash; Hassle-free Subversion Hosting</title>
7
+ <meta name="description" content="Beanstalk allows designers and developers to store source code, track changes, and collaborate with their team.">
8
+ <meta name="author" content="Wildbit, LLC">
9
+ <meta name="viewport" content="width=980">
10
+
11
+ <!--[if IE]>
12
+ <script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13
+ <![endif]-->
14
+
15
+ <link rel="stylesheet" href="files/stylesheets/global.css" media="all">
16
+
17
+ <!--[if IE 7]>
18
+ <link rel="stylesheet" href="files/stylesheets/ie7.css" media="all">
19
+ <![endif]-->
20
+
21
+ <script type="text/javascript" src="files/javascripts/mootools-1.2.4-core-yc.js"></script>
22
+ <script type="text/javascript" src="files/javascripts/code-highlighter.js"></script>
23
+ <script type="text/javascript" src="files/javascripts/global.js"></script>
24
+
25
+ <link rel="shortcut icon" href="images/favicon.ico">
26
+ <link rel="apple-touch-icon" href="images/apple-touch-icon.png">
27
+ </head>
28
+
29
+ <body>
30
+ <header>
31
+ <div class="container">
32
+
33
+ <hgroup>
34
+ <h1><a href="http://beanstalkapp.com">Beanstalk</a></h1>
35
+ <h2><a href="http://beanstalkapp.com">Version Control with a Human Face</a></h2>
36
+ </hgroup>
37
+
38
+ <nav>
39
+ <ul>
40
+ <li><a href="http://beanstalkapp.com">Home</a></li>
41
+ <li><a href="http://beanstalkapp.com/features">Feature Tour</a></li>
42
+ <li><a href="http://beanstalkapp.com/buzz">Buzz</a></li>
43
+ <li><a href="http://help.beanstalkapp.com/">Support</a></li>
44
+ <li><a href="http://beanstalkapp.com/partners">Partners</a></li>
45
+ <li><a href="http://blog.beanstalkapp.com">Blog</a></li>
46
+ <li><strong>API &amp; Tools</strong></li>
47
+ <li class="link-signin"><a href="https://login.beanstalkapp.com">Log In</a></li>
48
+ <li class="link-signup"><a href="http://beanstalkapp.com/pricing">Pricing &amp; Sign Up</a></li>
49
+ </ul>
50
+ </nav>
51
+
52
+ <b class="cl"></b><b class="cr"></b>
53
+ </div>
54
+ </header>
55
+
56
+ <div class="page" id="api">
57
+ <div class="container">
58
+ <section class="wrap">
59
+ <h1>Repository Model</h1>
60
+ <h3>Writable attributes</h3>
61
+ <ol>
62
+ <li><var>name</var> — required only on create, must be unique;</li>
63
+ <li><var>type_id</var> &#8211; <span class="caps">VCS</span> type: subversion or git. If not present it will default to subversion;</li>
64
+ <li><var>title</var> — required, must be unique;</li>
65
+ <li><var>create_structure</var> — only on create <sup class="footnote" id="fnr1"><a href="#fn1">1</a></sup></li>
66
+ <li><var>color_label</var> <sup class="footnote" id="fnr2"><a href="#fn2">2</a></sup></li>
67
+ </ol>
68
+ <p class="footnote" id="fn1"><a href="#fnr1"><sup>1</sup></a> Works only for Subversion repositories. That boolean flag determines if you want to create &#8220;trunk&#8221;, &#8220;branches&#8221; and &#8220;tags&#8221; directories in your new repository or not. If <var>true</var>, Beanstalk will create those directories as rev. 1 of your repository.</p>
69
+ <p class="footnote" id="fn2"><a href="#fnr2"><sup>2</sup></a> see the list of available color labels at the end of the page.</p>
70
+ <h3>Find all repositories</h3>
71
+ <div class="code_container http-request"><i>http-request</i><code class="http-request"><pre>GET /api/repositories.xml</pre></code></div>
72
+
73
+ <div class="code_container response">
74
+ <p>Click to expand&hellip;</p>
75
+ <i>http-response</i>
76
+ <pre><code>&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
77
+ &lt;repositories type=&quot;array&quot;&gt;
78
+ &lt;repository&gt;
79
+ &lt;account-id type=&quot;integer&quot;&gt;9247&lt;/account-id&gt;
80
+ &lt;anonymous type=&quot;boolean&quot;&gt;false&lt;/anonymous&gt;
81
+ &lt;color-label&gt;label-blue&lt;/color-label&gt;
82
+ &lt;created-at type=&quot;datetime&quot;&gt;
83
+ 2007-06-14T22:15:37Z
84
+ &lt;/created-at&gt;
85
+ &lt;id type=&quot;integer&quot;&gt;82346&lt;/id&gt;
86
+ &lt;type&gt;SubversionRepository&lt;/id&gt;
87
+ &lt;last-commit-at type=&quot;datetime&quot;&gt;
88
+ 2009-11-18T13:21:24Z
89
+ &lt;/last-commit-at&gt;
90
+ &lt;name&gt;ProjectAlpha&lt;/name&gt;
91
+ &lt;revision type=&quot;integer&quot;&gt;36&lt;/revision&gt;
92
+ &lt;storage-used-bytes type=&quot;integer&quot;&gt;
93
+ 151130112
94
+ &lt;/storage-used-bytes&gt;
95
+ &lt;title&gt;Beanstalk&lt;/title&gt;
96
+ &lt;updated-at type=&quot;datetime&quot;&gt;
97
+ 2009-11-18T13:21:42Z
98
+ &lt;/updated-at&gt;
99
+ &lt;/repository&gt;
100
+
101
+ &lt;repository&gt;
102
+ &lt;account-id type=&quot;integer&quot;&gt;7334&lt;/account-id&gt;
103
+ &lt;anonymous type=&quot;boolean&quot;&gt;false&lt;/anonymous&gt;
104
+ &lt;color-label&gt;label-&lt;/color-label&gt;
105
+ &lt;created-at type=&quot;datetime&quot;&gt;
106
+ 2007-07-23T06:59:15Z
107
+ &lt;/created-at&gt;
108
+ &lt;id type=&quot;integer&quot;&gt;63722&lt;/id&gt;
109
+ &lt;type&gt;SubversionRepository&lt;/id&gt;
110
+ &lt;last-commit-at type=&quot;datetime&quot;&gt;
111
+ 2007-07-23T08:11:13Z
112
+ &lt;/last-commit-at&gt;
113
+ &lt;name&gt;mt&lt;/name&gt;
114
+ &lt;revision type=&quot;integer&quot;&gt;2&lt;/revision&gt;
115
+ &lt;storage-used-bytes type=&quot;integer&quot;&gt;
116
+ 180224
117
+ &lt;/storage-used-bytes&gt;
118
+ &lt;title&gt;Super Repository&lt;/title&gt;
119
+ &lt;updated-at type=&quot;datetime&quot;&gt;
120
+ 2009-08-10T06:05:39Z
121
+ &lt;/updated-at&gt;
122
+ &lt;/repository&gt;
123
+ &lt;/repositories&gt;</code></pre>
124
+ </div>
125
+ <div class="code_container ruby"><i>ruby</i><code class="ruby"><pre>Beanstalk::API::Repository.find(:all)</pre></code></div>
126
+ <h3>Find a single repository by ID</h3>
127
+ <div class="code_container http-request"><i>http-request</i><code class="http-request"><pre>GET /api/repositories/58.xml</pre></code></div>
128
+
129
+ <div class="code_container response">
130
+ <p>Click to expand&hellip;</p>
131
+ <i>http-response</i>
132
+ <pre><code>&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
133
+ &lt;repository&gt;
134
+ &lt;account-id type=&quot;integer&quot;&gt;9247&lt;/account-id&gt;
135
+ &lt;anonymous type=&quot;boolean&quot;&gt;false&lt;/anonymous&gt;
136
+ &lt;color-label&gt;label-blue&lt;/color-label&gt;
137
+ &lt;created-at type=&quot;datetime&quot;&gt;
138
+ 2007-06-14T22:15:37Z
139
+ &lt;/created-at&gt;
140
+ &lt;id type=&quot;integer&quot;&gt;82346&lt;/id&gt;
141
+ &lt;type&gt;SubversionRepository&lt;/id&gt;
142
+ &lt;last-commit-at type=&quot;datetime&quot;&gt;
143
+ 2009-11-18T13:21:24Z
144
+ &lt;/last-commit-at&gt;
145
+ &lt;name&gt;ProjectAlpha&lt;/name&gt;
146
+ &lt;revision type=&quot;integer&quot;&gt;36&lt;/revision&gt;
147
+ &lt;storage-used-bytes type=&quot;integer&quot;&gt;
148
+ 151130112
149
+ &lt;/storage-used-bytes&gt;
150
+ &lt;title&gt;Beanstalk&lt;/title&gt;
151
+ &lt;updated-at type=&quot;datetime&quot;&gt;
152
+ 2009-11-18T13:21:42Z
153
+ &lt;/updated-at&gt;
154
+ &lt;/repository&gt;</code></pre>
155
+ </div>
156
+ <div class="code_container ruby"><i>ruby</i><code class="ruby"><pre>Beanstalk::API::Repository.find(58)</pre></code></div>
157
+ <h3>Create new repository</h3>
158
+ <p>See a list of writable attributes at the top of the page.</p>
159
+ <div class="code_container http-request"><i>http-request</i><code class="http-request"><pre>POST /api/repositories.xml
160
+ &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
161
+ &lt;repository&gt;
162
+ &lt;name&gt;shiny_new_repo&lt;/name&gt;
163
+ &lt;title&gt;Bubblegum&lt;/title&gt;
164
+ &lt;/repository&gt;
165
+ </pre></code></div>
166
+ <div class="code_container response">
167
+ <p>Click to expand&hellip;</p>
168
+ <i>http-response</i>
169
+ <pre><code>&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
170
+ &lt;repository&gt;
171
+ &lt;account-id type=&quot;integer&quot;&gt;9247&lt;/account-id&gt;
172
+ &lt;anonymous type=&quot;boolean&quot;&gt;false&lt;/anonymous&gt;
173
+ &lt;color-label&gt;label-blue&lt;/color-label&gt;
174
+ &lt;created-at type=&quot;datetime&quot;&gt;
175
+ 2007-06-14T22:15:37Z
176
+ &lt;/created-at&gt;
177
+ &lt;id type=&quot;integer&quot;&gt;82346&lt;/id&gt;
178
+ &lt;type&gt;SubversionRepository&lt;/id&gt;
179
+ &lt;last-commit-at type=&quot;datetime&quot;&gt;
180
+ 2009-11-18T13:21:24Z
181
+ &lt;/last-commit-at&gt;
182
+ &lt;name&gt;ProjectAlpha&lt;/name&gt;
183
+ &lt;revision type=&quot;integer&quot;&gt;36&lt;/revision&gt;
184
+ &lt;storage-used-bytes type=&quot;integer&quot;&gt;
185
+ 151130112
186
+ &lt;/storage-used-bytes&gt;
187
+ &lt;title&gt;Beanstalk&lt;/title&gt;
188
+ &lt;updated-at type=&quot;datetime&quot;&gt;
189
+ 2009-11-18T13:21:42Z
190
+ &lt;/updated-at&gt;
191
+ &lt;/repository&gt;
192
+
193
+ --OR IF INVALID--
194
+
195
+ &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
196
+ &lt;errors&gt;
197
+ &lt;error&gt;Name can't be blank&lt;/error&gt;
198
+ &lt;/errors&gt;</code></pre>
199
+ </div>
200
+ <div class="code_container ruby"><i>ruby</i><code class="ruby"><pre>Beanstalk::API::Repository.create(
201
+ :name =&gt; &quot;repo_name&quot;,
202
+ :title =&gt; &quot;Repo Name&quot;
203
+ )
204
+ </pre></code></div>
205
+ <h3>Update existing repository</h3>
206
+ <p>See a list of writable attributes at the top of the page. You only need to pass the attributes that you want to change.</p>
207
+ <div class="code_container http-request"><i>http-request</i><code class="http-request"><pre>PUT /api/repositories/58.xml
208
+ &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
209
+ &lt;repository&gt;
210
+ &lt;name&gt;bahroma_tunec&lt;/name&gt;
211
+ &lt;title&gt;bla&lt;/title&gt;
212
+ &lt;color_label&gt;label-red&lt;/color_label&gt;
213
+ &lt;/repository&gt;
214
+ </pre></code></div>
215
+ <div class="code_container response">
216
+ <p>Click to expand&hellip;</p>
217
+ <i>http-response</i>
218
+ <pre><code>HEAD 200 OK
219
+
220
+ --OR IF INVALID--
221
+
222
+ &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
223
+ &lt;errors&gt;
224
+ &lt;error&gt;Name can't be blank&lt;/error&gt;
225
+ &lt;/errors&gt;</code></pre>
226
+ </div>
227
+ <p>Or using the ruby lib:</p>
228
+ <div class="code_container ruby"><i>ruby</i><code class="ruby"><pre>repo = Beanstalk::API::Repository.find(58)
229
+ repo.title = &quot;New Neat Title&quot;
230
+ repo.save
231
+ </pre></code></div>
232
+ <h3>Color labels</h3>
233
+ <ol>
234
+ <li><var>label-red</var></li>
235
+ <li><var>label-orange</var></li>
236
+ <li><var>label-yellow</var></li>
237
+ <li><var>label-green</var></li>
238
+ <li><var>label-blue</var></li>
239
+ <li><var>label-pink</var></li>
240
+ <li><var>label-grey</var></li>
241
+ </ol>
242
+ <h3>To be implemented</h3>
243
+ <ol>
244
+ <li>Import repository from dump / working copy / etc.</li>
245
+ </ol>
246
+ </section>
247
+
248
+ <section id="sidebar">
249
+ <ul class="tabs">
250
+ <li>
251
+
252
+ <a href="introduction.html">Introduction</a>
253
+ </li>
254
+ <li>
255
+
256
+ <a href="changelog.html">Changelog</a>
257
+ </li>
258
+ <li>
259
+
260
+ <a href="ruby_gem.html">Ruby Gem</a>
261
+ </li>
262
+ <li>
263
+
264
+ <a href="account.html">Account</a>
265
+ </li>
266
+ <li>
267
+
268
+ <a href="user.html">User</a>
269
+ </li>
270
+ <li>
271
+
272
+ <strong>&rarr; Repository</strong>
273
+ </li>
274
+ <li>
275
+
276
+ <a href="changeset.html">Changeset</a>
277
+ </li>
278
+ <li>
279
+
280
+ <a href="comment.html">Comment</a>
281
+ </li>
282
+ <li>
283
+
284
+ <a href="server_environment.html">Server Environment</a>
285
+ </li>
286
+ <li>
287
+
288
+ <a href="release_server.html">Release Server</a>
289
+ </li>
290
+ <li>
291
+
292
+ <a href="release.html">Release</a>
293
+ </li>
294
+ </ul>
295
+ </section>
296
+ </div>
297
+ </div>
298
+
299
+ <footer>
300
+
301
+ <div class="container">
302
+ <ul>
303
+ <li><a href="http://help.beanstalkapp.com/discussion/new">Contact</a></li>
304
+ <li><a href="http://blog.beanstalkapp.com">Blog</a></li>
305
+ <li><a href="http://twitter.com/beanstalkapp">Twitter</a></li>
306
+ <li><a href="http://beanstalkapp.com/security">Security</a></li>
307
+ <li><a href="http://beanstalkapp.com/privacy-policy">Privacy Policy</a></li>
308
+ <li><a href="http://beanstalkapp.com/terms-of-service">Terms of Service</a></li>
309
+ </ul>
310
+ <p>&copy; <a href="http://wildbit.com/">Wildbit, <abbr>LLC</abbr></a>, 2010. All rights reserved. The Beanstalk logo and name are trademarks of Wildbit, <abbr>LLC</abbr>.</p>
311
+ </div>
312
+
313
+ </footer>
314
+
315
+ <script type="text/javascript">
316
+ var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
317
+ document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
318
+ </script>
319
+ <script type="text/javascript">
320
+ try {
321
+ var pageTracker = _gat._getTracker("UA-507677-5");
322
+ pageTracker._setDomainName(".beanstalkapp.com");
323
+ pageTracker._trackPageview();
324
+ } catch(err) {}</script>
325
+ </body>
326
+ </html>
@@ -0,0 +1,160 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html lang="en">
4
+ <head>
5
+ <meta charset="utf-8">
6
+ <title>Beanstalk &mdash; Hassle-free Subversion Hosting</title>
7
+ <meta name="description" content="Beanstalk allows designers and developers to store source code, track changes, and collaborate with their team.">
8
+ <meta name="author" content="Wildbit, LLC">
9
+ <meta name="viewport" content="width=980">
10
+
11
+ <!--[if IE]>
12
+ <script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13
+ <![endif]-->
14
+
15
+ <link rel="stylesheet" href="files/stylesheets/global.css" media="all">
16
+
17
+ <!--[if IE 7]>
18
+ <link rel="stylesheet" href="files/stylesheets/ie7.css" media="all">
19
+ <![endif]-->
20
+
21
+ <script type="text/javascript" src="files/javascripts/mootools-1.2.4-core-yc.js"></script>
22
+ <script type="text/javascript" src="files/javascripts/code-highlighter.js"></script>
23
+ <script type="text/javascript" src="files/javascripts/global.js"></script>
24
+
25
+ <link rel="shortcut icon" href="images/favicon.ico">
26
+ <link rel="apple-touch-icon" href="images/apple-touch-icon.png">
27
+ </head>
28
+
29
+ <body>
30
+ <header>
31
+ <div class="container">
32
+
33
+ <hgroup>
34
+ <h1><a href="http://beanstalkapp.com">Beanstalk</a></h1>
35
+ <h2><a href="http://beanstalkapp.com">Version Control with a Human Face</a></h2>
36
+ </hgroup>
37
+
38
+ <nav>
39
+ <ul>
40
+ <li><a href="http://beanstalkapp.com">Home</a></li>
41
+ <li><a href="http://beanstalkapp.com/features">Feature Tour</a></li>
42
+ <li><a href="http://beanstalkapp.com/buzz">Buzz</a></li>
43
+ <li><a href="http://help.beanstalkapp.com/">Support</a></li>
44
+ <li><a href="http://beanstalkapp.com/partners">Partners</a></li>
45
+ <li><a href="http://blog.beanstalkapp.com">Blog</a></li>
46
+ <li><strong>API &amp; Tools</strong></li>
47
+ <li class="link-signin"><a href="https://login.beanstalkapp.com">Log In</a></li>
48
+ <li class="link-signup"><a href="http://beanstalkapp.com/pricing">Pricing &amp; Sign Up</a></li>
49
+ </ul>
50
+ </nav>
51
+
52
+ <b class="cl"></b><b class="cr"></b>
53
+ </div>
54
+ </header>
55
+
56
+ <div class="page" id="api">
57
+ <div class="container">
58
+ <section class="wrap">
59
+ <h1>Ruby Gem</h1>
60
+ <p>We created a set of <tt>ActiveResource</tt> wrappers to make your work with the Beanstalk <span class="caps">API</span> a bit easier.</p>
61
+ <h3>Installation</h3>
62
+ <p>First enable <span class="caps">API</span> access in your account settings. Only account owner can do that.</p>
63
+ <p>Then install Beanstalk gem on your machine:</p>
64
+ <div class="code_container shell"><i>shell</i><code class="shell"><pre>gem install beanstalkapp</pre></code></div>
65
+ <h3>Usage</h3>
66
+ <p>Here&#8217;s a quick example on how to get started with the gem right away:</p>
67
+ <div class="code_container ruby"><i>ruby</i><code class="ruby"><pre>
68
+ require 'rubygems'
69
+ require 'beanstalkapp'
70
+
71
+ Beanstalk::API::Base.setup(
72
+ :domain =&gt; &quot;your_beanstalk_account_subdomain&quot;,
73
+ :login =&gt; &quot;login&quot;,
74
+ :password =&gt; &quot;password&quot;
75
+ )
76
+
77
+ Beanstalk::API::Account.find
78
+ </pre></code></div>
79
+ <p>You can get the source code of the gem <a href="http://github.com/iSabanin/beanstalkapp">on our Github account</a>.</p>
80
+ </section>
81
+
82
+ <section id="sidebar">
83
+ <ul class="tabs">
84
+ <li>
85
+
86
+ <a href="introduction.html">Introduction</a>
87
+ </li>
88
+ <li>
89
+
90
+ <a href="changelog.html">Changelog</a>
91
+ </li>
92
+ <li>
93
+
94
+ <strong>&rarr; Ruby Gem</strong>
95
+ </li>
96
+ <li>
97
+
98
+ <a href="account.html">Account</a>
99
+ </li>
100
+ <li>
101
+
102
+ <a href="user.html">User</a>
103
+ </li>
104
+ <li>
105
+
106
+ <a href="repository.html">Repository</a>
107
+ </li>
108
+ <li>
109
+
110
+ <a href="changeset.html">Changeset</a>
111
+ </li>
112
+ <li>
113
+
114
+ <a href="comment.html">Comment</a>
115
+ </li>
116
+ <li>
117
+
118
+ <a href="server_environment.html">Server Environment</a>
119
+ </li>
120
+ <li>
121
+
122
+ <a href="release_server.html">Release Server</a>
123
+ </li>
124
+ <li>
125
+
126
+ <a href="release.html">Release</a>
127
+ </li>
128
+ </ul>
129
+ </section>
130
+ </div>
131
+ </div>
132
+
133
+ <footer>
134
+
135
+ <div class="container">
136
+ <ul>
137
+ <li><a href="http://help.beanstalkapp.com/discussion/new">Contact</a></li>
138
+ <li><a href="http://blog.beanstalkapp.com">Blog</a></li>
139
+ <li><a href="http://twitter.com/beanstalkapp">Twitter</a></li>
140
+ <li><a href="http://beanstalkapp.com/security">Security</a></li>
141
+ <li><a href="http://beanstalkapp.com/privacy-policy">Privacy Policy</a></li>
142
+ <li><a href="http://beanstalkapp.com/terms-of-service">Terms of Service</a></li>
143
+ </ul>
144
+ <p>&copy; <a href="http://wildbit.com/">Wildbit, <abbr>LLC</abbr></a>, 2010. All rights reserved. The Beanstalk logo and name are trademarks of Wildbit, <abbr>LLC</abbr>.</p>
145
+ </div>
146
+
147
+ </footer>
148
+
149
+ <script type="text/javascript">
150
+ var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
151
+ document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
152
+ </script>
153
+ <script type="text/javascript">
154
+ try {
155
+ var pageTracker = _gat._getTracker("UA-507677-5");
156
+ pageTracker._setDomainName(".beanstalkapp.com");
157
+ pageTracker._trackPageview();
158
+ } catch(err) {}</script>
159
+ </body>
160
+ </html>