apparition 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4f76aefa6b5bebbab16d325e6f434846c2a426b74df9b8c0248465653124202
-  data.tar.gz: e9538e39a9c912471527fc456e801f0b3cc261bf042ddc82177d0e74e0769a33
+  metadata.gz: 69753c37a3e00ce9d57e86847601bef5e39a820ebef96db2c4ad7a6cb922f341
+  data.tar.gz: 486caf74087a17e078b39e4960a0c707b090142f1831d12b9755ad8b2cbb0596
 SHA512:
-  metadata.gz: 9f187d2d4b1185e2fe5460adf9435daec58d008789e69bca907df06bdc20f59b1b8808ac4f346ef1c7d00d4caa62a6fe7aaf033a9e3287299a007e8c9c7493fb
-  data.tar.gz: 443d5076e6b92f8c051a261663a8dc93a3ae2b0a75d87943579b762927b0f8d4e42a527b3c047c4ae937bf001198f7e14ebd8f4ea77de7ffd1ec04d4e096ad65
+  metadata.gz: 2f512ba7bbaca565d304a2ac0ede0d1c2b41fd3dc38d7f00b8dbe30b75bba2bbf3c35d7bcea2b00a17bdcbdb9d1702c27efcdfb9ef082b75de3988e7e48664c6
+  data.tar.gz: e01438d8900cd67015e0b473e7f710528ac1d8d4597cb8d0f47c97a1971a914b63cb52013bc1958d46621be58123105e1ed1f3d8f9e033ca0d908490fb152f8f

data/README.md

@@ -51,7 +51,7 @@ Apparition supports all Capybara features, and the following extended features:
 * `page.driver.render_base64(format, options)`
 * `page.driver.scroll_to(left, top)`
 * `page.driver.basic_authorize(user, password)`
-* `page.driver.set_proxy(ip, port, type, user, password)`
+* `page.driver.set_proxy(host, port, type, user, password, bypass: [bypass list passed to chrome])`
 * cookie handling
 * extra headers
 

data/lib/capybara/apparition/browser.rb

@@ -3,21 +3,31 @@
 require 'capybara/apparition/errors'
 require 'capybara/apparition/dev_tools_protocol/target_manager'
 require 'capybara/apparition/page'
+require 'capybara/apparition/console'
 require 'json'
 require 'time'
 
 module Capybara::Apparition
   class Browser
-    attr_reader :client, :logger, :paper_size, :zoom_factor
+    attr_reader :client, :paper_size, :zoom_factor, :console
+    extend Forwardable
+
+    delegate %i[visit current_url status_code
+                title frame_title frame_url
+                find scroll_to clear_network_traffic
+                evaluate evaluate_async execute
+                fullscreen maximize
+                response_headers
+                go_back go_forward refresh] => :current_page
 
     def initialize(client, logger = nil)
       @client = client
-      @logger = logger
       @current_page_handle = nil
       @targets = Capybara::Apparition::DevToolsProtocol::TargetManager.new
       @context_id = nil
       @js_errors = true
       @ignore_https_errors = false
+      @console = Console.new(logger)
 
       initialize_handlers
 
@@ -39,18 +49,6 @@ module Capybara::Apparition
       current_page.clear_network_traffic
     end
 
-    def visit(url)
-      current_page.visit url
-    end
-
-    def current_url
-      current_page.current_url
-    end
-
-    def status_code
-      current_page.status_code
-    end
-
     def body
       current_page.content
     end
@@ -60,40 +58,10 @@ module Capybara::Apparition
       # command 'source'
     end
 
-    def title
-      # Updated info doesn't have correct title when changed programmatically
-      # current_target.title
-      current_page.title
-    end
-
-    def frame_title
-      current_page.frame_title
-    end
-
-    def frame_url
-      current_page.frame_url
-    end
-
-    def find(method, selector)
-      current_page.find(method, selector)
-    end
-
     def click_coordinates(x, y)
       current_page.click_at(x, y)
     end
 
-    def evaluate(script, *args)
-      current_page.evaluate(script, *args)
-    end
-
-    def evaluate_async(script, wait_time, *args)
-      current_page.evaluate_async(script, wait_time, *args)
-    end
-
-    def execute(script, *args)
-      current_page.execute(script, *args)
-    end
-
     def switch_to_frame(frame)
       case frame
       when Capybara::Node::Base
