https://github.com/testingbot/testingbot-java
Java Rest Client for TestingBot.com
https://github.com/testingbot/testingbot-java
api-client java-client selenium testingbot webdriver
Last synced: 3 months ago
JSON representation
Java Rest Client for TestingBot.com
- Host: GitHub
- URL: https://github.com/testingbot/testingbot-java
- Owner: testingbot
- License: mit
- Created: 2015-11-13T15:55:32.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-05-10T11:26:06.000Z (about 1 year ago)
- Last Synced: 2025-01-19T19:17:01.215Z (4 months ago)
- Topics: api-client, java-client, selenium, testingbot, webdriver
- Language: Java
- Homepage: https://testingbot.com
- Size: 63.5 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://search.maven.org/artifact/com.testingbot/testingbotrest)
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.
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.
```java
TestingbotREST restApi = new TestingbotREST("key", "secret");
```
*All API methods can throw these exceptions:*
```java
TestingbotApiException(String json)
TestingbotUnauthorizedException
```
### getBrowsers
Retrieves collection of available browsers
```java
ArrayList devices = restApi.getBrowsers();
```
### getDevices
Retrieves collection of available devices
```java
ArrayList devices = restApi.getDevices();
```
### getAvailableDevices
Retrieves collection of available devices
```java
ArrayList devices = restApi.getAvailableDevices();
```
### getDevice
Retrieves information for a specific device
```java
TestingbotDevice device = restApi.getDevice(int deviceId);
```
### updateTest
Update meta-data for a test
- `String` status_message
- `boolean` success
- `String` build
- `String` name
```java
boolean success = restApi.updateTest(TestingbotTest test);
boolean success = restApi.updateTest(String sessionId, Map details);
```
### stopTest
Stops a running test
```java
boolean success = restApi.stopTest(String sessionId);
```
### deleteTest
Deletes a test from TestingBot
```java
boolean success = restApi.deleteTest(String sessionId);
```
### getTest
Retrieves information regarding a test
```java
TestingbotTest test = restApi.getTest(String sessionId);
```
### getTests
Retrieves a collection of tests
```java
TestingbotTestCollection test = restApi.getTests(int offset, int count);
```
### getBuilds
Retrieves a collection of builds
```java
TestingbotBuildCollection builds = restApi.getBuilds(int offset, int count);
```
### getTestsForBuild
Retrieves a collection of tests for a specific build
```java
TestingbotTestBuildCollection tests = restApi.getTestsForBuild(String buildIdentifier);
```
### getUserConfig
Retrieves information about the current user
```java
TestingbotUser user = restApi.getUserInfo();
```
### updateUserConfig
Updates information about the current user
```java
TestingbotUser user = restApi.updateUserInfo(TestingBotUser);
```
### getTunnels
Retrieves tunnels for the current user
```java
ArrayList tunnels = restApi.getTunnels();
```
### deleteTunnel
Deletes/stops a specific tunnel for the current user
```java
boolean success = restApi.deleteTunnel(String tunnelID);
```
### uploadToStorage - Local File
Uploads a local file to TestingBot Storage
```java
TestingbotStorageUploadResponse uploadResponse = restApi.uploadToStorage(File file);
```
### uploadToStorage - Remote File
Uploads a remote file to TestingBot Storage
```java
TestingbotStorageUploadResponse uploadResponse = restApi.uploadToStorage(String fileUrl);
```
### getStorageFile
Retrieves meta-data from a previously stored file
```java
TestingBotStorageFile storedFile = restApi.getStorageFile(String appUrl);
```
### getStorageFiles
Retrieves meta-data from previously stored files
```java
TestingBotStorageFileCollection fileList = restApi.getStorageFiles(int offset, int count);
```
### deleteStorageFile
Deletes a file previously stored in TestingBot Storage
```java
boolean success = restApi.deleteStorageFile(String appUrl);
```
### getAuthenticationHash
Calculates the authenticationHash necessary to share tests
```java
String hash = restApi.getAuthenticationHash(String identifier);
```
Test
-----
```java
mvn -DTB_KEY=... -DTB_SECRET=... test
```
Maven
-----
```xml
com.testingbot
testingbotrest
1.0.8
test