sauce_tunnel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cccb75d9ce568ac623ee5fad702a5ca033d319c4
+  data.tar.gz: 75738c6d52e17df9d6d07e2cc40fb7b16fac8528
+SHA512:
+  metadata.gz: 6f4320093a9ff4086f5eb954e9dca3089746c91bd4a51d33819d46cc7fc4b3e82c1939ba45449ef5f2ed5fd690be0d17873e1c1046066e333dc559e054f74106
+  data.tar.gz: cbce1f0569cfb129559836152d620176e007809f6a67ba72ffddfffaf9ca1a27476ee1b4604f6eed5034024e60723e5a5a3e65b8b7fc2c530debcf7a501d4b17

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.7

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 jonas.nicklas@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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sauce_tunnel.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jonas Nicklas
+
+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,67 @@
+# SauceTunnel
+
+This is a Ruby gem which makes it easy to establish a proxy tunnel to
+SauceLabs, via their `sc` command line utility.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sauce_tunnel'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+You'll also want to install the `sc` command line utility. On macOS you
+can do this via homebrew casks, like this:
+
+```
+brew cask install sauce-connect
+```
+
+On other platforms, please see: <https://wiki.saucelabs.com/display/DOCS/Sauce+Connect+Proxy>.
+
+## Usage
+
+You can configure and start a global tunnel like this:
+
+``` ruby
+SauceTunnel.start
+```
+
+This will block and wait until the tunnel is established. It is safe to call
+this method lazily even from multiple threads when you need the tunnel.
+
+If you need to configure the Tunnel, call `config` before calling start like
+this:
+
+``` ruby
+SauceTunnel.config(sc_args: ["-B", "all"])
+SauceTunnel.start
+```
+
+Available options are:
+
+*sc_path:* Location of the `sc` command line utility, defaults to assuming `sc` is in PATH
+*sc_args:* Additional args to pass to `sc`
+*quiet:* If `true` no output will be printed to `stdout`.
+*timeout:* Timeout for establishing the connection to SauceLabs
+*shutdown_timeout:* Timeout for shutting down the tunnel.
+
+You can also instantiate and use a Tunnel manually, but this is not recommended.
+
+``` ruby
+tunnel = SauceTunnel::Tunnel.new(sc_args: ["-B", "all"])
+tunnel.connect # establish connection in the background
+tunnel.await # wait for tunnel to start
+tunnel.terminate # wait for tunnel to shut down
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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 "sauce_tunnel"
+
+# 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

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/sauce_tunnel.rb

@@ -0,0 +1,35 @@
+require "open3"
+require "shellwords"
+
+module SauceTunnel
+  class Error < StandardError; end
+  class ConnectionError < Error; end
+
+  @config = {}
+  @mutex = Mutex.new
+  @tunnel = nil
+
+  class << self
+    def config(**config)
+      @config = config;
+    end
+
+    def start
+      # Wrap establishing Tunnel in Mutex since the Tunnel class is not thread safe.
+      @mutex.synchronize do
+        @tunnel ||= begin
+          Tunnel.new(**@config).tap do |tunnel|
+            at_exit do
+              tunnel.terminate
+            end
+            tunnel.connect
+            tunnel.await
+          end
+        end
+      end
+    end
+  end
+end
+
+require "sauce_tunnel/simple_queue"
+require "sauce_tunnel/tunnel"

data/lib/sauce_tunnel/simple_queue.rb

@@ -0,0 +1,36 @@
+module SauceTunnel
+  # A really basic message queue, which unlike the queue in stdlib makes it
+  # possible to specify a timeout for `pop`.
+  class SimpleQueue
+    def initialize
+      @mutex = Mutex.new
+      @queue = []
+      @received = ConditionVariable.new
+    end
+
+    def push(value)
+      @mutex.synchronize do
+        @queue << value
+        @received.signal
+      end
+    end
+
+    def pop(timeout = nil)
+      @mutex.synchronize do
+        start_time = Time.now
+        loop do
+          if @queue.empty?
+            elapsed_time = Time.now - start_time
+
+            raise ThreadError, "queue empty" if elapsed_time >= timeout
+
+            @received.wait(@mutex, timeout - elapsed_time)
+          else
+            break
+          end
+        end
+        @queue.shift
+      end
+    end
+  end
+end

data/lib/sauce_tunnel/tunnel.rb

@@ -0,0 +1,51 @@
+module SauceTunnel
+  class Tunnel
+    class Error < StandardError; end
+
+    attr_reader :sc_path, :sc_args
+
+    def initialize(sc_path: "sc", sc_args: [], quiet: false, timeout: 120, shutdown_timeout: 20)
+      @sc_path = sc_path
+      @sc_args = sc_args
+      @quiet = quiet
+      @timeout = timeout
+      @shutdown_timeout = shutdown_timeout
+
+      @queue = SauceTunnel::SimpleQueue.new
+      @up = false
+    end
+
+    def connect
+      return if @wait_thread # don't start twice
+
+      @stdin, @stdout, @stderr, @wait_thread = Open3.popen3(Shellwords.join([sc_path] + [sc_args].flatten))
+
+      @read_thread = Thread.new do
+        while line = @stdout.gets
+          puts line unless quiet?
+          @queue.push(true) if line =~ /sauce connect is up/i
+        end
+      end
+    end
+
+    def await
+      @up ||= @queue.pop(@timeout)
+      self
+    rescue ThreadError
+      raise ConnectionError, "timed out trying to establish connection to SauceLabs"
+    end
+
+    def terminate
+      if @wait_thread
+        Process.kill("TERM", @wait_thread.pid)
+        @wait_thread.join(@shutdown_timeout)
+      end
+    rescue Errno::ESRCH
+      # do nothing, tunnel already shut down
+    end
+
+    def quiet?
+      @quiet
+    end
+  end
+end

data/lib/sauce_tunnel/version.rb

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

data/sauce_tunnel.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sauce_tunnel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sauce_tunnel"
+  spec.version       = SauceTunnel::VERSION
+  spec.authors       = ["Jonas Nicklas"]
+  spec.email         = ["jonas.nicklas@gmail.com"]
+
+  spec.summary       = "Estabblish Tunnel to SauceLabs"
+  spec.homepage      = "https://github.com/jnicklas/sauce_tunnel"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: sauce_tunnel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonas Nicklas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- jonas.nicklas@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/sauce_tunnel.rb
+- lib/sauce_tunnel/simple_queue.rb
+- lib/sauce_tunnel/tunnel.rb
+- lib/sauce_tunnel/version.rb
+- sauce_tunnel.gemspec
+homepage: https://github.com/jnicklas/sauce_tunnel
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Estabblish Tunnel to SauceLabs
+test_files: []