spotify-ruby 0.1.1 → 0.2.1

data/lib/spotify/sdk/model.rb

@@ -9,45 +9,62 @@ module Spotify
       ##
       # Initialize a new Model instance.
       #
-      # @param [Hash] hash The response payload.
+      # @example
+      #   module Spotify
+      #     class SDK
+      #       class User < Model
+      #       end
+      #     end
+      #   end
+      #
+      #   @base = Spotify::SDK::Base.new(@sdk)
+      #   @user = Spotify::SDK::User.new({ username: "hi" }, @base)
+      #   @user.username # => "hi"
+      #
+      # @param [Hash] payload The response payload.
       # @param [Spotify::SDK] parent The SDK object for context.
       #
       def initialize(payload, parent)
         @payload = payload
-        validate_payload
+        raise "Expected payload to be of Hash type" unless @payload.instance_of?(Hash)
 
         @parent = parent
-        validate_parent
+        raise "Expected parent to be of Spotify::SDK::Base type" unless @parent.is_a?(Spotify::SDK::Base)
 
         super(payload)
       end
 
+      def to_h # :nodoc:
+        super.to_h.except(:parent)
+      end
+
+      def to_json # :nodoc:
+        to_h.to_json
+      end
+
       ##
-      # A reference to Spotify::SDK::Connect, so we can also do stuff.
+      # A reference to Spotify::SDK::Connect.
       #
       attr_reader :parent
 
-      private
-
-      def validate_payload
-        raise Spotify::Errors::ModelPayloadExpectedToBeHashError.new unless @payload.instance_of? Hash
-      end
+      class << self
+        def alias_attribute(new_method, attribute) # :nodoc:
+          if attribute.is_a?(Symbol)
+            define_method(new_method) { send(attribute) }
+          else
+            define_method(new_method) do
+              self.class.hash_selector(to_h, attribute)
+            end
+          end
+        end
 
-      def validate_parent
-        raise Spotify::Errors::ModelParentInvalidSDKBaseObjectError.new unless @parent.is_a? Spotify::SDK::Base
+        def hash_selector(hash, selector)
+          hash.deep_symbolize_keys!
+          segments = selector.split(".")
+          hash = hash[segments.shift.try(:to_sym)] while segments.any?
+          hash
+        end
       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

@@ -4,10 +4,13 @@ module Spotify
   ##
   # The definitive version of spotify-ruby.
   #
-  # You'll need to bump this for every change. The
-  # rule of thumb is to update it by one minor version (0.1.0 -> 0.1.1)
-  # if there is no breaking changes or new features. Anything
-  # else should constitute a major version bump (0.1.0 -> 1.0.0)
+  # We follow the Semantic Versioning convention.
+  # See https://semver.org/ for more information
   #
-  VERSION = "0.1.1"
+  # Summary:
+  # MAJOR version when you make incompatible API changes,
+  # MINOR version when you add functionality in a backwards-compatible manner, and
+  # PATCH version when you make backwards-compatible bug fixes.
+  #
+  VERSION = "0.2.1"
 end

data/spotify-ruby.gemspec

@@ -10,31 +10,46 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Bilawal Hameed"]
   spec.email         = ["bil@spotify.com"]
 
-  spec.summary       = "A modern, opinionated and unofficial Ruby SDK for the Spotify API."
+  spec.summary       = "The developer-friendly, opinionated Ruby SDK for Spotify."
   spec.description   = [
     "Build integrations with the different Spotify APIs",
     "inside of your application.",
     "For more information, visit https://developer.spotify.com"
   ].join(" ")
-  spec.homepage      = "https://github.com/bih/spotify-ruby"
+  spec.homepage      = "https://bih.github.io/spotify-ruby"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features|coverage|html|examples)/})
+    f.match(%r{^(assets|bin|coverage|doc|docs|html|examples|test|spec|features)/})
   end
 
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.metadata["yard.run"] = "yri"
 
+  # We don't support executables just yet. Comment this out if you're building one.
+  # spec.bindir        = "exe"
+  # spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
+  # spec.require_paths = ["lib"]
+
+  # Tooling
   spec.add_development_dependency "bundler", "~> 1.15", ">= 1.15.4"
-  spec.add_development_dependency "coveralls", "~> 0.8.21"
   spec.add_development_dependency "rake", "~> 12.1"
-  spec.add_development_dependency "rdoc", "~> 5.1"
+
+  # Testing
+  spec.add_development_dependency "factory_bot", "~> 1.0.0.alpha"
   spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_development_dependency "rspec-collection_matchers", "~> 1.1", ">= 1.1.2"
   spec.add_development_dependency "rubocop", "~> 0.51.0"
+  spec.add_development_dependency "simplecov"
   spec.add_development_dependency "webmock", "~> 3.1"
+
+  # Developer Productivity
+  spec.add_development_dependency "pry", "~> 0.10"
+
+  # Documentation
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "yard-api"
+
+  # Runtime Dependencies
   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.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Bilawal Hameed
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2017-11-16 00:00:00.000000000 Z
+date: 2018-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,61 +31,67 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.15.4
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.21
+        version: '12.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.21
+        version: '12.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.1'
+        version: 1.0.0.alpha
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.1'
+        version: 1.0.0.alpha
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-collection_matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +106,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.51.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -115,47 +135,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
+        version: '0.10'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.6
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.6
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: oauth2
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 0.15.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 0.15.6
 description: Build integrations with the different Spotify APIs inside of your application.
   For more information, visit https://developer.spotify.com
 email:
@@ -176,29 +224,29 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/spotify.rb
-- lib/spotify/auth.rb
+- lib/spotify/accounts.rb
+- lib/spotify/accounts/session.rb
 - lib/spotify/sdk.rb
 - lib/spotify/sdk/.keep
+- lib/spotify/sdk/album.rb
+- lib/spotify/sdk/artist.rb
 - 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/connect/playback_state.rb
+- lib/spotify/sdk/image.rb
+- lib/spotify/sdk/item.rb
+- lib/spotify/sdk/me.rb
+- lib/spotify/sdk/me/info.rb
 - lib/spotify/sdk/model.rb
 - lib/spotify/version.rb
 - spotify-ruby.gemspec
-homepage: https://github.com/bih/spotify-ruby
+homepage: https://bih.github.io/spotify-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  yard.run: yri
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -218,5 +266,6 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: A modern, opinionated and unofficial Ruby SDK for the Spotify API.
+summary: The developer-friendly, opinionated Ruby SDK for Spotify.
 test_files: []
+has_rdoc: 

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "spotify"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/spotify/auth.rb

@@ -1,111 +0,0 @@
-# frozen_string_literal: true
-
-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.
-    #
-    # @see https://developer.spotify.com/my-applications/
-    #
-    def initialize(config)
-      validate_initialized_input(config)
-      client_id = config.delete(:client_id)
-      client_secret = config.delete(:client_secret)
-      opts = {
-        site:          "https://api.spotify.com",
-        authorize_url: "https://accounts.spotify.com/oauth/authorize",
-        token_url:     "https://accounts.spotify.com/api/token"
-      }.merge(config)
-      super(client_id, 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.
-    # @return [String] A fully qualified Spotify authorization URL to send the user to.
-    #
-    # @see https://developer.spotify.com/web-api/authorization-guide/
-    #
-    def authorize_url(override_params={})
-      super({
-        client_id:     id,
-        response_type: "code",
-        scope:         SCOPES.join(" ")
-      }.merge(override_params))
-    end
-
-    private
-
-    ##
-    # Validate initialization configuration and raise errors.
-    #
-    # @param [Hash] config OAuth configuration containing the Client ID, secret and redirect URL.
-    # @return [nil]
-    #
-    def validate_initialized_input(config)
-      raise Errors::AuthClientCredentialsError.new(OAUTH_I18N[:must_be_hash]) unless config.is_a?(Hash)
-
-      %i[client_id client_secret].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