hallon 0.18.0 → 0.18.1

data/lib/hallon/enumerator.rb

@@ -8,7 +8,7 @@ module Hallon
   class Enumerator
     include Enumerable
 
-    # @return [Spotify::Pointer]
+    # @return [Spotify::ManagedPointer]
     attr_reader :pointer
 
     # @macro [attach] size
@@ -26,7 +26,7 @@ module Hallon
     end
 
     # @example modifying result with a block
-    #   item :playlist_track! do |track|
+    #   item :playlist_track do |track|
     #     Track.from(track)
     #   end
     #
@@ -35,7 +35,7 @@ module Hallon
     # @yield [item, index, pointer] item from calling Spotify#item_method
     # @yieldparam item
     # @yieldparam [Integer] index
-    # @yieldparam [Spotify::Pointer] pointer
+    # @yieldparam [Spotify::ManagedPointer] pointer
     #
     # @macro [attach] item
     #   @method at(index)

data/lib/hallon/ext/spotify.rb

@@ -2,54 +2,8 @@
 
 # Extensions to the Spotify gem.
 #
-# @see https://github.com/Burgestrand/libspotify-ruby
+# @see https://github.com/Burgestrand/spotify
 module Spotify
-  # Extensions to SessionConfig, allowing more sensible configuration names.
-  SessionConfig.class_eval do
-    [:cache_location, :settings_location, :user_agent, :device_id, :proxy, :proxy_username, :proxy_password, :tracefile].each do |field|
-      method = field.to_s.gsub('location', 'path')
-
-      define_method(:"#{method}") { self[field].read_string }
-      define_method(:"#{method}=") do |string|
-        string &&= FFI::MemoryPointer.from_string(string)
-        self[field] = string
-      end
-    end
-
-    # @note Also sets application_key_size.
-    # @param [#to_s]
-    def application_key=(appkey)
-      self[:application_key] = FFI::MemoryPointer.from_string(appkey)
-      self[:application_key_size] = appkey.bytesize
-    end
-
-    # Allows setting compress_playlists using a boolean.
-    #
-    # @param [Boolean]
-    # @return [Boolean]
-    def compress_playlists=(bool)
-      self[:compress_playlists] = !! bool
-    end
-
-    # Allows setting initially_unload_playlists using a boolean.
-    #
-    # @note Set to the inverse of the requested value.
-    # @param [Boolean]
-    # @return [Boolean]
-    def load_playlists=(bool)
-      self[:initially_unload_playlists] = ! bool
-    end
-
-    # Allows setting dont_save_metadata_for_playlists using a boolean.
-    #
-    # @note Set to the inverse of the requested value.
-    # @param [Boolean]
-    # @return [Boolean]
-    def cache_playlist_metadata=(bool)
-      self[:dont_save_metadata_for_playlists] = ! bool
-    end
-  end
-
   # Makes it easier binding callbacks safely to callback structs.
   #
   # @see add

data/lib/hallon/image.rb

@@ -7,7 +7,7 @@ module Hallon
     include Linkable
 
     from_link :as_image do |link|
-      Spotify.image_create_from_link!(session.pointer, link)
+      Spotify.image_create_from_link(session.pointer, link)
     end
 
     to_link :from_image
@@ -31,14 +31,14 @@ module Hallon
     # @example from an image id
     #   image = Hallon::Image.new("3ad93423add99766e02d563605c6e76ed2b0e450")
     #
-    # @param [String, Link, Spotify::Pointer] link link or image id
+    # @param [String, Link, Spotify::Image] link link or image id
     def initialize(link)
       if link.respond_to?(:=~) and link =~ %r~(?:image[:/]|\A)([a-fA-F0-9]{40})\z~
         link = to_id($1)
       end
 
-      @pointer = to_pointer(link, :image) do
-        Spotify.image_create!(session.pointer, link)
+      @pointer = to_pointer(link, Spotify::Image) do
+        Spotify.image_create(session.pointer, link)
       end
 
       subscribe_for_callbacks do |callbacks|

data/lib/hallon/link.rb

