selenium_surfer 0.0.2 → 0.0.3

data/lib/selenium_surfer/driver_bucket.rb

@@ -25,7 +25,7 @@ module SeleniumSurfer
         driver_name = SeleniumSurfer.config[:webdriver]
         raise ConfigurationError.new 'must provide a webdriver type' if driver_name.nil?
 
-        @driver = case driver_name.to_sym
+        case driver_name.to_sym
         when :remote
           url = SeleniumSurfer.config[:remote_host]
 
@@ -36,6 +36,9 @@ module SeleniumSurfer
           @driver = Selenium::WebDriver.for :remote, :url => url, :http_client => client
         else
           @driver = Selenium::WebDriver.for driver_name.to_sym
+
+          # apply browser configuration to new driver
+          @driver.manage.window.resize_to(SeleniumSurfer.config[:window_width], SeleniumSurfer.config[:window_height]) rescue nil
         end
       end
 
@@ -66,12 +69,12 @@ module SeleniumSurfer
     end
 
     # unbinds the currently bound context.
-    def unbind(_force_reset=false)
+    def unbind
       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
+      reset if @anonymous # reset bucket if required
     end
   end
 

data/lib/selenium_surfer/errors.rb

@@ -9,7 +9,19 @@ module SeleniumSurfer
   # Error thrown when a programming setup error is found
   class SetupError < StandardError; end
 
+  # Base class for context errors
+  class ContextError < StandardError
+
+    attr_reader :context, :source
+
+    def initialize(_msg, _context)
+      super _msg
+      @context = _context
+      @source = _context.root_context.page_source # cache page source for future reference
+    end
+  end
+
   # Error thrown when an element operation is attempted in an empty search result set
-  class EmptySetError < StandardError; end
+  class EmptySetError < ContextError; end
 
 end

data/lib/selenium_surfer/robot.rb

@@ -48,7 +48,10 @@ module SeleniumSurfer
         raise
       ensure
         force_reset = session_error or !keep_sessions
-        @@loaded_buckets.each { |b| b.unbind(force_reset) }
+        @@loaded_buckets.each do |bucket|
+          bucket.unbind
+          bucket.reset if force_reset
+        end
         @@loaded_buckets = nil
         @all_buckets = temp unless keep_sessions
       end
@@ -86,7 +89,8 @@ module SeleniumSurfer
       begin
         return _block.call ctx
       ensure
-        bucket.unbind _opt.fetch(:on_exit, :release) == :discard
+        bucket.unbind
+        bucket.reset if _opt.fetch(:on_exit, :release) == :discard
       end
     end
 

data/lib/selenium_surfer/search_context.rb

@@ -10,39 +10,54 @@ module SeleniumSurfer
     include Enumerable
     extend Forwardable
 
-    def initialize(_elements)
+    def initialize(_elements, _parent)
       @elements = _elements
+      @parent = _parent
+    end
+
+    # return the context's root context
+    def root_context
+      return @parent.root_context if @parent
+      self
+    end
+
+    # return the context's parent context
+    def parent_context
+      @parent
     end
 
     # forward read-only array methods to context
     def_delegators :context, :each, :[], :length, :count, :empty?, :first, :last
 
+    # yield individual SearchContext for each element contained in this result
     def explode(&_block)
       return enum_for(__method__) if _block.nil?
       context.each do |el|
-        _block.call SearchContext.new([el])
+        _block.call SearchContext.new([el], self)
       end
     end
 
+    # searches for elements that match a given selector
     def search(_selector=nil, _options={})
       _options[:css] = _selector if _selector
-      SearchContext.new search_elements(_options)
+      SearchContext.new search_elements(_options), self
     end
 
+    # clears and sends_keys to this context main element
     def fill(_value)
-      raise EmptySetError.new if empty?
+      raise EmptySetError.new('Cannot call \'fill\' on an empty set', self) if empty?
       context.first.clear
       context.first.send_keys _value
     end
 
-    # Any methods missing are forwarded to the first element.
+    # Any methods missing are forwarded to the main element (first).
     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?
+        raise EmptySetError.new("Cannot call '#{_method}' on an empty set", self) if empty?
         context.first.send(_method, *_args, &_block)
       end
     end
@@ -54,7 +69,7 @@ module SeleniumSurfer
         return true if empty?
         context.first.respond_to? m[1], _include_all
       else
-        raise EmptySetError.new if empty?
+        return true if empty?
         context.first.respond_to? _method, _include_all
       end
     end

data/lib/selenium_surfer/surf_context.rb

@@ -3,6 +3,7 @@ module SeleniumSurfer
   # ### Base class for robot contexts
   #
   class SurfContext < SearchContext
+    extend Forwardable
 
     # add a macro attribute writer to context.
     #
@@ -36,8 +37,10 @@ module SeleniumSurfer
     macro_attr_accessor :max_retries
 
     def initialize(_bucket, _macro=nil, _stack=nil)
+      super nil, nil
+
       @bucket = _bucket
-      @macro = _macro || {}
+      @macro = _macro || { max_retries: 5 }
       @stack = _stack || []
 
       @bucket.bind self
@@ -58,13 +61,24 @@ module SeleniumSurfer
     # ## Helpers
 
     # retrieves the current driver being used by this context
-    def driver
-      load_driver
+    def driver(_reset=false)
+      raise UnboundContextError.new if not bound?
+      @bucket.reset if _reset
+      @bucket.driver
     end
 
-    # return the current page title
-    def title
-      load_driver.title
+    # delegate some stuff to driver
+    def_delegators 'driver', :title, :current_url, :page_source
+    def_delegators 'driver.navigate', :back, :forward, :refresh
+
+    # return the current page url as an URI
+    def current_uri
+      URI.parse driver.current_url
+    end
+
+    # return the current page cookies as a hash
+    def cookies
+      driver.manage.all_cookies
     end
 
     # navigate to a given url (uses the max_retries setting)
@@ -74,12 +88,12 @@ module SeleniumSurfer
 
       loop do
         begin
-          load_driver(retries > 0).get(_url)
+          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
+        rescue Timeout::Error #, Selenium::WebDriver::Error::UnknownError
+          # TODO: log this
+          raise if retries >= max_retries
           retries += 1
           sleep 1.0
         end
@@ -87,7 +101,7 @@ module SeleniumSurfer
     end
 
     # changes the context
-    # TODO: this method may be unecesary...
+    # TODO: this method may be unnecesary...
     def step(_selector=nil, _options={})
       _options[:css] = _selector if _selector
       new_context = search_elements(_options)
@@ -110,15 +124,9 @@ module SeleniumSurfer
 
     # 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
+      @bucket.unbind
       return true
     end
 
@@ -130,15 +138,9 @@ module SeleniumSurfer
 
   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]
+      @stack.last || [driver]
     end
 
     def observe

data/lib/selenium_surfer/version.rb

@@ -1,3 +1,3 @@
 module SeleniumSurfer
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/selenium_surfer.rb

@@ -11,7 +11,9 @@ module SeleniumSurfer
   @@config = {
     :webdriver => nil,
     :remote_host => 'http://localhost:8080',
-    :remote_timeout => 120
+    :remote_timeout => 120,
+    :window_width => 1500,
+    :window_height => 1000
   }
 
   # Configure through hash

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selenium_surfer
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-13 00:00:00.000000000 Z
+date: 2013-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver