spotify-ruby 0.1.0 → 0.1.1

data/lib/spotify/sdk/initialization/url_string.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Spotify
+  class SDK
+    class Initialization
+      class URLString < Base
+        def query_fragment_string
+          @query_fragment_string ||= begin
+            @uri = begin
+                     URI.parse(subject)
+                   rescue URI::InvalidURIError
+                     URI.parse("")
+                   end
+            [@uri.query, @uri.fragment].compact.join("&")
+          end
+        end
+
+        def should_perform?
+          subject.is_a?(String) && query_fragment_string.present?
+        end
+
+        def perform
+          QueryString.new(query_fragment_string).perform
+        end
+
+        # TODO: Delete this when tests are written.
+        # rubocop:disable Metrics/LineLength
+        # def sample_inputs
+        #   [
+        #     "http://dev.localhost.com:443/?token=#{SAMPLE_TOKEN}",
+        #     "http://dev.localhost.com:443/?token=#{SAMPLE_TOKEN}&expires_in=1234567890",
+        #     "http://dev.localhost.com:443/?token=#{SAMPLE_TOKEN}&expires_in=1234567890&refresh_token=#{SAMPLE_TOKEN}",
+        #     "http://dev.localhost.com:443/#token=#{SAMPLE_TOKEN}",
+        #     "http://dev.localhost.com:443/#token=#{SAMPLE_TOKEN}&expires_in=1234567890",
+        #     "http://dev.localhost.com:443/#token=#{SAMPLE_TOKEN}&expires_in=1234567890&refresh_token=#{SAMPLE_TOKEN}",
+        #     "http://dev.localhost.com:443/?access_token=#{SAMPLE_TOKEN}",
+        #     "http://dev.localhost.com:443/?access_token=#{SAMPLE_TOKEN}&expires_in=1234567890",
+        #     "http://dev.localhost.com:443/?access_token=#{SAMPLE_TOKEN}&expires_in=1234567890&refresh_token=#{SAMPLE_TOKEN}",
+        #     "http://dev.localhost.com:443/#access_token=#{SAMPLE_TOKEN}",
+        #     "http://dev.localhost.com:443/#access_token=#{SAMPLE_TOKEN}&expires_in=1234567890",
+        #     "http://dev.localhost.com:443/#access_token=#{SAMPLE_TOKEN}&expires_in=1234567890&refresh_token=#{SAMPLE_TOKEN}",
+        #     "http://dev.localhost.com:443/?access_token=#{SAMPLE_TOKEN}&expires_in=1234567890#refresh_token=#{SAMPLE_TOKEN}"
+        #   ]
+        # end
+        # rubocop:enable Metrics/LineLength
+      end
+    end
+  end
+end

data/lib/spotify/sdk/model.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Spotify
+  class SDK
+    ##
+    # For each SDK response object (i.e. Device), we have a Model class. We're using OpenStruct.
+    #
+    class Model < OpenStruct
+      ##
+      # Initialize a new Model instance.
+      #
+      # @param [Hash] hash The response payload.
+      # @param [Spotify::SDK] parent The SDK object for context.
+      #
+      def initialize(payload, parent)
+        @payload = payload
+        validate_payload
+
+        @parent = parent
+        validate_parent
+
+        super(payload)
+      end
+
+      ##
+      # A reference to Spotify::SDK::Connect, so we can also do stuff.
+      #
+      attr_reader :parent
+
+      private
+
+      def validate_payload
+        raise Spotify::Errors::ModelPayloadExpectedToBeHashError.new unless @payload.instance_of? Hash
+      end
+
+      def validate_parent
+        raise Spotify::Errors::ModelParentInvalidSDKBaseObjectError.new unless @parent.is_a? Spotify::SDK::Base
+      end
+    end
+  end
+
+  class Errors
+    ##
+    # A Error class for when the payload is not a Hash instance.
+    #
+    class ModelPayloadExpectedToBeHashError < StandardError; end
+
+    ##
+    # A Error class for when the parent is not a Spotify::SDK::Base instance.
+    #
+    class ModelParentInvalidSDKBaseObjectError < StandardError; end
+  end
+end

data/lib/spotify/version.rb

@@ -9,5 +9,5 @@ module Spotify
   # if there is no breaking changes or new features. Anything
   # else should constitute a major version bump (0.1.0 -> 1.0.0)
   #
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spotify-ruby.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.name          = "spotify-ruby"
   spec.version       = Spotify::VERSION
   spec.authors       = ["Bilawal Hameed"]
-  spec.email         = ["me@bilaw.al"]
+  spec.email         = ["bil@spotify.com"]
 
-  spec.summary       = "A modern Ruby wrapper for the Spotify API."
+  spec.summary       = "A modern, opinionated and unofficial Ruby SDK for the Spotify API."
   spec.description   = [
     "Build integrations with the different Spotify APIs",
     "inside of your application.",
@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(test|spec|features|coverage|html|examples)/})
   end
 
   spec.bindir        = "exe"
@@ -33,6 +33,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rdoc", "~> 5.1"
   spec.add_development_dependency "rspec", "~> 3.7"
   spec.add_development_dependency "rubocop", "~> 0.51.0"
+  spec.add_development_dependency "webmock", "~> 3.1"
+  spec.add_runtime_dependency "activesupport", "~> 5.0"
   spec.add_runtime_dependency "httparty", "~> 0.15.6"
   spec.add_runtime_dependency "oauth2", "~> 1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spotify-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Bilawal Hameed
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-22 00:00:00.000000000 Z
+date: 2017-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,6 +100,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.51.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -131,7 +159,7 @@ dependencies:
 description: Build integrations with the different Spotify APIs inside of your application.
   For more information, visit https://developer.spotify.com
 email:
-- me@bilaw.al
+- bil@spotify.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -143,66 +171,28 @@ files:
 - ".rvm-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- COVERAGE.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- SPEC.md
 - bin/console
 - bin/setup
-- html/README_md.html
-- html/Spotify.html
-- html/Spotify/Auth.html
-- html/Spotify/Errors.html
-- html/Spotify/Errors/AuthClientCredentialsError.html
-- html/created.rid
-- html/css/fonts.css
-- html/css/rdoc.css
-- html/fonts/Lato-Light.ttf
-- html/fonts/Lato-LightItalic.ttf
-- html/fonts/Lato-Regular.ttf
-- html/fonts/Lato-RegularItalic.ttf
-- html/fonts/SourceCodePro-Bold.ttf
-- html/fonts/SourceCodePro-Regular.ttf
-- html/images/add.png
-- html/images/arrow_up.png
-- html/images/brick.png
-- html/images/brick_link.png
-- html/images/bug.png
-- html/images/bullet_black.png
-- html/images/bullet_toggle_minus.png
-- html/images/bullet_toggle_plus.png
-- html/images/date.png
-- html/images/delete.png
-- html/images/find.png
-- html/images/loadingAnimation.gif
-- html/images/macFFBgHack.png
-- html/images/package.png
-- html/images/page_green.png
-- html/images/page_white_text.png
-- html/images/page_white_width.png
-- html/images/plugin.png
-- html/images/ruby.png
-- html/images/tag_blue.png
-- html/images/tag_green.png
-- html/images/transparent.png
-- html/images/wrench.png
-- html/images/wrench_orange.png
-- html/images/zoom.png
-- html/index.html
-- html/js/darkfish.js
-- html/js/jquery.js
-- html/js/navigation.js
-- html/js/navigation.js.gz
-- html/js/search.js
-- html/js/search_index.js
-- html/js/search_index.js.gz
-- html/js/searcher.js
-- html/js/searcher.js.gz
-- html/table_of_contents.html
 - lib/spotify.rb
 - lib/spotify/auth.rb
+- lib/spotify/sdk.rb
 - lib/spotify/sdk/.keep
+- lib/spotify/sdk/base.rb
+- lib/spotify/sdk/connect.rb
+- lib/spotify/sdk/connect/device.rb
+- lib/spotify/sdk/initialization.rb
+- lib/spotify/sdk/initialization/base.rb
+- lib/spotify/sdk/initialization/oauth_access_token.rb
+- lib/spotify/sdk/initialization/plain_string.rb
+- lib/spotify/sdk/initialization/query_hash.rb
+- lib/spotify/sdk/initialization/query_string.rb
+- lib/spotify/sdk/initialization/url_string.rb
+- lib/spotify/sdk/model.rb
 - lib/spotify/version.rb
 - spotify-ruby.gemspec
 homepage: https://github.com/bih/spotify-ruby
@@ -228,5 +218,5 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: A modern Ruby wrapper for the Spotify API.
+summary: A modern, opinionated and unofficial Ruby SDK for the Spotify API.
 test_files: []

