mumbletune 0.1.3 → 0.2.1

data/.gitignore

@@ -18,3 +18,6 @@ tmp
 .DS_Store
 conf.yml
 conf.yaml
+
+spotify_appkey.key
+tmp/

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mumbletune.gemspec
 gemspec
+
+gem "mumble-ruby", :github => "elliottwilliams/mumble-ruby", :branch => "master"
+gem "hallon-queue-output", :github => "elliottwilliams/hallon-queue-output", :branch => "master"

data/Gemfile.lock

@@ -1,74 +1,67 @@
+GIT
+  remote: git://github.com/elliottwilliams/hallon-queue-output.git
+  revision: 19883c7b06a8b2bb7256bbef2579e715f359ab9e
+  branch: master
+  specs:
+    hallon-queue-output (0.0.2)
+
+GIT
+  remote: git://github.com/elliottwilliams/mumble-ruby.git
+  revision: 8a557f55d2bace410e9ca046469e7ab7344a51de
+  branch: master
+  specs:
+    mumble-ruby (0.0.3)
+      activesupport
+      celt-ruby
+      ruby-libsamplerate
+      ruby_protobuf
+
 PATH
   remote: .
   specs:
-    mumbletune (0.1.2)
-      eventmachine
-      meta-spotify
+    mumbletune (0.2.0)
+      daemons
+      ffi (~> 1.3.0)
+      hallon
       mumble-ruby
       mustache
-      ruby-mpd
-      rubypython
-      sinatra
       text
-      thin
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (3.2.12)
-      i18n (~> 0.6)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
       multi_json (~> 1.0)
-    blankslate (3.1.2)
     celt-ruby (0.0.1)
       ffi
-    columnize (0.3.6)
     daemons (1.1.9)
-    debugger (1.5.0)
-      columnize (>= 0.3.1)
-      debugger-linecache (~> 1.2.0)
-      debugger-ruby_core_source (~> 1.2.0)
-    debugger-linecache (1.2.0)
-    debugger-ruby_core_source (1.2.0)
-    eventmachine (1.0.3)
-    ffi (1.4.0)
-    httparty (0.10.2)
-      multi_json (~> 1.0)
-      multi_xml (>= 0.5.2)
-    i18n (0.6.4)
-    meta-spotify (0.3.0)
-      httparty (> 0.8)
-    multi_json (1.6.1)
-    multi_xml (0.5.3)
-    mumble-ruby (0.0.3)
-      activesupport
-      celt-ruby
-      ruby_protobuf
+    ffi (1.3.1)
+    hallon (0.18.1)
+      spotify (~> 12.3.0)
+      weak_observable (~> 1.0)
+    i18n (0.6.1)
+    libspotify (12.1.51.3)
+    multi_json (1.7.2)
     mustache (0.99.4)
-    rack (1.5.2)
-    rack-protection (1.5.0)
-      rack
-    rake (10.0.3)
-    ruby-mpd (0.2.1)
+    rake (10.0.4)
+    ref (1.0.4)
+    ruby-libsamplerate (0.0.1)
+      ffi
     ruby_protobuf (0.4.11)
-    rubypython (0.6.3)
-      blankslate (>= 2.1.2.3)
-      ffi (>= 1.0.7)
-    sinatra (1.4.1)
-      rack (~> 1.5, >= 1.5.2)
-      rack-protection (~> 1.4)
-      tilt (~> 1.3, >= 1.3.4)
+    spotify (12.3.0)
+      ffi (~> 1.0, >= 1.0.11)
+      libspotify (~> 12.1.51)
     text (1.2.1)
-    thin (1.5.0)
-      daemons (>= 1.0.9)
-      eventmachine (>= 0.12.6)
-      rack (>= 1.0.0)
-    tilt (1.3.5)
+    weak_observable (1.0.1)
+      ref (~> 1.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.3)
-  debugger
+  hallon-queue-output!
+  mumble-ruby!
   mumbletune!
   rake

