hallon 0.11.0 → 0.12.0

data/.yardopts

@@ -4,5 +4,6 @@
 --readme README.markdown
 --markup markdown
 --private
+--protected
 lib/**/*.rb
 ext/**/*.c

data/{CHANGELOG → CHANGELOG.md}

@@ -1,22 +1,49 @@
 Hallon’s Changelog
 ==================
 
-v0.11.0
+[v0.12.0][]
 ------------------
-[ Added ]
+
+__Added__
+
+- New system of handling callbacks (with documentation)
+- Hallon::Queue (useful for music_delivery callback)
+- PlaylistContainer::Folder#contents
+
+__Changed__
+
+- Rewrote the callback system (5f74ed8)
+- Thread.abort_on_exception = true
+- Upgraded to Spotify v10.3.0
+
+__Fixed__
+
+- Hallon::Error.maybe_raise(:is_loading) will not raise now
+- UTF8 strings in applicable places for output/input
+- Playlist#name= validation issue (allowing too long names)
+
+[v0.11.0][]
+------------------
+
+__Added__
+
 - Playlist#can_move?
 - Base.from(pointer)
 
-[ Changed ]
+__Changed__
+
 - Playlist#move no longer takes a dry_run parameter
 
-[ Fixed ]
+__Fixed__
+
 - Player#music_delivery callback ignoring consumed frames
 - Session#wait_for minimum timeout time from 0 to 10 ms
 
-v0.10.1 (actually v0.10.0)
+[v0.10.1][] (actually v0.10.0)
 ------------------
-[ Added ]
+
+__Added__
+
 - Add PlaylistContainer::Folder#rename
 - Add PlaylistContainer#insert_folder
 - Add PlaylistContainer#move (do see #57)
