async-webdriver 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bb124e522f9bb2e4f525b56b1f2633a396844c1ec033de92bcb863ba5a202d76
+  data.tar.gz: d4d70538d5ce3e4c41883be74169c71dcfda403f1e3e24c28cc9ca28d2614509
+SHA512:
+  metadata.gz: 329f215f5e863a1a8b01a12bf5595e5603ebd7754779ec386ba11bff7b7afd537ac5e57d73cf10c08cc760b11d1455b1344e4d34024b2ee6075a6fc8ec75d59a
+  data.tar.gz: 848396d5cf080dc1e07fcb83368263463aab0dc4151b6fee5b683408d865b14422aad77e46c5132eeeca3ab5e1d436f48f05229c5cd4ff04390e11ed1380a098

data/.gitignore

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

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+async-webdriver

data/.ruby-version

@@ -0,0 +1 @@
+2.6.0

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.16.6

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in async-webdriver.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    async-webdriver (0.1.0)
+      async-http
+      selenium-webdriver
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    async (1.12.0)
+      nio4r (~> 2.3)
+      timers (~> 4.1)
+    async-http (0.37.7)
+      async (~> 1.6)
+      async-io (~> 1.16)
+      http-protocol (~> 0.10)
+    async-io (1.17.2)
+      async (~> 1.3)
+    async-rspec (1.12.0)
+      rspec (~> 3.0)
+    byebug (10.0.2)
+    childprocess (0.9.0)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ffi (1.9.25)
+    formatador (0.2.5)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    http-hpack (0.1.1)
+    http-protocol (0.10.1)
+      http-hpack (~> 0.1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    nenv (0.3.0)
+    nio4r (2.3.1)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    ruby_dep (1.5.0)
+    rubyzip (1.2.2)
+    selenium-webdriver (3.141.0)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.2, >= 1.2.2)
+    shellany (0.0.1)
+    thor (0.20.3)
+    timers (4.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  async-rspec
+  async-webdriver!
+  bundler (~> 1.16)
+  guard
+  guard-rspec
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/Guardfile

@@ -0,0 +1,45 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  watch(/.+\.rb$/) { |m| puts m }
+  watch(/.+\.rb$/) { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Matti Paksula
+
+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,3 @@
+# Async::Webdriver
+
+run `bundle exec ruby examples/two_sessions.rb`

data/Rakefile

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

data/async-webdriver.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "async/webdriver/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "async-webdriver"
+  spec.version       = Async::Webdriver::VERSION
+  spec.authors       = ["Matti Paksula"]
+  spec.email         = ["matti.paksula@iki.fi"]
+
+  spec.summary       = "async-webdriver"
+  spec.homepage      = "https://github.com/matti/async-webdriver"
+  spec.license       = "MIT"
+
+  # 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_runtime_dependency "async-http"
+  spec.add_runtime_dependency "selenium-webdriver"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "async-rspec"
+  spec.add_development_dependency "pry-byebug"
+
+end

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "async/webdriver"
+
+client = Async::Webdriver::Client.new endpoint: "http://localhost:9515"
+
+require "pry"
+Pry.config.pager = false
+
+eval ARGV.join(" ") if ARGV.any?
+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/examples/multiple_sessions.rb

@@ -0,0 +1,29 @@
+require "async/webdriver"
+
+client = Async::Webdriver::Client.new endpoint: "http://localhost:9515"
+
+# before starting ensure no "window is closed" sessions are left behind in the chromedriver
+# this is because we use .first and .last in this example later on
+for s in client.sessions do
+  s.delete!
+end
+
+example_com_session = client.session.create!
+example_com_session.navigate! "http://www.example.com"
+
+time_is_session = client.session.create!
+time_is_session.navigate! "http://www.time.is"
+
+# another way to acess example_com_session
+client.sessions.first.navigate! "http://www.reddit.com"
+
+# another way to acess time_is_session
+client.sessions.last.navigate! "http://www.twitter.com"
+
+# close print current urls and <title>s and close all
+for s in client.sessions
+  puts s.url
+  puts s.title
+  s.delete!
+  puts "--"
+end

data/lib/async/webdriver/client.rb

@@ -0,0 +1,29 @@
+require "async/queue"
+
+module Async
+  module Webdriver
+    class Client
+      def initialize(endpoint:)
+        @connection = Connection.new endpoint: endpoint
+      end
+
+      def session
+        SessionCreator.new connection: @connection
+      end
+
+      def status
+        @connection.call method: :get, path: "status"
+      end
+
+      def sessions
+        value = @connection.call method: :get, path: "sessions"
+        list = []
+        for json in value do
+          list << Session.new(json: json, connection: @connection)
+        end
+        list
+      end
+
+    end
+  end
+end

data/lib/async/webdriver/connection.rb

@@ -0,0 +1,59 @@
+require "async"
+require "async/queue"
+require "async/http/internet"
+require "json"
+
+module Async
+  module Webdriver
+    class Connection
+      def initialize(endpoint:)
+        @url = endpoint
+        @internet = Async::HTTP::Internet.new
+      end
+
+      def call(method:, path:nil, headers:[], body:nil)
+        body_array = case body
+        when Hash
+          [body.to_json]
+        end
+
+        path_or_url = if path
+          "#{@url}/#{path}"
+        else
+          @url
+        end
+
+        task = Async.run do |t|
+          r = @internet.call method, path_or_url, headers, body_array
+
+          body = begin
+            JSON.parse r.read
+          rescue JSON::ParserError => ex
+            p ex
+            exit 1
+          end
+
+          @internet.close
+
+          status = body.dig "status"
+          if status == 0
+            # POST /session has different response structure than other calls
+            if method == "post" && path == "session"
+              {
+                "id" => body.dig("sessionId"),
+                "capabilities" => body.dig("value")
+              }
+            else # everything else works like this
+              body.dig "value"
+            end
+          else
+            p body
+            raise "Error: #{status} - #{body.dig("value", "message")}"
+          end
+        end
+
+        task.wait
+      end
+    end
+  end
+end

data/lib/async/webdriver/connection_path.rb

@@ -0,0 +1,25 @@
+require "async"
+require "async/queue"
+require "async/http/internet"
+require "json"
+
+module Async
+  module Webdriver
+    class ConnectionPath
+      def initialize(prefix, connection:)
+        @connection = connection
+        @prefix = prefix
+      end
+
+      def call(method:, path:nil, headers:[], body:nil)
+        connection_path = if path
+          "#{@prefix}/#{path}"
+        else
+          "#{@prefix}"
+        end
+
+        @connection.call method: method, path: connection_path, headers: headers, body: body
+      end
+    end
+  end
+end

data/lib/async/webdriver/element.rb

@@ -0,0 +1,20 @@
+require "selenium-webdriver"
+module Async
+  module Webdriver
+    class Element
+      def initialize(json:, connection:)
+        @id = json.fetch "ELEMENT"
+        @element_connection = ConnectionPath.new "element/#{@id}", connection: connection
+      end
+
+      def tag_name
+        @element_connection.call method: "get", path: "name"
+        value
+      end
+
+      def text
+        @element_connection.call method: "get", path: "text"
+      end
+    end
+  end
+end

data/lib/async/webdriver/execute.rb

@@ -0,0 +1,29 @@
+module Async
+  module Webdriver
+    class Execute
+      def initialize(connection:)
+        @execute_connection = ConnectionPath.new "execute", connection: connection
+      end
+
+      def sync(script, args=[])
+        #TODO: args?
+        body = {
+          script: script,
+          args: args
+        }
+
+        @execute_connection.call method: "post", path: "sync", body: body
+      end
+
+      def async(script, args=[])
+        #TODO: args?
+        body = {
+          script: script,
+          args: args
+        }
+
+        @execute_connection.call method: "post", path: "async", body: body
+      end
+    end
+  end
+end

data/lib/async/webdriver/session.rb

@@ -0,0 +1,70 @@
+module Async
+  module Webdriver
+    class Session
+      def initialize(json:, connection:)
+        @capabilities = json.fetch "capabilities"
+        @id = json.fetch "id"
+
+        @session_connection = ConnectionPath.new "session/#{@id}", connection: connection
+        @execute = Execute.new connection: @session_connection
+      end
+
+      attr_reader :id, :execute
+
+
+      def elements
+        body = {
+          using: "css selector",
+          value: "html"
+        }
+
+        session_id, value = @session_connection.call method: "post", path: "elements", body: body
+        list = []
+        for e in value do
+          list << Element.new(json: e, connection: @session_connection)
+        end
+        list
+      end
+
+      def delete!
+        response = @session_connection.call method: "delete"
+      end
+
+      def navigate!(url)
+        body = {
+          url: url
+        }
+
+        @session_connection.call method: "post", path: "url", body: body
+        self
+      end
+
+      def back!
+        @session_connection.call method: "post", path: "back"
+        self
+      end
+
+      def forward!
+        @session_connection.call method: "post", path: "forward"
+        self
+      end
+
+      def refresh!
+        @session_connection.call method: "post", path: "refresh"
+        self
+      end
+
+      def url
+        @session_connection.call method: "get", path: "url"
+      end
+
+      def title
+        @session_connection.call method: "get", path: "title"
+      end
+
+      def source
+        @session_connection.call method: "get", path: "source"
+      end
+    end
+  end
+end

data/lib/async/webdriver/session_creator.rb

@@ -0,0 +1,19 @@
+require "async/queue"
+
+module Async
+  module Webdriver
+    class SessionCreator
+      def initialize(connection:)
+        @connection = connection
+      end
+
+      def create!
+        value = @connection.call method: "post", path: "session", body: {
+          desiredCapabilities: {}
+        }
+
+        Session.new json: value, connection: @connection
+      end
+    end
+  end
+end

data/lib/async/webdriver/version.rb

@@ -0,0 +1,5 @@
+module Async
+  module Webdriver
+    VERSION = "0.1.0"
+  end
+end

data/lib/async/webdriver.rb

@@ -0,0 +1,15 @@
+module Async
+  module Webdriver
+  end
+end
+
+require_relative "webdriver/version"
+require_relative "webdriver/client"
+require_relative "webdriver/connection"
+require_relative "webdriver/connection_path"
+
+require_relative "webdriver/session"
+require_relative "webdriver/session_creator"
+
+require_relative "webdriver/element"
+require_relative "webdriver/execute"

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: async-webdriver
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matti Paksula
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async-http
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: guard
+  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: guard-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'
+- !ruby/object:Gem::Dependency
+  name: async-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'
+- !ruby/object:Gem::Dependency
+  name: pry-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'
+description: 
+email:
+- matti.paksula@iki.fi
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- async-webdriver.gemspec
+- bin/console
+- bin/setup
+- examples/multiple_sessions.rb
+- lib/async/webdriver.rb
+- lib/async/webdriver/client.rb
+- lib/async/webdriver/connection.rb
+- lib/async/webdriver/connection_path.rb
+- lib/async/webdriver/element.rb
+- lib/async/webdriver/execute.rb
+- lib/async/webdriver/session.rb
+- lib/async/webdriver/session_creator.rb
+- lib/async/webdriver/version.rb
+homepage: https://github.com/matti/async-webdriver
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: async-webdriver
+test_files: []