@@ -166,10 +134,6 @@ module Capybara::Apparition
       true
     end
 
-    def scroll_to(left, top)
-      current_page.scroll_to(left, top)
-    end
-
     def render(path, options = {})
       check_render_options!(options, path)
       img_data = current_page.render(options)
@@ -197,14 +161,6 @@ module Capybara::Apparition
       current_page.set_viewport width: width, height: height, screen: screen
     end
 
-    def fullscreen
-      current_page.fullscreen
-    end
-
-    def maximize
-      current_page.maximize
-    end
-
     def network_traffic(type = nil)
       case type
       when :blocked
@@ -214,18 +170,6 @@ module Capybara::Apparition
       end
     end
 
-    def clear_network_traffic
-      current_page.clear_network_traffic
-    end
-
-    def set_proxy(ip, port, type, user, password)
-      args = [ip, port, type]
-      args << user if user
-      args << password if password
-      # TODO: Implement via CDP if possible
-      # command('set_proxy', *args)
-    end
-
     def headers
       current_page.extra_headers
     end
@@ -260,10 +204,6 @@ module Capybara::Apparition
       end
     end
 
-    def response_headers
-      current_page.response_headers
-    end
-
     def cookies
       current_page.command('Network.getCookies')['cookies'].each_with_object({}) do |c, h|
         h[c['name']] = Cookie.new(c)
@@ -343,18 +283,6 @@ module Capybara::Apparition
       raise
     end
 
-    def go_back
-      current_page.go_back
-    end
-
-    def go_forward
-      current_page.go_forward
-    end
-
-    def refresh
-      current_page.refresh
-    end
-
     def accept_alert
       current_page.add_modal(alert: true)
     end
@@ -383,6 +311,10 @@ module Capybara::Apparition
       current_target.page
     end
 
+    def console_messages
+      console.messages
+    end
+
   private
 
     def current_target

data/lib/capybara/apparition/console.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Capybara::Apparition
+  class Console
+    def initialize(logger = nil)
+      @logger = logger
+      @messages = []
+    end
+
+    def log(type, message)
+      @messages << OpenStruct.new(type: type, message: message)
+      @logger&.puts message
+    end
+
+    def clear
+      @messages.clear
+    end
+
+    def messages
+      @messages
+    end
+  end
+end

data/lib/capybara/apparition/cookie.rb

@@ -47,5 +47,10 @@ module Capybara::Apparition
     def expires
       Time.at @attributes['expires'] unless [nil, 0, -1].include? @attributes['expires']
     end
+
+    def ==(value)
+      return super unless value.is_a? String
+      self.value == value
+    end
   end
 end

data/lib/capybara/apparition/driver.rb

@@ -22,7 +22,8 @@ module Capybara::Apparition
                 headers headers= add_headers
                 cookies remove_cookie clear_cookies cookies_enabled=
                 clear_memory_cache
-                go_back go_forward refresh] => :browser
+                go_back go_forward refresh
+                console_messages] => :browser
 
     def initialize(app, options = {})
       @app       = app
@@ -37,9 +38,9 @@ module Capybara::Apparition
       true
     end
 
-    def chrome_url
-      'ws://localhost:9223'
-    end
+    # def chrome_url
+    #   'ws://localhost:9223'
+    # end
 
     def browser
       @browser ||= begin
@@ -64,6 +65,7 @@ module Capybara::Apparition
         browser_options['remote-debugging-port'] = options[:port] || 0
         browser_options['remote-debugging-address'] = options[:host] if options[:host]
         browser_options['window-size'] = options[:window_size].join(',') if options[:window_size]
