robro 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10669183561bee9dc05019e9ba48e4a310d677bf7f6d894a2087b921bcbbf4e2
+  data.tar.gz: 5dc3de7e22944e99eb1573ec854c6c85c448c372b133e10a81919888b35106df
+SHA512:
+  metadata.gz: dc6d2c6335ddbad6ac9d1a4eeef648b1b1762230f3d9dc547adf73760662f070ec63b8cbecc17a0949ee3c6d799518c2bc469915ca7a60ebe5ade369f94f417d
+  data.tar.gz: ed9fc9c0d20e14fcf379617fccf84f98abb30e03936f71660bae4c79e21c7054b3b701d46ec0cb1dd1543900d774280ffd8574b091f065f09ed99d35054768cc

data/.gitignore

@@ -0,0 +1,11 @@
+.rspec_status
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+/.byebug_history

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/Gemfile

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

data/README.md

@@ -0,0 +1,32 @@
+# Robro
+
+**Robro**, _Robotized brower_, a tool to ease some tasks automation that needs a _real_ browser.
+
+Technically, `robro` is a CLI that starts a browser and provides some helpers to drive it.
+
+**Robro** is designed to run _user scripts_, specialized for the wanted automation. Out of the box, `robro` only provides a `browse` command to starts a browser, visit an URL and drop a ruby shell.
+
+## Usage
+
+Built-in command: `browse` will open the provided URL than simply drop a ruby shell (_byebug_).
+
+```
+robro browse https://example.com
+```
+
+Its useful to design your own _user script_, see below.
+
+## User scripts
+
+_User scripts_ are ruby files that provide new commands, designed to use the robotized browser.
+
+## 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/opus-codium/robro.
+

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 "robro"
+
+# 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/exe/robro

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+require 'robro/cli'
+
+begin
+  Robro::CLI.start ARGV
+#rescue Robro::Error => e
+#  $stderr.puts e.message
+#  exit 1
+end

data/lib/robro/browser.rb

@@ -0,0 +1,119 @@
+require 'capybara'
+require 'capybara/dsl'
+require 'capybara-screenshot'
+
+module Robro
+  class Browser
+    attr_reader :application
+
+    include Capybara::DSL
+
+    def initialize(application)
+      @application = application.to_sym
+      @headless = false # FIXME ENV['GUI'].nil?
+
+      Capybara.configure do |config|
+        config.run_server = false
+        config.default_max_wait_time = 5
+      end
+
+      # FIXME Register chrome_jack_headless
+      require 'selenium-webdriver'
+      Capybara.register_driver :chrome_jack do |app|
+        options = ::Selenium::WebDriver::Chrome::Options.new.tap do |opts|
+          opts.args << '--start-maximized'
+          opts.args << '--disable-blink-features'
+          opts.args << '--disable-blink-features=AutomationControlled'
+          opts.args << '--excludeSwitches=enable-automation'
+          opts.args << '--disable-gpu'
+        end
+        driver = Capybara::Selenium::Driver.new(app, browser: :chrome, capabilities: options)
+        bridge = driver.browser.send(:bridge)
+
+        path = '/session/:session_id/chromium/send_command'
+        path[':session_id'] = bridge.session_id
+
+        javascript = <<~JAVASCRIPT
+          Object.defineProperty(document, 'visibilityState', {value: 'visible', writable: true});
+          Object.defineProperty(document, 'hidden', {value: false, writable: true});
+          document.dispatchEvent(new Event("visibilitychange"));
+
+          Object.defineProperty(window, 'navigator', {
+            value: new Proxy(navigator, {
+            has: (target, key) => (key === 'webdriver' ? false : key in target),
+            get: (target, key) =>
+              key === 'webdriver'
+              ? undefined
+              : typeof target[key] === 'function'
+              ? target[key].bind(target)
+              : target[key]
+            })
+          });
+        JAVASCRIPT
+
+        bridge.http.call(:post, path, cmd: 'Page.addScriptToEvaluateOnNewDocument',
+                         params: {
+          source: javascript,
+        })
+
+        driver
+      end
+
+      Capybara.current_driver = driver
+
+      Capybara::Screenshot.register_driver(Capybara.current_driver) do |driver, path|
+        driver.browser.save_screenshot(path)
+      end
+
+      Robro.logger.debug "Browser User-Agent: '#{page.execute_script 'return navigator.userAgent'}'"
+
+      Robro.logger.debug "Capybara driver: #{Capybara.current_driver} (application: #{application}, headless: #{headless?})"
+    end
+
+    def headless?
+      @headless
+    end
+
+    def clear
+      visit 'file:///dev/null'
+    end
+
+    def close_other_tabs
+      current_tab = page.driver.browser.window_handle
+      tabs = page.driver.browser.window_handles - [current_tab]
+      tabs.each do |tab|
+        page.driver.browser.switch_to.window(tab)
+        page.driver.browser.close
+      end
+      page.driver.browser.switch_to.window current_tab
+    end
+
+    def keep_only_tabs_with(url:)
+      tabs = page.driver.browser.window_handles
+
+      tabs.each do |tab|
+        page.driver.browser.switch_to.window(tab)
+        page.driver.browser.close unless page.current_url.start_with?(url_start_with)
+      end
+    end
+
+    private
+
+    def driver
+      @application = 'chrome' if @application == 'chromium'
+
+      driver_name = case @application
+      when :firefox
+        'selenium'
+      when :chrome
+        'chrome_jack'
+      else
+        raise "Unsupported browser: '#{application}'"
+      end
+
+      driver_name += '_headless' if @headless
+
+      driver_name.to_sym
+    end
+  end
+end

data/lib/robro/cli.rb

@@ -0,0 +1,76 @@
+require 'robro'
+require 'robro/user_scripts'
+
+require 'thor'
+require 'json'
+
+require 'active_support/inflector'
+
+module Robro
+  class CLI < Thor
+    desc 'browse URL', 'Start browser at URL, drop a shell'
+    method_option :browser, :type => :string, :description => 'Supported values: firefox or chromium', :default => 'chrome'
+    def browse(url)
+      uri = validate_url(url)
+
+      Robro.browser = Browser.new options[:browser]
+      Robro.browser.visit uri
+
+      quit = false
+      until quit
+        UserScripts.all.each do |us_class|
+          us = us_class.new
+          next unless uri.host.start_with? *(us.supported_urls)
+
+          unless us.nil?
+            puts "Commands for this URL: #{us.supported_url_commands}"
+
+            us.supported_url_commands.each do |command|
+              define_singleton_method command do |*args|
+                us.send(command, *args)
+              end
+            end
+          end
+        end
+
+        byebug
+      end
+    end
+
+    no_commands do
+      def validate_url(url)
+        uri = URI(url)
+
+        case uri.scheme
+        when 'http'
+          uri.scheme = 'https'
+        when 'https'
+          # Supported
+        else
+          raise NotImplementedError
+        end
+
+        uri
+      end
+    end
+
+    UserScripts.all.each do |us_class|
+      us = us_class.new
+      us.supported_url_commands.each do |command|
+        desc "#{command} URL", command.to_s
+        method_option :browser, :type => :string, :description => 'Supported values: firefox or chromium', :default => 'chrome'
+        define_method command do |*args|
+          url = args.shift
+          raise Thor::Error, 'URL argument is missing' if url.nil?
+
+          uri = validate_url(url)
+
+          Robro.browser = Browser.new options[:browser]
+          Robro.browser.visit uri
+
+          puts JSON.pretty_generate(us.send(command, *args))
+        end
+      end
+    end
+  end
+end

data/lib/robro/user_scripts.rb

@@ -0,0 +1,17 @@
+module Robro
+  module UserScripts
+    def self.all
+      Dir.glob('userscripts/*.rb').map do |file|
+        require File.expand_path(file)
+        class_name = File.basename(file, '.rb').camelize
+        const_get class_name
+      end
+    end
+
+    class Base
+      def commands
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/robro/version.rb

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

data/lib/robro.rb

@@ -0,0 +1,25 @@
+require "robro/browser"
+require "robro/version"
+
+require 'tty/logger'
+require 'byebug'
+
+module Robro
+  class Error < StandardError; end
+
+  def self.logger
+    @@logger ||= TTY::Logger.new do |config|
+      config.handlers = [
+        [:console, { output: $stderr, level: :debug }],
+      ]
+    end
+  end
+
+  def self.browser=(browser)
+    @@browser = browser
+  end
+
+  def self.browser
+    @@browser || raise('Browser must be initialized first!')
+  end
+end

data/robro.gemspec

@@ -0,0 +1,37 @@
+require_relative 'lib/robro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "robro"
+  spec.version       = Robro::VERSION
+  spec.authors       = ["Romuald Conty"]
+  spec.email         = ["neomilium@gmail.com"]
+
+  spec.summary       = %q{Robotized Browser}
+  spec.description   = %q{Automate tasks that require a _real_ browser}
+  spec.homepage      = "https://github.com/neomilium/robro"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "#{spec.homepage}.git"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/Changelog.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "capybara"
+  spec.add_dependency "capybara-screenshot"
+  spec.add_dependency "selenium-webdriver"
+  spec.add_dependency "thor"
+  spec.add_dependency "tty-logger"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: robro
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Romuald Conty
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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
+    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-screenshot
+  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: selenium-webdriver
+  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: thor
+  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: tty-logger
+  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: 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: bundler
+  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: rake
+  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: rspec
+  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: Automate tasks that require a _real_ browser
+email:
+- neomilium@gmail.com
+executables:
+- robro
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/robro
+- lib/robro.rb
+- lib/robro/browser.rb
+- lib/robro/cli.rb
+- lib/robro/user_scripts.rb
+- lib/robro/version.rb
+- robro.gemspec
+homepage: https://github.com/neomilium/robro
+licenses: []
+metadata:
+  homepage_uri: https://github.com/neomilium/robro
+  source_code_uri: https://github.com/neomilium/robro.git
+  changelog_uri: https://github.com/neomilium/robro/Changelog.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Robotized Browser
+test_files: []