echonest-ruby-api 0.1.0 → 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
data/doc/file.README.html DELETED
@@ -1,128 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
- <head>
5
- <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII" />
6
- <title>
7
- File: README
8
-
9
- &mdash; Documentation by YARD 0.8.4.1
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
14
-
15
- <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
16
-
17
- <script type="text/javascript" charset="utf-8">
18
- hasFrames = window.top.frames.main ? true : false;
19
- relpath = '';
20
- framesUrl = "frames.html#!" + escape(window.location.href);
21
- </script>
22
-
23
-
24
- <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25
-
26
- <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27
-
28
-
29
- </head>
30
- <body>
31
- <div id="header">
32
- <div id="menu">
33
-
34
- <a href="_index.html">Index</a> &raquo;
35
- <span class="title">File: README</span>
36
-
37
-
38
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
39
- </div>
40
-
41
- <div id="search">
42
-
43
- <a class="full_list_link" id="class_list_link"
44
- href="class_list.html">
45
- Class List
46
- </a>
47
-
48
- <a class="full_list_link" id="method_list_link"
49
- href="method_list.html">
50
- Method List
51
- </a>
52
-
53
- <a class="full_list_link" id="file_list_link"
54
- href="file_list.html">
55
- File List
56
- </a>
57
-
58
- </div>
59
- <div class="clear"></div>
60
- </div>
61
-
62
- <iframe id="search_frame"></iframe>
63
-
64
- <div id="content"><div id='filecontents'><h1 id="echonest-ruby-api-code-climatehttpscodeclimatecomgithubmaxehmookauechonest-ruby-apipnghttpscodeclimatecomgithubmaxehmookauechonest-ruby-api">echonest-ruby-api <a href="https://codeclimate.com/github/maxehmookau/echonest-ruby-api"><img src="https://codeclimate.com/github/maxehmookau/echonest-ruby-api.png" alt="Code Climate" /></a></h1>
65
- <p><a href="https://travis-ci.org/maxehmookau/echonest-ruby-api"><img src="https://travis-ci.org/maxehmookau/echonest-ruby-api.png" alt="Build Status" /></a>
66
- <a href="https://gemnasium.com/maxehmookau/echonest-ruby-api"><img src="https://gemnasium.com/maxehmookau/echonest-ruby-api.png" alt="Dependency Status" /></a>
67
- TODO: Everything. (also, come up with a cool name)</p>
68
-
69
- <h2 id="installation">Installation</h2>
70
-
71
- <p>Add this line to your application&rsquo;s Gemfile:</p>
72
-
73
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>echonest-ruby-api</span><span class='tstring_end'>'</span></span>
74
- </code></pre>
75
-
76
- <p>And then execute:</p>
77
-
78
- <pre class="code ruby"><code class="ruby">$ bundle
79
- </code></pre>
80
-
81
- <p>Or install it yourself as:</p>
82
-
83
- <pre class="code ruby"><code class="ruby">$ gem install echonest-ruby-api
84
- </code></pre>
85
-
86
- <p><em>That said, probably don&rsquo;t do any of that, since nothing works yet&hellip;</em></p>
87
-
88
- <h2 id="usage">Usage</h2>
89
-
90
- <p>Require the gem in your file:</p>
91
-
92
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>echonest-ruby-api</span><span class='tstring_end'>'</span></span>
93
- </code></pre>
94
-
95
- <p>Create an instance of an object</p>
96
-
97
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_a'>a</span> <span class='op'>=</span> <span class='const'>Echonest</span><span class='op'>::</span><span class='const'>Artist</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Weezer</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>YOUR-API-KEY</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
98
- </code></pre>
99
-
100
- <p>Find out some stuff!</p>
101
-
102
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_a'>a</span><span class='period'>.</span><span class='id identifier rubyid_blogs'>blogs</span><span class='lparen'>(</span><span class='label'>results:</span> <span class='int'>20</span><span class='rparen'>)</span>
103
- <span class='id identifier rubyid_a'>a</span><span class='period'>.</span><span class='id identifier rubyid_biographies'>biographies</span>
104
- </code></pre>
105
-
106
- <p>Calls will return the first result unless setting the <code>results</code> option.</p>
107
-
108
- <p><em>Any valid option for echonest API calls will work as normal</em></p>
109
-
110
- <h2 id="contributing">Contributing</h2>
111
-
112
- <ol>
113
- <li>Fork it</li>
114
- <li>Create your feature branch (<code>git checkout -b my-new-feature</code>)</li>
115
- <li>Commit your changes (<code>git commit -am 'Add some feature'</code>)</li>
116
- <li>Push to the branch (<code>git push origin my-new-feature</code>)</li>
117
- <li>Create new Pull Request</li>
118
- </ol>
119
- </div></div>
120
-
121
- <div id="footer">
122
- Generated on Sun Feb 10 11:33:24 2013 by
123
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
124
- 0.8.4.1 (ruby-1.9.3).
125
- </div>
126
-
127
- </body>
128
- </html>
data/doc/file_list.html DELETED
@@ -1,55 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html>
4
- <head>
5
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
-
7
- <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
8
-
9
- <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
10
-
11
-
12
-
13
- <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
14
-
15
- <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
16
-
17
-
18
- <base id="base_target" target="_parent" />
19
- </head>
20
- <body>
21
- <script type="text/javascript" charset="utf-8">
22
- if (window.top.frames.main) {
23
- document.getElementById('base_target').target = 'main';
24
- document.body.className = 'frames';
25
- }
26
- </script>
27
- <div id="content">
28
- <h1 id="full_list_header">File List</h1>
29
- <div id="nav">
30
-
31
- <span><a target="_self" href="class_list.html">
32
- Classes
33
- </a></span>
34
-
35
- <span><a target="_self" href="method_list.html">
36
- Methods
37
- </a></span>
38
-
39
- <span><a target="_self" href="file_list.html">
40
- Files
41
- </a></span>
42
-
43
- </div>
44
- <div id="search">Search: <input type="text" /></div>
45
-
46
- <ul id="full_list" class="file">
47
-
48
-
49
- <li class="r1"><a href="index.html" title="README">README</a></li>
50
-
51
-
52
- </ul>
53
- </div>
54
- </body>
55
- </html>
data/doc/frames.html DELETED
@@ -1,28 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
3
-
4
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
- <head>
6
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
7
- <title>Documentation by YARD 0.8.4.1</title>
8
- </head>
9
- <script type="text/javascript" charset="utf-8">
10
- window.onload = function() {
11
- var match = window.location.hash.match(/^#!(.+)/);
12
- var name = 'index.html';
13
- if (match) {
14
- name = unescape(match[1]);
15
- }
16
- document.writeln('<frameset cols="20%,*">' +
17
- '<frame name="list" src="class_list.html" />' +
18
- '<frame name="main" src="' + name + '" />' +
19
- '</frameset>');
20
- }
21
- </script>
22
- <noscript>
23
- <frameset cols="20%,*">
24
- <frame name="list" src="class_list.html" />
25
- <frame name="main" src="index.html" />
26
- </frameset>
27
- </noscript>
28
- </html>
data/doc/index.html DELETED
@@ -1,128 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
- <head>
5
- <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII" />
6
- <title>
7
- File: README
8
-
9
- &mdash; Documentation by YARD 0.8.4.1
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
14
-
15
- <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
16
-
17
- <script type="text/javascript" charset="utf-8">
18
- hasFrames = window.top.frames.main ? true : false;
19
- relpath = '';
20
- framesUrl = "frames.html#!" + escape(window.location.href);
21
- </script>
22
-
23
-
24
- <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25
-
26
- <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27
-
28
-
29
- </head>
30
- <body>
31
- <div id="header">
32
- <div id="menu">
33
-
34
- <a href="_index.html">Index</a> &raquo;
35
- <span class="title">File: README</span>
36
-
37
-
38
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
39
- </div>
40
-
41
- <div id="search">
42
-
43
- <a class="full_list_link" id="class_list_link"
44
- href="class_list.html">
45
- Class List
46
- </a>
47
-
48
- <a class="full_list_link" id="method_list_link"
49
- href="method_list.html">
50
- Method List
51
- </a>
52
-
53
- <a class="full_list_link" id="file_list_link"
54
- href="file_list.html">
55
- File List
56
- </a>
57
-
58
- </div>
59
- <div class="clear"></div>
60
- </div>
61
-
62
- <iframe id="search_frame"></iframe>
63
-
64
- <div id="content"><div id='filecontents'><h1 id="echonest-ruby-api-code-climatehttpscodeclimatecomgithubmaxehmookauechonest-ruby-apipnghttpscodeclimatecomgithubmaxehmookauechonest-ruby-api">echonest-ruby-api <a href="https://codeclimate.com/github/maxehmookau/echonest-ruby-api"><img src="https://codeclimate.com/github/maxehmookau/echonest-ruby-api.png" alt="Code Climate" /></a></h1>
65
- <p><a href="https://travis-ci.org/maxehmookau/echonest-ruby-api"><img src="https://travis-ci.org/maxehmookau/echonest-ruby-api.png" alt="Build Status" /></a>
66
- <a href="https://gemnasium.com/maxehmookau/echonest-ruby-api"><img src="https://gemnasium.com/maxehmookau/echonest-ruby-api.png" alt="Dependency Status" /></a>
67
- TODO: Everything. (also, come up with a cool name)</p>
68
-
69
- <h2 id="installation">Installation</h2>
70
-
71
- <p>Add this line to your application&rsquo;s Gemfile:</p>
72
-
73
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>echonest-ruby-api</span><span class='tstring_end'>'</span></span>
74
- </code></pre>
75
-
76
- <p>And then execute:</p>
77
-
78
- <pre class="code ruby"><code class="ruby">$ bundle
79
- </code></pre>
80
-
81
- <p>Or install it yourself as:</p>
82
-
83
- <pre class="code ruby"><code class="ruby">$ gem install echonest-ruby-api
84
- </code></pre>
85
-
86
- <p><em>That said, probably don&rsquo;t do any of that, since nothing works yet&hellip;</em></p>
87
-
88
- <h2 id="usage">Usage</h2>
89
-
90
- <p>Require the gem in your file:</p>
91
-
92
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>echonest-ruby-api</span><span class='tstring_end'>'</span></span>
93
- </code></pre>
94
-
95
- <p>Create an instance of an object</p>
96
-
97
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_a'>a</span> <span class='op'>=</span> <span class='const'>Echonest</span><span class='op'>::</span><span class='const'>Artist</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Weezer</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>YOUR-API-KEY</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
98
- </code></pre>
99
-
100
- <p>Find out some stuff!</p>
101
-
102
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_a'>a</span><span class='period'>.</span><span class='id identifier rubyid_blogs'>blogs</span><span class='lparen'>(</span><span class='label'>results:</span> <span class='int'>20</span><span class='rparen'>)</span>
103
- <span class='id identifier rubyid_a'>a</span><span class='period'>.</span><span class='id identifier rubyid_biographies'>biographies</span>
104
- </code></pre>
105
-
106
- <p>Calls will return the first result unless setting the <code>results</code> option.</p>
107
-
108
- <p><em>Any valid option for echonest API calls will work as normal</em></p>
109
-
110
- <h2 id="contributing">Contributing</h2>
111
-
112
- <ol>
113
- <li>Fork it</li>
114
- <li>Create your feature branch (<code>git checkout -b my-new-feature</code>)</li>
115
- <li>Commit your changes (<code>git commit -am 'Add some feature'</code>)</li>
116
- <li>Push to the branch (<code>git push origin my-new-feature</code>)</li>
117
- <li>Create new Pull Request</li>
118
- </ol>
119
- </div></div>
120
-
121
- <div id="footer">
122
- Generated on Sun Feb 10 11:33:24 2013 by
123
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
124
- 0.8.4.1 (ruby-1.9.3).
125
- </div>
126
-
127
- </body>
128
- </html>
data/doc/js/app.js DELETED
@@ -1,214 +0,0 @@
1
- function createSourceLinks() {
2
- $('.method_details_list .source_code').
3
- before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
4
- $('.toggleSource').toggle(function() {
5
- $(this).parent().nextAll('.source_code').slideDown(100);
6
- $(this).text("Hide source");
7
- },
8
- function() {
9
- $(this).parent().nextAll('.source_code').slideUp(100);
10
- $(this).text("View source");
11
- });
12
- }
13
-
14
- function createDefineLinks() {
15
- var tHeight = 0;
16
- $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
17
- $('.toggleDefines').toggle(function() {
18
- tHeight = $(this).parent().prev().height();
19
- $(this).prev().show();
20
- $(this).parent().prev().height($(this).parent().height());
21
- $(this).text("(less)");
22
- },
23
- function() {
24
- $(this).prev().hide();
25
- $(this).parent().prev().height(tHeight);
26
- $(this).text("more...");
27
- });
28
- }
29
-
30
- function createFullTreeLinks() {
31
- var tHeight = 0;
32
- $('.inheritanceTree').toggle(function() {
33
- tHeight = $(this).parent().prev().height();
34
- $(this).parent().toggleClass('showAll');
35
- $(this).text("(hide)");
36
- $(this).parent().prev().height($(this).parent().height());
37
- },
38
- function() {
39
- $(this).parent().toggleClass('showAll');
40
- $(this).parent().prev().height(tHeight);
41
- $(this).text("show all");
42
- });
43
- }
44
-
45
- function fixBoxInfoHeights() {
46
- $('dl.box dd.r1, dl.box dd.r2').each(function() {
47
- $(this).prev().height($(this).height());
48
- });
49
- }
50
-
51
- function searchFrameLinks() {
52
- $('.full_list_link').click(function() {
53
- toggleSearchFrame(this, $(this).attr('href'));
54
- return false;
55
- });
56
- }
57
-
58
- function toggleSearchFrame(id, link) {
59
- var frame = $('#search_frame');
60
- $('#search a').removeClass('active').addClass('inactive');
61
- if (frame.attr('src') == link && frame.css('display') != "none") {
62
- frame.slideUp(100);
63
- $('#search a').removeClass('active inactive');
64
- }
65
- else {
66
- $(id).addClass('active').removeClass('inactive');
67
- frame.attr('src', link).slideDown(100);
68
- }
69
- }
70
-
71
- function linkSummaries() {
72
- $('.summary_signature').click(function() {
73
- document.location = $(this).find('a').attr('href');
74
- });
75
- }
76
-
77
- function framesInit() {
78
- if (hasFrames) {
79
- document.body.className = 'frames';
80
- $('#menu .noframes a').attr('href', document.location);
81
- window.top.document.title = $('html head title').text();
82
- }
83
- else {
84
- $('#menu .noframes a').text('frames').attr('href', framesUrl);
85
- }
86
- }
87
-
88
- function keyboardShortcuts() {
89
- if (window.top.frames.main) return;
90
- $(document).keypress(function(evt) {
91
- if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
92
- if (typeof evt.target !== "undefined" &&
93
- (evt.target.nodeName == "INPUT" ||
94
- evt.target.nodeName == "TEXTAREA")) return;
95
- switch (evt.charCode) {
96
- case 67: case 99: $('#class_list_link').click(); break; // 'c'
97
- case 77: case 109: $('#method_list_link').click(); break; // 'm'
98
- case 70: case 102: $('#file_list_link').click(); break; // 'f'
99
- default: break;
100
- }
101
- });
102
- }
103
-
104
- function summaryToggle() {
105
- $('.summary_toggle').click(function() {
106
- if (localStorage) {
107
- localStorage.summaryCollapsed = $(this).text();
108
- }
109
- $('.summary_toggle').each(function() {
110
- $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
111
- var next = $(this).parent().parent().nextAll('ul.summary').first();
112
- if (next.hasClass('compact')) {
113
- next.toggle();
114
- next.nextAll('ul.summary').first().toggle();
115
- }
116
- else if (next.hasClass('summary')) {
117
- var list = $('<ul class="summary compact" />');
118
- list.html(next.html());
119
- list.find('.summary_desc, .note').remove();
120
- list.find('a').each(function() {
121
- $(this).html($(this).find('strong').html());
122
- $(this).parent().html($(this)[0].outerHTML);
123
- });
124
- next.before(list);
125
- next.toggle();
126
- }
127
- });
128
- return false;
129
- });
130
- if (localStorage) {
131
- if (localStorage.summaryCollapsed == "collapse") {
132
- $('.summary_toggle').first().click();
133
- }
134
- else localStorage.summaryCollapsed = "expand";
135
- }
136
- }
137
-
138
- function fixOutsideWorldLinks() {
139
- $('a').each(function() {
140
- if (window.location.host != this.host) this.target = '_parent';
141
- });
142
- }
143
-
144
- function generateTOC() {
145
- if ($('#filecontents').length === 0) return;
146
- var _toc = $('<ol class="top"></ol>');
147
- var show = false;
148
- var toc = _toc;
149
- var counter = 0;
150
- var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
151
- var i;
152
- if ($('#filecontents h1').length > 1) tags.unshift('h1');
153
- for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
154
- var lastTag = parseInt(tags[0][1], 10);
155
- $(tags.join(', ')).each(function() {
156
- if ($(this).parents('.method_details .docstring').length != 0) return;
157
- if (this.id == "filecontents") return;
158
- show = true;
159
- var thisTag = parseInt(this.tagName[1], 10);
160
- if (this.id.length === 0) {
161
- var proposedId = $(this).attr('toc-id');
162
- if (typeof(proposedId) != "undefined") this.id = proposedId;
163
- else {
164
- var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
165
- if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
166
- this.id = proposedId;
167
- }
168
- }
169
- if (thisTag > lastTag) {
170
- for (i = 0; i < thisTag - lastTag; i++) {
171
- var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
172
- }
173
- }
174
- if (thisTag < lastTag) {
175
- for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
176
- }
177
- var title = $(this).attr('toc-title');
178
- if (typeof(title) == "undefined") title = $(this).text();
179
- toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
180
- lastTag = thisTag;
181
- });
182
- if (!show) return;
183
- html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
184
- $('#content').prepend(html);
185
- $('#toc').append(_toc);
186
- $('#toc .hide_toc').toggle(function() {
187
- $('#toc .top').slideUp('fast');
188
- $('#toc').toggleClass('hidden');
189
- $('#toc .title small').toggle();
190
- }, function() {
191
- $('#toc .top').slideDown('fast');
192
- $('#toc').toggleClass('hidden');
193
- $('#toc .title small').toggle();
194
- });
195
- $('#toc .float_toc').toggle(function() {
196
- $(this).text('float');
197
- $('#toc').toggleClass('nofloat');
198
- }, function() {
199
- $(this).text('left');
200
- $('#toc').toggleClass('nofloat');
201
- });
202
- }
203
-
204
- $(framesInit);
205
- $(createSourceLinks);
206
- $(createDefineLinks);
207
- $(createFullTreeLinks);
208
- $(fixBoxInfoHeights);
209
- $(searchFrameLinks);
210
- $(linkSummaries);
211
- $(keyboardShortcuts);
212
- $(summaryToggle);
213
- $(fixOutsideWorldLinks);
214
- $(generateTOC);