beanstalkappjeroenb 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/CHANGES.rdoc +52 -0
- data/MIT-LICENSE +20 -0
- data/README.rdoc +36 -0
- data/Rakefile +38 -0
- data/VERSION +1 -0
- data/beanstalkappjeroenb.gemspec +160 -0
- data/doc/account.html +192 -0
- data/doc/changelog.html +150 -0
- data/doc/changeset.html +256 -0
- data/doc/comment.html +299 -0
- data/doc/files/javascripts/code-highlighter.js +190 -0
- data/doc/files/javascripts/global.js +67 -0
- data/doc/files/javascripts/mootools-1.2.4-core-yc.js +357 -0
- data/doc/files/stylesheets/global.css +2152 -0
- data/doc/files/stylesheets/ie7.css +85 -0
- data/doc/images/apple-touch-icon.png +0 -0
- data/doc/images/b-search.gif +0 -0
- data/doc/images/b-submit.gif +0 -0
- data/doc/images/b-tour.png +0 -0
- data/doc/images/bg-comments-count.png +0 -0
- data/doc/images/bg-corners.png +0 -0
- data/doc/images/bg-header-pattern-alt.png +0 -0
- data/doc/images/bg-header-pattern.png +0 -0
- data/doc/images/bg-header.png +0 -0
- data/doc/images/bg-input.png +0 -0
- data/doc/images/bg-page-pattern-alt.png +0 -0
- data/doc/images/bg-page-pattern.png +0 -0
- data/doc/images/bg-plans.png +0 -0
- data/doc/images/bg-ref-basecamp.gif +0 -0
- data/doc/images/bg-ref-lighthouse.gif +0 -0
- data/doc/images/bg-ref-rackspace.gif +0 -0
- data/doc/images/bg-ref-versions.gif +0 -0
- data/doc/images/bg-referrer.png +0 -0
- data/doc/images/bg-screenshot.png +0 -0
- data/doc/images/bg-tooltip.png +0 -0
- data/doc/images/button.png +0 -0
- data/doc/images/customers/blueflavor.png +0 -0
- data/doc/images/customers/brightcove.png +0 -0
- data/doc/images/customers/flipshake-s.png +0 -0
- data/doc/images/customers/flipshake.png +0 -0
- data/doc/images/customers/helloenjoy-s.png +0 -0
- data/doc/images/customers/helloenjoy.png +0 -0
- data/doc/images/customers/netmagazine.jpg +0 -0
- data/doc/images/customers/newrelic.png +0 -0
- data/doc/images/customers/puma.png +0 -0
- data/doc/images/customers/realmac-s.png +0 -0
- data/doc/images/customers/realmac.png +0 -0
- data/doc/images/customers/scrapblog.png +0 -0
- data/doc/images/customers/store74.gif +0 -0
- data/doc/images/customers/theappleblog.jpg +0 -0
- data/doc/images/customers/tuaw.jpg +0 -0
- data/doc/images/customers/vzaar-s.png +0 -0
- data/doc/images/customers/vzaar.png +0 -0
- data/doc/images/customers/wufoo-s.png +0 -0
- data/doc/images/customers/wufoo.png +0 -0
- data/doc/images/favicon.ico +0 -0
- data/doc/images/i-arrow.png +0 -0
- data/doc/images/i-cc.png +0 -0
- data/doc/images/i-checkmark.png +0 -0
- data/doc/images/i-features.png +0 -0
- data/doc/images/i-help.png +0 -0
- data/doc/images/i-input-email.png +0 -0
- data/doc/images/i-input-password.png +0 -0
- data/doc/images/i-leaf.png +0 -0
- data/doc/images/i-lock-sml.png +0 -0
- data/doc/images/i-rss.png +0 -0
- data/doc/images/i-tour-help.png +0 -0
- data/doc/images/logo-rackspace.gif +0 -0
- data/doc/images/logo-sml.png +0 -0
- data/doc/images/logo-wildbit.png +0 -0
- data/doc/images/logo.png +0 -0
- data/doc/images/logos/basecamp-ref.png +0 -0
- data/doc/images/logos/basecamp.png +0 -0
- data/doc/images/logos/campfire.png +0 -0
- data/doc/images/logos/cloudscaling.png +0 -0
- data/doc/images/logos/collabnet.gif +0 -0
- data/doc/images/logos/dynect.png +0 -0
- data/doc/images/logos/fogbugz.png +0 -0
- data/doc/images/logos/freckle.png +0 -0
- data/doc/images/logos/harvest-ref.gif +0 -0
- data/doc/images/logos/harvest.png +0 -0
- data/doc/images/logos/lighthouse-ref.png +0 -0
- data/doc/images/logos/lighthouse.png +0 -0
- data/doc/images/logos/pixelnovel.png +0 -0
- data/doc/images/logos/rackspace-ref.gif +0 -0
- data/doc/images/logos/rackspace.gif +0 -0
- data/doc/images/logos/rackspace.png +0 -0
- data/doc/images/logos/splunk-s.png +0 -0
- data/doc/images/logos/splunk.png +0 -0
- data/doc/images/logos/teamsupport.png +0 -0
- data/doc/images/logos/twitter.png +0 -0
- data/doc/images/logos/versions-ref.gif +0 -0
- data/doc/images/logos/versions.png +0 -0
- data/doc/images/promo-screenshots.png +0 -0
- data/doc/images/sep-promo.png +0 -0
- data/doc/images/ss-browse.png +0 -0
- data/doc/images/ss-changeset.png +0 -0
- data/doc/images/ss-dashboard.png +0 -0
- data/doc/images/ss-integrations.png +0 -0
- data/doc/images/ss-releases.png +0 -0
- data/doc/images/ss-repositories.png +0 -0
- data/doc/images/ss-signup-motivator.jpg +0 -0
- data/doc/introduction.html +152 -0
- data/doc/rails_plugin.html +141 -0
- data/doc/release.html +282 -0
- data/doc/release_server.html +340 -0
- data/doc/repository.html +326 -0
- data/doc/ruby_gem.html +160 -0
- data/doc/server_environment.html +270 -0
- data/doc/user.html +210 -0
- data/lib/beanstalkapp.rb +23 -0
- data/lib/beanstalkapp/account.rb +12 -0
- data/lib/beanstalkapp/base.rb +21 -0
- data/lib/beanstalkapp/changeset.rb +51 -0
- data/lib/beanstalkapp/comment.rb +5 -0
- data/lib/beanstalkapp/permission.rb +9 -0
- data/lib/beanstalkapp/plan.rb +4 -0
- data/lib/beanstalkapp/public_key.rb +4 -0
- data/lib/beanstalkapp/release.rb +26 -0
- data/lib/beanstalkapp/release_server.rb +22 -0
- data/lib/beanstalkapp/repository.rb +4 -0
- data/lib/beanstalkapp/server_environment.rb +14 -0
- data/lib/beanstalkapp/user.rb +9 -0
- data/test/integration.rb +96 -0
- metadata +187 -0
|
@@ -0,0 +1,270 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="utf-8">
|
|
6
|
+
<title>Beanstalk — 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 & 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 & 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>Server Environment model</h1>
|
|
60
|
+
<p>Server Environment is a model that represents a group of Release Servers. Previously in Beanstalk all Deployments
|
|
61
|
+
were assigned a Release Server, but now they are assigned a Server Environment. Server Environment can have many Release Servers
|
|
62
|
+
in it.</p>
|
|
63
|
+
<h3>Writable attributes</h3>
|
|
64
|
+
<ol>
|
|
65
|
+
<li><var>name</var> — must be unique in repository, name must be no longer than 20 chars;</li>
|
|
66
|
+
<li><var>automatic</var> — “true” or “false”;</li>
|
|
67
|
+
<li><var>branch_name</var> — for Git repositories it means the branch which this environment will be deploying;</li>
|
|
68
|
+
</ol>
|
|
69
|
+
<h3>Find all Server Environments</h3>
|
|
70
|
+
<p>You need to specify the repository ID. It’s the number 58 in the example below.</p>
|
|
71
|
+
<div class="code_container http-request"><i>http-request</i><code class="http-request"><pre>GET /api/58/server_environments.xml</pre></code></div>
|
|
72
|
+
|
|
73
|
+
<div class="code_container response">
|
|
74
|
+
<p>Click to expand…</p>
|
|
75
|
+
<i>http-response</i>
|
|
76
|
+
<pre><code><?xml version="1.0" encoding="UTF-8"?>
|
|
77
|
+
<server-environments type="array">
|
|
78
|
+
<server-environment>
|
|
79
|
+
<account-id type="integer">4</account-id>
|
|
80
|
+
<automatic type="boolean">true</automatic>
|
|
81
|
+
<branch-name>production</branch-name>
|
|
82
|
+
<created-at type="datetime">2010-07-01T13:58:55+08:00</created-at>
|
|
83
|
+
<current-version>319dded3c14a2f901686b98fc58d5026f102ba65</current-version>
|
|
84
|
+
<id type="integer">6</id>
|
|
85
|
+
<name>Mascarpone</name>
|
|
86
|
+
<repository-id type="integer">58</repository-id>
|
|
87
|
+
<updated-at type="datetime">2010-08-09T11:32:53+08:00</updated-at>
|
|
88
|
+
</server-environment>
|
|
89
|
+
<server-environment>
|
|
90
|
+
<account-id type="integer">4</account-id>
|
|
91
|
+
<automatic type="boolean">true</automatic>
|
|
92
|
+
<branch-name>staging</branch-name>
|
|
93
|
+
<created-at type="datetime">2010-07-01T14:20:37+08:00</created-at>
|
|
94
|
+
<current-version>f17b73d207feb8ec21ad43dc8fafc20e934d7c04</current-version>
|
|
95
|
+
<id type="integer">7</id>
|
|
96
|
+
<name>The Staging</name>
|
|
97
|
+
<repository-id type="integer">58</repository-id>
|
|
98
|
+
<updated-at type="datetime">2010-07-06T19:58:20+08:00</updated-at>
|
|
99
|
+
</server-environment>
|
|
100
|
+
</server-environments></code></pre>
|
|
101
|
+
</div>
|
|
102
|
+
<div class="code_container ruby"><i>ruby</i><code class="ruby"><pre>Beanstalk::API::ServerEnvironment.find_all_for_repository("repo")</pre></code></div>
|
|
103
|
+
<h3>Find a single Server Environment</h3>
|
|
104
|
+
<p>To find an environment use it’s ID. <var>repository_id</var> is required as well. It’s the number 58 in the example below.</p>
|
|
105
|
+
<div class="code_container http-request"><i>http-request</i><code class="http-request"><pre>GET /api/58/server_environments/6.xml</pre></code></div>
|
|
106
|
+
|
|
107
|
+
<div class="code_container response">
|
|
108
|
+
<p>Click to expand…</p>
|
|
109
|
+
<i>http-response</i>
|
|
110
|
+
<pre><code><?xml version="1.0" encoding="UTF-8"?>
|
|
111
|
+
<server-environment>
|
|
112
|
+
<account-id type="integer">4</account-id>
|
|
113
|
+
<automatic type="boolean">true</automatic>
|
|
114
|
+
<branch-name>production</branch-name>
|
|
115
|
+
<created-at type="datetime">2010-07-01T13:58:55+08:00</created-at>
|
|
116
|
+
<current-version>319dded3c14a2f901686b98fc58d5026f102ba65</current-version>
|
|
117
|
+
<id type="integer">6</id>
|
|
118
|
+
<name>Mascarpone</name>
|
|
119
|
+
<repository-id type="integer">58</repository-id>
|
|
120
|
+
<updated-at type="datetime">2010-08-09T11:32:53+08:00</updated-at>
|
|
121
|
+
</server-environment></code></pre>
|
|
122
|
+
</div>
|
|
123
|
+
<div class="code_container ruby"><i>ruby</i><code class="ruby"><pre>Beanstalk::API::ServerEnvironment.find_for_repository(
|
|
124
|
+
6, "repo"
|
|
125
|
+
)</pre></code></div>
|
|
126
|
+
<h3>Create a Server Environment</h3>
|
|
127
|
+
<p>See the list of writable attributes at the top of the page. Only name attribute and branch_name (for Git repos) are required for creation.</p>
|
|
128
|
+
<div class="code_container http-request"><i>http-request</i><code class="http-request"><pre>POST /api/58/server_environments.xml
|
|
129
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
130
|
+
<server-environment>
|
|
131
|
+
<name>The Development</name>
|
|
132
|
+
</server-environment>
|
|
133
|
+
</pre></code></div>
|
|
134
|
+
<div class="code_container response">
|
|
135
|
+
<p>Click to expand…</p>
|
|
136
|
+
<i>http-response</i>
|
|
137
|
+
<pre><code><?xml version="1.0" encoding="UTF-8"?>
|
|
138
|
+
<server-environment>
|
|
139
|
+
<account-id type="integer">4</account-id>
|
|
140
|
+
<automatic type="boolean">true</automatic>
|
|
141
|
+
<branch-name>production</branch-name>
|
|
142
|
+
<created-at type="datetime">2010-07-01T13:58:55+08:00</created-at>
|
|
143
|
+
<current-version>319dded3c14a2f901686b98fc58d5026f102ba65</current-version>
|
|
144
|
+
<id type="integer">12</id>
|
|
145
|
+
<name>The Development</name>
|
|
146
|
+
<repository-id type="integer">58</repository-id>
|
|
147
|
+
<updated-at type="datetime">2010-08-09T11:32:53+08:00</updated-at>
|
|
148
|
+
</server-environment>
|
|
149
|
+
|
|
150
|
+
--OR IF INVALID--
|
|
151
|
+
|
|
152
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
153
|
+
<errors>
|
|
154
|
+
<error>Name can't be blank</error>
|
|
155
|
+
</errors></code></pre>
|
|
156
|
+
</div>
|
|
157
|
+
<div class="code_container ruby"><i>ruby</i><code class="ruby"><pre>env = Beanstalk::API::ServerEnvironment.new(
|
|
158
|
+
:name => "Macaroni",
|
|
159
|
+
:automatic => true,
|
|
160
|
+
:branch_name => "master"
|
|
161
|
+
)
|
|
162
|
+
env.prefix_options = { :repository_id => 58 }
|
|
163
|
+
env.save
|
|
164
|
+
</pre></code></div>
|
|
165
|
+
<h3>Update existing Server Environment</h3>
|
|
166
|
+
<p>See the list of writable attributes at the top of the page. You only need to pass the attributes that you want to change.</p>
|
|
167
|
+
<div class="code_container http-request"><i>http-request</i><code class="http-request"><pre>PUT /api/58/server_environments/6.xml
|
|
168
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
169
|
+
<server-environment>
|
|
170
|
+
<name>The Development</name>
|
|
171
|
+
</server-environment></pre></code></div>
|
|
172
|
+
<div class="code_container response">
|
|
173
|
+
<p>Click to expand…</p>
|
|
174
|
+
<i>http-response</i>
|
|
175
|
+
<pre><code>HEAD 200 OK
|
|
176
|
+
|
|
177
|
+
--OR IF INVALID--
|
|
178
|
+
|
|
179
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
180
|
+
<errors>
|
|
181
|
+
<error>Name must be unique in repository.</error>
|
|
182
|
+
</errors></code></pre>
|
|
183
|
+
</div>
|
|
184
|
+
<p>Or using the ruby lib:</p>
|
|
185
|
+
<div class="code_container ruby"><i>ruby</i><code class="ruby"><pre>env = Beanstalk::API::ServerEnvironment.find_for_repository(6, 58)
|
|
186
|
+
env.prefix_options = { :repository_id => 58 }
|
|
187
|
+
env.name = "The Development"
|
|
188
|
+
env.save
|
|
189
|
+
</pre></code></div>
|
|
190
|
+
</section>
|
|
191
|
+
|
|
192
|
+
<section id="sidebar">
|
|
193
|
+
<ul class="tabs">
|
|
194
|
+
<li>
|
|
195
|
+
|
|
196
|
+
<a href="introduction.html">Introduction</a>
|
|
197
|
+
</li>
|
|
198
|
+
<li>
|
|
199
|
+
|
|
200
|
+
<a href="changelog.html">Changelog</a>
|
|
201
|
+
</li>
|
|
202
|
+
<li>
|
|
203
|
+
|
|
204
|
+
<a href="ruby_gem.html">Ruby Gem</a>
|
|
205
|
+
</li>
|
|
206
|
+
<li>
|
|
207
|
+
|
|
208
|
+
<a href="account.html">Account</a>
|
|
209
|
+
</li>
|
|
210
|
+
<li>
|
|
211
|
+
|
|
212
|
+
<a href="user.html">User</a>
|
|
213
|
+
</li>
|
|
214
|
+
<li>
|
|
215
|
+
|
|
216
|
+
<a href="repository.html">Repository</a>
|
|
217
|
+
</li>
|
|
218
|
+
<li>
|
|
219
|
+
|
|
220
|
+
<a href="changeset.html">Changeset</a>
|
|
221
|
+
</li>
|
|
222
|
+
<li>
|
|
223
|
+
|
|
224
|
+
<a href="comment.html">Comment</a>
|
|
225
|
+
</li>
|
|
226
|
+
<li>
|
|
227
|
+
|
|
228
|
+
<strong>→ Server Environment</strong>
|
|
229
|
+
</li>
|
|
230
|
+
<li>
|
|
231
|
+
|
|
232
|
+
<a href="release_server.html">Release Server</a>
|
|
233
|
+
</li>
|
|
234
|
+
<li>
|
|
235
|
+
|
|
236
|
+
<a href="release.html">Release</a>
|
|
237
|
+
</li>
|
|
238
|
+
</ul>
|
|
239
|
+
</section>
|
|
240
|
+
</div>
|
|
241
|
+
</div>
|
|
242
|
+
|
|
243
|
+
<footer>
|
|
244
|
+
|
|
245
|
+
<div class="container">
|
|
246
|
+
<ul>
|
|
247
|
+
<li><a href="http://help.beanstalkapp.com/discussion/new">Contact</a></li>
|
|
248
|
+
<li><a href="http://blog.beanstalkapp.com">Blog</a></li>
|
|
249
|
+
<li><a href="http://twitter.com/beanstalkapp">Twitter</a></li>
|
|
250
|
+
<li><a href="http://beanstalkapp.com/security">Security</a></li>
|
|
251
|
+
<li><a href="http://beanstalkapp.com/privacy-policy">Privacy Policy</a></li>
|
|
252
|
+
<li><a href="http://beanstalkapp.com/terms-of-service">Terms of Service</a></li>
|
|
253
|
+
</ul>
|
|
254
|
+
<p>© <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>
|
|
255
|
+
</div>
|
|
256
|
+
|
|
257
|
+
</footer>
|
|
258
|
+
|
|
259
|
+
<script type="text/javascript">
|
|
260
|
+
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
|
261
|
+
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
|
262
|
+
</script>
|
|
263
|
+
<script type="text/javascript">
|
|
264
|
+
try {
|
|
265
|
+
var pageTracker = _gat._getTracker("UA-507677-5");
|
|
266
|
+
pageTracker._setDomainName(".beanstalkapp.com");
|
|
267
|
+
pageTracker._trackPageview();
|
|
268
|
+
} catch(err) {}</script>
|
|
269
|
+
</body>
|
|
270
|
+
</html>
|
data/doc/user.html
ADDED
|
@@ -0,0 +1,210 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="utf-8">
|
|
6
|
+
<title>Beanstalk — 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 & 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 & 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>User model</h1>
|
|
60
|
+
<p class='warning'>Admin privileges required for these <span class="caps">API</span> methods.</p>
|
|
61
|
+
<h3>Find all users</h3>
|
|
62
|
+
<div class="code_container http-request"><i>http-request</i><code class="http-request"><pre>GET /api/users.xml</pre></code></div>
|
|
63
|
+
|
|
64
|
+
<div class="code_container response">
|
|
65
|
+
<p>Click to expand…</p>
|
|
66
|
+
<i>http-response</i>
|
|
67
|
+
<pre><code><?xml version="1.0" encoding="UTF-8"?>
|
|
68
|
+
<users type="array">
|
|
69
|
+
<user>
|
|
70
|
+
<account-id type="integer">44253</account-id>
|
|
71
|
+
<admin type="boolean">true</admin>
|
|
72
|
+
<created-at type="datetime">
|
|
73
|
+
2007-05-16T23:52:31Z
|
|
74
|
+
</created-at>
|
|
75
|
+
<email>email@example.com</email>
|
|
76
|
+
<first-name>Dima</first-name>
|
|
77
|
+
<id type="integer">624622</id>
|
|
78
|
+
<last-name>Sabanin</last-name>
|
|
79
|
+
<login>sdmitry</login>
|
|
80
|
+
<timezone>Krasnoyarsk</timezone>
|
|
81
|
+
<updated-at type="datetime">
|
|
82
|
+
2009-04-20T19:05:16Z
|
|
83
|
+
</updated-at>
|
|
84
|
+
</user>
|
|
85
|
+
<user>
|
|
86
|
+
<account-id type="integer">56346</account-id>
|
|
87
|
+
<admin type="boolean" nil="true"></admin>
|
|
88
|
+
<created-at type="datetime">
|
|
89
|
+
2007-05-17T00:55:39Z
|
|
90
|
+
</created-at>
|
|
91
|
+
<email>fakeemail_2@nowhere.example.com</email>
|
|
92
|
+
<first-name>Ilya</first-name>
|
|
93
|
+
<id type="integer">2349</id>
|
|
94
|
+
<last-name>Sabanin</last-name>
|
|
95
|
+
<login>ilya</login>
|
|
96
|
+
<timezone nil="true"></timezone>
|
|
97
|
+
<updated-at type="datetime">
|
|
98
|
+
2009-04-20T19:05:18Z
|
|
99
|
+
</updated-at>
|
|
100
|
+
</user>
|
|
101
|
+
</users></code></pre>
|
|
102
|
+
</div>
|
|
103
|
+
<div class="code_container ruby"><i>ruby</i><code class="ruby"><pre>Beanstalk::API::User.find(:all)</pre></code></div>
|
|
104
|
+
<h3>Find a single user</h3>
|
|
105
|
+
<p>User ID is required. Number 27 in the examples below.</p>
|
|
106
|
+
<div class="code_container http-request"><i>http-request</i><code class="http-request"><pre>GET /api/users/27.xml</pre></code></div>
|
|
107
|
+
|
|
108
|
+
<div class="code_container response">
|
|
109
|
+
<p>Click to expand…</p>
|
|
110
|
+
<i>http-response</i>
|
|
111
|
+
<pre><code><?xml version="1.0" encoding="UTF-8"?>
|
|
112
|
+
<user>
|
|
113
|
+
<account-id type="integer">44253</account-id>
|
|
114
|
+
<admin type="boolean">true</admin>
|
|
115
|
+
<created-at type="datetime">
|
|
116
|
+
2007-05-16T23:52:31Z
|
|
117
|
+
</created-at>
|
|
118
|
+
<email>email@example.com</email>
|
|
119
|
+
<first-name>Dima</first-name>
|
|
120
|
+
<id type="integer">624622</id>
|
|
121
|
+
<last-name>Sabanin</last-name>
|
|
122
|
+
<login>sdmitry</login>
|
|
123
|
+
<timezone>Krasnoyarsk</timezone>
|
|
124
|
+
<updated-at type="datetime">
|
|
125
|
+
2009-04-20T19:05:16Z
|
|
126
|
+
</updated-at>
|
|
127
|
+
</user></code></pre>
|
|
128
|
+
</div>
|
|
129
|
+
<div class="code_container ruby"><i>ruby</i><code class="ruby"><pre>Beanstalk::API::User.find(27)</pre></code></div>
|
|
130
|
+
</section>
|
|
131
|
+
|
|
132
|
+
<section id="sidebar">
|
|
133
|
+
<ul class="tabs">
|
|
134
|
+
<li>
|
|
135
|
+
|
|
136
|
+
<a href="introduction.html">Introduction</a>
|
|
137
|
+
</li>
|
|
138
|
+
<li>
|
|
139
|
+
|
|
140
|
+
<a href="changelog.html">Changelog</a>
|
|
141
|
+
</li>
|
|
142
|
+
<li>
|
|
143
|
+
|
|
144
|
+
<a href="ruby_gem.html">Ruby Gem</a>
|
|
145
|
+
</li>
|
|
146
|
+
<li>
|
|
147
|
+
|
|
148
|
+
<a href="account.html">Account</a>
|
|
149
|
+
</li>
|
|
150
|
+
<li>
|
|
151
|
+
|
|
152
|
+
<strong>→ User</strong>
|
|
153
|
+
</li>
|
|
154
|
+
<li>
|
|
155
|
+
|
|
156
|
+
<a href="repository.html">Repository</a>
|
|
157
|
+
</li>
|
|
158
|
+
<li>
|
|
159
|
+
|
|
160
|
+
<a href="changeset.html">Changeset</a>
|
|
161
|
+
</li>
|
|
162
|
+
<li>
|
|
163
|
+
|
|
164
|
+
<a href="comment.html">Comment</a>
|
|
165
|
+
</li>
|
|
166
|
+
<li>
|
|
167
|
+
|
|
168
|
+
<a href="server_environment.html">Server Environment</a>
|
|
169
|
+
</li>
|
|
170
|
+
<li>
|
|
171
|
+
|
|
172
|
+
<a href="release_server.html">Release Server</a>
|
|
173
|
+
</li>
|
|
174
|
+
<li>
|
|
175
|
+
|
|
176
|
+
<a href="release.html">Release</a>
|
|
177
|
+
</li>
|
|
178
|
+
</ul>
|
|
179
|
+
</section>
|
|
180
|
+
</div>
|
|
181
|
+
</div>
|
|
182
|
+
|
|
183
|
+
<footer>
|
|
184
|
+
|
|
185
|
+
<div class="container">
|
|
186
|
+
<ul>
|
|
187
|
+
<li><a href="http://help.beanstalkapp.com/discussion/new">Contact</a></li>
|
|
188
|
+
<li><a href="http://blog.beanstalkapp.com">Blog</a></li>
|
|
189
|
+
<li><a href="http://twitter.com/beanstalkapp">Twitter</a></li>
|
|
190
|
+
<li><a href="http://beanstalkapp.com/security">Security</a></li>
|
|
191
|
+
<li><a href="http://beanstalkapp.com/privacy-policy">Privacy Policy</a></li>
|
|
192
|
+
<li><a href="http://beanstalkapp.com/terms-of-service">Terms of Service</a></li>
|
|
193
|
+
</ul>
|
|
194
|
+
<p>© <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>
|
|
195
|
+
</div>
|
|
196
|
+
|
|
197
|
+
</footer>
|
|
198
|
+
|
|
199
|
+
<script type="text/javascript">
|
|
200
|
+
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
|
201
|
+
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
|
202
|
+
</script>
|
|
203
|
+
<script type="text/javascript">
|
|
204
|
+
try {
|
|
205
|
+
var pageTracker = _gat._getTracker("UA-507677-5");
|
|
206
|
+
pageTracker._setDomainName(".beanstalkapp.com");
|
|
207
|
+
pageTracker._trackPageview();
|
|
208
|
+
} catch(err) {}</script>
|
|
209
|
+
</body>
|
|
210
|
+
</html>
|