spotify_web 0.0.1

data/lib/spotify_web/resource_collection.rb

@@ -0,0 +1,99 @@
+module SpotifyWeb
+  # Represents a collection of related resources (of the same type) on
+  # Spotify
+  class ResourceCollection < Array
+    # Initializes this collection with the given resources.  This will continue
+    # to call the superclass's constructor with any additional arguments that
+    # get specified.
+    # 
+    # @api private
+    def initialize(client, *args)
+      @client = client
+      @loaded = false
+      super(*args)
+
+      # Load all resources if attempted for a single one
+      each do |resource|
+        resource.metadata = lambda { load unless loaded? }
+      end
+    end
+
+    # Loads the attributes for these resources from Spotify.  By default this is
+    # a no-op and just marks the resource as loaded.
+    # 
+    # @return [true]
+    def load
+      if count == 1
+        # Remove the metadata loader / load directly from the resource
+        first.metadata = nil
+        first.load
+      else
+        # Load each resource's metadata
+        metadata.each_with_index do |result, index|
+          self[index].metadata = result
+        end
+
+        true
+      end
+
+      @loaded = true
+    end
+    alias :reload :load
+
+    # Determines whether the current collection has been loaded from Spotify.
+    # 
+    # @return [Boolean] +true+ if the collection has been loaded, otherwise +false+
+    def loaded?
+      @loaded
+    end
+
+    # Looks up the metadata associated with all of the resources in this
+    # collection.
+    # 
+    # @api private
+    # @return [Array] The resulting metadata for each resource
+    def metadata
+      if any? && metadata_schema
+        response = api('request',
+          :uri => "hm://metadata/#{resource_name}s",
+          :batch => true,
+          :payload => map {|resource| {:uri => resource.metadata_uri}},
+          :response_schema => metadata_schema
+        )
+        response['result']
+      else
+        []
+      end
+    end
+
+    private
+    # The types of resources being stored in this collection.  This should only
+    # be called when there are actually resources available.
+    def resource_class
+      if any?
+        first.class
+      else
+        raise ArgumentError, 'Cannot determine resource class on empty collection'
+      end
+    end
+
+    # The Spotify name for the resource type
+    def resource_name
+      resource_class.resource_name
+    end
+
+    # The response schema used for looking up metadata associated with the
+    # resources
+    def metadata_schema
+      resource_class.metadata_schema
+    end
+
+    # The client that all APIs filter through
+    attr_reader :client
+
+    # Runs the given API command on the client.
+    def api(command, options = {})
+      client.api(command, options)
+    end
+  end
+end

data/lib/spotify_web/restriction.rb

@@ -0,0 +1,32 @@
+require 'spotify_web/resource'
+
+module SpotifyWeb
+  # Represents a country-based restriction on Spotify data
+  class Restriction < Resource
+    # The countries allowed to access the data
+    # @return [String]
+    attribute :countries_allowed do |countries|
+      countries.scan(/.{2}/)
+    end
+
+    # The countries forbidden to access the data
+    # @return [String]
+    attribute :countries_forbidden do |countries|
+      countries.scan(/.{2}/)
+    end
+
+    # Whether the user is permitted to access data based on this restriction
+    # @return [Boolean]
+    def permitted?
+      country = client.user.settings['country']
+
+      if countries_allowed
+        countries_allowed.include?(country)
+      elsif countries_forbidden
+        !countries_forbidden.include?(country)
+      else
+        true
+      end
+    end
+  end
+end

data/lib/spotify_web/schema.rb

