GitHub - testingbot/testingbot_ruby: Ruby gem to use with the Cloud Selenium Service at testingbot.com

This is the TestingBot Ruby client which makes it easy to interact with the TestingBot API

Installation

Add this line to your application's Gemfile:

And then execute:

Or install it yourself as:

Configuration

You'll need a TestingBot account. TestingBot offers free trials. Once you have an account, retrieve your unique TestingBot Key and Secret from the TestingBot dashboard.

@api = TestingBot::Api.new(key, secret)

Credential resolution

If you do not pass a key/secret explicitly, the client resolves them in this order (the first source that provides both wins):

1. Arguments passed to TestingBot::Api.new(key, secret)
2. The ~/.testingbot file — a single line in the form key:secret
3. The TESTINGBOT_KEY / TESTINGBOT_SECRET environment variables
4. The TB_KEY / TB_SECRET environment variables

# environment variable style
export TB_KEY=your-testingbot-key
export TB_SECRET=your-testingbot-secret

You can generate the ~/.testingbot file interactively with the bundled CLI:

The file is created with 0600 permissions; the client warns if it finds the file readable by other users.

Options

TestingBot::Api.new accepts an options hash as a third argument:

@api = TestingBot::Api.new(key, secret,
  debug:        true,  # log (redacted) responses to STDERR
  open_timeout: 10,    # seconds to wait for the connection (default 10)
  read_timeout: 30,    # seconds to wait for the response   (default 30)
  max_retries:  3      # retry budget for idempotent requests (default 3)
)

Idempotent requests (GET/PUT/DELETE) are retried with exponential backoff on transient failures (timeouts, 5xx, and 429 — honoring Retry-After). POST requests are never retried automatically, to avoid duplicating side effects.

Error handling

All failures raise a subclass of TestingBot::Error, which carries #http_status and #body:

begin
  @api.get_test(session_id)
rescue TestingBot::NotFoundError
  # ...
rescue TestingBot::Error => e
  warn "TestingBot API error (#{e.http_status}): #{e.message}"
end

Most methods return the parsed JSON response (a Hash or Array). The mutating helpers update_user_info, update_test, delete_test, stop_test and delete_uploaded_file return a Boolean indicating success.

Usage

get_user_info

Gets your user information.

update_user_info

Updates your user information. Returns true/false.

@api.update_user_info({ "first_name" => 'my name' })

get_user_keys

Retrieves the API key/secret pair for the current account.

get_team

Gets info about the current team you belong to.

get_users_in_team

Gets all users in your team.

@api.get_users_in_team(offset = 0, count = 10)

get_user_in_team

Get info about a specific user in your team.

@api.get_user_in_team(user_id)

get_user_client_key

Gets a specific team member's API client key. Requires ADMIN rights.

@api.get_user_client_key(user_id)

create_user_in_team

Add a user to your current team. You need to have ADMIN rights to do this.

@api.create_user_in_team(user = {})

update_user_in_team

Updates a specific user in your team.

@api.update_user_in_team(user_id, user = {})

reset_credentials

Resets the credentials for a specific user.

@api.reset_credentials(user_id)

get_browsers

Gets a list of browsers you can test on.

get_devices

Gets a list of (physical) devices you can test on. Optionally filter by platform and/or web capability.

@api.get_devices
@api.get_devices("android", true)

get_available_devices

Gets a list of available (physical) devices you can test on.

@api.get_available_devices

get_device

Gets a single physical device by its numeric ID.

@api.get_device(device_id)

get_ip_ranges

Gets the IP ranges TestingBot tests originate from (useful for firewall allow-listing).

take_screenshots

Take screenshots for a specific URL on specific browsers.

@api.take_screenshots(configuration)

get_screenshots_history

Retrieve screenshots that were previously generated.

@api.get_screenshots_history(offset = 0, count = 10)

get_screenshots

Get screenshots from a specific id.

@api.get_screenshots(screenshots_id)

get_tests

Gets a list of previous jobs/tests that you ran on TestingBot, ordered by last run. The optional filters hash accepts the API's since, browser_id, group, build and skip_fields params.

@api.get_tests(0, 10)
@api.get_tests(0, 10, build: "my-build")

get_test

