RDee 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f108a3c7c47f5ce2e00c26b947671fa2bd992ed
-  data.tar.gz: 782ca4414611441da4ce915b868a31ebde8c49ea
+  metadata.gz: 0ee57a488781369377cdc08a2c8ef183d0d599ad
+  data.tar.gz: b93f7f13abec8499bd2b559bf719fb8a177a7ce5
 SHA512:
-  metadata.gz: 587e4e884907beff175008cbf8a68ab56488c8d9e094f91b230ba9ae92ce78311834fb53dcf3603bd5b6ba913ec295595698f41379a2f59e289101edbed61ac4
-  data.tar.gz: 8a290e05a8d5c27341513f249ab704fc115b1f0f1065ffd0a9be9dc97d55452efe2e6908d96fd87d427c9344c0a7d8e1b0c4196d0d2aea68bf464bf6a538a9e1
+  metadata.gz: 8535d8b60f972c6d1b52a97b4b0b3dcd6057672825e96f927c4ef1ee83fe20334ea90d2090a56f06a61100f9c32347239a940fe232822f57204b8b181fafc326
+  data.tar.gz: 4695865cee85acaa708296d9fd2ca3db5a6d36e5e4321f6e6e1a54a86d3ce5d2cc85575c937ad76feaf1df9614d62ccb0240d058821501f4b4a08df3c740d6e8

data/ChangeLog

@@ -1,2 +1,6 @@
-=== Release 0.1
+=== Release 0.2 / 18-August-2014
+* Enhancements
+  * Printing and raising exception when browser connection cannot be established
+
+=== Release 0.1 / 23-July-2014
 * Initial release

data/README.md

@@ -1,12 +1,103 @@
-# RD
+# RDee
+
+RDee is a gem that makes it easy to switch between different browsers when you are using
+Selenium or Watir as your driver.  You can also easily switch between running on a local
+browser or a browser that is part of a Selenium Grid on on Sauce Labs.
+
+## Usage
+
+RDee was designed to make it easy for your tests to switch between different browsers.  It
+can select browsers that are running on your local machine or on a Selenium Grid.  The way
+you select a browser is by calling one of the following methods:
+
+````ruby
+RDee.selenium_browser(target = :firefox, options = {})
+# or
+RDee.watir_browser(target = :firefox, options = {})
+````
+
+These methods take two optional parameters.  The first is the target browser.  The second
+is options that can be passed to that browser when it is started.
+
+### Specifying the target browser
+
+As we saw in the previous section, you can specify the target browser by passing a symbol
+to the `selenium_browser` or `watir_browser` methods.  The problem with this is that you
+would have to change the code if you wanted to use a different browser.  RDee has made
+this simpler by allowing you to set the target browser using an environment variable.
+The environment variable is named `RDEE_BROWSER`.  A couple of typical usage patterns
+are to set this in the `cucumber.yml` file for specific profiles or to simply set this
+on the command-line when running the tests.  Here is an example of a `cucumber.yml` file:
+
+````yml
+default: RDEE_BROWSER=firefox --format pretty --color
+chrome: RDEE_BROWSER=chrome --format pretty --color
+safari: RDEE_BROWSER=safari --format pretty --color
+````
+
+From the command-line you could simply do this:
+
+````
+RDEE_BROWSER=chrome bundle exec cucumber
+````
+
+The format of the target passed to the methods or set in the environment variable determines
+what browser, version, and host os you get.  The format follows the following pattern:
+
+````
+firefox30_win8
+````
+
+The first part of the target determines what browser to use.  At the current time you can
+specify `firefox`, `chrome`, `ie`, or `safari`.  In the near future we will be supporting
+mobile platforms so stay tuned.
+
+Immediately following the browser is the version.  This is optional and if you do not specify
+it will select whatever version is available.  It is up to you to make sure that the browser
+and version combination are valid.
+
+Following the version there is an underscore followed by the host os.  This value is also
+optional.  Currently the following host os values are available:
+
+| host | description |
+| --- | --- |
+| win81 | Windows 8.1 |
+| win8 | Windows 8 |
+| win7 | Windows 7 |
+| winxp | Windows XP |
+| snow_leopard | OS X 10.6 |
+| mountain_lion | OS X 10.8 |
+| mavricks | OS X 10.9 |
+| linux | Linux |
+
+The host os value is typically used when running the tests on a Selenium Grid.  It is up to
+you to ensure that the host and requested browser combination exist on your grid.
+
+### Additional Configurations
+
+Additional parameters can be set by calling the configure method on the RDee module.  First
+of all, you can set the `url` value.  If the `url` is set RDee will attempt to make a remote
+connect to the grid specified by the `url`.  Additionaly you can specify whether it should
+use a persistent http connection as well as specify additional parameters that should be
+sent to a specific type of browser when it is used.  Here are examples:
+
+````ruby
+RDee.configure do | config |
+  config.url = 'http://path.to.selenium.grid/wd/hub'
+  config.persistent_http = true
+  config.chrome_options = { :switches => %w[--disable-extensions]}
+  config.firefox_options = { :switches => %w[--disable-popups]}
+  config.ie_options = { :switches => %w[--disable-popups]}
+  config.safari_options = { :switches => %w[--disable-popups]}
+end
+````
 
