| 1 | <!DOCTYPE html> <html> <head> <title>discogs.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> discogs.coffee </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> </td> <td class="code"> <div class="highlight"><pre><span class="nv">querystring = </span><span class="nx">require</span> <span class="s1">'querystring'</span>
|
| 2 | <span class="nv">request = </span><span class="nx">require</span> <span class="s1">'request'</span>
|
| 3 | <span class="nv">compress = </span><span class="nx">require</span> <span class="s1">'compress'</span></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> <p>This is the entry point.</p>
|
| 4 |
|
| 5 | <p>Needs a <a href="https://www.discogs.com/users/login">Discogs API key</a>.</p>
|
| 6 |
|
| 7 | <p>Takes an object as such:</p>
|
| 8 |
|
| 9 | <pre><code>config = {
|
| 10 | api_key: 'string' # Required.
|
| 11 | f: 'json|xml' # Optional, defaults to 'json'. If 'xml' consumer is expected to take care of parsing
|
| 12 | }
|
| 13 |
|
| 14 | client = discogs({api_key: 'foo4711'})
|
| 15 | </code></pre> </td> <td class="code"> <div class="highlight"><pre><span class="nv">exports = module.exports = </span><span class="nf">(config) -></span>
|
| 16 | <span class="nv">_config = </span><span class="p">{}</span>
|
| 17 | <span class="nv">_config.api_key = </span><span class="nx">config</span><span class="p">.</span><span class="nx">api_key</span></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> <p>Default format</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">_config.f = </span><span class="nx">config</span><span class="p">.</span><span class="nx">f</span> <span class="o">or</span> <span class="s1">'json'</span>
|
| 18 | <span class="nv">params = </span><span class="nx">querystring</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nx">_config</span><span class="p">)</span>
|
| 19 |
|
| 20 | <span class="nv">gunzip = </span><span class="k">new</span> <span class="nx">compress</span><span class="p">.</span><span class="nx">Gunzip</span><span class="p">()</span>
|
| 21 | <span class="nx">gunzip</span><span class="p">.</span><span class="nx">init</span><span class="p">()</span></pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> <p>Return a proper url with api_key and format</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">getUrl = </span><span class="nf">(url) -></span>
|
| 22 | <span class="nv">url = </span><span class="s2">"http://www.discogs.com/#{encodeURIComponent(url)}"</span> <span class="k">if</span> <span class="nx">url</span><span class="p">.</span><span class="nx">substr</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">7</span><span class="p">)</span> <span class="o">isnt</span> <span class="s1">'http://'</span>
|
| 23 | <span class="nv">sep = </span><span class="k">if</span> <span class="s2">"?"</span> <span class="k">in</span> <span class="nx">url</span> <span class="k">then</span> <span class="s2">"&"</span> <span class="k">else</span> <span class="s2">"?"</span>
|
| 24 |
|
| 25 | <span class="s2">"#{url}#{sep}#{params}"</span>
|
| 26 | </pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> <p>Make a request</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">discogsRequest = </span><span class="nf">(url, next) -></span>
|
| 27 | <span class="nx">request</span>
|
| 28 | <span class="nv">uri: </span><span class="nx">getUrl</span><span class="p">(</span><span class="nx">url</span><span class="p">),</span>
|
| 29 | <span class="nv">headers: </span><span class="p">{</span><span class="s1">'accept-encoding'</span><span class="o">:</span> <span class="s1">'gzip'</span><span class="p">},</span>
|
| 30 | <span class="nv">encoding: </span><span class="s1">'binary'</span><span class="p">,</span>
|
| 31 | <span class="p">(</span><span class="nx">error</span><span class="p">,</span> <span class="nx">res</span><span class="p">,</span> <span class="nx">body</span><span class="p">)</span> <span class="o">=></span>
|
| 32 | <span class="k">if</span> <span class="o">not</span> <span class="nx">error</span> <span class="o">and</span> <span class="mi">200</span> <span class="o"><=</span> <span class="nx">res</span><span class="p">.</span><span class="nx">statusCode</span> <span class="o"><</span> <span class="mi">400</span>
|
| 33 | <span class="k">if</span> <span class="nx">body</span>
|
| 34 | <span class="nv">body = </span><span class="nx">gunzip</span><span class="p">.</span><span class="nx">inflate</span><span class="p">(</span><span class="nx">body</span><span class="p">)</span> <span class="k">if</span> <span class="s1">'gzip'</span> <span class="k">in</span> <span class="nx">res</span><span class="p">.</span><span class="nx">headers</span><span class="p">[</span><span class="s1">'content-type'</span><span class="p">]</span>
|
| 35 | <span class="nv">body = </span><span class="nx">JSON</span><span class="p">.</span><span class="nx">parse</span><span class="p">(</span><span class="nx">body</span><span class="p">)</span> <span class="k">if</span> <span class="s1">'json'</span> <span class="k">in</span> <span class="nx">res</span><span class="p">.</span><span class="nx">headers</span><span class="p">[</span><span class="s1">'content-type'</span><span class="p">]</span> <span class="o">or</span> <span class="nx">_config</span><span class="p">.</span><span class="nx">f</span> <span class="o">is</span> <span class="s1">'json'</span>
|
| 36 |
|
| 37 | <span class="nx">next</span><span class="p">(</span><span class="kc">null</span><span class="p">,</span> <span class="nx">body</span><span class="p">)</span>
|
| 38 | <span class="k">else</span>
|
| 39 | <span class="nx">next</span><span class="p">(</span><span class="nx">error</span><span class="p">)</span>
|
| 40 |
|
| 41 | <span class="nv">responseHandler = </span><span class="nf">(type, next) -></span>
|
| 42 | <span class="nf">(err, res) -></span>
|
| 43 | <span class="k">return</span> <span class="nx">next</span><span class="p">(</span><span class="nx">err</span><span class="p">,</span> <span class="nx">res</span><span class="p">)</span> <span class="k">if</span> <span class="nx">err</span> <span class="o">or</span> <span class="nx">res</span> <span class="o">not</span> <span class="k">instanceof</span> <span class="nb">Object</span> <span class="o">or</span> <span class="nx">type</span> <span class="o">not</span> <span class="k">of</span> <span class="nx">res</span><span class="o">?</span><span class="p">.</span><span class="nx">resp</span>
|
| 44 | <span class="nx">next</span><span class="p">(</span><span class="kc">null</span><span class="p">,</span> <span class="nx">res</span><span class="p">.</span><span class="nx">resp</span><span class="p">[</span><span class="nx">type</span><span class="p">])</span>
|
| 45 |
|
| 46 | <span class="k">return</span> <span class="p">{</span></pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> <p>Use this if you have a discogs url</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">get: </span><span class="nf">(url, next) -></span>
|
| 47 | <span class="nx">discogsRequest</span> <span class="nx">url</span><span class="p">,</span> <span class="nx">next</span>
|
| 48 | </pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> <p>Get a release</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">release: </span><span class="nf">(id, next) -></span>
|
| 49 | <span class="nx">discogsRequest</span> <span class="s1">'release/'</span> <span class="o">+</span> <span class="nx">id</span><span class="p">,</span>
|
| 50 | <span class="nx">responseHandler</span><span class="p">(</span><span class="s1">'release'</span><span class="p">,</span> <span class="nx">next</span><span class="p">)</span>
|
| 51 | </pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">¶</a> </div> <p>Get an artist</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">artist: </span><span class="nf">(name, next) -></span>
|
| 52 | <span class="nx">discogsRequest</span> <span class="s1">'artist/'</span> <span class="o">+</span> <span class="nx">name</span><span class="p">,</span>
|
| 53 | <span class="nx">responseHandler</span><span class="p">(</span><span class="s1">'artist'</span><span class="p">,</span> <span class="nx">next</span><span class="p">)</span></pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">¶</a> </div> <p>Get a label</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">label: </span><span class="nf">(name, next) -></span>
|
| 54 | <span class="nx">discogsRequest</span> <span class="s1">'label/'</span> <span class="o">+</span> <span class="nx">name</span><span class="p">,</span>
|
| 55 | <span class="nx">responseHandler</span><span class="p">(</span><span class="s1">'label'</span><span class="p">,</span> <span class="nx">next</span><span class="p">)</span>
|
| 56 | </pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">¶</a> </div> <p>Search for something
|
| 57 | Valid types:
|
| 58 | <code>all</code>, <code>artists</code>, <code>labels</code>, <code>releases</code>, <code>needsvote</code>, <code>catno</code>, <code>forsale</code></p> </td> <td class="code"> <div class="highlight"><pre> <span class="nv">search: </span><span class="nf">(query, type, next) -></span>
|
| 59 | <span class="k">if</span> <span class="nx">type</span> <span class="k">instanceof</span> <span class="nb">Function</span>
|
| 60 | <span class="nv">next = </span><span class="nx">type</span>
|
| 61 | <span class="nv">type = </span><span class="s1">'all'</span>
|
| 62 | <span class="nx">discogsRequest</span> <span class="s1">'search?'</span> <span class="o">+</span> <span class="nx">querystring</span><span class="p">.</span><span class="nx">stringify</span><span class="p">(</span><span class="nv">type: </span><span class="nx">type</span><span class="p">,</span> <span class="nv">q: </span><span class="nx">query</span><span class="p">),</span>
|
| 63 | <span class="nx">responseHandler</span><span class="p">(</span><span class="s1">'search'</span><span class="p">,</span> <span class="nx">next</span><span class="p">)</span>
|
| 64 | <span class="p">}</span>
|
| 65 |
|
| 66 | </pre></div> </td> </tr> </tbody> </table> </div> </body> </html> |
| \ | No newline at end of file |