@@ -0,0 +1,120 @@
+require 'net/http'
+require 'json'
+require 'rexml/document'
+
+module SpotifyWeb
+  module Schema
+    # The services that are used
+    SERVICES = %w(
+      mercury
+      metadata
+      playlist4changes
+      playlist4content
+      playlist4issues
+      playlist4meta
+      playlist4ops
+      radio
+      social
+      socialgraph
+      toplist
+    )
+
+    class << self
+      # Rebuilds all of the Beecake::Message schema definitions in Spotify.
+      # Note that this schema is not always kept up-to-date in Spotify --
+      # and can sometimes include parser errors.  As a result, there may be
+      # some manual changes that need to be made once the build is complete.
+      def build_all
+        # Prepare target directories
+        proto_dir = File.join(File.dirname(__FILE__), '../../proto')
+        schema_dir = File.join(File.dirname(__FILE__), 'schema')
+        Dir.mkdir(proto_dir) unless Dir.exists?(proto_dir)
+
+        # Build the proto files
+        packages.each do |name, package|
+          File.open("#{proto_dir}/#{name}.proto", 'w') {|f| f << package[:content]}
+        end
+
+        # Convert each proto file to a Beefcake message
+        packages.each do |name, package|
+          system(
+            {'BEEFCAKE_NAMESPACE' => package[:namespace]},
+            "protoc --beefcake_out #{schema_dir} -I #{proto_dir} #{proto_dir}/#{name}.proto"
+          )
+        end
+      end
+
+      # Generates the Protocol Buffer packages based on the current list of
+      # Spotify services.  This will merge certain services together under
+      # the same package if they have the same namespace.
+      def packages
+        packages = {}
+
+        services.values.each do |service|
+          namespace = 'SpotifyWeb::Schema'
+          if match = service[:content].match(/package spotify\.(.+)\.proto;/)
+            name = match[1]
+            namespace << '::' + name.split('.').map {|part| part.capitalize} * '::'
+          else
+            name = 'core'
+          end
+
+          if package = packages[name]
+            # Package already exists: just append the message definitions
+            content = service[:content]
+            content = content[content.index('message')..-1]
+            package[:content] += "\n#{content}"
+          else
+            # Create a new package with the entire definition
+            packages[name] = {:name => name, :namespace => namespace, :content => service[:content]}
+          end
+        end
+
+        packages
+      end
+
+      # Gets the collection of services defined in Spotify and the resource
+      # definitions associated with them
+      def services
+        services = {}
+
+        # Get the current schema
+        request = Net::HTTP::Get.new(data_url)
+        request['User-Agent'] = SpotifyWeb::USER_AGENT
+        uri = URI(data_url)
+        response = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
+          http.request(request)
+        end
+
+        # Parse each service definition
+        doc = REXML::Document.new(response.body)
+        doc.elements.each('services') do |root|
+          root.elements.each do |service|
+            name = service.name
+            if SERVICES.include?(name)
+              content = service.text.strip
+              services[name] = {:name => name, :content => content}
+            end
+          end
+        end
+
+        services
+      end
+
+      # Looks up the url representing the current schema for all Spotify services
+      def data_url
+        # Grab the login init options
+        request = Net::HTTP::Get.new('https://play.spotify.com')
+        request['User-Agent'] = SpotifyWeb::USER_AGENT
+        response = Net::HTTP.start('play.spotify.com', 443, :use_ssl => true) do |http|
+          http.request(request)
+        end
+
+        json = response.body.match(/Spotify\.Web\.Login\(document, (\{.+\}),[^\}]+\);/)[1]
+        options = JSON.parse(json)
+
+        "#{options['corejs']['protoSchemasLocation']}data.xml"
+      end
+    end
+  end
+end

data/lib/spotify_web/schema/core.pb.rb

@@ -0,0 +1,31 @@
+## Generated from core.proto for 
+require "beefcake"
+
+module SpotifyWeb
+  module Schema
+
+    class Toplist
+      include Beefcake::Message
+    end
+
+    class DecorationData
+      include Beefcake::Message
+    end
+
+    class Toplist
+      repeated :items, :string, 1
+    end
+
+
+    class DecorationData
+      optional :username, :string, 1
+      optional :full_name, :string, 2
+      optional :image_url, :string, 3
+      optional :large_image_url, :string, 5
+      optional :first_name, :string, 6
+      optional :last_name, :string, 7
+      optional :facebook_uid, :string, 8
+    end
+
+  end
+end

