crabfarm 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccec565757953537736ab94a2f8a45f9abb12847
-  data.tar.gz: 927c3fd72e63af76517b0d3e53e43a91261028d9
+  metadata.gz: e0b57880b14cf2f7456a2d457e9c3b9531c9ac2b
+  data.tar.gz: 61200983d1469d597384640d3d3457547ab486fa
 SHA512:
-  metadata.gz: 933c56e98e7f9703756d25a379b45011292f310606886bd1d40b138e36f60a36877efb45cb730bee5208bcd364802d06ce40dcf4ac2064544124e7ac3bf59f07
-  data.tar.gz: 2f80e480debeb2f8f39a8e44493579205269fb1f198b175b02db597c5bd531d2dfb7342214f49e2ac95eb299d05b39d9446f1bef242318bbc15367f8476f53d0
+  metadata.gz: 65659324efa94632a56a2da599f760ec0f79199f307efaf9399580d23344456f076987baba5631c1be7ac37ac063da41b46fd8aaf762c49911eae1439ba74d84
+  data.tar.gz: db9ee502e2db56b89ad0ec80dea565537cb20577b6660f27f1c3e3fbd8392da8a8ff1608b7e1c5011b7e30ddd922b2d6367bcff5630ab90fe67bc4aa7a27b766

data/lib/crabfarm.rb

@@ -2,24 +2,21 @@ require "logger"
 require "forwardable"
 require "net/http"
 require "active_support/inflector"
-require "selenium-webdriver"
 
 require "crabfarm/version"
 require "crabfarm/errors"
 require "crabfarm/configuration"
 require "crabfarm/global_state"
-require "crabfarm/driver_bucket"
-require "crabfarm/driver_bucket_pool"
+require "crabfarm/driver_pool"
 require "crabfarm/http_client"
-require "crabfarm/default_driver_factory"
-require "crabfarm/phantom_driver_factory"
 require "crabfarm/phantom_runner"
 require "crabfarm/state_store"
 require "crabfarm/context"
 require "crabfarm/context_factory"
 require "crabfarm/transition_service"
-require "crabfarm/base_state"
-require "crabfarm/base_parser"
+require "crabfarm/base_navigator"
+require "crabfarm/base_reducer"
+require "crabfarm/base_struct"
 require "crabfarm/strategies"
 
 require "crabfarm/utils/port_discovery"
@@ -47,18 +44,20 @@ module Crabfarm
   end
 
   module Strategies
-    # bundled browser dsl adapters
-    register :browser_dsl, :surfer, 'Crabfarm::SurferBrowserDsl', 'crabfarm/adapters/browser/surfer'
-    register :browser_dsl, :watir, 'Crabfarm::WatirBrowserDsl', 'crabfarm/adapters/browser/watir', ['watir-webdriver']
-    register :browser_dsl, :capybara, 'Crabfarm::CapybaraBrowserDsl', 'crabfarm/adapters/browser/capybara', ['capybara']
+    # bundled browser adapters
+    register :browser, :phantomjs, 'Crabfarm::Adapters::Browser::PhantomJs', dependencies: ['selenium-webdriver']
+    register :browser, :firefox, 'Crabfarm::Adapters::Browser::Firefox', dependencies: ['selenium-webdriver']
+    register :browser, :chrome, 'Crabfarm::Adapters::Browser::Chrome', dependencies: ['selenium-webdriver']
+    register :browser, :remote, 'Crabfarm::Adapters::Browser::RemoteWebdriver', dependencies: ['selenium-webdriver']
+    register :browser, :noop, 'Crabfarm::Adapters::Browser::Noop'
+
+    # bundled webdriver dsl adapters
+    register :webdriver_dsl, :surfer, 'Crabfarm::Adapters::DriverWrapper::Surfer'
+    register :webdriver_dsl, :watir, 'Crabfarm::Adapters::DriverWrapper::Watir', dependencies: ['watir-webdriver']
+    register :webdriver_dsl, :capybara, 'Crabfarm::Adapters::DriverWrapper::Capybara', dependencies: ['capybara']
 
     # bundled parsers dsl adapters
