RubyGems - forward - Versions diffs - 0.3.3 → 1.0.0 - Mend

forward 0.3.3 → 1.0.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 (44) hide show

checksums.yaml +7 -0
data/.gitignore +2 -0
data/Gemfile +0 -2
data/README.md +24 -0
data/Rakefile +3 -1
data/bin/forward +1 -1
data/forward.gemspec +17 -11
data/lib/forward/api/resource.rb +51 -83
data/lib/forward/api/tunnel.rb +41 -68
data/lib/forward/api/user.rb +14 -11
data/lib/forward/api.rb +7 -26
data/lib/forward/cli.rb +55 -253
data/lib/forward/command/account.rb +69 -0
data/lib/forward/command/base.rb +62 -0
data/lib/forward/command/config.rb +64 -0
data/lib/forward/command/tunnel.rb +178 -0
data/lib/forward/common.rb +44 -0
data/lib/forward/config.rb +75 -118
data/lib/forward/request.rb +72 -0
data/lib/forward/socket.rb +125 -0
data/lib/forward/static/app.rb +157 -0
data/lib/forward/static/directory.erb +142 -0
data/lib/forward/tunnel.rb +102 -40
data/lib/forward/version.rb +1 -1
data/lib/forward.rb +80 -63
data/test/api/resource_test.rb +70 -54
data/test/api/tunnel_test.rb +50 -51
data/test/api/user_test.rb +33 -20
data/test/cli_test.rb +0 -126
data/test/command/account_test.rb +26 -0
data/test/command/tunnel_test.rb +133 -0
data/test/config_test.rb +103 -54
data/test/forward_test.rb +47 -0
data/test/test_helper.rb +35 -26
data/test/tunnel_test.rb +50 -22
metadata +210 -169
data/forwardhq.crt +0 -112
data/lib/forward/api/client_log.rb +0 -20
data/lib/forward/api/tunnel_key.rb +0 -18
data/lib/forward/client.rb +0 -110
data/lib/forward/error.rb +0 -12
data/test/api/tunnel_key_test.rb +0 -28
data/test/api_test.rb +0 -0
data/test/client_test.rb +0 -8

data/lib/forward/static/app.rb ADDED Viewed

@@ -0,0 +1,157 @@
+require 'erb'
+module Forward
+  module Static
+    class TemplateContext
+      FILESIZE_FORMAT = [
+        ['%.1fT', 1 << 40],
+        ['%.1fG', 1 << 30],
+        ['%.1fM', 1 << 20],
+        ['%.1fK', 1 << 10],
+      ]
+      def initialize(root, path_info)
+        @root         = root
+        @project_name = File.basename(root)
+        @path_info    = path_info
+        @path         = File.join(root, path_info)
+      end
+      def path_components
+        @path_info.split('/')[1..-1]
+      end
+      def files
+        _files = []
+        Dir["#{@path}*"].sort.each do |path|
+          _stat = stat(path)
+          next if _stat.nil?
+          basename = File.basename(path)
+          url      = path.sub(@root, '')
+          ext      = File.extname(path)
+          size     = _stat.size
+          type     = _stat.directory? ? 'directory' : Rack::Mime.mime_type(ext)
+          size     = _stat.directory? ? '-' : filesize_format(size)
+          if _stat.directory?
+            url      << '/'
+            basename << '/'
+          end
+          _files << {
+            url: url,
+            basename: basename,
+            size: size,
+            type: type,
+          }
+        end
+        _files
+      end
+      def get_binding
+        binding
+      end
+      private
+      def stat(path)
+        File.stat(path)
+      rescue Errno::ENOENT, Errno::ELOOP
+        nil
+      end
+      def filesize_format(int)
+        FILESIZE_FORMAT.each do |format, size|
+          return format % (int.to_f / size) if int >= size
+        end
+        int.to_s + 'B'
+      end
+    end
+    class App
+      attr_reader :files
+      attr_accessor :root
+      attr_accessor :path
+      def initialize(root, app = nil)
+        @root            = File.expand_path(root)
+        @app             = app || Rack::File.new(@root)
+        @listing_view    = File.read(File.expand_path('../directory.erb', __FILE__))
+      end
+      def call(env)
+        dup._call(env)
+      end
+      def _call(env)
+        @env       = env
+        @path_info = Rack::Utils.unescape(env['PATH_INFO'])
+        if forbidden?
+          render_404
+        else
+          @path = File.join(@root, @path_info)
+          process
+        end
+      end
+      private
+      def forbidden?
+        @path_info =~ /\.\./
+      end
+      def render_directory_listing
+        context = TemplateContext.new(@root, @path_info)
+        body    = ERB.new(@listing_view).result(context.get_binding)
+        [ 200, {'Content-Type' => 'text/html; charset=utf-8'}, [body] ]
+      end
+      def has_index?
+        File.exist?(File.join(@path, 'index.html'))
+      end
+      def process
+        return render_404 unless File.exist?(@path)
+        @stat = File.stat(@path)
+        raise Errno::ENOENT, 'No such file or directory' unless @stat.readable?
+        if @stat.directory?
+          return render_404 unless @path.end_with?('/')
+          return render_directory_listing unless has_index?
+          @env['PATH_INFO'] << 'index.html'
+        end
+        Rack::File.new(@root).call(@env)
+      rescue Errno::ENOENT, Errno::ELOOP => e
+        Forward.logger.debug e
+        Forward.logger.debug e.message
+        render_404
+      end
+      def render_404
+        body    = "Not Found: #{@path_info}\n"
+        headers = {
+          "Content-Type"   => "text/plain",
+          "Content-Length" => Rack::Utils.bytesize(body).to_s,
+          "X-Cascade"      => "pass"
+        }
+        [404, headers, [body]]
+      end
+    end
+  end
+end

