chrome_remote 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d0252fdb7d96afe43850928ba57f69cdc66e373
+  data.tar.gz: 2500d1a4b85a0e77ee4b50db79011273b4e338dc
+SHA512:
+  metadata.gz: 86d013ba0f962afb6cf79847bd135f9ed72b1017ee0995bff299aa575f15d600d3c74f1070a5f7ad7fa99a38d051860da2cceede9813c795fb721b268b2a82b0
+  data.tar.gz: 20355a53f1b7dcf3f08a84fd3e111a3dc6015e3e5657dbe74f24c813cb6ca248785a40e7c053bc0848543e86f4c7606cbc1358bb3a512cf96a664e43d93add27

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.15.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at luismi@lmcavalle.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in chrome_remote.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Luismi Cavalle
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,185 @@
+# ChromeRemote
+
+ChromeRemote is a client implementation of the [Chrome DevTools Protocol][1] in Ruby. It lets you instrument, inspect, debug and profile instances of Chrome/Chromium based browsers from your Ruby code.
+
+[1]: https://chromedevtools.github.io/devtools-protocol/
+
+## Usage example
+
+The following snippet navigates to `https://github.com`, dumps any request made while loading the page, and takes a screenshot once the page is loaded:
+
+```ruby
+require 'chrome_remote'
+require 'base64'
+
+chrome = ChromeRemote.client
+
+# Enable events
+chrome.send_cmd "Network.enable"
+chrome.send_cmd "Page.enable"
+
+# Setup handler to log network requests
+chrome.on "Network.requestWillBeSent" do |params|
+  puts params["request"]["url"]
+end
+
+# Navigate to github.com and wait for the page to load
+chrome.send_cmd "Page.navigate", url: "https://github.com"
+chrome.wait_for "Page.loadEventFired"
+
+# Take page screenshot
+response = chrome.send_cmd "Page.captureScreenshot"
+File.write "screenshot.png", Base64.decode64(response["data"])
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chrome_remote'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install chrome_remote
+```
+
+## Usage
+
+To use ChromeRemote, you'll need a Chrome instance running on a known port (`localhost:9222` is the default), using the `--remote-debugging-port` flag.
+
+In Linux:
+
+```
+$ google-chrome --remote-debugging-port=9222
+```
+
+In macOS:
+
+```
+$ /Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --remote-debugging-port=9222
+```
+
+In Windows 7 or above:
+
+```
+> "C:\Program Files (x86)\Google\Chrome\Application\chrome.exe" --remote-debugging-port=9222
+```
+
+#### Headless mode
+
+Additionally, since version 59, you can use the `--headless` flag to start Chrome in [headless mode][2]
+
+[2]: https://developers.google.com/web/updates/2017/04/headless-chrome
+
+### 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. 
+
+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: 9992         # optional, default: 9992
+```
+
+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:
+
+```ruby
+chrome = ChromeRemote.client
+chrome.send_cmd "Page.navigate", url: "https://github.com"
+# => {:frameId=>1234}
+```
+
+To tackle events, you have several options but, first of all, you need to enable events for any domain you're interested in. You only need to do this once per domain:
+
+```ruby
+chrome = ChromeRemote.client
+chrome.send_cmd "Network.enable"
+```
+
+Now, you can use the `ChromeRemote#on` method to subscribe to an event. For instance, this is how you subscribe to the [Network.requestWillBeSent][8] event:
+
+```ruby
+chrome = ChromeRemote.client
+chrome.send_cmd "Network.enable"
+
+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
+chrome = ChromeRemote.client
+chrome.send_cmd "Page.navigate", url: "https://github.com"
+
+chrome.wait_for "Page.loadEventFired"
+# => {:timestamp=>34}
+```
+
+In certain occasions, after you have subscribed to one or several events, you may just want to process messages indefinitely, and let the event handlers process any event that may happen until you kill your script. For those cases, ChromeRemote provides the `ChromeRemote#listen` method:
+
+```ruby
+chrome = ChromeRemote.client
+chrome.send_cmd "Network.enable"
+
+chrome.on "Network.requestWillBeSent" do |params|
+  puts params["request"]["url"]
+end
+
+chrome.listen # will process incoming messages indefinitely
+```
+
+Finally, you have `ChromeRemote#listen_until` that will listen and process incoming messages but only until a certain condition is met. For instance, the following snippet waits until 5 requests are received and then continues:
+
+```ruby
+chrome = ChromeRemote.client
+chrome.send_cmd "Network.enable"
+
+requests = 0
+chrome.on "Network.requestWillBeSent" do |params|
+  requests += 1
+end
+
+chrome.listen_until { requests == 5 }
+
+# do other stuff
+```
+
+[3]: https://chromedevtools.github.io/devtools-protocol/tot/Page/
+[4]: https://chromedevtools.github.io/devtools-protocol/tot/DOM/
+[5]: https://chromedevtools.github.io/devtools-protocol/tot/Debugger/
+[6]: https://chromedevtools.github.io/devtools-protocol/tot/Network/
+[7]: https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-navigate
+[8]: https://chromedevtools.github.io/devtools-protocol/tot/Network/#event-requestWillBeSent
+[9]: https://chromedevtools.github.io/devtools-protocol/tot/Page/#event-loadEventFired
+
+## 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 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. 
+
+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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "chrome_remote"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/chrome_remote.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "chrome_remote/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "chrome_remote"
+  spec.version       = ChromeRemote::VERSION
+  spec.authors       = ["Luismi Cavalle"]
+  spec.email         = ["luismi@lmcavalle.com"]
+
+  spec.summary       = "ChromeRemote is a client implementation of the Chrome DevTools Protocol in Ruby"
+  spec.homepage      = "https://github.com/cavalle/chrome_remote"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  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"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "webmock"
+end

