hallon 0.18.0 → 0.18.1

data/lib/hallon/session.rb

@@ -82,8 +82,8 @@ module Hallon
     # @param [#to_s] appkey
     # @param [Hash] options
     # @option options [String] :user_agent ("Hallon") User-Agent to use (length < `256`)
-    # @option options [String] :settings_path ("tmp") where to save settings and user-specific cache
-    # @option options [String] :cache_path ("") where to save cache files (`""` to disable)
+    # @option options [String] :settings_location ("tmp") where to save settings and user-specific cache
+    # @option options [String] :cache_location ("") where to save cache files (`""` to disable)
     # @option options [String] :tracefile (nil) path to libspotify API tracefile (`nil` to disable)
     # @option options [String] :device_id (nil) device ID for offline synchronization (`nil` to disable)
     # @option options [String] :proxy (nil) proxy URI (supports http, https, socks4, socks5)
@@ -105,8 +105,8 @@ module Hallon
 
       @options = {
         :user_agent => "Hallon",
-        :settings_path => "tmp/hallon/",
-        :cache_path => "tmp/hallon/",
+        :settings_location => "tmp/hallon/",
+        :cache_location => "tmp/hallon/",
         :load_playlists => true,
         :compress_playlists => true,
         :cache_playlist_metadata => true,
@@ -125,18 +125,19 @@ module Hallon
       @cache_size = 0
 
       subscribe_for_callbacks do |callbacks|
-        config = Spotify::SessionConfig.new
-        config[:api_version]   = Hallon::API_VERSION
-        config.application_key = appkey
-        @options.each { |(key, value)| config.send(:"#{key}=", value) }
-        config[:callbacks]     = callbacks
+        # not overridable
+        @options[:api_version] = Hallon::API_VERSION
+        @options[:initially_unload_playlists] = ! @options.delete(:load_playlists)
+        @options[:dont_save_metadata_for_playlists] = ! @options.delete(:cache_playlist_metadata)
+
+        config = Spotify::SessionConfig.new(@options.merge(application_key: appkey, callbacks: callbacks))
 
         instance_eval(&block) if block_given?
 
         # You pass a pointer to the session pointer to libspotify >:)
         FFI::MemoryPointer.new(:pointer) do |p|
           Error::maybe_raise Spotify.session_create(config, p)
-          @pointer = p.read_pointer
+          @pointer = Spotify::Session.new(p.read_pointer)
         end
       end
     end
@@ -155,7 +156,7 @@ module Hallon
     # @note returns nil if the session is not logged in.
     # @return [PlaylistContainer, nil]
     def container
-      container = Spotify.session_playlistcontainer!(pointer)
+      container = Spotify.session_playlistcontainer(pointer)
       PlaylistContainer.from(container)
     end
 
@@ -198,7 +199,7 @@ module Hallon
     # @raise [Spotify::Error] if no credentials are stored in libspotify
     # @see #relogin!
     def relogin
-      Spotify.session_relogin!(pointer)
+      Spotify.try(:session_relogin, pointer)
     end
 
     # Log in to Spotify using the given credentials.
@@ -267,7 +268,7 @@ module Hallon
 
     # @return [User] the User currently logged in.
     def user
-      user = Spotify.session_user!(pointer)
+      user = Spotify.session_user(pointer)
       User.from(user)
     end
 
@@ -411,20 +412,20 @@ module Hallon
     # @see Player.bitrates
     def offline_bitrate=(bitrate)
       bitrate, resync = Array(bitrate)
-      Spotify.session_preferred_offline_bitrate!(pointer, bitrate, !! resync)
+      Spotify.try(:session_preferred_offline_bitrate, pointer, bitrate, !! resync)
     end
 
     # @note Returns nil when no user is logged in.
     # @return [Playlist, nil] currently logged in user’s starred playlist.
     def starred
-      playlist = Spotify.session_starred_create!(pointer)
+      playlist = Spotify.session_starred_create(pointer)
       Playlist.from(playlist)
     end
 
     # @note Returns nil when no user is logged in.
     # @return [Playlist, nil] currently logged in user’s inbox playlist.
     def inbox
-      playlist = Spotify.session_inbox_create!(pointer)
+      playlist = Spotify.session_inbox_create(pointer)
       Playlist.from(playlist)
     end
 
@@ -461,7 +462,7 @@ module Hallon
       def tracks_starred(tracks, starred)
         FFI::MemoryPointer.new(:pointer, tracks.size) do |ptr|
           ptr.write_array_of_pointer tracks.map(&:pointer)
-          Spotify.track_set_starred!(pointer, ptr, tracks.size, starred)
+          Spotify.try(:track_set_starred, pointer, ptr, tracks.size, starred)
         end
       end
 

data/lib/hallon/toplist.rb

@@ -11,7 +11,7 @@ module Hallon
       size :toplistbrowse_num_tracks
 
       # @return [Track, nil]
-      item :toplistbrowse_track! do |track|
+      item :toplistbrowse_track do |track|
         Track.from(track)
       end
     end
@@ -21,7 +21,7 @@ module Hallon
       size :toplistbrowse_num_albums
 
       # @return [Album, nil]
-      item :toplistbrowse_album! do |album|
+      item :toplistbrowse_album do |album|
         Album.from(album)
       end
     end
@@ -31,7 +31,7 @@ module Hallon
       size :toplistbrowse_num_artists
 
       # @return [Artist, nil]
-      item :toplistbrowse_artist! do |artist|
+      item :toplistbrowse_artist do |artist|
         Artist.from(artist)
       end
     end
@@ -72,7 +72,7 @@ module Hallon
 
       subscribe_for_callbacks do |callback|
         @type    = type
-        @pointer = Spotify.toplistbrowse_create!(session.pointer, type, region, user, callback, nil)
+        @pointer = Spotify.toplistbrowse_create(session.pointer, type, region, user, callback, nil)
       end
     end
 

data/lib/hallon/track.rb

@@ -10,7 +10,7 @@ module Hallon
       size :track_num_artists
 
       # @return [Artist, nil]
-      item :track_artist! do |artist|
+      item :track_artist do |artist|
         Artist.from(artist)
       end
     end
@@ -43,7 +43,7 @@ module Hallon
     # @param [String, Link, FFI::Pointer] link
     def initialize(link)
       FFI::MemoryPointer.new(:int) do |ptr|
-        @pointer = to_pointer(link, :track, ptr)
+        @pointer = to_pointer(link, Spotify::Track, ptr)
         @offset  = Rational(ptr.read_int, 1000)
       end
     end
@@ -74,7 +74,7 @@ module Hallon
     # @param [Integer] length
     # @return [Track]
     def self.local(title, artist, album = nil, length = nil)
-      track = Spotify.localtrack_create!(artist, title, album || "", length || -1)
+      track = Spotify.localtrack_create(artist, title, album || "", length || -1)
       new(track)
     end
 
@@ -157,7 +157,7 @@ module Hallon
 
     # @return [Hallon::Album] album this track belongs to.
     def album
-      album = Spotify.track_album!(pointer)
+      album = Spotify.track_album(pointer)
       Album.from(album)
     end
 
@@ -188,7 +188,7 @@ module Hallon
     # @see autolinked?
     # @return [Track] the track this track is autolinked to for audio playback.
     def playable_track
-      track = Spotify.track_get_playable!(session.pointer, pointer)
+      track = Spotify.track_get_playable(session.pointer, pointer)
       Track.from(track)
     end
 

data/lib/hallon/user.rb

@@ -47,7 +47,7 @@ module Hallon
           @tracks  = tracks
           @message = message
           @recipient_name = recipient_name
-          @pointer = Spotify.inbox_post_tracks!(session.pointer, @recipient_name, ary, tracks.length, @message, callback, nil)
+          @pointer = Spotify.inbox_post_tracks(session.pointer, @recipient_name, ary, tracks.length, @message, callback, nil)
         end
       end
 
@@ -72,7 +72,7 @@ module Hallon
     include Loadable
 
     from_link :profile do |link|
-      Spotify.link_as_user!(link)
+      Spotify.link_as_user(link)
     end
 
     to_link :from_user
@@ -86,11 +86,11 @@ module Hallon
     #   Hallon::User.new("spotify:user:burgestrand")
     #
     # @note You can also instantiate User with a canonical username
-    # @param [String, Link, Spotify::Pointer] link
+    # @param [String, Link, Spotify::User] link
     def initialize(link)
-      @pointer = to_pointer(link, :user) do
+      @pointer = to_pointer(link, Spotify::User) do
         if link.is_a?(String) and link !~ /\Aspotify:user:/
-          to_pointer("spotify:user:#{link}", :user)
+          to_pointer("spotify:user:#{link}", Spotify::User)
         end
       end
     end
@@ -114,14 +114,14 @@ module Hallon
     # @note Returns nil unless {User#loaded?}
     # @return [Playlist, nil] starred playlist of the User.
     def starred
-      playlist = Spotify.session_starred_for_user_create!(session.pointer, name)
+      playlist = Spotify.session_starred_for_user_create(session.pointer, name)
       Playlist.from(playlist)
     end
 
     # @note Returns nil unless {#loaded?}
     # @return [PlaylistContainer, nil] published playlists of the User.
     def published
-      container = Spotify.session_publishedcontainer_for_user_create!(session.pointer, name)
+      container = Spotify.session_publishedcontainer_for_user_create(session.pointer, name)
       PlaylistContainer.from(container)
     end
 

data/lib/hallon/version.rb

@@ -3,5 +3,5 @@ module Hallon
   # Current release version of Hallon
   #
   # @see http://semver.org/
-  VERSION = [0, 18, 0].join('.')
+  VERSION = [0, 18, 1].join('.')
 end

data/spec/hallon/album_browse_spec.rb

@@ -14,7 +14,7 @@ describe Hallon::AlbumBrowse do
 
   describe ".new" do
     it "should raise an error if the browse request failed" do
-      Spotify.should_receive(:albumbrowse_create).and_return(null_pointer)
+      spotify_api.should_receive(:albumbrowse_create).and_return(null_pointer)
       expect { Hallon::AlbumBrowse.new(mock_album) }.to raise_error(FFI::NullPointerError)
     end
 

data/spec/hallon/artist_browse_spec.rb

@@ -15,7 +15,7 @@ describe Hallon::ArtistBrowse do
 
   describe ".new" do
     it "should raise an error if the browse request failed" do
-      Spotify.should_receive(:artistbrowse_create).and_return(null_pointer)
+      spotify_api.should_receive(:artistbrowse_create).and_return(null_pointer)
       expect { Hallon::ArtistBrowse.new(mock_artist) }.to raise_error(FFI::NullPointerError)
     end
 

data/spec/hallon/base_spec.rb

@@ -1,15 +1,18 @@
+class Spotify::BasePointer < Spotify::ManagedPointer
+end
+
 describe Hallon::Base do
   let(:klass) do
     Class.new(Hallon::Base) do
       def initialize(pointer)
-        @pointer = to_pointer(pointer, :base) { |x| x }
+        @pointer = to_pointer(pointer, Spotify::BasePointer) { |x| x }
       end
     end
   end
 
   let(:base_pointer) do
-    Spotify.stub(:base_add_ref! => nil, :base_release! => nil)
-    Spotify::Pointer.new(a_pointer, :base, true)
+    spotify_api.stub(:base_pointer_release => nil)
+    Spotify::BasePointer.new(a_pointer)
   end
 
   describe "#to_pointer" do

data/spec/hallon/enumerator_spec.rb

@@ -1,8 +1,8 @@
 # coding: utf-8
 describe Hallon::Enumerator do
   def enumerator(items)
-    Spotify.stub(:enumerator_size => items)
-    Spotify.stub(:enumerator_item).and_return { |_, i| alphabet[i] }
+    spotify_api.stub(:enumerator_size => items)
+    spotify_api.stub(:enumerator_item).and_return { |_, i| alphabet[i] }
 
     klass = Class.new(Hallon::Enumerator) do
       size :enumerator_size

data/spec/hallon/hallon_spec.rb

@@ -8,10 +8,6 @@ describe Hallon do
     specify { Hallon::API_VERSION.should == 12 }
   end
 
-  describe "API_BUILD" do
-    specify { Hallon::API_BUILD.should be_a String }
-  end
-
   describe "URI" do
     example_uris.keys.each do |uri|
       specify(uri) { Hallon::URI.match(uri)[0].should eq uri }

data/spec/hallon/link_spec.rb

@@ -13,7 +13,7 @@ describe Hallon::Link do
     end
 
     it "should raise an error given a null pointer" do
-      expect { Hallon::Link.new(Spotify::Pointer.new(null_pointer, :link, false)) }.to raise_error(ArgumentError)
+      expect { Hallon::Link.new(Spotify::Link.new(null_pointer)) }.to raise_error(ArgumentError)
     end
 
     it "should raise an error when no session instance is about" do

data/spec/hallon/linkable_spec.rb

@@ -10,7 +10,7 @@ describe Hallon::Linkable do
   let(:object) { klass.new }
   let(:pointer) { FFI::Pointer.new(1) }
 
-  before(:each) { Spotify.stub(:link_as_search!) }
+  before(:each) { spotify_api.stub(:link_as_search) }
 
   it "should define the #from_link method" do
     object.respond_to?(:from_link, true).should be_false
@@ -24,7 +24,7 @@ describe Hallon::Linkable do
 
   describe "#to_link" do
     it "should return nil if link creation failed" do
-      Spotify.should_receive(:link_create_from_user).and_return(null_pointer)
+      spotify_api.should_receive(:link_create_from_user).and_return(null_pointer)
 
       klass.instance_eval do
         to_link(:from_user)
@@ -48,7 +48,7 @@ describe Hallon::Linkable do
 
   describe "#from_link" do
     it "should call the appropriate Spotify function" do
-      Spotify.should_receive(:link_as_search!).and_return(pointer)
+      spotify_api.should_receive(:link_as_search).and_return(pointer)
 
       klass.instance_eval do
         from_link(:as_search)
@@ -58,7 +58,7 @@ describe Hallon::Linkable do
     end
 
     it "should call the given block if necessary" do
-      Spotify.should_not_receive(:link_as_search!)
+      spotify_api.should_not_receive(:link_as_search)
 
       called  = false
       pointer = double(:null? => false)

data/spec/hallon/observable/playlist_container_spec.rb

@@ -1,16 +1,16 @@
 describe Hallon::Observable::PlaylistContainer do
   specification_for_callback "playlist_added" do
-    let(:input)  { [a_pointer, mock_playlist_raw, 3, :userdata] }
+    let(:input)  { [a_pointer, mock_playlist, 3, :userdata] }
     let(:output) { [Hallon::Playlist.new(mock_playlist), 3] }
   end
 
   specification_for_callback "playlist_removed" do
-    let(:input)  { [a_pointer, mock_playlist_raw, 3, :userdata] }
+    let(:input)  { [a_pointer, mock_playlist, 3, :userdata] }
     let(:output) { [Hallon::Playlist.new(mock_playlist), 3] }
   end
 
   specification_for_callback "playlist_moved" do
-    let(:input)  { [a_pointer, mock_playlist_raw, 3, 8, :userdata] }
+    let(:input)  { [a_pointer, mock_playlist, 3, 8, :userdata] }
     let(:output) { [Hallon::Playlist.new(mock_playlist), 3, 8] }
   end
 

data/spec/hallon/observable/playlist_spec.rb

@@ -52,7 +52,7 @@ describe Hallon::Observable::Playlist do
   end
 
   specification_for_callback "track_created_changed" do
-    let(:input)  { [a_pointer, 7, mock_user_raw, 15, :userdata] }
+    let(:input)  { [a_pointer, 7, mock_user, 15, :userdata] }
     let(:output) { [7, Hallon::User.new(mock_user), Time.at(15)] }
   end
 

data/spec/hallon/player_spec.rb

@@ -31,43 +31,43 @@ describe Hallon::Player do
 
   describe "#load" do
     it "should load the given track" do
-      Spotify.should_receive(:session_player_load).with(session.pointer, track.pointer)
+      spotify_api.should_receive(:session_player_load).with(session.pointer, track.pointer)
       player.load(track)
     end
 
     it "should try to instantiate the track if it’s not a track" do
-      Spotify.should_receive(:session_player_load).with(session.pointer, track.pointer)
+      spotify_api.should_receive(:session_player_load).with(session.pointer, track.pointer)
       player.load(track.to_str)
     end
 
     it "should raise an error if load was unsuccessful" do
-      Spotify.should_receive(:session_player_load).and_return(:is_loading)
+      spotify_api.should_receive(:session_player_load).and_return(:is_loading)
       expect { player.load(track) }.to raise_error(Hallon::Error, /IS_LOADING/)
     end
   end
 
   describe "#stop" do
     it "should unload the currently loaded track" do
-      Spotify.should_receive(:session_player_unload).with(session.pointer)
+      spotify_api.should_receive(:session_player_unload).with(session.pointer)
       player.stop
     end
   end
 
   describe "#prefetch" do
     it "should set up given track for prefetching" do
-      Spotify.should_receive(:session_player_prefetch).with(session.pointer, track.pointer)
+      spotify_api.should_receive(:session_player_prefetch).with(session.pointer, track.pointer)
       player.prefetch(track)
     end
   end
 
   describe "#play" do
     it "should start playback of given track" do
-      Spotify.should_receive(:session_player_play).with(session.pointer, true)
+      spotify_api.should_receive(:session_player_play).with(session.pointer, true)
       player.play
     end
 
     it "should load and play given track if one was given" do
-      Spotify.should_receive(:session_player_play).with(session.pointer, true)
+      spotify_api.should_receive(:session_player_play).with(session.pointer, true)
       player.should_receive(:load).with(track)
       player.play(track)
     end
@@ -75,14 +75,14 @@ describe Hallon::Player do
 
   describe "#pause" do
     it "should stop playback of given track" do
-      Spotify.should_receive(:session_player_play).with(session.pointer, false)
+      spotify_api.should_receive(:session_player_play).with(session.pointer, false)
       player.pause
     end
   end
 
   describe "#seek" do
     it "should set up the currently loaded track at given position" do
-      Spotify.should_receive(:session_player_seek).with(session.pointer, 1000)
+      spotify_api.should_receive(:session_player_seek).with(session.pointer, 1000)
       player.seek(1)
     end
   end