ferrum 0.1.2 → 0.2

data/lib/ferrum/page/screenshot.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Ferrum
+  class Page
+    module Screenshot
+      def screenshot(**opts)
+        path, encoding = common_options(**opts)
+        options = screenshot_options(path, **opts)
+        data = command("Page.captureScreenshot", **options).fetch("data")
+        return data if encoding == :base64
+        save_file(path, data)
+      end
+
+      def pdf(**opts)
+        path, encoding = common_options(**opts)
+        options = pdf_options(**opts)
+        data = command("Page.printToPDF", **options).fetch("data")
+        return data if encoding == :base64
+        save_file(path, data)
+      end
+
+      private
+
+      def save_file(path, data)
+        bin = Base64.decode64(data)
+        File.open(path.to_s, "wb") { |f| f.write(bin) }
+      end
+
+      def common_options(encoding: :base64, path: nil, **_)
+        encoding = encoding.to_sym
+        encoding = :binary if path
+
+        if encoding == :binary && !path
+          raise "You have to provide `:path` for `:binary` encoding"
+        end
+
+        [path, encoding]
+      end
+
+      def pdf_options(landscape: false, paper_width: 8.5, paper_height: 11, scale: 1.0, **opts)
+        options = {}
+        options[:landscape] = landscape
+        options[:paperWidth] = paper_width.to_f
+        options[:paperHeight] = paper_height.to_f
+        options[:scale] = scale.to_f
+        options.merge(opts)
+      end
+
+      def screenshot_options(path = nil, format: nil, scale: 1.0, **opts)
+        options = {}
+
+        format ||= path ? File.extname(path).delete(".") : "png"
+        format = "jpeg" if format == "jpg"
+        raise "Not supported options `:format` #{format}. jpeg | png" if format !~ /jpeg|png/i
+        options.merge!(format: format)
+
+        options.merge!(quality: opts[:quality] ? opts[:quality] : 75) if format == "jpeg"
+
+        if !!opts[:full] && opts[:selector]
+          warn "Ignoring :selector in #screenshot since full: true was given at #{caller(1..1).first}"
+        end
+
+        if !!opts[:full]
+          width, height = evaluate("[document.documentElement.offsetWidth, document.documentElement.offsetHeight]")
+          options.merge!(clip: { x: 0, y: 0, width: width, height: height, scale: scale }) if width > 0 && height > 0
+        elsif opts[:selector]
+          rect = evaluate("document.querySelector('#{opts[:selector]}').getBoundingClientRect()")
+          options.merge!(clip: { x: rect["x"], y: rect["y"], width: rect["width"], height: rect["height"], scale: scale })
+        end
+
+        if scale != 1.0
+          if !options[:clip]
+            width, height = evaluate("[document.documentElement.clientWidth, document.documentElement.clientHeight]")
+            options[:clip] = { x: 0, y: 0, width: width, height: height }
+          end
+
+          options[:clip].merge!(scale: scale)
+        end
+
+        options
+      end
+    end
+  end
+end

data/lib/ferrum/targets.rb

@@ -102,17 +102,13 @@ module Ferrum
     end
 
     def targets
-      attempts = 1
-      begin
+      Ferrum.with_attempts(errors: EmptyTargetsError,
+                           max: TARGETS_RETRY_ATTEMPTS,
+                           wait: TARGETS_RETRY_WAIT) do
         # Targets cannot be empty the must be at least one default target.
         targets = @browser.command("Target.getTargets")["targetInfos"]
-        raise EmptyTargetsError.new("No target browser available") if targets.empty?
+        raise EmptyTargetsError if targets.empty?
         targets
-      rescue EmptyTargetsError
-        raise if attempts > TARGETS_RETRY_ATTEMPTS
-        attempts += 1
-        sleep TARGETS_RETRY_WAIT
-        retry
       end
     end
 

data/lib/ferrum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ferrum
-  VERSION = "0.1.2"
+  VERSION = "0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ferrum
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: '0.2'
 platform: ruby
 authors:
 - Dmitry Vorotilin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-27 00:00:00.000000000 Z
+date: 2019-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-driver
@@ -195,28 +195,27 @@ files:
 - README.md
 - lib/ferrum.rb
 - lib/ferrum/browser.rb
-- lib/ferrum/browser/api.rb
-- lib/ferrum/browser/api/cookie.rb
-- lib/ferrum/browser/api/header.rb
-- lib/ferrum/browser/api/intercept.rb
-- lib/ferrum/browser/api/screenshot.rb
 - lib/ferrum/browser/client.rb
 - lib/ferrum/browser/process.rb
 - lib/ferrum/browser/subscriber.rb
 - lib/ferrum/browser/web_socket.rb
-- lib/ferrum/cookie.rb
-- lib/ferrum/errors.rb
+- lib/ferrum/cookies.rb
+- lib/ferrum/headers.rb
+- lib/ferrum/keyboard.json
+- lib/ferrum/keyboard.rb
+- lib/ferrum/mouse.rb
 - lib/ferrum/network/error.rb
