hallon 0.16.0 → 0.17.0

data/.gitignore

@@ -20,10 +20,11 @@ doc/
 
 ## bundler
 .bundle
+vendor/bundle
 
 ## jeweler
 pkg
 *.gem
 
 ## Mac OS
-.DS_Store
+.DS_Store

data/.travis.yml

@@ -1,3 +1,5 @@
+language: ruby
+bundler_args: --path vendor/bundle
 rvm:
   - 1.9.2
   - 1.9.3

data/CHANGELOG.md

@@ -4,6 +4,25 @@ Hallon’s Changelog
 [HEAD][]
 ------------------
 
+[v0.17.0][]
+------------------
+Updated to libspotify v12.1.45, with all the good parts included!
+
+__Added__
+
+- New session callbacks [2f6e27f9]
+- Support for image sizes [5f8156c]
+- Add Session#username [4cce4c55]
+- Support for specifying session proxy in Session#initialize [c61e5c5]
+- Add Session#private? and Session#private= [bcf2805] (1000th commit!)
+- Support for audio scrobbling [955a1b6, 627e0b, cf7957]
+
+__Changed__
+
+- Extracted Spotify::Pointer into Spotify gem [5cc88e9d]
+- Move GC-wrapped functions to the Spotify gem [d8eda4]
+- Moved error handling to Spotify gem [d31af5a]
+
 [v0.16.0][]
 ------------------
 This release brings a lot of changes to the Hallon test suite, mainly to make
@@ -361,4 +380,6 @@ easier to handle.
 [v0.13.0]: https://github.com/Burgestrand/Hallon/compare/v0.12.0...v0.13.0
 [v0.14.0]: https://github.com/Burgestrand/Hallon/compare/v0.13.0...v0.14.0
 [v0.15.0]: https://github.com/Burgestrand/Hallon/compare/v0.14.0...v0.15.0
-[HEAD]: https://github.com/Burgestrand/Hallon/compare/v0.15.0...HEAD
+[v0.16.0]: https://github.com/Burgestrand/Hallon/compare/v0.15.0...v0.16.0
+[v0.17.0]: https://github.com/Burgestrand/Hallon/compare/v0.16.0...v0.17.0
+[HEAD]: https://github.com/Burgestrand/Hallon/compare/v0.17.0...HEAD

data/Gemfile

@@ -1,7 +1,7 @@
 source :rubygems
 gemspec
 
-gem 'ruby_parser'
+gem 'ruby_parser', '>= 3.0.0.a1', '< 4.0'
 gem 'pry'
-gem 'cover_me', :platform => :ruby_19
+gem 'simplecov'
 gem 'rb-readline'

data/README.markdown

@@ -129,7 +129,7 @@ Hallon makes use of Ruby’s own garbage collection to automatically release lib
 
 Audio support
 -------------
-Hallon supports streaming audio from Spotify via [Hallon::Player][]. When you create the player you give it your current session and an audio driver, which the player will then use for audio playback.
+Hallon supports streaming audio from Spotify via [Hallon::Player][]. When you create the player you give it your audio driver of choice, which the player will then use for audio playback.
 
 ```ruby
 require 'hallon'
@@ -141,7 +141,7 @@ session.login!('username', 'password')
 track = Hallon::Track.new("spotify:track:1ZPsdTkzhDeHjA5c2Rnt2I")
 track.load
 
-player = Hallon::Player.new(session, Hallon::OpenAL)
+player = Hallon::Player.new(Hallon::OpenAL)
 player.play!(track)
 ```
 

data/Rakefile

@@ -14,23 +14,55 @@ YARD::Rake::YardocTask.new
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new('spec') do |task|
   task.ruby_opts = '-W2'
-end
+  task.rspec_opts = '-rsimplecov'
 
-desc "Run the full test suite and generate a coverage report"
-task 'spec:cov' => ['clean', 'spec'] do
-  require 'bundler/setup'
-  require 'cover_me'
-  require './spec/support/cover_me'
+  # rspec does not do this for us if we specify rspec_opts
+  opts_file   = File.expand_path('.rspec', File.dirname(__FILE__))
+  opts_string = File.readlines(opts_file).map(&:rstrip).join(' ')
+  task.rspec_opts += ' ' + opts_string
+end
 
