vlc-client 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae9ecda809fe61433d61d38c263715eebc2d99f3
-  data.tar.gz: 46c6ef80d8507cb05d6a32f0f274e7eaf629cfbb
+  metadata.gz: e9195752c1e3f892ffc1d20509a533f195088591
+  data.tar.gz: 7b921a75027b04fcc866460727cc887ce68f8b4f
 SHA512:
-  metadata.gz: e6f404e88f192deca0dd42e1acef2d4808bb70675b5a2a370cb293e9056e905fe1346f8ca56fc42b0780bb279ae47b5a9eb5df73fbe73cafd838ad95b0169cf2
-  data.tar.gz: 41e9cda0d0b842f7a7e4e25917a7ae5cbc3c4bfd7623465a99e5dda5a7675342eb9e6640ac01abfdacc394e20849cc3cd67af996ef1b0d99d9d0b5f61d38143c
+  metadata.gz: 550e57fc4986d746c42ee7e45bc34ed022633a50c4007ed66d4438c68271fa93934294fa0b69961276b17b558aa50b803c1730d8d6f97ad0cb1c5572b1d50957
+  data.tar.gz: d680adf103db6d10dbcfbc6d99f7ca5ed6d30ce444935db395fd60eba9cee49709b1a954d46011c0a5ce8be660f1b6383e382d49d2cb46f57a4789b36357995b

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 Guardfile
 trials
 .ruby-*
+.\#*

data/.travis.yml

@@ -1,8 +1,3 @@
-before_install:
-  #This is a temporary workaround a rubygems bug! Remove later
-  #see: https://github.com/bundler/bundler/issues/2784 & https://github.com/rubygems/rubygems/pull/763
-  - gem update --system 2.1.11
-  - gem --version
 language: ruby
 script: bundle exec rake --verbose --trace
 bundler_args: --without development
@@ -15,4 +10,5 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
-  - ruby-head
+  - 2.1.0
+  - ruby-head

data/Gemfile

@@ -16,5 +16,4 @@ group :test do
   gem 'coveralls', :require => false
 end
 
-# Specify your gem's dependencies in vlc.gemspec
 gemspec

data/lib/vlc-client.rb

@@ -46,6 +46,7 @@ module VLC
     #   @option options [Boolean] :auto_start When false, the server lifecycle is not managed automatically and controll is passed to the developer
     #   @option options [Integer] :conn_retries Number of connection retries (each separated by a second) to make on auto-connect. Defaults to 5.
     #   @option options [Boolean] :daemonize When true and only when on server auto-start mode, the server will be detached and run as a daemon process. Defaults to false.
+    #   @option options [Integer] :read_timeout Read timout value
     #
     #   @example
     #     vlc = VLC::Client.new(VLC::Server.new)
@@ -63,14 +64,15 @@ module VLC
     #
     def initialize(*args)
       args = NullObject.Null?(args)
-      options = args.extract_options!
 
+      options = args.extract_options!
       process_args(args)
-      @connection = Connection.new(host, port)
+
+      @connection = Connection.new(host, port, options[:read_timeout])
       bind_server(server, options) unless server.nil?
     end
 
-   private
+  private
     def bind_server(server, options = {})
       @connection.host = server.host
       @connection.port = server.port

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

@@ -16,7 +16,9 @@ module VLC
         connection.connected?
       end
 
-      def disconnected?; not connected?; end
+      def disconnected?
+        not(connected?)
+      end
     end
   end
 end

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

@@ -90,7 +90,8 @@ module VLC
       #   @param [Integer] level the volume level to set
       #
       def volume(level = nil)
-        level.nil? ? Integer(connection.write("volume", false)) : connection.write("volume #{Integer(level)}")
+        return Integer(connection.write("volume", false)) if level.nil?
+        connection.write("volume #{Integer(level)}")
       rescue ArgumentError
         level.nil? ? 0 : nil
       end

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

@@ -4,6 +4,14 @@ module VLC
       # @private
       PLAYLIST_TERMINATOR = "+----[ End of playlist ]"
 
+      # @private
+      LIST_ITEM_REGEXP = %r{
+        ^\|[\s]*(\d{1,2})\s-\s(.+)
+        \((\d\d:\d\d:\d\d)\)
+        (\s\[played\s(\d+)
+        \stime[s]?\])?
+      }x
+
       # Adds media to the playlist
       #
       # @param media [String, File, URI] the media to be played