@@ -19,7 +19,7 @@ module Hallon
         return false
       end
 
-      link = Spotify.link_create_from_string!(spotify_uri.to_s)
+      link = Spotify.link_create_from_string(spotify_uri.to_s)
       not link.null?
     end
 
@@ -38,8 +38,8 @@ module Hallon
         uri = uri.to_link.pointer
       end
 
-      @pointer = to_pointer(uri, :link) do
-        Spotify.link_create_from_string!(uri.to_str)
+      @pointer = to_pointer(uri, Spotify::Link) do
+        Spotify.link_create_from_string(uri.to_str)
       end
     end
 
@@ -87,7 +87,7 @@ module Hallon
     end
 
     # @param [Symbol] expected_type if given, makes sure the link is of this type
-    # @return [Spotify::Pointer] the underlying Spotify::Pointer.
+    # @return [Spotify::ManagedPointer] the underlying Spotify::ManagedPointer.
     # @raise ArgumentError if `type` is given and does not match link {#type}
     def pointer(expected_type = nil)
       unless type == expected_type or (expected_type == :playlist and type == :starred)

data/lib/hallon/linkable.rb

@@ -26,11 +26,11 @@ module Hallon
       #       from_link :as_album # => Spotify.link_as_album(pointer, *args)
       #       # ^ is roughly equivalent to:
       #       def from_link(link, *args)
-      #         unless Spotify::Pointer.typechecks?(link, :link)
+      #         unless link.is_a?(Spotify::Link)
       #           link = Link.new(link).pointer(:album)
       #         end
       #
-      #         Spotify.link_as_album!(link)
+      #         Spotify.link_as_album(link)
       #       end
       #     end
       #
@@ -46,30 +46,30 @@ module Hallon
       #       include Linkable
       #
       #       from_link :profile do |pointer|
-      #         Spotify.link_as_user!(pointer)
+      #         Spotify.link_as_user(pointer)
       #       end
       #       # ^ is roughly equivalent to:
       #       def from_link(link, *args)
-      #         unless Spotify::Pointer.typechecks?(link, :link)
+      #         unless link.is_a?(Spotify::Link)
       #           link = Link.new(link).pointer(:profile)
       #         end
       #
-      #         Spotify.link_as_user!(link)
+      #         Spotify.link_as_user(link)
       #       end
       #     end
       #
       #   @param [#to_s] type link type
       #   @yield [link, *args] called when conversion is needed from Link pointer
-      #   @yieldparam [Spotify::Pointer] link
+      #   @yieldparam [Spotify::Link] link
       #   @yieldparam *args any extra arguments given to `#from_link`
       #
       # @note Private API. You probably do not need to care about this method.
       def from_link(as_object, &block)
-        block ||= Spotify.method(:"link_#{as_object}!")
+        block ||= Spotify.method(:"link_#{as_object}")
         type    = as_object.to_s[/^(as_)?([^_]+)/, 2].to_sym
 
         define_method(:from_link) do |link, *args|
-          unless Spotify::Pointer.typechecks?(link, :link)
+          unless link.is_a?(Spotify::Link)
             link = Link.new(link).pointer(type)
           end
 
@@ -88,7 +88,7 @@ module Hallon
       #     to_link :from_artist
       #     # ^ is the same as:
       #     def to_link(*args)
-      #       link = Spotify.link_create_from_artist!(pointer, *args)
+      #       link = Spotify.link_create_from_artist(pointer, *args)
       #       Link.new(link)
       #     end
       #   end
@@ -97,7 +97,7 @@ module Hallon
       # @return [Link, nil]
       def to_link(cmethod)
         define_method(:to_link) do |*args|
-          link = Spotify.__send__(:"link_create_#{cmethod}!", pointer, *args)
+          link = Spotify.__send__(:"link_create_#{cmethod}", pointer, *args)
           Link.from(link)
         end
       end

data/lib/hallon/observable/playlist.rb

