starred/stf-DeviceFarmer-1
1
0
Fork 0
mirror of https://github.com/DeviceFarmer/stf.git synced 2026-04-18 00:03:28 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add bash example of using API in API doc

Browse Source
This commit is contained in:
Vishal Banthia
2016-10-28 15:22:50 +05:30
committed by GitHub
parent 13e646a756
commit 104c583418
1 changed files with 83 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
doc/API.md
View File

@@ -340,7 +340,88 @@ clientWithPromise.then(function(api) {
## Examples
### Connect to a device and retrieve its remote debug URL
### Using Shell
#### Dependencies
- [jq](https://stedolan.github.io/jq/)
```bash
#!/usr/bin/env bash
set -euxo pipefail
if [ "$DEVICE_SERIAL" == "" ]; then
echo "Please specify device serial using ENV['DEVICE_SERIAL']"
exit 1
fi
if [ "$STF_URL" == "" ]; then
echo "Please specify stf url using ENV['STF_URL']"
exit 1
fi
if [ "$STF_TOKEN" == "" ]; then
echo "Please specify stf token using using ENV['STF_TOKEN']"
exit 1
fi
function add_device
{
response=$(curl -X POST -H "Content-Type: application/json" \
-H "Authorization: Bearer $STF_TOKEN" \
--data "{\"serial\": \"$DEVICE_SERIAL\"}" $STF_URL/api/v1/user/devices)
success=$(echo "$response" | jq .success | tr -d '"')
description=$(echo "$response" | jq .description | tr -d '"')
if [ "$success" != "true" ]; then
echo "Failed because $description"
exit 1
fi
echo "Device $DEVICE_SERIAL added successfully"
}
function remote_connect
{
response=$(curl -X POST -H "Content-Type: application/json" \
-H "Authorization: Bearer $STF_TOKEN" \
$STF_URL/api/v1/user/devices/$DEVICE_SERIAL/remoteConnect)
success=$(echo "$response" | jq .success | tr -d '"')
description=$(echo "$response" | jq .description | tr -d '"')
if [ "$success" != "true" ]; then
echo "Failed because $description"
exit 1
fi
remote_connect_url=$(echo "$response" | jq .remoteConnectUrl | tr -d '"')
adb connect $remote_connect_url
echo "Device $DEVICE_SERIAL remote connected successfully"
}
function remove_device
{
response=$(curl -X DELETE -H "Content-Type: application/json" \
-H "Authorization: Bearer $STF_TOKEN" \
$STF_URL/api/v1/user/devices/$DEVICE_SERIAL)
success=$(echo "$response" | jq .success | tr -d '"')
description=$(echo "$response" | jq .description | tr -d '"')
if [ "$success" != "true" ]; then
echo "Failed because $description"
exit 1
fi
echo "Device $DEVICE_SERIAL removed successfully"
}
```
### Using NodeJs
#### Connect to a device and retrieve its remote debug URL
```js
// stf-connect.js
@@ -401,7 +482,7 @@ node stf-connect.js xxxx
# $PROVIDR_IP:16829
```
### Disconnect a device once you no longer need it
#### Disconnect a device once you no longer need it
```js
var Swagger = require('swagger-client');