vlc_proxy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e1b0d3e7ac5412726b8ff9d74dc38c00f9128b5
+  data.tar.gz: 4e39161521d48a62a363b015c0538386b1b35134
+SHA512:
+  metadata.gz: 6ec290b6f41b13c436159d86aaa660c176fdad255dc057f1b8838b06a90cebe7b8b5858bab4db79fd0210016e4fd7bfa64ec5cf09996ec61275a824b361b1414
+  data.tar.gz: 6852d3b7355437ba7b7ec532ceecbb7b414f8b98bf54e6b8a35d799c7b310f8602fc1f2845ab0d99c1d0cb424f0829ccdcfb61552fa9b5ea8797f3ec5527f920

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at zsyed91@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in vlc_proxy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Zshawn Syed
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vlc_proxy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vlc_proxy
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vlc_proxy"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/vlc_proxy.rb

@@ -0,0 +1,16 @@
+require 'vlc_proxy/version'
+require 'vlc_proxy/configuration'
+require 'vlc_proxy/exceptions'
+require 'vlc_proxy/connection'
+require 'vlc_proxy/client'
+
+module VlcProxy
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= VlcProxy::Configuration.new
+    yield config if block_given?
+  end
+end

data/lib/vlc_proxy/client.rb

@@ -0,0 +1,72 @@
+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

data/lib/vlc_proxy/configuration.rb

@@ -0,0 +1,21 @@
+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

data/lib/vlc_proxy/connection.rb

@@ -0,0 +1,66 @@
+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

data/lib/vlc_proxy/exceptions.rb

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

data/lib/vlc_proxy/version.rb

@@ -0,0 +1,3 @@
+module VlcProxy
+  VERSION = "0.1.0"
+end

data/vlc_proxy.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vlc_proxy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vlc_proxy'
+  spec.version       = VlcProxy::VERSION
+  spec.authors       = ['Zshawn Syed']
+  spec.email         = ['zsyed91@gmail.com']
+
+  spec.summary       = 'Simple Ruby wrapper around the HTTP server VLC exposes'
+  spec.description   = 'Simple Ruby wrapper around the HTTP server VLC exposes'
+  spec.homepage      = 'https://github.com/zsyed91/vlc_proxy'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # 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)/})
+    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'
+
+  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'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: vlc_proxy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zshawn Syed
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+description: Simple Ruby wrapper around the HTTP server VLC exposes
+email:
+- zsyed91@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/vlc_proxy.rb
+- lib/vlc_proxy/client.rb
+- lib/vlc_proxy/configuration.rb
+- lib/vlc_proxy/connection.rb
+- lib/vlc_proxy/exceptions.rb
+- lib/vlc_proxy/version.rb
+- vlc_proxy.gemspec
+homepage: https://github.com/zsyed91/vlc_proxy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Simple Ruby wrapper around the HTTP server VLC exposes
+test_files: []