@@ -27,7 +27,7 @@ module Hallon::Observable
     # @yieldparam [Integer] position
     def tracks_added_callback(pointer, tracks, num_tracks, position, userdata)
       tracks_ary = tracks.read_array_of_pointer(num_tracks).map do |track|
-        ptr = Spotify::Pointer.new(track, :track, true)
+        ptr = Spotify::Track.retaining_class.new(track)
         Hallon::Track.new(ptr)
       end
 
@@ -109,8 +109,7 @@ module Hallon::Observable
     # @yieldparam [User] user
     # @yieldparam [Time] created_at
     def track_created_changed_callback(pointer, position, user, created_at, userdata)
-      user = Spotify::Pointer.new(user, :user, true)
-      trigger(pointer, :track_created_changed, position, Hallon::User.new(user), Time.at(created_at))
+      trigger(pointer, :track_created_changed, position, Hallon::User.from(user), Time.at(created_at))
     end
 
     # @example listening to this event

data/lib/hallon/observable/playlist_container.rb

@@ -26,7 +26,7 @@ module Hallon::Observable
     # @yieldparam [Playlist] playlist
     # @yieldparam [Integer] position
     def playlist_added_callback(pointer, playlist, position, userdata)
-      trigger(pointer, :playlist_added, playlist_from(playlist), position)
+      trigger(pointer, :playlist_added, Hallon::Playlist.from(playlist), position)
     end
 
     # @example listening to this event
@@ -38,7 +38,7 @@ module Hallon::Observable
     # @yieldparam [Playlist] playlist
     # @yieldparam [Integer] position
     def playlist_removed_callback(pointer, playlist, position, userdata)
-      trigger(pointer, :playlist_removed, playlist_from(playlist), position)
+      trigger(pointer, :playlist_removed, Hallon::Playlist.from(playlist), position)
     end
 
     # @example listening to this event
@@ -51,7 +51,7 @@ module Hallon::Observable
     # @yieldparam [Integer] position
     # @yieldparam [Integer] new_position
     def playlist_moved_callback(pointer, playlist, position, new_position, userdata)
-      trigger(pointer, :playlist_moved, playlist_from(playlist), position, new_position)
+      trigger(pointer, :playlist_moved, Hallon::Playlist.from(playlist), position, new_position)
     end
 
     # @example listening to this event
@@ -63,14 +63,5 @@ module Hallon::Observable
     def container_loaded_callback(pointer, userdata)
       trigger(pointer, :container_loaded)
     end
-
-    protected
-
-      # @param [Spotify::Pointer] playlist
-      # @return [Hallon::Playlist] a playlist for the given pointer.
-      def playlist_from(playlist)
-        pointer = Spotify::Pointer.new(playlist, :playlist, true)
-        Hallon::Playlist.new(pointer)
-      end
   end
 end

data/lib/hallon/player.rb

@@ -10,7 +10,7 @@ module Hallon
     # meep?
     extend Observable::Player
 
-    # @return [Spotify::Pointer<Session>] session pointer
+    # @return [Spotify::Session] session pointer
     attr_reader :pointer
 
     # @return [Symbol] one of :playing, :paused, :stopped
@@ -208,7 +208,7 @@ module Hallon
     # @raise [Spotify::Error] if libspotify does not accept the given bitrate
     # @param [Symbol] bitrate one of :96k, :160k, :320k
     def bitrate=(bitrate)
-      Spotify.session_preferred_bitrate!(pointer, bitrate)
+      Spotify.try(:session_preferred_bitrate, pointer, bitrate)
     end
 
     # Loads a Track for playing.

data/lib/hallon/playlist.rb

@@ -11,7 +11,7 @@ module Hallon
       size :playlist_num_tracks
 
       # @return [Track, nil]
-      item :playlist_track! do |track, index, pointer|
+      item :playlist_track do |track, index, pointer|
         Playlist::Track.from(track, pointer, index)
       end
     end
@@ -33,12 +33,12 @@ module Hallon
         @seen         = Spotify.playlist_track_seen(playlist_ptr, index)
         @added_at     = Time.at(Spotify.playlist_track_create_time(playlist_ptr, index)).utc
         @adder        = begin
