forward 0.3.0 → 0.3.1

data/README.md

@@ -1,7 +1,36 @@
-1. parse options
-2. pass to client
-3. client gets a session for the user based on stored token/authentication request or asks the user to signup
-4. if account is in good standing client requests a tunnel to be setup
-5. if tunnel is setup, client opens the ssh channel
-6. client starts forwarding traffic
-7. the end
+# Forward
+
+The ruby client for [https://forwardhq.com/](https://forwardhq.com/). Forward gives you a sharable URL for localhost websites/webapps.
+
+## Usage
+
+    > forward <port> [options]
+    > forward <host> [options]
+    > forward <host:port> [options]
+
+    Description:
+
+       Share a server running on localhost:port over the web by tunneling
+       through Forward. A URL is created for each tunnel.
+
+    Simple example:
+
+      # You are developing a Rails site.
+
+      > rails server &
+      > forward 3000
+        Forward created at https://mycompany.fwd.wf
+
+    Assigning a static subdomain prefix:
+
+      > rails server &
+      > forward 3000 myapp
+        Forward created at https://myapp-mycompany.fwd.wf
+
+    Virtual Host example:
+
+      # You are already running something on port 80 that uses
+      # virtual host names.
+
+      > forward mysite.dev
+        Forward created at https://mycompany.fwd.wf

data/lib/forward.rb

@@ -39,6 +39,10 @@ module Forward
     ENV['FORWARD_SSH_PORT'] || DEFAULT_SSH_PORT
   end
 
+  def self.windows?
+    RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+  end
+
   def self.config=(config)
     @config = config
   end
@@ -81,7 +85,7 @@ module Forward
   end
 
   def self.logdev
-    @logdev ||= '/dev/null'
+    @logdev ||= (windows? ? 'NUL:' : '/dev/null')
   end
 
   def self.log

data/lib/forward/cli.rb

@@ -21,9 +21,9 @@ module Forward
 
       > rails server &
       > forward 3000
-        Forward created at https://4ad3f-mycompany.fwd.wf
+        Forward created at https://mycompany.fwd.wf
 
-    Assigning a subdomain prefix:
+    Assigning a static subdomain prefix:
 
       > rails server &
       > forward 3000 myapp
@@ -35,14 +35,14 @@ module Forward
       # virtual host names.
 
       > forward mysite.dev
-        Forward created at https://dh43a-mycompany.fwd.wf
+        Forward created at https://mycompany.fwd.wf
 
     BANNER
 
     # Parse non-published options and remove them from ARGV, then
     # parse published options and update the options Hash with provided
     # options and removes switches from ARGV.
-    def self.parse_cli_options
+    def self.parse_cli_options(args)
       Forward.log.debug("Parsing options")
       options = {}
 
@@ -78,7 +78,7 @@ module Forward
         end
       end
 
-      @opts.parse!
+      @opts.parse!(args)
 
       options
     end
@@ -106,7 +106,7 @@ module Forward
         Forward.log.debug("Forwardfile options: `#{options.inspect}'")
       end
 
-      options.merge!(parse_cli_options)
+      options.merge!(parse_cli_options(args))
 
       forwarded, prefix = args[0..1]
       options[:subdomain_prefix] = prefix unless prefix.nil?
@@ -230,7 +230,7 @@ module Forward
     # Parses various options and arguments, validates everything to ensure
     # we're safe to proceed, and finally passes options to the Client.
     def self.run(args)
-      ::HighLine.use_color = false if Forward::Config.windows?
+      ::HighLine.use_color = false if Forward.windows?
       if ARGV.include?('--debug')
         Forward.debug!
         ARGV.delete('--debug')

data/lib/forward/config.rb

@@ -1,5 +1,4 @@
 require 'fileutils'
-require 'rbconfig'
 require 'yaml'
 
 module Forward
@@ -80,19 +79,12 @@ module Forward
       raise ConfigError, 'Unable to write config file'
     end
 
-    # Shortcut for checking if host os is windows.
-    #
-    # Returns true or false if windows or not.
-    def self.windows?
-      RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
-    end
-
     # Returns the location of the forward ssh private key
     # based on the host os.
     #
     # Returns the String path.
     def self.key_path
-      if windows?
+      if Forward.windows?
         File.join(ENV['HOME'], 'forward', 'key')
       else
         File.join(ENV['HOME'], '.ssh', 'forwardhq.com')
@@ -104,7 +96,7 @@ module Forward
     #
     # Returns the String path.
     def self.config_path
-      if windows?
+      if Forward.windows?
         File.join(ENV['HOME'], 'forward', 'config')
       else
         File.join(ENV['HOME'], '.forward')

data/lib/forward/version.rb

@@ -1,3 +1,3 @@
 module Forward
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/test/cli_test.rb

@@ -51,24 +51,34 @@ describe Forward::CLI do
   end
 
   it 'parses a Forwardfile' do
-    yaml = YAML.dump(:auth => 'username:password')
-    File.open('Forwardfile', 'w') { |f| f.write(yaml) }
+    hash_to_forwardfile(:auth => 'username:password')
 
     options = Forward::CLI.parse_forwardfile
     options.has_key?(:auth).must_equal true
   end
 
   it 'exits if a Forwardfile does not parse to a Hash' do
-    yaml = YAML.dump('username:password')
-    File.open('Forwardfile', 'w') { |f| f.write(yaml) }
+    hash_to_forwardfile('username:password')
 
     lambda {
       dev_null { Forward::CLI.parse_forwardfile }
     }.must_raise SystemExit
   end
 
-  it 'overloads Forwardfile options via commandline' do
-    flunk
+  it 'overloads Forwardfile options via commandline options' do    
+    hash_to_forwardfile(
+      :port             => 8000, 
+      :username         => 'username', 
+      :password         => 'password', 
+      :subdomain_prefix => 'foo'
+    )
+    args    = [ '3000', '-a', 'example:secret', 'bar' ]
+    options = Forward::CLI.parse_args_and_options(args)
+
+    options[:port].must_equal 3000
+    options[:username].must_equal 'example'
+    options[:password].must_equal 'secret'
+    options[:subdomain_prefix].must_equal 'bar'
   end
 
   it 'doesnt exit on valid ports' do
@@ -114,3 +124,8 @@ describe Forward::CLI do
   end
 
 end
+
+def hash_to_forwardfile(hash)
+  yaml = YAML.dump(hash)
+  File.open('Forwardfile', 'w') { |f| f.write(yaml) }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forward
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-22 00:00:00.000000000 Z
+date: 2013-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json