vlc-client 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e93182279e83b89bc91c7fd08478ad97dda296da
+  data.tar.gz: 5ad6b5688d2babebc662003918331874878405e8
+SHA512:
+  metadata.gz: 06f1446c87b4cf6939bbc84a470881246803091f4af8f658c3f73a865828759caee8a988d43e1e3e159d603f052b08074dc63f1e3abe54eb6a88348a719c5bcf
+  data.tar.gz: 8f80b8fb1b534516441df59b3f10c3a502eafa0bc7c40377a1db6e721bdda04ffb2f49aa18067dae0605a6e9d0db30f2b967f656730181a054948265df7eddee

data/.gitignore

@@ -19,3 +19,4 @@ tmp
 .sublime/
 Guardfile
 trials
+.ruby-*

data/.travis.yml

@@ -1,10 +1,13 @@
 language: ruby
 script: bundle exec rake --verbose --trace
+bundler_args: --without development
 matrix:
   allow_failures:
       - rvm: ruby-head
 rvm:
+  - jruby-19mode
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0
   - ruby-head

data/Gemfile

@@ -1,4 +1,20 @@
 source 'https://rubygems.org'
 
+gem 'rake'
+
+group :development do
+  gem 'guard-rspec', '~> 2.5.1'
+  gem 'redcarpet'
+  gem 'yard'
+  gem 'pry'
+end
+
+group :test do
+  gem 'mime-types', '< 2.0.0'
+  gem 'rspec', '~> 2.14.1', :require => false
+  gem 'simplecov', :require => false
+  gem 'coveralls', :require => false
+end
+
 # Specify your gem's dependencies in vlc.gemspec
 gemspec

data/README.md

@@ -1,6 +1,6 @@
 # vlc-client [![Build Status](https://secure.travis-ci.org/mguinada/vlc-client.png?branch=master)](http://travis-ci.org/mguinada/vlc-client)
 