-  CoverMe.config.at_exit = proc { `open coverage/index.html` }
-  CoverMe.complete!
+desc "Start a console with Hallon loaded (no other setup is done)"
+task :console do
+  exec 'pry -Ilib -rhallon'
 end
 
 desc "Process the Hallon codebase, finding out which Spotify methods are being used"
 task 'spotify:coverage' do
   require 'bundler/setup'
 
+  require 'pry'
   require 'set'
+
+  module Spotify
+    # Wrapped functions return pointers that are auto-GC’d by Ruby,
+    # so we ignore add_ref and release for these methods; but since
+    # we don’t know their type by mere name, we must resort to this
+    # hack to do it automatically (because we can).
+    class << self
+      def lookup_return_value(name)
+        @function_to_return_type[name.to_s]
+      end
+
+      def define_singleton_method(name, &block)
+        return_type = block.binding.eval <<-CODE
+          begin
+            return_type if __method__ == :wrap_function
+          rescue NameError
+            nil
+          end
+        CODE
+
+        if return_type
+          @function_to_return_type ||= {}
+          @function_to_return_type[name.to_s] = return_type
+        end
+
+        super
+      end
+    end
+  end
+
   require 'spotify'
 
   begin
@@ -40,33 +72,17 @@ task 'spotify:coverage' do
     abort
   end
 
-  # Wrapped functions return pointers that are auto-GC’d by Ruby,
-  # so we ignore add_ref and release for these methods; but since
-  # we don’t know their type by mere name, we must resort to this
-  # hack to do it automatically (because we can).
-  class << Spotify
-    def lookup_return_value(name)
-      @function_to_return_type[name.to_s]
-    end
-
-    def define_singleton_method(name, &block)
-      return_type = block.binding.eval("return_type")
-      @function_to_return_type ||= {}
-      @function_to_return_type[name.to_s] = return_type
-
-      super
-    end
-  end
-  require 'hallon/ext/spotify'
-
   methods = Spotify.methods(false).map(&:to_s)
