sauce_tunnel 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: cccb75d9ce568ac623ee5fad702a5ca033d319c4
4
+ data.tar.gz: 75738c6d52e17df9d6d07e2cc40fb7b16fac8528
5
+ SHA512:
6
+ metadata.gz: 6f4320093a9ff4086f5eb954e9dca3089746c91bd4a51d33819d46cc7fc4b3e82c1939ba45449ef5f2ed5fd690be0d17873e1c1046066e333dc559e054f74106
7
+ data.tar.gz: cbce1f0569cfb129559836152d620176e007809f6a67ba72ffddfffaf9ca1a27476ee1b4604f6eed5034024e60723e5a5a3e65b8b7fc2c530debcf7a501d4b17
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.3
5
+ before_install: gem install bundler -v 1.13.7
@@ -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 jonas.nicklas@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,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in sauce_tunnel.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Jonas Nicklas
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,67 @@
1
+ # SauceTunnel
2
+
3
+ This is a Ruby gem which makes it easy to establish a proxy tunnel to
4
+ SauceLabs, via their `sc` command line utility.
5
+
6
+ ## Installation
7
+
8
+ Add this line to your application's Gemfile:
9
+
10
+ ```ruby
11
+ gem 'sauce_tunnel'
12
+ ```
13
+
14
+ And then execute:
15
+
16
+ ```
17
+ $ bundle
18
+ ```
19
+
20
+ You'll also want to install the `sc` command line utility. On macOS you
21
+ can do this via homebrew casks, like this:
22
+
23
+ ```
24
+ brew cask install sauce-connect
25
+ ```
26
+
27
+ On other platforms, please see: <https://wiki.saucelabs.com/display/DOCS/Sauce+Connect+Proxy>.
28
+
29
+ ## Usage
30
+
31
+ You can configure and start a global tunnel like this:
32
+
33
+ ``` ruby
34
+ SauceTunnel.start
35
+ ```
36
+
37
+ This will block and wait until the tunnel is established. It is safe to call
38
+ this method lazily even from multiple threads when you need the tunnel.
39
+
40
+ If you need to configure the Tunnel, call `config` before calling start like
41
+ this:
42
+
43
+ ``` ruby
44
+ SauceTunnel.config(sc_args: ["-B", "all"])
45
+ SauceTunnel.start
46
+ ```
47
+
48
+ Available options are:
49
+
50
+ *sc_path:* Location of the `sc` command line utility, defaults to assuming `sc` is in PATH
51
+ *sc_args:* Additional args to pass to `sc`
52
+ *quiet:* If `true` no output will be printed to `stdout`.
53
+ *timeout:* Timeout for establishing the connection to SauceLabs
54
+ *shutdown_timeout:* Timeout for shutting down the tunnel.
55
+
56
+ You can also instantiate and use a Tunnel manually, but this is not recommended.
57
+
58
+ ``` ruby
59
+ tunnel = SauceTunnel::Tunnel.new(sc_args: ["-B", "all"])
60
+ tunnel.connect # establish connection in the background
61
+ tunnel.await # wait for tunnel to start
62
+ tunnel.terminate # wait for tunnel to shut down
63
+ ```
64
+
65
+ ## License
66
+
67
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
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 "sauce_tunnel"
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
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
@@ -0,0 +1,35 @@
1
+ require "open3"
2
+ require "shellwords"
3
+
4
+ module SauceTunnel
5
+ class Error < StandardError; end
6
+ class ConnectionError < Error; end
7
+
8
+ @config = {}
9
+ @mutex = Mutex.new
10
+ @tunnel = nil
11
+
12
+ class << self
13
+ def config(**config)
14
+ @config = config;
15
+ end
16
+
17
+ def start
18
+ # Wrap establishing Tunnel in Mutex since the Tunnel class is not thread safe.
19
+ @mutex.synchronize do
20
+ @tunnel ||= begin
21
+ Tunnel.new(**@config).tap do |tunnel|
22
+ at_exit do
23
+ tunnel.terminate
24
+ end
25
+ tunnel.connect
26
+ tunnel.await
27
+ end
28
+ end
29
+ end
30
+ end
31
+ end
32
+ end
33
+
34
+ require "sauce_tunnel/simple_queue"
35
+ require "sauce_tunnel/tunnel"
@@ -0,0 +1,36 @@
1
+ module SauceTunnel
2
+ # A really basic message queue, which unlike the queue in stdlib makes it
3
+ # possible to specify a timeout for `pop`.
4
+ class SimpleQueue
5
+ def initialize
6
+ @mutex = Mutex.new
7
+ @queue = []
8
+ @received = ConditionVariable.new
9
+ end
10
+
11
+ def push(value)
12
+ @mutex.synchronize do
13
+ @queue << value
14
+ @received.signal
15
+ end
16
+ end
17
+
18
+ def pop(timeout = nil)
19
+ @mutex.synchronize do
20
+ start_time = Time.now
21
+ loop do
22
+ if @queue.empty?
23
+ elapsed_time = Time.now - start_time
24
+
25
+ raise ThreadError, "queue empty" if elapsed_time >= timeout
26
+
27
+ @received.wait(@mutex, timeout - elapsed_time)
28
+ else
29
+ break
30
+ end
31
+ end
32
+ @queue.shift
33
+ end
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,51 @@
1
+ module SauceTunnel
2
+ class Tunnel
3
+ class Error < StandardError; end
4
+
5
+ attr_reader :sc_path, :sc_args
6
+
7
+ def initialize(sc_path: "sc", sc_args: [], quiet: false, timeout: 120, shutdown_timeout: 20)
8
+ @sc_path = sc_path
9
+ @sc_args = sc_args
10
+ @quiet = quiet
11
+ @timeout = timeout
12
+ @shutdown_timeout = shutdown_timeout
13
+
14
+ @queue = SauceTunnel::SimpleQueue.new
15
+ @up = false
16
+ end
17
+
18
+ def connect
19
+ return if @wait_thread # don't start twice
20
+
21
+ @stdin, @stdout, @stderr, @wait_thread = Open3.popen3(Shellwords.join([sc_path] + [sc_args].flatten))
22
+
23
+ @read_thread = Thread.new do
24
+ while line = @stdout.gets
25
+ puts line unless quiet?
26
+ @queue.push(true) if line =~ /sauce connect is up/i
27
+ end
28
+ end
29
+ end
30
+
31
+ def await
32
+ @up ||= @queue.pop(@timeout)
33
+ self
34
+ rescue ThreadError
35
+ raise ConnectionError, "timed out trying to establish connection to SauceLabs"
36
+ end
37
+
38
+ def terminate
39
+ if @wait_thread
40
+ Process.kill("TERM", @wait_thread.pid)
41
+ @wait_thread.join(@shutdown_timeout)
42
+ end
43
+ rescue Errno::ESRCH
44
+ # do nothing, tunnel already shut down
45
+ end
46
+
47
+ def quiet?
48
+ @quiet
49
+ end
50
+ end
51
+ end
@@ -0,0 +1,3 @@
1
+ module SauceTunnel
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,26 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'sauce_tunnel/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "sauce_tunnel"
8
+ spec.version = SauceTunnel::VERSION
9
+ spec.authors = ["Jonas Nicklas"]
10
+ spec.email = ["jonas.nicklas@gmail.com"]
11
+
12
+ spec.summary = "Estabblish Tunnel to SauceLabs"
13
+ spec.homepage = "https://github.com/jnicklas/sauce_tunnel"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
17
+ f.match(%r{^(test|spec|features)/})
18
+ end
19
+ spec.bindir = "exe"
20
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
21
+ spec.require_paths = ["lib"]
22
+
23
+ spec.add_development_dependency "bundler", "~> 1.13"
24
+ spec.add_development_dependency "rake", "~> 10.0"
25
+ spec.add_development_dependency "rspec", "~> 3.0"
26
+ end
metadata ADDED
@@ -0,0 +1,101 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: sauce_tunnel
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Jonas Nicklas
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-04-12 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.13'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.13'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ description:
56
+ email:
57
+ - jonas.nicklas@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".rspec"
64
+ - ".travis.yml"
65
+ - CODE_OF_CONDUCT.md
66
+ - Gemfile
67
+ - LICENSE.txt
68
+ - README.md
69
+ - Rakefile
70
+ - bin/console
71
+ - bin/setup
72
+ - lib/sauce_tunnel.rb
73
+ - lib/sauce_tunnel/simple_queue.rb
74
+ - lib/sauce_tunnel/tunnel.rb
75
+ - lib/sauce_tunnel/version.rb
76
+ - sauce_tunnel.gemspec
77
+ homepage: https://github.com/jnicklas/sauce_tunnel
78
+ licenses:
79
+ - MIT
80
+ metadata: {}
81
+ post_install_message:
82
+ rdoc_options: []
83
+ require_paths:
84
+ - lib
85
+ required_ruby_version: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ required_rubygems_version: !ruby/object:Gem::Requirement
91
+ requirements:
92
+ - - ">="
93
+ - !ruby/object:Gem::Version
94
+ version: '0'
95
+ requirements: []
96
+ rubyforge_project:
97
+ rubygems_version: 2.5.2
98
+ signing_key:
99
+ specification_version: 4
100
+ summary: Estabblish Tunnel to SauceLabs
101
+ test_files: []