vlc-client 0.0.1.beta → 0.0.1.beta2

data/README.md

@@ -18,7 +18,7 @@ Or install it yourself as:
 
 ## Usage
 
-### Create a client and connect to a running VLC media play instance.
+### Create a client and connect to a running VLC media player instance.
 
 ```ruby
 
@@ -31,17 +31,19 @@ vlc = VLC::Client.new('192.168.1.10', 9999)
 vlc.connect
 # => true
 vlc.play('http://example.org/media.mp3') #play media
-=> true
+# => true
 vlc.playing?
-=> true
+# => true
 vlc.fullscreen
-=> true
+# => true
 #...
 
 ```
 
 ### Create a self managed client/server system.
-_(requires a local installation of VLC media player)_
+_Most of the time we want a local client/server VLC media player system_
+
+_(NOTE: requires a local installation of VLC media player)_
 
 ```ruby
 
@@ -49,27 +51,27 @@ vlc = VLC::System.new #A local VLC client/server system where a local VLC server
 # => "#<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
-=> true
+# => true
 
 vlc.play('http://example.org/media.mp3')
-=> true
+# => true
 
 vlc.progress
-=> 1 #%
+# => 1 #%
 #...
 
-#Technically this the same as
+#Technically this is the same as
 vlc = VLC::Client.new(VLC::Server.new('localhost', 9595, false))
 # => "#<VLC::Client:0x000000011de128 @server=#<VLC::Server:0x000000011de380 @headless=false, @port=9595, @host=\"localhost\", @pid=12656>, @connection=#<VLC::Connection:0x000000011de038 @port=9595, @host=\"localhost\", @socket=#<TCPSocket:fd 5>>>"
 ```
 
 ###Get local VLC server lifecycle management control
