chrome_remote 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c2aa46eb656817f1c7cef04b5b604bbd7da4aaaa
-  data.tar.gz: fbad3f461b01b9bde4f6b90dcf46bc23fa18aa6b
+SHA256:
+  metadata.gz: 17aac463e9f35f90f51ff383713fd0055ecd1cd39ff4b6bbd1fa8790f30ba2e5
+  data.tar.gz: 4c25272969e7b3d692875379c5a38eac31fb49abccfa2cb51b4a3a44ca8ce61a
 SHA512:
-  metadata.gz: 5bce9f49de0bb134ff2cb0ed38a36bf1d4e2241a73682e1cf082aee2437e7c2d1842cbb7be3c66471e1bec6efa0dd23f32f1c1a0edd7fd2ddd6063c710200144
-  data.tar.gz: ce718db0bb534d36a1cc6377ae56150d70ce55f001c50114a1885e1dc4a5f0b16a792dd9e44e061f9726d634b519f6f015fece1f200d84315d789826020a35e0
+  metadata.gz: 92be3ac44443cfa7b031ee07f952922e32e0184dd39ffea5cd33b4139649ed42de72c1ee00d6c992dc44876801f5e8493a4315c3311898b4d060fd342f0280dd
+  data.tar.gz: 5d1c17b3e6fb9f527d5aa300a3fbbba835f90a93d8955b886c995a2e6aa0a4d9b1d22ad09223c3c25e1697a7119a13691d1aa4d2fc1d3ab4b5a0ff824a801cd9

data/.travis.yml

@@ -1,5 +1,7 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.0
-before_install: gem install bundler -v 1.15.1
+  - 2.4
+  - 2.5
+  - 2.6
+  - ruby-head

data/README.md

@@ -1,5 +1,8 @@
 # ChromeRemote
 