data/README.md

@@ -1,23 +1,24 @@
 # Mumbletune
 
-MUMBLETUNE is an amiable bot that connects to a mumble server and allows users to interact with and play a queue of music. It currently plays music through Spotify.
+MUMBLETUNE is a nice bot that connects to a mumble server and allows users to listen to Spotify together.
 
 ## Installation
 
-First, install Hexxeh's [spotify-websocket-api](https://github.com/Hexxeh/spotify-websocket-api).
+What you need:
+- A Spotify Premium account. I wish it didn't have to be this way, but for API access, Premium's required
+- A Spotify App Key. Spotify will issue you one [here][1]. 
 
-    git clone git://github.com/Hexxeh/spotify-websocket-api.git
-    cd spotify-websocket-api
-    python setup.py build
-    python setup.py install
+Clone this repo and install its dependencies
 
-Then, install the gem:
-
-    $ gem install mumbletune
+    $ git clone git://github.com/elliottwilliams/mumbletune.git
+    cd mumbletune
+    bundle install
 
 ## Usage
 
 1. Create a configuration file. See `conf.example.yaml` for help.
 2. Start Mumbletune, passing your config with `-c`.
 
-		$ mumbletune -c config_file.yaml
+		$ mumbletune -c config_file.yaml
+
+[1]: https://developer.spotify.com/technologies/libspotify/keys/

data/bin/mumbletune-ctl

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require "daemons"
+require "optparse"
+
+dir = File.expand_path File.dirname(__FILE__)
+log = File.expand_path File.join(dir, "../logs")
+
+# change -c paramater to full path (survives daemon)
+ARGV.each_index do |i|
+	if ARGV[i] == "-c"
+		ARGV[i+1] = File.expand_path File.join(Dir.pwd, ARGV[i+1])
+	end
+end
+
+options = {
+	app_name:	"mumbletune",
+	dir_mode:	:normal,
+	dir:		log,
+	log_output:	true
+}
+
+Daemons.run(File.join(dir, "mumbletune"), options)

data/conf.example.yaml

@@ -1,4 +1,5 @@
 spotify:
+        appkey: "/path/to/spotify_appkey.key"
         username: "sp_username"
         password: "sp_password"
         region: "us"
@@ -8,8 +9,6 @@ mumble:
         username: "mumbletune"
         password: "server_password"
         channel: "Music Room"
-mpd:
-        host: "localhost"
-        port: 6600
-        fifo_out: "/tmp/mumble.fifo"
+player:
         default_volume: 60
+        tracks_for_artist: 5

data/docs/commands.md

@@ -16,9 +16,12 @@
 <br>
 For example:
 
-    play coldplay
-    play nicki minaj starships
+`play coldplay` plays the top 5 tracks by Coldplay.
 
-Mumbletune uses Spotify to find music.
+`play nicki minaj starships` will play the (excellent) song Starships.
+
+Mumbletune uses Spotify to find and play music. You can `play` a Spotify URL directly instead of searching, like
+
+`play spotify:album:1HjSyGjmLNjRAKgT9t1cna`
 
 <!-- Generate HTML with: $ pandoc -f markdown -->

data/lib/mumbletune.rb

@@ -1,81 +1,86 @@
+require 'bundler/setup'
+
+require 'mumbletune/version'
 require 'mumbletune/mumble_client'
-require 'mumbletune/mpd_client'
+require 'mumbletune/hallon_player'
 require 'mumbletune/messages'
-require 'mumbletune/track'
 require 'mumbletune/collection'
-require 'mumbletune/sp_uri_server'
-require 'mumbletune/spotify_track'
 require 'mumbletune/resolver'
-require 'mumbletune/handle_sp_error'
+require 'mumbletune/spotify_resolver'
 
 require 'optparse'
 require 'yaml'