-  auto_gc = Set.new(methods.grep(/!\z/))
+  auto_gc = Set.new(methods.grep(/!\z/).select { |m| Spotify.lookup_return_value(m) })
+  auto_err = Set.new(methods.grep(/!\z/)).difference(auto_gc)
   covered = Set.new(methods)
   warning = []
   ignored = [
     'attach_function',  # spotify overloads this
-    'session_release',  # segfaults on libspotify <= 9
+    'session_release',  # segfaults on libspotify <= 9, and sometimes deadlocks on libspotify <= v12
+    'session_release!', # …
     'session_userdata', # wont support this
+    'error_message',    # supported by Hallon::Error.explain
     'link_as_track',    # using link_as_track_and_offset instead
     'link_as_track!',   # using link_as_track_and_offset! instead
     'wrap_function',    # not a spotify function
@@ -89,13 +105,25 @@ task 'spotify:coverage' do
 
     result = [meth]
 
-    # if it’s auto-GC’d, we can also account for _release and _add_ref
-    if meth =~ /(.+)!\z/
-      return_type = Spotify.lookup_return_value(meth)
+    auto_err_lookup = meth.to_s.delete('!') + '!' # just one !
+
+    # if it has auto-error, we account for both versions, just assume
+    # we are doing the right thing here
+    if auto_err.member?(auto_err_lookup)
+      result << auto_err_lookup
+      result << auto_err_lookup.delete('!')
+      result.uniq!
+    end
 
-      result << $1
-      result << "#{return_type}_release"
-      result << "#{return_type}_add_ref"
+    if meth =~ /(.+)!\z/
+      # if it’s auto-GC’d, we can also account for _release and _add_ref
+      if (return_type = Spotify.lookup_return_value(meth))
+        result << $1
+        result << "#{return_type}_release"
+        result << "#{return_type}_add_ref"
+        result << "#{return_type}_release!"
+        result << "#{return_type}_add_ref!"
+      end
     end
 
     result
@@ -104,21 +132,19 @@ task 'spotify:coverage' do
   # DSL Methods
   no_receiver = handlers[nil] = Hash.new(silencer)
   no_receiver[:from_link] = no_receiver[:to_link] = proc do |recv, meth, (_, name)|
-    next unless name.respond_to?(:value)
     prefix = meth == :to_link ? "link_create" : "link"
-    method = "%s_%s" % [prefix, name.value]
+    method = "%s_%s" % [prefix, name]
     [method, "#{method}!"]
   end
 
   # Hallon::Enumerator
   no_receiver[:size] = proc do |recv, meth, (_, name)|
-    name.value if name.respond_to?(:value)
+    name
   end
 
   # Hallon::Enumerator
   no_receiver[:item] = proc do |recv, meth, (_, name)|
-    next unless name.respond_to?(:value)
-    method = name.value.to_s
+    method = name.to_s
     [method.delete("!"), method]
   end
 
@@ -133,13 +159,14 @@ task 'spotify:coverage' do
         covered.subtract Array(name).map(&:to_s)
       end
     rescue => e
-      fails[file] = e.message.strip + " (#{e.class.name})"
+      fails[file] = e.message.strip + " (#{e.class.name} #{e.backtrace[0..3]})"
     end
   end
 
   covered.group_by { |m| m[/[^_]+/] }.each_pair do |group, methods|
     puts "#{group.capitalize}:"
-    methods.each do |m|
+    no_bangs = methods.map(&:to_s).map { |m| m.delete('!') }.uniq
+    no_bangs.each do |m|
       puts "  #{m}"
     end
     puts

data/hallon.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 1.9'
 
   gem.add_dependency 'ref', '~> 1.0'
-  gem.add_dependency 'spotify', '~> 11.0.2'
+  gem.add_dependency 'spotify', '~> 12.0.2'
   gem.add_development_dependency 'rake', '~> 0.8'
   gem.add_development_dependency 'rspec', '~> 2'
   gem.add_development_dependency 'yard'

data/lib/hallon.rb

@@ -13,6 +13,7 @@ require 'hallon/base'
 require 'hallon/enumerator'
 require 'hallon/audio_queue'
 require 'hallon/blob'
+require 'hallon/scrobbler'
 
 require 'hallon/observable/album_browse'
 require 'hallon/observable/artist_browse'
@@ -68,7 +69,7 @@ module Hallon
     ))
   /x
 
-  # Thrown by {Loadable#load} and {Playlist#update} on failure.
+  # Thrown by {Loadable#load} and {Playlist#upload} on failure.
   TimeoutError = Class.new(Hallon::Error)
 
   # Raised by Session.instance
@@ -85,7 +86,7 @@ module Hallon
     # @return [Numeric] default load timeout in seconds, used in {Loadable#load}.
     attr_reader :load_timeout
 
-    # @param [Numeric] sets the default load_timeout in seconds for {Loadable#load}.
+    # @param [Numeric] new_timeout default load_timeout in seconds for {Loadable#load}.
     def load_timeout=(new_timeout)
       if new_timeout < 0
         raise ArgumentError, "timeout cannot be negative"

data/lib/hallon/album.rb

@@ -79,16 +79,18 @@ module Hallon
     end
 
     # @see cover_link
+    # @param [Symbol] size (see {Image.sizes})
     # @return [Image, nil] album cover as an Image.
-    def cover
-      cover = Spotify.album_cover(pointer)
+    def cover(size = :normal)
+      cover = Spotify.album_cover(pointer, size)
       Image.from(cover)
     end
 
     # @see cover
+    # @param [Symbol] size (see {Image.sizes})
     # @return [Link, nil] album cover as a spotify URI.
-    def cover_link
-      cover = Spotify.link_create_from_album_cover!(pointer)
+    def cover_link(size = :normal)
+      cover = Spotify.link_create_from_album_cover!(pointer, size)
       Link.from(cover)
     end
 

data/lib/hallon/artist.rb

@@ -44,16 +44,18 @@ module Hallon
     end
 
     # @see portrait_link
+    # @param [Symbol] size (see {Image.sizes})
     # @return [Image, nil] artist portrait as an Image.
-    def portrait
-      portrait = Spotify.artist_portrait(pointer)
+    def portrait(size = :normal)
+      portrait = Spotify.artist_portrait(pointer, size)
       Image.from(portrait)
     end
 
     # @see portrait
