selenium_surfer 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in selenium_surfer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ignacio Baixas
+
+MIT License
+
+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/README.md

@@ -0,0 +1,29 @@
+# SeleniumSurfer
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'selenium_surfer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install selenium_surfer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/selenium_surfer/driver_bucket.rb

@@ -0,0 +1,78 @@
+module SeleniumSurfer
+
+  # ### Webdriver connection wrapper
+  #
+  # By wrapping the connection is posible to control reconnection and bound context,
+  # this allows for safe context navigation.
+  #
+  class DriverBucket
+
+    attr_reader :session_id
+
+    def initialize(_session_id, _anonymous)
+      @session_id = _session_id
+      @bound_ctx = nil
+      @anonymous = _anonymous
+    end
+
+    # get the current driver instance, reset it if required
+    def driver(_reset=false)
+      reset if _reset
+
+      # TODO retrieve config data from config file instead of ENV
+
+      if @driver.nil?
+        driver_name = SeleniumSurfer.config[:webdriver]
+        raise ConfigurationError.new 'must provide a webdriver type' if driver_name.nil?
+
+        @driver = case driver_name.to_sym
+        when 'remote'
+          url = SeleniumSurfer.config[:remote_host]
+
+          # setup a custom client to use longer timeouts
+          client = Selenium::WebDriver::Remote::Http::Default.new
+          client.timeout = SeleniumSurfer.config[:remote_timeout]
+
+          @driver = Selenium::WebDriver.for :remote, :url => url, :http_client => client
+        else
+          @driver = Selenium::WebDriver.for driver_name.to_sym
+        end
+      end
+
+      return @driver
+    end
+
+    # force current driver connection to be discarded
+    def reset
+      if @driver
+        @driver.quit rescue nil
+        @driver = nil
+      end
+    end
+
+    # return true if there is a context bound to this bucket
+    def bound?
+      not @bound_ctx.nil?
+    end
+
+    # bind a context to this bucket
+    #
+    # The context may implement the `on_unbind` method to be notified when
+    # the bucket it is unbound from the bucket
+    #
+    def bind(_ctx)
+      @bound_ctx.on_unbind if @bound_ctx and @bound_ctx.respond_to? :on_unbind
+      @bound_ctx = _ctx
+    end
+
+    # unbinds the currently bound context.
+    def unbind(_force_reset=false)
+      if @bound_ctx
+        @bound_ctx.on_unbind if @bound_ctx.respond_to? :on_unbind
+        @bound_ctx = nil
+      end
+      reset if _force_reset or @anonymous # reset bucket if required
+    end
+  end
+
+end

data/lib/selenium_surfer/errors.rb

@@ -0,0 +1,15 @@
+module SeleniumSurfer
+
+  # Error thrown when a bad configuration parameter is passed or missing
+  class ConfigurationError < StandardError; end
+
+  # Error thrown when a driver operation is attempted in an unbound context
+  class UnboundContextError < StandardError; end
+
+  # Error thrown when a programming setup error is found
+  class SetupError < StandardError; end
+
+  # Error thrown when an element operation is attempted in an empty search result set
+  class EmptySetError < StandardError; end
+
+end

data/lib/selenium_surfer/robot.rb

