anyplayer 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -1,5 +1,7 @@
 source "http://rubygems.org"
 
+gem "rake"
+
 # Gem dependencies in anyplayer.gemspec
 gemspec
 

data/Gemfile.lock

@@ -0,0 +1,18 @@
+PATH
+  remote: .
+  specs:
+    anyplayer (0.0.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    minitest (4.1.0)
+    rake (0.9.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  anyplayer!
+  minitest
+  rake

data/Rakefile

@@ -1,2 +1,11 @@
 require 'bundler'
+require 'rake/testtask'
+
 Bundler::GemHelper.install_tasks
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+  t.verbose = true
+end

data/Readme.markdown

@@ -1,12 +1,71 @@
 Anyplayer
 =========
 
-Ruby library to interact with the running music player (iTunes, Rythmbox, MPD, XMMS).
+Interacts with the currently running music player. Supports iTunes OS X, iTunes Windows,
+Rythmbox, MPD & XMMS2.
 
-    require 'anyplayer'
-    player = Anyplayer::launched
-    player.name # => Rythmbox
-    player.track # => "Frontier Psychiatrist"
-    player.next
-    player.track # => "Ready For The Floor"
+Install
+-------
 
+```sh
+$ gem install anyplayer
+```
+
+Use it in your terminal
+-----------------------
+
+```sh
+$ anyplayer artist     # artist of the current track
+New Order
+$ anyplayer track      # name of the current track
+Blue Monday
+$ anyplayer album
+Power, Corruption & Lies
+$ anyplayer next       # changes track forward
+$ anyplayer prev       #               backward
+$ anyplayer playpause  # pauses if it is playing, plays if it's paused
+$ anyplayer play
+$ anyplayer pause
+$ anyplayer voldown    # put the volume somewhat up
+$ anyplayer volup      #                         down
+$ anyplayer volume     # prints the volume percentage
+100
+$ anyplayer vote       # votes to go to next song (default number of votes is 5)
+$ anyplayer name
+iTunes
+$ anyplayer launched && echo "a player is running" || echo "nothing running"
+a player is running
+```
+
+Or in Ruby
+----------
+
+```ruby
+require 'anyplayer'
+player = Anyplayer::launched
+
+player.launched? # => true
+player.name # => Rythmbox
+player.artist # => "The Avalanches"
+player.track # => "Frontier Psychiatrist"
+# …
+```
+
+Or in a browser
+----------------
+
+With the [So Nice](https://github.com/sunny/so-nice/) Web interface:
+
+![So Nice Screenshot](https://github.com/sunny/so-nice/raw/gh-pages/screenshot.png)
+
+Development
+-----------
+
+Launch from source:
+
+    ruby -Ilib bin/anyplayer
+
+Install from source:
+
+    gem build anyplayer.gemspec
+    gem install anyplayer-*.gem

data/anyplayer.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.name        = "anyplayer"
   s.version     = Anyplayer::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Sunny Ripert"]
-  s.email       = ["sunny@sunfox.org"]
+  s.authors     = ["Sunny Ripert", "Gordon Diggs"]
+  s.email       = ["sunny@sunfox.org", "gordon@gordondiggs.com"]
   s.homepage    = "http://github.com/sunny/anyplayer"
   s.summary     = %q{Interact with the running music player}
   s.description = %q{Play/pause/skip songs in iTunes, Rythmbox, MPD, XMMS}
@@ -16,4 +16,6 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+
+  s.add_development_dependency 'minitest'
 end

data/bin/anyplayer

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+require 'anyplayer'
+
+player = Anyplayer::launched
+
+if !player
+  puts "Error: no player connected."
+  exit 1
+end
+
+case ARGV.first
+  when "playpause" then player.playpause
+  when "play"      then player.play
+  when "pause"     then palyer.pause
+  when "next"      then player.next
+  when "prev"      then player.next
+  when "voldown"   then player.voldown
+  when "volup"     then player.volup
+  when "volume"    then puts player.volume
+  when "track"     then puts player.track
+  when "artist"    then puts player.artist
+  when "album"     then puts player.album
+  when "vote"      then player.vote
+  when "name"      then puts player.name
+  when "launched"  then exit(player.launched? ? 0 : 1)
+  when "playing"   then exit(player.playing? ? 0 : 1)
+  when "paused"    then exit(player.playing? ? 0 : 1)
+  else
+    puts <<USAGE
+Usage: #{$0} [command]
+
+Where command is one of: playpause, play, pause, next, prev, voldown, volup,
+volume, track, artist, album, vote, name, launched.
+
+Player connected: #{player.name}.
+USAGE
+    exit(1)
+end

data/lib/anyplayer.rb

@@ -2,7 +2,7 @@ require "timeout"
 require "anyplayer/player"
 
 module Anyplayer
-  PLAYERS = :itunes, :rhythmbox, :ituneswindows, :mpd, :xmms2, :amarok
+  PLAYERS = [:itunes, :rhythmbox, :ituneswindows, :mpd, :xmms2, :amarok]
   for player in PLAYERS
     require "anyplayer/players/#{player}"
   end

data/lib/anyplayer/player.rb

@@ -1,22 +1,68 @@
+# Default Player class that is inherrited by all players.
+#
+# All players should override these methods:
+#   launched? (return bool)
+#   next
+#   prev
+#   play
+#   pause
+#   playpause
+#   track     (return string)
+#   artist    (return string)
+#   album     (return string)
+#   voldown
+#   volup
+#   volume    (return int)
+#   playing?  (return bool)
+#   paused?   (return bool)
 module Anyplayer
   class Player
+    DEFAULT_VOTES_TO_SKIP = 5
 
-    # Guess the player name
+    def initialize
+      @votes = 0
+    end
+
+    def launched?
+      false
+    end
+
+    # Player name is the classe's, feel free to override it
     def name
       self.class.to_s.gsub(/^.*::/, '')
     end
 
-    # Methods to override
-    def launched?; false; end
-    def playpause; end
-    def next; end
-    def prev; end
-    def voldown; end
-    def volup; end
-    def volume; end
-    def track; end
-    def artist; end
-    def album; end
+    def playpause
+      paused? ? play : pause
+    end
+
+    # Vote to skip song
+    def vote(votes_to_skip = DEFAULT_VOTES_TO_SKIP)
+      @votes += 1
+      if @votes >= votes_to_skip
+        self.next
+        reset_votes
+      end
+    end
+
+    def votes
+      @votes
+    end
+
+    # Root next and prev reset the votes, so be sure to call super
+    # in children
+    def next
+      reset_votes
+    end
+
+    def prev
+      reset_votes
+    end
+
+    private
+      def reset_votes
+        @votes = 0
+      end
 
   end
 end

data/lib/anyplayer/players/amarok.rb

@@ -4,12 +4,22 @@ module Anyplayer
       tell_to 'PlayPause'
     end
 
+    def play
+      tell_to 'Play'
+    end
+
+    def pause
+      tell_to 'Pause'
+    end
+
     def prev
       tell_to 'Prev'
+      super
     end
 
     def next
       tell_to 'Next'
+      super
     end
 
     def voldown
@@ -27,17 +37,17 @@ module Anyplayer
     def track
       get_metadata('title')
     end
-    
+
     def artist
       get_metadata('artist')
     end
-    
+
     def album
       get_metadata('album')
     end
 
     def launched?
-      not %x(qdbus org.kde.amarok 2>&1).match(/does not exist/)
+      not %x(qdbus org.kde.amarok 2>&1).match(/does not exist|command not found/)
     end
 
     private

data/lib/anyplayer/players/itunes.rb

@@ -1,55 +1,66 @@
+if RUBY_PLATFORM =~ /darwin/
+  require 'appscript'
+  include Appscript
+end
+
 module Anyplayer
   class Itunes < Player
     def playpause
-      tell_to 'playpause'
+      @app.playpause
+    end
+
+    def play
+      @app.play
+    end
+
+    def pause
+      @app.pause
     end
 
     def prev
-      tell_to 'previous track'
+      @app.previous_track
+      super
     end
 
     def next
-      tell_to 'next track'
+      @app.next_track
+      super
     end
 
     def voldown
-      tell_to 'set sound volume to sound volume - 10'
+      @app.sound_volume.set(volume + 10)
     end
 
     def volup
-      tell_to 'set sound volume to sound volume + 10'
+      @app.sound_volume.set(volume + 10)
     end
 
     def volume
-      tell_to 'return sound volume'
+      @app.sound_volume.get
     end
 
     def track
-      tell_to 'return name of current track'
+      @app.current_track.name.get
     end
 
     def artist
-      tell_to 'return artist of current track'
+      @app.current_track.artist.get
     end
 
     def album
-      tell_to 'return album of current track'
+      @app.current_track.album.get
     end
 
     def launched?
-      return false if RUBY_PLATFORM !~ /darwin/
-      nb = %x(osascript -e 'tell app "System Events" to count (every process whose name is "iTunes")' 2>/dev/null).rstrip
-      nb.match(/^\d+/) and nb.to_i > 0 ? true : false
+      return false unless RUBY_PLATFORM =~ /darwin/
+      return false unless app('System Events').processes.name.get.include? "iTunes"
+      @app = app('iTunes')
+      true
     end
 
     def name
       "iTunes"
     end
-
-    private
-    def tell_to(command)
-      %x(osascript -e 'tell app "iTunes" to #{command}').rstrip
-    end
   end
 end
 

data/lib/anyplayer/players/ituneswindows.rb

@@ -4,12 +4,22 @@ module Anyplayer
       @itunes.PlayPause()
     end
 
+    def play
+      @itunes.Play()
+    end
+
+    def pause
+      @itunes.Pause()
+    end
+
     def prev
       @itunes.PreviousTrack()
+      super
     end
 
     def next
       @itunes.NextTrack()
+      super
     end
 
     def voldown

data/lib/anyplayer/players/mpd.rb

@@ -4,12 +4,22 @@ module Anyplayer
       mpc 'toggle'
     end
 
+    def play
+      mpc 'play'
+    end
+
+    def pause
+      mpc 'pause'
+    end
+
     def prev
       mpc 'prev'
+      super
     end
 
     def next
       mpc 'next'
+      super
     end
 
     def voldown

data/lib/anyplayer/players/rhythmbox.rb

@@ -4,12 +4,22 @@ module Anyplayer
       tell_to 'play-pause'
     end
 
+    def play
+      tell_to 'play'
+    end
+
+    def pause
+      tell_to 'pause'
+    end
+
     def prev
       tell_to 'previous'
+      super
     end
 
     def next
       tell_to 'next'
+      super
     end
 
     def voldown
@@ -31,7 +41,7 @@ module Anyplayer
     def artist
       tell_to 'print-playing-format=%ta'
     end
-    
+
     def album
       tell_to 'print-playing-format=%at'
     end

data/lib/anyplayer/players/xmms2.rb

@@ -4,12 +4,22 @@ module Anyplayer
       xmms2 'toggle'
     end
 
+    def play
+      xmms2 'play'
+    end
+
+    def pause
+      xmms2 'pause'
+    end
+
     def prev
       xmms2 'prev'
+      super
     end
 
     def next
       xmms2 'next'
+      super
     end
 
     def voldown
@@ -25,8 +35,8 @@ module Anyplayer
     end
 
     def volume
-      #currently just the first (left?) channel
-      xmms2('server volume').split("\n").first.sub /([^0-9]*)/, ''
+      # currently just the first (left?) channel
+      xmms2('server volume').split("\n").first.sub(/([^0-9]*)/, '')
       $1
     end
 
@@ -42,6 +52,14 @@ module Anyplayer
       xmms2 "status -f '${album}'"
     end
 
+    def playing?
+      xmms2("status -f '${playback_status}'") == "Playing"
+    end
+
+    def paused?
+      xmms2("status -f '${playback_status}'") == "Paused"
+    end
+
     def launched?
       # xmms2 autolaunches the daemon, so this should always be true
       %x(xmms2 status 2> /dev/null)
@@ -54,8 +72,8 @@ module Anyplayer
 
     private
     def xmms2(command)
-      %x(xmms2 #{command}).split("\n").first
+      %x(xmms2 #{command}).split("\n").first.strip
     end
   end
 
-end 
+end

data/lib/anyplayer/version.rb

@@ -1,3 +1,3 @@
 module Anyplayer
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/anyplayer_test.rb

@@ -1,13 +1,75 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
+require "minitest/unit"
+require "minitest/autorun"
+require "anyplayer"
 
-require 'test/unit'
-require 'anyplayer'
+class AnyplayerTest < MiniTest::Unit::TestCase
+  def setup
+    @player = Anyplayer::launched
+    refute_nil @player, "Make sure you have launched a player for tests to run"
+  end
 
-class AnyplayerTest < Test::Unit::TestCase
   def test_music_player_running
-    player = Anyplayer::launched
-    assert_not_nil player
-    assert player.is_a?(Anyplayer::Player)
+    assert_kind_of Anyplayer::Player, @player
+  end
+
+
+  def test_voting
+    assert_equal @player.votes, 0
+
+    first_track = @player.track
+
+    Anyplayer::Player::DEFAULT_VOTES_TO_SKIP.times do |i|
+     @player.vote
+
+     # votes should be 0 if we've voted enough times
+     if i == Anyplayer::Player::DEFAULT_VOTES_TO_SKIP-1
+       assert_equal @player.votes, 0
+     else
+       assert_equal @player.votes, i+1
+     end
+    end
+
+    # make sure we actually changed tracks
+    refute_equal @player.track, first_track
+
+    # rewind test
+    @player.prev
+    @player.play
+  end
+
+  def test_vote_resets
+    assert_equal @player.votes, 0
+
+    @player.next
+    assert_equal @player.votes, 0
+
+    @player.prev
+    assert_equal @player.votes, 0
+  end
+
+  def test_custom_voting_quota
+    assert_equal @player.votes, 0
+
+    num_votes = 10
+
+    first_track = @player.track
+
+    num_votes.times do |i|
+      @player.vote(num_votes)
+
+      # votes should be 0 if we've voted enough times
+      if i == num_votes-1
+        assert_equal @player.votes, 0
+      else
+        assert_equal @player.votes, i+1
+      end
+    end
+
+    # make sure we actually changed tracks
+    refute_equal @player.track, first_track
+
+    # rewind test
+    @player.prev
+    @player.play
   end
 end

metadata

@@ -1,39 +1,50 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: anyplayer
-version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Sunny Ripert
+- Gordon Diggs
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-01-18 00:00:00 +01:00
-default_executable: 
-dependencies: []
-
+date: 2013-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Play/pause/skip songs in iTunes, Rythmbox, MPD, XMMS
-email: 
+email:
 - sunny@sunfox.org
-executables: []
-
+- gordon@gordondiggs.com
+executables:
+- anyplayer
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .travis.yml
 - Gemfile
+- Gemfile.lock
 - Rakefile
 - Readme.markdown
 - anyplayer.gemspec
+- bin/anyplayer
 - lib/anyplayer.rb
 - lib/anyplayer/player.rb
 - lib/anyplayer/players/amarok.rb
@@ -44,39 +55,29 @@ files:
 - lib/anyplayer/players/xmms2.rb
 - lib/anyplayer/version.rb
 - test/anyplayer_test.rb
-has_rdoc: true
 homepage: http://github.com/sunny/anyplayer
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Interact with the running music player
-test_files: []
-
+test_files:
+- test/anyplayer_test.rb