Skip to content

Latest commit

 

History

History
271 lines (188 loc) · 5.13 KB

README.md

File metadata and controls

271 lines (188 loc) · 5.13 KB
Raw

Gem Version Test Changes

Testingbot-Ruby

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:

gem 'testingbot'

And then execute:

$ bundle

Or install it yourself as:

$ gem install testingbot

Configuration

You'll need a TestingBot account. TestingBot offers free trials.

Setup

Once you have a TestingBot account, you can retrieve your unique TestingBot Key and Secret from the TestingBot dashboard

Usage

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

Environment variables

You can set these environment variables to authenticate with our API:

TB_KEY=Your TestingBot Key
TB_SECRET=Your TestingBot Secret

get_browsers

Gets a list of browsers you can test on

@api.get_browsers

get_devices

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

@api.get_devices

get_available_devices

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

@api.get_available_devices

get_team

Gets info about the current team you belong to

@api.get_team

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)

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)

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_user_info

Gets your user information

@api.get_user_info

update_user_info

Updates your user information

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

update_test

Updates a Test with Meta-data to display on TestingBot. For example, you can specify the test name and whether the test succeeded or failed:

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

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)

get_tests

Gets a list of previous jobs/tests that you ran on TestingBot, order by last run:

@api.get_tests(0, 10)

delete_test

Deletes a test from TestingBot

@api.delete_test(webdriver_session_id)

stop_test

Stops a running test on TestingBot

@api.stop_test(webdriver_session_id)

get_builds

Gets a list of builds that you ran on TestingBot, order by last run:

@api.get_builds(0, 10)

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_tunnels

Gets a list of active tunnels for your account.

@api.get_tunnels

delete_tunnel

Deletes an active tunnel.

@api.delete_tunnel(tunnel_identifier)

upload_local_file

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

@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)

get_uploaded_files

Retrieves files previously uploaded TestingBot Storage for Mobile App Testing.

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

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

@api.delete_uploaded_file(remoteFileUrl)

upload_remote_file

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

@api.upload_remote_file(remoteFileUrl)

get_authentication_hash

Calculates the hash necessary to share tests with other people

@api.get_authentication_hash(identifier)

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