@@ -0,0 +1,104 @@
+module SeleniumSurfer
+
+  # ### Base class for selenium surfer robots
+  #
+  # This class defines the interface every test engine must implement.
+  #
+  # It also provides webdriver managed shared access, this allows for safe
+  # webdriver session persistance between tests.
+  #
+  # Usage: TODO
+  #
+  class Robot
+
+    @@all_buckets = {}
+    @@loaded_buckets = nil
+    @@block_options = nil
+
+    # execute a block with managed webdriver connections
+    #
+    # by putting all web related logic inside a managed block the
+    # user can rest asured that any unhandled exception inside the block will
+    # discard the requested webdrivers connections. This means that future
+    # calls to connect will always return valid driver connections.
+    #
+    def self.managed(_opt={})
+
+      raise SetupError.new 'cannot call managed block inside managed block' unless @@loaded_buckets.nil?
+
+      keep_sessions = _opt.fetch(:keep_sessions, false)
+      session_error = false
+
+      # TODO: When `keep_sessions` is used, special care should be taken in preventing a large number
+      # of sessions to remain in memory (like in de case a new session id  for each run)
+
+      unless keep_sessions
+        # use separate bucket collection if sessions are to be discarded
+        temp = @@all_buckets
+        @all_buckets = {}
+      end
+
+      @@loaded_buckets = []
+      @@block_options = _opt
+
+      begin
+        return yield
+      rescue
+        session_error = true
+        raise
+      ensure
+        force_reset = session_error or !keep_sessions
+        @@loaded_buckets.each { |b| b.unbind(force_reset) }
+        @@loaded_buckets = nil
+        @all_buckets = temp unless keep_sessions
+      end
+    end
+
+    # creates a new surf context and passes it to the given block.
+    #
+    # * Can only be called inside a `managed` block.
+    # * The context is released when block exits.
+    #
+    def self.new_surf_session(_session=nil, _opt={}, &_block)
+
+      # load context class to be used, must be a SurfContext or SurfContext subclass
+      ctx_class = _opt.fetch(:use, SurfContext)
+      raise SetupError.new 'invalid context class' unless ctx_class == SurfContext or ctx_class < SurfContext
+
+      # make sure this is called within a managed block
+      raise SetupError.new 'context is not managed' if @@loaded_buckets.nil?
+
+      if _session.nil? and not @@block_options.fetch(:nil_sessions, false)
+        # create an anonymous bucket
+        bucket = DriverBucket.new nil, true
+      else
+        bucket = @@all_buckets[_session]
+        bucket = @@all_buckets[_session] = DriverBucket.new _session, false if bucket.nil?
+        raise SetupError.new 'session already bound' if bucket.bound?
+      end
+
+      @@loaded_buckets << bucket
+      ctx = ctx_class.new bucket
+
+      # if block is not given, just return context, if given, pass it to block
+      # and ensure release
+      return ctx unless _block
+      begin
+        return _block.call ctx
+      ensure
+        bucket.unbind _opt.fetch(:on_exit, :release) == :discard
+      end
+    end
+
+    # Object instance flavor of `self.managed`
+    def managed(_opt={}, &_block)
+      return self.class.managed _opt, &_block
+    end
+
+    # Object instance flavor of `self.surf`
+    def new_surf_session(_session=nil, _opt={}, &_block)
+      return self.class.new_surf_session(_session, _opt, &_block)
+    end
+
+  end
+end

data/lib/selenium_surfer/search_context.rb

@@ -0,0 +1,75 @@
+require 'forwardable'
+
+module SeleniumSurfer
+
+  # ### WebDriver Element wrapper
+  #
+  # Provides jQuery-like access to elements.
+  #
+  class SearchContext
+    include Enumerable
+    extend Forwardable
+
+    def initialize(_elements)
+      @elements = _elements
+    end
+
+    # forward read-only array methods to context
+    def_delegators :context, :each, :[], :length, :count, :empty?, :first, :last
+
+    def explode(&_block)
+      return enum_for(__method__) if _block.nil?
+      context.each do |el|
+        _block.call SearchContext.new([el])
+      end
+    end
+
+    def search(_selector=nil, _options={})
+      _options[:css] = _selector if _selector
+      SearchContext.new search_elements(_options)
+    end
+
+    def fill(_value)
+      raise EmptySetError.new if empty?
+      context.first.clear
+      context.first.send_keys _value
+    end
+
+    # Any methods missing are forwarded to the first element.
+    def method_missing(_method, *_args, &_block)
+      m = /^(.*)_all$/.match _method.to_s
+      if m then
+        return [] if empty?
+        context.map { |e| e.send(m[1], *_args, &_block) }
+      else
+        raise EmptySetError.new if empty?
+        context.first.send(_method, *_args, &_block)
+      end
+    end
+
+    def respond_to?(_method, _include_all=false)
+      return true if super
+      m = /^.*_all$/.match _method.to_s
+      if m then
+        return true if empty?
+        context.first.respond_to? m[1], _include_all
+      else
+        raise EmptySetError.new if empty?
+        context.first.respond_to? _method, _include_all
+      end
+    end
+
+  private
+
+    def search_elements(_options)
+      context.inject([]) do |r, element|
+        r + element.find_elements(_options)
+      end
+    end
+
+    def context
+      @elements
+    end
+
+  end
+end

data/lib/selenium_surfer/surf_context.rb