-TODO: Write a gem description
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'rd'
+    gem 'RDee'
 
 And then execute:
 
@@ -14,11 +105,8 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install rd
-
-## Usage
+    $ gem install RDee
 
-TODO: Write usage instructions here
 
 ## Contributing
 

data/lib/rdee.rb

@@ -2,6 +2,86 @@ require 'rdee/version'
 require 'rdee/browser_factory'
 require 'rdee/target_parser'
 
+#
+# RDee was designed to make it easy for your tests to switch between different browsers.  It
+# can select browsers that are running on your local machine or on a Selenium Grid.  The way
+# you select a browser is by calling one of the following methods:
+#
+# @example Calling the RDee methods
+#   RDee.selenium_browser(target = :firefox, options = {})
+#   # or
+#   RDee.watir_browser(target = :firefox, options = {})
+#
+#
+# These methods take two optional parameters.  The first is the target browser.  The second
+# is options that can be passed to that browser when it is started.
+#
+# You can specify the target browser by passing a symbol
+# to the `selenium_browser` or `watir_browser` methods.  The problem with this is that you
+# would have to change the code if you wanted to use a different browser.  RDee has made
+# this simpler by allowing you to set the target browser using an environment variable.
+# The environment variable is named `RDEE_BROWSER`.  A couple of typical usage patterns
+# are to set this in the `cucumber.yml` file for specific profiles or to simply set this
+# on the command-line when running the tests.  Here is an example of a `cucumber.yml` file:
+#
+# @example  Setting RDEE_BROWSer environment variable in cucumber.yml
+#   default: RDEE_BROWSER=firefox --format pretty --color
+#   chrome: RDEE_BROWSER=chrome --format pretty --color
+#   safari: RDEE_BROWSER=safari --format pretty --color
+#
+# From the command-line you could simply do this:
+#
+# @example Setting the RDEE_BROWSER environment variable from command-line
+#   RDEE_BROWSER=chrome bundle exec cucumber
+#
+# The format of the target passed to the methods or set in the environment variable determines
+# what browser, version, and host os you get.  The format follows the following pattern:
+#
+# @example Format of the target browser
+#   firefox30_win8
+#
+#
+# The first part of the target determines what browser to use.  At the current time you can
+# specify `firefox`, `chrome`, `ie`, or `safari`.  In the near future we will be supporting
+# mobile platforms so stay tuned.
+#
+# Immediately following the browser is the version.  This is optional and if you do not specify
+# it will select whatever version is available.  It is up to you to make sure that the browser
+# and version combination are valid.
+#
+# Following the version there is an underscore followed by the host os.  This value is also
+# optional.  Currently the following host os values are available:
+#
+#   | host          | description |
+#   | ------------- | ----------- |
+#   | win81         | Windows 8.1 |
+#   | win8          | Windows 8   |
+#   | win7          | Windows 7   |
+#   | winxp         | Windows XP  |
+#   | snow_leopard  | OS X 10.6   |
+#   | mountain_lion | OS X 10.8   |
+#   | mavricks      | OS X 10.9   |
+#   | linux         | Linux       |
+#
+# The host os value is typically used when running the tests on a Selenium Grid.  It is up to
+# you to ensure that the host and requested browser combination exist on your grid.
+#
+# Additional parameters can be set by calling the configure method on the RDee module.  First
+# of all, you can set the `url` value.  If the `url` is set RDee will attempt to make a remote
+# connect to the grid specified by the `url`.  Additionaly you can specify whether it should
+# use a persistent http connection as well as specify additional parameters that should be
+# sent to a specific type of browser when it is used.  Here are examples:
+#
+# @example Setting parameters using configure
+#   RDee.configure do | config |
+#     config.url = 'http://path.to.selenium.grid/wd/hub'
+#     config.persistent_http = true
+#     config.chrome_options = { :switches => %w[--disable-extensions]}
+#     config.firefox_options = { :switches => %w[--disable-popups]}
+#     config.ie_options = { :switches => %w[--disable-popups]}
+#     config.safari_options = { :switches => %w[--disable-popups]}
+#   end
+#
 module RDee
 
   def self.watir_browser(target = :firefox, options = {})