+    # @param [Symbol] size (see {Image.sizes})
     # @return [Link, nil] artist portrait as a Link.
-    def portrait_link
-      portrait = Spotify.link_create_from_artist_portrait!(pointer)
+    def portrait_link(size = :normal)
+      portrait = Spotify.link_create_from_artist_portrait!(pointer, size)
       Link.from(portrait)
     end
 

data/lib/hallon/audio_queue.rb

@@ -35,7 +35,7 @@ module Hallon
       @condvar  = @samples.new_cond
     end
 
-    # @param [#take] data
+    # @param [#take] samples
     # @return [Integer] how much of the data that was added to the queue
     def push(samples)
       synchronize do

data/lib/hallon/base.rb

@@ -40,6 +40,8 @@ module Hallon
 
     private
 
+      # See {Linkable::ClassMethods#to_link}.
+      #
       # @macro [attach] to_link
       #   @method to_link
       #   @scope  instance
@@ -49,6 +51,8 @@ module Hallon
         # {Linkable} for the actual source
       end
 
+      # See {Linkable::ClassMethods#from_link}.
+      #
       # @macro [attach] from_link
       #   @method from_link
       #   @scope  instance

data/lib/hallon/blob.rb

@@ -5,6 +5,12 @@ module Hallon
   module Blob
   end
 
+  # Used to mark strings as Hallon::Blob for Session#login.
+  #
+  # @example creating a string blob
+  #    blob = Hallon::Blob("this is now a blob")
+  #
+  # @return [String<Hallon::Blob>] a string that is now a Blob
   def self.Blob(string)
     string.extend(Blob)
   end

data/lib/hallon/error.rb

@@ -2,8 +2,13 @@
 module Hallon
   # Thrown by Hallon on libspotify errors.
   #
+  # Hallon::Error inherits two methods from Spotify::Error:
+  #
+  # - Hallon::Error.explain(error) - from a Spotify error, create a descriptive string of it
+  # - Hallon::Error.disambiguate(error) - return the tuple of [code, symbol] of a given Spotify error
+  #
   # @see http://developer.spotify.com/en/libspotify/docs/group__error.html
-  class Error < RuntimeError
+  class Error < Spotify::Error
     class << self
       # Hash of error (Symbol) to code (Integer).
       #
@@ -12,38 +17,6 @@ module Hallon
         Spotify.enum_type(:error).to_hash
       end
 
-      # Given a number or a symbol, find both the symbol and the error
-      # number it represents.
-      #
-      # @param [Symbol, Fixnum] error
-      # @return [[Fixnum, Symbol]] (error code, error symbol)
-      def disambiguate(error)
-        @enum ||= Spotify.enum_type(:error)
-
-        if error.is_a? Symbol
-          error = @enum[symbol = error]
-        else
-          symbol = @enum[error]
-        end
-
-        if error.nil? || symbol.nil?
-          [-1, nil]
-        else
-          [error, symbol]
-        end
-      end
-
-      # Explain a Spotify error with a string message.
-      #
-      # @example
-      #   Hallon::Error.explain(:ok) # => "No error"
-      #
-      # @param [Fixnum, Symbol]
-      # @return [String]
-      def explain(error)
-        Spotify.error_message disambiguate(error)[0]
-      end
-
       # Raise an {Error} with the given errno, unless it is `nil`, `:timeout`, `0` or `:ok`.
       #
       # @example
@@ -54,18 +27,14 @@ module Hallon
       # @param [Hash] options
       # @option options [Array] :ignore ([]) other values to ignore of error
       # @return [nil]
-      def maybe_raise(x, options = {})
+      def maybe_raise(error, options = {})
         ignore = [nil, :timeout] + Array(options[:ignore])
-        return nil if ignore.include?(x)
+        return nil if ignore.include?(error)
 
-        error, symbol = disambiguate(x)
+        error, symbol = disambiguate(error)
         return symbol if symbol == :ok
 
-        message = []
-        message << "[#{symbol.to_s.upcase}]"
-        message << explain(error)
-        message << "(#{error})"
-        raise Hallon::Error, message.join(' ')
+        raise self, explain(error)
       end
     end
   end