-_(requires a local installation of VLC media player)_
+_(NOTE: requires a local installation of VLC media player)_
 
 ```ruby
 
 vlc = VLC::System.new('127.0.0.1', 9999, auto_start: false)
-=> "#<VLC::System:0x00000001695f68 @client=#<VLC::Client:0x0000000169d718 @server=#<VLC::Server:0x00000001695ec8 @headless=false, @port=9999, @host=\"127.0.0.1\", @pid=VLC::NullObject>, @connection=#<VLC::Connection:0x0000000169d588 @port=9999, @host=\"127.0.0.1\", @socket=VLC::NullObject>>>"
+# => "#<VLC::System:0x00000001695f68 @client=#<VLC::Client:0x0000000169d718 @server=#<VLC::Server:0x00000001695ec8 @headless=false, @port=9999, @host=\"127.0.0.1\", @pid=VLC::NullObject>, @connection=#<VLC::Connection:0x0000000169d588 @port=9999, @host=\"127.0.0.1\", @socket=VLC::NullObject>>>"
 
 vlc.server.running?
 # => false

data/lib/vlc-client.rb

@@ -1,13 +1,10 @@
-require 'uri'
-require 'socket'
 require 'retryable'
 
-require 'vlc-client/version'
-
 require 'vlc-client/null_object'
-
 require 'vlc-client/core_ext/array'
 
+require 'vlc-client/version'
+
 require 'vlc-client/server'
 require 'vlc-client/connection'
 require 'vlc-client/errors'
@@ -45,15 +42,17 @@ module VLC
     #   @param [Hash] options
     #   @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.
     #
     #   @example
     #     vlc = VLC::Client.new(VLC::Server.new)
     #     vlc.server.started?
-    #     => true
+    #     #=> true
     #
+    #   @example
     #     vlc = VLC::Client.new(VLC::Server.new, auto_start: false)
     #     vlc.server.started?
-    #     => false
+    #     #=> false
     #
     # @return [VLC::VLC] a VLC client
     #
@@ -68,7 +67,7 @@ module VLC
       bind_server(server, options) unless server.nil?
     end
 
-    private
+  private
     attr_reader :connection
 
     def bind_server(server, options = {})
@@ -77,7 +76,7 @@ module VLC
 
       if options.fetch(:auto_start, true)
         begin
-          @server.start
+          options.fetch(:daemonize, false) ? @server.daemonize : @server.start
           retryable(:tries => options.fetch(:conn_retries, 5), :on => VLC::ConnectionRefused) { connect }
         rescue VLC::ConnectionRefused => e
           @server.stop

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

@@ -12,7 +12,6 @@ module VLC
       end
 
       # Queries if there is an active connection to VLC RC interface
-      #
       def connected?
         connection.connected?
       end

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

@@ -1,3 +1,5 @@
+require 'uri'
+
 module VLC
   class Client
     module MediaControls
@@ -24,19 +26,16 @@ module VLC
       end
 
       # Pauses playback
-      #
       def pause
         connection.write("pause")
       end
 
       # Stops media currently playing
-      #
       def stop
         connection.write("stop")
       end
 
       # Gets the title of the media at play
-      #
       def title
         connection.write("get_title", false)
       end
@@ -71,18 +70,16 @@ module VLC
       end
 
       # Queries VLC if media is being played
-      #
       def playing?
         connection.write("is_playing", false) == "1"
       end
 
       # Queries VLC if playback is currently stopped
-      #
       def stopped?
         connection.write("is_playing", false) == "0"
       end
 
-      private
+    private
       def media_arg(media)
         case media
         when File

data/lib/vlc-client/connection.rb

@@ -1,5 +1,6 @@
+require 'socket'
+
 module VLC
-  #@ private
   #
   # Manages the connection to a VLC server
   #

data/lib/vlc-client/server.rb

@@ -9,13 +9,13 @@ module VLC
     #
     # @param [String] host The ip to bind to
     # @param [Integer] port the port
-    # @param [Boolean] headless if true VLC media player will run headless.
+    # @param [Boolean] headless if true VLC media player will run in headless mode.
     #                   i.e. without a graphical interface. Defaults to false
     #
     def initialize(host = 'localhost', port = 9595, headless = false)
       @host, @port, @headless = host, port, headless
       @pid = NullObject.new
-      setup_traps
+      @deamon = false
     end
 
     # Queries if VLC is running
@@ -36,20 +36,59 @@ module VLC
 
     # Starts a VLC instance in a subprocess
     #
+    # @param [Boolean] detached if true VLC will be started as a deamon process.
+    #                     Defaults to false.
+    #
     # @return [Integer] the subprocess PID or nil if the start command
     #                     as no effect (e.g. VLC already running)
     #
-    def start
-      return NullObject.new if running?
-      @pid = Process.fork do
+    # @see #daemonize
+    #
+    def start(detached = false)
+      return @pid if running?
+      rd, wr = IO.pipe
+
+      detached ? @deamon = true : setup_traps
+      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"
 
-        exec "#{headless? ? 'cvlc' : 'vlc'} --extraintf rc --rc-host #{@host}:#{@port}"
+        Kernel.exec "#{headless? ? 'cvlc' : 'vlc'} --extraintf rc --rc-host #{@host}:#{@port}"
       end
     end
 
+    # Start a VLC instance as a system deamon
+    #
+    #
+    # @return [Integer] the subprocess PID or nil if the start command
+    #                     as no effect (e.g. VLC already running)
+    # @see Server#start
+    #
+    def daemonize
+      start(true)
+    end
+
+    # Queries if VLC is running in daemonized mode
+    #
+    # @see #daemonize
+    #
+    def daemonized?
+      @deamon == true
+    end
+
     # Starts a VLC instance in a subprocess
     #
     # @return [Integer] the terminated subprocess PID or nil if the stop command
@@ -63,11 +102,21 @@ module VLC
       pid
     end
 
-    private
+  private
     def setup_traps
       trap("EXIT") { stop }
       trap("INT")  { stop }
-      trap("CLD")  { stop }
+      trap("CLD")  { @pid = NullObject.new }
+    end
+
+    def detach
+     if RUBY_VERSION < "1.9"
+        Process.setsid
+        exit if Process.fork
+        Dir.chdir "/"
+      else
+        Process.daemon
+      end
     end
   end
-end
+end

data/lib/vlc-client/system.rb

@@ -10,8 +10,10 @@ module VLC
     #   @param [String] host The ip to connect to
     #   @param [Integer] port the port
     #   @param [Hash] options
+    #   @option options [Boolean] :headless If true VLC run in headless mode. i.e. without a graphical interface. Defaults to false.
     #   @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.
     #
     #   @example
     #     vlc = VLC::System.new('10.10.0.10', 9000)

data/lib/vlc-client/version.rb

@@ -1,3 +1,3 @@
 module VLC
-  VERSION = "0.0.1.beta"
+  VERSION = "0.0.1.beta2"
 end

data/spec/helper.rb

@@ -25,8 +25,34 @@ module Mocks
   end
 
   def mock_system_calls(opts = {})
-    Process.stub(:fork).and_return(1)
-    Process.should_receive(:kill).once.with('INT', 1) if opts.fetch(:kill, true)
+    if opts.fetch(:daemonized, false)
+      Process.should_receive(:fork).once.ordered.and_return(false)
+
+      if RUBY_VERSION < "1.9"
+        Process.should_receive(:setsid).once.ordered
+        Process.should_receive(:fork).once.ordered.and_return(false)
+        Dir.should_receive(:chdir).once.with("/")
+      else
+        Process.should_receive(:daemon).once
+      end
+      Process.should_receive(:pid).once.and_return(99)
+
+      rd = stub('rd', :close => true)
+      wd = stub('wd', :write => true, :close => true)
+      IO.stub(:pipe).and_return([rd, wd])
+
+      [STDIN, STDOUT, STDERR].each { |std| std.stub(:reopen) }
+
+      Kernel.stub(:exec)
+    else
+      Process.stub(:fork).and_return(true)
+
+      rd = stub('rd', :read => 99, :close => true)
+      wd = stub('wd', :close => true)
+      IO.stub(:pipe).and_return([rd, wd])
+
+      Process.should_receive(:kill).once.with('INT', 99) if opts.fetch(:kill, true)
+    end
   end
 
   def mock_sub_systems

data/spec/system_spec.rb

@@ -1,11 +1,8 @@
 describe VLC::System do
-  before(:each) do
-    mock_system_calls(:kill => false)
-  end
-
   subject { VLC::System.new }
 
   it 'creates a self-managed VLC media client/server local system' do
+    mock_system_calls(:kill => false)
     mock_tcp_server(:close => false)
 
     subject.client.should be_a(VLC::Client)
@@ -13,6 +10,7 @@ describe VLC::System do
   end
 
   it 'delegates calls to the client' do
+    mock_system_calls(:kill => false)
     mock_tcp_server(:close => false).should_receive(:puts).with('is_playing').once
 
     should respond_to(:play)
@@ -20,6 +18,7 @@ describe VLC::System do
   end
 
   it 'handles server lifecycle management to client code' do
+    mock_system_calls(:kill => false)
     mock_tcp_server(:close => false)
 
     vlc = VLC::System.new('127.0.0.1', 9999, :auto_start => false)
@@ -28,4 +27,12 @@ describe VLC::System do
     vlc.server.host.should eq('127.0.0.1')
     vlc.server.port.should eq(9999)
   end
+
+  it 'runs server as a daemon process' do
+    mock_system_calls(:kill => false, :daemonized => true)
+    mock_tcp_server(:close => false)
+
+    vlc = VLC::System.new(:daemonize => true)
+    vlc.server.should be_daemonized
+  end
 end

data/spec/vlc-client/server_spec.rb

@@ -1,16 +1,26 @@
 describe VLC::Server do
-  let!(:server) do
-    mock_system_calls
-    server = VLC::Server.new('localhost', 9595, true)
-  end
+  let(:server) { VLC::Server.new('localhost', 9595, true) }
   after(:each) { server.stop }
 
-  it 'starts a VLC instance' do
-    server.start.should_not be_nil
-    server.should be_running
+  context 'starts a VLC instance' do
+    it 'as a child process' do
+      mock_system_calls
+
+      server.start.should_not be_nil
+      server.should be_running
+    end
+
+    it 'as a deamon' do
+      mock_system_calls(:daemonized => true)
+
+      server.daemonize
+      server.should be_daemonized
+    end
   end
 
   it 'stops a VLC instance' do
+    mock_system_calls
+
     server.start
 
     server.stop.should_not be_nil

data/spec/vlc_client_spec.rb

@@ -14,7 +14,7 @@ describe VLC::Client do
       vlc.port.should eq(9999)
     end
 
-    it 'is self managed if server is given' do
+    it 'is self managed if a server is given' do
       mock_system_calls(:kill => false)
 
       vlc = VLC::Client.new(VLC::Server.new('10.0.0.1', 9999))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vlc-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1.beta
+  version: 0.0.1.beta2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-28 00:00:00.000000000 Z
+date: 2012-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: retryable
-  requirement: &16536620 !ruby/object:Gem::Requirement
+  requirement: &11273980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *16536620
+  version_requirements: *11273980
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &16535440 !ruby/object:Gem::Requirement
+  requirement: &11272940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16535440
+  version_requirements: *11272940
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &16534580 !ruby/object:Gem::Requirement
+  requirement: &11271820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16534580
+  version_requirements: *11271820
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &16533480 !ruby/object:Gem::Requirement
+  requirement: &11271200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16533480
+  version_requirements: *11271200
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &16532400 !ruby/object:Gem::Requirement
+  requirement: &11269520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16532400
+  version_requirements: *11269520
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &16531440 !ruby/object:Gem::Requirement
+  requirement: &11268560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16531440
+  version_requirements: *11268560
 - !ruby/object:Gem::Dependency
   name: maruku
-  requirement: &16515700 !ruby/object:Gem::Requirement
+  requirement: &11267320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16515700
+  version_requirements: *11267320
 description: vlc-client allows to control VLC media player over TCP
 email:
 - mguinada@gmail.com