data/lib/forward/static/directory.erb ADDED Viewed

@@ -0,0 +1,142 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Directory Listing: <%= @project_name%><%= @path_info %></title>
+    <meta http-equiv="content-kind" content="text/html; charset=utf-8">
+    <link rel="stylesheet" href="https://assets.50east.co/v1.0/css/mark.css">
+    <link rel="stylesheet" href="https://assets.50east.co/v1.0/css/picons.css">
+    <link rel="stylesheet" href="https://assets.50east.co/v1.0/css/core.css">
+    <style kind="text/css">
+      h1 {
+        padding-left: 3rem;
+        text-indent: -1rem;
+        font-size: 1rem;
+        color: #999;
+        cursor: default;
+      }
+      h1 .root {
+        color: #222;
+        font-weight: 600;
+      }
+      h1 a {
+        color: inherit;
+        white-space: nowrap;
+      }
+      a {
+        color: #222;
+      }
+      a:hover {
+        color: #27c166 !important;
+      }
+      table {
+        max-width: 35rem;
+        width: 100%;
+      }
+      td,
+      th {
+        padding: 0.25rem 0 0.5rem;
+      }
+      th {
+        text-align: left;
+        padding-bottom: 1rem;
+        color: #ccc;
+      }
+      td.kind,
+      td.size {
+        color: #555;
+      }
+      .size {
+        text-align: right;
+        padding-right: 1rem;
+      }
+      td.name {
+        position: relative;
+        font-weight: 500;
+      }
+      .file-icon {
+        position: absolute;
+        top: 8px; left: -33px;
+        width: 20px;
+        height: 20px;
+      }
+      *[data-type="file"] .file-icon {
+        background-position: 0% -0.5%;
+      }
+      *[data-type="directory"] .file-icon {
+        top: 10px;
+        left: -34px;
+      }
+      footer p {
+        text-align: left !important;
+      }
+      footer a {
+        color: #27c166 !important;
+      }
+      footer a:hover {
+        border-bottom: 1px solid #ccc;
+      }
+    </style>
+  </head>
+  <body>
+    <div class="page">
+      <h1>
+        <a href="/" class="root"><%= @project_name %></a>
+        <% if path_components%>
+          <% path_components.each_with_index do |part, i| %>
+            /&nbsp;<a href="/<%= path_components[0..i].join('/') %>/"><%= part %></a>
+          <% end %>
+        <% end %>
+      </h1>
+      <section>
+        <table>
+          <thead>
+            <tr>
+              <th class="name">Name</th>
+              <th class="size">Size</th>
+              <th class="kind">Kind</th>
+            </tr>
+          </thead>
+          <tbody>
+            <% files.each do |file| %>
+            <tr>
+              <td class="name"><div class="file-icon"></div><a href="<%= file[:url] %>"><%= file[:basename] %></a></td><td class="size"><%= file[:size] %></td><td class="kind"><%= file[:type] %></td>
+            </tr>
+            <% end %>
+          </tbody>
+        </table>
+      </section>
+      <footer>
+        <p>
+          Brought to you by <a href="https://forwardhq.com/">Forward</a>
+        </p>
+      </footer>
+    </div>
+    <script src="https://assets.50east.co/v1.0/js/core.js"></script>
+    <script>
+    $('td.name').each(function(){
+      var filename = $.trim($(this).text());
+      var row = $(this).closest('tr');
+      row.attr('data-type', FileTypes.getTypeForFilename(filename));
+    });
+    </script>
+  </body>
+</html>

data/lib/forward/tunnel.rb CHANGED Viewed

@@ -1,6 +1,6 @@
 module Forward
   class Tunnel
-    CHECK_INTERVAL = 7
+    include Common
     # The Tunnel resource ID
     attr_reader :id
@@ -8,60 +8,122 @@ module Forward
     attr_reader :subdomain
     # The CNAME for the Tunnel
     attr_reader :cname
-    # The host
+    # The host to forward requests to
     attr_reader :host
-    # The vhost
-    attr_reader :vhost
-    # The hostport (local port)
-    attr_reader :hostport
-    # The remote port
+    # The port to forward requests to
     attr_reader :port
+    # Authentication for tunnel
+    attr_reader :username
+    attr_reader :password
+    attr_reader :no_auth
+    # The public hostname/subdomain url for the tunnel
+    attr_reader :url
     # The tunneler host
     attr_reader :tunneler
     # The timeout
     attr_reader :timeout
-    # The amount of time in seconds the Tunnel has be inactive for
-    attr_accessor :inactive_for
+    attr_reader :socket
+    attr_reader :socket_url
+    attr_reader :requests
+    attr_accessor :last_active_at
     # Initializes a Tunnel instance for the Client and requests a tunnel from
     # API.
     #
     # client - The Client instance.
-    def initialize(options = {})
-      @host         = options[:host]
-      @response     = Forward::Api::Tunnel.create(options)
-      @id           = @response[:_id]
-      @subdomain    = @response[:subdomain]
-      @cname        = @response[:cname]
-      @vhost        = @response[:vhost]
-      @hostport     = @response[:hostport]
-      @port         = @response[:port]
-      @tunneler     = @response[:tunneler_public]
-      @timeout      = @response[:timeout]
-      @inactive_for = 0
+    def initialize(attributes = {})
+      logger.debug "[tunnel] initializing with: #{attributes.inspect}"
+      @attributes       = attributes
+      @id               = attributes[:id]
+      @host             = attributes[:vhost]
+      @port             = attributes[:hostport]
+      @subdomain_prefix = attributes[:subdomain_prefix]
+      @username         = attributes[:username]
+      @password         = attributes[:password]
+      @no_auth          = attributes[:no_auth]
+      @static_path      = attributes[:static_path]
+      @cname            = attributes[:cname]
+      @timeout          = attributes[:timeout]
+      @tunneler         = attributes[:tunneler]
+      @url              = attributes[:url]
+      @requests         = {}
+      @open             = false
+      @socket           = Socket.new(self)
+    end
+    def ready!
+      logger.debug '[tunnel] opened successfully'
+      @open = true
+      copy_url_to_clipboard
+      open_url_in_browser
+      display_ready_message
+    end
+    def open?
+      @open
     end
-    def poll_status
-      Thread.new {
-        loop do
-          if @timeout && !@timeout.zero? && @inactive_for > @timeout
-            Forward.log.debug("Session closing due to inactivity `#{@inactive_for}' seconds")
-            Client.cleanup_and_exit!("Tunnel has been inactive for #{@inactive_for} seconds, exiting...")
-          elsif Forward::Api::Tunnel.show(@id).nil?
-            Client.current.tunnel = nil
-            Forward.log.debug("Tunnel destroyed, closing session")
-            Client.cleanup_and_exit!
-          else
-            sleep CHECK_INTERVAL
-          end
-          @inactive_for += CHECK_INTERVAL
+    def destroy(&block)
+      API::Tunnel.destroy(id, &block)
+    end
+    def authority
+      @authority ||= begin
+        _authority = "#{host}"
+        _authority << ":#{port}" unless port == 80
+        _authority
+      end
+    end
+    def track_activity!
+      self.last_active_at = Time.now.to_i
+    end
+    private
+    def display_ready_message
+      source  = static? ? "Directory `#{File.expand_path(@static_path).split('/').last}'" : authority
+      message = "#{source} is now available at: #{HighLine.color(url, :underline)}"
+      message << " and #{HighLine.color("http://#{cname}", :underline)}" if cname
+      puts "#{message}\n\nCtrl-C to stop forwarding"
+    end
+    def copy_url_to_clipboard
+      return unless config.auto_copy?
+      if windows?
+        begin
+          require 'ffi'
+        rescue LoadError
+          puts "The FFI gem is required to copy your url to the clipboard, you can install it with `gem install ffi'"
+          return
         end
-      }
+      end
+      Clipboard.copy(url)
+    end
+    def open_url_in_browser
+      return unless config.auto_open?
+      case os
+      when :windows
+        %x[start #{url}]
+      when :osx
+        %x[open #{url}]
+      when :unix
+        %x[xdg-open #{url}]
+      end
     end
-    def active?
-      @active
+    def static?
+      !@static_path.nil?
     end
   end

data/lib/forward/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Forward
-  VERSION = '0.3.3'
+  VERSION = '1.0.0'
 end

data/lib/forward.rb CHANGED Viewed

@@ -1,108 +1,125 @@
 require 'base64'
 require 'json'
 require 'logger'
-require 'openssl'
-require 'optparse'
 require 'rbconfig'
-require 'stringio'
-require 'uri'
+require 'fileutils'
+require 'yaml'
+require 'slop'
 require 'highline/import'
-require 'net/ssh'
+require 'eventmachine'
+require 'em-http-request'
+require 'faye/websocket'
+require 'clipboard'
 require 'forward/core_extensions'
-require 'forward/error'
+require 'forward/common'
 require 'forward/api'
 require 'forward/config'
+require 'forward/request'
+require 'forward/socket'
 require 'forward/tunnel'
-require 'forward/client'
 require 'forward/cli'
 require 'forward/version'
 module Forward
-  DEFAULT_SSL      = true
-  DEFAULT_SSH_PORT = 22
-  DEFAULT_SSH_USER = 'tunnel'
-  # Returns either a ssh user set in the environment or a set default.
+  class Error < StandardError; end
+	# An error occurred with the CLI
+	class CLIError < Error; end
+	# An error occurred with the Client
+	class ClientError < Error; end
+	# An error occurred with the Config
+	class ConfigError < Error; end
+	# An error occurred with the Tunnel
+	class TunnelError < Error; end
+  SUPPORT_EMAIL = 'support@forwardhq.com'.freeze
+  # Helper for determining the host OS
   #
-  # Returns a String containing the ssh user.
-  def self.ssh_user
-    ENV['FORWARD_SSH_USER'] || DEFAULT_SSH_USER
-  end
-  # Returns either a ssh port set in the environment or a set default.
+  # Returns simplified and symbolized host os name
+  def self.os
+    @os ||= begin
+      case RbConfig::CONFIG['host_os']
+      when /mswin|mingw|cygwin/
+        :windows
+      when /darwin/
+        :osx
+      when /linux|bsd/
+        :unix
+      else
+        :unknown
+      end
+    end
+  end
+  # Helper to determine if host OS is windows
   #
-  # Returns a String containing the ssh port.
-  def self.ssh_port
-    ENV['FORWARD_SSH_PORT'] || DEFAULT_SSH_PORT
-  end
+  # Returns Boolean
   def self.windows?
-    RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+    @windows ||= os == :windows
   end
-  def self.config=(config)
-    @config = config
+  # Setter for the current Client
+  #
+  # Returns the new Forawrd::Client instance
+  def self.tunnel=(tunnel)
+    @tunnel = tunnel
   end
-  def self.config
-    @config
+  # Getter for the current Client
+  #
+  # Returns a Forward::Client instance
+  def self.tunnel
+    @tunnel
   end
-  def self.client=(client)
-    @client = client
+  # Helper method for making forward quiet (silence most output)
+  def self.quiet!
+    @quiet = true
   end
-  def self.client
-    @client
+  # Helper method for making forward quiet (silence most output)
+  def self.quiet?
+    @quiet == true
   end
+  # Helper method for setting the log level to debug
   def self.debug!
-    @logdev   = STDOUT
-    @debug    = true
-    log.level = Logger::DEBUG
-  end
-  def self.debug?
-    @debug
+    logger.level = Logger::DEBUG
   end
-  def self.stringio_log
-    @stringio_log ||= StringIO.new
-  end
-  def self.debug_remotely!
-    @logdev         = stringio_log
-    @debug          = true
-    @debug_remotely = true
-    log.level       = Logger::DEBUG
-  end
-  def self.debug_remotely?
-    @debug_remotely ||= false
-  end
-  def self.logdev
-    @logdev ||= (windows? ? 'NUL:' : '/dev/null')
+  # Setter for the logger
+  #
+  # Returns the new Logger instance
+  def self.logger=(logger)
+    @logger ||= logger
   end
+  # Getter for the logger
+  #
+  # Returns the new or cached Logger instance
   def self.logger
-    @log ||= Logger.new(logdev)
-  end
+    @logger ||= begin
+      _logger           = Logger.new(STDOUT)
+      _logger.level     = Logger::WARN
+      _logger.formatter = proc do |severity, datetime, progname, msg|
+        "#{severity} - [#{datetime.strftime('%H:%M:%S')}] #{msg}\n"
+      end
-  def self.log
-    logger
+      _logger
+    end
   end
-  # Returns a string representing a detailed client version.
+  # Returns a string representing a detailed client version
   #
-  # Returns a String representing the client.
+  # Returns a String representing the client
   def self.client_string
     os     = RbConfig::CONFIG['host_os']
     engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : 'ruby'
-    "[#{os}]::[#{engine}-#{RUBY_VERSION}]::[ruby-client-#{Forward::VERSION}]"
+    # TODO: make os version more friendly
+    "(#{engine}-#{RUBY_VERSION})(#{os})(v#{Forward::VERSION})"
   end
 end