terminus 0.5.0 → 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30218e6e5c5e4b1e6511ce36a401a402889aaa21
+  data.tar.gz: 6dc3ecb9878543aaeb30294cefaee7cc87b16985
+SHA512:
+  metadata.gz: b9a983a66f5310a7cec00f4979c0425908a4cc62e1e29a11e0476d18457efaf82de970f088516a9180c2a93585fdd8337edd1bc709a4f9654aca4025d32e6b05
+  data.tar.gz: 80e252b012aad3bcc0f3a01a50108e293c298a34aeddba1612c6233f7887e475f1c28f0d7d4a99aa0553169daa3573a5a302566d47c509877d90e8fc9299aa83

data/README.md

@@ -0,0 +1,72 @@
+# Terminus
+
+[Terminus[(http://terminus.jcoglan.com) is an experimental
+[Capybara](https://github.com/jnicklas/capybara) driver for real browsers. It
+lets you control your application in any browser on any device (including
+[PhantomJS](http://phantomjs.org/)), without needing browser plugins. This
+allows several types of testing to be automated:
+    
+* Cross-browser testing
+* Headless testing
+* Multi-browser interaction e.g. messaging apps
+* Testing on remote machines, phones, iPads etc
+
+*Since it is experimental, this project is sporadically maintained. Usage is
+entirely at your own risk.*
+
+
+## Installation
+
+```
+$ gem install terminus
+```
+
+
+## Running the example
+
+Install the dependencies and boot the Terminus server, then open
+http://localhost:70004/ in your browser.
+
+```
+$ bundle install
+$ bundle exec bin/terminus
+```
+
+With your browser open, start an IRB session and begin controlling the app:
+
+```
+$ irb -r ./example/app
+>> extend Capybara::DSL
+>> visit '/'
+>> click_link 'Sign up!'
+>> fill_in 'Username', :with => 'jcoglan'
+>> fill_in 'Password', :with => 'hello'
+>> choose 'Web scale'
+>> click_button 'Go!'
+```
+
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2010-2013 James Coglan
+
+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.
+

data/lib/capybara/driver/terminus.rb

@@ -15,10 +15,15 @@ class Capybara::Driver::Terminus < Capybara::Driver::Base
     Terminus.register_local_port(@rack_server.port)
   end
 
-  def find(xpath)
-    browser.find(xpath, self)
+  def find_css(css)
+    browser.find_css(css, self)
   end
 
+  def find_xpath(xpath)
+    browser.find_xpath(xpath, self)
+  end
+  alias :find :find_xpath
+
   def invalid_element_errors
     [::Terminus::ObsoleteElementError]
   end
@@ -43,14 +48,18 @@ class Capybara::Driver::Terminus < Capybara::Driver::Base
                            :debugger,
                            :evaluate_script,
                            :execute_script,
+                           :go_back,
+                           :go_forward,
                            :html,
                            :reset!,
                            :response_headers,
                            :save_screenshot,
                            :source,
-                           :status_code
+                           :status_code,
+                           :title
 
   def within_window(name)
+    name = name['id'] unless String === name
     current_browser = browser
     Terminus.browser = browser.id + '/' + name
     result = yield
@@ -83,6 +92,7 @@ end
 
 Capybara.server do |app, port|
   handler = Rack::Handler.get('webrick')
-  handler.run(app, :Port => port, :AccessLog => [], :Logger => WEBrick::Log::new(nil, 0))
+  logger  = Terminus.debug ? Logger.new(STDOUT) : WEBrick::Log.new(nil, 0)
+  handler.run(app, :Port => port, :AccessLog => [], :Logger => logger)
 end
 

data/lib/terminus.rb

@@ -1,6 +1,7 @@
 require 'erb'
 require 'forwardable'
 require 'http/parser'
+require 'logger'
 require 'net/http'
 require 'rbconfig'
 require 'readline'
@@ -18,7 +19,7 @@ require 'useragent'
 
 module Terminus
   FAYE_MOUNT   = '/messaging'
-  DEFAULT_HOST = 'localhost'
+  DEFAULT_HOST = '127.0.0.1'
   DEFAULT_PORT = 7004
   LOCALHOST    = /^(localhost|0\.0\.0\.0|127\.0\.0\.1)$/
   PING_PATH    = '/favicon.ico'

data/lib/terminus/browser.rb

@@ -34,12 +34,12 @@ module Terminus
     def ask(command, retries = RETRY_LIMIT)
       debug(:ask, id, command)
       value = if @connector
-        message = Yajl::Encoder.encode('commandId' => '_', 'command' => command)
+        message = MultiJson.dump('commandId' => '_', 'command' => command)
         response = @connector.request(message)
         if response.nil?
           retries == false ? false : ask(command)
         else
-          result_hash = Yajl::Parser.parse(response)
+          result_hash = MultiJson.load(response)
           result_hash['value']
         end
       else
@@ -87,8 +87,14 @@ module Terminus
       nil
     end
 
-    def find(xpath, driver = nil)
-      ask([:find, xpath, false]).map { |id| Node.new(self, id, driver) }
+    def find_css(css, driver = nil)
+      return [] unless @find_enabled
+      ask([:find_css, css, false]).map { |id| Node.new(self, id, driver) }
+    end
+
+    def find_xpath(xpath, driver = nil)
+      return [] unless @find_enabled
+      ask([:find_xpath, xpath, false]).map { |id| Node.new(self, id, driver) }
     end
 
     def frame!(frame_browser)
@@ -99,6 +105,14 @@ module Terminus
       @frames.to_a
     end
 
+    def go_back
+      execute_script('window.history.back()')
+    end
+
+    def go_forward
+      execute_script('window.history.forward()')
+    end
+
     def html
       ask([:body])
     end
@@ -132,8 +146,10 @@ module Terminus
       @attributes['raw_url'] = message['url']
       message['url'] = rewrite_local(message['url'])
 
-      @attributes = @attributes.merge(message)
-      @user_agent = UserAgent.parse(message['ua'])
+      @attributes   = @attributes.merge(message)
+      @find_enabled = true
+      @user_agent   = UserAgent.parse(message['ua'].gsub(/.*?\bOPR\b/, 'Opera'))
+
       detect_dock_host
 
       @infinite_redirect = message['infinite']
@@ -160,6 +176,7 @@ module Terminus
       ask([:clear_cookies])
 
       @attributes.delete('url')
+      @find_enabled = false
     end
 
     def response_headers
@@ -205,12 +222,18 @@ module Terminus
       command_id
     end
 
+    def title
+      ask([:title])
+    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)
 
+      @find_enabled = true
+
       if @connector
         ask([:visit, uri.to_s], false)
         @connector.drain_socket
@@ -277,7 +300,7 @@ module Terminus
 
     def start_connector
       return if @connector or @dock_host.nil? or Terminus.browser != self
-      @connector = Connector::Server.new(self)
+      @connector = Connector.new(self)
       url = "ws://#{@dock_host}:#{@connector.port}/"
       debug(:connect, id, url)
       messenger.publish(socket_channel, 'url' => url)

data/lib/terminus/client.rb

@@ -25,7 +25,7 @@ module Terminus
         @id        = Faye.random
         @options   = options
         @address   = TCPServer.new(0).addr
-        @connector = Connector::Server.new(self)
+        @connector = Connector.new(self)
         @port      = options[:port] || @address[1]
         @terminus  = Terminus.create(:port => @port)
         @browser   = ChildProcess.build(*browser_args)

data/lib/terminus/client/phantomjs.rb

@@ -47,7 +47,7 @@ module Terminus
       end
 
       def save_screenshot(path, options = {})
-        message = Yajl::Encoder.encode(['save_screenshot', path, options])
+        message = MultiJson.dump(['save_screenshot', path, options])
         @connector.request(message)
       end
     end

data/lib/terminus/connector.rb

@@ -1,8 +1,125 @@
+# 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.
+
+require 'websocket/driver'
+
 module Terminus
-  module Connector
+  class Connector
+
+    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
+      @driver  = nil
+      @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?
+      @driver.text(message)
+      true while @closing && receive
+      result = receive
+      @browser.debug(:recv, @browser.id, result)
+      reset if result.nil?
+      result
+    rescue Errno::EBADF, Errno::ECONNRESET, Errno::EPIPE, Errno::EWOULDBLOCK
+      reset
+      nil
+    end
+
+    def drain_socket
+      @closing = true if @socket
+    end
+
+    def close
+      [@server, @socket].compact.each do |s|
+        s.close_read
+        s.close_write
+      end
+    end
+
+    def write(data)
+      @socket.write(data)
+    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
+      @messages = []
+      @driver   = WebSocket::Driver.server(self)
+
+      @driver.on(:connect) { |e| @driver.start }
+      @driver.on(:message) { |e| @messages << e.data }
+
+      # @browser.debug(:accept, @browser.id, @handler.url)
+    end
+
+    def receive
+      @browser.debug(:receive, @browser.id)
+      start = Time.now
 
-    autoload :Server,        ROOT + '/terminus/connector/server'
-    autoload :SocketHandler, ROOT + '/terminus/connector/socket_handler'
+      until @messages.any?
+        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?
+        @driver.parse(data)
+      end
+      @messages.shift
+    end
 
   end
 end

data/lib/terminus/controller.rb

@@ -55,7 +55,7 @@ module Terminus
 
     def register_local_port(port)
       @local_ports << port
-      @host_aliases[Host.new(URI.parse("http://localhost:#{port}/"))] = Host.new(URI.parse("http://localhost:80/"))
+      @host_aliases[Host.new(URI.parse("http://127.0.0.1:#{port}/"))] = Host.new(URI.parse("http://127.0.0.1:80/"))
     end
 
     def return_to_dock

data/lib/terminus/node.rb

@@ -40,10 +40,15 @@ module Terminus
     end
     alias :eql? :==
 
-    def find(xpath)
-      @browser.ask([:find, xpath, @id]).map { |id| Node.new(@browser, id) }
+    def find_css(css)
+      @browser.ask([:find_css, css, @id]).map { |id| Node.new(@browser, id, @driver) }
     end
 
+    def find_xpath(xpath)
+      @browser.ask([:find_xpath, xpath, @id]).map { |id| Node.new(@browser, id, @driver) }
+    end
+    alias :find :find_xpath
+
     def hash
       @id.hash
     end
@@ -66,6 +71,15 @@ module Terminus
       raise Capybara::NotSupportedByDriverError.new if result == 'not_allowed'
     end
 
+    def all_text
+      @browser.ask([:text, @id, false])
+    end
+
+    def visible_text
+      @browser.ask([:text, @id, true])
+    end
+    alias :text :visible_text
+
     def trigger(event_type)
       @browser.ask([:trigger, @id, event_type])
     end
@@ -85,8 +99,8 @@ module Terminus
 
     SYNC_DSL_METHODS = [ [:[], :attribute],
                          [:[]=, :set_attribute],
+                         [:disabled?, :is_disabled],
                          :tag_name,
-                         :text,
                          :value,
                          [:visible?, :is_visible]
                        ]

data/lib/terminus/proxy.rb

@@ -40,7 +40,7 @@ module Terminus
 
     def self.content_type(response)
       type = response[1].find { |key, _| key =~ /^content-type$/i }
-      type && type.last.split(';').first
+      type && type.flatten.last.split(';').first
     end
 
     def initialize(app)
@@ -69,7 +69,7 @@ module Terminus
       set_cookie = response[1].keys.grep(/^set-cookie$/i).first
       return unless set_cookie
 
-      host = External === @app ? @app.uri.host : env['HTTP_HOST']
+      host = External === @app ? @app.host : env['HTTP_HOST']
       endpoint = "http://#{host}#{env['PATH_INFO']}"
 
       [*response[1][set_cookie]].compact.each do |cookie|
@@ -100,11 +100,13 @@ module Terminus
     end
 
     def rewrite_response(env, response)
+      headers = response[1]
+
+      headers.each_key { |k| headers[k] = [headers[k]].flatten.first }
       rewrite_location(env, response)
       return response if return_unmodified?(env, response)
 
-      response[1] = response[1].dup
-      response[1].delete_if { |key, _| key =~ /^content-length$/i }
+      headers.delete_if { |key, _| key =~ /^content-length$/i }
       response[2] = DriverBody.new(env, response)
       response
     end