spotify-ruby 0.1.0

data/html/js/search.js

@@ -0,0 +1,109 @@
+Search = function(data, input, result) {
+  this.data = data;
+  this.$input = $(input);
+  this.$result = $(result);
+
+  this.$current = null;
+  this.$view = this.$result.parent();
+  this.searcher = new Searcher(data.index);
+  this.init();
+}
+
+Search.prototype = $.extend({}, Navigation, new function() {
+  var suid = 1;
+
+  this.init = function() {
+    var _this = this;
+    var observer = function(e) {
+      switch(e.originalEvent.keyCode) {
+        case 38: // Event.KEY_UP
+        case 40: // Event.KEY_DOWN
+          return;
+      }
+      _this.search(_this.$input[0].value);
+    };
+    this.$input.keyup(observer);
+    this.$input.click(observer); // mac's clear field
+
+    this.searcher.ready(function(results, isLast) {
+      _this.addResults(results, isLast);
+    })
+
+    this.initNavigation();
+    this.setNavigationActive(false);
+  }
+
+  this.search = function(value, selectFirstMatch) {
+    value = jQuery.trim(value).toLowerCase();
+    if (value) {
+      this.setNavigationActive(true);
+    } else {
+      this.setNavigationActive(false);
+    }
+
+    if (value == '') {
+      this.lastQuery = value;
+      this.$result.empty();
+      this.$result.attr('aria-expanded', 'false');
+      this.setNavigationActive(false);
+    } else if (value != this.lastQuery) {
+      this.lastQuery = value;
+      this.$result.attr('aria-busy',     'true');
+      this.$result.attr('aria-expanded', 'true');
+      this.firstRun = true;
+      this.searcher.find(value);
+    }
+  }
+
+  this.addResults = function(results, isLast) {
+    var target = this.$result.get(0);
+    if (this.firstRun && (results.length > 0 || isLast)) {
+      this.$current = null;
+      this.$result.empty();
+    }
+
+    for (var i=0, l = results.length; i < l; i++) {
+      var item = this.renderItem.call(this, results[i]);
+      item.setAttribute('id', 'search-result-' + target.childElementCount);
+      target.appendChild(item);
+    };
+
+    if (this.firstRun && results.length > 0) {
+      this.firstRun = false;
+      this.$current = $(target.firstChild);
+      this.$current.addClass('search-selected');
+    }
+    if (jQuery.browser.msie) this.$element[0].className += '';
+
+    if (isLast) this.$result.attr('aria-busy', 'false');
+  }
+
+  this.move = function(isDown) {
+    if (!this.$current) return;
+    var $next = this.$current[isDown ? 'next' : 'prev']();
+    if ($next.length) {
+      this.$current.removeClass('search-selected');
+      $next.addClass('search-selected');
+      this.$input.attr('aria-activedescendant', $next.attr('id'));
+      this.scrollIntoView($next[0], this.$view[0]);
+      this.$current = $next;
+      this.$input.val($next[0].firstChild.firstChild.text);
+      this.$input.select();
+    }
+    return true;
+  }
+
+  this.hlt = function(html) {
+    return this.escapeHTML(html).
+      replace(/\u0001/g, '<em>').
+      replace(/\u0002/g, '</em>');
+  }
+
+  this.escapeHTML = function(html) {
+    return html.replace(/[&<>]/g, function(c) {
+      return '&#' + c.charCodeAt(0) + ';';
+    });
+  }
+
+});
+

data/html/js/search_index.js

@@ -0,0 +1 @@
+var search_data = {"index":{"searchIndex":["spotify","auth","errors","authclientcredentialserror","authorize_url()","new()","readme"],"longSearchIndex":["spotify","spotify::auth","spotify::errors","spotify::errors::authclientcredentialserror","spotify::auth#authorize_url()","spotify::auth::new()",""],"info":[["Spotify","","Spotify.html","",""],["Spotify::Auth","","Spotify/Auth.html","","<p>Spotify::Auth inherits from OAuth2::Client based on the “oauth-2” gem.\n"],["Spotify::Errors","","Spotify/Errors.html","",""],["Spotify::Errors::AuthClientCredentialsError","","Spotify/Errors/AuthClientCredentialsError.html","","<p>A Error class for when authentication client credentials are empty or\nincorrectly formatted.\n"],["authorize_url","Spotify::Auth","Spotify/Auth.html#method-i-authorize_url","(override_params={})","<p>Get a HTTP URL to send user for authorizing with Spotify.\n<p>@example\n\n<pre>@auth = Spotify::Auth.new({\n  client_id: ...</pre>\n"],["new","Spotify::Auth","Spotify/Auth.html#method-c-new","(config)","<p>Initialize the Spotify Auth object.\n<p>@example\n\n<pre>@auth = Spotify::Auth.new({\n  client_id: &quot;[client id goes ...</pre>\n"],["README","","README_md.html","","<p>bih/spotify-ruby\n<p>A modern, opinionated and <em>unofficial</em> Ruby SDK for the Spotify Web\nAPI to help developers …\n"]]}}

