vagrant-foodshow 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88f6cec9d2f7c57b8a2e92e0bec90135fab7e9a1
+  data.tar.gz: 30e62916d8ec460e30e4cdb16b7dd0752be5cc54
+SHA512:
+  metadata.gz: 374c1b799cc844e393271ac642e34f64dbe48faeb8c3bf4e23d313eeda4f4e45f030e760386e5784eba77bb963e54c323d93de3fbc8dd761fcea8a804c6410df
+  data.tar.gz: 5098467446f496b68312946dc81d077b1ca768c7331cc75ec33246bf6d777e88e0dfb47835d51ae6f359fdb0c79a144d52baa5f4099e62ef5291fa7085e4a31e

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Vagrantfile
+.vagrant

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-foodshow.gemspec
+gemspec
+
+gem 'rake'
+
+group :development do
+  gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git", :tag => "v1.4.3"
+end

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nikita Borzykh
+
+MIT License
+
+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,123 @@
+# Foodshow: Share your [Vagrant](http://vagrantup.com) virtual machine
+
+Vagrant-Foodshow plugin allows you to share tcp ports of your virtual machine via the Internet.
+
+With Vagrant You may show your web application to your colleague, present new feature for your customer and give ssh access to your ops guy.
+
+All tunneling job performed by [Ngrok](http://ngrok.com) backend.
+Ngrok tunnel operates in TCP and HTTP mode. In HTTP tunnel mode ngrok provides access to HTTP requests and server answers, so you can analyze your traffic. TCP mode allows you tunnel any binary protocol like a `ssh` or `postgresql` or whatever you want, but there is no introspection in TCP tunnel.
+
+## Installation
+
+To install this plugin just execute:
+
+```bash
+vagrant plugin install vagrant-foodshow
+```
+
+## Usage&Configuration
+
+First of all you should enable plugin in your `Vagrantfile`:
+```ruby
+config.foodshow.enabled = true
+```
+
+### There are two ways to create a tunnel
+
+##### Call method `foodshow.tunnel` :
+
+```ruby
+...
+config.foodshow.tunnel <host_port>, <protocol>, [options hash]
+...
+```
+
+##### Add `ngrok_proto` parameter to `vm.network` :
+
+```ruby
+...
+config.vm.network :forwarded_port, guest: <guest_port>, host: <host_port>, ngrok_proto: "<protocol>"
+...
+```
+
+Default tunnel protocol is `http+https`. Ngrok supports `http`, `https`, `http+https` and `tcp`. For tcp protocol authtoken is required.
+
+### Simple tunnel example
+
+```ruby
+Vagrant.configure("2") do |config|
+  #Enable foodshow
+  config.foodshow.enabled = true
+  ...
+  # Define vm
+  config.vm.define :web01 do |conf|
+    ...
+    #Just add ngrok_proto parameter to your port forwarding entry
+    conf.vm.network :forwarded_port, guest: 80, host: 8080, ngrok_proto: "http+https"
+    ...
+    end
+end
+```
+
+### Advanced tunnel example
+
+```ruby
+Vagrant.configure("2") do |config|
+  #Enable foodshow
+  config.foodshow.enabled = true
+  config.foodshow.forward_ssh = true
+  ...
+  # Define vms
+  config.vm.define :web01 do |conf|
+    ...
+    conf.vm.network :forwarded_port, guest: 80, host: 8080, ngrok_proto: "http+https"
+    # Don't tunnel ssh for this vm
+    config.foodshow.forward_ssh = false
+    # For this vm we use another token
+    conf.foodshow.authtoken = <sometoken_2>
+    ...
+  end
+  config.vm.define :web02 do |conf|
+    ...
+    conf.vm.network :forwarded_port, guest: 80, host: 8081
+    conf.vm.network :forwarded_port, guest: 389, host: 3389
+    # You may pass some params as tunnel options
+    # This code creates a tunnel http://mycopmanyllc.ngrok.com with basic auth
+    conf.foodshow.tunnel 8081, "http", :httpauth => "foodshow:ngrok" :subdomain => "mycopmanyllc"
+    # And sure you may tunnel any tcp port
+    conf.foodshow.tunnel 3389, "tcp"
+    ...
+  end
+end
+```
+### Options
+
+- Scope *config* means that this option can be set only via `foodshow.<options>`
+- Scope *config+tunnel* means that this option can be set via `foodshow.<options>` and can be can be passed to the `foodshow.tunnel` method as options hash.
+- Scope *tunnel* means that this option can be passed to the `foodshow.tunnel` method
+
+Option | Default | Scope | Purpose
+-------|---------|---------|--------
+`enabled` | `false` |  config | Enable foodshow plugin
+`ngrok_bin` | `~/bin/ngrok` | config+tunnel |  Ngrok binary location (you should put a binary file at this location)
+`forward_ssh` | `false` | config | Automatically search and forward vagrant ssh guest port (authtoken required)
+`timeout` | `10` | config | Max waiting time for establishing tunnel
+`authtoken` | `nil` | config+tunnel | Auth token. Required for TCP tunnels and some functions (Go to [ngrok.com](http://ngrok.com) to get authkey)
+`httpauth` | `nil` | config+tunnel | You may set basic auth for http/https tunnel. Format: `user:password`
+`subdomain` | `nil` | config+tunnel | Custom subdomain for http/https tunnel. URL will be like a http://\<subdomain\>.ngrok.com
+`hostname` | `nil` | config+tunnel | Custom domain for http/https tunnel (Paid feature, see [Pricing & Features](http://ngrok.com/features) on ngrok website )
+`host_ip` | `127.0.0.1` | tunnel | Custom destination ip for tunnel
+`inspect_addr` | `127.0.0.1` | config | Address for traffic inspection
+`inspect_pbase` | `4040` | config | Base port for traffic inspection, other ngrok  processes will use the next available port
+
+# Authors
+
+* Nikita Borzykh (<sample.n@gmail.com>)
+
+## Contributing
+
+1. Fork it ( http://github.com/express42/vagrant-foodshow/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/vagrant-foodshow/action/start.rb

@@ -0,0 +1,50 @@
+module VagrantPlugins
+  module Foodshow
+    module Action
+      class Start
+        def initialize(app,env)
+          @app = app
+        end
+
+        def call(env)
+          @app.call(env)
+
+          return unless env[:machine].config.foodshow.enabled?
+          env[:machine].config.vm.networks.each do |network|
+            if network[0] == :forwarded_port
+              if network[1][:ngrok_proto] or (network[1][:id] == "ssh" && env[:machine].config.foodshow.forward_ssh?)
+
+                if network[1][:id] == "ssh"
+                  network[1][:ngrok_proto] = "tcp"
+                end
+
+                if network[1][:protocol] != "tcp"
+                  env[:ui].error "Can't tunnel port #{network[1][:host]}, only tcp protocol supported. Skipping."
+                  next
+                end
+
+                env[:machine].config.foodshow.tunnel(
+                                                     network[1][:host],
+                                                     network[1][:ngrok_proto],
+                                                     :host  => network[1][:host_ip] || "127.0.0.1",
+                                                    )
+              end
+            end
+          end
+          env[:machine].config.foodshow.tunnels.each do |tunnel|
+            status, message, debug_output = VagrantPlugins::Foodshow::Util::Ngrok.start(env, tunnel)
+
+            if status == 0
+              env[:ui].success "Tunnel from " + message + " to " + tunnel[:host] + ":" + tunnel[:port].to_s
+            elsif status == 1
+              env[:ui].error "Ngrok failed: " + message
+            elsif status == -1
+              env[:ui].error message
+              env[:ui].error "Ngrok output: " + debug_output.join()
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-foodshow/action/stop.rb

@@ -0,0 +1,30 @@
+module VagrantPlugins
+  module Foodshow
+    module Action
+      class Stop
+        def initialize(app,env)
+          @app = app
+        end
+
+        def call(env)
+
+          Dir.glob("#{env[:tmp_path] || '/tmp'}/ngrok-#{env[:machine].id}-*.pid") do |pid_file|
+            ::File.open(pid_file, "r") do |f|
+              begin
+                pid = f.readline().to_i
+                ::Process.kill("TERM",pid)
+                ::File.delete(pid_file)
+              rescue Errno::ESRCH
+                ::File.delete(pid_file)
+              ensure
+                env[:ui].info("ngrok terminated")
+              end
+            end
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-foodshow/config.rb

@@ -0,0 +1,97 @@
+module VagrantPlugins
+  module Foodshow
+    class Config < Vagrant.plugin(2, :config)
+
+      attr_accessor :timeout
+      attr_accessor :enabled
+      attr_accessor :forward_ssh
+
+      attr_accessor :authtoken
+      attr_accessor :hostname
+      attr_accessor :httpauth
+      attr_accessor :subdomain
+      attr_accessor :inspect_addr
+      attr_accessor :inspect_pbase
+
+      attr_reader   :tunnels
+      attr_reader   :ngrok_bin
+
+      def initialize
+        @forward_ssh  = UNSET_VALUE
+        @enabled      = UNSET_VALUE
+        @timeout      = UNSET_VALUE
+        @ngrok_bin    = UNSET_VALUE
+        @inspect_addr = UNSET_VALUE
+        @inspect_port = UNSET_VALUE
+        @tunnels      = []
+
+        #ngrok params
+        @authtoken    = UNSET_VALUE
+        @hostname     = UNSET_VALUE
+        @httpauth     = UNSET_VALUE
+        @subdomain    = UNSET_VALUE
+      end
+
+      def tunnel(port, proto = "http+https", options={})
+        host_hash = {:host => options[:host] || "127.0.0.1"}
+        @tunnels << options.merge(:port => port).merge( :proto => proto).merge(host_hash)
+      end
+
+      def forward_ssh?
+        @forward_ssh
+      end
+
+      def enabled?
+        @enabled
+      end
+
+      def ngrok_bin=(path)
+        @ngrok_bin = ::File.expand_path(path)
+      end
+
+      def validate(machine)
+        errors = _detected_errors
+        unless ::File.executable? @ngrok_bin
+          errors << "You must put ngrok binary to #{@ngrok_bin}.\n"\
+                    "  Go to http://ngrok.com and download ngrok binary.\n"\
+                    "  You can change binary location by changing option foodshow.ngrok_bin.\n\n"\
+                    "  EXAMPLE. Download and unpack ngrok to ~/bin on Mac OS x86_64:\n"\
+                    "  curl -O https://dl.ngrok.com/darwin_amd64/ngrok.zip && unzip ngrok.zip && mkdir -p ~/bin && mv ngrok ~/bin\n\n"\
+                    "  You can read docs at http://github.com/express42/vagrant-foodshow\n"
+        end
+
+        unless @authtoken
+          if @subdomain || @forward_ssh || @hostname
+            errors << "You should set authtoken if you use subdomain/forward_ssh/hostname options"
+          end
+          
+          @tunnels.each do |tunnel|
+
+            unless tunnel[:authtoken]
+              if tunnel[:hostname] || tunnel[:subdomain] || tunnel[:proto] == "tcp"
+                errors << "You should set authtoken if you call foodshow.tunnel with subdomain/hostname/proto=tcp options"
+              end
+            end
+          end
+
+        end
+        
+        { "foodshow" => errors }
+      end
+
+      def finalize!
+        @ngrok_bin = ::File.expand_path('~/bin/ngrok') if @ngrok_bin == UNSET_VALUE
+
+        @enabled       = false            if @enabled      == UNSET_VALUE
+        @forward_ssh   = false            if @forward_ssh  == UNSET_VALUE
+        @timeout       = 10               if @timeout      == UNSET_VALUE
+        @authtoken     = nil              if @authtoken    == UNSET_VALUE
+        @hostname      = nil              if @hostname     == UNSET_VALUE
+        @httpauth      = nil              if @httpauth     == UNSET_VALUE
+        @subdomain     = nil              if @subdomain    == UNSET_VALUE
+        @inspect_addr  = "127.0.0.1"      if @inspect_addr == UNSET_VALUE
+        @inspect_pbase = 4040             if @inspect_port == UNSET_VALUE
+      end
+    end
+  end
+end

data/lib/vagrant-foodshow/plugin.rb

@@ -0,0 +1,36 @@
+require "vagrant-foodshow/action/start.rb"
+require "vagrant-foodshow/action/stop.rb"
+require "vagrant-foodshow/util/ngrok.rb"
+
+module VagrantPlugins
+  module Foodshow
+    class Plugin < Vagrant.plugin("2")
+      name "foodshow"
+      config 'foodshow' do
+        require_relative "config"
+        Config
+      end
+      action_hook :ngrok_start_handler, :machine_action_up do |hook|
+        hook.append(Action::Start)
+      end
+
+      action_hook :ngrok_start_handler, :machine_action_halt do |hook|
+        hook.prepend(Action::Stop)
+      end
+
+      action_hook :ngrok_start_handler, :machine_action_reload do |hook|
+        hook.prepend(Action::Stop)
+        hook.append(Action::Start)
+      end
+
+      action_hook :ngrok_start_handler, :machine_action_suspend do |hook|
+        hook.prepend(Action::Stop)
+      end
+
+      action_hook :ngrok_start_handler, :machine_action_resume do |hook|
+        hook.append(Action::Start)
+      end
+
+    end
+  end
+end

data/lib/vagrant-foodshow/util/ngrok.rb

@@ -0,0 +1,94 @@
+require 'open3'
+require 'timeout'
+require "vagrant-foodshow/util/ngrok_config.rb"
+
+module VagrantPlugins
+  module Foodshow
+    module Util
+      class Ngrok
+        def self.start(env, tunnel)
+          if defined?(@@counter)
+            @@counter += 1
+          else
+            @@counter = 0
+          end
+
+          config        = VagrantPlugins::Foodshow::Util::NgrokConfig.merge_config(env, tunnel)
+          timeout       = config.delete(:timeout)
+          log_file      = config.delete(:log_file)
+          pid_file      = config.delete(:pid_file)
+          inspect_addr  = config.delete(:inspect_addr)
+          authtoken     = config.delete(:authtoken)
+          inspect_pbase = config.delete(:inspect_pbase)
+          config_file   = config[:config]
+          
+          cmd           = VagrantPlugins::Foodshow::Util::NgrokConfig.build_cmd(config)
+
+          begin
+            current_pid=-1
+            ::File.open(pid_file) { |pid| current_pid = pid.readline(); }
+            Process.getpgid(current_pid.to_i)
+            return 0, "Ngrok already running at pid #{current_pid}. Skipping tunnel", ""
+          rescue
+          end
+
+          ::File.open(config_file, "w") do |conf_h|
+
+            conf_h.write("inspect_addr: #{inspect_addr.to_s}:#{inspect_pbase.to_i + @@counter}\n")
+
+            if authtoken
+              conf_h.write("auth_token: #{authtoken}\n")
+            end
+
+          end
+
+          pid = spawn(cmd, :out => log_file.to_s)
+
+          ::File.open(pid_file, "w") { |pid_h| pid_h.write(pid) }
+
+          log_h = ::File.open(log_file, "r")
+          status, message, debug_output = parse_log(log_h, timeout)
+          log_h.close
+
+          unless status == 0
+            begin
+              ::File.delete(pid_file)
+              ::Process.kill("TERM", pid)
+            rescue
+            end
+          end
+
+          return status, message, debug_output
+        end
+
+        private
+
+        def self.parse_log(log_h, timeout)
+          debug_output = []
+          begin
+            timeout(timeout.to_i) do
+              while true do
+                begin
+                  stdout_str = log_h.readline()
+                rescue
+                  next
+                end
+                debug_output << stdout_str
+
+                if stdout_str.include? "[INFO] [client] Tunnel established at"
+                  return 0, stdout_str[/(http\:\/\/|https\:\/\/|tcp\:\/\/).+/], debug_output
+                end
+
+                if stdout_str.include? "[EROR]"
+                  return 1, stdout_str, debug_output
+                end
+              end
+            end
+          rescue ::Timeout::Error
+            return -1, "Ngrok wait timeout. See ngrok output:", debug_output
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-foodshow/util/ngrok_config.rb

@@ -0,0 +1,46 @@
+module VagrantPlugins
+  module Foodshow
+    module Util
+      class NgrokConfig
+        NGROK_ALLOWED_OPTIONS = %w(authtoken hostname httpauth proto subdomain host port)
+
+        def self.build_cmd(config)
+          cmd  = config.delete(:ngrok_bin) + " -log=stdout"
+          host = config.delete(:host)
+          port = config.delete(:port)
+
+          config.each_pair do |opt, val|
+            cmd = cmd + " -" + opt.to_s + "=" + val.to_s
+          end
+
+          cmd = cmd + " " + host + ":" + port.to_s
+        end
+
+        def self.merge_config(env, tunnel)
+          config = {}
+          foodshow_config = env[:machine].config.foodshow
+
+          config[:ngrok_bin]     = foodshow_config.ngrok_bin     if foodshow_config.ngrok_bin
+          config[:timeout]       = foodshow_config.timeout       if foodshow_config.timeout
+
+          config[:authtoken]     = foodshow_config.authtoken     if foodshow_config.authtoken
+          config[:hostname]      = foodshow_config.hostname      if foodshow_config.hostname
+          config[:httpauth]      = foodshow_config.httpauth      if foodshow_config.httpauth
+          config[:subdomain]     = foodshow_config.subdomain     if foodshow_config.subdomain
+          config[:inspect_addr]  = foodshow_config.inspect_addr  if foodshow_config.inspect_addr
+          config[:inspect_pbase] = foodshow_config.inspect_pbase if foodshow_config.inspect_pbase
+
+          tunnel.keys.each do |key|
+            raise unless NGROK_ALLOWED_OPTIONS.include? key.to_s
+          end
+          config.merge!(tunnel)
+
+          config[:config]   = (env[:tmp_path] || "/tmp") + ("ngrok-" + env[:machine].id + "-" + config[:port].to_s + ".cfg")
+          config[:log_file] = (env[:tmp_path] || "/tmp") + ("ngrok-" + env[:machine].id + "-" + config[:port].to_s + ".log")
+          config[:pid_file] = (env[:tmp_path] || "/tmp") + ("ngrok-" + env[:machine].id + "-" + config[:port].to_s + ".pid")
+          config
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-foodshow/version.rb

@@ -0,0 +1,5 @@
+module Vagrant
+  module Foodshow
+    VERSION = "0.0.4"
+  end
+end

data/lib/vagrant-foodshow.rb

@@ -0,0 +1,6 @@
+require "vagrant-foodshow/version"
+require "vagrant-foodshow/plugin"
+module Vagrant
+  module Foodshow
+  end
+end

data/vagrant-foodshow.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vagrant-foodshow/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-foodshow"
+  spec.version       = Vagrant::Foodshow::VERSION
+  spec.authors       = ["Nikita Borzykh"]
+  spec.email         = ["sample.n@gmail.com"]
+  spec.summary       = %q{You can share your vagrant vm with your colleagues easily by using vagrant-foodshow}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/express42/vagrant-foodshow"
+  spec.license       = "MIT"
+
+  spec.rubyforge_project = "vagrant-foodshow"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-foodshow
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Nikita Borzykh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: You can share your vagrant vm with your colleagues easily by using vagrant-foodshow
+email:
+- sample.n@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/vagrant-foodshow.rb
+- lib/vagrant-foodshow/action/start.rb
+- lib/vagrant-foodshow/action/stop.rb
+- lib/vagrant-foodshow/config.rb
+- lib/vagrant-foodshow/plugin.rb
+- lib/vagrant-foodshow/util/ngrok.rb
+- lib/vagrant-foodshow/util/ngrok_config.rb
+- lib/vagrant-foodshow/version.rb
+- vagrant-foodshow.gemspec
+homepage: https://github.com/express42/vagrant-foodshow
+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: vagrant-foodshow
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: You can share your vagrant vm with your colleagues easily by using vagrant-foodshow
+test_files: []