terminus 0.4.0 → 0.5.0

data/bin/terminus

@@ -7,23 +7,23 @@ require File.expand_path('../../lib/terminus', __FILE__)
 spec = Oyster.spec do
   name "terminus -- Control web browsers with Ruby"
   synopsis "terminus [--port PORT]"
-  
+
   integer :port, :default => Terminus::DEFAULT_PORT
 end
 
 begin
   options = spec.parse
   app = Terminus.create(options)
-  
+
   trap("INT") { app.stop! ; exit }
-  
+
   Terminus.port = options[:port]
-  
+
   puts "Terminus server running on port #{Terminus.port}"
   puts "Press CTRL-C to exit"
   puts ""
   app.run!
-  
+
 rescue Oyster::HelpRendered
 end
 

data/lib/capybara/driver/terminus.rb

@@ -1,55 +1,66 @@
 class Capybara::Driver::Terminus < Capybara::Driver::Base
   attr_reader :options
-  
+
   NULL_APP = lambda do |env|
     [200, {'Content-Type' => 'text/html'}, ['']]
   end
-  
+
   def initialize(app = nil, options = {})
     @app         = Terminus::Proxy[app || NULL_APP]
     @options     = options
     @rack_server = Capybara::Server.new(@app)
-    
+
     @rack_server.boot
     sleep(0.1) until Terminus.server_running?(@rack_server)
+    Terminus.register_local_port(@rack_server.port)
   end
-  
+
   def find(xpath)
     browser.find(xpath, self)
   end
-  
+
   def invalid_element_errors
     [::Terminus::ObsoleteElementError]
   end
-  
+
+  def needs_server?
+    true
+  end
+
   def visit(path)
-    browser.visit(@rack_server.url(path))
+    h, s = Capybara.app_host, @rack_server
+    path = "#{h || "http://#{s.host}:#{s.port}"}#{path}" unless path =~ /^https?:\/\//
+    browser.visit(path)
   end
-  
+
   def wait?
     true
   end
-  
+
   extend Forwardable
   def_delegators :browser, :body,
                            :current_url,
+                           :debugger,
                            :evaluate_script,
                            :execute_script,
+                           :html,
                            :reset!,
                            :response_headers,
+                           :save_screenshot,
                            :source,
                            :status_code
-  
+
   def within_window(name)
     current_browser = browser
     Terminus.browser = browser.id + '/' + name
-    yield
+    result = yield
     Terminus.browser = current_browser
+    result
   end
   alias :within_frame :within_window
-  
+
 private
-  
+
   def browser
     Terminus.ensure_browsers
     Terminus.browser

data/lib/terminus.rb

@@ -3,6 +3,7 @@ require 'forwardable'
 require 'http/parser'
 require 'net/http'
 require 'rbconfig'
+require 'readline'
 require 'socket'
 require 'stringio'
 require 'uri'
@@ -20,70 +21,75 @@ module Terminus
   DEFAULT_HOST = 'localhost'
   DEFAULT_PORT = 7004
   LOCALHOST    = /^(localhost|0\.0\.0\.0|127\.0\.0\.1)$/
+  PING_PATH    = '/favicon.ico'
   RETRY_LIMIT  = 3
-  
+
   ROOT = File.expand_path('..', __FILE__)
   autoload :Application, ROOT + '/terminus/application'
   autoload :Browser,     ROOT + '/terminus/browser'
   autoload :Client,      ROOT + '/terminus/client'
   autoload :Connector,   ROOT + '/terminus/connector'
   autoload :Controller,  ROOT + '/terminus/controller'
+  autoload :Headers,     ROOT + '/terminus/headers'
   autoload :Host,        ROOT + '/terminus/host'
   autoload :Node,        ROOT + '/terminus/node'
   autoload :Proxy,       ROOT + '/terminus/proxy'
   autoload :Server,      ROOT + '/terminus/server'
   autoload :Timeouts,    ROOT + '/terminus/timeouts'
-  
+
   require ROOT + '/capybara/driver/terminus'
-  
+
   class ObsoleteElementError < StandardError
   end
-  
+
   class << self
     attr_accessor :debug, :sockets
-    
+
     def create(options = {})
       Server.new(options)
     end
-    
+
     def endpoint(host = DEFAULT_HOST)
       "http://#{host}:#{port}#{FAYE_MOUNT}"
     end
