revisor_client 0.0.1

data/README.md

@@ -0,0 +1,24 @@
+Ruby Revisor Client Library
+===================
+
+This library provides object-oriented interface for executing commands
+on [Revisor](http://github.com/sotakone/revisor) server. Althrough you
+can send commands with any HTTP client, this library might save you
+some time collecting command arguments and handling server responses
+for you. It also includes some examples and test suite.
+
+Location of Revisor executable
+----------
+
+Client library expects your Revisor executable will be in PATH, or
+it's location is set in REVISOR_PATH environment variable.
+
+Running examples (GMail test)
+----------
+
+    $ rake examples REVISOR_PATH=/path/to/your/revisor/executable
+    
+Running tests
+----------
+
+    $ rake test REVISOR_PATH=/path/to/your/revisor/executable

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake/testtask'
+
+begin
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "revisor_client"
+    gemspec.summary = "Ruby helper library for Revisor browser"
+    gemspec.description = "Object-oriented interface for remotelly-controller WebKit-based browser named Revisor."
+    gemspec.email = "sotakone@sotakone.com"
+    gemspec.homepage = "http://github.com/sotakone/revisor/"
+    gemspec.description = ""
+    gemspec.authors = ["Mikhail Lapshin"]
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['test/*_test.rb']
+end
+
+Rake::TestTask.new(:examples) do |t|
+  t.test_files = FileList['examples/*_example.rb']
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/revisor/client/session.rb

@@ -0,0 +1,53 @@
+module Revisor
+  class Client
+    class Session
+      attr_reader :client, :name
+
+      def initialize(client, name)
+        @client = client
+        @name = name
+        @tabs = {}
+      end
+
+      def stop
+        @client.stop_session(self.name)
+      end
+
+      def create_tab(tab_name)
+        @client.command("session.tab.create",
+                        :session_name => @name,
+                        :tab_name => tab_name)
+
+        @tabs[tab_name] = Tab.new(self, tab_name)
+      end
+
+      def destroy_tab(tab_name)
+        @client.command("session.tab.destroy",
+                        :session_name => @name,
+                        :tab_name => tab_name)
+
+        @tabs.delete(tab_name)
+      end
+
+      def set_cookies(cookies, url)
+        cookies.each do |cookie|
+          if cookie[:expires_at] && cookie[:expires_at].is_a?(Time)
+            cookie[:expires_at] = Client.datetime_to_json(cookie[:expires_at])
+          end
+        end
+
+        @client.command("session.set_cookies",
+                        :session_name => @name,
+                        :cookies => cookies,
+                        :url => url)
+      end
+
+      def get_cookies(url)
+        @client.command("session.get_cookies",
+                        :session_name => @name,
+                        :url => url)[:cookies]
+      end
+
+    end
+  end
+end

data/lib/revisor/client/tab.rb

@@ -0,0 +1,93 @@
+module Revisor
+  class Client
+    class Tab
+
+      attr_reader :session, :name, :client
+
+      def initialize(session, name)
+        @client = session.client
+        @session = session
+        @name = name
+      end
+
+      def destroy
+        @session.destroy_tab(self.name)
+        @session = nil
+
+        true
+      end
+
+      def visit(url)
+        cmd = session_and_tab_names.merge({ :url => url })
+        @client.command("session.tab.visit", cmd)
+      end
+
+      def wait_for_load(timeout = 0)
+        cmd = session_and_tab_names.merge({ :timeout => timeout })
+        @client.command("session.tab.wait_for_load", cmd)
+      end
+
+      def wait_for_condition(script, interval, tries_count)
+        successfull = false
+        step = 0
+
+        while !successfull && step < tries_count
+          result = e(script)
+          puts "WTE: #{result.inspect}"
+          successfull = (result == true)
+          step = step + 1
+          sleep(interval / 1000.0)
+        end
+
+        successfull
+      end
+
+      def set_confirm_answer(answer)
+        cmd = session_and_tab_names.merge({ :answer => answer })
+        @client.command("session.tab.set_confirm_answer", cmd)
+      end
+
+      def set_prompt_answer(answer, cancelled)
+        cmd = session_and_tab_names.merge({ :answer => answer, :cancelled => cancelled })
+        @client.command("session.tab.set_prompt_answer", cmd)
+      end
+
+      def evaluate_javascript(script)
+        puts "EEE: #{script}"
+        cmd = session_and_tab_names.merge({ :script => script })
+        @client.command("session.tab.evaluate_javascript", cmd)[:eval_result]
+      end
+
+      alias :e :evaluate_javascript
+
+      def save_screenshot(file_name, size = nil)
+        cmd = session_and_tab_names.merge({ :file_name => file_name })
+
+        if size
+          cmd[:viewport_width] = size.first.to_i
+          cmd[:viewport_height] = size.last.to_i
+        end
+
+        @client.command("session.tab.save_screenshot", cmd)
+      end
+
+      def send_mouse_event(type, x, y, options = {})
+        options[:button] ||= "left" if type == "click" || type == "dblclick"
+        cmd = session_and_tab_names.merge(:x => x, :y => y, :type => type).merge(options)
+        @client.command("session.tab.send_mouse_event", cmd)
+      end
+
+      def send_key_event(type, key, text, options = {})
+        cmd = session_and_tab_names.merge(:text => text, :key => key, :type => type).merge(options)
+        @client.command("session.tab.send_key_event", cmd)
+      end
+
+      protected
+
+      def session_and_tab_names
+        { :session_name => session.name, :tab_name => name }
+      end
+
+    end
+  end
+end

data/lib/revisor/client.rb

@@ -0,0 +1,66 @@
+require 'rubygems'
+require 'json'
+require 'net/http'
+require File.join(File.dirname(__FILE__), "client", "session")
+require File.join(File.dirname(__FILE__), "client", "tab")
+
+module Revisor
+  class Client
+
+    class ServerError < RuntimeError
+    end
+
+    attr_accessor :host, :port
+
+    def initialize(host, port)
+      @host = host
+      @port = port
+
+      @sessions = {}
+    end
+
+    def command(command_name, params = {})
+      command = { :name => command_name }.merge(params)
+      json = JSON.generate(command)
+      # puts "==> " + json
+
+      response = Net::HTTP.post_form(URI.parse("http://#{@host}:#{@port}/command"), 'command' => json)
+      # puts "<== " + response.body
+
+      response_json = JSON.parse(response.body).inject({}) { |r, k| r[k.first.to_sym] = k.last; r }
+
+      if response_json[:result] == 'Error'
+        raise ServerError, response_json[:message]
+      end
+
+      response_json
+    end
+
+    def start_session(name)
+      command("session.start", :session_name => name)
+      @sessions[name] = Session.new(self, name)
+    end
+
+    def stop_session(name)
+      command("session.stop", :session_name => name)
+      @sessions.delete(name)
+    end
+
+    def session(name)
+      if @sessions.include?(name)
+        @sessions[name]
+      else
+        raise "No session found with name #{name}"
+      end
+    end
+
+    def [] (n)
+      session(n)
+    end
+
+    def self.datetime_to_json(t)
+      t.utc.strftime("%Y-%m-%dT%H:%M:%S")
+    end
+
+  end
+end

data/lib/revisor.rb

@@ -0,0 +1,50 @@
+require File.join(File.dirname(__FILE__), "revisor", "client")
+
+module Revisor
+
+  @@server_executable = "revisor"
+  @@server_pid = nil
+
+  class << self
+    def server_executable
+      @@server_executable
+    end
+
+    def server_executable=(e)
+      @@server_executable = e
+    end
+
+    def server_pid
+      @@server_pid
+    end
+
+    def start_server(interface = "127.0.0.1", port = 8080, delay = 3)
+      if @@server_pid
+        raise "Revisor server already started"
+      else
+        @@server_pid = fork do
+          exec("#{@@server_executable} -l #{interface} -p #{port}")
+        end
+
+        at_exit do
+          if Revisor.server_pid && $$ != Revisor.server_pid
+            Revisor.stop_server
+          end
+        end
+
+        # TODO: more clever detection of server startup
+        sleep delay
+        @@server_pid
+      end
+    end
+
+    def stop_server
+      if @@server_pid
+        Process.kill("INT", @@server_pid)
+        @@server_pid = nil
+      else
+        raise "Revisor server is not started, so I couldn't stop it"
+      end
+    end
+  end
+end

data/revisor_client.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{revisor_client}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mikhail Lapshin"]
+  s.date = %q{2011-04-11}
+  s.description = %q{}
+  s.email = %q{sotakone@sotakone.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/revisor.rb",
+    "lib/revisor/client.rb",
+    "lib/revisor/client/session.rb",
+    "lib/revisor/client/tab.rb",
+    "revisor_client.gemspec",
+    "test/session_tab_test.rb",
+    "test/session_test.rb",
+    "test/test_helper.rb",
+    "test/test_pages/send_key_event.html",
+    "test/test_pages/send_mouse_click_event.html",
+    "test/test_pages/send_mouse_move_event.html"
+  ]
+  s.homepage = %q{http://github.com/sotakone/revisor/}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Ruby helper library for Revisor browser}
+  s.test_files = [
+    "test/session_tab_test.rb",
+    "test/session_test.rb",
+    "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/test/session_tab_test.rb

@@ -0,0 +1,143 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+
+class SessionTabTest < Test::Unit::TestCase
+  include RevisorTestHelper
+
+  def setup
+    create_client
+    @session = @client.start_session(:session_tab_test)
+    @tab = @session.create_tab :foo
+  end
+
+  def teardown
+    @session.stop
+  end
+
+  def test_session_tab_creation_and_deletion
+    assert_not_nil @tab
+    assert_equal :foo, @tab.name
+
+    tab2 = @session.create_tab :bar
+    assert tab2.destroy
+  end
+
+  def test_session_tab_creation_with_duplicate_name
+    assert_raise Revisor::Client::ServerError do
+      @session.create_tab :foo
+    end
+  end
+
+  def test_visit_url_and_wait_for_load
+    @tab.visit("http://example.com/")
+    @tab.wait_for_load
+    assert_equal "http://example.com/", @tab.evaluate_javascript("window.location.href")
+  end
+
+  def test_evaluate_javascript
+    @tab.visit("http://example.com/")
+    @tab.wait_for_load
+    assert_equal 4, @tab.evaluate_javascript("2 + 2")
+  end
+
+  def test_prompt_answer
+    @tab.visit("http://example.com/")
+    @tab.wait_for_load
+    @tab.set_prompt_answer("my answer", false)
+    assert_equal "my answer", @tab.evaluate_javascript("prompt('prompt')")
+
+    @tab.set_prompt_answer("my answer", true)
+    assert_equal "", @tab.evaluate_javascript("prompt('prompt')")
+  end
+
+  def test_confirm_answer
+    @tab.visit("http://example.com/")
+    @tab.wait_for_load
+    @tab.set_confirm_answer(true)
+    assert_equal true, @tab.evaluate_javascript("confirm('prompt')")
+
+    @tab.set_confirm_answer(false)
+    assert_equal false, @tab.evaluate_javascript("confirm('prompt')")
+  end
+
+  def test_save_screenshot
+    @tab.visit("http://example.com/")
+    @tab.wait_for_load
+
+    assert_equal "OK", @tab.save_screenshot("/tmp/twitter_screenshot.png", [1024, 1024])[:result]
+    assert File.exist?("/tmp/twitter_screenshot.png")
+  end
+
+  def test_wait_for_condition
+    @tab.visit("http://example.com/")
+    @tab.wait_for_load
+
+    # foo will be 42 after 1000 msec
+    @tab.evaluate_javascript("var foo = 0; setTimeout('foo = 42', 1000)")
+    assert @tab.wait_for_condition("foo == 42", 1000, 3)
+
+    # this one will never be true
+    assert_equal false, @tab.wait_for_condition("false", 1000, 3)
+  end
+
+  def test_send_mouse_click_event
+    @tab.visit(test_page_url("send_mouse_click_event"))
+    @tab.wait_for_load
+
+    @tab.e("window.scrollTo(40, 40)")
+
+    x, y = get_element_coordinates('first')
+    @tab.send_mouse_event "click", x + 10, y + 10
+
+    x, y = get_element_coordinates('second')
+    @tab.send_mouse_event "dblclick", x + 10, y + 10
+
+    # Third will be clicked only with Ctrl+Shift+Alt modifiers
+    x, y = get_element_coordinates('third')
+    @tab.send_mouse_event "click", x + 10, y + 10, :modifiers => ["control", "shift", "alt"]
+
+    assert_equal [true, true, true], @tab.e("[first_clicked, second_clicked, third_clicked]")
+  end
+
+  def test_send_mouse_move_event
+    @tab.visit(test_page_url("send_mouse_move_event"))
+    @tab.wait_for_load
+
+    x, y = get_element_coordinates('first')
+    @tab.send_mouse_event "move", x + 10, y + 10
+    @tab.send_mouse_event "move", x + 20, y + 20
+
+    assert_equal [[x + 10, y + 10], [x + 20, y + 20]], @tab.e("mousemove_coordinates")
+  end
+
+  def test_send_key_event
+    @tab.visit(test_page_url("send_key_event"))
+    @tab.wait_for_load
+
+    @tab.e("focusTextbox(1)")
+    @tab.send_key_event "press", "A", "A"
+    @tab.send_key_event "press", "B", "B"
+    @tab.send_key_event "press", "C", "C"
+    @tab.send_key_event "press", "Semicolon", "Ж"
+    @tab.send_key_event "press", "E",         "У"
+    @tab.send_key_event "press", "Q",         "Й"
+
+    assert_equal "ABCЖУЙ", @tab.e("document.getElementById('textbox1').value")
+
+    @tab.e("focusTextbox(2)")
+    @tab.send_key_event "down", "A", "A", :modifiers => ['shift']
+
+    @tab.e("focusTextbox(3)")
+    @tab.send_key_event "up", "A", "A", :modifiers => ['ctrl']
+
+    assert_equal [true, true], @tab.e("[keyWithShiftDowned, keyWithCtrlUpped]")
+  end
+
+  private
+
+  def get_element_coordinates(element_id)
+    x, y = @tab.e("[document.getElementById('#{element_id}').offsetLeft, document.getElementById('#{element_id}').offsetTop]")
+    assert x.is_a?(Fixnum) && y.is_a?(Fixnum)
+    return [x, y]
+  end
+
+end

data/test/session_test.rb

@@ -0,0 +1,42 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+
+class SessionTest < Test::Unit::TestCase
+  include RevisorTestHelper
+
+  def setup
+    create_client
+  end
+
+  def test_session_start_and_stop
+    session = @client.start_session(:default)
+    assert_equal :default, session.name
+    session.stop
+  end
+
+  def test_creation_of_session_with_duplicate_names
+    session = @client.start_session(:default)
+
+    assert_raise Revisor::Client::ServerError do
+      @client.start_session(:default)
+    end
+
+    @client.stop_session(:default)
+  end
+
+  def test_setting_and_getting_cookies
+    session = @client.start_session(:cookies_test)
+    session.set_cookies([{ :name => "foo", :value => "bar", :expires_at => Time.now + 3600 }], "http://sotakone.github.com")
+
+    c = session.get_cookies('http://sotakone.github.com/').first
+    assert_equal "foo", c['name']
+    assert_equal "bar", c['value']
+
+    # Also test cookie presence in JS
+    tab = session.create_tab "cookies_test"
+    tab.visit("http://sotakone.github.com/")
+    tab.wait_for_load
+
+    assert tab.e("document.cookie.match(/foo=bar/).length == 1")
+    tab.destroy
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,64 @@
+require File.join(File.dirname(__FILE__), "/../lib/revisor")
+require 'test/unit'
+
+module SetupAndTeardownOnce
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def suite
+      my_suite = super
+      klass = self.class
+
+      def my_suite.run(*args)
+        klass = eval(@name)
+        klass.setup_once
+        super(*args)
+        klass.teardown_once
+      end
+
+      return my_suite
+    end
+
+    def setup_once
+      # Override me in child classes
+    end
+
+    def teardown_once
+      # Override me in child classes
+    end
+
+  end
+end
+
+module RevisorTestHelper
+  def self.included(base)
+    base.send(:include, SetupAndTeardownOnce)
+    base.send(:include, InstanceMethods)
+    base.send(:extend, ClassMethods)
+  end
+
+  module InstanceMethods
+    def create_client
+      @client = Revisor::Client.new("localhost", 8080)
+    end
+
+    def test_page_url(test_page_name)
+      "file://" + File.dirname(File.expand_path(__FILE__)) + "/test_pages/#{test_page_name}.html"
+    end
+  end
+
+  module ClassMethods
+    def setup_once
+      unless Revisor.server_pid
+        Revisor.server_executable = ENV['REVISOR_PATH'] || 'revisor'
+        Revisor.start_server
+      end
+    end
+
+    def teardown_once
+      Revisor.stop_server
+    end
+  end
+end

data/test/test_pages/send_key_event.html

@@ -0,0 +1,35 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <title>send_key_event test page</title>
+
+    <script type="text/javascript">
+      var keyWithShiftDowned = false;
+      var keyWithCtrlUpped = false;
+
+      function focusTextbox(i) {
+        var tb = document.getElementById("textbox" + i);
+        tb.focus();
+      }
+
+      window.onload = function() {
+        document.getElementById("textbox2").onkeydown = function(e) {
+          if(e.shiftKey) {
+            keyWithShiftDowned = true;
+          }
+        };
+
+        document.getElementById("textbox3").onkeyup = function(e) {
+          if(e.ctrlKey) {
+            keyWithCtrlUpped = true;
+          }
+        };
+      }
+    </script>
+  </head>
+  <body>
+    <input type="text" id="textbox1" />
+    <input type="text" id="textbox2" />
+    <input type="text" id="textbox3" />
+  </body>
+</html>

data/test/test_pages/send_mouse_click_event.html

@@ -0,0 +1,40 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <title>send_mouse_event test page</title>
+
+    <style type="text/css" media="screen">
+      body {
+        margin: 0;
+        padding: 0;
+      }
+
+      #first, #second, #third {
+        width: 50px;
+        height: 50px;
+        position: absolute;
+        overflow: hidden;
+      }
+
+      #first {
+        background-color: #c00;
+      }
+
+      #second {
+        background-color: #0c0;
+        left: 2000px;
+      }
+
+      #third {
+        background-color: #00c;
+        left: 2000px;
+        top: 2000px;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="first" onclick="first_clicked = true; console.log('first clicked');">First</div>
+    <div id="second" ondblclick="second_clicked = true; console.log('second dblclicked');">Second</div>
+    <div id="third" onclick="third_clicked = (window.event.shiftKey && window.event.ctrlKey && window.event.altKey); console.log('third clicked');">Third</div>
+  </body>
+</html>