data/SPEC.md

@@ -1,18 +0,0 @@
-Core files: # This is all the core files.
-- /lib/spotify/version.rb
-- /spec/spotify_spec.rb
-
-Authorization: # For integrating OAuth.
-- /lib/spotify/auth/*.rb
-- /spec/lib/spotify/auth/*_spec.rb
-
-  Code sample:
-  ```
-    require "spotify"
-
-    auth = Spotify::Auth.new({
-      client_id: "client id",
-      client_secret: "client_secret",
-      redirect_uri: ""
-    })
-  ```

data/html/README_md.html

@@ -1,189 +0,0 @@
-<!DOCTYPE html>
-
-<html>
-<head>
-<meta charset="UTF-8">
-
-<title>README - 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" role="document" class="file">
-<nav role="navigation">
-  <div id="project-navigation">
-    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
-  <h2>
-    <a href="./index.html" rel="home">Home</a>
-  </h2>
-
-  <div id="table-of-contents-navigation">
-    <a href="./table_of_contents.html#pages">Pages</a>
-    <a href="./table_of_contents.html#classes">Classes</a>
-    <a href="./table_of_contents.html#methods">Methods</a>
-  </div>
-</div>
-
-    <div id="search-section" role="search" class="project-section initially-hidden">
-  <form action="#" method="get" accept-charset="utf-8">
-    <div id="search-field-wrapper">
-      <input id="search-field" role="combobox" aria-label="Search"
-             aria-autocomplete="list" aria-controls="search-results"
-             type="text" name="search" placeholder="Search" spellcheck="false"
-             title="Type to search, Up and Down to navigate, Enter to load">
-    </div>
-
-    <ul id="search-results" aria-label="Search Results"
-        aria-busy="false" aria-expanded="false"
-        aria-atomic="false" class="initially-hidden"></ul>
-  </form>
-</div>
-
-  </div>
-
-  
-<div class="nav-section">
-  <h3>Table of Contents</h3>
-
-  <ul class="link-list" role="directory">
-    <li><a href="#label-bih-2Fspotify-ruby">bih/spotify-ruby</a>
-    <li><a href="#label-Installation">Installation</a>
-    <li><a href="#label-Setup">Setup</a>
-    <li><a href="#label-Authentication">Authentication</a>
-    <li><a href="#label-Usage">Usage</a>
-    <li><a href="#label-Development">Development</a>
-    <li><a href="#label-Contributing">Contributing</a>
-    <li><a href="#label-License">License</a>
-    <li><a href="#label-Code+of+Conduct">Code of Conduct</a>
-  </ul>
-</div>
-
-
-  <div id="project-metadata">
-    <div id="fileindex-section" class="nav-section">
-  <h3>Pages</h3>
-
-  <ul class="link-list">
-  
-    <li><a href="./README_md.html">README</a>
-  
-  </ul>
-</div>
-
-  </div>
-</nav>
-
-<main role="main" aria-label="Page README.md">
-
-<h1 id="label-bih-2Fspotify-ruby">bih/spotify-ruby<span><a href="#label-bih-2Fspotify-ruby">&para;</a> <a href="#top">&uarr;</a></span></h1>
-
-<p>A modern, opinionated and <em>unofficial</em> Ruby SDK for the <a
-href="https://developer.spotify.com/documentation/web-api/reference/">Spotify
-Web API</a> to help developers all over the world build amazing music
-things with <a href="Spotify.html">Spotify</a>.</p>
-
-<p>This is a work in progress. <strong>Currently in pre-alpha.</strong></p>
-
-<p><a href="https://travis-ci.org/bih/spotify-ruby"><img
-src="https://travis-ci.org/bih/spotify-ruby.svg?branch=master"></a></p>
-
-<h2 id="label-Installation">Installation<span><a href="#label-Installation">&para;</a> <a href="#top">&uarr;</a></span></h2>
-
-<p>Add this line to your application&#39;s Gemfile:</p>
-
-<pre class="ruby"><span class="ruby-identifier">gem</span> <span class="ruby-string">&#39;spotify-ruby&#39;</span>
-</pre>
-
-<p>And then execute:</p>
-
-<pre>$ bundle</pre>
-
-<p>Or install it yourself as:</p>
-
-<pre>$ gem install spotify-ruby</pre>
-
-<h2 id="label-Setup">Setup<span><a href="#label-Setup">&para;</a> <a href="#top">&uarr;</a></span></h2>
-
-<p>You&#39;ll need to create a <code>Spotify::Auth</code> instance with your
-credentials.</p>
-
-<pre class="ruby"><span class="ruby-ivar">@auth</span> = <span class="ruby-constant">Spotify</span><span class="ruby-operator">::</span><span class="ruby-constant">Auth</span>.<span class="ruby-identifier">new</span>({
-  <span class="ruby-identifier">client_id</span><span class="ruby-operator">:</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">&quot;SPOTIFY_CLIENT_ID&quot;</span>],
-  <span class="ruby-identifier">client_secret</span><span class="ruby-operator">:</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">&quot;SPOTIFY_CLIENT_SECRET&quot;</span>],
-  <span class="ruby-identifier">redirect_uri</span><span class="ruby-operator">:</span> <span class="ruby-constant">ENV</span>[<span class="ruby-string">&quot;SPOTIFY_REDIRECT_URI&quot;</span>]
-})
-</pre>
-
-<h2 id="label-Authentication">Authentication<span><a href="#label-Authentication">&para;</a> <a href="#top">&uarr;</a></span></h2>
-
-<p>With our <code>@auth</code> instance, we can initiate an authentication URL
-for <code>https://accounts.spotify.com</code>. By default, this will have
-all the values needed to get a user setup.</p>
-
-<pre class="ruby"><span class="ruby-ivar">@auth</span>.<span class="ruby-identifier">authorize_url</span> <span class="ruby-comment"># =&gt; https://accounts.spotify.com/oauth/authorize?client_id=...&amp;redirect_uri=...</span>
-</pre>
-
-<h2 id="label-Usage">Usage<span><a href="#label-Usage">&para;</a> <a href="#top">&uarr;</a></span></h2>
-
-<pre class="ruby"><span class="ruby-identifier">spotify</span> = <span class="ruby-constant">Spotify</span><span class="ruby-operator">::</span><span class="ruby-constant">SDK</span>.<span class="ruby-identifier">new</span>
-<span class="ruby-identifier">spotify</span>.<span class="ruby-identifier">access_token</span> = <span class="ruby-string">&quot;[access token]&quot;</span>
-
-<span class="ruby-identifier">puts</span> <span class="ruby-identifier">spotify</span>.<span class="ruby-identifier">connect</span>.<span class="ruby-identifier">devices</span>
-</pre>
-
-<p>TODO: Write usage instructions here</p>
-
-<h2 id="label-Development">Development<span><a href="#label-Development">&para;</a> <a href="#top">&uarr;</a></span></h2>
-
-<p>After checking out the repo, run <code>bin/setup</code> to install
-dependencies. Then, run <code>rake spec</code> to run the tests. You can
-also run <code>bin/console</code> for an interactive prompt that will allow
-you to experiment.</p>
-
-<p>To install this gem onto your local machine, run <code>bundle exec rake
-install</code>. To release a new version, update the version number in
-<code>version.rb</code>, and then run <code>bundle exec rake
-release</code>, which will create a git tag for the version, push git
-commits and tags, and push the <code>.gem</code> file to <a
-href="https://rubygems.org">rubygems.org</a>.</p>
-
-<h2 id="label-Contributing">Contributing<span><a href="#label-Contributing">&para;</a> <a href="#top">&uarr;</a></span></h2>
-
-<p>Bug reports and pull requests are welcome on GitHub at <a
-href="https://github.com/bih/spotify-ruby">github.com/bih/spotify-ruby</a>.
-This project is intended to be a safe, welcoming space for collaboration,
-and contributors are expected to adhere to the <a
-href="http://contributor-covenant.org">Contributor Covenant</a> code of
-conduct.</p>
-
-<h2 id="label-License">License<span><a href="#label-License">&para;</a> <a href="#top">&uarr;</a></span></h2>
-
-<p>The gem is available as open source under the terms of the <a
-href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
-
-<h2 id="label-Code+of+Conduct">Code of Conduct<span><a href="#label-Code+of+Conduct">&para;</a> <a href="#top">&uarr;</a></span></h2>
-
-<p>Everyone interacting in the <code>spotify-ruby</code> project’s codebases,
-issue trackers, chat rooms and mailing lists is expected to follow the <a
-href="https://github.com/bih/spotify-ruby/blob/master/CODE_OF_CONDUCT.md">code
-of conduct</a>.</p>
-</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>
-