-          creator = Spotify.playlist_track_creator!(playlist_ptr, index)
+          creator = Spotify.playlist_track_creator(playlist_ptr, index)
           User.from(creator)
         end
       end
 
-      # @return [Spotify::Pointer<Playlist>] playlist pointer this track was created from.
+      # @return [Spotify::Playlist] playlist pointer this track was created from.
       attr_reader :playlist_ptr
       private :playlist_ptr
 
@@ -99,7 +99,7 @@ module Hallon
     extend Observable::Playlist
 
     from_link :playlist do |pointer|
-      Spotify.playlist_create!(session.pointer, pointer)
+      Spotify.playlist_create(session.pointer, pointer)
     end
 
     to_link :from_playlist
@@ -126,7 +126,7 @@ module Hallon
     #
     # @param [String, Link, FFI::Pointer] link
     def initialize(link)
-      @pointer = to_pointer(link, :playlist)
+      @pointer = to_pointer(link, Spotify::Playlist)
 
       subscribe_for_callbacks do |callbacks|
         Spotify.playlist_remove_callbacks(pointer, callbacks, nil)
@@ -227,7 +227,7 @@ module Hallon
 
     # @return [User, nil]
     def owner
-      user = Spotify.playlist_owner!(pointer)
+      user = Spotify.playlist_owner(pointer)
       User.from(user)
     end
 

data/lib/hallon/playlist_container.rb

@@ -16,7 +16,7 @@ module Hallon
       item :playlistcontainer_playlist_type do |type, index, pointer|
         case type
         when :playlist
-          playlist = Spotify.playlistcontainer_playlist!(pointer, index)
+          playlist = Spotify.playlistcontainer_playlist(pointer, index)
           Playlist.from(playlist)
         when :start_folder, :end_folder
           Folder.new(pointer, folder_range(index, type))
@@ -72,7 +72,7 @@ module Hallon
       # @return [String]
       attr_reader :name
 
-      # @return [Spotify::Pointer<Container>]
+      # @return [Spotify::Container]
       attr_reader :container_ptr
       private :container_ptr
 
@@ -138,9 +138,9 @@ module Hallon
 
     # Wrap an existing PlaylistContainer pointer in an object.
     #
-    # @param [Spotify::Pointer] pointer
+    # @param [Spotify::PlaylistContainer] pointer
     def initialize(pointer)
-      @pointer = to_pointer(pointer, :playlistcontainer)
+      @pointer = to_pointer(pointer, Spotify::PlaylistContainer)
 
       subscribe_for_callbacks do |callbacks|
         Spotify.playlistcontainer_remove_callbacks(pointer, callbacks, nil)
@@ -155,7 +155,7 @@ module Hallon
 
     # @return [User, nil] owner of the container (nil if unknown or no owner).
     def owner
-      owner = Spotify.playlistcontainer_owner!(pointer)
+      owner = Spotify.playlistcontainer_owner(pointer)
       User.from(owner)
     end
 
@@ -196,13 +196,13 @@ module Hallon
     def add(playlist, force_create = false)
       resource = if force_create or not Link.valid?(playlist) and playlist.is_a?(String)
         unless error = Playlist.invalid_name?(playlist)
-          Spotify.playlistcontainer_add_new_playlist!(pointer, playlist)
+          Spotify.playlistcontainer_add_new_playlist(pointer, playlist)
         else
           raise ArgumentError, error
         end
       else
         link = Link.new(playlist)
-        Spotify.playlistcontainer_add_playlist!(pointer, link.pointer)
+        Spotify.playlistcontainer_add_playlist(pointer, link.pointer)
       end
 
       Playlist.from(resource)
@@ -310,7 +310,7 @@ module Hallon
       real_count = Spotify.playlistcontainer_get_unseen_tracks(pointer, playlist.pointer, tracks_ary, count)
       raise OperationFailedError if real_count < 0
       tracks_ary.read_array_of_pointer([real_count, count].min).map do |track|
