vlc_proxy 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5e1b0d3e7ac5412726b8ff9d74dc38c00f9128b5
-  data.tar.gz: 4e39161521d48a62a363b015c0538386b1b35134
+SHA256:
+  metadata.gz: 800716aa5e1bb47031fb019e9ca215f06717b47faebc69f0bdfacec48b67a803
+  data.tar.gz: 742ed130d6e8be1017206730e271779879f6912266be8f0af5e00caf388c0256
 SHA512:
-  metadata.gz: 6ec290b6f41b13c436159d86aaa660c176fdad255dc057f1b8838b06a90cebe7b8b5858bab4db79fd0210016e4fd7bfa64ec5cf09996ec61275a824b361b1414
-  data.tar.gz: 6852d3b7355437ba7b7ec532ceecbb7b414f8b98bf54e6b8a35d799c7b310f8602fc1f2845ab0d99c1d0cb424f0829ccdcfb61552fa9b5ea8797f3ec5527f920
+  metadata.gz: f06aaa10e8c30d35a9c173a36493f3e587a30da8fbc6397421118d5d3e15e7bbe506cd619eab56b7842e26497a1c0051744fc3a16cc9db769571106cdda85dd5
+  data.tar.gz: 79059b04d4c470fd9e5a3d16b8099f793011b9dd1d43425e51274f48c70c02ca524a0481a7679cd8fe82df3c194b4c74da6d8f824c16deafdf55ff8c3bb3d4d4

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  NewCops: enable
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'

data/.simplecov

@@ -0,0 +1,8 @@
+require 'simplecov-console'
+
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter.new([
+    SimpleCov::Formatter::Console,
+    SimpleCov::Formatter::HTMLFormatter
+  ])
+end

data/.travis.yml

@@ -1,7 +1,7 @@
-sudo: false
 language: ruby
+os: linux
 rvm:
-  - 2.3.0
-  - 2.4.0
   - 2.5.0
-before_install: gem install bundler -v 1.16.2
+  - 2.6.0
+  - 2.7.0
+  - 3.0.0

data/README.md

@@ -1,8 +1,17 @@
 # VlcProxy
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/vlc_proxy`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/vlc_proxy.svg)](https://badge.fury.io/rb/vlc_proxy)
+[![Build Status](https://travis-ci.org/zsyed91/vlc_proxy.svg?branch=master)](https://travis-ci.org/zsyed91/vlc_proxy)
 
-TODO: Delete this and the text above, and describe your gem
+
+VLC exposes an optional [http server](https://wiki.videolan.org/Documentation:Modules/http_intf/) for remote commands to be called against the
+running instance of VLC. This can be configured to listen on localhost only and
+uses HTTP basic auth for authentication.
+
+The purpose of this gem is to allow programmatic access using ruby against this
+http server. Possible use cases are scripts to automate VLC, expose automation
+services to your VLC instance, gather information on your running VLC instance,
+control VLC programmatically etc.
 
 ## Installation
 
@@ -22,17 +31,81 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+At the top of your application or script load the library:
+
+```ruby
+require 'vlc_proxy
+```
+
+### Client Usage - Basic Example
+
+First create the connection object by giving it both the hostname that VLC is
+running on along with the password set for basic auth. The default port is `8080`
+and the default scheme is `http`.
+
+```ruby
+# Create the connection
+
+connection = VlcProxy::Connection.new(hostname, password)
+
+# Create the client
+client = VlcProxy::Client.new(connection)
+
+puts client.current_state.inspect
+```
+
+### Client Usage - Advanced Example
+
+If you configure the HTTP server not to use the default port and scheme, you
+can pass this into the connection object as optional inputs to override the defaults.
+
+```ruby
+# Create the connection
+
+port = 8090
+connection = VlcProxy::Connection.new(hostname, password, port)
+
+# Create the client
+client = VlcProxy::Client.new(connection)
+
+if client.connection.connected?
+  puts 'Hello VLC'
+else
+  puts 'Failed to connect to VLC'
+end
+```
+
+### Methods available
+
+After creating the client, there are multiple methods exposed to interact with
+the VLC instance. The basic example is to call current state, but we can also
+make VLC take actions directly available through the UI.
+
+- current_state
+- pause_playlist
+- start_playlist
+- stop_playlist
+- next_item
+- previous_item
+- toggle_repeat
+- toggle_loop
+- toggle_random
+- toggle_fullscren
+- increase_volume(amount)
+- decrease_volume(amount)
+- volume(amount_with_units)
+- skip_forward(amount_in_seconds)
+- skip_backward(amount_in_seconds)
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/vlc_proxy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/zsyed91/vlc_proxy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +113,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the VlcProxy project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/vlc_proxy/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the VlcProxy project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/zsyed91/vlc_proxy/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,6 +1,14 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
 
+desc 'Run RSpec against the spec directory'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+desc 'Run RuboCop on the lib directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+  task.fail_on_error = true
+end
+
+task :default => [:spec, :rubocop]

data/lib/vlc_proxy/client.rb

@@ -1,72 +1,81 @@
-require 'vlc_proxy/configuration'
-module VlcProxy
-  class Client
-    attr_reader :connection
-
-    def initialize(connection)
-      @connection = connection
-      @logger = VlcProxy.config.logger
-    end
-
-    def pause_playlist
-      request('status', 'pl_pause')
-    end
-
-    def start_playlist
-      request('status', 'pl_play')
-    end
-
-    def stop_playlist
-      request('status', 'pl_stop')
-    end
-
-    def next_item
-      request('status', 'pl_next')
-    end
-
-    def previous_item
-      request('status', 'pl_previous')
-    end
-
-    def toggle_repeat
-      request('status', 'pl_repeat')
-    end
-
-    def toggle_loop
-      request('status', 'pl_loop')
-    end
-
-    def toggle_random
-      request('status', 'pl_random')
-    end
-
-    def toggle_fullscreen
-      request('status', 'fullscreen')
-    end
-
-    def increase_volume(value)
-      request('status', 'volume', val: "+#{value}")
-    end
-
-    def decrease_volume(value)
-      request('status', 'volume', val: "-#{value}")
-    end
-
-    def skip_forward(seconds)
-      request('status', 'seek', val: "+#{seconds}S")
-    end
-
-    def skip_backward(seconds)
-      request('status', 'seek', val: "-#{seconds}S")
-    end
-
-    private
-
-    def request(action, command = '', parameters = {})
-      @connection.execute(action, command, parameters)
-    rescue StandardError => e
-      @logger.error(e.message)
-      raise e
-    end
-  end
-end
+require 'vlc_proxy/configuration'
+
+module VlcProxy
+  class Client
+    attr_reader :connection
+
+    def initialize(connection)
+      @connection = connection
+      @logger = VlcProxy.config.logger
+    end
+
+    def current_state
+      request('status')
+    end
+
+    def pause_playlist
+      request('status', 'pl_pause')
+    end
+
+    def start_playlist
+      request('status', 'pl_play')
+    end
+
+    def stop_playlist
+      request('status', 'pl_stop')
+    end
+
+    def next_item
+      request('status', 'pl_next')
+    end
+
+    def previous_item
+      request('status', 'pl_previous')
+    end
+
+    def toggle_repeat
+      request('status', 'pl_repeat')
+    end
+
+    def toggle_loop
+      request('status', 'pl_loop')
+    end
+
+    def toggle_random
+      request('status', 'pl_random')
+    end
+
+    def toggle_fullscreen
+      request('status', 'fullscreen')
+    end
+
+    def increase_volume(value)
+      volume("+#{value.abs}")
+    end
+
+    def decrease_volume(value)
+      volume("-#{value.abs}")
+    end
+
+    def volume(value)
+      request('status', 'volume', val: value)
+    end
+
+    def skip_forward(seconds)
+      request('status', 'seek', val: "+#{seconds.abs}S")
+    end
+
+    def skip_backward(seconds)
+      request('status', 'seek', val: "-#{seconds.abs}S")
+    end
+
+    private
+
+    def request(action, command = '', parameters = {})
+      @connection.execute(action, command, parameters)
+    rescue StandardError => e
+      @logger.error(e.message)
+      raise e
+    end
+  end
+end

data/lib/vlc_proxy/configuration.rb

@@ -1,21 +1,22 @@
-require 'logger'
-
-module VlcProxy
-  class Configuration
-    attr_accessor :logger, :verbose
-
-    def initialize
-      @logger = Logger.new(STDOUT)
-      @verbose = false
-    end
-
-    def logger
-      @logger.level = Logger::INFO if verbose? && !@logger.info?
-      @logger
-    end
-
-    def verbose?
-      @verbose
-    end
-  end
-end
+require 'logger'
+
+module VlcProxy
+  class Configuration
+    attr_writer :logger, :verbose
+
+    def initialize
+      @logger = Logger.new($stdout)
+      @verbose = false
+    end
+
+    def logger
+      @logger.level = verbose? ? Logger::DEBUG : Logger::INFO
+
+      @logger
+    end
+
+    def verbose?
+      @verbose
+    end
+  end
+end

data/lib/vlc_proxy/connection.rb

@@ -1,66 +1,70 @@
-require 'net/http'
-require 'nokogiri'
-
-module VlcProxy
-  # When HTTP enabled on VLC, a LUA web server runs in background listening
-  #   on the specific port on localhost by default. VLC requires setting a
-  #   password for basic auth as well
-  class Connection
-    def initialize(hostname, password, port = 8080, scheme = 'http')
-      @hostname = hostname
-      @password = password
-      @port = port
-      @scheme = scheme
-      @logger = VlcProxy.config.logger
-    end
-
-    # Test if the connection works with the connection parameters
-    #  Returns true if VLC is running and returns a response on /status
-    #  Returns false if there are any connection errors
-    def connected?
-      response = execute('status')
-      parse_response(response)
-    rescue VlcProxy::AccessDeniedError, Errno::ECONNREFUSED => e
-      @logger.error(e.message)
-      false
-    end
-
-    def execute(action, command = '', parameters = {})
-      uri = build_uri(action, command, parameters)
-      request = Net::HTTP::Get.new(uri)
-      request.basic_auth('', @password)
-
-      Net::HTTP.start(uri.hostname, uri.port) do |http|
-        @logger.info('Starting HTTP request')
-        http.request(request)
-      end
-    end
-
-    private
-
-    def http_success?(response)
-      response.code == '200'
-    end
-
-    def http_unauthorized?(response)
-      response.code == '401'
-    end
-
-    def parse_response(response)
-      return true if http_success?(response)
-      raise VlcProxy::AccessDeniedError if http_unauthorized?(response)
-      false
-    end
-
-    def build_uri(action, command = '', parameters = {})
-      base_url = "#{@scheme}://#{@hostname}:#{@port}/requests/#{action}.xml"
-      base_url += "?command=#{command}" unless command.empty?
-      unless parameters.empty?
-        params = parameters.map { |key, value| "#{key}=#{value}" }.join('&')
-        base_url += "&#{params}"
-      end
-      @logger.info("built uri: #{base_url}")
-      URI(base_url)
-    end
-  end
-end
+require 'net/http'
+require 'nokogiri'
+
+module VlcProxy
+  # When HTTP enabled on VLC, a LUA web server runs in background listening
+  #   on the specific port on localhost by default. VLC requires setting a
+  #   password for basic auth as well
+  class Connection
+    def initialize(hostname, password, port = 8080, scheme = 'http')
+      @hostname = hostname
+      @password = password
+      @port = port
+      @scheme = scheme
+      @logger = VlcProxy.config.logger
+    end
+
+    # Test if the connection works with the connection parameters
+    #  Returns true if VLC is running and returns a response on /status
+    #  Returns false if there are any connection errors
+    def connected?
+      response = execute('status')
+      valid_response?(response)
+    rescue VlcProxy::AccessDeniedError, Errno::ECONNREFUSED => e
+      @logger.error(e.message)
+      false
+    end
+
+    def execute(action, command = '', parameters = {})
+      uri = build_uri(action, command, parameters)
+      request = Net::HTTP::Get.new(uri)
+      request.basic_auth('', @password)
+
+      Net::HTTP.start(uri.hostname, uri.port) do |http|
+        @logger.debug('Starting HTTP request')
+        http.request(request)
+      end
+    end
+
+    private
+
+    def http_success?(response)
+      response.code == '200'
+    end
+
+    def http_unauthorized?(response)
+      response.code == '401'
+    end
+
+    def valid_response?(response)
+      return true if http_success?(response)
+
+      raise VlcProxy::AccessDeniedError if http_unauthorized?(response)
+
+      false
+    end
+
+    def build_uri(action, command = '', parameters = {})
+      base_url = "#{@scheme}://#{@hostname}:#{@port}/requests/#{action}.xml"
+      base_url += "?command=#{command}" unless command.empty?
+
+      unless parameters.empty?
+        params = parameters.map { |key, value| "#{key}=#{value}" }.join('&')
+        base_url += "&#{params}"
+      end
+
+      @logger.debug("built uri: #{base_url}")
+      URI(base_url)
+    end
+  end
+end

data/lib/vlc_proxy/exceptions.rb

@@ -1,4 +1,4 @@
-# List of custom Exceptions
-module VlcProxy
-  class AccessDeniedError < StandardError; end
-end
+# List of custom Exceptions
+module VlcProxy
+  class AccessDeniedError < StandardError; end
+end

data/lib/vlc_proxy/version.rb

@@ -1,3 +1,3 @@
 module VlcProxy
-  VERSION = "0.1.0"
+  VERSION = '0.1.5'.freeze
 end

data/vlc_proxy.gemspec

@@ -18,18 +18,21 @@ Gem::Specification.new do |spec|
   # into git
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject do |f|
-      f.match(%r{^(test|spec|features)/})
+	    f.match(%r{^(test|spec|features)/}) || f.match(/vlc_proxy-0.1.0.gem/)
     end
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'nokogiri', '>= 1.9.1'
+  # Runtime Dependencies
+  spec.add_runtime_dependency 'nokogiri', '>= 1.11.3'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.7'
-  spec.add_development_dependency 'pry', '~> 0.12.2'
-  spec.add_development_dependency 'simplecov', '~> 0.16.1'
+  # Development/Test Dependencies
+  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.3'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'pry', '~> 0.14.1'
+  spec.add_development_dependency 'simplecov', '~> 0.21.2'
+  spec.add_development_dependency 'simplecov-console', '~> 0.9.1'
+  spec.add_development_dependency 'rubocop', '~> 1.13'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vlc_proxy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Zshawn Syed
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-26 00:00:00.000000000 Z
+date: 2021-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,84 +16,104 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: 1.11.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: 1.11.3
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.3
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 0.21.2
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '1.13'
 description: Simple Ruby wrapper around the HTTP server VLC exposes
 email:
 - zsyed91@gmail.com
@@ -103,6 +123,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".simplecov"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -137,8 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Simple Ruby wrapper around the HTTP server VLC exposes