terminus 0.3.0 → 0.4.0

data/lib/terminus/client.rb

@@ -0,0 +1,43 @@
+module Terminus
+  module Client
+    
+    autoload :Browser,    ROOT + '/terminus/client/browser'
+    autoload :PhantomJS,  ROOT + '/terminus/client/phantomjs'
+    
+    class Base
+      def self.start(options = {})
+        process = new(options)
+        process.start
+        process
+      end
+      
+      def initialize(options)
+        @address  = TCPServer.new(0).addr
+        @port     = options[:port] || @address[1]
+        @terminus = Terminus.create(:port => @port)
+        @browser  = ChildProcess.build(*browser_args(options[:command]))
+      end
+      
+      def start
+        Terminus.ensure_reactor_running
+        @terminus.run!
+        
+        @browser.start
+        
+        Terminus.port = @port
+        Terminus.browser = browser_selector
+        
+        at_exit { stop }
+      end
+      
+      def stop
+        @terminus.stop!
+        @browser.stop
+        @browser.poll_for_exit(10)
+      rescue ChildProcess::TimeoutError
+      end
+    end
+    
+  end
+end
+

data/lib/terminus/client/browser.rb

@@ -0,0 +1,30 @@
+module Terminus
+  module Client
+    
+    class Browser < Base
+      DEFAULT_COMMANDS = {
+        /(mingw|mswin|windows|cygwin)/i => ['cmd', '/C', 'start', '/b'],
+        /(darwin|mac os)/i              => ['open'],
+        /(linux|bsd|aix|solaris)/i      => ['xdg-open']
+      }
+      
+      def browser_args(command)
+        return command + [dock_url] if command
+          
+        os  = RbConfig::CONFIG['host_os']
+        key = DEFAULT_COMMANDS.keys.find { |key| os =~ key }
+        DEFAULT_COMMANDS[key] + [dock_url]
+      end
+      
+      def browser_selector
+        {:current_url => dock_url}
+      end
+      
+      def dock_url
+        "http://#{@address[2]}:#{@port}"
+      end
+    end
+    
+  end
+end
+

data/lib/terminus/client/phantom.js

@@ -0,0 +1,6 @@
+var page = new WebPage(),
+    host = phantom.args[0],
+    port = phantom.args[1];
+
+page.open('http://' + host + ':' + port + '/');
+

data/lib/terminus/client/phantomjs.rb

@@ -0,0 +1,20 @@
+module Terminus
+  module Client
+    
+    class PhantomJS < Base
+      DEFAULT_COMMAND = ['/usr/bin/env', 'phantomjs']
+      PHANTOM_CLIENT  = File.expand_path('../phantom.js', __FILE__)
+      
+      def browser_args(command)
+        args = (command || DEFAULT_COMMAND).dup
+        args + [PHANTOM_CLIENT, @address[2], @port.to_s]
+      end
+      
+      def browser_selector
+        {:name => 'PhantomJS'}
+      end
+    end
+    
+  end
+end
+

data/lib/terminus/connector.rb

@@ -0,0 +1,9 @@
+module Terminus
+  module Connector
+    
+    autoload :Server,        ROOT + '/terminus/connector/server'
+    autoload :SocketHandler, ROOT + '/terminus/connector/socket_handler'
+    
+  end
+end
+

data/lib/terminus/connector/server.rb