-        track_pointer = Spotify::Pointer.new(track, :track, true)
+        track_pointer = Spotify::Track.retaining_class.new(track)
         Hallon::Track.new(track_pointer)
       end
     end

data/lib/hallon/scrobbler.rb

@@ -44,7 +44,7 @@ module Hallon
         true
       else
         FFI::Buffer.alloc_out(:bool) do |buffer|
-          Spotify.session_is_scrobbling_possible!(session.pointer, provider, buffer)
+          Spotify.try(:session_is_scrobbling_possible, session.pointer, provider, buffer)
           return ! buffer.read_uchar.zero?
         end
       end
@@ -58,7 +58,7 @@ module Hallon
     # @param [Array<Username, Password>] credentials
     def credentials=(credentials)
       username, password = Array(credentials)
-      Spotify.session_set_social_credentials!(session.pointer, provider, username, password)
+      Spotify.try(:session_set_social_credentials, session.pointer, provider, username, password)
     end
 
     # Enables or disables the local scrobbling setting.
@@ -66,7 +66,7 @@ module Hallon
     # @param [Boolean] scrobble true if you want scrobbling to be enabled
     def enabled=(scrobble)
       state = scrobble ? :local_enabled : :local_disabled
-      Spotify.session_set_scrobbling!(session.pointer, provider, state)
+      Spotify.try(:session_set_scrobbling, session.pointer, provider, state)
     end
 
     # @return [Boolean] true if scrobbling (global or local) is enabled.
@@ -82,7 +82,7 @@ module Hallon
     #
     # @return [Scrobbler]
     def reset
-      tap { Spotify.session_set_scrobbling!(session.pointer, provider, :use_global_setting) }
+      tap { Spotify.try(:session_set_scrobbling, session.pointer, provider, :use_global_setting) }
     end
 
     protected

data/lib/hallon/search.rb

@@ -12,7 +12,7 @@ module Hallon
       size :search_num_tracks
 
       # @return [Track, nil]
-      item :search_track! do |track|
+      item :search_track do |track|
         Track.from(track)
       end
 
@@ -27,7 +27,7 @@ module Hallon
       size :search_num_albums
 
       # @return [Album, nil]
-      item :search_album! do |album|
+      item :search_album do |album|
         Album.from(album)
       end
 
@@ -42,7 +42,7 @@ module Hallon
       size :search_num_artists
 
       # @return [Artist, nil]
-      item :search_artist! do |artist|
+      item :search_artist do |artist|
         Artist.from(artist)
       end
 
@@ -125,6 +125,21 @@ module Hallon
 
     # Construct a new search with given query.
     #
+    # Given enough results for a given query, all searches are paginated by libspotify.
+    # If the current number of results (say `search.tracks.size`) is less than the total
+    # number of results (`search.tracks.total`), there are more results available. To
+    # retrieve the additional tracks, you’ll need to do the same search query again, but
+    # with a higher `tracks_offset`.
+    #
+    # @example searching tracks by offset
+    #   search = Hallon::Search.new("genre:rock", tracks: 10, tracks_offset: 0).load
+    #   search.tracks.size # => 10
+    #   search.tracks.total # => 17
+    #
+    #   again  = Hallon::Search.new("genre:rock", tracks: 10, tracks_offset: 10).load
+    #   again.tracks.size # => 7
+    #   again.tracks.total # => 17
+    #
     # @param [String, Link] search search query or spotify URI
     # @param [Hash] options additional search options
     # @option options [Symbol] :type (:standard) search type, either standard or suggest
@@ -144,10 +159,10 @@ module Hallon
       search = from_link(search) if Link.valid?(search)
 
       subscribe_for_callbacks do |callback|
-        @pointer = if Spotify::Pointer.typechecks?(search, :search)
+        @pointer = if search.is_a?(Spotify::Search)
           search
         else
-          Spotify.search_create!(session.pointer, search, *opts, type, callback, nil)
+          Spotify.search_create(session.pointer, search, *opts, type, callback, nil)
         end
 
         raise ArgumentError, "search with #{search} failed" if @pointer.null?