+        browser_options.merge! @options[:browser] if @options[:browser]
         @launcher ||= Browser::Launcher.start(
           headless: options[:headless] != false,
           browser: browser_options
@@ -194,13 +196,19 @@ module Capybara::Apparition
       end
     end
 
-    def set_proxy(ip, port, type = 'http', user = nil, password = nil)
-      browser.set_proxy(ip, port, type, user, password)
+    def set_proxy(host, port, type = nil, user = nil, password = nil, bypass: [])
+      # TODO: Look at implementing via the CDP Fetch domain
+      raise ArgumentError, "Proxy auth is not yet implented" if user || password
+      @options[:browser] ||= {}
+      @options[:browser].merge!("proxy-server" => "#{type+"=" if type}#{host}:#{port}")
+      bypass = Array(bypass).join(';')
+      @options[:browser].merge!("proxy-bypass-list" => bypass) unless bypass.empty?
     end
 
     def add_header(name, value, options = {})
       browser.add_header({ name => value }, { permanent: true }.merge(options))
     end
+    alias_method :header, :add_header
 
     def response_headers
       browser.response_headers.each_with_object({}) do |(key, value), hsh|
@@ -208,7 +216,9 @@ module Capybara::Apparition
       end
     end
 
-    def set_cookie(name, value, options = {})
+    def set_cookie(name, value=nil, options = {})
+      name, value, options = parse_raw_cookie(name) if value.nil?
+
       options[:name]  ||= name
       options[:value] ||= value
       options[:domain] ||= begin
@@ -227,6 +237,7 @@ module Capybara::Apparition
       # credentials = ["#{user}:#{password}"].pack('m*').strip
       # add_header('Authorization', "Basic #{credentials}")
     end
+    alias_method :authenticate, :basic_authorize
 
     def debug
       if @options[:inspector]
@@ -324,8 +335,41 @@ module Capybara::Apparition
       client.timeout = sec
     end
 
+    def within_frame(frame_selector)
+      warn "Driver#within_frame is deprecated, please use Session#within_frame"
+
+      frame = case frame_selector
+      when Capybara::Apparition::Node
+        frame_selector
+      when Integer
+        find_css('iframe')[frame_selector]
+      when String
+        find_css("iframe[name='#{frame_selector}']")[0]
+      else
+        raise TypeError, 'Unknown frame selector'
+        command("FrameFocus")
+      end
+
+      switch_to_frame(frame)
+      begin
+        yield
+      ensure
+        switch_to_frame(:parent)
+      end
+    end
+
   private
 
+    def parse_raw_cookie(raw)
+      parts = raw.split(/;\s*/)
+      name, value = parts[0].split('=', 2)
+      options = parts[1..-1].each_with_object({}) do |part, opts|
+        name, value = part.split('=', 2)
+        opts[name.to_sym] = value
+      end
+      [name, value, options]
+    end
+
     def screen_size
       options[:screen_size] || [1366, 768]
     end
@@ -341,8 +385,9 @@ module Capybara::Apparition
         raise Capybara::ModalNotFound if modal_text.nil? || (expect_text && !modal_text.match(expect_regexp))
       rescue Capybara::ModalNotFound => e
         if timer.expired?
-          raise e, 'Unable to find modal dialog'\
-                   "#{" with #{expect_text}" if expect_text}"\
+          raise e, 'Timed out waiting for modal dialog. Unable to find modal dialog.' if !found_text
+          raise e, 'Unable to find modal dialog' \
+                   "#{" with #{expect_text}" if expect_text}" \
                    "#{", did find modal with #{found_text}" if found_text}"
         end
         sleep(0.05)

data/lib/capybara/apparition/errors.rb

@@ -128,12 +128,14 @@ module Capybara
           'new element.'
       end
     end
+    NodeNotAttachedError = ObsoleteNode
 
     class WrongWorld < ObsoleteNode
       def message
         'The element you are trying to access is not from the current page'
       end
     end
+    NodeNotAttachedError = ObsoleteNode
 
     class UnsupportedFeature < ClientError
       def name

data/lib/capybara/apparition/keyboard.rb

@@ -186,6 +186,7 @@ module Capybara::Apparition
       'abort': { 'keyCode': 3, 'code': 'Abort', 'key': 'Cancel' },
       'help': { 'keyCode': 6, 'code': 'Help', 'key': 'Help' },
       'backspace': { 'keyCode': 8, 'code': 'Backspace', 'key': 'Backspace' },
+      "\b": { 'keyCode': 8, 'code': 'Backspace', 'key': 'Backspace' },
       'tab': { 'keyCode': 9, 'code': 'Tab', 'key': 'Tab' },
       'enter': { 'keyCode': 13, 'code': 'Enter', 'key': 'Enter', 'text': "\r" },
       "\r": { 'keyCode': 13, 'code': 'Enter', 'key': 'Enter', 'text': "\r" },

data/lib/capybara/apparition/node.rb

@@ -64,6 +64,11 @@ module Capybara::Apparition
           .tr("\u00a0", ' ')
     end
 
+    def text # capybara-webkit method
+      warn "Node#text is deprecated, please use Node#visible_text instead"
+      visible_text
+    end
+
     def property(name)
       evaluate_on('function(name){ return this[name] }', value: name)
     end
@@ -161,8 +166,11 @@ module Capybara::Apparition
 
       @page.mouse.click_at pos.merge(button: button, count: count, modifiers: keys)
       if ENV['DEBUG']
-        new_pos = element_click_pos(options)
-        puts "Element moved from #{pos} to #{new_pos}" unless pos == new_pos
+        begin
+          new_pos = element_click_pos(options)
+          puts "Element moved from #{pos} to #{new_pos}" unless pos == new_pos
+        rescue WrongWorld
+        end
       end
       # Wait a short time to see if click triggers page load
       sleep 0.05
@@ -430,7 +438,11 @@ module Capybara::Apparition
         # Clear field by JavaScript assignment of the value property.
         # Script can change a readonly element which user input cannot, so
         # don't execute if readonly.
-        driver.execute_script "arguments[0].value = ''", self unless clear == :none
+        driver.execute_script <<~JS, self unless clear == :none
+          if (!arguments[0].readOnly) {
+            arguments[0].value = ''
+          }
+        JS
         send_keys(value)
       end
     end
@@ -706,13 +718,7 @@ module Capybara::Apparition
     GET_VALUE_JS = <<~JS
       function(){
         if ((this.tagName == 'SELECT') && this.multiple){
-          let selected = [];
-          for (let option of this.children) {
-            if (option.selected) {
-              selected.push(option.value);
-            }
-          }
-          return selected;
+          return Array.from(this.querySelectorAll("option:checked"),e=>e.value);
         } else {
           return this.value;
         }

data/lib/capybara/apparition/page.rb

@@ -339,8 +339,8 @@ module Capybara::Apparition
 
     def update_headers(async: false)
       method = async ? :async_command : :command
-      if extra_headers['User-Agent']
-        send(method, 'Network.setUserAgentOverride', userAgent: extra_headers['User-Agent'])
+      if (ua = extra_headers.find { |k, _v| k=~/^User-Agent$/i })
+        send(method, 'Network.setUserAgentOverride', userAgent: ua[1])
       end
       send(method, 'Network.setExtraHTTPHeaders', headers: extra_headers)
       setup_network_interception
@@ -526,9 +526,8 @@ module Capybara::Apparition
       end
 
       @session.on 'Runtime.consoleAPICalled' do |params|
-        @browser.logger&.puts(
-          "#{params['type']}: #{params['args'].map { |arg| arg['description'] || arg['value'] }.join(' ')}"
-        )
+        @browser.console.log(params['type'],
+                             "#{params['args'].map { |arg| arg['description'] || arg['value'] }.join(' ')}")
       end
 
       # @session.on 'Security.certificateError' do |params|
@@ -603,7 +602,9 @@ module Capybara::Apparition
       entry = history['entries'][history['currentIndex'] + delta]
       return nil unless entry
 
+      main_frame.loading(-1)
       command('Page.navigateToHistoryEntry', entryId: entry['id'])
+      wait_for_loaded
     end
 
     def _execute_script(script, *args)

data/lib/capybara/apparition/version.rb

@@ -2,6 +2,6 @@
 
 module Capybara
   module Apparition
-    VERSION = '0.0.3'
+    VERSION = '0.0.4'
   end
 end

data/lib/capybara/apparition.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'backports/2.4.0/enumerable/sum'
+require 'backports/2.4.0/string/match'
 require 'capybara'
 
 module Capybara

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: apparition
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Thomas Walpole
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-27 00:00:00.000000000 Z
+date: 2019-01-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: backports
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -197,6 +211,7 @@ files:
 - lib/capybara/apparition.rb
 - lib/capybara/apparition/browser.rb
 - lib/capybara/apparition/chrome_client.rb
+- lib/capybara/apparition/console.rb
 - lib/capybara/apparition/cookie.rb
 - lib/capybara/apparition/dev_tools_protocol/session.rb
 - lib/capybara/apparition/dev_tools_protocol/target.rb
@@ -232,7 +247,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="