data/lib/rdee/browser_factory.rb

@@ -1,11 +1,16 @@
 require_relative 'target_parser'
 
+
+
 module RDee
+  class ConnectionError < StandardError
+  end
+  
   class BrowserFactory
     include TargetParser
 
     attr_accessor :url, :persistent_http, :chrome_options, :firefox_options,
-    :ie_options, :safari_options, :opera_options
+    :ie_options, :safari_options
 
     def watir_browser(target, options)
       platform, options = platform_and_options(target, options)
@@ -20,19 +25,29 @@ module RDee
     private
 
     def watir_browser_for(platform, options)
-      if options.empty?
-        Watir::Browser.new platform
-      else
-        Watir::Browser.new platform, options
+      begin
+        if options.empty?
+          Watir::Browser.new platform
+        else
+          Watir::Browser.new platform, options
+        end
+      rescue Exception => e
+        $stderr.puts e
+        raise RDee::ConnectionError, e
       end
     end
 
     def selenium_browser_for(platform, options)
-      if options.empty?
-        Selenium::WebDriver.for platform
-      else
-        Selenium::WebDriver.for platform, options
-      end      
+      begin
+        if options.empty?
+          Selenium::WebDriver.for platform
+        else
+          Selenium::WebDriver.for platform, options
+        end
+      rescue Exception => e
+        $stderr.puts e
+        raise RDee::ConnectionError, e
+      end
     end
 
     def platform_and_options(target, options)

data/lib/rdee/version.rb

@@ -1,3 +1,3 @@
 module RDee
-  VERSION = "0.1"
+  VERSION = "0.2"
 end

data/spec/lib/rd_spec.rb

@@ -10,7 +10,12 @@ describe RDee do
       expect(watir_browser).to receive(:new).with(:firefox)
       RDee.watir_browser
     end
-  end
+
+    it "should catch and print exceptions that occur when establishing a connection" do
+      expect(watir_browser).to receive(:new).and_raise(Exception, 'foo')
+      expect{ RDee.watir_browser }.to raise_error(RDee::ConnectionError, 'foo')
+    end
+end
 
   context "when getting a connection for Selenium" do
     let(:selenium_browser) { Selenium::WebDriver }
@@ -19,7 +24,12 @@ describe RDee do
       expect(selenium_browser).to receive(:for).with(:firefox)
       RDee.selenium_browser
     end
-  end
+
+    it "should catch and print exceptions that occur when establishing a connection" do
+      expect(selenium_browser).to receive(:for).and_raise(Exception, 'foo')
+      expect{ RDee.selenium_browser }.to raise_error(RDee::ConnectionError, 'foo')
+    end
+end
 
   context "when using common functionality" do
     it "should use the BROWSER environment variable when present" do
@@ -70,6 +80,7 @@ describe RDee do
         config.url = nil
       end
     end
+
   end
   
   context "when passing additional browser options" do
@@ -161,15 +172,5 @@ describe RDee do
       end
     end
 
-    it "should not allow opera_options when not using opera" do
-      RDee.configure do |config|
-        config.opera_options = {opera_options: 'option'}
-      end
-      expect(watir_browser).to receive(:new).with(:firefox)
-      RDee.watir_browser(:firefox)
-      RDee.configure do |config|
-        config.opera_options = nil
-      end
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: RDee
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Jeffrey S. Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-23 00:00:00.000000000 Z
+date: 2014-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: watir-webdriver
@@ -174,3 +174,4 @@ test_files:
 - spec/lib/target_parser_spec.rb
 - spec/lib/targets_spec.rb
 - spec/spec_helper.rb
+has_rdoc: