tidal 0.1.0 → 0.1.1

data/docs/js/searcher.js

@@ -0,0 +1,229 @@
+Searcher = function(data) {
+  this.data = data;
+  this.handlers = [];
+}
+
+Searcher.prototype = new function() {
+  // search is performed in chunks of 1000 for non-blocking user input
+  var CHUNK_SIZE = 1000;
+  // do not try to find more than 100 results
+  var MAX_RESULTS = 100;
+  var huid = 1;
+  var suid = 1;
+  var runs = 0;
+
+  this.find = function(query) {
+    var queries = splitQuery(query);
+    var regexps = buildRegexps(queries);
+    var highlighters = buildHilighters(queries);
+    var state = { from: 0, pass: 0, limit: MAX_RESULTS, n: suid++};
+    var _this = this;
+
+    this.currentSuid = state.n;
+
+    if (!query) return;
+
+    var run = function() {
+      // stop current search thread if new search started
+      if (state.n != _this.currentSuid) return;
+
+      var results =
+        performSearch(_this.data, regexps, queries, highlighters, state);
+      var hasMore = (state.limit > 0 && state.pass < 4);
+
+      triggerResults.call(_this, results, !hasMore);
+      if (hasMore) {
+        setTimeout(run, 2);
+      }
+      runs++;
+    };
+    runs = 0;
+
+    // start search thread
+    run();
+  }
+
+  /*  ----- Events ------  */
+  this.ready = function(fn) {
+    fn.huid = huid;
+    this.handlers.push(fn);
+  }
+
+  /*  ----- Utilities ------  */
+  function splitQuery(query) {
+    return query.split(/(\s+|::?|\(\)?)/).filter(function(string) {
+      return string.match(/\S/);
+    });
+  }
+
+  function buildRegexps(queries) {
+    return queries.map(function(query) {
+      return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i');
+    });
+  }
+
+  function buildHilighters(queries) {
+    return queries.map(function(query) {
+      return query.split('').map(function(l, i) {
+        return '\u0001$' + (i*2+1) + '\u0002$' + (i*2+2);
+      }).join('');
+    });
+  }
+
+  // function longMatchRegexp(index, longIndex, regexps) {
+  //     for (var i = regexps.length - 1; i >= 0; i--){
+  //         if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) return false;
+  //     };
+  //     return true;
+  // }
+
+
+  /*  ----- Mathchers ------  */
+
+  /*
+   * This record matches if the index starts with queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassBeginning(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the longIndex starts with queries[0] and the
+   * longIndex matches all of the regexps
+   */
+  function matchPassLongIndex(index, longIndex, queries, regexps) {
+    if (longIndex.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the index contains queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassContains(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) == -1) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if regexps[0] matches the index and the record
+   * matches all of the regexps
+   */
+  function matchPassRegexp(index, longIndex, queries, regexps) {
+    if (!index.match(regexps[0])) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+
+  /*  ----- Highlighters ------  */
+  function highlightRegexp(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    for (var i=0, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function hltSubstring(string, pos, length) {
+    return string.substring(0, pos) + '\u0001' + string.substring(pos, pos + length) + '\u0002' + string.substring(pos + length);
+  }
+
+  function highlightQuery(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    var pos = 0;
+    var lcTitle = result.title.toLowerCase();
+
+    pos = lcTitle.indexOf(queries[0]);
+    if (pos != -1) {
+      result.title = hltSubstring(result.title, pos, queries[0].length);
+    }
+
+    result.namespace = result.namespace.replace(regexps[0], highlighters[0]);
+    for (var i=1, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function createResult(info) {
+    var result = {};
+    result.title = info[0];
+    result.namespace = info[1];
+    result.path = info[2];
+    result.params = info[3];
+    result.snippet = info[4];
+    result.badge = info[6];
+    return result;
+  }
+
+  /*  ----- Searching ------  */
+  function performSearch(data, regexps, queries, highlighters, state) {
+    var searchIndex = data.searchIndex;
+    var longSearchIndex = data.longSearchIndex;
+    var info = data.info;
+    var result = [];
+    var i = state.from;
+    var l = searchIndex.length;
+    var togo = CHUNK_SIZE;
+    var matchFunc, hltFunc;
+
+    while (state.pass < 4 && state.limit > 0 && togo > 0) {
+      if (state.pass == 0) {
+        matchFunc = matchPassBeginning;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 1) {
+        matchFunc = matchPassLongIndex;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 2) {
+        matchFunc = matchPassContains;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 3) {
+        matchFunc = matchPassRegexp;
+        hltFunc = highlightRegexp;
+      }
+
+      for (; togo > 0 && i < l && state.limit > 0; i++, togo--) {
+        if (info[i].n == state.n) continue;
+        if (matchFunc(searchIndex[i], longSearchIndex[i], queries, regexps)) {
+          info[i].n = state.n;
+          result.push(hltFunc(info[i], queries, regexps, highlighters));
+          state.limit--;
+        }
+      };
+      if (searchIndex.length <= i) {
+        state.pass++;
+        i = state.from = 0;
+      } else {
+        state.from = i;
+      }
+    }
+    return result;
+  }
+
+  function triggerResults(results, isLast) {
+    this.handlers.forEach(function(fn) {
+      fn.call(this, results, isLast)
+    });
+  }
+}
+

data/docs/table_of_contents.html

@@ -0,0 +1,176 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>Table of Contents - Tidal API Client Documentation</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+  var index_rel_prefix = "./";
+</script>
+
+<script src="./js/navigation.js" defer></script>
+<script src="./js/search.js" defer></script>
+<script src="./js/search_index.js" defer></script>
+<script src="./js/searcher.js" defer></script>
+<script src="./js/darkfish.js" defer></script>
+
+<link href="./css/fonts.css" rel="stylesheet">
+<link href="./css/rdoc.css" rel="stylesheet">
+
+
+<body id="top" class="table-of-contents">
+<main role="main">
+<h1 class="class">Table of Contents - Tidal API Client Documentation</h1>
+
+<h2 id="pages">Pages</h2>
+<ul>
+  <li class="file">
+    <a href="README_md.html">README</a>
+
+    <ul>
+      <li><a href="README_md.html#label-Tidal">Tidal</a>
+      <li><a href="README_md.html#label-Installation">Installation</a>
+      <li><a href="README_md.html#label-Usage">Usage</a>
+      <li><a href="README_md.html#label-Configuration">Configuration</a>
+      <li><a href="README_md.html#label-Fetch+Albums+by+Barcode+ID">Fetch Albums by Barcode ID</a>
+      <li><a href="README_md.html#label-Fetch+Multiple+Albums+by+IDs">Fetch Multiple Albums by IDs</a>
+      <li><a href="README_md.html#label-Fetch+Album+Items">Fetch Album Items</a>
+      <li><a href="README_md.html#label-Fetch+Similar+Albums">Fetch Similar Albums</a>
+      <li><a href="README_md.html#label-Fetch+Single+Album">Fetch Single Album</a>
+      <li><a href="README_md.html#label-Fetch+Albums+by+Artist">Fetch Albums by Artist</a>
+      <li><a href="README_md.html#label-Fetch+Multiple+Artists+by+IDs">Fetch Multiple Artists by IDs</a>
+      <li><a href="README_md.html#label-Fetch+Similar+Artists">Fetch Similar Artists</a>
+      <li><a href="README_md.html#label-Fetch+Single+Artist">Fetch Single Artist</a>
+      <li><a href="README_md.html#label-Fetch+Tracks+by+Artist">Fetch Tracks by Artist</a>
+      <li><a href="README_md.html#label-Fetch+Multiple+Tracks+by+IDs">Fetch Multiple Tracks by IDs</a>
+      <li><a href="README_md.html#label-Fetch+Tracks+by+ISRC">Fetch Tracks by ISRC</a>
+      <li><a href="README_md.html#label-Fetch+Single+Track">Fetch Single Track</a>
+      <li><a href="README_md.html#label-Fetch+Similar+Tracks">Fetch Similar Tracks</a>
+      <li><a href="README_md.html#label-Fetch+Multiple+Videos+by+IDs">Fetch Multiple Videos by IDs</a>
+      <li><a href="README_md.html#label-Fetch+Single+Video">Fetch Single Video</a>
+      <li><a href="README_md.html#label-Search">Search</a>
+      <li><a href="README_md.html#label-Development">Development</a>
+      <li><a href="README_md.html#label-Contributing">Contributing</a>
+      <li><a href="README_md.html#label-License">License</a>
+    </ul>
+  </li>
+</ul>
+
+<h2 id="classes">Classes and Modules</h2>
+<ul>
+  <li class="module">
+    <a href="Tidal.html">Tidal</a>
+  </li>
+  <li class="class">
+    <a href="Tidal/ClientV1.html">Tidal::ClientV1</a>
+  </li>
+  <li class="class">
+    <a href="Tidal/Error.html">Tidal::Error</a>
+  </li>
+</ul>
+
+<h2 id="methods">Methods</h2>
+<ul>
+
+  <li class="method">
+    <a href="Tidal/ClientV1.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">Tidal::ClientV1</span>
+
+  <li class="method">
+    <a href="Tidal/ClientV1.html#method-i-get_album_items">#get_album_items</a>
+    &mdash;
+    <span class="container">Tidal::ClientV1</span>
+
+  <li class="method">
+    <a href="Tidal/ClientV1.html#method-i-get_albums_by_artist">#get_albums_by_artist</a>
+    &mdash;
+    <span class="container">Tidal::ClientV1</span>
+
+  <li class="method">
+    <a href="Tidal/ClientV1.html#method-i-get_albums_by_barcode_id">#get_albums_by_barcode_id</a>
+    &mdash;
+    <span class="container">Tidal::ClientV1</span>
+
+  <li class="method">
+    <a href="Tidal/ClientV1.html#method-i-get_multiple_albums">#get_multiple_albums</a>
+    &mdash;
+    <span class="container">Tidal::ClientV1</span>
+
+  <li class="method">
+    <a href="Tidal/ClientV1.html#method-i-get_multiple_artists">#get_multiple_artists</a>
+    &mdash;
+    <span class="container">Tidal::ClientV1</span>
+
+  <li class="method">
+    <a href="Tidal/ClientV1.html#method-i-get_multiple_tracks">#get_multiple_tracks</a>
+    &mdash;
+    <span class="container">Tidal::ClientV1</span>
+
+  <li class="method">
+    <a href="Tidal/ClientV1.html#method-i-get_multiple_videos">#get_multiple_videos</a>
+    &mdash;
+    <span class="container">Tidal::ClientV1</span>
+
+  <li class="method">
+    <a href="Tidal/ClientV1.html#method-i-get_search">#get_search</a>
+    &mdash;
+    <span class="container">Tidal::ClientV1</span>
+
+  <li class="method">
+    <a href="Tidal/ClientV1.html#method-i-get_similar_albums">#get_similar_albums</a>
+    &mdash;
+    <span class="container">Tidal::ClientV1</span>
+
+  <li class="method">
+    <a href="Tidal/ClientV1.html#method-i-get_similar_artists">#get_similar_artists</a>
+    &mdash;
+    <span class="container">Tidal::ClientV1</span>
+
+  <li class="method">
+    <a href="Tidal/ClientV1.html#method-i-get_similar_tracks">#get_similar_tracks</a>
+    &mdash;
+    <span class="container">Tidal::ClientV1</span>
+
+  <li class="method">
+    <a href="Tidal/ClientV1.html#method-i-get_single_album">#get_single_album</a>
+    &mdash;
+    <span class="container">Tidal::ClientV1</span>
+
+  <li class="method">
+    <a href="Tidal/ClientV1.html#method-i-get_single_artist">#get_single_artist</a>
+    &mdash;
+    <span class="container">Tidal::ClientV1</span>
+
+  <li class="method">
+    <a href="Tidal/ClientV1.html#method-i-get_single_track">#get_single_track</a>
+    &mdash;
+    <span class="container">Tidal::ClientV1</span>
+
+  <li class="method">
+    <a href="Tidal/ClientV1.html#method-i-get_single_video">#get_single_video</a>
+    &mdash;
+    <span class="container">Tidal::ClientV1</span>
+
+  <li class="method">
+    <a href="Tidal/ClientV1.html#method-i-get_tracks_by_artist">#get_tracks_by_artist</a>
+    &mdash;
+    <span class="container">Tidal::ClientV1</span>
+
+  <li class="method">
+    <a href="Tidal/ClientV1.html#method-i-get_tracks_by_isrc">#get_tracks_by_isrc</a>
+    &mdash;
+    <span class="container">Tidal::ClientV1</span>
+</ul>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.7.0.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+

data/lib/tidal/client_v1.rb

@@ -8,6 +8,10 @@ module Tidal
 
     attr_reader :access_token
 
+    # Initialize the Tidal client
+    #
+    # @param client_id [String] The client ID for the Tidal API
+    # @param client_secret [String] The client secret for the Tidal API
     def initialize(client_id, client_secret)
       @client_id = client_id
       @client_secret = client_secret
@@ -15,6 +19,11 @@ module Tidal
       @access_token = @client.client_credentials.get_token.token
     end
 
+    # Get albums by barcode ID
+    #
+    # @param barcode_id [String] The barcode ID
+    # @param country_code [String] The country code
+    # @return [Array] The list of albums
     def get_albums_by_barcode_id(barcode_id, country_code)
       uri = URI("#{BASE_URL}/albums/byBarcodeId")
       params = { barcodeId: barcode_id, countryCode: country_code }
@@ -24,6 +33,11 @@ module Tidal
       JSON.parse(response.body)
     end
 
+    # Get multiple albums
+    #
+    # @param ids [Array] The array of album IDs
+    # @param country_code [String] The country code
+    # @return [Array] The list of albums
     def get_multiple_albums(ids, country_code)
       uri = URI("#{BASE_URL}/albums/byIds")
       params = { ids: ids.join(','), countryCode: country_code }
@@ -33,7 +47,13 @@ module Tidal
       JSON.parse(response.body)
     end
 
-
+    # Get album items
+    #
+    # @param album_id [String] The album ID
+    # @param country_code [String] The country code
+    # @param offset [Integer, nil] The offset for pagination
+    # @param limit [Integer, nil] The limit for pagination
+    # @return [Array] The list of album items
     def get_album_items(album_id, country_code, offset = nil, limit = nil)
       uri = URI("#{BASE_URL}/albums/#{album_id}/items")
       params = { countryCode: country_code }
@@ -45,6 +65,13 @@ module Tidal
       JSON.parse(response.body)
     end
 
+    # Get similar albums
+    #
+    # @param album_id [String] The album ID
+    # @param country_code [String] The country code
+    # @param offset [Integer, nil] The offset for pagination
+    # @param limit [Integer, nil] The limit for pagination
+    # @return [Array] The list of similar albums
     def get_similar_albums(album_id, country_code, offset = nil, limit = nil)
       uri = URI("#{BASE_URL}/albums/#{album_id}/similar")
       params = { countryCode: country_code }
@@ -56,6 +83,11 @@ module Tidal
       JSON.parse(response.body)
     end
 
+    # Get a single album
+    #
+    # @param album_id [String] The album ID
+    # @param country_code [String] The country code
+    # @return [Hash] The album data
     def get_single_album(album_id, country_code)
       uri = URI("#{BASE_URL}/albums/#{album_id}")
       params = { countryCode: country_code }
@@ -65,6 +97,13 @@ module Tidal
       JSON.parse(response.body)
     end
 
+    # Get albums by artist
+    #
+    # @param artist_id [String] The artist ID
+    # @param country_code [String] The country code
+    # @param offset [Integer, nil] The offset for pagination
+    # @param limit [Integer, nil] The limit for pagination
+    # @return [Array] The list of albums by the artist
     def get_albums_by_artist(artist_id, country_code, offset = nil, limit = nil)
       uri = URI("#{BASE_URL}/artists/#{artist_id}/albums")
       params = { countryCode: country_code }
@@ -76,6 +115,11 @@ module Tidal
       JSON.parse(response.body)
     end
 
+    # Get multiple artists
+    #
+    # @param ids [Array] The array of artist IDs
+    # @param country_code [String] The country code
+    # @return [Array] The list of artists
     def get_multiple_artists(ids, country_code)
       uri = URI("#{BASE_URL}/artists")
       params = { ids: ids.join(','), countryCode: country_code }
@@ -85,6 +129,13 @@ module Tidal
       JSON.parse(response.body)
     end
 
+    # Get similar artists
+    #
+    # @param artist_id [String] The artist ID
+    # @param country_code [String] The country code
+    # @param offset [Integer, nil] The offset for pagination
+    # @param limit [Integer, nil] The limit for pagination
+    # @return [Array] The list of similar artists
     def get_similar_artists(artist_id, country_code, offset = nil, limit = nil)
       uri = URI("#{BASE_URL}/artists/#{artist_id}/similar")
       params = { countryCode: country_code }
@@ -96,6 +147,11 @@ module Tidal
       JSON.parse(response.body)
     end
 
+    # Get a single artist
+    #
+    # @param artist_id [String] The artist ID
+    # @param country_code [String] The country code
+    # @return [Hash] The artist data
     def get_single_artist(artist_id, country_code)
       uri = URI("#{BASE_URL}/artists/#{artist_id}")
       params = { countryCode: country_code }
@@ -105,6 +161,14 @@ module Tidal
       JSON.parse(response.body)
     end
 
+    # Get tracks by artist
+    #
+    # @param artist_id [String] The artist ID
+    # @param country_code [String] The country code
+    # @param collapse_by [String, nil] The collapse criteria
+    # @param offset [Integer, nil] The offset for pagination
+    # @param limit [Integer, nil] The limit for pagination
+    # @return [Array] The list of tracks by the artist
     def get_tracks_by_artist(artist_id, country_code, collapse_by = nil, offset = nil, limit = nil)
       uri = URI("#{BASE_URL}/artists/#{artist_id}/tracks")
       params = { countryCode: country_code }
@@ -117,6 +181,11 @@ module Tidal
       JSON.parse(response.body)
     end
 
+    # Get multiple tracks
+    #
+    # @param ids [Array] The array of track IDs
+    # @param country_code [String] The country code
+    # @return [Array] The list of tracks
     def get_multiple_tracks(ids, country_code)
       uri = URI("#{BASE_URL}/tracks")
       params = { ids: ids.join(','), countryCode: country_code }
@@ -126,6 +195,13 @@ module Tidal
       JSON.parse(response.body)
     end
 
+    # Get tracks by ISRC
+    #
+    # @param isrc [String] The ISRC code
+    # @param country_code [String] The country code
+    # @param offset [Integer, nil] The offset for pagination
+    # @param limit [Integer, nil] The limit for pagination
+    # @return [Array] The list of tracks by ISRC
     def get_tracks_by_isrc(isrc, country_code, offset = nil, limit = nil)
       uri = URI("#{BASE_URL}/tracks/byIsrc")
       params = { isrc: isrc, countryCode: country_code }
@@ -137,6 +213,11 @@ module Tidal
       JSON.parse(response.body)
     end
 
+    # Get a single track
+    #
+    # @param artist_id [String] The artist ID
+    # @param country_code [String] The country code
+    # @return [Hash] The track data
     def get_single_track(artist_id, country_code)
       uri = URI("#{BASE_URL}/tracks/#{artist_id}")
       params = { countryCode: country_code }
@@ -146,6 +227,13 @@ module Tidal
       JSON.parse(response.body)
     end
 
+    # Get similar tracks
+    #
+    # @param track_id [String] The track ID
+    # @param country_code [String] The country code
+    # @param offset [Integer, nil] The offset for pagination
+    # @param limit [Integer, nil] The limit for pagination
+    # @return [Array] The list of similar tracks
     def get_similar_tracks(track_id, country_code, offset = nil, limit = nil)
       uri = URI("#{BASE_URL}/tracks/#{track_id}/similar")
       params = { countryCode: country_code }
@@ -157,6 +245,11 @@ module Tidal
       JSON.parse(response.body)
     end
 
+    # Get multiple videos
+    #
+    # @param ids [Array] The array of video IDs
+    # @param country_code [String] The country code
+    # @return [Array] The list of videos
     def get_multiple_videos(ids, country_code)
       uri = URI("#{BASE_URL}/videos")
       params = { ids: ids.join(','), countryCode: country_code }
@@ -166,6 +259,11 @@ module Tidal
       JSON.parse(response.body)
     end
 
+    # Get a single video
+    #
+    # @param video_id [String] The video ID
+    # @param country_code [String] The country code
+    # @return [Hash] The video data
     def get_single_video(video_id, country_code)
       uri = URI("#{BASE_URL}/videos/#{video_id}")
       params = { countryCode: country_code }
@@ -175,6 +273,15 @@ module Tidal
       JSON.parse(response.body)
     end
 
+    # Search for content
+    #
+    # @param query [String] The search query
+    # @param country_code [String] The country code
+    # @param type [String, nil] The type of content to search for
+    # @param popularity [String, nil] The popularity filter
+    # @param offset [Integer, nil] The offset for pagination
+    # @param limit [Integer, nil] The limit for pagination
+    # @return [Hash] The search results
     def get_search(query, country_code, type = nil, popularity = nil, offset = nil, limit = nil)
       uri = URI("#{BASE_URL}/search")
       params = { query: query, countryCode: country_code }
@@ -190,6 +297,9 @@ module Tidal
 
     private
 
+    # Default headers for requests
+    #
+    # @return [Hash] The default headers
     def default_headers
       {
         'accept' => "application/vnd.tidal.v1+json",

data/lib/tidal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tidal
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end