@@ -0,0 +1,142 @@
+# Based on code from the Poltergeist project
+# https://github.com/jonleighton/poltergeist
+# 
+# Copyright (c) 2011 Jonathan Leighton
+# 
+# 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.
+
+module Terminus
+  module Connector
+    
+    class Server
+      RECV_SIZE    = 1024
+      BIND_TIMEOUT = 5
+      
+      def initialize(browser, timeout = BIND_TIMEOUT)
+        @browser = browser
+        @skips   = 0
+        @server  = start_server
+        @timeout = timeout
+        reset
+      end
+      
+      def reset
+        @closing = false
+        @env     = nil
+        @handler = nil
+        @parser  = Http::Parser.new
+        @socket  = nil
+      end
+      
+      def connected?
+        not @socket.nil?
+      end
+      
+      def port
+        @server.addr[1]
+      end
+      
+      def request(message)
+        @browser.debug(:send, @browser.id, message)
+        accept unless connected?
+        @socket.write(@handler.encode(message))
+        true while @closing && receive
+        result = receive
+        @browser.debug(:recv, @browser.id, result)
+        reset if result.nil?
+        result
+      rescue Errno::ECONNRESET, Errno::EPIPE, Errno::EWOULDBLOCK
+        reset
+        nil
+      end
+      
+      def drain_socket
+        @closing = true if @socket
+      end
+      
+    private
+      
+      def start_server
+        time = Time.now
+        TCPServer.open(0)
+      rescue Errno::EADDRINUSE
+        if (Time.now - time) < BIND_TIMEOUT
+          sleep(0.01)
+          retry
+        else
+          raise
+        end
+      end
+      
+      def accept
+        @skips.times { @server.accept.close }
+        @socket = @server.accept
+        while line = @socket.gets
+          @parser << line
+          break if line == "\r\n"
+        end
+        if line.nil?
+          accept
+          @skips += 1
+        else
+          @handler = SocketHandler.new(self, env)
+          @socket.write(@handler.handshake_response)
+          @browser.debug(:accept, @browser.id, @handler.url)
+        end
+      end
+      
+      def env
+        @env ||= begin
+          env = {'REQUEST_METHOD' => @parser.http_method}
+          @parser.headers.each do |header, value|
+            env['HTTP_' + header.upcase.gsub('-', '_')] = value
+          end
+          if env['HTTP_SEC_WEBSOCKET_KEY1']
+            env['rack.input'] = StringIO.new(@socket.read(8))
+          end
+          env
+        end
+      end
+      
+      def receive
+        @browser.debug(:receive, @browser.id)
+        start = Time.now
+        
+        until @handler.message?
+          raise Errno::EWOULDBLOCK if (Time.now - start) >= @timeout
+          IO.select([@socket], [], [], @timeout) or raise Errno::EWOULDBLOCK
+          data = @socket.recv(RECV_SIZE)
+          break if data.empty?
+          @handler << data
+          break if @handler.nil?
+        end
+        @handler && @handler.next_message
+      end
+      
+      def close
+        [server, socket].compact.each do |s|
+          s.close_read
+          s.close_write
+        end
+      end
+    end
+    
+  end
+end
+

data/lib/terminus/connector/socket_handler.rb

@@ -0,0 +1,72 @@
+# Based on code from the Poltergeist project
+# https://github.com/jonleighton/poltergeist
+# 
+# Copyright (c) 2011 Jonathan Leighton
+# 
+# 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.
+
+module Terminus
+  module Connector
+    
+    class SocketHandler
+      attr_reader :env
+      
+      def initialize(server, env)
+        @server   = server
+        @env      = env
+        @parser   = Faye::WebSocket.parser(env).new(self)
+        @messages = []
+      end
+      
+      def url
+        "ws://#{env['HTTP_HOST']}/"
+      end
+      
+      def handshake_response
+        @parser.handshake_response
+      end
+      
+      def <<(data)
+        @parser.parse(data)
+      end
+      
+      def encode(message)
+        @parser.frame(Faye::WebSocket.encode(message))
+      end
+      
+      def receive(message)
+        @messages << message
+      end
+      
+      def message?
+        @messages.any?
+      end
+      
+      def next_message
+        @messages.shift
+      end
+      
+      def close(*args)
+        @server.reset
+      end
+    end
+    
+  end
+end
+

data/lib/terminus/controller.rb

@@ -11,7 +11,7 @@ module Terminus
     
     def browser(id = nil)
       return @browser if id.nil?
-      @browsers[id] ||= Browser.new(self)
+      @browsers[id] ||= Browser.new(self, id)
     end
     
     def browsers
@@ -26,6 +26,10 @@ module Terminus
       end
     end
     
+    def cookies
+      @cookies ||= CookieJar::Jar.new
+    end
+    
     def drop_browser(browser)
       @browsers.delete(browser.id)
       @browser = nil if @browser == browser
@@ -62,8 +66,9 @@ module Terminus
                     @host_aliases.index(Host.new(uri))
 
       if remote_host
-        uri.host = remote_host.host
-        uri.port = remote_host.port
+        uri.scheme = remote_host.scheme
+        uri.host   = remote_host.host
+        uri.port   = remote_host.port
       end
       uri.host = dock_host if dock_host and uri.host =~ LOCALHOST
       uri
@@ -73,8 +78,20 @@ module Terminus
       uri = URI.parse(url)
       return uri unless URI::HTTP === uri and uri.host !~ LOCALHOST and uri.host != dock_host
       server = boot(uri)
-      uri.host, uri.port = server.host, server.port
+      uri.scheme = 'http'
+      uri.host, uri.port = (dock_host || server.host), server.port
       uri
+    rescue URI::InvalidURIError
+      url
+    end
+    
+    def server_running?(server)
+      return false unless server.port
+      uri = URI.parse("http://#{server.host}:#{server.port}/")
+      Net::HTTP.start(uri.host, uri.port) { |h| h.head(uri.path) }
+      true
+    rescue
+      false
     end
     
   private
@@ -93,7 +110,7 @@ module Terminus
       @host_aliases[host] ||= begin
         server = Capybara::Server.new(Proxy[host])
         Thread.new { server.boot }
-        sleep 0.1 until server.port
+        sleep(0.1) until server_running?(server)
         Host.new(server)
       end
     end

data/lib/terminus/host.rb

@@ -4,8 +4,13 @@ module Terminus
     attr_reader :host, :port
     
     def initialize(uri)
-      @host = uri.host
-      @port = uri.port
+      @scheme = uri.scheme if uri.respond_to?(:scheme)
+      @host   = uri.host
+      @port   = uri.port
+    end
+    
+    def scheme
+      @scheme || 'http'
     end
     
     def eql?(other)

data/lib/terminus/node.rb

@@ -18,14 +18,20 @@ module Terminus
     def click
       page    = @browser.page_id
       options = @driver ? @driver.options : {}
-      command = @browser.tell([:click, @id, options])
       
-      result = @browser.wait_with_timeout(:click_response) do
-        @browser.result(command) || (@browser.page_id != page)
+      value = if @browser.connector
+        @browser.ask([:click, @id, options], false)
+      else
+        command = @browser.tell([:click, @id, options])
+        
+        result = @browser.wait_with_timeout(:click_response) do
+          @browser.result(command) || (@browser.page_id != page)
+        end
+        Hash === result ? result[:value] : nil
       end
       
-      if Hash === result and String === result[:value]
-        raise Capybara::TimeoutError, result[:value]
+      if String === value
+        raise Capybara::TimeoutError, value
       end
     end
     

data/lib/terminus/proxy.rb

@@ -4,6 +4,7 @@ module Terminus
     CONTENT_TYPES   = %w[text/plain text/html]
     BASIC_RESOURCES = %w[/favicon.ico /robots.txt]
     MAX_REDIRECTS   = 5
+    REDIRECT_CODES  = [301, 302, 303, 305, 307]
     
     INFINITE_REDIRECT_RESPONSE = [
       200,
@@ -32,9 +33,11 @@ module Terminus
     end
     
     def call(env)
+      add_cookies(env)
       response = @app.call(env)
+      store_cookies(env, response)
       
-      if response.first == 302
+      if REDIRECT_CODES.include?(response.first)
         @redirects += 1
         if @redirects > MAX_REDIRECTS
           @redirects = 0
@@ -44,7 +47,13 @@ module Terminus
         @redirects = 0
       end
       
+      if location = response[1].keys.grep(/^location$/i).first
+        app_host = URI.parse('http://' + env['HTTP_HOST']).host
+        response[1][location] = Terminus.rewrite_remote(response[1][location], app_host).to_s
+      end
+      
       return response if response.first == -1 or              # async response
+             REDIRECT_CODES.include?(response.first) or       # redirects
              BASIC_RESOURCES.include?(env['PATH_INFO']) or    # not pages - favicon etc
              env.has_key?('HTTP_X_REQUESTED_WITH')            # Ajax calls
       
@@ -58,5 +67,30 @@ module Terminus
       response
     end
     
+  private
+    
+    def add_cookies(env)
+      return unless External === @app
+      cookies = Terminus.cookies.get_cookies(env['REQUEST_URI'])
+      env['HTTP_COOKIE'] = (cookies + [env['HTTP_COOKIE']]).compact.join('; ')
+    rescue => e
+      puts e.message
+    end
+    
+    def store_cookies(env, response)
+      set_cookie = response[1].keys.grep(/^set-cookie$/i).first
+      return unless set_cookie
+      
+      host = External === @app ? @app.uri.host : env['HTTP_HOST']
+      endpoint = "http://#{host}#{env['PATH_INFO']}"
+      
+      [*response[1][set_cookie]].compact.each do |cookie|
+        cookie.split(/\s*,\s*(?=\S+=)/).each do |value|
+          Terminus.cookies.set_cookie(endpoint, value)
+        end
+      end
+    end
+    
   end
 end
+