-    
+
     def ensure_reactor_running
       Thread.new { EM.run unless EM.reactor_running? }
       Thread.pass until EM.reactor_running?
     end
-    
+
     def port
       @port || DEFAULT_PORT
     end
-    
+
     def port=(port)
       @port = port.to_i
     end
-    
+
     def start_browser(options = {})
       Client::Browser.start(options)
     end
-    
+
     def start_phantomjs(options = {})
       Client::PhantomJS.start(options)
     end
-    
+
     extend Forwardable
     def_delegators :controller, :browser,
                                 :browsers,
                                 :browser=,
                                 :cookies,
                                 :ensure_browsers,
+                                :register_local_port,
                                 :return_to_dock,
                                 :rewrite_local,
                                 :rewrite_remote,
-                                :server_running?
-    
+                                :save_error,
+                                :server_running?,
+                                :visited?
+
   private
-    
+
     def controller
       @controller ||= Controller.new
     end

data/lib/terminus/application.rb

@@ -3,27 +3,27 @@ require 'sinatra'
 
 module Terminus
   class Application < Sinatra::Base
-    
+
     ROOT = File.expand_path('../..', __FILE__)
-    
+
     set :static, true
     set :root,   ROOT + '/terminus'
-    
+
     helpers do
       def bootstrap
         Packr.pack(erb(:bootstrap), :shrink_vars => true)
       end
     end
-    
+
     get '/' do
       erb :index
     end
-    
+
     get '/bootstrap.js' do
       headers 'Content-Type' => 'text/javascript'
       bootstrap
     end
-    
+
   end
 end
 

data/lib/terminus/browser.rb

@@ -1,13 +1,13 @@
 module Terminus
   class Browser
-    
+
     include Timeouts
     attr_reader :connector
     attr_writer :sockets
-    
+
     extend Forwardable
     def_delegators :@user_agent, :os, :version
-    
+
     def initialize(controller, id)
       @controller = controller
       @attributes = {'id' => id}
@@ -15,22 +15,22 @@ module Terminus
       @frames     = Set.new
       @namespace  = Faye::Namespace.new
       @results    = {}
-      
+
       add_timeout(:dead, Timeouts::TIMEOUT) { drop_dead! }
     end
-    
+
     def ===(params)
       return docked? if params == :docked
       return params == id if String === params
       return false if @parent
       return false unless @user_agent
-      
+
       params.all? do |name, value|
         property = __send__(name)
         value === property
       end
     end
-    
+
     def ask(command, retries = RETRY_LIMIT)
       debug(:ask, id, command)
       value = if @connector
@@ -54,146 +54,163 @@ module Terminus
       raise e if retries == 1
       ask(command, retries - 1)
     end
-    
-    def body
-      ask([:body])
-    end
-    
+
     def current_path
       URI.parse(current_url).path
     end
-    
+
     def current_url
       url = @attributes['url']
       return '' unless url
-      return url unless @connector
       rewrite_local(ask([:current_url]))
     end
-    
+
     def debug(*args)
       p args if Terminus.debug
     end
-    
+
+    def debugger
+      Client::PhantomJS.debugger if name == 'PhantomJS'
+      Readline.readline('Driver paused, press ENTER to continue')
+    end
+
     def docked?
       @docked
     end
-    
+
     def evaluate_script(expression)
       ask([:evaluate, expression])
     end
-    
+
     def execute_script(expression)
       @connector ? ask([:execute, expression]) : tell([:execute, expression])
       nil
     end
-    
+
     def find(xpath, driver = nil)
       ask([:find, xpath, false]).map { |id| Node.new(self, id, driver) }
     end
-    
+
     def frame!(frame_browser)
       @frames.add(frame_browser)
     end
-    
+
     def frames
       @frames.to_a
     end
-    
+
+    def html
+      ask([:body])
+    end
+    alias :body :html
+
     def id
       @attributes['id']
     end
-    
+
     def infinite_redirect?
       return @infinite_redirect unless @connector
       evaluate_script('!!window.TERMINUS_INFINITE_REDIRECT')
     end
-    
+
     def name
       return 'PhantomJS' if @user_agent.to_str =~ /\bPhantomJS\b/
       @user_agent.browser
     end
-    
+
     def page_id
       @attributes['page']
     end
-    
+
     def ping!(message)
       debug(:ping, id)
       debug(:recv, message)
-      
+
       remove_timeout(:dead)
       add_timeout(:dead, Timeouts::TIMEOUT) { drop_dead! }