+[![Gem Version](https://img.shields.io/gem/v/chrome_remote.svg?style=for-the-badge)](https://rubygems.org/gems/chrome_remote)
+[![Build Status](https://img.shields.io/travis/cavalle/chrome_remote/master?style=for-the-badge)](https://travis-ci.org/cavalle/chrome_remote)
+
 ChromeRemote is a client implementation of the [Chrome DevTools Protocol][1] in Ruby. It lets you remotely control, instrument, inspect, debug and profile instances of Chrome/Chromium based browsers from your Ruby code.
 
 [1]: https://chromedevtools.github.io/devtools-protocol/
@@ -82,15 +85,18 @@ Additionally, since version 59, you can use the `--headless` flag to start Chrom
 
 ### Using the ChromeRemote API
 
-The [Chrome DevTools Protocol][1] is divided into a number of domains ([Page][3], [DOM][4], [Debugger][5], [Network][6], etc.). Each domain defines a number of **commands** it supports and **events** it generates. 
+The [Chrome DevTools Protocol][1] is divided into a number of domains ([Page][3], [DOM][4], [Debugger][5], [Network][6], etc.). Each domain defines a number of **commands** it supports and **events** it generates.
 
 ChromeRemote provides a simple API that lets you send commands, and handle events of any of the domains in the protocol.
 
 To start with, you need an instance of the `ChromeRemote` class.
 
 ```ruby
-chrome = ChromeRemote.client host: 'localhost', # optional, default: localhost
-                             port: 9222         # optional, default: 9222
+chrome = ChromeRemote.client(
+  host: 'localhost', # optional (default: localhost). Host of the Chrome remote server
+  port: 9222,        # optional (default: 9222). Port of the Chrome remote server
+  new_tab: false     # optional (default: false). Whether to use the browser's current tab or a new one
+)
 ```
 
 Now, to send commands, ChromeRemote provides the `ChromeRemote#send_cmd` method. For example, this is how you make Chrome navigate to a url by sending the [Page.navigate][7] command:
@@ -118,7 +124,7 @@ chrome.on "Network.requestWillBeSent" do |params|
   puts params["request"]["url"]
 end
 ```
-    
+
 With the `ChromeRemote#wait_for` method, you can wait until the next time a given event is triggered. For example, the following snippet navigates to a page and waits for the [Page.loadEventFired][9] event to happen:
 
 ```ruby
@@ -177,20 +183,31 @@ chrome.listen_until { requests == 5 }
 [8]: https://chromedevtools.github.io/devtools-protocol/tot/Network/#event-requestWillBeSent
 [9]: https://chromedevtools.github.io/devtools-protocol/tot/Page/#event-loadEventFired
 
+### Logger
+
+To log all incoming and outgoing messages you can pass [Logger](https://github.com/ruby/logger) compatible instance to client.
+
+```ruby
+client = ChromeRemote.client(logger: Logger.new($stdout))
+client.send_cmd('Page.enable')
+# I, [2019-03-06T22:32:28.433643 #5070]  INFO -- : SEND ► {"method":"Page.enable","params":{},"id":1}
+# I, [2019-03-06T22:32:28.440294 #5070]  INFO -- : ◀ RECV {"id":1,"result":{}}
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment or any of the scripts in the `/examples` directory (e.g. `bundle exec ruby examples/network_dump_and_screenshot.rb`).
 
-To install this gem onto your local machine, run `bundle exec rake install`. 
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 To release a new version (if you're a maintainer), update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/cavalle/chrome_remote. 
+Bug reports and pull requests are welcome on GitHub at https://github.com/cavalle/chrome_remote.
 
 This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to follow the [code of conduct](https://github.com/cavalle/chrome_remote/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/chrome_remote.gemspec

@@ -20,7 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "websocket-driver", "~> 0.6"
 
-  spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "em-websocket", "~> 0.5"

data/examples/network_dump_and_screenshot.rb

@@ -18,4 +18,4 @@ chrome.wait_for "Page.loadEventFired"
 
 # Take page screenshot
 response = chrome.send_cmd "Page.captureScreenshot"
-File.write "screenshot.png", Base64.decode64(response["data"])
+File.write "screenshot.png", Base64.decode64(response["data"])

data/lib/chrome_remote.rb

@@ -4,6 +4,8 @@ require "json"
 require "net/http"
 
 module ChromeRemote
+  class ChromeConnectionError < RuntimeError; end
+
   class << self
     DEFAULT_OPTIONS = {
       host: "localhost",
@@ -12,20 +14,38 @@ module ChromeRemote
 
     def client(options = {})
       options = DEFAULT_OPTIONS.merge(options)
+      logger = options.delete(:logger)
 
-      Client.new(get_ws_url(options))
+      Client.new(get_ws_url(options), logger)
     end
 
     private
 
     def get_ws_url(options)
-      response = Net::HTTP.get(options[:host], "/json", options[:port])
-      # TODO handle unsuccesful request
+      path = '/json'
+      path += '/new?about:blank'  if options.key?(:new_tab)
+
+      response = Net::HTTP.get(options[:host], path, options[:port])
       response = JSON.parse(response)
 
-      first_page = response.find {|e| e["type"] == "page"} 
-      # TODO handle no entry found
+      raise ChromeConnectionError unless response.any?
+
+      return response['webSocketDebuggerUrl'] if options.key?(:new_tab)
+
+      first_page = response.find {|e| e["type"] == "page"}
+
+      raise ChromeConnectionError unless first_page
+
       first_page["webSocketDebuggerUrl"]
+    rescue ChromeConnectionError
+      try ||= 0
+      try += 1
+
+      # Wait up to 5 seconds for Chrome to start fully
+      if try <= 50
+        sleep 0.1
+        retry
+      end
     end
   end
 end

data/lib/chrome_remote/client.rb

@@ -1,18 +1,23 @@
 require "chrome_remote/web_socket_client"
+require "logger"
 
 module ChromeRemote
   class Client
-    attr_reader :ws, :handlers
+    attr_reader :ws, :handlers, :logger
 
-    def initialize(ws_url)
+    def initialize(ws_url, logger = nil)
       @ws = WebSocketClient.new(ws_url)
       @handlers = Hash.new { |hash, key| hash[key] = [] }
+      @logger = logger || Logger.new(nil)
+      @last_id = 0
     end
 
     def send_cmd(command, params = {})
       msg_id = generate_unique_id
+      payload = {method: command, params: params, id: msg_id}.to_json
 
-      ws.send_msg({method: command, params: params, id: msg_id}.to_json)
+      logger.info "SEND ► #{payload}"
+      ws.send_msg(payload)
 
       msg = read_until { |msg| msg["id"] == msg_id }
       msg["result"]
@@ -42,12 +47,13 @@ module ChromeRemote
     private
 
     def generate_unique_id
-      @last_id ||= 0
       @last_id += 1
     end
 
     def read_msg
-      msg = JSON.parse(ws.read_msg)
+      msg = ws.read_msg
+      logger.info "◀ RECV #{msg}"
+      msg = JSON.parse(msg)
 
       # Check if it’s an event and invoke any handlers
       if event_name = msg["method"]

data/lib/chrome_remote/socket.rb

@@ -19,4 +19,4 @@ module ChromeRemote
       io.readpartial(1024)
     end
   end
-end
+end

data/lib/chrome_remote/version.rb

@@ -1,3 +1,3 @@
 module ChromeRemote
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/chrome_remote/web_socket_client.rb

@@ -15,11 +15,11 @@ module ChromeRemote
       setup_driver
       start_driver
     end
-    
+
     def send_msg(msg)
       driver.text msg
     end
-    
+
     def read_msg
       parse_input until msg = messages.shift
       msg
@@ -31,11 +31,11 @@ module ChromeRemote
       driver.on(:message) do |e|
         messages << e.data
       end
-      
+
       driver.on(:error) do |e|
         raise e.message
       end
-      
+
       driver.on(:close) do |e|
         @status = :closed
       end
@@ -54,4 +54,4 @@ module ChromeRemote
       @driver.parse(@socket.read)
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chrome_remote
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Luismi Cavalle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-03 00:00:00.000000000 Z
+date: 2019-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-driver
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -151,8 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: ChromeRemote is a client implementation of the Chrome DevTools Protocol in