-vlc-client manages a [VLC media player](http://www.videolan.org/vlc/) through it's RC interface.
+vlc-client manages a [VLC media player](http://www.videolan.org/vlc/) instance through it's RC interface.
 
 ## Installation
 
@@ -23,17 +23,20 @@ Or install it yourself as:
 ```ruby
 
 #Expects a VLC media player running on 192.168.1.10:9999
-#e.g. vlc --extraintf rc --rc-host 192.168.1.10:9999"
+#e.g. vlc --extraintf rc --rc-host 192.168.1.10:9999
 
 vlc = VLC::Client.new('192.168.1.10', 9999)
 # => "#<VLC::Client:0x0000000229c370 @server=#<VLC::Server:0x0000000229c6e0 @headless=false, @port=9999, @host=\"192.168.1.10\", @pid=10514>, @self_managed=true, @connection=#<VLC::Connection:0x0000000229c258 @port=9999, @host=\"192.168.1.10\", @socket=#<TCPSocket:fd 5>>>"
 
 vlc.connect
 # => true
+
 vlc.play('http://example.org/media.mp3') #play media
 # => true
+
 vlc.playing?
 # => true
+
 vlc.fullscreen
 # => true
 #...
@@ -41,13 +44,12 @@ vlc.fullscreen
 ```
 
 ### Create a self managed client/server system.
-_Most of the time we want a local client/server VLC media player system_
+Most of the time we want a local client/server VLC media player system
 
-_(NOTE: requires a local installation of VLC media player)_
 
 ```ruby
 
-vlc = VLC::System.new #A local VLC client/server system where a local VLC server is automaticaly managed
+vlc = VLC::System.new #A local VLC client/server system where a local VLC installation is automaticaly managed
 # => "#<VLC::System:0x00000001bbb1a0 @client=#<VLC::Client:0x00000001bbade0 @server=#<VLC::Server:0x00000001bbb178 @headless=false, @port=9595, @host=\"localhost\", @pid=11225>, @connection=#<VLC::Connection:0x00000001bbacc8 @port=9595, @host=\"localhost\", @socket=#<TCPSocket:fd 5>>>>"
 
 vlc.connected? #auto_connect
@@ -66,7 +68,6 @@ vlc = VLC::Client.new(VLC::Server.new('localhost', 9595, false))
 ```
 
 ###Get local VLC server lifecycle management control
-_(NOTE: requires a local installation of VLC media player)_
 
 ```ruby
 
@@ -75,8 +76,10 @@ vlc = VLC::System.new('127.0.0.1', 9999, auto_start: false)
 
 vlc.server.running?
 # => false
+
 vlc.server.start
 # => 12672
+
 vlc.connect
 # => true
 ```
@@ -85,10 +88,17 @@ vlc.connect
 
 [reference](http://rdoc.info/github/mguinada/vlc-client)
 
-## Support
+## Notice
+
+vlc-client has been tested on linux but it should work on any VLC installation as long and the command line is responsive for `vlc` and `cvlc` calls. On Mac OSX these are not available by default. They can be created with:
+
+```
+ln -s /Applications/VLC.app/Contents/MacOS/VLC /usr/local/bin/vlc
+ln -s /Applications/VLC.app/Contents/MacOS/VLC /usr/local/bin/cvlc
+```
 
-vlc-client has been tested on linux only.
-If you need support for other OS a pull request is welcome.
+VLC media player 2.0.3 seems to [ship with a bug](http://www.linuxquestions.org/questions/slackware-14/problem-vlc-2-0-3-playing-youtube-videos-4175429135) that invalidates YouTube streaming.
+[Please use VLC 2.0.4 or later](http://www.videolan.org/). The last tested version is VLC media player 2.1.2 Rincewind
 
 ## Contributing
 
@@ -108,3 +118,4 @@ Copyright (c) 2012 Miguel Guinada
 [LICENSE][] for details.
 
 [license]: https://github.com/mguinada/vlc-client/blob/master/LICENSE
+[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/8b1a3dc0229bef37fd7746bb62d29997 "githalytics.com")](http://githalytics.com/mguinada/vlc-client)

data/Rakefile

@@ -1,7 +1,6 @@
 #!/usr/bin/env rake
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-require 'yard'
 
 task :test    => :spec
 task :default => :spec
@@ -21,10 +20,16 @@ task :console do
 end
 
 namespace :doc do
-  desc "Generate documentation"
-  YARD::Rake::YardocTask.new do |t|
-    t.files   = ['lib/**/*.rb']
-    t.options = ['--no-private', '--protected', '--markup', 'markdown']
+  begin
+    require 'yard'
+
+    desc "Generate documentation"
+    YARD::Rake::YardocTask.new do |t|
+      t.files   = ['lib/**/*.rb']
+      t.options = ['--no-private', '--protected', '--markup', 'markdown']
+    end
+  rescue LoadError
+    puts "yard not available"
   end
 end
 

data/lib/vlc-client.rb

@@ -10,6 +10,7 @@ require 'vlc-client/connection'
 require 'vlc-client/errors'
 
 require 'vlc-client/client/media_controls'
+require 'vlc-client/client/playlist_controls'
 require 'vlc-client/client/video_controls'
 require 'vlc-client/client/connection_management'
 
@@ -19,6 +20,7 @@ module VLC
   # The VLC client
   class Client
     include VLC::Client::MediaControls
+    include VLC::Client::PlaylistControls
     include VLC::Client::VideoControls
     include VLC::Client::ConnectionManagement
 
@@ -67,9 +69,9 @@ module VLC
       bind_server(server, options) unless server.nil?
     end
 
-  private
     attr_reader :connection
 
+   private
     def bind_server(server, options = {})
       @connection.host = server.host
       @connection.port = server.port
@@ -97,5 +99,16 @@ module VLC
       end
       args
     end
+
+    def media_arg(media)
+      case media
+      when File
+        media.path
+      when String, URI
+        media
+      else
+        raise ArgumentError, "Can not play: #{media}"
+      end
+    end
   end
-end
+end

data/lib/vlc-client/client/media_controls.rb

@@ -99,18 +99,6 @@ module VLC
       def volume=(level)
         volume(level)
       end
-
-    private
-      def media_arg(media)
-        case media
-        when File
-          media.path
-        when String, URI
-          media
-        else
-          raise ArgumentError, "Can play: #{media}"
-        end
-      end
     end
   end
-end
+end

data/lib/vlc-client/client/playlist_controls.rb

@@ -0,0 +1,55 @@
+module VLC
+  class Client
+    module PlaylistControls
+      # @private
+      PLAYLIST_TERMINATOR = "+----[ End of playlist ]"
+
+      # Adds media to the playlist
+      #
+      # @param media [String, File, URI] the media to be played
+      #
+      def add_to_playlist(media)
+        connection.write("enqueue #{media_arg(media)}")
+      end
+
+      # Lists tracks on the playlist
+      def playlist
+        connection.write("playlist")
+
+        list = []
+        begin
+          list << connection.read
+        end while list.last != PLAYLIST_TERMINATOR
+        process_raw_playlist(list)
+      end
+
+      # Plays the next element on the playlist
+      def next
+        connection.write("next")
+      end
+
+      # Plays the previous element on the playlist
+      def previous
+        connection.write("prev")
+      end
+
+      # Clears the playlist
+      def clear
+        connection.write("clear")
+      end
+    private
+      def process_raw_playlist(list)
+        list.map do |i|
+          match = i.match(/^\|[\s]*(\d{1,2})\s-\s(.+)\((\d\d:\d\d:\d\d)\)(\s\[played\s(\d+)\stime[s]?\])?/)
+
+          next if match.nil?
+
+          {:number => match[1].to_i,
+           :title => match[2].strip,
+           :length => match[3],
+           :times_played => match[5].to_i}
+        end.compact
+      end
+    end
+  end
+end

data/lib/vlc-client/version.rb

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

data/spec/helper.rb

@@ -1,7 +1,12 @@
 require 'simplecov'
-require 'pry'
+require 'coveralls'
+
+# SimpleCov & Coveralls setup
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
 
-#setup simplecov
 SimpleCov.start do
   add_filter "/spec"
 end
@@ -13,8 +18,8 @@ module Mocks
     tcp = double()
     TCPSocket.stub(:new).and_return do
       if opts.fetch(:defaults, true)
+        tcp.stub(:flush)
         tcp.should_receive(:gets).with(no_args).at_least(:twice).and_return("")
-        tcp.should_receive(:flush).with(no_args).any_number_of_times
         tcp.should_receive(:close).with(no_args) if opts.fetch(:close, true)
       end
 
@@ -37,8 +42,8 @@ module Mocks
       end
       Process.should_receive(:pid).once.and_return(99)
 
-      rd = stub('rd', :close => true)
-      wd = stub('wd', :write => true, :close => true)
+      rd = double('rd', :close => true)
+      wd = double('wd', :write => true, :close => true)
       IO.stub(:pipe).and_return([rd, wd])
 
       [STDIN, STDOUT, STDERR].each { |std| std.stub(:reopen) }
@@ -47,8 +52,8 @@ module Mocks
     else
       Process.stub(:fork).and_return(true)
 
-      rd = stub('rd', :read => 99, :close => true)
-      wd = stub('wd', :close => true)
+      rd = double('rd', :read => 99, :close => true)
+      wd = double('wd', :close => true)
       IO.stub(:pipe).and_return([rd, wd])
 
       Process.should_receive(:kill).once.with('INT', 99) if opts.fetch(:kill, true)
@@ -59,6 +64,14 @@ module Mocks
     mock_system_calls
     mock_tcp_server
   end
+
+  def mock_file(filename)
+    File.stub(:open).and_return {
+      f = File.new('./LICENSE', 'r')
+      f.should_receive(:path).once.and_return(filename)
+      f
+    }
+  end
 end
 
 RSpec.configure do |cfg|

data/spec/vlc-client/client/media_controls_spec.rb

@@ -11,11 +11,7 @@ describe VLC::Client::MediaControls do
     end
 
     it 'from a file descriptor' do
-      File.stub(:open).and_return {
-        f = File.new('./LICENSE', 'r')
-        f.should_receive(:path).once.and_return('./media.mp3')
-        f
-      }
+      mock_file('./media.mp3')
 
       mock_tcp_server.should_receive(:puts).once.with('add ./media.mp3')
       vlc.connect
@@ -42,7 +38,7 @@ describe VLC::Client::MediaControls do
     def tcp_mock
       tcp = mock_tcp_server(:defaults => false)
 
-      tcp.should_receive(:flush).with(no_args).any_number_of_times
+      tcp.should_receive(:flush).with(no_args).at_least(1).times
       tcp.should_receive(:gets).with(no_args).twice.and_return("")
 
       tcp.should_receive(:puts).once.with('add http://example.org/media.mp3')
@@ -190,7 +186,7 @@ describe VLC::Client::MediaControls do
 
   it 'is aware of current status' do
     tcp = mock_tcp_server(:defaults => false)
-    tcp.should_receive(:flush).with(no_args).any_number_of_times
+    tcp.should_receive(:flush).with(no_args).at_least(1).times
 
     tcp.should_receive(:gets).with(no_args).twice.and_return("")
 

data/spec/vlc-client/client/playlist_controls_spec.rb

@@ -0,0 +1,52 @@
+describe VLC::Client::PlaylistControls do
+  let(:vlc) { VLC::Client.new(:self_managed => false) }
+  let!(:server) { mock_tcp_server }
+  after(:each) { vlc.disconnect }
+
+  it 'enqueues media' do
+    server.should_receive(:puts).once.with('enqueue media.mp3')
+    server.should_receive(:puts).once.with('enqueue media2.mp3')
+    vlc.connect
+
+    vlc.add_to_playlist("media.mp3")
+    vlc.add_to_playlist("media2.mp3")
+  end
+
+  context 'manages the playlist' do
+    it 'lists playlist contents' do
+      vlc.connect
+
+      vlc.connection.should_receive(:write).once.with("playlist")
+      vlc.connection.should_receive(:read).once.with(no_args).and_return("+----[ Playlist - Test ]")
+      vlc.connection.should_receive(:read).once.with(no_args).and_return("| 2 - Playlist")
+      vlc.connection.should_receive(:read).once.with(no_args).and_return("|   1 - Track 1 (00:01:30) [played 2 times]")
+      vlc.connection.should_receive(:read).once.with(no_args).and_return("|   2 - Track 2 (00:00:23)")
+      vlc.connection.should_receive(:read).once.with(no_args).and_return("| 3 - Media Library")
+      vlc.connection.should_receive(:read).once.with(no_args).and_return("+----[ End of playlist ]")
+
+      vlc.playlist.should eq([{:number => 1, :title => "Track 1", :length => "00:01:30", :times_played => 2},
+                              {:number => 2, :title => "Track 2", :length => "00:00:23", :times_played => 0}])
+    end
+
+    it 'plays the next element on the playlist' do
+      vlc.connect
+
+      vlc.connection.should_receive(:write).once.with("next")
+      vlc.next
+    end
+
+    it 'plays the previous element on the playlist' do
+      vlc.connect
+
+      vlc.connection.should_receive(:write).once.with("prev")
+      vlc.previous
+    end
+
+    it 'clear the playlist' do
+      vlc.connect
+
+      vlc.connection.should_receive(:write).once.with("clear")
+      vlc.clear
+    end
+  end
+end

data/vlc-client.gemspec

@@ -16,14 +16,5 @@ Gem::Specification.new do |gem|
   gem.version       = VLC::VERSION
   gem.date          = Time.now.utc.strftime("%Y-%m-%d")
 
-  #package
-  gem.add_dependency             'retryable', '~> 1.3'
-
-  #development
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'simplecov'
-  gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'yard'
-  gem.add_development_dependency 'maruku'
+  gem.add_dependency 'retryable', '~> 1.3'
 end

metadata

@@ -1,93 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: vlc-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Miguel Guinada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-01 00:00:00.000000000 Z
+date: 2013-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: retryable
-  requirement: &22175840 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *22175840
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &22174780 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *22174780
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &22174160 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *22174160
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: &22173600 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *22173600
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: &22172800 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *22172800
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: &22172160 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *22172160
-- !ruby/object:Gem::Dependency
-  name: maruku
-  requirement: &22171740 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *22171740
+        version: '1.3'
 description: vlc-client allows to control VLC media player over TCP
 email:
 - mguinada@gmail.com
@@ -106,6 +42,7 @@ files:
 - lib/vlc-client.rb
 - lib/vlc-client/client/connection_management.rb
 - lib/vlc-client/client/media_controls.rb
+- lib/vlc-client/client/playlist_controls.rb
 - lib/vlc-client/client/video_controls.rb
 - lib/vlc-client/connection.rb
 - lib/vlc-client/core_ext/array.rb
@@ -118,6 +55,7 @@ files:
 - spec/system_spec.rb
 - spec/vlc-client/client/connection_management_spec.rb
 - spec/vlc-client/client/media_controls_spec.rb
+- spec/vlc-client/client/playlist_controls_spec.rb
 - spec/vlc-client/client/video_controls_spec.rb
 - spec/vlc-client/connection_spec.rb
 - spec/vlc-client/server_spec.rb
@@ -125,33 +63,33 @@ files:
 - vlc-client.gemspec
 homepage: https://github.com/mguinada/vlc-client
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: vlc-client is a TCP client for VLC media player
 test_files:
 - spec/helper.rb
 - spec/system_spec.rb
 - spec/vlc-client/client/connection_management_spec.rb
 - spec/vlc-client/client/media_controls_spec.rb
+- spec/vlc-client/client/playlist_controls_spec.rb
 - spec/vlc-client/client/video_controls_spec.rb
 - spec/vlc-client/connection_spec.rb
 - spec/vlc-client/server_spec.rb