-    register :parser_engine, :nokogiri, 'Crabfarm::NokogiriAdapter', 'crabfarm/adapters/parser/nokogiri'
-    register :parser_engine, :pdf_reader, 'Crabfarm::PdfReaderAdapter', 'crabfarm/adapters/parser/pdf_reader', ['pdf-reader']
-
-    # bundled state output builders
-    register :output_builder, :hash, 'Crabfarm::HashOutputBuilder', 'crabfarm/adapters/output/hash'
-    register :output_builder, :ostruct, 'Crabfarm::OStructOutputBuilder', 'crabfarm/adapters/output/ostruct'
-    register :output_builder, :jbuilder, 'Crabfarm::JbuilderOutputBuilder', 'crabfarm/adapters/output/jbuilder', ['jbuilder']
+    register :parser, :nokogiri, 'Crabfarm::Adapters::Parser::Nokogiri', dependencies: ['nokogiri']
+    register :parser, :pdf_reader, 'Crabfarm::Adapters::Parser::PdfReader', dependencies: ['pdf-reader']
   end
 end

data/lib/crabfarm/adapters/browser/abstract_webdriver.rb

@@ -0,0 +1,60 @@
+module Crabfarm
+  module Adapters
+    module Browser
+      class AbstractWebdriver
+
+        attr_accessor :config
+
+        def initialize(_proxy=nil)
+          @config = load_driver_config
+          @config[:proxy] = _proxy
+        end
+
+        def prepare_driver_services
+          # Nothing by default
+        end
+
+        def cleanup_driver_services
+          # Nothing by default
+        end
+
+        def build_driver(_session_id)
+
+          # load driver and configure general selenium settings
+          driver = build_webdriver_instance
+          driver.manage.window.resize_to(config[:window_width], config[:window_height]) rescue nil
+
+          return wrap_driver driver
+        end
+
+        def release_driver(_driver)
+          @driver.quit rescue nil
+        end
+
+      private
+
+        def wrap_driver _driver
+          if config[:dsl].present?
+            Strategies.load(:webdriver_dsl, config[:dsl]).wrap _driver
+          else _driver end
+        end
+
+        def build_webdriver_instance
+          raise NotImplementedError.new
+        end
+
+        def load_driver_config
+          {
+            capabilities: Crabfarm.config.webdriver_capabilities,
+            remote_host: Crabfarm.config.webdriver_remote_host,
+            remote_timeout: Crabfarm.config.webdriver_remote_timeout,
+            window_width: Crabfarm.config.webdriver_window_width,
+            window_height: Crabfarm.config.webdriver_window_height,
+            dsl: Crabfarm.config.webdriver_dsl
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/crabfarm/adapters/browser/chrome.rb

@@ -0,0 +1,24 @@
+require "crabfarm/adapters/browser/abstract_webdriver"
+
+module Crabfarm
+  module Adapters
+    module Browser
+      class Chrome < AbstractWebdriver
+
+      private
+
+        def build_webdriver_instance
+          switches = []
+
+          if config[:proxy].present?
+            switches << "--proxy-server=#{config[:proxy]}"
+            switches << "--ignore-certificate-errors"
+          end
+
+          Selenium::WebDriver.for :chrome, :switches => switches
+        end
+
+      end
+    end
+  end
+end

data/lib/crabfarm/adapters/browser/firefox.rb

@@ -0,0 +1,26 @@
+require "crabfarm/adapters/browser/abstract_webdriver"
+
+module Crabfarm
+  module Adapters
+    module Browser
+      class Firefox < AbstractWebdriver
+
+      private
+
+        def build_webdriver_instance
+          profile = Selenium::WebDriver::Firefox::Profile.new
+
+          if config.key? :proxy
+            profile.proxy = Selenium::WebDriver::Proxy.new({
+              :http => config[:proxy],
+              :ssl => config[:proxy]
+            })
+          end
+
+          Selenium::WebDriver.for :firefox, :profile => profile
+        end
+
+      end
+    end
+  end
+end

data/lib/crabfarm/adapters/browser/noop.rb

@@ -0,0 +1,25 @@
+module Crabfarm
+  module Adapters
+    module Browser
+      class Noop
+
+        def initialize(_proxy=nil)
+        end
+
+        def prepare_driver_services
+        end
+
+        def cleanup_driver_services
+        end
+
+        def build_driver(_session_id)
+          _session_id || :noop
+        end
+
+        def release_driver(_driver)
+        end
+
+      end
+    end
+  end
+end

data/lib/crabfarm/adapters/browser/phantom_js.rb

@@ -0,0 +1,59 @@
+require "crabfarm/adapters/browser/abstract_webdriver"
+require "crabfarm/phantom_runner"
+
+module Crabfarm
+  module Adapters
+    module Browser
+      class PhantomJs < AbstractWebdriver
+
+        def prepare_driver_services
+          @phantom = load_and_start_phantom if @phantom.nil?
+        end
+
+        def cleanup_driver_services
+          @phantom.stop unless @phantom.nil?
+          @phantom = nil
+        end
+
+      private
+
+        def build_webdriver_instance
+          client = Selenium::WebDriver::Remote::Http::Default.new
+          client.timeout = config[:remote_timeout]
+
+          driver = Selenium::WebDriver.for :remote, {
+            :url => phantom_url,
+            :http_client => client,
+            :desired_capabilities => config[:capabilities] || Selenium::WebDriver::Remote::Capabilities.firefox
+          }
+
+          # TODO: not sure if this is necessary...
+          # driver.send(:bridge).setWindowSize(config[:window_width], config[:window_height])
+
+          return driver
+        end
+
+        def load_and_start_phantom
+          new_phantom = PhantomRunner.new phantom_config
+          new_phantom.start
+          return new_phantom
+        end
+
+        def phantom_config
+          {
+            load_images: Crabfarm.config.phantom_load_images,
+            ssl: Crabfarm.config.phantom_ssl,
+            bin_path: Crabfarm.config.phantom_bin_path,
+            proxy: config[:proxy],
+            port: Utils::PortDiscovery.find_available_port
+          }
+        end
+
+         def phantom_url
+          "http://localhost:#{@phantom.port}"
+        end
+
+      end
+    end
+  end
+end

data/lib/crabfarm/adapters/browser/remote_webdriver.rb

@@ -0,0 +1,31 @@
+require "crabfarm/adapters/browser/abstract_webdriver"
+
+module Crabfarm
+  module Adapters
+    module Browser
+      class RemoteWebdriver < AbstractWebdriver
+
+      private
+
+        def build_webdriver_instance
+          client = Selenium::WebDriver::Remote::Http::Default.new
+          client.timeout = config[:remote_timeout]
+
+          if config.has_key? :proxy
+            client.proxy = Selenium::WebDriver::Proxy.new({
+              :http => config[:proxy],
+              :ssl => config[:proxy]
+            })
+          end
+
+          Selenium::WebDriver.for(:remote, {
+            :url => config[:remote_host],
+            :http_client => client,
+            :desired_capabilities => config[:capabilities] || Selenium::WebDriver::Remote::Capabilities.firefox
+          })
+        end
+
+      end
+    end
+  end
+end

data/lib/crabfarm/adapters/driver_wrapper/capybara.rb

@@ -0,0 +1,11 @@
+module Crabfarm
+  module Adapters
+    module DriverWrapper
+      class Capybara
+        def self.wrap(_driver)
+          raise NotImplementedError.new "Capybara adapter is not available yet"
+        end
+      end
+    end
+  end
+end

data/lib/crabfarm/adapters/driver_wrapper/surfer.rb

@@ -0,0 +1,13 @@
+require 'crabfarm/dsl/surfer'
+
+module Crabfarm
+  module Adapters
+    module DriverWrapper
+      class Surfer
+        def self.wrap(_driver)
+          Crabfarm::Dsl::Surfer::SurfContext.new _driver
+        end
+      end
+    end
+  end
+end

data/lib/crabfarm/adapters/{browser → driver_wrapper}/watir.rb

@@ -17,9 +17,13 @@ class Watir::ElementCollection
 end
 
 module Crabfarm
-  class WatirBrowserDsl
-    def self.wrap(_bucket)
-      Watir::Browser.new _bucket.original
+  module Adapters
+    module DriverWrapper
+      class Watir
+        def self.wrap(_driver)
+          ::Watir::Browser.new _driver
+        end
+      end
     end
   end
 end

data/lib/crabfarm/adapters/parser/nokogiri.rb

@@ -1,21 +1,23 @@
-require 'nokogiri'
-
 module Crabfarm
-  class NokogiriAdapter
-    def self.format
-      'html'
-    end
+  module Adapters
+    module Parser
+      class Nokogiri
+        def self.format
+          'html'
+        end
 
-    def self.parse(_raw)
-      Nokogiri::HTML _raw
-    end
+        def self.parse(_raw)
+          ::Nokogiri::HTML _raw
+        end
 
-    def self.preprocess_parsing_target(_target)
-      if _target.respond_to? :to_html
-        _target.to_html
-      else
-        _target
+        def self.preprocess_parsing_target(_target)
+          if _target.respond_to? :to_html
+            _target.to_html
+          else
+            _target
+          end
+        end
       end
     end
   end
-end
+end

data/lib/crabfarm/adapters/parser/pdf_reader.rb

@@ -1,17 +1,19 @@
-require "pdf-reader"
-
 module Crabfarm
-  class PdfReaderAdapter
-    def self.format
-      'pdf'
-    end
+  module Adapters
+    module Parser
+      class PdfReader
+        def self.format
+          'pdf'
+        end
 
-    def self.parse(_raw)
-      PDF::Reader.new StringIO.new _raw
-    end
+        def self.parse(_raw)
+          PDF::Reader.new StringIO.new _raw
+        end
 
-    def self.preprocess_parsing_target(_target)
-      _target
+        def self.preprocess_parsing_target(_target)
+          _target
+        end
+      end
     end
   end
-end
+end

data/lib/crabfarm/assertion/fields.rb

@@ -0,0 +1,85 @@
+require "active_support/core_ext/object/duplicable"
+require 'crabfarm/assertion/context'
+
+module Crabfarm
+  module Assertion
+    module Fields
+      include Context
+
+      module ClassMethods
+
+        def has_field(_name, _options={})
+          name = _name.to_sym
+
+          fields << name
+          field_defaults[name] = _options.delete :field_default
+
+          assertion = _options.delete :field_assertion
+          if assertion
+            define_method("#{name}=") { |v| field_hash[name] = assert(v).send(assertion, _options) }
+          elsif not _options[:field_readonly]
+            define_method("#{name}=") { |v| field_hash[name] = v }
+          end
+
+          define_method(name) { field_hash[name] }
+        end
+
+        def has_asserted_field(_name, _assertion, _options={})
+          has_field(_name, _options.merge(field_assertion: _assertion))
+        end
+
+        def has_array(_name)
+          has_field(_name, field_default: [], field_readonly: true)
+        end
+
+        def has_integer(_name, _options={})
+          has_asserted_field _name, :is_integer, _options
+        end
+
+        def has_float(_name, _options={})
+          has_asserted_field _name, :is_float, _options
+        end
+
+        def has_string(_name, _options={})
+          has_asserted_field _name, :is_string, _options
+        end
+
+        def has_word(_name, _options={})
+          has_asserted_field _name, :is_word, _options
+        end
+
+        def has_boolean(_name, _options={})
+          has_asserted_field _name, :is_boolean, _options
+        end
+
+        def fields
+          @fields ||= []
+        end
+
+        def field_defaults
+          @field_defaults ||= {}
+        end
+
+      end
+
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      def reset_fields
+        klass = self.class
+
+        @field_hash = {}
+        klass.fields.each do |field|
+          value = klass.field_defaults[field]
+          @field_hash[field] = value.duplicable? ? value.clone : value
+        end
+      end
+
+      def field_hash
+        @field_hash
+      end
+
+    end
+  end
+end