vlc_proxy 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 5e1b0d3e7ac5412726b8ff9d74dc38c00f9128b5
4
+ data.tar.gz: 4e39161521d48a62a363b015c0538386b1b35134
5
+ SHA512:
6
+ metadata.gz: 6ec290b6f41b13c436159d86aaa660c176fdad255dc057f1b8838b06a90cebe7b8b5858bab4db79fd0210016e4fd7bfa64ec5cf09996ec61275a824b361b1414
7
+ data.tar.gz: 6852d3b7355437ba7b7ec532ceecbb7b414f8b98bf54e6b8a35d799c7b310f8602fc1f2845ab0d99c1d0cb424f0829ccdcfb61552fa9b5ea8797f3ec5527f920
data/.gitignore ADDED
@@ -0,0 +1,11 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.travis.yml ADDED
@@ -0,0 +1,7 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.0
5
+ - 2.4.0
6
+ - 2.5.0
7
+ before_install: gem install bundler -v 1.16.2
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at zsyed91@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source 'https://rubygems.org'
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in vlc_proxy.gemspec
6
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 Zshawn Syed
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,43 @@
1
+ # VlcProxy
2
+
3
+ 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.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'vlc_proxy'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install vlc_proxy
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ 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.
30
+
31
+ 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).
32
+
33
+ ## Contributing
34
+
35
+ 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.
36
+
37
+ ## License
38
+
39
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
40
+
41
+ ## Code of Conduct
42
+
43
+ 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 ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "vlc_proxy"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/lib/vlc_proxy.rb ADDED
@@ -0,0 +1,16 @@
1
+ require 'vlc_proxy/version'
2
+ require 'vlc_proxy/configuration'
3
+ require 'vlc_proxy/exceptions'
4
+ require 'vlc_proxy/connection'
5
+ require 'vlc_proxy/client'
6
+
7
+ module VlcProxy
8
+ class << self
9
+ attr_accessor :config
10
+ end
11
+
12
+ def self.configure
13
+ self.config ||= VlcProxy::Configuration.new
14
+ yield config if block_given?
15
+ end
16
+ end
@@ -0,0 +1,72 @@
1
+ require 'vlc_proxy/configuration'
2
+ module VlcProxy
3
+ class Client
4
+ attr_reader :connection
5
+
6
+ def initialize(connection)
7
+ @connection = connection
8
+ @logger = VlcProxy.config.logger
9
+ end
10
+
11
+ def pause_playlist
12
+ request('status', 'pl_pause')
13
+ end
14
+
15
+ def start_playlist
16
+ request('status', 'pl_play')
17
+ end
18
+
19
+ def stop_playlist
20
+ request('status', 'pl_stop')
21
+ end
22
+
23
+ def next_item
24
+ request('status', 'pl_next')
25
+ end
26
+
27
+ def previous_item
28
+ request('status', 'pl_previous')
29
+ end
30
+
31
+ def toggle_repeat
32
+ request('status', 'pl_repeat')
33
+ end
34
+
35
+ def toggle_loop
36
+ request('status', 'pl_loop')
37
+ end
38
+
39
+ def toggle_random
40
+ request('status', 'pl_random')
41
+ end
42
+
43
+ def toggle_fullscreen
44
+ request('status', 'fullscreen')
45
+ end
46
+
47
+ def increase_volume(value)
48
+ request('status', 'volume', val: "+#{value}")
49
+ end
50
+
51
+ def decrease_volume(value)
52
+ request('status', 'volume', val: "-#{value}")
53
+ end
54
+
55
+ def skip_forward(seconds)
56
+ request('status', 'seek', val: "+#{seconds}S")
57
+ end
58
+
59
+ def skip_backward(seconds)
60
+ request('status', 'seek', val: "-#{seconds}S")
61
+ end
62
+
63
+ private
64
+
65
+ def request(action, command = '', parameters = {})
66
+ @connection.execute(action, command, parameters)
67
+ rescue StandardError => e
68
+ @logger.error(e.message)
69
+ raise e
70
+ end
71
+ end
72
+ end
@@ -0,0 +1,21 @@
1
+ require 'logger'
2
+
3
+ module VlcProxy
4
+ class Configuration
5
+ attr_accessor :logger, :verbose
6
+
7
+ def initialize
8
+ @logger = Logger.new(STDOUT)
9
+ @verbose = false
10
+ end
11
+
12
+ def logger
13
+ @logger.level = Logger::INFO if verbose? && !@logger.info?
14
+ @logger
15
+ end
16
+
17
+ def verbose?
18
+ @verbose
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,66 @@
1
+ require 'net/http'
2
+ require 'nokogiri'
3
+
4
+ module VlcProxy
5
+ # When HTTP enabled on VLC, a LUA web server runs in background listening
6
+ # on the specific port on localhost by default. VLC requires setting a
7
+ # password for basic auth as well
8
+ class Connection
9
+ def initialize(hostname, password, port = 8080, scheme = 'http')
10
+ @hostname = hostname
11
+ @password = password
12
+ @port = port
13
+ @scheme = scheme
14
+ @logger = VlcProxy.config.logger
15
+ end
16
+
17
+ # Test if the connection works with the connection parameters
18
+ # Returns true if VLC is running and returns a response on /status
19
+ # Returns false if there are any connection errors
20
+ def connected?
21
+ response = execute('status')
22
+ parse_response(response)
23
+ rescue VlcProxy::AccessDeniedError, Errno::ECONNREFUSED => e
24
+ @logger.error(e.message)
25
+ false
26
+ end
27
+
28
+ def execute(action, command = '', parameters = {})
29
+ uri = build_uri(action, command, parameters)
30
+ request = Net::HTTP::Get.new(uri)
31
+ request.basic_auth('', @password)
32
+
33
+ Net::HTTP.start(uri.hostname, uri.port) do |http|
34
+ @logger.info('Starting HTTP request')
35
+ http.request(request)
36
+ end
37
+ end
38
+
39
+ private
40
+
41
+ def http_success?(response)
42
+ response.code == '200'
43
+ end
44
+
45
+ def http_unauthorized?(response)
46
+ response.code == '401'
47
+ end
48
+
49
+ def parse_response(response)
50
+ return true if http_success?(response)
51
+ raise VlcProxy::AccessDeniedError if http_unauthorized?(response)
52
+ false
53
+ end
54
+
55
+ def build_uri(action, command = '', parameters = {})
56
+ base_url = "#{@scheme}://#{@hostname}:#{@port}/requests/#{action}.xml"
57
+ base_url += "?command=#{command}" unless command.empty?
58
+ unless parameters.empty?
59
+ params = parameters.map { |key, value| "#{key}=#{value}" }.join('&')
60
+ base_url += "&#{params}"
61
+ end
62
+ @logger.info("built uri: #{base_url}")
63
+ URI(base_url)
64
+ end
65
+ end
66
+ end
@@ -0,0 +1,4 @@
1
+ # List of custom Exceptions
2
+ module VlcProxy
3
+ class AccessDeniedError < StandardError; end
4
+ end
@@ -0,0 +1,3 @@
1
+ module VlcProxy
2
+ VERSION = "0.1.0"
3
+ end
data/vlc_proxy.gemspec ADDED
@@ -0,0 +1,35 @@
1
+ lib = File.expand_path('../lib', __FILE__)
2
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+ require 'vlc_proxy/version'
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = 'vlc_proxy'
7
+ spec.version = VlcProxy::VERSION
8
+ spec.authors = ['Zshawn Syed']
9
+ spec.email = ['zsyed91@gmail.com']
10
+
11
+ spec.summary = 'Simple Ruby wrapper around the HTTP server VLC exposes'
12
+ spec.description = 'Simple Ruby wrapper around the HTTP server VLC exposes'
13
+ spec.homepage = 'https://github.com/zsyed91/vlc_proxy'
14
+ spec.license = 'MIT'
15
+
16
+ # Specify which files should be added to the gem when it is released.
17
+ # The `git ls-files -z` loads the files in the RubyGem that have been added
18
+ # into git
19
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
20
+ `git ls-files -z`.split("\x0").reject do |f|
21
+ f.match(%r{^(test|spec|features)/})
22
+ end
23
+ end
24
+ spec.bindir = 'exe'
25
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
26
+ spec.require_paths = ['lib']
27
+
28
+ spec.add_dependency 'nokogiri', '>= 1.9.1'
29
+
30
+ spec.add_development_dependency 'bundler', '~> 1.16'
31
+ spec.add_development_dependency 'rake', '~> 10.0'
32
+ spec.add_development_dependency 'rspec', '~> 3.7'
33
+ spec.add_development_dependency 'pry', '~> 0.12.2'
34
+ spec.add_development_dependency 'simplecov', '~> 0.16.1'
35
+ end
metadata ADDED
@@ -0,0 +1,145 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: vlc_proxy
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Zshawn Syed
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2018-12-26 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: nokogiri
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: 1.9.1
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: 1.9.1
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.16'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.16'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.7'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.7'
69
+ - !ruby/object:Gem::Dependency
70
+ name: pry
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: 0.12.2
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: 0.12.2
83
+ - !ruby/object:Gem::Dependency
84
+ name: simplecov
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: 0.16.1
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: 0.16.1
97
+ description: Simple Ruby wrapper around the HTTP server VLC exposes
98
+ email:
99
+ - zsyed91@gmail.com
100
+ executables: []
101
+ extensions: []
102
+ extra_rdoc_files: []
103
+ files:
104
+ - ".gitignore"
105
+ - ".rspec"
106
+ - ".travis.yml"
107
+ - CODE_OF_CONDUCT.md
108
+ - Gemfile
109
+ - LICENSE.txt
110
+ - README.md
111
+ - Rakefile
112
+ - bin/console
113
+ - bin/setup
114
+ - lib/vlc_proxy.rb
115
+ - lib/vlc_proxy/client.rb
116
+ - lib/vlc_proxy/configuration.rb
117
+ - lib/vlc_proxy/connection.rb
118
+ - lib/vlc_proxy/exceptions.rb
119
+ - lib/vlc_proxy/version.rb
120
+ - vlc_proxy.gemspec
121
+ homepage: https://github.com/zsyed91/vlc_proxy
122
+ licenses:
123
+ - MIT
124
+ metadata: {}
125
+ post_install_message:
126
+ rdoc_options: []
127
+ require_paths:
128
+ - lib
129
+ required_ruby_version: !ruby/object:Gem::Requirement
130
+ requirements:
131
+ - - ">="
132
+ - !ruby/object:Gem::Version
133
+ version: '0'
134
+ required_rubygems_version: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - ">="
137
+ - !ruby/object:Gem::Version
138
+ version: '0'
139
+ requirements: []
140
+ rubyforge_project:
141
+ rubygems_version: 2.6.8
142
+ signing_key:
143
+ specification_version: 4
144
+ summary: Simple Ruby wrapper around the HTTP server VLC exposes
145
+ test_files: []