-require 'eventmachine'
-require 'rubypython'
 
 module Mumbletune
 	class << self
-		attr_reader :player, :mumble, :uri_server, :config
+		attr_reader :player, :mumble, :uri_server, :config, :verbose
 	end
 
+	# defaults
+	@verbose 		= false
+	config_file 	= nil
+
 	# parse command line options
-	config_file = nil
-	OptionParser.new do |opts|
+	opts = OptionParser.new do |opts|
 		opts.banner = "Usage: mumbletune.rb [options]"
 		opts.on("-c", "--config FILE", "=MANDATORY", "Path to configuration file") do |file|
 			config_file = file
 		end
+		opts.on("-v", "--verbose", "Verbose output") do
+			@verbose = true
+		end
 		opts.on("-h", "--help", "This help message") do
-			puts opts.help()
+			puts opts.help
 			exit
 		end
-	end.parse!
-	raise OptionParser::MissingArgument unless config_file
-
-	# load configuration file
-	@config = YAML.load_file(config_file)
+	end
 
-	# load spotify-websocket-api
-	puts ">> Loading Spotify APIs..."
-	RubyPython.start(:python_exe => 'python2.7')
-	Spotify = RubyPython.import('spotify_web.friendly').Spotify
+	opts.parse!
 
-	# open URI server
-	uri_thread = Thread.new do
-		SPURIServer::Server.run!
+	unless config_file
+		puts opts.help
+		exit
 	end
 
+	# load configuration file
+	@config = YAML.load_file(config_file)
+
 	# initialize player
 	play_thread = Thread.new do
-		@player = Player.new
+		@player = HallonPlayer.new
+		@player.connect
+		puts ">> Connected to Spotify."
 	end
 
 	# connect to mumble & start streaming
+	sleep 0.1 until @player && @player.ready
 	mumble_thread = Thread.new do
 		@mumble = MumbleClient.new
 		@mumble.connect
+		puts ">> Connected to Mumble server at #{self.config['mumble']['host']}."
 		@mumble.stream
 	end
 
 	# shutdown code
 	def self.shutdown
+		Thread.new do
+			sleep 5 # timeout
+			puts "Timeout. Forcing exit."
+			exit!
+		end
+		print "\n>> Exiting... "
 		self.mumble.disconnect
+		print "Disconnected from Mumble... "
 		self.player.disconnect
-		puts "\nGoodbye forever. Exiting..."
+		print "Disconnected from Spotify... "
+		puts "\nGoodbye forever."
 	 	exit
 	end
 
 	# exit when Ctrl-C pressed
-	EventMachine.schedule do
-		trap("INT") { Mumbletune.shutdown }
+	Signal.trap("INT") do
+		Mumbletune.shutdown
 	end
 
-	# testing
-	# sleep 3
-	# @player.command_test_load
-	# @player.command_play
-
-	Thread.stop # wake up to shut down
-	self.shutdown
-
+	Thread.stop # we're done here
 end

data/lib/mumbletune/collection.rb

@@ -1,17 +1,37 @@
+require 'forwardable'
+
 module Mumbletune
 	class Collection
-		attr_accessor :type, :tracks, :description, :user
+		include Enumerable
+		extend Forwardable
+
+		attr_accessor :type,  :description, :user, :tracks, :history, :current_track
+
+		def_delegators :@tracks, :length, :first, :last, :each, :any?, :empty?
 
 		def initialize(type, tracks, description)
 			@type = type
 			@description = description
+			@tracks = [tracks].flatten
+			@history = Array.new
+		end
 
-			if tracks.class == Array
-				@tracks = tracks
-			else
-				@tracks = [tracks]
+		def next
+			if @current_track
+				@history << @current_track
+				@tracks.delete @current_track
 			end
+			@current_track = @tracks.first
 		end
 
