spotify-ruby-kev 0.2.5

data/lib/spotify/sdk/me/info.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Spotify
+  class SDK
+    class Me
+      class Info < Model
+        ##
+        # Is the user currently on Spotify Free?
+        #
+        # @example
+        #   @sdk.me.info.free?
+        #
+        # @return [TrueClass,FalseClass] is_free Return true if user is on Spotify Free.
+        #
+        def free?
+          product == "free"
+        end
+
+        ##
+        # Is the user currently on Spotify Premium?
+        #
+        # @example
+        #   @sdk.me.info.premium?
+        #
+        # @return [TrueClass,FalseClass] is_premium Return true if user is on Spotify Premium.
+        #
+        def premium?
+          product == "premium"
+        end
+
+        ##
+        # Get the user's birthdate.
+        # Requires the `user-read-birthdate` scope, otherwise it will return nil.
+        #
+        # @example
+        #   @sdk.me.info.birthdate # => Wed, 10 May 1985
+        #
+        # @return [Date,NilClass] birthdate Return the user's birthdate, otherwise return nil.
+        #
+        def birthdate
+          Date.parse(super) if super
+        end
+
+        ##
+        # Does the user have a valid display_name?
+        #
+        # @example
+        #   @sdk.me.info.display_name? # => false
+        #
+        # @return [TrueClass,FalseClass] has_display_name Return true if the user has a non-empty display name.
+        #
+        def display_name?
+          !display_name.to_s.empty?
+        end
+
+        ##
+        # Get the images for the user.
+        #
+        # @example
+        #   @sdk.me.info.images[0].spotify_uri # => "spotify:image:..."
+        #   @sdk.me.info.images[0].spotify_url # => "https://profile-images.scdn.co/..."
+        #
+        # @return [Array] images A list of all user photos wrapped in Spotify::SDK::Image
+        #
+        def images
+          super.map do |image|
+            Spotify::SDK::Image.new(image, parent)
+          end
+        end
+
+        ##
+        # Return the followers on Spotify for this user.
+        #
+        # @example
+        #   me = @sdk.me.info
+        #   me.followers # => 13913
+        #
+        # @return [Integer] followers The number of users following this user.
+        #
+        def followers
+          super[:total]
+        end
+
+        ##
+        # Get the Spotify URI for this user.
+        # Alias to self.uri
+        #
+        # @example
+        #   @sdk.me.info.spotify_uri # => "spotify:user:..."
+        #
+        # @return [String] spotify_uri The direct URI to this Spotify resource.
+        #
+        alias_attribute :spotify_uri, :uri
+
+        ##
+        # Get the Spotify HTTP URL for this user.
+        # Alias to self.external_urls[:spotify]
+        #
+        # @example
+        #   @sdk.me.info.spotify_url # => "https://open.spotify.com/..."
+        #
+        # @return [String] spotify_url The direct HTTP URL to this Spotify resource.
+        #
+        alias_attribute :spotify_url, "external_urls.spotify"
+      end
+    end
+  end
+end

data/lib/spotify/sdk/model.rb

@@ -0,0 +1,70 @@
+# 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.
+      #
+      # @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
+        raise "Expected payload to be of Hash type" unless @payload.instance_of?(Hash)
+
+        @parent = 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(*_args) # :nodoc:
+        to_h.to_json
+      end
+
+      ##
+      # A reference to Spotify::SDK::Connect.
+      #
+      attr_reader :parent
+
+      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 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
+end

data/lib/spotify/version.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Spotify
+  ##
+  # The definitive version of spotify-ruby.
+  #
+  # We follow the Semantic Versioning convention.
+  # See https://semver.org/ for more information
+  #
+  # 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.5"
+end

data/spotify-ruby-kev.gemspec

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "spotify/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "spotify-ruby-kev"
+  spec.version       = Spotify::VERSION
+  spec.authors       = ["Kevin Heffernan"]
+  spec.email         = ["kevin.heffernan97@gmail.com"]
+
+  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/kev737/spotify-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(assets|bin|coverage|doc|docs|html|examples|test|spec|features)/})
+  end
+
+  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", "~> 2.1.4", ">= 2.1.4"
+  spec.add_development_dependency "rake", "~> 12.1"
+
+  # Testing
+  spec.add_development_dependency "climate_control", "~> 0.2"
+  spec.add_development_dependency "factory_bot", "~> 5.0.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "rspec-collection_matchers", "~> 1.1", ">= 1.1.2"
+  spec.add_development_dependency "rubocop", "~> 0.71.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "webmock", "~> 3.6"
+
+  # Developer Productivity
+  spec.add_development_dependency "pry", "~> 0.12"
+
+  # Documentation
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "yard-api"
+
+  # Runtime Dependencies
+  spec.add_runtime_dependency "activesupport", "~> 6.0"
+  spec.add_runtime_dependency "httparty", ">= 0.15.6", "< 0.18"
+end

metadata

@@ -0,0 +1,291 @@
+--- !ruby/object:Gem::Specification
+name: spotify-ruby-kev
+version: !ruby/object:Gem::Version
+  version: 0.2.5
+platform: ruby
+authors:
+- Kevin Heffernan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.71.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.71.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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  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: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+description: Build integrations with the different Spotify APIs inside of your application.
+  For more information, visit https://developer.spotify.com
+email:
+- kevin.heffernan97@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/CONTRIBUTING.md"
+- ".github/ISSUE_TEMPLATE.md"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".rvm-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- COVERAGE.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/spotify.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/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-kev.gemspec
+homepage: https://github.com/kev737/spotify-ruby
+licenses:
+- MIT
+metadata:
+  yard.run: yri
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: The developer-friendly, opinionated Ruby SDK for Spotify.
+test_files: []