spotify 7.0.4 → 8.0.0

data/.yardopts

@@ -1 +1 @@
--e ./lib/yard-ffi.rb
+-e ./lib/yard-ffi-plugin.rb

data/README.markdown

@@ -1,14 +1,17 @@
-libspotify FFI bindings for Ruby
-================================
-[libspotify](http://developer.spotify.com/en/libspotify/overview/) is a C library which allows developers to interact with the Spotify music streaming service. I wanted to be able to use this library in Ruby, and thus [Hallon](https://github.com/Burgestrand/Hallon) was born. Hallon, however, is more than just bindings to libspotify, it’s my attempt to make the API a joy to use. This is Ruby, after all!
+Ruby FFI bindings for [libspotify][]
+====================================
 
-Hallon recently changed from being a C extension to using [Ruby FFI](https://github.com/ffi/ffi), and in the process I created libspotify for Ruby. I decided to extract that work into its’ own gem, and here it is.
+    The libspotify C API package allows third party developers to write
+    applications that utilize the Spotify music streaming service.
 
-This is a very primitive library!
----------------------------------
-There is no sugar-coating. When (if) you use this library you will practically be writing C, handling pointers and so on; only you’ll be doing it in Ruby.
+[Spotify][] is a really nice music streaming service, and being able to interact with it in an API is awesome. However, because libspotify is a C library, writing applications with it is cumbersome and error-prone compared to doing it in Ruby. As I found myself needing to do this one day, knowing I’d rather not be writing it in C, this gem was born.
 
-If you want a library that is easier to use, have a look at [Hallon](https://github.com/Burgestrand/Hallon).
+Spotify, the gem, is a thin layer of Ruby atop the [libspotify][] C library. It allows developers to use libspotify without writing a line of C, thanks to [Ruby FFI](https://rubygems.org/gems/ffi). Do note that there is no sugar-coating, and no attempts of abstraction will be made. If you want a library that is easier to use, you should have a look at [Hallon](https://github.com/Burgestrand/Hallon).
+
+(anecdotal note: this code base was previously a part of Hallon, but I decided to extract it and make a gem out of it)
+
+[libspotify]: http://developer.spotify.com/en/libspotify/overview/
+[Spotify]: https://www.spotify.com/
 
 Need help installing libspotify?
 --------------------------------

data/lib/spotify.rb

@@ -42,7 +42,7 @@ module Spotify
 
   #
   enum :sampletype, [:int16_native_endian]
-  enum :bitrate, %w(160k 320k)
+  enum :bitrate, %w(160k 320k 96k).map(&:to_sym)
 
   # FFI::Struct for Audio Format.
   #
@@ -71,9 +71,19 @@ module Spotify
 
   #
   enum :connectionstate, [:logged_out, :logged_in, :disconnected, :undefined]
+  
+  #
+  enum :connection_type, [:unknown, :none, :mobile, :mobile_roaming, :wifi, :wired]
+  
+  #
+  enum :connection_rules, [:network               , 0x1,
+                           :network_if_roaming    , 0x2,
+                           :allow_sync_over_mobile, 0x4,
+                           :allow_sync_over_wifi  , 0x8]
 
   attach_function :session_create, :sp_session_create, [ :pointer, :pointer ], :error
   attach_function :session_release, :sp_session_release, [ :pointer ], :void
+  
   attach_function :session_login, :sp_session_login, [ :pointer, :string, :string ], :void
   attach_function :session_user, :sp_session_user, [ :pointer ], :pointer
   attach_function :session_logout, :sp_session_logout, [ :pointer ], :void
@@ -94,6 +104,15 @@ module Spotify
   attach_function :session_preferred_bitrate, :sp_session_preferred_bitrate, [ :pointer, :bitrate ], :void
   attach_function :session_num_friends, :sp_session_num_friends, [ :pointer ], :int
   attach_function :session_friend, :sp_session_friend, [ :pointer, :int ], :pointer
+  
+  attach_function :session_set_connection_type, :sp_session_set_connection_type, [ :pointer, :pointer ], :void
+  attach_function :session_set_connection_rules, :sp_session_set_connection_rules, [ :pointer, :pointer ], :void
+  attach_function :offline_tracks_to_sync, :sp_offline_tracks_to_sync, [ :pointer ], :int
+  attach_function :offline_num_playlists, :sp_offline_num_playlists, [ :pointer ], :int
+  attach_function :offline_sync_get_status, :sp_offline_sync_get_status, [ :pointer, :pointer ], :void
+  attach_function :session_user_country, :sp_session_user_country, [ :pointer ], :int
+  attach_function :session_preferred_offline_bitrate, :sp_session_preferred_offline_bitrate, [ :pointer, :bitrate, :bool ], :void
+  
 
   # FFI::Struct for Session callbacks.
   #
@@ -112,6 +131,7 @@ module Spotify
   # @attr [callback(:pointer):void] start_playback
   # @attr [callback(:pointer):void] stop_playback
   # @attr [callback(:pointer, :pointer):void] get_audio_buffer_stats
+  # @attr [callback(:pointer)::void] offline_status_updated
   class SessionCallbacks < FFI::Struct
     layout :logged_in, callback([ :pointer, :error ], :void),
            :logged_out, callback([ :pointer ], :void),
@@ -127,7 +147,8 @@ module Spotify
            :userinfo_updated, callback([ :pointer ], :void),
            :start_playback, callback([ :pointer ], :void),
            :stop_playback, callback([ :pointer ], :void),
-           :get_audio_buffer_stats, callback([ :pointer, :pointer ], :void)
+           :get_audio_buffer_stats, callback([ :pointer, :pointer ], :void),
+           :offline_status_updated, callback([ :pointer ], :void)
   end
 
   # FFI::Struct for Session configuration.
@@ -154,6 +175,29 @@ module Spotify
            :dont_save_metadata_for_playlists, :int,
            :initially_unload_playlists, :int
   end
+  
+  # FFI::Struct for Offline Sync Status
+  # 
+  # @attr [Fixnum] queued_tracks
+  # @attr [Fixnum] queued_bytes
+  # @attr [Fixnum] done_tracks
+  # @attr [Fixnum] done_bytes
+  # @attr [Fixnum] copied_tracks
+  # @attr [Fixnum] copied_bytes
+  # @attr [Fixnum] willnotcopy_tracks
+  # @attr [Fixnum] error_tracks
+  # @attr [Fixnum] syncing
+  class OfflineSyncStatus < FFI::Struct
+    layout :queued_tracks, :int,
+           :queued_bytes, :uint64,
+           :done_tracks, :int,
+           :done_bytes, :uint64,
+           :copied_tracks, :int,
+           :copied_bytes, :uint64,
+           :willnotcopy_tracks, :int,
+           :error_tracks, :int,
+           :syncing, :int
+  end
 
   #
   # Link
@@ -162,7 +206,7 @@ module Spotify
 
   #
   enum :linktype, [:invalid, :track, :album, :artist, :search,
-                   :playlist, :profile, :starred, :localtrack]
+                   :playlist, :profile, :starred, :localtrack, :image]
 
   attach_function :link_create_from_string, :sp_link_create_from_string, [ :string ], :pointer
   attach_function :link_create_from_track, :sp_link_create_from_track, [ :pointer, :int ], :pointer
@@ -170,6 +214,9 @@ module Spotify
   attach_function :link_create_from_artist, :sp_link_create_from_artist, [ :pointer ], :pointer
   attach_function :link_create_from_search, :sp_link_create_from_search, [ :pointer ], :pointer
   attach_function :link_create_from_playlist, :sp_link_create_from_playlist, [ :pointer ], :pointer
+  attach_function :link_create_from_artist_portrait, :sp_link_create_from_artist_portrait, [ :pointer, :int ], :pointer
+  attach_function :link_create_from_album_cover, :sp_link_create_from_album_cover, [ :pointer ], :pointer
+  attach_function :link_create_from_image, :sp_link_create_from_image, [ :pointer ], :pointer
   attach_function :link_create_from_user, :sp_link_create_from_user, [ :pointer ], :pointer
   attach_function :link_as_string, :sp_link_as_string, [ :pointer, :buffer_out, :int ], :int
   attach_function :link_type, :sp_link_type, [ :pointer ], :linktype
@@ -178,6 +225,7 @@ module Spotify
   attach_function :link_as_album, :sp_link_as_album, [ :pointer ], :pointer
   attach_function :link_as_artist, :sp_link_as_artist, [ :pointer ], :pointer
   attach_function :link_as_user, :sp_link_as_user, [ :pointer ], :pointer
+  
   attach_function :link_add_ref, :sp_link_add_ref, [ :pointer ], :void
   attach_function :link_release, :sp_link_release, [ :pointer ], :void
 
@@ -203,6 +251,7 @@ module Spotify
   attach_function :track_disc, :sp_track_disc, [ :pointer ], :int
   attach_function :track_index, :sp_track_index, [ :pointer ], :int
   attach_function :localtrack_create, :sp_localtrack_create, [ :string, :string, :string, :int ], :pointer
+  
   attach_function :track_add_ref, :sp_track_add_ref, [ :pointer ], :void
   attach_function :track_release, :sp_track_release, [ :pointer ], :void
 
@@ -221,6 +270,7 @@ module Spotify
   attach_function :album_name, :sp_album_name, [ :pointer ], :string
   attach_function :album_year, :sp_album_year, [ :pointer ], :int
   attach_function :album_type, :sp_album_type, [ :pointer ], :albumtype
+  
   attach_function :album_add_ref, :sp_album_add_ref, [ :pointer ], :void
   attach_function :album_release, :sp_album_release, [ :pointer ], :void
 
@@ -240,6 +290,7 @@ module Spotify
   attach_function :albumbrowse_num_tracks, :sp_albumbrowse_num_tracks, [ :pointer ], :int
   attach_function :albumbrowse_track, :sp_albumbrowse_track, [ :pointer, :int ], :pointer
   attach_function :albumbrowse_review, :sp_albumbrowse_review, [ :pointer ], :string
+  
   attach_function :albumbrowse_add_ref, :sp_albumbrowse_add_ref, [ :pointer ], :void
   attach_function :albumbrowse_release, :sp_albumbrowse_release, [ :pointer ], :void
 
@@ -251,6 +302,7 @@ module Spotify
   #
   attach_function :artist_name, :sp_artist_name, [ :pointer ], :string
   attach_function :artist_is_loaded, :sp_artist_is_loaded, [ :pointer ], :bool
+  
   attach_function :artist_add_ref, :sp_artist_add_ref, [ :pointer ], :void
   attach_function :artist_release, :sp_artist_release, [ :pointer ], :void
 
@@ -273,6 +325,7 @@ module Spotify
   attach_function :artistbrowse_num_similar_artists, :sp_artistbrowse_num_similar_artists, [ :pointer ], :int
   attach_function :artistbrowse_similar_artist, :sp_artistbrowse_similar_artist, [ :pointer, :int ], :pointer
   attach_function :artistbrowse_biography, :sp_artistbrowse_biography, [ :pointer ], :string
+  
   attach_function :artistbrowse_add_ref, :sp_artistbrowse_add_ref, [ :pointer ], :void
   attach_function :artistbrowse_release, :sp_artistbrowse_release, [ :pointer ], :void
 
@@ -293,6 +346,8 @@ module Spotify
   attach_function :image_format, :sp_image_format, [ :pointer ], :imageformat
   attach_function :image_data, :sp_image_data, [ :pointer, :pointer ], :pointer
   attach_function :image_image_id, :sp_image_image_id, [ :pointer ], :pointer
+  attach_function :image_create_from_link, :sp_image_create_from_link, [ :pointer, :pointer ], :pointer
+  
   attach_function :image_add_ref, :sp_image_add_ref, [ :pointer ], :void
   attach_function :image_release, :sp_image_release, [ :pointer ], :void
 
@@ -338,6 +393,7 @@ module Spotify
   attach_function :search_total_tracks, :sp_search_total_tracks, [ :pointer ], :int
   attach_function :search_total_albums, :sp_search_total_albums, [ :pointer ], :int
   attach_function :search_total_artists, :sp_search_total_artists, [ :pointer ], :int
+  
   attach_function :search_add_ref, :sp_search_add_ref, [ :pointer ], :void
   attach_function :search_release, :sp_search_release, [ :pointer ], :void
 
@@ -348,6 +404,9 @@ module Spotify
 
   #
   enum :playlist_type, [:playlist, :start_folder, :end_folder, :placeholder]
+  
+  #
+  enum :playlist_offline_status, [:no, :yes, :downloading, :waiting]
 
   attach_function :playlist_is_loaded, :sp_playlist_is_loaded, [ :pointer ], :bool
   attach_function :playlist_add_callbacks, :sp_playlist_add_callbacks, [ :pointer, :pointer, :pointer ], :void
@@ -378,6 +437,10 @@ module Spotify
   attach_function :playlist_is_in_ram, :sp_playlist_is_in_ram, [ :pointer, :pointer ], :bool
   attach_function :playlist_set_in_ram, :sp_playlist_set_in_ram, [ :pointer, :pointer, :bool ], :void
   attach_function :playlist_create, :sp_playlist_create, [ :pointer, :pointer ], :pointer
+  attach_function :playlist_get_offline_status, :sp_playlist_get_offline_status, [ :pointer, :pointer ], :playlist_offline_status
+  attach_function :playlist_get_offline_download_completed, :sp_playlist_get_offline_download_completed, [ :pointer, :pointer ], :playlist_offline_status
+  attach_function :playlist_set_offline_mode, :sp_playlist_set_offline_mode, [ :pointer, :pointer, :bool ], :void
+  
   attach_function :playlist_add_ref, :sp_playlist_add_ref, [ :pointer ], :void
   attach_function :playlist_release, :sp_playlist_release, [ :pointer ], :void
 
@@ -439,6 +502,8 @@ module Spotify
   attach_function :playlistcontainer_move_playlist, :sp_playlistcontainer_move_playlist, [ :pointer, :int, :int, :bool ], :error
   attach_function :playlistcontainer_add_folder, :sp_playlistcontainer_add_folder, [ :pointer, :int, :string ], :error
   attach_function :playlistcontainer_owner, :sp_playlistcontainer_owner, [ :pointer ], :pointer
+  attach_function :playlistcontainer_is_loaded, :sp_playlistcontainer_is_loaded, [ :pointer ], :bool
+  
   attach_function :playlistcontainer_add_ref, :sp_playlistcontainer_add_ref, [ :pointer ], :void
   attach_function :playlistcontainer_release, :sp_playlistcontainer_release, [ :pointer ], :void
 
@@ -469,6 +534,7 @@ module Spotify
   attach_function :user_full_name, :sp_user_full_name, [ :pointer ], :string
   attach_function :user_picture, :sp_user_picture, [ :pointer ], :string
   attach_function :user_relation_type, :sp_user_relation_type, [ :pointer, :pointer ], :relation_type
+  
   attach_function :user_add_ref, :sp_user_add_ref, [ :pointer ], :void
   attach_function :user_release, :sp_user_release, [ :pointer ], :void
 
@@ -484,14 +550,15 @@ module Spotify
   attach_function :toplistbrowse_create, :sp_toplistbrowse_create, [ :pointer, :toplisttype, :toplistregion, :string, callback([:pointer, :pointer], :void), :pointer ], :pointer
   attach_function :toplistbrowse_is_loaded, :sp_toplistbrowse_is_loaded, [ :pointer ], :bool
   attach_function :toplistbrowse_error, :sp_toplistbrowse_error, [ :pointer ], :error
-  attach_function :toplistbrowse_add_ref, :sp_toplistbrowse_add_ref, [ :pointer ], :void
-  attach_function :toplistbrowse_release, :sp_toplistbrowse_release, [ :pointer ], :void
   attach_function :toplistbrowse_num_artists, :sp_toplistbrowse_num_artists, [ :pointer ], :int
   attach_function :toplistbrowse_artist, :sp_toplistbrowse_artist, [ :pointer, :int ], :pointer
   attach_function :toplistbrowse_num_albums, :sp_toplistbrowse_num_albums, [ :pointer ], :int
   attach_function :toplistbrowse_album, :sp_toplistbrowse_album, [ :pointer, :int ], :pointer
   attach_function :toplistbrowse_num_tracks, :sp_toplistbrowse_num_tracks, [ :pointer ], :int
   attach_function :toplistbrowse_track, :sp_toplistbrowse_track, [ :pointer, :int ], :pointer
+  
+  attach_function :toplistbrowse_add_ref, :sp_toplistbrowse_add_ref, [ :pointer ], :void
+  attach_function :toplistbrowse_release, :sp_toplistbrowse_release, [ :pointer ], :void
 
   #
   # Inbox
@@ -501,6 +568,7 @@ module Spotify
   #
   attach_function :inbox_post_tracks, :sp_inbox_post_tracks, [ :pointer, :string, :pointer, :int, :string, callback([:pointer, :pointer], :void), :pointer ], :pointer
   attach_function :inbox_error, :sp_inbox_error, [ :pointer ], :error
+  
   attach_function :inbox_add_ref, :sp_inbox_add_ref, [ :pointer ], :void
   attach_function :inbox_release, :sp_inbox_release, [ :pointer ], :void
 end

data/lib/spotify/version.rb

@@ -1,3 +1,3 @@
 module Spotify
-  VERSION = [7, 0, 4].join('.')
+  VERSION = [8, 0, 0].join('.')
 end

data/spec/api.h

@@ -147,7 +147,7 @@ SP_LIBEXPORT(const char*) sp_error_message(sp_error error);
  * returned from sp_session_create(). Future versions of the library will provide you with some kind of mechanism
  * to request an updated version of the library.
  */
-#define SPOTIFY_API_VERSION 7
+#define SPOTIFY_API_VERSION 8
 
 /**
  * Describes the current state of the connection
@@ -182,6 +182,7 @@ typedef struct sp_audioformat {
 typedef enum sp_bitrate {
   SP_BITRATE_160k = 0,
   SP_BITRATE_320k = 1,
+  SP_BITRATE_96k = 2,
 } sp_bitrate;
 
 /**
@@ -194,6 +195,16 @@ typedef enum sp_playlist_type {
 	SP_PLAYLIST_TYPE_PLACEHOLDER  = 3, ///< Unknown entry.
 } sp_playlist_type;
 
+/*
+ * Playlist offline status
+ */
+typedef enum sp_playlist_offline_status {
+	SP_PLAYLIST_OFFLINE_STATUS_NO          = 0, ///< Playlist is not offline enabled
+	SP_PLAYLIST_OFFLINE_STATUS_YES         = 1, ///< Playlist is synchronized to local storage
+	SP_PLAYLIST_OFFLINE_STATUS_DOWNLOADING = 2, ///< This playlist is currently downloading. Only one playlist can be in this state any given time
+	SP_PLAYLIST_OFFLINE_STATUS_WAITING     = 3, ///< Playlist is queued for download
+} sp_playlist_offline_status;
+
 /**
  * Buffer stats used by get_audio_buffer_stats callback
  */
@@ -211,6 +222,79 @@ typedef struct sp_subscribers {
 } sp_subscribers;
 
 
+/**
+ * Current connection type set using sp_session_set_connection_type()
+ */
+typedef enum sp_connection_type {
+	SP_CONNECTION_TYPE_UNKNOWN        = 0, ///< Connection type unknown (Default)
+	SP_CONNECTION_TYPE_NONE           = 1, ///< No connection
+	SP_CONNECTION_TYPE_MOBILE         = 2, ///< Mobile data (EDGE, 3G, etc)
+	SP_CONNECTION_TYPE_MOBILE_ROAMING = 3, ///< Roamed mobile data (EDGE, 3G, etc)
+	SP_CONNECTION_TYPE_WIFI           = 4, ///< Wireless connection
+	SP_CONNECTION_TYPE_WIRED          = 5, ///< Ethernet cable, etc
+} sp_connection_type;
+
+
+/**
+ * Connection rules, bitwise OR of flags
+ *
+ * The default is SP_CONNECTION_RULE_NETWORK | SP_CONNECTION_RULE_ALLOW_SYNC
+ */
+typedef enum sp_connection_rules {
+	SP_CONNECTION_RULE_NETWORK                = 0x1, ///< Allow network traffic. When not set libspotify will force itself into offline mode
+	SP_CONNECTION_RULE_NETWORK_IF_ROAMING     = 0x2, ///< Allow network traffic even if roaming
+	SP_CONNECTION_RULE_ALLOW_SYNC_OVER_MOBILE = 0x4, ///< Set to allow syncing of offline content over mobile connections
+	SP_CONNECTION_RULE_ALLOW_SYNC_OVER_WIFI   = 0x8, ///< Set to allow syncing of offline content over WiFi
+} sp_connection_rules;
+
+
+/**
+ * Offline sync status
+ */
+typedef struct sp_offline_sync_status {
+	/**
+	 * Queued tracks/bytes is things left to sync in current sync
+	 * operation
+	 */
+	int queued_tracks;
+	sp_uint64 queued_bytes;
+	
+	/**
+	 * Done tracks/bytes is things marked for sync that existed on
+	 * device before current sync operation
+	 */
+	int done_tracks;
+	sp_uint64 done_bytes;
+	
+	/**
+	 * Copied tracks/bytes is things that has been copied in
+	 * current sync operation
+	 */
+	int copied_tracks;
+	sp_uint64 copied_bytes;
+
+	/**
+	 * Tracks that are marked as synced but will not be copied
+	 * (for various reasons)
+	 */
+	int willnotcopy_tracks;
+
+	/**
+	 * A track is counted as error when something goes wrong while
+	 * syncing the track
+	 */
+	int error_tracks;
+
+	/**
+	 * Set if sync operation is in progress
+	 */
+	bool syncing;
+
+} sp_offline_sync_status;
+
+
+
+
 /**
  * Session callbacks
  *
@@ -404,6 +488,13 @@ typedef struct sp_session_callbacks {
 	 */
 	void (SP_CALLCONV *get_audio_buffer_stats)(sp_session *session, sp_audio_buffer_stats *stats);
 
+	/**
+	 * Called when offline synchronization status is updated
+	 *
+	 * @param[in]  session    Session
+	 */
+	void (SP_CALLCONV *offline_status_updated)(sp_session *session);
+
 } sp_session_callbacks;
 
 /**
@@ -678,6 +769,18 @@ SP_LIBEXPORT(sp_playlistcontainer *) sp_session_publishedcontainer_for_user_crea
  */
 SP_LIBEXPORT(void) sp_session_preferred_bitrate(sp_session *session, sp_bitrate bitrate);
 
+
+/**
+ * Set preferred bitrate for offline sync
+ *
+ * @param[in]  session        Session object
+ * @param[in]  bitrate        Preferred bitrate, see ::sp_bitrate for possible values
+ * @param[in]  allow_resync   Set to true if libspotify should resynchronize already synchronized tracks. Usually you should set this to false.
+ *
+ */
+SP_LIBEXPORT(void) sp_session_preferred_offline_bitrate(sp_session *session, sp_bitrate bitrate, bool allow_resync);
+
+
 /**
  * Return number of friends in the currently logged in users friends list.
  *
@@ -699,6 +802,75 @@ SP_LIBEXPORT(int) sp_session_num_friends(sp_session *session);
  */
 SP_LIBEXPORT(sp_user *) sp_session_friend(sp_session *session, int index);
 
+
+/**
+ * Set to true if the connection is currently routed over a roamed connectivity
+ *
+ * @param[in]  session        Session object
+ * @param[in]  type           Connection type
+ *
+ * @note       Used in conjunction with sp_session_set_connection_rules() to control
+ *             how libspotify should behave in respect to network activity and offline
+ *             synchronization.
+ */
+SP_LIBEXPORT(void) sp_session_set_connection_type(sp_session *session, sp_connection_type type);
+
+
+/**
+ * Set rules for how libspotify connects to Spotify servers and synchronizes offline content
+ *
+ * @param[in]  session        Session object
+ * @param[in]  rules          Connection rules
+ *
+ * @note       Used in conjunction with sp_session_set_connection_type() to control
+ *             how libspotify should behave in respect to network activity and offline
+ *             synchronization.
+ */
+SP_LIBEXPORT(void) sp_session_set_connection_rules(sp_session *session, sp_connection_rules rules);
+
+
+
+/**
+ * Get total number of tracks that needs download before everything
+ * from all playlists that is marked for offline is fully synchronized
+ *
+ * @param[in]  session        Session object
+ *
+ * @return Number of tracks
+ */
+SP_LIBEXPORT(int) sp_offline_tracks_to_sync(sp_session *session);
+
+/**
+ * Return number of playlisys that is marked for offline synchronization
+ *
+ * @param[in]  session        Session object
+ *
+ * @return Number of playlists
+ */
+SP_LIBEXPORT(int) sp_offline_num_playlists(sp_session *session);
+
+/**
+ * Return offline synchronization status. When the internal status is
+ * updated the offline_status_updated() callback will be invoked.
+ *
+ * @param[in]  session        Session object
+ * @param[out] status         Status object that will be filled with info
+ *
+ */
+SP_LIBEXPORT(void) sp_offline_sync_get_status(sp_session *session, sp_offline_sync_status *status);
+
+/**
+ * Get currently logged in users country
+ * updated the offline_status_updated() callback will be invoked.
+ *
+ * @param[in]  session        Session object
+ *
+ * @return  Country encoded in an integer 'SE' = 'S' << 8 | 'E'
+ */
+SP_LIBEXPORT(int) sp_session_user_country(sp_session *session);
+
+
+
 /** @} */
 
 
@@ -723,6 +895,7 @@ typedef enum {
 	SP_LINKTYPE_PROFILE  = 6, ///< Link type is profile
 	SP_LINKTYPE_STARRED  = 7, ///< Link type is starred
 	SP_LINKTYPE_LOCALTRACK  = 8, ///< Link type is a local file	
+	SP_LINKTYPE_IMAGE = 9, ///< Link type is an image
 } sp_linktype;
 
 /**
@@ -764,6 +937,18 @@ SP_LIBEXPORT(sp_link *) sp_link_create_from_track(sp_track *track, int offset);
  */
 SP_LIBEXPORT(sp_link *) sp_link_create_from_album(sp_album *album);
 
+/**
+ * Create an image link object from an album
+ *
+ * @param[in]   album      An album object
+ *
+ * @return                 A link representing the album cover. Type is set to SP_LINKTYPE_IMAGE
+ *
+ * @note You need to release the link when you are done with it.
+ * @see sp_link_release()
+ */
+SP_LIBEXPORT(sp_link *) sp_link_create_from_album_cover(sp_album *album);
+
 /**
  * Creates a link object from an artist
  *
@@ -776,6 +961,20 @@ SP_LIBEXPORT(sp_link *) sp_link_create_from_album(sp_album *album);
  */
 SP_LIBEXPORT(sp_link *) sp_link_create_from_artist(sp_artist *artist);
 
+/**
+ * Creates a link object from an artist portrait
+ *
+ * @param[in]   arb        Artist browse object
+ * @param[in]   index      The index of the portrait. Should be in the interval [0, sp_artistbrowse_num_portraits() - 1]
+ *
+ * @return                 A link object representing an image
+ *
+ * @note You need to release the link when you are done with it.
+ * @see sp_link_release()
+ * @see sp_artistbrowse_num_portraits()
+ */
+SP_LIBEXPORT(sp_link *) sp_link_create_from_artist_portrait(sp_artistbrowse *arb, int index);
+
 /**
  * Generate a link object representing the current search
  *
@@ -817,6 +1016,18 @@ SP_LIBEXPORT(sp_link *) sp_link_create_from_playlist(sp_playlist *playlist);
  */
 SP_LIBEXPORT(sp_link *) sp_link_create_from_user(sp_user *user);
 
+/**
+ * Create a link object representing the given image
+ *
+ * @param[in]  image          Image object
+ *
+ * @return                    A link representing the image.
+ *
+ * @note You need to release the link when you are done with it.
+ * @see sp_link_release()
+ */
+SP_LIBEXPORT(sp_link *) sp_link_create_from_image(sp_image *image);
+
 /**
  * Create a string representation of the given Spotify link
  *
@@ -1638,6 +1849,19 @@ typedef void SP_CALLCONV image_loaded_cb(sp_image *image, void *userdata);
  */
 SP_LIBEXPORT(sp_image *) sp_image_create(sp_session *session, const byte image_id[20]);
 
+/**
+ * Create an image object from a link
+ *
+ * @param[in]  session    Session
+ * @param[in]  l          Spotify link object. This must be of SP_LINKTYPE_IMAGE type
+ *
+ * @return                Pointer to an image object. To free the object, use
+ *                        sp_image_release()
+ *
+ * @see sp_image_create
+ */
+SP_LIBEXPORT(sp_image *) sp_image_create_from_link(sp_session *session, sp_link *l);
+
 /**
  * Add a callback that will be invoked when the image is loaded
  *
@@ -2480,6 +2704,41 @@ SP_LIBEXPORT(void) sp_playlist_set_in_ram(sp_session *session, sp_playlist *play
  */
 SP_LIBEXPORT(sp_playlist *) sp_playlist_create(sp_session *session, sp_link *link);
 
+/**
+ * Mark a playlist to be synchronized for offline playback
+ *
+ * @param[in]  session        Session object
+ * @param[in]  playlist       Playlist object
+ * @param[in]  offline        True iff playlist should be offline, false otherwise
+ */
+SP_LIBEXPORT(void) sp_playlist_set_offline_mode(sp_session *session, sp_playlist *playlist, bool offline);
+
+/**
+ * Get offline status for a playlist
+ *
+ * @param[in]  session        Session object
+ * @param[in]  playlist       Playlist object
+ *
+ * @return sp_playlist_offline_status
+ *
+ * @see When in SP_PLAYLIST_OFFLINE_STATUS_DOWNLOADING mode the
+ *      sp_playlist_get_offline_download_completed() method can be used to query
+ *      progress of the download
+ */
+SP_LIBEXPORT(sp_playlist_offline_status) sp_playlist_get_offline_status(sp_session *session, sp_playlist *playlist);
+
+/**
+ * Get download progress for an offline playlist
+ *
+ * @param[in]  session        Session object
+ * @param[in]  playlist       Playlist object
+ *
+ * @return Value from 0 - 100 that indicates amount of playlist that is downloaded
+ *
+ * @see sp_playlist_offline_status()
+ */
+SP_LIBEXPORT(int) sp_playlist_get_offline_download_completed(sp_session *session, sp_playlist *playlist);
+
 /**
  * Increase the reference count of a playlist
  *
@@ -2587,6 +2846,17 @@ SP_LIBEXPORT(void) sp_playlistcontainer_remove_callbacks(sp_playlistcontainer *p
  */
 SP_LIBEXPORT(int) sp_playlistcontainer_num_playlists(sp_playlistcontainer *pc);
 
+/**
+ * Return true if the playlistcontainer is fully loaded
+ *
+ * @param[in]  pc        Playlist container
+ *
+ * @return               True if container is loaded
+ *
+ * @note The container_loaded callback will be invoked when this flips to true
+ */
+SP_LIBEXPORT(bool) sp_playlistcontainer_is_loaded(sp_playlistcontainer *pc);
+
 /**
  * Return a pointer to the playlist at a specific index
  *

data/spec/spotify_spec.rb

@@ -1,12 +1,8 @@
-require 'rubygems' unless defined?(gem)
-gem 'minitest'
-require 'minitest/autorun'
-require 'minitest/spec'
-
-begin require 'minitest-rg'
-rescue LoadError; end
-
-require 'rbgccxml'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  retry if require 'rubygems'
+end
 
 #
 # Hooking FFI for extra introspection
@@ -31,7 +27,7 @@ module Spotify
   attr_reader :attached_methods
 end
 
-require 'spotify'
+Bundler.require(:default, :development)
 
 #
 # Utility
@@ -80,9 +76,7 @@ end
 describe "enums" do
   API_H_XML.enumerations.each do |enum|
     attached_enum = Spotify.enum_type enum["name"].sub(/\Asp_/, '').to_sym
-    original_enum = Hash[enum.values.map do |v|
-      [v["name"].downcase, v["init"]]
-    end]
+    original_enum = enum.values.map { |v| [v["name"].downcase, v["init"]] } # TODO: SP_BITRATE_X => X
     
     describe enum["name"] do
       it "should exist" do
@@ -90,10 +84,19 @@ describe "enums" do
       end
       
       it "should match the definition" do
-        attached_enum.symbol_map.sort_by { |k, v| -k.to_s.size }.each do |(key, value)|
-          k, v = original_enum.find { |x, _| x.match key.to_s }
-          v.must_equal value.to_s
-          original_enum.delete(k)
+        attached_enum_map = attached_enum.symbol_map
+        original_enum.each do |(name, value)|
+          a_name, a_value = attached_enum_map.find { |(n, v)| name.match n.to_s }
+          attached_enum_map.delete(a_name)
+          
+          unless a_value.to_s == value.to_s
+              p enum["name"]
+              p [name, value]
+              p [a_name, a_value]
+              puts
+          end
+          
+          a_value.to_s.must_equal value
         end
       end
     end
@@ -108,12 +111,12 @@ describe "structs" do
       struct["name"].gsub('_', '').match(/#{const}/i)
     end
     
+    attached_members = Spotify.const_get(attached_struct).members.map(&:to_s)
+    
     describe struct["name"] do
       it "should contain the same attributes" do
-        original_members = struct.variables.map(&:name)
-        
-        Spotify.const_get(attached_struct).members.each do |member|
-          original_members.must_include member.to_s
+        struct.variables.map(&:name).each do |member|
+          attached_members.must_include member
         end
       end
     end

data/spotify.gemspec

@@ -17,10 +17,11 @@ Gem::Specification.new do |gem|
   gem.version     = Spotify::VERSION
   gem.platform    = Gem::Platform::RUBY
   
-  gem.requirements << 'libspotify, v0.0.7'
+  gem.requirements << 'libspotify, v0.0.8'
   gem.add_dependency 'ffi', '~> 1.0.0'
   gem.add_development_dependency 'yard'
   gem.add_development_dependency 'rbgccxml'
+  gem.add_development_dependency 'turn'
   gem.add_development_dependency 'minitest', '~> 2.0.0'
   gem.add_development_dependency 'bundler', '~> 1.0.0'
 end

metadata

@@ -1,79 +1,93 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: spotify
-version: !ruby/object:Gem::Version
-  version: 7.0.4
+version: !ruby/object:Gem::Version 
   prerelease: 
+  version: 8.0.0
 platform: ruby
-authors:
+authors: 
 - Kim Burgestrand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-04-20 00:00:00.000000000 +02:00
-default_executable: 
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-05-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: ffi
-  requirement: &2156760220 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 1.0.0
   type: :runtime
-  prerelease: false
-  version_requirements: *2156760220
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: yard
-  requirement: &2156759800 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *2156759800
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: rbgccxml
-  requirement: &2156759340 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: turn
   prerelease: false
-  version_requirements: *2156759340
-- !ruby/object:Gem::Dependency
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: minitest
-  requirement: &2156758780 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 2.0.0
   type: :development
-  prerelease: false
-  version_requirements: *2156758780
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: &2156758160 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 1.0.0
   type: :development
-  prerelease: false
-  version_requirements: *2156758160
+  version_requirements: *id006
 description: 
-email:
+email: 
 - kim@burgestrand.se
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gemtest
 - .gitignore
 - .yardopts
@@ -83,37 +97,37 @@ files:
 - Rakefile
 - lib/spotify.rb
 - lib/spotify/version.rb
-- lib/yard-ffi.rb
+- lib/yard-ffi-plugin.rb
 - spec/api.h
 - spec/spotify_spec.rb
 - spotify.gemspec
-has_rdoc: true
 homepage: https://github.com/Burgestrand/libspotify-ruby
-licenses:
+licenses: 
 - X11 License
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-requirements:
-- libspotify, v0.0.7
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: 
+- libspotify, v0.0.8
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.3
 signing_key: 
 specification_version: 3
 summary: Bare-bones Ruby bindings for libspotify
-test_files:
+test_files: 
 - spec/api.h
 - spec/spotify_spec.rb