+		def empty?
+			without_current = @tracks.dup
+			without_current.delete_if { |t| t == @current_track }
+			without_current.empty?
+		end
+
+		def any?
+			!empty?
+		end
 	end
 end

data/lib/mumbletune/hallon_player.rb

@@ -0,0 +1,162 @@
+require "hallon"
+require "hallon-queue-output"
+require "thread"
+
+module Mumbletune
+
+	class HallonPlayer
+
+		attr_accessor :ready, :play_history, :add_history, :queue, :current_track, :audio_queue
+
+		def initialize
+			conf = Mumbletune.config
+
+			@play_history = Array.new
+			@add_history  = Array.new
+			@queue        = Array.new
+			@prev_id      = 0
+			@ready        = false
+			@audio_queue  = Queue.new
+
+			@ready = true
+		end
+
+		def connect
+			conf = Mumbletune.config
+
+			@session = Hallon::Session.initialize(IO.read(conf["spotify"]["appkey"]))
+			@session.login!(conf["spotify"]["username"], conf["spotify"]["password"])
+
+			@player = Hallon::Player.new(Hallon::QueueOutput) do
+				# Set driver options
+				@driver.queue = Mumbletune.player.audio_queue
+				@driver.verbose = true if Mumbletune.verbose
+
+				# Define callbacks
+				on(:end_of_track) { Mumbletune.player.next }
+				on(:streaming_error) { |s, e| raise "Spotify connection error: #{e}" }
+				on(:play_token_lost) { Mumbletune.player.play_token_lost }
+			end
+
+			@ready = true
+
+			start_event_loop
+		end
+
+		def disconnect
+			@logging_out = true
+			@event_loop_thread.kill
+			@session.logout!
+		end
+
+		# Status methods
+		def playing?
+			@player.status == :playing
+		end
+
+		def paused?
+			@player.status == :paused
+		end
+
+		def stopped?
+			@player.status == :stopped
+		end
+
+		def any?
+			cols_with_more = @queue.map { |col| col.any? }
+			cols_with_more.delete_if { |m| m == false }
+			cols_with_more.any?
+		end
+
+		def empty?
+			!any?
+		end
+
+		# Queue Control
+		def add_collection(col, now=false)
+			only_track = empty?
+
+			# add to the queue
+			if now
+				@queue.unshift col
+			else
+				@queue.push col
+			end
+
+			# record in additions history
+			@add_history.push col
+
+			# play it, if this is the first track or if the user specified `now`
+			self.next if now || only_track
+		end
+
+		def undo
+			removed = @add_history.pop
+			@queue.delete_if { |col| col == removed }
+			self.next if removed.current_track
+			removed
+		end
+
+		def clear_queue
+			@queue.clear
+			self.stop
+		end
+
+		# Playback Commands
+		def play
+			if stopped?
+				self.next
+			elsif paused?
+				@player.play
+			end
+		end
+
+		def pause
+			if playing?
+				@player.pause
+			elsif paused?
+				@player.play
+			end
+		end
+
+		def next
+			# move the collection to play_history if it has played all its tracks
+			@play_history << @queue.shift if @queue.first && @queue.first.empty?
+
+			return stop unless any?
+
+			track = @queue.first.next
+
+			return stop unless track
+
+			# play that shit!
+			@current_track = track
+			@player.play track
+
+			puts "\u266B  #{track.name} - #{track.artist.name}" unless Mumbletune.verbose
+		end
+
+		def stop
+			@player.stop
+		end
+
+		# Callback Handling
+		def play_token_lost
+			Mumbletune.mumble.broadcast %w{Mumbletune was just paused because this
+				Spotify account is being used elsewhere. Type <code>unpause
+				</code> to regain control and keep playing.} * " "
+		end
+
+		private
+
+		def start_event_loop
+			@event_loop_thread = Thread.new do
+				loop do
+					@session.process_events unless @session.disconnected?
+					sleep 1
+				end
+			end
+		end
+		
+	end
+end