data/examples/network_dump_and_screenshot.rb

@@ -0,0 +1,21 @@
+require 'chrome_remote'
+require 'base64'
+
+chrome = ChromeRemote.client
+
+# Enable events
+chrome.send_cmd "Network.enable"
+chrome.send_cmd "Page.enable"
+
+# Setup handler to log network requests
+chrome.on "Network.requestWillBeSent" do |params|
+  puts params["request"]["url"]
+end
+
+# Navigate to github.com and wait for the page to load
+chrome.send_cmd "Page.navigate", url: "https://github.com"
+chrome.wait_for "Page.loadEventFired"
+
+# Take page screenshot
+response = chrome.send_cmd "Page.captureScreenshot"
+File.write "screenshot.png", Base64.decode64(response["data"])

data/lib/chrome_remote.rb

@@ -0,0 +1,31 @@
+require "chrome_remote/version"
+require "chrome_remote/client"
+require "json"
+require "net/http"
+
+module ChromeRemote
+  class << self
+    DEFAULT_OPTIONS = {
+      host: "localhost",
+      port: 9222
+    }
+
+    def client(options = {})
+      options = DEFAULT_OPTIONS.merge(options)
+
+      Client.new(get_ws_url(options))
+    end
+
+    private
+
+    def get_ws_url(options)
+      response = Net::HTTP.get(options[:host], "/json", options[:port])
+      # TODO handle unsuccesful request
+      response = JSON.parse(response)
+
+      first_page = response.find {|e| e["type"] == "page"} 
+      # TODO handle no entry found
+      first_page["webSocketDebuggerUrl"]
+    end
+  end
+end

data/lib/chrome_remote/client.rb

@@ -0,0 +1,65 @@
+require "chrome_remote/web_socket_client"
+
+module ChromeRemote
+  class Client
+    attr_reader :ws, :handlers
+
+    def initialize(ws_url)
+      @ws = WebSocketClient.new(ws_url)
+      @handlers = Hash.new {|hash, key| hash[key] = [] }
+    end
+  
+    def send_cmd(command, params = {})  
+      msg_id = generate_unique_id
+      
+      ws.send_msg({method: command, params: params, id: msg_id}.to_json)
+      
+      msg = read_until { |msg| msg["id"] == msg_id }
+      msg["result"]
+    end
+
+    def on(event_name, &block)
+      handlers[event_name] << block
+    end
+
+    def listen_until(&block)
+      read_until { block.call }
+    end
+
+    def listen
+      read_until { false }
+    end
+
+    def wait_for(event_name)
+      msg = read_until { |msg| msg["method"] == event_name }
+      msg["params"]
+    end
+  
+    private
+  
+    def generate_unique_id
+      @last_id ||= 0
+      @last_id += 1
+    end
+
+    def read_msg
+      msg = JSON.parse(ws.read_msg)
+
+      # Check if it’s an event and invoke any handlers
+      if event_name = msg["method"]
+        handlers[event_name].each do |handler|
+          handler.call(msg["params"])
+        end
+      end
+
+      msg
+    end
+
+    def read_until(&block)
+      loop do
+        msg = read_msg
+        return msg if block.call(msg)
+      end
+    end
+  end
+end

data/lib/chrome_remote/socket.rb

@@ -0,0 +1,22 @@
+require "socket"
+
+module ChromeRemote
+  class Socket
+    attr_reader :url, :io
+
+    def initialize(url)
+      uri = URI.parse(url)
+
+      @url = url
+      @io = TCPSocket.new(uri.host, uri.port)
+    end
+
+    def write(data)
+      io.print data
+    end
+
+    def read
+      io.readpartial(1024)
+    end
+  end
+end

data/lib/chrome_remote/version.rb

@@ -0,0 +1,3 @@
+module ChromeRemote
+  VERSION = "0.1.0"
+end

data/lib/chrome_remote/web_socket_client.rb

@@ -0,0 +1,57 @@
+require "websocket/driver"
+require "chrome_remote/socket"
+
+module ChromeRemote
+  class WebSocketClient
+    attr_reader :socket, :driver, :messages, :status
+
+    def initialize(url)
+      @socket = ChromeRemote::Socket.new(url)
+      @driver = ::WebSocket::Driver.client(socket)
+
+      @messages = []
+      @status = :closed
+
+      setup_driver
+      start_driver
+    end
+    
+    def send_msg(msg)
+      driver.text msg
+    end
+    
+    def read_msg
+      parse_input until msg = messages.shift
+      msg
+    end
+
+    private
+
+    def setup_driver
+      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
+
+      driver.on(:open) do |e|
+        @status = :open
+      end
+    end
+
+    def start_driver
+      driver.start
+      parse_input until status == :open
+    end
+
+    def parse_input
+      @driver.parse(@socket.read)
+    end
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: chrome_remote
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luismi Cavalle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: websocket-driver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- luismi@lmcavalle.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chrome_remote.gemspec
+- examples/network_dump_and_screenshot.rb
+- lib/chrome_remote.rb
+- lib/chrome_remote/client.rb
+- lib/chrome_remote/socket.rb
+- lib/chrome_remote/version.rb
+- lib/chrome_remote/web_socket_client.rb
+homepage: https://github.com/cavalle/chrome_remote
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: ChromeRemote is a client implementation of the Chrome DevTools Protocol in
+  Ruby
+test_files: []