playwright-ruby-client 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac3e5cd3487407baf16ee61f1c08e9a2a20e7463027998218c5466c853c94acf
+  data.tar.gz: add832c083cf0ce9cdf94f044649a815cfee24221385957594f3644264d97327
+SHA512:
+  metadata.gz: beb033e38e066d9bf459af794b0112ded024038d7c1903f89902c0d36e9ed0c57191ce72ff2880664719cb333350aa5a85747ab18f5ad113f1b5df2a781c891e
+  data.tar.gz: 5c0723a2d4bd529e30eb78adb5b44bbba44df43d1160ce48c1323aba91e064d05e19ee5fb74c1abe6c1f4ecce127fec297e45fd72172a4bde53add9ffc8376eb

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

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 iwaki@i3-systems.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,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in playwright.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 YusukeIwaki
+
+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,49 @@
+[![Gem Version](https://badge.fury.io/rb/playwright-ruby-client.svg)](https://badge.fury.io/rb/playwright-ruby-client)
+
+# playwright-ruby-client
+
+A Ruby client for Playwright driver.
+
+## Getting Started
+
+At this point, playwright-ruby-client doesn't include the downloader of playwright-cli, so **we have to install [playwright-cli](https://github.com/microsoft/playwright-cli) in advance**.
+
+via npm: `npm install -g playwright-cli`
+
+or
+
+direct download: `wget https://playwright.azureedge.net/builds/cli/next/playwright-cli-0.180.0-next.1608746109749-cbc13bd-mac.zip`
+
+(`-mac.zip` should be replaced for another OS)
+
+### Capture a site
+
+```ruby
+require 'playwright'
+
+Playwright.create(playwright_cli_executable_path: '/path/to/playwright-cli') do |playwright|
+  playwright.chromium.launch(headless: false) do |browser|
+    page = browser.new_page
+    page.goto('https://github.com/YusukeIwaki')
+    page.screenshot(path: './YusukeIwaki.png')
+  end
+end
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, 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/[USERNAME]/playwright-ruby-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Playwright project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/playwright-ruby-client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'playwright'
+
+# 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.
+
+require 'pry'
+Pry.start

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/lib/playwright.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# namespace declaration
+module Playwright; end
+
+# concurrent-ruby
+require 'concurrent'
+
+# modules & constants
+require 'playwright/errors'
+require 'playwright/events'
+require 'playwright/event_emitter'
+
+require 'playwright/channel'
+require 'playwright/channel_owner'
+require 'playwright/connection'
+require 'playwright/transport'
+require 'playwright/version'
+
+require 'playwright/playwright_api'
+# load generated files
+Dir[File.join(__dir__, 'playwright_api', '*.rb')].each { |f| require f }
+
+module Playwright
+  module_function def create(playwright_cli_executable_path:, &block)
+    raise ArgumentError.new("block must be provided") unless block
+
+    connection = Connection.new(playwright_cli_executable_path: playwright_cli_executable_path)
+
+    playwright_promise = connection.async_wait_for_object_with_known_name('Playwright')
+    Thread.new { connection.run }
+    playwright = PlaywrightApi.from_channel_owner(playwright_promise.value!)
+    begin
+      block.call(playwright)
+    ensure
+      connection.stop
+    end
+  end
+end

data/lib/playwright/channel.rb

@@ -0,0 +1,28 @@
+module Playwright
+  class Channel
+    include EventEmitter
+
+    # @param connection [Playwright::Connection]
+    # @param guid [String]
+    # @param object [Playwright::ChannelOwner]
+    def initialize(connection, guid, object:)
+      @connection = connection
+      @guid = guid
+      @object = object
+    end
+
+    attr_reader :guid, :object
+
+    # @param method [String]
+    # @param params [Hash]
+    def send_message_to_server(method, params = {})
+      result = @connection.send_message_to_server(@guid, method, params)
+      if result.is_a?(Hash)
+        _type, channel_owner = result.first
+        channel_owner
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/playwright/channel_owner.rb

@@ -0,0 +1,80 @@
+module Playwright
+  class ChannelOwner
+    include Playwright::EventEmitter
+
+    def self.from(channel)
+      channel.object
+    end
+
+    # @param parent [Playwright::ChannelOwner|Playwright::Connection]
+    # @param type [String]
+    # @param guid [String]
+    # @param initializer [Hash]
+    def initialize(parent, type, guid, initializer)
+      @objects = {}
+
+      if parent.is_a?(ChannelOwner)
+        @connection = parent.instance_variable_get(:@connection)
+        @connection.send(:update_object_from_channel_owner, guid, self)
+        @parent = parent
+        @parent.send(:update_object_from_child, guid, self)
+      elsif parent.is_a?(Connection)
+        @connection = parent
+        @connection.send(:update_object_from_channel_owner, guid, self)
+      else
+        raise ArgumentError.new('parent must be an instance of Playwright::ChannelOwner or Playwright::Connection')
+      end
+
+      @channel = Channel.new(@connection, guid, object: self)
+      @type = type
+      @guid = guid
+      @initializer = initializer
+
+      after_initialize
+    end
+
+    attr_reader :channel
+
+    def dispose
+      # Clean up from parent and connection.
+      @parent&.send(:delete_object_from_child, @guid)
+      @connection.send(:delete_object_from_channel_owner, @guid)
+
+      # Dispose all children.
+      @objects.each_value(&:dispose)
+      @objects.clear
+    end
+
+    private
+
+    def after_initialize
+    end
+
+    def update_object_from_child(guid, child)
+      @objects[guid] = child
+    end
+
+    def delete_object_from_child(guid)
+      @objects.delete(guid)
+    end
+  end
+
+  class RootChannelOwner < ChannelOwner
+    # @param connection [Playwright::Connection]
+    def initialize(connection)
+      super(connection, '', '', {})
+    end
+  end
+
+  # namespace declaration
+  module ChannelOwners ; end
+
+  def self.define_channel_owner(class_name, &block)
+    klass = Class.new(ChannelOwner)
+    klass.class_eval(&block) if block
+    ChannelOwners.const_set(class_name, klass)
+  end
+end
+
+# load subclasses
+Dir[File.join(__dir__, 'channel_owners', '*.rb')].each { |f| require f }

data/lib/playwright/channel_owners/android.rb

@@ -0,0 +1,3 @@
+module Playwright
+  define_channel_owner :Android
+end

data/lib/playwright/channel_owners/binding_call.rb

@@ -0,0 +1,4 @@
+module Playwright
+  define_channel_owner :BindingCall do
+  end
+end

data/lib/playwright/channel_owners/browser.rb

@@ -0,0 +1,80 @@
+module Playwright
+  # @ref https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_browser.py
+  define_channel_owner :Browser do
+    def after_initialize
+      @contexts = Set.new
+      @channel.on('close', method(:handle_close))
+    end
+
+    def contexts
+      @contexts.to_a
+    end
+
+    def connected?
+      @connected
+    end
+
+    def new_context(**options)
+      params = options.dup
+      # @see https://github.com/microsoft/playwright/blob/5a2cfdbd47ed3c3deff77bb73e5fac34241f649d/src/client/browserContext.ts#L265
+      if params[:viewport] == 0
+        params.delete(:viewport)
+        params[:noDefaultViewport] = true
+      end
+      if params[:extraHTTPHeaders]
+        # TODO
+      end
+      if params[:storageState].is_a?(String)
+        params[:storageState] = JSON.parse(File.read(params[:storageState]))
+      end
+
+      resp = @channel.send_message_to_server('newContext', params.compact)
+      context = ChannelOwners::BrowserContext.from(resp)
+      @contexts << context
+      context.browser = self
+      context.options = params
+      context
+    end
+
+    def new_page(*args)
+      context = new_context(*args)
+      page = context.new_page
+      page.owned_context = context
+      context.owner_page = page
+      page
+    end
+
+    def close
+      return if @closed_or_closing
+      @closed_or_closing = true
+      @channel.send_message_to_server('close')
+      nil
+    rescue => err
+      raise unless safe_close_error?(err)
+    end
+
+    def version
+      @initializer['version']
+    end
+
+    private
+
+    def handle_close(_ = {})
+      @connected = false
+      emit(Events::Browser::Disconnected)
+      @closed_or_closing = false
+    end
+
+    # @param err [Exception]
+    def safe_close_error?(err)
+      return true if err.is_a?(Transport::AlreadyDisconnectedError)
+
+      [
+        'Browser has been closed',
+        'Target page, context or browser has been closed',
+      ].any? do |closed_message|
+        err.message.end_with?(closed_message)
+      end
+    end
+  end
+end

data/lib/playwright/channel_owners/browser_context.rb

@@ -0,0 +1,13 @@
+module Playwright
+  # @ref https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_browser_context.py
+  define_channel_owner :BrowserContext do
+    attr_writer :browser, :owner_page, :options
+
+    # @returns [Playwright::Page]
+    def new_page
+      raise 'Please use browser.new_context' if @owner_page
+      resp = @channel.send_message_to_server('newPage')
+      ChannelOwners::Page.from(resp)
+    end
+  end
+end