data/lib/spotify_web/schema/mercury.pb.rb

@@ -0,0 +1,66 @@
+## Generated from mercury.proto for spotify.mercury.proto
+require "beefcake"
+
+module SpotifyWeb
+  module Schema
+    module Mercury
+
+      class UserField
+        include Beefcake::Message
+      end
+
+      class MercuryMultiGetRequest
+        include Beefcake::Message
+      end
+
+      class MercuryMultiGetReply
+        include Beefcake::Message
+      end
+
+      class MercuryRequest
+        include Beefcake::Message
+      end
+
+      class MercuryReply
+        include Beefcake::Message
+
+        module CachePolicy
+          CACHE_NO = 1
+          CACHE_PRIVATE = 2
+          CACHE_PUBLIC = 3
+        end
+      end
+
+      class MercuryMultiGetRequest
+        repeated :request, MercuryRequest, 1
+      end
+
+
+      class MercuryMultiGetReply
+        repeated :reply, MercuryReply, 1
+      end
+
+
+      class MercuryRequest
+        optional :uri, :string, 1
+        optional :content_type, :string, 2
+        optional :method, :bytes, 3
+        optional :status_code, :sint32, 4
+        optional :source, :string, 5
+        repeated :user_fields, UserField, 6
+      end
+
+
+      class MercuryReply
+        optional :status_code, :sint32, 1
+        optional :status_message, :string, 2
+        optional :cache_policy, MercuryReply::CachePolicy, 3
+        optional :ttl, :sint32, 4
+        optional :etag, :bytes, 5
+        optional :content_type, :string, 6
+        optional :body, :bytes, 7
+      end
+
+    end
+  end
+end

data/lib/spotify_web/schema/metadata.pb.rb