Gets meta information for a test/job by passing in the WebDriver sessionID of the test you ran on TestingBot.

@api.get_test(webdriver_session_id)

update_test

Updates a Test with meta-data to display on TestingBot (e.g. name and pass/fail). Returns true/false.

@api.update_test(webdriver_session_id, { :name => new_name, :success => true })

delete_test

Deletes a test from TestingBot. Returns true/false.

@api.delete_test(webdriver_session_id)

stop_test

Stops a running test on TestingBot. Returns true/false.

@api.stop_test(webdriver_session_id)

get_builds

Gets a list of builds that you ran on TestingBot, ordered by last run.

get_build

Gets a build from TestingBot.

@api.get_build(build_identifier)

delete_build

Deletes a build from TestingBot.

@api.delete_build(build_identifier)

get_job

Polls the status/result of an asynchronous job (e.g. a Codeless Lab run started by a trigger endpoint).

get_tunnels

Gets a list of active tunnels for your account.

get_tunnel

Gets the active tunnel, or a specific tunnel by ID.

@api.get_tunnel
@api.get_tunnel(tunnel_id)

delete_tunnel

Deletes a tunnel by ID, or the active tunnel when called without an argument.

@api.delete_tunnel(tunnel_identifier)
@api.delete_tunnel

upload_local_file

Uploads a local file (APK or IPA file) to TestingBot Storage for Mobile App Testing. This request uses a 600-second timeout to accommodate large uploads.

@api.upload_local_file(localFilePath)

upload_remote_file

Uploads a remote file (APK or IPA URL) to TestingBot Storage for Mobile App Testing.

@api.upload_remote_file(remoteFileUrl)

update_local_file / update_remote_file

Replaces the binary stored under an existing app key.

@api.update_local_file(app_url, localFilePath)
@api.update_remote_file(app_url, remoteFileUrl)

get_uploaded_files

Retrieves files previously uploaded to TestingBot Storage for Mobile App Testing.

@api.get_uploaded_files(offset = 0, count = 10)

get_uploaded_file

Retrieves meta-data for a file previously uploaded to TestingBot Storage.

@api.get_uploaded_file(app_url)

delete_uploaded_file

Deletes a previously uploaded file. Returns true/false.

@api.delete_uploaded_file(app_url)

Codeless Lab tests

@api.get_lab_tests(offset = 0, count = 10)
@api.create_lab_test(params = {})
@api.get_lab_test(lab_test_id)
@api.update_lab_test(lab_test_id, params = {})
@api.delete_lab_test(lab_test_id)
@api.get_lab_test_steps(lab_test_id)
@api.set_lab_test_steps(lab_test_id, params = {})
@api.get_lab_test_browsers(lab_test_id)
@api.set_lab_test_browsers(lab_test_id, params = {})
@api.add_lab_test_alert(lab_test_id, params = {})
@api.update_lab_test_alert(lab_test_id, params = {})
@api.create_lab_test_report(lab_test_id, params = {})
@api.update_lab_test_report(lab_test_id, params = {})
@api.schedule_lab_test(lab_test_id, params = {})
@api.trigger_lab_test(lab_test_id, params = {})
@api.stop_lab_test(lab_test_id)
@api.trigger_all_lab_tests(params = {})

Codeless Lab suites

@api.get_lab_suites(offset = 0, count = 10)
@api.create_lab_suite(params = {})
@api.get_lab_suite(suite_id)
@api.delete_lab_suite(suite_id)
@api.get_lab_suite_tests(suite_id)
@api.add_lab_suite_tests(suite_id, params = {})
@api.remove_lab_suite_test(suite_id, test_id)
@api.get_lab_suite_browsers(suite_id)
@api.set_lab_suite_browsers(suite_id, params = {})
@api.trigger_lab_suite(suite_id, params = {})

get_authentication_hash

Calculates the hash necessary to share private tests/builds with other people. Returns MD5("#{key}:#{secret}:#{identifier}").

@api.get_authentication_hash(identifier)

Development

bundle install
bundle exec rake unit         # offline, mocked unit suite (no credentials required)
bundle exec rake integration  # live suite, requires TB_KEY / TB_SECRET

Contributing

1. Fork this repository
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request