soundcloud-ruby-api-wrapper 0.1.9 → 0.2.0
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/.document +5 -0
- data/.gitignore +5 -0
- data/README.html +2 -2
- data/VERSION.yml +2 -2
- data/doc/classes/Soundcloud.html +213 -0
- data/doc/classes/Soundcloud.src/M000001.html +24 -0
- data/doc/classes/Soundcloud.src/M000002.html +19 -0
- data/doc/classes/Soundcloud/Models.html +135 -0
- data/doc/classes/Soundcloud/Models/Comment.html +197 -0
- data/doc/classes/Soundcloud/Models/Comment.src/M000007.html +22 -0
- data/doc/classes/Soundcloud/Models/Event.html +190 -0
- data/doc/classes/Soundcloud/Models/Event.src/M000009.html +18 -0
- data/doc/classes/Soundcloud/Models/Playlist.html +220 -0
- data/doc/classes/Soundcloud/Models/Playlist.src/M000009.html +20 -0
- data/doc/classes/Soundcloud/Models/Playlist.src/M000010.html +20 -0
- data/doc/classes/Soundcloud/Models/Track.html +348 -0
- data/doc/classes/Soundcloud/Models/Track.src/M000003.html +29 -0
- data/doc/classes/Soundcloud/Models/Track.src/M000004.html +18 -0
- data/doc/classes/Soundcloud/Models/Track.src/M000005.html +22 -0
- data/doc/classes/Soundcloud/Models/Track.src/M000006.html +28 -0
- data/doc/classes/Soundcloud/Models/User.html +284 -0
- data/doc/classes/Soundcloud/Models/User.src/M000008.html +18 -0
- data/doc/created.rid +1 -0
- data/doc/files/lib/soundcloud/models/base_rb.html +101 -0
- data/doc/files/lib/soundcloud/models/comment_rb.html +101 -0
- data/doc/files/lib/soundcloud/models/event_rb.html +101 -0
- data/doc/files/lib/soundcloud/models/playlist_rb.html +101 -0
- data/doc/files/lib/soundcloud/models/track_rb.html +101 -0
- data/doc/files/lib/soundcloud/models/user_rb.html +101 -0
- data/doc/files/lib/soundcloud_rb.html +127 -0
- data/doc/fr_class_index.html +33 -0
- data/doc/fr_file_index.html +33 -0
- data/doc/fr_method_index.html +36 -0
- data/doc/index.html +24 -0
- data/doc/rdoc-style.css +208 -0
- data/lib/soundcloud/models/user.rb +2 -2
- data/ruby-api-wrapper.gemspec +103 -0
- data/spec/soundcloud_comment_spec.rb +3 -3
- data/spec/soundcloud_playlist_spec.rb +4 -4
- data/spec/soundcloud_track_spec.rb +3 -3
- data/spec/soundcloud_user_spec.rb +4 -4
- metadata +39 -5
data/.document
ADDED
data/README.html
CHANGED
|
@@ -122,9 +122,9 @@ To get all fans you have to do something like this:
|
|
|
122
122
|
fans = []
|
|
123
123
|
limit = 50
|
|
124
124
|
begin
|
|
125
|
-
some_fans = famous_dj.fans({:offset => fans.
|
|
125
|
+
some_fans = famous_dj.fans({:offset => fans.length, :limit => limit})
|
|
126
126
|
fans += some_fans
|
|
127
|
-
end while some_fans.
|
|
127
|
+
end while some_fans.length >= limit
|
|
128
128
|
</pre>
|
|
129
129
|
|
|
130
130
|
The array fans now contains all fans/followers of famous_dj.
|
data/VERSION.yml
CHANGED
|
@@ -0,0 +1,213 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
7
|
+
<head>
|
|
8
|
+
<title>Module: Soundcloud</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
|
11
|
+
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
|
|
12
|
+
<script type="text/javascript">
|
|
13
|
+
// <![CDATA[
|
|
14
|
+
|
|
15
|
+
function popupCode( url ) {
|
|
16
|
+
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
function toggleCode( id ) {
|
|
20
|
+
if ( document.getElementById )
|
|
21
|
+
elem = document.getElementById( id );
|
|
22
|
+
else if ( document.all )
|
|
23
|
+
elem = eval( "document.all." + id );
|
|
24
|
+
else
|
|
25
|
+
return false;
|
|
26
|
+
|
|
27
|
+
elemStyle = elem.style;
|
|
28
|
+
|
|
29
|
+
if ( elemStyle.display != "block" ) {
|
|
30
|
+
elemStyle.display = "block"
|
|
31
|
+
} else {
|
|
32
|
+
elemStyle.display = "none"
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
// Make codeblocks hidden by default
|
|
39
|
+
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
|
|
40
|
+
|
|
41
|
+
// ]]>
|
|
42
|
+
</script>
|
|
43
|
+
|
|
44
|
+
</head>
|
|
45
|
+
<body>
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
<div id="classHeader">
|
|
50
|
+
<table class="header-table">
|
|
51
|
+
<tr class="top-aligned-row">
|
|
52
|
+
<td><strong>Module</strong></td>
|
|
53
|
+
<td class="class-name-in-header">Soundcloud</td>
|
|
54
|
+
</tr>
|
|
55
|
+
<tr class="top-aligned-row">
|
|
56
|
+
<td><strong>In:</strong></td>
|
|
57
|
+
<td>
|
|
58
|
+
<a href="../files/lib/soundcloud_rb.html">
|
|
59
|
+
lib/soundcloud.rb
|
|
60
|
+
</a>
|
|
61
|
+
<br />
|
|
62
|
+
<a href="../files/lib/soundcloud/models/base_rb.html">
|
|
63
|
+
lib/soundcloud/models/base.rb
|
|
64
|
+
</a>
|
|
65
|
+
<br />
|
|
66
|
+
<a href="../files/lib/soundcloud/models/comment_rb.html">
|
|
67
|
+
lib/soundcloud/models/comment.rb
|
|
68
|
+
</a>
|
|
69
|
+
<br />
|
|
70
|
+
<a href="../files/lib/soundcloud/models/track_rb.html">
|
|
71
|
+
lib/soundcloud/models/track.rb
|
|
72
|
+
</a>
|
|
73
|
+
<br />
|
|
74
|
+
<a href="../files/lib/soundcloud/models/user_rb.html">
|
|
75
|
+
lib/soundcloud/models/user.rb
|
|
76
|
+
</a>
|
|
77
|
+
<br />
|
|
78
|
+
<a href="../files/lib/soundcloud/models/playlist_rb.html">
|
|
79
|
+
lib/soundcloud/models/playlist.rb
|
|
80
|
+
</a>
|
|
81
|
+
<br />
|
|
82
|
+
<a href="../files/lib/soundcloud/models/event_rb.html">
|
|
83
|
+
lib/soundcloud/models/event.rb
|
|
84
|
+
</a>
|
|
85
|
+
<br />
|
|
86
|
+
</td>
|
|
87
|
+
</tr>
|
|
88
|
+
|
|
89
|
+
</table>
|
|
90
|
+
</div>
|
|
91
|
+
<!-- banner header -->
|
|
92
|
+
|
|
93
|
+
<div id="bodyContent">
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<div id="contextContent">
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
</div>
|
|
102
|
+
|
|
103
|
+
<div id="method-list">
|
|
104
|
+
<h3 class="section-bar">Methods</h3>
|
|
105
|
+
|
|
106
|
+
<div class="name-list">
|
|
107
|
+
<a href="#M000001">consumer</a>
|
|
108
|
+
<a href="#M000002">register</a>
|
|
109
|
+
</div>
|
|
110
|
+
</div>
|
|
111
|
+
|
|
112
|
+
</div>
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
<!-- if includes -->
|
|
116
|
+
|
|
117
|
+
<div id="section">
|
|
118
|
+
|
|
119
|
+
<div id="class-list">
|
|
120
|
+
<h3 class="section-bar">Classes and Modules</h3>
|
|
121
|
+
|
|
122
|
+
Module <a href="Soundcloud/Models.html" class="link">Soundcloud::Models</a><br />
|
|
123
|
+
|
|
124
|
+
</div>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
<!-- if method_list -->
|
|
133
|
+
<div id="methods">
|
|
134
|
+
<h3 class="section-bar">Public Class methods</h3>
|
|
135
|
+
|
|
136
|
+
<div id="method-M000001" class="method-detail">
|
|
137
|
+
<a name="M000001"></a>
|
|
138
|
+
|
|
139
|
+
<div class="method-heading">
|
|
140
|
+
<a href="Soundcloud.src/M000001.html" target="Code" class="method-signature"
|
|
141
|
+
onclick="popupCode('Soundcloud.src/M000001.html');return false;">
|
|
142
|
+
<span class="method-name">consumer</span><span class="method-args">(consumer_token,consumer_secret, site = 'http://api.soundcloud.com')</span>
|
|
143
|
+
</a>
|
|
144
|
+
</div>
|
|
145
|
+
|
|
146
|
+
<div class="method-description">
|
|
147
|
+
<p>
|
|
148
|
+
Will create an OAuth Consumer for you.
|
|
149
|
+
</p>
|
|
150
|
+
<p>
|
|
151
|
+
You have to <a href="Soundcloud.html#M000002">register</a> your application
|
|
152
|
+
on soundcloud.com to get a <a href="Soundcloud.html#M000001">consumer</a>
|
|
153
|
+
token and secret.
|
|
154
|
+
</p>
|
|
155
|
+
<p>
|
|
156
|
+
Optionally you can specify another provider site (i.e. <a
|
|
157
|
+
href="http://api.sandbox-soundcloud.com">api.sandbox-soundcloud.com</a>)
|
|
158
|
+
</p>
|
|
159
|
+
<p>
|
|
160
|
+
Default provider site is <a
|
|
161
|
+
href="http://api.soundcloud.com">api.soundcloud.com</a>
|
|
162
|
+
</p>
|
|
163
|
+
</div>
|
|
164
|
+
</div>
|
|
165
|
+
|
|
166
|
+
<div id="method-M000002" class="method-detail">
|
|
167
|
+
<a name="M000002"></a>
|
|
168
|
+
|
|
169
|
+
<div class="method-heading">
|
|
170
|
+
<a href="Soundcloud.src/M000002.html" target="Code" class="method-signature"
|
|
171
|
+
onclick="popupCode('Soundcloud.src/M000002.html');return false;">
|
|
172
|
+
<span class="method-name">register</span><span class="method-args">(options = {})</span>
|
|
173
|
+
</a>
|
|
174
|
+
</div>
|
|
175
|
+
|
|
176
|
+
<div class="method-description">
|
|
177
|
+
<p>
|
|
178
|
+
Will create a soundcloud module containing all the soundcloud models. This
|
|
179
|
+
module is bound to the given OAuth access token.
|
|
180
|
+
</p>
|
|
181
|
+
<p>
|
|
182
|
+
Options:
|
|
183
|
+
</p>
|
|
184
|
+
<pre>
|
|
185
|
+
:access_token = your oauth access token
|
|
186
|
+
:site = soundcloud api site (i.e. "http://api.sandbox-soundcloud.com", defaults to "http://api.soundcloud.com")
|
|
187
|
+
</pre>
|
|
188
|
+
<p>
|
|
189
|
+
Examples:
|
|
190
|
+
</p>
|
|
191
|
+
<pre>
|
|
192
|
+
# unauthenticated to "http://api.soundcloud.com"
|
|
193
|
+
cl = Soundcloud.register()
|
|
194
|
+
|
|
195
|
+
# authenticated connection to soundcloud sandbox
|
|
196
|
+
cl = Soundcloud.register({:access_token => your_access_token, :site => "http://api.sandbox-soundcloud.com"})
|
|
197
|
+
</pre>
|
|
198
|
+
</div>
|
|
199
|
+
</div>
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
</div>
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
</div>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
<div id="validator-badges">
|
|
209
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
210
|
+
</div>
|
|
211
|
+
|
|
212
|
+
</body>
|
|
213
|
+
</html>
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html>
|
|
7
|
+
<head>
|
|
8
|
+
<title>consumer (Soundcloud)</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
|
|
11
|
+
</head>
|
|
12
|
+
<body class="standalone-code">
|
|
13
|
+
<pre><span class="ruby-comment cmt"># File lib/soundcloud.rb, line 21</span>
|
|
14
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">consumer</span>(<span class="ruby-identifier">consumer_token</span>,<span class="ruby-identifier">consumer_secret</span>, <span class="ruby-identifier">site</span> = <span class="ruby-value str">'http://api.soundcloud.com'</span>)
|
|
15
|
+
<span class="ruby-keyword kw">return</span> <span class="ruby-constant">OAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">Consumer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">consumer_token</span>, <span class="ruby-identifier">consumer_secret</span>, {
|
|
16
|
+
<span class="ruby-identifier">:site</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">site</span>,
|
|
17
|
+
<span class="ruby-identifier">:request_token_path</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"/oauth/request_token"</span>,
|
|
18
|
+
<span class="ruby-identifier">:access_token_path</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"/oauth/access_token"</span>,
|
|
19
|
+
<span class="ruby-identifier">:authorize_path</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"/oauth/authorize"</span>,
|
|
20
|
+
<span class="ruby-identifier">:scheme</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">:query_string</span>
|
|
21
|
+
})
|
|
22
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
23
|
+
</body>
|
|
24
|
+
</html>
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html>
|
|
7
|
+
<head>
|
|
8
|
+
<title>register (Soundcloud)</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
|
|
11
|
+
</head>
|
|
12
|
+
<body class="standalone-code">
|
|
13
|
+
<pre><span class="ruby-comment cmt"># File lib/soundcloud.rb, line 46</span>
|
|
14
|
+
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">register</span>(<span class="ruby-identifier">options</span> = {})
|
|
15
|
+
<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:site</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:site</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">'http://api.soundcloud.com'</span>
|
|
16
|
+
<span class="ruby-constant">OAuthActiveResource</span>.<span class="ruby-identifier">register</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ancestors</span>.<span class="ruby-identifier">first</span>, <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ancestors</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-value str">'Models'</span>), <span class="ruby-identifier">options</span>)
|
|
17
|
+
<span class="ruby-keyword kw">end</span></pre>
|
|
18
|
+
</body>
|
|
19
|
+
</html>
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
7
|
+
<head>
|
|
8
|
+
<title>Module: Soundcloud::Models</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
|
11
|
+
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
|
|
12
|
+
<script type="text/javascript">
|
|
13
|
+
// <![CDATA[
|
|
14
|
+
|
|
15
|
+
function popupCode( url ) {
|
|
16
|
+
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
function toggleCode( id ) {
|
|
20
|
+
if ( document.getElementById )
|
|
21
|
+
elem = document.getElementById( id );
|
|
22
|
+
else if ( document.all )
|
|
23
|
+
elem = eval( "document.all." + id );
|
|
24
|
+
else
|
|
25
|
+
return false;
|
|
26
|
+
|
|
27
|
+
elemStyle = elem.style;
|
|
28
|
+
|
|
29
|
+
if ( elemStyle.display != "block" ) {
|
|
30
|
+
elemStyle.display = "block"
|
|
31
|
+
} else {
|
|
32
|
+
elemStyle.display = "none"
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
// Make codeblocks hidden by default
|
|
39
|
+
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
|
|
40
|
+
|
|
41
|
+
// ]]>
|
|
42
|
+
</script>
|
|
43
|
+
|
|
44
|
+
</head>
|
|
45
|
+
<body>
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
<div id="classHeader">
|
|
50
|
+
<table class="header-table">
|
|
51
|
+
<tr class="top-aligned-row">
|
|
52
|
+
<td><strong>Module</strong></td>
|
|
53
|
+
<td class="class-name-in-header">Soundcloud::Models</td>
|
|
54
|
+
</tr>
|
|
55
|
+
<tr class="top-aligned-row">
|
|
56
|
+
<td><strong>In:</strong></td>
|
|
57
|
+
<td>
|
|
58
|
+
<a href="../../files/lib/soundcloud/models/base_rb.html">
|
|
59
|
+
lib/soundcloud/models/base.rb
|
|
60
|
+
</a>
|
|
61
|
+
<br />
|
|
62
|
+
<a href="../../files/lib/soundcloud/models/comment_rb.html">
|
|
63
|
+
lib/soundcloud/models/comment.rb
|
|
64
|
+
</a>
|
|
65
|
+
<br />
|
|
66
|
+
<a href="../../files/lib/soundcloud/models/track_rb.html">
|
|
67
|
+
lib/soundcloud/models/track.rb
|
|
68
|
+
</a>
|
|
69
|
+
<br />
|
|
70
|
+
<a href="../../files/lib/soundcloud/models/user_rb.html">
|
|
71
|
+
lib/soundcloud/models/user.rb
|
|
72
|
+
</a>
|
|
73
|
+
<br />
|
|
74
|
+
<a href="../../files/lib/soundcloud/models/playlist_rb.html">
|
|
75
|
+
lib/soundcloud/models/playlist.rb
|
|
76
|
+
</a>
|
|
77
|
+
<br />
|
|
78
|
+
<a href="../../files/lib/soundcloud/models/event_rb.html">
|
|
79
|
+
lib/soundcloud/models/event.rb
|
|
80
|
+
</a>
|
|
81
|
+
<br />
|
|
82
|
+
</td>
|
|
83
|
+
</tr>
|
|
84
|
+
|
|
85
|
+
</table>
|
|
86
|
+
</div>
|
|
87
|
+
<!-- banner header -->
|
|
88
|
+
|
|
89
|
+
<div id="bodyContent">
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
<div id="contextContent">
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
</div>
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
<!-- if includes -->
|
|
104
|
+
|
|
105
|
+
<div id="section">
|
|
106
|
+
|
|
107
|
+
<div id="class-list">
|
|
108
|
+
<h3 class="section-bar">Classes and Modules</h3>
|
|
109
|
+
|
|
110
|
+
Class <a href="Models/Comment.html" class="link">Soundcloud::Models::Comment</a><br />
|
|
111
|
+
Class <a href="Models/Event.html" class="link">Soundcloud::Models::Event</a><br />
|
|
112
|
+
Class <a href="Models/Playlist.html" class="link">Soundcloud::Models::Playlist</a><br />
|
|
113
|
+
Class <a href="Models/Track.html" class="link">Soundcloud::Models::Track</a><br />
|
|
114
|
+
Class <a href="Models/User.html" class="link">Soundcloud::Models::User</a><br />
|
|
115
|
+
|
|
116
|
+
</div>
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
<!-- if method_list -->
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
</div>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
<div id="validator-badges">
|
|
131
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
132
|
+
</div>
|
|
133
|
+
|
|
134
|
+
</body>
|
|
135
|
+
</html>
|
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
2
|
+
<!DOCTYPE html
|
|
3
|
+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
4
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
5
|
+
|
|
6
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
7
|
+
<head>
|
|
8
|
+
<title>Class: Soundcloud::Models::Comment</title>
|
|
9
|
+
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
10
|
+
<meta http-equiv="Content-Script-Type" content="text/javascript" />
|
|
11
|
+
<link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
|
|
12
|
+
<script type="text/javascript">
|
|
13
|
+
// <![CDATA[
|
|
14
|
+
|
|
15
|
+
function popupCode( url ) {
|
|
16
|
+
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
function toggleCode( id ) {
|
|
20
|
+
if ( document.getElementById )
|
|
21
|
+
elem = document.getElementById( id );
|
|
22
|
+
else if ( document.all )
|
|
23
|
+
elem = eval( "document.all." + id );
|
|
24
|
+
else
|
|
25
|
+
return false;
|
|
26
|
+
|
|
27
|
+
elemStyle = elem.style;
|
|
28
|
+
|
|
29
|
+
if ( elemStyle.display != "block" ) {
|
|
30
|
+
elemStyle.display = "block"
|
|
31
|
+
} else {
|
|
32
|
+
elemStyle.display = "none"
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
// Make codeblocks hidden by default
|
|
39
|
+
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
|
|
40
|
+
|
|
41
|
+
// ]]>
|
|
42
|
+
</script>
|
|
43
|
+
|
|
44
|
+
</head>
|
|
45
|
+
<body>
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
<div id="classHeader">
|
|
50
|
+
<table class="header-table">
|
|
51
|
+
<tr class="top-aligned-row">
|
|
52
|
+
<td><strong>Class</strong></td>
|
|
53
|
+
<td class="class-name-in-header">Soundcloud::Models::Comment</td>
|
|
54
|
+
</tr>
|
|
55
|
+
<tr class="top-aligned-row">
|
|
56
|
+
<td><strong>In:</strong></td>
|
|
57
|
+
<td>
|
|
58
|
+
<a href="../../../files/lib/soundcloud/models/comment_rb.html">
|
|
59
|
+
lib/soundcloud/models/comment.rb
|
|
60
|
+
</a>
|
|
61
|
+
<br />
|
|
62
|
+
</td>
|
|
63
|
+
</tr>
|
|
64
|
+
|
|
65
|
+
<tr class="top-aligned-row">
|
|
66
|
+
<td><strong>Parent:</strong></td>
|
|
67
|
+
<td>
|
|
68
|
+
Base
|
|
69
|
+
</td>
|
|
70
|
+
</tr>
|
|
71
|
+
</table>
|
|
72
|
+
</div>
|
|
73
|
+
<!-- banner header -->
|
|
74
|
+
|
|
75
|
+
<div id="bodyContent">
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
<div id="contextContent">
|
|
80
|
+
|
|
81
|
+
<div id="description">
|
|
82
|
+
<p>
|
|
83
|
+
SC API Attributes (as of 26/05/09):
|
|
84
|
+
</p>
|
|
85
|
+
<ul>
|
|
86
|
+
<li>body
|
|
87
|
+
|
|
88
|
+
</li>
|
|
89
|
+
<li>timestamp
|
|
90
|
+
|
|
91
|
+
</li>
|
|
92
|
+
<li>id
|
|
93
|
+
|
|
94
|
+
</li>
|
|
95
|
+
<li>track_id
|
|
96
|
+
|
|
97
|
+
</li>
|
|
98
|
+
<li>user_id
|
|
99
|
+
|
|
100
|
+
</li>
|
|
101
|
+
<li>uri
|
|
102
|
+
|
|
103
|
+
</li>
|
|
104
|
+
</ul>
|
|
105
|
+
<p>
|
|
106
|
+
Custom Wrapper Attributes/Methods:
|
|
107
|
+
</p>
|
|
108
|
+
<ul>
|
|
109
|
+
<li>user
|
|
110
|
+
|
|
111
|
+
</li>
|
|
112
|
+
<li>track
|
|
113
|
+
|
|
114
|
+
</li>
|
|
115
|
+
</ul>
|
|
116
|
+
<p>
|
|
117
|
+
Look up the resource attributes and filtering usage here:
|
|
118
|
+
</p>
|
|
119
|
+
<p>
|
|
120
|
+
<a
|
|
121
|
+
href="http://wiki.github.com/soundcloud/api/documentation#comment">wiki.github.com/soundcloud/api/documentation#comment</a>
|
|
122
|
+
</p>
|
|
123
|
+
<p>
|
|
124
|
+
Examples:
|
|
125
|
+
</p>
|
|
126
|
+
<pre>
|
|
127
|
+
# add a comment to a track
|
|
128
|
+
some_track = sc_client.Track.find('some-track')
|
|
129
|
+
sc_client.Comment.create({:track => some_track, :body => 'Nice Track!'})
|
|
130
|
+
|
|
131
|
+
# optionally you can add a timestamp (in milliseconds)
|
|
132
|
+
sc_client.Comment.create({:track => some_track, :body => 'nice drums @ the 5th second!', :timestamp => 5000})
|
|
133
|
+
|
|
134
|
+
# display all comments of some track
|
|
135
|
+
some_track.comments.each do |comment|
|
|
136
|
+
p "#{comment.user.full_name} wrote: #{comment.body}"
|
|
137
|
+
end
|
|
138
|
+
</pre>
|
|
139
|
+
|
|
140
|
+
</div>
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
</div>
|
|
144
|
+
|
|
145
|
+
<div id="method-list">
|
|
146
|
+
<h3 class="section-bar">Methods</h3>
|
|
147
|
+
|
|
148
|
+
<div class="name-list">
|
|
149
|
+
<a href="#M000007">new</a>
|
|
150
|
+
</div>
|
|
151
|
+
</div>
|
|
152
|
+
|
|
153
|
+
</div>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
<!-- if includes -->
|
|
157
|
+
|
|
158
|
+
<div id="section">
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
<!-- if method_list -->
|
|
168
|
+
<div id="methods">
|
|
169
|
+
<h3 class="section-bar">Public Class methods</h3>
|
|
170
|
+
|
|
171
|
+
<div id="method-M000007" class="method-detail">
|
|
172
|
+
<a name="M000007"></a>
|
|
173
|
+
|
|
174
|
+
<div class="method-heading">
|
|
175
|
+
<a href="Comment.src/M000007.html" target="Code" class="method-signature"
|
|
176
|
+
onclick="popupCode('Comment.src/M000007.html');return false;">
|
|
177
|
+
<span class="method-name">new</span><span class="method-args">(options)</span>
|
|
178
|
+
</a>
|
|
179
|
+
</div>
|
|
180
|
+
|
|
181
|
+
<div class="method-description">
|
|
182
|
+
</div>
|
|
183
|
+
</div>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
</div>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
</div>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
<div id="validator-badges">
|
|
193
|
+
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
194
|
+
</div>
|
|
195
|
+
|
|
196
|
+
</body>
|
|
197
|
+
</html>
|