@@ -0,0 +1,257 @@
+## Generated from metadata.proto for spotify.metadata.proto
+require "beefcake"
+
+module SpotifyWeb
+  module Schema
+    module Metadata
+
+      class TopTracks
+        include Beefcake::Message
+      end
+
+      class ActivityPeriod
+        include Beefcake::Message
+      end
+
+      class Artist
+        include Beefcake::Message
+      end
+
+      class AlbumGroup
+        include Beefcake::Message
+      end
+
+      class Date
+        include Beefcake::Message
+      end
+
+      class Album
+        include Beefcake::Message
+
+        module Type
+          ALBUM = 1
+          SINGLE = 2
+          COMPILATION = 3
+        end
+      end
+
+      class Track
+        include Beefcake::Message
+      end
+
+      class Image
+        include Beefcake::Message
+
+        module Size
+          DEFAULT = 0
+          SMALL = 1
+          LARGE = 2
+          XLARGE = 3
+        end
+      end
+
+      class ImageGroup
+        include Beefcake::Message
+      end
+
+      class Biography
+        include Beefcake::Message
+      end
+
+      class Disc
+        include Beefcake::Message
+      end
+
+      class Copyright
+        include Beefcake::Message
+
+        module Type
+          P = 0
+          C = 1
+        end
+      end
+
+      class Restriction
+        include Beefcake::Message
+
+        module Catalogue
+          AD = 0
+          SUBSCRIPTION = 1
+          SHUFFLE = 3
+        end
+
+        module Type
+          STREAMING = 0
+        end
+      end
+
+      class SalePeriod
+        include Beefcake::Message
+      end
+
+      class ExternalId
+        include Beefcake::Message
+      end
+
+      class AudioFile
+        include Beefcake::Message
+
+        module Format
+          OGG_VORBIS_96 = 0
+          OGG_VORBIS_160 = 1
+          OGG_VORBIS_320 = 2
+          MP3_256 = 3
+          MP3_320 = 4
+          MP3_160 = 5
+          MP3_96 = 6
+        end
+      end
+
+      class TopTracks
+        optional :country, :string, 1
+        repeated :track, Track, 2
+      end
+
+
+      class ActivityPeriod
+        optional :start_year, :sint32, 1
+        optional :end_year, :sint32, 2
+        optional :decade, :sint32, 3
+      end
+
+
+      class Artist
+        optional :gid, :bytes, 1
+        optional :name, :string, 2
+        optional :popularity, :sint32, 3
+        repeated :top_track, TopTracks, 4
+        repeated :album_group, AlbumGroup, 5
+        repeated :single_group, AlbumGroup, 6
+        repeated :compilation_group, AlbumGroup, 7
+        repeated :appears_on_group, AlbumGroup, 8
+        repeated :genre, :string, 9
+        repeated :external_id, ExternalId, 10
+        repeated :portrait, Image, 11
+        repeated :biography, Biography, 12
+        repeated :activity_period, ActivityPeriod, 13
+        repeated :restriction, Restriction, 14
+        repeated :related, Artist, 15
+        optional :is_portrait_album_cover, :bool, 16
+        optional :portrait_group, ImageGroup, 17
+      end
+
+
+      class AlbumGroup
+        repeated :album, Album, 1
+      end
+
+
+      class Date
+        optional :year, :sint32, 1
+        optional :month, :sint32, 2
+        optional :day, :sint32, 3
+      end
+
+
+      class Album
+        optional :gid, :bytes, 1
+        optional :name, :string, 2
+        repeated :artist, Artist, 3
+        optional :type, Album::Type, 4
+        optional :label, :string, 5
+        optional :date, Date, 6
+        optional :popularity, :sint32, 7
+        repeated :genre, :string, 8
+        repeated :cover, Image, 9
+        repeated :external_id, ExternalId, 10
+        repeated :disc, Disc, 11
+        repeated :review, :string, 12
+        repeated :copyright, Copyright, 13
+        repeated :restriction, Restriction, 14
+        repeated :related, Album, 15
+        repeated :sale_period, SalePeriod, 16
+        optional :cover_group, ImageGroup, 17
+      end
+
+
+      class Track
+        optional :gid, :bytes, 1
+        optional :name, :string, 2
+        optional :album, Album, 3
+        repeated :artist, Artist, 4
+        optional :number, :sint32, 5
+        optional :disc_number, :sint32, 6
+        optional :duration, :sint32, 7
+        optional :popularity, :sint32, 8
+        optional :explicit, :bool, 9
+        repeated :external_id, ExternalId, 10
+        repeated :restriction, Restriction, 11
+        repeated :file, AudioFile, 12
+        repeated :alternative, Track, 13
+        repeated :sale_period, SalePeriod, 14
+        repeated :preview, AudioFile, 15
+      end
+
+
+      class Image
+        optional :file_id, :bytes, 1
+        optional :size, Image::Size, 2
+        optional :width, :sint32, 3
+        optional :height, :sint32, 4
+      end
+
+
+      class ImageGroup
+        repeated :image, Image, 1
+      end
+
+
+      class Biography
+        optional :text, :string, 1
+        repeated :portrait, Image, 2
+        repeated :portrait_group, ImageGroup, 3
+      end
+
+
+      class Disc
+        optional :number, :sint32, 1
+        optional :name, :string, 2
+        repeated :track, Track, 3
+      end
+
+
+      class Copyright
+        optional :type, Copyright::Type, 1
+        optional :text, :string, 2
+      end
+
+
+      class Restriction
+        repeated :catalogue, Restriction::Catalogue, 1
+        optional :countries_allowed, :string, 2
+        optional :countries_forbidden, :string, 3
+        optional :type, Restriction::Type, 4
+      end
+
+
+      class SalePeriod
+        repeated :restriction, Restriction, 1
+        optional :start, Date, 2
+        optional :end, Date, 3
+      end
+
+
+      class ExternalId
+        optional :type, :string, 1
+        optional :id, :string, 2
+      end
+
+
+      class AudioFile
+        optional :file_id, :bytes, 1
+        optional :format, AudioFile::Format, 2
+      end
+
+    end
+  end
+end