vlc_proxy 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 838c6ceedc898be9d6c1bca8c6b9811a03a5fd4baac760b841d4b192bdd09dd1
-  data.tar.gz: d101db097f1d8bd7a9984a5d521f25b141b0c2e7a21bf08344d2bc64a14443e9
+  metadata.gz: 55af8fdb16a59d8aabde1102d3c94d8c66f2f55eb30e408c30f632602b6c0c35
+  data.tar.gz: 0e00741374165ae9cfc4b2907acc67ff5827d82624e8927293e03255fc79ae5c
 SHA512:
-  metadata.gz: c86b087a48edbdb6f5a9e891ef2e2414dfcbe7c22b9cae0940dd45184e6150bba17e0989e90411c20c33a763cd31b5313cc9bb4abd9764b2325bd6c6541b9739
-  data.tar.gz: 0ad2aefec8a13c60beed9376dcd546121e0d08ace35a07b0250d48f837decbf530eef7c6d9319a6409d650cf7b6bb34a797b959a8083d28830785748891b0fb3
+  metadata.gz: f61cd8c90688ed04f5a422ffaa20393de9039766273dd430f62b556fe2e0f7e47185d425e267c88809b871d90aa74d590bfed15270299658a56b936fa1a7f4cc
+  data.tar.gz: 4df5dd0df57f09bc936bc2b23d73be36bbf0056902b03c3b9893650bd5fe77c795698b66052476f379683bf2bc8e53abbd8987a172c6b36bc090333f440fc646

data/.travis.yml

@@ -1,7 +1,7 @@
 sudo: false
 language: ruby
 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

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,80 @@ 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)
+- 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 +112,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/lib/vlc_proxy/configuration.rb

@@ -10,7 +10,7 @@ module VlcProxy
     end
 
     def logger
-      @logger.level = verbose? ? Logger::INFO : Logger::WARN
+      @logger.level = verbose? ? Logger::DEBUG : Logger::INFO
 
       @logger
     end

data/lib/vlc_proxy/connection.rb

@@ -31,7 +31,7 @@ module VlcProxy
       request.basic_auth('', @password)
 
       Net::HTTP.start(uri.hostname, uri.port) do |http|
-        @logger.info('Starting HTTP request')
+        @logger.debug('Starting HTTP request')
         http.request(request)
       end
     end
@@ -63,7 +63,7 @@ module VlcProxy
         base_url += "&#{params}"
       end
 
-      @logger.info("built uri: #{base_url}")
+      @logger.debug("built uri: #{base_url}")
       URI(base_url)
     end
   end

data/lib/vlc_proxy/version.rb

@@ -1,3 +1,3 @@
 module VlcProxy
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vlc_proxy
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Zshawn Syed
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-27 00:00:00.000000000 Z
+date: 2020-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -128,7 +128,6 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,79 +0,0 @@
-PATH
-  remote: .
-  specs:
-    vlc_proxy (0.1.0)
-      nokogiri (>= 1.9.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ansi (1.5.0)
-    ast (2.4.1)
-    coderay (1.1.3)
-    diff-lcs (1.4.4)
-    docile (1.3.2)
-    method_source (0.9.2)
-    mini_portile2 (2.4.0)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
-    parallel (1.19.2)
-    parser (2.7.1.4)
-      ast (~> 2.4.1)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.87.1)
-      parallel (~> 1.10)
-      parser (>= 2.7.1.1)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
-      rexml
-      rubocop-ast (>= 0.1.0, < 1.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.1.0)
-      parser (>= 2.7.0.1)
-    ruby-progressbar (1.10.1)
-    simplecov (0.18.5)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-    simplecov-console (0.7.2)
-      ansi
-      simplecov
-      terminal-table
-    simplecov-html (0.12.2)
-    terminal-table (1.8.0)
-      unicode-display_width (~> 1.1, >= 1.1.1)
-    unicode-display_width (1.7.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  pry (~> 0.12.1)
-  rake (~> 13.0, >= 13.0.1)
-  rspec (~> 3.9)
-  rubocop (~> 0.87.0)
-  simplecov (~> 0.18.5)
-  simplecov-console (~> 0.7.2)
-  vlc_proxy!
-
-BUNDLED WITH
-   2.1.4