RubyGems - devproxy - Versions diffs - 0.1.0 → 0.2.0 - Mend

devproxy 0.1.0 → 0.2.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.

Files changed (15) hide show

data/.travis.yml ADDED Viewed

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.8.7
+  - ree

data/Gemfile CHANGED Viewed

@@ -1,3 +1,6 @@
 source 'https://rubygems.org'
 gemspec
+gem "rake"
+gem "travis-lint"

data/Rakefile CHANGED Viewed

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

data/data/css/style.css ADDED Viewed

@@ -0,0 +1,21 @@
+body {
+  text-align: center;
+}
+.details {
+  width: 100%;
+}
+.details table {
+  margin: auto;
+  font-size: 30px;
+  border-collapse: collapse;
+}
+.details table tr:nth-child(odd) {
+  background-color: #efefef;
+}
+.details table td {
+  padding: 5px;
+}

data/devproxy.gemspec CHANGED Viewed

@@ -11,6 +11,7 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{https://devproxy.io client gem}
   gem.description   = %q{https://devproxy.io client gem}
   gem.homepage      = "https://github.com/boz/devproxy"
+  gem.license       = "MIT"
   gem.add_dependency "net-ssh", "~> 2.6.7"
   gem.add_development_dependency "rspec"

data/lib/devproxy/cli/server.rb ADDED Viewed

@@ -0,0 +1,63 @@
+require 'webrick'
+require 'cgi'
+class Devproxy::CLI::Server < WEBrick::HTTPServer
+  class Servlet < WEBrick::HTTPServlet::AbstractServlet
+    def do_GET(request,response)
+      token   = request.cookies.detect { |x| x.name == "DEVPROXY" }
+      token &&= token.value
+      token ||= "NONE"
+      sysname = "#{%x{whoami}}@#{%x{hostname}}"
+      response.status          = 200
+      response['Content-Type'] = "text/html"
+      response.body = %{
+        <html>
+        <head>
+          <link rel="stylesheet" href="/css/style.css">
+          <title>Devproxy Test Server</title>
+        </head>
+        <body>
+          <h1>Hello from #{h(sysname)}</h2>
+          <div class="details">
+            <table>
+              <caption>Tunnel Details</caption>
+              <tbody>
+                <tr>
+                  <td>host</td><td>#{h(request.host)}</td>
+                </tr>
+                <tr>
+                  <td>protocol</td><td>#{h(request['x-forwarded-proto'])}</td>
+                </tr>
+                <tr>
+                  <td>token</td><td>#{h(token)}</td>
+                </tr>
+              </tbody>
+            </table>
+          </div>
+        </body>
+        </html>
+      }
+    end
+    def h(str)
+      CGI::escape_html(str)
+    end
+  end
+  def initialize(*args)
+    super
+    mount "/"   , Servlet
+    mount "/css", WEBrick::HTTPServlet::FileHandler, File.join(File.dirname(__FILE__),"..","..","..","data","css")
+  end
+  def start(*args)
+    @mutex  ||= Mutex.new
+    @thread ||= Thread.new do
+      super(*args)
+    end
+  end
+  def shutdown
+    @mutex.synchronize do
+      super
+    end if @mutex
+  end
+end

data/lib/devproxy/cli.rb CHANGED Viewed

@@ -1,10 +1,54 @@
 require 'devproxy/connection'
 require 'devproxy/options'
 require 'optparse'
 module Devproxy
   class CLI < Devproxy::Connection
+    class Options < Devproxy::Options
+      attr_accessor(:test)
+    end
+    autoload :Server, 'devproxy/cli/server'
+    def initialize *args
+      super(*args)
+      initialize_test_server
+    end
+    def loop!
+      start_test_server
+      super
+    end
+    def stop!
+      stop_test_server
+      super
+    end
+    protected
+    def testing?
+      options.test
+    end
+    def initialize_test_server
+      return unless testing?
+      @test_server = Server.new({
+        :Port        => options.port,
+        :BindAddress => options.listen,
+      })
+    end
+    def start_test_server
+      return unless testing?
+      @test_server.start
+    end
+    def stop_test_server
+      return unless testing?
+      @test_server.stop
+    end
     def self.parse(argv)
-      options = Devproxy::Options::default
+      options = Options::default
       opts    = OptionParser.new
       opts.banner = "Usage: devproxy user [proxy] [options...]"
@@ -21,7 +65,20 @@ module Devproxy
         options.port = x
       end
+      opts.on "--test-server", "Launch local server for testing" do |x|
+        options.test = true
+      end
+      opts.on "-v", "--verbose",
+              "Verbose output (default: #{options.verbose})" do |x|
+        options.verbose = true
+      end
       if ENV['DEVPROXY_DEVELOPMENT']
+        opts.on "-l ADDRESS", "--listen ADDRESS",
+                "Local address to listen on (default: #{options.listen})" do |x|
+          options.listen = x
+        end
         opts.on "--host HOST", "remote hostname." do |x|
           options.host = x
         end

data/lib/devproxy/connection.rb CHANGED Viewed

@@ -5,6 +5,7 @@ module Devproxy
   class Connection
     class Error                 < StandardError; end
     class Error::Authentication < Error        ; end
+    HEARTBEAT = "HEARTBEAT"
     attr_reader :options, :ssh
@@ -28,15 +29,27 @@ module Devproxy
       @halt
     end
-    def on_stdout data
-      $stdout.write data
+    def on_connected
+      $stdout.puts "Tunneling requests from https://#{options.proxy}.devproxy.io to #{options.listen} port #{options.port}"
+    end
+    def on_heartbeat data
+      return unless options.verbose
+      $stdout.write "."
       if (@dotno += 1) % MAX_DOTS == 0
         $stdout.write "\n"
       end
     end
+    def on_stdout data
+      $stdout.write("\n") if options.verbose
+      $stdout.puts(data)
+      reset_dots!
+    end
     def on_stderr data
-      $stderr.puts "\nError: #{data}"
+      $stdout.write("\n") if options.verbose
+      $stderr.puts(data)
       reset_dots!
     end
@@ -56,10 +69,14 @@ module Devproxy
     def self.create(options)
       ssh        = open_ssh(options)
       connection = new(options,ssh)
-      ssh.forward.remote(options.port,"localhost",0,'0.0.0.0')
+      ssh.forward.remote(options.port,options.listen,0,'0.0.0.0')
       channel    = ssh.exec(options.proxy) do |ch,stream,data|
         if stream == :stdout
-          connection.on_stdout(data)
+          if data.start_with?(HEARTBEAT)
+            connection.on_heartbeat(data)
+          else
+            connection.on_stdout(data)
+          end
         else
           connection.on_stderr(data)
         end
@@ -67,6 +84,7 @@ module Devproxy
       channel.on_close do
         connection.on_close
       end
+      connection.on_connected
       connection
     rescue Net::SSH::AuthenticationFailed
       raise Error::Authentication, "Authentication Failed: Invalid username or SSH key"
@@ -74,6 +92,7 @@ module Devproxy
     def self.open_ssh(options)
       Net::SSH.start(options.host, options.username,{
         :port => options.remote_port,
+        :user_known_hosts_file => "/dev/null",
       })
     end
   end

data/lib/devproxy/options.rb CHANGED Viewed

@@ -1,7 +1,7 @@
 module Devproxy
-  class Options < Struct.new(:user, :proxy, :port, :host, :remote_port)
+  class Options < Struct.new(:user, :proxy, :port, :host, :remote_port, :listen, :verbose)
     def username
-      "devproxy-#{user}"
+      "devproxy-#{user}" if !!user && !user.empty?
     end
     def valid?
       !( user.nil?  || user.empty?      ||
@@ -14,6 +14,8 @@ module Devproxy
       default.host        = "ssh.devproxy.io"
       default.remote_port = 2222
       default.port        = 3000
+      default.listen      = "0.0.0.0"
+      default.verbose     = false
       default
     end
   end

data/lib/devproxy/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Devproxy
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/readme.md CHANGED Viewed

@@ -1,4 +1,4 @@
-# Devproxy
+# Devproxy [![Build Status](https://travis-ci.org/boz/devproxy.png?branch=master)](https://travis-ci.org/boz/devproxy)
 [devproxy.io](https://devproxy.io) client used for tunneling
 connections from a public domain (`https://example.devproxy.io`) to your

data/spec/cli_spec.rb ADDED Viewed

@@ -0,0 +1,33 @@
+require 'spec_helper'
+describe Devproxy::CLI do
+  describe "#parse" do
+    it "should default the proxy to the given name" do
+      options = parse("foo")
+      expect(options.user).to  eq("foo")
+      expect(options.proxy).to eq("foo")
+    end
+    it "should accept a different proxy name" do
+      options = parse("foo","bar")
+      expect(options.user).to  eq("foo")
+      expect(options.proxy).to eq("bar")
+    end
+    it "should parse the port option" do
+      expect(parse("foo","bar","-p"    ,"20").port).to eq(20)
+      expect(parse("foo","bar","--port","20").port).to eq(20)
+      expect(parse("foo","bar"              ).port).to eq(Devproxy::Options.default.port)
+    end
+    it "should parse the test server option" do
+      expect(parse("foo","bar","--test-server").test).to be_true
+      expect(parse("foo","bar"                ).test).to be_false
+    end
+    it "should parse the verbose option" do
+      expect(parse("foo","bar","-v"       ).verbose).to be_true
+      expect(parse("foo","bar","--verbose").verbose).to be_true
+      expect(parse("foo","bar"            ).verbose).to be_false
+    end
+  end
+  def parse(*args)
+    Devproxy::CLI::parse(args)
+  end
+end

data/spec/options_spec.rb ADDED Viewed

@@ -0,0 +1,47 @@
+require 'spec_helper'
+describe Devproxy::Options do
+  describe "defaults" do
+    it "should have default values" do
+      options = default_options
+      expect(options.host        ).to eq("ssh.devproxy.io")
+      expect(options.remote_port ).to eq(2222)
+      expect(options.port        ).to eq(3000)
+      expect(options.listen      ).to eq("0.0.0.0")
+      expect(options.verbose     ).to eq(false)
+    end
+    it "should not have username or proxy" do
+      options = default_options
+      expect(options.username).to be_nil
+      expect(options.proxy   ).to be_nil
+    end
+  end
+  describe "valid?" do
+    it "should require a username" do
+      expect(default_options(:proxy => "foo")).to_not be_valid
+    end
+    it "should require a username" do
+      expect(default_options(:user => "bar")).to_not be_valid
+    end
+    it "should only need a username and proxy" do
+      expect(default_options(:proxy => "foo", :user => "bar")).to be_valid
+    end
+  end
+  describe "username" do
+    it "should include name" do
+      expect(default_options(:user => "bar").username).to include("bar")
+    end
+    it "should be nil if no name is given" do
+      expect(default_options.username).to be_nil
+    end
+  end
+  def default_options(options = {})
+    default = Devproxy::Options.default
+    options.each do |key,value|
+      default.__send__("#{key}=",value)
+    end
+    default
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,3 @@
+require 'devproxy'
+RSpec.configure do
+end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devproxy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2013-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -52,20 +52,27 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - Rakefile
 - bin/devproxy
+- data/css/style.css
 - devproxy.gemspec
 - lib/devproxy.rb
 - lib/devproxy/cli.rb
+- lib/devproxy/cli/server.rb
 - lib/devproxy/connection.rb
 - lib/devproxy/net-ssh-patch.rb
 - lib/devproxy/options.rb
 - lib/devproxy/version.rb
 - readme.md
+- spec/cli_spec.rb
+- spec/options_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/boz/devproxy
-licenses: []
+licenses:
+- MIT
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -76,16 +83,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -760381207862352631
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -760381207862352631
 requirements: []
 rubyforge_project:
 rubygems_version: 1.8.25
 signing_key:
 specification_version: 3
 summary: https://devproxy.io client gem
-test_files: []
+test_files:
+- spec/cli_spec.rb
+- spec/options_spec.rb
+- spec/spec_helper.rb