+- lib/ferrum/network/intercepted_request.rb
 - lib/ferrum/network/request.rb
 - lib/ferrum/network/response.rb
 - lib/ferrum/node.rb
 - lib/ferrum/page.rb
 - lib/ferrum/page/dom.rb
 - lib/ferrum/page/frame.rb
-- lib/ferrum/page/input.json
 - lib/ferrum/page/input.rb
 - lib/ferrum/page/net.rb
 - lib/ferrum/page/runtime.rb
+- lib/ferrum/page/screenshot.rb
 - lib/ferrum/targets.rb
 - lib/ferrum/version.rb
 homepage: https://github.com/route/ferrum

data/lib/ferrum/browser/api.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require "ferrum/browser/api/cookie"
-require "ferrum/browser/api/header"
-require "ferrum/browser/api/screenshot"
-require "ferrum/browser/api/intercept"
-
-module Ferrum
-  class Browser
-    module API
-      include Cookie, Header, Screenshot, Intercept
-    end
-  end
-end

data/lib/ferrum/browser/api/cookie.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Ferrum
-  class Browser
-    module API
-      module Cookie
-        def cookies
-          cookies = page.command("Network.getAllCookies")["cookies"]
-          cookies.map { |c| [c["name"], ::Ferrum::Cookie.new(c)] }.to_h
-        end
-
-        def set_cookie(name: nil, value: nil, cookie: nil, **options)
-          cookie = options.dup
-          cookie[:name]   ||= name
-          cookie[:value]  ||= value
-          cookie[:domain] ||= default_domain
-
-          expires = cookie.delete(:expires).to_i
-          cookie[:expires] = expires if expires > 0
-
-          page.command("Network.setCookie", **cookie)
-        end
-
-        # Supports :url, :domain and :path options
-        def remove_cookie(name:, **options)
-          raise "Specify :domain or :url option" if !options[:domain] && !options[:url] && !default_domain
-
-          options = options.merge(name: name)
-          options[:domain] ||= default_domain
-
-          page.command("Network.deleteCookies", **options)
-        end
-
-        def clear_cookies
-          page.command("Network.clearBrowserCookies")
-        end
-
-        private
-
-        def default_domain
-          URI.parse(base_url).host if base_url
-        end
-      end
-    end
-  end
-end

data/lib/ferrum/browser/api/header.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Ferrum
-  class Browser
-    module API
-      module Header
-        def headers=(headers)
-          @headers = {}
-          add_headers(headers)
-        end
-
-        def add_headers(headers, permanent: true)
-          if headers["Referer"]
-            page.referrer = headers["Referer"]
-            headers.delete("Referer") unless permanent
-          end
-
-          @headers.merge!(headers)
-          user_agent = @headers["User-Agent"]
-          accept_language = @headers["Accept-Language"]
-
-          set_overrides(user_agent: user_agent, accept_language: accept_language)
-          page.command("Network.setExtraHTTPHeaders", headers: @headers)
-        end
-
-        def add_header(header, permanent: true)
-          add_headers(header, permanent: permanent)
-        end
-      end
-    end
-  end
-end

data/lib/ferrum/browser/api/intercept.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Ferrum
-  class Browser
-    module API
-      module Intercept
-        def url_whitelist=(wildcards)
-          @url_whitelist = prepare_wildcards(wildcards)
-          page.intercept_request("*") if @client && !@url_whitelist.empty?
-        end
-
-        def url_blacklist=(wildcards)
-          @url_blacklist = prepare_wildcards(wildcards)
-          page.intercept_request("*") if @client && !@url_blacklist.empty?
-        end
-
-        private
-
-        def prepare_wildcards(wc)
-          Array(wc).map do |wildcard|
-            if wildcard.is_a?(Regexp)
-              wildcard
-            else
-              wildcard = wildcard.gsub("*", ".*")
-              Regexp.new(wildcard, Regexp::IGNORECASE)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ferrum/browser/api/screenshot.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-module Ferrum
-  class Browser
-    module API
-      module Screenshot
-        def screenshot(**opts)
-          encoding, path, options = screenshot_options(**opts)
-
-          data = if options[:format].to_s == "pdf"
-            options = {}
-            options[:paperWidth] = @paper_size[:width].to_f if @paper_size
-            options[:paperHeight] = @paper_size[:height].to_f if @paper_size
-            options[:scale] = @zoom_factor if @zoom_factor
-            page.command("Page.printToPDF", **options)
-          else
-            page.command("Page.captureScreenshot", **options)
-          end.fetch("data")
-
-          return data if encoding == :base64
-
-          bin = Base64.decode64(data)
-          File.open(path.to_s, "wb") { |f| f.write(bin) }
-        end
-
-        def zoom_factor=(value)
-          @zoom_factor = value.to_f
-        end
-
-        def paper_size=(value)
-          @paper_size = value
-        end
-
-        private
-
-        def screenshot_options(encoding: :base64, format: nil, path: nil, **opts)
-          options = {}
-
-          encoding = :binary if path
-
-          if encoding == :binary && !path
-            raise "Not supported option `:path` #{path}. Should be path to file"
-          end
-
-          format ||= path ? File.extname(path).delete(".") : "png"
-          format = "jpeg" if format == "jpg"
-          raise "Not supported options `:format` #{format}. jpeg | png | pdf" if format !~ /jpeg|png|pdf/i
-          options.merge!(format: format)
-
-          options.merge!(quality: opts[:quality] ? opts[:quality] : 75) if format == "jpeg"
-
-          if !!opts[:full] && opts[:selector]
-            warn "Ignoring :selector in #screenshot since full: true was given at #{caller(1..1).first}"
-          end
-
-          if !!opts[:full]
-            width, height = page.evaluate("[document.documentElement.offsetWidth, document.documentElement.offsetHeight]")
-            options.merge!(clip: { x: 0, y: 0, width: width, height: height, scale: @zoom_factor || 1.0 }) if width > 0 && height > 0
-          elsif opts[:selector]
-            rect = page.evaluate("document.querySelector('#{opts[:selector]}').getBoundingClientRect()")
-            options.merge!(clip: { x: rect["x"], y: rect["y"], width: rect["width"], height: rect["height"], scale: @zoom_factor || 1.0 })
-          end
-
-          if @zoom_factor
-            if !options[:clip]
-              width, height = page.evaluate("[document.documentElement.clientWidth, document.documentElement.clientHeight]")
-              options[:clip] = { x: 0, y: 0, width: width, height: height }
-            end
-
-            options[:clip].merge!(scale: @zoom_factor)
-          end
-
-          [encoding, path, options]
-        end
-      end
-    end
-  end
-end

data/lib/ferrum/cookie.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module Ferrum
-  class Cookie
-    def initialize(attributes)
-      @attributes = attributes
-    end
-
-    def name
-      @attributes["name"]
-    end
-
-    def value
-      @attributes["value"]
-    end
-
-    def domain
-      @attributes["domain"]
-    end
-
-    def path
-      @attributes["path"]
-    end
-
-    def size
-      @attributes["size"]
-    end
-
-    def secure?
-      @attributes["secure"]
-    end
-
-    def httponly?
-      @attributes["httpOnly"]
-    end
-
-    def session?
-      @attributes["session"]
-    end
-
-    def expires
-      if @attributes["expires"] > 0
-        Time.at(@attributes["expires"])
-      end
-    end
-  end
-end

data/lib/ferrum/errors.rb

@@ -1,94 +0,0 @@
-# frozen_string_literal: true
-
-module Ferrum
-  class NotImplemented < StandardError; end
-  class ModalNotFound < StandardError; end
-  class Error < StandardError; end
-  class NoSuchWindowError < Error; end
-  class EmptyTargetsError < Error; end
-  class NoExecutionContext < Error; end
-
-  class ClientError < Error
-    attr_reader :response
-
-    def initialize(response)
-      @response = response
-      super(response["message"])
-    end
-  end
-
-  class BrowserError < ClientError
-    def code
-      response["code"]
-    end
-
-    def data
-      response["data"]
-    end
-  end
-
-  class JavaScriptError < ClientError
-    attr_reader :class_name, :message
-
-    def initialize(response)
-      super
-      @class_name, @message = response.values_at("className", "description")
-    end
-  end
-
-  class StatusFailError < ClientError
-    def message
-      "Request to #{response["url"]} failed to reach server, check DNS and/or server status"
-    end
-  end
-
-  class FrameNotFound < ClientError
-    def name
-      response["args"].first
-    end
-
-    def message
-      "The frame \"#{name}\" was not found."
-    end
-  end
-
-  class NodeError < ClientError
-    attr_reader :node
-
-    def initialize(node, response)
-      @node = node
-      super(response)
-    end
-  end
-
-  class ObsoleteNode < NodeError
-    def message
-      "The element you are trying to interact with is either not part of the DOM, or is " \
-      "not currently visible on the page (perhaps display: none is set). " \
-      "It is possible the element has been replaced by another element and you meant to interact with " \
-      "the new element. If so you need to do a new find in order to get a reference to the " \
-      "new element."
-    end
-  end
-
-  class TimeoutError < Error
-    def message
-      "Timed out waiting for response. It's possible that this happened " \
-      "because something took a very long time (for example a page load " \
-      "was slow). If so, setting the :timeout option to a higher value might " \
-      "help."
-    end
-  end
-
-  class ScriptTimeoutError < Error
-    def message
-      "Timed out waiting for evaluated script to return a value"
-    end
-  end
-
-  class DeadBrowser < Error
-    def initialize(message = "Browser is dead")
-      super
-    end
-  end
-end