CrossBrowserTesting Screenshots

A ruby gem for CrossBrowserTesting's screenshots API.

Installation

Add this line to your application's Gemfile:

gem 'crossbrowsertesting-gem'

And then execute:

bundle

Or install it yourself as:

gem install crossbrowsertesting-gem

Examples of use

If you are not using Rails, you'll need to require the gem:

require 'CBT'

Create a client

Creates a new client instance.

client = CBT.new('username', 'password')

API

Take a screenshot

Queues up a request for a screenshot

params = {
  :url => 'http://darrennix.com',
  :delay => 5,
}
request = client.take_screenshot(params)

Check the status of a screenshot request

Returns true or false for completion status

test = request[:test][:id]
version = request[:test][:version][:id]
completed = client.status(test, version)

Load the full results of a screenshot request

results = client.results(test, version)

results[:test][:version][:results].each do |screenshot|
    puts screenshot[:images][:fullpage]
end

Get available os and browsers

Fetches all available browsers.

Rather than using this list to construct a set of browsers for testing, I recommend saving a list of browser configurations through the main site and then referencing that list by name in your "take_screenshot" params.

puts client.browsers    #returns a hash

{
    :error=>0, 
    :message=>"", 
    :oss=>[
        {
            :name=>"Android 4.0 Simulator", 
            :api_name=>"Android4.0", 
            :type=>"Android", 
            :version=>"4.0", 
            :device=>"mobile", 
            :icon=>"http://crossbrowsertesting.com/images/software_logos/android15.png", 
            :browsers=>[
                {
                    :name=>"Android Browser 4.0", 
                    :api_name=>"Android4.0", 
                    :type=>"Android Browser", 
                    :version=>"4.0", 
                    :device=>"mobile", 
                    :major_browser=>1, 
                    :icon=>"http://crossbrowsertesting.com/images/software_logos/android-browser15.png",
                    :default_config=>"Android4.0"
                }
            ], 
            :other_software=>[
                {
                    :name=>"Base install - no additional software added", 
                    :type=>"None", 
                    :version=>"", 
                    :icon=>"http://crossbrowsertesting.com/images/software_logos/15.png"
                }
            ], 
            :resolutions=>[
                {
                    :name=>"480x800", 
                    :width=>480, 
                    :height=>800, 
                    :default=>1
                }
            ]
        },
        ...
    ]
}