data/test/test_pages/send_mouse_move_event.html

@@ -0,0 +1,33 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <title>send_mouse_move_event test page</title>
+
+    <style type="text/css" media="screen">
+      body {
+        margin: 0;
+        padding: 0;
+      }
+
+      #first, #second, #third {
+        width: 50px;
+        height: 50px;
+        position: absolute;
+        overflow: hidden;
+      }
+
+      #first {
+        background-color: #c00;
+        left: 1000px;
+        top: 1000px;
+      }
+    </style>
+
+    <script type="text/javascript">
+      var mousemove_coordinates = [];
+    </script>
+  </head>
+  <body>
+    <div id="first" onmousemove="mousemove_coordinates.push([window.event.pageX, window.event.pageY]);">First</div>
+  </body>
+</html>

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: revisor_client
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mikhail Lapshin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-11 00:00:00 +04:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: sotakone@sotakone.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- VERSION
+- lib/revisor.rb
+- lib/revisor/client.rb
+- lib/revisor/client/session.rb
+- lib/revisor/client/tab.rb
+- revisor_client.gemspec
+- test/session_tab_test.rb
+- test/session_test.rb
+- test/test_helper.rb
+- test/test_pages/send_key_event.html
+- test/test_pages/send_mouse_click_event.html
+- test/test_pages/send_mouse_move_event.html
+has_rdoc: true
+homepage: http://github.com/sotakone/revisor/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Ruby helper library for Revisor browser
+test_files: 
+- test/session_tab_test.rb
+- test/session_test.rb
+- test/test_helper.rb