@@ -0,0 +1,150 @@
+module SeleniumSurfer
+
+  # ### Base class for robot contexts
+  #
+  class SurfContext < SearchContext
+
+    # add a macro attribute writer to context.
+    #
+    # A macro attribute persist through context changes.
+    #
+    def self.macro_attr_writer(*_names)
+      _names.each do |name|
+        send :define_method, "#{name}=" do |v| @macro[name.to_sym] = v end
+      end
+    end
+
+    # add a macro attribute reader to context.
+    #
+    # A macro attribute persist through context changes.
+    #
+    def self.macro_attr_reader(*_names)
+      _names.each do |name|
+        send :define_method, "#{name}" do @macro[name.to_sym] end
+      end
+    end
+
+    # add a macro attribute accessor to context.
+    #
+    # A macro attribute persist through context changes.
+    #
+    def self.macro_attr_accessor(*_names)
+      macro_attr_reader *_names
+      macro_attr_writer *_names
+    end
+
+    macro_attr_accessor :max_retries
+
+    def initialize(_bucket, _macro=nil, _stack=nil)
+      @bucket = _bucket
+      @macro = _macro || {}
+      @stack = _stack || []
+
+      @bucket.bind self
+    end
+
+    # return true if context is bound
+    def bound?
+      not @bucket.nil?
+    end
+
+    # switch to another context
+    # new context class should be a SurfContext subclass
+    def switch_to(_klass=nil)
+      raise UnboundContextError.new unless bound?
+      _klass.new @bucket, @macro, @stack
+    end
+
+    # ## Helpers
+
+    # retrieves the current driver being used by this context
+    def driver
+      load_driver
+    end
+
+    # return the current page title
+    def title
+      load_driver.title
+    end
+
+    # navigate to a given url (uses the max_retries setting)
+    def navigate(_url, _params=nil)
+      _url += "?#{_params.to_query}" if _params
+      retries = 0
+
+      loop do
+        begin
+          load_driver(retries > 0).get(_url)
+          @stack = [] # clear stack after successfull navigation
+          break
+        rescue Timeout::Error, Selenium::WebDriver::Error::UnknownError
+          trace "Error when opening #{_url}!"
+          raise if retries >= @max_retries
+          retries += 1
+          sleep 1.0
+        end
+      end
+    end
+
+    # changes the context
+    # TODO: this method may be unecesary...
+    def step(_selector=nil, _options={})
+      _options[:css] = _selector if _selector
+      new_context = search_elements(_options)
+      begin
+        @stack << new_context
+        yield
+      ensure
+        @stack.pop
+      end
+
+      return true
+    end
+
+    # release current driver connection
+    def release
+      return false if not bound?
+      @bucket.unbind
+      return true
+    end
+
+    # release and discard the current driver connection.
+    def quit
+      return false if not bound?
+      @bucket.unbind true
+      return true
+    end
+
+    # resets the current driver connection, does not release it.
+    def reset
+      return false if not bound?
+      @bucket.reset
+      return true
+    end
+
+    # bucket context interface implementation
+    # not to be called directly
+    def on_unbind
+      @bucket = @stack = nil
+    end
+
+  private
+
+    def load_driver(_reset=false)
+      raise UnboundContextError.new if not bound?
+      @bucket.reset if _reset
+      @bucket.driver
+    end
+
+    def context
+      raise UnboundContextError.new if not bound?
+      @stack.last || [load_driver]
+    end
+
+    def observe
+      # get current url
+      return yield
+      # compare url after function call, if changed reset stack
+    end
+  end
+end

data/lib/selenium_surfer/version.rb

@@ -0,0 +1,3 @@
+module SeleniumSurfer
+  VERSION = "0.0.1"
+end

data/lib/selenium_surfer.rb

@@ -0,0 +1,38 @@
+require "selenium_surfer/version"
+require "selenium_surfer/errors"
+require "selenium_surfer/driver_bucket"
+require "selenium_surfer/search_context"
+require "selenium_surfer/surf_context"
+require "selenium_surfer/robot"
+
+module SeleniumSurfer
+
+  # Configuration defaults
+  @@config = {
+    :webdriver => nil,
+    :remote_host => 'http://localhost:8080',
+    :remote_timeout => 120
+  }
+
+  # Configure through hash
+  def self.configure(_opts = {})
+    _opts.each { |k,v| @@config[k.to_sym] = v if @@config.has_key? k.to_sym }
+  end
+
+  # Configure through yaml file
+  def self.configure_with(_path_to_yaml_file)
+    begin
+      config = YAML::load(IO.read(_path_to_yaml_file))
+    rescue Errno::ENOENT
+      log(:warning, "YAML configuration file couldn't be found. Using defaults."); return
+    rescue Psych::SyntaxError
+      log(:warning, "YAML configuration file contains invalid syntax. Using defaults."); return
+    end
+
+    configure(config)
+  end
+
+  def self.config
+    @@config
+  end
+end

data/selenium_surfer.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'selenium_surfer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "selenium_surfer"
+  spec.version       = SeleniumSurfer::VERSION
+  spec.authors       = ["Ignacio Baixas"]
+  spec.email         = ["ignacio@platan.us"]
+  spec.description   = %q{Selenium Surfer Robots!}
+  spec.summary       = %q{Base infrastructure for webdriver robots with session managing and rich DSL}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'selenium-webdriver', "~> 2.33.0"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: selenium_surfer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ignacio Baixas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.33.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.33.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Selenium Surfer Robots!
+email:
+- ignacio@platan.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/selenium_surfer.rb
+- lib/selenium_surfer/driver_bucket.rb
+- lib/selenium_surfer/errors.rb
+- lib/selenium_surfer/robot.rb
+- lib/selenium_surfer/search_context.rb
+- lib/selenium_surfer/surf_context.rb
+- lib/selenium_surfer/version.rb
+- selenium_surfer.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Base infrastructure for webdriver robots with session managing and rich DSL
+test_files: []
+has_rdoc: