browsenator 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e92b28da1e6c1430a0086b32892212542aa166f0
+  data.tar.gz: e058c5f20090410634b1ac4b132e9377d34fc1d5
+SHA512:
+  metadata.gz: afbe17523c0665005930fb4956b00b0cbde9869de8a44b5c9473209f4285fc4d16b671c575c68b0c64783cf8ce2da90bc46f5925337bf91178aaedc1b8ffaf8e
+  data.tar.gz: c0ce17449c3f224b3ea2f751938c4e0bc467ac672cad70e6a0a07066472aafb04eeebd0718c409d9dd2af244614b1b698cde50aba5f02521cf2389ff866f5866

data/README.md

@@ -0,0 +1,62 @@
+# Browsenator
+[![Build Status](https://travis-ci.com/Typeform/browsenator.svg?token=4XnFa7v9wzSNqUXXdfpX&branch=master)](https://travis-ci.com/Typeform/browsenator)
+
+Browsenator is a Watir wrapper to make starting local and remote browsers easier.
+
+## Installation
+
+Install Browsenator as a Gem from git:
+
+```ruby
+gem 'browsenator', git: git@github.com:Typeform/browsenator.git
+```
+
+And then in your project execute:
+
+    $ bundle install
+
+## Configuration
+
+To use remote Browsertack browsers, configure the following environment variables:
+
+- BROWSERSTACK_USERNAME
+- BROWSERSTACK_ACCESS_KEY
+
+## Usage
+
+### Local browser
+
+Start a local browser:
+
+```ruby
+Browsenator.for(:chrome)
+```
+
+You can start the following local browsers: `:chrome`, `:firefox`, `:safari`.
+
+Chrome and Firefox browsers can be started in headless mode:
+
+```ruby
+Browsenator.for(:chrome, headless: true)
+```
+
+### Remote browser
+
+To start a remote browser:
+
+```ruby
+Browsenator.for(:chrome, remote: :browserstack)
+```
+
+Currently, remote browsers are only available through Browserstack.
+
+You can start the following remote browsers: `:chrome`, `:safari`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+The code follows [Ruby Style Guidelines](https://github.com/bbatsov/ruby-style-guide). Run Rubocop to ensure them by executing `bundle exec rubocop`.
+
+Code coverage is automatically generated when rspec is run. A full report can be viewed by opening coverage/index.html (target is > 90%).
+

data/lib/browsenator.rb

@@ -0,0 +1,18 @@
+require 'webdrivers'
+require_relative 'browsenator/local'
+require_relative 'browsenator/remote/browserstack'
+
+module Browsenator
+  def self.for(browser, opts = {})
+    remote = opts.delete(:remote)
+
+    case remote
+    when false, nil
+      Local.for(browser, opts)
+    when :browserstack
+      Remote::Browserstack.for(browser, opts)
+    else
+      raise ArgumentError, "Unknown remote: #{remote.inspect}"
+    end
+  end
+end

data/lib/browsenator/local.rb

@@ -0,0 +1,20 @@
+require_relative 'local/chrome'
+require_relative 'local/firefox'
+require_relative 'local/safari'
+
+module Browsenator
+  module Local
+    def self.for(browser, opts = {})
+      case browser
+      when :chrome
+        Chrome.new(opts).open
+      when :firefox
+        Firefox.new(opts).open
+      when :safari
+        Safari.new.open
+      else
+        raise ArgumentError, "Unknown local browser: #{browser.inspect}"
+      end
+    end
+  end
+end

data/lib/browsenator/local/chrome.rb

@@ -0,0 +1,30 @@
+require 'watir'
+require_relative 'window_size'
+
+module Browsenator
+  module Local
+    class Chrome
+      include WindowSize
+
+      def initialize(opts = {})
+        @args = %w[--ignore-certificate-errors
+                   --dirubocosable-prompt-on-repost
+                   --disable-popup-blocking
+                   --disable-translate
+                   --disable-infobars]
+
+        @args << '--headless' if opts[:headless]
+      end
+
+      def open
+        chrome = Watir::Browser.new :chrome, args: args
+        chrome.window.resize_to(width, height)
+        chrome
+      end
+
+      private
+
+      attr_reader :args
+    end
+  end
+end

data/lib/browsenator/local/firefox.rb

@@ -0,0 +1,24 @@
+require 'watir'
+require_relative 'window_size'
+
+module Browsenator
+  module Local
+    class Firefox
+      include WindowSize
+
+      def initialize(opts = {})
+        @options = { accept_insecure_certs: true }
+
+        @options[:headless] = true if opts[:headless]
+      end
+
+      def open
+        firefox = Watir::Browser.new :firefox, options
+        firefox.window.resize_to(width, height)
+        firefox
+      end
+
+      attr_reader :options
+    end
+  end
+end

data/lib/browsenator/local/safari.rb

@@ -0,0 +1,16 @@
+require 'watir'
+require_relative 'window_size'
+
+module Browsenator
+  module Local
+    class Safari
+      include WindowSize
+
+      def open
+        safari = Watir::Browser.new :safari
+        safari.window.resize_to(width, height)
+        safari
+      end
+    end
+  end
+end

data/lib/browsenator/local/window_size.rb

@@ -0,0 +1,13 @@
+module Browsenator
+  module Local
+    module WindowSize
+      def width
+        1024
+      end
+
+      def height
+        640
+      end
+    end
+  end
+end

data/lib/browsenator/remote/browserstack.rb

@@ -0,0 +1,19 @@
+require_relative 'browserstack/chrome'
+require_relative 'browserstack/safari'
+
+module Browsenator
+  module Remote
+    module Browserstack
+      def self.for(browser, opts = {})
+        case browser
+        when :chrome
+          Chrome.new(opts).open
+        when :safari
+          Safari.new(opts).open
+        else
+          raise ArgumentError, "Unknown Browserstack browser: #{browser.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/browsenator/remote/browserstack/browserstack_credentials.rb

@@ -0,0 +1,9 @@
+module BrowserstackCredentials
+  def username
+    ENV['BROWSERSTACK_USERNAME']
+  end
+
+  def access_key
+    ENV['BROWSERSTACK_ACCESS_KEY']
+  end
+end

data/lib/browsenator/remote/browserstack/chrome.rb

@@ -0,0 +1,37 @@
+require 'watir'
+require_relative 'browserstack_credentials'
+require_relative 'window_size'
+
+module Browsenator
+  module Remote
+    module Browserstack
+      class Chrome
+        include BrowserstackCredentials
+        include WindowSize
+
+        def initialize(opts = {})
+          caps = Selenium::WebDriver::Remote::Capabilities.new
+          caps['browser'] = 'Chrome'
+          caps['browser_version'] = '66.0'
+          caps['os'] = 'OS X'
+          caps['os_version'] = 'High Sierra'
+          caps['resolution'] = "#{width}x#{height}"
+          caps['project'] = opts[:project]
+
+          @options = {
+            url: "http://#{username}:#{access_key}@hub-cloud.browserstack.com/wd/hub",
+            desired_capabilities: caps
+          }
+        end
+
+        def open
+          Watir::Browser.new :remote, options
+        end
+
+        private
+
+        attr_reader :options
+      end
+    end
+  end
+end

data/lib/browsenator/remote/browserstack/safari.rb

@@ -0,0 +1,37 @@
+require 'watir'
+require_relative 'browserstack_credentials'
+require_relative 'window_size'
+
+module Browsenator
+  module Remote
+    module Browserstack
+      class Safari
+        include BrowserstackCredentials
+        include WindowSize
+
+        def initialize(opts = {})
+          caps = Selenium::WebDriver::Remote::Capabilities.new
+          caps['browser'] = 'Safari'
+          caps['browser_version'] = '11.1'
+          caps['os'] = 'OS X'
+          caps['os_version'] = 'High Sierra'
+          caps['resolution'] = "#{width}x#{height}"
+          caps['project'] = opts[:project]
+
+          @options = {
+            url: "http://#{username}:#{access_key}@hub-cloud.browserstack.com/wd/hub",
+            desired_capabilities: caps
+          }
+        end
+
+        def open
+          Watir::Browser.new :remote, options
+        end
+
+        private
+
+        attr_reader :options
+      end
+    end
+  end
+end

data/lib/browsenator/remote/browserstack/window_size.rb

@@ -0,0 +1,15 @@
+module Browsenator
+  module Remote
+    module Browserstack
+      module WindowSize
+        def width
+          1024
+        end
+
+        def height
+          768
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: browsenator
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+platform: ruby
+authors:
+- Aida Manna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: watir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.10'
+- !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: byebug
+  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: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.56.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.56.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: webdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: 
+email:
+- aidamanna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/browsenator.rb
+- lib/browsenator/local.rb
+- lib/browsenator/local/chrome.rb
+- lib/browsenator/local/firefox.rb
+- lib/browsenator/local/safari.rb
+- lib/browsenator/local/window_size.rb
+- lib/browsenator/remote/browserstack.rb
+- lib/browsenator/remote/browserstack/browserstack_credentials.rb
+- lib/browsenator/remote/browserstack/chrome.rb
+- lib/browsenator/remote/browserstack/safari.rb
+- lib/browsenator/remote/browserstack/window_size.rb
+homepage: https://github.com/Typeform/browsenator
+licenses: []
+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.14
+signing_key: 
+specification_version: 4
+summary: Easily start different browsers
+test_files: []