@@ -20,7 +28,8 @@ module VLC
         begin
           list << connection.read
         end while list.last != PLAYLIST_TERMINATOR
-        process_raw_playlist(list)
+
+        parse_playlist(list)
       end
 
       # Plays the next element on the playlist
@@ -37,19 +46,20 @@ module VLC
       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]?\])?/)
+      def parse_playlist(list)
+        list.map do |item|
+          match = item.match(LIST_ITEM_REGEXP)
 
           next if match.nil?
 
-          {:number => match[1].to_i,
-           :title => match[2].strip,
-           :length => match[3],
+          {:number       => match[1].to_i,
+           :title        => match[2].strip,
+           :length       => match[3],
            :times_played => match[5].to_i}
         end.compact
       end
     end
   end
-end
+end

data/lib/vlc-client/connection.rb

@@ -1,21 +1,26 @@
 require 'socket'
+require 'timeout'
 
 module VLC
   #
   # Manages the connection to a VLC server
   #
   class Connection
-    attr_accessor :host, :port
+    DEFAULT_READ_TIMEOUT = 2 #secs
 
-    def initialize(host, port)
+    attr_accessor :host, :port, :read_timeout
+
+    def initialize(host, port, read_timeout=nil)
       @host, @port = host, port
       @socket = NullObject.new
+      @read_timeout = read_timeout || DEFAULT_READ_TIMEOUT
     end
 
     # Connects to VLC RC interface on Client#host and Client#port
     def connect
       @socket = TCPSocket.new(@host, @port)
-      2.times { read } #Clean the reading channel
+      #Channel cleanup: some vlc versions echo two lines of text on connect.
+      2.times { read(0.1) rescue nil }
       true
     rescue Errno::ECONNREFUSED => e
       raise VLC::ConnectionRefused, "Could not connect to #{@host}:#{@port}: #{e}"
@@ -26,7 +31,7 @@ module VLC
     # @return [Boolean] true is connected, false otherwise
     #
     def connected?
-      not @socket.nil?
+      not(@socket.nil?)
     end
 
     # Disconnects from VLC RC interface
@@ -59,20 +64,32 @@ module VLC
 
     # Reads data from the TCP server
     #
+    # @param timeout read timeout value for a read operation.
+    #                If omited the configured value or DEFAULT_READ_TIMEOUT will be used.
+    #
+    #
     # @return [String] the data
     #
-    def read
-      #TODO: Timeouts
-      raw_data = @socket.gets.chomp
-      if (data = process_data(raw_data))
+    def read(timeout=nil)
+      timeout = read_timeout if timeout.nil?
+      raw_data = nil
+
+      Timeout.timeout(timeout) do
+        raw_data = @socket.gets.chomp
+      end
+
+      if (data = parse_raw_data(raw_data))
         data[1]
       else
-        raise ProtocolError, "could not interpret the playload: #{raw_data}"
+        raise VLC::ProtocolError, "could not interpret the playload: #{raw_data}"
       end
+    rescue Timeout::Error
+      raise VLC::ReadTimeoutError, "read timeout"
     end
 
-    def process_data(data)
-      data.match(/^[>*\s*]*(.*)$/)
+    def parse_raw_data(data)
+      return nil if data.nil?
+      data.match(%r{^[>*\s*]*(.*)$})
     end
   end
 end

data/lib/vlc-client/errors.rb

@@ -11,6 +11,9 @@ module VLC
   # Raised on a write to a broken connection
   class BrokenConnectionError < Error; end
 
-  # Raised on a write ti a disconnected connection
+  # Raised on a write to a disconnected connection
   class NotConnectedError < Error; end
+
+  # Raised on a read timeout
+  class ReadTimeoutError < Error; end
 end

data/lib/vlc-client/server.rb

@@ -23,7 +23,7 @@ module VLC
     # @return [Boolean] true is VLC is running, false otherwise
     #
     def running?
-      not @pid.nil?
+      not(@pid.nil?)
     end
 
     alias :started? :running?
@@ -32,7 +32,9 @@ module VLC
     #
     # @return [Boolean] true is VLC is stopped, false otherwise
     #
-    def stopped?; not running?; end
+    def stopped?
+      not(running?)
+    end
 
     # Starts a VLC instance in a subprocess
     #
@@ -47,38 +49,11 @@ module VLC
       return @pid if running?
       detached ? @deamon = true : setup_traps
 
-      if RUBY_VERSION >= '1.9'
-        @pid = Process.spawn(headless? ? 'cvlc' : 'vlc',
-                             '--extraintf', 'rc', '--rc-host', "#{@host}:#{@port}",
-                             :pgroup => detached,
-                             :in => '/dev/null',
-                             :out => '/dev/null',
-                             :err => '/dev/null')
-
-        return @pid
-      end
-
-      # for Ruby 1.8 and below
-      rd, wr = IO.pipe
-      if Process.fork      #parent
-        wr.close
-        @pid = rd.read.to_i
-        rd.close
-        return @pid
-      else                 #child
-        rd.close
-
-        detach if detached #daemonization
-
-        wr.write(Process.pid)
-        wr.close
-
-        STDIN.reopen "/dev/null"
-        STDOUT.reopen "/dev/null", "a"
-        STDERR.reopen "/dev/null", "a"
-
-        Kernel.exec "#{headless? ? 'cvlc' : 'vlc'} --extraintf rc --rc-host #{@host}:#{@port}"
-      end
+      @pid = if RUBY_VERSION >= '1.9'
+               process_spawn(detached)
+             else
+               process_spawn_ruby_1_8(detached)
+             end
     end
 
     # Start a VLC instance as a system deamon
@@ -106,7 +81,7 @@ module VLC
     #                     as no effect (e.g. VLC not running)
     #
     def stop
-      return nil if not running?
+      return nil if stopped?
 
       Process.kill('INT', pid = @pid)
       @pid = NullObject.new
@@ -115,6 +90,48 @@ module VLC
     end
 
   private
+    def process_spawn(detached)
+      if ENV['OS'] == 'Windows_NT'
+        # We don't have pgroup, and should write to NUL in case the env doesn't simulate /dev/null
+        Process.spawn(headless? ? 'cvlc' : 'vlc',
+                             '--extraintf', 'rc', '--rc-host', "#{@host}:#{@port}",
+                             :in => 'NUL',
+                             :out => 'NUL',
+                             :err => 'NUL')
+      else
+        Process.spawn(headless? ? 'cvlc' : 'vlc',
+                      '--extraintf', 'rc', '--rc-host', "#{@host}:#{@port}",
+                      :pgroup => detached,
+                      :in => '/dev/null',
+                      :out => '/dev/null',
+                      :err => '/dev/null')
+      end
+    end
+
+    # For ruby 1.8
+    def process_spawn_ruby_1_8(detached)
+      rd, wr = IO.pipe
+      if Process.fork      #parent
+        wr.close
+        pid = rd.read.to_i
+        rd.close
+        return pid
+      else                 #child
+        rd.close
+
+        detach if detached #daemonization
+
+        wr.write(Process.pid)
+        wr.close
+
+        STDIN.reopen "/dev/null"
+        STDOUT.reopen "/dev/null", "a"
+        STDERR.reopen "/dev/null", "a"
+
+        Kernel.exec "#{headless? ? 'cvlc' : 'vlc'} --extraintf rc --rc-host #{@host}:#{@port}"
+      end
+    end
+
     def setup_traps
       trap("EXIT") do
         stop
@@ -126,10 +143,11 @@ module VLC
         exit
       end
 
+
       trap("CLD") do
         @pid = NullObject.new
         @deamon = false
-      end
+      end if Signal.list['CLD'] # Windows does not support this signal. Or daemons.
     end
 
     def detach

data/lib/vlc-client/version.rb

@@ -1,3 +1,3 @@
 module VLC
-  VERSION = "0.0.3"
+  VERSION = '0.0.4'
 end

data/spec/helper.rb

@@ -48,11 +48,11 @@ module Mocks
   end
 
   def mock_file(filename)
-    File.stub(:open).and_return {
-      f = File.new('./LICENSE', 'r')
+    File.stub(:open).and_return do
+      f = File.new('./README.md', 'r')
       f.should_receive(:path).once.and_return(filename)
       f
-    }
+    end
   end
 end
 

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

@@ -1,7 +1,7 @@
 describe VLC::Client::ConnectionManagement do
-  let(:vlc) { VLC::Client.new(:self_managed => false) }
   before(:each) { mock_tcp_server }
-  after(:each) { vlc.disconnect }
+  after(:each)  { vlc.disconnect }
+  let(:vlc)     { VLC::Client.new(:self_managed => false) }
 
   context 'when disconnected' do
     specify { vlc.should be_disconnected }

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

@@ -1,6 +1,6 @@
 describe VLC::Client::MediaControls do
-  let(:vlc) { VLC::Client.new(:self_managed => false) }
   after(:each) { vlc.disconnect }
+  let(:vlc)    { VLC::Client.new(:self_managed => false) }
 
   context 'plays media' do
     it 'from filesystem' do

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

@@ -1,7 +1,7 @@
 describe VLC::Client::PlaylistControls do
-  let(:vlc) { VLC::Client.new(:self_managed => false) }
+  after(:each)  { vlc.disconnect }
   let!(:server) { mock_tcp_server }
-  after(:each) { vlc.disconnect }
+  let(:vlc)     { VLC::Client.new(:self_managed => false) }
 
   it 'enqueues media' do
     server.should_receive(:puts).once.with('enqueue media.mp3')

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

@@ -1,6 +1,6 @@
 describe VLC::Client::VideoControls do
-  let(:vlc) { VLC::Client.new(:self_managed => false) }
   after(:each) { vlc.disconnect }
+  let(:vlc)    { VLC::Client.new(:self_managed => false) }
 
   context 'manipulate the screen size' do
     it 'toggles fullscreen' do

data/spec/vlc-client/connection_spec.rb

@@ -42,14 +42,49 @@ describe VLC::Connection do
     end
   end
 
+  context 'supports read timeouts' do
+    it 'per call' do
+      tcp = mock_tcp_server
+      connection.connect
+
+      Timeout.should_receive(:timeout).with(5)
+      connection.should_receive(:parse_raw_data).and_return([])
+      connection.read(5)
+    end
+
+    it 'configured' do
+      tcp = mock_tcp_server
+      connection = VLC::Connection.new('localhost', 9595, 3)
+      connection.connect
+
+      Timeout.should_receive(:timeout).with(3)
+      connection.should_receive(:parse_raw_data).and_return([])
+      connection.read
+      connection.close
+    end
+
+    it "defaults to #{VLC::Connection::DEFAULT_READ_TIMEOUT}" do
+      connection = VLC::Connection.new('localhost', 9595, nil)
+      connection.read_timeout.should eq(VLC::Connection::DEFAULT_READ_TIMEOUT)
+    end
+  end
+
   context 'raises error on' do
+    it 'read timeout' do
+       tcp = mock_tcp_server
+       connection.connect
+
+       Timeout.should_receive(:timeout).and_raise(Timeout::Error)
+       expect { connection.read(0) }.to raise_error(VLC::ReadTimeoutError)
+    end
+
     it 'unreadable content' do
       tcp = mock_tcp_server
       tcp.should_receive(:puts).once.with('some data')
       tcp.should_receive(:gets).once.and_return('some response data')
 
       connection.connect
-      connection.should_receive(:process_data).once.and_return(nil)
+      connection.should_receive(:parse_raw_data).once.and_return(nil)
 
       expect { connection.write('some data', false) }.to raise_error(VLC::ProtocolError)
     end
@@ -67,4 +102,4 @@ describe VLC::Connection do
       expect { connection.write('something') }.to raise_error(VLC::NotConnectedError)
     end
   end
-end
+end

data/spec/vlc_client_spec.rb

@@ -27,6 +27,13 @@ describe VLC::Client do
       vlc.server.should_not be_started
       vlc.should_not be_connected
     end
+
+    it 'accepts timeout configuration' do
+      mock_system_calls(:kill => false)
+
+      vlc = VLC::Client.new(VLC::Server.new('10.0.0.1', 9999), :read_timeout => 3)
+      vlc.connection.read_timeout.should eq(3)
+    end
   end
 
   it 'may manage an embedded VLC server' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vlc-client
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Miguel Guinada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-11 00:00:00.000000000 Z
+date: 2014-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: retryable