testcentricity_web 0.6.4 → 0.6.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d1c25417263a8e482daf9053e4f28d1fc3283e7
-  data.tar.gz: 583b938a2eaca21ead5afa17aa62a07f4303137b
+  metadata.gz: 58bd9d1679b6f663c4899846aec59b4872961837
+  data.tar.gz: 9cd449d7a5aa687253b498b9def2a3331d97e8ee
 SHA512:
-  metadata.gz: e68237af398f2488d7392c191f0ba51a49292873313afa4c0cda5cb237181fbec10aa33441b619726b30d873c645f4aee1ceb3ef4e1f505e9e974d0d7c5c61b1
-  data.tar.gz: bde9567c48c39a96de491e990cf1a917e22ede563efbe45210b598726c987bbc69ea7c8aa95f2c9df8da5ca96d91f5b184041a6801aa93b8091a4c29c9b3e276
+  metadata.gz: 7ce854490297c36cff5afc7d2feb9de2b034d2916ebabbc9bf5cb23b552f0623aa37ed25b74dd50dfb3e912931a95f0285d3954ac6cfec20811afddccfd972a8
+  data.tar.gz: 356e35f4a42b49cefcc26d364d16ebb1f4b682caee16a6b218a8f94b47106b3d8defa6b9bd8717a3d88f62a48ff2051ef4c7ea1d79256db4e6720cb533c87781

data/README.md

@@ -1,13 +1,9 @@
 # TestCentricityWeb
 
 The TestCentricity™ core generic framework for desktop and mobile web site testing implements a Page Object and Data Object Model DSL for
-use with Cucumber, Capybara, and Selenium-Webdriver.
-
-The TestCentricity™ web gem supports running testing against the following web test targets:
-- locally hosted desktop browsers (Firefox, Chrome, Safari, IE, or Edge)
-- locally hosted emulated iOS and Android mobile browsers (using Firefox)
-- a "headless" browser (using Poltergeist and PhantomJS)
-- cloud hosted desktop or mobile web browsers using the BrowserStack, Sauce Labs, CrossBrowserTesting, or TestingBot services.
+use with Cucumber, Capybara, and Selenium-Webdriver. It supports testing against locally hosted desktop browsers (Firefox, Chrome, Safari,
+IE, or Edge), locally hosted emulated iOS and Android mobile browsers (using Firefox), a "headless" browser (using Poltergeist and PhantomJS),
+or on cloud hosted desktop or mobile web browsers using the BrowserStack, Sauce Labs, CrossBrowserTesting, or TestingBot services.
 
 
 ## Installation
@@ -70,7 +66,7 @@ to update the affected feature file, scenarios, or step definitions.
 
 ### Defining a Page Object
 
-Your **Page Object** class definitions should be contained within individual *.rb* files in the ***features/support/pages*** folder of your
+Your **Page Object** class definitions should be contained within individual **`.rb`** files in the **`features/support/pages`** folder of your
 test automation project. You define new **Page Objects** as shown below:
 
     class LoginPage < TestCentricity::PageObject
@@ -86,17 +82,17 @@ test automation project. You define new **Page Objects** as shown below:
 Web pages typically have names and URLs associated with them. Web pages also typically have a unique object or attribute that, when present,
 indicates that the page's contents have fully loaded.
 
-The ***page_name*** trait is registered with the **PageManager** object, which includes a **find_page** method that takes a page name as a
+The **`page_name`** trait is registered with the **PageManager** object, which includes a **`find_page`** method that takes a page name as a
 parameter and returns an instance of the associated **Page Object**.
 
-A ***page_url*** trait should be defined if a page can be directly loaded using a URL. If you set Capybara's *app_host*, or specify a base URL
-when calling the ***WebDriverConnect.initialize_web_driver*** method, then your ***page_url*** trait can be the relative URL slug that will
-be appended to the base URL specified in *app_host*. Specifying a ***page_url*** trait is optional, as not all web pages can be directly loaded
+A **`page_url`** trait should be defined if a page can be directly loaded using a URL. If you set Capybara's **`app_host`**, or specify a base URL
+when calling the **`WebDriverConnect.initialize_web_driver`** method, then your **`page_url`** trait can be the relative URL slug that will
+be appended to the base URL specified in **`app_host`**. Specifying a **`page_url`** trait is optional, as not all web pages can be directly loaded
 via a URL.
 
-A ***page_locator*** trait is defined if a page has a unique object or attribute that exists once the page's contents have fully loaded. The
-***page_locator*** trait is a CSS or Xpath expression that uniquely identifies the object or attribute. The **verify_page_exists** method waits
-for the ***page_locator*** trait to exist.
+A **`page_locator`** trait is defined if a page has a unique object or attribute that exists once the page's contents have fully loaded. The
+**`page_locator`** trait is a CSS or Xpath expression that uniquely identifies the object or attribute. The **`verify_page_exists`** method waits
+for the **`page_locator`** trait to exist.
 
 You define your page's **Traits** as shown below:
 
@@ -187,7 +183,7 @@ A **PageSection Object** may contain other **PageSection Objects**.
 
 ### Defining a PageSection Object
 
-Your **PageSection** class definitions should be contained within individual *.rb* files in the ***features/support/sections*** folder of
+Your **PageSection** class definitions should be contained within individual **`.rb`** files in the **`features/support/sections`** folder of
 your test automation project. You define new **PageSection Objects** as shown below:
 
     class SearchForm < TestCentricity::PageSection
@@ -196,7 +192,7 @@ your test automation project. You define new **PageSection Objects** as shown be
 
 ### Adding Traits to a PageSection Object
 
-A **PageSection Object** typically has a root node object that encapsulates a collection of **UI Elements**. The ***section_locator*** trait
+A **PageSection Object** typically has a root node object that encapsulates a collection of **UI Elements**. The **`section_locator`** trait
 specifies the CSS or Xpath expression that uniquely identifies that root node object.
 
 You define your page section's **Traits** as shown below:
@@ -280,8 +276,8 @@ One common implementation is shown below:
         
     World(WorldPages)
 
-The **WorldPages** module above can be defined in your *env.rb* file, or you can define it in a separate *world_pages.rb* file in the
-***features/support*** folder.
+The **`WorldPages`** module above can be defined in your **`env.rb`** file, or you can define it in a separate **`world_pages.rb`** file in the
+**`features/support`** folder.
 
 While this approach is effective for small web applications with only a few pages (and hence few **Page Objects**), it quickly becomes
 cumbersome to manage if your web application has dozens of **Page Objects** that need to be instantiated and managed.
@@ -289,7 +285,7 @@ cumbersome to manage if your web application has dozens of **Page Objects** that
 ### Using the PageManager
 
 The **PageManager** class provides methods for supporting the instantiation and management of **Page Objects**. In the code example below,
-the **page_objects** method contains a hash table of your **Page Object** instances and their associated **Page Object** class names
+the **`page_objects`** method contains a hash table of your **Page Object** instances and their associated **Page Object** class names
 to be instantiated by **PageManager**:
     
     module WorldPages
@@ -311,9 +307,9 @@ to be instantiated by **PageManager**:
     
     World(WorldPages)
     
-The **WorldPages** module above should be defined in the *world_pages.rb* file in the ***features/support*** folder.
+The **`WorldPages`** module above should be defined in the **`world_pages.rb`** file in the **`features/support`** folder.
 
-Include the code below in your *env.rb* file to ensure that your **Page Objects** are instantiated before your Cucumber scenarios are
+Include the code below in your **`env.rb`** file to ensure that your **Page Objects** are instantiated before your Cucumber scenarios are
 executed:
     
     include WorldPages
@@ -323,54 +319,54 @@ executed:
 
 ## Connecting to a Web Browser
 
-The ***WebDriverConnect.initialize_web_driver*** method configures the appropriate selenium-webdriver capabilities required to establish a
-connection with a target web browser, and sets the base host URL of the web site you are running your tests against
+The **`WebDriverConnect.initialize_web_driver`** method configures the appropriate selenium-webdriver capabilities required to establish a
+connection with a target web browser, and sets the base host URL of the web site you are running your tests against.
 
-The ***WebDriverConnect.initialize_web_driver*** method accepts a single optional parameter - the base host URL. Cucumber **Environment
-Variables**are used to specify the target local or remote web browser, and the various webdriver capability parameters required to configure
+The **`WebDriverConnect.initialize_web_driver`** method accepts a single optional parameter - the base host URL. Cucumber **Environment
+Variables** are used to specify the target local or remote web browser, and the various webdriver capability parameters required to configure
 the connection.
 
 
 ### Locally hosted desktop web browser
 
-For locally hosted desktop web browsers, the **WEB_BROWSER** Environment Variable must be set to one of the values from the table below: 
+For locally hosted desktop web browsers, the **`WEB_BROWSER`** Environment Variable must be set to one of the values from the table below: 
 
-**WEB_BROWSER** | Desktop Platform
+**`WEB_BROWSER`** | Desktop Platform
 --------------- | ----------------
-firefox | OS X or Windows
-chrome | OS X or Windows
-safari | OS X only
-ie | Windows only
-edge | Windows 10 only
-poltergeist | OS X or Windows
+`firefox` | OS X or Windows
+`chrome` | OS X or Windows
+`safari` | OS X only
+`ie` | Windows only
+`edge` | Windows 10 only
+`poltergeist` | OS X or Windows
 
 
 ### Locally hosted emulated mobile web browser
 
 You can also run your tests against emulated mobile device browsers within a locally hosted instance of the Firefox desktop browser. You may
-even specify the emulated device's screen orientation. For locally hosted emulated mobile web browsers, the **WEB_BROWSER** Environment Variable
+even specify the emulated device's screen orientation. For locally hosted emulated mobile web browsers, the **`WEB_BROWSER`** Environment Variable
 must be set to one of the values from the table below: 
 
-**WEB_BROWSER** |
+**`WEB_BROWSER`** |
 --------------- |
-ipad |
-ipad_pro |
-iphone |
-iphone4 |
-iphone5 |
-iphone6 |
-iphone6_plus |
-android_phone |
-android_tablet |
+`ipad` |
+`ipad_pro` |
+`iphone` |
+`iphone4` |
+`iphone5` |
+`iphone6` |
+`iphone6_plus` |
+`android_phone` |
+`android_tablet` |
 
-To specify the emulated device's screen orientation, you set the **ORIENTATION** Environment Variable to either ***portrait*** or ***landscape***.
+To specify the emulated device's screen orientation, you set the **`ORIENTATION`** Environment Variable to either **`portrait`** or **`landscape`**.
 
 
 ### Remotely hosted desktop and mobile web browsers
 
 You can run your automated tests against remotely hosted desktop and mobile web browsers using the BrowserStack, CrossBrowserTesting,
 Sauce Labs, or TestingBot services. If your tests are running against a web site hosted on your local computer (localhost), or on a
-staging server inside your LAN, you must set the **TUNNELING** Environment Variable to true.
+staging server inside your LAN, you must set the **`TUNNELING`** Environment Variable to **`true`**.
 
 
 #### Remote desktop browsers on the BrowserStack service
@@ -380,15 +376,15 @@ the table below. Refer to the [Browserstack-specific capabilities chart page](ht
 
 **Environment Variable** | Description
 --------------- | ----------------
-WEB_BROWSER | Must be set to ***browserstack***
-BS_USERNAME | Must be set to your BrowserStack account user name
-BS_AUTHKEY | Must be set to your BrowserStack account access key
-BS_OS | Must be set to ***OS X*** or ***Windows***
-BS_OS_VERSION | Refer to ***os_version*** capability in chart
-BS_BROWSER | Refer to ***browser*** capability in chart
-BS_VERSION | Refer to ***browser_version*** capability in chart
-TUNNELING | Must be ***true*** if you are testing against internal/local servers
-RESOLUTION | Refer to supported screen ***resolution*** capability in chart
+`WEB_BROWSER` | Must be set to **`browserstack`**
+`BS_USERNAME` | Must be set to your BrowserStack account user name
+`BS_AUTHKEY` | Must be set to your BrowserStack account access key
+`BS_OS` | Must be set to **`OS X`** or **`Windows`**
+`BS_OS_VERSION` | Refer to **`os_version`** capability in chart
+`BS_BROWSER` | Refer to **`browser`** capability in chart
+`BS_VERSION` | Refer to **`browser_version`** capability in chart
+`TUNNELING` | Must be **`true`** if you are testing against internal/local servers
+`RESOLUTION` | Refer to supported screen **`resolution`** capability in chart
 
 
 #### Remote mobile browsers on the BrowserStack service
@@ -398,14 +394,14 @@ the table below. Refer to the [Browserstack-specific capabilities chart page](ht
 
 **Environment Variable** | Description
 --------------- | ----------------
-WEB_BROWSER | Must be set to ***browserstack***
-BS_USERNAME | Must be set to your BrowserStack account user name
-BS_AUTHKEY | Must be set to your BrowserStack account access key
-BS_BROWSER | Must be set to ***iPhone***, ***iPad***, or ***android***
-BS_PLATFORM | Must be set to ***MAC*** (for iOS) or ***ANDROID***
-BS_DEVICE | Refer to ***device*** capability in chart
-TUNNELING | Must be ***true*** if you are testing against internal/local servers
-ORIENTATION | set to ***portrait*** or ***landscape***
+`WEB_BROWSER` | Must be set to **`browserstack`**
+`BS_USERNAME` | Must be set to your BrowserStack account user name
+`BS_AUTHKEY` | Must be set to your BrowserStack account access key
+`BS_BROWSER` | Must be set to **`iPhone`**, **`iPad`**, or **`android`**
+`BS_PLATFORM` | Must be set to **`MAC`** (for iOS) or **`ANDROID`**
+`BS_DEVICE` | Refer to **`device`** capability in chart
+`TUNNELING` | Must be **`true`** if you are testing against internal/local servers
+`ORIENTATION` | set to **`portrait`** or **`landscape`**
 
 
 
@@ -416,12 +412,12 @@ the table below. Use the Configuration Wizard on the [Start a Selenium Test page
 
 **Environment Variable** | Description
 --------------- | ----------------
-WEB_BROWSER | Must be set to ***crossbrowser***
-CB_USERNAME | Must be set to your CrossBrowserTesting account user name or email address
-CB_AUTHKEY | Must be set to your CrossBrowserTesting account access key
-CB_OS | Refer to ***os_api_name*** capability in the sample script of the Wizard
-CB_BROWSER | Refer to ***browser_api_name*** capability in the sample script of the Wizard
-RESOLUTION | Refer to supported ***screen_resolution*** capability in the sample script of the Wizard
+`WEB_BROWSER` | Must be set to **`crossbrowser`**
+`CB_USERNAME` | Must be set to your CrossBrowserTesting account user name or email address
+`CB_AUTHKEY` | Must be set to your CrossBrowserTesting account access key
+`CB_OS` | Refer to **`os_api_name`** capability in the sample script of the Wizard
+`CB_BROWSER` | Refer to **`browser_api_name`** capability in the sample script of the Wizard
+`RESOLUTION` | Refer to supported **`screen_resolution`** capability in the sample script of the Wizard
 
 
 #### Remote mobile browsers on the CrossBrowserTesting service
@@ -431,12 +427,12 @@ the table below. Use the Configuration Wizard on the [Start a Selenium Test page
 
 **Environment Variable** | Description
 --------------- | ----------------
-WEB_BROWSER | Must be set to ***crossbrowser***
-CB_USERNAME | Must be set to your CrossBrowserTesting account user name or email address
-CB_AUTHKEY | Must be set to your CrossBrowserTesting account access key
-CB_PLATFORM | Refer to ***os_api_name*** capability in the sample script of the Wizard
-CB_BROWSER | Refer to ***browser_api_name*** capability in the sample script of the Wizard
-RESOLUTION | Refer to supported ***screen_resolution*** capability in the sample script of the Wizard
+`WEB_BROWSER` | Must be set to **`crossbrowser`**
+`CB_USERNAME` | Must be set to your CrossBrowserTesting account user name or email address
+`CB_AUTHKEY` | Must be set to your CrossBrowserTesting account access key
+`CB_PLATFORM` | Refer to **`os_api_name`** capability in the sample script of the Wizard
+`CB_BROWSER` | Refer to **`browser_api_name`** capability in the sample script of the Wizard
+`RESOLUTION` | Refer to supported **`screen_resolution`** capability in the sample script of the Wizard
 
 
 
@@ -447,13 +443,13 @@ the table below. Use the Selenium API on the [Platform Configurator page](https:
 
 **Environment Variable** | Description
 --------------- | ----------------
-WEB_BROWSER | Must be set to ***saucelabs***
-SL_USERNAME | Must be set to your Sauce Labs account user name or email address
-SL_AUTHKEY | Must be set to your Sauce Labs account access key
-SL_OS | Refer to ***platform*** capability in the Copy Code section of the Platform Configurator page
-SL_BROWSER | Must be set to ***chrome***, ***firefox***, ***safari***, ***internet explorer***, or ***edge***
-SL_VERSION | Refer to ***version*** capability in the Copy Code section of the Platform Configurator page
-RESOLUTION | Refer to supported ***screenResolution*** capability in the Copy Code section of the Platform Configurator page
+`WEB_BROWSER` | Must be set to **`saucelabs`**
+`SL_USERNAME` | Must be set to your Sauce Labs account user name or email address
+`SL_AUTHKEY` | Must be set to your Sauce Labs account access key
+`SL_OS` | Refer to **`platform`** capability in the Copy Code section of the Platform Configurator page
+`SL_BROWSER` | Must be set to **`chrome`**, **`firefox`**, **`safari`**, **`internet explorer`**, or **`edge`**
+`SL_VERSION` | Refer to **`version`** capability in the Copy Code section of the Platform Configurator page
+`RESOLUTION` | Refer to supported **`screenResolution`** capability in the Copy Code section of the Platform Configurator page
 
 
 #### Remote mobile browsers on the Sauce Labs service
@@ -463,15 +459,15 @@ the table below. Use the Selenium API on the [Platform Configurator page](https:
 
 **Environment Variable** | Description
 --------------- | ----------------
-WEB_BROWSER | Must be set to ***saucelabs***
-SL_USERNAME | Must be set to your Sauce Labs account user name or email address
-SL_AUTHKEY | Must be set to your Sauce Labs account access key
-SL_PLATFORM | Refer to ***platform*** capability in the Copy Code section of the Platform Configurator page
-SL_BROWSER | Must be set to ***iPhone*** or ***android***
-SL_VERSION | Refer to ***version*** capability in the Copy Code section of the Platform Configurator page
-SL_DEVICE | Refer to ***deviceName*** capability in the Copy Code section of the Platform Configurator page
-SL_DEVICE_TYPE | If displayed, refer to ***deviceType*** capability in the Copy Code section of the Platform Configurator page
-ORIENTATION | Refer to ***deviceOrientation*** capability in the Copy Code section of the Platform Configurator page
+`WEB_BROWSER` | Must be set to **`saucelabs`**
+`SL_USERNAME` | Must be set to your Sauce Labs account user name or email address
+`SL_AUTHKEY` | Must be set to your Sauce Labs account access key
+`SL_PLATFORM` | Refer to **`platform`** capability in the Copy Code section of the Platform Configurator page
+`SL_BROWSER` | Must be set to **`iPhone`** or **`android`**
+`SL_VERSION` | Refer to **`version`** capability in the Copy Code section of the Platform Configurator page
+`SL_DEVICE` | Refer to **`deviceName`** capability in the Copy Code section of the Platform Configurator page
+`SL_DEVICE_TYPE` | If displayed, refer to **`deviceType`** capability in the Copy Code section of the Platform Configurator page
+`ORIENTATION` | Refer to **`deviceOrientation`** capability in the Copy Code section of the Platform Configurator page
 
 
 #### Remote desktop browsers on the TestingBot service
@@ -481,24 +477,24 @@ the table below. Refer to the [TestingBot List of Available Browsers page](https
 
 **Environment Variable** | Description
 --------------- | ----------------
-WEB_BROWSER | Must be set to ***testingbot***
-TB_USERNAME | Must be set to your TestingBot account user name
-TB_AUTHKEY | Must be set to your TestingBot account access key
-TB_OS | Refer to ***platform*** capability in chart
-TB_BROWSER | Refer to ***browserName*** capability in chart
-TB_VERSION | Refer to ***version*** capability in chart
-TUNNELING | Must be ***true*** if you are testing against internal/local servers
-RESOLUTION | Possible values: 800x600, 1024x768, 1280x960, 1280x1024, 1600x1200, 1920x1200, 2560x1440
+`WEB_BROWSER` | Must be set to **`testingbot`**
+`TB_USERNAME` | Must be set to your TestingBot account user name
+`TB_AUTHKEY` | Must be set to your TestingBot account access key
+`TB_OS` | Refer to **`platform`** capability in chart
+`TB_BROWSER` | Refer to **`browserName`** capability in chart
+`TB_VERSION` | Refer to **`version`** capability in chart
+`TUNNELING` | Must be **`true`** if you are testing against internal/local servers
+`RESOLUTION` | Possible values: **`800x600`**, **`1024x768`**, **`1280x960`**, **`1280x1024`**, **`1600x1200`**, **`1920x1200`**, **`2560x1440`**
 
 
 ### Using Browser specific Profiles in cucumber.yml
 
 While you can set **Environment Variables** in the command line when invoking Cucumber, a preferred method of specifying and managing
 target web browsers is to create browser specific **Profiles** that set the appropriate **Environment Variables** for each target browser
-in your ***cucumber.yml*** file.
+in your **`cucumber.yml`** file.
 
 Below is a list of Cucumber **Profiles** for supported locally and remotely hosted desktop and mobile web browsers (put these in in your
-***cucumber.yml*** file). Before you can use the BrowserStack, CrossBrowserTesting, Sauce Labs, or TestingBot services, you will need to
+**`cucumber.yml`** file). Before you can use the BrowserStack, CrossBrowserTesting, Sauce Labs, or TestingBot services, you will need to
 replace the placeholder text with your user account and authorization code for the cloud service(s) that you intend to connect with.
 
     <% desktop          = "--tags ~@wip --tags ~@failing --tags @desktop --require features" %>
@@ -768,7 +764,7 @@ replace the placeholder text with your user account and authorization code for t
     tb_edge_win10:      --profile tb_win10 TB_BROWSER="microsoftedge" TB_VERSION="13"
 
 
-To specify a locally hosted target browser using a profile at runtime, you use the flag --profile or -p followed by the profile name when
+To specify a locally hosted target browser using a profile at runtime, you use the flag **`--profile`** or **`-p`** followed by the profile name when
 invoking Cucumber in the command line. For instance, the following command invokes Cucumber and specifies that a local instance of Chrome
 will be used as the target web browser:
     

data/lib/testcentricity_web/version.rb

@@ -1,3 +1,3 @@
 module TestCentricityWeb
-  VERSION = '0.6.4'
+  VERSION = '0.6.4.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testcentricity_web
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.4.1
 platform: ruby
 authors:
 - A.J. Mrozinski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-29 00:00:00.000000000 Z
+date: 2016-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler