songkickr 0.2.2 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (66) hide show
  1. data/Gemfile +6 -2
  2. data/Gemfile.lock +32 -10
  3. data/README.rdoc +7 -7
  4. data/Rakefile +1 -1
  5. data/VERSION +1 -1
  6. data/bin/autospec +16 -0
  7. data/bin/convert_to_should_syntax +16 -0
  8. data/bin/guard +16 -0
  9. data/bin/htmldiff +16 -0
  10. data/bin/httparty +16 -0
  11. data/bin/jeweler +16 -0
  12. data/bin/ldiff +16 -0
  13. data/bin/rake +16 -0
  14. data/bin/rake2thor +16 -0
  15. data/bin/rg +16 -0
  16. data/bin/ri +16 -0
  17. data/bin/rspec +16 -0
  18. data/bin/thor +16 -0
  19. data/doc/APIError.html +241 -0
  20. data/doc/APIKeyNotSet.html +164 -175
  21. data/doc/LICENSE.html +109 -109
  22. data/doc/README_rdoc.html +120 -117
  23. data/doc/ResourceNotFound.html +203 -0
  24. data/doc/Songkickr/Artist.html +210 -237
  25. data/doc/Songkickr/ArtistResult.html +228 -254
  26. data/doc/Songkickr/ConcertSetlistResult.html +205 -223
  27. data/doc/Songkickr/Event.html +344 -409
  28. data/doc/Songkickr/EventResult.html +226 -252
  29. data/doc/Songkickr/Location.html +210 -237
  30. data/doc/Songkickr/LocationResult.html +229 -255
  31. data/doc/Songkickr/Performance.html +222 -253
  32. data/doc/Songkickr/Remote.html +630 -481
  33. data/doc/Songkickr/Setlist.html +258 -296
  34. data/doc/Songkickr/SetlistItem.html +187 -206
  35. data/doc/Songkickr/Venue.html +205 -232
  36. data/doc/Songkickr.html +204 -271
  37. data/doc/created.rid +16 -16
  38. data/doc/images/add.png +0 -0
  39. data/doc/images/delete.png +0 -0
  40. data/doc/images/tag_blue.png +0 -0
  41. data/doc/images/transparent.png +0 -0
  42. data/doc/index.html +93 -127
  43. data/doc/js/darkfish.js +99 -62
  44. data/doc/js/jquery.js +15 -29
  45. data/doc/js/navigation.js +142 -0
  46. data/doc/js/search.js +94 -0
  47. data/doc/js/search_index.js +1 -0
  48. data/doc/js/searcher.js +228 -0
  49. data/doc/rdoc.css +119 -339
  50. data/doc/table_of_contents.html +185 -0
  51. data/lib/songkickr/artist.rb +3 -3
  52. data/lib/songkickr/remote.rb +36 -13
  53. data/lib/songkickr.rb +16 -2
  54. data/songkickr.gemspec +121 -4
  55. data/test/fixtures/vcr/invalid_api_key.yml +63 -0
  56. data/test/fixtures/vcr/invalid_event_id.yml +33 -0
  57. data/test/fixtures/vcr/invalid_user.yml +32 -0
  58. data/test/fixtures/vcr/invalid_venue_id.yml +33 -0
  59. data/test/fixtures/vcr/valid_event.yml +52 -0
  60. data/test/fixtures/vcr/valid_user.yml +71 -0
  61. data/test/fixtures/vcr/valid_venue.yml +53 -0
  62. data/test/helper.rb +2 -2
  63. data/test/songkickr/test_remote.rb +68 -24
  64. data/test/vcr_helper.rb +7 -0
  65. data/test.rb +2 -2
  66. metadata +626 -40
@@ -1,715 +1,864 @@
1
- <?xml version="1.0" encoding="UTF-8"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1
+ <!DOCTYPE html>
2
+
3
+ <html>
5
4
  <head>
6
- <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>class Songkickr::Remote - RDoc Documentation</title>
8
+
9
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
7
10
 
8
- <title>Class: Songkickr::Remote</title>
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "../";
13
+ </script>
9
14
 
10
- <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
15
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
11
21
 
12
- <script src="../js/jquery.js" type="text/javascript" charset="utf-8"></script>
13
- <script src="../js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
14
- <script src="../js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
15
- <script src="../js/darkfish.js" type="text/javascript" charset="utf-8"></script>
16
22
 
17
- </head>
18
23
  <body id="top" class="class">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="../index.html">Home</a>
28
+ <a href="../table_of_contents.html#classes">Classes</a>
29
+ <a href="../table_of_contents.html#methods">Methods</a>
30
+ </h3>
31
+ </nav>
32
+
33
+
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
35
+ <form action="#" method="get" accept-charset="utf-8">
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
38
+ title="Type to search, Up and Down to navigate, Enter to load">
39
+ </h3>
40
+ </form>
41
+
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
45
+
46
+ <div id="file-metadata">
47
+ <nav id="file-list-section" class="section">
48
+ <h3 class="section-header">Defined In</h3>
49
+ <ul>
50
+ <li>lib/songkickr/remote.rb
51
+ </ul>
52
+ </nav>
19
53
 
20
- <div id="metadata">
21
- <div id="home-metadata">
22
- <div id="home-section" class="section">
23
- <h3 class="section-header">
24
- <a href="../index.html">Home</a>
25
- <a href="../index.html#classes">Classes</a>
26
- <a href="../index.html#methods">Methods</a>
27
- </h3>
28
- </div>
29
- </div>
54
+
55
+ </div>
30
56
 
31
- <div id="file-metadata">
32
- <div id="file-list-section" class="section">
33
- <h3 class="section-header">In Files</h3>
34
- <div class="section-body">
35
- <ul>
36
-
37
- <li><a href="../lib/songkickr/remote_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
38
- class="thickbox" title="lib/songkickr/remote.rb">lib/songkickr/remote.rb</a></li>
39
-
40
- </ul>
41
- </div>
42
- </div>
57
+ <div id="class-metadata">
58
+
59
+ <nav id="parent-class-section" class="section">
60
+ <h3 class="section-header">Parent</h3>
61
+
62
+ <p class="link">Object
63
+
64
+ </nav>
43
65
 
44
-
45
- </div>
66
+ <!-- Included Modules -->
67
+ <nav id="includes-section" class="section">
68
+ <h3 class="section-header">Included Modules</h3>
46
69
 
47
- <div id="class-metadata">
48
-
49
- <!-- Parent Class -->
50
- <div id="parent-class-section" class="section">
51
- <h3 class="section-header">Parent</h3>
52
-
53
- <p class="link">Object</p>
54
-
55
- </div>
56
-
70
+ <ul class="link-list">
71
+
72
+
73
+ <li><span class="include">HTTParty</span>
74
+
75
+
76
+ </ul>
77
+ </nav>
57
78
 
58
-
79
+ <!-- Method Quickref -->
80
+ <nav id="method-list-section" class="section">
81
+ <h3 class="section-header">Methods</h3>
59
82
 
60
-
83
+ <ul class="link-list">
84
+
85
+ <li><a href="#method-c-new">::new</a>
86
+
87
+ <li><a href="#method-i-artist_events">#artist_events</a>
88
+
89
+ <li><a href="#method-i-artist_search">#artist_search</a>
90
+
91
+ <li><a href="#method-i-concert_setlists">#concert_setlists</a>
92
+
93
+ <li><a href="#method-i-event">#event</a>
94
+
95
+ <li><a href="#method-i-events">#events</a>
96
+
97
+ <li><a href="#method-i-get">#get</a>
98
+
99
+ <li><a href="#method-i-gigography">#gigography</a>
100
+
101
+ <li><a href="#method-i-location_search">#location_search</a>
102
+
103
+ <li><a href="#method-i-metro_areas_events">#metro_areas_events</a>
104
+
105
+ <li><a href="#method-i-users_events">#users_events</a>
106
+
107
+ <li><a href="#method-i-users_tracked_artists">#users_tracked_artists</a>
108
+
109
+ <li><a href="#method-i-venue">#venue</a>
110
+
111
+ </ul>
112
+ </nav>
61
113
 
62
-
63
- <!-- Method Quickref -->
64
- <div id="method-list-section" class="section">
65
- <h3 class="section-header">Methods</h3>
66
- <ul class="link-list">
67
-
68
- <li><a href="#method-c-new">::new</a></li>
69
-
70
- <li><a href="#method-i-artist_search">#artist_search</a></li>
71
-
72
- <li><a href="#method-i-concert_setlists">#concert_setlists</a></li>
73
-
74
- <li><a href="#method-i-event">#event</a></li>
75
-
76
- <li><a href="#method-i-events">#events</a></li>
77
-
78
- <li><a href="#method-i-gigography">#gigography</a></li>
79
-
80
- <li><a href="#method-i-location_search">#location_search</a></li>
81
-
82
- <li><a href="#method-i-metro_areas_events">#metro_areas_events</a></li>
83
-
84
- <li><a href="#method-i-users_events">#users_events</a></li>
85
-
86
- </ul>
87
- </div>
88
-
114
+ </div>
89
115
 
90
-
91
- <!-- Included Modules -->
92
- <div id="includes-section" class="section">
93
- <h3 class="section-header">Included Modules</h3>
94
- <ul class="link-list">
95
-
96
-
97
- <li><span class="include">HTTParty</span></li>
98
-
99
-
100
- </ul>
101
- </div>
102
-
103
- </div>
116
+ <div id="project-metadata">
117
+ <nav id="fileindex-section" class="section project-section">
118
+ <h3 class="section-header">Pages</h3>
104
119
 
105
- <div id="project-metadata">
106
-
107
-
108
- <div id="fileindex-section" class="section project-section">
109
- <h3 class="section-header">Files</h3>
110
- <ul>
111
-
112
- <li class="file"><a href="../LICENSE.html">LICENSE</a></li>
113
-
114
- <li class="file"><a href="../README_rdoc.html">README.rdoc</a></li>
115
-
116
- </ul>
117
- </div>
118
-
120
+ <ul>
121
+
122
+ <li class="file"><a href="../LICENSE.html">LICENSE</a>
123
+
124
+ <li class="file"><a href="../README_rdoc.html">README</a>
125
+
126
+ </ul>
127
+ </nav>
119
128
 
120
- <div id="classindex-section" class="section project-section">
121
- <h3 class="section-header">Class/Module Index
122
- <span class="search-toggle"><img src="../images/find.png"
123
- height="16" width="16" alt="[+]"
124
- title="show/hide quicksearch" /></span></h3>
125
- <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
126
- <fieldset>
127
- <legend>Quicksearch</legend>
128
- <input type="text" name="quicksearch" value=""
129
- class="quicksearch-field" />
130
- </fieldset>
131
- </form>
129
+ <nav id="classindex-section" class="section project-section">
130
+ <h3 class="section-header">Class and Module Index</h3>
132
131
 
133
- <ul class="link-list">
134
-
135
- <li><a href="../Songkickr.html">Songkickr</a></li>
136
-
137
- <li><a href="../Songkickr/Artist.html">Songkickr::Artist</a></li>
138
-
139
- <li><a href="../Songkickr/ArtistResult.html">Songkickr::ArtistResult</a></li>
140
-
141
- <li><a href="../Songkickr/ConcertSetlistResult.html">Songkickr::ConcertSetlistResult</a></li>
142
-
143
- <li><a href="../Songkickr/Event.html">Songkickr::Event</a></li>
144
-
145
- <li><a href="../Songkickr/EventResult.html">Songkickr::EventResult</a></li>
146
-
147
- <li><a href="../Songkickr/Location.html">Songkickr::Location</a></li>
148
-
149
- <li><a href="../Songkickr/LocationResult.html">Songkickr::LocationResult</a></li>
150
-
151
- <li><a href="../Songkickr/Performance.html">Songkickr::Performance</a></li>
152
-
153
- <li><a href="../Songkickr/Remote.html">Songkickr::Remote</a></li>
154
-
155
- <li><a href="../Songkickr/Setlist.html">Songkickr::Setlist</a></li>
156
-
157
- <li><a href="../Songkickr/SetlistItem.html">Songkickr::SetlistItem</a></li>
158
-
159
- <li><a href="../Songkickr/Venue.html">Songkickr::Venue</a></li>
160
-
161
- <li><a href="../APIKeyNotSet.html">APIKeyNotSet</a></li>
162
-
163
- </ul>
164
- <div id="no-class-search-results" style="display: none;">No matching classes.</div>
165
- </div>
132
+ <ul class="link-list">
133
+
134
+ <li><a href="../Songkickr.html">Songkickr</a>
135
+
136
+ <li><a href="../Songkickr/Artist.html">Songkickr::Artist</a>
137
+
138
+ <li><a href="../Songkickr/ArtistResult.html">Songkickr::ArtistResult</a>
139
+
140
+ <li><a href="../Songkickr/ConcertSetlistResult.html">Songkickr::ConcertSetlistResult</a>
141
+
142
+ <li><a href="../Songkickr/Event.html">Songkickr::Event</a>
143
+
144
+ <li><a href="../Songkickr/EventResult.html">Songkickr::EventResult</a>
145
+
146
+ <li><a href="../Songkickr/Location.html">Songkickr::Location</a>
147
+
148
+ <li><a href="../Songkickr/LocationResult.html">Songkickr::LocationResult</a>
149
+
150
+ <li><a href="../Songkickr/Performance.html">Songkickr::Performance</a>
151
+
152
+ <li><a href="../Songkickr/Remote.html">Songkickr::Remote</a>
153
+
154
+ <li><a href="../Songkickr/Setlist.html">Songkickr::Setlist</a>
155
+
156
+ <li><a href="../Songkickr/SetlistItem.html">Songkickr::SetlistItem</a>
157
+
158
+ <li><a href="../Songkickr/Venue.html">Songkickr::Venue</a>
159
+
160
+ <li><a href="../APIError.html">APIError</a>
161
+
162
+ <li><a href="../APIKeyNotSet.html">APIKeyNotSet</a>
163
+
164
+ <li><a href="../ResourceNotFound.html">ResourceNotFound</a>
165
+
166
+ </ul>
167
+ </nav>
166
168
 
167
-
168
- </div>
169
169
  </div>
170
+ </nav>
170
171
 
171
- <div id="documentation">
172
- <h1 class="class">Songkickr::Remote</h1>
172
+ <div id="documentation">
173
+ <h1 class="class">class Songkickr::Remote</h1>
173
174
 
174
- <div id="description" class="description">
175
-
175
+ <div id="description" class="description">
176
+
176
177
  <p>Create an instance of the remote class to interact with the Songkick API.</p>
177
178
 
178
- </div><!-- description -->
179
+ </div><!-- description -->
179
180
 
181
+
182
+
183
+
184
+ <section id="5Buntitled-5D" class="documentation-section">
180
185
 
181
- <div id="5Buntitled-5D" class="documentation-section">
182
-
183
186
 
184
-
187
+
185
188
 
186
-
189
+
190
+
191
+
192
+ <!-- Attributes -->
193
+ <section id="attribute-method-details" class="method-section section">
194
+ <h3 class="section-header">Attributes</h3>
187
195
 
188
196
 
189
- <!-- Attributes -->
190
- <div id="attribute-method-details" class="method-section section">
191
- <h3 class="section-header">Attributes</h3>
197
+ <div id="attribute-i-api_key" class="method-detail">
198
+ <div class="method-heading attribute-method-heading">
199
+ <span class="method-name">api_key</span><span
200
+ class="attribute-access-type">[R]</span>
201
+ </div>
192
202
 
203
+ <div class="method-description">
193
204
 
194
- <div id="api_key-attribute-method" class="method-detail">
195
- <a name="api_key"></a>
196
-
197
- <div class="method-heading attribute-method-heading">
198
- <span class="method-name">api_key</span><span
199
- class="attribute-access-type">[R]</span>
200
- </div>
201
-
202
- <div class="method-description">
203
-
204
-
205
-
206
- </div>
207
- </div>
208
205
 
209
- </div><!-- attribute-method-details -->
206
+
207
+ </div>
208
+ </div>
210
209
 
210
+ </section><!-- attribute-method-details -->
211
+
211
212
 
212
- <!-- Methods -->
213
-
214
- <div id="public-class-method-details" class="method-section section">
215
- <h3 class="section-header">Public Class Methods</h3>
213
+ <!-- Methods -->
214
+
215
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
216
+ <h3 class="section-header">Public Class Methods</h3>
216
217
 
217
-
218
- <div id="new-method" class="method-detail ">
219
- <a name="method-c-new"></a>
218
+
219
+ <div id="method-c-new" class="method-detail ">
220
+
221
+ <div class="method-heading">
222
+ <span class="method-name">new</span><span
223
+ class="method-args">(api_key = nil)</span>
224
+ <span class="method-click-advice">click to toggle source</span>
225
+ </div>
226
+
220
227
 
228
+ <div class="method-description">
221
229
 
222
- <div class="method-heading">
223
- <span class="method-name">new</span><span
224
- class="method-args">(api_key = nil)</span>
225
- <span class="method-click-advice">click to toggle source</span>
226
- </div>
227
-
228
-
229
- <div class="method-description">
230
-
231
- <h4>Create a new instance of the remote class to talk to Songkick</h4>
230
+ <h4 id="method-c-new-label-Create+a+new+instance+of+the+remote+class+to+talk+to+Songkick">Create a new instance of the remote class to talk to Songkick</h4>
232
231
 
233
232
  <p>Get an API key for your app from <a
234
233
  href="http://developer.songkick.com/">developer.songkick.com/</a></p>
235
-
234
+
236
235
 
237
-
238
- <div class="method-source-code" id="new-source">
239
- <pre>
240
- <span class="ruby-comment"># File lib/songkickr/remote.rb, line 12</span>
236
+
237
+ <div class="method-source-code" id="new-source">
238
+ <pre><span class="ruby-comment"># File lib/songkickr/remote.rb, line 12</span>
241
239
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">api_key</span> = <span class="ruby-keyword">nil</span>)
242
240
  <span class="ruby-ivar">@api_key</span> = <span class="ruby-identifier">api_key</span>
243
241
  <span class="ruby-ivar">@api_key</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Songkickr</span>.<span class="ruby-identifier">api_key</span>
244
-
242
+
245
243
  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">default_params</span> <span class="ruby-value">:apikey</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@api_key</span>
246
244
  <span class="ruby-keyword">end</span></pre>
247
- </div><!-- new-source -->
248
-
249
- </div>
250
-
245
+ </div><!-- new-source -->
251
246
 
247
+ </div>
252
248
 
253
-
254
- </div><!-- new-method -->
249
+
250
+
251
+
252
+ </div><!-- new-method -->
255
253
 
256
-
257
- </div><!-- public-class-method-details -->
258
254
 
259
- <div id="public-instance-method-details" class="method-section section">
260
- <h3 class="section-header">Public Instance Methods</h3>
255
+ </section><!-- public-class-method-details -->
256
+
257
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
258
+ <h3 class="section-header">Public Instance Methods</h3>
261
259
 
262
-
263
- <div id="artist_search-method" class="method-detail ">
264
- <a name="method-i-artist_search"></a>
260
+
261
+ <div id="method-i-artist_events" class="method-detail ">
262
+
263
+ <div class="method-heading">
264
+ <span class="method-name">artist_events</span><span
265
+ class="method-args">(artist_id, query = {})</span>
266
+ <span class="method-click-advice">click to toggle source</span>
267
+ </div>
268
+
269
+
270
+ <div class="method-description">
271
+
272
+ <h4 id="method-i-artist_events-label-Artist+calendar+%28Upcoming%29"><a href="Artist.html">Artist</a> calendar (Upcoming)</h4>
273
+
274
+ <p>Returns an array of Events.</p>
275
+
276
+ <p><a
277
+ href="http://www.songkick.com/developer/upcoming-events-for-artist">www.songkick.com/developer/upcoming-events-for-artist</a></p>
278
+
279
+ <h3 id="method-i-artist_events-label-Parameters">Parameters</h3>
280
+ <ul><li>
281
+ <p><code>artist_id</code> - Songkick unique ID for artist. Use <a
282
+ href="Remote.html#method-i-artist_search">#artist_search</a> to find an
283
+ artist ID.</p>
284
+ </li><li>
285
+ <p><code>query</code> - A hash of query parameters, see below for options.</p>
286
+ </li></ul>
287
+
288
+ <h4 id="method-i-artist_events-label-Query+Parameters">Query Parameters</h4>
289
+ <ul><li>
290
+ <p><code>page</code> - Page number</p>
291
+ </li><li>
292
+ <p><code>per_page</code> - Number of results per page, max 50.</p>
293
+ </li></ul>
294
+
265
295
 
266
296
 
267
- <div class="method-heading">
268
- <span class="method-name">artist_search</span><span
269
- class="method-args">(query={})</span>
270
- <span class="method-click-advice">click to toggle source</span>
271
- </div>
297
+ <div class="method-source-code" id="artist_events-source">
298
+ <pre><span class="ruby-comment"># File lib/songkickr/remote.rb, line 99</span>
299
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">artist_events</span>(<span class="ruby-identifier">artist_id</span>, <span class="ruby-identifier">query</span> = {})
300
+ <span class="ruby-identifier">result</span> = <span class="ruby-identifier">get</span>(<span class="ruby-node">&quot;/artists/#{artist_id}/calendar.json&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">query</span>)
301
+ <span class="ruby-constant">Songkickr</span><span class="ruby-operator">::</span><span class="ruby-constant">EventResult</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">result</span>
302
+ <span class="ruby-keyword">end</span></pre>
303
+ </div><!-- artist_events-source -->
272
304
 
305
+ </div>
306
+
307
+
308
+
309
+
310
+ </div><!-- artist_events-method -->
311
+
312
+
313
+ <div id="method-i-artist_search" class="method-detail ">
314
+
315
+ <div class="method-heading">
316
+ <span class="method-name">artist_search</span><span
317
+ class="method-args">(query={})</span>
318
+ <span class="method-click-advice">click to toggle source</span>
319
+ </div>
320
+
273
321
 
274
- <div class="method-description">
275
-
276
- <h4><a href="Artist.html">Artist</a> Search API</h4>
322
+ <div class="method-description">
323
+
324
+ <h4 id="method-i-artist_search-label-Artist+Search+API"><a href="Artist.html">Artist</a> Search API</h4>
277
325
 
278
326
  <p>Returns <a href="Artist.html">Artist</a> objects.</p>
279
327
 
280
328
  <p><a
281
329
  href="http://www.songkick.com/developer/artist-search">www.songkick.com/developer/artist-search</a></p>
282
330
 
283
- <h3>Parameters</h3>
331
+ <h3 id="method-i-artist_search-label-Parameters">Parameters</h3>
284
332
  <ul><li>
285
- <p><tt>query</tt> - Search for artists by name using full text search. Results
286
- from Songkick are returned by relevancy.</p>
333
+ <p><code>query</code> - Search for artists by name using full text search.
334
+ Results from Songkick are returned by relevancy.</p>
287
335
  </li></ul>
288
336
 
289
- <h4>Query Parameters</h4>
337
+ <h4 id="method-i-artist_search-label-Query+Parameters">Query Parameters</h4>
290
338
  <ul><li>
291
- <p><tt>artist_name</tt> - Name of an artist. <em>Ex. Lady Gaga’,
292
- Slayer’, Atmosphere’</em></p>
339
+ <p><code>artist_name</code> - Name of an artist. <em>Ex. 'Lady Gaga',
340
+ 'Slayer', 'Atmosphere'</em></p>
293
341
  </li></ul>
294
-
342
+
295
343
 
296
-
297
- <div class="method-source-code" id="artist_search-source">
298
- <pre>
299
- <span class="ruby-comment"># File lib/songkickr/remote.rb, line 83</span>
344
+
345
+ <div class="method-source-code" id="artist_search-source">
346
+ <pre><span class="ruby-comment"># File lib/songkickr/remote.rb, line 82</span>
300
347
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">artist_search</span>(<span class="ruby-identifier">query</span>={})
301
- <span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">get</span>(<span class="ruby-string">&quot;/search/artists.json&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">query</span>)
348
+ <span class="ruby-identifier">result</span> = <span class="ruby-identifier">get</span>(<span class="ruby-string">&quot;/search/artists.json&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">query</span>)
302
349
  <span class="ruby-constant">Songkickr</span><span class="ruby-operator">::</span><span class="ruby-constant">ArtistResult</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">result</span>
303
350
  <span class="ruby-keyword">end</span></pre>
304
- </div><!-- artist_search-source -->
305
-
306
- </div>
307
-
351
+ </div><!-- artist_search-source -->
308
352
 
353
+ </div>
309
354
 
310
-
311
- </div><!-- artist_search-method -->
355
+
312
356
 
313
-
314
- <div id="concert_setlists-method" class="method-detail ">
315
- <a name="method-i-concert_setlists"></a>
357
+
358
+ </div><!-- artist_search-method -->
316
359
 
317
-
318
- <div class="method-heading">
319
- <span class="method-name">concert_setlists</span><span
320
- class="method-args">(event_id)</span>
321
- <span class="method-click-advice">click to toggle source</span>
322
- </div>
323
-
360
+
361
+ <div id="method-i-concert_setlists" class="method-detail ">
362
+
363
+ <div class="method-heading">
364
+ <span class="method-name">concert_setlists</span><span
365
+ class="method-args">(event_id)</span>
366
+ <span class="method-click-advice">click to toggle source</span>
367
+ </div>
368
+
324
369
 
325
- <div class="method-description">
326
-
327
- <h4>Concert Setlists API</h4>
370
+ <div class="method-description">
371
+
372
+ <h4 id="method-i-concert_setlists-label-Concert+Setlists+API">Concert Setlists API</h4>
328
373
 
329
374
  <p><a
330
375
  href="http://www.songkick.com/developer/setlists">www.songkick.com/developer/setlists</a></p>
331
376
 
332
- <h3>Parameters</h3>
377
+ <h3 id="method-i-concert_setlists-label-Parameters">Parameters</h3>
333
378
  <ul><li>
334
- <p><tt>event_id</tt> - Songkick event ID. Extract the event ID either from a
335
- previous API call or from the URL of the event page on the website.</p>
379
+ <p><code>event_id</code> - Songkick event ID. Extract the event ID either from
380
+ a previous API call or from the URL of the event page on the website.</p>
336
381
  </li></ul>
337
-
382
+
338
383
 
339
-
340
- <div class="method-source-code" id="concert_setlists-source">
341
- <pre>
342
- <span class="ruby-comment"># File lib/songkickr/remote.rb, line 133</span>
384
+
385
+ <div class="method-source-code" id="concert_setlists-source">
386
+ <pre><span class="ruby-comment"># File lib/songkickr/remote.rb, line 164</span>
343
387
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">concert_setlists</span>(<span class="ruby-identifier">event_id</span>)
344
- <span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">get</span>(<span class="ruby-node">&quot;/events/#{event_id}/setlists.json&quot;</span>)
388
+ <span class="ruby-identifier">result</span> = <span class="ruby-identifier">get</span>(<span class="ruby-node">&quot;/events/#{event_id}/setlists.json&quot;</span>)
345
389
  <span class="ruby-constant">Songkickr</span><span class="ruby-operator">::</span><span class="ruby-constant">ConcertSetlistResult</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">result</span>
346
390
  <span class="ruby-keyword">end</span></pre>
347
- </div><!-- concert_setlists-source -->
348
-
349
- </div>
350
-
391
+ </div><!-- concert_setlists-source -->
351
392
 
393
+ </div>
352
394
 
353
-
354
- </div><!-- concert_setlists-method -->
395
+
355
396
 
356
-
357
- <div id="event-method" class="method-detail ">
358
- <a name="method-i-event"></a>
397
+
398
+ </div><!-- concert_setlists-method -->
359
399
 
360
-
361
- <div class="method-heading">
362
- <span class="method-name">event</span><span
363
- class="method-args">(event_id)</span>
364
- <span class="method-click-advice">click to toggle source</span>
365
- </div>
366
-
400
+
401
+ <div id="method-i-event" class="method-detail ">
402
+
403
+ <div class="method-heading">
404
+ <span class="method-name">event</span><span
405
+ class="method-args">(event_id)</span>
406
+ <span class="method-click-advice">click to toggle source</span>
407
+ </div>
408
+
367
409
 
368
- <div class="method-description">
369
-
370
- <h4><a href="Event.html">Event</a> API</h4>
410
+ <div class="method-description">
411
+
412
+ <h4 id="method-i-event-label-Event+API"><a href="Event.html">Event</a> API</h4>
371
413
 
372
414
  <p><a
373
415
  href="http://www.songkick.com/developer/upcoming-events">www.songkick.com/developer/upcoming-events</a></p>
374
416
 
375
417
  <p>Getting detailed information of a single event.</p>
376
418
 
377
- <h3>Parameters</h3>
419
+ <h3 id="method-i-event-label-Parameters">Parameters</h3>
378
420
  <ul><li>
379
- <p><tt>event_id</tt> - Songkick event ID. Extract the event ID either from a
380
- previous API call or from the URL of the event page on the website.</p>
421
+ <p><code>event_id</code> - Songkick event ID. Extract the event ID either from
422
+ a previous API call or from the URL of the event page on the website.</p>
381
423
  </li></ul>
382
-
424
+
383
425
 
384
-
385
- <div class="method-source-code" id="event-source">
386
- <pre>
387
- <span class="ruby-comment"># File lib/songkickr/remote.rb, line 50</span>
426
+
427
+ <div class="method-source-code" id="event-source">
428
+ <pre><span class="ruby-comment"># File lib/songkickr/remote.rb, line 50</span>
388
429
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">event</span>(<span class="ruby-identifier">event_id</span>)
389
- <span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">get</span>(<span class="ruby-node">&quot;/events/#{event_id}.json&quot;</span>)
390
- <span class="ruby-comment"># and now for some dirrty hack</span>
430
+ <span class="ruby-identifier">result</span> = <span class="ruby-identifier">get</span>(<span class="ruby-node">&quot;/events/#{event_id}.json&quot;</span>)
391
431
  <span class="ruby-constant">Songkickr</span><span class="ruby-operator">::</span><span class="ruby-constant">Event</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">result</span>[<span class="ruby-string">&quot;resultsPage&quot;</span>][<span class="ruby-string">&quot;results&quot;</span>][<span class="ruby-string">&quot;event&quot;</span>]
392
432
  <span class="ruby-keyword">end</span></pre>
393
- </div><!-- event-source -->
394
-
395
- </div>
396
-
433
+ </div><!-- event-source -->
397
434
 
435
+ </div>
398
436
 
399
-
400
- </div><!-- event-method -->
437
+
401
438
 
402
-
403
- <div id="events-method" class="method-detail ">
404
- <a name="method-i-events"></a>
439
+
440
+ </div><!-- event-method -->
405
441
 
406
-
407
- <div class="method-heading">
408
- <span class="method-name">events</span><span
409
- class="method-args">(query = {})</span>
410
- <span class="method-click-advice">click to toggle source</span>
411
- </div>
412
-
442
+
443
+ <div id="method-i-events" class="method-detail ">
444
+
445
+ <div class="method-heading">
446
+ <span class="method-name">events</span><span
447
+ class="method-args">(query = {})</span>
448
+ <span class="method-click-advice">click to toggle source</span>
449
+ </div>
450
+
413
451
 
414
- <div class="method-description">
415
-
416
- <h4><a href="Event.html">Event</a> Search API</h4>
452
+ <div class="method-description">
453
+
454
+ <h4 id="method-i-events-label-Event+Search+API"><a href="Event.html">Event</a> Search API</h4>
417
455
 
418
456
  <p><a
419
457
  href="http://www.songkick.com/developer/event-search">www.songkick.com/developer/event-search</a></p>
420
458
 
421
- <h3>Parameters</h3>
459
+ <h3 id="method-i-events-label-Parameters">Parameters</h3>
422
460
  <ul><li>
423
- <p><tt>query</tt> - A hash of query parameters, see below for options.</p>
461
+ <p><code>query</code> - A hash of query parameters, see below for options.</p>
424
462
  </li></ul>
425
463
 
426
- <p><em>Example:</em> <tt>{ :type =&gt; 'concert', :artists =&gt; 'Coolio'
427
- }</tt></p>
464
+ <p><em>Example:</em> <code>{ :type =&gt; 'concert', :artists =&gt; 'Coolio'
465
+ }</code></p>
428
466
 
429
- <h4>Query Parameters</h4>
467
+ <h4 id="method-i-events-label-Query+Parameters">Query Parameters</h4>
430
468
  <ul><li>
431
- <p><tt>type</tt> - valid types: concert or festival</p>
469
+ <p><code>type</code> - valid types: concert or festival</p>
432
470
  </li><li>
433
- <p><tt>artists</tt> - events by any of the artists, comma-separated</p>
471
+ <p><code>artists</code> - events by any of the artists, comma-separated</p>
434
472
  </li><li>
435
- <p><tt>artist_name</tt> - plain text name of artist ex. As I Lay Dying’,
436
- Parkway Drive’, Animals As Leaders’</p>
473
+ <p><code>artist_name</code> - plain text name of artist ex. 'As I Lay Dying',
474
+ 'Parkway Drive', 'Animals As Leaders'</p>
437
475
  </li><li>
438
- <p><tt>artist_id</tt> - Songkick unique ID for an artist</p>
476
+ <p><code>artist_id</code> - Songkick unique ID for an artist</p>
439
477
  </li><li>
440
- <p><tt>venue_id</tt> - Songkick unique ID for a venue</p>
478
+ <p><code>venue_id</code> - Songkick unique ID for a venue</p>
441
479
  </li><li>
442
- <p><tt>setlist_item_name</tt> - name of a song which was played at the event
443
- – use with artist_id or artist_name</p>
480
+ <p><code>setlist_item_name</code> - name of a song which was played at the
481
+ event – use with artist_id or artist_name</p>
444
482
  </li><li>
445
- <p><tt>min_date</tt> - Oldest date for which you want to look for events</p>
483
+ <p><code>min_date</code> - Oldest date for which you want to look for events</p>
446
484
  </li><li>
447
- <p><tt>max_date</tt> - Most recent date for which you want to look for events</p>
485
+ <p><code>max_date</code> - Most recent date for which you want to look for
486
+ events</p>
448
487
  </li><li>
449
- <p><tt>location</tt> - See the Songkick website for instructions on how to use
450
- the location parameter <a
488
+ <p><code>location</code> - See the Songkick website for instructions on how to
489
+ use the location parameter <a
451
490
  href="http://www.songkick.com/developer/location-search">www.songkick.com/developer/location-search</a></p>
452
491
  </li></ul>
453
-
492
+
454
493
 
455
-
456
- <div class="method-source-code" id="events-source">
457
- <pre>
458
- <span class="ruby-comment"># File lib/songkickr/remote.rb, line 37</span>
494
+
495
+ <div class="method-source-code" id="events-source">
496
+ <pre><span class="ruby-comment"># File lib/songkickr/remote.rb, line 37</span>
459
497
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">events</span>(<span class="ruby-identifier">query</span> = {})
460
498
  <span class="ruby-identifier">path</span> = <span class="ruby-identifier">extract_path_from_query</span>(<span class="ruby-identifier">query</span>)
461
- <span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">get</span>(<span class="ruby-node">&quot;#{path}/events.json&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">query</span>)
499
+ <span class="ruby-identifier">result</span> = <span class="ruby-identifier">get</span>(<span class="ruby-node">&quot;#{path}/events.json&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">query</span>)
462
500
  <span class="ruby-constant">Songkickr</span><span class="ruby-operator">::</span><span class="ruby-constant">EventResult</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">result</span>
463
501
  <span class="ruby-keyword">end</span></pre>
464
- </div><!-- events-source -->
465
-
466
- </div>
467
-
502
+ </div><!-- events-source -->
468
503
 
504
+ </div>
469
505
 
470
-
471
- </div><!-- events-method -->
506
+
472
507
 
473
-
474
- <div id="gigography-method" class="method-detail ">
475
- <a name="method-i-gigography"></a>
508
+
509
+ </div><!-- events-method -->
476
510
 
511
+
512
+ <div id="method-i-get" class="method-detail ">
513
+
514
+ <div class="method-heading">
515
+ <span class="method-name">get</span><span
516
+ class="method-args">(location, query_params = {})</span>
517
+ <span class="method-click-advice">click to toggle source</span>
518
+ </div>
519
+
520
+
521
+ <div class="method-description">
522
+
477
523
 
478
- <div class="method-heading">
479
- <span class="method-name">gigography</span><span
480
- class="method-args">(artist_id, query= {})</span>
481
- <span class="method-click-advice">click to toggle source</span>
482
- </div>
483
524
 
484
525
 
485
- <div class="method-description">
486
-
487
- <h4>Gigography API</h4>
526
+
527
+ <div class="method-source-code" id="get-source">
528
+ <pre><span class="ruby-comment"># File lib/songkickr/remote.rb, line 193</span>
529
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">location</span>, <span class="ruby-identifier">query_params</span> = {})
530
+ <span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">location</span>, <span class="ruby-identifier">query_params</span>)
531
+ <span class="ruby-comment"># FIXME: this is shit. should be based on on http response.</span>
532
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">result</span>[<span class="ruby-string">'resultsPage'</span>][<span class="ruby-string">'error'</span>]
533
+ <span class="ruby-identifier">msg</span> = <span class="ruby-identifier">result</span>[<span class="ruby-string">'resultsPage'</span>][<span class="ruby-string">'error'</span>][<span class="ruby-string">'message'</span>]
534
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">ResourceNotFound</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">msg</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">%rnot found/</span>
535
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">APIError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">msg</span>)
536
+ <span class="ruby-keyword">end</span>
537
+ <span class="ruby-identifier">result</span>
538
+ <span class="ruby-keyword">end</span></pre>
539
+ </div><!-- get-source -->
540
+
541
+ </div>
542
+
543
+
544
+
545
+
546
+ </div><!-- get-method -->
547
+
548
+
549
+ <div id="method-i-gigography" class="method-detail ">
550
+
551
+ <div class="method-heading">
552
+ <span class="method-name">gigography</span><span
553
+ class="method-args">(artist_id, query= {})</span>
554
+ <span class="method-click-advice">click to toggle source</span>
555
+ </div>
556
+
557
+
558
+ <div class="method-description">
559
+
560
+ <h4 id="method-i-gigography-label-Gigography+API">Gigography API</h4>
488
561
 
489
562
  <p><a
490
563
  href="http://groups.google.com/group/songkick-api/browse_thread/thread/af15b9a6ad3c3513">groups.google.com/group/songkick-api/browse_thread/thread/af15b9a6ad3c3513</a>#</p>
491
564
 
492
- <h3>Parameters</h3>
565
+ <h3 id="method-i-gigography-label-Parameters">Parameters</h3>
493
566
  <ul><li>
494
- <p><tt>artist_id</tt> - Songkick artist_id, use <a
495
- href="Remote.html#method-i-artist_search">artist_search</a> to get it</p>
567
+ <p><code>artist_id</code> - Songkick artist_id, use <a
568
+ href="Remote.html#method-i-artist_search">#artist_search</a> to get it</p>
496
569
  </li><li>
497
- <p><tt>query</tt> - A hash of query parameters, see below for options.</p>
570
+ <p><code>query</code> - A hash of query parameters, see below for options.</p>
498
571
  </li></ul>
499
572
 
500
- <h4>Query Parameters</h4>
573
+ <h4 id="method-i-gigography-label-Query+Parameters">Query Parameters</h4>
501
574
  <ul><li>
502
- <p><tt>min_date</tt> - Oldest date for which you want to look for events</p>
575
+ <p><code>min_date</code> - Oldest date for which you want to look for events</p>
503
576
  </li><li>
504
- <p><tt>max_date</tt> - Most recent date for which you want to look for events</p>
577
+ <p><code>max_date</code> - Most recent date for which you want to look for
578
+ events</p>
505
579
  </li><li>
506
- <p><tt>per_page</tt> - Number of items on a page</p>
580
+ <p><code>per_page</code> - Number of items on a page</p>
507
581
  </li><li>
508
- <p><tt>page</tt> - Number of page</p>
582
+ <p><code>page</code> - Number of page</p>
509
583
  </li></ul>
510
-
584
+
511
585
 
512
-
513
- <div class="method-source-code" id="gigography-source">
514
- <pre>
515
- <span class="ruby-comment"># File lib/songkickr/remote.rb, line 68</span>
586
+
587
+ <div class="method-source-code" id="gigography-source">
588
+ <pre><span class="ruby-comment"># File lib/songkickr/remote.rb, line 67</span>
516
589
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">gigography</span>(<span class="ruby-identifier">artist_id</span>, <span class="ruby-identifier">query</span>= {})
517
- <span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">get</span>(<span class="ruby-node">&quot;/artists/#{artist_id}/gigography.json&quot;</span>,<span class="ruby-value">:query=</span><span class="ruby-operator">&gt;</span><span class="ruby-identifier">query</span>)
590
+ <span class="ruby-identifier">result</span> = <span class="ruby-identifier">get</span>(<span class="ruby-node">&quot;/artists/#{artist_id}/gigography.json&quot;</span>,<span class="ruby-value">:query=</span><span class="ruby-operator">&gt;</span><span class="ruby-identifier">query</span>)
518
591
  <span class="ruby-constant">Songkickr</span><span class="ruby-operator">::</span><span class="ruby-constant">EventResult</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">result</span>
519
592
  <span class="ruby-keyword">end</span></pre>
520
- </div><!-- gigography-source -->
521
-
522
- </div>
523
-
593
+ </div><!-- gigography-source -->
524
594
 
595
+ </div>
525
596
 
526
-
527
- </div><!-- gigography-method -->
597
+
528
598
 
529
-
530
- <div id="location_search-method" class="method-detail ">
531
- <a name="method-i-location_search"></a>
599
+
600
+ </div><!-- gigography-method -->
532
601
 
533
-
534
- <div class="method-heading">
535
- <span class="method-name">location_search</span><span
536
- class="method-args">(query = {})</span>
537
- <span class="method-click-advice">click to toggle source</span>
538
- </div>
539
-
602
+
603
+ <div id="method-i-location_search" class="method-detail ">
604
+
605
+ <div class="method-heading">
606
+ <span class="method-name">location_search</span><span
607
+ class="method-args">(query = {})</span>
608
+ <span class="method-click-advice">click to toggle source</span>
609
+ </div>
610
+
540
611
 
541
- <div class="method-description">
542
-
543
- <h4><a href="Location.html">Location</a> Search API</h4>
612
+ <div class="method-description">
613
+
614
+ <h4 id="method-i-location_search-label-Location+Search+API"><a href="Location.html">Location</a> Search API</h4>
544
615
 
545
616
  <p><a
546
617
  href="http://www.songkick.com/developer/location-search">www.songkick.com/developer/location-search</a></p>
547
618
 
548
- <h3>Parameters</h3>
619
+ <h3 id="method-i-location_search-label-Parameters">Parameters</h3>
549
620
  <ul><li>
550
- <p><tt>query</tt> - A hash of query parameters, see below for options.</p>
621
+ <p><code>query</code> - A hash of query parameters, see below for options.</p>
551
622
  </li></ul>
552
623
 
553
- <h4>Query Parameters</h4>
624
+ <h4 id="method-i-location_search-label-Query+Parameters">Query Parameters</h4>
554
625
  <ul><li>
555
- <p><tt>location</tt> - geo:{lat,lng} string <em>Ex.
556
- geo:{-0.128,51.5078}’</em></p>
626
+ <p><code>location</code> - 'geo:{lat,lng}' string <em>Ex.
627
+ 'geo:{-0.128,51.5078}'</em></p>
557
628
  </li></ul>
558
-
629
+
559
630
 
560
-
561
- <div class="method-source-code" id="location_search-source">
562
- <pre>
563
- <span class="ruby-comment"># File lib/songkickr/remote.rb, line 146</span>
631
+
632
+ <div class="method-source-code" id="location_search-source">
633
+ <pre><span class="ruby-comment"># File lib/songkickr/remote.rb, line 177</span>
564
634
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">location_search</span>(<span class="ruby-identifier">query</span> = {})
565
- <span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">get</span>(<span class="ruby-string">&quot;/search/locations.json&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">query</span>)
635
+ <span class="ruby-identifier">result</span> = <span class="ruby-identifier">get</span>(<span class="ruby-string">&quot;/search/locations.json&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">query</span>)
566
636
  <span class="ruby-constant">Songkickr</span><span class="ruby-operator">::</span><span class="ruby-constant">LocationResult</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">result</span>
567
637
  <span class="ruby-keyword">end</span></pre>
568
- </div><!-- location_search-source -->
569
-
570
- </div>
571
-
638
+ </div><!-- location_search-source -->
572
639
 
640
+ </div>
573
641
 
574
-
575
- </div><!-- location_search-method -->
642
+
576
643
 
577
-
578
- <div id="metro_areas_events-method" class="method-detail ">
579
- <a name="method-i-metro_areas_events"></a>
644
+
645
+ </div><!-- location_search-method -->
580
646
 
581
-
582
- <div class="method-heading">
583
- <span class="method-name">metro_areas_events</span><span
584
- class="method-args">(metro_area_id, query = {})</span>
585
- <span class="method-click-advice">click to toggle source</span>
586
- </div>
587
-
647
+
648
+ <div id="method-i-metro_areas_events" class="method-detail ">
649
+
650
+ <div class="method-heading">
651
+ <span class="method-name">metro_areas_events</span><span
652
+ class="method-args">(metro_area_id, query = {})</span>
653
+ <span class="method-click-advice">click to toggle source</span>
654
+ </div>
655
+
588
656
 
589
- <div class="method-description">
590
-
591
- <h4>Metro Area Events (Upcoming)</h4>
657
+ <div class="method-description">
658
+
659
+ <h4 id="method-i-metro_areas_events-label-Metro+Area+Events+%28Upcoming%29">Metro Area Events (Upcoming)</h4>
592
660
 
593
661
  <p>Returns an array of Events.</p>
594
662
 
595
663
  <p><a
596
664
  href="http://www.songkick.com/developer/upcoming-events-for-metro-area">www.songkick.com/developer/upcoming-events-for-metro-area</a></p>
597
665
 
598
- <h3>Parameters</h3>
666
+ <h3 id="method-i-metro_areas_events-label-Parameters">Parameters</h3>
599
667
  <ul><li>
600
- <p><tt>metro_area_id</tt> - Songkick unique ID for metro areas. Use <a
601
- href="Remote.html#method-i-location_search">location_search</a> to find a
668
+ <p><code>metro_area_id</code> - Songkick unique ID for metro areas. Use <a
669
+ href="Remote.html#method-i-location_search">#location_search</a> to find a
602
670
  metro area ID.</p>
603
671
  </li><li>
604
- <p><tt>query</tt> - A hash of query parameters, see below for options.</p>
672
+ <p><code>query</code> - A hash of query parameters, see below for options.</p>
605
673
  </li></ul>
606
674
 
607
- <h4>Query Parameters</h4>
675
+ <h4 id="method-i-metro_areas_events-label-Query+Parameters">Query Parameters</h4>
608
676
  <ul><li>
609
- <p><tt>page</tt> - Page number</p>
677
+ <p><code>page</code> - Page number</p>
610
678
  </li><li>
611
- <p><tt>per_page</tt> - Number of results per page, max 50.</p>
679
+ <p><code>per_page</code> - Number of results per page, max 50.</p>
612
680
  </li></ul>
613
-
681
+
614
682
 
615
-
616
- <div class="method-source-code" id="metro_areas_events-source">
617
- <pre>
618
- <span class="ruby-comment"># File lib/songkickr/remote.rb, line 122</span>
683
+
684
+ <div class="method-source-code" id="metro_areas_events-source">
685
+ <pre><span class="ruby-comment"># File lib/songkickr/remote.rb, line 153</span>
619
686
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">metro_areas_events</span>(<span class="ruby-identifier">metro_area_id</span>, <span class="ruby-identifier">query</span> = {})
620
- <span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">get</span>(<span class="ruby-node">&quot;/metro_areas/#{metro_area_id}/calendar.json&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">query</span>)
687
+ <span class="ruby-identifier">result</span> = <span class="ruby-identifier">get</span>(<span class="ruby-node">&quot;/metro_areas/#{metro_area_id}/calendar.json&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">query</span>)
621
688
  <span class="ruby-constant">Songkickr</span><span class="ruby-operator">::</span><span class="ruby-constant">EventResult</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">result</span>
622
689
  <span class="ruby-keyword">end</span></pre>
623
- </div><!-- metro_areas_events-source -->
624
-
625
- </div>
626
-
690
+ </div><!-- metro_areas_events-source -->
627
691
 
692
+ </div>
628
693
 
629
-
630
- </div><!-- metro_areas_events-method -->
694
+
631
695
 
632
-
633
- <div id="users_events-method" class="method-detail ">
634
- <a name="method-i-users_events"></a>
696
+
697
+ </div><!-- metro_areas_events-method -->
635
698
 
636
-
637
- <div class="method-heading">
638
- <span class="method-name">users_events</span><span
639
- class="method-args">(username, query = {})</span>
640
- <span class="method-click-advice">click to toggle source</span>
641
- </div>
642
-
699
+
700
+ <div id="method-i-users_events" class="method-detail ">
701
+
702
+ <div class="method-heading">
703
+ <span class="method-name">users_events</span><span
704
+ class="method-args">(username, query = {})</span>
705
+ <span class="method-click-advice">click to toggle source</span>
706
+ </div>
707
+
643
708
 
644
- <div class="method-description">
645
-
646
- <h4>User Events API</h4>
709
+ <div class="method-description">
710
+
711
+ <h4 id="method-i-users_events-label-User+Events+API">User Events API</h4>
647
712
 
648
713
  <p><a
649
714
  href="http://www.songkick.com/developer/upcoming-events-for-user">www.songkick.com/developer/upcoming-events-for-user</a></p>
650
715
 
651
- <h3>Parameters</h3>
716
+ <h3 id="method-i-users_events-label-Parameters">Parameters</h3>
652
717
  <ul><li>
653
- <p><tt>username</tt> - A Songkick username.</p>
718
+ <p><code>username</code> - A Songkick username.</p>
654
719
  </li><li>
655
- <p><tt>query</tt> - A hash of query parameters, see below for options.</p>
720
+ <p><code>query</code> - A hash of query parameters, see below for options.</p>
656
721
  </li></ul>
657
722
 
658
- <h4>Query Parameters</h4>
723
+ <h4 id="method-i-users_events-label-Query+Parameters">Query Parameters</h4>
659
724
  <ul><li>
660
- <p><tt>attendance</tt> (all, im_going, i_might_go) - defaults to im_going</p>
725
+ <p><code>attendance</code> (all, im_going, i_might_go) - defaults to im_going</p>
661
726
  </li><li>
662
- <p><tt>type</tt> (concert or festival)</p>
727
+ <p><code>type</code> (concert or festival)</p>
663
728
  </li><li>
664
- <p><tt>artists</tt> (events by any of the artists, comma-separated)</p>
729
+ <p><code>artists</code> (events by any of the artists, comma-separated)</p>
665
730
  </li><li>
666
- <p><tt>artist_id</tt> - Songkick unique ID for an artist</p>
731
+ <p><code>artist_id</code> - Songkick unique ID for an artist</p>
667
732
  </li><li>
668
- <p><tt>venue_id</tt> - Songkick unique ID for a venue</p>
733
+ <p><code>venue_id</code> - Songkick unique ID for a venue</p>
669
734
  </li><li>
670
- <p><tt>setlist_item_name</tt> (name of a song which was played at the event
671
- – use with artist_id or artist_name)</p>
735
+ <p><code>setlist_item_name</code> (name of a song which was played at the
736
+ event – use with artist_id or artist_name)</p>
672
737
  </li><li>
673
- <p><tt>min_date</tt> - Oldest date for which you want to look for events</p>
738
+ <p><code>min_date</code> - Oldest date for which you want to look for events</p>
674
739
  </li><li>
675
- <p><tt>max_date</tt> - Most recent date for which you want to look for events</p>
740
+ <p><code>max_date</code> - Most recent date for which you want to look for
741
+ events</p>
676
742
  </li><li>
677
- <p><tt>location</tt> - see the Songkick website for instructions on how to use
678
- the location parameter</p>
743
+ <p><code>location</code> - see the Songkick website for instructions on how to
744
+ use the location parameter</p>
679
745
  </li></ul>
680
-
746
+
681
747
 
682
-
683
- <div class="method-source-code" id="users_events-source">
684
- <pre>
685
- <span class="ruby-comment"># File lib/songkickr/remote.rb, line 105</span>
748
+
749
+ <div class="method-source-code" id="users_events-source">
750
+ <pre><span class="ruby-comment"># File lib/songkickr/remote.rb, line 121</span>
686
751
  <span class="ruby-keyword">def</span> <span class="ruby-identifier">users_events</span>(<span class="ruby-identifier">username</span>, <span class="ruby-identifier">query</span> = {})
687
- <span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">get</span>(<span class="ruby-node">&quot;/users/#{username}/events.json&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">query</span>)
752
+ <span class="ruby-identifier">result</span> = <span class="ruby-identifier">get</span>(<span class="ruby-node">&quot;/users/#{username}/events.json&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">query</span>)
688
753
  <span class="ruby-constant">Songkickr</span><span class="ruby-operator">::</span><span class="ruby-constant">EventResult</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">result</span>
689
754
  <span class="ruby-keyword">end</span></pre>
690
- </div><!-- users_events-source -->
691
-
692
- </div>
755
+ </div><!-- users_events-source -->
756
+
757
+ </div>
693
758
 
759
+
760
+
761
+
762
+ </div><!-- users_events-method -->
763
+
764
+
765
+ <div id="method-i-users_tracked_artists" class="method-detail ">
766
+
767
+ <div class="method-heading">
768
+ <span class="method-name">users_tracked_artists</span><span
769
+ class="method-args">(username, query = {})</span>
770
+ <span class="method-click-advice">click to toggle source</span>
771
+ </div>
772
+
773
+
774
+ <div class="method-description">
694
775
 
776
+ <h4 id="method-i-users_tracked_artists-label-User+Tracked+Artists">User Tracked Artists</h4>
777
+
778
+ <p><a
779
+ href="http://www.songkick.com/developer/trackings">www.songkick.com/developer/trackings</a></p>
695
780
 
781
+ <h3 id="method-i-users_tracked_artists-label-Parameters">Parameters</h3>
782
+ <ul><li>
783
+ <p><code>username</code> - A Songkick username.</p>
784
+ </li><li>
785
+ <p><code>query</code> - A hash of query parameters, see below for options.</p>
786
+ </li></ul>
787
+
788
+ <h4 id="method-i-users_tracked_artists-label-Query+Parameters">Query Parameters</h4>
789
+ <ul><li>
790
+ <p><code>page</code> - Page number</p>
791
+ </li><li>
792
+ <p><code>per_page</code> - Number of results per page, max 50.</p>
793
+ </li></ul>
696
794
 
697
- </div><!-- users_events-method -->
698
795
 
699
-
700
- </div><!-- public-instance-method-details -->
796
+
797
+ <div class="method-source-code" id="users_tracked_artists-source">
798
+ <pre><span class="ruby-comment"># File lib/songkickr/remote.rb, line 136</span>
799
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">users_tracked_artists</span>(<span class="ruby-identifier">username</span>, <span class="ruby-identifier">query</span> = {})
800
+ <span class="ruby-identifier">result</span> = <span class="ruby-identifier">get</span>(<span class="ruby-node">&quot;/users/#{username}/artists/tracked.json&quot;</span>, <span class="ruby-value">:query</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">query</span>)
801
+ <span class="ruby-constant">Songkickr</span><span class="ruby-operator">::</span><span class="ruby-constant">ArtistResult</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">result</span>
802
+ <span class="ruby-keyword">end</span></pre>
803
+ </div><!-- users_tracked_artists-source -->
804
+
805
+ </div>
806
+
807
+
808
+
809
+
810
+ </div><!-- users_tracked_artists-method -->
811
+
812
+
813
+ <div id="method-i-venue" class="method-detail ">
814
+
815
+ <div class="method-heading">
816
+ <span class="method-name">venue</span><span
817
+ class="method-args">(venue_id)</span>
818
+ <span class="method-click-advice">click to toggle source</span>
819
+ </div>
820
+
821
+
822
+ <div class="method-description">
823
+
824
+ <h4 id="method-i-venue-label-Venue+Search"><a href="Venue.html">Venue</a> Search</h4>
825
+
826
+ <p><a
827
+ href="http://www.songkick.com/developer/venue-details">www.songkick.com/developer/venue-details</a></p>
828
+
829
+ <h3 id="method-i-venue-label-Parameters">Parameters</h3>
830
+ <ul><li>
831
+ <p><code>venue_id</code> - Songkick venue ID.</p>
832
+ </li></ul>
833
+
834
+
835
+
836
+ <div class="method-source-code" id="venue-source">
837
+ <pre><span class="ruby-comment"># File lib/songkickr/remote.rb, line 188</span>
838
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">venue</span>(<span class="ruby-identifier">venue_id</span>)
839
+ <span class="ruby-identifier">result</span> = <span class="ruby-identifier">get</span>(<span class="ruby-node">&quot;/venues/#{venue_id}.json&quot;</span>)
840
+ <span class="ruby-constant">Songkickr</span><span class="ruby-operator">::</span><span class="ruby-constant">Venue</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">result</span>[<span class="ruby-string">'resultsPage'</span>][<span class="ruby-string">'results'</span>][<span class="ruby-string">'venue'</span>]
841
+ <span class="ruby-keyword">end</span></pre>
842
+ </div><!-- venue-source -->
843
+
844
+ </div>
845
+
846
+
847
+
848
+
849
+ </div><!-- venue-method -->
850
+
701
851
 
702
- </div><!-- 5Buntitled-5D -->
852
+ </section><!-- public-instance-method-details -->
703
853
 
854
+ </section><!-- 5Buntitled-5D -->
704
855
 
705
- </div><!-- documentation -->
856
+ </div><!-- documentation -->
706
857
 
707
- <div id="validator-badges">
708
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
709
- <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
710
- Rdoc Generator</a> 2</small>.</p>
711
- </div>
712
858
 
713
- </body>
714
- </html>
859
+ <footer id="validator-badges">
860
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
861
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
862
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
863
+ </footer>
715
864