data/html/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 jQuery.grep(query.split(/(\s+|::?|\(\)?)/), function(string) {
+      return string.match(/\S/);
+    });
+  }
+
+  function buildRegexps(queries) {
+    return jQuery.map(queries, function(query) {
+      return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i');
+    });
+  }
+
+  function buildHilighters(queries) {
+    return jQuery.map(queries, function(query) {
+      return jQuery.map(query.split(''), 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) {
+    jQuery.each(this.handlers, function(i, fn) {
+      fn.call(this, results, isLast)
+    })
+  }
+}
+

data/html/table_of_contents.html

@@ -0,0 +1,83 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>Table of Contents - RDoc Documentation</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+  var index_rel_prefix = "./";
+</script>
+
+<script src="./js/jquery.js"></script>
+<script src="./js/darkfish.js"></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 - RDoc 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-bih-2Fspotify-ruby">bih/spotify-ruby</a>
+      <li><a href="README_md.html#label-Installation">Installation</a>
+      <li><a href="README_md.html#label-Setup">Setup</a>
+      <li><a href="README_md.html#label-Authentication">Authentication</a>
+      <li><a href="README_md.html#label-Usage">Usage</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>
+      <li><a href="README_md.html#label-Code+of+Conduct">Code of Conduct</a>
+    </ul>
+  </li>
+  
+</ul>
+
+<h2 id="classes">Classes and Modules</h2>
+<ul>
+  <li class="module">
+    <a href="Spotify.html">Spotify</a>
+  </li>
+  <li class="class">
+    <a href="Spotify/Auth.html">Spotify::Auth</a>
+  </li>
+  <li class="class">
+    <a href="Spotify/Errors.html">Spotify::Errors</a>
+  </li>
+  <li class="class">
+    <a href="Spotify/Errors/AuthClientCredentialsError.html">Spotify::Errors::AuthClientCredentialsError</a>
+  </li>
+</ul>
+
+<h2 id="methods">Methods</h2>
+<ul>
+
+  <li class="method">
+    <a href="Spotify/Auth.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">Spotify::Auth</span>
+
+  <li class="method">
+    <a href="Spotify/Auth.html#method-i-authorize_url">#authorize_url</a>
+    &mdash;
+    <span class="container">Spotify::Auth</span>
+</ul>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="http://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> 5.1.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/spotify.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "spotify/version"
+require "spotify/auth"
+
+##
+# The declaration for the Spotify namespace.
+#
+module Spotify
+end

data/lib/spotify/auth.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require "oauth2"
+
+module Spotify
+  ##
+  # Spotify::Auth inherits from OAuth2::Client based on the "oauth-2" gem.
+  #
+  class Auth < OAuth2::Client
+    ##
+    # An entire list of Spotify's OAuth scopes. Stored
+    # in the form of a symbolized array.
+    # Example: `[:scope1, :scope2]`
+    #
+    # @see https://developer.spotify.com/web-api/using-scopes/
+    #
+    # Last updated: 21 October 2017
+    #
+    SCOPES = %i[
+      playlist-read-private playlist-read-collaborative
+      playlist-modify-public playlist-modify-private
+      ugc-image-upload user-follow-modify user-follow-read
+      user-library-read user-library-modify user-read-private
+      user-read-birthdate user-read-email user-top-read
+      user-read-playback-state user-modify-playback-state
+      user-read-currently-playing user-read-recently-played
+      streaming
+    ].freeze
+
+    ##
+    # Error-related translations we're using.
+    #
+    OAUTH_I18N = {
+      must_be_hash: "Must be a Hash. Example: Spotify::Auth.new({ client_id: '', ... })",
+      require_attr: "Expecting a '%s' key. You can obtain from https://developer.spotify.com"
+    }.freeze
+
+    ##
+    # Initialize the Spotify Auth object.
+    #
+    # @example
+    #
+    #   @auth = Spotify::Auth.new({
+    #     client_id: "[client id goes here]",
+    #     client_secret: "[client secret goes here]",
+    #     redirect_uri: "http://localhost"
+    #   })
+    #
+    # @param [Hash] config OAuth configuration containing the Client ID, secret and redirect URL.
+    # The redirect URL can be overriden later.
+    #
+    # @see https://developer.spotify.com/my-applications/
+    #
+    def initialize(config)
+      opts = {
+        site:          "https://api.spotify.com",
+        authorize_url: "https://accounts.spotify.com/oauth/authorize"
+      }
+      validate_initialized_input(config)
+      @redirect_uri = config[:redirect_uri]
+      super(config[:client_id], config[:client_secret], opts)
+    end
+
+    ##
+    # Get a HTTP URL to send user for authorizing with Spotify.
+    #
+    # @example
+    #
+    #   @auth = Spotify::Auth.new({
+    #     client_id: "[client id goes here]",
+    #     client_secret: "[client secret goes here]",
+    #     redirect_uri: "http://localhost"
+    #   })
+    #
+    #   @auth.authorize_url
+    #
+    # @param [Hash] override_params Optional hash containing any overriding values for parameters.
+    # Parameters used are client_id, redirect_uri, response_type and scope.
+    #
+    # @see https://developer.spotify.com/web-api/authorization-guide/
+    #
+    def authorize_url(override_params={})
+      super({
+        client_id:     id,
+        redirect_uri:  redirect_uri,
+        response_type: "code",
+        scope:         SCOPES.join(" ")
+      }.merge(override_params))
+    end
+
+    private
+
+    ##
+    # OAuth2::Client does not support redirect_uri at initialization, so we store
+    # it in the instance and call it later. We think it makes things clearer.
+    #
+    attr_accessor :redirect_uri
+
+    ##
+    # Validate initialization configuration and raise errors.
+    #
+    # @param [Hash] config OAuth configuration containing the Client ID, secret and redirect URL.
+    #
+    def validate_initialized_input(config)
+      raise Errors::AuthClientCredentialsError.new(OAUTH_I18N[:must_be_hash]) unless config.is_a?(Hash)
+
+      %i[client_id client_secret redirect_uri].each do |key|
+        raise Errors::AuthClientCredentialsError.new(OAUTH_I18N[:require_attr] % key) unless config.has_key?(key)
+      end
+    end
+  end
+
+  class Errors
+    ##
+    # A Error class for when authentication client credentials are empty or incorrectly formatted.
+    #
+    class AuthClientCredentialsError < StandardError; end
+  end
+end