@@ -27,33 +54,39 @@ v0.10.1 (actually v0.10.0)
 - Playlist::Track#moved?
 - PlaylistContainer callback support (to be changed, see #56)
 
-[ Fixed ]
+__Fixed__
+
 - A lot of random deadlocks (updated spotify gem dependency)
 
-v0.9.1
+[v0.9.1][]
 ------------------
-[ Added ]
+
+__Added__
+
 - PlaylistContainer#size
 - User#published
 - PlaylistContainer#contents (only for playlists)
 - PlaylistContainer#add (existing playlist, new playlist)
 
-[ Changed ]
+__Changed__
+
 - Playlist#seen now moved to Playlist::Track#seen=
 
-[ Fixed ]
+__Fixed__
+
 - Album#cover null pointer issue (https://github.com/Burgestrand/Hallon/issues/53)
 - Various possible null pointer bugs
 
-
-v0.9.0
+[v0.9.0][]
 ------------------
+
 - Upgraded to libspotify *v10*
 - Improve documentation consistency
 - Link.new now raises an error if there’s no session
 - Minimal PlaylistContainer support (more to come next version)
 
-[ Added ]
+__Added__
+
 - Playlist subsystem support
 - Toplist#request_duration
 - AlbumBrowse#request_duration
@@ -75,23 +108,27 @@ v0.9.0
 - Track#unwrap
 - type parameter to Artist#browse
 
-[ Fixed ]
+__Fixed__
+
 - Moved from using FFI::Pointers to Spotify::Pointers
 - Spotify::Pointer garbage collection
 - Link#valid? using exceptions for flow control
 - Session#connection_rules= now raises an error when given invalid rule
 - Search.radio now raises an error when given invalid genres
 
-[ Changed ]
+__Changed__
+
 - Playlist::Track#seen= removed in favor of Playlist#seen(index, yesno)
 - Object#error -> Object#status (AlbumBrowse, ArtistBrowse, Search, Toplist, User)
 - Album#year renamed to Album#release_year
 - Linkable.from_link/to_link and resulting #from_link are now private
 
 
-v0.8.0
+[v0.8.0][]
 ------------------
-[ Added ]
+
+__Added__
+
 - Add example for listing track information in playlists
 - Updated to (lib)Spotify v9
 - Full Track subsystem support
@@ -112,7 +149,8 @@ v0.8.0
 - Allow Image.new to accept an image id
 - Add Hallon::API_BUILD
 
-[ Fixed ]
+__Fixed__
+
 - Improve speed of Session#wait_for for already-loaded cases
 - Error.maybe_raise no longer errors out on timeout
 - from_link now checks for null pointers
@@ -120,33 +158,38 @@ v0.8.0
 - Cleaned up specs to use same mocks everywhere
 - Make Hallon::URI match image URIs
 
-[ Broke ]
-- Ignore Ruby v1.8.x compatibility
+__Broke__
 
+- Ignore Ruby v1.8.x compatibility
 
-v0.3.0
+[v0.3.0][]
 ------------------
+
 - Don’t use bundler for :spec and :test rake tasks
 - Add Error.table
 - Add Track subsystem
 - Fix spec:cov and spotify:coverage rake tasks
 
-v0.2.1
+[v0.2.1][]
 ------------------
+
 - Fix compatibility with v1.8
 
-v0.2.0
+[v0.2.0][]
 ------------------
+
 - Alias Session#process_events_on to Session#wait_until
 - Have Error.maybe_raise return error code
 - Use mockspotify gem (https://rubygems.org/gems/mockspotify) for testing
 
-v0.1.1
+[v0.1.1][]
 ------------------
-Don’t show the README in the gem description.
 
-v0.1.0
+- Don’t show the README in the gem description.
+
+[v0.1.0][]
 ------------------
+
 Initial, first, release! This version is merely made to
 have a starting point, a point of reference, for future
 releases soon to come.
@@ -162,3 +205,15 @@ releases soon to come.
 The API is still very young, and I expect a lot of changes to
 happen to it, to make the asynchronous nature of libspotify
 easier to handle.
+
+[v0.1.0]: https://github.com/Burgestrand/Hallon/compare/5f2e118...v0.1.0
+[v0.1.1]: https://github.com/Burgestrand/Hallon/compare/v0.1.0...v0.1.1
+[v0.2.0]: https://github.com/Burgestrand/Hallon/compare/v0.1.1...v0.2.0
+[v0.2.1]: https://github.com/Burgestrand/Hallon/compare/v0.2.0...v0.2.1
+[v0.3.0]: https://github.com/Burgestrand/Hallon/compare/v0.2.1...v0.3.0
+[v0.8.0]: https://github.com/Burgestrand/Hallon/compare/v0.3.0...v0.8.0
+[v0.9.0]: https://github.com/Burgestrand/Hallon/compare/v0.8.0...v0.9.0
+[v0.9.1]: https://github.com/Burgestrand/Hallon/compare/v0.9.0...v0.9.1
+[v0.10.1]: https://github.com/Burgestrand/Hallon/compare/v0.9.1...v0.10.1
+[v0.11.0]: https://github.com/Burgestrand/Hallon/compare/v0.10.1...v0.11.0
+[v0.12.0]: https://github.com/Burgestrand/Hallon/compare/v0.11.0...v0.12.0

data/Gemfile

@@ -4,3 +4,4 @@ gemspec
 gem 'ruby_parser'
 gem 'pry'
 gem 'cover_me', :platform => :ruby_19
+gem 'coreaudio' if RUBY_PLATFORM =~ /darwin/i

data/README.markdown

@@ -53,7 +53,7 @@ Versioning policy
 -----------------
 Hallon uses [semantic versioning](http://semver.org) as of v0.0.0. As long
 as Hallon stays at major version 0, no guarantees of backwards-compatibility
-are made. CHANGELOG will be kept up to date with the different versions.
+are made. `CHANGELOG.md` will be kept up to date with the different versions.
 
 License
 -------

data/Rakefile

@@ -1,8 +1,12 @@
 # coding: utf-8
 require 'rake'
 
-require 'bundler'
-Bundler::GemHelper.install_tasks
+begin
+  require 'bundler'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  # not everybody needs these
+end
 
 require 'yard'
 YARD::Rake::YardocTask.new
@@ -68,9 +72,6 @@ task 'spotify:coverage' do
     'wrap_function',    # not a spotify function
     'lookup_return_value', # custom method
     'define_singleton_method', # overloaded by us
-    'image_remove_load_callback', # cleared when Image is GCd
-    'playlist_remove_callbacks', # cleared when Playlist is GCd
-    'playlistcontainer_remove_callbacks', # cleared when Playlist is GCd
   ]
 
   covered -= ignored
@@ -113,7 +114,8 @@ task 'spotify:coverage' do
   FileList['lib/**/*.rb'].each do |file|
     begin
       $file = file
-      ast = Ruby19Parser.new.parse File.read(file)
+      klass = defined?(Ruby19Parser)? Ruby19Parser : RubyParser
+      ast = klass.new.parse File.read(file)
       ast.each_of_type(:call) do |_, recv, meth, args, *rest|
         name = handlers[recv][meth].call(recv, meth, args)
         covered.subtract Array(name).map(&:to_s)

data/examples/adding_tracks_to_playlist.rb

@@ -1,4 +1,7 @@
 # coding: utf-8
+
+$LOAD_PATH.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
 require 'hallon'
 require './spec/support/config'
 

data/examples/logging_in.rb

@@ -1,4 +1,7 @@
 # coding: utf-8
+
+$LOAD_PATH.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
 require 'hallon'
 require './spec/support/config'
 

data/examples/playing_audio.rb

@@ -0,0 +1,130 @@
+# coding: utf-8
+
+$LOAD_PATH.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
+require 'hallon'
+require_relative '../spec/support/config'
+
+begin
+  require 'coreaudio'
+rescue LoadError
+  abort <<-ERROR
+    This example requires the ruby-coreaudio gem.
+
+    See: http://rubygems.org/gems/coreaudio
+  ERROR
+end
+
+# Utility
+def say(string)
+  system('say', string)
+end
+
+def tell(string)
+  puts(string)
+  say(string)
+end
+
+def prompt(string)
+  print(string + ': ')
+  $stdout.flush
+  say(string)
+  gets.chomp
+end
+
+# Hallon set-up.
+
+sample_rate = 44100 # 44100 samples / second
+device      = CoreAudio.default_output_device
+output      = device.output_buffer(sample_rate * 3)
+audio_queue = Hallon::Queue.new(sample_rate)
+
+session = Hallon::Session.initialize IO.read(ENV['HALLON_APPKEY']) do
+  on(:log_message) do |message|
+    puts "[LOG] #{message}"
+  end
+
+  on(:connection_error) do |error|
+    Hallon::Error.maybe_raise(error)
+  end
+
+  on(:logged_out) do
+    abort "[FAIL] Logged out!"
+  end
+end
+
+end_of_track = false
+player = Hallon::Player.new(session) do
+  on(:music_delivery) do |format, frames|
+    audio_queue.push(frames)
+  end
+
+  on(:start_playback) do
+    puts "(start playback)"
+    output.start
+  end
+
+  on(:stop_playback) do
+    puts "(stop playback)"
+    output.stop
+  end
+
+  on(:get_audio_buffer_stats) do
+    [audio_queue.size, 0]
+  end
+
+  on(:end_of_track) do
+    puts "End of track!"
+    end_of_track = true
+  end
+end
+
+# Program flow.
+
+session.login!(ENV['HALLON_USERNAME'], ENV['HALLON_PASSWORD'])
+
+search = loop do
+  query  = prompt("Enter a search term for a track you’d like to play")
+  search = Hallon::Search.new(query)
+
+  tell "Searching for “#{search.query}”…"
+  session.wait_for do
+    search.loaded? or Hallon::Error.maybe_raise(search.status)
+  end
+
+  if search.tracks.size.zero?
+    tell "No results for “#{search.query}”."
+    next
+  else
+    break search
+  end
+end
+
+tracks = search.tracks[0...10]
+session.wait_for { tracks.all?(&:loaded?) }
+
+tell "Results for “#{search.query}”: "
+tracks.each_with_index do |track, index|
+  puts "  [#{index + 1}] #{track.name} — #{track.artist.name} (#{track.to_link.to_str})"
+end
+puts
+
+track = loop do
+  index = prompt("Choose a track to play (between 1 and #{tracks.size})").to_i
+
+  if track = tracks[index - 1]
+    break track
+  else
+    tell "No such track."
+  end
+end
+
+player.play(track)
+
+tell "Alright! Playing “#{track.name}” by “#{track.artist.name}”."
+
+until end_of_track
+  output << audio_queue.pop(sample_rate)
+end
+
+tell "Done! This was “#{track.name}” by “#{track.artist.name}”. Bye bye!"

data/examples/printing_link_information.rb

@@ -1,4 +1,7 @@
 # coding: utf-8
+
+$LOAD_PATH.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
 require 'hallon'
 require './spec/support/config'
 

data/examples/show_published_playlists_of_user.rb

@@ -1,21 +1,13 @@
 # coding: utf-8
 #
 # DISCLAIMER:
-# This file was written without extensive testing, and is merely a proof
-# of concept. Before using this yourself, I advice you to look through
+# This file was written without extensive testing, and is merely an
+# example. Before using this yourself, I advice you to look through
 # the code carefully.
 #
-# The below code uses the raw Spotify FFI API, and does not represent how
-# this will be done when Hallon has API support for below operations!
-#
-# Hallon API in this file is only used for:
-# - logging in
-# - querying track information
-#
-# Raw Spotify FFI API is used for:
-# - fetching playlist container
-# - fetching playlists
-# - fetching tracks from playlists
+
+$LOAD_PATH.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
 require 'hallon'
 require './spec/support/config'