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
data/doc/changelog.html
ADDED
|
@@ -0,0 +1,150 @@
|
|
|
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>Changelog</h1>
|
|
60
|
+
<p>When a new version of the <span class="caps">API</span> is released, it will use a different <span class="caps">URL</span> for all <span class="caps">API</span> requests. For example: “/api2/repositories.xml”.</p>
|
|
61
|
+
<h3>1.0 — Current version</h3>
|
|
62
|
+
<ul>
|
|
63
|
+
<li>Prepended all <span class="caps">API</span> URLs with “/api”</li>
|
|
64
|
+
<li>Public release.</li>
|
|
65
|
+
</ul>
|
|
66
|
+
<h3>Beta</h3>
|
|
67
|
+
<ul>
|
|
68
|
+
<li>Closed beta-testing of the <span class="caps">API</span>.</li>
|
|
69
|
+
</ul>
|
|
70
|
+
</section>
|
|
71
|
+
|
|
72
|
+
<section id="sidebar">
|
|
73
|
+
<ul class="tabs">
|
|
74
|
+
<li>
|
|
75
|
+
|
|
76
|
+
<a href="introduction.html">Introduction</a>
|
|
77
|
+
</li>
|
|
78
|
+
<li>
|
|
79
|
+
|
|
80
|
+
<strong>→ Changelog</strong>
|
|
81
|
+
</li>
|
|
82
|
+
<li>
|
|
83
|
+
|
|
84
|
+
<a href="ruby_gem.html">Ruby Gem</a>
|
|
85
|
+
</li>
|
|
86
|
+
<li>
|
|
87
|
+
|
|
88
|
+
<a href="account.html">Account</a>
|
|
89
|
+
</li>
|
|
90
|
+
<li>
|
|
91
|
+
|
|
92
|
+
<a href="user.html">User</a>
|
|
93
|
+
</li>
|
|
94
|
+
<li>
|
|
95
|
+
|
|
96
|
+
<a href="repository.html">Repository</a>
|
|
97
|
+
</li>
|
|
98
|
+
<li>
|
|
99
|
+
|
|
100
|
+
<a href="changeset.html">Changeset</a>
|
|
101
|
+
</li>
|
|
102
|
+
<li>
|
|
103
|
+
|
|
104
|
+
<a href="comment.html">Comment</a>
|
|
105
|
+
</li>
|
|
106
|
+
<li>
|
|
107
|
+
|
|
108
|
+
<a href="server_environment.html">Server Environment</a>
|
|
109
|
+
</li>
|
|
110
|
+
<li>
|
|
111
|
+
|
|
112
|
+
<a href="release_server.html">Release Server</a>
|
|
113
|
+
</li>
|
|
114
|
+
<li>
|
|
115
|
+
|
|
116
|
+
<a href="release.html">Release</a>
|
|
117
|
+
</li>
|
|
118
|
+
</ul>
|
|
119
|
+
</section>
|
|
120
|
+
</div>
|
|
121
|
+
</div>
|
|
122
|
+
|
|
123
|
+
<footer>
|
|
124
|
+
|
|
125
|
+
<div class="container">
|
|
126
|
+
<ul>
|
|
127
|
+
<li><a href="http://help.beanstalkapp.com/discussion/new">Contact</a></li>
|
|
128
|
+
<li><a href="http://blog.beanstalkapp.com">Blog</a></li>
|
|
129
|
+
<li><a href="http://twitter.com/beanstalkapp">Twitter</a></li>
|
|
130
|
+
<li><a href="http://beanstalkapp.com/security">Security</a></li>
|
|
131
|
+
<li><a href="http://beanstalkapp.com/privacy-policy">Privacy Policy</a></li>
|
|
132
|
+
<li><a href="http://beanstalkapp.com/terms-of-service">Terms of Service</a></li>
|
|
133
|
+
</ul>
|
|
134
|
+
<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>
|
|
135
|
+
</div>
|
|
136
|
+
|
|
137
|
+
</footer>
|
|
138
|
+
|
|
139
|
+
<script type="text/javascript">
|
|
140
|
+
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
|
141
|
+
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
|
142
|
+
</script>
|
|
143
|
+
<script type="text/javascript">
|
|
144
|
+
try {
|
|
145
|
+
var pageTracker = _gat._getTracker("UA-507677-5");
|
|
146
|
+
pageTracker._setDomainName(".beanstalkapp.com");
|
|
147
|
+
pageTracker._trackPageview();
|
|
148
|
+
} catch(err) {}</script>
|
|
149
|
+
</body>
|
|
150
|
+
</html>
|
data/doc/changeset.html
ADDED
|
@@ -0,0 +1,256 @@
|
|
|
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>Changeset model</h1>
|
|
60
|
+
<h3>Requirements</h3>
|
|
61
|
+
<p>ActiveResource version 2.3 will not work with this model since it doesn’t support loading of nested arrays. We created a <a href="https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/2394-support-for-loading-nested-arrays-in-activeresource">patch for ActiveResource</a> to fix this, but we are not sure when it will be approved and committed. For now you can use the <a href="rails_plugin.html">Ruby libraries</a> provided by Beanstalk which includes this patch.</p>
|
|
62
|
+
<h3>Find all changesets</h3>
|
|
63
|
+
<p>This will fetch 15 changesets from all repositories available to the user currently logged in by basic auth. Use the optional <var>page</var> parameter to fetch more changesets.</p>
|
|
64
|
+
<div class="code_container http-request"><i>http-request</i><code class="http-request"><pre>GET /api/changesets.xml</pre></code></div>
|
|
65
|
+
|
|
66
|
+
<div class="code_container response">
|
|
67
|
+
<p>Click to expand…</p>
|
|
68
|
+
<i>http-response</i>
|
|
69
|
+
<pre><code><?xml version="1.0" encoding="UTF-8"?>
|
|
70
|
+
<revision-caches type="array">
|
|
71
|
+
<revision-cache>
|
|
72
|
+
<account-id type="integer">46245</account-id>
|
|
73
|
+
<repository-id type="integer">14327</repository-id>
|
|
74
|
+
<revision type="integer">1</revision>
|
|
75
|
+
<message>Creating initial repository structure</message>
|
|
76
|
+
<author>gilbert</author>
|
|
77
|
+
<changed-dirs type="yaml">---
|
|
78
|
+
- - branches/
|
|
79
|
+
- :add
|
|
80
|
+
- - tags/
|
|
81
|
+
- :add
|
|
82
|
+
- - trunk/
|
|
83
|
+
- :add
|
|
84
|
+
</changed-dirs>
|
|
85
|
+
<changed-files type="yaml">--- []</changed-files>
|
|
86
|
+
<changed-properties nil="true"></changed-properties>
|
|
87
|
+
<too-large type="boolean" nil="true"></too-large>
|
|
88
|
+
<time type="datetime">2009-11-18T12:49:34Z</time>
|
|
89
|
+
</revision-cache>
|
|
90
|
+
|
|
91
|
+
<revision-cache>
|
|
92
|
+
<account-id type="integer">46245</account-id>
|
|
93
|
+
<repository-id type="integer">87654</repository-id>
|
|
94
|
+
<revision type="integer">253</revision>
|
|
95
|
+
<message>Added nothing</message>
|
|
96
|
+
<author>evil-gilbert</author>
|
|
97
|
+
<user_id>34087</user_id>
|
|
98
|
+
<changed-dirs type="yaml">--- []</changed-dirs>
|
|
99
|
+
<changed-files type="yaml">--- []</changed-files>
|
|
100
|
+
<changed-properties nil="true"></changed-properties>
|
|
101
|
+
<too-large type="boolean" nil="true"></too-large>
|
|
102
|
+
<time type="datetime">2009-11-18T13:23:32Z</time>
|
|
103
|
+
</revision-cache>
|
|
104
|
+
</revision-caches></code></pre>
|
|
105
|
+
</div>
|
|
106
|
+
<div class="code_container ruby"><i>ruby</i><code class="ruby"><pre>Beanstalk::API::Changeset.find :all</pre></code></div>
|
|
107
|
+
<h3>Find all changesets for a specific repository</h3>
|
|
108
|
+
<p>You can use the repository name and it’s ID. So instead of <var>repo_name</var> in the example below, you could use a number like 58.</p>
|
|
109
|
+
<div class="code_container http-request"><i>http-request</i><code class="http-request"><pre>GET /api/changesets/repository.xml?repository_id=NAME_OR_ID</pre></code></div>
|
|
110
|
+
|
|
111
|
+
<div class="code_container response">
|
|
112
|
+
<p>Click to expand…</p>
|
|
113
|
+
<i>http-response</i>
|
|
114
|
+
<pre><code><?xml version="1.0" encoding="UTF-8"?>
|
|
115
|
+
<revision-caches type="array">
|
|
116
|
+
<revision-cache>
|
|
117
|
+
<account-id type="integer">46245</account-id>
|
|
118
|
+
<repository-id type="integer">1</repository-id>
|
|
119
|
+
<revision type="integer">1</revision>
|
|
120
|
+
<message>Creating initial repository structure</message>
|
|
121
|
+
<author>gilbert</author>
|
|
122
|
+
<user_id>34087</user_id>
|
|
123
|
+
<changed-dirs type="yaml">---
|
|
124
|
+
- - branches/
|
|
125
|
+
- :add
|
|
126
|
+
- - tags/
|
|
127
|
+
- :add
|
|
128
|
+
- - trunk/
|
|
129
|
+
- :add
|
|
130
|
+
</changed-dirs>
|
|
131
|
+
<changed-files type="yaml">--- []</changed-files>
|
|
132
|
+
<changed-properties nil="true"></changed-properties>
|
|
133
|
+
<too-large type="boolean" nil="true"></too-large>
|
|
134
|
+
<time type="datetime">2009-11-18T12:49:34Z</time>
|
|
135
|
+
</revision-cache>
|
|
136
|
+
|
|
137
|
+
<revision-cache>
|
|
138
|
+
<account-id type="integer">46245</account-id>
|
|
139
|
+
<repository-id type="integer">1</repository-id>
|
|
140
|
+
<revision type="integer">2</revision>
|
|
141
|
+
<message>Dummy commit</message>
|
|
142
|
+
<author>ilya</author>
|
|
143
|
+
<user_id>97523</user_id>
|
|
144
|
+
<changed-dirs type="yaml">--- []</changed-dirs>
|
|
145
|
+
<changed-files type="yaml">--- []</changed-files>
|
|
146
|
+
<changed-properties nil="true"></changed-properties>
|
|
147
|
+
<too-large type="boolean" nil="true"></too-large>
|
|
148
|
+
<time type="datetime">2009-20-18T14:59:12Z</time>
|
|
149
|
+
</revision-cache>
|
|
150
|
+
</revision-caches></code></pre>
|
|
151
|
+
</div>
|
|
152
|
+
<div class="code_container ruby"><i>ruby</i><code class="ruby"><pre>Beanstalk::API::Changeset.find_all_for_repository(58)</pre></code></div>
|
|
153
|
+
<h3>Find a single changeset</h3>
|
|
154
|
+
<p>Note that revision number is used instead of ID. Therefore you need to specify <var>repository_id</var>, which is the label (“repo_name”) in the example below. Alternatively for <var>repository_id</var> you could use it’s numeric ID (say “58”).</p>
|
|
155
|
+
<div class="code_container http-request"><i>http-request</i><code class="http-request"><pre>GET /api/changesets/100.xml?repository_id=repo_name_or_id</pre></code></div>
|
|
156
|
+
|
|
157
|
+
<div class="code_container response">
|
|
158
|
+
<p>Click to expand…</p>
|
|
159
|
+
<i>http-response</i>
|
|
160
|
+
<pre><code><?xml version="1.0" encoding="UTF-8"?>
|
|
161
|
+
<revision-cache>
|
|
162
|
+
<account-id type="integer">46245</account-id>
|
|
163
|
+
<repository-id type="integer">1</repository-id>
|
|
164
|
+
<revision type="integer">2</revision>
|
|
165
|
+
<message>Dummy commit</message>
|
|
166
|
+
<author>ilya</author>
|
|
167
|
+
<user_id>97523</user_id>
|
|
168
|
+
<changed-dirs type="yaml">--- []</changed-dirs>
|
|
169
|
+
<changed-files type="yaml">--- []</changed-files>
|
|
170
|
+
<changed-properties nil="true"></changed-properties>
|
|
171
|
+
<too-large type="boolean" nil="true"></too-large>
|
|
172
|
+
<time type="datetime">2009-20-18T14:59:12Z</time>
|
|
173
|
+
</revision-cache></code></pre>
|
|
174
|
+
</div>
|
|
175
|
+
<div class="code_container ruby"><i>ruby</i><code class="ruby"><pre>Beanstalk::API::Changeset.find_for_repository(100, "repo")</pre></code></div>
|
|
176
|
+
</section>
|
|
177
|
+
|
|
178
|
+
<section id="sidebar">
|
|
179
|
+
<ul class="tabs">
|
|
180
|
+
<li>
|
|
181
|
+
|
|
182
|
+
<a href="introduction.html">Introduction</a>
|
|
183
|
+
</li>
|
|
184
|
+
<li>
|
|
185
|
+
|
|
186
|
+
<a href="changelog.html">Changelog</a>
|
|
187
|
+
</li>
|
|
188
|
+
<li>
|
|
189
|
+
|
|
190
|
+
<a href="ruby_gem.html">Ruby Gem</a>
|
|
191
|
+
</li>
|
|
192
|
+
<li>
|
|
193
|
+
|
|
194
|
+
<a href="account.html">Account</a>
|
|
195
|
+
</li>
|
|
196
|
+
<li>
|
|
197
|
+
|
|
198
|
+
<a href="user.html">User</a>
|
|
199
|
+
</li>
|
|
200
|
+
<li>
|
|
201
|
+
|
|
202
|
+
<a href="repository.html">Repository</a>
|
|
203
|
+
</li>
|
|
204
|
+
<li>
|
|
205
|
+
|
|
206
|
+
<strong>→ Changeset</strong>
|
|
207
|
+
</li>
|
|
208
|
+
<li>
|
|
209
|
+
|
|
210
|
+
<a href="comment.html">Comment</a>
|
|
211
|
+
</li>
|
|
212
|
+
<li>
|
|
213
|
+
|
|
214
|
+
<a href="server_environment.html">Server Environment</a>
|
|
215
|
+
</li>
|
|
216
|
+
<li>
|
|
217
|
+
|
|
218
|
+
<a href="release_server.html">Release Server</a>
|
|
219
|
+
</li>
|
|
220
|
+
<li>
|
|
221
|
+
|
|
222
|
+
<a href="release.html">Release</a>
|
|
223
|
+
</li>
|
|
224
|
+
</ul>
|
|
225
|
+
</section>
|
|
226
|
+
</div>
|
|
227
|
+
</div>
|
|
228
|
+
|
|
229
|
+
<footer>
|
|
230
|
+
|
|
231
|
+
<div class="container">
|
|
232
|
+
<ul>
|
|
233
|
+
<li><a href="http://help.beanstalkapp.com/discussion/new">Contact</a></li>
|
|
234
|
+
<li><a href="http://blog.beanstalkapp.com">Blog</a></li>
|
|
235
|
+
<li><a href="http://twitter.com/beanstalkapp">Twitter</a></li>
|
|
236
|
+
<li><a href="http://beanstalkapp.com/security">Security</a></li>
|
|
237
|
+
<li><a href="http://beanstalkapp.com/privacy-policy">Privacy Policy</a></li>
|
|
238
|
+
<li><a href="http://beanstalkapp.com/terms-of-service">Terms of Service</a></li>
|
|
239
|
+
</ul>
|
|
240
|
+
<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>
|
|
241
|
+
</div>
|
|
242
|
+
|
|
243
|
+
</footer>
|
|
244
|
+
|
|
245
|
+
<script type="text/javascript">
|
|
246
|
+
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
|
247
|
+
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
|
248
|
+
</script>
|
|
249
|
+
<script type="text/javascript">
|
|
250
|
+
try {
|
|
251
|
+
var pageTracker = _gat._getTracker("UA-507677-5");
|
|
252
|
+
pageTracker._setDomainName(".beanstalkapp.com");
|
|
253
|
+
pageTracker._trackPageview();
|
|
254
|
+
} catch(err) {}</script>
|
|
255
|
+
</body>
|
|
256
|
+
</html>
|
data/doc/comment.html
ADDED
|
@@ -0,0 +1,299 @@
|
|
|
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>Comment model</h1>
|
|
60
|
+
<p>Every Changeset in Beanstalk can have many Comments. The <span class="caps">API</span> allows you to view and create them.</p>
|
|
61
|
+
<h3>Writable attributes</h3>
|
|
62
|
+
<ol>
|
|
63
|
+
<li><var>body</var> — comment contents;</li>
|
|
64
|
+
<li><var>file_path</var> — file from a diff the comment is associated with;</li>
|
|
65
|
+
<li><var>line_number</var> — line number of the associated file;</li>
|
|
66
|
+
<li><var>revision</var> — changeset revision.</li>
|
|
67
|
+
</ol>
|
|
68
|
+
<h3>Note on formatting</h3>
|
|
69
|
+
<p>Beanstalk will automatically escape all <span class="caps">HTML</span> tags from the <var>body</var> attribute, apply Textile formatting and turn all URls into clickable <span class="caps">HTML</span> links.</p>
|
|
70
|
+
<h3>Find all comments for a repository</h3>
|
|
71
|
+
<p><var>repository_id</var> is required. Either name of the repo or it’s ID can be used. Use <var>page</var> parameter to skim through pages. Beanstalk will send 15 comments per page.</p>
|
|
72
|
+
<div class="code_container http-request"><i>http-request</i><code class="http-request"><pre>GET /api/repo_name/comments.xml</pre></code></div>
|
|
73
|
+
|
|
74
|
+
<div class="code_container response">
|
|
75
|
+
<p>Click to expand…</p>
|
|
76
|
+
<i>http-response</i>
|
|
77
|
+
<pre><code><?xml version="1.0" encoding="UTF-8"?>
|
|
78
|
+
<comments type="array">
|
|
79
|
+
<comment>
|
|
80
|
+
<id type="integer">324934</id>
|
|
81
|
+
<account-id type="integer">4</account-id>
|
|
82
|
+
<author-id type="integer">17</author-id>
|
|
83
|
+
<body>
|
|
84
|
+
Hey, this is my first comment.
|
|
85
|
+
I think you have a typo on this line.
|
|
86
|
+
</body>
|
|
87
|
+
<created-at type="datetime">2010-01-18T15:47:45Z</created-at>
|
|
88
|
+
<file-path>trunk/index.html</file-path>
|
|
89
|
+
<line-number>34</line-number>
|
|
90
|
+
<rendered-body>
|
|
91
|
+
&lt;p&gt;Hey, this is my first comment.
|
|
92
|
+
I think you have a typo on this line.&lt;/p&gt;
|
|
93
|
+
</rendered-body>
|
|
94
|
+
<repository-id type="integer">2</repository-id>
|
|
95
|
+
<revision type="integer">1</revision>
|
|
96
|
+
<updated-at type="datetime">2010-01-18T15:47:45Z</updated-at>
|
|
97
|
+
</comment>
|
|
98
|
+
<comment>
|
|
99
|
+
<id type="integer">834234</id>
|
|
100
|
+
<account-id type="integer">4</account-id>
|
|
101
|
+
<author-id type="integer">17</author-id>
|
|
102
|
+
<body>Check out my *textile* dude.</body>
|
|
103
|
+
<created-at type="datetime">2010-01-18T15:48:54Z</created-at>
|
|
104
|
+
<file-path nil="true"></file-path>
|
|
105
|
+
<line-number nil="true"></line-number>
|
|
106
|
+
<rendered-body>
|
|
107
|
+
&lt;p&gt;Check out my <strong>textile</strong> dude.&lt;/p&gt;
|
|
108
|
+
</rendered-body>
|
|
109
|
+
<repository-id type="integer">2</repository-id>
|
|
110
|
+
<revision type="integer">66</revision>
|
|
111
|
+
<updated-at type="datetime">2010-01-18T15:48:54Z</updated-at>
|
|
112
|
+
</comment>
|
|
113
|
+
</comments></code></pre>
|
|
114
|
+
</div>
|
|
115
|
+
<div class="code_container ruby"><i>ruby</i><code class="ruby"><pre>Beanstalk::API::Comment.find :all, :params => {
|
|
116
|
+
:repository_id => 2
|
|
117
|
+
}</pre></code></div>
|
|
118
|
+
<h3>Find all comments for specific changeset</h3>
|
|
119
|
+
<div class="code_container http-request"><i>http-request</i><code class="http-request"><pre>GET /api/repo_name/comments.xml?revision=1</pre></code></div>
|
|
120
|
+
<div class="code_container response">
|
|
121
|
+
<p>Click to expand…</p>
|
|
122
|
+
<i>http-response</i>
|
|
123
|
+
<pre><code><?xml version="1.0" encoding="UTF-8"?>
|
|
124
|
+
<comments type="array">
|
|
125
|
+
<comment>
|
|
126
|
+
<id type="integer">583197</id>
|
|
127
|
+
<account-id type="integer">4</account-id>
|
|
128
|
+
<author-id type="integer">17</author-id>
|
|
129
|
+
<body>
|
|
130
|
+
Hey, this is my first comment.
|
|
131
|
+
I think you have a typo on this line.
|
|
132
|
+
</body>
|
|
133
|
+
<created-at type="datetime">2010-01-18T15:47:45Z</created-at>
|
|
134
|
+
<file-path>trunk/index.html</file-path>
|
|
135
|
+
<line-number>34</line-number>
|
|
136
|
+
<rendered-body>
|
|
137
|
+
&lt;p&gt;Hey, this is my first comment.
|
|
138
|
+
I think you have a typo on this line.&lt;/p&gt;
|
|
139
|
+
</rendered-body>
|
|
140
|
+
<repository-id type="integer">2</repository-id>
|
|
141
|
+
<revision type="integer">1</revision>
|
|
142
|
+
<updated-at type="datetime">2010-01-18T15:47:45Z</updated-at>
|
|
143
|
+
</comment>
|
|
144
|
+
</comments></code></pre>
|
|
145
|
+
</div>
|
|
146
|
+
<div class="code_container ruby"><i>ruby</i><code class="ruby"><pre>Beanstalk::API::Comment.find :all, :params => {
|
|
147
|
+
:repository_id => 2,
|
|
148
|
+
:revision => 1
|
|
149
|
+
}</pre></code></div>
|
|
150
|
+
<h3>Find single comment by id</h3>
|
|
151
|
+
<div class="code_container http-request"><i>http-request</i><code class="http-request"><pre>GET /api/repo_name/comments/8543.xml</pre></code></div>
|
|
152
|
+
<div class="code_container response">
|
|
153
|
+
<p>Click to expand…</p>
|
|
154
|
+
<i>http-response</i>
|
|
155
|
+
<pre><code><?xml version="1.0" encoding="UTF-8"?>
|
|
156
|
+
<comment>
|
|
157
|
+
<id type="integer">8543</id>
|
|
158
|
+
<account-id type="integer">4</account-id>
|
|
159
|
+
<author-id type="integer">17</author-id>
|
|
160
|
+
<body>Hey, this is my first comment.</body>
|
|
161
|
+
<created-at type="datetime">2010-01-18T15:47:45Z</created-at>
|
|
162
|
+
<file-path>trunk/index.html</file-path>
|
|
163
|
+
<line-number>34</line-number>
|
|
164
|
+
<rendered-body>
|
|
165
|
+
&lt;p&gt;Hey, this is my first comment.&lt;/p&gt;
|
|
166
|
+
</rendered-body>
|
|
167
|
+
<repository-id type="integer">2</repository-id>
|
|
168
|
+
<revision type="integer">1</revision>
|
|
169
|
+
<updated-at type="datetime">2010-01-18T15:47:45Z</updated-at>
|
|
170
|
+
</comment></code></pre>
|
|
171
|
+
</div>
|
|
172
|
+
<div class="code_container ruby"><i>ruby</i><code class="ruby"><pre>Beanstalk::API::Comment.find 8543, :params => {
|
|
173
|
+
:repository_id => 2
|
|
174
|
+
}</pre></code></div>
|
|
175
|
+
<h3>Create new comment</h3>
|
|
176
|
+
<div class="code_container http-request"><i>http-request</i><code class="http-request"><pre>POST /api/repo_name/comments.xml
|
|
177
|
+
<comment>
|
|
178
|
+
<revision type="integer">6</revision>
|
|
179
|
+
<body>This is my comment text.</body>
|
|
180
|
+
<file-path>/branches/application/super_file.txt</file-path>
|
|
181
|
+
<line-number>4</line-number>
|
|
182
|
+
</comment>
|
|
183
|
+
</pre></code></div>
|
|
184
|
+
<div class="code_container response">
|
|
185
|
+
<p>Click to expand…</p>
|
|
186
|
+
<i>http-response</i>
|
|
187
|
+
<pre><code><?xml version="1.0" encoding="UTF-8"?>
|
|
188
|
+
<comment>
|
|
189
|
+
<id type="integer">98636</id>
|
|
190
|
+
<account-id type="integer">4</account-id>
|
|
191
|
+
<author-id type="integer">17</author-id>
|
|
192
|
+
<body>This is my comment text.</body>
|
|
193
|
+
<created-at type="datetime">2010-01-18T15:47:45Z</created-at>
|
|
194
|
+
<file-path>/branches/application/super_file.txt</file-path>
|
|
195
|
+
<line-number>4</line-number>
|
|
196
|
+
<rendered-body>
|
|
197
|
+
&lt;p&gt;This is my comment text.&lt;/p&gt;
|
|
198
|
+
</rendered-body>
|
|
199
|
+
<repository-id type="integer">2</repository-id>
|
|
200
|
+
<revision type="integer">6</revision>
|
|
201
|
+
<updated-at type="datetime">2010-01-18T15:47:45Z</updated-at>
|
|
202
|
+
</comment>
|
|
203
|
+
|
|
204
|
+
--OR IF INVALID--
|
|
205
|
+
|
|
206
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
207
|
+
<errors>
|
|
208
|
+
<error>Body can't be blank</error>
|
|
209
|
+
</errors></code></pre>
|
|
210
|
+
</div>
|
|
211
|
+
<div class="code_container ruby"><i>ruby</i><code class="ruby"><pre>c = Beanstalk::API::Comment.new
|
|
212
|
+
c.prefix_options = { :repository_id => 2 }
|
|
213
|
+
c.revision = 6
|
|
214
|
+
c.body = "This is my comment text."
|
|
215
|
+
c.file_path = "/branches/application/super_file.txt"
|
|
216
|
+
c.line_number = 4
|
|
217
|
+
c.save
|
|
218
|
+
</pre></code></div>
|
|
219
|
+
</section>
|
|
220
|
+
|
|
221
|
+
<section id="sidebar">
|
|
222
|
+
<ul class="tabs">
|
|
223
|
+
<li>
|
|
224
|
+
|
|
225
|
+
<a href="introduction.html">Introduction</a>
|
|
226
|
+
</li>
|
|
227
|
+
<li>
|
|
228
|
+
|
|
229
|
+
<a href="changelog.html">Changelog</a>
|
|
230
|
+
</li>
|
|
231
|
+
<li>
|
|
232
|
+
|
|
233
|
+
<a href="ruby_gem.html">Ruby Gem</a>
|
|
234
|
+
</li>
|
|
235
|
+
<li>
|
|
236
|
+
|
|
237
|
+
<a href="account.html">Account</a>
|
|
238
|
+
</li>
|
|
239
|
+
<li>
|
|
240
|
+
|
|
241
|
+
<a href="user.html">User</a>
|
|
242
|
+
</li>
|
|
243
|
+
<li>
|
|
244
|
+
|
|
245
|
+
<a href="repository.html">Repository</a>
|
|
246
|
+
</li>
|
|
247
|
+
<li>
|
|
248
|
+
|
|
249
|
+
<a href="changeset.html">Changeset</a>
|
|
250
|
+
</li>
|
|
251
|
+
<li>
|
|
252
|
+
|
|
253
|
+
<strong>→ Comment</strong>
|
|
254
|
+
</li>
|
|
255
|
+
<li>
|
|
256
|
+
|
|
257
|
+
<a href="server_environment.html">Server Environment</a>
|
|
258
|
+
</li>
|
|
259
|
+
<li>
|
|
260
|
+
|
|
261
|
+
<a href="release_server.html">Release Server</a>
|
|
262
|
+
</li>
|
|
263
|
+
<li>
|
|
264
|
+
|
|
265
|
+
<a href="release.html">Release</a>
|
|
266
|
+
</li>
|
|
267
|
+
</ul>
|
|
268
|
+
</section>
|
|
269
|
+
</div>
|
|
270
|
+
</div>
|
|
271
|
+
|
|
272
|
+
<footer>
|
|
273
|
+
|
|
274
|
+
<div class="container">
|
|
275
|
+
<ul>
|
|
276
|
+
<li><a href="http://help.beanstalkapp.com/discussion/new">Contact</a></li>
|
|
277
|
+
<li><a href="http://blog.beanstalkapp.com">Blog</a></li>
|
|
278
|
+
<li><a href="http://twitter.com/beanstalkapp">Twitter</a></li>
|
|
279
|
+
<li><a href="http://beanstalkapp.com/security">Security</a></li>
|
|
280
|
+
<li><a href="http://beanstalkapp.com/privacy-policy">Privacy Policy</a></li>
|
|
281
|
+
<li><a href="http://beanstalkapp.com/terms-of-service">Terms of Service</a></li>
|
|
282
|
+
</ul>
|
|
283
|
+
<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>
|
|
284
|
+
</div>
|
|
285
|
+
|
|
286
|
+
</footer>
|
|
287
|
+
|
|
288
|
+
<script type="text/javascript">
|
|
289
|
+
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
|
|
290
|
+
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
|
|
291
|
+
</script>
|
|
292
|
+
<script type="text/javascript">
|
|
293
|
+
try {
|
|
294
|
+
var pageTracker = _gat._getTracker("UA-507677-5");
|
|
295
|
+
pageTracker._setDomainName(".beanstalkapp.com");
|
|
296
|
+
pageTracker._trackPageview();
|
|
297
|
+
} catch(err) {}</script>
|
|
298
|
+
</body>
|
|
299
|
+
</html>
|