TestingBotREST Java

A Java client for TestingBot.com's REST API.

Using this client you can interact with the TestingBot API; update Test info, including pass/fail status and other metadata.

https://testingbot.com/support/api

Getting Started

Sign up for an account on TestingBot.com - in the member area you will find the key and secret required to authenticate with the TestingBot API.

TestingbotREST restApi = new TestingbotREST("key", "secret");

All API methods can throw these exceptions:

TestingbotApiException(String json)
TestingbotUnauthorizedException

getBrowsers

Retrieves collection of available browsers https://testingbot.com/support/api

ArrayList<TestingbotBrowser> devices = restApi.getBrowsers();

getDevices

Retrieves collection of available devices https://testingbot.com/support/api#devices

ArrayList<TestingbotDevice> devices = restApi.getDevices();

getAvailableDevices

Retrieves collection of available devices https://testingbot.com/support/api#available-devices

ArrayList<TestingbotDevice> devices = restApi.getAvailableDevices();

getDevice

Retrieves information for a specific device https://testingbot.com/support/api#devicedetails

TestingbotDevice device = restApi.getDevice(int deviceId);

updateTest

Update meta-data for a test https://testingbot.com/support/api#updatetest

String status_message
boolean success
String build
String name

boolean success = restApi.updateTest(TestingbotTest test);
boolean success = restApi.updateTest(String sessionId, Map<String, Object> details);

stopTest

Stops a running test https://testingbot.com/support/api#stoptest

boolean success = restApi.stopTest(String sessionId);

deleteTest

Deletes a test from TestingBot https://testingbot.com/support/api#deletetest

boolean success = restApi.deleteTest(String sessionId);

getTest

Retrieves information regarding a test https://testingbot.com/support/api#singletest

TestingbotTest test = restApi.getTest(String sessionId);

getTests

Retrieves a collection of tests https://testingbot.com/support/api#tests

TestingbotTest test = restApi.getTests(int offset, int count);

getBuilds

Retrieves a collection of builds https://testingbot.com/support/api#builds

TestingbotBuildCollection builds = restApi.getBuilds(int offset, int count);

getTestsForBuild

Retrieves a collection of tests for a specific build https://testingbot.com/support/api#singlebuild

TestingbotTestBuildCollection tests = restApi.getTestsForBuild(String buildIdentifier);

getUserConfig

Retrieves information about the current user https://testingbot.com/support/api#user

TestingbotUser user = restApi.getUserInfo();

updateUserConfig

Updates information about the current user https://testingbot.com/support/api#useredit

TestingbotUser user = restApi.updateUserInfo(TestingBotUser);

getTunnels

Retrieves tunnels for the current user https://testingbot.com/support/api#apitunnellist

ArrayList<TestingbotTunnel> tunnels = restApi.getTunnels();

deleteTunnel

Deletes/stops a specific tunnel for the current user https://testingbot.com/support/api#apitunneldelete

boolean success = restApi.deleteTunnel(String tunnelID);

uploadToStorage - Local File

Uploads a local file to TestingBot Storage https://testingbot.com/support/api#upload

TestingbotStorageUploadResponse uploadResponse = restApi.uploadToStorage(File file);

uploadToStorage - Remote File

Uploads a remote file to TestingBot Storage https://testingbot.com/support/api#upload

TestingbotStorageUploadResponse uploadResponse = restApi.uploadToStorage(String fileUrl);

getStorageFile

Retrieves meta-data from a previously stored file https://testingbot.com/support/api#uploadfile

TestingBotStorageFile storedFile = restApi.getStorageFile(String appUrl);

getStorageFiles

Retrieves meta-data from previously stored files https://testingbot.com/support/api#filelist

TestingBotStorageFileCollection fileList = restApi.getStorageFiles(int offset, int count);

deleteStorageFile

Deletes a file previously stored in TestingBot Storage https://testingbot.com/support/api#filedelete

boolean success = restApi.deleteStorageFile(String appUrl);

getAuthenticationHash

Calculates the authenticationHash necessary to share tests https://testingbot.com/support/other/sharing

String hash = restApi.getAuthenticationHash(String identifier);

Test

mvn -DTB_KEY=... -DTB_SECRET=... test

Maven

<dependencies>
  <dependency>
    <groupId>com.testingbot</groupId>
    <artifactId>testingbotrest</artifactId>
    <version>1.0.8</version>
    <scope>test</scope>
  </dependency>
</dependencies

GeezerVison

Latest commit

History

Folders and files

Repository files navigation