-      
+
+      @attributes['raw_url'] = message['url']
       message['url'] = rewrite_local(message['url'])
-      
+
       @attributes = @attributes.merge(message)
       @user_agent = UserAgent.parse(message['ua'])
       detect_dock_host
-      
+
       @infinite_redirect = message['infinite']
-      
+
       if id =~ /\//
         @parent = Terminus.browser(id.gsub(/\/[^\/]+$/, ''))
         @parent.frame!(self) unless @parent == self
       end
-      
+
       start_connector if message['sockets'] and sockets?
-      
+
       @ping = true
     end
-    
+
+    def raw_url
+      @attributes['raw_url']
+    end
+
     def reset!
       if url = @attributes['url']
         uri = URI.parse(url)
         visit("http://#{uri.host}:#{uri.port}/")
       end
       ask([:clear_cookies])
+
       @attributes.delete('url')
     end
-    
+
     def response_headers
-      evaluate_script('TERMINUS_HEADERS')
+      Headers.new(evaluate_script('TERMINUS_HEADERS'))
     end
-    
+
     def result!(message)
       debug(:result, id, message['commandId'], message['result'])
       @results[message['commandId']] = {:value => message['result']}
     end
-    
+
     def result(id)
       return nil unless @results.has_key?(id)
       @results.delete(id)
     end
-    
+
     def return_to_dock
       return unless @dock_host
       visit("http://#{@dock_host}:#{Terminus.port}/")
     end
-    
+
+    def save_screenshot(path, options = {})
+      raise Capybara::NotSupportedByDriverError.new unless name == 'PhantomJS'
+      Client::PhantomJS.save_screenshot(path, options)
+    end
+
     def sockets?
       @sockets.nil? ? Terminus.sockets != false : @sockets
     end
-    
+
     def source
       evaluate_script('TERMINUS_SOURCE')
     end
-    
+
     def status_code
       evaluate_script('TERMINUS_STATUS')
     end
-    
+
     def tell(command)
       command_id = @namespace.generate
       debug(:tell, id, command, command_id)
       messenger.publish(command_channel, 'command' => command, 'commandId' => command_id)
       command_id
     end
-    
+
     def visit(url, retries = RETRY_LIMIT)
       close_frames!
       uri = @controller.rewrite_remote(url, @dock_host)
       uri.host = @dock_host if uri.host =~ LOCALHOST
-      
+      @controller.visit_url(uri.to_s)
+
       if @connector
         ask([:visit, uri.to_s], false)
         @connector.drain_socket
@@ -202,29 +219,29 @@ module Terminus
         tell([:visit, uri.to_s])
         wait_for_ping
       end
-      
+
       if infinite_redirect?
         @infinite_redirect = nil
         raise Capybara::InfiniteRedirectError
       end
-      
+
     rescue Timeouts::TimeoutError => e
       raise e if retries.zero?
       visit(url, retries - 1)
     end
-    
+
     def wait_for_ping
       @ping = false
       wait_with_timeout(:ping) { @ping or @dead }
     end
-    
+
     def to_s
       "<#{self.class.name} #{name} #{version} (#{os})>"
     end
     alias :inspect :to_s
-    
+
   protected
-    
+
     def drop_dead!
       remove_timeout(:dead)
       close_frames!
@@ -232,32 +249,32 @@ module Terminus
       @dead = true
       @controller.drop_browser(self)
     end
-    
+
   private
-    
+
     def command_channel
       "/terminus/clients/#{id}"
     end
-    
+
     def socket_channel
       "/terminus/sockets/#{id}"
     end
-    
+
     def close_frames!
       @frames.each { |frame| frame.drop_dead! }
       @frames = Set.new
     end
-    
+
     def detect_dock_host
       uri = URI.parse(@attributes['url'])
       @docked = (uri.port == Terminus.port)
       @dock_host = @attributes['host']
     end
-    
+
     def rewrite_local(url)
       @controller.rewrite_local(url.to_s, @dock_host).to_s
     end
-    
+
     def start_connector
       return if @connector or @dock_host.nil? or Terminus.browser != self
       @connector = Connector::Server.new(self)
@@ -265,11 +282,11 @@ module Terminus
       debug(:connect, id, url)
       messenger.publish(socket_channel, 'url' => url)
     end
-    
+
     def messenger
       @controller.messenger
     end
-    
+
   end
 end