Skip to content

Update the client to use SSL (https) to contact BrowserStack. #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jcheek wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update the client to use SSL (https) to contact BrowserStack. #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54ddcd9
Update the client to use SSL (https) to contact BrowserStack. The cl…
Jun 29, 2016
384834e
Add tunnel information to the README.
Jun 29, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 27 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,24 @@
stackshots uses the BrowserStack's Screenshot API to take screenshots from websites and downloads to your computer.
It's great for automated tests to get a glance of your site in different browsers.

Note that this feature needs as of now, a "Regular" BrowserStack plan. Please, see [BrowserStack](http://www.browserstack.com/screenshots/pricing) for more details.
Note that this program needs a "Regular" BrowserStack plan. Please see [BrowserStack Account Subscriptions](https://www.browserstack.com/accounts/subscriptions) for more details.

## CLI Usage

These are the parameters of the CLI

```
Options:
-u, --username The email you use to log in to Browserstack [required]
-p, --password Your account's password [required]
-w, --website The website(s) from which you want to get screenshots. Comma separated list
-b, --browser The browser(s) from which you want to get screenshots. Comma separated list [default: "IE_8,IE_9,Chrome,Firefox"]
-o, --orientation Orientation of the device (portrait|landscape). [default: "portrait"]
-s, --os Operating System of the browser separating version with underscore (windows_xp). Comma separated list [default: "windows_7"]
-d, --device The device(s) from which you want to get screenshots. Comma separated list
-f, --folder Folder in which screenshots will be stored [default: Current folder]
-l, --ls Instead of getting images, it will output a list of browsers and OS available
-u, --username The username you use to log in to Browserstack [required]
-k, --accesskey Your api access key [required]
-w, --website The website(s) from which you want to get screenshots, as a comma-separated list
-b, --browser The browser(s) from which you want to get screenshots, as a comma-separated list [default: "IE_8,IE_9,Chrome,Firefox"]
-o, --orientation Orientation of the device (portrait|landscape) [default: "portrait"]
-s, --os Operating System of the browser separating version with underscore (windows_xp), as a comma-separated list [default: "windows_7"]
-d, --device The device(s) from which you want to get screenshots, as a comma-separated list
-f, --folder Folder in which screenshots will be stored [default: Current folder]
-l, --ls Instead of getting images, it will output a list of browsers and OSes available
-t, --tunnel Enable tunnel support
-h, --help Shows help info
```

Expand All @@ -28,15 +29,15 @@ will get the browsers to which you *would* submit the request. Try as many times

### `username`

This is actually your email to log into your BrowserStack account
This is your BrowserStack Username. See [BrowserStack Account Settings](https://www.browserstack.com/accounts/settings).

### `password`
### `accesskey`

Password of your BrowserStack account
Access Key for your BrowserStack account.

### `website`

Comma separated list of the URL's you want to get screenshot's from.
Comma-separated list of the URLs from which you want to get screenshots.

For example:

Expand All @@ -52,13 +53,13 @@ www.google.com

### `browser`

Browser from which you want to get an screenshot. By default they are:
Browser from which you want to get an screenshot. By default they are:

* Internet Explorer 8 & Internet Explorer 9
* Chrome Latest
* Firefox Latest

If you don't specify a version, it will suppose you wan't to get the latest one:
If you don't specify a version, it will suppose you want to use the latest one:

```
--browser ie
Expand Down Expand Up @@ -102,17 +103,17 @@ Just add `"` if you need to add spaces:

### `orientation`

Orientation is usefull for Mobile Devices, otherwise, it is not. However, the program will not allow you to pass anything that's not `portrait` or `landscape`. By default is `portrait`.
Orientation is useful only for mobile devices. However, the program will not allow you to pass anything that's not `portrait` or `landscape`. The default is `portrait`.

### `os`

This is the Operating System in which you can request Screenshots. By default is Windows
This is the Operating System in which you can request screenshots. The default is `Windows`.

```
--os "OS X"
```

The program is smart enough to know your intentions... some times. Let's say you want to get Firefox screenshots from Mac and screenshots from IE 8:
The program is smart enough to know your intentions... sometimes. Let's say you want to get Firefox screenshots from Mac and screenshots from IE 8:

```
--os "OS X" --browser firefox,ie_8
Expand Down Expand Up @@ -193,27 +194,30 @@ The device from which you want to take a screenshot.

### `folder`

The folder in which you want to store the screenshots. By default is the folder in which you are invoking the process.
The folder in which you want to store the screenshots. The default is the current directory.

```
--folder /tmp
```

### `ls`

This option will ignore the rest of arguments and will output the list of browsers, versions and OS available so you have an idea of what is available.
This option will ignore the rest of arguments and will output the list of browsers, versions, and OSes available. Note that you still need to pass username and accesskey arguments.

```
Browser: ie
OS: windows
Versions: 6.0, 7.0, 10.0 Desktop, 8.0, 9.0, 10.0
```
### `tunnel`

##Development and Tests
Enable local testing via a tunnel from the Internet back to your machine. Requires that you run the `BrowserStackLocal` client. See [BrowserStack Local Testing](https://www.browserstack.com/local-testing) for more information and to download binaries.

## Development and Tests

```
npm install
./node_modules/.bin/grunt
grunt
```

## Credits
Expand Down
8 changes: 4 additions & 4 deletions lib/stackshots.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
var http = require('http'),
var https = require('https'),
os = require('os'),
extend = require('extend'),
async = require('async'),
Expand Down Expand Up @@ -46,7 +46,7 @@ function APIClient(settings, cb){

this.reqOptions = {
host : 'www.browserstack.com',
port : 80,
port : 443,
method : "GET",
headers : {
"authorization" : this.authHeader,
Expand Down Expand Up @@ -103,7 +103,7 @@ APIClient.prototype.request = function(options, data, cb){
'400' : 'Bad request'
};

var request = http.request(this.getRequestOptions(options,dataString), function(res){
var request = https.request(this.getRequestOptions(options,dataString), function(res){
var response = '';
res.setEncoding('utf8');

Expand Down Expand Up @@ -436,4 +436,4 @@ APIClient.prototype.validDevice = function(currentBrowserDevice, devices){
return !currentBrowserDevice || !devices || devices.indexOf(currentBrowserDevice) > -1;
};

module.exports = APIClient;
module.exports = APIClient;