vlc-client 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bf06f6577ac01caa2f087f52810c0f9f8f9d909
-  data.tar.gz: 28223c029ee4a5df6eaa988f724766e9fcaae4e6
+  metadata.gz: b141e2f7f60baf5ac577461081fbaade9ff4c051
+  data.tar.gz: d7d66afcdf65b58fc266413eaa4a286e312ff846
 SHA512:
-  metadata.gz: 5103d85a95e92e33f8a7a07b42f4882517888dd38e49217cb8d3cabdc70171b7e848f480dde1443a99543bd2e20de2419a451d2baee2077cdda442252bfabbb3
-  data.tar.gz: 1f4271b37a1a6e2058e98edf66747d9f10c0558867cf7bd47ba52a1ea558d79dbddf0b5a81df5a06824ba39cf648fec65304e9aeceef8f30b8a954060deb9475
+  metadata.gz: 73fcaa9d7b0bf70fe306e30b31a1559d3ed298fbfbee48d5577dd1fcd1ef3b0fe19e192bc63635c640132ce226417856d50fa984ad630a06234e4d70dc4757ce
+  data.tar.gz: 92c826484688bd0265ff2eaecf7f34c0c72f921fc0653a7ce34630b30b622314c08e4b3ddf49ed23252b6f516b9b625a9672b1d4939cd05e7e65bd089ddfd2e9

data/.travis.yml

@@ -1,15 +1,17 @@
 language: ruby
+before_install:
+   - gem install bundler -v 1.10
 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
+  - jruby
+  - rbx-2
   - 1.9.3
   - 2.0.0
   - 2.1.0
+  - 2.2.0
   - ruby-head
 

data/README.md

@@ -2,7 +2,7 @@
 
 vlc-client manages a [VLC media player](http://www.videolan.org/vlc/) instance through it's RC interface.
 
-## Installation
+### Installation
 
 Add this line to your application's Gemfile:
 
@@ -16,22 +16,18 @@ Or install it yourself as:
 
     $ gem install vlc-client
 
-## Usage
+### Usage
 
-### Create a client and connect to a running VLC media player instance.
+##### Create a client and connect to a running VLC media player instance.
 
 ```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
+vlc = VLC::Client.new('192.168.1.10', 9999) #Expects a VLC media player running on `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
+vlc.connect # connect to server
 # => true
 
-vlc.play('http://example.org/media.mp3') #play media
+vlc.play('http://example.org/media.mp3') # play media
 # => true
 
 vlc.playing?
@@ -43,16 +39,15 @@ vlc.fullscreen
 
 ```
 
-### Create a self managed client/server system.
+##### Create a self managed client/server system.
 Most of the time we want a local client/server VLC media player system
 
 
 ```ruby
 
-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 = VLC::System.new # A client/server system over a local managed VLC instance
 
-vlc.connected? #auto_connect
+vlc.connected? # auto connect
 # => true
 
 vlc.play('http://example.org/media.mp3')
@@ -62,60 +57,53 @@ vlc.progress
 # => 1 #%
 #...
 
-#Technically this is 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
+# Playlist management
 
 ```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 = VLC::System.new
 
-vlc.server.running?
-# => false
+vlc.add_to_playlist('track1.mp3')
+vlc.add_to_playlist('track2.mp3')
 
-vlc.server.start
-# => 12672
+vlc.play
+
+vlc.playlist
+#=> [{:number=>1, :title=>"Track #1 title", :length=>"00:03:10", :times_played=>1}, {:number=>2, :title=>"Track #2 title", :length=>"00:03:30", :times_played=>0}]
 
-vlc.connect
-# => true
 ```
 
-## Reference
+### Reference
 
 [reference](http://rdoc.info/github/mguinada/vlc-client)
 
-## Notice
+### Notice
 
 vlc-client has been tested on linux but it should work on any VLC installation as long as the command line is responsive for `vlc` and `cvlc` calls. On Mac OS X these are not available by default. They can be created with:
 
-```
+```bash
 echo "alias vlc='/Applications/VLC.app/Contents/MacOS/VLC'" >> ~/.bash_profile
 echo "alias cvlc='/Applications/VLC.app/Contents/MacOS/VLC'" >> ~/.bash_profile
 ```
 
-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
+### Contributing
 
 1. Fork it
 2. Create your topic branch (`git checkout -b my-topic-branch`)
 3. Add/change specs for your unimplemented feature or bug fix
-4. Make sure specs fail by running `bundle exec rake spec`. If not return to step 3
-5. Hack it
-6. Make sure specs pass (`bundle exec rake spec`). If not return to step 5
-7. Edit the documentation so it is coherent with your feature or fix. Run `bundle exec rake yard` to review
-8. Commit changes (`git commit -am 'Add some feature/fix'`) and push to the branch (`git push origin my-topic-branch`)
-9. Submit a pull request for your branch.
+4. Hack it
+5. Make sure specs pass (`bundle exec rake spec`)
+6. Edit the documentation so it is coherent with your feature or fix. Run `bundle exec rake yard` to review
+7. Commit changes (`git commit -am 'Add some feature/fix'`) and push to the branch (`git push origin my-topic-branch`)
+8. Submit a pull request
 
-## Copyright
+### Copyright
 
 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)
+[license]: https://github.com/mguinada/vlc-client/blob/master/LICENSE

data/lib/vlc-client.rb

@@ -1,5 +1,3 @@
-require 'retryable'
-
 require 'vlc-client/null_object'
 require 'vlc-client/core_ext/array'
 
@@ -72,16 +70,25 @@ module VLC
       bind_server(server, options) unless server.nil?
     end
 
-  private
+    private
+
     def bind_server(server, options = {})
       @connection.host = server.host
       @connection.port = server.port
 
       if options.fetch(:auto_start, true)
+        connection_calls   = 0
+        connection_retries = options.fetch(:conn_retries, 5)
+        options.fetch(:daemonize, false) ? @server.daemonize : @server.start
+
         begin
-          options.fetch(:daemonize, false) ? @server.daemonize : @server.start
-          retryable(:tries => options.fetch(:conn_retries, 5), :on => VLC::ConnectionRefused) { connect }
+          connect
         rescue VLC::ConnectionRefused => e
+          if (connection_calls += 1) < connection_retries
+            sleep(0.5)
+            retry
+          end
+
           @server.stop
           raise e
         end
@@ -96,19 +103,20 @@ module VLC
         @host = args.first.to_s
         @port = Integer(args.last)
       else
-        @host, @port = 'localhost', 9595
+        @host = 'localhost'
+        @port = 9595
       end
       args
     end
 
-    def media_arg(media)
+    def media(media)
       case media
       when File
         media.path
       when String, URI
         media
       else
-        raise ArgumentError, "Can not play: #{media}"
+        raise ArgumentError, "Can not play #{media}"
       end
     end
   end

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

@@ -22,7 +22,7 @@ module VLC
       #     vlc.play #resume playback
       #
       def play(media = nil)
-        connection.write(media.nil? ? "play" : "add #{media_arg(media)}")
+        connection.write(media.nil? ? "play" : "add #{media(media)}")
       end
 
       # Pauses playback

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

@@ -17,7 +17,7 @@ module VLC
       # @param media [String, File, URI] the media to be played
       #
       def add_to_playlist(media)
-        connection.write("enqueue #{media_arg(media)}")
+        connection.write("enqueue #{media(media)}")
       end
 
       # Lists tracks on the playlist
@@ -47,7 +47,8 @@ module VLC
         connection.write("clear")
       end
 
-    private
+      private
+
       def parse_playlist(list)
         list.map do |item|
           match = item.match(LIST_ITEM_REGEXP)

data/lib/vlc-client/connection.rb

@@ -19,8 +19,7 @@ module VLC
     # Connects to VLC RC interface on Client#host and Client#port
     def connect
       @socket = TCPSocket.new(@host, @port)
-      #Channel cleanup: some vlc versions echo two lines of text on connect.
-      2.times { read(0.1) rescue nil }
+      2.times { read(0.1) rescue nil } #Channel cleanup: some vlc versions echo two lines of text on connect.
       true
     rescue Errno::ECONNREFUSED => e
       raise VLC::ConnectionRefused, "Could not connect to #{@host}:#{@port}: #{e}"
@@ -31,7 +30,7 @@ module VLC
     # @return [Boolean] true is connected, false otherwise
     #
     def connected?
-      not(@socket.nil?)
+      not @socket.nil?
     end
 
     # Disconnects from VLC RC interface
@@ -52,6 +51,7 @@ module VLC
     #
     def write(data, fire_and_forget = true)
       raise NotConnectedError, "no connection to server" unless connected?
+
       @socket.puts(data)
       @socket.flush
 

data/lib/vlc-client/errors.rb

@@ -1,19 +1,8 @@
 module VLC
-  # Root error class
-  class Error < StandardError; end
-
-  # Raised on connection refusal
-  class ConnectionRefused < Error; end
-
-  # Raised on communication errors
-  class ProtocolError < Error; end
-
-  # Raised on a write to a broken connection
-  class BrokenConnectionError < Error; end
-
-  # Raised on a write to a disconnected connection
-  class NotConnectedError < Error; end
-
-  # Raised on a read timeout
-  class ReadTimeoutError < Error; end
+  Error                 = Class.new(StandardError) # Root error class
+  ConnectionRefused     = Class.new(Error)         # Raised on connection refusal
+  NotConnectedError     = Class.new(Error)         # Raised on a write to a disconnected connection
+  BrokenConnectionError = Class.new(Error)         # Raised on a write to a broken connection
+  ProtocolError         = Class.new(Error)         # Raised on communication errors
+  ReadTimeoutError      = Class.new(Error)         # Raised on a read timeout
 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?
@@ -33,7 +33,7 @@ module VLC
     # @return [Boolean] true is VLC is stopped, false otherwise
     #
     def stopped?
-      not(running?)
+      not running?
     end
 
     # Starts a VLC instance in a subprocess
@@ -47,18 +47,14 @@ module VLC
     #
     def start(detached = false)
       return @pid if running?
+
       detached ? @deamon = true : setup_traps
 
-      @pid = if RUBY_VERSION >= '1.9'
-               process_spawn(detached)
-             else
-               process_spawn_ruby_1_8(detached)
-             end
+      @pid = RUBY_VERSION >= '1.9' ? process_spawn(detached) : process_spawn_ruby_1_8(detached)
     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
@@ -83,22 +79,25 @@ module VLC
     def stop
       return nil if stopped?
 
-      Process.kill('INT', pid = @pid)
+      Process.kill('SIGTERM', pid = @pid)
       @pid = NullObject.new
       @deamon = false
+
       pid
     end
 
-  private
+    private
+
     def process_spawn(detached)
-      if ENV['OS'] == 'Windows_NT'
+      case
+      when 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')
-      elsif (/darwin/ =~ RUBY_PLATFORM) != nil
+                      '--extraintf', 'rc', '--rc-host', "#{@host}:#{@port}",
+                      :in => 'NUL',
+                      :out => 'NUL',
+                      :err => 'NUL')
+      when /darwin/ =~ RUBY_PLATFORM
         Process.spawn('/Applications/VLC.app/Contents/MacOS/VLC',
                       '--extraintf', 'rc', '--rc-host', "#{@host}:#{@port}",
                       :pgroup => detached,
@@ -118,6 +117,7 @@ module VLC
     # 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
@@ -158,7 +158,7 @@ module VLC
     end
 
     def detach
-     if RUBY_VERSION < "1.9"
+      if RUBY_VERSION < "1.9"
         Process.setsid
         exit if Process.fork
         Dir.chdir "/"

data/lib/vlc-client/system.rb

@@ -38,6 +38,7 @@ module VLC
         server.host = args.first.to_s
         server.port = Integer(args.last)
       end
+
       @client = VLC::Client.new(server, opts)
     end
 
@@ -49,7 +50,8 @@ module VLC
       client.respond_to?(method, private_methods) || super(method, private_methods)
     end
 
-  protected
+    protected
+
     # Delegate to VLC::Client
     #
     def method_missing(method, *args, &block)

data/lib/vlc-client/version.rb

@@ -1,3 +1,3 @@
 module VLC
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/spec/helper.rb

@@ -44,7 +44,7 @@ module Mocks
       Process.should_receive(:spawn).once.and_return(99)
     end
 
-    Process.should_receive(:kill).once.with('INT', 99) if opts.fetch(:kill, true)
+    Process.should_receive(:kill).once.with('SIGTERM', 99) if opts.fetch(:kill, true)
   end
 
   def mock_file(filename)

data/spec/vlc_client_spec.rb

@@ -34,6 +34,17 @@ describe VLC::Client do
       vlc = VLC::Client.new(VLC::Server.new('10.0.0.1', 9999), :read_timeout => 3)
       vlc.connection.read_timeout.should eq(3)
     end
+
+    it 'retries to connect on autoconnect failure' do
+      mock_system_calls(:kill => true)
+      num_retries = 3
+
+      TCPSocket.should_receive(:new).exactly(num_retries).times.and_raise(Errno::ECONNREFUSED)
+
+      expect {
+        VLC::Client.new(VLC::Server.new('10.0.0.1', 9898), :conn_retries => num_retries)
+      }.to raise_error(VLC::ConnectionRefused)
+    end
   end
 
   it 'may manage an embedded VLC server' do

data/vlc-client.gemspec

@@ -7,7 +7,6 @@ Gem::Specification.new do |gem|
   gem.description   = %q{vlc-client allows to control VLC media player over TCP}
   gem.summary       = %q{vlc-client is a TCP client for VLC media player}
   gem.homepage      = "https://github.com/mguinada/vlc-client"
-
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
@@ -15,6 +14,4 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = VLC::VERSION
   gem.date          = Time.now.utc.strftime("%Y-%m-%d")
-
-  gem.add_dependency 'retryable', '~> 1.3'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: vlc-client
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Miguel Guinada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: retryable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
+date: 2016-08-03 00:00:00.000000000 Z
+dependencies: []
 description: vlc-client allows to control VLC media player over TCP
 email:
 - mguinada@gmail.com
@@ -94,4 +80,3 @@ test_files:
 - spec/vlc-client/connection_spec.rb
 - spec/vlc-client/server_spec.rb
 - spec/vlc_client_spec.rb
-has_rdoc: